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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.749   ! tempelho    4: # $Id: loncommon.pm,v 1.748 2009/02/14 12:20:10 schulted Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
                    409: <script type="text/javascript" language="Javascript" >
                    410:     var stdeditbrowser;
1.558     albertel  411:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74      www       412:         var url = '/adm/pickstudent?';
                    413:         var filter;
1.558     albertel  414: 	if (!ignorefilter) {
                    415: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    416: 	}
1.74      www       417:         if (filter != null) {
                    418:            if (filter != '') {
                    419:                url += 'filter='+filter+'&';
                    420: 	   }
                    421:         }
                    422:         url += 'form=' + formname + '&unameelement='+uname+
                    423:                                     '&udomelement='+udom;
1.111     www       424: 	if (roleflag) { url+="&roles=1"; }
1.102     www       425:         var title = 'Student_Browser';
1.74      www       426:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    427:         options += ',width=700,height=600';
                    428:         stdeditbrowser = open(url,title,options,'1');
                    429:         stdeditbrowser.focus();
                    430:     }
                    431: </script>
                    432: ENDSTDBRW
                    433: }
1.42      matthew   434: 
1.74      www       435: sub selectstudent_link {
1.111     www       436:    my ($form,$unameele,$udomele)=@_;
1.258     albertel  437:    if ($env{'request.course.id'}) {  
1.302     albertel  438:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    439: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    440: 					'/'.$env{'request.course.sec'})) {
1.111     www       441: 	   return '';
                    442:        }
                    443:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607     albertel  444:         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74      www       445:    }
1.258     albertel  446:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111     www       447:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       448:         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111     www       449:    }
                    450:    return '';
1.91      www       451: }
                    452: 
1.653     raeburn   453: sub authorbrowser_javascript {
                    454:     return <<"ENDAUTHORBRW";
                    455: <script type="text/javascript">
                    456: var stdeditbrowser;
                    457: 
                    458: function openauthorbrowser(formname,udom) {
                    459:     var url = '/adm/pickauthor?';
                    460:     url += 'form='+formname+'&roledom='+udom;
                    461:     var title = 'Author_Browser';
                    462:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    463:     options += ',width=700,height=600';
                    464:     stdeditbrowser = open(url,title,options,'1');
                    465:     stdeditbrowser.focus();
                    466: }
                    467: 
                    468: </script>
                    469: ENDAUTHORBRW
                    470: }
                    471: 
1.91      www       472: sub coursebrowser_javascript {
1.468     raeburn   473:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   474:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468     raeburn   475:    my $output = '
1.538     albertel  476: <script type="text/javascript">
1.468     raeburn   477:     var stdeditbrowser;'."\n";
                    478:    $output .= <<"ENDSTDBRW";
1.377     raeburn   479:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       480:         var url = '/adm/pickcourse?';
1.468     raeburn   481:         var domainfilter = '';
                    482:         var formid = getFormIdByName(formname);
                    483:         if (formid > -1) {
                    484:             var domid = getIndexByName(formid,udom);
                    485:             if (domid > -1) {
                    486:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    487:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    488:                 }
                    489:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    490:                     domainfilter=document.forms[formid].elements[domid].value;
                    491:                 }
                    492:             }
1.91      www       493:         }
1.128     albertel  494:         if (domainfilter != null) {
                    495:            if (domainfilter != '') {
                    496:                url += 'domainfilter='+domainfilter+'&';
                    497: 	   }
                    498:         }
1.91      www       499:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  500: 	                            '&cdomelement='+udom+
                    501:                                     '&cnameelement='+desc;
1.468     raeburn   502:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   503:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   504:                 url += '&roleelement='+extra_element;
                    505:                 if (domainfilter == null || domainfilter == '') {
                    506:                     url += '&domainfilter='+extra_element;
                    507:                 }
1.234     raeburn   508:             }
1.468     raeburn   509:             else {
                    510:                 if (formname == 'portform') {
                    511:                     url += '&setroles='+extra_element;
                    512:                 }
                    513:             }     
1.230     raeburn   514:         }
1.293     raeburn   515:         if (multflag !=null && multflag != '') {
                    516:             url += '&multiple='+multflag;
                    517:         }
1.377     raeburn   518:         if (crstype == 'Course/Group') {
                    519:             if (formname == 'cu') {
                    520:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    521:                 if (crstype == "") {
                    522:                     alert("$crs_or_grp_alert");
                    523:                     return;
                    524:                 }
                    525:             }
                    526:         }
                    527:         if (crstype !=null && crstype != '') {
                    528:             url += '&type='+crstype;
                    529:         }
1.102     www       530:         var title = 'Course_Browser';
1.91      www       531:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    532:         options += ',width=700,height=600';
                    533:         stdeditbrowser = open(url,title,options,'1');
                    534:         stdeditbrowser.focus();
                    535:     }
1.468     raeburn   536: 
                    537:     function getFormIdByName(formname) {
                    538:         for (var i=0;i<document.forms.length;i++) {
                    539:             if (document.forms[i].name == formname) {
                    540:                 return i;
                    541:             }
                    542:         }
                    543:         return -1; 
                    544:     }
                    545: 
                    546:     function getIndexByName(formid,item) {
                    547:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    548:             if (document.forms[formid].elements[i].name == item) {
                    549:                 return i;
                    550:             }
                    551:         }
                    552:         return -1;
                    553:     }
1.91      www       554: ENDSTDBRW
1.468     raeburn   555:     if ($sec_element ne '') {
                    556:         $output .= &setsec_javascript($sec_element,$formname);
                    557:     }
                    558:     $output .= '
                    559: </script>';
                    560:     return $output;
                    561: }
                    562: 
                    563: sub setsec_javascript {
                    564:     my ($sec_element,$formname) = @_;
                    565:     my $setsections = qq|
                    566: function setSect(sectionlist) {
1.629     raeburn   567:     var sectionsArray = new Array();
                    568:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    569:         sectionsArray = sectionlist.split(",");
                    570:     }
1.468     raeburn   571:     var numSections = sectionsArray.length;
                    572:     document.$formname.$sec_element.length = 0;
                    573:     if (numSections == 0) {
                    574:         document.$formname.$sec_element.multiple=false;
                    575:         document.$formname.$sec_element.size=1;
                    576:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    577:     } else {
                    578:         if (numSections == 1) {
                    579:             document.$formname.$sec_element.multiple=false;
                    580:             document.$formname.$sec_element.size=1;
                    581:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    582:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    583:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    584:         } else {
                    585:             for (var i=0; i<numSections; i++) {
                    586:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    587:             }
                    588:             document.$formname.$sec_element.multiple=true
                    589:             if (numSections < 3) {
                    590:                 document.$formname.$sec_element.size=numSections;
                    591:             } else {
                    592:                 document.$formname.$sec_element.size=3;
                    593:             }
                    594:             document.$formname.$sec_element.options[0].selected = false
                    595:         }
                    596:     }
1.91      www       597: }
1.468     raeburn   598: |;
                    599:     return $setsections;
                    600: }
                    601: 
1.91      www       602: 
                    603: sub selectcourse_link {
1.377     raeburn   604:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492     albertel  605:    return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
                    606:         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74      www       607: }
1.42      matthew   608: 
1.653     raeburn   609: sub selectauthor_link {
                    610:    my ($form,$udom)=@_;
                    611:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    612:           &mt('Select Author').'</a>';
                    613: }
                    614: 
1.273     raeburn   615: sub check_uncheck_jscript {
                    616:     my $jscript = <<"ENDSCRT";
                    617: function checkAll(field) {
                    618:     if (field.length > 0) {
                    619:         for (i = 0; i < field.length; i++) {
                    620:             field[i].checked = true ;
                    621:         }
                    622:     } else {
                    623:         field.checked = true
                    624:     }
                    625: }
                    626:  
                    627: function uncheckAll(field) {
                    628:     if (field.length > 0) {
                    629:         for (i = 0; i < field.length; i++) {
                    630:             field[i].checked = false ;
1.543     albertel  631:         }
                    632:     } else {
1.273     raeburn   633:         field.checked = false ;
                    634:     }
                    635: }
                    636: ENDSCRT
                    637:     return $jscript;
                    638: }
                    639: 
1.656     www       640: sub select_timezone {
1.659     raeburn   641:    my ($name,$selected,$onchange,$includeempty)=@_;
                    642:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    643:    if ($includeempty) {
                    644:        $output .= '<option value=""';
                    645:        if (($selected eq '') || ($selected eq 'local')) {
                    646:            $output .= ' selected="selected" ';
                    647:        }
                    648:        $output .= '> </option>';
                    649:    }
1.657     raeburn   650:    my @timezones = DateTime::TimeZone->all_names;
                    651:    foreach my $tzone (@timezones) {
                    652:        $output.= '<option value="'.$tzone.'"';
                    653:        if ($tzone eq $selected) {
                    654:            $output.=' selected="selected"';
                    655:        }
                    656:        $output.=">$tzone</option>\n";
1.656     www       657:    }
                    658:    $output.="</select>";
                    659:    return $output;
                    660: }
1.273     raeburn   661: 
1.687     raeburn   662: sub select_datelocale {
                    663:     my ($name,$selected,$onchange,$includeempty)=@_;
                    664:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    665:     if ($includeempty) {
                    666:         $output .= '<option value=""';
                    667:         if ($selected eq '') {
                    668:             $output .= ' selected="selected" ';
                    669:         }
                    670:         $output .= '> </option>';
                    671:     }
                    672:     my (@possibles,%locale_names);
                    673:     my @locales = DateTime::Locale::Catalog::Locales;
                    674:     foreach my $locale (@locales) {
                    675:         if (ref($locale) eq 'HASH') {
                    676:             my $id = $locale->{'id'};
                    677:             if ($id ne '') {
                    678:                 my $en_terr = $locale->{'en_territory'};
                    679:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   680:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   681:                 if (grep(/^en$/,@languages) || !@languages) {
                    682:                     if ($en_terr ne '') {
                    683:                         $locale_names{$id} = '('.$en_terr.')';
                    684:                     } elsif ($native_terr ne '') {
                    685:                         $locale_names{$id} = $native_terr;
                    686:                     }
                    687:                 } else {
                    688:                     if ($native_terr ne '') {
                    689:                         $locale_names{$id} = $native_terr.' ';
                    690:                     } elsif ($en_terr ne '') {
                    691:                         $locale_names{$id} = '('.$en_terr.')';
                    692:                     }
                    693:                 }
                    694:                 push (@possibles,$id);
                    695:             }
                    696:         }
                    697:     }
                    698:     foreach my $item (sort(@possibles)) {
                    699:         $output.= '<option value="'.$item.'"';
                    700:         if ($item eq $selected) {
                    701:             $output.=' selected="selected"';
                    702:         }
                    703:         $output.=">$item";
                    704:         if ($locale_names{$item} ne '') {
                    705:             $output.="  $locale_names{$item}</option>\n";
                    706:         }
                    707:         $output.="</option>\n";
                    708:     }
                    709:     $output.="</select>";
                    710:     return $output;
                    711: }
                    712: 
1.42      matthew   713: =pod
1.36      matthew   714: 
1.648     raeburn   715: =item * &linked_select_forms(...)
1.36      matthew   716: 
                    717: linked_select_forms returns a string containing a <script></script> block
                    718: and html for two <select> menus.  The select menus will be linked in that
                    719: changing the value of the first menu will result in new values being placed
                    720: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   721: order unless a defined order is provided.
1.36      matthew   722: 
                    723: linked_select_forms takes the following ordered inputs:
                    724: 
                    725: =over 4
                    726: 
1.112     bowersj2  727: =item * $formname, the name of the <form> tag
1.36      matthew   728: 
1.112     bowersj2  729: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   730: 
1.112     bowersj2  731: =item * $firstdefault, the default value for the first menu
1.36      matthew   732: 
1.112     bowersj2  733: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   734: 
1.112     bowersj2  735: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   736: 
1.112     bowersj2  737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   738: 
1.609     raeburn   739: =item * $menuorder, the order of values in the first menu
                    740: 
1.41      ng        741: =back 
                    742: 
1.36      matthew   743: Below is an example of such a hash.  Only the 'text', 'default', and 
                    744: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    745: values for the first select menu.  The text that coincides with the 
1.41      ng        746: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   747: and text for the second menu are given in the hash pointed to by 
                    748: $menu{$choice1}->{'select2'}.  
                    749: 
1.112     bowersj2  750:  my %menu = ( A1 => { text =>"Choice A1" ,
                    751:                        default => "B3",
                    752:                        select2 => { 
                    753:                            B1 => "Choice B1",
                    754:                            B2 => "Choice B2",
                    755:                            B3 => "Choice B3",
                    756:                            B4 => "Choice B4"
1.609     raeburn   757:                            },
                    758:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  759:                    },
                    760:                A2 => { text =>"Choice A2" ,
                    761:                        default => "C2",
                    762:                        select2 => { 
                    763:                            C1 => "Choice C1",
                    764:                            C2 => "Choice C2",
                    765:                            C3 => "Choice C3"
1.609     raeburn   766:                            },
                    767:                        order => ['C2','C1','C3'],
1.112     bowersj2  768:                    },
                    769:                A3 => { text =>"Choice A3" ,
                    770:                        default => "D6",
                    771:                        select2 => { 
                    772:                            D1 => "Choice D1",
                    773:                            D2 => "Choice D2",
                    774:                            D3 => "Choice D3",
                    775:                            D4 => "Choice D4",
                    776:                            D5 => "Choice D5",
                    777:                            D6 => "Choice D6",
                    778:                            D7 => "Choice D7"
1.609     raeburn   779:                            },
                    780:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  781:                    }
                    782:                );
1.36      matthew   783: 
                    784: =cut
                    785: 
                    786: sub linked_select_forms {
                    787:     my ($formname,
                    788:         $middletext,
                    789:         $firstdefault,
                    790:         $firstselectname,
                    791:         $secondselectname, 
1.609     raeburn   792:         $hashref,
                    793:         $menuorder,
1.36      matthew   794:         ) = @_;
                    795:     my $second = "document.$formname.$secondselectname";
                    796:     my $first = "document.$formname.$firstselectname";
                    797:     # output the javascript to do the changing
                    798:     my $result = '';
1.219     albertel  799:     $result.="<script type=\"text/javascript\">\n";
1.36      matthew   800:     $result.="var select2data = new Object();\n";
                    801:     $" = '","';
                    802:     my $debug = '';
                    803:     foreach my $s1 (sort(keys(%$hashref))) {
                    804:         $result.="select2data.d_$s1 = new Object();\n";        
                    805:         $result.="select2data.d_$s1.def = new String('".
                    806:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   807:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   808:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   809:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    810:             @s2values = @{$hashref->{$s1}->{'order'}};
                    811:         }
1.36      matthew   812:         $result.="\"@s2values\");\n";
                    813:         $result.="select2data.d_$s1.texts = new Array(";        
                    814:         my @s2texts;
                    815:         foreach my $value (@s2values) {
                    816:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    817:         }
                    818:         $result.="\"@s2texts\");\n";
                    819:     }
                    820:     $"=' ';
                    821:     $result.= <<"END";
                    822: 
                    823: function select1_changed() {
                    824:     // Determine new choice
                    825:     var newvalue = "d_" + $first.value;
                    826:     // update select2
                    827:     var values     = select2data[newvalue].values;
                    828:     var texts      = select2data[newvalue].texts;
                    829:     var select2def = select2data[newvalue].def;
                    830:     var i;
                    831:     // out with the old
                    832:     for (i = 0; i < $second.options.length; i++) {
                    833:         $second.options[i] = null;
                    834:     }
                    835:     // in with the nuclear
                    836:     for (i=0;i<values.length; i++) {
                    837:         $second.options[i] = new Option(values[i]);
1.143     matthew   838:         $second.options[i].value = values[i];
1.36      matthew   839:         $second.options[i].text = texts[i];
                    840:         if (values[i] == select2def) {
                    841:             $second.options[i].selected = true;
                    842:         }
                    843:     }
                    844: }
                    845: </script>
                    846: END
                    847:     # output the initial values for the selection lists
                    848:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   849:     my @order = sort(keys(%{$hashref}));
                    850:     if (ref($menuorder) eq 'ARRAY') {
                    851:         @order = @{$menuorder};
                    852:     }
                    853:     foreach my $value (@order) {
1.36      matthew   854:         $result.="    <option value=\"$value\" ";
1.253     albertel  855:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       856:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   857:     }
                    858:     $result .= "</select>\n";
                    859:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    860:     $result .= $middletext;
                    861:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    862:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   863:     
                    864:     my @secondorder = sort(keys(%select2));
                    865:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    866:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    867:     }
                    868:     foreach my $value (@secondorder) {
1.36      matthew   869:         $result.="    <option value=\"$value\" ";        
1.253     albertel  870:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       871:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   872:     }
                    873:     $result .= "</select>\n";
                    874:     #    return $debug;
                    875:     return $result;
                    876: }   #  end of sub linked_select_forms {
                    877: 
1.45      matthew   878: =pod
1.44      bowersj2  879: 
1.648     raeburn   880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  881: 
1.112     bowersj2  882: Returns a string corresponding to an HTML link to the given help
                    883: $topic, where $topic corresponds to the name of a .tex file in
                    884: /home/httpd/html/adm/help/tex, with underscores replaced by
                    885: spaces. 
                    886: 
                    887: $text will optionally be linked to the same topic, allowing you to
                    888: link text in addition to the graphic. If you do not want to link
                    889: text, but wish to specify one of the later parameters, pass an
                    890: empty string. 
                    891: 
                    892: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    893: the link will not open a new window. If false, the link will open
                    894: a new window using Javascript. (Default is false.) 
                    895: 
                    896: $width and $height are optional numerical parameters that will
                    897: override the width and height of the popped up window, which may
                    898: be useful for certain help topics with big pictures included. 
1.44      bowersj2  899: 
                    900: =cut
                    901: 
                    902: sub help_open_topic {
1.48      bowersj2  903:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    904:     $text = "" if (not defined $text);
1.44      bowersj2  905:     $stayOnPage = 0 if (not defined $stayOnPage);
1.552     banghart  906:     if ($env{'browser.interface'} eq 'textual') {
1.79      www       907: 	$stayOnPage=1;
                    908:     }
1.44      bowersj2  909:     $width = 350 if (not defined $width);
                    910:     $height = 400 if (not defined $height);
                    911:     my $filename = $topic;
                    912:     $filename =~ s/ /_/g;
                    913: 
1.48      bowersj2  914:     my $template = "";
                    915:     my $link;
1.572     banghart  916:     
1.159     www       917:     $topic=~s/\W/\_/g;
1.44      bowersj2  918: 
1.572     banghart  919:     if (!$stayOnPage) {
1.72      bowersj2  920: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart  921:     } else {
1.48      bowersj2  922: 	$link = "/adm/help/${filename}.hlp";
                    923:     }
                    924: 
                    925:     # Add the text
1.572     banghart  926:     if ($text ne "") {
1.77      www       927: 	$template .= 
1.572     banghart  928:             "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho  929:             "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48      bowersj2  930:     }
                    931: 
                    932:     # Add the graphic
1.179     matthew   933:     my $title = &mt('Online Help');
1.667     raeburn   934:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48      bowersj2  935:     $template .= <<"ENDTEMPLATE";
1.436     albertel  936:  <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44      bowersj2  937: ENDTEMPLATE
1.705     tempelho  938:     if ($text ne '') { $template.='</td></tr></table>' };
1.44      bowersj2  939:     return $template;
                    940: 
1.106     bowersj2  941: }
                    942: 
                    943: # This is a quicky function for Latex cheatsheet editing, since it 
                    944: # appears in at least four places
                    945: sub helpLatexCheatsheet {
1.732     raeburn   946:     my ($topic,$text,$not_author) = @_;
                    947:     my $out;
1.106     bowersj2  948:     my $addOther = '';
1.732     raeburn   949:     if ($topic) {
                    950: 	$addOther = &Apache::loncommon::help_open_topic($topic,$text,
                    951: 						       undef, undef, 600).
1.106     bowersj2  952: 							   '</td><td>';
                    953:     }
1.732     raeburn   954:     $out = '<table><tr><td>'.
                    955: 	   $addOther .
                    956: 	   &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
                    957: 					       undef,undef,600).
                    958: 	   '</td><td>'.
                    959: 	   &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
                    960: 					       undef,undef,600).
                    961: 	   '</td>';
                    962:     unless ($not_author) {
                    963:         $out .= '<td>'.
                    964: 	        &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
                    965: 	                                            undef,undef,600).
                    966: 	        '</td>';
                    967:     }
                    968:     $out .= '</tr></table>';
                    969:     return $out;
1.172     www       970: }
                    971: 
1.430     albertel  972: sub general_help {
                    973:     my $helptopic='Student_Intro';
                    974:     if ($env{'request.role'}=~/^(ca|au)/) {
                    975: 	$helptopic='Authoring_Intro';
                    976:     } elsif ($env{'request.role'}=~/^cc/) {
                    977: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn   978:     } elsif ($env{'request.role'}=~/^dc/) {
                    979:         $helptopic='Domain_Coordination_Intro';
1.430     albertel  980:     }
                    981:     return $helptopic;
                    982: }
                    983: 
                    984: sub update_help_link {
                    985:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                    986:     my $origurl = $ENV{'REQUEST_URI'};
                    987:     $origurl=~s|^/~|/priv/|;
                    988:     my $timestamp = time;
                    989:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                    990:         $$datum = &escape($$datum);
                    991:     }
                    992: 
                    993:     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";
                    994:     my $output .= <<"ENDOUTPUT";
                    995: <script type="text/javascript">
                    996: banner_link = '$banner_link';
                    997: </script>
                    998: ENDOUTPUT
                    999:     return $output;
                   1000: }
                   1001: 
                   1002: # now just updates the help link and generates a blue icon
1.193     raeburn  1003: sub help_open_menu {
1.430     albertel 1004:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1005: 	= @_;    
1.430     albertel 1006:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1007:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1008:     # if environment.remote is on (using remote control UI)
1.572     banghart 1009:     if ($env{'browser.interface'} eq 'textual' ||
                   1010:     	$env{'environment.remote'} eq 'off' ) {
1.552     banghart 1011:         $stayOnPage=1;
1.430     albertel 1012:     }
                   1013:     my $output;
                   1014:     if ($component_help) {
                   1015: 	if (!$text) {
                   1016: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1017: 				       $width,$height);
                   1018: 	} else {
                   1019: 	    my $help_text;
                   1020: 	    $help_text=&unescape($topic);
                   1021: 	    $output='<table><tr><td>'.
                   1022: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1023: 				 $width,$height).'</td></tr></table>';
                   1024: 	}
                   1025:     }
                   1026:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1027:     return $output.$banner_link;
                   1028: }
                   1029: 
                   1030: sub top_nav_help {
                   1031:     my ($text) = @_;
1.436     albertel 1032:     $text = &mt($text);
1.572     banghart 1033:     my $stay_on_page = 
1.436     albertel 1034: 	($env{'browser.interface'}  eq 'textual' ||
                   1035: 	 $env{'environment.remote'} eq 'off' );
1.572     banghart 1036:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1037: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1038:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1039: 
1.201     raeburn  1040:     my $title = &mt('Get help');
1.436     albertel 1041: 
                   1042:     return <<"END";
                   1043: $banner_link
                   1044:  <a href="$link" title="$title">$text</a>
                   1045: END
                   1046: }
                   1047: 
                   1048: sub help_menu_js {
                   1049:     my ($text) = @_;
                   1050: 
                   1051:     my $stayOnPage = 
                   1052: 	($env{'browser.interface'}  eq 'textual' ||
                   1053: 	 $env{'environment.remote'} eq 'off' );
                   1054: 
                   1055:     my $width = 620;
                   1056:     my $height = 600;
1.430     albertel 1057:     my $helptopic=&general_help();
                   1058:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1059:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1060:     my $start_page =
                   1061:         &Apache::loncommon::start_page('Help Menu', undef,
                   1062: 				       {'frameset'    => 1,
                   1063: 					'js_ready'    => 1,
                   1064: 					'add_entries' => {
                   1065: 					    'border' => '0',
1.579     raeburn  1066: 					    'rows'   => "110,*",},});
1.331     albertel 1067:     my $end_page =
                   1068:         &Apache::loncommon::end_page({'frameset' => 1,
                   1069: 				      'js_ready' => 1,});
                   1070: 
1.436     albertel 1071:     my $template .= <<"ENDTEMPLATE";
                   1072: <script type="text/javascript">
1.253     albertel 1073: // <!-- BEGIN LON-CAPA Internal
                   1074: // <![CDATA[
1.430     albertel 1075: var banner_link = '';
1.243     raeburn  1076: function helpMenu(target) {
                   1077:     var caller = this;
                   1078:     if (target == 'open') {
                   1079:         var newWindow = null;
                   1080:         try {
1.262     albertel 1081:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1082:         }
                   1083:         catch(error) {
                   1084:             writeHelp(caller);
                   1085:             return;
                   1086:         }
                   1087:         if (newWindow) {
                   1088:             caller = newWindow;
                   1089:         }
1.193     raeburn  1090:     }
1.243     raeburn  1091:     writeHelp(caller);
                   1092:     return;
                   1093: }
                   1094: function writeHelp(caller) {
1.430     albertel 1095:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1096:     caller.document.close()
                   1097:     caller.focus()
1.193     raeburn  1098: }
1.253     albertel 1099: // ]]>
1.219     albertel 1100: // END LON-CAPA Internal -->
1.436     albertel 1101: </script>
1.193     raeburn  1102: ENDTEMPLATE
                   1103:     return $template;
                   1104: }
                   1105: 
1.172     www      1106: sub help_open_bug {
                   1107:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1108:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1109:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1110:     $text = "" if (not defined $text);
                   1111:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel 1112:     if ($env{'browser.interface'} eq 'textual' ||
                   1113: 	$env{'environment.remote'} eq 'off' ) {
1.172     www      1114: 	$stayOnPage=1;
                   1115:     }
1.184     albertel 1116:     $width = 600 if (not defined $width);
                   1117:     $height = 600 if (not defined $height);
1.172     www      1118: 
                   1119:     $topic=~s/\W+/\+/g;
                   1120:     my $link='';
                   1121:     my $template='';
1.379     albertel 1122:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1123: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1124:     if (!$stayOnPage)
                   1125:     {
                   1126: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1127:     }
                   1128:     else
                   1129:     {
                   1130: 	$link = $url;
                   1131:     }
                   1132:     # Add the text
                   1133:     if ($text ne "")
                   1134:     {
                   1135: 	$template .= 
                   1136:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1137:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1138:     }
                   1139: 
                   1140:     # Add the graphic
1.179     matthew  1141:     my $title = &mt('Report a Bug');
1.215     albertel 1142:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1143:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1144:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1145: ENDTEMPLATE
                   1146:     if ($text ne '') { $template.='</td></tr></table>' };
                   1147:     return $template;
                   1148: 
                   1149: }
                   1150: 
                   1151: sub help_open_faq {
                   1152:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1153:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1154:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1155:     $text = "" if (not defined $text);
                   1156:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel 1157:     if ($env{'browser.interface'} eq 'textual' ||
                   1158: 	$env{'environment.remote'} eq 'off' ) {
1.172     www      1159: 	$stayOnPage=1;
                   1160:     }
                   1161:     $width = 350 if (not defined $width);
                   1162:     $height = 400 if (not defined $height);
                   1163: 
                   1164:     $topic=~s/\W+/\+/g;
                   1165:     my $link='';
                   1166:     my $template='';
                   1167:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1168:     if (!$stayOnPage)
                   1169:     {
                   1170: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1171:     }
                   1172:     else
                   1173:     {
                   1174: 	$link = $url;
                   1175:     }
                   1176: 
                   1177:     # Add the text
                   1178:     if ($text ne "")
                   1179:     {
                   1180: 	$template .= 
1.173     www      1181:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1182:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1183:     }
                   1184: 
                   1185:     # Add the graphic
1.179     matthew  1186:     my $title = &mt('View the FAQ');
1.215     albertel 1187:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1188:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1189:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1190: ENDTEMPLATE
                   1191:     if ($text ne '') { $template.='</td></tr></table>' };
                   1192:     return $template;
                   1193: 
1.44      bowersj2 1194: }
1.37      matthew  1195: 
1.180     matthew  1196: ###############################################################
                   1197: ###############################################################
                   1198: 
1.45      matthew  1199: =pod
                   1200: 
1.648     raeburn  1201: =item * &change_content_javascript():
1.256     matthew  1202: 
                   1203: This and the next function allow you to create small sections of an
                   1204: otherwise static HTML page that you can update on the fly with
                   1205: Javascript, even in Netscape 4.
                   1206: 
                   1207: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1208: must be written to the HTML page once. It will prove the Javascript
                   1209: function "change(name, content)". Calling the change function with the
                   1210: name of the section 
                   1211: you want to update, matching the name passed to C<changable_area>, and
                   1212: the new content you want to put in there, will put the content into
                   1213: that area.
                   1214: 
                   1215: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1216: to contain room for the original contents. You need to "make space"
                   1217: for whatever changes you wish to make, and be B<sure> to check your
                   1218: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1219: it's adequate for updating a one-line status display, but little more.
                   1220: This script will set the space to 100% width, so you only need to
                   1221: worry about height in Netscape 4.
                   1222: 
                   1223: Modern browsers are much less limiting, and if you can commit to the
                   1224: user not using Netscape 4, this feature may be used freely with
                   1225: pretty much any HTML.
                   1226: 
                   1227: =cut
                   1228: 
                   1229: sub change_content_javascript {
                   1230:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1231:     if ($env{'browser.type'} eq 'netscape' &&
                   1232: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1233: 	return (<<NETSCAPE4);
                   1234: 	function change(name, content) {
                   1235: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1236: 	    doc.open();
                   1237: 	    doc.write(content);
                   1238: 	    doc.close();
                   1239: 	}
                   1240: NETSCAPE4
                   1241:     } else {
                   1242: 	# Otherwise, we need to use semi-standards-compliant code
                   1243: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1244: 	# is really scary, and every useful browser supports it
                   1245: 	return (<<DOMBASED);
                   1246: 	function change(name, content) {
                   1247: 	    element = document.getElementById(name);
                   1248: 	    element.innerHTML = content;
                   1249: 	}
                   1250: DOMBASED
                   1251:     }
                   1252: }
                   1253: 
                   1254: =pod
                   1255: 
1.648     raeburn  1256: =item * &changable_area($name,$origContent):
1.256     matthew  1257: 
                   1258: This provides a "changable area" that can be modified on the fly via
                   1259: the Javascript code provided in C<change_content_javascript>. $name is
                   1260: the name you will use to reference the area later; do not repeat the
                   1261: same name on a given HTML page more then once. $origContent is what
                   1262: the area will originally contain, which can be left blank.
                   1263: 
                   1264: =cut
                   1265: 
                   1266: sub changable_area {
                   1267:     my ($name, $origContent) = @_;
                   1268: 
1.258     albertel 1269:     if ($env{'browser.type'} eq 'netscape' &&
                   1270: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1271: 	# If this is netscape 4, we need to use the Layer tag
                   1272: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1273:     } else {
                   1274: 	return "<span id='$name'>$origContent</span>";
                   1275:     }
                   1276: }
                   1277: 
                   1278: =pod
                   1279: 
1.648     raeburn  1280: =item * &viewport_geometry_js 
1.590     raeburn  1281: 
                   1282: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1283: 
                   1284: =cut
                   1285: 
                   1286: 
                   1287: sub viewport_geometry_js { 
                   1288:     return <<"GEOMETRY";
                   1289: var Geometry = {};
                   1290: function init_geometry() {
                   1291:     if (Geometry.init) { return };
                   1292:     Geometry.init=1;
                   1293:     if (window.innerHeight) {
                   1294:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1295:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1296:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1297:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1298:     }
                   1299:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1300:         Geometry.getViewportHeight =
                   1301:             function() { return document.documentElement.clientHeight; };
                   1302:         Geometry.getViewportWidth =
                   1303:             function() { return document.documentElement.clientWidth; };
                   1304: 
                   1305:         Geometry.getHorizontalScroll =
                   1306:             function() { return document.documentElement.scrollLeft; };
                   1307:         Geometry.getVerticalScroll =
                   1308:             function() { return document.documentElement.scrollTop; };
                   1309:     }
                   1310:     else if (document.body.clientHeight) {
                   1311:         Geometry.getViewportHeight =
                   1312:             function() { return document.body.clientHeight; };
                   1313:         Geometry.getViewportWidth =
                   1314:             function() { return document.body.clientWidth; };
                   1315:         Geometry.getHorizontalScroll =
                   1316:             function() { return document.body.scrollLeft; };
                   1317:         Geometry.getVerticalScroll =
                   1318:             function() { return document.body.scrollTop; };
                   1319:     }
                   1320: }
                   1321: 
                   1322: GEOMETRY
                   1323: }
                   1324: 
                   1325: =pod
                   1326: 
1.648     raeburn  1327: =item * &viewport_size_js()
1.590     raeburn  1328: 
                   1329: 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. 
                   1330: 
                   1331: =cut
                   1332: 
                   1333: sub viewport_size_js {
                   1334:     my $geometry = &viewport_geometry_js();
                   1335:     return <<"DIMS";
                   1336: 
                   1337: $geometry
                   1338: 
                   1339: function getViewportDims(width,height) {
                   1340:     init_geometry();
                   1341:     width.value = Geometry.getViewportWidth();
                   1342:     height.value = Geometry.getViewportHeight();
                   1343:     return;
                   1344: }
                   1345: 
                   1346: DIMS
                   1347: }
                   1348: 
                   1349: =pod
                   1350: 
1.648     raeburn  1351: =item * &resize_textarea_js()
1.565     albertel 1352: 
                   1353: emits the needed javascript to resize a textarea to be as big as possible
                   1354: 
                   1355: creates a function resize_textrea that takes two IDs first should be
                   1356: the id of the element to resize, second should be the id of a div that
                   1357: surrounds everything that comes after the textarea, this routine needs
                   1358: to be attached to the <body> for the onload and onresize events.
                   1359: 
1.648     raeburn  1360: =back
1.565     albertel 1361: 
                   1362: =cut
                   1363: 
                   1364: sub resize_textarea_js {
1.590     raeburn  1365:     my $geometry = &viewport_geometry_js();
1.565     albertel 1366:     return <<"RESIZE";
                   1367:     <script type="text/javascript">
1.590     raeburn  1368: $geometry
1.565     albertel 1369: 
1.588     albertel 1370: function getX(element) {
                   1371:     var x = 0;
                   1372:     while (element) {
                   1373: 	x += element.offsetLeft;
                   1374: 	element = element.offsetParent;
                   1375:     }
                   1376:     return x;
                   1377: }
                   1378: function getY(element) {
                   1379:     var y = 0;
                   1380:     while (element) {
                   1381: 	y += element.offsetTop;
                   1382: 	element = element.offsetParent;
                   1383:     }
                   1384:     return y;
                   1385: }
                   1386: 
                   1387: 
1.565     albertel 1388: function resize_textarea(textarea_id,bottom_id) {
                   1389:     init_geometry();
                   1390:     var textarea        = document.getElementById(textarea_id);
                   1391:     //alert(textarea);
                   1392: 
1.588     albertel 1393:     var textarea_top    = getY(textarea);
1.565     albertel 1394:     var textarea_height = textarea.offsetHeight;
                   1395:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1396:     var bottom_top      = getY(bottom);
1.565     albertel 1397:     var bottom_height   = bottom.offsetHeight;
                   1398:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1399:     var fudge           = 23;
1.565     albertel 1400:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1401:     if (new_height < 300) {
                   1402: 	new_height = 300;
                   1403:     }
                   1404:     textarea.style.height=new_height+'px';
                   1405: }
                   1406: </script>
                   1407: RESIZE
                   1408: 
                   1409: }
                   1410: 
                   1411: =pod
                   1412: 
1.256     matthew  1413: =head1 Excel and CSV file utility routines
                   1414: 
                   1415: =over 4
                   1416: 
                   1417: =cut
                   1418: 
                   1419: ###############################################################
                   1420: ###############################################################
                   1421: 
                   1422: =pod
                   1423: 
1.648     raeburn  1424: =item * &csv_translate($text) 
1.37      matthew  1425: 
1.185     www      1426: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1427: format.
                   1428: 
                   1429: =cut
                   1430: 
1.180     matthew  1431: ###############################################################
                   1432: ###############################################################
1.37      matthew  1433: sub csv_translate {
                   1434:     my $text = shift;
                   1435:     $text =~ s/\"/\"\"/g;
1.209     albertel 1436:     $text =~ s/\n/ /g;
1.37      matthew  1437:     return $text;
                   1438: }
1.180     matthew  1439: 
                   1440: ###############################################################
                   1441: ###############################################################
                   1442: 
                   1443: =pod
                   1444: 
1.648     raeburn  1445: =item * &define_excel_formats()
1.180     matthew  1446: 
                   1447: Define some commonly used Excel cell formats.
                   1448: 
                   1449: Currently supported formats:
                   1450: 
                   1451: =over 4
                   1452: 
                   1453: =item header
                   1454: 
                   1455: =item bold
                   1456: 
                   1457: =item h1
                   1458: 
                   1459: =item h2
                   1460: 
                   1461: =item h3
                   1462: 
1.256     matthew  1463: =item h4
                   1464: 
                   1465: =item i
                   1466: 
1.180     matthew  1467: =item date
                   1468: 
                   1469: =back
                   1470: 
                   1471: Inputs: $workbook
                   1472: 
                   1473: Returns: $format, a hash reference.
                   1474: 
                   1475: =cut
                   1476: 
                   1477: ###############################################################
                   1478: ###############################################################
                   1479: sub define_excel_formats {
                   1480:     my ($workbook) = @_;
                   1481:     my $format;
                   1482:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1483:                                                 bottom    => 1,
                   1484:                                                 align     => 'center');
                   1485:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1486:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1487:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1488:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1489:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1490:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1491:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1492:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1493:     return $format;
                   1494: }
                   1495: 
                   1496: ###############################################################
                   1497: ###############################################################
1.113     bowersj2 1498: 
                   1499: =pod
                   1500: 
1.648     raeburn  1501: =item * &create_workbook()
1.255     matthew  1502: 
                   1503: Create an Excel worksheet.  If it fails, output message on the
                   1504: request object and return undefs.
                   1505: 
                   1506: Inputs: Apache request object
                   1507: 
                   1508: Returns (undef) on failure, 
                   1509:     Excel worksheet object, scalar with filename, and formats 
                   1510:     from &Apache::loncommon::define_excel_formats on success
                   1511: 
                   1512: =cut
                   1513: 
                   1514: ###############################################################
                   1515: ###############################################################
                   1516: sub create_workbook {
                   1517:     my ($r) = @_;
                   1518:         #
                   1519:     # Create the excel spreadsheet
                   1520:     my $filename = '/prtspool/'.
1.258     albertel 1521:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1522:         time.'_'.rand(1000000000).'.xls';
                   1523:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1524:     if (! defined($workbook)) {
                   1525:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1526:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1527:                             "This error has been logged.  ".
                   1528:                             "Please alert your LON-CAPA administrator").
                   1529:                   '</p>');
                   1530:         return (undef);
                   1531:     }
                   1532:     #
                   1533:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1534:     #
                   1535:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1536:     return ($workbook,$filename,$format);
                   1537: }
                   1538: 
                   1539: ###############################################################
                   1540: ###############################################################
                   1541: 
                   1542: =pod
                   1543: 
1.648     raeburn  1544: =item * &create_text_file()
1.113     bowersj2 1545: 
1.542     raeburn  1546: Create a file to write to and eventually make available to the user.
1.256     matthew  1547: If file creation fails, outputs an error message on the request object and 
                   1548: return undefs.
1.113     bowersj2 1549: 
1.256     matthew  1550: Inputs: Apache request object, and file suffix
1.113     bowersj2 1551: 
1.256     matthew  1552: Returns (undef) on failure, 
                   1553:     Filehandle and filename on success.
1.113     bowersj2 1554: 
                   1555: =cut
                   1556: 
1.256     matthew  1557: ###############################################################
                   1558: ###############################################################
                   1559: sub create_text_file {
                   1560:     my ($r,$suffix) = @_;
                   1561:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1562:     my $fh;
                   1563:     my $filename = '/prtspool/'.
1.258     albertel 1564:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1565:         time.'_'.rand(1000000000).'.'.$suffix;
                   1566:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1567:     if (! defined($fh)) {
                   1568:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1569:         $r->print(&mt('Problems occurred in creating the output file. '
                   1570:                      .'This error has been logged. '
                   1571:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1572:     }
1.256     matthew  1573:     return ($fh,$filename)
1.113     bowersj2 1574: }
                   1575: 
                   1576: 
1.256     matthew  1577: =pod 
1.113     bowersj2 1578: 
                   1579: =back
                   1580: 
                   1581: =cut
1.37      matthew  1582: 
                   1583: ###############################################################
1.33      matthew  1584: ##        Home server <option> list generating code          ##
                   1585: ###############################################################
1.35      matthew  1586: 
1.169     www      1587: # ------------------------------------------
                   1588: 
                   1589: sub domain_select {
                   1590:     my ($name,$value,$multiple)=@_;
                   1591:     my %domains=map { 
1.514     albertel 1592: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1593:     } &Apache::lonnet::all_domains();
1.169     www      1594:     if ($multiple) {
                   1595: 	$domains{''}=&mt('Any domain');
1.550     albertel 1596: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1597: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1598:     } else {
1.550     albertel 1599: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1600: 	return &select_form($name,$value,%domains);
                   1601:     }
                   1602: }
                   1603: 
1.282     albertel 1604: #-------------------------------------------
                   1605: 
                   1606: =pod
                   1607: 
1.519     raeburn  1608: =head1 Routines for form select boxes
                   1609: 
                   1610: =over 4
                   1611: 
1.648     raeburn  1612: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1613: 
                   1614: Returns a string containing a <select> element int multiple mode
                   1615: 
                   1616: 
                   1617: Args:
                   1618:   $name - name of the <select> element
1.506     raeburn  1619:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1620:   $size - number of rows long the select element is
1.283     albertel 1621:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1622:           (shown text should already have been &mt())
1.506     raeburn  1623:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1624: 
1.282     albertel 1625: =cut
                   1626: 
                   1627: #-------------------------------------------
1.169     www      1628: sub multiple_select_form {
1.284     albertel 1629:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1630:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1631:     my $output='';
1.191     matthew  1632:     if (! defined($size)) {
                   1633:         $size = 4;
1.283     albertel 1634:         if (scalar(keys(%$hash))<4) {
                   1635:             $size = scalar(keys(%$hash));
1.191     matthew  1636:         }
                   1637:     }
1.734     bisitz   1638:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1639:     my @order;
1.506     raeburn  1640:     if (ref($order) eq 'ARRAY')  {
                   1641:         @order = @{$order};
                   1642:     } else {
                   1643:         @order = sort(keys(%$hash));
1.501     banghart 1644:     }
                   1645:     if (exists($$hash{'select_form_order'})) {
                   1646:         @order = @{$$hash{'select_form_order'}};
                   1647:     }
                   1648:         
1.284     albertel 1649:     foreach my $key (@order) {
1.356     albertel 1650:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1651:         $output.='selected="selected" ' if ($selected{$key});
                   1652:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1653:     }
                   1654:     $output.="</select>\n";
                   1655:     return $output;
                   1656: }
                   1657: 
1.88      www      1658: #-------------------------------------------
                   1659: 
                   1660: =pod
                   1661: 
1.648     raeburn  1662: =item * &select_form($defdom,$name,%hash)
1.88      www      1663: 
                   1664: Returns a string containing a <select name='$name' size='1'> form to 
                   1665: allow a user to select options from a hash option_name => displayed text.  
                   1666: See lonrights.pm for an example invocation and use.
                   1667: 
                   1668: =cut
                   1669: 
                   1670: #-------------------------------------------
                   1671: sub select_form {
                   1672:     my ($def,$name,%hash) = @_;
                   1673:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1674:     my @keys;
                   1675:     if (exists($hash{'select_form_order'})) {
                   1676: 	@keys=@{$hash{'select_form_order'}};
                   1677:     } else {
                   1678: 	@keys=sort(keys(%hash));
                   1679:     }
1.356     albertel 1680:     foreach my $key (@keys) {
                   1681:         $selectform.=
                   1682: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1683:             ($key eq $def ? 'selected="selected" ' : '').
                   1684:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1685:     }
                   1686:     $selectform.="</select>";
                   1687:     return $selectform;
                   1688: }
                   1689: 
1.475     www      1690: # For display filters
                   1691: 
                   1692: sub display_filter {
                   1693:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1694:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1695:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1696: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1697: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1698: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1699:            &mt('Filter [_1]',
1.477     www      1700: 	   &select_form($env{'form.displayfilter'},
                   1701: 			'displayfilter',
                   1702: 			('currentfolder' => 'Current folder/page',
                   1703: 			 'containing' => 'Containing phrase',
                   1704: 			 'none' => 'None'))).
1.714     bisitz   1705: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1706: }
                   1707: 
1.167     www      1708: sub gradeleveldescription {
                   1709:     my $gradelevel=shift;
                   1710:     my %gradelevels=(0 => 'Not specified',
                   1711: 		     1 => 'Grade 1',
                   1712: 		     2 => 'Grade 2',
                   1713: 		     3 => 'Grade 3',
                   1714: 		     4 => 'Grade 4',
                   1715: 		     5 => 'Grade 5',
                   1716: 		     6 => 'Grade 6',
                   1717: 		     7 => 'Grade 7',
                   1718: 		     8 => 'Grade 8',
                   1719: 		     9 => 'Grade 9',
                   1720: 		     10 => 'Grade 10',
                   1721: 		     11 => 'Grade 11',
                   1722: 		     12 => 'Grade 12',
                   1723: 		     13 => 'Grade 13',
                   1724: 		     14 => '100 Level',
                   1725: 		     15 => '200 Level',
                   1726: 		     16 => '300 Level',
                   1727: 		     17 => '400 Level',
                   1728: 		     18 => 'Graduate Level');
                   1729:     return &mt($gradelevels{$gradelevel});
                   1730: }
                   1731: 
1.163     www      1732: sub select_level_form {
                   1733:     my ($deflevel,$name)=@_;
                   1734:     unless ($deflevel) { $deflevel=0; }
1.167     www      1735:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1736:     for (my $i=0; $i<=18; $i++) {
                   1737:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1738:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1739:                 ">".&gradeleveldescription($i)."</option>\n";
                   1740:     }
                   1741:     $selectform.="</select>";
                   1742:     return $selectform;
1.163     www      1743: }
1.167     www      1744: 
1.35      matthew  1745: #-------------------------------------------
                   1746: 
1.45      matthew  1747: =pod
                   1748: 
1.743     raeburn  1749: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35      matthew  1750: 
                   1751: Returns a string containing a <select name='$name' size='1'> form to 
                   1752: allow a user to select the domain to preform an operation in.  
                   1753: See loncreateuser.pm for an example invocation and use.
                   1754: 
1.90      www      1755: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1756: selected");
                   1757: 
1.743     raeburn  1758: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1759: 
                   1760: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
1.563     raeburn  1761: 
1.35      matthew  1762: =cut
                   1763: 
                   1764: #-------------------------------------------
1.34      matthew  1765: sub select_dom_form {
1.743     raeburn  1766:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
                   1767:     my $onchange;
                   1768:     if ($autosubmit) {
                   1769:         $onchange = ' onchange="this.form.submit()"';
                   1770:     }
1.550     albertel 1771:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1772:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1773:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1774:     foreach my $dom (@domains) {
                   1775:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1776:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1777:         if ($showdomdesc) {
                   1778:             if ($dom ne '') {
                   1779:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1780:                 if ($domdesc ne '') {
                   1781:                     $selectdomain .= ' ('.$domdesc.')';
                   1782:                 }
                   1783:             } 
                   1784:         }
                   1785:         $selectdomain .= "</option>\n";
1.34      matthew  1786:     }
                   1787:     $selectdomain.="</select>";
                   1788:     return $selectdomain;
                   1789: }
                   1790: 
1.35      matthew  1791: #-------------------------------------------
                   1792: 
1.45      matthew  1793: =pod
                   1794: 
1.648     raeburn  1795: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1796: 
1.586     raeburn  1797: input: 4 arguments (two required, two optional) - 
                   1798:     $domain - domain of new user
                   1799:     $name - name of form element
                   1800:     $default - Value of 'default' causes a default item to be first 
                   1801:                             option, and selected by default. 
                   1802:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1803:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1804: output: returns 2 items: 
1.586     raeburn  1805: (a) form element which contains either:
                   1806:    (i) <select name="$name">
                   1807:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1808:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1809:        </select>
                   1810:        form item if there are multiple library servers in $domain, or
                   1811:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1812:        if there is only one library server in $domain.
                   1813: 
                   1814: (b) number of library servers found.
                   1815: 
                   1816: See loncreateuser.pm for example of use.
1.35      matthew  1817: 
                   1818: =cut
                   1819: 
                   1820: #-------------------------------------------
1.586     raeburn  1821: sub home_server_form_item {
                   1822:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1823:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1824:     my $result;
                   1825:     my $numlib = keys(%servers);
                   1826:     if ($numlib > 1) {
                   1827:         $result .= '<select name="'.$name.'" />'."\n";
                   1828:         if ($default) {
                   1829:             $result .= '<option value="default" selected>'.&mt('default').
                   1830:                        '</option>'."\n";
                   1831:         }
                   1832:         foreach my $hostid (sort(keys(%servers))) {
                   1833:             $result.= '<option value="'.$hostid.'">'.
                   1834: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1835:         }
                   1836:         $result .= '</select>'."\n";
                   1837:     } elsif ($numlib == 1) {
                   1838:         my $hostid;
                   1839:         foreach my $item (keys(%servers)) {
                   1840:             $hostid = $item;
                   1841:         }
                   1842:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1843:                    $hostid.'" />';
                   1844:                    if (!$hide) {
                   1845:                        $result .= $hostid.' '.$servers{$hostid};
                   1846:                    }
                   1847:                    $result .= "\n";
                   1848:     } elsif ($default) {
                   1849:         $result .= '<input type="hidden" name="'.$name.
                   1850:                    '" value="default" />';
                   1851:                    if (!$hide) {
                   1852:                        $result .= &mt('default');
                   1853:                    }
                   1854:                    $result .= "\n";
1.33      matthew  1855:     }
1.586     raeburn  1856:     return ($result,$numlib);
1.33      matthew  1857: }
1.112     bowersj2 1858: 
                   1859: =pod
                   1860: 
1.534     albertel 1861: =back 
                   1862: 
1.112     bowersj2 1863: =cut
1.87      matthew  1864: 
                   1865: ###############################################################
1.112     bowersj2 1866: ##                  Decoding User Agent                      ##
1.87      matthew  1867: ###############################################################
                   1868: 
                   1869: =pod
                   1870: 
1.112     bowersj2 1871: =head1 Decoding the User Agent
                   1872: 
                   1873: =over 4
                   1874: 
                   1875: =item * &decode_user_agent()
1.87      matthew  1876: 
                   1877: Inputs: $r
                   1878: 
                   1879: Outputs:
                   1880: 
                   1881: =over 4
                   1882: 
1.112     bowersj2 1883: =item * $httpbrowser
1.87      matthew  1884: 
1.112     bowersj2 1885: =item * $clientbrowser
1.87      matthew  1886: 
1.112     bowersj2 1887: =item * $clientversion
1.87      matthew  1888: 
1.112     bowersj2 1889: =item * $clientmathml
1.87      matthew  1890: 
1.112     bowersj2 1891: =item * $clientunicode
1.87      matthew  1892: 
1.112     bowersj2 1893: =item * $clientos
1.87      matthew  1894: 
                   1895: =back
                   1896: 
1.157     matthew  1897: =back 
                   1898: 
1.87      matthew  1899: =cut
                   1900: 
                   1901: ###############################################################
                   1902: ###############################################################
                   1903: sub decode_user_agent {
1.247     albertel 1904:     my ($r)=@_;
1.87      matthew  1905:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1906:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1907:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1908:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1909:     my $clientbrowser='unknown';
                   1910:     my $clientversion='0';
                   1911:     my $clientmathml='';
                   1912:     my $clientunicode='0';
                   1913:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1914:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1915: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1916: 	    $clientbrowser=$bname;
                   1917:             $httpbrowser=~/$vreg/i;
                   1918: 	    $clientversion=$1;
                   1919:             $clientmathml=($clientversion>=$minv);
                   1920:             $clientunicode=($clientversion>=$univ);
                   1921: 	}
                   1922:     }
                   1923:     my $clientos='unknown';
                   1924:     if (($httpbrowser=~/linux/i) ||
                   1925:         ($httpbrowser=~/unix/i) ||
                   1926:         ($httpbrowser=~/ux/i) ||
                   1927:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1928:     if (($httpbrowser=~/vax/i) ||
                   1929:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1930:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1931:     if (($httpbrowser=~/mac/i) ||
                   1932:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1933:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1934:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1935:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1936:             $clientunicode,$clientos,);
                   1937: }
                   1938: 
1.32      matthew  1939: ###############################################################
                   1940: ##    Authentication changing form generation subroutines    ##
                   1941: ###############################################################
                   1942: ##
                   1943: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1944: ## hash, and have reasonable default values.
                   1945: ##
                   1946: ##    formname = the name given in the <form> tag.
1.35      matthew  1947: #-------------------------------------------
                   1948: 
1.45      matthew  1949: =pod
                   1950: 
1.112     bowersj2 1951: =head1 Authentication Routines
                   1952: 
                   1953: =over 4
                   1954: 
1.648     raeburn  1955: =item * &authform_xxxxxx()
1.35      matthew  1956: 
                   1957: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1958: handle some of the conveniences required for authentication forms.  
                   1959: This is not an optimal method, but it works.  
                   1960: 
                   1961: =over 4
                   1962: 
1.112     bowersj2 1963: =item * authform_header
1.35      matthew  1964: 
1.112     bowersj2 1965: =item * authform_authorwarning
1.35      matthew  1966: 
1.112     bowersj2 1967: =item * authform_nochange
1.35      matthew  1968: 
1.112     bowersj2 1969: =item * authform_kerberos
1.35      matthew  1970: 
1.112     bowersj2 1971: =item * authform_internal
1.35      matthew  1972: 
1.112     bowersj2 1973: =item * authform_filesystem
1.35      matthew  1974: 
                   1975: =back
                   1976: 
1.648     raeburn  1977: See loncreateuser.pm for invocation and use examples.
1.157     matthew  1978: 
1.35      matthew  1979: =cut
                   1980: 
                   1981: #-------------------------------------------
1.32      matthew  1982: sub authform_header{  
                   1983:     my %in = (
                   1984:         formname => 'cu',
1.80      albertel 1985:         kerb_def_dom => '',
1.32      matthew  1986:         @_,
                   1987:     );
                   1988:     $in{'formname'} = 'document.' . $in{'formname'};
                   1989:     my $result='';
1.80      albertel 1990: 
                   1991: #---------------------------------------------- Code for upper case translation
                   1992:     my $Javascript_toUpperCase;
                   1993:     unless ($in{kerb_def_dom}) {
                   1994:         $Javascript_toUpperCase =<<"END";
                   1995:         switch (choice) {
                   1996:            case 'krb': currentform.elements[choicearg].value =
                   1997:                currentform.elements[choicearg].value.toUpperCase();
                   1998:                break;
                   1999:            default:
                   2000:         }
                   2001: END
                   2002:     } else {
                   2003:         $Javascript_toUpperCase = "";
                   2004:     }
                   2005: 
1.165     raeburn  2006:     my $radioval = "'nochange'";
1.591     raeburn  2007:     if (defined($in{'curr_authtype'})) {
                   2008:         if ($in{'curr_authtype'} ne '') {
                   2009:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2010:         }
1.174     matthew  2011:     }
1.165     raeburn  2012:     my $argfield = 'null';
1.591     raeburn  2013:     if (defined($in{'mode'})) {
1.165     raeburn  2014:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2015:             if (defined($in{'curr_autharg'})) {
                   2016:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2017:                     $argfield = "'$in{'curr_autharg'}'";
                   2018:                 }
                   2019:             }
                   2020:         }
                   2021:     }
                   2022: 
1.32      matthew  2023:     $result.=<<"END";
                   2024: var current = new Object();
1.165     raeburn  2025: current.radiovalue = $radioval;
                   2026: current.argfield = $argfield;
1.32      matthew  2027: 
                   2028: function changed_radio(choice,currentform) {
                   2029:     var choicearg = choice + 'arg';
                   2030:     // If a radio button in changed, we need to change the argfield
                   2031:     if (current.radiovalue != choice) {
                   2032:         current.radiovalue = choice;
                   2033:         if (current.argfield != null) {
                   2034:             currentform.elements[current.argfield].value = '';
                   2035:         }
                   2036:         if (choice == 'nochange') {
                   2037:             current.argfield = null;
                   2038:         } else {
                   2039:             current.argfield = choicearg;
                   2040:             switch(choice) {
                   2041:                 case 'krb': 
                   2042:                     currentform.elements[current.argfield].value = 
                   2043:                         "$in{'kerb_def_dom'}";
                   2044:                 break;
                   2045:               default:
                   2046:                 break;
                   2047:             }
                   2048:         }
                   2049:     }
                   2050:     return;
                   2051: }
1.22      www      2052: 
1.32      matthew  2053: function changed_text(choice,currentform) {
                   2054:     var choicearg = choice + 'arg';
                   2055:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2056:         $Javascript_toUpperCase
1.32      matthew  2057:         // clear old field
                   2058:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2059:             currentform.elements[current.argfield].value = '';
                   2060:         }
                   2061:         current.argfield = choicearg;
                   2062:     }
                   2063:     set_auth_radio_buttons(choice,currentform);
                   2064:     return;
1.20      www      2065: }
1.32      matthew  2066: 
                   2067: function set_auth_radio_buttons(newvalue,currentform) {
                   2068:     var i=0;
                   2069:     while (i < currentform.login.length) {
                   2070:         if (currentform.login[i].value == newvalue) { break; }
                   2071:         i++;
                   2072:     }
                   2073:     if (i == currentform.login.length) {
                   2074:         return;
                   2075:     }
                   2076:     current.radiovalue = newvalue;
                   2077:     currentform.login[i].checked = true;
                   2078:     return;
                   2079: }
                   2080: END
                   2081:     return $result;
                   2082: }
                   2083: 
                   2084: sub authform_authorwarning{
                   2085:     my $result='';
1.144     matthew  2086:     $result='<i>'.
                   2087:         &mt('As a general rule, only authors or co-authors should be '.
                   2088:             'filesystem authenticated '.
                   2089:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2090:     return $result;
                   2091: }
                   2092: 
                   2093: sub authform_nochange{  
                   2094:     my %in = (
                   2095:               formname => 'document.cu',
                   2096:               kerb_def_dom => 'MSU.EDU',
                   2097:               @_,
                   2098:           );
1.586     raeburn  2099:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2100:     my $result;
                   2101:     if (keys(%can_assign) == 0) {
                   2102:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2103:     } else {
                   2104:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2105:                   '<input type="radio" name="login" value="nochange" '.
                   2106:                   'checked="checked" onclick="'.
1.281     albertel 2107:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2108: 	    '</label>';
1.586     raeburn  2109:     }
1.32      matthew  2110:     return $result;
                   2111: }
                   2112: 
1.591     raeburn  2113: sub authform_kerberos {
1.32      matthew  2114:     my %in = (
                   2115:               formname => 'document.cu',
                   2116:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2117:               kerb_def_auth => 'krb4',
1.32      matthew  2118:               @_,
                   2119:               );
1.586     raeburn  2120:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2121:         $autharg,$jscall);
                   2122:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2123:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.586     raeburn  2124:        $check5 = ' checked="on"';
1.80      albertel 2125:     } else {
1.586     raeburn  2126:        $check4 = ' checked="on"';
1.80      albertel 2127:     }
1.165     raeburn  2128:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2129:     if (defined($in{'curr_authtype'})) {
                   2130:         if ($in{'curr_authtype'} eq 'krb') {
1.586     raeburn  2131:             $krbcheck = ' checked="on"';
1.623     raeburn  2132:             if (defined($in{'mode'})) {
                   2133:                 if ($in{'mode'} eq 'modifyuser') {
                   2134:                     $krbcheck = '';
                   2135:                 }
                   2136:             }
1.591     raeburn  2137:             if (defined($in{'curr_kerb_ver'})) {
                   2138:                 if ($in{'curr_krb_ver'} eq '5') {
                   2139:                     $check5 = ' checked="on"';
                   2140:                     $check4 = '';
                   2141:                 } else {
                   2142:                     $check4 = ' checked="on"';
                   2143:                     $check5 = '';
                   2144:                 }
1.586     raeburn  2145:             }
1.591     raeburn  2146:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2147:                 $krbarg = $in{'curr_autharg'};
                   2148:             }
1.586     raeburn  2149:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2150:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2151:                     $result = 
                   2152:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2153:         $in{'curr_autharg'},$krbver);
                   2154:                 } else {
                   2155:                     $result =
                   2156:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2157:                 }
                   2158:                 return $result; 
                   2159:             }
                   2160:         }
                   2161:     } else {
                   2162:         if ($authnum == 1) {
                   2163:             $authtype = '<input type="hidden" name="login" value="krb">';
1.165     raeburn  2164:         }
                   2165:     }
1.586     raeburn  2166:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2167:         return;
1.587     raeburn  2168:     } elsif ($authtype eq '') {
1.591     raeburn  2169:         if (defined($in{'mode'})) {
1.587     raeburn  2170:             if ($in{'mode'} eq 'modifycourse') {
                   2171:                 if ($authnum == 1) {
                   2172:                     $authtype = '<input type="hidden" name="login" value="krb">';
                   2173:                 }
                   2174:             }
                   2175:         }
1.586     raeburn  2176:     }
                   2177:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2178:     if ($authtype eq '') {
                   2179:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2180:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2181:                     $krbcheck.' />';
                   2182:     }
                   2183:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2184:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2185:          $in{'curr_authtype'} eq 'krb5') ||
                   2186:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2187:          $in{'curr_authtype'} eq 'krb4')) {
                   2188:         $result .= &mt
1.144     matthew  2189:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2190:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2191:          '<label>'.$authtype,
1.281     albertel 2192:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2193:              'value="'.$krbarg.'" '.
1.144     matthew  2194:              'onchange="'.$jscall.'" />',
1.281     albertel 2195:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2196:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2197: 	 '</label>');
1.586     raeburn  2198:     } elsif ($can_assign{'krb4'}) {
                   2199:         $result .= &mt
                   2200:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2201:          '[_3] Version 4 [_4]',
                   2202:          '<label>'.$authtype,
                   2203:          '</label><input type="text" size="10" name="krbarg" '.
                   2204:              'value="'.$krbarg.'" '.
                   2205:              'onchange="'.$jscall.'" />',
                   2206:          '<label><input type="hidden" name="krbver" value="4" />',
                   2207:          '</label>');
                   2208:     } elsif ($can_assign{'krb5'}) {
                   2209:         $result .= &mt
                   2210:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2211:          '[_3] Version 5 [_4]',
                   2212:          '<label>'.$authtype,
                   2213:          '</label><input type="text" size="10" name="krbarg" '.
                   2214:              'value="'.$krbarg.'" '.
                   2215:              'onchange="'.$jscall.'" />',
                   2216:          '<label><input type="hidden" name="krbver" value="5" />',
                   2217:          '</label>');
                   2218:     }
1.32      matthew  2219:     return $result;
                   2220: }
                   2221: 
                   2222: sub authform_internal{  
1.586     raeburn  2223:     my %in = (
1.32      matthew  2224:                 formname => 'document.cu',
                   2225:                 kerb_def_dom => 'MSU.EDU',
                   2226:                 @_,
                   2227:                 );
1.586     raeburn  2228:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2229:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2230:     if (defined($in{'curr_authtype'})) {
                   2231:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2232:             if ($can_assign{'int'}) {
                   2233:                 $intcheck = 'checked="on" ';
1.623     raeburn  2234:                 if (defined($in{'mode'})) {
                   2235:                     if ($in{'mode'} eq 'modifyuser') {
                   2236:                         $intcheck = '';
                   2237:                     }
                   2238:                 }
1.591     raeburn  2239:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2240:                     $intarg = $in{'curr_autharg'};
                   2241:                 }
                   2242:             } else {
                   2243:                 $result = &mt('Currently internally authenticated.');
                   2244:                 return $result;
1.165     raeburn  2245:             }
                   2246:         }
1.586     raeburn  2247:     } else {
                   2248:         if ($authnum == 1) {
                   2249:             $authtype = '<input type="hidden" name="login" value="int">';
                   2250:         }
                   2251:     }
                   2252:     if (!$can_assign{'int'}) {
                   2253:         return;
1.587     raeburn  2254:     } elsif ($authtype eq '') {
1.591     raeburn  2255:         if (defined($in{'mode'})) {
1.587     raeburn  2256:             if ($in{'mode'} eq 'modifycourse') {
                   2257:                 if ($authnum == 1) {
                   2258:                     $authtype = '<input type="hidden" name="login" value="int">';
                   2259:                 }
                   2260:             }
                   2261:         }
1.165     raeburn  2262:     }
1.586     raeburn  2263:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2264:     if ($authtype eq '') {
                   2265:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2266:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2267:     }
1.605     bisitz   2268:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2269:                $intarg.'" onchange="'.$jscall.'" />';
                   2270:     $result = &mt
1.144     matthew  2271:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2272:          '<label>'.$authtype,'</label>'.$autharg);
1.620     www      2273:     $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2274:     return $result;
                   2275: }
                   2276: 
                   2277: sub authform_local{  
                   2278:     my %in = (
                   2279:               formname => 'document.cu',
                   2280:               kerb_def_dom => 'MSU.EDU',
                   2281:               @_,
                   2282:               );
1.586     raeburn  2283:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2284:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2285:     if (defined($in{'curr_authtype'})) {
                   2286:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2287:             if ($can_assign{'loc'}) {
                   2288:                 $loccheck = 'checked="on" ';
1.623     raeburn  2289:                 if (defined($in{'mode'})) {
                   2290:                     if ($in{'mode'} eq 'modifyuser') {
                   2291:                         $loccheck = '';
                   2292:                     }
                   2293:                 }
1.591     raeburn  2294:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2295:                     $locarg = $in{'curr_autharg'};
                   2296:                 }
                   2297:             } else {
                   2298:                 $result = &mt('Currently using local (institutional) authentication.');
                   2299:                 return $result;
1.165     raeburn  2300:             }
                   2301:         }
1.586     raeburn  2302:     } else {
                   2303:         if ($authnum == 1) {
                   2304:             $authtype = '<input type="hidden" name="login" value="loc">';
                   2305:         }
                   2306:     }
                   2307:     if (!$can_assign{'loc'}) {
                   2308:         return;
1.587     raeburn  2309:     } elsif ($authtype eq '') {
1.591     raeburn  2310:         if (defined($in{'mode'})) {
1.587     raeburn  2311:             if ($in{'mode'} eq 'modifycourse') {
                   2312:                 if ($authnum == 1) {
                   2313:                     $authtype = '<input type="hidden" name="login" value="loc">';
                   2314:                 }
                   2315:             }
                   2316:         }
1.165     raeburn  2317:     }
1.586     raeburn  2318:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2319:     if ($authtype eq '') {
                   2320:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2321:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2322:                     $jscall.'" />';
                   2323:     }
                   2324:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2325:                $locarg.'" onchange="'.$jscall.'" />';
                   2326:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2327:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2328:     return $result;
                   2329: }
                   2330: 
                   2331: sub authform_filesystem{  
                   2332:     my %in = (
                   2333:               formname => 'document.cu',
                   2334:               kerb_def_dom => 'MSU.EDU',
                   2335:               @_,
                   2336:               );
1.586     raeburn  2337:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2338:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2339:     if (defined($in{'curr_authtype'})) {
                   2340:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2341:             if ($can_assign{'fsys'}) {
                   2342:                 $fsyscheck = 'checked="on" ';
1.623     raeburn  2343:                 if (defined($in{'mode'})) {
                   2344:                     if ($in{'mode'} eq 'modifyuser') {
                   2345:                         $fsyscheck = '';
                   2346:                     }
                   2347:                 }
1.586     raeburn  2348:             } else {
                   2349:                 $result = &mt('Currently Filesystem Authenticated.');
                   2350:                 return $result;
                   2351:             }           
                   2352:         }
                   2353:     } else {
                   2354:         if ($authnum == 1) {
                   2355:             $authtype = '<input type="hidden" name="login" value="fsys">';
                   2356:         }
                   2357:     }
                   2358:     if (!$can_assign{'fsys'}) {
                   2359:         return;
1.587     raeburn  2360:     } elsif ($authtype eq '') {
1.591     raeburn  2361:         if (defined($in{'mode'})) {
1.587     raeburn  2362:             if ($in{'mode'} eq 'modifycourse') {
                   2363:                 if ($authnum == 1) {
                   2364:                     $authtype = '<input type="hidden" name="login" value="fsys">';
                   2365:                 }
                   2366:             }
                   2367:         }
1.586     raeburn  2368:     }
                   2369:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2370:     if ($authtype eq '') {
                   2371:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2372:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2373:                     $jscall.'" />';
                   2374:     }
                   2375:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2376:                ' onchange="'.$jscall.'" />';
                   2377:     $result = &mt
1.144     matthew  2378:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2379:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2380:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2381:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2382:                   'onchange="'.$jscall.'" />');
1.32      matthew  2383:     return $result;
                   2384: }
                   2385: 
1.586     raeburn  2386: sub get_assignable_auth {
                   2387:     my ($dom) = @_;
                   2388:     if ($dom eq '') {
                   2389:         $dom = $env{'request.role.domain'};
                   2390:     }
                   2391:     my %can_assign = (
                   2392:                           krb4 => 1,
                   2393:                           krb5 => 1,
                   2394:                           int  => 1,
                   2395:                           loc  => 1,
                   2396:                      );
                   2397:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2398:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2399:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2400:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2401:             my $context;
                   2402:             if ($env{'request.role'} =~ /^au/) {
                   2403:                 $context = 'author';
                   2404:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2405:                 $context = 'domain';
                   2406:             } elsif ($env{'request.course.id'}) {
                   2407:                 $context = 'course';
                   2408:             }
                   2409:             if ($context) {
                   2410:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2411:                    %can_assign = %{$authhash->{$context}}; 
                   2412:                 }
                   2413:             }
                   2414:         }
                   2415:     }
                   2416:     my $authnum = 0;
                   2417:     foreach my $key (keys(%can_assign)) {
                   2418:         if ($can_assign{$key}) {
                   2419:             $authnum ++;
                   2420:         }
                   2421:     }
                   2422:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2423:         $authnum --;
                   2424:     }
                   2425:     return ($authnum,%can_assign);
                   2426: }
                   2427: 
1.80      albertel 2428: ###############################################################
                   2429: ##    Get Kerberos Defaults for Domain                 ##
                   2430: ###############################################################
                   2431: ##
                   2432: ## Returns default kerberos version and an associated argument
                   2433: ## as listed in file domain.tab. If not listed, provides
                   2434: ## appropriate default domain and kerberos version.
                   2435: ##
                   2436: #-------------------------------------------
                   2437: 
                   2438: =pod
                   2439: 
1.648     raeburn  2440: =item * &get_kerberos_defaults()
1.80      albertel 2441: 
                   2442: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2443: version and domain. If not found, it defaults to version 4 and the 
                   2444: domain of the server.
1.80      albertel 2445: 
1.648     raeburn  2446: =over 4
                   2447: 
1.80      albertel 2448: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2449: 
1.648     raeburn  2450: =back
                   2451: 
                   2452: =back
                   2453: 
1.80      albertel 2454: =cut
                   2455: 
                   2456: #-------------------------------------------
                   2457: sub get_kerberos_defaults {
                   2458:     my $domain=shift;
1.641     raeburn  2459:     my ($krbdef,$krbdefdom);
                   2460:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2461:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2462:         $krbdef = $domdefaults{'auth_def'};
                   2463:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2464:     } else {
1.80      albertel 2465:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2466:         my $krbdefdom=$1;
                   2467:         $krbdefdom=~tr/a-z/A-Z/;
                   2468:         $krbdef = "krb4";
                   2469:     }
                   2470:     return ($krbdef,$krbdefdom);
                   2471: }
1.112     bowersj2 2472: 
1.32      matthew  2473: 
1.46      matthew  2474: ###############################################################
                   2475: ##                Thesaurus Functions                        ##
                   2476: ###############################################################
1.20      www      2477: 
1.46      matthew  2478: =pod
1.20      www      2479: 
1.112     bowersj2 2480: =head1 Thesaurus Functions
                   2481: 
                   2482: =over 4
                   2483: 
1.648     raeburn  2484: =item * &initialize_keywords()
1.46      matthew  2485: 
                   2486: Initializes the package variable %Keywords if it is empty.  Uses the
                   2487: package variable $thesaurus_db_file.
                   2488: 
                   2489: =cut
                   2490: 
                   2491: ###################################################
                   2492: 
                   2493: sub initialize_keywords {
                   2494:     return 1 if (scalar keys(%Keywords));
                   2495:     # If we are here, %Keywords is empty, so fill it up
                   2496:     #   Make sure the file we need exists...
                   2497:     if (! -e $thesaurus_db_file) {
                   2498:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2499:                                  " failed because it does not exist");
                   2500:         return 0;
                   2501:     }
                   2502:     #   Set up the hash as a database
                   2503:     my %thesaurus_db;
                   2504:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2505:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2506:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2507:                                  $thesaurus_db_file);
                   2508:         return 0;
                   2509:     } 
                   2510:     #  Get the average number of appearances of a word.
                   2511:     my $avecount = $thesaurus_db{'average.count'};
                   2512:     #  Put keywords (those that appear > average) into %Keywords
                   2513:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2514:         my ($count,undef) = split /:/,$data;
                   2515:         $Keywords{$word}++ if ($count > $avecount);
                   2516:     }
                   2517:     untie %thesaurus_db;
                   2518:     # Remove special values from %Keywords.
1.356     albertel 2519:     foreach my $value ('total.count','average.count') {
                   2520:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2521:   }
1.46      matthew  2522:     return 1;
                   2523: }
                   2524: 
                   2525: ###################################################
                   2526: 
                   2527: =pod
                   2528: 
1.648     raeburn  2529: =item * &keyword($word)
1.46      matthew  2530: 
                   2531: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2532: than the average number of times in the thesaurus database.  Calls 
                   2533: &initialize_keywords
                   2534: 
                   2535: =cut
                   2536: 
                   2537: ###################################################
1.20      www      2538: 
                   2539: sub keyword {
1.46      matthew  2540:     return if (!&initialize_keywords());
                   2541:     my $word=lc(shift());
                   2542:     $word=~s/\W//g;
                   2543:     return exists($Keywords{$word});
1.20      www      2544: }
1.46      matthew  2545: 
                   2546: ###############################################################
                   2547: 
                   2548: =pod 
1.20      www      2549: 
1.648     raeburn  2550: =item * &get_related_words()
1.46      matthew  2551: 
1.160     matthew  2552: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2553: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2554: will be returned.  The order of the words returned is determined by the
                   2555: database which holds them.
                   2556: 
                   2557: Uses global $thesaurus_db_file.
                   2558: 
                   2559: =cut
                   2560: 
                   2561: ###############################################################
                   2562: sub get_related_words {
                   2563:     my $keyword = shift;
                   2564:     my %thesaurus_db;
                   2565:     if (! -e $thesaurus_db_file) {
                   2566:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2567:                                  "failed because the file does not exist");
                   2568:         return ();
                   2569:     }
                   2570:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2571:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2572:         return ();
                   2573:     } 
                   2574:     my @Words=();
1.429     www      2575:     my $count=0;
1.46      matthew  2576:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2577: 	# The first element is the number of times
                   2578: 	# the word appears.  We do not need it now.
1.429     www      2579: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2580: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2581: 	my $threshold=$mostfrequentcount/10;
                   2582:         foreach my $possibleword (@RelatedWords) {
                   2583:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2584:             if ($wordcount>$threshold) {
                   2585: 		push(@Words,$word);
                   2586:                 $count++;
                   2587:                 if ($count>10) { last; }
                   2588: 	    }
1.20      www      2589:         }
                   2590:     }
1.46      matthew  2591:     untie %thesaurus_db;
                   2592:     return @Words;
1.14      harris41 2593: }
1.46      matthew  2594: 
1.112     bowersj2 2595: =pod
                   2596: 
                   2597: =back
                   2598: 
                   2599: =cut
1.61      www      2600: 
                   2601: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2602: =pod
                   2603: 
1.112     bowersj2 2604: =head1 User Name Functions
                   2605: 
                   2606: =over 4
                   2607: 
1.648     raeburn  2608: =item * &plainname($uname,$udom,$first)
1.81      albertel 2609: 
1.112     bowersj2 2610: Takes a users logon name and returns it as a string in
1.226     albertel 2611: "first middle last generation" form 
                   2612: if $first is set to 'lastname' then it returns it as
                   2613: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2614: 
                   2615: =cut
1.61      www      2616: 
1.295     www      2617: 
1.81      albertel 2618: ###############################################################
1.61      www      2619: sub plainname {
1.226     albertel 2620:     my ($uname,$udom,$first)=@_;
1.537     albertel 2621:     return if (!defined($uname) || !defined($udom));
1.295     www      2622:     my %names=&getnames($uname,$udom);
1.226     albertel 2623:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2624: 					  $names{'middlename'},
                   2625: 					  $names{'lastname'},
                   2626: 					  $names{'generation'},$first);
                   2627:     $name=~s/^\s+//;
1.62      www      2628:     $name=~s/\s+$//;
                   2629:     $name=~s/\s+/ /g;
1.353     albertel 2630:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2631:     return $name;
1.61      www      2632: }
1.66      www      2633: 
                   2634: # -------------------------------------------------------------------- Nickname
1.81      albertel 2635: =pod
                   2636: 
1.648     raeburn  2637: =item * &nickname($uname,$udom)
1.81      albertel 2638: 
                   2639: Gets a users name and returns it as a string as
                   2640: 
                   2641: "&quot;nickname&quot;"
1.66      www      2642: 
1.81      albertel 2643: if the user has a nickname or
                   2644: 
                   2645: "first middle last generation"
                   2646: 
                   2647: if the user does not
                   2648: 
                   2649: =cut
1.66      www      2650: 
                   2651: sub nickname {
                   2652:     my ($uname,$udom)=@_;
1.537     albertel 2653:     return if (!defined($uname) || !defined($udom));
1.295     www      2654:     my %names=&getnames($uname,$udom);
1.68      albertel 2655:     my $name=$names{'nickname'};
1.66      www      2656:     if ($name) {
                   2657:        $name='&quot;'.$name.'&quot;'; 
                   2658:     } else {
                   2659:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2660: 	     $names{'lastname'}.' '.$names{'generation'};
                   2661:        $name=~s/\s+$//;
                   2662:        $name=~s/\s+/ /g;
                   2663:     }
                   2664:     return $name;
                   2665: }
                   2666: 
1.295     www      2667: sub getnames {
                   2668:     my ($uname,$udom)=@_;
1.537     albertel 2669:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2670:     if ($udom eq 'public' && $uname eq 'public') {
                   2671: 	return ('lastname' => &mt('Public'));
                   2672:     }
1.295     www      2673:     my $id=$uname.':'.$udom;
                   2674:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2675:     if ($cached) {
                   2676: 	return %{$names};
                   2677:     } else {
                   2678: 	my %loadnames=&Apache::lonnet::get('environment',
                   2679:                     ['firstname','middlename','lastname','generation','nickname'],
                   2680: 					 $udom,$uname);
                   2681: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2682: 	return %loadnames;
                   2683:     }
                   2684: }
1.61      www      2685: 
1.542     raeburn  2686: # -------------------------------------------------------------------- getemails
1.648     raeburn  2687: 
1.542     raeburn  2688: =pod
                   2689: 
1.648     raeburn  2690: =item * &getemails($uname,$udom)
1.542     raeburn  2691: 
                   2692: Gets a user's email information and returns it as a hash with keys:
                   2693: notification, critnotification, permanentemail
                   2694: 
                   2695: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2696: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2697:  
1.648     raeburn  2698: 
1.542     raeburn  2699: =cut
                   2700: 
1.648     raeburn  2701: 
1.466     albertel 2702: sub getemails {
                   2703:     my ($uname,$udom)=@_;
                   2704:     if ($udom eq 'public' && $uname eq 'public') {
                   2705: 	return;
                   2706:     }
1.467     www      2707:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2708:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2709:     my $id=$uname.':'.$udom;
                   2710:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2711:     if ($cached) {
                   2712: 	return %{$names};
                   2713:     } else {
                   2714: 	my %loadnames=&Apache::lonnet::get('environment',
                   2715:                     			   ['notification','critnotification',
                   2716: 					    'permanentemail'],
                   2717: 					   $udom,$uname);
                   2718: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2719: 	return %loadnames;
                   2720:     }
                   2721: }
                   2722: 
1.551     albertel 2723: sub flush_email_cache {
                   2724:     my ($uname,$udom)=@_;
                   2725:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2726:     if (!$uname) { $uname=$env{'user.name'};   }
                   2727:     return if ($udom eq 'public' && $uname eq 'public');
                   2728:     my $id=$uname.':'.$udom;
                   2729:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2730: }
                   2731: 
1.728     raeburn  2732: # -------------------------------------------------------------------- getlangs
                   2733: 
                   2734: =pod
                   2735: 
                   2736: =item * &getlangs($uname,$udom)
                   2737: 
                   2738: Gets a user's language preference and returns it as a hash with key:
                   2739: language.
                   2740: 
                   2741: =cut
                   2742: 
                   2743: 
                   2744: sub getlangs {
                   2745:     my ($uname,$udom) = @_;
                   2746:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2747:     if (!$uname) { $uname=$env{'user.name'};   }
                   2748:     my $id=$uname.':'.$udom;
                   2749:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2750:     if ($cached) {
                   2751:         return %{$langs};
                   2752:     } else {
                   2753:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2754:                                            $udom,$uname);
                   2755:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2756:         return %loadlangs;
                   2757:     }
                   2758: }
                   2759: 
                   2760: sub flush_langs_cache {
                   2761:     my ($uname,$udom)=@_;
                   2762:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2763:     if (!$uname) { $uname=$env{'user.name'};   }
                   2764:     return if ($udom eq 'public' && $uname eq 'public');
                   2765:     my $id=$uname.':'.$udom;
                   2766:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2767: }
                   2768: 
1.61      www      2769: # ------------------------------------------------------------------ Screenname
1.81      albertel 2770: 
                   2771: =pod
                   2772: 
1.648     raeburn  2773: =item * &screenname($uname,$udom)
1.81      albertel 2774: 
                   2775: Gets a users screenname and returns it as a string
                   2776: 
                   2777: =cut
1.61      www      2778: 
                   2779: sub screenname {
                   2780:     my ($uname,$udom)=@_;
1.258     albertel 2781:     if ($uname eq $env{'user.name'} &&
                   2782: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2783:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2784:     return $names{'screenname'};
1.62      www      2785: }
                   2786: 
1.212     albertel 2787: 
1.62      www      2788: # ------------------------------------------------------------- Message Wrapper
                   2789: 
                   2790: sub messagewrapper {
1.369     www      2791:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2792:     return 
1.441     albertel 2793:         '<a href="/adm/email?compose=individual&amp;'.
                   2794:         'recname='.$username.'&amp;recdom='.$domain.
                   2795: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2796:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2797: }
                   2798: # --------------------------------------------------------------- Notes Wrapper
                   2799: 
                   2800: sub noteswrapper {
                   2801:     my ($link,$un,$do)=@_;
                   2802:     return 
                   2803: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2804: }
                   2805: # ------------------------------------------------------------- Aboutme Wrapper
                   2806: 
                   2807: sub aboutmewrapper {
1.166     www      2808:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2809:     if (!defined($username)  && !defined($domain)) {
                   2810:         return;
                   2811:     }
1.205     www      2812:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454     banghart 2813: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62      www      2814: }
                   2815: 
                   2816: # ------------------------------------------------------------ Syllabus Wrapper
                   2817: 
                   2818: 
                   2819: sub syllabuswrapper {
1.707     bisitz   2820:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2821:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2822: }
1.14      harris41 2823: 
1.208     matthew  2824: sub track_student_link {
1.268     albertel 2825:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2826:     my $link ="/adm/trackstudent?";
1.208     matthew  2827:     my $title = 'View recent activity';
                   2828:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2829:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2830:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2831:         $title .= ' of this student';
1.268     albertel 2832:     } 
1.208     matthew  2833:     if (defined($target) && $target !~ /^\s*$/) {
                   2834:         $target = qq{target="$target"};
                   2835:     } else {
                   2836:         $target = '';
                   2837:     }
1.268     albertel 2838:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2839:     $title = &mt($title);
                   2840:     $linktext = &mt($linktext);
1.448     albertel 2841:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2842: 	&help_open_topic('View_recent_activity');
1.208     matthew  2843: }
                   2844: 
1.508     www      2845: # ===================================================== Display a student photo
                   2846: 
                   2847: 
1.509     albertel 2848: sub student_image_tag {
1.508     www      2849:     my ($domain,$user)=@_;
                   2850:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2851:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2852: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2853:     } else {
                   2854: 	return '';
                   2855:     }
                   2856: }
                   2857: 
1.112     bowersj2 2858: =pod
                   2859: 
                   2860: =back
                   2861: 
                   2862: =head1 Access .tab File Data
                   2863: 
                   2864: =over 4
                   2865: 
1.648     raeburn  2866: =item * &languageids() 
1.112     bowersj2 2867: 
                   2868: returns list of all language ids
                   2869: 
                   2870: =cut
                   2871: 
1.14      harris41 2872: sub languageids {
1.16      harris41 2873:     return sort(keys(%language));
1.14      harris41 2874: }
                   2875: 
1.112     bowersj2 2876: =pod
                   2877: 
1.648     raeburn  2878: =item * &languagedescription() 
1.112     bowersj2 2879: 
                   2880: returns description of a specified language id
                   2881: 
                   2882: =cut
                   2883: 
1.14      harris41 2884: sub languagedescription {
1.125     www      2885:     my $code=shift;
                   2886:     return  ($supported_language{$code}?'* ':'').
                   2887:             $language{$code}.
1.126     www      2888: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2889: }
                   2890: 
                   2891: sub plainlanguagedescription {
                   2892:     my $code=shift;
                   2893:     return $language{$code};
                   2894: }
                   2895: 
                   2896: sub supportedlanguagecode {
                   2897:     my $code=shift;
                   2898:     return $supported_language{$code};
1.97      www      2899: }
                   2900: 
1.112     bowersj2 2901: =pod
                   2902: 
1.648     raeburn  2903: =item * &copyrightids() 
1.112     bowersj2 2904: 
                   2905: returns list of all copyrights
                   2906: 
                   2907: =cut
                   2908: 
                   2909: sub copyrightids {
                   2910:     return sort(keys(%cprtag));
                   2911: }
                   2912: 
                   2913: =pod
                   2914: 
1.648     raeburn  2915: =item * &copyrightdescription() 
1.112     bowersj2 2916: 
                   2917: returns description of a specified copyright id
                   2918: 
                   2919: =cut
                   2920: 
                   2921: sub copyrightdescription {
1.166     www      2922:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2923: }
1.197     matthew  2924: 
                   2925: =pod
                   2926: 
1.648     raeburn  2927: =item * &source_copyrightids() 
1.192     taceyjo1 2928: 
                   2929: returns list of all source copyrights
                   2930: 
                   2931: =cut
                   2932: 
                   2933: sub source_copyrightids {
                   2934:     return sort(keys(%scprtag));
                   2935: }
                   2936: 
                   2937: =pod
                   2938: 
1.648     raeburn  2939: =item * &source_copyrightdescription() 
1.192     taceyjo1 2940: 
                   2941: returns description of a specified source copyright id
                   2942: 
                   2943: =cut
                   2944: 
                   2945: sub source_copyrightdescription {
                   2946:     return &mt($scprtag{shift(@_)});
                   2947: }
1.112     bowersj2 2948: 
                   2949: =pod
                   2950: 
1.648     raeburn  2951: =item * &filecategories() 
1.112     bowersj2 2952: 
                   2953: returns list of all file categories
                   2954: 
                   2955: =cut
                   2956: 
                   2957: sub filecategories {
                   2958:     return sort(keys(%category_extensions));
                   2959: }
                   2960: 
                   2961: =pod
                   2962: 
1.648     raeburn  2963: =item * &filecategorytypes() 
1.112     bowersj2 2964: 
                   2965: returns list of file types belonging to a given file
                   2966: category
                   2967: 
                   2968: =cut
                   2969: 
                   2970: sub filecategorytypes {
1.356     albertel 2971:     my ($cat) = @_;
                   2972:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 2973: }
                   2974: 
                   2975: =pod
                   2976: 
1.648     raeburn  2977: =item * &fileembstyle() 
1.112     bowersj2 2978: 
                   2979: returns embedding style for a specified file type
                   2980: 
                   2981: =cut
                   2982: 
                   2983: sub fileembstyle {
                   2984:     return $fe{lc(shift(@_))};
1.169     www      2985: }
                   2986: 
1.351     www      2987: sub filemimetype {
                   2988:     return $fm{lc(shift(@_))};
                   2989: }
                   2990: 
1.169     www      2991: 
                   2992: sub filecategoryselect {
                   2993:     my ($name,$value)=@_;
1.189     matthew  2994:     return &select_form($value,$name,
1.169     www      2995: 			'' => &mt('Any category'),
                   2996: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 2997: }
                   2998: 
                   2999: =pod
                   3000: 
1.648     raeburn  3001: =item * &filedescription() 
1.112     bowersj2 3002: 
                   3003: returns description for a specified file type
                   3004: 
                   3005: =cut
                   3006: 
                   3007: sub filedescription {
1.188     matthew  3008:     my $file_description = $fd{lc(shift())};
                   3009:     $file_description =~ s:([\[\]]):~$1:g;
                   3010:     return &mt($file_description);
1.112     bowersj2 3011: }
                   3012: 
                   3013: =pod
                   3014: 
1.648     raeburn  3015: =item * &filedescriptionex() 
1.112     bowersj2 3016: 
                   3017: returns description for a specified file type with
                   3018: extra formatting
                   3019: 
                   3020: =cut
                   3021: 
                   3022: sub filedescriptionex {
                   3023:     my $ex=shift;
1.188     matthew  3024:     my $file_description = $fd{lc($ex)};
                   3025:     $file_description =~ s:([\[\]]):~$1:g;
                   3026:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3027: }
                   3028: 
                   3029: # End of .tab access
                   3030: =pod
                   3031: 
                   3032: =back
                   3033: 
                   3034: =cut
                   3035: 
                   3036: # ------------------------------------------------------------------ File Types
                   3037: sub fileextensions {
                   3038:     return sort(keys(%fe));
                   3039: }
                   3040: 
1.97      www      3041: # ----------------------------------------------------------- Display Languages
                   3042: # returns a hash with all desired display languages
                   3043: #
                   3044: 
                   3045: sub display_languages {
                   3046:     my %languages=();
1.695     raeburn  3047:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3048: 	$languages{$lang}=1;
1.97      www      3049:     }
                   3050:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3051:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3052: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3053: 	    $languages{$lang}=1;
1.97      www      3054:         }
                   3055:     }
                   3056:     return %languages;
1.14      harris41 3057: }
                   3058: 
1.582     albertel 3059: sub languages {
                   3060:     my ($possible_langs) = @_;
1.695     raeburn  3061:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3062:     if (!ref($possible_langs)) {
                   3063: 	if( wantarray ) {
                   3064: 	    return @preferred_langs;
                   3065: 	} else {
                   3066: 	    return $preferred_langs[0];
                   3067: 	}
                   3068:     }
                   3069:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3070:     my @preferred_possibilities;
                   3071:     foreach my $preferred_lang (@preferred_langs) {
                   3072: 	if (exists($possibilities{$preferred_lang})) {
                   3073: 	    push(@preferred_possibilities, $preferred_lang);
                   3074: 	}
                   3075:     }
                   3076:     if( wantarray ) {
                   3077: 	return @preferred_possibilities;
                   3078:     }
                   3079:     return $preferred_possibilities[0];
                   3080: }
                   3081: 
1.742     raeburn  3082: sub user_lang {
                   3083:     my ($touname,$toudom,$fromcid) = @_;
                   3084:     my @userlangs;
                   3085:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3086:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3087:                     $env{'course.'.$fromcid.'.languages'}));
                   3088:     } else {
                   3089:         my %langhash = &getlangs($touname,$toudom);
                   3090:         if ($langhash{'languages'} ne '') {
                   3091:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3092:         } else {
                   3093:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3094:             if ($domdefs{'lang_def'} ne '') {
                   3095:                 @userlangs = ($domdefs{'lang_def'});
                   3096:             }
                   3097:         }
                   3098:     }
                   3099:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3100:     my $user_lh = Apache::localize->get_handle(@languages);
                   3101:     return $user_lh;
                   3102: }
                   3103: 
                   3104: 
1.112     bowersj2 3105: ###############################################################
                   3106: ##               Student Answer Attempts                     ##
                   3107: ###############################################################
                   3108: 
                   3109: =pod
                   3110: 
                   3111: =head1 Alternate Problem Views
                   3112: 
                   3113: =over 4
                   3114: 
1.648     raeburn  3115: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3116:     $getattempt, $regexp, $gradesub)
                   3117: 
                   3118: Return string with previous attempt on problem. Arguments:
                   3119: 
                   3120: =over 4
                   3121: 
                   3122: =item * $symb: Problem, including path
                   3123: 
                   3124: =item * $username: username of the desired student
                   3125: 
                   3126: =item * $domain: domain of the desired student
1.14      harris41 3127: 
1.112     bowersj2 3128: =item * $course: Course ID
1.14      harris41 3129: 
1.112     bowersj2 3130: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3131:     something
1.14      harris41 3132: 
1.112     bowersj2 3133: =item * $regexp: if string matches this regexp, the string will be
                   3134:     sent to $gradesub
1.14      harris41 3135: 
1.112     bowersj2 3136: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3137: 
1.112     bowersj2 3138: =back
1.14      harris41 3139: 
1.112     bowersj2 3140: The output string is a table containing all desired attempts, if any.
1.16      harris41 3141: 
1.112     bowersj2 3142: =cut
1.1       albertel 3143: 
                   3144: sub get_previous_attempt {
1.43      ng       3145:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3146:   my $prevattempts='';
1.43      ng       3147:   no strict 'refs';
1.1       albertel 3148:   if ($symb) {
1.3       albertel 3149:     my (%returnhash)=
                   3150:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3151:     if ($returnhash{'version'}) {
                   3152:       my %lasthash=();
                   3153:       my $version;
                   3154:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3155:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3156: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3157:         }
1.1       albertel 3158:       }
1.596     albertel 3159:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3160:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3161:       foreach my $key (sort(keys(%lasthash))) {
                   3162: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3163: 	if ($#parts > 0) {
1.31      albertel 3164: 	  my $data=$parts[-1];
                   3165: 	  pop(@parts);
1.596     albertel 3166: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3167: 	} else {
1.41      ng       3168: 	  if ($#parts == 0) {
                   3169: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3170: 	  } else {
                   3171: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3172: 	  }
1.31      albertel 3173: 	}
1.16      harris41 3174:       }
1.596     albertel 3175:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3176:       if ($getattempt eq '') {
                   3177: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3178: 	  $prevattempts.=&start_data_table_row().
                   3179: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3180: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3181: 		my $value = &format_previous_attempt_value($key,
                   3182: 							   $returnhash{$version.':'.$key});
                   3183: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3184: 	    }
1.596     albertel 3185: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3186: 	 }
1.1       albertel 3187:       }
1.596     albertel 3188:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3189:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3190: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3191: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3192: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3193:       }
1.596     albertel 3194:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3195:     } else {
1.596     albertel 3196:       $prevattempts=
                   3197: 	  &start_data_table().&start_data_table_row().
                   3198: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3199: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3200:     }
                   3201:   } else {
1.596     albertel 3202:     $prevattempts=
                   3203: 	  &start_data_table().&start_data_table_row().
                   3204: 	  '<td>'.&mt('No data.').'</td>'.
                   3205: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3206:   }
1.10      albertel 3207: }
                   3208: 
1.581     albertel 3209: sub format_previous_attempt_value {
                   3210:     my ($key,$value) = @_;
                   3211:     if ($key =~ /timestamp/) {
                   3212: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3213:     } elsif (ref($value) eq 'ARRAY') {
                   3214: 	$value = '('.join(', ', @{ $value }).')';
                   3215:     } else {
                   3216: 	$value = &unescape($value);
                   3217:     }
                   3218:     return $value;
                   3219: }
                   3220: 
                   3221: 
1.107     albertel 3222: sub relative_to_absolute {
                   3223:     my ($url,$output)=@_;
                   3224:     my $parser=HTML::TokeParser->new(\$output);
                   3225:     my $token;
                   3226:     my $thisdir=$url;
                   3227:     my @rlinks=();
                   3228:     while ($token=$parser->get_token) {
                   3229: 	if ($token->[0] eq 'S') {
                   3230: 	    if ($token->[1] eq 'a') {
                   3231: 		if ($token->[2]->{'href'}) {
                   3232: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3233: 		}
                   3234: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3235: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3236: 	    } elsif ($token->[1] eq 'base') {
                   3237: 		$thisdir=$token->[2]->{'href'};
                   3238: 	    }
                   3239: 	}
                   3240:     }
                   3241:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3242:     foreach my $link (@rlinks) {
1.726     raeburn  3243: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3244: 		($link=~/^\//) ||
                   3245: 		($link=~/^javascript:/i) ||
                   3246: 		($link=~/^mailto:/i) ||
                   3247: 		($link=~/^\#/)) {
                   3248: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3249: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3250: 	}
                   3251:     }
                   3252: # -------------------------------------------------- Deal with Applet codebases
                   3253:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3254:     return $output;
                   3255: }
                   3256: 
1.112     bowersj2 3257: =pod
                   3258: 
1.648     raeburn  3259: =item * &get_student_view()
1.112     bowersj2 3260: 
                   3261: show a snapshot of what student was looking at
                   3262: 
                   3263: =cut
                   3264: 
1.10      albertel 3265: sub get_student_view {
1.186     albertel 3266:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3267:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3268:   my (%form);
1.10      albertel 3269:   my @elements=('symb','courseid','domain','username');
                   3270:   foreach my $element (@elements) {
1.186     albertel 3271:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3272:   }
1.186     albertel 3273:   if (defined($moreenv)) {
                   3274:       %form=(%form,%{$moreenv});
                   3275:   }
1.236     albertel 3276:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3277:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3278:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3279:   $userview=~s/\<body[^\>]*\>//gi;
                   3280:   $userview=~s/\<\/body\>//gi;
                   3281:   $userview=~s/\<html\>//gi;
                   3282:   $userview=~s/\<\/html\>//gi;
                   3283:   $userview=~s/\<head\>//gi;
                   3284:   $userview=~s/\<\/head\>//gi;
                   3285:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3286:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3287:   if (wantarray) {
                   3288:      return ($userview,$response);
                   3289:   } else {
                   3290:      return $userview;
                   3291:   }
                   3292: }
                   3293: 
                   3294: sub get_student_view_with_retries {
                   3295:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3296: 
                   3297:     my $ok = 0;                 # True if we got a good response.
                   3298:     my $content;
                   3299:     my $response;
                   3300: 
                   3301:     # Try to get the student_view done. within the retries count:
                   3302:     
                   3303:     do {
                   3304:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3305:          $ok      = $response->is_success;
                   3306:          if (!$ok) {
                   3307:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3308:          }
                   3309:          $retries--;
                   3310:     } while (!$ok && ($retries > 0));
                   3311:     
                   3312:     if (!$ok) {
                   3313:        $content = '';          # On error return an empty content.
                   3314:     }
1.651     www      3315:     if (wantarray) {
                   3316:        return ($content, $response);
                   3317:     } else {
                   3318:        return $content;
                   3319:     }
1.11      albertel 3320: }
                   3321: 
1.112     bowersj2 3322: =pod
                   3323: 
1.648     raeburn  3324: =item * &get_student_answers() 
1.112     bowersj2 3325: 
                   3326: show a snapshot of how student was answering problem
                   3327: 
                   3328: =cut
                   3329: 
1.11      albertel 3330: sub get_student_answers {
1.100     sakharuk 3331:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3332:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3333:   my (%moreenv);
1.11      albertel 3334:   my @elements=('symb','courseid','domain','username');
                   3335:   foreach my $element (@elements) {
1.186     albertel 3336:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3337:   }
1.186     albertel 3338:   $moreenv{'grade_target'}='answer';
                   3339:   %moreenv=(%form,%moreenv);
1.497     raeburn  3340:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3341:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3342:   return $userview;
1.1       albertel 3343: }
1.116     albertel 3344: 
                   3345: =pod
                   3346: 
                   3347: =item * &submlink()
                   3348: 
1.242     albertel 3349: Inputs: $text $uname $udom $symb $target
1.116     albertel 3350: 
                   3351: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3352: 
                   3353: =cut
                   3354: 
                   3355: ###############################################
                   3356: sub submlink {
1.242     albertel 3357:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3358:     if (!($uname && $udom)) {
                   3359: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3360: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3361: 	if (!$symb) { $symb=$cursymb; }
                   3362:     }
1.254     matthew  3363:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3364:     $symb=&escape($symb);
1.242     albertel 3365:     if ($target) { $target="target=\"$target\""; }
                   3366:     return '<a href="/adm/grades?&command=submission&'.
                   3367: 	'symb='.$symb.'&student='.$uname.
                   3368: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3369: }
                   3370: ##############################################
                   3371: 
                   3372: =pod
                   3373: 
                   3374: =item * &pgrdlink()
                   3375: 
                   3376: Inputs: $text $uname $udom $symb $target
                   3377: 
                   3378: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3379: 
                   3380: =cut
                   3381: 
                   3382: ###############################################
                   3383: sub pgrdlink {
                   3384:     my $link=&submlink(@_);
                   3385:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3386:     return $link;
                   3387: }
                   3388: ##############################################
                   3389: 
                   3390: =pod
                   3391: 
                   3392: =item * &pprmlink()
                   3393: 
                   3394: Inputs: $text $uname $udom $symb $target
                   3395: 
                   3396: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3397: student and a specific resource
1.242     albertel 3398: 
                   3399: =cut
                   3400: 
                   3401: ###############################################
                   3402: sub pprmlink {
                   3403:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3404:     if (!($uname && $udom)) {
                   3405: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3406: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3407: 	if (!$symb) { $symb=$cursymb; }
                   3408:     }
1.254     matthew  3409:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3410:     $symb=&escape($symb);
1.242     albertel 3411:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3412:     return '<a href="/adm/parmset?command=set&amp;'.
                   3413: 	'symb='.$symb.'&amp;uname='.$uname.
                   3414: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3415: }
                   3416: ##############################################
1.37      matthew  3417: 
1.112     bowersj2 3418: =pod
                   3419: 
                   3420: =back
                   3421: 
                   3422: =cut
                   3423: 
1.37      matthew  3424: ###############################################
1.51      www      3425: 
                   3426: 
                   3427: sub timehash {
1.687     raeburn  3428:     my ($thistime) = @_;
                   3429:     my $timezone = &Apache::lonlocal::gettimezone();
                   3430:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3431:                      ->set_time_zone($timezone);
                   3432:     my $wday = $dt->day_of_week();
                   3433:     if ($wday == 7) { $wday = 0; }
                   3434:     return ( 'second' => $dt->second(),
                   3435:              'minute' => $dt->minute(),
                   3436:              'hour'   => $dt->hour(),
                   3437:              'day'     => $dt->day_of_month(),
                   3438:              'month'   => $dt->month(),
                   3439:              'year'    => $dt->year(),
                   3440:              'weekday' => $wday,
                   3441:              'dayyear' => $dt->day_of_year(),
                   3442:              'dlsav'   => $dt->is_dst() );
1.51      www      3443: }
                   3444: 
1.370     www      3445: sub utc_string {
                   3446:     my ($date)=@_;
1.371     www      3447:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3448: }
                   3449: 
1.51      www      3450: sub maketime {
                   3451:     my %th=@_;
1.687     raeburn  3452:     my ($epoch_time,$timezone,$dt);
                   3453:     $timezone = &Apache::lonlocal::gettimezone();
                   3454:     eval {
                   3455:         $dt = DateTime->new( year   => $th{'year'},
                   3456:                              month  => $th{'month'},
                   3457:                              day    => $th{'day'},
                   3458:                              hour   => $th{'hour'},
                   3459:                              minute => $th{'minute'},
                   3460:                              second => $th{'second'},
                   3461:                              time_zone => $timezone,
                   3462:                          );
                   3463:     };
                   3464:     if (!$@) {
                   3465:         $epoch_time = $dt->epoch;
                   3466:         if ($epoch_time) {
                   3467:             return $epoch_time;
                   3468:         }
                   3469:     }
1.51      www      3470:     return POSIX::mktime(
                   3471:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3472:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3473: }
                   3474: 
                   3475: #########################################
1.51      www      3476: 
                   3477: sub findallcourses {
1.482     raeburn  3478:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3479:     my %roles;
                   3480:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3481:     my %courses;
1.51      www      3482:     my $now=time;
1.482     raeburn  3483:     if (!defined($uname)) {
                   3484:         $uname = $env{'user.name'};
                   3485:     }
                   3486:     if (!defined($udom)) {
                   3487:         $udom = $env{'user.domain'};
                   3488:     }
                   3489:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3490:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3491:         if (!%roles) {
                   3492:             %roles = (
                   3493:                        cc => 1,
                   3494:                        in => 1,
                   3495:                        ep => 1,
                   3496:                        ta => 1,
                   3497:                        cr => 1,
                   3498:                        st => 1,
                   3499:              );
                   3500:         }
                   3501:         foreach my $entry (keys(%roleshash)) {
                   3502:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3503:             if ($trole =~ /^cr/) { 
                   3504:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3505:             } else {
                   3506:                 next if (!exists($roles{$trole}));
                   3507:             }
                   3508:             if ($tend) {
                   3509:                 next if ($tend < $now);
                   3510:             }
                   3511:             if ($tstart) {
                   3512:                 next if ($tstart > $now);
                   3513:             }
                   3514:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3515:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3516:             if ($secpart eq '') {
                   3517:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3518:                 $sec = 'none';
                   3519:                 $realsec = '';
                   3520:             } else {
                   3521:                 $cnum = $cnumpart;
                   3522:                 ($sec,$role) = split(/_/,$secpart);
                   3523:                 $realsec = $sec;
1.490     raeburn  3524:             }
1.482     raeburn  3525:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3526:         }
                   3527:     } else {
                   3528:         foreach my $key (keys(%env)) {
1.483     albertel 3529: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3530:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3531: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3532: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3533: 	        next if (%roles && !exists($roles{$role}));
                   3534: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3535:                 my $active=1;
                   3536:                 if ($starttime) {
                   3537: 		    if ($now<$starttime) { $active=0; }
                   3538:                 }
                   3539:                 if ($endtime) {
                   3540:                     if ($now>$endtime) { $active=0; }
                   3541:                 }
                   3542:                 if ($active) {
                   3543:                     if ($sec eq '') {
                   3544:                         $sec = 'none';
                   3545:                     }
                   3546:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3547:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3548:                 }
                   3549:             }
1.51      www      3550:         }
                   3551:     }
1.474     raeburn  3552:     return %courses;
1.51      www      3553: }
1.37      matthew  3554: 
1.54      www      3555: ###############################################
1.474     raeburn  3556: 
                   3557: sub blockcheck {
1.482     raeburn  3558:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3559: 
                   3560:     if (!defined($udom)) {
                   3561:         $udom = $env{'user.domain'};
                   3562:     }
                   3563:     if (!defined($uname)) {
                   3564:         $uname = $env{'user.name'};
                   3565:     }
                   3566: 
                   3567:     # If uname and udom are for a course, check for blocks in the course.
                   3568: 
                   3569:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3570:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3571:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3572:         return ($startblock,$endblock);
                   3573:     }
1.474     raeburn  3574: 
1.502     raeburn  3575:     my $startblock = 0;
                   3576:     my $endblock = 0;
1.482     raeburn  3577:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3578: 
1.490     raeburn  3579:     # If uname is for a user, and activity is course-specific, i.e.,
                   3580:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3581: 
1.490     raeburn  3582:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3583:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3584:         foreach my $key (keys(%live_courses)) {
                   3585:             if ($key ne $env{'request.course.id'}) {
                   3586:                 delete($live_courses{$key});
                   3587:             }
                   3588:         }
                   3589:     }
                   3590: 
                   3591:     my $otheruser = 0;
                   3592:     my %own_courses;
                   3593:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3594:         # Resource belongs to user other than current user.
                   3595:         $otheruser = 1;
                   3596:         # Gather courses for current user
                   3597:         %own_courses = 
                   3598:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3599:     }
                   3600: 
                   3601:     # Gather active course roles - course coordinator, instructor, 
                   3602:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3603: 
                   3604:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3605:         my ($cdom,$cnum);
                   3606:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3607:             $cdom = $env{'course.'.$course.'.domain'};
                   3608:             $cnum = $env{'course.'.$course.'.num'};
                   3609:         } else {
1.490     raeburn  3610:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3611:         }
                   3612:         my $no_ownblock = 0;
                   3613:         my $no_userblock = 0;
1.533     raeburn  3614:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3615:             # Check if current user has 'evb' priv for this
                   3616:             if (defined($own_courses{$course})) {
                   3617:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3618:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3619:                     if ($sec ne 'none') {
                   3620:                         $checkrole .= '/'.$sec;
                   3621:                     }
                   3622:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3623:                         $no_ownblock = 1;
                   3624:                         last;
                   3625:                     }
                   3626:                 }
                   3627:             }
                   3628:             # if they have 'evb' priv and are currently not playing student
                   3629:             next if (($no_ownblock) &&
                   3630:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3631:         }
1.474     raeburn  3632:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3633:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3634:             if ($sec ne 'none') {
1.482     raeburn  3635:                 $checkrole .= '/'.$sec;
1.474     raeburn  3636:             }
1.490     raeburn  3637:             if ($otheruser) {
                   3638:                 # Resource belongs to user other than current user.
                   3639:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3640:                 my ($trole,$tdom,$tnum,$tsec);
                   3641:                 my $entry = $live_courses{$course}{$sec};
                   3642:                 if ($entry =~ /^cr/) {
                   3643:                     ($trole,$tdom,$tnum,$tsec) = 
                   3644:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3645:                 } else {
                   3646:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3647:                 }
                   3648:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3649:                 $area = '/'.$tdom.'/'.$tnum;
                   3650:                 $trest = $tnum;
                   3651:                 if ($tsec ne '') {
                   3652:                     $area .= '/'.$tsec;
                   3653:                     $trest .= '/'.$tsec;
                   3654:                 }
                   3655:                 $spec = $trole.'.'.$area;
                   3656:                 if ($trole =~ /^cr/) {
                   3657:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3658:                                                       $tdom,$spec,$trest,$area);
                   3659:                 } else {
                   3660:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3661:                                                        $tdom,$spec,$trest,$area);
                   3662:                 }
                   3663:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3664:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3665:                     if ($1) {
                   3666:                         $no_userblock = 1;
                   3667:                         last;
                   3668:                     }
                   3669:                 }
1.490     raeburn  3670:             } else {
                   3671:                 # Resource belongs to current user
                   3672:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3673:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3674:                     $no_ownblock = 1;
                   3675:                     last;
                   3676:                 }
1.474     raeburn  3677:             }
                   3678:         }
                   3679:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3680:         next if (($no_ownblock) &&
1.491     albertel 3681:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3682:         next if ($no_userblock);
1.474     raeburn  3683: 
1.490     raeburn  3684:         # Retrieve blocking times and identity of blocker for course
                   3685:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3686:         
                   3687:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3688:         if (($start != 0) && 
                   3689:             (($startblock == 0) || ($startblock > $start))) {
                   3690:             $startblock = $start;
                   3691:         }
                   3692:         if (($end != 0)  &&
                   3693:             (($endblock == 0) || ($endblock < $end))) {
                   3694:             $endblock = $end;
                   3695:         }
1.490     raeburn  3696:     }
                   3697:     return ($startblock,$endblock);
                   3698: }
                   3699: 
                   3700: sub get_blocks {
                   3701:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3702:     my $startblock = 0;
                   3703:     my $endblock = 0;
                   3704:     my $course = $cdom.'_'.$cnum;
                   3705:     $setters->{$course} = {};
                   3706:     $setters->{$course}{'staff'} = [];
                   3707:     $setters->{$course}{'times'} = [];
                   3708:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3709:     foreach my $record (keys(%records)) {
                   3710:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3711:         if ($start <= time && $end >= time) {
                   3712:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3713:                 &parse_block_record($records{$record});
                   3714:             if ($blocks->{$activity} eq 'on') {
                   3715:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3716:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3717:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3718:                     $startblock = $start;
1.490     raeburn  3719:                 }
1.491     albertel 3720:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3721:                     $endblock = $end;
1.474     raeburn  3722:                 }
                   3723:             }
                   3724:         }
                   3725:     }
                   3726:     return ($startblock,$endblock);
                   3727: }
                   3728: 
                   3729: sub parse_block_record {
                   3730:     my ($record) = @_;
                   3731:     my ($setuname,$setudom,$title,$blocks);
                   3732:     if (ref($record) eq 'HASH') {
                   3733:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3734:         $title = &unescape($record->{'event'});
                   3735:         $blocks = $record->{'blocks'};
                   3736:     } else {
                   3737:         my @data = split(/:/,$record,3);
                   3738:         if (scalar(@data) eq 2) {
                   3739:             $title = $data[1];
                   3740:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3741:         } else {
                   3742:             ($setuname,$setudom,$title) = @data;
                   3743:         }
                   3744:         $blocks = { 'com' => 'on' };
                   3745:     }
                   3746:     return ($setuname,$setudom,$title,$blocks);
                   3747: }
                   3748: 
                   3749: sub build_block_table {
                   3750:     my ($startblock,$endblock,$setters) = @_;
                   3751:     my %lt = &Apache::lonlocal::texthash(
                   3752:         'cacb' => 'Currently active communication blocks',
                   3753:         'cour' => 'Course',
                   3754:         'dura' => 'Duration',
                   3755:         'blse' => 'Block set by'
                   3756:     );
                   3757:     my $output;
1.476     raeburn  3758:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3759:     $output .= &start_data_table();
                   3760:     $output .= '
                   3761: <tr>
                   3762:  <th>'.$lt{'cour'}.'</th>
                   3763:  <th>'.$lt{'dura'}.'</th>
                   3764:  <th>'.$lt{'blse'}.'</th>
                   3765: </tr>
                   3766: ';
                   3767:     foreach my $course (keys(%{$setters})) {
                   3768:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3769:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3770:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3771:             my $fullname = &plainname($uname,$udom);
                   3772:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3773:                 && $env{'user.name'} ne 'public' 
                   3774:                 && $env{'user.domain'} ne 'public') {
                   3775:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3776:             }
1.474     raeburn  3777:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3778:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3779:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3780:             $output .= &Apache::loncommon::start_data_table_row().
                   3781:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3782:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3783:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3784:                         &Apache::loncommon::end_data_table_row();
                   3785:         }
                   3786:     }
                   3787:     $output .= &end_data_table();
                   3788: }
                   3789: 
1.490     raeburn  3790: sub blocking_status {
                   3791:     my ($activity,$uname,$udom) = @_;
                   3792:     my %setters;
                   3793:     my ($blocked,$output,$ownitem,$is_course);
                   3794:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3795:     if ($startblock && $endblock) {
                   3796:         $blocked = 1;
                   3797:         if (wantarray) {
                   3798:             my $category;
                   3799:             if ($activity eq 'boards') {
                   3800:                 $category = 'Discussion posts in this course';
                   3801:             } elsif ($activity eq 'blogs') {
                   3802:                 $category = 'Blogs';
                   3803:             } elsif ($activity eq 'port') {
                   3804:                 if (defined($uname) && defined($udom)) {
                   3805:                     if ($uname eq $env{'user.name'} &&
                   3806:                         $udom eq $env{'user.domain'}) {
                   3807:                         $ownitem = 1;
                   3808:                     }
                   3809:                 }
                   3810:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3811:                 if ($ownitem) { 
                   3812:                     $category = 'Your portfolio files';  
                   3813:                 } elsif ($is_course) {
                   3814:                     my $coursedesc;
                   3815:                     foreach my $course (keys(%setters)) {
                   3816:                         my %courseinfo =
                   3817:                              &Apache::lonnet::coursedescription($course);
                   3818:                         $coursedesc = $courseinfo{'description'};
                   3819:                     }
                   3820:                     $category = "Group files in the course '$coursedesc'";
                   3821:                 } else {
                   3822:                     $category = 'Portfolio files belonging to ';
                   3823:                     if ($env{'user.name'} eq 'public' && 
                   3824:                         $env{'user.domain'} eq 'public') {
                   3825:                         $category .= &plainname($uname,$udom);
                   3826:                     } else {
                   3827:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3828:                     }
                   3829:                 }
                   3830:             } elsif ($activity eq 'groups') {
                   3831:                 $category = 'Groups in this course';
                   3832:             }
                   3833:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3834:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3835:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3836:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3837:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3838:             }
                   3839:         }
                   3840:     }
                   3841:     if (wantarray) {
                   3842:         return ($blocked,$output);
                   3843:     } else {
                   3844:         return $blocked;
                   3845:     }
                   3846: }
                   3847: 
1.60      matthew  3848: ###############################################
                   3849: 
1.682     raeburn  3850: sub check_ip_acc {
                   3851:     my ($acc)=@_;
                   3852:     &Apache::lonxml::debug("acc is $acc");
                   3853:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3854:         return 1;
                   3855:     }
                   3856:     my $allowed=0;
                   3857:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3858: 
                   3859:     my $name;
                   3860:     foreach my $pattern (split(',',$acc)) {
                   3861:         $pattern =~ s/^\s*//;
                   3862:         $pattern =~ s/\s*$//;
                   3863:         if ($pattern =~ /\*$/) {
                   3864:             #35.8.*
                   3865:             $pattern=~s/\*//;
                   3866:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3867:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3868:             #35.8.3.[34-56]
                   3869:             my $low=$2;
                   3870:             my $high=$3;
                   3871:             $pattern=$1;
                   3872:             if ($ip =~ /^\Q$pattern\E/) {
                   3873:                 my $last=(split(/\./,$ip))[3];
                   3874:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3875:             }
                   3876:         } elsif ($pattern =~ /^\*/) {
                   3877:             #*.msu.edu
                   3878:             $pattern=~s/\*//;
                   3879:             if (!defined($name)) {
                   3880:                 use Socket;
                   3881:                 my $netaddr=inet_aton($ip);
                   3882:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3883:             }
                   3884:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3885:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3886:             #127.0.0.1
                   3887:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3888:         } else {
                   3889:             #some.name.com
                   3890:             if (!defined($name)) {
                   3891:                 use Socket;
                   3892:                 my $netaddr=inet_aton($ip);
                   3893:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3894:             }
                   3895:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3896:         }
                   3897:         if ($allowed) { last; }
                   3898:     }
                   3899:     return $allowed;
                   3900: }
                   3901: 
                   3902: ###############################################
                   3903: 
1.60      matthew  3904: =pod
                   3905: 
1.112     bowersj2 3906: =head1 Domain Template Functions
                   3907: 
                   3908: =over 4
                   3909: 
                   3910: =item * &determinedomain()
1.60      matthew  3911: 
                   3912: Inputs: $domain (usually will be undef)
                   3913: 
1.63      www      3914: Returns: Determines which domain should be used for designs
1.60      matthew  3915: 
                   3916: =cut
1.54      www      3917: 
1.60      matthew  3918: ###############################################
1.63      www      3919: sub determinedomain {
                   3920:     my $domain=shift;
1.531     albertel 3921:     if (! $domain) {
1.60      matthew  3922:         # Determine domain if we have not been given one
                   3923:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 3924:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   3925:         if ($env{'request.role.domain'}) { 
                   3926:             $domain=$env{'request.role.domain'}; 
1.60      matthew  3927:         }
                   3928:     }
1.63      www      3929:     return $domain;
                   3930: }
                   3931: ###############################################
1.517     raeburn  3932: 
1.518     albertel 3933: sub devalidate_domconfig_cache {
                   3934:     my ($udom)=@_;
                   3935:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   3936: }
                   3937: 
                   3938: # ---------------------- Get domain configuration for a domain
                   3939: sub get_domainconf {
                   3940:     my ($udom) = @_;
                   3941:     my $cachetime=1800;
                   3942:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   3943:     if (defined($cached)) { return %{$result}; }
                   3944: 
                   3945:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   3946: 					     ['login','rolecolors'],$udom);
1.632     raeburn  3947:     my (%designhash,%legacy);
1.518     albertel 3948:     if (keys(%domconfig) > 0) {
                   3949:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  3950:             if (keys(%{$domconfig{'login'}})) {
                   3951:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  3952:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   3953:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   3954:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   3955:                                 $domconfig{'login'}{$key}{$img};
                   3956:                         }
                   3957:                     } else {
                   3958:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   3959:                     }
1.632     raeburn  3960:                 }
                   3961:             } else {
                   3962:                 $legacy{'login'} = 1;
1.518     albertel 3963:             }
1.632     raeburn  3964:         } else {
                   3965:             $legacy{'login'} = 1;
1.518     albertel 3966:         }
                   3967:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  3968:             if (keys(%{$domconfig{'rolecolors'}})) {
                   3969:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   3970:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   3971:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   3972:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   3973:                         }
1.518     albertel 3974:                     }
                   3975:                 }
1.632     raeburn  3976:             } else {
                   3977:                 $legacy{'rolecolors'} = 1;
1.518     albertel 3978:             }
1.632     raeburn  3979:         } else {
                   3980:             $legacy{'rolecolors'} = 1;
1.518     albertel 3981:         }
1.632     raeburn  3982:         if (keys(%legacy) > 0) {
                   3983:             my %legacyhash = &get_legacy_domconf($udom);
                   3984:             foreach my $item (keys(%legacyhash)) {
                   3985:                 if ($item =~ /^\Q$udom\E\.login/) {
                   3986:                     if ($legacy{'login'}) { 
                   3987:                         $designhash{$item} = $legacyhash{$item};
                   3988:                     }
                   3989:                 } else {
                   3990:                     if ($legacy{'rolecolors'}) {
                   3991:                         $designhash{$item} = $legacyhash{$item};
                   3992:                     }
1.518     albertel 3993:                 }
                   3994:             }
                   3995:         }
1.632     raeburn  3996:     } else {
                   3997:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 3998:     }
                   3999:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4000: 				  $cachetime);
                   4001:     return %designhash;
                   4002: }
                   4003: 
1.632     raeburn  4004: sub get_legacy_domconf {
                   4005:     my ($udom) = @_;
                   4006:     my %legacyhash;
                   4007:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4008:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4009:     if (-e $designfile) {
                   4010:         if ( open (my $fh,"<$designfile") ) {
                   4011:             while (my $line = <$fh>) {
                   4012:                 next if ($line =~ /^\#/);
                   4013:                 chomp($line);
                   4014:                 my ($key,$val)=(split(/\=/,$line));
                   4015:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4016:             }
                   4017:             close($fh);
                   4018:         }
                   4019:     }
                   4020:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4021:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4022:     }
                   4023:     return %legacyhash;
                   4024: }
                   4025: 
1.63      www      4026: =pod
                   4027: 
1.112     bowersj2 4028: =item * &domainlogo()
1.63      www      4029: 
                   4030: Inputs: $domain (usually will be undef)
                   4031: 
                   4032: Returns: A link to a domain logo, if the domain logo exists.
                   4033: If the domain logo does not exist, a description of the domain.
                   4034: 
                   4035: =cut
1.112     bowersj2 4036: 
1.63      www      4037: ###############################################
                   4038: sub domainlogo {
1.517     raeburn  4039:     my $domain = &determinedomain(shift);
1.518     albertel 4040:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4041:     # See if there is a logo
                   4042:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4043:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4044:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4045: 	    if ($imgsrc =~ m{^/res/}) {
                   4046: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4047: 		&Apache::lonnet::repcopy($local_name);
                   4048: 	    }
                   4049: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4050:         } 
                   4051:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4052:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4053:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4054:     } else {
1.60      matthew  4055:         return '';
1.59      www      4056:     }
                   4057: }
1.63      www      4058: ##############################################
                   4059: 
                   4060: =pod
                   4061: 
1.112     bowersj2 4062: =item * &designparm()
1.63      www      4063: 
                   4064: Inputs: $which parameter; $domain (usually will be undef)
                   4065: 
                   4066: Returns: value of designparamter $which
                   4067: 
                   4068: =cut
1.112     bowersj2 4069: 
1.397     albertel 4070: 
1.400     albertel 4071: ##############################################
1.397     albertel 4072: sub designparm {
                   4073:     my ($which,$domain)=@_;
1.258     albertel 4074:     if ($env{'browser.blackwhite'} eq 'on') {
1.635     raeburn  4075: 	if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110     www      4076: 	    return '#000000';
                   4077: 	}
1.635     raeburn  4078: 	if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110     www      4079: 	    return '#FFFFFF';
                   4080: 	}
                   4081: 	if ($which=~/\.tabbg$/) {
                   4082: 	    return '#CCCCCC';
                   4083: 	}
                   4084:     }
1.397     albertel 4085:     if (exists($env{'environment.color.'.$which})) {
1.258     albertel 4086: 	return $env{'environment.color.'.$which};
1.96      www      4087:     }
1.63      www      4088:     $domain=&determinedomain($domain);
1.518     albertel 4089:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4090:     my $output;
1.517     raeburn  4091:     if ($domdesign{$domain.'.'.$which} ne '') {
1.520     raeburn  4092: 	$output = $domdesign{$domain.'.'.$which};
1.63      www      4093:     } else {
1.520     raeburn  4094:         $output = $defaultdesign{$which};
                   4095:     }
                   4096:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4097:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4098:         if ($output =~ m{^/(adm|res)/}) {
                   4099: 	    if ($output =~ m{^/res/}) {
                   4100: 		my $local_name = &Apache::lonnet::filelocation('',$output);
                   4101: 		&Apache::lonnet::repcopy($local_name);
                   4102: 	    }
1.520     raeburn  4103:             $output = &lonhttpdurl($output);
                   4104:         }
1.63      www      4105:     }
1.520     raeburn  4106:     return $output;
1.63      www      4107: }
1.59      www      4108: 
1.60      matthew  4109: ###############################################
                   4110: ###############################################
                   4111: 
                   4112: =pod
                   4113: 
1.112     bowersj2 4114: =back
                   4115: 
1.549     albertel 4116: =head1 HTML Helpers
1.112     bowersj2 4117: 
                   4118: =over 4
                   4119: 
                   4120: =item * &bodytag()
1.60      matthew  4121: 
                   4122: Returns a uniform header for LON-CAPA web pages.
                   4123: 
                   4124: Inputs: 
                   4125: 
1.112     bowersj2 4126: =over 4
                   4127: 
                   4128: =item * $title, A title to be displayed on the page.
                   4129: 
                   4130: =item * $function, the current role (can be undef).
                   4131: 
                   4132: =item * $addentries, extra parameters for the <body> tag.
                   4133: 
                   4134: =item * $bodyonly, if defined, only return the <body> tag.
                   4135: 
                   4136: =item * $domain, if defined, force a given domain.
                   4137: 
                   4138: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4139:             text interface only)
1.60      matthew  4140: 
1.326     albertel 4141: =item * $customtitle, alternate text to use instead of $title
                   4142:                       in the title box that appears, this text
                   4143:                       is not auto translated like the $title is
1.309     albertel 4144: 
                   4145: =item * $notopbar, if true, keep the 'what is this' info but remove the
                   4146:                    navigational links
1.317     albertel 4147: 
1.338     albertel 4148: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4149: 
                   4150: =item * $notitle, if true keep the nav controls, but remove the title bar
                   4151: 
1.361     albertel 4152: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4153:          'Switch To Inline Menu' link
                   4154: 
1.460     albertel 4155: =item * $args, optional argument valid values are
                   4156:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4157:             inherit_jsmath -> when creating popup window in a page,
                   4158:                               should it have jsmath forced on by the
                   4159:                               current page
1.460     albertel 4160: 
1.112     bowersj2 4161: =back
                   4162: 
1.60      matthew  4163: Returns: A uniform header for LON-CAPA web pages.  
                   4164: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4165: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4166: other decorations will be returned.
                   4167: 
                   4168: =cut
                   4169: 
1.54      www      4170: sub bodytag {
1.309     albertel 4171:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460     albertel 4172: 	$notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339     albertel 4173: 
1.460     albertel 4174:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4175: 
1.183     matthew  4176:     $function = &get_users_function() if (!$function);
1.339     albertel 4177:     my $img =    &designparm($function.'.img',$domain);
                   4178:     my $font =   &designparm($function.'.font',$domain);
                   4179:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4180: 
                   4181:     my %design = ( 'style'   => 'margin-top: 0px',
1.535     albertel 4182: 		   'bgcolor' => $pgbg,
1.339     albertel 4183: 		   'text'    => $font,
                   4184:                    'alink'   => &designparm($function.'.alink',$domain),
                   4185: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4186: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4187:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4188: 
1.63      www      4189:  # role and realm
1.378     raeburn  4190:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4191:     if ($role  eq 'ca') {
1.479     albertel 4192:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4193:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4194:     } 
1.55      www      4195: # realm
1.258     albertel 4196:     if ($env{'request.course.id'}) {
1.378     raeburn  4197:         if ($env{'request.role'} !~ /^cr/) {
                   4198:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4199:         }
1.359     albertel 4200: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4201:     } else {
                   4202:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4203:     }
1.433     albertel 4204: 
1.359     albertel 4205:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4206: # Set messages
1.60      matthew  4207:     my $messages=&domainlogo($domain);
1.330     albertel 4208: 
1.438     albertel 4209:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4210: 
1.101     www      4211: # construct main body tag
1.359     albertel 4212:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4213: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4214: 
1.530     albertel 4215:     if ($bodyonly) {
1.60      matthew  4216:         return $bodytag;
1.258     albertel 4217:     } elsif ($env{'browser.interface'} eq 'textual') {
1.95      www      4218: # Accessibility
1.224     raeburn  4219:           
1.337     albertel 4220: 	$bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338     albertel 4221: 	if (!$notitle) {
1.337     albertel 4222: 	    $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
                   4223: 	}
                   4224: 	return $bodytag;
1.359     albertel 4225:     }
                   4226: 
1.410     albertel 4227:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4228:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4229: 	undef($role);
1.434     albertel 4230:     } else {
                   4231: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4232:     }
1.359     albertel 4233:     
                   4234:     my $roleinfo=(<<ENDROLE);
                   4235: <td class="LC_title_bar_who">
                   4236: <div class="LC_title_bar_name">
1.410     albertel 4237:     $name
1.361     albertel 4238:     &nbsp;
1.359     albertel 4239: </div>
                   4240: <div class="LC_title_bar_role">
1.361     albertel 4241: $role&nbsp;
1.359     albertel 4242: </div>
                   4243: <div class="LC_title_bar_realm">
1.361     albertel 4244: $realm&nbsp;
1.359     albertel 4245: </div>
1.206     albertel 4246: </td>
                   4247: ENDROLE
1.235     raeburn  4248: 
1.359     albertel 4249:     my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
                   4250:     if ($customtitle) {
                   4251:         $titleinfo = $customtitle;
                   4252:     }
                   4253:     #
                   4254:     # Extra info if you are the DC
                   4255:     my $dc_info = '';
                   4256:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4257:                         $env{'course.'.$env{'request.course.id'}.
                   4258:                                  '.domain'}.'/'})) {
                   4259:         my $cid = $env{'request.course.id'};
                   4260:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4261:         $dc_info =~ s/\s+$//;
1.359     albertel 4262:         $dc_info = '('.$dc_info.')';
                   4263:     }
                   4264: 
1.644     www      4265:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4266:         # No Remote
1.258     albertel 4267: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4268: 	    $forcereg=1;
                   4269: 	}
                   4270: 
                   4271: 	if (!$customtitle && $env{'request.state'} eq 'construct') {
                   4272: 	    # this is for resources; directories have customtitle, and crumbs
                   4273:             # and select recent are created in lonpubdir.pm  
1.229     albertel 4274: 	    my ($uname,$thisdisfn)=
1.258     albertel 4275: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 4276: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4277: 	    $formaction=~s/\/+/\//g;
                   4278: 
1.359     albertel 4279: 	    my $parentpath = '';
                   4280: 	    my $lastitem = '';
                   4281: 	    if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4282: 		$parentpath = $1;
                   4283: 		$lastitem = $2;
                   4284: 	    } else {
                   4285: 		$lastitem = $thisdisfn;
                   4286: 	    }
                   4287: 	    $titleinfo = 
1.640     bisitz   4288: 		&Apache::loncommon::help_open_menu('','',3,'Authoring')
                   4289: 		.'<b>'.&mt('Construction Space').'</b>:&nbsp;'
                   4290: 		.'<form name="dirs" method="post" action="'.$formaction
1.359     albertel 4291: 		.'" target="_top"><tt><b>'
1.705     tempelho 4292: 		.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359     albertel 4293: 		.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4294: 		.'</form>'
                   4295: 		.&Apache::lonmenu::constspaceform();
1.235     raeburn  4296:         }
1.359     albertel 4297: 
1.337     albertel 4298:         my $titletable;
1.338     albertel 4299: 	if (!$notitle) {
1.337     albertel 4300: 	    $titletable =
1.359     albertel 4301: 		'<table id="LC_title_bar">'.
                   4302:                          "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
                   4303: 			 '</tr></table>';
1.337     albertel 4304: 	}
1.359     albertel 4305: 	if ($notopbar) {
                   4306: 	    $bodytag .= $titletable;
                   4307: 	} else {
                   4308: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4309:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4310: 							  $titletable);
1.272     raeburn  4311:             } else {
1.336     albertel 4312:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4313: 		    $titletable;
1.272     raeburn  4314:             }
1.235     raeburn  4315:         }
                   4316:         return $bodytag;
1.94      www      4317:     }
1.95      www      4318: 
1.93      www      4319: #
1.95      www      4320: # Top frame rendering, Remote is up
1.93      www      4321: #
1.359     albertel 4322: 
1.517     raeburn  4323:     my $imgsrc = $img;
                   4324:     if ($img =~ /^\/adm/) {
1.575     albertel 4325:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4326:     }
                   4327:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4328: 
1.305     www      4329:     # Explicit link to get inline menu
1.361     albertel 4330:     my $menu= ($no_inline_link?''
                   4331: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4332:     #
1.338     albertel 4333:     if ($notitle) {
1.337     albertel 4334: 	return $bodytag;
                   4335:     }
1.94      www      4336:     return(<<ENDBODY);
1.60      matthew  4337: $bodytag
1.359     albertel 4338: <table id="LC_title_bar" class="LC_with_remote">
1.368     albertel 4339: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359     albertel 4340:     <td class="LC_title_bar_domain_logo">$messages&nbsp;</td>
1.54      www      4341: </tr>
1.359     albertel 4342: <tr><td>$titleinfo $dc_info $menu</td>
                   4343: $roleinfo
1.368     albertel 4344: </tr>
1.356     albertel 4345: </table>
1.54      www      4346: ENDBODY
1.182     matthew  4347: }
                   4348: 
1.330     albertel 4349: sub make_attr_string {
                   4350:     my ($register,$attr_ref) = @_;
                   4351: 
                   4352:     if ($attr_ref && !ref($attr_ref)) {
                   4353: 	die("addentries Must be a hash ref ".
                   4354: 	    join(':',caller(1))." ".
                   4355: 	    join(':',caller(0))." ");
                   4356:     }
                   4357: 
                   4358:     if ($register) {
1.339     albertel 4359: 	my ($on_load,$on_unload);
                   4360: 	foreach my $key (keys(%{$attr_ref})) {
                   4361: 	    if      (lc($key) eq 'onload') {
                   4362: 		$on_load.=$attr_ref->{$key}.';';
                   4363: 		delete($attr_ref->{$key});
                   4364: 
                   4365: 	    } elsif (lc($key) eq 'onunload') {
                   4366: 		$on_unload.=$attr_ref->{$key}.';';
                   4367: 		delete($attr_ref->{$key});
                   4368: 	    }
                   4369: 	}
                   4370: 	$attr_ref->{'onload'}  =
                   4371: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4372: 	$attr_ref->{'onunload'}=
                   4373: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4374:     }
                   4375: 
                   4376: # Accessibility font enhance
                   4377:     if ($env{'browser.fontenhance'} eq 'on') {
                   4378: 	my $style;
                   4379: 	foreach my $key (keys(%{$attr_ref})) {
                   4380: 	    if (lc($key) eq 'style') {
                   4381: 		$style.=$attr_ref->{$key}.';';
                   4382: 		delete($attr_ref->{$key});
                   4383: 	    }
                   4384: 	}
                   4385: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4386:     }
1.339     albertel 4387: 
                   4388:     if ($env{'browser.blackwhite'} eq 'on') {
                   4389: 	delete($attr_ref->{'font'});
                   4390: 	delete($attr_ref->{'link'});
                   4391: 	delete($attr_ref->{'alink'});
                   4392: 	delete($attr_ref->{'vlink'});
                   4393: 	delete($attr_ref->{'bgcolor'});
                   4394: 	delete($attr_ref->{'background'});
                   4395:     }
                   4396: 
1.330     albertel 4397:     my $attr_string;
                   4398:     foreach my $attr (keys(%$attr_ref)) {
                   4399: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4400:     }
                   4401:     return $attr_string;
                   4402: }
                   4403: 
                   4404: 
1.182     matthew  4405: ###############################################
1.251     albertel 4406: ###############################################
                   4407: 
                   4408: =pod
                   4409: 
                   4410: =item * &endbodytag()
                   4411: 
                   4412: Returns a uniform footer for LON-CAPA web pages.
                   4413: 
1.635     raeburn  4414: Inputs: 1 - optional reference to an args hash
                   4415: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4416: a 'Continue' link is not displayed if the page contains an
                   4417: internal redirect in the <head></head> section,
                   4418: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4419: 
                   4420: =cut
                   4421: 
                   4422: sub endbodytag {
1.635     raeburn  4423:     my ($args) = @_;
1.251     albertel 4424:     my $endbodytag='</body>';
1.269     albertel 4425:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4426:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4427:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4428: 	    $endbodytag=
                   4429: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4430: 	        &mt('Continue').'</a>'.
                   4431: 	        $endbodytag;
                   4432:         }
1.315     albertel 4433:     }
1.251     albertel 4434:     return $endbodytag;
                   4435: }
                   4436: 
1.352     albertel 4437: =pod
                   4438: 
                   4439: =item * &standard_css()
                   4440: 
                   4441: Returns a style sheet
                   4442: 
                   4443: Inputs: (all optional)
                   4444:             domain         -> force to color decorate a page for a specific
                   4445:                                domain
                   4446:             function       -> force usage of a specific rolish color scheme
                   4447:             bgcolor        -> override the default page bgcolor
                   4448: 
                   4449: =cut
                   4450: 
1.343     albertel 4451: sub standard_css {
1.345     albertel 4452:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4453:     $function  = &get_users_function() if (!$function);
                   4454:     my $img    = &designparm($function.'.img',   $domain);
                   4455:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4456:     my $font   = &designparm($function.'.font',  $domain);
1.345     albertel 4457:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4458:     my $pgbg_or_bgcolor =
                   4459: 	         $bgcolor ||
1.352     albertel 4460: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4461:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4462:     my $alink  = &designparm($function.'.alink', $domain);
                   4463:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4464:     my $link   = &designparm($function.'.link',  $domain);
                   4465: 
1.704     muellerd 4466:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4467:     my $bgcol = &designparm('login.bgcol',$domain);
                   4468:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4469: 
1.602     albertel 4470:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4471:     my $mono                 = 'monospace';
1.352     albertel 4472:     my $data_table_head      = $tabbg;
                   4473:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4474:     my $data_table_dark      = '#DDDDDD';
                   4475:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4476:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4477:     my $mail_new             = '#FFBB77';
                   4478:     my $mail_new_hover       = '#DD9955';
                   4479:     my $mail_read            = '#BBBB77';
                   4480:     my $mail_read_hover      = '#999944';
                   4481:     my $mail_replied         = '#AAAA88';
                   4482:     my $mail_replied_hover   = '#888855';
                   4483:     my $mail_other           = '#99BBBB';
                   4484:     my $mail_other_hover     = '#669999';
1.391     albertel 4485:     my $table_header         = '#DDDDDD';
1.489     raeburn  4486:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4487:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4488: 
1.608     albertel 4489:     my $border = ($env{'browser.type'} eq 'explorer' ||
                   4490: 		  $env{'browser.type'} eq 'safari'     ) ? '0px 2px 0px 2px'
                   4491: 	                                                 : '0px 3px 0px 4px';
1.448     albertel 4492: 
1.523     albertel 4493: 
1.343     albertel 4494:     return <<END;
1.698     harmsja  4495: body{
                   4496:      font-family: $sans;
                   4497:      line-height:130%;
1.701     harmsja  4498:      font-size:0.83em;
1.698     harmsja  4499:      color:$font;
                   4500:   }
1.701     harmsja  4501: a:link, a:visited { font-size:100%; }
1.698     harmsja  4502: 
1.343     albertel 4503: a:focus { color: red; background: yellow } 
1.510     albertel 4504: table.thinborder,
                   4505: table.thinborder tr th {
                   4506:   border-style: solid;
                   4507:   border-width: 1px;
1.698     harmsja  4508:   border-color: $lg_border_color;
1.510     albertel 4509:   background: $tabbg;
                   4510: }
1.523     albertel 4511: table.thinborder tr td {
1.510     albertel 4512:   border-style: solid;
1.698     harmsja  4513:   border-width: 1px;
                   4514:   border-color: $lg_border_color;
1.510     albertel 4515: }
1.426     albertel 4516: 
1.343     albertel 4517: form, .inline { display: inline; }
1.721     harmsja  4518: 
                   4519: .LC_center { text-align: center; }
                   4520: .LC_left { text-align:left; }
                   4521: .LC_right {text-align:right;}
                   4522: .LC_middle {vertical-align:middle;}
                   4523: .LC_top {vertical-align:top;}
                   4524: .LC_bottom {vertical-align:bottom;}
                   4525: 
                   4526: /* just for tests */
                   4527: .LC_300Box { width:300px; }
                   4528: .LC_200Box {width:200px; }
                   4529: .LC_500Box {width:500px; }
                   4530: .LC_600Box {width:600px; }
1.741     harmsja  4531: .LC_800Box {width:800px;}
1.721     harmsja  4532: /* end */
                   4533: 
1.593     albertel 4534: .LC_filename {font-family: $mono; white-space:pre;}
1.350     albertel 4535: .LC_error {
                   4536:   color: red;
                   4537:   font-size: larger;
                   4538: }
1.457     albertel 4539: .LC_warning,
                   4540: .LC_diff_removed {
1.733     bisitz   4541:   color: red;
1.394     albertel 4542: }
1.532     albertel 4543: 
                   4544: .LC_info,
1.457     albertel 4545: .LC_success,
                   4546: .LC_diff_added {
1.350     albertel 4547:   color: green;
                   4548: }
1.543     albertel 4549: .LC_unknown {
                   4550:   color: yellow;
                   4551: }
                   4552: 
1.440     albertel 4553: .LC_icon {
                   4554:   border: 0px;
                   4555: }
1.539     albertel 4556: .LC_indexer_icon {
                   4557:   border: 0px;
                   4558:   height: 22px;
                   4559: }
1.543     albertel 4560: .LC_docs_spacer {
                   4561:   width: 25px;
                   4562:   height: 1px;
                   4563:   border: 0px;
                   4564: }
1.346     albertel 4565: 
1.532     albertel 4566: .LC_internal_info {
1.735     bisitz   4567:   color: #999999;
1.532     albertel 4568: }
                   4569: 
1.458     albertel 4570: table.LC_pastsubmission {
                   4571:   border: 1px solid black;
                   4572:   margin: 2px;
                   4573: }
                   4574: 
1.606     albertel 4575: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345     albertel 4576:   width: 100%;
                   4577:   background: $pgbg;
1.392     albertel 4578:   border: 2px;
1.402     albertel 4579:   border-collapse: separate;
1.403     albertel 4580:   padding: 0px;
1.345     albertel 4581: }
1.392     albertel 4582: 
1.606     albertel 4583: table#LC_title_bar, table.LC_breadcrumbs, 
1.393     albertel 4584: table#LC_title_bar.LC_with_remote {
1.359     albertel 4585:   width: 100%;
1.392     albertel 4586:   border-color: $pgbg;
                   4587:   border-style: solid;
                   4588:   border-width: $border;
                   4589: 
1.379     albertel 4590:   background: $pgbg;
                   4591:   font-family: $sans;
1.392     albertel 4592:   border-collapse: collapse;
1.403     albertel 4593:   padding: 0px;
1.359     albertel 4594: }
1.409     albertel 4595: table.LC_docs_path {
                   4596:   width: 100%;
                   4597:   border: 0;
                   4598:   background: $pgbg;
                   4599:   font-family: $sans;
                   4600:   border-collapse: collapse;
                   4601:   padding: 0px;
                   4602: }
                   4603: 
1.359     albertel 4604: table#LC_title_bar td {
                   4605:   background: $tabbg;
                   4606: }
                   4607: table#LC_title_bar td.LC_title_bar_who {
                   4608:   background: $tabbg;
                   4609:   color: $font;
1.427     albertel 4610:   font: small $sans;
1.359     albertel 4611:   text-align: right;
                   4612: }
1.469     banghart 4613: span.LC_metadata {
                   4614:     font-family: $sans;
                   4615: }
1.359     albertel 4616: span.LC_title_bar_title {
1.416     albertel 4617:   font: bold x-large $sans;
1.359     albertel 4618: }
                   4619: table#LC_title_bar td.LC_title_bar_domain_logo {
                   4620:   background: $sidebg;
                   4621:   text-align: right;
1.368     albertel 4622:   padding: 0px;
                   4623: }
                   4624: table#LC_title_bar td.LC_title_bar_role_logo {
                   4625:   background: $sidebg;
                   4626:   padding: 0px;
1.359     albertel 4627: }
                   4628: 
1.706     harmsja  4629: table#LC_menubuttons img{
1.346     albertel 4630:   border: 0px;
                   4631: }
1.345     albertel 4632: table#LC_top_nav td {
                   4633:   background: $tabbg;
1.392     albertel 4634:   border: 0px;
1.407     albertel 4635:   font-size: small;
1.706     harmsja  4636:   vertical-align:top;
                   4637:   padding:2px 5px 2px 5px;
1.345     albertel 4638: }
                   4639: table#LC_top_nav td a, div#LC_top_nav a {
                   4640:   color: $font;
                   4641:   font-family: $sans;
                   4642: }
1.364     albertel 4643: table#LC_top_nav td.LC_top_nav_logo {
                   4644:   background: $tabbg;
1.432     albertel 4645:   text-align: left;
1.408     albertel 4646:   white-space: nowrap;
1.432     albertel 4647:   width: 31px;
1.408     albertel 4648: }
                   4649: table#LC_top_nav td.LC_top_nav_logo img {
1.432     albertel 4650:   border: 0px;
1.408     albertel 4651:   vertical-align: bottom;
1.364     albertel 4652: }
1.432     albertel 4653: table#LC_top_nav td.LC_top_nav_exit,
                   4654: table#LC_top_nav td.LC_top_nav_help {
                   4655:   width: 2.0em;
                   4656: }
1.442     albertel 4657: table#LC_top_nav td.LC_top_nav_login {
                   4658:   width: 4.0em;
                   4659:   text-align: center;
                   4660: }
1.409     albertel 4661: table.LC_breadcrumbs td, table.LC_docs_path td  {
1.357     albertel 4662:   background: $tabbg;
                   4663:   color: $font;
                   4664:   font-family: $sans;
1.358     albertel 4665:   font-size: smaller;
1.357     albertel 4666: }
1.411     albertel 4667: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409     albertel 4668: table.LC_docs_path td.LC_docs_path_component {
1.357     albertel 4669:   background: $tabbg;
                   4670:   color: $font;
                   4671:   font-family: $sans;
                   4672:   font-size: larger;
                   4673:   text-align: right;
                   4674: }
1.383     albertel 4675: td.LC_table_cell_checkbox {
                   4676:   text-align: center;
                   4677: }
1.522     albertel 4678: table#LC_mainmenu td.LC_mainmenu_column {
                   4679:     vertical-align: top;
                   4680: }
                   4681: 
1.705     tempelho 4682: .LC_fontsize_small
                   4683: {
                   4684:  font-size: 70%;
                   4685: }
                   4686: 
                   4687: .LC_fontsize_medium
                   4688: {
                   4689:  font-size: 85%;
                   4690: }
                   4691: 
                   4692: .LC_fontsize_large
                   4693: {
                   4694:  font-size: 120%;
                   4695: }
                   4696: 
                   4697: .LC_fontcolor_red
                   4698: {
                   4699:  color: #FF0000;
                   4700: }
                   4701: 
1.346     albertel 4702: .LC_menubuttons_inline_text {
                   4703:   color: $font;
                   4704:   font-family: $sans;
1.698     harmsja  4705:   font-size: 90%;
1.701     harmsja  4706:   padding-left:3px;
1.346     albertel 4707: }
                   4708: 
1.526     www      4709: .LC_menubuttons_link {
                   4710:   text-decoration: none;
                   4711: }
1.698     harmsja  4712: /*2008--9-5: new menu style sheet.Changed category*/
1.522     albertel 4713: .LC_menubuttons_category {
1.521     www      4714:   color: $font;
1.526     www      4715:   background: $pgbg;
1.521     www      4716:   font-family: $sans;
                   4717:   font-size: larger;
                   4718:   font-weight: bold;
                   4719: }
                   4720: 
1.346     albertel 4721: td.LC_menubuttons_text {
1.701     harmsja  4722:  	color: $font; 	
1.346     albertel 4723: }
1.706     harmsja  4724: 
                   4725: 
1.526     www      4726: 
1.346     albertel 4727: .LC_current_location {
                   4728:   font-family: $sans;
                   4729:   background: $tabbg;
                   4730: }
                   4731: .LC_new_mail {
                   4732:   font-family: $sans;
1.634     www      4733:   background: $tabbg;
1.346     albertel 4734:   font-weight: bold;
                   4735: }
1.347     albertel 4736: 
1.526     www      4737: 
1.527     www      4738: .LC_dropadd_labeltext {
                   4739:   font-family: $sans;
                   4740:   text-align: right;
                   4741: }
                   4742: 
                   4743: .LC_preferences_labeltext {
                   4744:   font-family: $sans;
                   4745:   text-align: right;
                   4746: }
                   4747: 
1.666     raeburn  4748: .LC_roleslog_note {
1.701     harmsja  4749:   font-size: small;
1.666     raeburn  4750: }
                   4751: 
1.715     raeburn  4752: .LC_mail_functions {
                   4753:     font-weight: bold;
                   4754: }
                   4755: 
1.440     albertel 4756: table.LC_aboutme_port {
                   4757:   border: 0px;
                   4758:   border-collapse: collapse;
                   4759:   border-spacing: 0px;
                   4760: }
1.349     albertel 4761: table.LC_data_table, table.LC_mail_list {
1.347     albertel 4762:   border: 1px solid #000000;
1.402     albertel 4763:   border-collapse: separate;
1.426     albertel 4764:   border-spacing: 1px;
1.610     albertel 4765:   background: $pgbg;
1.347     albertel 4766: }
1.422     albertel 4767: .LC_data_table_dense {
                   4768:   font-size: small;
                   4769: }
1.507     raeburn  4770: table.LC_nested_outer {
                   4771:   border: 1px solid #000000;
1.589     raeburn  4772:   border-collapse: collapse;
1.507     raeburn  4773:   border-spacing: 0px;
                   4774:   width: 100%;
                   4775: }
                   4776: table.LC_nested {
                   4777:   border: 0px;
1.589     raeburn  4778:   border-collapse: collapse;
1.507     raeburn  4779:   border-spacing: 0px;
                   4780:   width: 100%;
                   4781: }
1.523     albertel 4782: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
                   4783: table.LC_prior_tries tr th {
1.349     albertel 4784:   font-weight: bold;
                   4785:   background-color: $data_table_head;
1.701     harmsja  4786:   font-size:90%;
1.347     albertel 4787: }
1.711     raeburn  4788: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4789:   background-color: #CCCCCC;
1.711     raeburn  4790:   font-weight: bold;
                   4791:   text-align: left;
                   4792: }
1.610     albertel 4793: table.LC_data_table tr.LC_odd_row > td, 
1.709     bisitz   4794: table.LC_pick_box tr > td.LC_odd_row,
1.440     albertel 4795: table.LC_aboutme_port tr td {
1.349     albertel 4796:   background-color: $data_table_light;
1.425     albertel 4797:   padding: 2px;
1.347     albertel 4798: }
1.610     albertel 4799: table.LC_data_table tr.LC_even_row > td,
1.709     bisitz   4800: table.LC_pick_box tr > td.LC_even_row,
1.440     albertel 4801: table.LC_aboutme_port tr.LC_even_row td {
1.349     albertel 4802:   background-color: $data_table_dark;
1.709     bisitz   4803:   padding: 2px;
1.347     albertel 4804: }
1.425     albertel 4805: table.LC_data_table tr.LC_data_table_highlight td {
                   4806:   background-color: $data_table_darker;
                   4807: }
1.639     raeburn  4808: table.LC_data_table tr td.LC_leftcol_header {
                   4809:   background-color: $data_table_head;
                   4810:   font-weight: bold;
                   4811: }
1.451     albertel 4812: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4813: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4814:   background-color: #FFFFFF;
1.421     albertel 4815:   font-weight: bold;
                   4816:   font-style: italic;
                   4817:   text-align: center;
                   4818:   padding: 8px;
1.347     albertel 4819: }
1.507     raeburn  4820: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4821:   padding: 4ex
                   4822: }
1.507     raeburn  4823: table.LC_nested_outer tr th {
                   4824:   font-weight: bold;
                   4825:   background-color: $data_table_head;
1.701     harmsja  4826:   font-size: small;
1.507     raeburn  4827:   border-bottom: 1px solid #000000;
                   4828: }
                   4829: table.LC_nested_outer tr td.LC_subheader {
                   4830:   background-color: $data_table_head;
                   4831:   font-weight: bold;
                   4832:   font-size: small;
                   4833:   border-bottom: 1px solid #000000;
                   4834:   text-align: right;
1.451     albertel 4835: }
1.507     raeburn  4836: table.LC_nested tr.LC_info_row td {
1.735     bisitz   4837:   background-color: #CCCCCC;
1.451     albertel 4838:   font-weight: bold;
                   4839:   font-size: small;
1.507     raeburn  4840:   text-align: center;
                   4841: }
1.589     raeburn  4842: table.LC_nested tr.LC_info_row td.LC_left_item,
                   4843: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  4844:   text-align: left;
1.451     albertel 4845: }
1.507     raeburn  4846: table.LC_nested td {
1.735     bisitz   4847:   background-color: #FFFFFF;
1.451     albertel 4848:   font-size: small;
1.507     raeburn  4849: }
                   4850: table.LC_nested_outer tr th.LC_right_item,
                   4851: table.LC_nested tr.LC_info_row td.LC_right_item,
                   4852: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   4853: table.LC_nested tr td.LC_right_item {
1.451     albertel 4854:   text-align: right;
                   4855: }
                   4856: 
1.507     raeburn  4857: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   4858:   background-color: #EEEEEE;
1.451     albertel 4859: }
                   4860: 
1.473     raeburn  4861: table.LC_createuser {
                   4862: }
                   4863: 
                   4864: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  4865:   font-size: small;
1.473     raeburn  4866: }
                   4867: 
                   4868: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   4869:   background-color: #CCCCCC;
1.473     raeburn  4870:   font-weight: bold;
                   4871:   text-align: center;
                   4872: }
                   4873: 
1.349     albertel 4874: table.LC_calendar {
                   4875:   border: 1px solid #000000;
                   4876:   border-collapse: collapse;
                   4877: }
                   4878: table.LC_calendar_pickdate {
                   4879:   font-size: xx-small;
                   4880: }
                   4881: table.LC_calendar tr td {
                   4882:   border: 1px solid #000000;
                   4883:   vertical-align: top;
                   4884: }
                   4885: table.LC_calendar tr td.LC_calendar_day_empty {
                   4886:   background-color: $data_table_dark;
                   4887: }
                   4888: table.LC_calendar tr td.LC_calendar_day_current {
                   4889:   background-color: $data_table_highlight;
                   4890: }
                   4891: 
                   4892: table.LC_mail_list tr.LC_mail_new {
                   4893:   background-color: $mail_new;
                   4894: }
                   4895: table.LC_mail_list tr.LC_mail_new:hover {
                   4896:   background-color: $mail_new_hover;
                   4897: }
                   4898: table.LC_mail_list tr.LC_mail_read {
                   4899:   background-color: $mail_read;
                   4900: }
                   4901: table.LC_mail_list tr.LC_mail_read:hover {
                   4902:   background-color: $mail_read_hover;
                   4903: }
                   4904: table.LC_mail_list tr.LC_mail_replied {
                   4905:   background-color: $mail_replied;
                   4906: }
                   4907: table.LC_mail_list tr.LC_mail_replied:hover {
                   4908:   background-color: $mail_replied_hover;
                   4909: }
                   4910: table.LC_mail_list tr.LC_mail_other {
                   4911:   background-color: $mail_other;
                   4912: }
                   4913: table.LC_mail_list tr.LC_mail_other:hover {
                   4914:   background-color: $mail_other_hover;
                   4915: }
1.494     raeburn  4916: table.LC_mail_list tr.LC_mail_even {
                   4917: }
                   4918: table.LC_mail_list tr.LC_mail_odd {
                   4919: }
                   4920: 
1.696     bisitz   4921: table.LC_data_table tr > td.LC_browser_file,
                   4922: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 4923:   background: #CCFF88;
                   4924: }
1.696     bisitz   4925: table.LC_data_table tr > td.LC_browser_file_locked,
                   4926: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 4927:   background: #FFAA99;
1.387     albertel 4928: }
1.696     bisitz   4929: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389     albertel 4930:   background: #AAAAAA;
1.387     albertel 4931: }
1.696     bisitz   4932: table.LC_data_table tr > td.LC_browser_file_modified,
                   4933: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389     albertel 4934:   background: #FFFF77;
1.387     albertel 4935: }
1.696     bisitz   4936: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 4937:   background: #CCCCFF;
1.387     albertel 4938: }
1.696     bisitz   4939: 
1.707     bisitz   4940: table.LC_data_table tr > td.LC_roles_is {
                   4941: /*  background: #77FF77; */
                   4942: }
                   4943: table.LC_data_table tr > td.LC_roles_future {
                   4944:   background: #FFFF77;
                   4945: }
                   4946: table.LC_data_table tr > td.LC_roles_will {
                   4947:   background: #FFAA77;
                   4948: }
                   4949: table.LC_data_table tr > td.LC_roles_expired {
                   4950:   background: #FF7777;
                   4951: }
                   4952: table.LC_data_table tr > td.LC_roles_will_not {
                   4953:   background: #AAFF77;
                   4954: }
                   4955: table.LC_data_table tr > td.LC_roles_selected {
                   4956:   background: #11CC55;
                   4957: }
                   4958: 
1.388     albertel 4959: span.LC_current_location {
1.701     harmsja  4960:   font-size:larger;
1.388     albertel 4961:   background: $pgbg;
                   4962: }
1.387     albertel 4963: 
1.395     albertel 4964: span.LC_parm_menu_item {
                   4965:   font-size: larger;
                   4966:   font-family: $sans;
                   4967: }
                   4968: span.LC_parm_scope_all {
                   4969:   color: red;
                   4970: }
                   4971: span.LC_parm_scope_folder {
                   4972:   color: green;
                   4973: }
                   4974: span.LC_parm_scope_resource {
                   4975:   color: orange;
                   4976: }
                   4977: span.LC_parm_part {
                   4978:   color: blue;
                   4979: }
                   4980: span.LC_parm_folder, span.LC_parm_symb {
                   4981:   font-size: x-small;
                   4982:   font-family: $mono;
                   4983:   color: #AAAAAA;
                   4984: }
                   4985: 
1.396     albertel 4986: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
                   4987: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
                   4988:   border: 1px solid black;
                   4989:   border-collapse: collapse;
                   4990: }
                   4991: table.LC_parm_overview_restrictions td {
                   4992:   border-width: 1px 4px 1px 4px;
                   4993:   border-style: solid;
                   4994:   border-color: $pgbg;
                   4995:   text-align: center;
                   4996: }
                   4997: table.LC_parm_overview_restrictions th {
                   4998:   background: $tabbg;
                   4999:   border-width: 1px 4px 1px 4px;
                   5000:   border-style: solid;
                   5001:   border-color: $pgbg;
                   5002: }
1.398     albertel 5003: table#LC_helpmenu {
                   5004:   border: 0px;
                   5005:   height: 55px;
                   5006:   border-spacing: 0px;
                   5007: }
                   5008: 
                   5009: table#LC_helpmenu fieldset legend {
                   5010:   font-size: larger;
                   5011:   font-weight: bold;
                   5012: }
1.397     albertel 5013: table#LC_helpmenu_links {
                   5014:   width: 100%;
                   5015:   border: 1px solid black;
                   5016:   background: $pgbg;
                   5017:   padding: 0px;
                   5018:   border-spacing: 1px;
                   5019: }
                   5020: table#LC_helpmenu_links tr td {
                   5021:   padding: 1px;
                   5022:   background: $tabbg;
1.399     albertel 5023:   text-align: center;
                   5024:   font-weight: bold;
1.397     albertel 5025: }
1.396     albertel 5026: 
1.397     albertel 5027: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
                   5028: table#LC_helpmenu_links a:active {
                   5029:   text-decoration: none;
                   5030:   color: $font;
                   5031: }
                   5032: table#LC_helpmenu_links a:hover {
                   5033:   text-decoration: underline;
                   5034:   color: $vlink;
                   5035: }
1.396     albertel 5036: 
1.417     albertel 5037: .LC_chrt_popup_exists {
                   5038:   border: 1px solid #339933;
                   5039:   margin: -1px;
                   5040: }
                   5041: .LC_chrt_popup_up {
                   5042:   border: 1px solid yellow;
                   5043:   margin: -1px;
                   5044: }
                   5045: .LC_chrt_popup {
                   5046:   border: 1px solid #8888FF;
                   5047:   background: #CCCCFF;
                   5048: }
1.421     albertel 5049: table.LC_pick_box {
                   5050:   border-collapse: separate;
                   5051:   background: white;
                   5052:   border: 1px solid black;
                   5053:   border-spacing: 1px;
                   5054: }
                   5055: table.LC_pick_box td.LC_pick_box_title {
                   5056:   background: $tabbg;
                   5057:   font-weight: bold;
                   5058:   text-align: right;
1.740     bisitz   5059:   vertical-align: top;
1.421     albertel 5060:   width: 184px;
                   5061:   padding: 8px;
                   5062: }
1.645     raeburn  5063: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5064:   background: $tabbg;
                   5065:   font-weight: bold;
                   5066:   text-align: right;
                   5067:   width: 350px;
                   5068:   padding: 8px;
                   5069: }
                   5070: 
1.579     raeburn  5071: table.LC_pick_box td.LC_pick_box_value {
                   5072:   text-align: left;
                   5073:   padding: 8px;
                   5074: }
                   5075: table.LC_pick_box td.LC_pick_box_select {
                   5076:   text-align: left;
                   5077:   padding: 8px;
                   5078: }
1.424     albertel 5079: table.LC_pick_box td.LC_pick_box_separator {
1.421     albertel 5080:   padding: 0px;
                   5081:   height: 1px;
                   5082:   background: black;
                   5083: }
                   5084: table.LC_pick_box td.LC_pick_box_submit {
                   5085:   text-align: right;
                   5086: }
1.579     raeburn  5087: table.LC_pick_box td.LC_evenrow_value {
                   5088:   text-align: left;
                   5089:   padding: 8px;
                   5090:   background-color: $data_table_light;
                   5091: }
                   5092: table.LC_pick_box td.LC_oddrow_value {
                   5093:   text-align: left;
                   5094:   padding: 8px;
                   5095:   background-color: $data_table_light;
                   5096: }
                   5097: table.LC_helpform_receipt {
                   5098:   width: 620px;
                   5099:   border-collapse: separate;
                   5100:   background: white;
                   5101:   border: 1px solid black;
                   5102:   border-spacing: 1px;
                   5103: }
                   5104: table.LC_helpform_receipt td.LC_pick_box_title {
                   5105:   background: $tabbg;
                   5106:   font-weight: bold;
                   5107:   text-align: right;
                   5108:   width: 184px;
                   5109:   padding: 8px;
                   5110: }
                   5111: table.LC_helpform_receipt td.LC_evenrow_value {
                   5112:   text-align: left;
                   5113:   padding: 8px;
                   5114:   background-color: $data_table_light;
                   5115: }
                   5116: table.LC_helpform_receipt td.LC_oddrow_value {
                   5117:   text-align: left;
                   5118:   padding: 8px;
                   5119:   background-color: $data_table_light;
                   5120: }
                   5121: table.LC_helpform_receipt td.LC_pick_box_separator {
                   5122:   padding: 0px;
                   5123:   height: 1px;
                   5124:   background: black;
                   5125: }
                   5126: span.LC_helpform_receipt_cat {
                   5127:   font-weight: bold;
                   5128: }
1.424     albertel 5129: table.LC_group_priv_box {
                   5130:   background: white;
                   5131:   border: 1px solid black;
                   5132:   border-spacing: 1px;
                   5133: }
                   5134: table.LC_group_priv_box td.LC_pick_box_title {
                   5135:   background: $tabbg;
                   5136:   font-weight: bold;
                   5137:   text-align: right;
                   5138:   width: 184px;
                   5139: }
                   5140: table.LC_group_priv_box td.LC_groups_fixed {
                   5141:   background: $data_table_light;
                   5142:   text-align: center;
                   5143: }
                   5144: table.LC_group_priv_box td.LC_groups_optional {
                   5145:   background: $data_table_dark;
                   5146:   text-align: center;
                   5147: }
                   5148: table.LC_group_priv_box td.LC_groups_functionality {
                   5149:   background: $data_table_darker;
                   5150:   text-align: center;
                   5151:   font-weight: bold;
                   5152: }
                   5153: table.LC_group_priv td {
                   5154:   text-align: left;
                   5155:   padding: 0px;
                   5156: }
                   5157: 
1.421     albertel 5158: table.LC_notify_front_page {
                   5159:   background: white;
                   5160:   border: 1px solid black;
                   5161:   padding: 8px;
                   5162: }
                   5163: table.LC_notify_front_page td {
                   5164:   padding: 8px;
                   5165: }
1.424     albertel 5166: .LC_navbuttons {
                   5167:   margin: 2ex 0ex 2ex 0ex;
                   5168: }
1.423     albertel 5169: .LC_topic_bar {
                   5170:   font-family: $sans;
                   5171:   font-weight: bold;
                   5172:   width: 100%;
                   5173:   background: $tabbg;
                   5174:   vertical-align: middle;
                   5175:   margin: 2ex 0ex 2ex 0ex;
                   5176: }
                   5177: .LC_topic_bar span {
                   5178:   vertical-align: middle;
                   5179: }
                   5180: .LC_topic_bar img {
                   5181:   vertical-align: bottom;
                   5182: }
                   5183: table.LC_course_group_status {
                   5184:   margin: 20px;
                   5185: }
                   5186: table.LC_status_selector td {
                   5187:   vertical-align: top;
                   5188:   text-align: center;
1.424     albertel 5189:   padding: 4px;
                   5190: }
                   5191: table.LC_descriptive_input td.LC_description {
                   5192:   vertical-align: top;
                   5193:   text-align: right;
                   5194:   font-weight: bold;
1.423     albertel 5195: }
1.599     albertel 5196: div.LC_feedback_link {
1.616     albertel 5197:   clear: both;
1.599     albertel 5198:   background: white;
                   5199:   width: 100%;  
1.489     raeburn  5200: }
                   5201: span.LC_feedback_link {
1.599     albertel 5202:   background: $feedback_link_bg;
                   5203:   font-size: larger;
                   5204: }
                   5205: span.LC_message_link {
                   5206:   background: $feedback_link_bg;
                   5207:   font-size: larger;
                   5208:   position: absolute;
                   5209:   right: 1em;
1.489     raeburn  5210: }
1.421     albertel 5211: 
1.515     albertel 5212: table.LC_prior_tries {
1.524     albertel 5213:   border: 1px solid #000000;
                   5214:   border-collapse: separate;
                   5215:   border-spacing: 1px;
1.515     albertel 5216: }
1.523     albertel 5217: 
1.515     albertel 5218: table.LC_prior_tries td {
1.524     albertel 5219:   padding: 2px;
1.515     albertel 5220: }
1.523     albertel 5221: 
                   5222: .LC_answer_correct {
                   5223:   background: #AAFFAA;
                   5224:   color: black;
                   5225: }
                   5226: .LC_answer_charged_try {
                   5227:   background: #FFAAAA ! important;
                   5228:   color: black;
                   5229: }
                   5230: .LC_answer_not_charged_try, 
                   5231: .LC_answer_no_grade,
                   5232: .LC_answer_late {
                   5233:   background: #FFFFAA;
                   5234:   color: black;
                   5235: }
                   5236: .LC_answer_previous {
                   5237:   background: #AAAAFF;
                   5238:   color: black;
                   5239: }
                   5240: .LC_answer_no_message {
                   5241:   background: #FFFFFF;
                   5242:   color: black;
                   5243: }
                   5244: .LC_answer_unknown {
                   5245:   background: orange;
                   5246:   color: black;
                   5247: }
                   5248: 
                   5249: 
1.529     albertel 5250: span.LC_prior_numerical,
                   5251: span.LC_prior_string,
                   5252: span.LC_prior_custom,
                   5253: span.LC_prior_reaction,
                   5254: span.LC_prior_math {
1.523     albertel 5255:   font-family: monospace;
                   5256:   white-space: pre;
                   5257: }
                   5258: 
1.525     albertel 5259: span.LC_prior_string {
                   5260:   font-family: monospace;
                   5261:   white-space: pre;
                   5262: }
                   5263: 
1.523     albertel 5264: table.LC_prior_option {
                   5265:   width: 100%;
                   5266:   border-collapse: collapse;
                   5267: }
1.528     albertel 5268: table.LC_prior_rank, table.LC_prior_match {
                   5269:   border-collapse: collapse;
                   5270: }
                   5271: table.LC_prior_option tr td,
                   5272: table.LC_prior_rank tr td,
                   5273: table.LC_prior_match tr td {
1.524     albertel 5274:   border: 1px solid #000000;
1.515     albertel 5275: }
                   5276: 
1.519     raeburn  5277: span.LC_nobreak {
1.544     albertel 5278:   white-space: nowrap;
1.519     raeburn  5279: }
                   5280: 
1.576     raeburn  5281: span.LC_cusr_emph {
                   5282:   font-style: italic;
                   5283: }
                   5284: 
1.633     raeburn  5285: span.LC_cusr_subheading {
                   5286:   font-weight: normal;
                   5287:   font-size: 85%;
                   5288: }
                   5289: 
1.545     albertel 5290: table.LC_docs_documents {
                   5291:   background: #BBBBBB;
1.547     albertel 5292:   border-width: 0px;
1.545     albertel 5293:   border-collapse: collapse;
                   5294: }
                   5295: 
                   5296: table.LC_docs_documents td.LC_docs_document {
                   5297:   border: 2px solid black;
                   5298:   padding: 4px;
                   5299: }
                   5300: 
                   5301: .LC_docs_entry_move {
                   5302:   border: 0px;
                   5303:   border-collapse: collapse;
1.544     albertel 5304: }
                   5305: 
1.545     albertel 5306: .LC_docs_entry_move td {
                   5307:   border: 2px solid #BBBBBB;
                   5308:   background: #DDDDDD;
                   5309: }
                   5310: 
                   5311: .LC_docs_editor td.LC_docs_entry_commands {
                   5312:   background: #DDDDDD;
                   5313:   font-size: x-small;
                   5314: }
1.544     albertel 5315: .LC_docs_copy {
1.545     albertel 5316:   color: #000099;
1.544     albertel 5317: }
                   5318: .LC_docs_cut {
1.545     albertel 5319:   color: #550044;
1.544     albertel 5320: }
                   5321: .LC_docs_rename {
1.545     albertel 5322:   color: #009900;
1.544     albertel 5323: }
                   5324: .LC_docs_remove {
1.545     albertel 5325:   color: #990000;
                   5326: }
                   5327: 
1.547     albertel 5328: .LC_docs_reinit_warn,
                   5329: .LC_docs_ext_edit {
                   5330:   font-size: x-small;
                   5331: }
                   5332: 
1.545     albertel 5333: .LC_docs_editor td.LC_docs_entry_title,
                   5334: .LC_docs_editor td.LC_docs_entry_icon {
                   5335:   background: #FFFFBB;
                   5336: }
                   5337: .LC_docs_editor td.LC_docs_entry_parameter {
                   5338:   background: #BBBBFF;
                   5339:   font-size: x-small;
                   5340:   white-space: nowrap;
                   5341: }
                   5342: 
                   5343: table.LC_docs_adddocs td,
                   5344: table.LC_docs_adddocs th {
                   5345:   border: 1px solid #BBBBBB;
                   5346:   padding: 4px;
                   5347:   background: #DDDDDD;
1.543     albertel 5348: }
                   5349: 
1.584     albertel 5350: table.LC_sty_begin {
                   5351:   background: #BBFFBB;
                   5352: }
                   5353: table.LC_sty_end {
                   5354:   background: #FFBBBB;
                   5355: }
                   5356: 
1.589     raeburn  5357: table.LC_double_column {
                   5358:   border-width: 0px;
                   5359:   border-collapse: collapse;
                   5360:   width: 100%;
                   5361:   padding: 2px;
                   5362: }
                   5363: 
                   5364: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5365:   top: 2px;
1.589     raeburn  5366:   left: 2px;
                   5367:   width: 47%;
                   5368:   vertical-align: top;
                   5369: }
                   5370: 
                   5371: table.LC_double_column tr td.LC_right_col {
                   5372:   top: 2px;
                   5373:   right: 2px; 
                   5374:   width: 47%;
                   5375:   vertical-align: top;
                   5376: }
                   5377: 
1.594     raeburn  5378: span.LC_role_level {
                   5379:   font-weight: bold;
                   5380: }
                   5381: 
1.591     raeburn  5382: div.LC_left_float {
                   5383:   float: left;
                   5384:   padding-right: 5%;
1.597     albertel 5385:   padding-bottom: 4px;
1.591     raeburn  5386: }
                   5387: 
                   5388: div.LC_clear_float_header {
1.597     albertel 5389:   padding-bottom: 2px;
1.591     raeburn  5390: }
                   5391: 
                   5392: div.LC_clear_float_footer {
1.597     albertel 5393:   padding-top: 10px;
1.591     raeburn  5394:   clear: both;
                   5395: }
                   5396: 
1.597     albertel 5397: 
                   5398: div.LC_grade_show_user {
                   5399:   margin-top: 20px;
                   5400:   border: 1px solid black;
                   5401: }
                   5402: div.LC_grade_user_name {
                   5403:   background: #DDDDEE;
                   5404:   border-bottom: 1px solid black;
1.705     tempelho 5405:   font-weight: bold;
                   5406:   font-size: large;
1.597     albertel 5407: }
                   5408: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5409:   background: #DDEEDD;
                   5410: }
                   5411: 
                   5412: div.LC_grade_show_problem,
                   5413: div.LC_grade_submissions,
                   5414: div.LC_grade_message_center,
                   5415: div.LC_grade_info_links,
                   5416: div.LC_grade_assign {
                   5417:   margin: 5px;
                   5418:   width: 99%;
                   5419:   background: #FFFFFF;
                   5420: }
                   5421: div.LC_grade_show_problem_header,
                   5422: div.LC_grade_submissions_header,
                   5423: div.LC_grade_message_center_header,
                   5424: div.LC_grade_assign_header {
1.705     tempelho 5425:   font-weight: bold;
                   5426:   font-size: large;
1.597     albertel 5427: }
                   5428: div.LC_grade_show_problem_problem,
                   5429: div.LC_grade_submissions_body,
                   5430: div.LC_grade_message_center_body,
                   5431: div.LC_grade_assign_body {
                   5432:   border: 1px solid black;
                   5433:   width: 99%;
                   5434:   background: #FFFFFF;
                   5435: }
1.598     albertel 5436: span.LC_grade_check_note {
1.705     tempelho 5437:   font-weight: normal;
                   5438:   font-size: medium;
1.598     albertel 5439:   display: inline;
                   5440:   position: absolute;
                   5441:   right: 1em;
                   5442: }
1.597     albertel 5443: 
1.613     albertel 5444: table.LC_scantron_action {
                   5445:   width: 100%;
                   5446: }
                   5447: table.LC_scantron_action tr th {
1.698     harmsja  5448:   font-weight:bold;
                   5449:   font-style:normal;
1.613     albertel 5450: }
1.698     harmsja  5451: .LC_edit_problem_header, 
1.614     albertel 5452: div.LC_edit_problem_footer {
1.705     tempelho 5453:   font-weight: normal;
                   5454:   font-size:  medium;
1.602     albertel 5455:   margin: 2px;
1.600     albertel 5456: }
                   5457: div.LC_edit_problem_header,
1.602     albertel 5458: div.LC_edit_problem_header div,
1.614     albertel 5459: div.LC_edit_problem_footer,
                   5460: div.LC_edit_problem_footer div,
1.602     albertel 5461: div.LC_edit_problem_editxml_header,
                   5462: div.LC_edit_problem_editxml_header div {
1.600     albertel 5463:   margin-top: 5px;
                   5464: }
1.602     albertel 5465: div.LC_edit_problem_header_edit_row {
                   5466:   background: $tabbg;
                   5467:   padding: 3px;
                   5468:   margin-bottom: 5px;
                   5469: }
1.600     albertel 5470: div.LC_edit_problem_header_title {
1.705     tempelho 5471:   font-weight: bold;
                   5472:   font-size: larger;
1.602     albertel 5473:   background: $tabbg;
                   5474:   padding: 3px;
                   5475: }
                   5476: table.LC_edit_problem_header_title {
1.705     tempelho 5477:   font-size: larger;
                   5478:   font-weight:  bold;
1.602     albertel 5479:   width: 100%;
                   5480:   border-color: $pgbg;
                   5481:   border-style: solid;
                   5482:   border-width: $border;
                   5483: 
1.600     albertel 5484:   background: $tabbg;
1.602     albertel 5485:   border-collapse: collapse;
                   5486:   padding: 0px
                   5487: }
                   5488: 
                   5489: div.LC_edit_problem_discards {
                   5490:   float: left;
                   5491:   padding-bottom: 5px;
                   5492: }
                   5493: div.LC_edit_problem_saves {
                   5494:   float: right;
                   5495:   padding-bottom: 5px;
1.600     albertel 5496: }
                   5497: hr.LC_edit_problem_divide {
1.602     albertel 5498:   clear: both;
1.600     albertel 5499:   color: $tabbg;
                   5500:   background-color: $tabbg;
                   5501:   height: 3px;
                   5502:   border: 0px;
                   5503: }
1.679     riegler  5504: img.stift{
1.678     riegler  5505:   border-width:0;
1.679     riegler  5506:   vertical-align:middle;
1.677     riegler  5507: }
1.680     riegler  5508: 
1.681     riegler  5509: table#LC_mainmenu{
                   5510:  margin-top:10px;
                   5511:  width:80%;
                   5512: 
                   5513: }
                   5514: 
1.680     riegler  5515: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5516:   vertical-align: top;
                   5517:   width: 45%;
                   5518: }
                   5519: .LC_mainmenu_fieldset_category {
                   5520:   color: $font;
                   5521:   background: $pgbg;
                   5522:   font-family: $sans;
                   5523:   font-size: small;
                   5524:   font-weight: bold;
                   5525: }
                   5526: 
1.716     raeburn  5527: div.LC_createcourse {
                   5528:     margin: 10px 10px 10px 10px;
                   5529: }
                   5530: 
1.693     droeschl 5531: /* ---- Remove when done ----
                   5532: # The following styles is part of the redesign of LON-CAPA and are
                   5533: # subject to change during this project.
                   5534: # Don't rely on their current functionality as they might be 
                   5535: # changed or removed.
                   5536: # --------------------------*/
                   5537: 
1.698     harmsja  5538: a:hover,
1.721     harmsja  5539: ol.LC_smallMenu a:hover,
                   5540: ol#LC_MenuBreadcrumbs a:hover,
                   5541: ol#LC_PathBreadcrumbs a:hover,
                   5542: ul#LC_TabMainMenuContent a:hover,
                   5543: .LC_FormSectionClearButton input:hover
                   5544: ul.LC_TabContent   li:hover a{
1.698     harmsja  5545: 	color:#BF2317;
                   5546:         text-decoration:none;
1.693     droeschl 5547: }
                   5548: 
                   5549: h1 { 
1.721     harmsja  5550: 	padding:5px 10px 5px 20px;
1.693     droeschl 5551: 	line-height:130%;
                   5552: }
1.698     harmsja  5553: 
1.693     droeschl 5554: h2,h3,h4,h5,h6
                   5555: {
1.721     harmsja  5556: 	margin:5px 0px 5px 0px;
                   5557: 	padding:0px;
                   5558: 	line-height:130%;
1.693     droeschl 5559: }
1.721     harmsja  5560: .LC_hcell{
1.698     harmsja  5561:         padding:3px 15px 3px 15px;
                   5562:         margin:0px;
1.703     harmsja  5563: 	background-color:$tabbg;
                   5564: 	border-bottom:solid 1px $lg_border_color;       
1.693     droeschl 5565: }
1.721     harmsja  5566: .LC_noBorder {
1.698     harmsja  5567:         border:0px;
                   5568: }
1.693     droeschl 5569: 
1.722     harmsja  5570: .LC_bgLightGrey{
1.741     harmsja  5571: 	background:URL(/adm/lonIcons/lightGreyBG.png) repeat-x left bottom;
1.722     harmsja  5572: }
1.741     harmsja  5573: 
1.693     droeschl 5574: 
1.698     harmsja  5575: /* Main Header with discription of Person, Course, etc. */
1.721     harmsja  5576: .LC_HeadRight {
1.693     droeschl 5577: 	text-align: right;
                   5578: 	float: right;
                   5579: 	margin: 0px;
                   5580: 	padding: 0px;
1.698     harmsja  5581:         right:0;
1.693     droeschl 5582:         position:absolute;
1.698     harmsja  5583:         overflow:hidden;
1.693     droeschl 5584: }
                   5585: 
1.721     harmsja  5586: p, .LC_ContentBox {
1.698     harmsja  5587: 	padding: 10px;
                   5588: 
                   5589: }
1.721     harmsja  5590: .LC_FormSectionClearButton input {
1.741     harmsja  5591:         background-color:transparent;    	    
1.698     harmsja  5592:         border:0px;
                   5593:         cursor:pointer;
                   5594:         text-decoration:underline;
1.693     droeschl 5595: }
                   5596: 
                   5597: 
1.698     harmsja  5598: dl,ul,div,fieldset {
                   5599: 	margin: 10px 10px 10px 0px;
1.693     droeschl 5600: 	overflow:hidden;
                   5601: }
1.721     harmsja  5602: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698     harmsja  5603: 	margin: 0px;
1.693     droeschl 5604: }
                   5605: 
1.721     harmsja  5606: ol.LC_smallMenu li {
1.693     droeschl 5607: 	display: inline;
                   5608: 	padding: 5px 5px 0px 10px;
                   5609: 	vertical-align: top;
                   5610: }
                   5611: 
1.721     harmsja  5612: ol.LC_smallMenu li img {
1.693     droeschl 5613: 	vertical-align: bottom;
                   5614: }
                   5615: 
1.721     harmsja  5616: ol.LC_smallMenu a {
1.693     droeschl 5617: 	font-size: 90%;
                   5618: 	color: RGB(80, 80, 80);
                   5619: 	text-decoration: none;
                   5620: }
1.744     ehlerst  5621: ol#LC_TabMainMenueContent, ul.LC_TabContent ,
1.741     harmsja  5622: ul.LC_TabContentBigger {
1.721     harmsja  5623: 	display:block;
                   5624: 	list-style:none;
1.741     harmsja  5625: 	margin: 0px;
1.693     droeschl 5626: 	padding: 0px;
                   5627: }
                   5628: 
1.744     ehlerst  5629: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741     harmsja  5630: ul.LC_TabContentBigger li{
1.693     droeschl 5631: 	display: inline;
1.741     harmsja  5632: 	border-right: solid 1px $lg_border_color;
                   5633: 	float:left;
                   5634: 	line-height:140%;
                   5635: 	white-space:nowrap;
                   5636: }
                   5637: ol#LC_TabMainMenuContent li{
1.693     droeschl 5638: 	vertical-align: bottom;
                   5639: 	border-bottom: solid 1px RGB(175, 175, 175);
1.721     harmsja  5640: 	padding: 5px 10px 5px 10px;
1.741     harmsja  5641: 	margin-right:5px;
                   5642: 	margin-bottom:3px;
1.693     droeschl 5643: 	font-weight: bold;
1.723     riegler  5644: 	background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693     droeschl 5645: }
                   5646: 
1.721     harmsja  5647: ol#LC_TabMainMenuContent li a{
1.693     droeschl 5648: 	color: RGB(47, 47, 47);
                   5649: 	text-decoration: none;
                   5650: }
1.721     harmsja  5651: ul.LC_TabContent {
1.741     harmsja  5652: 	min-height:1.6em;
1.721     harmsja  5653: }
                   5654: ul.LC_TabContent li{
1.741     harmsja  5655: 	vertical-align:middle;
                   5656: 	padding:0px 10px 0px 10px;
1.745     ehlerst  5657: 	background-color:$tabbg;
                   5658: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5659: }
1.744     ehlerst  5660: ul.LC_TabContent li a, ul.LC_TabContent li{ 
1.721     harmsja  5661: 	color:rgb(47,47,47);
                   5662: 	text-decoration:none;
                   5663: 	font-size:95%;
                   5664: 	font-weight:bold;
                   5665: }
1.744     ehlerst  5666: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
                   5667: 	background-color:#FFFFFF;
1.745     ehlerst  5668: 	border-bottom:solid 1px #FFFFFF;
1.744     ehlerst  5669: }
1.741     harmsja  5670: ul.LC_TabContentBigger li{
                   5671: 	vertical-align:bottom;
                   5672: 	border-top:solid 1px $lg_border_color;
                   5673: 	border-left:solid 1px $lg_border_color;
                   5674: 	padding:5px 10px 5px 10px;
                   5675: 	margin-left:2px;
                   5676: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
                   5677: }
1.744     ehlerst  5678: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
                   5679: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
                   5680: }
1.741     harmsja  5681: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
                   5682: 	font-size:110%;
                   5683: 	font-weight:bold;
                   5684: }
                   5685: #LC_CourseDocuments, #LC_SupplementalCourseDocuments
                   5686: {
                   5687: 	margin:0px;
1.737     tempelho 5688: }
                   5689: 
1.721     harmsja  5690: .LC_hideThis
                   5691: {
                   5692: 	display:none;
                   5693: 	visibility:hidden;
1.693     droeschl 5694: }
                   5695: 
1.721     harmsja  5696: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693     droeschl 5697: 	border-top: solid 1px RGB(255, 255, 255);
                   5698: 	height: 20px;
                   5699: 	line-height: 20px;
                   5700: 	vertical-align: bottom;
                   5701: 	margin: 0px 0px 30px 0px;
                   5702: 	padding-left: 10px;
                   5703: 	list-style-position: inside;
1.723     riegler  5704: 	background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693     droeschl 5705: }
                   5706: 
1.721     harmsja  5707: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.741     harmsja  5708: /*
1.723     riegler  5709: 	background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.741     harmsja  5710: */	
1.693     droeschl 5711: 	display: inline;
                   5712: 	padding: 0px 0px 0px 10px;
                   5713: 	vertical-align: bottom;
                   5714: 	overflow:hidden;
                   5715: }
                   5716: 
1.721     harmsja  5717: ol#LC_MenuBreadcrumbs li a {
1.693     droeschl 5718: 	text-decoration: none;
                   5719: 	font-size:90%;
                   5720: }
1.721     harmsja  5721: ol#LC_PathBreadcrumbs li a{
1.698     harmsja  5722: 	text-decoration:none;
                   5723: 	font-size:100%;
                   5724: 	font-weight:bold;
1.693     droeschl 5725: }
1.721     harmsja  5726: .LC_ContentBoxSpecial
1.693     droeschl 5727: {
1.701     harmsja  5728: 	border: solid 1px $lg_border_color;
1.746     neumanie 5729: }
                   5730: .LC_ContentBoxSpecialContactInfo
                   5731: {
                   5732: 	border: solid 1px $lg_border_color;
                   5733: 	max-width:25%;
                   5734: 	min-width:25%;
1.698     harmsja  5735: }
1.747     neumanie 5736: .LC_AboutMe_Image
                   5737: {
                   5738: 	float:left;
                   5739: 	margin-right:10px;
                   5740: }
                   5741: .LC_Clear_AboutMe_Image
                   5742: {
                   5743: 	clear:left;
                   5744: }
1.721     harmsja  5745: dl.LC_ListStyleClean dt {
1.693     droeschl 5746: 	padding-right: 5px;
                   5747: 	display: table-header-group;
                   5748: }
                   5749: 
1.721     harmsja  5750: dl.LC_ListStyleClean dd {
1.693     droeschl 5751: 	display: table-row;
                   5752: }
                   5753: 
1.721     harmsja  5754: .LC_ListStyleClean,
                   5755: .LC_ListStyleSimple,
                   5756: .LC_ListStyleNormal,
                   5757: .LC_ListStyleNormal_Border,
                   5758: .LC_ListStyleSpecial
1.693     droeschl 5759: 	{
                   5760: 	/*display:block;	*/
                   5761: 	list-style-position: inside;
                   5762: 	list-style-type: none;
                   5763: 	overflow: hidden;
                   5764: 	padding: 0px;
                   5765: }
                   5766: 
1.721     harmsja  5767: .LC_ListStyleSimple li,
                   5768: .LC_ListStyleSimple dd,
                   5769: .LC_ListStyleNormal li,
                   5770: .LC_ListStyleNormal dd,
                   5771: .LC_ListStyleSpecial li,
                   5772: .LC_ListStyleSpecial dd
1.693     droeschl 5773: 	{
                   5774: 	margin: 0px;
                   5775: 	padding: 5px 5px 5px 10px;
                   5776: 	clear: both;
                   5777: }
                   5778: 
1.721     harmsja  5779: .LC_ListStyleClean li,
                   5780: .LC_ListStyleClean dd {
1.693     droeschl 5781: 	padding-top: 0px;
                   5782: 	padding-bottom: 0px;
                   5783: }
                   5784: 
1.721     harmsja  5785: .LC_ListStyleSimple dd,
                   5786: .LC_ListStyleSimple li{
1.698     harmsja  5787: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 5788: }
                   5789: 
1.721     harmsja  5790: .LC_ListStyleSpecial li,
                   5791: .LC_ListStyleSpecial dd {
1.693     droeschl 5792: 	list-style-type: none;
                   5793: 	background-color: RGB(220, 220, 220);
                   5794: 	margin-bottom: 4px;
                   5795: }
                   5796: 
1.721     harmsja  5797: table.LC_SimpleTable {
1.698     harmsja  5798: 	margin:5px;
                   5799: 	border:solid 1px $lg_border_color;
1.693     droeschl 5800: 	}
                   5801: 
1.721     harmsja  5802: table.LC_SimpleTable tr {
1.698     harmsja  5803: 	padding:0px;
                   5804: 	border:solid 1px $lg_border_color;
1.693     droeschl 5805: }
1.721     harmsja  5806: table.LC_SimpleTable thead{
1.698     harmsja  5807: 	 background:rgb(220,220,220);
1.693     droeschl 5808: }
                   5809: 
1.721     harmsja  5810: div.LC_columnSection {
1.693     droeschl 5811: 	display: block;
                   5812: 	clear: both;
                   5813: 	overflow: hidden;
                   5814: 	margin:0px;
                   5815: }
                   5816: 
1.721     harmsja  5817: div.LC_columnSection>* {
1.693     droeschl 5818: 	float: left;
                   5819: 	margin: 10px 20px 10px 0px;
1.747     neumanie 5820: 	overflow:hidden;
1.693     droeschl 5821: }
1.721     harmsja  5822: div.LC_columnSection > .LC_ContentBox,
                   5823: div.LC_columnSection > .LC_ContentBoxSpecial
1.693     droeschl 5824: 	{
1.747     neumanie 5825: 	width: 400px;
1.693     droeschl 5826: }
1.721     harmsja  5827: 
1.719     ehlerst  5828: .ContentBoxSpecialTemplate
                   5829: {
1.747     neumanie 5830:         border: solid 1px $lg_border_color;
1.719     ehlerst  5831: }
                   5832: .ContentBoxTemplate {
                   5833:         padding:10px;
                   5834: }
                   5835: 
1.721     harmsja  5836: div.LC_columnSection > .ContentBoxTemplate,
                   5837: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719     ehlerst  5838:         {
                   5839:         width: 600px;
                   5840: 
                   5841: }
                   5842: 
1.720     ehlerst  5843: .clear{
                   5844: 	clear: both;
                   5845: 	line-height: 0px;
                   5846: 	font-size: 0px;
                   5847: 	height: 0px;
                   5848: }
1.693     droeschl 5849: 
1.694     tempelho 5850: .LC_loginpage_container {
                   5851: 	text-align:left;
                   5852: 	margin : 0 auto;
                   5853: 	width:65%;
                   5854: 	padding: 10px;
                   5855: 	height: auto;
1.712     muellerd 5856: 	background-color:#FFFFFF;
1.694     tempelho 5857: 	border:1px solid #CCCCCC;
                   5858: }
                   5859: 
                   5860: 
                   5861: .LC_loginpage_loginContainer {
                   5862: 	float:left;
1.712     muellerd 5863: 	width: 182px;
                   5864: 	border:1px solid #CCCCCC;
                   5865: 	background-color:$loginbg;
1.694     tempelho 5866: }
                   5867: 
1.717     tempelho 5868: .LC_loginpage_loginContainer h2{
1.712     muellerd 5869: 	margin-top:0;
                   5870: 	display:block;
                   5871: 	background:$bgcol;
                   5872: 	color:$textcol;
                   5873: 	padding-left:5px;
                   5874: }
1.694     tempelho 5875: .LC_loginpage_loginInfo {
                   5876: 	margin-left:20px;
                   5877: 	float:left;
                   5878: 	width:30%;
                   5879: 	border:1px solid #CCCCCC;
                   5880: 	padding:10px;
                   5881: }
                   5882: 
1.712     muellerd 5883: .LC_loginpage_loginDomain {
                   5884: 	margin-right:20px;
                   5885: 	width:20%;
                   5886: 	float:left;
                   5887: 	padding:10px;
                   5888: }
                   5889: 
1.694     tempelho 5890: .LC_loginpage_space {
                   5891: 	clear:both;
                   5892: 	margin-bottom:20px;
                   5893: 	border-bottom: 1px solid #CCCCCC;
                   5894: }
                   5895: 
1.748     schulted 5896: table em{
                   5897: 	font-weight:bold;
                   5898: 	font-style:normal;
                   5899: }
                   5900: 
1.343     albertel 5901: END
                   5902: }
                   5903: 
1.306     albertel 5904: =pod
                   5905: 
                   5906: =item * &headtag()
                   5907: 
                   5908: Returns a uniform footer for LON-CAPA web pages.
                   5909: 
1.307     albertel 5910: Inputs: $title - optional title for the head
                   5911:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 5912:         $args - optional arguments
1.319     albertel 5913:             force_register - if is true call registerurl so the remote is 
                   5914:                              informed
1.415     albertel 5915:             redirect       -> array ref of
                   5916:                                    1- seconds before redirect occurs
                   5917:                                    2- url to redirect to
                   5918:                                    3- whether the side effect should occur
1.315     albertel 5919:                            (side effect of setting 
                   5920:                                $env{'internal.head.redirect'} to the url 
                   5921:                                redirected too)
1.352     albertel 5922:             domain         -> force to color decorate a page for a specific
                   5923:                                domain
                   5924:             function       -> force usage of a specific rolish color scheme
                   5925:             bgcolor        -> override the default page bgcolor
1.460     albertel 5926:             no_auto_mt_title
                   5927:                            -> prevent &mt()ing the title arg
1.464     albertel 5928: 
1.306     albertel 5929: =cut
                   5930: 
                   5931: sub headtag {
1.313     albertel 5932:     my ($title,$head_extra,$args) = @_;
1.306     albertel 5933:     
1.363     albertel 5934:     my $function = $args->{'function'} || &get_users_function();
                   5935:     my $domain   = $args->{'domain'}   || &determinedomain();
                   5936:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 5937:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 5938: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 5939: 		   #time(),
1.418     albertel 5940: 		   $env{'environment.color.timestamp'},
1.363     albertel 5941: 		   $function,$domain,$bgcolor);
                   5942: 
1.369     www      5943:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 5944: 
1.308     albertel 5945:     my $result =
                   5946: 	'<head>'.
1.461     albertel 5947: 	&font_settings();
1.319     albertel 5948: 
1.461     albertel 5949:     if (!$args->{'frameset'}) {
                   5950: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   5951:     }
1.319     albertel 5952:     if ($args->{'force_register'}) {
                   5953: 	$result .= &Apache::lonmenu::registerurl(1);
                   5954:     }
1.436     albertel 5955:     if (!$args->{'no_nav_bar'} 
                   5956: 	&& !$args->{'only_body'}
                   5957: 	&& !$args->{'frameset'}) {
                   5958: 	$result .= &help_menu_js();
                   5959:     }
1.319     albertel 5960: 
1.314     albertel 5961:     if (ref($args->{'redirect'})) {
1.414     albertel 5962: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 5963: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 5964: 	if (!$inhibit_continue) {
                   5965: 	    $env{'internal.head.redirect'} = $url;
                   5966: 	}
1.313     albertel 5967: 	$result.=<<ADDMETA
                   5968: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 5969: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 5970: ADDMETA
                   5971:     }
1.306     albertel 5972:     if (!defined($title)) {
                   5973: 	$title = 'The LearningOnline Network with CAPA';
                   5974:     }
1.460     albertel 5975:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   5976:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 5977: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   5978: 	.$head_extra;
1.306     albertel 5979:     return $result;
                   5980: }
                   5981: 
                   5982: =pod
                   5983: 
1.340     albertel 5984: =item * &font_settings()
                   5985: 
                   5986: Returns neccessary <meta> to set the proper encoding
                   5987: 
                   5988: Inputs: none
                   5989: 
                   5990: =cut
                   5991: 
                   5992: sub font_settings {
                   5993:     my $headerstring='';
1.647     www      5994:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 5995: 	$headerstring.=
                   5996: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   5997:     }
                   5998:     return $headerstring;
                   5999: }
                   6000: 
1.341     albertel 6001: =pod
                   6002: 
                   6003: =item * &xml_begin()
                   6004: 
                   6005: Returns the needed doctype and <html>
                   6006: 
                   6007: Inputs: none
                   6008: 
                   6009: =cut
                   6010: 
                   6011: sub xml_begin {
                   6012:     my $output='';
                   6013: 
1.592     albertel 6014:     if ($env{'internal.start_page'}==1) {
                   6015: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6016:     }
1.342     albertel 6017: 
1.341     albertel 6018:     if ($env{'browser.mathml'}) {
                   6019: 	$output='<?xml version="1.0"?>'
                   6020:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6021: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6022:             
                   6023: #	    .'<!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">] >'
                   6024: 	    .'<!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">'
                   6025:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6026: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6027:     } else {
                   6028: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   6029:     }
                   6030:     return $output;
                   6031: }
1.340     albertel 6032: 
                   6033: =pod
                   6034: 
1.306     albertel 6035: =item * &endheadtag()
                   6036: 
                   6037: Returns a uniform </head> for LON-CAPA web pages.
                   6038: 
                   6039: Inputs: none
                   6040: 
                   6041: =cut
                   6042: 
                   6043: sub endheadtag {
                   6044:     return '</head>';
                   6045: }
                   6046: 
                   6047: =pod
                   6048: 
                   6049: =item * &head()
                   6050: 
                   6051: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6052: 
1.648     raeburn  6053: Inputs:
                   6054: 
                   6055: =over 4
                   6056: 
                   6057: $title - optional title for the page
                   6058: 
                   6059: $head_extra - optional extra HTML to put inside the <head>
                   6060: 
                   6061: =back
1.405     albertel 6062: 
1.306     albertel 6063: =cut
                   6064: 
                   6065: sub head {
1.325     albertel 6066:     my ($title,$head_extra,$args) = @_;
                   6067:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6068: }
                   6069: 
                   6070: =pod
                   6071: 
                   6072: =item * &start_page()
                   6073: 
                   6074: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6075: 
1.648     raeburn  6076: Inputs:
                   6077: 
                   6078: =over 4
                   6079: 
                   6080: $title - optional title for the page
                   6081: 
                   6082: $head_extra - optional extra HTML to incude inside the <head>
                   6083: 
                   6084: $args - additional optional args supported are:
                   6085: 
                   6086: =over 8
                   6087: 
                   6088:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6089:                                     arg on
1.648     raeburn  6090:              no_nav_bar     -> is true will set &bodytag() notopbar arg on
                   6091:              add_entries    -> additional attributes to add to the  <body>
                   6092:              domain         -> force to color decorate a page for a 
1.317     albertel 6093:                                     specific domain
1.648     raeburn  6094:              function       -> force usage of a specific rolish color
1.317     albertel 6095:                                     scheme
1.648     raeburn  6096:              redirect       -> see &headtag()
                   6097:              bgcolor        -> override the default page bg color
                   6098:              js_ready       -> return a string ready for being used in 
1.317     albertel 6099:                                     a javascript writeln
1.648     raeburn  6100:              html_encode    -> return a string ready for being used in 
1.320     albertel 6101:                                     a html attribute
1.648     raeburn  6102:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6103:                                     $forcereg arg
1.648     raeburn  6104:              body_title     -> alternate text to use instead of $title
1.326     albertel 6105:                                     in the title box that appears, this text
                   6106:                                     is not auto translated like the $title is
1.648     raeburn  6107:              frameset       -> if true will start with a <frameset>
1.330     albertel 6108:                                     rather than <body>
1.648     raeburn  6109:              no_title       -> if true the title bar won't be shown
                   6110:              skip_phases    -> hash ref of 
1.338     albertel 6111:                                     head -> skip the <html><head> generation
                   6112:                                     body -> skip all <body> generation
1.648     raeburn  6113:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6114:                                     'Switch To Inline Menu' link
1.648     raeburn  6115:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6116:              inherit_jsmath -> when creating popup window in a page,
                   6117:                                     should it have jsmath forced on by the
                   6118:                                     current page
1.361     albertel 6119: 
1.648     raeburn  6120: =back
1.460     albertel 6121: 
1.648     raeburn  6122: =back
1.562     albertel 6123: 
1.306     albertel 6124: =cut
                   6125: 
                   6126: sub start_page {
1.309     albertel 6127:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6128:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6129:     my %head_args;
1.352     albertel 6130:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6131: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6132: 		     'no_auto_mt_title') {
1.319     albertel 6133: 	if (defined($args->{$arg})) {
1.324     raeburn  6134: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6135: 	}
1.313     albertel 6136:     }
1.319     albertel 6137: 
1.315     albertel 6138:     $env{'internal.start_page'}++;
1.338     albertel 6139:     my $result;
                   6140:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6141: 	$result.=
1.341     albertel 6142: 	    &xml_begin().
1.338     albertel 6143: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6144:     }
                   6145:     
                   6146:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6147: 	if ($args->{'frameset'}) {
                   6148: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6149: 						$args->{'add_entries'});
                   6150: 	    $result .= "\n<frameset $attr_string>\n";
                   6151: 	} else {
                   6152: 	    $result .=
                   6153: 		&bodytag($title, 
                   6154: 			 $args->{'function'},       $args->{'add_entries'},
                   6155: 			 $args->{'only_body'},      $args->{'domain'},
                   6156: 			 $args->{'force_register'}, $args->{'body_title'},
                   6157: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.460     albertel 6158: 			 $args->{'no_title'},       $args->{'no_inline_link'},
                   6159: 			 $args);
1.338     albertel 6160: 	}
1.330     albertel 6161:     }
1.338     albertel 6162: 
1.315     albertel 6163:     if ($args->{'js_ready'}) {
1.713     kaisler  6164: 		$result = &js_ready($result);
1.315     albertel 6165:     }
1.320     albertel 6166:     if ($args->{'html_encode'}) {
1.713     kaisler  6167: 		$result = &html_encode($result);
                   6168:     }
                   6169: 
1.718     raeburn  6170:     if (exists($args->{'bread_crumbs'})) {
                   6171:         &Apache::lonhtmlcommon::clear_breadcrumbs();
                   6172:         if (ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6173:             foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6174:                 &Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6175:             }
                   6176:         }
                   6177:         $result .= &Apache::lonhtmlcommon::breadcrumbs();
1.320     albertel 6178:     }
1.713     kaisler  6179: 
1.315     albertel 6180:     return $result;
1.306     albertel 6181: }
                   6182: 
1.330     albertel 6183: 
1.306     albertel 6184: =pod
                   6185: 
                   6186: =item * &head()
                   6187: 
                   6188: Returns a complete </body></html> section for LON-CAPA web pages.
                   6189: 
1.315     albertel 6190: Inputs:         $args - additional optional args supported are:
                   6191:                  js_ready     -> return a string ready for being used in 
                   6192:                                  a javascript writeln
1.320     albertel 6193:                  html_encode  -> return a string ready for being used in 
                   6194:                                  a html attribute
1.330     albertel 6195:                  frameset     -> if true will start with a <frameset>
                   6196:                                  rather than <body>
1.493     albertel 6197:                  dicsussion   -> if true will get discussion from
                   6198:                                   lonxml::xmlend
                   6199:                                  (you can pass the target and parser arguments
                   6200:                                   through optional 'target' and 'parser' args
                   6201:                                   to this routine)
1.306     albertel 6202: 
                   6203: =cut
                   6204: 
                   6205: sub end_page {
1.315     albertel 6206:     my ($args) = @_;
                   6207:     $env{'internal.end_page'}++;
1.330     albertel 6208:     my $result;
1.335     albertel 6209:     if ($args->{'discussion'}) {
                   6210: 	my ($target,$parser);
                   6211: 	if (ref($args->{'discussion'})) {
                   6212: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6213: 				$args->{'discussion'}{'parser'});
                   6214: 	}
                   6215: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6216:     }
                   6217: 
1.330     albertel 6218:     if ($args->{'frameset'}) {
                   6219: 	$result .= '</frameset>';
                   6220:     } else {
1.635     raeburn  6221: 	$result .= &endbodytag($args);
1.330     albertel 6222:     }
                   6223:     $result .= "\n</html>";
                   6224: 
1.315     albertel 6225:     if ($args->{'js_ready'}) {
1.317     albertel 6226: 	$result = &js_ready($result);
1.315     albertel 6227:     }
1.335     albertel 6228: 
1.320     albertel 6229:     if ($args->{'html_encode'}) {
                   6230: 	$result = &html_encode($result);
                   6231:     }
1.335     albertel 6232: 
1.315     albertel 6233:     return $result;
                   6234: }
                   6235: 
1.320     albertel 6236: sub html_encode {
                   6237:     my ($result) = @_;
                   6238: 
1.322     albertel 6239:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6240:     
                   6241:     return $result;
                   6242: }
1.317     albertel 6243: sub js_ready {
                   6244:     my ($result) = @_;
                   6245: 
1.323     albertel 6246:     $result =~ s/[\n\r]/ /xmsg;
                   6247:     $result =~ s/\\/\\\\/xmsg;
                   6248:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6249:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6250:     
                   6251:     return $result;
                   6252: }
                   6253: 
1.315     albertel 6254: sub validate_page {
                   6255:     if (  exists($env{'internal.start_page'})
1.316     albertel 6256: 	  &&     $env{'internal.start_page'} > 1) {
                   6257: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6258: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6259: 				 $ENV{'request.filename'});
1.315     albertel 6260:     }
                   6261:     if (  exists($env{'internal.end_page'})
1.316     albertel 6262: 	  &&     $env{'internal.end_page'} > 1) {
                   6263: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6264: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6265: 				 $env{'request.filename'});
1.315     albertel 6266:     }
                   6267:     if (     exists($env{'internal.start_page'})
                   6268: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6269: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6270: 				 $env{'request.filename'});
1.315     albertel 6271:     }
                   6272:     if (   ! exists($env{'internal.start_page'})
                   6273: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6274: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6275: 				 $env{'request.filename'});
1.315     albertel 6276:     }
1.306     albertel 6277: }
1.315     albertel 6278: 
1.318     albertel 6279: sub simple_error_page {
                   6280:     my ($r,$title,$msg) = @_;
                   6281:     my $page =
                   6282: 	&Apache::loncommon::start_page($title).
                   6283: 	&mt($msg).
                   6284: 	&Apache::loncommon::end_page();
                   6285:     if (ref($r)) {
                   6286: 	$r->print($page);
1.327     albertel 6287: 	return;
1.318     albertel 6288:     }
                   6289:     return $page;
                   6290: }
1.347     albertel 6291: 
                   6292: {
1.610     albertel 6293:     my @row_count;
1.347     albertel 6294:     sub start_data_table {
1.422     albertel 6295: 	my ($add_class) = @_;
                   6296: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6297: 	unshift(@row_count,0);
1.422     albertel 6298: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6299:     }
                   6300: 
                   6301:     sub end_data_table {
1.610     albertel 6302: 	shift(@row_count);
1.389     albertel 6303: 	return '</table>'."\n";;
1.347     albertel 6304:     }
                   6305: 
                   6306:     sub start_data_table_row {
1.422     albertel 6307: 	my ($add_class) = @_;
1.610     albertel 6308: 	$row_count[0]++;
                   6309: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6310: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6311: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6312:     }
1.471     banghart 6313:     
                   6314:     sub continue_data_table_row {
                   6315: 	my ($add_class) = @_;
1.610     albertel 6316: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6317: 	$css_class = (join(' ',$css_class,$add_class));
                   6318: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6319:     }
1.347     albertel 6320: 
                   6321:     sub end_data_table_row {
1.389     albertel 6322: 	return '</tr>'."\n";;
1.347     albertel 6323:     }
1.367     www      6324: 
1.421     albertel 6325:     sub start_data_table_empty_row {
1.707     bisitz   6326: #	$row_count[0]++;
1.421     albertel 6327: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6328:     }
                   6329: 
                   6330:     sub end_data_table_empty_row {
                   6331: 	return '</tr>'."\n";;
                   6332:     }
                   6333: 
1.367     www      6334:     sub start_data_table_header_row {
1.389     albertel 6335: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6336:     }
                   6337: 
                   6338:     sub end_data_table_header_row {
1.389     albertel 6339: 	return '</tr>'."\n";;
1.367     www      6340:     }
1.347     albertel 6341: }
                   6342: 
1.548     albertel 6343: =pod
                   6344: 
                   6345: =item * &inhibit_menu_check($arg)
                   6346: 
                   6347: Checks for a inhibitmenu state and generates output to preserve it
                   6348: 
                   6349: Inputs:         $arg - can be any of
                   6350:                      - undef - in which case the return value is a string 
                   6351:                                to add  into arguments list of a uri
                   6352:                      - 'input' - in which case the return value is a HTML
                   6353:                                  <form> <input> field of type hidden to
                   6354:                                  preserve the value
                   6355:                      - a url - in which case the return value is the url with
                   6356:                                the neccesary cgi args added to preserve the
                   6357:                                inhibitmenu state
                   6358:                      - a ref to a url - no return value, but the string is
                   6359:                                         updated to include the neccessary cgi
                   6360:                                         args to preserve the inhibitmenu state
                   6361: 
                   6362: =cut
                   6363: 
                   6364: sub inhibit_menu_check {
                   6365:     my ($arg) = @_;
                   6366:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6367:     if ($arg eq 'input') {
                   6368: 	if ($env{'form.inhibitmenu'}) {
                   6369: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6370: 	} else {
                   6371: 	    return
                   6372: 	}
                   6373:     }
                   6374:     if ($env{'form.inhibitmenu'}) {
                   6375: 	if (ref($arg)) {
                   6376: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6377: 	} elsif ($arg eq '') {
                   6378: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6379: 	} else {
                   6380: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6381: 	}
                   6382:     }
                   6383:     if (!ref($arg)) {
                   6384: 	return $arg;
                   6385:     }
                   6386: }
                   6387: 
1.251     albertel 6388: ###############################################
1.182     matthew  6389: 
                   6390: =pod
                   6391: 
1.549     albertel 6392: =back
                   6393: 
                   6394: =head1 User Information Routines
                   6395: 
                   6396: =over 4
                   6397: 
1.405     albertel 6398: =item * &get_users_function()
1.182     matthew  6399: 
                   6400: Used by &bodytag to determine the current users primary role.
                   6401: Returns either 'student','coordinator','admin', or 'author'.
                   6402: 
                   6403: =cut
                   6404: 
                   6405: ###############################################
                   6406: sub get_users_function {
                   6407:     my $function = 'student';
1.258     albertel 6408:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6409:         $function='coordinator';
                   6410:     }
1.258     albertel 6411:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6412:         $function='admin';
                   6413:     }
1.258     albertel 6414:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  6415:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6416:         $function='author';
                   6417:     }
                   6418:     return $function;
1.54      www      6419: }
1.99      www      6420: 
                   6421: ###############################################
                   6422: 
1.233     raeburn  6423: =pod
                   6424: 
1.542     raeburn  6425: =item * &check_user_status()
1.274     raeburn  6426: 
                   6427: Determines current status of supplied role for a
                   6428: specific user. Roles can be active, previous or future.
                   6429: 
                   6430: Inputs: 
                   6431: user's domain, user's username, course's domain,
1.375     raeburn  6432: course's number, optional section ID.
1.274     raeburn  6433: 
                   6434: Outputs:
                   6435: role status: active, previous or future. 
                   6436: 
                   6437: =cut
                   6438: 
                   6439: sub check_user_status {
1.412     raeburn  6440:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6441:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6442:     my @uroles = keys %userinfo;
                   6443:     my $srchstr;
                   6444:     my $active_chk = 'none';
1.412     raeburn  6445:     my $now = time;
1.274     raeburn  6446:     if (@uroles > 0) {
1.412     raeburn  6447:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6448:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6449:         } else {
1.412     raeburn  6450:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6451:         }
                   6452:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6453:             my $role_end = 0;
                   6454:             my $role_start = 0;
                   6455:             $active_chk = 'active';
1.412     raeburn  6456:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6457:                 $role_end = $1;
                   6458:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6459:                     $role_start = $1;
1.274     raeburn  6460:                 }
                   6461:             }
                   6462:             if ($role_start > 0) {
1.412     raeburn  6463:                 if ($now < $role_start) {
1.274     raeburn  6464:                     $active_chk = 'future';
                   6465:                 }
                   6466:             }
                   6467:             if ($role_end > 0) {
1.412     raeburn  6468:                 if ($now > $role_end) {
1.274     raeburn  6469:                     $active_chk = 'previous';
                   6470:                 }
                   6471:             }
                   6472:         }
                   6473:     }
                   6474:     return $active_chk;
                   6475: }
                   6476: 
                   6477: ###############################################
                   6478: 
                   6479: =pod
                   6480: 
1.405     albertel 6481: =item * &get_sections()
1.233     raeburn  6482: 
                   6483: Determines all the sections for a course including
                   6484: sections with students and sections containing other roles.
1.419     raeburn  6485: Incoming parameters: 
                   6486: 
                   6487: 1. domain
                   6488: 2. course number 
                   6489: 3. reference to array containing roles for which sections should 
                   6490: be gathered (optional).
                   6491: 4. reference to array containing status types for which sections 
                   6492: should be gathered (optional).
                   6493: 
                   6494: If the third argument is undefined, sections are gathered for any role. 
                   6495: If the fourth argument is undefined, sections are gathered for any status.
                   6496: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6497:  
1.374     raeburn  6498: Returns section hash (keys are section IDs, values are
                   6499: number of users in each section), subject to the
1.419     raeburn  6500: optional roles filter, optional status filter 
1.233     raeburn  6501: 
                   6502: =cut
                   6503: 
                   6504: ###############################################
                   6505: sub get_sections {
1.419     raeburn  6506:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6507:     if (!defined($cdom) || !defined($cnum)) {
                   6508:         my $cid =  $env{'request.course.id'};
                   6509: 
                   6510: 	return if (!defined($cid));
                   6511: 
                   6512:         $cdom = $env{'course.'.$cid.'.domain'};
                   6513:         $cnum = $env{'course.'.$cid.'.num'};
                   6514:     }
                   6515: 
                   6516:     my %sectioncount;
1.419     raeburn  6517:     my $now = time;
1.240     albertel 6518: 
1.366     albertel 6519:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6520: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6521: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6522: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6523:         my $start_index = &Apache::loncoursedata::CL_START();
                   6524:         my $end_index = &Apache::loncoursedata::CL_END();
                   6525:         my $status;
1.366     albertel 6526: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6527: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6528: 				                     $data->[$status_index],
                   6529:                                                      $data->[$start_index],
                   6530:                                                      $data->[$end_index]);
                   6531:             if ($stu_status eq 'Active') {
                   6532:                 $status = 'active';
                   6533:             } elsif ($end < $now) {
                   6534:                 $status = 'previous';
                   6535:             } elsif ($start > $now) {
                   6536:                 $status = 'future';
                   6537:             } 
                   6538: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6539:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6540:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6541: 		    $sectioncount{$section}++;
                   6542:                 }
1.240     albertel 6543: 	    }
                   6544: 	}
                   6545:     }
                   6546:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6547:     foreach my $user (sort(keys(%courseroles))) {
                   6548: 	if ($user !~ /^(\w{2})/) { next; }
                   6549: 	my ($role) = ($user =~ /^(\w{2})/);
                   6550: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6551: 	my ($section,$status);
1.240     albertel 6552: 	if ($role eq 'cr' &&
                   6553: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6554: 	    $section=$1;
                   6555: 	}
                   6556: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6557: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  6558:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   6559:         if ($end == -1 && $start == -1) {
                   6560:             next; #deleted role
                   6561:         }
                   6562:         if (!defined($possible_status)) { 
                   6563:             $sectioncount{$section}++;
                   6564:         } else {
                   6565:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   6566:                 $status = 'active';
                   6567:             } elsif ($end < $now) {
                   6568:                 $status = 'future';
                   6569:             } elsif ($start > $now) {
                   6570:                 $status = 'previous';
                   6571:             }
                   6572:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   6573:                 $sectioncount{$section}++;
                   6574:             }
                   6575:         }
1.233     raeburn  6576:     }
1.366     albertel 6577:     return %sectioncount;
1.233     raeburn  6578: }
                   6579: 
1.274     raeburn  6580: ###############################################
1.294     raeburn  6581: 
                   6582: =pod
1.405     albertel 6583: 
                   6584: =item * &get_course_users()
                   6585: 
1.275     raeburn  6586: Retrieves usernames:domains for users in the specified course
                   6587: with specific role(s), and access status. 
                   6588: 
                   6589: Incoming parameters:
1.277     albertel 6590: 1. course domain
                   6591: 2. course number
                   6592: 3. access status: users must have - either active, 
1.275     raeburn  6593: previous, future, or all.
1.277     albertel 6594: 4. reference to array of permissible roles
1.288     raeburn  6595: 5. reference to array of section restrictions (optional)
                   6596: 6. reference to results object (hash of hashes).
                   6597: 7. reference to optional userdata hash
1.609     raeburn  6598: 8. reference to optional statushash
1.630     raeburn  6599: 9. flag if privileged users (except those set to unhide in
                   6600:    course settings) should be excluded    
1.609     raeburn  6601: Keys of top level results hash are roles.
1.275     raeburn  6602: Keys of inner hashes are username:domain, with 
                   6603: values set to access type.
1.288     raeburn  6604: Optional userdata hash returns an array with arguments in the 
                   6605: same order as loncoursedata::get_classlist() for student data.
                   6606: 
1.609     raeburn  6607: Optional statushash returns
                   6608: 
1.288     raeburn  6609: Entries for end, start, section and status are blank because
                   6610: of the possibility of multiple values for non-student roles.
                   6611: 
1.275     raeburn  6612: =cut
1.405     albertel 6613: 
1.275     raeburn  6614: ###############################################
1.405     albertel 6615: 
1.275     raeburn  6616: sub get_course_users {
1.630     raeburn  6617:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  6618:     my %idx = ();
1.419     raeburn  6619:     my %seclists;
1.288     raeburn  6620: 
                   6621:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   6622:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   6623:     $idx{end} = &Apache::loncoursedata::CL_END();
                   6624:     $idx{start} = &Apache::loncoursedata::CL_START();
                   6625:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   6626:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   6627:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   6628:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   6629: 
1.290     albertel 6630:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 6631:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  6632:         my $now = time;
1.277     albertel 6633:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  6634:             my $match = 0;
1.412     raeburn  6635:             my $secmatch = 0;
1.419     raeburn  6636:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  6637:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  6638:             if ($section eq '') {
                   6639:                 $section = 'none';
                   6640:             }
1.291     albertel 6641:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 6642:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  6643:                     $secmatch = 1;
                   6644:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 6645:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  6646:                         $secmatch = 1;
                   6647:                     }
                   6648:                 } else {  
1.419     raeburn  6649: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  6650: 		        $secmatch = 1;
                   6651:                     }
1.290     albertel 6652: 		}
1.412     raeburn  6653:                 if (!$secmatch) {
                   6654:                     next;
                   6655:                 }
1.419     raeburn  6656:             }
1.275     raeburn  6657:             if (defined($$types{'active'})) {
1.288     raeburn  6658:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  6659:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  6660:                     $match = 1;
1.275     raeburn  6661:                 }
                   6662:             }
                   6663:             if (defined($$types{'previous'})) {
1.609     raeburn  6664:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  6665:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  6666:                     $match = 1;
1.275     raeburn  6667:                 }
                   6668:             }
                   6669:             if (defined($$types{'future'})) {
1.609     raeburn  6670:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  6671:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  6672:                     $match = 1;
1.275     raeburn  6673:                 }
                   6674:             }
1.609     raeburn  6675:             if ($match) {
                   6676:                 push(@{$seclists{$student}},$section);
                   6677:                 if (ref($userdata) eq 'HASH') {
                   6678:                     $$userdata{$student} = $$classlist{$student};
                   6679:                 }
                   6680:                 if (ref($statushash) eq 'HASH') {
                   6681:                     $statushash->{$student}{'st'}{$section} = $status;
                   6682:                 }
1.288     raeburn  6683:             }
1.275     raeburn  6684:         }
                   6685:     }
1.412     raeburn  6686:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  6687:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6688:         my $now = time;
1.609     raeburn  6689:         my %displaystatus = ( previous => 'Expired',
                   6690:                               active   => 'Active',
                   6691:                               future   => 'Future',
                   6692:                             );
1.630     raeburn  6693:         my %nothide;
                   6694:         if ($hidepriv) {
                   6695:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   6696:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   6697:                 if ($user !~ /:/) {
                   6698:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   6699:                 } else {
                   6700:                     $nothide{$user} = 1;
                   6701:                 }
                   6702:             }
                   6703:         }
1.439     raeburn  6704:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  6705:             my $match = 0;
1.412     raeburn  6706:             my $secmatch = 0;
1.439     raeburn  6707:             my $status;
1.412     raeburn  6708:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  6709:             $user =~ s/:$//;
1.439     raeburn  6710:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   6711:             if ($end == -1 || $start == -1) {
                   6712:                 next;
                   6713:             }
                   6714:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   6715:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  6716:                 my ($uname,$udom) = split(/:/,$user);
                   6717:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 6718:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  6719:                         $secmatch = 1;
                   6720:                     } elsif ($usec eq '') {
1.420     albertel 6721:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  6722:                             $secmatch = 1;
                   6723:                         }
                   6724:                     } else {
                   6725:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   6726:                             $secmatch = 1;
                   6727:                         }
                   6728:                     }
                   6729:                     if (!$secmatch) {
                   6730:                         next;
                   6731:                     }
1.288     raeburn  6732:                 }
1.419     raeburn  6733:                 if ($usec eq '') {
                   6734:                     $usec = 'none';
                   6735:                 }
1.275     raeburn  6736:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  6737:                     if ($hidepriv) {
                   6738:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   6739:                             (!$nothide{$uname.':'.$udom})) {
                   6740:                             next;
                   6741:                         }
                   6742:                     }
1.503     raeburn  6743:                     if ($end > 0 && $end < $now) {
1.439     raeburn  6744:                         $status = 'previous';
                   6745:                     } elsif ($start > $now) {
                   6746:                         $status = 'future';
                   6747:                     } else {
                   6748:                         $status = 'active';
                   6749:                     }
1.277     albertel 6750:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  6751:                         if ($status eq $type) {
1.420     albertel 6752:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  6753:                                 push(@{$$users{$role}{$user}},$type);
                   6754:                             }
1.288     raeburn  6755:                             $match = 1;
                   6756:                         }
                   6757:                     }
1.419     raeburn  6758:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   6759:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   6760: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   6761:                         }
1.420     albertel 6762:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  6763:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   6764:                         }
1.609     raeburn  6765:                         if (ref($statushash) eq 'HASH') {
                   6766:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   6767:                         }
1.275     raeburn  6768:                     }
                   6769:                 }
                   6770:             }
                   6771:         }
1.290     albertel 6772:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  6773:             if ((defined($cdom)) && (defined($cnum))) {
                   6774:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   6775:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   6776:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  6777:                     next if ($owner eq '');
                   6778:                     my ($ownername,$ownerdom);
                   6779:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   6780:                         $ownername = $1;
                   6781:                         $ownerdom = $2;
                   6782:                     } else {
                   6783:                         $ownername = $owner;
                   6784:                         $ownerdom = $cdom;
                   6785:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  6786:                     }
                   6787:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 6788:                     if (defined($userdata) && 
1.609     raeburn  6789: 			!exists($$userdata{$owner})) {
                   6790: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   6791:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   6792:                             push(@{$seclists{$owner}},'none');
                   6793:                         }
                   6794:                         if (ref($statushash) eq 'HASH') {
                   6795:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  6796:                         }
1.290     albertel 6797: 		    }
1.279     raeburn  6798:                 }
                   6799:             }
                   6800:         }
1.419     raeburn  6801:         foreach my $user (keys(%seclists)) {
                   6802:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   6803:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   6804:         }
1.275     raeburn  6805:     }
                   6806:     return;
                   6807: }
                   6808: 
1.288     raeburn  6809: sub get_user_info {
                   6810:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 6811:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   6812: 	&plainname($uname,$udom,'lastname');
1.291     albertel 6813:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  6814:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  6815:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   6816:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  6817:     return;
                   6818: }
1.275     raeburn  6819: 
1.472     raeburn  6820: ###############################################
                   6821: 
                   6822: =pod
                   6823: 
                   6824: =item * &get_user_quota()
                   6825: 
                   6826: Retrieves quota assigned for storage of portfolio files for a user  
                   6827: 
                   6828: Incoming parameters:
                   6829: 1. user's username
                   6830: 2. user's domain
                   6831: 
                   6832: Returns:
1.536     raeburn  6833: 1. Disk quota (in Mb) assigned to student.
                   6834: 2. (Optional) Type of setting: custom or default
                   6835:    (individually assigned or default for user's 
                   6836:    institutional status).
                   6837: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   6838:    or student - types as defined in localenroll::inst_usertypes 
                   6839:    for user's domain, which determines default quota for user.
                   6840: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  6841: 
                   6842: If a value has been stored in the user's environment, 
1.536     raeburn  6843: it will return that, otherwise it returns the maximal default
                   6844: defined for the user's instituional status(es) in the domain.
1.472     raeburn  6845: 
                   6846: =cut
                   6847: 
                   6848: ###############################################
                   6849: 
                   6850: 
                   6851: sub get_user_quota {
                   6852:     my ($uname,$udom) = @_;
1.536     raeburn  6853:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  6854:     if (!defined($udom)) {
                   6855:         $udom = $env{'user.domain'};
                   6856:     }
                   6857:     if (!defined($uname)) {
                   6858:         $uname = $env{'user.name'};
                   6859:     }
                   6860:     if (($udom eq '' || $uname eq '') ||
                   6861:         ($udom eq 'public') && ($uname eq 'public')) {
                   6862:         $quota = 0;
1.536     raeburn  6863:         $quotatype = 'default';
                   6864:         $defquota = 0; 
1.472     raeburn  6865:     } else {
1.536     raeburn  6866:         my $inststatus;
1.472     raeburn  6867:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   6868:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  6869:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  6870:         } else {
1.536     raeburn  6871:             my %userenv = 
                   6872:                 &Apache::lonnet::get('environment',['portfolioquota',
                   6873:                                      'inststatus'],$udom,$uname);
1.472     raeburn  6874:             my ($tmp) = keys(%userenv);
                   6875:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   6876:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  6877:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  6878:             } else {
                   6879:                 undef(%userenv);
                   6880:             }
                   6881:         }
1.536     raeburn  6882:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  6883:         if ($quota eq '') {
1.536     raeburn  6884:             $quota = $defquota;
                   6885:             $quotatype = 'default';
                   6886:         } else {
                   6887:             $quotatype = 'custom';
1.472     raeburn  6888:         }
                   6889:     }
1.536     raeburn  6890:     if (wantarray) {
                   6891:         return ($quota,$quotatype,$settingstatus,$defquota);
                   6892:     } else {
                   6893:         return $quota;
                   6894:     }
1.472     raeburn  6895: }
                   6896: 
                   6897: ###############################################
                   6898: 
                   6899: =pod
                   6900: 
                   6901: =item * &default_quota()
                   6902: 
1.536     raeburn  6903: Retrieves default quota assigned for storage of user portfolio files,
                   6904: given an (optional) user's institutional status.
1.472     raeburn  6905: 
                   6906: Incoming parameters:
                   6907: 1. domain
1.536     raeburn  6908: 2. (Optional) institutional status(es).  This is a : separated list of 
                   6909:    status types (e.g., faculty, staff, student etc.)
                   6910:    which apply to the user for whom the default is being retrieved.
                   6911:    If the institutional status string in undefined, the domain
                   6912:    default quota will be returned. 
1.472     raeburn  6913: 
                   6914: Returns:
                   6915: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  6916: 2. (Optional) institutional type which determined the value of the
                   6917:    default quota.
1.472     raeburn  6918: 
                   6919: If a value has been stored in the domain's configuration db,
                   6920: it will return that, otherwise it returns 20 (for backwards 
                   6921: compatibility with domains which have not set up a configuration
                   6922: db file; the original statically defined portfolio quota was 20 Mb). 
                   6923: 
1.536     raeburn  6924: If the user's status includes multiple types (e.g., staff and student),
                   6925: the largest default quota which applies to the user determines the
                   6926: default quota returned.
                   6927: 
1.472     raeburn  6928: =cut
                   6929: 
                   6930: ###############################################
                   6931: 
                   6932: 
                   6933: sub default_quota {
1.536     raeburn  6934:     my ($udom,$inststatus) = @_;
                   6935:     my ($defquota,$settingstatus);
                   6936:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  6937:                                             ['quotas'],$udom);
                   6938:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  6939:         if ($inststatus ne '') {
                   6940:             my @statuses = split(/:/,$inststatus);
                   6941:             foreach my $item (@statuses) {
1.711     raeburn  6942:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   6943:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   6944:                         if ($defquota eq '') {
                   6945:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   6946:                             $settingstatus = $item;
                   6947:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   6948:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   6949:                             $settingstatus = $item;
                   6950:                         }
                   6951:                     }
                   6952:                 } else {
                   6953:                     if ($quotahash{'quotas'}{$item} ne '') {
                   6954:                         if ($defquota eq '') {
                   6955:                             $defquota = $quotahash{'quotas'}{$item};
                   6956:                             $settingstatus = $item;
                   6957:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   6958:                             $defquota = $quotahash{'quotas'}{$item};
                   6959:                             $settingstatus = $item;
                   6960:                         }
1.536     raeburn  6961:                     }
                   6962:                 }
                   6963:             }
                   6964:         }
                   6965:         if ($defquota eq '') {
1.711     raeburn  6966:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   6967:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   6968:             } else {
                   6969:                 $defquota = $quotahash{'quotas'}{'default'};
                   6970:             }
1.536     raeburn  6971:             $settingstatus = 'default';
                   6972:         }
                   6973:     } else {
                   6974:         $settingstatus = 'default';
                   6975:         $defquota = 20;
                   6976:     }
                   6977:     if (wantarray) {
                   6978:         return ($defquota,$settingstatus);
1.472     raeburn  6979:     } else {
1.536     raeburn  6980:         return $defquota;
1.472     raeburn  6981:     }
                   6982: }
                   6983: 
1.384     raeburn  6984: sub get_secgrprole_info {
                   6985:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   6986:     my %sections_count = &get_sections($cdom,$cnum);
                   6987:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   6988:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   6989:     my @groups = sort(keys(%curr_groups));
                   6990:     my $allroles = [];
                   6991:     my $rolehash;
                   6992:     my $accesshash = {
                   6993:                      active => 'Currently has access',
                   6994:                      future => 'Will have future access',
                   6995:                      previous => 'Previously had access',
                   6996:                   };
                   6997:     if ($needroles) {
                   6998:         $rolehash = {'all' => 'all'};
1.385     albertel 6999:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7000: 	if (&Apache::lonnet::error(%user_roles)) {
                   7001: 	    undef(%user_roles);
                   7002: 	}
                   7003:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7004:             my ($role)=split(/\:/,$item,2);
                   7005:             if ($role eq 'cr') { next; }
                   7006:             if ($role =~ /^cr/) {
                   7007:                 $$rolehash{$role} = (split('/',$role))[3];
                   7008:             } else {
                   7009:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7010:             }
                   7011:         }
                   7012:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7013:             push(@{$allroles},$key);
                   7014:         }
                   7015:         push (@{$allroles},'st');
                   7016:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7017:     }
                   7018:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7019: }
                   7020: 
1.555     raeburn  7021: sub user_picker {
1.627     raeburn  7022:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7023:     my $currdom = $dom;
                   7024:     my %curr_selected = (
                   7025:                         srchin => 'dom',
1.580     raeburn  7026:                         srchby => 'lastname',
1.555     raeburn  7027:                       );
                   7028:     my $srchterm;
1.625     raeburn  7029:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7030:         if ($srch->{'srchby'} ne '') {
                   7031:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7032:         }
                   7033:         if ($srch->{'srchin'} ne '') {
                   7034:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7035:         }
                   7036:         if ($srch->{'srchtype'} ne '') {
                   7037:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7038:         }
                   7039:         if ($srch->{'srchdomain'} ne '') {
                   7040:             $currdom = $srch->{'srchdomain'};
                   7041:         }
                   7042:         $srchterm = $srch->{'srchterm'};
                   7043:     }
                   7044:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7045:                     'usr'       => 'Search criteria',
1.563     raeburn  7046:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7047:                     'uname'     => 'username',
                   7048:                     'lastname'  => 'last name',
1.555     raeburn  7049:                     'lastfirst' => 'last name, first name',
1.558     albertel 7050:                     'crs'       => 'in this course',
1.576     raeburn  7051:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7052:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7053:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7054:                     'exact'     => 'is',
                   7055:                     'contains'  => 'contains',
1.569     raeburn  7056:                     'begins'    => 'begins with',
1.571     raeburn  7057:                     'youm'      => "You must include some text to search for.",
                   7058:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7059:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7060:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7061:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7062:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7063:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7064:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7065:                                        );
1.563     raeburn  7066:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7067:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7068: 
                   7069:     my @srchins = ('crs','dom','alc','instd');
                   7070: 
                   7071:     foreach my $option (@srchins) {
                   7072:         # FIXME 'alc' option unavailable until 
                   7073:         #       loncreateuser::print_user_query_page()
                   7074:         #       has been completed.
                   7075:         next if ($option eq 'alc');
                   7076:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7077:         if ($curr_selected{'srchin'} eq $option) {
                   7078:             $srchinsel .= ' 
                   7079:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7080:         } else {
                   7081:             $srchinsel .= '
                   7082:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7083:         }
1.555     raeburn  7084:     }
1.563     raeburn  7085:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7086: 
                   7087:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7088:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7089:         if ($curr_selected{'srchby'} eq $option) {
                   7090:             $srchbysel .= '
                   7091:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7092:         } else {
                   7093:             $srchbysel .= '
                   7094:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7095:          }
                   7096:     }
                   7097:     $srchbysel .= "\n  </select>\n";
                   7098: 
                   7099:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7100:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7101:         if ($curr_selected{'srchtype'} eq $option) {
                   7102:             $srchtypesel .= '
                   7103:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7104:         } else {
                   7105:             $srchtypesel .= '
                   7106:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7107:         }
                   7108:     }
                   7109:     $srchtypesel .= "\n  </select>\n";
                   7110: 
1.558     albertel 7111:     my ($newuserscript,$new_user_create);
1.556     raeburn  7112: 
                   7113:     if ($forcenewuser) {
1.576     raeburn  7114:         if (ref($srch) eq 'HASH') {
                   7115:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7116:                 if ($cancreate) {
                   7117:                     $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>';
                   7118:                 } else {
                   7119:                     my $helplink = ' href="javascript:helpMenu('."'display'".')"';
                   7120:                     my %usertypetext = (
                   7121:                         official   => 'institutional',
                   7122:                         unofficial => 'non-institutional',
                   7123:                     );
                   7124:                     $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
                   7125:                 }
1.576     raeburn  7126:             }
                   7127:         }
                   7128: 
1.556     raeburn  7129:         $newuserscript = <<"ENDSCRIPT";
                   7130: 
1.570     raeburn  7131: function setSearch(createnew,callingForm) {
1.556     raeburn  7132:     if (createnew == 1) {
1.570     raeburn  7133:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7134:             if (callingForm.srchby.options[i].value == 'uname') {
                   7135:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7136:             }
                   7137:         }
1.570     raeburn  7138:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7139:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7140: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7141:             }
                   7142:         }
1.570     raeburn  7143:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7144:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7145:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7146:             }
                   7147:         }
1.570     raeburn  7148:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7149:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7150:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7151:             }
                   7152:         }
                   7153:     }
                   7154: }
                   7155: ENDSCRIPT
1.558     albertel 7156: 
1.556     raeburn  7157:     }
                   7158: 
1.555     raeburn  7159:     my $output = <<"END_BLOCK";
1.556     raeburn  7160: <script type="text/javascript">
1.570     raeburn  7161: function validateEntry(callingForm) {
1.558     albertel 7162: 
1.556     raeburn  7163:     var checkok = 1;
1.558     albertel 7164:     var srchin;
1.570     raeburn  7165:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7166: 	if ( callingForm.srchin[i].checked ) {
                   7167: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7168: 	}
                   7169:     }
                   7170: 
1.570     raeburn  7171:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7172:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7173:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7174:     var srchterm =  callingForm.srchterm.value;
                   7175:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7176:     var msg = "";
                   7177: 
                   7178:     if (srchterm == "") {
                   7179:         checkok = 0;
1.571     raeburn  7180:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7181:     }
                   7182: 
1.569     raeburn  7183:     if (srchtype== 'begins') {
                   7184:         if (srchterm.length < 2) {
                   7185:             checkok = 0;
1.571     raeburn  7186:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7187:         }
                   7188:     }
                   7189: 
1.556     raeburn  7190:     if (srchtype== 'contains') {
                   7191:         if (srchterm.length < 3) {
                   7192:             checkok = 0;
1.571     raeburn  7193:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7194:         }
                   7195:     }
                   7196:     if (srchin == 'instd') {
                   7197:         if (srchdomain == '') {
                   7198:             checkok = 0;
1.571     raeburn  7199:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7200:         }
                   7201:     }
                   7202:     if (srchin == 'dom') {
                   7203:         if (srchdomain == '') {
                   7204:             checkok = 0;
1.571     raeburn  7205:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7206:         }
                   7207:     }
                   7208:     if (srchby == 'lastfirst') {
                   7209:         if (srchterm.indexOf(",") == -1) {
                   7210:             checkok = 0;
1.571     raeburn  7211:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7212:         }
                   7213:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7214:             checkok = 0;
1.571     raeburn  7215:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7216:         }
                   7217:     }
                   7218:     if (checkok == 0) {
1.571     raeburn  7219:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7220:         return;
                   7221:     }
                   7222:     if (checkok == 1) {
1.570     raeburn  7223:         callingForm.submit();
1.556     raeburn  7224:     }
                   7225: }
                   7226: 
                   7227: $newuserscript
                   7228: 
                   7229: </script>
1.558     albertel 7230: 
                   7231: $new_user_create
                   7232: 
1.555     raeburn  7233: <table>
1.558     albertel 7234:  <tr>
1.573     raeburn  7235:   <td>$lt{'doma'}:</td>
                   7236:   <td>$domform</td>
                   7237:   </td>
                   7238:  </tr>
                   7239:  <tr>
                   7240:   <td>$lt{'usr'}:</td>
1.563     raeburn  7241:   <td>$srchbysel
                   7242:       $srchtypesel 
                   7243:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7244:       $srchinsel 
1.563     raeburn  7245:   </td>
                   7246:  </tr>
1.555     raeburn  7247: </table>
                   7248: <br />
                   7249: END_BLOCK
1.558     albertel 7250: 
1.555     raeburn  7251:     return $output;
                   7252: }
                   7253: 
1.612     raeburn  7254: sub user_rule_check {
1.615     raeburn  7255:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7256:     my $response;
                   7257:     if (ref($usershash) eq 'HASH') {
                   7258:         foreach my $user (keys(%{$usershash})) {
                   7259:             my ($uname,$udom) = split(/:/,$user);
                   7260:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7261:             my ($id,$newuser);
1.612     raeburn  7262:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7263:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7264:                 $id = $usershash->{$user}->{'id'};
                   7265:             }
                   7266:             my $inst_response;
                   7267:             if (ref($checks) eq 'HASH') {
                   7268:                 if (defined($checks->{'username'})) {
1.615     raeburn  7269:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7270:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7271:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7272:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7273:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7274:                 }
1.615     raeburn  7275:             } else {
                   7276:                 ($inst_response,%{$inst_results->{$user}}) =
                   7277:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7278:                 return;
1.612     raeburn  7279:             }
1.615     raeburn  7280:             if (!$got_rules->{$udom}) {
1.612     raeburn  7281:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7282:                                                   ['usercreation'],$udom);
                   7283:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7284:                     foreach my $item ('username','id') {
1.612     raeburn  7285:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7286:                             $$curr_rules{$udom}{$item} = 
                   7287:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7288:                         }
                   7289:                     }
                   7290:                 }
1.615     raeburn  7291:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7292:             }
1.612     raeburn  7293:             foreach my $item (keys(%{$checks})) {
                   7294:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7295:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7296:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7297:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7298:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7299:                                 if ($rule_check{$rule}) {
                   7300:                                     $$rulematch{$user}{$item} = $rule;
                   7301:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7302:                                         if (ref($inst_results) eq 'HASH') {
                   7303:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7304:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7305:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7306:                                                 }
1.612     raeburn  7307:                                             }
                   7308:                                         }
1.615     raeburn  7309:                                     }
                   7310:                                     last;
1.585     raeburn  7311:                                 }
                   7312:                             }
                   7313:                         }
                   7314:                     }
                   7315:                 }
                   7316:             }
                   7317:         }
                   7318:     }
1.612     raeburn  7319:     return;
                   7320: }
                   7321: 
                   7322: sub user_rule_formats {
                   7323:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7324:     my %text = ( 
                   7325:                  'username' => 'Usernames',
                   7326:                  'id'       => 'IDs',
                   7327:                );
                   7328:     my $output;
                   7329:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7330:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7331:         if (@{$ruleorder} > 0) {
                   7332:             $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>';
                   7333:             foreach my $rule (@{$ruleorder}) {
                   7334:                 if (ref($curr_rules) eq 'ARRAY') {
                   7335:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7336:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7337:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7338:                                         $rules->{$rule}{'desc'}.'</li>';
                   7339:                         }
                   7340:                     }
                   7341:                 }
                   7342:             }
                   7343:             $output .= '</ul>';
                   7344:         }
                   7345:     }
                   7346:     return $output;
                   7347: }
                   7348: 
                   7349: sub instrule_disallow_msg {
1.615     raeburn  7350:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7351:     my $response;
                   7352:     my %text = (
                   7353:                   item   => 'username',
                   7354:                   items  => 'usernames',
                   7355:                   match  => 'matches',
                   7356:                   do     => 'does',
                   7357:                   action => 'a username',
                   7358:                   one    => 'one',
                   7359:                );
                   7360:     if ($count > 1) {
                   7361:         $text{'item'} = 'usernames';
                   7362:         $text{'match'} ='match';
                   7363:         $text{'do'} = 'do';
                   7364:         $text{'action'} = 'usernames',
                   7365:         $text{'one'} = 'ones';
                   7366:     }
                   7367:     if ($checkitem eq 'id') {
                   7368:         $text{'items'} = 'IDs';
                   7369:         $text{'item'} = 'ID';
                   7370:         $text{'action'} = 'an ID';
1.615     raeburn  7371:         if ($count > 1) {
                   7372:             $text{'item'} = 'IDs';
                   7373:             $text{'action'} = 'IDs';
                   7374:         }
1.612     raeburn  7375:     }
1.674     bisitz   7376:     $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615     raeburn  7377:     if ($mode eq 'upload') {
                   7378:         if ($checkitem eq 'username') {
                   7379:             $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'}.");
                   7380:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7381:             $response .= &mt("Either upload a file which includes $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615     raeburn  7382:         }
1.669     raeburn  7383:     } elsif ($mode eq 'selfcreate') {
                   7384:         if ($checkitem eq 'id') {
                   7385:             $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.");
                   7386:         }
1.615     raeburn  7387:     } else {
                   7388:         if ($checkitem eq 'username') {
                   7389:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7390:         } elsif ($checkitem eq 'id') {
                   7391:             $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.");
                   7392:         }
1.612     raeburn  7393:     }
                   7394:     return $response;
1.585     raeburn  7395: }
                   7396: 
1.624     raeburn  7397: sub personal_data_fieldtitles {
                   7398:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7399:                         id => 'Student/Employee ID',
                   7400:                         permanentemail => 'E-mail address',
                   7401:                         lastname => 'Last Name',
                   7402:                         firstname => 'First Name',
                   7403:                         middlename => 'Middle Name',
                   7404:                         generation => 'Generation',
                   7405:                         gen => 'Generation',
                   7406:                    );
                   7407:     return %fieldtitles;
                   7408: }
                   7409: 
1.642     raeburn  7410: sub sorted_inst_types {
                   7411:     my ($dom) = @_;
                   7412:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7413:     my $othertitle = &mt('All users');
                   7414:     if ($env{'request.course.id'}) {
1.668     raeburn  7415:         $othertitle  = &mt('Any users');
1.642     raeburn  7416:     }
                   7417:     my @types;
                   7418:     if (ref($order) eq 'ARRAY') {
                   7419:         @types = @{$order};
                   7420:     }
                   7421:     if (@types == 0) {
                   7422:         if (ref($usertypes) eq 'HASH') {
                   7423:             @types = sort(keys(%{$usertypes}));
                   7424:         }
                   7425:     }
                   7426:     if (keys(%{$usertypes}) > 0) {
                   7427:         $othertitle = &mt('Other users');
                   7428:     }
                   7429:     return ($othertitle,$usertypes,\@types);
                   7430: }
                   7431: 
1.645     raeburn  7432: sub get_institutional_codes {
                   7433:     my ($settings,$allcourses,$LC_code) = @_;
                   7434: # Get complete list of course sections to update
                   7435:     my @currsections = ();
                   7436:     my @currxlists = ();
                   7437:     my $coursecode = $$settings{'internal.coursecode'};
                   7438: 
                   7439:     if ($$settings{'internal.sectionnums'} ne '') {
                   7440:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7441:     }
                   7442: 
                   7443:     if ($$settings{'internal.crosslistings'} ne '') {
                   7444:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7445:     }
                   7446: 
                   7447:     if (@currxlists > 0) {
                   7448:         foreach (@currxlists) {
                   7449:             if (m/^([^:]+):(\w*)$/) {
                   7450:                 unless (grep/^$1$/,@{$allcourses}) {
                   7451:                     push @{$allcourses},$1;
                   7452:                     $$LC_code{$1} = $2;
                   7453:                 }
                   7454:             }
                   7455:         }
                   7456:     }
                   7457:  
                   7458:     if (@currsections > 0) {
                   7459:         foreach (@currsections) {
                   7460:             if (m/^(\w+):(\w*)$/) {
                   7461:                 my $sec = $coursecode.$1;
                   7462:                 my $lc_sec = $2;
                   7463:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7464:                     push @{$allcourses},$sec;
                   7465:                     $$LC_code{$sec} = $lc_sec;
                   7466:                 }
                   7467:             }
                   7468:         }
                   7469:     }
                   7470:     return;
                   7471: }
                   7472: 
1.112     bowersj2 7473: =pod
                   7474: 
1.549     albertel 7475: =back
                   7476: 
                   7477: =head1 HTTP Helpers
                   7478: 
                   7479: =over 4
                   7480: 
1.648     raeburn  7481: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7482: 
1.258     albertel 7483: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7484: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7485: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7486: 
                   7487: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7488: $possible_names is an ref to an array of form element names.  As an example:
                   7489: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7490: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7491: 
                   7492: =cut
1.1       albertel 7493: 
1.6       albertel 7494: sub get_unprocessed_cgi {
1.25      albertel 7495:   my ($query,$possible_names)= @_;
1.26      matthew  7496:   # $Apache::lonxml::debug=1;
1.356     albertel 7497:   foreach my $pair (split(/&/,$query)) {
                   7498:     my ($name, $value) = split(/=/,$pair);
1.369     www      7499:     $name = &unescape($name);
1.25      albertel 7500:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   7501:       $value =~ tr/+/ /;
                   7502:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 7503:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 7504:     }
1.16      harris41 7505:   }
1.6       albertel 7506: }
                   7507: 
1.112     bowersj2 7508: =pod
                   7509: 
1.648     raeburn  7510: =item * &cacheheader() 
1.112     bowersj2 7511: 
                   7512: returns cache-controlling header code
                   7513: 
                   7514: =cut
                   7515: 
1.7       albertel 7516: sub cacheheader {
1.258     albertel 7517:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 7518:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   7519:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 7520:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   7521:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 7522:     return $output;
1.7       albertel 7523: }
                   7524: 
1.112     bowersj2 7525: =pod
                   7526: 
1.648     raeburn  7527: =item * &no_cache($r) 
1.112     bowersj2 7528: 
                   7529: specifies header code to not have cache
                   7530: 
                   7531: =cut
                   7532: 
1.9       albertel 7533: sub no_cache {
1.216     albertel 7534:     my ($r) = @_;
                   7535:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 7536: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 7537:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   7538:     $r->no_cache(1);
                   7539:     $r->header_out("Expires" => $date);
                   7540:     $r->header_out("Pragma" => "no-cache");
1.123     www      7541: }
                   7542: 
                   7543: sub content_type {
1.181     albertel 7544:     my ($r,$type,$charset) = @_;
1.299     foxr     7545:     if ($r) {
                   7546: 	#  Note that printout.pl calls this with undef for $r.
                   7547: 	&no_cache($r);
                   7548:     }
1.258     albertel 7549:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 7550:     unless ($charset) {
                   7551: 	$charset=&Apache::lonlocal::current_encoding;
                   7552:     }
                   7553:     if ($charset) { $type.='; charset='.$charset; }
                   7554:     if ($r) {
                   7555: 	$r->content_type($type);
                   7556:     } else {
                   7557: 	print("Content-type: $type\n\n");
                   7558:     }
1.9       albertel 7559: }
1.25      albertel 7560: 
1.112     bowersj2 7561: =pod
                   7562: 
1.648     raeburn  7563: =item * &add_to_env($name,$value) 
1.112     bowersj2 7564: 
1.258     albertel 7565: adds $name to the %env hash with value
1.112     bowersj2 7566: $value, if $name already exists, the entry is converted to an array
                   7567: reference and $value is added to the array.
                   7568: 
                   7569: =cut
                   7570: 
1.25      albertel 7571: sub add_to_env {
                   7572:   my ($name,$value)=@_;
1.258     albertel 7573:   if (defined($env{$name})) {
                   7574:     if (ref($env{$name})) {
1.25      albertel 7575:       #already have multiple values
1.258     albertel 7576:       push(@{ $env{$name} },$value);
1.25      albertel 7577:     } else {
                   7578:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 7579:       my $first=$env{$name};
                   7580:       undef($env{$name});
                   7581:       push(@{ $env{$name} },$first,$value);
1.25      albertel 7582:     }
                   7583:   } else {
1.258     albertel 7584:     $env{$name}=$value;
1.25      albertel 7585:   }
1.31      albertel 7586: }
1.149     albertel 7587: 
                   7588: =pod
                   7589: 
1.648     raeburn  7590: =item * &get_env_multiple($name) 
1.149     albertel 7591: 
1.258     albertel 7592: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 7593: values may be defined and end up as an array ref.
                   7594: 
                   7595: returns an array of values
                   7596: 
                   7597: =cut
                   7598: 
                   7599: sub get_env_multiple {
                   7600:     my ($name) = @_;
                   7601:     my @values;
1.258     albertel 7602:     if (defined($env{$name})) {
1.149     albertel 7603:         # exists is it an array
1.258     albertel 7604:         if (ref($env{$name})) {
                   7605:             @values=@{ $env{$name} };
1.149     albertel 7606:         } else {
1.258     albertel 7607:             $values[0]=$env{$name};
1.149     albertel 7608:         }
                   7609:     }
                   7610:     return(@values);
                   7611: }
                   7612: 
1.660     raeburn  7613: sub ask_for_embedded_content {
                   7614:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   7615:     my $upload_output = '
                   7616:    <form name="upload_embedded" action="'.$actionurl.'"
                   7617:                   method="post" enctype="multipart/form-data">';
                   7618:     $upload_output .= $state;
1.661     raeburn  7619:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  7620: 
                   7621:     my $num = 0;
                   7622:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   7623:         $upload_output .= &start_data_table_row().
                   7624:             '<td>'.$embed_file.'</td><td>';
                   7625:         if ($args->{'ignore_remote_references'}
                   7626:             && $embed_file =~ m{^\w+://}) {
                   7627:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   7628:         } elsif ($args->{'error_on_invalid_names'}
                   7629:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   7630: 
                   7631:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   7632: 
                   7633:         } else {
                   7634:             $upload_output .='
1.661     raeburn  7635:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  7636:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   7637:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   7638:             $upload_output .=
                   7639:                 "\n\t\t".
                   7640:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   7641:                 $attrib.'" />';
                   7642:             if (exists($$codebase{$embed_file})) {
                   7643:                 $upload_output .=
                   7644:                     "\n\t\t".
                   7645:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   7646:                     &escape($$codebase{$embed_file}).'" />';
                   7647:             }
                   7648:         }
                   7649:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   7650:         $num++;
                   7651:     }
                   7652:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   7653:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   7654:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   7655:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   7656:    </form>';
                   7657:     return $upload_output;
                   7658: }
                   7659: 
1.661     raeburn  7660: sub upload_embedded {
                   7661:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   7662:         $current_disk_usage) = @_;
                   7663:     my $output;
                   7664:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   7665:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   7666:         my $orig_uploaded_filename =
                   7667:             $env{'form.embedded_item_'.$i.'.filename'};
                   7668: 
                   7669:         $env{'form.embedded_orig_'.$i} =
                   7670:             &unescape($env{'form.embedded_orig_'.$i});
                   7671:         my ($path,$fname) =
                   7672:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   7673:         # no path, whole string is fname
                   7674:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   7675: 
                   7676:         $path = $env{'form.currentpath'}.$path;
                   7677:         $fname = &Apache::lonnet::clean_filename($fname);
                   7678:         # See if there is anything left
                   7679:         next if ($fname eq '');
                   7680: 
                   7681:         # Check if file already exists as a file or directory.
                   7682:         my ($state,$msg);
                   7683:         if ($context eq 'portfolio') {
                   7684:             my $port_path = $dirpath;
                   7685:             if ($group ne '') {
                   7686:                 $port_path = "groups/$group/$port_path";
                   7687:             }
                   7688:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   7689:                                               $dir_root,$port_path,$disk_quota,
                   7690:                                               $current_disk_usage,$uname,$udom);
                   7691:             if ($state eq 'will_exceed_quota'
                   7692:                 || $state eq 'file_locked'
                   7693:                 || $state eq 'file_exists' ) {
                   7694:                 $output .= $msg;
                   7695:                 next;
                   7696:             }
                   7697:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   7698:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   7699:             if ($state eq 'exists') {
                   7700:                 $output .= $msg;
                   7701:                 next;
                   7702:             }
                   7703:         }
                   7704:         # Check if extension is valid
                   7705:         if (($fname =~ /\.(\w+)$/) &&
                   7706:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   7707:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   7708:             next;
                   7709:         } elsif (($fname =~ /\.(\w+)$/) &&
                   7710:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   7711:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   7712:             next;
                   7713:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   7714:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   7715:             next;
                   7716:         }
                   7717: 
                   7718:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   7719:         if ($context eq 'portfolio') {
                   7720:             my $result=
                   7721:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   7722:                                                 $dirpath.$path);
                   7723:             if ($result !~ m|^/uploaded/|) {
                   7724:                 $output .= '<span class="LC_error">'
                   7725:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   7726:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   7727:                       .'</span><br />';
                   7728:                 next;
                   7729:             } else {
                   7730:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   7731:                            $path.$fname.'</span>').'</p>';     
                   7732:             }
                   7733:         } else {
                   7734: # Save the file
                   7735:             my $target = $env{'form.embedded_item_'.$i};
                   7736:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   7737:             my $dest = $fullpath.$fname;
                   7738:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   7739:             my @parts=split(/\//,$fullpath);
                   7740:             my $count;
                   7741:             my $filepath = $dir_root;
                   7742:             for ($count=4;$count<=$#parts;$count++) {
                   7743:                 $filepath .= "/$parts[$count]";
                   7744:                 if ((-e $filepath)!=1) {
                   7745:                     mkdir($filepath,0770);
                   7746:                 }
                   7747:             }
                   7748:             my $fh;
                   7749:             if (!open($fh,'>'.$dest)) {
                   7750:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   7751:                 $output .= '<span class="LC_error">'.
                   7752:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   7753:                            '</span><br />';
                   7754:             } else {
                   7755:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   7756:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   7757:                     $output .= '<span class="LC_error">'.
                   7758:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   7759:                               '</span><br />';
                   7760:                 } else {
                   7761:                     if ($context eq 'testbank') {
                   7762:                         $output .= &mt('Embedded file uploaded successfully:').
                   7763:                                    '&nbsp;<a href="'.$url.'">'.
                   7764:                                    $orig_uploaded_filename.'</a><br />';
                   7765:                     } else {
1.705     tempelho 7766:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  7767:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 7768:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  7769:                     }
                   7770:                 }
                   7771:                 close($fh);
                   7772:             }
                   7773:         }
                   7774:     }
                   7775:     return $output;
                   7776: }
                   7777: 
                   7778: sub check_for_existing {
                   7779:     my ($path,$fname,$element) = @_;
                   7780:     my ($state,$msg);
                   7781:     if (-d $path.'/'.$fname) {
                   7782:         $state = 'exists';
                   7783:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   7784:     } elsif (-e $path.'/'.$fname) {
                   7785:         $state = 'exists';
                   7786:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   7787:     }
                   7788:     if ($state eq 'exists') {
                   7789:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   7790:     }
                   7791:     return ($state,$msg);
                   7792: }
                   7793: 
                   7794: sub check_for_upload {
                   7795:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   7796:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   7797:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   7798:     my $getpropath = 1;
                   7799:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   7800:                                             $getpropath);
                   7801:     my $found_file = 0;
                   7802:     my $locked_file = 0;
                   7803:     foreach my $line (@dir_list) {
                   7804:         my ($file_name)=split(/\&/,$line,2);
                   7805:         if ($file_name eq $fname){
                   7806:             $file_name = $path.$file_name;
                   7807:             if ($group ne '') {
                   7808:                 $file_name = $group.$file_name;
                   7809:             }
                   7810:             $found_file = 1;
                   7811:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   7812:                 $locked_file = 1;
                   7813:             }
                   7814:         }
                   7815:     }
                   7816:     if (($current_disk_usage + $filesize) > $disk_quota){
                   7817:         my $msg = '<span class="LC_error">'.
                   7818:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   7819:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   7820:         return ('will_exceed_quota',$msg);
                   7821:     } elsif ($found_file) {
                   7822:         if ($locked_file) {
                   7823:             my $msg = '<span class="LC_error">';
                   7824:             $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>');
                   7825:             $msg .= '</span><br />';
                   7826:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   7827:             return ('file_locked',$msg);
                   7828:         } else {
                   7829:             my $msg = '<span class="LC_error">';
                   7830:             $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'});
                   7831:             $msg .= '</span>';
                   7832:             $msg .= '<br />';
                   7833:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   7834:             return ('file_exists',$msg);
                   7835:         }
                   7836:     }
                   7837: }
                   7838: 
1.31      albertel 7839: 
1.41      ng       7840: =pod
1.45      matthew  7841: 
1.464     albertel 7842: =back
1.41      ng       7843: 
1.112     bowersj2 7844: =head1 CSV Upload/Handling functions
1.38      albertel 7845: 
1.41      ng       7846: =over 4
                   7847: 
1.648     raeburn  7848: =item * &upfile_store($r)
1.41      ng       7849: 
                   7850: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 7851: needs $env{'form.upfile'}
1.41      ng       7852: returns $datatoken to be put into hidden field
                   7853: 
                   7854: =cut
1.31      albertel 7855: 
                   7856: sub upfile_store {
                   7857:     my $r=shift;
1.258     albertel 7858:     $env{'form.upfile'}=~s/\r/\n/gs;
                   7859:     $env{'form.upfile'}=~s/\f/\n/gs;
                   7860:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   7861:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 7862: 
1.258     albertel 7863:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   7864: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 7865:     {
1.158     raeburn  7866:         my $datafile = $r->dir_config('lonDaemons').
                   7867:                            '/tmp/'.$datatoken.'.tmp';
                   7868:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 7869:             print $fh $env{'form.upfile'};
1.158     raeburn  7870:             close($fh);
                   7871:         }
1.31      albertel 7872:     }
                   7873:     return $datatoken;
                   7874: }
                   7875: 
1.56      matthew  7876: =pod
                   7877: 
1.648     raeburn  7878: =item * &load_tmp_file($r)
1.41      ng       7879: 
                   7880: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 7881: needs $env{'form.datatoken'},
                   7882: sets $env{'form.upfile'} to the contents of the file
1.41      ng       7883: 
                   7884: =cut
1.31      albertel 7885: 
                   7886: sub load_tmp_file {
                   7887:     my $r=shift;
                   7888:     my @studentdata=();
                   7889:     {
1.158     raeburn  7890:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 7891:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  7892:         if ( open(my $fh,"<$studentfile") ) {
                   7893:             @studentdata=<$fh>;
                   7894:             close($fh);
                   7895:         }
1.31      albertel 7896:     }
1.258     albertel 7897:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 7898: }
                   7899: 
1.56      matthew  7900: =pod
                   7901: 
1.648     raeburn  7902: =item * &upfile_record_sep()
1.41      ng       7903: 
                   7904: Separate uploaded file into records
                   7905: returns array of records,
1.258     albertel 7906: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       7907: 
                   7908: =cut
1.31      albertel 7909: 
                   7910: sub upfile_record_sep {
1.258     albertel 7911:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 7912:     } else {
1.248     albertel 7913: 	my @records;
1.258     albertel 7914: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 7915: 	    if ($line=~/^\s*$/) { next; }
                   7916: 	    push(@records,$line);
                   7917: 	}
                   7918: 	return @records;
1.31      albertel 7919:     }
                   7920: }
                   7921: 
1.56      matthew  7922: =pod
                   7923: 
1.648     raeburn  7924: =item * &record_sep($record)
1.41      ng       7925: 
1.258     albertel 7926: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       7927: 
                   7928: =cut
                   7929: 
1.263     www      7930: sub takeleft {
                   7931:     my $index=shift;
                   7932:     return substr('0000'.$index,-4,4);
                   7933: }
                   7934: 
1.31      albertel 7935: sub record_sep {
                   7936:     my $record=shift;
                   7937:     my %components=();
1.258     albertel 7938:     if ($env{'form.upfiletype'} eq 'xml') {
                   7939:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 7940:         my $i=0;
1.356     albertel 7941:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 7942:             $field=~s/^(\"|\')//;
                   7943:             $field=~s/(\"|\')$//;
1.263     www      7944:             $components{&takeleft($i)}=$field;
1.31      albertel 7945:             $i++;
                   7946:         }
1.258     albertel 7947:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 7948:         my $i=0;
1.356     albertel 7949:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 7950:             $field=~s/^(\"|\')//;
                   7951:             $field=~s/(\"|\')$//;
1.263     www      7952:             $components{&takeleft($i)}=$field;
1.31      albertel 7953:             $i++;
                   7954:         }
                   7955:     } else {
1.561     www      7956:         my $separator=',';
1.480     banghart 7957:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      7958:             $separator=';';
1.480     banghart 7959:         }
1.31      albertel 7960:         my $i=0;
1.561     www      7961: # the character we are looking for to indicate the end of a quote or a record 
                   7962:         my $looking_for=$separator;
                   7963: # do not add the characters to the fields
                   7964:         my $ignore=0;
                   7965: # we just encountered a separator (or the beginning of the record)
                   7966:         my $just_found_separator=1;
                   7967: # store the field we are working on here
                   7968:         my $field='';
                   7969: # work our way through all characters in record
                   7970:         foreach my $character ($record=~/(.)/g) {
                   7971:             if ($character eq $looking_for) {
                   7972:                if ($character ne $separator) {
                   7973: # Found the end of a quote, again looking for separator
                   7974:                   $looking_for=$separator;
                   7975:                   $ignore=1;
                   7976:                } else {
                   7977: # Found a separator, store away what we got
                   7978:                   $components{&takeleft($i)}=$field;
                   7979: 	          $i++;
                   7980:                   $just_found_separator=1;
                   7981:                   $ignore=0;
                   7982:                   $field='';
                   7983:                }
                   7984:                next;
                   7985:             }
                   7986: # single or double quotation marks after a separator indicate beginning of a quote
                   7987: # we are now looking for the end of the quote and need to ignore separators
                   7988:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   7989:                $looking_for=$character;
                   7990:                next;
                   7991:             }
                   7992: # ignore would be true after we reached the end of a quote
                   7993:             if ($ignore) { next; }
                   7994:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   7995:             $field.=$character;
                   7996:             $just_found_separator=0; 
1.31      albertel 7997:         }
1.561     www      7998: # catch the very last entry, since we never encountered the separator
                   7999:         $components{&takeleft($i)}=$field;
1.31      albertel 8000:     }
                   8001:     return %components;
                   8002: }
                   8003: 
1.144     matthew  8004: ######################################################
                   8005: ######################################################
                   8006: 
1.56      matthew  8007: =pod
                   8008: 
1.648     raeburn  8009: =item * &upfile_select_html()
1.41      ng       8010: 
1.144     matthew  8011: Return HTML code to select a file from the users machine and specify 
                   8012: the file type.
1.41      ng       8013: 
                   8014: =cut
                   8015: 
1.144     matthew  8016: ######################################################
                   8017: ######################################################
1.31      albertel 8018: sub upfile_select_html {
1.144     matthew  8019:     my %Types = (
                   8020:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8021:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8022:                  space => &mt('Space separated'),
                   8023:                  tab   => &mt('Tabulator separated'),
                   8024: #                 xml   => &mt('HTML/XML'),
                   8025:                  );
                   8026:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8027:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8028:     foreach my $type (sort(keys(%Types))) {
                   8029:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8030:     }
                   8031:     $Str .= "</select>\n";
                   8032:     return $Str;
1.31      albertel 8033: }
                   8034: 
1.301     albertel 8035: sub get_samples {
                   8036:     my ($records,$toget) = @_;
                   8037:     my @samples=({});
                   8038:     my $got=0;
                   8039:     foreach my $rec (@$records) {
                   8040: 	my %temp = &record_sep($rec);
                   8041: 	if (! grep(/\S/, values(%temp))) { next; }
                   8042: 	if (%temp) {
                   8043: 	    $samples[$got]=\%temp;
                   8044: 	    $got++;
                   8045: 	    if ($got == $toget) { last; }
                   8046: 	}
                   8047:     }
                   8048:     return \@samples;
                   8049: }
                   8050: 
1.144     matthew  8051: ######################################################
                   8052: ######################################################
                   8053: 
1.56      matthew  8054: =pod
                   8055: 
1.648     raeburn  8056: =item * &csv_print_samples($r,$records)
1.41      ng       8057: 
                   8058: Prints a table of sample values from each column uploaded $r is an
                   8059: Apache Request ref, $records is an arrayref from
                   8060: &Apache::loncommon::upfile_record_sep
                   8061: 
                   8062: =cut
                   8063: 
1.144     matthew  8064: ######################################################
                   8065: ######################################################
1.31      albertel 8066: sub csv_print_samples {
                   8067:     my ($r,$records) = @_;
1.662     bisitz   8068:     my $samples = &get_samples($records,5);
1.301     albertel 8069: 
1.594     raeburn  8070:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8071:               &start_data_table_header_row());
1.356     albertel 8072:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   8073:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  8074:     $r->print(&end_data_table_header_row());
1.301     albertel 8075:     foreach my $hash (@$samples) {
1.594     raeburn  8076: 	$r->print(&start_data_table_row());
1.356     albertel 8077: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8078: 	    $r->print('<td>');
1.356     albertel 8079: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8080: 	    $r->print('</td>');
                   8081: 	}
1.594     raeburn  8082: 	$r->print(&end_data_table_row());
1.31      albertel 8083:     }
1.594     raeburn  8084:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8085: }
                   8086: 
1.144     matthew  8087: ######################################################
                   8088: ######################################################
                   8089: 
1.56      matthew  8090: =pod
                   8091: 
1.648     raeburn  8092: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8093: 
                   8094: Prints a table to create associations between values and table columns.
1.144     matthew  8095: 
1.41      ng       8096: $r is an Apache Request ref,
                   8097: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8098: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8099: 
                   8100: =cut
                   8101: 
1.144     matthew  8102: ######################################################
                   8103: ######################################################
1.31      albertel 8104: sub csv_print_select_table {
                   8105:     my ($r,$records,$d) = @_;
1.301     albertel 8106:     my $i=0;
                   8107:     my $samples = &get_samples($records,1);
1.144     matthew  8108:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8109: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8110:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8111:               '<th>'.&mt('Column').'</th>'.
                   8112:               &end_data_table_header_row()."\n");
1.356     albertel 8113:     foreach my $array_ref (@$d) {
                   8114: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8115: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8116: 
                   8117: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8118: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8119: 	$r->print('<option value="none"></option>');
1.356     albertel 8120: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8121: 	    $r->print('<option value="'.$sample.'"'.
                   8122:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8123:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8124: 	}
1.594     raeburn  8125: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8126: 	$i++;
                   8127:     }
1.594     raeburn  8128:     $r->print(&end_data_table());
1.31      albertel 8129:     $i--;
                   8130:     return $i;
                   8131: }
1.56      matthew  8132: 
1.144     matthew  8133: ######################################################
                   8134: ######################################################
                   8135: 
1.56      matthew  8136: =pod
1.31      albertel 8137: 
1.648     raeburn  8138: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8139: 
                   8140: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8141: 
                   8142: $r is an Apache Request ref,
                   8143: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8144: $d is an array of 2 element arrays (internal name, displayed name)
                   8145: 
                   8146: =cut
                   8147: 
1.144     matthew  8148: ######################################################
                   8149: ######################################################
1.31      albertel 8150: sub csv_samples_select_table {
                   8151:     my ($r,$records,$d) = @_;
                   8152:     my $i=0;
1.144     matthew  8153:     #
1.662     bisitz   8154:     my $max_samples = 5;
                   8155:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8156:     $r->print(&start_data_table().
                   8157:               &start_data_table_header_row().'<th>'.
                   8158:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8159:               &end_data_table_header_row());
1.301     albertel 8160: 
                   8161:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8162: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8163: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8164: 	foreach my $option (@$d) {
                   8165: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8166: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8167:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8168:                       $display.'</option>');
1.31      albertel 8169: 	}
                   8170: 	$r->print('</select></td><td>');
1.662     bisitz   8171: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8172: 	    if (defined($samples->[$line]{$key})) { 
                   8173: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8174: 	    }
                   8175: 	}
1.594     raeburn  8176: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8177: 	$i++;
                   8178:     }
1.594     raeburn  8179:     $r->print(&end_data_table());
1.31      albertel 8180:     $i--;
                   8181:     return($i);
1.115     matthew  8182: }
                   8183: 
1.144     matthew  8184: ######################################################
                   8185: ######################################################
                   8186: 
1.115     matthew  8187: =pod
                   8188: 
1.648     raeburn  8189: =item * &clean_excel_name($name)
1.115     matthew  8190: 
                   8191: Returns a replacement for $name which does not contain any illegal characters.
                   8192: 
                   8193: =cut
                   8194: 
1.144     matthew  8195: ######################################################
                   8196: ######################################################
1.115     matthew  8197: sub clean_excel_name {
                   8198:     my ($name) = @_;
                   8199:     $name =~ s/[:\*\?\/\\]//g;
                   8200:     if (length($name) > 31) {
                   8201:         $name = substr($name,0,31);
                   8202:     }
                   8203:     return $name;
1.25      albertel 8204: }
1.84      albertel 8205: 
1.85      albertel 8206: =pod
                   8207: 
1.648     raeburn  8208: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8209: 
                   8210: Returns either 1 or undef
                   8211: 
                   8212: 1 if the part is to be hidden, undef if it is to be shown
                   8213: 
                   8214: Arguments are:
                   8215: 
                   8216: $id the id of the part to be checked
                   8217: $symb, optional the symb of the resource to check
                   8218: $udom, optional the domain of the user to check for
                   8219: $uname, optional the username of the user to check for
                   8220: 
                   8221: =cut
1.84      albertel 8222: 
                   8223: sub check_if_partid_hidden {
                   8224:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8225:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8226: 					 $symb,$udom,$uname);
1.141     albertel 8227:     my $truth=1;
                   8228:     #if the string starts with !, then the list is the list to show not hide
                   8229:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8230:     my @hiddenlist=split(/,/,$hiddenparts);
                   8231:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8232: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8233:     }
1.141     albertel 8234:     return !$truth;
1.84      albertel 8235: }
1.127     matthew  8236: 
1.138     matthew  8237: 
                   8238: ############################################################
                   8239: ############################################################
                   8240: 
                   8241: =pod
                   8242: 
1.157     matthew  8243: =back 
                   8244: 
1.138     matthew  8245: =head1 cgi-bin script and graphing routines
                   8246: 
1.157     matthew  8247: =over 4
                   8248: 
1.648     raeburn  8249: =item * &get_cgi_id()
1.138     matthew  8250: 
                   8251: Inputs: none
                   8252: 
                   8253: Returns an id which can be used to pass environment variables
                   8254: to various cgi-bin scripts.  These environment variables will
                   8255: be removed from the users environment after a given time by
                   8256: the routine &Apache::lonnet::transfer_profile_to_env.
                   8257: 
                   8258: =cut
                   8259: 
                   8260: ############################################################
                   8261: ############################################################
1.152     albertel 8262: my $uniq=0;
1.136     matthew  8263: sub get_cgi_id {
1.154     albertel 8264:     $uniq=($uniq+1)%100000;
1.280     albertel 8265:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8266: }
                   8267: 
1.127     matthew  8268: ############################################################
                   8269: ############################################################
                   8270: 
                   8271: =pod
                   8272: 
1.648     raeburn  8273: =item * &DrawBarGraph()
1.127     matthew  8274: 
1.138     matthew  8275: Facilitates the plotting of data in a (stacked) bar graph.
                   8276: Puts plot definition data into the users environment in order for 
                   8277: graph.png to plot it.  Returns an <img> tag for the plot.
                   8278: The bars on the plot are labeled '1','2',...,'n'.
                   8279: 
                   8280: Inputs:
                   8281: 
                   8282: =over 4
                   8283: 
                   8284: =item $Title: string, the title of the plot
                   8285: 
                   8286: =item $xlabel: string, text describing the X-axis of the plot
                   8287: 
                   8288: =item $ylabel: string, text describing the Y-axis of the plot
                   8289: 
                   8290: =item $Max: scalar, the maximum Y value to use in the plot
                   8291: If $Max is < any data point, the graph will not be rendered.
                   8292: 
1.140     matthew  8293: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8294: they are plotted.  If undefined, default values will be used.
                   8295: 
1.178     matthew  8296: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8297: 
1.138     matthew  8298: =item @Values: An array of array references.  Each array reference holds data
                   8299: to be plotted in a stacked bar chart.
                   8300: 
1.239     matthew  8301: =item If the final element of @Values is a hash reference the key/value
                   8302: pairs will be added to the graph definition.
                   8303: 
1.138     matthew  8304: =back
                   8305: 
                   8306: Returns:
                   8307: 
                   8308: An <img> tag which references graph.png and the appropriate identifying
                   8309: information for the plot.
                   8310: 
1.127     matthew  8311: =cut
                   8312: 
                   8313: ############################################################
                   8314: ############################################################
1.134     matthew  8315: sub DrawBarGraph {
1.178     matthew  8316:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8317:     #
                   8318:     if (! defined($colors)) {
                   8319:         $colors = ['#33ff00', 
                   8320:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8321:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8322:                   ]; 
                   8323:     }
1.228     matthew  8324:     my $extra_settings = {};
                   8325:     if (ref($Values[-1]) eq 'HASH') {
                   8326:         $extra_settings = pop(@Values);
                   8327:     }
1.127     matthew  8328:     #
1.136     matthew  8329:     my $identifier = &get_cgi_id();
                   8330:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8331:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8332:         return '';
                   8333:     }
1.225     matthew  8334:     #
                   8335:     my @Labels;
                   8336:     if (defined($labels)) {
                   8337:         @Labels = @$labels;
                   8338:     } else {
                   8339:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8340:             push (@Labels,$i+1);
                   8341:         }
                   8342:     }
                   8343:     #
1.129     matthew  8344:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8345:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8346:     my %ValuesHash;
                   8347:     my $NumSets=1;
                   8348:     foreach my $array (@Values) {
                   8349:         next if (! ref($array));
1.136     matthew  8350:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8351:             join(',',@$array);
1.129     matthew  8352:     }
1.127     matthew  8353:     #
1.136     matthew  8354:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8355:     if ($NumBars < 3) {
                   8356:         $width = 120+$NumBars*32;
1.220     matthew  8357:         $xskip = 1;
1.225     matthew  8358:         $bar_width = 30;
                   8359:     } elsif ($NumBars < 5) {
                   8360:         $width = 120+$NumBars*20;
                   8361:         $xskip = 1;
                   8362:         $bar_width = 20;
1.220     matthew  8363:     } elsif ($NumBars < 10) {
1.136     matthew  8364:         $width = 120+$NumBars*15;
                   8365:         $xskip = 1;
                   8366:         $bar_width = 15;
                   8367:     } elsif ($NumBars <= 25) {
                   8368:         $width = 120+$NumBars*11;
                   8369:         $xskip = 5;
                   8370:         $bar_width = 8;
                   8371:     } elsif ($NumBars <= 50) {
                   8372:         $width = 120+$NumBars*8;
                   8373:         $xskip = 5;
                   8374:         $bar_width = 4;
                   8375:     } else {
                   8376:         $width = 120+$NumBars*8;
                   8377:         $xskip = 5;
                   8378:         $bar_width = 4;
                   8379:     }
                   8380:     #
1.137     matthew  8381:     $Max = 1 if ($Max < 1);
                   8382:     if ( int($Max) < $Max ) {
                   8383:         $Max++;
                   8384:         $Max = int($Max);
                   8385:     }
1.127     matthew  8386:     $Title  = '' if (! defined($Title));
                   8387:     $xlabel = '' if (! defined($xlabel));
                   8388:     $ylabel = '' if (! defined($ylabel));
1.369     www      8389:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8390:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8391:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8392:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8393:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8394:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8395:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8396:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8397:     $ValuesHash{$id.'.height'}   = $height;
                   8398:     $ValuesHash{$id.'.width'}    = $width;
                   8399:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8400:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8401:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8402:     #
1.228     matthew  8403:     # Deal with other parameters
                   8404:     while (my ($key,$value) = each(%$extra_settings)) {
                   8405:         $ValuesHash{$id.'.'.$key} = $value;
                   8406:     }
                   8407:     #
1.646     raeburn  8408:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8409:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8410: }
                   8411: 
                   8412: ############################################################
                   8413: ############################################################
                   8414: 
                   8415: =pod
                   8416: 
1.648     raeburn  8417: =item * &DrawXYGraph()
1.137     matthew  8418: 
1.138     matthew  8419: Facilitates the plotting of data in an XY graph.
                   8420: Puts plot definition data into the users environment in order for 
                   8421: graph.png to plot it.  Returns an <img> tag for the plot.
                   8422: 
                   8423: Inputs:
                   8424: 
                   8425: =over 4
                   8426: 
                   8427: =item $Title: string, the title of the plot
                   8428: 
                   8429: =item $xlabel: string, text describing the X-axis of the plot
                   8430: 
                   8431: =item $ylabel: string, text describing the Y-axis of the plot
                   8432: 
                   8433: =item $Max: scalar, the maximum Y value to use in the plot
                   8434: If $Max is < any data point, the graph will not be rendered.
                   8435: 
                   8436: =item $colors: Array ref containing the hex color codes for the data to be 
                   8437: plotted in.  If undefined, default values will be used.
                   8438: 
                   8439: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8440: 
                   8441: =item $Ydata: Array ref containing Array refs.  
1.185     www      8442: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8443: 
                   8444: =item %Values: hash indicating or overriding any default values which are 
                   8445: passed to graph.png.  
                   8446: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8447: 
                   8448: =back
                   8449: 
                   8450: Returns:
                   8451: 
                   8452: An <img> tag which references graph.png and the appropriate identifying
                   8453: information for the plot.
                   8454: 
1.137     matthew  8455: =cut
                   8456: 
                   8457: ############################################################
                   8458: ############################################################
                   8459: sub DrawXYGraph {
                   8460:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8461:     #
                   8462:     # Create the identifier for the graph
                   8463:     my $identifier = &get_cgi_id();
                   8464:     my $id = 'cgi.'.$identifier;
                   8465:     #
                   8466:     $Title  = '' if (! defined($Title));
                   8467:     $xlabel = '' if (! defined($xlabel));
                   8468:     $ylabel = '' if (! defined($ylabel));
                   8469:     my %ValuesHash = 
                   8470:         (
1.369     www      8471:          $id.'.title'  => &escape($Title),
                   8472:          $id.'.xlabel' => &escape($xlabel),
                   8473:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8474:          $id.'.y_max_value'=> $Max,
                   8475:          $id.'.labels'     => join(',',@$Xlabels),
                   8476:          $id.'.PlotType'   => 'XY',
                   8477:          );
                   8478:     #
                   8479:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8480:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8481:     }
                   8482:     #
                   8483:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8484:         return '';
                   8485:     }
                   8486:     my $NumSets=1;
1.138     matthew  8487:     foreach my $array (@{$Ydata}){
1.137     matthew  8488:         next if (! ref($array));
                   8489:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8490:     }
1.138     matthew  8491:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8492:     #
                   8493:     # Deal with other parameters
                   8494:     while (my ($key,$value) = each(%Values)) {
                   8495:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8496:     }
                   8497:     #
1.646     raeburn  8498:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  8499:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8500: }
                   8501: 
                   8502: ############################################################
                   8503: ############################################################
                   8504: 
                   8505: =pod
                   8506: 
1.648     raeburn  8507: =item * &DrawXYYGraph()
1.138     matthew  8508: 
                   8509: Facilitates the plotting of data in an XY graph with two Y axes.
                   8510: Puts plot definition data into the users environment in order for 
                   8511: graph.png to plot it.  Returns an <img> tag for the plot.
                   8512: 
                   8513: Inputs:
                   8514: 
                   8515: =over 4
                   8516: 
                   8517: =item $Title: string, the title of the plot
                   8518: 
                   8519: =item $xlabel: string, text describing the X-axis of the plot
                   8520: 
                   8521: =item $ylabel: string, text describing the Y-axis of the plot
                   8522: 
                   8523: =item $colors: Array ref containing the hex color codes for the data to be 
                   8524: plotted in.  If undefined, default values will be used.
                   8525: 
                   8526: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8527: 
                   8528: =item $Ydata1: The first data set
                   8529: 
                   8530: =item $Min1: The minimum value of the left Y-axis
                   8531: 
                   8532: =item $Max1: The maximum value of the left Y-axis
                   8533: 
                   8534: =item $Ydata2: The second data set
                   8535: 
                   8536: =item $Min2: The minimum value of the right Y-axis
                   8537: 
                   8538: =item $Max2: The maximum value of the left Y-axis
                   8539: 
                   8540: =item %Values: hash indicating or overriding any default values which are 
                   8541: passed to graph.png.  
                   8542: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8543: 
                   8544: =back
                   8545: 
                   8546: Returns:
                   8547: 
                   8548: An <img> tag which references graph.png and the appropriate identifying
                   8549: information for the plot.
1.136     matthew  8550: 
                   8551: =cut
                   8552: 
                   8553: ############################################################
                   8554: ############################################################
1.137     matthew  8555: sub DrawXYYGraph {
                   8556:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   8557:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  8558:     #
                   8559:     # Create the identifier for the graph
                   8560:     my $identifier = &get_cgi_id();
                   8561:     my $id = 'cgi.'.$identifier;
                   8562:     #
                   8563:     $Title  = '' if (! defined($Title));
                   8564:     $xlabel = '' if (! defined($xlabel));
                   8565:     $ylabel = '' if (! defined($ylabel));
                   8566:     my %ValuesHash = 
                   8567:         (
1.369     www      8568:          $id.'.title'  => &escape($Title),
                   8569:          $id.'.xlabel' => &escape($xlabel),
                   8570:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  8571:          $id.'.labels' => join(',',@$Xlabels),
                   8572:          $id.'.PlotType' => 'XY',
                   8573:          $id.'.NumSets' => 2,
1.137     matthew  8574:          $id.'.two_axes' => 1,
                   8575:          $id.'.y1_max_value' => $Max1,
                   8576:          $id.'.y1_min_value' => $Min1,
                   8577:          $id.'.y2_max_value' => $Max2,
                   8578:          $id.'.y2_min_value' => $Min2,
1.136     matthew  8579:          );
                   8580:     #
1.137     matthew  8581:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8582:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8583:     }
                   8584:     #
                   8585:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   8586:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  8587:         return '';
                   8588:     }
                   8589:     my $NumSets=1;
1.137     matthew  8590:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  8591:         next if (! ref($array));
                   8592:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  8593:     }
                   8594:     #
                   8595:     # Deal with other parameters
                   8596:     while (my ($key,$value) = each(%Values)) {
                   8597:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  8598:     }
                   8599:     #
1.646     raeburn  8600:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 8601:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  8602: }
                   8603: 
                   8604: ############################################################
                   8605: ############################################################
                   8606: 
                   8607: =pod
                   8608: 
1.157     matthew  8609: =back 
                   8610: 
1.139     matthew  8611: =head1 Statistics helper routines?  
                   8612: 
                   8613: Bad place for them but what the hell.
                   8614: 
1.157     matthew  8615: =over 4
                   8616: 
1.648     raeburn  8617: =item * &chartlink()
1.139     matthew  8618: 
                   8619: Returns a link to the chart for a specific student.  
                   8620: 
                   8621: Inputs:
                   8622: 
                   8623: =over 4
                   8624: 
                   8625: =item $linktext: The text of the link
                   8626: 
                   8627: =item $sname: The students username
                   8628: 
                   8629: =item $sdomain: The students domain
                   8630: 
                   8631: =back
                   8632: 
1.157     matthew  8633: =back
                   8634: 
1.139     matthew  8635: =cut
                   8636: 
                   8637: ############################################################
                   8638: ############################################################
                   8639: sub chartlink {
                   8640:     my ($linktext, $sname, $sdomain) = @_;
                   8641:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      8642:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 8643:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  8644:        '">'.$linktext.'</a>';
1.153     matthew  8645: }
                   8646: 
                   8647: #######################################################
                   8648: #######################################################
                   8649: 
                   8650: =pod
                   8651: 
                   8652: =head1 Course Environment Routines
1.157     matthew  8653: 
                   8654: =over 4
1.153     matthew  8655: 
1.648     raeburn  8656: =item * &restore_course_settings()
1.153     matthew  8657: 
1.648     raeburn  8658: =item * &store_course_settings()
1.153     matthew  8659: 
                   8660: Restores/Store indicated form parameters from the course environment.
                   8661: Will not overwrite existing values of the form parameters.
                   8662: 
                   8663: Inputs: 
                   8664: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   8665: 
                   8666: a hash ref describing the data to be stored.  For example:
                   8667:    
                   8668: %Save_Parameters = ('Status' => 'scalar',
                   8669:     'chartoutputmode' => 'scalar',
                   8670:     'chartoutputdata' => 'scalar',
                   8671:     'Section' => 'array',
1.373     raeburn  8672:     'Group' => 'array',
1.153     matthew  8673:     'StudentData' => 'array',
                   8674:     'Maps' => 'array');
                   8675: 
                   8676: Returns: both routines return nothing
                   8677: 
1.631     raeburn  8678: =back
                   8679: 
1.153     matthew  8680: =cut
                   8681: 
                   8682: #######################################################
                   8683: #######################################################
                   8684: sub store_course_settings {
1.496     albertel 8685:     return &store_settings($env{'request.course.id'},@_);
                   8686: }
                   8687: 
                   8688: sub store_settings {
1.153     matthew  8689:     # save to the environment
                   8690:     # appenv the same items, just to be safe
1.300     albertel 8691:     my $udom  = $env{'user.domain'};
                   8692:     my $uname = $env{'user.name'};
1.496     albertel 8693:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  8694:     my %SaveHash;
                   8695:     my %AppHash;
                   8696:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 8697:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 8698:         my $envname = 'environment.'.$basename;
1.258     albertel 8699:         if (exists($env{'form.'.$setting})) {
1.153     matthew  8700:             # Save this value away
                   8701:             if ($type eq 'scalar' &&
1.258     albertel 8702:                 (! exists($env{$envname}) || 
                   8703:                  $env{$envname} ne $env{'form.'.$setting})) {
                   8704:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   8705:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  8706:             } elsif ($type eq 'array') {
                   8707:                 my $stored_form;
1.258     albertel 8708:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  8709:                     $stored_form = join(',',
                   8710:                                         map {
1.369     www      8711:                                             &escape($_);
1.258     albertel 8712:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  8713:                 } else {
                   8714:                     $stored_form = 
1.369     www      8715:                         &escape($env{'form.'.$setting});
1.153     matthew  8716:                 }
                   8717:                 # Determine if the array contents are the same.
1.258     albertel 8718:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  8719:                     $SaveHash{$basename} = $stored_form;
                   8720:                     $AppHash{$envname}   = $stored_form;
                   8721:                 }
                   8722:             }
                   8723:         }
                   8724:     }
                   8725:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 8726:                                           $udom,$uname);
1.153     matthew  8727:     if ($put_result !~ /^(ok|delayed)/) {
                   8728:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   8729:                                  'got error:'.$put_result);
                   8730:     }
                   8731:     # Make sure these settings stick around in this session, too
1.646     raeburn  8732:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  8733:     return;
                   8734: }
                   8735: 
                   8736: sub restore_course_settings {
1.499     albertel 8737:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 8738: }
                   8739: 
                   8740: sub restore_settings {
                   8741:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  8742:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 8743:         next if (exists($env{'form.'.$setting}));
1.496     albertel 8744:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  8745:             '.'.$setting;
1.258     albertel 8746:         if (exists($env{$envname})) {
1.153     matthew  8747:             if ($type eq 'scalar') {
1.258     albertel 8748:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  8749:             } elsif ($type eq 'array') {
1.258     albertel 8750:                 $env{'form.'.$setting} = [ 
1.153     matthew  8751:                                            map { 
1.369     www      8752:                                                &unescape($_); 
1.258     albertel 8753:                                            } split(',',$env{$envname})
1.153     matthew  8754:                                            ];
                   8755:             }
                   8756:         }
                   8757:     }
1.127     matthew  8758: }
                   8759: 
1.618     raeburn  8760: #######################################################
                   8761: #######################################################
                   8762: 
                   8763: =pod
                   8764: 
                   8765: =head1 Domain E-mail Routines  
                   8766: 
                   8767: =over 4
                   8768: 
1.648     raeburn  8769: =item * &build_recipient_list()
1.618     raeburn  8770: 
                   8771: Build recipient lists for three types of e-mail:
                   8772: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619     raeburn  8773: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618     raeburn  8774: 
                   8775: Inputs:
1.619     raeburn  8776: defmail (scalar - email address of default recipient), 
1.618     raeburn  8777: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  8778: defdom (domain for which to retrieve configuration settings),
                   8779: origmail (scalar - email address of recipient from loncapa.conf, 
                   8780: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  8781: 
1.655     raeburn  8782: Returns: comma separated list of addresses to which to send e-mail.
                   8783: 
                   8784: =back
1.618     raeburn  8785: 
                   8786: =cut
                   8787: 
                   8788: ############################################################
                   8789: ############################################################
                   8790: sub build_recipient_list {
1.619     raeburn  8791:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  8792:     my @recipients;
                   8793:     my $otheremails;
                   8794:     my %domconfig =
                   8795:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   8796:     if (ref($domconfig{'contacts'}) eq 'HASH') {
                   8797:         if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   8798:             my @contacts = ('adminemail','supportemail');
                   8799:             foreach my $item (@contacts) {
                   8800:                 if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619     raeburn  8801:                     my $addr = $domconfig{'contacts'}{$item}; 
                   8802:                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   8803:                         push(@recipients,$addr);
                   8804:                     }
1.618     raeburn  8805:                 }
                   8806:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   8807:             }
                   8808:         }
1.619     raeburn  8809:     } elsif ($origmail ne '') {
                   8810:         push(@recipients,$origmail);
1.618     raeburn  8811:     }
1.688     raeburn  8812:     if (defined($defmail)) {
                   8813:         if ($defmail ne '') {
                   8814:             push(@recipients,$defmail);
                   8815:         }
1.618     raeburn  8816:     }
                   8817:     if ($otheremails) {
1.619     raeburn  8818:         my @others;
                   8819:         if ($otheremails =~ /,/) {
                   8820:             @others = split(/,/,$otheremails);
1.618     raeburn  8821:         } else {
1.619     raeburn  8822:             push(@others,$otheremails);
                   8823:         }
                   8824:         foreach my $addr (@others) {
                   8825:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   8826:                 push(@recipients,$addr);
                   8827:             }
1.618     raeburn  8828:         }
                   8829:     }
1.619     raeburn  8830:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  8831:     return $recipientlist;
                   8832: }
                   8833: 
1.127     matthew  8834: ############################################################
                   8835: ############################################################
1.154     albertel 8836: 
1.655     raeburn  8837: =pod
                   8838: 
                   8839: =head1 Course Catalog Routines
                   8840: 
                   8841: =over 4
                   8842: 
                   8843: =item * &gather_categories()
                   8844: 
                   8845: Converts category definitions - keys of categories hash stored in  
                   8846: coursecategories in configuration.db on the primary library server in a 
                   8847: domain - to an array.  Also generates javascript and idx hash used to 
                   8848: generate Domain Coordinator interface for editing Course Categories.
                   8849: 
                   8850: Inputs:
1.663     raeburn  8851: 
1.655     raeburn  8852: categories (reference to hash of category definitions).
1.663     raeburn  8853: 
1.655     raeburn  8854: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8855:       categories and subcategories).
1.663     raeburn  8856: 
1.655     raeburn  8857: idx (reference to hash of counters used in Domain Coordinator interface for 
                   8858:       editing Course Categories).
1.663     raeburn  8859: 
1.655     raeburn  8860: jsarray (reference to array of categories used to create Javascript arrays for
                   8861:          Domain Coordinator interface for editing Course Categories).
                   8862: 
                   8863: Returns: nothing
                   8864: 
                   8865: Side effects: populates cats, idx and jsarray. 
                   8866: 
                   8867: =cut
                   8868: 
                   8869: sub gather_categories {
                   8870:     my ($categories,$cats,$idx,$jsarray) = @_;
                   8871:     my %counters;
                   8872:     my $num = 0;
                   8873:     foreach my $item (keys(%{$categories})) {
                   8874:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   8875:         if ($container eq '' && $depth == 0) {
                   8876:             $cats->[$depth][$categories->{$item}] = $cat;
                   8877:         } else {
                   8878:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   8879:         }
                   8880:         my ($escitem,$tail) = split(/:/,$item,2);
                   8881:         if ($counters{$tail} eq '') {
                   8882:             $counters{$tail} = $num;
                   8883:             $num ++;
                   8884:         }
                   8885:         if (ref($idx) eq 'HASH') {
                   8886:             $idx->{$item} = $counters{$tail};
                   8887:         }
                   8888:         if (ref($jsarray) eq 'ARRAY') {
                   8889:             push(@{$jsarray->[$counters{$tail}]},$item);
                   8890:         }
                   8891:     }
                   8892:     return;
                   8893: }
                   8894: 
                   8895: =pod
                   8896: 
                   8897: =item * &extract_categories()
                   8898: 
                   8899: Used to generate breadcrumb trails for course categories.
                   8900: 
                   8901: Inputs:
1.663     raeburn  8902: 
1.655     raeburn  8903: categories (reference to hash of category definitions).
1.663     raeburn  8904: 
1.655     raeburn  8905: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8906:       categories and subcategories).
1.663     raeburn  8907: 
1.655     raeburn  8908: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  8909: 
1.655     raeburn  8910: allitems (reference to hash - key is category key 
                   8911:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  8912: 
1.655     raeburn  8913: idx (reference to hash of counters used in Domain Coordinator interface for
                   8914:       editing Course Categories).
1.663     raeburn  8915: 
1.655     raeburn  8916: jsarray (reference to array of categories used to create Javascript arrays for
                   8917:          Domain Coordinator interface for editing Course Categories).
                   8918: 
1.665     raeburn  8919: subcats (reference to hash of arrays containing all subcategories within each 
                   8920:          category, -recursive)
                   8921: 
1.655     raeburn  8922: Returns: nothing
                   8923: 
                   8924: Side effects: populates trails and allitems hash references.
                   8925: 
                   8926: =cut
                   8927: 
                   8928: sub extract_categories {
1.665     raeburn  8929:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  8930:     if (ref($categories) eq 'HASH') {
                   8931:         &gather_categories($categories,$cats,$idx,$jsarray);
                   8932:         if (ref($cats->[0]) eq 'ARRAY') {
                   8933:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   8934:                 my $name = $cats->[0][$i];
                   8935:                 my $item = &escape($name).'::0';
                   8936:                 my $trailstr;
                   8937:                 if ($name eq 'instcode') {
                   8938:                     $trailstr = &mt('Official courses (with institutional codes)');
                   8939:                 } else {
                   8940:                     $trailstr = $name;
                   8941:                 }
                   8942:                 if ($allitems->{$item} eq '') {
                   8943:                     push(@{$trails},$trailstr);
                   8944:                     $allitems->{$item} = scalar(@{$trails})-1;
                   8945:                 }
                   8946:                 my @parents = ($name);
                   8947:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   8948:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   8949:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  8950:                         if (ref($subcats) eq 'HASH') {
                   8951:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   8952:                         }
                   8953:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   8954:                     }
                   8955:                 } else {
                   8956:                     if (ref($subcats) eq 'HASH') {
                   8957:                         $subcats->{$item} = [];
1.655     raeburn  8958:                     }
                   8959:                 }
                   8960:             }
                   8961:         }
                   8962:     }
                   8963:     return;
                   8964: }
                   8965: 
                   8966: =pod
                   8967: 
                   8968: =item *&recurse_categories()
                   8969: 
                   8970: Recursively used to generate breadcrumb trails for course categories.
                   8971: 
                   8972: Inputs:
1.663     raeburn  8973: 
1.655     raeburn  8974: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8975:       categories and subcategories).
1.663     raeburn  8976: 
1.655     raeburn  8977: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  8978: 
                   8979: category (current course category, for which breadcrumb trail is being generated).
                   8980: 
                   8981: trails (reference to array of breadcrumb trails for each category).
                   8982: 
1.655     raeburn  8983: allitems (reference to hash - key is category key
                   8984:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  8985: 
1.655     raeburn  8986: parents (array containing containers directories for current category, 
                   8987:          back to top level). 
                   8988: 
                   8989: Returns: nothing
                   8990: 
                   8991: Side effects: populates trails and allitems hash references
                   8992: 
                   8993: =cut
                   8994: 
                   8995: sub recurse_categories {
1.665     raeburn  8996:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  8997:     my $shallower = $depth - 1;
                   8998:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   8999:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9000:             my $name = $cats->[$depth]{$category}[$k];
                   9001:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9002:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9003:             if ($allitems->{$item} eq '') {
                   9004:                 push(@{$trails},$trailstr);
                   9005:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9006:             }
                   9007:             my $deeper = $depth+1;
                   9008:             push(@{$parents},$category);
1.665     raeburn  9009:             if (ref($subcats) eq 'HASH') {
                   9010:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9011:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9012:                     my $higher;
                   9013:                     if ($j > 0) {
                   9014:                         $higher = &escape($parents->[$j]).':'.
                   9015:                                   &escape($parents->[$j-1]).':'.$j;
                   9016:                     } else {
                   9017:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9018:                     }
                   9019:                     push(@{$subcats->{$higher}},$subcat);
                   9020:                 }
                   9021:             }
                   9022:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9023:                                 $subcats);
1.655     raeburn  9024:             pop(@{$parents});
                   9025:         }
                   9026:     } else {
                   9027:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9028:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9029:         if ($allitems->{$item} eq '') {
                   9030:             push(@{$trails},$trailstr);
                   9031:             $allitems->{$item} = scalar(@{$trails})-1;
                   9032:         }
                   9033:     }
                   9034:     return;
                   9035: }
                   9036: 
1.663     raeburn  9037: =pod
                   9038: 
                   9039: =item *&assign_categories_table()
                   9040: 
                   9041: Create a datatable for display of hierarchical categories in a domain,
                   9042: with checkboxes to allow a course to be categorized. 
                   9043: 
                   9044: Inputs:
                   9045: 
                   9046: cathash - reference to hash of categories defined for the domain (from
                   9047:           configuration.db)
                   9048: 
                   9049: currcat - scalar with an & separated list of categories assigned to a course. 
                   9050: 
                   9051: Returns: $output (markup to be displayed) 
                   9052: 
                   9053: =cut
                   9054: 
                   9055: sub assign_categories_table {
                   9056:     my ($cathash,$currcat) = @_;
                   9057:     my $output;
                   9058:     if (ref($cathash) eq 'HASH') {
                   9059:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9060:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9061:         $maxdepth = scalar(@cats);
                   9062:         if (@cats > 0) {
                   9063:             my $itemcount = 0;
                   9064:             if (ref($cats[0]) eq 'ARRAY') {
                   9065:                 $output = &Apache::loncommon::start_data_table();
                   9066:                 my @currcategories;
                   9067:                 if ($currcat ne '') {
                   9068:                     @currcategories = split('&',$currcat);
                   9069:                 }
                   9070:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9071:                     my $parent = $cats[0][$i];
                   9072:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9073:                     next if ($parent eq 'instcode');
                   9074:                     my $item = &escape($parent).'::0';
                   9075:                     my $checked = '';
                   9076:                     if (@currcategories > 0) {
                   9077:                         if (grep(/^\Q$item\E$/,@currcategories)) {
                   9078:                             $checked = ' checked="checked" ';
                   9079:                         }
                   9080:                     }
1.675     raeburn  9081:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9082:                                '<input type="checkbox" name="usecategory" value="'.
                   9083:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9084:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9085:                     my $depth = 1;
                   9086:                     push(@path,$parent);
                   9087:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9088:                     pop(@path);
                   9089:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9090:                     $itemcount ++;
                   9091:                 }
                   9092:                 $output .= &Apache::loncommon::end_data_table();
                   9093:             }
                   9094:         }
                   9095:     }
                   9096:     return $output;
                   9097: }
                   9098: 
                   9099: =pod
                   9100: 
                   9101: =item *&assign_category_rows()
                   9102: 
                   9103: Create a datatable row for display of nested categories in a domain,
                   9104: with checkboxes to allow a course to be categorized,called recursively.
                   9105: 
                   9106: Inputs:
                   9107: 
                   9108: itemcount - track row number for alternating colors
                   9109: 
                   9110: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9111:       categories and subcategories.
                   9112: 
                   9113: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9114: 
                   9115: parent - parent of current category item
                   9116: 
                   9117: path - Array containing all categories back up through the hierarchy from the
                   9118:        current category to the top level.
                   9119: 
                   9120: currcategories - reference to array of current categories assigned to the course
                   9121: 
                   9122: Returns: $output (markup to be displayed).
                   9123: 
                   9124: =cut
                   9125: 
                   9126: sub assign_category_rows {
                   9127:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9128:     my ($text,$name,$item,$chgstr);
                   9129:     if (ref($cats) eq 'ARRAY') {
                   9130:         my $maxdepth = scalar(@{$cats});
                   9131:         if (ref($cats->[$depth]) eq 'HASH') {
                   9132:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9133:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9134:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9135:                 $text .= '<td><table class="LC_datatable">';
                   9136:                 for (my $j=0; $j<$numchildren; $j++) {
                   9137:                     $name = $cats->[$depth]{$parent}[$j];
                   9138:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9139:                     my $deeper = $depth+1;
                   9140:                     my $checked = '';
                   9141:                     if (ref($currcategories) eq 'ARRAY') {
                   9142:                         if (@{$currcategories} > 0) {
                   9143:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
                   9144:                                 $checked = ' checked="checked" ';
                   9145:                             }
                   9146:                         }
                   9147:                     }
1.664     raeburn  9148:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9149:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9150:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9151:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9152:                              '</td><td>';
1.663     raeburn  9153:                     if (ref($path) eq 'ARRAY') {
                   9154:                         push(@{$path},$name);
                   9155:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9156:                         pop(@{$path});
                   9157:                     }
                   9158:                     $text .= '</td></tr>';
                   9159:                 }
                   9160:                 $text .= '</table></td>';
                   9161:             }
                   9162:         }
                   9163:     }
                   9164:     return $text;
                   9165: }
                   9166: 
1.655     raeburn  9167: ############################################################
                   9168: ############################################################
                   9169: 
                   9170: 
1.443     albertel 9171: sub commit_customrole {
1.664     raeburn  9172:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9173:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9174:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9175:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9176:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9177:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9178:                  '</b><br />';
                   9179:     return $output;
                   9180: }
                   9181: 
                   9182: sub commit_standardrole {
1.541     raeburn  9183:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9184:     my ($output,$logmsg,$linefeed);
                   9185:     if ($context eq 'auto') {
                   9186:         $linefeed = "\n";
                   9187:     } else {
                   9188:         $linefeed = "<br />\n";
                   9189:     }  
1.443     albertel 9190:     if ($three eq 'st') {
1.541     raeburn  9191:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9192:                                          $one,$two,$sec,$context);
                   9193:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9194:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9195:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9196:         } else {
1.541     raeburn  9197:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9198:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9199:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9200:             if ($context eq 'auto') {
                   9201:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9202:             } else {
                   9203:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9204:                &mt('Add to classlist').': <b>ok</b>';
                   9205:             }
                   9206:             $output .= $linefeed;
1.443     albertel 9207:         }
                   9208:     } else {
                   9209:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9210:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9211:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9212:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9213:         if ($context eq 'auto') {
                   9214:             $output .= $result.$linefeed;
                   9215:         } else {
                   9216:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9217:         }
1.443     albertel 9218:     }
                   9219:     return $output;
                   9220: }
                   9221: 
                   9222: sub commit_studentrole {
1.541     raeburn  9223:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9224:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9225:     if ($context eq 'auto') {
                   9226:         $linefeed = "\n";
                   9227:     } else {
                   9228:         $linefeed = '<br />'."\n";
                   9229:     }
1.443     albertel 9230:     if (defined($one) && defined($two)) {
                   9231:         my $cid=$one.'_'.$two;
                   9232:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9233:         my $secchange = 0;
                   9234:         my $expire_role_result;
                   9235:         my $modify_section_result;
1.628     raeburn  9236:         if ($oldsec ne '-1') { 
                   9237:             if ($oldsec ne $sec) {
1.443     albertel 9238:                 $secchange = 1;
1.628     raeburn  9239:                 my $now = time;
1.443     albertel 9240:                 my $uurl='/'.$cid;
                   9241:                 $uurl=~s/\_/\//g;
                   9242:                 if ($oldsec) {
                   9243:                     $uurl.='/'.$oldsec;
                   9244:                 }
1.626     raeburn  9245:                 $oldsecurl = $uurl;
1.628     raeburn  9246:                 $expire_role_result = 
1.652     raeburn  9247:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9248:                 if ($env{'request.course.sec'} ne '') { 
                   9249:                     if ($expire_role_result eq 'refused') {
                   9250:                         my @roles = ('st');
                   9251:                         my @statuses = ('previous');
                   9252:                         my @roledoms = ($one);
                   9253:                         my $withsec = 1;
                   9254:                         my %roleshash = 
                   9255:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9256:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9257:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9258:                             my ($oldstart,$oldend) = 
                   9259:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9260:                             if ($oldend > 0 && $oldend <= $now) {
                   9261:                                 $expire_role_result = 'ok';
                   9262:                             }
                   9263:                         }
                   9264:                     }
                   9265:                 }
1.443     albertel 9266:                 $result = $expire_role_result;
                   9267:             }
                   9268:         }
                   9269:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9270:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9271:             if ($modify_section_result =~ /^ok/) {
                   9272:                 if ($secchange == 1) {
1.628     raeburn  9273:                     if ($sec eq '') {
                   9274:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9275:                     } else {
                   9276:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9277:                     }
1.443     albertel 9278:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9279:                     if ($sec eq '') {
                   9280:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9281:                     } else {
                   9282:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9283:                     }
1.443     albertel 9284:                 } else {
1.628     raeburn  9285:                     if ($sec eq '') {
                   9286:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9287:                     } else {
                   9288:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9289:                     }
1.443     albertel 9290:                 }
                   9291:             } else {
1.628     raeburn  9292:                 if ($secchange) {       
                   9293:                     $$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;
                   9294:                 } else {
                   9295:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9296:                 }
1.443     albertel 9297:             }
                   9298:             $result = $modify_section_result;
                   9299:         } elsif ($secchange == 1) {
1.628     raeburn  9300:             if ($oldsec eq '') {
                   9301:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9302:             } else {
                   9303:                 $$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;
                   9304:             }
1.626     raeburn  9305:             if ($expire_role_result eq 'refused') {
                   9306:                 my $newsecurl = '/'.$cid;
                   9307:                 $newsecurl =~ s/\_/\//g;
                   9308:                 if ($sec ne '') {
                   9309:                     $newsecurl.='/'.$sec;
                   9310:                 }
                   9311:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9312:                     if ($sec eq '') {
                   9313:                         $$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;
                   9314:                     } else {
                   9315:                         $$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;
                   9316:                     }
                   9317:                 }
                   9318:             }
1.443     albertel 9319:         }
                   9320:     } else {
1.626     raeburn  9321:         $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443     albertel 9322:         $result = "error: incomplete course id\n";
                   9323:     }
                   9324:     return $result;
                   9325: }
                   9326: 
                   9327: ############################################################
                   9328: ############################################################
                   9329: 
1.566     albertel 9330: sub check_clone {
1.578     raeburn  9331:     my ($args,$linefeed) = @_;
1.566     albertel 9332:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9333:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9334:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9335:     my $clonemsg;
                   9336:     my $can_clone = 0;
                   9337: 
                   9338:     if ($clonehome eq 'no_host') {
1.578     raeburn  9339:         $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});     
1.566     albertel 9340:     } else {
                   9341: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9342: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9343: 	    $can_clone = 1;
                   9344: 	} else {
                   9345: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9346: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9347: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9348:             if (grep(/^\*$/,@cloners)) {
                   9349:                 $can_clone = 1;
                   9350:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9351:                 $can_clone = 1;
                   9352:             } else {
                   9353: 	        my %roleshash =
                   9354: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9355: 					 $args->{'ccdomain'},
                   9356:                                          'userroles',['active'],['cc'],
                   9357: 					 [$args->{'clonedomain'}]);
                   9358: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9359: 		    $can_clone = 1;
                   9360: 	        } else {
                   9361:                     $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'});
                   9362: 	        }
1.566     albertel 9363: 	    }
1.578     raeburn  9364:         }
1.566     albertel 9365:     }
                   9366:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9367: }
                   9368: 
1.444     albertel 9369: sub construct_course {
1.541     raeburn  9370:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9371:     my $outcome;
1.541     raeburn  9372:     my $linefeed =  '<br />'."\n";
                   9373:     if ($context eq 'auto') {
                   9374:         $linefeed = "\n";
                   9375:     }
1.566     albertel 9376: 
                   9377: #
                   9378: # Are we cloning?
                   9379: #
                   9380:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9381:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9382: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9383: 	if ($context ne 'auto') {
1.578     raeburn  9384:             if ($clonemsg ne '') {
                   9385: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9386:             }
1.566     albertel 9387: 	}
                   9388: 	$outcome .= $clonemsg.$linefeed;
                   9389: 
                   9390:         if (!$can_clone) {
                   9391: 	    return (0,$outcome);
                   9392: 	}
                   9393:     }
                   9394: 
1.444     albertel 9395: #
                   9396: # Open course
                   9397: #
                   9398:     my $crstype = lc($args->{'crstype'});
                   9399:     my %cenv=();
                   9400:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9401:                                              $args->{'cdescr'},
                   9402:                                              $args->{'curl'},
                   9403:                                              $args->{'course_home'},
                   9404:                                              $args->{'nonstandard'},
                   9405:                                              $args->{'crscode'},
                   9406:                                              $args->{'ccuname'}.':'.
                   9407:                                              $args->{'ccdomain'},
                   9408:                                              $args->{'crstype'});
                   9409: 
                   9410:     # Note: The testing routines depend on this being output; see 
                   9411:     # Utils::Course. This needs to at least be output as a comment
                   9412:     # if anyone ever decides to not show this, and Utils::Course::new
                   9413:     # will need to be suitably modified.
1.541     raeburn  9414:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9415: #
                   9416: # Check if created correctly
                   9417: #
1.479     albertel 9418:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9419:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9420:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9421: 
1.444     albertel 9422: #
1.566     albertel 9423: # Do the cloning
                   9424: #   
                   9425:     if ($can_clone && $cloneid) {
                   9426: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9427: 	if ($context ne 'auto') {
                   9428: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9429: 	}
                   9430: 	$outcome .= $clonemsg.$linefeed;
                   9431: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9432: # Copy all files
1.637     www      9433: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9434: # Restore URL
1.566     albertel 9435: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9436: # Restore title
1.566     albertel 9437: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9438: # Mark as cloned
1.566     albertel 9439: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9440: # Need to clone grading mode
                   9441:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9442:         $cenv{'grading'}=$newenv{'grading'};
                   9443: # Do not clone these environment entries
                   9444:         &Apache::lonnet::del('environment',
                   9445:                   ['default_enrollment_start_date',
                   9446:                    'default_enrollment_end_date',
                   9447:                    'question.email',
                   9448:                    'policy.email',
                   9449:                    'comment.email',
                   9450:                    'pch.users.denied',
1.725     raeburn  9451:                    'plc.users.denied',
                   9452:                    'hidefromcat',
                   9453:                    'categories'],
1.638     www      9454:                    $$crsudom,$$crsunum);
1.444     albertel 9455:     }
1.566     albertel 9456: 
1.444     albertel 9457: #
                   9458: # Set environment (will override cloned, if existing)
                   9459: #
                   9460:     my @sections = ();
                   9461:     my @xlists = ();
                   9462:     if ($args->{'crstype'}) {
                   9463:         $cenv{'type'}=$args->{'crstype'};
                   9464:     }
                   9465:     if ($args->{'crsid'}) {
                   9466:         $cenv{'courseid'}=$args->{'crsid'};
                   9467:     }
                   9468:     if ($args->{'crscode'}) {
                   9469:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9470:     }
                   9471:     if ($args->{'crsquota'} ne '') {
                   9472:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9473:     } else {
                   9474:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9475:     }
                   9476:     if ($args->{'ccuname'}) {
                   9477:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9478:                                         ':'.$args->{'ccdomain'};
                   9479:     } else {
                   9480:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9481:     }
                   9482:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9483:     if ($args->{'crssections'}) {
                   9484:         $cenv{'internal.sectionnums'} = '';
                   9485:         if ($args->{'crssections'} =~ m/,/) {
                   9486:             @sections = split/,/,$args->{'crssections'};
                   9487:         } else {
                   9488:             $sections[0] = $args->{'crssections'};
                   9489:         }
                   9490:         if (@sections > 0) {
                   9491:             foreach my $item (@sections) {
                   9492:                 my ($sec,$gp) = split/:/,$item;
                   9493:                 my $class = $args->{'crscode'}.$sec;
                   9494:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   9495:                 $cenv{'internal.sectionnums'} .= $item.',';
                   9496:                 unless ($addcheck eq 'ok') {
                   9497:                     push @badclasses, $class;
                   9498:                 }
                   9499:             }
                   9500:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   9501:         }
                   9502:     }
                   9503: # do not hide course coordinator from staff listing, 
                   9504: # even if privileged
                   9505:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9506: # add crosslistings
                   9507:     if ($args->{'crsxlist'}) {
                   9508:         $cenv{'internal.crosslistings'}='';
                   9509:         if ($args->{'crsxlist'} =~ m/,/) {
                   9510:             @xlists = split/,/,$args->{'crsxlist'};
                   9511:         } else {
                   9512:             $xlists[0] = $args->{'crsxlist'};
                   9513:         }
                   9514:         if (@xlists > 0) {
                   9515:             foreach my $item (@xlists) {
                   9516:                 my ($xl,$gp) = split/:/,$item;
                   9517:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   9518:                 $cenv{'internal.crosslistings'} .= $item.',';
                   9519:                 unless ($addcheck eq 'ok') {
                   9520:                     push @badclasses, $xl;
                   9521:                 }
                   9522:             }
                   9523:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   9524:         }
                   9525:     }
                   9526:     if ($args->{'autoadds'}) {
                   9527:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   9528:     }
                   9529:     if ($args->{'autodrops'}) {
                   9530:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   9531:     }
                   9532: # check for notification of enrollment changes
                   9533:     my @notified = ();
                   9534:     if ($args->{'notify_owner'}) {
                   9535:         if ($args->{'ccuname'} ne '') {
                   9536:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   9537:         }
                   9538:     }
                   9539:     if ($args->{'notify_dc'}) {
                   9540:         if ($uname ne '') { 
1.630     raeburn  9541:             push(@notified,$uname.':'.$udom);
1.444     albertel 9542:         }
                   9543:     }
                   9544:     if (@notified > 0) {
                   9545:         my $notifylist;
                   9546:         if (@notified > 1) {
                   9547:             $notifylist = join(',',@notified);
                   9548:         } else {
                   9549:             $notifylist = $notified[0];
                   9550:         }
                   9551:         $cenv{'internal.notifylist'} = $notifylist;
                   9552:     }
                   9553:     if (@badclasses > 0) {
                   9554:         my %lt=&Apache::lonlocal::texthash(
                   9555:                 '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',
                   9556:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   9557:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   9558:         );
1.541     raeburn  9559:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   9560:                            ' ('.$lt{'adby'}.')';
                   9561:         if ($context eq 'auto') {
                   9562:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 9563:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  9564:             foreach my $item (@badclasses) {
                   9565:                 if ($context eq 'auto') {
                   9566:                     $outcome .= " - $item\n";
                   9567:                 } else {
                   9568:                     $outcome .= "<li>$item</li>\n";
                   9569:                 }
                   9570:             }
                   9571:             if ($context eq 'auto') {
                   9572:                 $outcome .= $linefeed;
                   9573:             } else {
1.566     albertel 9574:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  9575:             }
                   9576:         } 
1.444     albertel 9577:     }
                   9578:     if ($args->{'no_end_date'}) {
                   9579:         $args->{'endaccess'} = 0;
                   9580:     }
                   9581:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   9582:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   9583:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   9584:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   9585:     if ($args->{'showphotos'}) {
                   9586:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   9587:     }
                   9588:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   9589:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   9590:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   9591:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  9592:             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'); 
                   9593:             if ($context eq 'auto') {
                   9594:                 $outcome .= $krb_msg;
                   9595:             } else {
1.566     albertel 9596:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  9597:             }
                   9598:             $outcome .= $linefeed;
1.444     albertel 9599:         }
                   9600:     }
                   9601:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   9602:        if ($args->{'setpolicy'}) {
                   9603:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9604:        }
                   9605:        if ($args->{'setcontent'}) {
                   9606:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9607:        }
                   9608:     }
                   9609:     if ($args->{'reshome'}) {
                   9610: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   9611: 	$cenv{'reshome'}=~s/\/+$/\//;
                   9612:     }
                   9613: #
                   9614: # course has keyed access
                   9615: #
                   9616:     if ($args->{'setkeys'}) {
                   9617:        $cenv{'keyaccess'}='yes';
                   9618:     }
                   9619: # if specified, key authority is not course, but user
                   9620: # only active if keyaccess is yes
                   9621:     if ($args->{'keyauth'}) {
1.487     albertel 9622: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   9623: 	$user = &LONCAPA::clean_username($user);
                   9624: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     9625: 	if ($user ne '' && $domain ne '') {
1.487     albertel 9626: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 9627: 	}
                   9628:     }
                   9629: 
                   9630:     if ($args->{'disresdis'}) {
                   9631:         $cenv{'pch.roles.denied'}='st';
                   9632:     }
                   9633:     if ($args->{'disablechat'}) {
                   9634:         $cenv{'plc.roles.denied'}='st';
                   9635:     }
                   9636: 
                   9637:     # Record we've not yet viewed the Course Initialization Helper for this 
                   9638:     # course
                   9639:     $cenv{'course.helper.not.run'} = 1;
                   9640:     #
                   9641:     # Use new Randomseed
                   9642:     #
                   9643:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   9644:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   9645:     #
                   9646:     # The encryption code and receipt prefix for this course
                   9647:     #
                   9648:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   9649:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   9650:     #
                   9651:     # By default, use standard grading
                   9652:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   9653: 
1.541     raeburn  9654:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   9655:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 9656: #
                   9657: # Open all assignments
                   9658: #
                   9659:     if ($args->{'openall'}) {
                   9660:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   9661:        my %storecontent = ($storeunder         => time,
                   9662:                            $storeunder.'.type' => 'date_start');
                   9663:        
                   9664:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  9665:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 9666:    }
                   9667: #
                   9668: # Set first page
                   9669: #
                   9670:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   9671: 	    || ($cloneid)) {
1.445     albertel 9672: 	use LONCAPA::map;
1.444     albertel 9673: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 9674: 
                   9675: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   9676:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   9677: 
1.444     albertel 9678:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   9679:         my $title; my $url;
                   9680:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   9681: 	    $title=&mt('Syllabus');
1.444     albertel 9682:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   9683:         } else {
1.690     bisitz   9684:             $title=&mt('Navigate Contents');
1.444     albertel 9685:             $url='/adm/navmaps';
                   9686:         }
1.445     albertel 9687: 
                   9688:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   9689: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   9690: 
                   9691: 	if ($errtext) { $fatal=2; }
1.541     raeburn  9692:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 9693:     }
1.566     albertel 9694: 
                   9695:     return (1,$outcome);
1.444     albertel 9696: }
                   9697: 
                   9698: ############################################################
                   9699: ############################################################
                   9700: 
1.378     raeburn  9701: sub course_type {
                   9702:     my ($cid) = @_;
                   9703:     if (!defined($cid)) {
                   9704:         $cid = $env{'request.course.id'};
                   9705:     }
1.404     albertel 9706:     if (defined($env{'course.'.$cid.'.type'})) {
                   9707:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  9708:     } else {
                   9709:         return 'Course';
1.377     raeburn  9710:     }
                   9711: }
1.156     albertel 9712: 
1.406     raeburn  9713: sub group_term {
                   9714:     my $crstype = &course_type();
                   9715:     my %names = (
                   9716:                   'Course' => 'group',
                   9717:                   'Group' => 'team',
                   9718:                 );
                   9719:     return $names{$crstype};
                   9720: }
                   9721: 
1.156     albertel 9722: sub icon {
                   9723:     my ($file)=@_;
1.505     albertel 9724:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 9725:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 9726:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 9727:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   9728: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   9729: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   9730: 	            $curfext.".gif") {
                   9731: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   9732: 		$curfext.".gif";
                   9733: 	}
                   9734:     }
1.249     albertel 9735:     return &lonhttpdurl($iconname);
1.154     albertel 9736: } 
1.84      albertel 9737: 
1.575     albertel 9738: sub lonhttpdurl {
1.692     www      9739: #
                   9740: # Had been used for "small fry" static images on separate port 8080.
                   9741: # Modify here if lightweight http functionality desired again.
                   9742: # Currently eliminated due to increasing firewall issues.
                   9743: #
1.575     albertel 9744:     my ($url)=@_;
1.692     www      9745:     return $url;
1.215     albertel 9746: }
                   9747: 
1.213     albertel 9748: sub connection_aborted {
                   9749:     my ($r)=@_;
                   9750:     $r->print(" ");$r->rflush();
                   9751:     my $c = $r->connection;
                   9752:     return $c->aborted();
                   9753: }
                   9754: 
1.221     foxr     9755: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     9756: #    strings as 'strings'.
                   9757: sub escape_single {
1.221     foxr     9758:     my ($input) = @_;
1.223     albertel 9759:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     9760:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   9761:     return $input;
                   9762: }
1.223     albertel 9763: 
1.222     foxr     9764: #  Same as escape_single, but escape's "'s  This 
                   9765: #  can be used for  "strings"
                   9766: sub escape_double {
                   9767:     my ($input) = @_;
                   9768:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   9769:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   9770:     return $input;
                   9771: }
1.223     albertel 9772:  
1.222     foxr     9773: #   Escapes the last element of a full URL.
                   9774: sub escape_url {
                   9775:     my ($url)   = @_;
1.238     raeburn  9776:     my @urlslices = split(/\//, $url,-1);
1.369     www      9777:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 9778:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     9779: }
1.462     albertel 9780: 
                   9781: # -------------------------------------------------------- Initliaze user login
                   9782: sub init_user_environment {
1.463     albertel 9783:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 9784:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   9785: 
                   9786:     my $public=($username eq 'public' && $domain eq 'public');
                   9787: 
                   9788: # See if old ID present, if so, remove
                   9789: 
                   9790:     my ($filename,$cookie,$userroles);
                   9791:     my $now=time;
                   9792: 
                   9793:     if ($public) {
                   9794: 	my $max_public=100;
                   9795: 	my $oldest;
                   9796: 	my $oldest_time=0;
                   9797: 	for(my $next=1;$next<=$max_public;$next++) {
                   9798: 	    if (-e $lonids."/publicuser_$next.id") {
                   9799: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   9800: 		if ($mtime<$oldest_time || !$oldest_time) {
                   9801: 		    $oldest_time=$mtime;
                   9802: 		    $oldest=$next;
                   9803: 		}
                   9804: 	    } else {
                   9805: 		$cookie="publicuser_$next";
                   9806: 		last;
                   9807: 	    }
                   9808: 	}
                   9809: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   9810:     } else {
1.463     albertel 9811: 	# if this isn't a robot, kill any existing non-robot sessions
                   9812: 	if (!$args->{'robot'}) {
                   9813: 	    opendir(DIR,$lonids);
                   9814: 	    while ($filename=readdir(DIR)) {
                   9815: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   9816: 		    unlink($lonids.'/'.$filename);
                   9817: 		}
1.462     albertel 9818: 	    }
1.463     albertel 9819: 	    closedir(DIR);
1.462     albertel 9820: 	}
                   9821: # Give them a new cookie
1.463     albertel 9822: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      9823: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 9824: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 9825:     
                   9826: # Initialize roles
                   9827: 
                   9828: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   9829:     }
                   9830: # ------------------------------------ Check browser type and MathML capability
                   9831: 
                   9832:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   9833:         $clientunicode,$clientos) = &decode_user_agent($r);
                   9834: 
                   9835: # -------------------------------------- Any accessibility options to remember?
                   9836:     if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
                   9837: 	foreach my $option ('imagesuppress','appletsuppress',
                   9838: 			    'embedsuppress','fontenhance','blackwhite') {
                   9839: 	    if ($form->{$option} eq 'true') {
                   9840: 		&Apache::lonnet::put('environment',{$option => 'on'},
                   9841: 				     $domain,$username);
                   9842: 	    } else {
                   9843: 		&Apache::lonnet::del('environment',[$option],
                   9844: 				     $domain,$username);
                   9845: 	    }
                   9846: 	}
                   9847:     }
                   9848: # ------------------------------------------------------------- Get environment
                   9849: 
                   9850:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   9851:     my ($tmp) = keys(%userenv);
                   9852:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9853: 	# default remote control to off
                   9854: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   9855:     } else {
                   9856: 	undef(%userenv);
                   9857:     }
                   9858:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   9859: 	$form->{'interface'}=$userenv{'interface'};
                   9860:     }
                   9861:     $env{'environment.remote'}=$userenv{'remote'};
                   9862:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   9863: 
                   9864: # --------------- Do not trust query string to be put directly into environment
                   9865:     foreach my $option ('imagesuppress','appletsuppress',
                   9866: 			'embedsuppress','fontenhance','blackwhite',
                   9867: 			'interface','localpath','localres') {
                   9868: 	$form->{$option}=~s/[\n\r\=]//gs;
                   9869:     }
                   9870: # --------------------------------------------------------- Write first profile
                   9871: 
                   9872:     {
                   9873: 	my %initial_env = 
                   9874: 	    ("user.name"          => $username,
                   9875: 	     "user.domain"        => $domain,
                   9876: 	     "user.home"          => $authhost,
                   9877: 	     "browser.type"       => $clientbrowser,
                   9878: 	     "browser.version"    => $clientversion,
                   9879: 	     "browser.mathml"     => $clientmathml,
                   9880: 	     "browser.unicode"    => $clientunicode,
                   9881: 	     "browser.os"         => $clientos,
                   9882: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   9883: 	     "request.course.fn"  => '',
                   9884: 	     "request.course.uri" => '',
                   9885: 	     "request.course.sec" => '',
                   9886: 	     "request.role"       => 'cm',
                   9887: 	     "request.role.adv"   => $env{'user.adv'},
                   9888: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   9889: 
                   9890:         if ($form->{'localpath'}) {
                   9891: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   9892: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   9893:         }
                   9894: 	
                   9895: 	if ($public) {
                   9896: 	    $initial_env{"environment.remote"} = "off";
                   9897: 	}
                   9898: 	if ($form->{'interface'}) {
                   9899: 	    $form->{'interface'}=~s/\W//gs;
                   9900: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   9901: 	    $env{'browser.interface'}=$form->{'interface'};
                   9902: 	    foreach my $option ('imagesuppress','appletsuppress',
                   9903: 				'embedsuppress','fontenhance','blackwhite') {
                   9904: 		if (($form->{$option} eq 'true') ||
                   9905: 		    ($userenv{$option} eq 'on')) {
                   9906: 		    $initial_env{"browser.$option"} = "on";
                   9907: 		}
                   9908: 	    }
                   9909: 	}
                   9910: 
1.724     raeburn  9911:         foreach my $tool ('aboutme','blog','portfolio') {
                   9912:             $userenv{'availabletools.'.$tool} = 
                   9913:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   9914:         }
                   9915: 
1.462     albertel 9916: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   9917: 	
                   9918: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   9919: 		 &GDBM_WRCREAT(),0640)) {
                   9920: 	    &_add_to_env(\%disk_env,\%initial_env);
                   9921: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   9922: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 9923: 	    if (ref($args->{'extra_env'})) {
                   9924: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   9925: 	    }
1.462     albertel 9926: 	    untie(%disk_env);
                   9927: 	} else {
1.705     tempelho 9928: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   9929: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 9930: 	    return 'error: '.$!;
                   9931: 	}
                   9932:     }
                   9933:     $env{'request.role'}='cm';
                   9934:     $env{'request.role.adv'}=$env{'user.adv'};
                   9935:     $env{'browser.type'}=$clientbrowser;
                   9936: 
                   9937:     return $cookie;
                   9938: 
                   9939: }
                   9940: 
                   9941: sub _add_to_env {
                   9942:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  9943:     if (ref($env_data) eq 'HASH') {
                   9944:         while (my ($key,$value) = each(%$env_data)) {
                   9945: 	    $idf->{$prefix.$key} = $value;
                   9946: 	    $env{$prefix.$key}   = $value;
                   9947:         }
1.462     albertel 9948:     }
                   9949: }
                   9950: 
1.685     tempelho 9951: # --- Get the symbolic name of a problem and the url
                   9952: sub get_symb {
                   9953:     my ($request,$silent) = @_;
1.726     raeburn  9954:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 9955:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   9956:     if ($symb eq '') {
                   9957:         if (!$silent) {
                   9958:             $request->print("Unable to handle ambiguous references:$url:.");
                   9959:             return ();
                   9960:         }
                   9961:     }
                   9962:     &Apache::lonenc::check_decrypt(\$symb);
                   9963:     return ($symb);
                   9964: }
                   9965: 
                   9966: # --------------------------------------------------------------Get annotation
                   9967: 
                   9968: sub get_annotation {
                   9969:     my ($symb,$enc) = @_;
                   9970: 
                   9971:     my $key = $symb;
                   9972:     if (!$enc) {
                   9973:         $key =
                   9974:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   9975:     }
                   9976:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   9977:     return $annotation{$key};
                   9978: }
                   9979: 
                   9980: sub clean_symb {
1.731     raeburn  9981:     my ($symb,$delete_enc) = @_;
1.685     tempelho 9982: 
                   9983:     &Apache::lonenc::check_decrypt(\$symb);
                   9984:     my $enc = $env{'request.enc'};
1.731     raeburn  9985:     if ($delete_enc) {
1.730     raeburn  9986:         delete($env{'request.enc'});
                   9987:     }
1.685     tempelho 9988: 
                   9989:     return ($symb,$enc);
                   9990: }
1.462     albertel 9991: 
1.41      ng       9992: =pod
                   9993: 
                   9994: =back
                   9995: 
1.112     bowersj2 9996: =cut
1.41      ng       9997: 
1.112     bowersj2 9998: 1;
                   9999: __END__;
1.41      ng       10000: 

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