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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.851   ! tempelho    4: # $Id: loncommon.pm,v 1.850 2009/07/06 15:29:31 bisitz Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.468     raeburn   485:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   486:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468     raeburn   487:    my $output = '
1.776     bisitz    488: <script type="text/javascript" language="JavaScript">
1.824     bisitz    489: // <![CDATA[
1.468     raeburn   490:     var stdeditbrowser;'."\n";
                    491:    $output .= <<"ENDSTDBRW";
1.377     raeburn   492:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       493:         var url = '/adm/pickcourse?';
1.468     raeburn   494:         var domainfilter = '';
                    495:         var formid = getFormIdByName(formname);
                    496:         if (formid > -1) {
                    497:             var domid = getIndexByName(formid,udom);
                    498:             if (domid > -1) {
                    499:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    500:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    501:                 }
                    502:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    503:                     domainfilter=document.forms[formid].elements[domid].value;
                    504:                 }
                    505:             }
1.91      www       506:         }
1.128     albertel  507:         if (domainfilter != null) {
                    508:            if (domainfilter != '') {
                    509:                url += 'domainfilter='+domainfilter+'&';
                    510: 	   }
                    511:         }
1.91      www       512:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  513: 	                            '&cdomelement='+udom+
                    514:                                     '&cnameelement='+desc;
1.468     raeburn   515:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   516:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   517:                 url += '&roleelement='+extra_element;
                    518:                 if (domainfilter == null || domainfilter == '') {
                    519:                     url += '&domainfilter='+extra_element;
                    520:                 }
1.234     raeburn   521:             }
1.468     raeburn   522:             else {
                    523:                 if (formname == 'portform') {
                    524:                     url += '&setroles='+extra_element;
1.800     raeburn   525:                 } else {
                    526:                     if (formname == 'rules') {
                    527:                         url += '&fixeddom='+extra_element; 
                    528:                     }
1.468     raeburn   529:                 }
                    530:             }     
1.230     raeburn   531:         }
1.293     raeburn   532:         if (multflag !=null && multflag != '') {
                    533:             url += '&multiple='+multflag;
                    534:         }
1.377     raeburn   535:         if (crstype == 'Course/Group') {
                    536:             if (formname == 'cu') {
                    537:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    538:                 if (crstype == "") {
                    539:                     alert("$crs_or_grp_alert");
                    540:                     return;
                    541:                 }
                    542:             }
                    543:         }
                    544:         if (crstype !=null && crstype != '') {
                    545:             url += '&type='+crstype;
                    546:         }
1.102     www       547:         var title = 'Course_Browser';
1.91      www       548:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    549:         options += ',width=700,height=600';
                    550:         stdeditbrowser = open(url,title,options,'1');
                    551:         stdeditbrowser.focus();
                    552:     }
1.468     raeburn   553: 
                    554:     function getFormIdByName(formname) {
                    555:         for (var i=0;i<document.forms.length;i++) {
                    556:             if (document.forms[i].name == formname) {
                    557:                 return i;
                    558:             }
                    559:         }
                    560:         return -1; 
                    561:     }
                    562: 
                    563:     function getIndexByName(formid,item) {
                    564:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    565:             if (document.forms[formid].elements[i].name == item) {
                    566:                 return i;
                    567:             }
                    568:         }
                    569:         return -1;
                    570:     }
1.91      www       571: ENDSTDBRW
1.468     raeburn   572:     if ($sec_element ne '') {
                    573:         $output .= &setsec_javascript($sec_element,$formname);
                    574:     }
                    575:     $output .= '
1.824     bisitz    576: // ]]>
1.468     raeburn   577: </script>';
                    578:     return $output;
                    579: }
                    580: 
                    581: sub setsec_javascript {
                    582:     my ($sec_element,$formname) = @_;
                    583:     my $setsections = qq|
                    584: function setSect(sectionlist) {
1.629     raeburn   585:     var sectionsArray = new Array();
                    586:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    587:         sectionsArray = sectionlist.split(",");
                    588:     }
1.468     raeburn   589:     var numSections = sectionsArray.length;
                    590:     document.$formname.$sec_element.length = 0;
                    591:     if (numSections == 0) {
                    592:         document.$formname.$sec_element.multiple=false;
                    593:         document.$formname.$sec_element.size=1;
                    594:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    595:     } else {
                    596:         if (numSections == 1) {
                    597:             document.$formname.$sec_element.multiple=false;
                    598:             document.$formname.$sec_element.size=1;
                    599:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    600:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    601:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    602:         } else {
                    603:             for (var i=0; i<numSections; i++) {
                    604:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    605:             }
                    606:             document.$formname.$sec_element.multiple=true
                    607:             if (numSections < 3) {
                    608:                 document.$formname.$sec_element.size=numSections;
                    609:             } else {
                    610:                 document.$formname.$sec_element.size=3;
                    611:             }
                    612:             document.$formname.$sec_element.options[0].selected = false
                    613:         }
                    614:     }
1.91      www       615: }
1.468     raeburn   616: |;
                    617:     return $setsections;
                    618: }
                    619: 
1.91      www       620: 
                    621: sub selectcourse_link {
1.377     raeburn   622:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787     bisitz    623:    return '<span class="LC_nobreak">'
                    624:          ."<a href='"
                    625:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    626:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    627:          .'","'.$multflag.'","'.$selecttype.'");'
                    628:          ."'>".&mt('Select Course').'</a>'
                    629:          .'</span>';
1.74      www       630: }
1.42      matthew   631: 
1.653     raeburn   632: sub selectauthor_link {
                    633:    my ($form,$udom)=@_;
                    634:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    635:           &mt('Select Author').'</a>';
                    636: }
                    637: 
1.273     raeburn   638: sub check_uncheck_jscript {
                    639:     my $jscript = <<"ENDSCRT";
                    640: function checkAll(field) {
                    641:     if (field.length > 0) {
                    642:         for (i = 0; i < field.length; i++) {
                    643:             field[i].checked = true ;
                    644:         }
                    645:     } else {
                    646:         field.checked = true
                    647:     }
                    648: }
                    649:  
                    650: function uncheckAll(field) {
                    651:     if (field.length > 0) {
                    652:         for (i = 0; i < field.length; i++) {
                    653:             field[i].checked = false ;
1.543     albertel  654:         }
                    655:     } else {
1.273     raeburn   656:         field.checked = false ;
                    657:     }
                    658: }
                    659: ENDSCRT
                    660:     return $jscript;
                    661: }
                    662: 
1.656     www       663: sub select_timezone {
1.659     raeburn   664:    my ($name,$selected,$onchange,$includeempty)=@_;
                    665:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    666:    if ($includeempty) {
                    667:        $output .= '<option value=""';
                    668:        if (($selected eq '') || ($selected eq 'local')) {
                    669:            $output .= ' selected="selected" ';
                    670:        }
                    671:        $output .= '> </option>';
                    672:    }
1.657     raeburn   673:    my @timezones = DateTime::TimeZone->all_names;
                    674:    foreach my $tzone (@timezones) {
                    675:        $output.= '<option value="'.$tzone.'"';
                    676:        if ($tzone eq $selected) {
                    677:            $output.=' selected="selected"';
                    678:        }
                    679:        $output.=">$tzone</option>\n";
1.656     www       680:    }
                    681:    $output.="</select>";
                    682:    return $output;
                    683: }
1.273     raeburn   684: 
1.687     raeburn   685: sub select_datelocale {
                    686:     my ($name,$selected,$onchange,$includeempty)=@_;
                    687:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    688:     if ($includeempty) {
                    689:         $output .= '<option value=""';
                    690:         if ($selected eq '') {
                    691:             $output .= ' selected="selected" ';
                    692:         }
                    693:         $output .= '> </option>';
                    694:     }
                    695:     my (@possibles,%locale_names);
                    696:     my @locales = DateTime::Locale::Catalog::Locales;
                    697:     foreach my $locale (@locales) {
                    698:         if (ref($locale) eq 'HASH') {
                    699:             my $id = $locale->{'id'};
                    700:             if ($id ne '') {
                    701:                 my $en_terr = $locale->{'en_territory'};
                    702:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   703:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   704:                 if (grep(/^en$/,@languages) || !@languages) {
                    705:                     if ($en_terr ne '') {
                    706:                         $locale_names{$id} = '('.$en_terr.')';
                    707:                     } elsif ($native_terr ne '') {
                    708:                         $locale_names{$id} = $native_terr;
                    709:                     }
                    710:                 } else {
                    711:                     if ($native_terr ne '') {
                    712:                         $locale_names{$id} = $native_terr.' ';
                    713:                     } elsif ($en_terr ne '') {
                    714:                         $locale_names{$id} = '('.$en_terr.')';
                    715:                     }
                    716:                 }
                    717:                 push (@possibles,$id);
                    718:             }
                    719:         }
                    720:     }
                    721:     foreach my $item (sort(@possibles)) {
                    722:         $output.= '<option value="'.$item.'"';
                    723:         if ($item eq $selected) {
                    724:             $output.=' selected="selected"';
                    725:         }
                    726:         $output.=">$item";
                    727:         if ($locale_names{$item} ne '') {
                    728:             $output.="  $locale_names{$item}</option>\n";
                    729:         }
                    730:         $output.="</option>\n";
                    731:     }
                    732:     $output.="</select>";
                    733:     return $output;
                    734: }
                    735: 
1.792     raeburn   736: sub select_language {
                    737:     my ($name,$selected,$includeempty) = @_;
                    738:     my %langchoices;
                    739:     if ($includeempty) {
                    740:         %langchoices = ('' => 'No language preference');
                    741:     }
                    742:     foreach my $id (&languageids()) {
                    743:         my $code = &supportedlanguagecode($id);
                    744:         if ($code) {
                    745:             $langchoices{$code} = &plainlanguagedescription($id);
                    746:         }
                    747:     }
                    748:     return &select_form($selected,$name,%langchoices);
                    749: }
                    750: 
1.42      matthew   751: =pod
1.36      matthew   752: 
1.648     raeburn   753: =item * &linked_select_forms(...)
1.36      matthew   754: 
                    755: linked_select_forms returns a string containing a <script></script> block
                    756: and html for two <select> menus.  The select menus will be linked in that
                    757: changing the value of the first menu will result in new values being placed
                    758: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   759: order unless a defined order is provided.
1.36      matthew   760: 
                    761: linked_select_forms takes the following ordered inputs:
                    762: 
                    763: =over 4
                    764: 
1.112     bowersj2  765: =item * $formname, the name of the <form> tag
1.36      matthew   766: 
1.112     bowersj2  767: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   768: 
1.112     bowersj2  769: =item * $firstdefault, the default value for the first menu
1.36      matthew   770: 
1.112     bowersj2  771: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   772: 
1.112     bowersj2  773: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   774: 
1.112     bowersj2  775: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   776: 
1.609     raeburn   777: =item * $menuorder, the order of values in the first menu
                    778: 
1.41      ng        779: =back 
                    780: 
1.36      matthew   781: Below is an example of such a hash.  Only the 'text', 'default', and 
                    782: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    783: values for the first select menu.  The text that coincides with the 
1.41      ng        784: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   785: and text for the second menu are given in the hash pointed to by 
                    786: $menu{$choice1}->{'select2'}.  
                    787: 
1.112     bowersj2  788:  my %menu = ( A1 => { text =>"Choice A1" ,
                    789:                        default => "B3",
                    790:                        select2 => { 
                    791:                            B1 => "Choice B1",
                    792:                            B2 => "Choice B2",
                    793:                            B3 => "Choice B3",
                    794:                            B4 => "Choice B4"
1.609     raeburn   795:                            },
                    796:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  797:                    },
                    798:                A2 => { text =>"Choice A2" ,
                    799:                        default => "C2",
                    800:                        select2 => { 
                    801:                            C1 => "Choice C1",
                    802:                            C2 => "Choice C2",
                    803:                            C3 => "Choice C3"
1.609     raeburn   804:                            },
                    805:                        order => ['C2','C1','C3'],
1.112     bowersj2  806:                    },
                    807:                A3 => { text =>"Choice A3" ,
                    808:                        default => "D6",
                    809:                        select2 => { 
                    810:                            D1 => "Choice D1",
                    811:                            D2 => "Choice D2",
                    812:                            D3 => "Choice D3",
                    813:                            D4 => "Choice D4",
                    814:                            D5 => "Choice D5",
                    815:                            D6 => "Choice D6",
                    816:                            D7 => "Choice D7"
1.609     raeburn   817:                            },
                    818:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  819:                    }
                    820:                );
1.36      matthew   821: 
                    822: =cut
                    823: 
                    824: sub linked_select_forms {
                    825:     my ($formname,
                    826:         $middletext,
                    827:         $firstdefault,
                    828:         $firstselectname,
                    829:         $secondselectname, 
1.609     raeburn   830:         $hashref,
                    831:         $menuorder,
1.36      matthew   832:         ) = @_;
                    833:     my $second = "document.$formname.$secondselectname";
                    834:     my $first = "document.$formname.$firstselectname";
                    835:     # output the javascript to do the changing
                    836:     my $result = '';
1.776     bisitz    837:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    838:     $result.="// <![CDATA[\n";
1.36      matthew   839:     $result.="var select2data = new Object();\n";
                    840:     $" = '","';
                    841:     my $debug = '';
                    842:     foreach my $s1 (sort(keys(%$hashref))) {
                    843:         $result.="select2data.d_$s1 = new Object();\n";        
                    844:         $result.="select2data.d_$s1.def = new String('".
                    845:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   846:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   847:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   848:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    849:             @s2values = @{$hashref->{$s1}->{'order'}};
                    850:         }
1.36      matthew   851:         $result.="\"@s2values\");\n";
                    852:         $result.="select2data.d_$s1.texts = new Array(";        
                    853:         my @s2texts;
                    854:         foreach my $value (@s2values) {
                    855:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    856:         }
                    857:         $result.="\"@s2texts\");\n";
                    858:     }
                    859:     $"=' ';
                    860:     $result.= <<"END";
                    861: 
                    862: function select1_changed() {
                    863:     // Determine new choice
                    864:     var newvalue = "d_" + $first.value;
                    865:     // update select2
                    866:     var values     = select2data[newvalue].values;
                    867:     var texts      = select2data[newvalue].texts;
                    868:     var select2def = select2data[newvalue].def;
                    869:     var i;
                    870:     // out with the old
                    871:     for (i = 0; i < $second.options.length; i++) {
                    872:         $second.options[i] = null;
                    873:     }
                    874:     // in with the nuclear
                    875:     for (i=0;i<values.length; i++) {
                    876:         $second.options[i] = new Option(values[i]);
1.143     matthew   877:         $second.options[i].value = values[i];
1.36      matthew   878:         $second.options[i].text = texts[i];
                    879:         if (values[i] == select2def) {
                    880:             $second.options[i].selected = true;
                    881:         }
                    882:     }
                    883: }
1.824     bisitz    884: // ]]>
1.36      matthew   885: </script>
                    886: END
                    887:     # output the initial values for the selection lists
                    888:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   889:     my @order = sort(keys(%{$hashref}));
                    890:     if (ref($menuorder) eq 'ARRAY') {
                    891:         @order = @{$menuorder};
                    892:     }
                    893:     foreach my $value (@order) {
1.36      matthew   894:         $result.="    <option value=\"$value\" ";
1.253     albertel  895:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       896:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   897:     }
                    898:     $result .= "</select>\n";
                    899:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    900:     $result .= $middletext;
                    901:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    902:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   903:     
                    904:     my @secondorder = sort(keys(%select2));
                    905:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    906:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    907:     }
                    908:     foreach my $value (@secondorder) {
1.36      matthew   909:         $result.="    <option value=\"$value\" ";        
1.253     albertel  910:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       911:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   912:     }
                    913:     $result .= "</select>\n";
                    914:     #    return $debug;
                    915:     return $result;
                    916: }   #  end of sub linked_select_forms {
                    917: 
1.45      matthew   918: =pod
1.44      bowersj2  919: 
1.648     raeburn   920: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  921: 
1.112     bowersj2  922: Returns a string corresponding to an HTML link to the given help
                    923: $topic, where $topic corresponds to the name of a .tex file in
                    924: /home/httpd/html/adm/help/tex, with underscores replaced by
                    925: spaces. 
                    926: 
                    927: $text will optionally be linked to the same topic, allowing you to
                    928: link text in addition to the graphic. If you do not want to link
                    929: text, but wish to specify one of the later parameters, pass an
                    930: empty string. 
                    931: 
                    932: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    933: the link will not open a new window. If false, the link will open
                    934: a new window using Javascript. (Default is false.) 
                    935: 
                    936: $width and $height are optional numerical parameters that will
                    937: override the width and height of the popped up window, which may
                    938: be useful for certain help topics with big pictures included. 
1.44      bowersj2  939: 
                    940: =cut
                    941: 
                    942: sub help_open_topic {
1.48      bowersj2  943:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    944:     $text = "" if (not defined $text);
1.44      bowersj2  945:     $stayOnPage = 0 if (not defined $stayOnPage);
                    946:     $width = 350 if (not defined $width);
                    947:     $height = 400 if (not defined $height);
                    948:     my $filename = $topic;
                    949:     $filename =~ s/ /_/g;
                    950: 
1.48      bowersj2  951:     my $template = "";
                    952:     my $link;
1.572     banghart  953:     
1.159     www       954:     $topic=~s/\W/\_/g;
1.44      bowersj2  955: 
1.572     banghart  956:     if (!$stayOnPage) {
1.72      bowersj2  957: 	$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  958:     } else {
1.48      bowersj2  959: 	$link = "/adm/help/${filename}.hlp";
                    960:     }
                    961: 
                    962:     # Add the text
1.755     neumanie  963:     if ($text ne "") {	
1.763     bisitz    964: 	$template.='<span class="LC_help_open_topic">'
                    965:                   .'<a target="_top" href="'.$link.'">'
                    966:                   .$text.'</a>';
1.48      bowersj2  967:     }
                    968: 
1.763     bisitz    969:     # (Always) Add the graphic
1.179     matthew   970:     my $title = &mt('Online Help');
1.667     raeburn   971:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz    972:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                    973:               .'<img src="'.$helpicon.'" border="0"'
                    974:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller  975:               .' title="'.$title.'"' 
1.763     bisitz    976:               .' /></a>';
                    977:     if ($text ne "") {	
                    978:         $template.='</span>';
                    979:     }
1.44      bowersj2  980:     return $template;
                    981: 
1.106     bowersj2  982: }
                    983: 
                    984: # This is a quicky function for Latex cheatsheet editing, since it 
                    985: # appears in at least four places
                    986: sub helpLatexCheatsheet {
1.732     raeburn   987:     my ($topic,$text,$not_author) = @_;
                    988:     my $out;
1.106     bowersj2  989:     my $addOther = '';
1.732     raeburn   990:     if ($topic) {
1.763     bisitz    991: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                    992: 							       undef, undef, 600).
                    993: 								   '</span> ';
                    994:     }
                    995:     $out = '<span>' # Start cheatsheet
                    996: 	  .$addOther
                    997:           .'<span>'
                    998: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                    999: 					       undef,undef,600)
                   1000: 	  .'</span> <span>'
                   1001: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1002: 					       undef,undef,600)
                   1003: 	  .'</span>';
1.732     raeburn  1004:     unless ($not_author) {
1.763     bisitz   1005:         $out .= ' <span>'
                   1006: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1007: 	                                            undef,undef,600)
                   1008: 	       .'</span>';
1.732     raeburn  1009:     }
1.763     bisitz   1010:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1011:     return $out;
1.172     www      1012: }
                   1013: 
1.430     albertel 1014: sub general_help {
                   1015:     my $helptopic='Student_Intro';
                   1016:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1017: 	$helptopic='Authoring_Intro';
                   1018:     } elsif ($env{'request.role'}=~/^cc/) {
                   1019: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1020:     } elsif ($env{'request.role'}=~/^dc/) {
                   1021:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1022:     }
                   1023:     return $helptopic;
                   1024: }
                   1025: 
                   1026: sub update_help_link {
                   1027:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1028:     my $origurl = $ENV{'REQUEST_URI'};
                   1029:     $origurl=~s|^/~|/priv/|;
                   1030:     my $timestamp = time;
                   1031:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1032:         $$datum = &escape($$datum);
                   1033:     }
                   1034: 
                   1035:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1036:     my $output .= <<"ENDOUTPUT";
                   1037: <script type="text/javascript">
1.824     bisitz   1038: // <![CDATA[
1.430     albertel 1039: banner_link = '$banner_link';
1.824     bisitz   1040: // ]]>
1.430     albertel 1041: </script>
                   1042: ENDOUTPUT
                   1043:     return $output;
                   1044: }
                   1045: 
                   1046: # now just updates the help link and generates a blue icon
1.193     raeburn  1047: sub help_open_menu {
1.430     albertel 1048:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1049: 	= @_;    
1.430     albertel 1050:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1051:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1052:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1053:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1054:         $stayOnPage=1;
1.430     albertel 1055:     }
                   1056:     my $output;
                   1057:     if ($component_help) {
                   1058: 	if (!$text) {
                   1059: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1060: 				       $width,$height);
                   1061: 	} else {
                   1062: 	    my $help_text;
                   1063: 	    $help_text=&unescape($topic);
                   1064: 	    $output='<table><tr><td>'.
                   1065: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1066: 				 $width,$height).'</td></tr></table>';
                   1067: 	}
                   1068:     }
                   1069:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1070:     return $output.$banner_link;
                   1071: }
                   1072: 
                   1073: sub top_nav_help {
                   1074:     my ($text) = @_;
1.436     albertel 1075:     $text = &mt($text);
1.572     banghart 1076:     my $stay_on_page = 
1.798     tempelho 1077: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1078:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1079: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1080:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1081: 
1.201     raeburn  1082:     my $title = &mt('Get help');
1.436     albertel 1083: 
                   1084:     return <<"END";
                   1085: $banner_link
                   1086:  <a href="$link" title="$title">$text</a>
                   1087: END
                   1088: }
                   1089: 
                   1090: sub help_menu_js {
                   1091:     my ($text) = @_;
                   1092: 
                   1093:     my $stayOnPage = 
1.798     tempelho 1094: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1095: 
                   1096:     my $width = 620;
                   1097:     my $height = 600;
1.430     albertel 1098:     my $helptopic=&general_help();
                   1099:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1100:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1101:     my $start_page =
                   1102:         &Apache::loncommon::start_page('Help Menu', undef,
                   1103: 				       {'frameset'    => 1,
                   1104: 					'js_ready'    => 1,
                   1105: 					'add_entries' => {
                   1106: 					    'border' => '0',
1.579     raeburn  1107: 					    'rows'   => "110,*",},});
1.331     albertel 1108:     my $end_page =
                   1109:         &Apache::loncommon::end_page({'frameset' => 1,
                   1110: 				      'js_ready' => 1,});
                   1111: 
1.436     albertel 1112:     my $template .= <<"ENDTEMPLATE";
                   1113: <script type="text/javascript">
1.253     albertel 1114: // <!-- BEGIN LON-CAPA Internal
                   1115: // <![CDATA[
1.430     albertel 1116: var banner_link = '';
1.243     raeburn  1117: function helpMenu(target) {
                   1118:     var caller = this;
                   1119:     if (target == 'open') {
                   1120:         var newWindow = null;
                   1121:         try {
1.262     albertel 1122:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1123:         }
                   1124:         catch(error) {
                   1125:             writeHelp(caller);
                   1126:             return;
                   1127:         }
                   1128:         if (newWindow) {
                   1129:             caller = newWindow;
                   1130:         }
1.193     raeburn  1131:     }
1.243     raeburn  1132:     writeHelp(caller);
                   1133:     return;
                   1134: }
                   1135: function writeHelp(caller) {
1.430     albertel 1136:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1137:     caller.document.close()
                   1138:     caller.focus()
1.193     raeburn  1139: }
1.253     albertel 1140: // ]]>
1.219     albertel 1141: // END LON-CAPA Internal -->
1.436     albertel 1142: </script>
1.193     raeburn  1143: ENDTEMPLATE
                   1144:     return $template;
                   1145: }
                   1146: 
1.172     www      1147: sub help_open_bug {
                   1148:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1149:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1150:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1151:     $text = "" if (not defined $text);
                   1152:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1153:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1154: 	$stayOnPage=1;
                   1155:     }
1.184     albertel 1156:     $width = 600 if (not defined $width);
                   1157:     $height = 600 if (not defined $height);
1.172     www      1158: 
                   1159:     $topic=~s/\W+/\+/g;
                   1160:     my $link='';
                   1161:     my $template='';
1.379     albertel 1162:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1163: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1164:     if (!$stayOnPage)
                   1165:     {
                   1166: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1167:     }
                   1168:     else
                   1169:     {
                   1170: 	$link = $url;
                   1171:     }
                   1172:     # Add the text
                   1173:     if ($text ne "")
                   1174:     {
                   1175: 	$template .= 
                   1176:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1177:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1178:     }
                   1179: 
                   1180:     # Add the graphic
1.179     matthew  1181:     my $title = &mt('Report a Bug');
1.215     albertel 1182:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1183:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1184:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1185: ENDTEMPLATE
                   1186:     if ($text ne '') { $template.='</td></tr></table>' };
                   1187:     return $template;
                   1188: 
                   1189: }
                   1190: 
                   1191: sub help_open_faq {
                   1192:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1193:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1194:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1195:     $text = "" if (not defined $text);
                   1196:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1197:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1198: 	$stayOnPage=1;
                   1199:     }
                   1200:     $width = 350 if (not defined $width);
                   1201:     $height = 400 if (not defined $height);
                   1202: 
                   1203:     $topic=~s/\W+/\+/g;
                   1204:     my $link='';
                   1205:     my $template='';
                   1206:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1207:     if (!$stayOnPage)
                   1208:     {
                   1209: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1210:     }
                   1211:     else
                   1212:     {
                   1213: 	$link = $url;
                   1214:     }
                   1215: 
                   1216:     # Add the text
                   1217:     if ($text ne "")
                   1218:     {
                   1219: 	$template .= 
1.173     www      1220:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1221:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1222:     }
                   1223: 
                   1224:     # Add the graphic
1.179     matthew  1225:     my $title = &mt('View the FAQ');
1.215     albertel 1226:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1227:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1228:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1229: ENDTEMPLATE
                   1230:     if ($text ne '') { $template.='</td></tr></table>' };
                   1231:     return $template;
                   1232: 
1.44      bowersj2 1233: }
1.37      matthew  1234: 
1.180     matthew  1235: ###############################################################
                   1236: ###############################################################
                   1237: 
1.45      matthew  1238: =pod
                   1239: 
1.648     raeburn  1240: =item * &change_content_javascript():
1.256     matthew  1241: 
                   1242: This and the next function allow you to create small sections of an
                   1243: otherwise static HTML page that you can update on the fly with
                   1244: Javascript, even in Netscape 4.
                   1245: 
                   1246: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1247: must be written to the HTML page once. It will prove the Javascript
                   1248: function "change(name, content)". Calling the change function with the
                   1249: name of the section 
                   1250: you want to update, matching the name passed to C<changable_area>, and
                   1251: the new content you want to put in there, will put the content into
                   1252: that area.
                   1253: 
                   1254: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1255: to contain room for the original contents. You need to "make space"
                   1256: for whatever changes you wish to make, and be B<sure> to check your
                   1257: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1258: it's adequate for updating a one-line status display, but little more.
                   1259: This script will set the space to 100% width, so you only need to
                   1260: worry about height in Netscape 4.
                   1261: 
                   1262: Modern browsers are much less limiting, and if you can commit to the
                   1263: user not using Netscape 4, this feature may be used freely with
                   1264: pretty much any HTML.
                   1265: 
                   1266: =cut
                   1267: 
                   1268: sub change_content_javascript {
                   1269:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1270:     if ($env{'browser.type'} eq 'netscape' &&
                   1271: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1272: 	return (<<NETSCAPE4);
                   1273: 	function change(name, content) {
                   1274: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1275: 	    doc.open();
                   1276: 	    doc.write(content);
                   1277: 	    doc.close();
                   1278: 	}
                   1279: NETSCAPE4
                   1280:     } else {
                   1281: 	# Otherwise, we need to use semi-standards-compliant code
                   1282: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1283: 	# is really scary, and every useful browser supports it
                   1284: 	return (<<DOMBASED);
                   1285: 	function change(name, content) {
                   1286: 	    element = document.getElementById(name);
                   1287: 	    element.innerHTML = content;
                   1288: 	}
                   1289: DOMBASED
                   1290:     }
                   1291: }
                   1292: 
                   1293: =pod
                   1294: 
1.648     raeburn  1295: =item * &changable_area($name,$origContent):
1.256     matthew  1296: 
                   1297: This provides a "changable area" that can be modified on the fly via
                   1298: the Javascript code provided in C<change_content_javascript>. $name is
                   1299: the name you will use to reference the area later; do not repeat the
                   1300: same name on a given HTML page more then once. $origContent is what
                   1301: the area will originally contain, which can be left blank.
                   1302: 
                   1303: =cut
                   1304: 
                   1305: sub changable_area {
                   1306:     my ($name, $origContent) = @_;
                   1307: 
1.258     albertel 1308:     if ($env{'browser.type'} eq 'netscape' &&
                   1309: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1310: 	# If this is netscape 4, we need to use the Layer tag
                   1311: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1312:     } else {
                   1313: 	return "<span id='$name'>$origContent</span>";
                   1314:     }
                   1315: }
                   1316: 
                   1317: =pod
                   1318: 
1.648     raeburn  1319: =item * &viewport_geometry_js 
1.590     raeburn  1320: 
                   1321: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1322: 
                   1323: =cut
                   1324: 
                   1325: 
                   1326: sub viewport_geometry_js { 
                   1327:     return <<"GEOMETRY";
                   1328: var Geometry = {};
                   1329: function init_geometry() {
                   1330:     if (Geometry.init) { return };
                   1331:     Geometry.init=1;
                   1332:     if (window.innerHeight) {
                   1333:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1334:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1335:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1336:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1337:     }
                   1338:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1339:         Geometry.getViewportHeight =
                   1340:             function() { return document.documentElement.clientHeight; };
                   1341:         Geometry.getViewportWidth =
                   1342:             function() { return document.documentElement.clientWidth; };
                   1343: 
                   1344:         Geometry.getHorizontalScroll =
                   1345:             function() { return document.documentElement.scrollLeft; };
                   1346:         Geometry.getVerticalScroll =
                   1347:             function() { return document.documentElement.scrollTop; };
                   1348:     }
                   1349:     else if (document.body.clientHeight) {
                   1350:         Geometry.getViewportHeight =
                   1351:             function() { return document.body.clientHeight; };
                   1352:         Geometry.getViewportWidth =
                   1353:             function() { return document.body.clientWidth; };
                   1354:         Geometry.getHorizontalScroll =
                   1355:             function() { return document.body.scrollLeft; };
                   1356:         Geometry.getVerticalScroll =
                   1357:             function() { return document.body.scrollTop; };
                   1358:     }
                   1359: }
                   1360: 
                   1361: GEOMETRY
                   1362: }
                   1363: 
                   1364: =pod
                   1365: 
1.648     raeburn  1366: =item * &viewport_size_js()
1.590     raeburn  1367: 
                   1368: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1369: 
                   1370: =cut
                   1371: 
                   1372: sub viewport_size_js {
                   1373:     my $geometry = &viewport_geometry_js();
                   1374:     return <<"DIMS";
                   1375: 
                   1376: $geometry
                   1377: 
                   1378: function getViewportDims(width,height) {
                   1379:     init_geometry();
                   1380:     width.value = Geometry.getViewportWidth();
                   1381:     height.value = Geometry.getViewportHeight();
                   1382:     return;
                   1383: }
                   1384: 
                   1385: DIMS
                   1386: }
                   1387: 
                   1388: =pod
                   1389: 
1.648     raeburn  1390: =item * &resize_textarea_js()
1.565     albertel 1391: 
                   1392: emits the needed javascript to resize a textarea to be as big as possible
                   1393: 
                   1394: creates a function resize_textrea that takes two IDs first should be
                   1395: the id of the element to resize, second should be the id of a div that
                   1396: surrounds everything that comes after the textarea, this routine needs
                   1397: to be attached to the <body> for the onload and onresize events.
                   1398: 
1.648     raeburn  1399: =back
1.565     albertel 1400: 
                   1401: =cut
                   1402: 
                   1403: sub resize_textarea_js {
1.590     raeburn  1404:     my $geometry = &viewport_geometry_js();
1.565     albertel 1405:     return <<"RESIZE";
                   1406:     <script type="text/javascript">
1.824     bisitz   1407: // <![CDATA[
1.590     raeburn  1408: $geometry
1.565     albertel 1409: 
1.588     albertel 1410: function getX(element) {
                   1411:     var x = 0;
                   1412:     while (element) {
                   1413: 	x += element.offsetLeft;
                   1414: 	element = element.offsetParent;
                   1415:     }
                   1416:     return x;
                   1417: }
                   1418: function getY(element) {
                   1419:     var y = 0;
                   1420:     while (element) {
                   1421: 	y += element.offsetTop;
                   1422: 	element = element.offsetParent;
                   1423:     }
                   1424:     return y;
                   1425: }
                   1426: 
                   1427: 
1.565     albertel 1428: function resize_textarea(textarea_id,bottom_id) {
                   1429:     init_geometry();
                   1430:     var textarea        = document.getElementById(textarea_id);
                   1431:     //alert(textarea);
                   1432: 
1.588     albertel 1433:     var textarea_top    = getY(textarea);
1.565     albertel 1434:     var textarea_height = textarea.offsetHeight;
                   1435:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1436:     var bottom_top      = getY(bottom);
1.565     albertel 1437:     var bottom_height   = bottom.offsetHeight;
                   1438:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1439:     var fudge           = 23;
1.565     albertel 1440:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1441:     if (new_height < 300) {
                   1442: 	new_height = 300;
                   1443:     }
                   1444:     textarea.style.height=new_height+'px';
                   1445: }
1.824     bisitz   1446: // ]]>
1.565     albertel 1447: </script>
                   1448: RESIZE
                   1449: 
                   1450: }
                   1451: 
                   1452: =pod
                   1453: 
1.256     matthew  1454: =head1 Excel and CSV file utility routines
                   1455: 
                   1456: =over 4
                   1457: 
                   1458: =cut
                   1459: 
                   1460: ###############################################################
                   1461: ###############################################################
                   1462: 
                   1463: =pod
                   1464: 
1.648     raeburn  1465: =item * &csv_translate($text) 
1.37      matthew  1466: 
1.185     www      1467: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1468: format.
                   1469: 
                   1470: =cut
                   1471: 
1.180     matthew  1472: ###############################################################
                   1473: ###############################################################
1.37      matthew  1474: sub csv_translate {
                   1475:     my $text = shift;
                   1476:     $text =~ s/\"/\"\"/g;
1.209     albertel 1477:     $text =~ s/\n/ /g;
1.37      matthew  1478:     return $text;
                   1479: }
1.180     matthew  1480: 
                   1481: ###############################################################
                   1482: ###############################################################
                   1483: 
                   1484: =pod
                   1485: 
1.648     raeburn  1486: =item * &define_excel_formats()
1.180     matthew  1487: 
                   1488: Define some commonly used Excel cell formats.
                   1489: 
                   1490: Currently supported formats:
                   1491: 
                   1492: =over 4
                   1493: 
                   1494: =item header
                   1495: 
                   1496: =item bold
                   1497: 
                   1498: =item h1
                   1499: 
                   1500: =item h2
                   1501: 
                   1502: =item h3
                   1503: 
1.256     matthew  1504: =item h4
                   1505: 
                   1506: =item i
                   1507: 
1.180     matthew  1508: =item date
                   1509: 
                   1510: =back
                   1511: 
                   1512: Inputs: $workbook
                   1513: 
                   1514: Returns: $format, a hash reference.
                   1515: 
                   1516: =cut
                   1517: 
                   1518: ###############################################################
                   1519: ###############################################################
                   1520: sub define_excel_formats {
                   1521:     my ($workbook) = @_;
                   1522:     my $format;
                   1523:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1524:                                                 bottom    => 1,
                   1525:                                                 align     => 'center');
                   1526:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1527:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1528:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1529:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1530:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1531:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1532:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1533:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1534:     return $format;
                   1535: }
                   1536: 
                   1537: ###############################################################
                   1538: ###############################################################
1.113     bowersj2 1539: 
                   1540: =pod
                   1541: 
1.648     raeburn  1542: =item * &create_workbook()
1.255     matthew  1543: 
                   1544: Create an Excel worksheet.  If it fails, output message on the
                   1545: request object and return undefs.
                   1546: 
                   1547: Inputs: Apache request object
                   1548: 
                   1549: Returns (undef) on failure, 
                   1550:     Excel worksheet object, scalar with filename, and formats 
                   1551:     from &Apache::loncommon::define_excel_formats on success
                   1552: 
                   1553: =cut
                   1554: 
                   1555: ###############################################################
                   1556: ###############################################################
                   1557: sub create_workbook {
                   1558:     my ($r) = @_;
                   1559:         #
                   1560:     # Create the excel spreadsheet
                   1561:     my $filename = '/prtspool/'.
1.258     albertel 1562:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1563:         time.'_'.rand(1000000000).'.xls';
                   1564:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1565:     if (! defined($workbook)) {
                   1566:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1567:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1568:                             "This error has been logged.  ".
                   1569:                             "Please alert your LON-CAPA administrator").
                   1570:                   '</p>');
                   1571:         return (undef);
                   1572:     }
                   1573:     #
                   1574:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1575:     #
                   1576:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1577:     return ($workbook,$filename,$format);
                   1578: }
                   1579: 
                   1580: ###############################################################
                   1581: ###############################################################
                   1582: 
                   1583: =pod
                   1584: 
1.648     raeburn  1585: =item * &create_text_file()
1.113     bowersj2 1586: 
1.542     raeburn  1587: Create a file to write to and eventually make available to the user.
1.256     matthew  1588: If file creation fails, outputs an error message on the request object and 
                   1589: return undefs.
1.113     bowersj2 1590: 
1.256     matthew  1591: Inputs: Apache request object, and file suffix
1.113     bowersj2 1592: 
1.256     matthew  1593: Returns (undef) on failure, 
                   1594:     Filehandle and filename on success.
1.113     bowersj2 1595: 
                   1596: =cut
                   1597: 
1.256     matthew  1598: ###############################################################
                   1599: ###############################################################
                   1600: sub create_text_file {
                   1601:     my ($r,$suffix) = @_;
                   1602:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1603:     my $fh;
                   1604:     my $filename = '/prtspool/'.
1.258     albertel 1605:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1606:         time.'_'.rand(1000000000).'.'.$suffix;
                   1607:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1608:     if (! defined($fh)) {
                   1609:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1610:         $r->print(&mt('Problems occurred in creating the output file. '
                   1611:                      .'This error has been logged. '
                   1612:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1613:     }
1.256     matthew  1614:     return ($fh,$filename)
1.113     bowersj2 1615: }
                   1616: 
                   1617: 
1.256     matthew  1618: =pod 
1.113     bowersj2 1619: 
                   1620: =back
                   1621: 
                   1622: =cut
1.37      matthew  1623: 
                   1624: ###############################################################
1.33      matthew  1625: ##        Home server <option> list generating code          ##
                   1626: ###############################################################
1.35      matthew  1627: 
1.169     www      1628: # ------------------------------------------
                   1629: 
                   1630: sub domain_select {
                   1631:     my ($name,$value,$multiple)=@_;
                   1632:     my %domains=map { 
1.514     albertel 1633: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1634:     } &Apache::lonnet::all_domains();
1.169     www      1635:     if ($multiple) {
                   1636: 	$domains{''}=&mt('Any domain');
1.550     albertel 1637: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1638: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1639:     } else {
1.550     albertel 1640: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1641: 	return &select_form($name,$value,%domains);
                   1642:     }
                   1643: }
                   1644: 
1.282     albertel 1645: #-------------------------------------------
                   1646: 
                   1647: =pod
                   1648: 
1.519     raeburn  1649: =head1 Routines for form select boxes
                   1650: 
                   1651: =over 4
                   1652: 
1.648     raeburn  1653: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1654: 
                   1655: Returns a string containing a <select> element int multiple mode
                   1656: 
                   1657: 
                   1658: Args:
                   1659:   $name - name of the <select> element
1.506     raeburn  1660:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1661:   $size - number of rows long the select element is
1.283     albertel 1662:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1663:           (shown text should already have been &mt())
1.506     raeburn  1664:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1665: 
1.282     albertel 1666: =cut
                   1667: 
                   1668: #-------------------------------------------
1.169     www      1669: sub multiple_select_form {
1.284     albertel 1670:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1671:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1672:     my $output='';
1.191     matthew  1673:     if (! defined($size)) {
                   1674:         $size = 4;
1.283     albertel 1675:         if (scalar(keys(%$hash))<4) {
                   1676:             $size = scalar(keys(%$hash));
1.191     matthew  1677:         }
                   1678:     }
1.734     bisitz   1679:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1680:     my @order;
1.506     raeburn  1681:     if (ref($order) eq 'ARRAY')  {
                   1682:         @order = @{$order};
                   1683:     } else {
                   1684:         @order = sort(keys(%$hash));
1.501     banghart 1685:     }
                   1686:     if (exists($$hash{'select_form_order'})) {
                   1687:         @order = @{$$hash{'select_form_order'}};
                   1688:     }
                   1689:         
1.284     albertel 1690:     foreach my $key (@order) {
1.356     albertel 1691:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1692:         $output.='selected="selected" ' if ($selected{$key});
                   1693:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1694:     }
                   1695:     $output.="</select>\n";
                   1696:     return $output;
                   1697: }
                   1698: 
1.88      www      1699: #-------------------------------------------
                   1700: 
                   1701: =pod
                   1702: 
1.648     raeburn  1703: =item * &select_form($defdom,$name,%hash)
1.88      www      1704: 
                   1705: Returns a string containing a <select name='$name' size='1'> form to 
                   1706: allow a user to select options from a hash option_name => displayed text.  
                   1707: See lonrights.pm for an example invocation and use.
                   1708: 
                   1709: =cut
                   1710: 
                   1711: #-------------------------------------------
                   1712: sub select_form {
                   1713:     my ($def,$name,%hash) = @_;
                   1714:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1715:     my @keys;
                   1716:     if (exists($hash{'select_form_order'})) {
                   1717: 	@keys=@{$hash{'select_form_order'}};
                   1718:     } else {
                   1719: 	@keys=sort(keys(%hash));
                   1720:     }
1.356     albertel 1721:     foreach my $key (@keys) {
                   1722:         $selectform.=
                   1723: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1724:             ($key eq $def ? 'selected="selected" ' : '').
                   1725:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1726:     }
                   1727:     $selectform.="</select>";
                   1728:     return $selectform;
                   1729: }
                   1730: 
1.475     www      1731: # For display filters
                   1732: 
                   1733: sub display_filter {
                   1734:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1735:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1736:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1737: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1738: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1739: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1740:            &mt('Filter [_1]',
1.477     www      1741: 	   &select_form($env{'form.displayfilter'},
                   1742: 			'displayfilter',
                   1743: 			('currentfolder' => 'Current folder/page',
                   1744: 			 'containing' => 'Containing phrase',
                   1745: 			 'none' => 'None'))).
1.714     bisitz   1746: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1747: }
                   1748: 
1.167     www      1749: sub gradeleveldescription {
                   1750:     my $gradelevel=shift;
                   1751:     my %gradelevels=(0 => 'Not specified',
                   1752: 		     1 => 'Grade 1',
                   1753: 		     2 => 'Grade 2',
                   1754: 		     3 => 'Grade 3',
                   1755: 		     4 => 'Grade 4',
                   1756: 		     5 => 'Grade 5',
                   1757: 		     6 => 'Grade 6',
                   1758: 		     7 => 'Grade 7',
                   1759: 		     8 => 'Grade 8',
                   1760: 		     9 => 'Grade 9',
                   1761: 		     10 => 'Grade 10',
                   1762: 		     11 => 'Grade 11',
                   1763: 		     12 => 'Grade 12',
                   1764: 		     13 => 'Grade 13',
                   1765: 		     14 => '100 Level',
                   1766: 		     15 => '200 Level',
                   1767: 		     16 => '300 Level',
                   1768: 		     17 => '400 Level',
                   1769: 		     18 => 'Graduate Level');
                   1770:     return &mt($gradelevels{$gradelevel});
                   1771: }
                   1772: 
1.163     www      1773: sub select_level_form {
                   1774:     my ($deflevel,$name)=@_;
                   1775:     unless ($deflevel) { $deflevel=0; }
1.167     www      1776:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1777:     for (my $i=0; $i<=18; $i++) {
                   1778:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1779:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1780:                 ">".&gradeleveldescription($i)."</option>\n";
                   1781:     }
                   1782:     $selectform.="</select>";
                   1783:     return $selectform;
1.163     www      1784: }
1.167     www      1785: 
1.35      matthew  1786: #-------------------------------------------
                   1787: 
1.45      matthew  1788: =pod
                   1789: 
1.743     raeburn  1790: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35      matthew  1791: 
                   1792: Returns a string containing a <select name='$name' size='1'> form to 
                   1793: allow a user to select the domain to preform an operation in.  
                   1794: See loncreateuser.pm for an example invocation and use.
                   1795: 
1.90      www      1796: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1797: selected");
                   1798: 
1.743     raeburn  1799: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1800: 
                   1801: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
1.563     raeburn  1802: 
1.35      matthew  1803: =cut
                   1804: 
                   1805: #-------------------------------------------
1.34      matthew  1806: sub select_dom_form {
1.743     raeburn  1807:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
                   1808:     my $onchange;
                   1809:     if ($autosubmit) {
                   1810:         $onchange = ' onchange="this.form.submit()"';
                   1811:     }
1.550     albertel 1812:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1813:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1814:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1815:     foreach my $dom (@domains) {
                   1816:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1817:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1818:         if ($showdomdesc) {
                   1819:             if ($dom ne '') {
                   1820:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1821:                 if ($domdesc ne '') {
                   1822:                     $selectdomain .= ' ('.$domdesc.')';
                   1823:                 }
                   1824:             } 
                   1825:         }
                   1826:         $selectdomain .= "</option>\n";
1.34      matthew  1827:     }
                   1828:     $selectdomain.="</select>";
                   1829:     return $selectdomain;
                   1830: }
                   1831: 
1.35      matthew  1832: #-------------------------------------------
                   1833: 
1.45      matthew  1834: =pod
                   1835: 
1.648     raeburn  1836: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1837: 
1.586     raeburn  1838: input: 4 arguments (two required, two optional) - 
                   1839:     $domain - domain of new user
                   1840:     $name - name of form element
                   1841:     $default - Value of 'default' causes a default item to be first 
                   1842:                             option, and selected by default. 
                   1843:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1844:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1845: output: returns 2 items: 
1.586     raeburn  1846: (a) form element which contains either:
                   1847:    (i) <select name="$name">
                   1848:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1849:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1850:        </select>
                   1851:        form item if there are multiple library servers in $domain, or
                   1852:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1853:        if there is only one library server in $domain.
                   1854: 
                   1855: (b) number of library servers found.
                   1856: 
                   1857: See loncreateuser.pm for example of use.
1.35      matthew  1858: 
                   1859: =cut
                   1860: 
                   1861: #-------------------------------------------
1.586     raeburn  1862: sub home_server_form_item {
                   1863:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1864:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1865:     my $result;
                   1866:     my $numlib = keys(%servers);
                   1867:     if ($numlib > 1) {
                   1868:         $result .= '<select name="'.$name.'" />'."\n";
                   1869:         if ($default) {
1.804     bisitz   1870:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1871:                        '</option>'."\n";
                   1872:         }
                   1873:         foreach my $hostid (sort(keys(%servers))) {
                   1874:             $result.= '<option value="'.$hostid.'">'.
                   1875: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1876:         }
                   1877:         $result .= '</select>'."\n";
                   1878:     } elsif ($numlib == 1) {
                   1879:         my $hostid;
                   1880:         foreach my $item (keys(%servers)) {
                   1881:             $hostid = $item;
                   1882:         }
                   1883:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1884:                    $hostid.'" />';
                   1885:                    if (!$hide) {
                   1886:                        $result .= $hostid.' '.$servers{$hostid};
                   1887:                    }
                   1888:                    $result .= "\n";
                   1889:     } elsif ($default) {
                   1890:         $result .= '<input type="hidden" name="'.$name.
                   1891:                    '" value="default" />';
                   1892:                    if (!$hide) {
                   1893:                        $result .= &mt('default');
                   1894:                    }
                   1895:                    $result .= "\n";
1.33      matthew  1896:     }
1.586     raeburn  1897:     return ($result,$numlib);
1.33      matthew  1898: }
1.112     bowersj2 1899: 
                   1900: =pod
                   1901: 
1.534     albertel 1902: =back 
                   1903: 
1.112     bowersj2 1904: =cut
1.87      matthew  1905: 
                   1906: ###############################################################
1.112     bowersj2 1907: ##                  Decoding User Agent                      ##
1.87      matthew  1908: ###############################################################
                   1909: 
                   1910: =pod
                   1911: 
1.112     bowersj2 1912: =head1 Decoding the User Agent
                   1913: 
                   1914: =over 4
                   1915: 
                   1916: =item * &decode_user_agent()
1.87      matthew  1917: 
                   1918: Inputs: $r
                   1919: 
                   1920: Outputs:
                   1921: 
                   1922: =over 4
                   1923: 
1.112     bowersj2 1924: =item * $httpbrowser
1.87      matthew  1925: 
1.112     bowersj2 1926: =item * $clientbrowser
1.87      matthew  1927: 
1.112     bowersj2 1928: =item * $clientversion
1.87      matthew  1929: 
1.112     bowersj2 1930: =item * $clientmathml
1.87      matthew  1931: 
1.112     bowersj2 1932: =item * $clientunicode
1.87      matthew  1933: 
1.112     bowersj2 1934: =item * $clientos
1.87      matthew  1935: 
                   1936: =back
                   1937: 
1.157     matthew  1938: =back 
                   1939: 
1.87      matthew  1940: =cut
                   1941: 
                   1942: ###############################################################
                   1943: ###############################################################
                   1944: sub decode_user_agent {
1.247     albertel 1945:     my ($r)=@_;
1.87      matthew  1946:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1947:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1948:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1949:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1950:     my $clientbrowser='unknown';
                   1951:     my $clientversion='0';
                   1952:     my $clientmathml='';
                   1953:     my $clientunicode='0';
                   1954:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1955:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1956: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1957: 	    $clientbrowser=$bname;
                   1958:             $httpbrowser=~/$vreg/i;
                   1959: 	    $clientversion=$1;
                   1960:             $clientmathml=($clientversion>=$minv);
                   1961:             $clientunicode=($clientversion>=$univ);
                   1962: 	}
                   1963:     }
                   1964:     my $clientos='unknown';
                   1965:     if (($httpbrowser=~/linux/i) ||
                   1966:         ($httpbrowser=~/unix/i) ||
                   1967:         ($httpbrowser=~/ux/i) ||
                   1968:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1969:     if (($httpbrowser=~/vax/i) ||
                   1970:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1971:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1972:     if (($httpbrowser=~/mac/i) ||
                   1973:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1974:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1975:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1976:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1977:             $clientunicode,$clientos,);
                   1978: }
                   1979: 
1.32      matthew  1980: ###############################################################
                   1981: ##    Authentication changing form generation subroutines    ##
                   1982: ###############################################################
                   1983: ##
                   1984: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1985: ## hash, and have reasonable default values.
                   1986: ##
                   1987: ##    formname = the name given in the <form> tag.
1.35      matthew  1988: #-------------------------------------------
                   1989: 
1.45      matthew  1990: =pod
                   1991: 
1.112     bowersj2 1992: =head1 Authentication Routines
                   1993: 
                   1994: =over 4
                   1995: 
1.648     raeburn  1996: =item * &authform_xxxxxx()
1.35      matthew  1997: 
                   1998: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1999: handle some of the conveniences required for authentication forms.  
                   2000: This is not an optimal method, but it works.  
                   2001: 
                   2002: =over 4
                   2003: 
1.112     bowersj2 2004: =item * authform_header
1.35      matthew  2005: 
1.112     bowersj2 2006: =item * authform_authorwarning
1.35      matthew  2007: 
1.112     bowersj2 2008: =item * authform_nochange
1.35      matthew  2009: 
1.112     bowersj2 2010: =item * authform_kerberos
1.35      matthew  2011: 
1.112     bowersj2 2012: =item * authform_internal
1.35      matthew  2013: 
1.112     bowersj2 2014: =item * authform_filesystem
1.35      matthew  2015: 
                   2016: =back
                   2017: 
1.648     raeburn  2018: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2019: 
1.35      matthew  2020: =cut
                   2021: 
                   2022: #-------------------------------------------
1.32      matthew  2023: sub authform_header{  
                   2024:     my %in = (
                   2025:         formname => 'cu',
1.80      albertel 2026:         kerb_def_dom => '',
1.32      matthew  2027:         @_,
                   2028:     );
                   2029:     $in{'formname'} = 'document.' . $in{'formname'};
                   2030:     my $result='';
1.80      albertel 2031: 
                   2032: #---------------------------------------------- Code for upper case translation
                   2033:     my $Javascript_toUpperCase;
                   2034:     unless ($in{kerb_def_dom}) {
                   2035:         $Javascript_toUpperCase =<<"END";
                   2036:         switch (choice) {
                   2037:            case 'krb': currentform.elements[choicearg].value =
                   2038:                currentform.elements[choicearg].value.toUpperCase();
                   2039:                break;
                   2040:            default:
                   2041:         }
                   2042: END
                   2043:     } else {
                   2044:         $Javascript_toUpperCase = "";
                   2045:     }
                   2046: 
1.165     raeburn  2047:     my $radioval = "'nochange'";
1.591     raeburn  2048:     if (defined($in{'curr_authtype'})) {
                   2049:         if ($in{'curr_authtype'} ne '') {
                   2050:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2051:         }
1.174     matthew  2052:     }
1.165     raeburn  2053:     my $argfield = 'null';
1.591     raeburn  2054:     if (defined($in{'mode'})) {
1.165     raeburn  2055:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2056:             if (defined($in{'curr_autharg'})) {
                   2057:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2058:                     $argfield = "'$in{'curr_autharg'}'";
                   2059:                 }
                   2060:             }
                   2061:         }
                   2062:     }
                   2063: 
1.32      matthew  2064:     $result.=<<"END";
                   2065: var current = new Object();
1.165     raeburn  2066: current.radiovalue = $radioval;
                   2067: current.argfield = $argfield;
1.32      matthew  2068: 
                   2069: function changed_radio(choice,currentform) {
                   2070:     var choicearg = choice + 'arg';
                   2071:     // If a radio button in changed, we need to change the argfield
                   2072:     if (current.radiovalue != choice) {
                   2073:         current.radiovalue = choice;
                   2074:         if (current.argfield != null) {
                   2075:             currentform.elements[current.argfield].value = '';
                   2076:         }
                   2077:         if (choice == 'nochange') {
                   2078:             current.argfield = null;
                   2079:         } else {
                   2080:             current.argfield = choicearg;
                   2081:             switch(choice) {
                   2082:                 case 'krb': 
                   2083:                     currentform.elements[current.argfield].value = 
                   2084:                         "$in{'kerb_def_dom'}";
                   2085:                 break;
                   2086:               default:
                   2087:                 break;
                   2088:             }
                   2089:         }
                   2090:     }
                   2091:     return;
                   2092: }
1.22      www      2093: 
1.32      matthew  2094: function changed_text(choice,currentform) {
                   2095:     var choicearg = choice + 'arg';
                   2096:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2097:         $Javascript_toUpperCase
1.32      matthew  2098:         // clear old field
                   2099:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2100:             currentform.elements[current.argfield].value = '';
                   2101:         }
                   2102:         current.argfield = choicearg;
                   2103:     }
                   2104:     set_auth_radio_buttons(choice,currentform);
                   2105:     return;
1.20      www      2106: }
1.32      matthew  2107: 
                   2108: function set_auth_radio_buttons(newvalue,currentform) {
                   2109:     var i=0;
                   2110:     while (i < currentform.login.length) {
                   2111:         if (currentform.login[i].value == newvalue) { break; }
                   2112:         i++;
                   2113:     }
                   2114:     if (i == currentform.login.length) {
                   2115:         return;
                   2116:     }
                   2117:     current.radiovalue = newvalue;
                   2118:     currentform.login[i].checked = true;
                   2119:     return;
                   2120: }
                   2121: END
                   2122:     return $result;
                   2123: }
                   2124: 
                   2125: sub authform_authorwarning{
                   2126:     my $result='';
1.144     matthew  2127:     $result='<i>'.
                   2128:         &mt('As a general rule, only authors or co-authors should be '.
                   2129:             'filesystem authenticated '.
                   2130:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2131:     return $result;
                   2132: }
                   2133: 
                   2134: sub authform_nochange{  
                   2135:     my %in = (
                   2136:               formname => 'document.cu',
                   2137:               kerb_def_dom => 'MSU.EDU',
                   2138:               @_,
                   2139:           );
1.586     raeburn  2140:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2141:     my $result;
                   2142:     if (keys(%can_assign) == 0) {
                   2143:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2144:     } else {
                   2145:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2146:                   '<input type="radio" name="login" value="nochange" '.
                   2147:                   'checked="checked" onclick="'.
1.281     albertel 2148:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2149: 	    '</label>';
1.586     raeburn  2150:     }
1.32      matthew  2151:     return $result;
                   2152: }
                   2153: 
1.591     raeburn  2154: sub authform_kerberos {
1.32      matthew  2155:     my %in = (
                   2156:               formname => 'document.cu',
                   2157:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2158:               kerb_def_auth => 'krb4',
1.32      matthew  2159:               @_,
                   2160:               );
1.586     raeburn  2161:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2162:         $autharg,$jscall);
                   2163:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2164:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2165:        $check5 = ' checked="checked"';
1.80      albertel 2166:     } else {
1.772     bisitz   2167:        $check4 = ' checked="checked"';
1.80      albertel 2168:     }
1.165     raeburn  2169:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2170:     if (defined($in{'curr_authtype'})) {
                   2171:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2172:             $krbcheck = ' checked="checked"';
1.623     raeburn  2173:             if (defined($in{'mode'})) {
                   2174:                 if ($in{'mode'} eq 'modifyuser') {
                   2175:                     $krbcheck = '';
                   2176:                 }
                   2177:             }
1.591     raeburn  2178:             if (defined($in{'curr_kerb_ver'})) {
                   2179:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2180:                     $check5 = ' checked="checked"';
1.591     raeburn  2181:                     $check4 = '';
                   2182:                 } else {
1.772     bisitz   2183:                     $check4 = ' checked="checked"';
1.591     raeburn  2184:                     $check5 = '';
                   2185:                 }
1.586     raeburn  2186:             }
1.591     raeburn  2187:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2188:                 $krbarg = $in{'curr_autharg'};
                   2189:             }
1.586     raeburn  2190:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2191:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2192:                     $result = 
                   2193:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2194:         $in{'curr_autharg'},$krbver);
                   2195:                 } else {
                   2196:                     $result =
                   2197:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2198:                 }
                   2199:                 return $result; 
                   2200:             }
                   2201:         }
                   2202:     } else {
                   2203:         if ($authnum == 1) {
1.784     bisitz   2204:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2205:         }
                   2206:     }
1.586     raeburn  2207:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2208:         return;
1.587     raeburn  2209:     } elsif ($authtype eq '') {
1.591     raeburn  2210:         if (defined($in{'mode'})) {
1.587     raeburn  2211:             if ($in{'mode'} eq 'modifycourse') {
                   2212:                 if ($authnum == 1) {
1.784     bisitz   2213:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2214:                 }
                   2215:             }
                   2216:         }
1.586     raeburn  2217:     }
                   2218:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2219:     if ($authtype eq '') {
                   2220:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2221:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2222:                     $krbcheck.' />';
                   2223:     }
                   2224:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2225:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2226:          $in{'curr_authtype'} eq 'krb5') ||
                   2227:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2228:          $in{'curr_authtype'} eq 'krb4')) {
                   2229:         $result .= &mt
1.144     matthew  2230:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2231:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2232:          '<label>'.$authtype,
1.281     albertel 2233:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2234:              'value="'.$krbarg.'" '.
1.144     matthew  2235:              'onchange="'.$jscall.'" />',
1.281     albertel 2236:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2237:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2238: 	 '</label>');
1.586     raeburn  2239:     } elsif ($can_assign{'krb4'}) {
                   2240:         $result .= &mt
                   2241:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2242:          '[_3] Version 4 [_4]',
                   2243:          '<label>'.$authtype,
                   2244:          '</label><input type="text" size="10" name="krbarg" '.
                   2245:              'value="'.$krbarg.'" '.
                   2246:              'onchange="'.$jscall.'" />',
                   2247:          '<label><input type="hidden" name="krbver" value="4" />',
                   2248:          '</label>');
                   2249:     } elsif ($can_assign{'krb5'}) {
                   2250:         $result .= &mt
                   2251:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2252:          '[_3] Version 5 [_4]',
                   2253:          '<label>'.$authtype,
                   2254:          '</label><input type="text" size="10" name="krbarg" '.
                   2255:              'value="'.$krbarg.'" '.
                   2256:              'onchange="'.$jscall.'" />',
                   2257:          '<label><input type="hidden" name="krbver" value="5" />',
                   2258:          '</label>');
                   2259:     }
1.32      matthew  2260:     return $result;
                   2261: }
                   2262: 
                   2263: sub authform_internal{  
1.586     raeburn  2264:     my %in = (
1.32      matthew  2265:                 formname => 'document.cu',
                   2266:                 kerb_def_dom => 'MSU.EDU',
                   2267:                 @_,
                   2268:                 );
1.586     raeburn  2269:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2270:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2271:     if (defined($in{'curr_authtype'})) {
                   2272:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2273:             if ($can_assign{'int'}) {
1.772     bisitz   2274:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2275:                 if (defined($in{'mode'})) {
                   2276:                     if ($in{'mode'} eq 'modifyuser') {
                   2277:                         $intcheck = '';
                   2278:                     }
                   2279:                 }
1.591     raeburn  2280:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2281:                     $intarg = $in{'curr_autharg'};
                   2282:                 }
                   2283:             } else {
                   2284:                 $result = &mt('Currently internally authenticated.');
                   2285:                 return $result;
1.165     raeburn  2286:             }
                   2287:         }
1.586     raeburn  2288:     } else {
                   2289:         if ($authnum == 1) {
1.784     bisitz   2290:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2291:         }
                   2292:     }
                   2293:     if (!$can_assign{'int'}) {
                   2294:         return;
1.587     raeburn  2295:     } elsif ($authtype eq '') {
1.591     raeburn  2296:         if (defined($in{'mode'})) {
1.587     raeburn  2297:             if ($in{'mode'} eq 'modifycourse') {
                   2298:                 if ($authnum == 1) {
1.784     bisitz   2299:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2300:                 }
                   2301:             }
                   2302:         }
1.165     raeburn  2303:     }
1.586     raeburn  2304:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2305:     if ($authtype eq '') {
                   2306:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2307:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2308:     }
1.605     bisitz   2309:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2310:                $intarg.'" onchange="'.$jscall.'" />';
                   2311:     $result = &mt
1.144     matthew  2312:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2313:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2314:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2315:     return $result;
                   2316: }
                   2317: 
                   2318: sub authform_local{  
                   2319:     my %in = (
                   2320:               formname => 'document.cu',
                   2321:               kerb_def_dom => 'MSU.EDU',
                   2322:               @_,
                   2323:               );
1.586     raeburn  2324:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2325:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2326:     if (defined($in{'curr_authtype'})) {
                   2327:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2328:             if ($can_assign{'loc'}) {
1.772     bisitz   2329:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2330:                 if (defined($in{'mode'})) {
                   2331:                     if ($in{'mode'} eq 'modifyuser') {
                   2332:                         $loccheck = '';
                   2333:                     }
                   2334:                 }
1.591     raeburn  2335:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2336:                     $locarg = $in{'curr_autharg'};
                   2337:                 }
                   2338:             } else {
                   2339:                 $result = &mt('Currently using local (institutional) authentication.');
                   2340:                 return $result;
1.165     raeburn  2341:             }
                   2342:         }
1.586     raeburn  2343:     } else {
                   2344:         if ($authnum == 1) {
1.784     bisitz   2345:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2346:         }
                   2347:     }
                   2348:     if (!$can_assign{'loc'}) {
                   2349:         return;
1.587     raeburn  2350:     } elsif ($authtype eq '') {
1.591     raeburn  2351:         if (defined($in{'mode'})) {
1.587     raeburn  2352:             if ($in{'mode'} eq 'modifycourse') {
                   2353:                 if ($authnum == 1) {
1.784     bisitz   2354:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2355:                 }
                   2356:             }
                   2357:         }
1.165     raeburn  2358:     }
1.586     raeburn  2359:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2360:     if ($authtype eq '') {
                   2361:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2362:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2363:                     $jscall.'" />';
                   2364:     }
                   2365:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2366:                $locarg.'" onchange="'.$jscall.'" />';
                   2367:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2368:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2369:     return $result;
                   2370: }
                   2371: 
                   2372: sub authform_filesystem{  
                   2373:     my %in = (
                   2374:               formname => 'document.cu',
                   2375:               kerb_def_dom => 'MSU.EDU',
                   2376:               @_,
                   2377:               );
1.586     raeburn  2378:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2379:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2380:     if (defined($in{'curr_authtype'})) {
                   2381:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2382:             if ($can_assign{'fsys'}) {
1.772     bisitz   2383:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2384:                 if (defined($in{'mode'})) {
                   2385:                     if ($in{'mode'} eq 'modifyuser') {
                   2386:                         $fsyscheck = '';
                   2387:                     }
                   2388:                 }
1.586     raeburn  2389:             } else {
                   2390:                 $result = &mt('Currently Filesystem Authenticated.');
                   2391:                 return $result;
                   2392:             }           
                   2393:         }
                   2394:     } else {
                   2395:         if ($authnum == 1) {
1.784     bisitz   2396:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2397:         }
                   2398:     }
                   2399:     if (!$can_assign{'fsys'}) {
                   2400:         return;
1.587     raeburn  2401:     } elsif ($authtype eq '') {
1.591     raeburn  2402:         if (defined($in{'mode'})) {
1.587     raeburn  2403:             if ($in{'mode'} eq 'modifycourse') {
                   2404:                 if ($authnum == 1) {
1.784     bisitz   2405:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2406:                 }
                   2407:             }
                   2408:         }
1.586     raeburn  2409:     }
                   2410:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2411:     if ($authtype eq '') {
                   2412:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2413:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2414:                     $jscall.'" />';
                   2415:     }
                   2416:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2417:                ' onchange="'.$jscall.'" />';
                   2418:     $result = &mt
1.144     matthew  2419:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2420:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2421:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2422:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2423:                   'onchange="'.$jscall.'" />');
1.32      matthew  2424:     return $result;
                   2425: }
                   2426: 
1.586     raeburn  2427: sub get_assignable_auth {
                   2428:     my ($dom) = @_;
                   2429:     if ($dom eq '') {
                   2430:         $dom = $env{'request.role.domain'};
                   2431:     }
                   2432:     my %can_assign = (
                   2433:                           krb4 => 1,
                   2434:                           krb5 => 1,
                   2435:                           int  => 1,
                   2436:                           loc  => 1,
                   2437:                      );
                   2438:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2439:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2440:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2441:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2442:             my $context;
                   2443:             if ($env{'request.role'} =~ /^au/) {
                   2444:                 $context = 'author';
                   2445:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2446:                 $context = 'domain';
                   2447:             } elsif ($env{'request.course.id'}) {
                   2448:                 $context = 'course';
                   2449:             }
                   2450:             if ($context) {
                   2451:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2452:                    %can_assign = %{$authhash->{$context}}; 
                   2453:                 }
                   2454:             }
                   2455:         }
                   2456:     }
                   2457:     my $authnum = 0;
                   2458:     foreach my $key (keys(%can_assign)) {
                   2459:         if ($can_assign{$key}) {
                   2460:             $authnum ++;
                   2461:         }
                   2462:     }
                   2463:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2464:         $authnum --;
                   2465:     }
                   2466:     return ($authnum,%can_assign);
                   2467: }
                   2468: 
1.80      albertel 2469: ###############################################################
                   2470: ##    Get Kerberos Defaults for Domain                 ##
                   2471: ###############################################################
                   2472: ##
                   2473: ## Returns default kerberos version and an associated argument
                   2474: ## as listed in file domain.tab. If not listed, provides
                   2475: ## appropriate default domain and kerberos version.
                   2476: ##
                   2477: #-------------------------------------------
                   2478: 
                   2479: =pod
                   2480: 
1.648     raeburn  2481: =item * &get_kerberos_defaults()
1.80      albertel 2482: 
                   2483: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2484: version and domain. If not found, it defaults to version 4 and the 
                   2485: domain of the server.
1.80      albertel 2486: 
1.648     raeburn  2487: =over 4
                   2488: 
1.80      albertel 2489: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2490: 
1.648     raeburn  2491: =back
                   2492: 
                   2493: =back
                   2494: 
1.80      albertel 2495: =cut
                   2496: 
                   2497: #-------------------------------------------
                   2498: sub get_kerberos_defaults {
                   2499:     my $domain=shift;
1.641     raeburn  2500:     my ($krbdef,$krbdefdom);
                   2501:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2502:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2503:         $krbdef = $domdefaults{'auth_def'};
                   2504:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2505:     } else {
1.80      albertel 2506:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2507:         my $krbdefdom=$1;
                   2508:         $krbdefdom=~tr/a-z/A-Z/;
                   2509:         $krbdef = "krb4";
                   2510:     }
                   2511:     return ($krbdef,$krbdefdom);
                   2512: }
1.112     bowersj2 2513: 
1.32      matthew  2514: 
1.46      matthew  2515: ###############################################################
                   2516: ##                Thesaurus Functions                        ##
                   2517: ###############################################################
1.20      www      2518: 
1.46      matthew  2519: =pod
1.20      www      2520: 
1.112     bowersj2 2521: =head1 Thesaurus Functions
                   2522: 
                   2523: =over 4
                   2524: 
1.648     raeburn  2525: =item * &initialize_keywords()
1.46      matthew  2526: 
                   2527: Initializes the package variable %Keywords if it is empty.  Uses the
                   2528: package variable $thesaurus_db_file.
                   2529: 
                   2530: =cut
                   2531: 
                   2532: ###################################################
                   2533: 
                   2534: sub initialize_keywords {
                   2535:     return 1 if (scalar keys(%Keywords));
                   2536:     # If we are here, %Keywords is empty, so fill it up
                   2537:     #   Make sure the file we need exists...
                   2538:     if (! -e $thesaurus_db_file) {
                   2539:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2540:                                  " failed because it does not exist");
                   2541:         return 0;
                   2542:     }
                   2543:     #   Set up the hash as a database
                   2544:     my %thesaurus_db;
                   2545:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2546:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2547:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2548:                                  $thesaurus_db_file);
                   2549:         return 0;
                   2550:     } 
                   2551:     #  Get the average number of appearances of a word.
                   2552:     my $avecount = $thesaurus_db{'average.count'};
                   2553:     #  Put keywords (those that appear > average) into %Keywords
                   2554:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2555:         my ($count,undef) = split /:/,$data;
                   2556:         $Keywords{$word}++ if ($count > $avecount);
                   2557:     }
                   2558:     untie %thesaurus_db;
                   2559:     # Remove special values from %Keywords.
1.356     albertel 2560:     foreach my $value ('total.count','average.count') {
                   2561:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2562:   }
1.46      matthew  2563:     return 1;
                   2564: }
                   2565: 
                   2566: ###################################################
                   2567: 
                   2568: =pod
                   2569: 
1.648     raeburn  2570: =item * &keyword($word)
1.46      matthew  2571: 
                   2572: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2573: than the average number of times in the thesaurus database.  Calls 
                   2574: &initialize_keywords
                   2575: 
                   2576: =cut
                   2577: 
                   2578: ###################################################
1.20      www      2579: 
                   2580: sub keyword {
1.46      matthew  2581:     return if (!&initialize_keywords());
                   2582:     my $word=lc(shift());
                   2583:     $word=~s/\W//g;
                   2584:     return exists($Keywords{$word});
1.20      www      2585: }
1.46      matthew  2586: 
                   2587: ###############################################################
                   2588: 
                   2589: =pod 
1.20      www      2590: 
1.648     raeburn  2591: =item * &get_related_words()
1.46      matthew  2592: 
1.160     matthew  2593: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2594: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2595: will be returned.  The order of the words returned is determined by the
                   2596: database which holds them.
                   2597: 
                   2598: Uses global $thesaurus_db_file.
                   2599: 
                   2600: =cut
                   2601: 
                   2602: ###############################################################
                   2603: sub get_related_words {
                   2604:     my $keyword = shift;
                   2605:     my %thesaurus_db;
                   2606:     if (! -e $thesaurus_db_file) {
                   2607:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2608:                                  "failed because the file does not exist");
                   2609:         return ();
                   2610:     }
                   2611:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2612:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2613:         return ();
                   2614:     } 
                   2615:     my @Words=();
1.429     www      2616:     my $count=0;
1.46      matthew  2617:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2618: 	# The first element is the number of times
                   2619: 	# the word appears.  We do not need it now.
1.429     www      2620: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2621: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2622: 	my $threshold=$mostfrequentcount/10;
                   2623:         foreach my $possibleword (@RelatedWords) {
                   2624:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2625:             if ($wordcount>$threshold) {
                   2626: 		push(@Words,$word);
                   2627:                 $count++;
                   2628:                 if ($count>10) { last; }
                   2629: 	    }
1.20      www      2630:         }
                   2631:     }
1.46      matthew  2632:     untie %thesaurus_db;
                   2633:     return @Words;
1.14      harris41 2634: }
1.46      matthew  2635: 
1.112     bowersj2 2636: =pod
                   2637: 
                   2638: =back
                   2639: 
                   2640: =cut
1.61      www      2641: 
                   2642: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2643: =pod
                   2644: 
1.112     bowersj2 2645: =head1 User Name Functions
                   2646: 
                   2647: =over 4
                   2648: 
1.648     raeburn  2649: =item * &plainname($uname,$udom,$first)
1.81      albertel 2650: 
1.112     bowersj2 2651: Takes a users logon name and returns it as a string in
1.226     albertel 2652: "first middle last generation" form 
                   2653: if $first is set to 'lastname' then it returns it as
                   2654: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2655: 
                   2656: =cut
1.61      www      2657: 
1.295     www      2658: 
1.81      albertel 2659: ###############################################################
1.61      www      2660: sub plainname {
1.226     albertel 2661:     my ($uname,$udom,$first)=@_;
1.537     albertel 2662:     return if (!defined($uname) || !defined($udom));
1.295     www      2663:     my %names=&getnames($uname,$udom);
1.226     albertel 2664:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2665: 					  $names{'middlename'},
                   2666: 					  $names{'lastname'},
                   2667: 					  $names{'generation'},$first);
                   2668:     $name=~s/^\s+//;
1.62      www      2669:     $name=~s/\s+$//;
                   2670:     $name=~s/\s+/ /g;
1.353     albertel 2671:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2672:     return $name;
1.61      www      2673: }
1.66      www      2674: 
                   2675: # -------------------------------------------------------------------- Nickname
1.81      albertel 2676: =pod
                   2677: 
1.648     raeburn  2678: =item * &nickname($uname,$udom)
1.81      albertel 2679: 
                   2680: Gets a users name and returns it as a string as
                   2681: 
                   2682: "&quot;nickname&quot;"
1.66      www      2683: 
1.81      albertel 2684: if the user has a nickname or
                   2685: 
                   2686: "first middle last generation"
                   2687: 
                   2688: if the user does not
                   2689: 
                   2690: =cut
1.66      www      2691: 
                   2692: sub nickname {
                   2693:     my ($uname,$udom)=@_;
1.537     albertel 2694:     return if (!defined($uname) || !defined($udom));
1.295     www      2695:     my %names=&getnames($uname,$udom);
1.68      albertel 2696:     my $name=$names{'nickname'};
1.66      www      2697:     if ($name) {
                   2698:        $name='&quot;'.$name.'&quot;'; 
                   2699:     } else {
                   2700:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2701: 	     $names{'lastname'}.' '.$names{'generation'};
                   2702:        $name=~s/\s+$//;
                   2703:        $name=~s/\s+/ /g;
                   2704:     }
                   2705:     return $name;
                   2706: }
                   2707: 
1.295     www      2708: sub getnames {
                   2709:     my ($uname,$udom)=@_;
1.537     albertel 2710:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2711:     if ($udom eq 'public' && $uname eq 'public') {
                   2712: 	return ('lastname' => &mt('Public'));
                   2713:     }
1.295     www      2714:     my $id=$uname.':'.$udom;
                   2715:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2716:     if ($cached) {
                   2717: 	return %{$names};
                   2718:     } else {
                   2719: 	my %loadnames=&Apache::lonnet::get('environment',
                   2720:                     ['firstname','middlename','lastname','generation','nickname'],
                   2721: 					 $udom,$uname);
                   2722: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2723: 	return %loadnames;
                   2724:     }
                   2725: }
1.61      www      2726: 
1.542     raeburn  2727: # -------------------------------------------------------------------- getemails
1.648     raeburn  2728: 
1.542     raeburn  2729: =pod
                   2730: 
1.648     raeburn  2731: =item * &getemails($uname,$udom)
1.542     raeburn  2732: 
                   2733: Gets a user's email information and returns it as a hash with keys:
                   2734: notification, critnotification, permanentemail
                   2735: 
                   2736: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2737: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2738:  
1.648     raeburn  2739: 
1.542     raeburn  2740: =cut
                   2741: 
1.648     raeburn  2742: 
1.466     albertel 2743: sub getemails {
                   2744:     my ($uname,$udom)=@_;
                   2745:     if ($udom eq 'public' && $uname eq 'public') {
                   2746: 	return;
                   2747:     }
1.467     www      2748:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2749:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2750:     my $id=$uname.':'.$udom;
                   2751:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2752:     if ($cached) {
                   2753: 	return %{$names};
                   2754:     } else {
                   2755: 	my %loadnames=&Apache::lonnet::get('environment',
                   2756:                     			   ['notification','critnotification',
                   2757: 					    'permanentemail'],
                   2758: 					   $udom,$uname);
                   2759: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2760: 	return %loadnames;
                   2761:     }
                   2762: }
                   2763: 
1.551     albertel 2764: sub flush_email_cache {
                   2765:     my ($uname,$udom)=@_;
                   2766:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2767:     if (!$uname) { $uname=$env{'user.name'};   }
                   2768:     return if ($udom eq 'public' && $uname eq 'public');
                   2769:     my $id=$uname.':'.$udom;
                   2770:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2771: }
                   2772: 
1.728     raeburn  2773: # -------------------------------------------------------------------- getlangs
                   2774: 
                   2775: =pod
                   2776: 
                   2777: =item * &getlangs($uname,$udom)
                   2778: 
                   2779: Gets a user's language preference and returns it as a hash with key:
                   2780: language.
                   2781: 
                   2782: =cut
                   2783: 
                   2784: 
                   2785: sub getlangs {
                   2786:     my ($uname,$udom) = @_;
                   2787:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2788:     if (!$uname) { $uname=$env{'user.name'};   }
                   2789:     my $id=$uname.':'.$udom;
                   2790:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2791:     if ($cached) {
                   2792:         return %{$langs};
                   2793:     } else {
                   2794:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2795:                                            $udom,$uname);
                   2796:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2797:         return %loadlangs;
                   2798:     }
                   2799: }
                   2800: 
                   2801: sub flush_langs_cache {
                   2802:     my ($uname,$udom)=@_;
                   2803:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2804:     if (!$uname) { $uname=$env{'user.name'};   }
                   2805:     return if ($udom eq 'public' && $uname eq 'public');
                   2806:     my $id=$uname.':'.$udom;
                   2807:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2808: }
                   2809: 
1.61      www      2810: # ------------------------------------------------------------------ Screenname
1.81      albertel 2811: 
                   2812: =pod
                   2813: 
1.648     raeburn  2814: =item * &screenname($uname,$udom)
1.81      albertel 2815: 
                   2816: Gets a users screenname and returns it as a string
                   2817: 
                   2818: =cut
1.61      www      2819: 
                   2820: sub screenname {
                   2821:     my ($uname,$udom)=@_;
1.258     albertel 2822:     if ($uname eq $env{'user.name'} &&
                   2823: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2824:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2825:     return $names{'screenname'};
1.62      www      2826: }
                   2827: 
1.212     albertel 2828: 
1.802     bisitz   2829: # ------------------------------------------------------------- Confirm Wrapper
                   2830: =pod
                   2831: 
                   2832: =item confirmwrapper
                   2833: 
                   2834: Wrap messages about completion of operation in box
                   2835: 
                   2836: =cut
                   2837: 
                   2838: sub confirmwrapper {
                   2839:     my ($message)=@_;
                   2840:     if ($message) {
                   2841:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2842:                .$message."\n"
                   2843:                .'</div>'."\n";
                   2844:     } else {
                   2845:         return $message;
                   2846:     }
                   2847: }
                   2848: 
1.62      www      2849: # ------------------------------------------------------------- Message Wrapper
                   2850: 
                   2851: sub messagewrapper {
1.369     www      2852:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2853:     return 
1.441     albertel 2854:         '<a href="/adm/email?compose=individual&amp;'.
                   2855:         'recname='.$username.'&amp;recdom='.$domain.
                   2856: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2857:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2858: }
1.802     bisitz   2859: 
1.74      www      2860: # --------------------------------------------------------------- Notes Wrapper
                   2861: 
                   2862: sub noteswrapper {
                   2863:     my ($link,$un,$do)=@_;
                   2864:     return 
                   2865: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2866: }
1.802     bisitz   2867: 
1.62      www      2868: # ------------------------------------------------------------- Aboutme Wrapper
                   2869: 
                   2870: sub aboutmewrapper {
1.166     www      2871:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2872:     if (!defined($username)  && !defined($domain)) {
                   2873:         return;
                   2874:     }
1.205     www      2875:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756     weissno  2876: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2877: }
                   2878: 
                   2879: # ------------------------------------------------------------ Syllabus Wrapper
                   2880: 
                   2881: sub syllabuswrapper {
1.707     bisitz   2882:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2883:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2884: }
1.14      harris41 2885: 
1.802     bisitz   2886: # -----------------------------------------------------------------------------
                   2887: 
1.208     matthew  2888: sub track_student_link {
1.268     albertel 2889:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2890:     my $link ="/adm/trackstudent?";
1.208     matthew  2891:     my $title = 'View recent activity';
                   2892:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2893:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2894:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2895:         $title .= ' of this student';
1.268     albertel 2896:     } 
1.208     matthew  2897:     if (defined($target) && $target !~ /^\s*$/) {
                   2898:         $target = qq{target="$target"};
                   2899:     } else {
                   2900:         $target = '';
                   2901:     }
1.268     albertel 2902:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2903:     $title = &mt($title);
                   2904:     $linktext = &mt($linktext);
1.448     albertel 2905:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2906: 	&help_open_topic('View_recent_activity');
1.208     matthew  2907: }
                   2908: 
1.781     raeburn  2909: sub slot_reservations_link {
                   2910:     my ($linktext,$sname,$sdom,$target) = @_;
                   2911:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   2912:     my $title = 'View slot reservation history';
                   2913:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2914:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   2915:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   2916:         $title .= ' of this student';
                   2917:     }
                   2918:     if (defined($target) && $target !~ /^\s*$/) {
                   2919:         $target = qq{target="$target"};
                   2920:     } else {
                   2921:         $target = '';
                   2922:     }
                   2923:     $title = &mt($title);
                   2924:     $linktext = &mt($linktext);
                   2925:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2926: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   2927: 
                   2928: }
                   2929: 
1.508     www      2930: # ===================================================== Display a student photo
                   2931: 
                   2932: 
1.509     albertel 2933: sub student_image_tag {
1.508     www      2934:     my ($domain,$user)=@_;
                   2935:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2936:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2937: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2938:     } else {
                   2939: 	return '';
                   2940:     }
                   2941: }
                   2942: 
1.112     bowersj2 2943: =pod
                   2944: 
                   2945: =back
                   2946: 
                   2947: =head1 Access .tab File Data
                   2948: 
                   2949: =over 4
                   2950: 
1.648     raeburn  2951: =item * &languageids() 
1.112     bowersj2 2952: 
                   2953: returns list of all language ids
                   2954: 
                   2955: =cut
                   2956: 
1.14      harris41 2957: sub languageids {
1.16      harris41 2958:     return sort(keys(%language));
1.14      harris41 2959: }
                   2960: 
1.112     bowersj2 2961: =pod
                   2962: 
1.648     raeburn  2963: =item * &languagedescription() 
1.112     bowersj2 2964: 
                   2965: returns description of a specified language id
                   2966: 
                   2967: =cut
                   2968: 
1.14      harris41 2969: sub languagedescription {
1.125     www      2970:     my $code=shift;
                   2971:     return  ($supported_language{$code}?'* ':'').
                   2972:             $language{$code}.
1.126     www      2973: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2974: }
                   2975: 
                   2976: sub plainlanguagedescription {
                   2977:     my $code=shift;
                   2978:     return $language{$code};
                   2979: }
                   2980: 
                   2981: sub supportedlanguagecode {
                   2982:     my $code=shift;
                   2983:     return $supported_language{$code};
1.97      www      2984: }
                   2985: 
1.112     bowersj2 2986: =pod
                   2987: 
1.648     raeburn  2988: =item * &copyrightids() 
1.112     bowersj2 2989: 
                   2990: returns list of all copyrights
                   2991: 
                   2992: =cut
                   2993: 
                   2994: sub copyrightids {
                   2995:     return sort(keys(%cprtag));
                   2996: }
                   2997: 
                   2998: =pod
                   2999: 
1.648     raeburn  3000: =item * &copyrightdescription() 
1.112     bowersj2 3001: 
                   3002: returns description of a specified copyright id
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub copyrightdescription {
1.166     www      3007:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3008: }
1.197     matthew  3009: 
                   3010: =pod
                   3011: 
1.648     raeburn  3012: =item * &source_copyrightids() 
1.192     taceyjo1 3013: 
                   3014: returns list of all source copyrights
                   3015: 
                   3016: =cut
                   3017: 
                   3018: sub source_copyrightids {
                   3019:     return sort(keys(%scprtag));
                   3020: }
                   3021: 
                   3022: =pod
                   3023: 
1.648     raeburn  3024: =item * &source_copyrightdescription() 
1.192     taceyjo1 3025: 
                   3026: returns description of a specified source copyright id
                   3027: 
                   3028: =cut
                   3029: 
                   3030: sub source_copyrightdescription {
                   3031:     return &mt($scprtag{shift(@_)});
                   3032: }
1.112     bowersj2 3033: 
                   3034: =pod
                   3035: 
1.648     raeburn  3036: =item * &filecategories() 
1.112     bowersj2 3037: 
                   3038: returns list of all file categories
                   3039: 
                   3040: =cut
                   3041: 
                   3042: sub filecategories {
                   3043:     return sort(keys(%category_extensions));
                   3044: }
                   3045: 
                   3046: =pod
                   3047: 
1.648     raeburn  3048: =item * &filecategorytypes() 
1.112     bowersj2 3049: 
                   3050: returns list of file types belonging to a given file
                   3051: category
                   3052: 
                   3053: =cut
                   3054: 
                   3055: sub filecategorytypes {
1.356     albertel 3056:     my ($cat) = @_;
                   3057:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3058: }
                   3059: 
                   3060: =pod
                   3061: 
1.648     raeburn  3062: =item * &fileembstyle() 
1.112     bowersj2 3063: 
                   3064: returns embedding style for a specified file type
                   3065: 
                   3066: =cut
                   3067: 
                   3068: sub fileembstyle {
                   3069:     return $fe{lc(shift(@_))};
1.169     www      3070: }
                   3071: 
1.351     www      3072: sub filemimetype {
                   3073:     return $fm{lc(shift(@_))};
                   3074: }
                   3075: 
1.169     www      3076: 
                   3077: sub filecategoryselect {
                   3078:     my ($name,$value)=@_;
1.189     matthew  3079:     return &select_form($value,$name,
1.169     www      3080: 			'' => &mt('Any category'),
                   3081: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3082: }
                   3083: 
                   3084: =pod
                   3085: 
1.648     raeburn  3086: =item * &filedescription() 
1.112     bowersj2 3087: 
                   3088: returns description for a specified file type
                   3089: 
                   3090: =cut
                   3091: 
                   3092: sub filedescription {
1.188     matthew  3093:     my $file_description = $fd{lc(shift())};
                   3094:     $file_description =~ s:([\[\]]):~$1:g;
                   3095:     return &mt($file_description);
1.112     bowersj2 3096: }
                   3097: 
                   3098: =pod
                   3099: 
1.648     raeburn  3100: =item * &filedescriptionex() 
1.112     bowersj2 3101: 
                   3102: returns description for a specified file type with
                   3103: extra formatting
                   3104: 
                   3105: =cut
                   3106: 
                   3107: sub filedescriptionex {
                   3108:     my $ex=shift;
1.188     matthew  3109:     my $file_description = $fd{lc($ex)};
                   3110:     $file_description =~ s:([\[\]]):~$1:g;
                   3111:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3112: }
                   3113: 
                   3114: # End of .tab access
                   3115: =pod
                   3116: 
                   3117: =back
                   3118: 
                   3119: =cut
                   3120: 
                   3121: # ------------------------------------------------------------------ File Types
                   3122: sub fileextensions {
                   3123:     return sort(keys(%fe));
                   3124: }
                   3125: 
1.97      www      3126: # ----------------------------------------------------------- Display Languages
                   3127: # returns a hash with all desired display languages
                   3128: #
                   3129: 
                   3130: sub display_languages {
                   3131:     my %languages=();
1.695     raeburn  3132:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3133: 	$languages{$lang}=1;
1.97      www      3134:     }
                   3135:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3136:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3137: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3138: 	    $languages{$lang}=1;
1.97      www      3139:         }
                   3140:     }
                   3141:     return %languages;
1.14      harris41 3142: }
                   3143: 
1.582     albertel 3144: sub languages {
                   3145:     my ($possible_langs) = @_;
1.695     raeburn  3146:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3147:     if (!ref($possible_langs)) {
                   3148: 	if( wantarray ) {
                   3149: 	    return @preferred_langs;
                   3150: 	} else {
                   3151: 	    return $preferred_langs[0];
                   3152: 	}
                   3153:     }
                   3154:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3155:     my @preferred_possibilities;
                   3156:     foreach my $preferred_lang (@preferred_langs) {
                   3157: 	if (exists($possibilities{$preferred_lang})) {
                   3158: 	    push(@preferred_possibilities, $preferred_lang);
                   3159: 	}
                   3160:     }
                   3161:     if( wantarray ) {
                   3162: 	return @preferred_possibilities;
                   3163:     }
                   3164:     return $preferred_possibilities[0];
                   3165: }
                   3166: 
1.742     raeburn  3167: sub user_lang {
                   3168:     my ($touname,$toudom,$fromcid) = @_;
                   3169:     my @userlangs;
                   3170:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3171:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3172:                     $env{'course.'.$fromcid.'.languages'}));
                   3173:     } else {
                   3174:         my %langhash = &getlangs($touname,$toudom);
                   3175:         if ($langhash{'languages'} ne '') {
                   3176:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3177:         } else {
                   3178:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3179:             if ($domdefs{'lang_def'} ne '') {
                   3180:                 @userlangs = ($domdefs{'lang_def'});
                   3181:             }
                   3182:         }
                   3183:     }
                   3184:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3185:     my $user_lh = Apache::localize->get_handle(@languages);
                   3186:     return $user_lh;
                   3187: }
                   3188: 
                   3189: 
1.112     bowersj2 3190: ###############################################################
                   3191: ##               Student Answer Attempts                     ##
                   3192: ###############################################################
                   3193: 
                   3194: =pod
                   3195: 
                   3196: =head1 Alternate Problem Views
                   3197: 
                   3198: =over 4
                   3199: 
1.648     raeburn  3200: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3201:     $getattempt, $regexp, $gradesub)
                   3202: 
                   3203: Return string with previous attempt on problem. Arguments:
                   3204: 
                   3205: =over 4
                   3206: 
                   3207: =item * $symb: Problem, including path
                   3208: 
                   3209: =item * $username: username of the desired student
                   3210: 
                   3211: =item * $domain: domain of the desired student
1.14      harris41 3212: 
1.112     bowersj2 3213: =item * $course: Course ID
1.14      harris41 3214: 
1.112     bowersj2 3215: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3216:     something
1.14      harris41 3217: 
1.112     bowersj2 3218: =item * $regexp: if string matches this regexp, the string will be
                   3219:     sent to $gradesub
1.14      harris41 3220: 
1.112     bowersj2 3221: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3222: 
1.112     bowersj2 3223: =back
1.14      harris41 3224: 
1.112     bowersj2 3225: The output string is a table containing all desired attempts, if any.
1.16      harris41 3226: 
1.112     bowersj2 3227: =cut
1.1       albertel 3228: 
                   3229: sub get_previous_attempt {
1.43      ng       3230:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3231:   my $prevattempts='';
1.43      ng       3232:   no strict 'refs';
1.1       albertel 3233:   if ($symb) {
1.3       albertel 3234:     my (%returnhash)=
                   3235:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3236:     if ($returnhash{'version'}) {
                   3237:       my %lasthash=();
                   3238:       my $version;
                   3239:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3240:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3241: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3242:         }
1.1       albertel 3243:       }
1.596     albertel 3244:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3245:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3246:       foreach my $key (sort(keys(%lasthash))) {
                   3247: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3248: 	if ($#parts > 0) {
1.31      albertel 3249: 	  my $data=$parts[-1];
                   3250: 	  pop(@parts);
1.596     albertel 3251: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3252: 	} else {
1.41      ng       3253: 	  if ($#parts == 0) {
                   3254: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3255: 	  } else {
                   3256: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3257: 	  }
1.31      albertel 3258: 	}
1.16      harris41 3259:       }
1.596     albertel 3260:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3261:       if ($getattempt eq '') {
                   3262: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3263: 	  $prevattempts.=&start_data_table_row().
                   3264: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3265: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3266: 		my $value = &format_previous_attempt_value($key,
                   3267: 							   $returnhash{$version.':'.$key});
                   3268: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3269: 	    }
1.596     albertel 3270: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3271: 	 }
1.1       albertel 3272:       }
1.596     albertel 3273:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3274:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3275: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3276: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3277: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3278:       }
1.596     albertel 3279:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3280:     } else {
1.596     albertel 3281:       $prevattempts=
                   3282: 	  &start_data_table().&start_data_table_row().
                   3283: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3284: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3285:     }
                   3286:   } else {
1.596     albertel 3287:     $prevattempts=
                   3288: 	  &start_data_table().&start_data_table_row().
                   3289: 	  '<td>'.&mt('No data.').'</td>'.
                   3290: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3291:   }
1.10      albertel 3292: }
                   3293: 
1.581     albertel 3294: sub format_previous_attempt_value {
                   3295:     my ($key,$value) = @_;
                   3296:     if ($key =~ /timestamp/) {
                   3297: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3298:     } elsif (ref($value) eq 'ARRAY') {
                   3299: 	$value = '('.join(', ', @{ $value }).')';
                   3300:     } else {
                   3301: 	$value = &unescape($value);
                   3302:     }
                   3303:     return $value;
                   3304: }
                   3305: 
                   3306: 
1.107     albertel 3307: sub relative_to_absolute {
                   3308:     my ($url,$output)=@_;
                   3309:     my $parser=HTML::TokeParser->new(\$output);
                   3310:     my $token;
                   3311:     my $thisdir=$url;
                   3312:     my @rlinks=();
                   3313:     while ($token=$parser->get_token) {
                   3314: 	if ($token->[0] eq 'S') {
                   3315: 	    if ($token->[1] eq 'a') {
                   3316: 		if ($token->[2]->{'href'}) {
                   3317: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3318: 		}
                   3319: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3320: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3321: 	    } elsif ($token->[1] eq 'base') {
                   3322: 		$thisdir=$token->[2]->{'href'};
                   3323: 	    }
                   3324: 	}
                   3325:     }
                   3326:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3327:     foreach my $link (@rlinks) {
1.726     raeburn  3328: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3329: 		($link=~/^\//) ||
                   3330: 		($link=~/^javascript:/i) ||
                   3331: 		($link=~/^mailto:/i) ||
                   3332: 		($link=~/^\#/)) {
                   3333: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3334: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3335: 	}
                   3336:     }
                   3337: # -------------------------------------------------- Deal with Applet codebases
                   3338:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3339:     return $output;
                   3340: }
                   3341: 
1.112     bowersj2 3342: =pod
                   3343: 
1.648     raeburn  3344: =item * &get_student_view()
1.112     bowersj2 3345: 
                   3346: show a snapshot of what student was looking at
                   3347: 
                   3348: =cut
                   3349: 
1.10      albertel 3350: sub get_student_view {
1.186     albertel 3351:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3352:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3353:   my (%form);
1.10      albertel 3354:   my @elements=('symb','courseid','domain','username');
                   3355:   foreach my $element (@elements) {
1.186     albertel 3356:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3357:   }
1.186     albertel 3358:   if (defined($moreenv)) {
                   3359:       %form=(%form,%{$moreenv});
                   3360:   }
1.236     albertel 3361:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3362:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3363:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3364:   $userview=~s/\<body[^\>]*\>//gi;
                   3365:   $userview=~s/\<\/body\>//gi;
                   3366:   $userview=~s/\<html\>//gi;
                   3367:   $userview=~s/\<\/html\>//gi;
                   3368:   $userview=~s/\<head\>//gi;
                   3369:   $userview=~s/\<\/head\>//gi;
                   3370:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3371:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3372:   if (wantarray) {
                   3373:      return ($userview,$response);
                   3374:   } else {
                   3375:      return $userview;
                   3376:   }
                   3377: }
                   3378: 
                   3379: sub get_student_view_with_retries {
                   3380:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3381: 
                   3382:     my $ok = 0;                 # True if we got a good response.
                   3383:     my $content;
                   3384:     my $response;
                   3385: 
                   3386:     # Try to get the student_view done. within the retries count:
                   3387:     
                   3388:     do {
                   3389:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3390:          $ok      = $response->is_success;
                   3391:          if (!$ok) {
                   3392:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3393:          }
                   3394:          $retries--;
                   3395:     } while (!$ok && ($retries > 0));
                   3396:     
                   3397:     if (!$ok) {
                   3398:        $content = '';          # On error return an empty content.
                   3399:     }
1.651     www      3400:     if (wantarray) {
                   3401:        return ($content, $response);
                   3402:     } else {
                   3403:        return $content;
                   3404:     }
1.11      albertel 3405: }
                   3406: 
1.112     bowersj2 3407: =pod
                   3408: 
1.648     raeburn  3409: =item * &get_student_answers() 
1.112     bowersj2 3410: 
                   3411: show a snapshot of how student was answering problem
                   3412: 
                   3413: =cut
                   3414: 
1.11      albertel 3415: sub get_student_answers {
1.100     sakharuk 3416:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3417:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3418:   my (%moreenv);
1.11      albertel 3419:   my @elements=('symb','courseid','domain','username');
                   3420:   foreach my $element (@elements) {
1.186     albertel 3421:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3422:   }
1.186     albertel 3423:   $moreenv{'grade_target'}='answer';
                   3424:   %moreenv=(%form,%moreenv);
1.497     raeburn  3425:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3426:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3427:   return $userview;
1.1       albertel 3428: }
1.116     albertel 3429: 
                   3430: =pod
                   3431: 
                   3432: =item * &submlink()
                   3433: 
1.242     albertel 3434: Inputs: $text $uname $udom $symb $target
1.116     albertel 3435: 
                   3436: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3437: 
                   3438: =cut
                   3439: 
                   3440: ###############################################
                   3441: sub submlink {
1.242     albertel 3442:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3443:     if (!($uname && $udom)) {
                   3444: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3445: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3446: 	if (!$symb) { $symb=$cursymb; }
                   3447:     }
1.254     matthew  3448:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3449:     $symb=&escape($symb);
1.242     albertel 3450:     if ($target) { $target="target=\"$target\""; }
                   3451:     return '<a href="/adm/grades?&command=submission&'.
                   3452: 	'symb='.$symb.'&student='.$uname.
                   3453: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3454: }
                   3455: ##############################################
                   3456: 
                   3457: =pod
                   3458: 
                   3459: =item * &pgrdlink()
                   3460: 
                   3461: Inputs: $text $uname $udom $symb $target
                   3462: 
                   3463: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3464: 
                   3465: =cut
                   3466: 
                   3467: ###############################################
                   3468: sub pgrdlink {
                   3469:     my $link=&submlink(@_);
                   3470:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3471:     return $link;
                   3472: }
                   3473: ##############################################
                   3474: 
                   3475: =pod
                   3476: 
                   3477: =item * &pprmlink()
                   3478: 
                   3479: Inputs: $text $uname $udom $symb $target
                   3480: 
                   3481: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3482: student and a specific resource
1.242     albertel 3483: 
                   3484: =cut
                   3485: 
                   3486: ###############################################
                   3487: sub pprmlink {
                   3488:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3489:     if (!($uname && $udom)) {
                   3490: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3491: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3492: 	if (!$symb) { $symb=$cursymb; }
                   3493:     }
1.254     matthew  3494:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3495:     $symb=&escape($symb);
1.242     albertel 3496:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3497:     return '<a href="/adm/parmset?command=set&amp;'.
                   3498: 	'symb='.$symb.'&amp;uname='.$uname.
                   3499: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3500: }
                   3501: ##############################################
1.37      matthew  3502: 
1.112     bowersj2 3503: =pod
                   3504: 
                   3505: =back
                   3506: 
                   3507: =cut
                   3508: 
1.37      matthew  3509: ###############################################
1.51      www      3510: 
                   3511: 
                   3512: sub timehash {
1.687     raeburn  3513:     my ($thistime) = @_;
                   3514:     my $timezone = &Apache::lonlocal::gettimezone();
                   3515:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3516:                      ->set_time_zone($timezone);
                   3517:     my $wday = $dt->day_of_week();
                   3518:     if ($wday == 7) { $wday = 0; }
                   3519:     return ( 'second' => $dt->second(),
                   3520:              'minute' => $dt->minute(),
                   3521:              'hour'   => $dt->hour(),
                   3522:              'day'     => $dt->day_of_month(),
                   3523:              'month'   => $dt->month(),
                   3524:              'year'    => $dt->year(),
                   3525:              'weekday' => $wday,
                   3526:              'dayyear' => $dt->day_of_year(),
                   3527:              'dlsav'   => $dt->is_dst() );
1.51      www      3528: }
                   3529: 
1.370     www      3530: sub utc_string {
                   3531:     my ($date)=@_;
1.371     www      3532:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3533: }
                   3534: 
1.51      www      3535: sub maketime {
                   3536:     my %th=@_;
1.687     raeburn  3537:     my ($epoch_time,$timezone,$dt);
                   3538:     $timezone = &Apache::lonlocal::gettimezone();
                   3539:     eval {
                   3540:         $dt = DateTime->new( year   => $th{'year'},
                   3541:                              month  => $th{'month'},
                   3542:                              day    => $th{'day'},
                   3543:                              hour   => $th{'hour'},
                   3544:                              minute => $th{'minute'},
                   3545:                              second => $th{'second'},
                   3546:                              time_zone => $timezone,
                   3547:                          );
                   3548:     };
                   3549:     if (!$@) {
                   3550:         $epoch_time = $dt->epoch;
                   3551:         if ($epoch_time) {
                   3552:             return $epoch_time;
                   3553:         }
                   3554:     }
1.51      www      3555:     return POSIX::mktime(
                   3556:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3557:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3558: }
                   3559: 
                   3560: #########################################
1.51      www      3561: 
                   3562: sub findallcourses {
1.482     raeburn  3563:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3564:     my %roles;
                   3565:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3566:     my %courses;
1.51      www      3567:     my $now=time;
1.482     raeburn  3568:     if (!defined($uname)) {
                   3569:         $uname = $env{'user.name'};
                   3570:     }
                   3571:     if (!defined($udom)) {
                   3572:         $udom = $env{'user.domain'};
                   3573:     }
                   3574:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3575:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3576:         if (!%roles) {
                   3577:             %roles = (
                   3578:                        cc => 1,
                   3579:                        in => 1,
                   3580:                        ep => 1,
                   3581:                        ta => 1,
                   3582:                        cr => 1,
                   3583:                        st => 1,
                   3584:              );
                   3585:         }
                   3586:         foreach my $entry (keys(%roleshash)) {
                   3587:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3588:             if ($trole =~ /^cr/) { 
                   3589:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3590:             } else {
                   3591:                 next if (!exists($roles{$trole}));
                   3592:             }
                   3593:             if ($tend) {
                   3594:                 next if ($tend < $now);
                   3595:             }
                   3596:             if ($tstart) {
                   3597:                 next if ($tstart > $now);
                   3598:             }
                   3599:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3600:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3601:             if ($secpart eq '') {
                   3602:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3603:                 $sec = 'none';
                   3604:                 $realsec = '';
                   3605:             } else {
                   3606:                 $cnum = $cnumpart;
                   3607:                 ($sec,$role) = split(/_/,$secpart);
                   3608:                 $realsec = $sec;
1.490     raeburn  3609:             }
1.482     raeburn  3610:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3611:         }
                   3612:     } else {
                   3613:         foreach my $key (keys(%env)) {
1.483     albertel 3614: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3615:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3616: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3617: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3618: 	        next if (%roles && !exists($roles{$role}));
                   3619: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3620:                 my $active=1;
                   3621:                 if ($starttime) {
                   3622: 		    if ($now<$starttime) { $active=0; }
                   3623:                 }
                   3624:                 if ($endtime) {
                   3625:                     if ($now>$endtime) { $active=0; }
                   3626:                 }
                   3627:                 if ($active) {
                   3628:                     if ($sec eq '') {
                   3629:                         $sec = 'none';
                   3630:                     }
                   3631:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3632:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3633:                 }
                   3634:             }
1.51      www      3635:         }
                   3636:     }
1.474     raeburn  3637:     return %courses;
1.51      www      3638: }
1.37      matthew  3639: 
1.54      www      3640: ###############################################
1.474     raeburn  3641: 
                   3642: sub blockcheck {
1.482     raeburn  3643:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3644: 
                   3645:     if (!defined($udom)) {
                   3646:         $udom = $env{'user.domain'};
                   3647:     }
                   3648:     if (!defined($uname)) {
                   3649:         $uname = $env{'user.name'};
                   3650:     }
                   3651: 
                   3652:     # If uname and udom are for a course, check for blocks in the course.
                   3653: 
                   3654:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3655:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3656:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3657:         return ($startblock,$endblock);
                   3658:     }
1.474     raeburn  3659: 
1.502     raeburn  3660:     my $startblock = 0;
                   3661:     my $endblock = 0;
1.482     raeburn  3662:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3663: 
1.490     raeburn  3664:     # If uname is for a user, and activity is course-specific, i.e.,
                   3665:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3666: 
1.490     raeburn  3667:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3668:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3669:         foreach my $key (keys(%live_courses)) {
                   3670:             if ($key ne $env{'request.course.id'}) {
                   3671:                 delete($live_courses{$key});
                   3672:             }
                   3673:         }
                   3674:     }
                   3675: 
                   3676:     my $otheruser = 0;
                   3677:     my %own_courses;
                   3678:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3679:         # Resource belongs to user other than current user.
                   3680:         $otheruser = 1;
                   3681:         # Gather courses for current user
                   3682:         %own_courses = 
                   3683:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3684:     }
                   3685: 
                   3686:     # Gather active course roles - course coordinator, instructor, 
                   3687:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3688: 
                   3689:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3690:         my ($cdom,$cnum);
                   3691:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3692:             $cdom = $env{'course.'.$course.'.domain'};
                   3693:             $cnum = $env{'course.'.$course.'.num'};
                   3694:         } else {
1.490     raeburn  3695:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3696:         }
                   3697:         my $no_ownblock = 0;
                   3698:         my $no_userblock = 0;
1.533     raeburn  3699:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3700:             # Check if current user has 'evb' priv for this
                   3701:             if (defined($own_courses{$course})) {
                   3702:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3703:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3704:                     if ($sec ne 'none') {
                   3705:                         $checkrole .= '/'.$sec;
                   3706:                     }
                   3707:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3708:                         $no_ownblock = 1;
                   3709:                         last;
                   3710:                     }
                   3711:                 }
                   3712:             }
                   3713:             # if they have 'evb' priv and are currently not playing student
                   3714:             next if (($no_ownblock) &&
                   3715:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3716:         }
1.474     raeburn  3717:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3718:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3719:             if ($sec ne 'none') {
1.482     raeburn  3720:                 $checkrole .= '/'.$sec;
1.474     raeburn  3721:             }
1.490     raeburn  3722:             if ($otheruser) {
                   3723:                 # Resource belongs to user other than current user.
                   3724:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3725:                 my ($trole,$tdom,$tnum,$tsec);
                   3726:                 my $entry = $live_courses{$course}{$sec};
                   3727:                 if ($entry =~ /^cr/) {
                   3728:                     ($trole,$tdom,$tnum,$tsec) = 
                   3729:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3730:                 } else {
                   3731:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3732:                 }
                   3733:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3734:                 $area = '/'.$tdom.'/'.$tnum;
                   3735:                 $trest = $tnum;
                   3736:                 if ($tsec ne '') {
                   3737:                     $area .= '/'.$tsec;
                   3738:                     $trest .= '/'.$tsec;
                   3739:                 }
                   3740:                 $spec = $trole.'.'.$area;
                   3741:                 if ($trole =~ /^cr/) {
                   3742:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3743:                                                       $tdom,$spec,$trest,$area);
                   3744:                 } else {
                   3745:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3746:                                                        $tdom,$spec,$trest,$area);
                   3747:                 }
                   3748:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3749:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3750:                     if ($1) {
                   3751:                         $no_userblock = 1;
                   3752:                         last;
                   3753:                     }
                   3754:                 }
1.490     raeburn  3755:             } else {
                   3756:                 # Resource belongs to current user
                   3757:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3758:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3759:                     $no_ownblock = 1;
                   3760:                     last;
                   3761:                 }
1.474     raeburn  3762:             }
                   3763:         }
                   3764:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3765:         next if (($no_ownblock) &&
1.491     albertel 3766:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3767:         next if ($no_userblock);
1.474     raeburn  3768: 
1.490     raeburn  3769:         # Retrieve blocking times and identity of blocker for course
                   3770:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3771:         
                   3772:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3773:         if (($start != 0) && 
                   3774:             (($startblock == 0) || ($startblock > $start))) {
                   3775:             $startblock = $start;
                   3776:         }
                   3777:         if (($end != 0)  &&
                   3778:             (($endblock == 0) || ($endblock < $end))) {
                   3779:             $endblock = $end;
                   3780:         }
1.490     raeburn  3781:     }
                   3782:     return ($startblock,$endblock);
                   3783: }
                   3784: 
                   3785: sub get_blocks {
                   3786:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3787:     my $startblock = 0;
                   3788:     my $endblock = 0;
                   3789:     my $course = $cdom.'_'.$cnum;
                   3790:     $setters->{$course} = {};
                   3791:     $setters->{$course}{'staff'} = [];
                   3792:     $setters->{$course}{'times'} = [];
                   3793:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3794:     foreach my $record (keys(%records)) {
                   3795:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3796:         if ($start <= time && $end >= time) {
                   3797:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3798:                 &parse_block_record($records{$record});
                   3799:             if ($blocks->{$activity} eq 'on') {
                   3800:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3801:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3802:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3803:                     $startblock = $start;
1.490     raeburn  3804:                 }
1.491     albertel 3805:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3806:                     $endblock = $end;
1.474     raeburn  3807:                 }
                   3808:             }
                   3809:         }
                   3810:     }
                   3811:     return ($startblock,$endblock);
                   3812: }
                   3813: 
                   3814: sub parse_block_record {
                   3815:     my ($record) = @_;
                   3816:     my ($setuname,$setudom,$title,$blocks);
                   3817:     if (ref($record) eq 'HASH') {
                   3818:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3819:         $title = &unescape($record->{'event'});
                   3820:         $blocks = $record->{'blocks'};
                   3821:     } else {
                   3822:         my @data = split(/:/,$record,3);
                   3823:         if (scalar(@data) eq 2) {
                   3824:             $title = $data[1];
                   3825:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3826:         } else {
                   3827:             ($setuname,$setudom,$title) = @data;
                   3828:         }
                   3829:         $blocks = { 'com' => 'on' };
                   3830:     }
                   3831:     return ($setuname,$setudom,$title,$blocks);
                   3832: }
                   3833: 
                   3834: sub build_block_table {
                   3835:     my ($startblock,$endblock,$setters) = @_;
                   3836:     my %lt = &Apache::lonlocal::texthash(
                   3837:         'cacb' => 'Currently active communication blocks',
                   3838:         'cour' => 'Course',
                   3839:         'dura' => 'Duration',
                   3840:         'blse' => 'Block set by'
                   3841:     );
                   3842:     my $output;
1.476     raeburn  3843:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3844:     $output .= &start_data_table();
                   3845:     $output .= '
                   3846: <tr>
                   3847:  <th>'.$lt{'cour'}.'</th>
                   3848:  <th>'.$lt{'dura'}.'</th>
                   3849:  <th>'.$lt{'blse'}.'</th>
                   3850: </tr>
                   3851: ';
                   3852:     foreach my $course (keys(%{$setters})) {
                   3853:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3854:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3855:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3856:             my $fullname = &plainname($uname,$udom);
                   3857:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3858:                 && $env{'user.name'} ne 'public' 
                   3859:                 && $env{'user.domain'} ne 'public') {
                   3860:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3861:             }
1.474     raeburn  3862:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3863:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3864:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3865:             $output .= &Apache::loncommon::start_data_table_row().
                   3866:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3867:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3868:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3869:                         &Apache::loncommon::end_data_table_row();
                   3870:         }
                   3871:     }
                   3872:     $output .= &end_data_table();
                   3873: }
                   3874: 
1.490     raeburn  3875: sub blocking_status {
                   3876:     my ($activity,$uname,$udom) = @_;
                   3877:     my %setters;
                   3878:     my ($blocked,$output,$ownitem,$is_course);
                   3879:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3880:     if ($startblock && $endblock) {
                   3881:         $blocked = 1;
                   3882:         if (wantarray) {
                   3883:             my $category;
                   3884:             if ($activity eq 'boards') {
                   3885:                 $category = 'Discussion posts in this course';
                   3886:             } elsif ($activity eq 'blogs') {
                   3887:                 $category = 'Blogs';
                   3888:             } elsif ($activity eq 'port') {
                   3889:                 if (defined($uname) && defined($udom)) {
                   3890:                     if ($uname eq $env{'user.name'} &&
                   3891:                         $udom eq $env{'user.domain'}) {
                   3892:                         $ownitem = 1;
                   3893:                     }
                   3894:                 }
                   3895:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3896:                 if ($ownitem) { 
                   3897:                     $category = 'Your portfolio files';  
                   3898:                 } elsif ($is_course) {
                   3899:                     my $coursedesc;
                   3900:                     foreach my $course (keys(%setters)) {
                   3901:                         my %courseinfo =
                   3902:                              &Apache::lonnet::coursedescription($course);
                   3903:                         $coursedesc = $courseinfo{'description'};
                   3904:                     }
1.764     weissno  3905:                     $category = "Group portfolio in the course '$coursedesc'";
1.490     raeburn  3906:                 } else {
                   3907:                     $category = 'Portfolio files belonging to ';
                   3908:                     if ($env{'user.name'} eq 'public' && 
                   3909:                         $env{'user.domain'} eq 'public') {
                   3910:                         $category .= &plainname($uname,$udom);
                   3911:                     } else {
                   3912:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3913:                     }
                   3914:                 }
                   3915:             } elsif ($activity eq 'groups') {
                   3916:                 $category = 'Groups in this course';
                   3917:             }
                   3918:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3919:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3920:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3921:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3922:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3923:             }
                   3924:         }
                   3925:     }
                   3926:     if (wantarray) {
                   3927:         return ($blocked,$output);
                   3928:     } else {
                   3929:         return $blocked;
                   3930:     }
                   3931: }
                   3932: 
1.60      matthew  3933: ###############################################
                   3934: 
1.682     raeburn  3935: sub check_ip_acc {
                   3936:     my ($acc)=@_;
                   3937:     &Apache::lonxml::debug("acc is $acc");
                   3938:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3939:         return 1;
                   3940:     }
                   3941:     my $allowed=0;
                   3942:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3943: 
                   3944:     my $name;
                   3945:     foreach my $pattern (split(',',$acc)) {
                   3946:         $pattern =~ s/^\s*//;
                   3947:         $pattern =~ s/\s*$//;
                   3948:         if ($pattern =~ /\*$/) {
                   3949:             #35.8.*
                   3950:             $pattern=~s/\*//;
                   3951:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3952:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3953:             #35.8.3.[34-56]
                   3954:             my $low=$2;
                   3955:             my $high=$3;
                   3956:             $pattern=$1;
                   3957:             if ($ip =~ /^\Q$pattern\E/) {
                   3958:                 my $last=(split(/\./,$ip))[3];
                   3959:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3960:             }
                   3961:         } elsif ($pattern =~ /^\*/) {
                   3962:             #*.msu.edu
                   3963:             $pattern=~s/\*//;
                   3964:             if (!defined($name)) {
                   3965:                 use Socket;
                   3966:                 my $netaddr=inet_aton($ip);
                   3967:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3968:             }
                   3969:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3970:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3971:             #127.0.0.1
                   3972:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3973:         } else {
                   3974:             #some.name.com
                   3975:             if (!defined($name)) {
                   3976:                 use Socket;
                   3977:                 my $netaddr=inet_aton($ip);
                   3978:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3979:             }
                   3980:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3981:         }
                   3982:         if ($allowed) { last; }
                   3983:     }
                   3984:     return $allowed;
                   3985: }
                   3986: 
                   3987: ###############################################
                   3988: 
1.60      matthew  3989: =pod
                   3990: 
1.112     bowersj2 3991: =head1 Domain Template Functions
                   3992: 
                   3993: =over 4
                   3994: 
                   3995: =item * &determinedomain()
1.60      matthew  3996: 
                   3997: Inputs: $domain (usually will be undef)
                   3998: 
1.63      www      3999: Returns: Determines which domain should be used for designs
1.60      matthew  4000: 
                   4001: =cut
1.54      www      4002: 
1.60      matthew  4003: ###############################################
1.63      www      4004: sub determinedomain {
                   4005:     my $domain=shift;
1.531     albertel 4006:     if (! $domain) {
1.60      matthew  4007:         # Determine domain if we have not been given one
                   4008:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 4009:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4010:         if ($env{'request.role.domain'}) { 
                   4011:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4012:         }
                   4013:     }
1.63      www      4014:     return $domain;
                   4015: }
                   4016: ###############################################
1.517     raeburn  4017: 
1.518     albertel 4018: sub devalidate_domconfig_cache {
                   4019:     my ($udom)=@_;
                   4020:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4021: }
                   4022: 
                   4023: # ---------------------- Get domain configuration for a domain
                   4024: sub get_domainconf {
                   4025:     my ($udom) = @_;
                   4026:     my $cachetime=1800;
                   4027:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4028:     if (defined($cached)) { return %{$result}; }
                   4029: 
                   4030:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4031: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4032:     my (%designhash,%legacy);
1.518     albertel 4033:     if (keys(%domconfig) > 0) {
                   4034:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4035:             if (keys(%{$domconfig{'login'}})) {
                   4036:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4037:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4038:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4039:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4040:                                 $domconfig{'login'}{$key}{$img};
                   4041:                         }
                   4042:                     } else {
                   4043:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4044:                     }
1.632     raeburn  4045:                 }
                   4046:             } else {
                   4047:                 $legacy{'login'} = 1;
1.518     albertel 4048:             }
1.632     raeburn  4049:         } else {
                   4050:             $legacy{'login'} = 1;
1.518     albertel 4051:         }
                   4052:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4053:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4054:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4055:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4056:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4057:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4058:                         }
1.518     albertel 4059:                     }
                   4060:                 }
1.632     raeburn  4061:             } else {
                   4062:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4063:             }
1.632     raeburn  4064:         } else {
                   4065:             $legacy{'rolecolors'} = 1;
1.518     albertel 4066:         }
1.632     raeburn  4067:         if (keys(%legacy) > 0) {
                   4068:             my %legacyhash = &get_legacy_domconf($udom);
                   4069:             foreach my $item (keys(%legacyhash)) {
                   4070:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4071:                     if ($legacy{'login'}) { 
                   4072:                         $designhash{$item} = $legacyhash{$item};
                   4073:                     }
                   4074:                 } else {
                   4075:                     if ($legacy{'rolecolors'}) {
                   4076:                         $designhash{$item} = $legacyhash{$item};
                   4077:                     }
1.518     albertel 4078:                 }
                   4079:             }
                   4080:         }
1.632     raeburn  4081:     } else {
                   4082:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4083:     }
                   4084:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4085: 				  $cachetime);
                   4086:     return %designhash;
                   4087: }
                   4088: 
1.632     raeburn  4089: sub get_legacy_domconf {
                   4090:     my ($udom) = @_;
                   4091:     my %legacyhash;
                   4092:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4093:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4094:     if (-e $designfile) {
                   4095:         if ( open (my $fh,"<$designfile") ) {
                   4096:             while (my $line = <$fh>) {
                   4097:                 next if ($line =~ /^\#/);
                   4098:                 chomp($line);
                   4099:                 my ($key,$val)=(split(/\=/,$line));
                   4100:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4101:             }
                   4102:             close($fh);
                   4103:         }
                   4104:     }
                   4105:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4106:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4107:     }
                   4108:     return %legacyhash;
                   4109: }
                   4110: 
1.63      www      4111: =pod
                   4112: 
1.112     bowersj2 4113: =item * &domainlogo()
1.63      www      4114: 
                   4115: Inputs: $domain (usually will be undef)
                   4116: 
                   4117: Returns: A link to a domain logo, if the domain logo exists.
                   4118: If the domain logo does not exist, a description of the domain.
                   4119: 
                   4120: =cut
1.112     bowersj2 4121: 
1.63      www      4122: ###############################################
                   4123: sub domainlogo {
1.517     raeburn  4124:     my $domain = &determinedomain(shift);
1.518     albertel 4125:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4126:     # See if there is a logo
                   4127:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4128:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4129:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4130: 	    if ($imgsrc =~ m{^/res/}) {
                   4131: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4132: 		&Apache::lonnet::repcopy($local_name);
                   4133: 	    }
                   4134: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4135:         } 
                   4136:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4137:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4138:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4139:     } else {
1.60      matthew  4140:         return '';
1.59      www      4141:     }
                   4142: }
1.63      www      4143: ##############################################
                   4144: 
                   4145: =pod
                   4146: 
1.112     bowersj2 4147: =item * &designparm()
1.63      www      4148: 
                   4149: Inputs: $which parameter; $domain (usually will be undef)
                   4150: 
                   4151: Returns: value of designparamter $which
                   4152: 
                   4153: =cut
1.112     bowersj2 4154: 
1.397     albertel 4155: 
1.400     albertel 4156: ##############################################
1.397     albertel 4157: sub designparm {
                   4158:     my ($which,$domain)=@_;
                   4159:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4160:         return $env{'environment.color.'.$which};
1.96      www      4161:     }
1.63      www      4162:     $domain=&determinedomain($domain);
1.518     albertel 4163:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4164:     my $output;
1.517     raeburn  4165:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4166:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4167:     } else {
1.520     raeburn  4168:         $output = $defaultdesign{$which};
                   4169:     }
                   4170:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4171:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4172:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4173:             if ($output =~ m{^/res/}) {
                   4174:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4175:                 &Apache::lonnet::repcopy($local_name);
                   4176:             }
1.520     raeburn  4177:             $output = &lonhttpdurl($output);
                   4178:         }
1.63      www      4179:     }
1.520     raeburn  4180:     return $output;
1.63      www      4181: }
1.59      www      4182: 
1.822     bisitz   4183: ##############################################
                   4184: =pod
                   4185: 
1.832     bisitz   4186: =item * &authorspace()
                   4187: 
                   4188: Inputs: ./.
                   4189: 
                   4190: Returns: Path to the Construction Space of the current user's
                   4191:          accessed author space
                   4192:          The author space will be that of the current user
                   4193:          when accessing the own author space
                   4194:          and that of the co-author/assistent co-author
                   4195:          when accessing the co-author's/assistent co-author's
                   4196:          space
                   4197: 
                   4198: =cut
                   4199: 
                   4200: sub authorspace {
                   4201:     my $caname = '';
                   4202:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4203:         (undef,$caname) =
                   4204:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4205:     } else {
                   4206:         $caname = $env{'user.name'};
                   4207:     }
                   4208:     return '/priv/'.$caname.'/';
                   4209: }
                   4210: 
                   4211: ##############################################
                   4212: =pod
                   4213: 
1.822     bisitz   4214: =item * &head_subbox()
                   4215: 
                   4216: Inputs: $content (contains HTML code with page functions, etc.)
                   4217: 
                   4218: Returns: HTML div with $content
                   4219:          To be included in page header
                   4220: 
                   4221: =cut
                   4222: 
                   4223: sub head_subbox {
                   4224:     my ($content)=@_;
                   4225:     my $output =
1.844     bisitz   4226:         '<div id="LC_head_subbox">'
1.822     bisitz   4227:        .$content
                   4228:        .'</div>'
                   4229: }
                   4230: 
                   4231: ##############################################
                   4232: =pod
                   4233: 
                   4234: =item * &CSTR_pageheader()
                   4235: 
                   4236: Inputs: ./.
                   4237: 
                   4238: Returns: HTML div with CSTR path and recent box
                   4239:          To be included on Construction Space pages
                   4240: 
                   4241: =cut
                   4242: 
                   4243: sub CSTR_pageheader {
                   4244:     # this is for resources; directories have customtitle, and crumbs
                   4245:             # and select recent are created in lonpubdir.pm  
                   4246:     my ($uname,$thisdisfn)=
                   4247:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4248:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4249:     $formaction=~s/\/+/\//g;
                   4250: 
                   4251:     my $parentpath = '';
                   4252:     my $lastitem = '';
                   4253:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4254:         $parentpath = $1;
                   4255:         $lastitem = $2;
                   4256:     } else {
                   4257:         $lastitem = $thisdisfn;
                   4258:     }
                   4259:     return
                   4260:          '<div>'
                   4261:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4262:         .'<b>'.&mt('Construction Space:').'</b> '
                   4263:         .'<form name="dirs" method="post" action="'.$formaction
                   4264:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4265:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4266:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4267:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4268:         .'</form>'
                   4269:         .&Apache::lonmenu::constspaceform()
                   4270:         .'</div>';
                   4271: }
                   4272: 
1.60      matthew  4273: ###############################################
                   4274: ###############################################
                   4275: 
                   4276: =pod
                   4277: 
1.112     bowersj2 4278: =back
                   4279: 
1.549     albertel 4280: =head1 HTML Helpers
1.112     bowersj2 4281: 
                   4282: =over 4
                   4283: 
                   4284: =item * &bodytag()
1.60      matthew  4285: 
                   4286: Returns a uniform header for LON-CAPA web pages.
                   4287: 
                   4288: Inputs: 
                   4289: 
1.112     bowersj2 4290: =over 4
                   4291: 
                   4292: =item * $title, A title to be displayed on the page.
                   4293: 
                   4294: =item * $function, the current role (can be undef).
                   4295: 
                   4296: =item * $addentries, extra parameters for the <body> tag.
                   4297: 
                   4298: =item * $bodyonly, if defined, only return the <body> tag.
                   4299: 
                   4300: =item * $domain, if defined, force a given domain.
                   4301: 
                   4302: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4303:             text interface only)
1.60      matthew  4304: 
1.814     bisitz   4305: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4306:                      navigational links
1.317     albertel 4307: 
1.338     albertel 4308: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4309: 
1.361     albertel 4310: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4311:          'Switch To Inline Menu' link
                   4312: 
1.460     albertel 4313: =item * $args, optional argument valid values are
                   4314:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4315:             inherit_jsmath -> when creating popup window in a page,
                   4316:                               should it have jsmath forced on by the
                   4317:                               current page
1.460     albertel 4318: 
1.112     bowersj2 4319: =back
                   4320: 
1.60      matthew  4321: Returns: A uniform header for LON-CAPA web pages.  
                   4322: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4323: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4324: other decorations will be returned.
                   4325: 
                   4326: =cut
                   4327: 
1.54      www      4328: sub bodytag {
1.831     bisitz   4329:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4330:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4331: 
1.460     albertel 4332:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4333: 
1.183     matthew  4334:     $function = &get_users_function() if (!$function);
1.339     albertel 4335:     my $img =    &designparm($function.'.img',$domain);
                   4336:     my $font =   &designparm($function.'.font',$domain);
                   4337:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4338: 
1.803     bisitz   4339:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4340: 		   'bgcolor' => $pgbg,
1.339     albertel 4341: 		   'text'    => $font,
                   4342:                    'alink'   => &designparm($function.'.alink',$domain),
                   4343: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4344: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4345:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4346: 
1.63      www      4347:  # role and realm
1.378     raeburn  4348:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4349:     if ($role  eq 'ca') {
1.479     albertel 4350:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4351:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4352:     } 
1.55      www      4353: # realm
1.258     albertel 4354:     if ($env{'request.course.id'}) {
1.378     raeburn  4355:         if ($env{'request.role'} !~ /^cr/) {
                   4356:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4357:         }
1.359     albertel 4358: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4359:     } else {
                   4360:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4361:     }
1.433     albertel 4362: 
1.359     albertel 4363:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4364: # Set messages
1.60      matthew  4365:     my $messages=&domainlogo($domain);
1.330     albertel 4366: 
1.438     albertel 4367:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4368: 
1.101     www      4369: # construct main body tag
1.359     albertel 4370:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4371: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4372: 
1.530     albertel 4373:     if ($bodyonly) {
1.60      matthew  4374:         return $bodytag;
1.798     tempelho 4375:     } 
1.359     albertel 4376: 
1.410     albertel 4377:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4378:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4379: 	undef($role);
1.434     albertel 4380:     } else {
                   4381: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4382:     }
1.359     albertel 4383:     
1.762     bisitz   4384:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4385:     #
                   4386:     # Extra info if you are the DC
                   4387:     my $dc_info = '';
                   4388:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4389:                         $env{'course.'.$env{'request.course.id'}.
                   4390:                                  '.domain'}.'/'})) {
                   4391:         my $cid = $env{'request.course.id'};
                   4392:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4393:         $dc_info =~ s/\s+$//;
1.359     albertel 4394:         $dc_info = '('.$dc_info.')';
                   4395:     }
                   4396: 
1.837     bisitz   4397:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4398:         # No Remote
1.258     albertel 4399: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4400: 	    $forcereg=1;
                   4401: 	}
                   4402: 
1.836     bisitz   4403: #    if ($env{'request.state'} eq 'construct') {
                   4404: #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4405: #    }
1.359     albertel 4406: 
1.816     bisitz   4407:         my $titletable = '<table id="LC_title_bar">'
1.836     bisitz   4408:                         ."<tr><td> $titleinfo $dc_info</td>"
1.816     bisitz   4409:                         .'</tr></table>';
                   4410: 
1.814     bisitz   4411: 	if ($no_nav_bar) {
1.359     albertel 4412: 	    $bodytag .= $titletable;
                   4413: 	} else {
1.813     bisitz   4414:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
                   4415:             <em>$realm</em> $dc_info</div>|;
1.359     albertel 4416: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4417:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4418: 							  $titletable);
1.272     raeburn  4419:             } else {
1.336     albertel 4420:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4421: 		    $titletable;
1.272     raeburn  4422:             }
1.235     raeburn  4423:         }
                   4424:         return $bodytag;
1.94      www      4425:     }
1.95      www      4426: 
1.93      www      4427: #
1.95      www      4428: # Top frame rendering, Remote is up
1.93      www      4429: #
1.359     albertel 4430: 
1.517     raeburn  4431:     my $imgsrc = $img;
                   4432:     if ($img =~ /^\/adm/) {
1.575     albertel 4433:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4434:     }
                   4435:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4436: 
1.305     www      4437:     # Explicit link to get inline menu
1.361     albertel 4438:     my $menu= ($no_inline_link?''
                   4439: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4440:     #
1.94      www      4441:     return(<<ENDBODY);
1.60      matthew  4442: $bodytag
1.359     albertel 4443: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4444: <tr><td>$upperleft</td>
                   4445:     <td>$messages&nbsp;</td>
1.54      www      4446: </tr>
1.359     albertel 4447: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4448: </tr>
1.356     albertel 4449: </table>
1.54      www      4450: ENDBODY
1.182     matthew  4451: }
                   4452: 
1.330     albertel 4453: sub make_attr_string {
                   4454:     my ($register,$attr_ref) = @_;
                   4455: 
                   4456:     if ($attr_ref && !ref($attr_ref)) {
                   4457: 	die("addentries Must be a hash ref ".
                   4458: 	    join(':',caller(1))." ".
                   4459: 	    join(':',caller(0))." ");
                   4460:     }
                   4461: 
                   4462:     if ($register) {
1.339     albertel 4463: 	my ($on_load,$on_unload);
                   4464: 	foreach my $key (keys(%{$attr_ref})) {
                   4465: 	    if      (lc($key) eq 'onload') {
                   4466: 		$on_load.=$attr_ref->{$key}.';';
                   4467: 		delete($attr_ref->{$key});
                   4468: 
                   4469: 	    } elsif (lc($key) eq 'onunload') {
                   4470: 		$on_unload.=$attr_ref->{$key}.';';
                   4471: 		delete($attr_ref->{$key});
                   4472: 	    }
                   4473: 	}
                   4474: 	$attr_ref->{'onload'}  =
                   4475: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4476: 	$attr_ref->{'onunload'}=
                   4477: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4478:     }
                   4479: 
                   4480: # Accessibility font enhance
                   4481:     if ($env{'browser.fontenhance'} eq 'on') {
                   4482: 	my $style;
                   4483: 	foreach my $key (keys(%{$attr_ref})) {
                   4484: 	    if (lc($key) eq 'style') {
                   4485: 		$style.=$attr_ref->{$key}.';';
                   4486: 		delete($attr_ref->{$key});
                   4487: 	    }
                   4488: 	}
                   4489: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4490:     }
1.339     albertel 4491: 
1.330     albertel 4492:     my $attr_string;
                   4493:     foreach my $attr (keys(%$attr_ref)) {
                   4494: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4495:     }
                   4496:     return $attr_string;
                   4497: }
                   4498: 
                   4499: 
1.182     matthew  4500: ###############################################
1.251     albertel 4501: ###############################################
                   4502: 
                   4503: =pod
                   4504: 
                   4505: =item * &endbodytag()
                   4506: 
                   4507: Returns a uniform footer for LON-CAPA web pages.
                   4508: 
1.635     raeburn  4509: Inputs: 1 - optional reference to an args hash
                   4510: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4511: a 'Continue' link is not displayed if the page contains an
                   4512: internal redirect in the <head></head> section,
                   4513: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4514: 
                   4515: =cut
                   4516: 
                   4517: sub endbodytag {
1.635     raeburn  4518:     my ($args) = @_;
1.251     albertel 4519:     my $endbodytag='</body>';
1.269     albertel 4520:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4521:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4522:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4523: 	    $endbodytag=
                   4524: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4525: 	        &mt('Continue').'</a>'.
                   4526: 	        $endbodytag;
                   4527:         }
1.315     albertel 4528:     }
1.251     albertel 4529:     return $endbodytag;
                   4530: }
                   4531: 
1.352     albertel 4532: =pod
                   4533: 
                   4534: =item * &standard_css()
                   4535: 
                   4536: Returns a style sheet
                   4537: 
                   4538: Inputs: (all optional)
                   4539:             domain         -> force to color decorate a page for a specific
                   4540:                                domain
                   4541:             function       -> force usage of a specific rolish color scheme
                   4542:             bgcolor        -> override the default page bgcolor
                   4543: 
                   4544: =cut
                   4545: 
1.343     albertel 4546: sub standard_css {
1.345     albertel 4547:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4548:     $function  = &get_users_function() if (!$function);
                   4549:     my $img    = &designparm($function.'.img',   $domain);
                   4550:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4551:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4552:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4553: #second colour for later usage
1.345     albertel 4554:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4555:     my $pgbg_or_bgcolor =
                   4556: 	         $bgcolor ||
1.352     albertel 4557: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4558:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4559:     my $alink  = &designparm($function.'.alink', $domain);
                   4560:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4561:     my $link   = &designparm($function.'.link',  $domain);
                   4562: 
1.704     muellerd 4563:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4564:     my $bgcol = &designparm('login.bgcol',$domain);
                   4565:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4566: 
1.602     albertel 4567:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4568:     my $mono                 = 'monospace';
1.850     bisitz   4569:     my $data_table_head      = $sidebg;
                   4570:     my $data_table_light     = '#FAFAFA';
                   4571:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4572:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4573:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4574:     my $mail_new             = '#FFBB77';
                   4575:     my $mail_new_hover       = '#DD9955';
                   4576:     my $mail_read            = '#BBBB77';
                   4577:     my $mail_read_hover      = '#999944';
                   4578:     my $mail_replied         = '#AAAA88';
                   4579:     my $mail_replied_hover   = '#888855';
                   4580:     my $mail_other           = '#99BBBB';
                   4581:     my $mail_other_hover     = '#669999';
1.391     albertel 4582:     my $table_header         = '#DDDDDD';
1.489     raeburn  4583:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4584:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4585: 
1.608     albertel 4586:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4587: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4588: 	                                                 : '0 3px 0 4px';
1.448     albertel 4589: 
1.523     albertel 4590: 
1.343     albertel 4591:     return <<END;
1.795     www      4592: body {
                   4593:    font-family: $sans;
                   4594:    line-height:130%;
                   4595:    font-size:0.83em;
                   4596:    color:$font;
                   4597: }
                   4598: 
                   4599: a:link, a:visited { 
                   4600:   font-size:100%; 
                   4601: }
                   4602: 
                   4603: a:focus { 
                   4604:   color: red;
                   4605:   background: yellow 
                   4606: }
1.698     harmsja  4607: 
1.846     bisitz   4608: hr {
                   4609:   clear: both;
                   4610:   color: $tabbg;
                   4611:   background-color: $tabbg;
                   4612:   height: 3px;
                   4613:   border: none;
                   4614: }
                   4615: 
1.795     www      4616: form, .inline { 
                   4617:    display: inline; 
                   4618: }
1.721     harmsja  4619: 
1.795     www      4620: .LC_right {
                   4621:    text-align:right;
                   4622: }
                   4623: 
                   4624: .LC_middle {
                   4625:    vertical-align:middle;
                   4626: }
1.721     harmsja  4627: 
                   4628: /* just for tests */
1.754     droeschl 4629: .LC_400Box {width:400px; }
1.721     harmsja  4630: /* end */
                   4631: 
1.778     bisitz   4632: .LC_filename {
                   4633:   font-family: $mono;
                   4634:   white-space:pre;
                   4635: }
                   4636: 
                   4637: .LC_fileicon {
                   4638:   border: none;
                   4639:   height: 1.3em;
                   4640:   vertical-align: text-bottom;
                   4641:   margin-right: 0.3em;
                   4642:   text-decoration:none;
                   4643: }
                   4644: 
1.350     albertel 4645: .LC_error {
                   4646:   color: red;
                   4647:   font-size: larger;
                   4648: }
1.795     www      4649: 
1.457     albertel 4650: .LC_warning,
                   4651: .LC_diff_removed {
1.733     bisitz   4652:   color: red;
1.394     albertel 4653: }
1.532     albertel 4654: 
                   4655: .LC_info,
1.457     albertel 4656: .LC_success,
                   4657: .LC_diff_added {
1.350     albertel 4658:   color: green;
                   4659: }
1.795     www      4660: 
1.802     bisitz   4661: div.LC_confirm_box {
                   4662:   background-color: #FAFAFA;
                   4663:   border: 1px solid $lg_border_color;
                   4664:   margin-right: 0;
                   4665:   padding: 5px;
                   4666: }
                   4667: 
                   4668: div.LC_confirm_box .LC_error img,
                   4669: div.LC_confirm_box .LC_success img {
                   4670:   vertical-align: middle;
                   4671: }
                   4672: 
1.440     albertel 4673: .LC_icon {
1.771     droeschl 4674:   border: none;
1.790     droeschl 4675:   vertical-align: middle;
1.771     droeschl 4676: }
                   4677: 
1.543     albertel 4678: .LC_docs_spacer {
                   4679:   width: 25px;
                   4680:   height: 1px;
1.771     droeschl 4681:   border: none;
1.543     albertel 4682: }
1.346     albertel 4683: 
1.532     albertel 4684: .LC_internal_info {
1.735     bisitz   4685:   color: #999999;
1.532     albertel 4686: }
                   4687: 
1.794     www      4688: .LC_discussion {
                   4689:    background: $tabbg;
                   4690:    border: 1px solid black;
                   4691:    margin: 2px;
                   4692: }
                   4693: 
                   4694: .LC_disc_action_links_bar {
                   4695:    background: $tabbg;
1.803     bisitz   4696:    border: none;
1.795     www      4697:    margin: 4px;
1.794     www      4698: }
                   4699: 
                   4700: .LC_disc_action_left {
                   4701:    text-align: left;
                   4702: }
                   4703: 
                   4704: .LC_disc_action_right {
                   4705:    text-align: right;
                   4706: }
                   4707: 
                   4708: .LC_disc_new_item {
                   4709:    background: white;
                   4710:    border: 2px solid red;
                   4711:    margin: 2px;
                   4712: }
                   4713: 
                   4714: .LC_disc_old_item {
                   4715:    background: white;
                   4716:    border: 1px solid black;
                   4717:    margin: 2px;
                   4718: }
                   4719: 
1.458     albertel 4720: table.LC_pastsubmission {
                   4721:   border: 1px solid black;
                   4722:   margin: 2px;
                   4723: }
                   4724: 
1.795     www      4725: table#LC_top_nav,
                   4726: table#LC_menubuttons,
                   4727: table#LC_nav_location {
1.345     albertel 4728:   width: 100%;
                   4729:   background: $pgbg;
1.392     albertel 4730:   border: 2px;
1.402     albertel 4731:   border-collapse: separate;
1.803     bisitz   4732:   padding: 0;
1.345     albertel 4733: }
1.392     albertel 4734: 
1.801     tempelho 4735: table#LC_title_bar a {
                   4736:   color: $fontmenu;
                   4737: }
1.836     bisitz   4738: 
1.807     droeschl 4739: table#LC_title_bar {
1.819     tempelho 4740:   clear: both;
1.836     bisitz   4741:   display: none;
1.807     droeschl 4742: }
                   4743: 
1.795     www      4744: table#LC_title_bar,
                   4745: table.LC_breadcrumbs,
1.393     albertel 4746: table#LC_title_bar.LC_with_remote {
1.359     albertel 4747:   width: 100%;
1.392     albertel 4748:   border-color: $pgbg;
                   4749:   border-style: solid;
                   4750:   border-width: $border;
1.379     albertel 4751:   background: $pgbg;
1.801     tempelho 4752:   color: $fontmenu;
1.392     albertel 4753:   border-collapse: collapse;
1.803     bisitz   4754:   padding: 0;
1.819     tempelho 4755:   margin: 0;
1.359     albertel 4756: }
1.795     www      4757: 
1.359     albertel 4758: table#LC_title_bar td {
                   4759:   background: $tabbg;
                   4760: }
1.795     www      4761: 
1.706     harmsja  4762: table#LC_menubuttons img{
1.803     bisitz   4763:   border: none;
1.346     albertel 4764: }
1.795     www      4765: 
1.345     albertel 4766: table#LC_top_nav td {
                   4767:   background: $tabbg;
1.803     bisitz   4768:   border: none;
1.407     albertel 4769:   font-size: small;
1.706     harmsja  4770:   vertical-align:top;
                   4771:   padding:2px 5px 2px 5px;
1.345     albertel 4772: }
1.795     www      4773: 
                   4774: table#LC_top_nav td a,
                   4775: div#LC_top_nav a {
1.345     albertel 4776:   color: $font;
                   4777: }
1.795     www      4778: 
1.364     albertel 4779: table#LC_top_nav td.LC_top_nav_logo {
                   4780:   background: $tabbg;
1.432     albertel 4781:   text-align: left;
1.408     albertel 4782:   white-space: nowrap;
1.432     albertel 4783:   width: 31px;
1.408     albertel 4784: }
1.795     www      4785: 
1.408     albertel 4786: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4787:   border: none;
1.408     albertel 4788:   vertical-align: bottom;
1.364     albertel 4789: }
1.795     www      4790: 
1.777     tempelho 4791: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4792: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4793:   width: 2.0em;
                   4794: }
1.795     www      4795: 
1.442     albertel 4796: table#LC_top_nav td.LC_top_nav_login {
                   4797:   width: 4.0em;
                   4798:   text-align: center;
                   4799: }
1.795     www      4800: 
1.842     droeschl 4801: .LC_breadcrumbs_component {
                   4802:     float: right;
                   4803:     margin: 0 1em;
1.357     albertel 4804: }
1.842     droeschl 4805: .LC_breadcrumbs_component img {
                   4806:     vertical-align: middle;
1.777     tempelho 4807: }
1.795     www      4808: 
1.383     albertel 4809: td.LC_table_cell_checkbox {
                   4810:   text-align: center;
                   4811: }
1.795     www      4812: 
1.779     bisitz   4813: table#LC_mainmenu td.LC_mainmenu_column {
                   4814:     vertical-align: top;
1.777     tempelho 4815: }
1.522     albertel 4816: 
1.795     www      4817: .LC_fontsize_small {
1.705     tempelho 4818:  font-size: 70%;
                   4819: }
                   4820: 
1.844     bisitz   4821: #LC_breadcrumbs {
1.819     tempelho 4822:  clear:both;
                   4823:  background: $sidebg;
1.822     bisitz   4824:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4825:  line-height: 32px; 
1.822     bisitz   4826:  margin: 0;
1.819     tempelho 4827:  padding: 0;
                   4828: }
1.839     droeschl 4829: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   4830: #LC_remote #LC_breadcrumbs {
1.839     droeschl 4831:     display:none;
                   4832: }
1.819     tempelho 4833: 
1.844     bisitz   4834: #LC_head_subbox {
1.822     bisitz   4835:  clear:both;
                   4836:  background: #F8F8F8; /* $sidebg; */
                   4837:  border-bottom: 1px solid $lg_border_color;
                   4838:  margin: 0 0 10px 0;
                   4839:  padding: 5px;
                   4840: }
                   4841: 
1.795     www      4842: .LC_fontsize_medium {
1.705     tempelho 4843:  font-size: 85%;
                   4844: }
                   4845: 
1.795     www      4846: .LC_fontsize_large {
1.705     tempelho 4847:  font-size: 120%;
                   4848: }
                   4849: 
1.346     albertel 4850: .LC_menubuttons_inline_text {
                   4851:   color: $font;
1.698     harmsja  4852:   font-size: 90%;
1.701     harmsja  4853:   padding-left:3px;
1.346     albertel 4854: }
                   4855: 
1.526     www      4856: .LC_menubuttons_link {
                   4857:   text-decoration: none;
                   4858: }
1.795     www      4859: 
1.522     albertel 4860: .LC_menubuttons_category {
1.521     www      4861:   color: $font;
1.526     www      4862:   background: $pgbg;
1.521     www      4863:   font-size: larger;
                   4864:   font-weight: bold;
                   4865: }
                   4866: 
1.346     albertel 4867: td.LC_menubuttons_text {
1.779     bisitz   4868:  	color: $font;
1.346     albertel 4869: }
1.706     harmsja  4870: 
1.346     albertel 4871: .LC_current_location {
                   4872:   background: $tabbg;
                   4873: }
1.795     www      4874: 
1.346     albertel 4875: .LC_new_mail {
1.634     www      4876:   background: $tabbg;
1.346     albertel 4877:   font-weight: bold;
                   4878: }
1.347     albertel 4879: 
1.666     raeburn  4880: .LC_roleslog_note {
1.701     harmsja  4881:   font-size: small;
1.666     raeburn  4882: }
                   4883: 
1.795     www      4884: table.LC_data_table,
                   4885: table.LC_mail_list {
1.347     albertel 4886:   border: 1px solid #000000;
1.402     albertel 4887:   border-collapse: separate;
1.426     albertel 4888:   border-spacing: 1px;
1.610     albertel 4889:   background: $pgbg;
1.347     albertel 4890: }
1.795     www      4891: 
1.422     albertel 4892: .LC_data_table_dense {
                   4893:   font-size: small;
                   4894: }
1.795     www      4895: 
1.507     raeburn  4896: table.LC_nested_outer {
                   4897:   border: 1px solid #000000;
1.589     raeburn  4898:   border-collapse: collapse;
1.803     bisitz   4899:   border-spacing: 0;
1.507     raeburn  4900:   width: 100%;
                   4901: }
1.795     www      4902: 
1.507     raeburn  4903: table.LC_nested {
1.803     bisitz   4904:   border: none;
1.589     raeburn  4905:   border-collapse: collapse;
1.803     bisitz   4906:   border-spacing: 0;
1.507     raeburn  4907:   width: 100%;
                   4908: }
1.795     www      4909: 
                   4910: table.LC_data_table tr th, 
                   4911: table.LC_calendar tr th, 
                   4912: table.LC_mail_list tr th,
1.523     albertel 4913: table.LC_prior_tries tr th {
1.349     albertel 4914:   font-weight: bold;
                   4915:   background-color: $data_table_head;
1.801     tempelho 4916:   color:$fontmenu;
1.701     harmsja  4917:   font-size:90%;
1.347     albertel 4918: }
1.795     www      4919: 
1.711     raeburn  4920: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4921:   background-color: #CCCCCC;
1.711     raeburn  4922:   font-weight: bold;
                   4923:   text-align: left;
                   4924: }
1.795     www      4925: 
1.779     bisitz   4926: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4927: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4928:   background-color: $data_table_light;
1.425     albertel 4929:   padding: 2px;
1.347     albertel 4930: }
1.795     www      4931: 
1.610     albertel 4932: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4933: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4934:   background-color: $data_table_dark;
1.709     bisitz   4935:   padding: 2px;
1.347     albertel 4936: }
1.795     www      4937: 
1.425     albertel 4938: table.LC_data_table tr.LC_data_table_highlight td {
                   4939:   background-color: $data_table_darker;
                   4940: }
1.795     www      4941: 
1.639     raeburn  4942: table.LC_data_table tr td.LC_leftcol_header {
                   4943:   background-color: $data_table_head;
                   4944:   font-weight: bold;
                   4945: }
1.795     www      4946: 
1.451     albertel 4947: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4948: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4949:   background-color: #FFFFFF;
1.421     albertel 4950:   font-weight: bold;
                   4951:   font-style: italic;
                   4952:   text-align: center;
                   4953:   padding: 8px;
1.347     albertel 4954: }
1.795     www      4955: 
1.507     raeburn  4956: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4957:   padding: 4ex
                   4958: }
1.795     www      4959: 
1.507     raeburn  4960: table.LC_nested_outer tr th {
                   4961:   font-weight: bold;
1.801     tempelho 4962:   color:$fontmenu;
1.507     raeburn  4963:   background-color: $data_table_head;
1.701     harmsja  4964:   font-size: small;
1.507     raeburn  4965:   border-bottom: 1px solid #000000;
                   4966: }
1.795     www      4967: 
1.507     raeburn  4968: table.LC_nested_outer tr td.LC_subheader {
                   4969:   background-color: $data_table_head;
                   4970:   font-weight: bold;
                   4971:   font-size: small;
                   4972:   border-bottom: 1px solid #000000;
                   4973:   text-align: right;
1.451     albertel 4974: }
1.795     www      4975: 
1.507     raeburn  4976: table.LC_nested tr.LC_info_row td {
1.735     bisitz   4977:   background-color: #CCCCCC;
1.451     albertel 4978:   font-weight: bold;
                   4979:   font-size: small;
1.507     raeburn  4980:   text-align: center;
                   4981: }
1.795     www      4982: 
1.589     raeburn  4983: table.LC_nested tr.LC_info_row td.LC_left_item,
                   4984: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  4985:   text-align: left;
1.451     albertel 4986: }
1.795     www      4987: 
1.507     raeburn  4988: table.LC_nested td {
1.735     bisitz   4989:   background-color: #FFFFFF;
1.451     albertel 4990:   font-size: small;
1.507     raeburn  4991: }
1.795     www      4992: 
1.507     raeburn  4993: table.LC_nested_outer tr th.LC_right_item,
                   4994: table.LC_nested tr.LC_info_row td.LC_right_item,
                   4995: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   4996: table.LC_nested tr td.LC_right_item {
1.451     albertel 4997:   text-align: right;
                   4998: }
                   4999: 
1.507     raeburn  5000: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5001:   background-color: #EEEEEE;
1.451     albertel 5002: }
                   5003: 
1.473     raeburn  5004: table.LC_createuser {
                   5005: }
                   5006: 
                   5007: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5008:   font-size: small;
1.473     raeburn  5009: }
                   5010: 
                   5011: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5012:   background-color: #CCCCCC;
1.473     raeburn  5013:   font-weight: bold;
                   5014:   text-align: center;
                   5015: }
                   5016: 
1.349     albertel 5017: table.LC_calendar {
                   5018:   border: 1px solid #000000;
                   5019:   border-collapse: collapse;
                   5020: }
1.795     www      5021: 
1.349     albertel 5022: table.LC_calendar_pickdate {
                   5023:   font-size: xx-small;
                   5024: }
1.795     www      5025: 
1.349     albertel 5026: table.LC_calendar tr td {
                   5027:   border: 1px solid #000000;
                   5028:   vertical-align: top;
                   5029: }
1.795     www      5030: 
1.349     albertel 5031: table.LC_calendar tr td.LC_calendar_day_empty {
                   5032:   background-color: $data_table_dark;
                   5033: }
1.795     www      5034: 
1.779     bisitz   5035: table.LC_calendar tr td.LC_calendar_day_current {
                   5036:   background-color: $data_table_highlight;
1.777     tempelho 5037: }
1.795     www      5038: 
1.349     albertel 5039: table.LC_mail_list tr.LC_mail_new {
                   5040:   background-color: $mail_new;
                   5041: }
1.795     www      5042: 
1.349     albertel 5043: table.LC_mail_list tr.LC_mail_new:hover {
                   5044:   background-color: $mail_new_hover;
                   5045: }
1.795     www      5046: 
                   5047: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5048: }
1.795     www      5049: 
                   5050: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5051: }
1.795     www      5052: 
1.349     albertel 5053: table.LC_mail_list tr.LC_mail_read {
                   5054:   background-color: $mail_read;
                   5055: }
1.795     www      5056: 
1.349     albertel 5057: table.LC_mail_list tr.LC_mail_read:hover {
                   5058:   background-color: $mail_read_hover;
                   5059: }
1.795     www      5060: 
1.349     albertel 5061: table.LC_mail_list tr.LC_mail_replied {
                   5062:   background-color: $mail_replied;
                   5063: }
1.795     www      5064: 
1.349     albertel 5065: table.LC_mail_list tr.LC_mail_replied:hover {
                   5066:   background-color: $mail_replied_hover;
                   5067: }
1.795     www      5068: 
1.349     albertel 5069: table.LC_mail_list tr.LC_mail_other {
                   5070:   background-color: $mail_other;
                   5071: }
1.795     www      5072: 
1.349     albertel 5073: table.LC_mail_list tr.LC_mail_other:hover {
                   5074:   background-color: $mail_other_hover;
                   5075: }
1.494     raeburn  5076: 
1.777     tempelho 5077: table.LC_data_table tr > td.LC_browser_file,
                   5078: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5079:   background: #CCFF88;
                   5080: }
1.795     www      5081: 
1.777     tempelho 5082: table.LC_data_table tr > td.LC_browser_file_locked,
                   5083: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5084:   background: #FFAA99;
1.387     albertel 5085: }
1.795     www      5086: 
1.777     tempelho 5087: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5088:   background: #AAAAAA;
                   5089: }
1.795     www      5090: 
1.777     tempelho 5091: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5092: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5093:   background: #FFFF77;
1.777     tempelho 5094: }
1.795     www      5095: 
1.696     bisitz   5096: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5097:   background: #CCCCFF;
1.387     albertel 5098: }
1.696     bisitz   5099: 
1.707     bisitz   5100: table.LC_data_table tr > td.LC_roles_is {
                   5101: /*  background: #77FF77; */
                   5102: }
1.795     www      5103: 
1.707     bisitz   5104: table.LC_data_table tr > td.LC_roles_future {
                   5105:   background: #FFFF77;
                   5106: }
1.795     www      5107: 
1.707     bisitz   5108: table.LC_data_table tr > td.LC_roles_will {
                   5109:   background: #FFAA77;
                   5110: }
1.795     www      5111: 
1.707     bisitz   5112: table.LC_data_table tr > td.LC_roles_expired {
                   5113:   background: #FF7777;
                   5114: }
1.795     www      5115: 
1.707     bisitz   5116: table.LC_data_table tr > td.LC_roles_will_not {
                   5117:   background: #AAFF77;
                   5118: }
1.795     www      5119: 
1.707     bisitz   5120: table.LC_data_table tr > td.LC_roles_selected {
                   5121:   background: #11CC55;
                   5122: }
                   5123: 
1.388     albertel 5124: span.LC_current_location {
1.701     harmsja  5125:   font-size:larger;
1.388     albertel 5126:   background: $pgbg;
                   5127: }
1.387     albertel 5128: 
1.395     albertel 5129: span.LC_parm_menu_item {
                   5130:   font-size: larger;
                   5131: }
1.795     www      5132: 
1.395     albertel 5133: span.LC_parm_scope_all {
                   5134:   color: red;
                   5135: }
1.795     www      5136: 
1.395     albertel 5137: span.LC_parm_scope_folder {
                   5138:   color: green;
                   5139: }
1.795     www      5140: 
1.395     albertel 5141: span.LC_parm_scope_resource {
                   5142:   color: orange;
                   5143: }
1.795     www      5144: 
1.395     albertel 5145: span.LC_parm_part {
                   5146:   color: blue;
                   5147: }
1.795     www      5148: 
1.395     albertel 5149: span.LC_parm_folder, span.LC_parm_symb {
                   5150:   font-size: x-small;
                   5151:   font-family: $mono;
                   5152:   color: #AAAAAA;
                   5153: }
                   5154: 
1.795     www      5155: td.LC_parm_overview_level_menu,
                   5156: td.LC_parm_overview_map_menu,
                   5157: td.LC_parm_overview_parm_selectors,
                   5158: td.LC_parm_overview_restrictions  {
1.396     albertel 5159:   border: 1px solid black;
                   5160:   border-collapse: collapse;
                   5161: }
1.795     www      5162: 
1.396     albertel 5163: table.LC_parm_overview_restrictions td {
                   5164:   border-width: 1px 4px 1px 4px;
                   5165:   border-style: solid;
                   5166:   border-color: $pgbg;
                   5167:   text-align: center;
                   5168: }
1.795     www      5169: 
1.396     albertel 5170: table.LC_parm_overview_restrictions th {
                   5171:   background: $tabbg;
                   5172:   border-width: 1px 4px 1px 4px;
                   5173:   border-style: solid;
                   5174:   border-color: $pgbg;
                   5175: }
1.795     www      5176: 
1.398     albertel 5177: table#LC_helpmenu {
1.803     bisitz   5178:   border: none;
1.398     albertel 5179:   height: 55px;
1.803     bisitz   5180:   border-spacing: 0;
1.398     albertel 5181: }
                   5182: 
                   5183: table#LC_helpmenu fieldset legend {
                   5184:   font-size: larger;
                   5185: }
1.795     www      5186: 
1.397     albertel 5187: table#LC_helpmenu_links {
                   5188:   width: 100%;
                   5189:   border: 1px solid black;
                   5190:   background: $pgbg;
1.803     bisitz   5191:   padding: 0;
1.397     albertel 5192:   border-spacing: 1px;
                   5193: }
1.795     www      5194: 
1.397     albertel 5195: table#LC_helpmenu_links tr td {
                   5196:   padding: 1px;
                   5197:   background: $tabbg;
1.399     albertel 5198:   text-align: center;
                   5199:   font-weight: bold;
1.397     albertel 5200: }
1.396     albertel 5201: 
1.795     www      5202: table#LC_helpmenu_links a:link,
                   5203: table#LC_helpmenu_links a:visited,
1.397     albertel 5204: table#LC_helpmenu_links a:active {
                   5205:   text-decoration: none;
                   5206:   color: $font;
                   5207: }
1.795     www      5208: 
1.397     albertel 5209: table#LC_helpmenu_links a:hover {
                   5210:   text-decoration: underline;
                   5211:   color: $vlink;
                   5212: }
1.396     albertel 5213: 
1.417     albertel 5214: .LC_chrt_popup_exists {
                   5215:   border: 1px solid #339933;
                   5216:   margin: -1px;
                   5217: }
1.795     www      5218: 
1.417     albertel 5219: .LC_chrt_popup_up {
                   5220:   border: 1px solid yellow;
                   5221:   margin: -1px;
                   5222: }
1.795     www      5223: 
1.417     albertel 5224: .LC_chrt_popup {
                   5225:   border: 1px solid #8888FF;
                   5226:   background: #CCCCFF;
                   5227: }
1.795     www      5228: 
1.421     albertel 5229: table.LC_pick_box {
                   5230:   border-collapse: separate;
                   5231:   background: white;
                   5232:   border: 1px solid black;
                   5233:   border-spacing: 1px;
                   5234: }
1.795     www      5235: 
1.421     albertel 5236: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5237:   background: $sidebg;
1.421     albertel 5238:   font-weight: bold;
                   5239:   text-align: right;
1.740     bisitz   5240:   vertical-align: top;
1.421     albertel 5241:   width: 184px;
                   5242:   padding: 8px;
                   5243: }
1.795     www      5244: 
1.645     raeburn  5245: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5246:   background: $tabbg;
                   5247:   font-weight: bold;
                   5248:   text-align: right;
                   5249:   width: 350px;
                   5250:   padding: 8px;
                   5251: }
                   5252: 
1.579     raeburn  5253: table.LC_pick_box td.LC_pick_box_value {
                   5254:   text-align: left;
                   5255:   padding: 8px;
                   5256: }
1.795     www      5257: 
1.579     raeburn  5258: table.LC_pick_box td.LC_pick_box_select {
                   5259:   text-align: left;
                   5260:   padding: 8px;
                   5261: }
1.795     www      5262: 
1.424     albertel 5263: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5264:   padding: 0;
1.421     albertel 5265:   height: 1px;
                   5266:   background: black;
                   5267: }
1.795     www      5268: 
1.421     albertel 5269: table.LC_pick_box td.LC_pick_box_submit {
                   5270:   text-align: right;
                   5271: }
1.795     www      5272: 
1.579     raeburn  5273: table.LC_pick_box td.LC_evenrow_value {
                   5274:   text-align: left;
                   5275:   padding: 8px;
                   5276:   background-color: $data_table_light;
                   5277: }
1.795     www      5278: 
1.579     raeburn  5279: table.LC_pick_box td.LC_oddrow_value {
                   5280:   text-align: left;
                   5281:   padding: 8px;
                   5282:   background-color: $data_table_light;
                   5283: }
1.795     www      5284: 
1.579     raeburn  5285: table.LC_helpform_receipt {
                   5286:   width: 620px;
                   5287:   border-collapse: separate;
                   5288:   background: white;
                   5289:   border: 1px solid black;
                   5290:   border-spacing: 1px;
                   5291: }
1.795     www      5292: 
1.579     raeburn  5293: table.LC_helpform_receipt td.LC_pick_box_title {
                   5294:   background: $tabbg;
                   5295:   font-weight: bold;
                   5296:   text-align: right;
                   5297:   width: 184px;
                   5298:   padding: 8px;
                   5299: }
1.795     www      5300: 
1.579     raeburn  5301: table.LC_helpform_receipt td.LC_evenrow_value {
                   5302:   text-align: left;
                   5303:   padding: 8px;
                   5304:   background-color: $data_table_light;
                   5305: }
1.795     www      5306: 
1.579     raeburn  5307: table.LC_helpform_receipt td.LC_oddrow_value {
                   5308:   text-align: left;
                   5309:   padding: 8px;
                   5310:   background-color: $data_table_light;
                   5311: }
1.795     www      5312: 
1.579     raeburn  5313: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5314:   padding: 0;
1.579     raeburn  5315:   height: 1px;
                   5316:   background: black;
                   5317: }
1.795     www      5318: 
1.579     raeburn  5319: span.LC_helpform_receipt_cat {
                   5320:   font-weight: bold;
                   5321: }
1.795     www      5322: 
1.424     albertel 5323: table.LC_group_priv_box {
                   5324:   background: white;
                   5325:   border: 1px solid black;
                   5326:   border-spacing: 1px;
                   5327: }
1.795     www      5328: 
1.424     albertel 5329: table.LC_group_priv_box td.LC_pick_box_title {
                   5330:   background: $tabbg;
                   5331:   font-weight: bold;
                   5332:   text-align: right;
                   5333:   width: 184px;
                   5334: }
1.795     www      5335: 
1.424     albertel 5336: table.LC_group_priv_box td.LC_groups_fixed {
                   5337:   background: $data_table_light;
                   5338:   text-align: center;
                   5339: }
1.795     www      5340: 
1.424     albertel 5341: table.LC_group_priv_box td.LC_groups_optional {
                   5342:   background: $data_table_dark;
                   5343:   text-align: center;
                   5344: }
1.795     www      5345: 
1.424     albertel 5346: table.LC_group_priv_box td.LC_groups_functionality {
                   5347:   background: $data_table_darker;
                   5348:   text-align: center;
                   5349:   font-weight: bold;
                   5350: }
1.795     www      5351: 
1.424     albertel 5352: table.LC_group_priv td {
                   5353:   text-align: left;
1.803     bisitz   5354:   padding: 0;
1.424     albertel 5355: }
                   5356: 
1.421     albertel 5357: table.LC_notify_front_page {
                   5358:   background: white;
                   5359:   border: 1px solid black;
                   5360:   padding: 8px;
                   5361: }
1.795     www      5362: 
1.421     albertel 5363: table.LC_notify_front_page td {
                   5364:   padding: 8px;
                   5365: }
1.795     www      5366: 
1.424     albertel 5367: .LC_navbuttons {
                   5368:   margin: 2ex 0ex 2ex 0ex;
                   5369: }
1.795     www      5370: 
1.423     albertel 5371: .LC_topic_bar {
                   5372:   font-weight: bold;
                   5373:   width: 100%;
                   5374:   background: $tabbg;
                   5375:   vertical-align: middle;
                   5376:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5377:   padding: 3px;
1.423     albertel 5378: }
1.795     www      5379: 
1.423     albertel 5380: .LC_topic_bar span {
                   5381:   vertical-align: middle;
                   5382: }
1.795     www      5383: 
1.423     albertel 5384: .LC_topic_bar img {
                   5385:   vertical-align: bottom;
                   5386: }
1.795     www      5387: 
1.423     albertel 5388: table.LC_course_group_status {
                   5389:   margin: 20px;
                   5390: }
1.795     www      5391: 
1.423     albertel 5392: table.LC_status_selector td {
                   5393:   vertical-align: top;
                   5394:   text-align: center;
1.424     albertel 5395:   padding: 4px;
                   5396: }
1.795     www      5397: 
1.599     albertel 5398: div.LC_feedback_link {
1.616     albertel 5399:   clear: both;
1.829     kalberla 5400:   background: $sidebg;
1.779     bisitz   5401:   width: 100%;
1.829     kalberla 5402:   padding-bottom: 10px;
                   5403:   border: 1px $tabbg solid;
1.833     kalberla 5404:   height: 22px;
                   5405:   line-height: 22px;
                   5406:   padding-top: 5px;
                   5407: }
                   5408: 
                   5409: div.LC_feedback_link img {
                   5410:   height: 22px;
1.829     kalberla 5411: }
                   5412: 
                   5413: div.LC_feedback_link a{
                   5414:   text-decoration: none;
1.489     raeburn  5415: }
1.795     www      5416: 
1.489     raeburn  5417: span.LC_feedback_link {
1.829     kalberla 5418:   //background: $feedback_link_bg;
1.599     albertel 5419:   font-size: larger;
                   5420: }
1.795     www      5421: 
1.599     albertel 5422: span.LC_message_link {
1.829     kalberla 5423:   //background: $feedback_link_bg;
1.599     albertel 5424:   font-size: larger;
                   5425:   position: absolute;
                   5426:   right: 1em;
1.489     raeburn  5427: }
1.421     albertel 5428: 
1.515     albertel 5429: table.LC_prior_tries {
1.524     albertel 5430:   border: 1px solid #000000;
                   5431:   border-collapse: separate;
                   5432:   border-spacing: 1px;
1.515     albertel 5433: }
1.523     albertel 5434: 
1.515     albertel 5435: table.LC_prior_tries td {
1.524     albertel 5436:   padding: 2px;
1.515     albertel 5437: }
1.523     albertel 5438: 
                   5439: .LC_answer_correct {
1.795     www      5440:   background: lightgreen;
                   5441:   color: darkgreen;
                   5442:   padding: 6px;
1.523     albertel 5443: }
1.795     www      5444: 
1.523     albertel 5445: .LC_answer_charged_try {
1.797     www      5446:   background: #FFAAAA;
1.795     www      5447:   color: darkred;
                   5448:   padding: 6px;
1.523     albertel 5449: }
1.795     www      5450: 
1.779     bisitz   5451: .LC_answer_not_charged_try,
1.523     albertel 5452: .LC_answer_no_grade,
                   5453: .LC_answer_late {
1.795     www      5454:   background: lightyellow;
1.523     albertel 5455:   color: black;
1.795     www      5456:   padding: 6px;
1.523     albertel 5457: }
1.795     www      5458: 
1.523     albertel 5459: .LC_answer_previous {
1.795     www      5460:   background: lightblue;
                   5461:   color: darkblue;
                   5462:   padding: 6px;
1.523     albertel 5463: }
1.795     www      5464: 
1.779     bisitz   5465: .LC_answer_no_message {
1.777     tempelho 5466:   background: #FFFFFF;
                   5467:   color: black;
1.795     www      5468:   padding: 6px;
1.779     bisitz   5469: }
1.795     www      5470: 
1.779     bisitz   5471: .LC_answer_unknown {
                   5472:   background: orange;
                   5473:   color: black;
1.795     www      5474:   padding: 6px;
1.777     tempelho 5475: }
1.795     www      5476: 
1.529     albertel 5477: span.LC_prior_numerical,
                   5478: span.LC_prior_string,
                   5479: span.LC_prior_custom,
                   5480: span.LC_prior_reaction,
                   5481: span.LC_prior_math {
1.523     albertel 5482:   font-family: monospace;
                   5483:   white-space: pre;
                   5484: }
                   5485: 
1.525     albertel 5486: span.LC_prior_string {
                   5487:   font-family: monospace;
                   5488:   white-space: pre;
                   5489: }
                   5490: 
1.523     albertel 5491: table.LC_prior_option {
                   5492:   width: 100%;
                   5493:   border-collapse: collapse;
                   5494: }
1.795     www      5495: 
                   5496: table.LC_prior_rank, 
                   5497: table.LC_prior_match {
1.528     albertel 5498:   border-collapse: collapse;
                   5499: }
1.795     www      5500: 
1.528     albertel 5501: table.LC_prior_option tr td,
                   5502: table.LC_prior_rank tr td,
                   5503: table.LC_prior_match tr td {
1.524     albertel 5504:   border: 1px solid #000000;
1.515     albertel 5505: }
                   5506: 
1.770     droeschl 5507: td.LC_nobreak,
1.519     raeburn  5508: span.LC_nobreak {
1.544     albertel 5509:   white-space: nowrap;
1.519     raeburn  5510: }
                   5511: 
1.576     raeburn  5512: span.LC_cusr_emph {
                   5513:   font-style: italic;
                   5514: }
                   5515: 
1.633     raeburn  5516: span.LC_cusr_subheading {
                   5517:   font-weight: normal;
                   5518:   font-size: 85%;
                   5519: }
                   5520: 
1.545     albertel 5521: table.LC_docs_documents {
                   5522:   background: #BBBBBB;
1.803     bisitz   5523:   border-width: 0;
1.545     albertel 5524:   border-collapse: collapse;
                   5525: }
1.795     www      5526: 
1.777     tempelho 5527: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5528:   border: 2px solid black;
                   5529:   padding: 4px;
1.777     tempelho 5530: }
1.795     www      5531: 
1.545     albertel 5532: .LC_docs_entry_move {
1.803     bisitz   5533:   border: none;
1.545     albertel 5534:   border-collapse: collapse;
1.544     albertel 5535: }
                   5536: 
1.545     albertel 5537: .LC_docs_entry_move td {
                   5538:   border: 2px solid #BBBBBB;
                   5539:   background: #DDDDDD;
                   5540: }
                   5541: 
                   5542: .LC_docs_editor td.LC_docs_entry_commands {
                   5543:   background: #DDDDDD;
                   5544:   font-size: x-small;
                   5545: }
1.795     www      5546: 
1.544     albertel 5547: .LC_docs_copy {
1.545     albertel 5548:   color: #000099;
1.544     albertel 5549: }
1.795     www      5550: 
1.544     albertel 5551: .LC_docs_cut {
1.545     albertel 5552:   color: #550044;
1.544     albertel 5553: }
1.795     www      5554: 
1.544     albertel 5555: .LC_docs_rename {
1.545     albertel 5556:   color: #009900;
1.544     albertel 5557: }
1.795     www      5558: 
1.544     albertel 5559: .LC_docs_remove {
1.545     albertel 5560:   color: #990000;
                   5561: }
                   5562: 
1.547     albertel 5563: .LC_docs_reinit_warn,
                   5564: .LC_docs_ext_edit {
                   5565:   font-size: x-small;
                   5566: }
                   5567: 
1.545     albertel 5568: .LC_docs_editor td.LC_docs_entry_title,
                   5569: .LC_docs_editor td.LC_docs_entry_icon {
                   5570:   background: #FFFFBB;
                   5571: }
1.795     www      5572: 
1.545     albertel 5573: .LC_docs_editor td.LC_docs_entry_parameter {
                   5574:   background: #BBBBFF;
                   5575:   font-size: x-small;
                   5576:   white-space: nowrap;
                   5577: }
                   5578: 
                   5579: table.LC_docs_adddocs td,
                   5580: table.LC_docs_adddocs th {
                   5581:   border: 1px solid #BBBBBB;
                   5582:   padding: 4px;
                   5583:   background: #DDDDDD;
1.543     albertel 5584: }
                   5585: 
1.584     albertel 5586: table.LC_sty_begin {
                   5587:   background: #BBFFBB;
                   5588: }
1.795     www      5589: 
1.584     albertel 5590: table.LC_sty_end {
                   5591:   background: #FFBBBB;
                   5592: }
                   5593: 
1.589     raeburn  5594: table.LC_double_column {
1.803     bisitz   5595:   border-width: 0;
1.589     raeburn  5596:   border-collapse: collapse;
                   5597:   width: 100%;
                   5598:   padding: 2px;
                   5599: }
                   5600: 
                   5601: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5602:   top: 2px;
1.589     raeburn  5603:   left: 2px;
                   5604:   width: 47%;
                   5605:   vertical-align: top;
                   5606: }
                   5607: 
                   5608: table.LC_double_column tr td.LC_right_col {
                   5609:   top: 2px;
1.779     bisitz   5610:   right: 2px;
1.589     raeburn  5611:   width: 47%;
                   5612:   vertical-align: top;
                   5613: }
                   5614: 
1.594     raeburn  5615: span.LC_role_level {
                   5616:   font-weight: bold;
                   5617: }
                   5618: 
1.591     raeburn  5619: div.LC_left_float {
                   5620:   float: left;
                   5621:   padding-right: 5%;
1.597     albertel 5622:   padding-bottom: 4px;
1.591     raeburn  5623: }
                   5624: 
                   5625: div.LC_clear_float_header {
1.597     albertel 5626:   padding-bottom: 2px;
1.591     raeburn  5627: }
                   5628: 
                   5629: div.LC_clear_float_footer {
1.597     albertel 5630:   padding-top: 10px;
1.591     raeburn  5631:   clear: both;
                   5632: }
                   5633: 
1.597     albertel 5634: div.LC_grade_show_user {
                   5635:   margin-top: 20px;
                   5636:   border: 1px solid black;
                   5637: }
1.795     www      5638: 
1.597     albertel 5639: div.LC_grade_user_name {
                   5640:   background: #DDDDEE;
                   5641:   border-bottom: 1px solid black;
1.705     tempelho 5642:   font-weight: bold;
                   5643:   font-size: large;
1.597     albertel 5644: }
1.795     www      5645: 
1.597     albertel 5646: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5647:   background: #DDEEDD;
                   5648: }
                   5649: 
                   5650: div.LC_grade_show_problem,
                   5651: div.LC_grade_submissions,
                   5652: div.LC_grade_message_center,
                   5653: div.LC_grade_info_links,
                   5654: div.LC_grade_assign {
                   5655:   margin: 5px;
                   5656:   width: 99%;
                   5657:   background: #FFFFFF;
                   5658: }
1.795     www      5659: 
1.597     albertel 5660: div.LC_grade_show_problem_header,
                   5661: div.LC_grade_submissions_header,
                   5662: div.LC_grade_message_center_header,
                   5663: div.LC_grade_assign_header {
1.705     tempelho 5664:   font-weight: bold;
                   5665:   font-size: large;
1.597     albertel 5666: }
1.795     www      5667: 
1.597     albertel 5668: div.LC_grade_show_problem_problem,
                   5669: div.LC_grade_submissions_body,
                   5670: div.LC_grade_message_center_body,
                   5671: div.LC_grade_assign_body {
                   5672:   border: 1px solid black;
                   5673:   width: 99%;
                   5674:   background: #FFFFFF;
                   5675: }
1.795     www      5676: 
1.598     albertel 5677: span.LC_grade_check_note {
1.705     tempelho 5678:   font-weight: normal;
                   5679:   font-size: medium;
1.598     albertel 5680:   display: inline;
                   5681:   position: absolute;
                   5682:   right: 1em;
                   5683: }
1.597     albertel 5684: 
1.613     albertel 5685: table.LC_scantron_action {
                   5686:   width: 100%;
                   5687: }
1.795     www      5688: 
1.613     albertel 5689: table.LC_scantron_action tr th {
1.698     harmsja  5690:   font-weight:bold;
                   5691:   font-style:normal;
1.613     albertel 5692: }
1.795     www      5693: 
1.779     bisitz   5694: .LC_edit_problem_header,
1.614     albertel 5695: div.LC_edit_problem_footer {
1.705     tempelho 5696:   font-weight: normal;
                   5697:   font-size:  medium;
1.602     albertel 5698:   margin: 2px;
1.600     albertel 5699: }
1.795     www      5700: 
1.600     albertel 5701: div.LC_edit_problem_header,
1.602     albertel 5702: div.LC_edit_problem_header div,
1.614     albertel 5703: div.LC_edit_problem_footer,
                   5704: div.LC_edit_problem_footer div,
1.602     albertel 5705: div.LC_edit_problem_editxml_header,
                   5706: div.LC_edit_problem_editxml_header div {
1.600     albertel 5707:   margin-top: 5px;
                   5708: }
1.795     www      5709: 
1.600     albertel 5710: div.LC_edit_problem_header_title {
1.705     tempelho 5711:   font-weight: bold;
                   5712:   font-size: larger;
1.602     albertel 5713:   background: $tabbg;
                   5714:   padding: 3px;
                   5715: }
1.795     www      5716: 
1.602     albertel 5717: table.LC_edit_problem_header_title {
1.705     tempelho 5718:   font-size: larger;
                   5719:   font-weight:  bold;
1.602     albertel 5720:   width: 100%;
                   5721:   border-color: $pgbg;
                   5722:   border-style: solid;
                   5723:   border-width: $border;
1.600     albertel 5724:   background: $tabbg;
1.602     albertel 5725:   border-collapse: collapse;
1.803     bisitz   5726:   padding: 0;
1.602     albertel 5727: }
                   5728: 
                   5729: div.LC_edit_problem_discards {
                   5730:   float: left;
                   5731:   padding-bottom: 5px;
                   5732: }
1.795     www      5733: 
1.602     albertel 5734: div.LC_edit_problem_saves {
                   5735:   float: right;
                   5736:   padding-bottom: 5px;
1.600     albertel 5737: }
1.795     www      5738: 
1.679     riegler  5739: img.stift{
1.803     bisitz   5740:   border-width: 0;
                   5741:   vertical-align: middle;
1.677     riegler  5742: }
1.680     riegler  5743: 
1.681     riegler  5744: table#LC_mainmenu{
                   5745:  margin-top:10px;
                   5746:  width:80%;
                   5747: }
                   5748: 
1.680     riegler  5749: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5750:   vertical-align: top;
                   5751:   width: 45%;
                   5752: }
1.795     www      5753: 
1.779     bisitz   5754: .LC_mainmenu_fieldset_category {
                   5755:   color: $font;
                   5756:   background: $pgbg;
                   5757:   font-size: small;
                   5758:   font-weight: bold;
1.777     tempelho 5759: }
1.795     www      5760: 
1.716     raeburn  5761: div.LC_createcourse {
                   5762:     margin: 10px 10px 10px 10px;
                   5763: }
                   5764: 
1.693     droeschl 5765: /* ---- Remove when done ----
                   5766: # The following styles is part of the redesign of LON-CAPA and are
                   5767: # subject to change during this project.
                   5768: # Don't rely on their current functionality as they might be 
                   5769: # changed or removed.
                   5770: # --------------------------*/
                   5771: 
1.698     harmsja  5772: a:hover,
1.721     harmsja  5773: ol.LC_smallMenu a:hover,
                   5774: ol#LC_MenuBreadcrumbs a:hover,
                   5775: ol#LC_PathBreadcrumbs a:hover,
                   5776: ul#LC_TabMainMenuContent a:hover,
                   5777: .LC_FormSectionClearButton input:hover
1.795     www      5778: ul.LC_TabContent   li:hover a {
1.698     harmsja  5779: 	color:#BF2317;
                   5780:         text-decoration:none;
1.693     droeschl 5781: }
                   5782: 
1.779     bisitz   5783: h1 {
1.813     bisitz   5784: 	padding: 0;
1.693     droeschl 5785: 	line-height:130%;
                   5786: }
1.698     harmsja  5787: 
1.795     www      5788: h2,h3,h4,h5,h6 {
1.803     bisitz   5789: 	margin: 5px 0 5px 0;
                   5790: 	padding: 0;
1.721     harmsja  5791: 	line-height:130%;
1.693     droeschl 5792: }
1.795     www      5793: 
                   5794: .LC_hcell {
1.698     harmsja  5795:         padding:3px 15px 3px 15px;
1.803     bisitz   5796:         margin: 0;
1.703     harmsja  5797: 	background-color:$tabbg;
1.801     tempelho 5798: 	color:$fontmenu;
1.779     bisitz   5799: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5800: }
1.795     www      5801: 
1.840     bisitz   5802: .LC_Box > .LC_hcell {
1.847     tempelho 5803:     margin: 0 -10px 10px -10px;
1.835     bisitz   5804: }
                   5805: 
1.721     harmsja  5806: .LC_noBorder {
1.803     bisitz   5807:         border: 0;
1.698     harmsja  5808: }
1.693     droeschl 5809: 
1.761     tempelho 5810: .LC_Right {
                   5811:         float: right;
1.803     bisitz   5812:         margin: 0;
                   5813:         padding: 0;
1.761     tempelho 5814: }
                   5815: 
1.721     harmsja  5816: .LC_FormSectionClearButton input {
1.779     bisitz   5817:         background-color:transparent;
1.803     bisitz   5818:         border: none;
1.698     harmsja  5819:         cursor:pointer;
                   5820:         text-decoration:underline;
1.693     droeschl 5821: }
1.763     bisitz   5822: 
                   5823: .LC_help_open_topic {
                   5824:         color: #FFFFFF;
                   5825:         background-color: #EEEEFF;
                   5826:         margin: 1px;
                   5827:         padding: 4px;
                   5828:         border: 1px solid #000033;
                   5829:         white-space: nowrap;
1.783     amueller 5830: /*		vertical-align: middle; */
1.759     neumanie 5831: }
1.693     droeschl 5832: 
1.698     harmsja  5833: dl,ul,div,fieldset {
1.803     bisitz   5834: 	margin: 10px 10px 10px 0;
1.806     bisitz   5835: /*	overflow: hidden; */
1.693     droeschl 5836: }
1.795     www      5837: 
1.838     bisitz   5838: fieldset > legend {
                   5839:     font-weight: bold;
                   5840:     padding: 0 5px 0 5px;
                   5841: }
                   5842: 
1.813     bisitz   5843: #LC_nav_bar {
1.807     droeschl 5844:     float: left;
                   5845:     margin: 0;
                   5846: }
                   5847: 
1.813     bisitz   5848: #LC_nav_bar em{
1.807     droeschl 5849:     font-weight: bold;
                   5850:     font-style: normal;
                   5851: }
                   5852: 
                   5853: ol.LC_smallMenu {
                   5854:     float: right;
                   5855: }
                   5856: 
1.721     harmsja  5857: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803     bisitz   5858: 	margin: 0;
1.693     droeschl 5859: }
                   5860: 
1.721     harmsja  5861: ol.LC_smallMenu li {
1.693     droeschl 5862: 	display: inline;
1.803     bisitz   5863: 	padding: 5px 5px 0 10px;
1.693     droeschl 5864: 	vertical-align: top;
                   5865: }
                   5866: 
1.721     harmsja  5867: ol.LC_smallMenu li img {
1.693     droeschl 5868: 	vertical-align: bottom;
                   5869: }
                   5870: 
1.721     harmsja  5871: ol.LC_smallMenu a {
1.693     droeschl 5872: 	font-size: 90%;
                   5873: 	color: RGB(80, 80, 80);
                   5874: 	text-decoration: none;
                   5875: }
1.795     www      5876: 
1.808     droeschl 5877: ul#LC_TabMainMenuContent {
1.807     droeschl 5878:     clear: both;
1.808     droeschl 5879:     color: $fontmenu;
                   5880:     background: $tabbg;
                   5881:     list-style: none;
                   5882:     padding: 0;
                   5883:     margin: 0;
                   5884:     float:left;
                   5885:     width: 100%;
                   5886: }
                   5887: 
                   5888: ul#LC_TabMainMenuContent li {
                   5889:     float: left;
                   5890:     font-weight: bold;
                   5891:     line-height: 1.8em;
                   5892:     padding: 0 0.8em; 
                   5893:     border-right: 1px solid black;
                   5894:     display: inline;
                   5895:     vertical-align: middle;
1.807     droeschl 5896: }
                   5897: 
1.847     tempelho 5898: ul.LC_TabContent {
1.721     harmsja  5899: 	display:block;
1.847     tempelho 5900: 	background: $sidebg;
                   5901: 	border-bottom: solid 1px $lg_border_color
1.721     harmsja  5902: 	list-style:none;
1.847     tempelho 5903: 	margin: -10px -10px 0 -10px;
1.803     bisitz   5904: 	padding: 0;
1.693     droeschl 5905: }
                   5906: 
1.847     tempelho 5907: ul.LC_TabContentBigger {
                   5908:         display:block;
                   5909:         list-style:none;
                   5910:         padding: 0;
                   5911: }
                   5912: 
                   5913: 
1.795     www      5914: ul.LC_TabContent li,
                   5915: ul.LC_TabContentBigger li {
1.693     droeschl 5916: 	display: inline;
1.741     harmsja  5917: 	border-right: solid 1px $lg_border_color;
                   5918: 	float:left;
                   5919: 	line-height:140%;
                   5920: 	white-space:nowrap;
                   5921: }
1.795     www      5922: 
1.808     droeschl 5923: ul#LC_TabMainMenuContent li a {
                   5924:     color: $fontmenu;
1.693     droeschl 5925: 	text-decoration: none;
                   5926: }
1.795     www      5927: 
1.721     harmsja  5928: ul.LC_TabContent {
1.847     tempelho 5929: 	min-height:1.5em;
1.721     harmsja  5930: }
1.795     www      5931: 
                   5932: ul.LC_TabContent li {
1.741     harmsja  5933: 	vertical-align:middle;
1.803     bisitz   5934: 	padding: 0 10px 0 10px;
1.745     ehlerst  5935: 	background-color:$tabbg;
                   5936: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5937: }
1.795     www      5938: 
1.847     tempelho 5939: ul.LC_TabContent .right {
                   5940: 	float:right;
                   5941: }
                   5942: 
1.795     www      5943: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5944: 	color:rgb(47,47,47);
                   5945: 	text-decoration:none;
                   5946: 	font-size:95%;
                   5947: 	font-weight:bold;
1.761     tempelho 5948: 	padding-right: 16px;
1.721     harmsja  5949: }
1.795     www      5950: 
                   5951: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5952:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.841     tempelho 5953: 	border-bottom:solid 2px #FFFFFF;
1.761     tempelho 5954: 	padding-right: 16px;
1.744     ehlerst  5955: }
1.795     www      5956: 
                   5957: ul.LC_TabContentBigger li {
1.741     harmsja  5958: 	vertical-align:bottom;
                   5959: 	border-top:solid 1px $lg_border_color;
                   5960: 	border-left:solid 1px $lg_border_color;
                   5961: 	padding:5px 10px 5px 10px;
                   5962: 	margin-left:2px;
1.841     tempelho 5963: 	background: #d9d9d9;
                   5964: }
                   5965: 
                   5966: #maincoursedoc {
                   5967: 	clear:both;
1.741     harmsja  5968: }
1.795     www      5969: 
                   5970: ul.LC_TabContentBigger li:hover, 
                   5971: ul.LC_TabContentBigger li.active {
1.847     tempelho 5972: 	background: #ffffff;
1.744     ehlerst  5973: }
1.795     www      5974: 
                   5975: ul.LC_TabContentBigger li, 
                   5976: ul.LC_TabContentBigger li a {
1.741     harmsja  5977: 	font-size:110%;
                   5978: 	font-weight:bold;
                   5979: }
1.693     droeschl 5980: 
1.795     www      5981: ol#LC_MenuBreadcrumbs, 
                   5982: ol#LC_PathBreadcrumbs, 
1.823     bisitz   5983: ul#LC_CourseBreadcrumbs {
1.693     droeschl 5984: 	padding-left: 10px;
1.819     tempelho 5985: 	margin: 0;
1.693     droeschl 5986: 	list-style-position: inside;
                   5987: }
                   5988: 
1.795     www      5989: ol#LC_MenuBreadcrumbs li, 
                   5990: ol#LC_PathBreadcrumbs li, 
1.823     bisitz   5991: ul#LC_CourseBreadcrumbs li {
1.842     droeschl 5992:     display: inline;
                   5993:     white-space: nowrap;
1.693     droeschl 5994: }
                   5995: 
1.823     bisitz   5996: ol#LC_MenuBreadcrumbs li a,
                   5997: ul#LC_CourseBreadcrumbs li a {
1.693     droeschl 5998: 	text-decoration: none;
                   5999: 	font-size:90%;
                   6000: }
1.795     www      6001: 
                   6002: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6003: 	text-decoration:none;
                   6004: 	font-size:100%;
                   6005: 	font-weight:bold;
1.693     droeschl 6006: }
1.795     www      6007: 
1.840     bisitz   6008: .LC_Box {
1.835     bisitz   6009:     border: solid 1px $lg_border_color;
                   6010:     padding: 0 10px 10px 10px;
1.746     neumanie 6011: }
1.795     www      6012: 
                   6013: .LC_AboutMe_Image {
1.747     neumanie 6014: 	float:left;
                   6015: 	margin-right:10px;
                   6016: }
1.795     www      6017: 
                   6018: .LC_Clear_AboutMe_Image {
1.747     neumanie 6019: 	clear:left;
                   6020: }
1.795     www      6021: 
1.721     harmsja  6022: dl.LC_ListStyleClean dt {
1.693     droeschl 6023: 	padding-right: 5px;
                   6024: 	display: table-header-group;
                   6025: }
                   6026: 
1.721     harmsja  6027: dl.LC_ListStyleClean dd {
1.693     droeschl 6028: 	display: table-row;
                   6029: }
                   6030: 
1.721     harmsja  6031: .LC_ListStyleClean,
                   6032: .LC_ListStyleSimple,
                   6033: .LC_ListStyleNormal,
1.777     tempelho 6034: .LC_ListStyle_Border,
1.795     www      6035: .LC_ListStyleSpecial {
1.693     droeschl 6036: 	/*display:block;	*/
                   6037: 	list-style-position: inside;
                   6038: 	list-style-type: none;
                   6039: 	overflow: hidden;
1.803     bisitz   6040: 	padding: 0;
1.693     droeschl 6041: }
                   6042: 
1.721     harmsja  6043: .LC_ListStyleSimple li,
                   6044: .LC_ListStyleSimple dd,
                   6045: .LC_ListStyleNormal li,
                   6046: .LC_ListStyleNormal dd,
                   6047: .LC_ListStyleSpecial li,
1.795     www      6048: .LC_ListStyleSpecial dd {
1.803     bisitz   6049: 	margin: 0;
1.693     droeschl 6050: 	padding: 5px 5px 5px 10px;
                   6051: 	clear: both;
                   6052: }
                   6053: 
1.721     harmsja  6054: .LC_ListStyleClean li,
                   6055: .LC_ListStyleClean dd {
1.803     bisitz   6056: 	padding-top: 0;
                   6057: 	padding-bottom: 0;
1.693     droeschl 6058: }
                   6059: 
1.721     harmsja  6060: .LC_ListStyleSimple dd,
1.795     www      6061: .LC_ListStyleSimple li {
1.698     harmsja  6062: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6063: }
                   6064: 
1.721     harmsja  6065: .LC_ListStyleSpecial li,
                   6066: .LC_ListStyleSpecial dd {
1.693     droeschl 6067: 	list-style-type: none;
                   6068: 	background-color: RGB(220, 220, 220);
                   6069: 	margin-bottom: 4px;
                   6070: }
                   6071: 
1.721     harmsja  6072: table.LC_SimpleTable {
1.698     harmsja  6073: 	margin:5px;
                   6074: 	border:solid 1px $lg_border_color;
1.795     www      6075: }
1.693     droeschl 6076: 
1.721     harmsja  6077: table.LC_SimpleTable tr {
1.803     bisitz   6078: 	padding: 0;
1.698     harmsja  6079: 	border:solid 1px $lg_border_color;
1.693     droeschl 6080: }
1.795     www      6081: 
                   6082: table.LC_SimpleTable thead {
1.698     harmsja  6083: 	 background:rgb(220,220,220);
1.693     droeschl 6084: }
                   6085: 
1.721     harmsja  6086: div.LC_columnSection {
1.693     droeschl 6087: 	display: block;
                   6088: 	clear: both;
                   6089: 	overflow: hidden;
1.803     bisitz   6090: 	margin: 0;
1.693     droeschl 6091: }
                   6092: 
1.721     harmsja  6093: div.LC_columnSection>* {
1.693     droeschl 6094: 	float: left;
1.803     bisitz   6095: 	margin: 10px 20px 10px 0;
1.747     neumanie 6096: 	overflow:hidden;
1.693     droeschl 6097: }
1.721     harmsja  6098: 
1.795     www      6099: .clear {
1.720     ehlerst  6100: 	clear: both;
1.851   ! tempelho 6101: 	margin: 0;
1.720     ehlerst  6102: }
1.693     droeschl 6103: 
1.694     tempelho 6104: .LC_loginpage_container {
                   6105: 	text-align:left;
                   6106: 	margin : 0 auto;
1.785     tempelho 6107: 	width:90%;
1.694     tempelho 6108: 	padding: 10px;
                   6109: 	height: auto;
1.712     muellerd 6110: 	background-color:#FFFFFF;
1.694     tempelho 6111: 	border:1px solid #CCCCCC;
                   6112: }
                   6113: 
                   6114: 
                   6115: .LC_loginpage_loginContainer {
                   6116: 	float:left;
1.712     muellerd 6117: 	width: 182px;
1.785     tempelho 6118: 	padding: 2px;
1.712     muellerd 6119: 	border:1px solid #CCCCCC;
                   6120: 	background-color:$loginbg;
1.694     tempelho 6121: }
                   6122: 
1.795     www      6123: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6124: 	margin-top: 0;
1.712     muellerd 6125: 	display:block;
                   6126: 	background:$bgcol;
                   6127: 	color:$textcol;
                   6128: 	padding-left:5px;
                   6129: }
1.785     tempelho 6130: 
1.694     tempelho 6131: .LC_loginpage_loginInfo {
                   6132: 	float:left;
1.785     tempelho 6133: 	width:182px;
1.694     tempelho 6134: 	border:1px solid #CCCCCC;
1.785     tempelho 6135: 	padding:2px;
1.712     muellerd 6136: }
                   6137: 
1.694     tempelho 6138: .LC_loginpage_space {
1.754     droeschl 6139: 	clear: both;
                   6140: 	margin-bottom: 20px;
1.694     tempelho 6141: 	border-bottom: 1px solid #CCCCCC;
                   6142: }
                   6143: 
1.785     tempelho 6144: .LC_loginpage_floatLeft {
                   6145: 	float: left;
                   6146: 	width: 200px;
                   6147: 	margin: 0;
                   6148: }
                   6149: 
1.795     www      6150: table em {
1.754     droeschl 6151: 	font-weight: bold;
                   6152: 	font-style: normal;
1.748     schulted 6153: }
1.795     www      6154: 
1.779     bisitz   6155: table.LC_tableBrowseRes,
1.795     www      6156: table.LC_tableOfContent {
1.769     schulted 6157:         border:none;
                   6158: 	border-spacing: 1;
1.754     droeschl 6159: 	padding: 3px;
                   6160: 	background-color: #FFFFFF;
                   6161: 	font-size: 90%;
1.753     droeschl 6162: }
1.789     droeschl 6163: 
                   6164: table.LC_tableOfContent{
                   6165:     border-collapse: collapse;
                   6166: }
                   6167: 
1.771     droeschl 6168: table.LC_tableBrowseRes a,
1.768     schulted 6169: table.LC_tableOfContent a {
1.771     droeschl 6170:         background-color: transparent;
1.753     droeschl 6171: 	text-decoration: none;
                   6172: }
                   6173: 
1.771     droeschl 6174: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6175: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6176: 	background-color: #EEEEEE;
1.753     droeschl 6177: }
                   6178: 
1.795     www      6179: table.LC_tableOfContent img {
1.753     droeschl 6180: 	border: none;
                   6181: 	height: 1.3em;
                   6182: 	vertical-align: text-bottom;
                   6183: 	margin-right: 0.3em;
                   6184: }
1.757     schulted 6185: 
1.795     www      6186: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6187: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6188: }
                   6189: 
1.795     www      6190: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6191: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6192: }
                   6193: 
1.795     www      6194: a#LC_content_toolbar_closenav {
1.774     ehlerst  6195: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6196: }
                   6197: 
1.795     www      6198: a#LC_content_toolbar_everything {
1.774     ehlerst  6199: 	background-image:url(/res/adm/pages/show-all.gif);
                   6200: }
                   6201: 
1.795     www      6202: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6203: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6204: }
                   6205: 
1.795     www      6206: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6207: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6208: }
                   6209: 
1.795     www      6210: a#LC_content_toolbar_changefolder {
1.757     schulted 6211: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6212: }
                   6213: 
1.795     www      6214: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6215: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6216: }
                   6217: 
1.795     www      6218: ul#LC_toolbar li a:hover {
1.757     schulted 6219: 	background-position: bottom center;
                   6220: }
                   6221: 
1.795     www      6222: ul#LC_toolbar {
1.803     bisitz   6223: 	padding: 0;
1.757     schulted 6224: 	margin: 2px;
                   6225: 	list-style:none;
                   6226: 	position:relative;
                   6227: 	background-color:white;
                   6228: }
                   6229: 
1.795     www      6230: ul#LC_toolbar li {
1.757     schulted 6231: 	border:1px solid white;
1.803     bisitz   6232: 	padding: 0;
1.757     schulted 6233: 	margin: 0;
1.795     www      6234:         float: left;
1.767     droeschl 6235: 	display:inline;
1.757     schulted 6236: 	vertical-align:middle;
1.795     www      6237: } 
1.757     schulted 6238: 
1.783     amueller 6239: 
1.795     www      6240: a.LC_toolbarItem {
1.767     droeschl 6241: 	display:block;
1.803     bisitz   6242: 	padding: 0;
                   6243: 	margin: 0;
1.757     schulted 6244: 	height: 32px;
                   6245: 	width: 32px;
1.779     bisitz   6246: 	color:white;
1.803     bisitz   6247: 	border: none;
1.757     schulted 6248: 	background-repeat:no-repeat;
                   6249: 	background-color:transparent;
                   6250: }
                   6251: 
1.843     bisitz   6252: ul.LC_funclist li {
1.782     bisitz   6253:   float: left;
                   6254:   white-space: nowrap;
                   6255:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6256:   margin: 0 15px 15px 10px;
1.782     bisitz   6257: }
                   6258: 
1.757     schulted 6259: 
1.343     albertel 6260: END
                   6261: }
                   6262: 
1.306     albertel 6263: =pod
                   6264: 
                   6265: =item * &headtag()
                   6266: 
                   6267: Returns a uniform footer for LON-CAPA web pages.
                   6268: 
1.307     albertel 6269: Inputs: $title - optional title for the head
                   6270:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6271:         $args - optional arguments
1.319     albertel 6272:             force_register - if is true call registerurl so the remote is 
                   6273:                              informed
1.415     albertel 6274:             redirect       -> array ref of
                   6275:                                    1- seconds before redirect occurs
                   6276:                                    2- url to redirect to
                   6277:                                    3- whether the side effect should occur
1.315     albertel 6278:                            (side effect of setting 
                   6279:                                $env{'internal.head.redirect'} to the url 
                   6280:                                redirected too)
1.352     albertel 6281:             domain         -> force to color decorate a page for a specific
                   6282:                                domain
                   6283:             function       -> force usage of a specific rolish color scheme
                   6284:             bgcolor        -> override the default page bgcolor
1.460     albertel 6285:             no_auto_mt_title
                   6286:                            -> prevent &mt()ing the title arg
1.464     albertel 6287: 
1.306     albertel 6288: =cut
                   6289: 
                   6290: sub headtag {
1.313     albertel 6291:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6292:     
1.363     albertel 6293:     my $function = $args->{'function'} || &get_users_function();
                   6294:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6295:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6296:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6297: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6298: 		   #time(),
1.418     albertel 6299: 		   $env{'environment.color.timestamp'},
1.363     albertel 6300: 		   $function,$domain,$bgcolor);
                   6301: 
1.369     www      6302:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6303: 
1.308     albertel 6304:     my $result =
                   6305: 	'<head>'.
1.461     albertel 6306: 	&font_settings();
1.319     albertel 6307: 
1.461     albertel 6308:     if (!$args->{'frameset'}) {
                   6309: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6310:     }
1.319     albertel 6311:     if ($args->{'force_register'}) {
                   6312: 	$result .= &Apache::lonmenu::registerurl(1);
                   6313:     }
1.436     albertel 6314:     if (!$args->{'no_nav_bar'} 
                   6315: 	&& !$args->{'only_body'}
                   6316: 	&& !$args->{'frameset'}) {
                   6317: 	$result .= &help_menu_js();
                   6318:     }
1.319     albertel 6319: 
1.314     albertel 6320:     if (ref($args->{'redirect'})) {
1.414     albertel 6321: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6322: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6323: 	if (!$inhibit_continue) {
                   6324: 	    $env{'internal.head.redirect'} = $url;
                   6325: 	}
1.313     albertel 6326: 	$result.=<<ADDMETA
                   6327: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6328: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6329: ADDMETA
                   6330:     }
1.306     albertel 6331:     if (!defined($title)) {
                   6332: 	$title = 'The LearningOnline Network with CAPA';
                   6333:     }
1.460     albertel 6334:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6335:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6336: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6337: 	.$head_extra;
1.306     albertel 6338:     return $result;
                   6339: }
                   6340: 
                   6341: =pod
                   6342: 
1.340     albertel 6343: =item * &font_settings()
                   6344: 
                   6345: Returns neccessary <meta> to set the proper encoding
                   6346: 
                   6347: Inputs: none
                   6348: 
                   6349: =cut
                   6350: 
                   6351: sub font_settings {
                   6352:     my $headerstring='';
1.647     www      6353:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6354: 	$headerstring.=
                   6355: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6356:     }
                   6357:     return $headerstring;
                   6358: }
                   6359: 
1.341     albertel 6360: =pod
                   6361: 
                   6362: =item * &xml_begin()
                   6363: 
                   6364: Returns the needed doctype and <html>
                   6365: 
                   6366: Inputs: none
                   6367: 
                   6368: =cut
                   6369: 
                   6370: sub xml_begin {
                   6371:     my $output='';
                   6372: 
1.592     albertel 6373:     if ($env{'internal.start_page'}==1) {
                   6374: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6375:     }
1.342     albertel 6376: 
1.341     albertel 6377:     if ($env{'browser.mathml'}) {
                   6378: 	$output='<?xml version="1.0"?>'
                   6379:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6380: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6381:             
                   6382: #	    .'<!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">] >'
                   6383: 	    .'<!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">'
                   6384:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6385: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6386:     } else {
1.849     bisitz   6387: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6388:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6389:     }
                   6390:     return $output;
                   6391: }
1.340     albertel 6392: 
                   6393: =pod
                   6394: 
1.306     albertel 6395: =item * &endheadtag()
                   6396: 
                   6397: Returns a uniform </head> for LON-CAPA web pages.
                   6398: 
                   6399: Inputs: none
                   6400: 
                   6401: =cut
                   6402: 
                   6403: sub endheadtag {
                   6404:     return '</head>';
                   6405: }
                   6406: 
                   6407: =pod
                   6408: 
                   6409: =item * &head()
                   6410: 
                   6411: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6412: 
1.648     raeburn  6413: Inputs:
                   6414: 
                   6415: =over 4
                   6416: 
                   6417: $title - optional title for the page
                   6418: 
                   6419: $head_extra - optional extra HTML to put inside the <head>
                   6420: 
                   6421: =back
1.405     albertel 6422: 
1.306     albertel 6423: =cut
                   6424: 
                   6425: sub head {
1.325     albertel 6426:     my ($title,$head_extra,$args) = @_;
                   6427:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6428: }
                   6429: 
                   6430: =pod
                   6431: 
                   6432: =item * &start_page()
                   6433: 
                   6434: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6435: 
1.648     raeburn  6436: Inputs:
                   6437: 
                   6438: =over 4
                   6439: 
                   6440: $title - optional title for the page
                   6441: 
                   6442: $head_extra - optional extra HTML to incude inside the <head>
                   6443: 
                   6444: $args - additional optional args supported are:
                   6445: 
                   6446: =over 8
                   6447: 
                   6448:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6449:                                     arg on
1.814     bisitz   6450:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6451:              add_entries    -> additional attributes to add to the  <body>
                   6452:              domain         -> force to color decorate a page for a 
1.317     albertel 6453:                                     specific domain
1.648     raeburn  6454:              function       -> force usage of a specific rolish color
1.317     albertel 6455:                                     scheme
1.648     raeburn  6456:              redirect       -> see &headtag()
                   6457:              bgcolor        -> override the default page bg color
                   6458:              js_ready       -> return a string ready for being used in 
1.317     albertel 6459:                                     a javascript writeln
1.648     raeburn  6460:              html_encode    -> return a string ready for being used in 
1.320     albertel 6461:                                     a html attribute
1.648     raeburn  6462:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6463:                                     $forcereg arg
1.648     raeburn  6464:              frameset       -> if true will start with a <frameset>
1.330     albertel 6465:                                     rather than <body>
1.648     raeburn  6466:              skip_phases    -> hash ref of 
1.338     albertel 6467:                                     head -> skip the <html><head> generation
                   6468:                                     body -> skip all <body> generation
1.648     raeburn  6469:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6470:                                     'Switch To Inline Menu' link
1.648     raeburn  6471:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6472:              inherit_jsmath -> when creating popup window in a page,
                   6473:                                     should it have jsmath forced on by the
                   6474:                                     current page
1.361     albertel 6475: 
1.648     raeburn  6476: =back
1.460     albertel 6477: 
1.648     raeburn  6478: =back
1.562     albertel 6479: 
1.306     albertel 6480: =cut
                   6481: 
                   6482: sub start_page {
1.309     albertel 6483:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6484:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6485:     my %head_args;
1.352     albertel 6486:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6487: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6488: 		     'no_auto_mt_title') {
1.319     albertel 6489: 	if (defined($args->{$arg})) {
1.324     raeburn  6490: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6491: 	}
1.313     albertel 6492:     }
1.319     albertel 6493: 
1.315     albertel 6494:     $env{'internal.start_page'}++;
1.338     albertel 6495:     my $result;
                   6496:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6497: 	$result.=
1.341     albertel 6498: 	    &xml_begin().
1.338     albertel 6499: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6500:     }
                   6501:     
                   6502:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6503: 	if ($args->{'frameset'}) {
                   6504: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6505: 						$args->{'add_entries'});
                   6506: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6507:         } else {
                   6508:             $result .=
                   6509:                 &bodytag($title, 
                   6510:                          $args->{'function'},       $args->{'add_entries'},
                   6511:                          $args->{'only_body'},      $args->{'domain'},
                   6512:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6513:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6514:                          $args);
                   6515:         }
1.330     albertel 6516:     }
1.338     albertel 6517: 
1.315     albertel 6518:     if ($args->{'js_ready'}) {
1.713     kaisler  6519: 		$result = &js_ready($result);
1.315     albertel 6520:     }
1.320     albertel 6521:     if ($args->{'html_encode'}) {
1.713     kaisler  6522: 		$result = &html_encode($result);
                   6523:     }
                   6524: 
1.813     bisitz   6525:     # Preparation for new and consistent functionlist at top of screen
                   6526:     # if ($args->{'functionlist'}) {
                   6527:     #            $result .= &build_functionlist();
                   6528:     #}
                   6529: 
                   6530:     # Don't add anything more if only_body wanted
                   6531:     return $result if $args->{'only_body'};
                   6532: 
                   6533:     #Breadcrumbs
1.758     kaisler  6534:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6535: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6536: 		#if any br links exists, add them to the breadcrumbs
                   6537: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6538: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6539: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6540: 			}
                   6541: 		}
                   6542: 
                   6543: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6544: 		if(exists($args->{'bread_crumbs_component'})){
                   6545: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6546: 		}else{
                   6547: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6548: 		}
1.320     albertel 6549:     }
1.315     albertel 6550:     return $result;
1.306     albertel 6551: }
                   6552: 
1.330     albertel 6553: 
1.306     albertel 6554: =pod
                   6555: 
                   6556: =item * &head()
                   6557: 
                   6558: Returns a complete </body></html> section for LON-CAPA web pages.
                   6559: 
1.315     albertel 6560: Inputs:         $args - additional optional args supported are:
                   6561:                  js_ready     -> return a string ready for being used in 
                   6562:                                  a javascript writeln
1.320     albertel 6563:                  html_encode  -> return a string ready for being used in 
                   6564:                                  a html attribute
1.330     albertel 6565:                  frameset     -> if true will start with a <frameset>
                   6566:                                  rather than <body>
1.493     albertel 6567:                  dicsussion   -> if true will get discussion from
                   6568:                                   lonxml::xmlend
                   6569:                                  (you can pass the target and parser arguments
                   6570:                                   through optional 'target' and 'parser' args
                   6571:                                   to this routine)
1.306     albertel 6572: 
                   6573: =cut
                   6574: 
                   6575: sub end_page {
1.315     albertel 6576:     my ($args) = @_;
                   6577:     $env{'internal.end_page'}++;
1.330     albertel 6578:     my $result;
1.335     albertel 6579:     if ($args->{'discussion'}) {
                   6580: 	my ($target,$parser);
                   6581: 	if (ref($args->{'discussion'})) {
                   6582: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6583: 				$args->{'discussion'}{'parser'});
                   6584: 	}
                   6585: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6586:     }
                   6587: 
1.330     albertel 6588:     if ($args->{'frameset'}) {
                   6589: 	$result .= '</frameset>';
                   6590:     } else {
1.635     raeburn  6591: 	$result .= &endbodytag($args);
1.330     albertel 6592:     }
                   6593:     $result .= "\n</html>";
                   6594: 
1.315     albertel 6595:     if ($args->{'js_ready'}) {
1.317     albertel 6596: 	$result = &js_ready($result);
1.315     albertel 6597:     }
1.335     albertel 6598: 
1.320     albertel 6599:     if ($args->{'html_encode'}) {
                   6600: 	$result = &html_encode($result);
                   6601:     }
1.335     albertel 6602: 
1.315     albertel 6603:     return $result;
                   6604: }
                   6605: 
1.320     albertel 6606: sub html_encode {
                   6607:     my ($result) = @_;
                   6608: 
1.322     albertel 6609:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6610:     
                   6611:     return $result;
                   6612: }
1.317     albertel 6613: sub js_ready {
                   6614:     my ($result) = @_;
                   6615: 
1.323     albertel 6616:     $result =~ s/[\n\r]/ /xmsg;
                   6617:     $result =~ s/\\/\\\\/xmsg;
                   6618:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6619:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6620:     
                   6621:     return $result;
                   6622: }
                   6623: 
1.315     albertel 6624: sub validate_page {
                   6625:     if (  exists($env{'internal.start_page'})
1.316     albertel 6626: 	  &&     $env{'internal.start_page'} > 1) {
                   6627: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6628: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6629: 				 $ENV{'request.filename'});
1.315     albertel 6630:     }
                   6631:     if (  exists($env{'internal.end_page'})
1.316     albertel 6632: 	  &&     $env{'internal.end_page'} > 1) {
                   6633: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6634: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6635: 				 $env{'request.filename'});
1.315     albertel 6636:     }
                   6637:     if (     exists($env{'internal.start_page'})
                   6638: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6639: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6640: 				 $env{'request.filename'});
1.315     albertel 6641:     }
                   6642:     if (   ! exists($env{'internal.start_page'})
                   6643: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6644: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6645: 				 $env{'request.filename'});
1.315     albertel 6646:     }
1.306     albertel 6647: }
1.315     albertel 6648: 
1.318     albertel 6649: sub simple_error_page {
                   6650:     my ($r,$title,$msg) = @_;
                   6651:     my $page =
                   6652: 	&Apache::loncommon::start_page($title).
                   6653: 	&mt($msg).
                   6654: 	&Apache::loncommon::end_page();
                   6655:     if (ref($r)) {
                   6656: 	$r->print($page);
1.327     albertel 6657: 	return;
1.318     albertel 6658:     }
                   6659:     return $page;
                   6660: }
1.347     albertel 6661: 
                   6662: {
1.610     albertel 6663:     my @row_count;
1.347     albertel 6664:     sub start_data_table {
1.422     albertel 6665: 	my ($add_class) = @_;
                   6666: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6667: 	unshift(@row_count,0);
1.422     albertel 6668: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6669:     }
                   6670: 
                   6671:     sub end_data_table {
1.610     albertel 6672: 	shift(@row_count);
1.389     albertel 6673: 	return '</table>'."\n";;
1.347     albertel 6674:     }
                   6675: 
                   6676:     sub start_data_table_row {
1.422     albertel 6677: 	my ($add_class) = @_;
1.610     albertel 6678: 	$row_count[0]++;
                   6679: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6680: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6681: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6682:     }
1.471     banghart 6683:     
                   6684:     sub continue_data_table_row {
                   6685: 	my ($add_class) = @_;
1.610     albertel 6686: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6687: 	$css_class = (join(' ',$css_class,$add_class));
                   6688: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6689:     }
1.347     albertel 6690: 
                   6691:     sub end_data_table_row {
1.389     albertel 6692: 	return '</tr>'."\n";;
1.347     albertel 6693:     }
1.367     www      6694: 
1.421     albertel 6695:     sub start_data_table_empty_row {
1.707     bisitz   6696: #	$row_count[0]++;
1.421     albertel 6697: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6698:     }
                   6699: 
                   6700:     sub end_data_table_empty_row {
                   6701: 	return '</tr>'."\n";;
                   6702:     }
                   6703: 
1.367     www      6704:     sub start_data_table_header_row {
1.389     albertel 6705: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6706:     }
                   6707: 
                   6708:     sub end_data_table_header_row {
1.389     albertel 6709: 	return '</tr>'."\n";;
1.367     www      6710:     }
1.347     albertel 6711: }
                   6712: 
1.548     albertel 6713: =pod
                   6714: 
                   6715: =item * &inhibit_menu_check($arg)
                   6716: 
                   6717: Checks for a inhibitmenu state and generates output to preserve it
                   6718: 
                   6719: Inputs:         $arg - can be any of
                   6720:                      - undef - in which case the return value is a string 
                   6721:                                to add  into arguments list of a uri
                   6722:                      - 'input' - in which case the return value is a HTML
                   6723:                                  <form> <input> field of type hidden to
                   6724:                                  preserve the value
                   6725:                      - a url - in which case the return value is the url with
                   6726:                                the neccesary cgi args added to preserve the
                   6727:                                inhibitmenu state
                   6728:                      - a ref to a url - no return value, but the string is
                   6729:                                         updated to include the neccessary cgi
                   6730:                                         args to preserve the inhibitmenu state
                   6731: 
                   6732: =cut
                   6733: 
                   6734: sub inhibit_menu_check {
                   6735:     my ($arg) = @_;
                   6736:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6737:     if ($arg eq 'input') {
                   6738: 	if ($env{'form.inhibitmenu'}) {
                   6739: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6740: 	} else {
                   6741: 	    return
                   6742: 	}
                   6743:     }
                   6744:     if ($env{'form.inhibitmenu'}) {
                   6745: 	if (ref($arg)) {
                   6746: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6747: 	} elsif ($arg eq '') {
                   6748: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6749: 	} else {
                   6750: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6751: 	}
                   6752:     }
                   6753:     if (!ref($arg)) {
                   6754: 	return $arg;
                   6755:     }
                   6756: }
                   6757: 
1.251     albertel 6758: ###############################################
1.182     matthew  6759: 
                   6760: =pod
                   6761: 
1.549     albertel 6762: =back
                   6763: 
                   6764: =head1 User Information Routines
                   6765: 
                   6766: =over 4
                   6767: 
1.405     albertel 6768: =item * &get_users_function()
1.182     matthew  6769: 
                   6770: Used by &bodytag to determine the current users primary role.
                   6771: Returns either 'student','coordinator','admin', or 'author'.
                   6772: 
                   6773: =cut
                   6774: 
                   6775: ###############################################
                   6776: sub get_users_function {
1.815     tempelho 6777:     my $function = 'norole';
1.818     tempelho 6778:     if ($env{'request.role'}=~/^(st)/) {
                   6779:         $function='student';
                   6780:     }
1.258     albertel 6781:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6782:         $function='coordinator';
                   6783:     }
1.258     albertel 6784:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6785:         $function='admin';
                   6786:     }
1.826     bisitz   6787:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6788:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6789:         $function='author';
                   6790:     }
                   6791:     return $function;
1.54      www      6792: }
1.99      www      6793: 
                   6794: ###############################################
                   6795: 
1.233     raeburn  6796: =pod
                   6797: 
1.821     raeburn  6798: =item * &show_course()
                   6799: 
                   6800: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6801: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6802: 
                   6803: Inputs:
                   6804: None
                   6805: 
                   6806: Outputs:
                   6807: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6808: 
                   6809: =cut
                   6810: 
                   6811: ###############################################
                   6812: sub show_course {
                   6813:     my $course = !$env{'user.adv'};
                   6814:     if (!$env{'user.adv'}) {
                   6815:         foreach my $env (keys(%env)) {
                   6816:             next if ($env !~ m/^user\.priv\./);
                   6817:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6818:                 $course = 0;
                   6819:                 last;
                   6820:             }
                   6821:         }
                   6822:     }
                   6823:     return $course;
                   6824: }
                   6825: 
                   6826: ###############################################
                   6827: 
                   6828: =pod
                   6829: 
1.542     raeburn  6830: =item * &check_user_status()
1.274     raeburn  6831: 
                   6832: Determines current status of supplied role for a
                   6833: specific user. Roles can be active, previous or future.
                   6834: 
                   6835: Inputs: 
                   6836: user's domain, user's username, course's domain,
1.375     raeburn  6837: course's number, optional section ID.
1.274     raeburn  6838: 
                   6839: Outputs:
                   6840: role status: active, previous or future. 
                   6841: 
                   6842: =cut
                   6843: 
                   6844: sub check_user_status {
1.412     raeburn  6845:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6846:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6847:     my @uroles = keys %userinfo;
                   6848:     my $srchstr;
                   6849:     my $active_chk = 'none';
1.412     raeburn  6850:     my $now = time;
1.274     raeburn  6851:     if (@uroles > 0) {
1.412     raeburn  6852:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6853:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6854:         } else {
1.412     raeburn  6855:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6856:         }
                   6857:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6858:             my $role_end = 0;
                   6859:             my $role_start = 0;
                   6860:             $active_chk = 'active';
1.412     raeburn  6861:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6862:                 $role_end = $1;
                   6863:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6864:                     $role_start = $1;
1.274     raeburn  6865:                 }
                   6866:             }
                   6867:             if ($role_start > 0) {
1.412     raeburn  6868:                 if ($now < $role_start) {
1.274     raeburn  6869:                     $active_chk = 'future';
                   6870:                 }
                   6871:             }
                   6872:             if ($role_end > 0) {
1.412     raeburn  6873:                 if ($now > $role_end) {
1.274     raeburn  6874:                     $active_chk = 'previous';
                   6875:                 }
                   6876:             }
                   6877:         }
                   6878:     }
                   6879:     return $active_chk;
                   6880: }
                   6881: 
                   6882: ###############################################
                   6883: 
                   6884: =pod
                   6885: 
1.405     albertel 6886: =item * &get_sections()
1.233     raeburn  6887: 
                   6888: Determines all the sections for a course including
                   6889: sections with students and sections containing other roles.
1.419     raeburn  6890: Incoming parameters: 
                   6891: 
                   6892: 1. domain
                   6893: 2. course number 
                   6894: 3. reference to array containing roles for which sections should 
                   6895: be gathered (optional).
                   6896: 4. reference to array containing status types for which sections 
                   6897: should be gathered (optional).
                   6898: 
                   6899: If the third argument is undefined, sections are gathered for any role. 
                   6900: If the fourth argument is undefined, sections are gathered for any status.
                   6901: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6902:  
1.374     raeburn  6903: Returns section hash (keys are section IDs, values are
                   6904: number of users in each section), subject to the
1.419     raeburn  6905: optional roles filter, optional status filter 
1.233     raeburn  6906: 
                   6907: =cut
                   6908: 
                   6909: ###############################################
                   6910: sub get_sections {
1.419     raeburn  6911:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6912:     if (!defined($cdom) || !defined($cnum)) {
                   6913:         my $cid =  $env{'request.course.id'};
                   6914: 
                   6915: 	return if (!defined($cid));
                   6916: 
                   6917:         $cdom = $env{'course.'.$cid.'.domain'};
                   6918:         $cnum = $env{'course.'.$cid.'.num'};
                   6919:     }
                   6920: 
                   6921:     my %sectioncount;
1.419     raeburn  6922:     my $now = time;
1.240     albertel 6923: 
1.366     albertel 6924:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6925: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6926: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6927: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6928:         my $start_index = &Apache::loncoursedata::CL_START();
                   6929:         my $end_index = &Apache::loncoursedata::CL_END();
                   6930:         my $status;
1.366     albertel 6931: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6932: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6933: 				                     $data->[$status_index],
                   6934:                                                      $data->[$start_index],
                   6935:                                                      $data->[$end_index]);
                   6936:             if ($stu_status eq 'Active') {
                   6937:                 $status = 'active';
                   6938:             } elsif ($end < $now) {
                   6939:                 $status = 'previous';
                   6940:             } elsif ($start > $now) {
                   6941:                 $status = 'future';
                   6942:             } 
                   6943: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6944:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6945:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6946: 		    $sectioncount{$section}++;
                   6947:                 }
1.240     albertel 6948: 	    }
                   6949: 	}
                   6950:     }
                   6951:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6952:     foreach my $user (sort(keys(%courseroles))) {
                   6953: 	if ($user !~ /^(\w{2})/) { next; }
                   6954: 	my ($role) = ($user =~ /^(\w{2})/);
                   6955: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6956: 	my ($section,$status);
1.240     albertel 6957: 	if ($role eq 'cr' &&
                   6958: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6959: 	    $section=$1;
                   6960: 	}
                   6961: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6962: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  6963:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   6964:         if ($end == -1 && $start == -1) {
                   6965:             next; #deleted role
                   6966:         }
                   6967:         if (!defined($possible_status)) { 
                   6968:             $sectioncount{$section}++;
                   6969:         } else {
                   6970:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   6971:                 $status = 'active';
                   6972:             } elsif ($end < $now) {
                   6973:                 $status = 'future';
                   6974:             } elsif ($start > $now) {
                   6975:                 $status = 'previous';
                   6976:             }
                   6977:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   6978:                 $sectioncount{$section}++;
                   6979:             }
                   6980:         }
1.233     raeburn  6981:     }
1.366     albertel 6982:     return %sectioncount;
1.233     raeburn  6983: }
                   6984: 
1.274     raeburn  6985: ###############################################
1.294     raeburn  6986: 
                   6987: =pod
1.405     albertel 6988: 
                   6989: =item * &get_course_users()
                   6990: 
1.275     raeburn  6991: Retrieves usernames:domains for users in the specified course
                   6992: with specific role(s), and access status. 
                   6993: 
                   6994: Incoming parameters:
1.277     albertel 6995: 1. course domain
                   6996: 2. course number
                   6997: 3. access status: users must have - either active, 
1.275     raeburn  6998: previous, future, or all.
1.277     albertel 6999: 4. reference to array of permissible roles
1.288     raeburn  7000: 5. reference to array of section restrictions (optional)
                   7001: 6. reference to results object (hash of hashes).
                   7002: 7. reference to optional userdata hash
1.609     raeburn  7003: 8. reference to optional statushash
1.630     raeburn  7004: 9. flag if privileged users (except those set to unhide in
                   7005:    course settings) should be excluded    
1.609     raeburn  7006: Keys of top level results hash are roles.
1.275     raeburn  7007: Keys of inner hashes are username:domain, with 
                   7008: values set to access type.
1.288     raeburn  7009: Optional userdata hash returns an array with arguments in the 
                   7010: same order as loncoursedata::get_classlist() for student data.
                   7011: 
1.609     raeburn  7012: Optional statushash returns
                   7013: 
1.288     raeburn  7014: Entries for end, start, section and status are blank because
                   7015: of the possibility of multiple values for non-student roles.
                   7016: 
1.275     raeburn  7017: =cut
1.405     albertel 7018: 
1.275     raeburn  7019: ###############################################
1.405     albertel 7020: 
1.275     raeburn  7021: sub get_course_users {
1.630     raeburn  7022:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7023:     my %idx = ();
1.419     raeburn  7024:     my %seclists;
1.288     raeburn  7025: 
                   7026:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7027:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7028:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7029:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7030:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7031:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7032:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7033:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7034: 
1.290     albertel 7035:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7036:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7037:         my $now = time;
1.277     albertel 7038:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7039:             my $match = 0;
1.412     raeburn  7040:             my $secmatch = 0;
1.419     raeburn  7041:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7042:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7043:             if ($section eq '') {
                   7044:                 $section = 'none';
                   7045:             }
1.291     albertel 7046:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7047:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7048:                     $secmatch = 1;
                   7049:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7050:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7051:                         $secmatch = 1;
                   7052:                     }
                   7053:                 } else {  
1.419     raeburn  7054: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7055: 		        $secmatch = 1;
                   7056:                     }
1.290     albertel 7057: 		}
1.412     raeburn  7058:                 if (!$secmatch) {
                   7059:                     next;
                   7060:                 }
1.419     raeburn  7061:             }
1.275     raeburn  7062:             if (defined($$types{'active'})) {
1.288     raeburn  7063:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7064:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7065:                     $match = 1;
1.275     raeburn  7066:                 }
                   7067:             }
                   7068:             if (defined($$types{'previous'})) {
1.609     raeburn  7069:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7070:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7071:                     $match = 1;
1.275     raeburn  7072:                 }
                   7073:             }
                   7074:             if (defined($$types{'future'})) {
1.609     raeburn  7075:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7076:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7077:                     $match = 1;
1.275     raeburn  7078:                 }
                   7079:             }
1.609     raeburn  7080:             if ($match) {
                   7081:                 push(@{$seclists{$student}},$section);
                   7082:                 if (ref($userdata) eq 'HASH') {
                   7083:                     $$userdata{$student} = $$classlist{$student};
                   7084:                 }
                   7085:                 if (ref($statushash) eq 'HASH') {
                   7086:                     $statushash->{$student}{'st'}{$section} = $status;
                   7087:                 }
1.288     raeburn  7088:             }
1.275     raeburn  7089:         }
                   7090:     }
1.412     raeburn  7091:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7092:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7093:         my $now = time;
1.609     raeburn  7094:         my %displaystatus = ( previous => 'Expired',
                   7095:                               active   => 'Active',
                   7096:                               future   => 'Future',
                   7097:                             );
1.630     raeburn  7098:         my %nothide;
                   7099:         if ($hidepriv) {
                   7100:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7101:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7102:                 if ($user !~ /:/) {
                   7103:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7104:                 } else {
                   7105:                     $nothide{$user} = 1;
                   7106:                 }
                   7107:             }
                   7108:         }
1.439     raeburn  7109:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7110:             my $match = 0;
1.412     raeburn  7111:             my $secmatch = 0;
1.439     raeburn  7112:             my $status;
1.412     raeburn  7113:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7114:             $user =~ s/:$//;
1.439     raeburn  7115:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7116:             if ($end == -1 || $start == -1) {
                   7117:                 next;
                   7118:             }
                   7119:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7120:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7121:                 my ($uname,$udom) = split(/:/,$user);
                   7122:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7123:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7124:                         $secmatch = 1;
                   7125:                     } elsif ($usec eq '') {
1.420     albertel 7126:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7127:                             $secmatch = 1;
                   7128:                         }
                   7129:                     } else {
                   7130:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7131:                             $secmatch = 1;
                   7132:                         }
                   7133:                     }
                   7134:                     if (!$secmatch) {
                   7135:                         next;
                   7136:                     }
1.288     raeburn  7137:                 }
1.419     raeburn  7138:                 if ($usec eq '') {
                   7139:                     $usec = 'none';
                   7140:                 }
1.275     raeburn  7141:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7142:                     if ($hidepriv) {
                   7143:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7144:                             (!$nothide{$uname.':'.$udom})) {
                   7145:                             next;
                   7146:                         }
                   7147:                     }
1.503     raeburn  7148:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7149:                         $status = 'previous';
                   7150:                     } elsif ($start > $now) {
                   7151:                         $status = 'future';
                   7152:                     } else {
                   7153:                         $status = 'active';
                   7154:                     }
1.277     albertel 7155:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7156:                         if ($status eq $type) {
1.420     albertel 7157:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7158:                                 push(@{$$users{$role}{$user}},$type);
                   7159:                             }
1.288     raeburn  7160:                             $match = 1;
                   7161:                         }
                   7162:                     }
1.419     raeburn  7163:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7164:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7165: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7166:                         }
1.420     albertel 7167:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7168:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7169:                         }
1.609     raeburn  7170:                         if (ref($statushash) eq 'HASH') {
                   7171:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7172:                         }
1.275     raeburn  7173:                     }
                   7174:                 }
                   7175:             }
                   7176:         }
1.290     albertel 7177:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7178:             if ((defined($cdom)) && (defined($cnum))) {
                   7179:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7180:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7181:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7182:                     next if ($owner eq '');
                   7183:                     my ($ownername,$ownerdom);
                   7184:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7185:                         $ownername = $1;
                   7186:                         $ownerdom = $2;
                   7187:                     } else {
                   7188:                         $ownername = $owner;
                   7189:                         $ownerdom = $cdom;
                   7190:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7191:                     }
                   7192:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7193:                     if (defined($userdata) && 
1.609     raeburn  7194: 			!exists($$userdata{$owner})) {
                   7195: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7196:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7197:                             push(@{$seclists{$owner}},'none');
                   7198:                         }
                   7199:                         if (ref($statushash) eq 'HASH') {
                   7200:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7201:                         }
1.290     albertel 7202: 		    }
1.279     raeburn  7203:                 }
                   7204:             }
                   7205:         }
1.419     raeburn  7206:         foreach my $user (keys(%seclists)) {
                   7207:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7208:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7209:         }
1.275     raeburn  7210:     }
                   7211:     return;
                   7212: }
                   7213: 
1.288     raeburn  7214: sub get_user_info {
                   7215:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7216:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7217: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7218:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7219:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7220:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7221:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7222:     return;
                   7223: }
1.275     raeburn  7224: 
1.472     raeburn  7225: ###############################################
                   7226: 
                   7227: =pod
                   7228: 
                   7229: =item * &get_user_quota()
                   7230: 
                   7231: Retrieves quota assigned for storage of portfolio files for a user  
                   7232: 
                   7233: Incoming parameters:
                   7234: 1. user's username
                   7235: 2. user's domain
                   7236: 
                   7237: Returns:
1.536     raeburn  7238: 1. Disk quota (in Mb) assigned to student.
                   7239: 2. (Optional) Type of setting: custom or default
                   7240:    (individually assigned or default for user's 
                   7241:    institutional status).
                   7242: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7243:    or student - types as defined in localenroll::inst_usertypes 
                   7244:    for user's domain, which determines default quota for user.
                   7245: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7246: 
                   7247: If a value has been stored in the user's environment, 
1.536     raeburn  7248: it will return that, otherwise it returns the maximal default
                   7249: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7250: 
                   7251: =cut
                   7252: 
                   7253: ###############################################
                   7254: 
                   7255: 
                   7256: sub get_user_quota {
                   7257:     my ($uname,$udom) = @_;
1.536     raeburn  7258:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7259:     if (!defined($udom)) {
                   7260:         $udom = $env{'user.domain'};
                   7261:     }
                   7262:     if (!defined($uname)) {
                   7263:         $uname = $env{'user.name'};
                   7264:     }
                   7265:     if (($udom eq '' || $uname eq '') ||
                   7266:         ($udom eq 'public') && ($uname eq 'public')) {
                   7267:         $quota = 0;
1.536     raeburn  7268:         $quotatype = 'default';
                   7269:         $defquota = 0; 
1.472     raeburn  7270:     } else {
1.536     raeburn  7271:         my $inststatus;
1.472     raeburn  7272:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7273:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7274:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7275:         } else {
1.536     raeburn  7276:             my %userenv = 
                   7277:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7278:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7279:             my ($tmp) = keys(%userenv);
                   7280:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7281:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7282:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7283:             } else {
                   7284:                 undef(%userenv);
                   7285:             }
                   7286:         }
1.536     raeburn  7287:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7288:         if ($quota eq '') {
1.536     raeburn  7289:             $quota = $defquota;
                   7290:             $quotatype = 'default';
                   7291:         } else {
                   7292:             $quotatype = 'custom';
1.472     raeburn  7293:         }
                   7294:     }
1.536     raeburn  7295:     if (wantarray) {
                   7296:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7297:     } else {
                   7298:         return $quota;
                   7299:     }
1.472     raeburn  7300: }
                   7301: 
                   7302: ###############################################
                   7303: 
                   7304: =pod
                   7305: 
                   7306: =item * &default_quota()
                   7307: 
1.536     raeburn  7308: Retrieves default quota assigned for storage of user portfolio files,
                   7309: given an (optional) user's institutional status.
1.472     raeburn  7310: 
                   7311: Incoming parameters:
                   7312: 1. domain
1.536     raeburn  7313: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7314:    status types (e.g., faculty, staff, student etc.)
                   7315:    which apply to the user for whom the default is being retrieved.
                   7316:    If the institutional status string in undefined, the domain
                   7317:    default quota will be returned. 
1.472     raeburn  7318: 
                   7319: Returns:
                   7320: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7321: 2. (Optional) institutional type which determined the value of the
                   7322:    default quota.
1.472     raeburn  7323: 
                   7324: If a value has been stored in the domain's configuration db,
                   7325: it will return that, otherwise it returns 20 (for backwards 
                   7326: compatibility with domains which have not set up a configuration
                   7327: db file; the original statically defined portfolio quota was 20 Mb). 
                   7328: 
1.536     raeburn  7329: If the user's status includes multiple types (e.g., staff and student),
                   7330: the largest default quota which applies to the user determines the
                   7331: default quota returned.
                   7332: 
1.780     raeburn  7333: =back
                   7334: 
1.472     raeburn  7335: =cut
                   7336: 
                   7337: ###############################################
                   7338: 
                   7339: 
                   7340: sub default_quota {
1.536     raeburn  7341:     my ($udom,$inststatus) = @_;
                   7342:     my ($defquota,$settingstatus);
                   7343:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7344:                                             ['quotas'],$udom);
                   7345:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7346:         if ($inststatus ne '') {
1.765     raeburn  7347:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7348:             foreach my $item (@statuses) {
1.711     raeburn  7349:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7350:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7351:                         if ($defquota eq '') {
                   7352:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7353:                             $settingstatus = $item;
                   7354:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7355:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7356:                             $settingstatus = $item;
                   7357:                         }
                   7358:                     }
                   7359:                 } else {
                   7360:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7361:                         if ($defquota eq '') {
                   7362:                             $defquota = $quotahash{'quotas'}{$item};
                   7363:                             $settingstatus = $item;
                   7364:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7365:                             $defquota = $quotahash{'quotas'}{$item};
                   7366:                             $settingstatus = $item;
                   7367:                         }
1.536     raeburn  7368:                     }
                   7369:                 }
                   7370:             }
                   7371:         }
                   7372:         if ($defquota eq '') {
1.711     raeburn  7373:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7374:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7375:             } else {
                   7376:                 $defquota = $quotahash{'quotas'}{'default'};
                   7377:             }
1.536     raeburn  7378:             $settingstatus = 'default';
                   7379:         }
                   7380:     } else {
                   7381:         $settingstatus = 'default';
                   7382:         $defquota = 20;
                   7383:     }
                   7384:     if (wantarray) {
                   7385:         return ($defquota,$settingstatus);
1.472     raeburn  7386:     } else {
1.536     raeburn  7387:         return $defquota;
1.472     raeburn  7388:     }
                   7389: }
                   7390: 
1.384     raeburn  7391: sub get_secgrprole_info {
                   7392:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7393:     my %sections_count = &get_sections($cdom,$cnum);
                   7394:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7395:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7396:     my @groups = sort(keys(%curr_groups));
                   7397:     my $allroles = [];
                   7398:     my $rolehash;
                   7399:     my $accesshash = {
                   7400:                      active => 'Currently has access',
                   7401:                      future => 'Will have future access',
                   7402:                      previous => 'Previously had access',
                   7403:                   };
                   7404:     if ($needroles) {
                   7405:         $rolehash = {'all' => 'all'};
1.385     albertel 7406:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7407: 	if (&Apache::lonnet::error(%user_roles)) {
                   7408: 	    undef(%user_roles);
                   7409: 	}
                   7410:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7411:             my ($role)=split(/\:/,$item,2);
                   7412:             if ($role eq 'cr') { next; }
                   7413:             if ($role =~ /^cr/) {
                   7414:                 $$rolehash{$role} = (split('/',$role))[3];
                   7415:             } else {
                   7416:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7417:             }
                   7418:         }
                   7419:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7420:             push(@{$allroles},$key);
                   7421:         }
                   7422:         push (@{$allroles},'st');
                   7423:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7424:     }
                   7425:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7426: }
                   7427: 
1.555     raeburn  7428: sub user_picker {
1.627     raeburn  7429:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7430:     my $currdom = $dom;
                   7431:     my %curr_selected = (
                   7432:                         srchin => 'dom',
1.580     raeburn  7433:                         srchby => 'lastname',
1.555     raeburn  7434:                       );
                   7435:     my $srchterm;
1.625     raeburn  7436:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7437:         if ($srch->{'srchby'} ne '') {
                   7438:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7439:         }
                   7440:         if ($srch->{'srchin'} ne '') {
                   7441:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7442:         }
                   7443:         if ($srch->{'srchtype'} ne '') {
                   7444:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7445:         }
                   7446:         if ($srch->{'srchdomain'} ne '') {
                   7447:             $currdom = $srch->{'srchdomain'};
                   7448:         }
                   7449:         $srchterm = $srch->{'srchterm'};
                   7450:     }
                   7451:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7452:                     'usr'       => 'Search criteria',
1.563     raeburn  7453:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7454:                     'uname'     => 'username',
                   7455:                     'lastname'  => 'last name',
1.555     raeburn  7456:                     'lastfirst' => 'last name, first name',
1.558     albertel 7457:                     'crs'       => 'in this course',
1.576     raeburn  7458:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7459:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7460:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7461:                     'exact'     => 'is',
                   7462:                     'contains'  => 'contains',
1.569     raeburn  7463:                     'begins'    => 'begins with',
1.571     raeburn  7464:                     'youm'      => "You must include some text to search for.",
                   7465:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7466:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7467:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7468:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7469:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7470:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7471:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7472:                                        );
1.563     raeburn  7473:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7474:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7475: 
                   7476:     my @srchins = ('crs','dom','alc','instd');
                   7477: 
                   7478:     foreach my $option (@srchins) {
                   7479:         # FIXME 'alc' option unavailable until 
                   7480:         #       loncreateuser::print_user_query_page()
                   7481:         #       has been completed.
                   7482:         next if ($option eq 'alc');
                   7483:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7484:         if ($curr_selected{'srchin'} eq $option) {
                   7485:             $srchinsel .= ' 
                   7486:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7487:         } else {
                   7488:             $srchinsel .= '
                   7489:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7490:         }
1.555     raeburn  7491:     }
1.563     raeburn  7492:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7493: 
                   7494:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7495:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7496:         if ($curr_selected{'srchby'} eq $option) {
                   7497:             $srchbysel .= '
                   7498:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7499:         } else {
                   7500:             $srchbysel .= '
                   7501:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7502:          }
                   7503:     }
                   7504:     $srchbysel .= "\n  </select>\n";
                   7505: 
                   7506:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7507:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7508:         if ($curr_selected{'srchtype'} eq $option) {
                   7509:             $srchtypesel .= '
                   7510:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7511:         } else {
                   7512:             $srchtypesel .= '
                   7513:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7514:         }
                   7515:     }
                   7516:     $srchtypesel .= "\n  </select>\n";
                   7517: 
1.558     albertel 7518:     my ($newuserscript,$new_user_create);
1.556     raeburn  7519: 
                   7520:     if ($forcenewuser) {
1.576     raeburn  7521:         if (ref($srch) eq 'HASH') {
                   7522:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7523:                 if ($cancreate) {
                   7524:                     $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>';
                   7525:                 } else {
1.799     bisitz   7526:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7527:                     my %usertypetext = (
                   7528:                         official   => 'institutional',
                   7529:                         unofficial => 'non-institutional',
                   7530:                     );
1.799     bisitz   7531:                     $new_user_create = '<p class="LC_warning">'
                   7532:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7533:                                       .' '
                   7534:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7535:                                           ,'<a href="'.$helplink.'">','</a>')
                   7536:                                       .'</p><br />';
1.627     raeburn  7537:                 }
1.576     raeburn  7538:             }
                   7539:         }
                   7540: 
1.556     raeburn  7541:         $newuserscript = <<"ENDSCRIPT";
                   7542: 
1.570     raeburn  7543: function setSearch(createnew,callingForm) {
1.556     raeburn  7544:     if (createnew == 1) {
1.570     raeburn  7545:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7546:             if (callingForm.srchby.options[i].value == 'uname') {
                   7547:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7548:             }
                   7549:         }
1.570     raeburn  7550:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7551:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7552: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7553:             }
                   7554:         }
1.570     raeburn  7555:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7556:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7557:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7558:             }
                   7559:         }
1.570     raeburn  7560:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7561:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7562:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7563:             }
                   7564:         }
                   7565:     }
                   7566: }
                   7567: ENDSCRIPT
1.558     albertel 7568: 
1.556     raeburn  7569:     }
                   7570: 
1.555     raeburn  7571:     my $output = <<"END_BLOCK";
1.556     raeburn  7572: <script type="text/javascript">
1.824     bisitz   7573: // <![CDATA[
1.570     raeburn  7574: function validateEntry(callingForm) {
1.558     albertel 7575: 
1.556     raeburn  7576:     var checkok = 1;
1.558     albertel 7577:     var srchin;
1.570     raeburn  7578:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7579: 	if ( callingForm.srchin[i].checked ) {
                   7580: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7581: 	}
                   7582:     }
                   7583: 
1.570     raeburn  7584:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7585:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7586:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7587:     var srchterm =  callingForm.srchterm.value;
                   7588:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7589:     var msg = "";
                   7590: 
                   7591:     if (srchterm == "") {
                   7592:         checkok = 0;
1.571     raeburn  7593:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7594:     }
                   7595: 
1.569     raeburn  7596:     if (srchtype== 'begins') {
                   7597:         if (srchterm.length < 2) {
                   7598:             checkok = 0;
1.571     raeburn  7599:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7600:         }
                   7601:     }
                   7602: 
1.556     raeburn  7603:     if (srchtype== 'contains') {
                   7604:         if (srchterm.length < 3) {
                   7605:             checkok = 0;
1.571     raeburn  7606:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7607:         }
                   7608:     }
                   7609:     if (srchin == 'instd') {
                   7610:         if (srchdomain == '') {
                   7611:             checkok = 0;
1.571     raeburn  7612:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7613:         }
                   7614:     }
                   7615:     if (srchin == 'dom') {
                   7616:         if (srchdomain == '') {
                   7617:             checkok = 0;
1.571     raeburn  7618:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7619:         }
                   7620:     }
                   7621:     if (srchby == 'lastfirst') {
                   7622:         if (srchterm.indexOf(",") == -1) {
                   7623:             checkok = 0;
1.571     raeburn  7624:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7625:         }
                   7626:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7627:             checkok = 0;
1.571     raeburn  7628:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7629:         }
                   7630:     }
                   7631:     if (checkok == 0) {
1.571     raeburn  7632:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7633:         return;
                   7634:     }
                   7635:     if (checkok == 1) {
1.570     raeburn  7636:         callingForm.submit();
1.556     raeburn  7637:     }
                   7638: }
                   7639: 
                   7640: $newuserscript
                   7641: 
1.824     bisitz   7642: // ]]>
1.556     raeburn  7643: </script>
1.558     albertel 7644: 
                   7645: $new_user_create
                   7646: 
1.555     raeburn  7647: <table>
1.558     albertel 7648:  <tr>
1.573     raeburn  7649:   <td>$lt{'doma'}:</td>
                   7650:   <td>$domform</td>
                   7651:   </td>
                   7652:  </tr>
                   7653:  <tr>
                   7654:   <td>$lt{'usr'}:</td>
1.563     raeburn  7655:   <td>$srchbysel
                   7656:       $srchtypesel 
                   7657:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7658:       $srchinsel 
1.563     raeburn  7659:   </td>
                   7660:  </tr>
1.555     raeburn  7661: </table>
                   7662: <br />
                   7663: END_BLOCK
1.558     albertel 7664: 
1.555     raeburn  7665:     return $output;
                   7666: }
                   7667: 
1.612     raeburn  7668: sub user_rule_check {
1.615     raeburn  7669:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7670:     my $response;
                   7671:     if (ref($usershash) eq 'HASH') {
                   7672:         foreach my $user (keys(%{$usershash})) {
                   7673:             my ($uname,$udom) = split(/:/,$user);
                   7674:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7675:             my ($id,$newuser);
1.612     raeburn  7676:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7677:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7678:                 $id = $usershash->{$user}->{'id'};
                   7679:             }
                   7680:             my $inst_response;
                   7681:             if (ref($checks) eq 'HASH') {
                   7682:                 if (defined($checks->{'username'})) {
1.615     raeburn  7683:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7684:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7685:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7686:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7687:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7688:                 }
1.615     raeburn  7689:             } else {
                   7690:                 ($inst_response,%{$inst_results->{$user}}) =
                   7691:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7692:                 return;
1.612     raeburn  7693:             }
1.615     raeburn  7694:             if (!$got_rules->{$udom}) {
1.612     raeburn  7695:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7696:                                                   ['usercreation'],$udom);
                   7697:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7698:                     foreach my $item ('username','id') {
1.612     raeburn  7699:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7700:                             $$curr_rules{$udom}{$item} = 
                   7701:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7702:                         }
                   7703:                     }
                   7704:                 }
1.615     raeburn  7705:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7706:             }
1.612     raeburn  7707:             foreach my $item (keys(%{$checks})) {
                   7708:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7709:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7710:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7711:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7712:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7713:                                 if ($rule_check{$rule}) {
                   7714:                                     $$rulematch{$user}{$item} = $rule;
                   7715:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7716:                                         if (ref($inst_results) eq 'HASH') {
                   7717:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7718:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7719:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7720:                                                 }
1.612     raeburn  7721:                                             }
                   7722:                                         }
1.615     raeburn  7723:                                     }
                   7724:                                     last;
1.585     raeburn  7725:                                 }
                   7726:                             }
                   7727:                         }
                   7728:                     }
                   7729:                 }
                   7730:             }
                   7731:         }
                   7732:     }
1.612     raeburn  7733:     return;
                   7734: }
                   7735: 
                   7736: sub user_rule_formats {
                   7737:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7738:     my %text = ( 
                   7739:                  'username' => 'Usernames',
                   7740:                  'id'       => 'IDs',
                   7741:                );
                   7742:     my $output;
                   7743:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7744:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7745:         if (@{$ruleorder} > 0) {
                   7746:             $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>';
                   7747:             foreach my $rule (@{$ruleorder}) {
                   7748:                 if (ref($curr_rules) eq 'ARRAY') {
                   7749:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7750:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7751:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7752:                                         $rules->{$rule}{'desc'}.'</li>';
                   7753:                         }
                   7754:                     }
                   7755:                 }
                   7756:             }
                   7757:             $output .= '</ul>';
                   7758:         }
                   7759:     }
                   7760:     return $output;
                   7761: }
                   7762: 
                   7763: sub instrule_disallow_msg {
1.615     raeburn  7764:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7765:     my $response;
                   7766:     my %text = (
                   7767:                   item   => 'username',
                   7768:                   items  => 'usernames',
                   7769:                   match  => 'matches',
                   7770:                   do     => 'does',
                   7771:                   action => 'a username',
                   7772:                   one    => 'one',
                   7773:                );
                   7774:     if ($count > 1) {
                   7775:         $text{'item'} = 'usernames';
                   7776:         $text{'match'} ='match';
                   7777:         $text{'do'} = 'do';
                   7778:         $text{'action'} = 'usernames',
                   7779:         $text{'one'} = 'ones';
                   7780:     }
                   7781:     if ($checkitem eq 'id') {
                   7782:         $text{'items'} = 'IDs';
                   7783:         $text{'item'} = 'ID';
                   7784:         $text{'action'} = 'an ID';
1.615     raeburn  7785:         if ($count > 1) {
                   7786:             $text{'item'} = 'IDs';
                   7787:             $text{'action'} = 'IDs';
                   7788:         }
1.612     raeburn  7789:     }
1.674     bisitz   7790:     $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  7791:     if ($mode eq 'upload') {
                   7792:         if ($checkitem eq 'username') {
                   7793:             $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'}.");
                   7794:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7795:             $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  7796:         }
1.669     raeburn  7797:     } elsif ($mode eq 'selfcreate') {
                   7798:         if ($checkitem eq 'id') {
                   7799:             $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.");
                   7800:         }
1.615     raeburn  7801:     } else {
                   7802:         if ($checkitem eq 'username') {
                   7803:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7804:         } elsif ($checkitem eq 'id') {
                   7805:             $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.");
                   7806:         }
1.612     raeburn  7807:     }
                   7808:     return $response;
1.585     raeburn  7809: }
                   7810: 
1.624     raeburn  7811: sub personal_data_fieldtitles {
                   7812:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7813:                         id => 'Student/Employee ID',
                   7814:                         permanentemail => 'E-mail address',
                   7815:                         lastname => 'Last Name',
                   7816:                         firstname => 'First Name',
                   7817:                         middlename => 'Middle Name',
                   7818:                         generation => 'Generation',
                   7819:                         gen => 'Generation',
1.765     raeburn  7820:                         inststatus => 'Affiliation',
1.624     raeburn  7821:                    );
                   7822:     return %fieldtitles;
                   7823: }
                   7824: 
1.642     raeburn  7825: sub sorted_inst_types {
                   7826:     my ($dom) = @_;
                   7827:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7828:     my $othertitle = &mt('All users');
                   7829:     if ($env{'request.course.id'}) {
1.668     raeburn  7830:         $othertitle  = &mt('Any users');
1.642     raeburn  7831:     }
                   7832:     my @types;
                   7833:     if (ref($order) eq 'ARRAY') {
                   7834:         @types = @{$order};
                   7835:     }
                   7836:     if (@types == 0) {
                   7837:         if (ref($usertypes) eq 'HASH') {
                   7838:             @types = sort(keys(%{$usertypes}));
                   7839:         }
                   7840:     }
                   7841:     if (keys(%{$usertypes}) > 0) {
                   7842:         $othertitle = &mt('Other users');
                   7843:     }
                   7844:     return ($othertitle,$usertypes,\@types);
                   7845: }
                   7846: 
1.645     raeburn  7847: sub get_institutional_codes {
                   7848:     my ($settings,$allcourses,$LC_code) = @_;
                   7849: # Get complete list of course sections to update
                   7850:     my @currsections = ();
                   7851:     my @currxlists = ();
                   7852:     my $coursecode = $$settings{'internal.coursecode'};
                   7853: 
                   7854:     if ($$settings{'internal.sectionnums'} ne '') {
                   7855:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7856:     }
                   7857: 
                   7858:     if ($$settings{'internal.crosslistings'} ne '') {
                   7859:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7860:     }
                   7861: 
                   7862:     if (@currxlists > 0) {
                   7863:         foreach (@currxlists) {
                   7864:             if (m/^([^:]+):(\w*)$/) {
                   7865:                 unless (grep/^$1$/,@{$allcourses}) {
                   7866:                     push @{$allcourses},$1;
                   7867:                     $$LC_code{$1} = $2;
                   7868:                 }
                   7869:             }
                   7870:         }
                   7871:     }
                   7872:  
                   7873:     if (@currsections > 0) {
                   7874:         foreach (@currsections) {
                   7875:             if (m/^(\w+):(\w*)$/) {
                   7876:                 my $sec = $coursecode.$1;
                   7877:                 my $lc_sec = $2;
                   7878:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7879:                     push @{$allcourses},$sec;
                   7880:                     $$LC_code{$sec} = $lc_sec;
                   7881:                 }
                   7882:             }
                   7883:         }
                   7884:     }
                   7885:     return;
                   7886: }
                   7887: 
1.112     bowersj2 7888: =pod
                   7889: 
1.780     raeburn  7890: =head1 Slot Helpers
                   7891: 
                   7892: =over 4
                   7893: 
                   7894: =item * sorted_slots()
                   7895: 
                   7896: Sorts an array of slot names in order of slot start time (earliest first). 
                   7897: 
                   7898: Inputs:
                   7899: 
                   7900: =over 4
                   7901: 
                   7902: slotsarr  - Reference to array of unsorted slot names.
                   7903: 
                   7904: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7905: 
1.549     albertel 7906: =back
                   7907: 
1.780     raeburn  7908: Returns:
                   7909: 
                   7910: =over 4
                   7911: 
                   7912: sorted   - An array of slot names sorted by the start time of the slot.
                   7913: 
                   7914: =back
                   7915: 
                   7916: =back
                   7917: 
                   7918: =cut
                   7919: 
                   7920: 
                   7921: sub sorted_slots {
                   7922:     my ($slotsarr,$slots) = @_;
                   7923:     my @sorted;
                   7924:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7925:         @sorted =
                   7926:             sort {
                   7927:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7928:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7929:                      }
                   7930:                      if (ref($slots->{$a})) { return -1;}
                   7931:                      if (ref($slots->{$b})) { return 1;}
                   7932:                      return 0;
                   7933:                  } @{$slotsarr};
                   7934:     }
                   7935:     return @sorted;
                   7936: }
                   7937: 
                   7938: 
                   7939: =pod
                   7940: 
1.549     albertel 7941: =head1 HTTP Helpers
                   7942: 
                   7943: =over 4
                   7944: 
1.648     raeburn  7945: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7946: 
1.258     albertel 7947: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7948: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7949: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7950: 
                   7951: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7952: $possible_names is an ref to an array of form element names.  As an example:
                   7953: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7954: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7955: 
                   7956: =cut
1.1       albertel 7957: 
1.6       albertel 7958: sub get_unprocessed_cgi {
1.25      albertel 7959:   my ($query,$possible_names)= @_;
1.26      matthew  7960:   # $Apache::lonxml::debug=1;
1.356     albertel 7961:   foreach my $pair (split(/&/,$query)) {
                   7962:     my ($name, $value) = split(/=/,$pair);
1.369     www      7963:     $name = &unescape($name);
1.25      albertel 7964:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   7965:       $value =~ tr/+/ /;
                   7966:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 7967:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 7968:     }
1.16      harris41 7969:   }
1.6       albertel 7970: }
                   7971: 
1.112     bowersj2 7972: =pod
                   7973: 
1.648     raeburn  7974: =item * &cacheheader() 
1.112     bowersj2 7975: 
                   7976: returns cache-controlling header code
                   7977: 
                   7978: =cut
                   7979: 
1.7       albertel 7980: sub cacheheader {
1.258     albertel 7981:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 7982:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   7983:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 7984:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   7985:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 7986:     return $output;
1.7       albertel 7987: }
                   7988: 
1.112     bowersj2 7989: =pod
                   7990: 
1.648     raeburn  7991: =item * &no_cache($r) 
1.112     bowersj2 7992: 
                   7993: specifies header code to not have cache
                   7994: 
                   7995: =cut
                   7996: 
1.9       albertel 7997: sub no_cache {
1.216     albertel 7998:     my ($r) = @_;
                   7999:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8000: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8001:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8002:     $r->no_cache(1);
                   8003:     $r->header_out("Expires" => $date);
                   8004:     $r->header_out("Pragma" => "no-cache");
1.123     www      8005: }
                   8006: 
                   8007: sub content_type {
1.181     albertel 8008:     my ($r,$type,$charset) = @_;
1.299     foxr     8009:     if ($r) {
                   8010: 	#  Note that printout.pl calls this with undef for $r.
                   8011: 	&no_cache($r);
                   8012:     }
1.258     albertel 8013:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8014:     unless ($charset) {
                   8015: 	$charset=&Apache::lonlocal::current_encoding;
                   8016:     }
                   8017:     if ($charset) { $type.='; charset='.$charset; }
                   8018:     if ($r) {
                   8019: 	$r->content_type($type);
                   8020:     } else {
                   8021: 	print("Content-type: $type\n\n");
                   8022:     }
1.9       albertel 8023: }
1.25      albertel 8024: 
1.112     bowersj2 8025: =pod
                   8026: 
1.648     raeburn  8027: =item * &add_to_env($name,$value) 
1.112     bowersj2 8028: 
1.258     albertel 8029: adds $name to the %env hash with value
1.112     bowersj2 8030: $value, if $name already exists, the entry is converted to an array
                   8031: reference and $value is added to the array.
                   8032: 
                   8033: =cut
                   8034: 
1.25      albertel 8035: sub add_to_env {
                   8036:   my ($name,$value)=@_;
1.258     albertel 8037:   if (defined($env{$name})) {
                   8038:     if (ref($env{$name})) {
1.25      albertel 8039:       #already have multiple values
1.258     albertel 8040:       push(@{ $env{$name} },$value);
1.25      albertel 8041:     } else {
                   8042:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8043:       my $first=$env{$name};
                   8044:       undef($env{$name});
                   8045:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8046:     }
                   8047:   } else {
1.258     albertel 8048:     $env{$name}=$value;
1.25      albertel 8049:   }
1.31      albertel 8050: }
1.149     albertel 8051: 
                   8052: =pod
                   8053: 
1.648     raeburn  8054: =item * &get_env_multiple($name) 
1.149     albertel 8055: 
1.258     albertel 8056: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8057: values may be defined and end up as an array ref.
                   8058: 
                   8059: returns an array of values
                   8060: 
                   8061: =cut
                   8062: 
                   8063: sub get_env_multiple {
                   8064:     my ($name) = @_;
                   8065:     my @values;
1.258     albertel 8066:     if (defined($env{$name})) {
1.149     albertel 8067:         # exists is it an array
1.258     albertel 8068:         if (ref($env{$name})) {
                   8069:             @values=@{ $env{$name} };
1.149     albertel 8070:         } else {
1.258     albertel 8071:             $values[0]=$env{$name};
1.149     albertel 8072:         }
                   8073:     }
                   8074:     return(@values);
                   8075: }
                   8076: 
1.660     raeburn  8077: sub ask_for_embedded_content {
                   8078:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8079:     my $upload_output = '
                   8080:    <form name="upload_embedded" action="'.$actionurl.'"
                   8081:                   method="post" enctype="multipart/form-data">';
                   8082:     $upload_output .= $state;
1.661     raeburn  8083:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8084: 
                   8085:     my $num = 0;
                   8086:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8087:         $upload_output .= &start_data_table_row().
                   8088:             '<td>'.$embed_file.'</td><td>';
                   8089:         if ($args->{'ignore_remote_references'}
                   8090:             && $embed_file =~ m{^\w+://}) {
                   8091:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8092:         } elsif ($args->{'error_on_invalid_names'}
                   8093:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8094: 
                   8095:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8096: 
                   8097:         } else {
                   8098:             $upload_output .='
1.661     raeburn  8099:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8100:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8101:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8102:             $upload_output .=
                   8103:                 "\n\t\t".
                   8104:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8105:                 $attrib.'" />';
                   8106:             if (exists($$codebase{$embed_file})) {
                   8107:                 $upload_output .=
                   8108:                     "\n\t\t".
                   8109:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8110:                     &escape($$codebase{$embed_file}).'" />';
                   8111:             }
                   8112:         }
                   8113:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8114:         $num++;
                   8115:     }
                   8116:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8117:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8118:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8119:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8120:    </form>';
                   8121:     return $upload_output;
                   8122: }
                   8123: 
1.661     raeburn  8124: sub upload_embedded {
                   8125:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8126:         $current_disk_usage) = @_;
                   8127:     my $output;
                   8128:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8129:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8130:         my $orig_uploaded_filename =
                   8131:             $env{'form.embedded_item_'.$i.'.filename'};
                   8132: 
                   8133:         $env{'form.embedded_orig_'.$i} =
                   8134:             &unescape($env{'form.embedded_orig_'.$i});
                   8135:         my ($path,$fname) =
                   8136:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8137:         # no path, whole string is fname
                   8138:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8139: 
                   8140:         $path = $env{'form.currentpath'}.$path;
                   8141:         $fname = &Apache::lonnet::clean_filename($fname);
                   8142:         # See if there is anything left
                   8143:         next if ($fname eq '');
                   8144: 
                   8145:         # Check if file already exists as a file or directory.
                   8146:         my ($state,$msg);
                   8147:         if ($context eq 'portfolio') {
                   8148:             my $port_path = $dirpath;
                   8149:             if ($group ne '') {
                   8150:                 $port_path = "groups/$group/$port_path";
                   8151:             }
                   8152:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8153:                                               $dir_root,$port_path,$disk_quota,
                   8154:                                               $current_disk_usage,$uname,$udom);
                   8155:             if ($state eq 'will_exceed_quota'
                   8156:                 || $state eq 'file_locked'
                   8157:                 || $state eq 'file_exists' ) {
                   8158:                 $output .= $msg;
                   8159:                 next;
                   8160:             }
                   8161:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8162:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8163:             if ($state eq 'exists') {
                   8164:                 $output .= $msg;
                   8165:                 next;
                   8166:             }
                   8167:         }
                   8168:         # Check if extension is valid
                   8169:         if (($fname =~ /\.(\w+)$/) &&
                   8170:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8171:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8172:             next;
                   8173:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8174:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8175:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8176:             next;
                   8177:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8178:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8179:             next;
                   8180:         }
                   8181: 
                   8182:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8183:         if ($context eq 'portfolio') {
                   8184:             my $result=
                   8185:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8186:                                                 $dirpath.$path);
                   8187:             if ($result !~ m|^/uploaded/|) {
                   8188:                 $output .= '<span class="LC_error">'
                   8189:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8190:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8191:                       .'</span><br />';
                   8192:                 next;
                   8193:             } else {
                   8194:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8195:                            $path.$fname.'</span>').'</p>';     
                   8196:             }
                   8197:         } else {
                   8198: # Save the file
                   8199:             my $target = $env{'form.embedded_item_'.$i};
                   8200:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8201:             my $dest = $fullpath.$fname;
                   8202:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8203:             my @parts=split(/\//,$fullpath);
                   8204:             my $count;
                   8205:             my $filepath = $dir_root;
                   8206:             for ($count=4;$count<=$#parts;$count++) {
                   8207:                 $filepath .= "/$parts[$count]";
                   8208:                 if ((-e $filepath)!=1) {
                   8209:                     mkdir($filepath,0770);
                   8210:                 }
                   8211:             }
                   8212:             my $fh;
                   8213:             if (!open($fh,'>'.$dest)) {
                   8214:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8215:                 $output .= '<span class="LC_error">'.
                   8216:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8217:                            '</span><br />';
                   8218:             } else {
                   8219:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8220:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8221:                     $output .= '<span class="LC_error">'.
                   8222:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8223:                               '</span><br />';
                   8224:                 } else {
                   8225:                     if ($context eq 'testbank') {
                   8226:                         $output .= &mt('Embedded file uploaded successfully:').
                   8227:                                    '&nbsp;<a href="'.$url.'">'.
                   8228:                                    $orig_uploaded_filename.'</a><br />';
                   8229:                     } else {
1.705     tempelho 8230:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8231:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8232:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8233:                     }
                   8234:                 }
                   8235:                 close($fh);
                   8236:             }
                   8237:         }
                   8238:     }
                   8239:     return $output;
                   8240: }
                   8241: 
                   8242: sub check_for_existing {
                   8243:     my ($path,$fname,$element) = @_;
                   8244:     my ($state,$msg);
                   8245:     if (-d $path.'/'.$fname) {
                   8246:         $state = 'exists';
                   8247:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8248:     } elsif (-e $path.'/'.$fname) {
                   8249:         $state = 'exists';
                   8250:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8251:     }
                   8252:     if ($state eq 'exists') {
                   8253:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8254:     }
                   8255:     return ($state,$msg);
                   8256: }
                   8257: 
                   8258: sub check_for_upload {
                   8259:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8260:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8261:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8262:     my $getpropath = 1;
                   8263:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8264:                                             $getpropath);
                   8265:     my $found_file = 0;
                   8266:     my $locked_file = 0;
                   8267:     foreach my $line (@dir_list) {
                   8268:         my ($file_name)=split(/\&/,$line,2);
                   8269:         if ($file_name eq $fname){
                   8270:             $file_name = $path.$file_name;
                   8271:             if ($group ne '') {
                   8272:                 $file_name = $group.$file_name;
                   8273:             }
                   8274:             $found_file = 1;
                   8275:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8276:                 $locked_file = 1;
                   8277:             }
                   8278:         }
                   8279:     }
                   8280:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8281:         my $msg = '<span class="LC_error">'.
                   8282:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8283:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8284:         return ('will_exceed_quota',$msg);
                   8285:     } elsif ($found_file) {
                   8286:         if ($locked_file) {
                   8287:             my $msg = '<span class="LC_error">';
                   8288:             $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>');
                   8289:             $msg .= '</span><br />';
                   8290:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8291:             return ('file_locked',$msg);
                   8292:         } else {
                   8293:             my $msg = '<span class="LC_error">';
                   8294:             $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'});
                   8295:             $msg .= '</span>';
                   8296:             $msg .= '<br />';
                   8297:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8298:             return ('file_exists',$msg);
                   8299:         }
                   8300:     }
                   8301: }
                   8302: 
1.31      albertel 8303: 
1.41      ng       8304: =pod
1.45      matthew  8305: 
1.464     albertel 8306: =back
1.41      ng       8307: 
1.112     bowersj2 8308: =head1 CSV Upload/Handling functions
1.38      albertel 8309: 
1.41      ng       8310: =over 4
                   8311: 
1.648     raeburn  8312: =item * &upfile_store($r)
1.41      ng       8313: 
                   8314: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8315: needs $env{'form.upfile'}
1.41      ng       8316: returns $datatoken to be put into hidden field
                   8317: 
                   8318: =cut
1.31      albertel 8319: 
                   8320: sub upfile_store {
                   8321:     my $r=shift;
1.258     albertel 8322:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8323:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8324:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8325:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8326: 
1.258     albertel 8327:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8328: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8329:     {
1.158     raeburn  8330:         my $datafile = $r->dir_config('lonDaemons').
                   8331:                            '/tmp/'.$datatoken.'.tmp';
                   8332:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8333:             print $fh $env{'form.upfile'};
1.158     raeburn  8334:             close($fh);
                   8335:         }
1.31      albertel 8336:     }
                   8337:     return $datatoken;
                   8338: }
                   8339: 
1.56      matthew  8340: =pod
                   8341: 
1.648     raeburn  8342: =item * &load_tmp_file($r)
1.41      ng       8343: 
                   8344: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8345: needs $env{'form.datatoken'},
                   8346: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8347: 
                   8348: =cut
1.31      albertel 8349: 
                   8350: sub load_tmp_file {
                   8351:     my $r=shift;
                   8352:     my @studentdata=();
                   8353:     {
1.158     raeburn  8354:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8355:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8356:         if ( open(my $fh,"<$studentfile") ) {
                   8357:             @studentdata=<$fh>;
                   8358:             close($fh);
                   8359:         }
1.31      albertel 8360:     }
1.258     albertel 8361:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8362: }
                   8363: 
1.56      matthew  8364: =pod
                   8365: 
1.648     raeburn  8366: =item * &upfile_record_sep()
1.41      ng       8367: 
                   8368: Separate uploaded file into records
                   8369: returns array of records,
1.258     albertel 8370: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8371: 
                   8372: =cut
1.31      albertel 8373: 
                   8374: sub upfile_record_sep {
1.258     albertel 8375:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8376:     } else {
1.248     albertel 8377: 	my @records;
1.258     albertel 8378: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8379: 	    if ($line=~/^\s*$/) { next; }
                   8380: 	    push(@records,$line);
                   8381: 	}
                   8382: 	return @records;
1.31      albertel 8383:     }
                   8384: }
                   8385: 
1.56      matthew  8386: =pod
                   8387: 
1.648     raeburn  8388: =item * &record_sep($record)
1.41      ng       8389: 
1.258     albertel 8390: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8391: 
                   8392: =cut
                   8393: 
1.263     www      8394: sub takeleft {
                   8395:     my $index=shift;
                   8396:     return substr('0000'.$index,-4,4);
                   8397: }
                   8398: 
1.31      albertel 8399: sub record_sep {
                   8400:     my $record=shift;
                   8401:     my %components=();
1.258     albertel 8402:     if ($env{'form.upfiletype'} eq 'xml') {
                   8403:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8404:         my $i=0;
1.356     albertel 8405:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8406:             $field=~s/^(\"|\')//;
                   8407:             $field=~s/(\"|\')$//;
1.263     www      8408:             $components{&takeleft($i)}=$field;
1.31      albertel 8409:             $i++;
                   8410:         }
1.258     albertel 8411:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8412:         my $i=0;
1.356     albertel 8413:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8414:             $field=~s/^(\"|\')//;
                   8415:             $field=~s/(\"|\')$//;
1.263     www      8416:             $components{&takeleft($i)}=$field;
1.31      albertel 8417:             $i++;
                   8418:         }
                   8419:     } else {
1.561     www      8420:         my $separator=',';
1.480     banghart 8421:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8422:             $separator=';';
1.480     banghart 8423:         }
1.31      albertel 8424:         my $i=0;
1.561     www      8425: # the character we are looking for to indicate the end of a quote or a record 
                   8426:         my $looking_for=$separator;
                   8427: # do not add the characters to the fields
                   8428:         my $ignore=0;
                   8429: # we just encountered a separator (or the beginning of the record)
                   8430:         my $just_found_separator=1;
                   8431: # store the field we are working on here
                   8432:         my $field='';
                   8433: # work our way through all characters in record
                   8434:         foreach my $character ($record=~/(.)/g) {
                   8435:             if ($character eq $looking_for) {
                   8436:                if ($character ne $separator) {
                   8437: # Found the end of a quote, again looking for separator
                   8438:                   $looking_for=$separator;
                   8439:                   $ignore=1;
                   8440:                } else {
                   8441: # Found a separator, store away what we got
                   8442:                   $components{&takeleft($i)}=$field;
                   8443: 	          $i++;
                   8444:                   $just_found_separator=1;
                   8445:                   $ignore=0;
                   8446:                   $field='';
                   8447:                }
                   8448:                next;
                   8449:             }
                   8450: # single or double quotation marks after a separator indicate beginning of a quote
                   8451: # we are now looking for the end of the quote and need to ignore separators
                   8452:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8453:                $looking_for=$character;
                   8454:                next;
                   8455:             }
                   8456: # ignore would be true after we reached the end of a quote
                   8457:             if ($ignore) { next; }
                   8458:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8459:             $field.=$character;
                   8460:             $just_found_separator=0; 
1.31      albertel 8461:         }
1.561     www      8462: # catch the very last entry, since we never encountered the separator
                   8463:         $components{&takeleft($i)}=$field;
1.31      albertel 8464:     }
                   8465:     return %components;
                   8466: }
                   8467: 
1.144     matthew  8468: ######################################################
                   8469: ######################################################
                   8470: 
1.56      matthew  8471: =pod
                   8472: 
1.648     raeburn  8473: =item * &upfile_select_html()
1.41      ng       8474: 
1.144     matthew  8475: Return HTML code to select a file from the users machine and specify 
                   8476: the file type.
1.41      ng       8477: 
                   8478: =cut
                   8479: 
1.144     matthew  8480: ######################################################
                   8481: ######################################################
1.31      albertel 8482: sub upfile_select_html {
1.144     matthew  8483:     my %Types = (
                   8484:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8485:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8486:                  space => &mt('Space separated'),
                   8487:                  tab   => &mt('Tabulator separated'),
                   8488: #                 xml   => &mt('HTML/XML'),
                   8489:                  );
                   8490:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8491:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8492:     foreach my $type (sort(keys(%Types))) {
                   8493:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8494:     }
                   8495:     $Str .= "</select>\n";
                   8496:     return $Str;
1.31      albertel 8497: }
                   8498: 
1.301     albertel 8499: sub get_samples {
                   8500:     my ($records,$toget) = @_;
                   8501:     my @samples=({});
                   8502:     my $got=0;
                   8503:     foreach my $rec (@$records) {
                   8504: 	my %temp = &record_sep($rec);
                   8505: 	if (! grep(/\S/, values(%temp))) { next; }
                   8506: 	if (%temp) {
                   8507: 	    $samples[$got]=\%temp;
                   8508: 	    $got++;
                   8509: 	    if ($got == $toget) { last; }
                   8510: 	}
                   8511:     }
                   8512:     return \@samples;
                   8513: }
                   8514: 
1.144     matthew  8515: ######################################################
                   8516: ######################################################
                   8517: 
1.56      matthew  8518: =pod
                   8519: 
1.648     raeburn  8520: =item * &csv_print_samples($r,$records)
1.41      ng       8521: 
                   8522: Prints a table of sample values from each column uploaded $r is an
                   8523: Apache Request ref, $records is an arrayref from
                   8524: &Apache::loncommon::upfile_record_sep
                   8525: 
                   8526: =cut
                   8527: 
1.144     matthew  8528: ######################################################
                   8529: ######################################################
1.31      albertel 8530: sub csv_print_samples {
                   8531:     my ($r,$records) = @_;
1.662     bisitz   8532:     my $samples = &get_samples($records,5);
1.301     albertel 8533: 
1.594     raeburn  8534:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8535:               &start_data_table_header_row());
1.356     albertel 8536:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8537:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8538:     $r->print(&end_data_table_header_row());
1.301     albertel 8539:     foreach my $hash (@$samples) {
1.594     raeburn  8540: 	$r->print(&start_data_table_row());
1.356     albertel 8541: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8542: 	    $r->print('<td>');
1.356     albertel 8543: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8544: 	    $r->print('</td>');
                   8545: 	}
1.594     raeburn  8546: 	$r->print(&end_data_table_row());
1.31      albertel 8547:     }
1.594     raeburn  8548:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8549: }
                   8550: 
1.144     matthew  8551: ######################################################
                   8552: ######################################################
                   8553: 
1.56      matthew  8554: =pod
                   8555: 
1.648     raeburn  8556: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8557: 
                   8558: Prints a table to create associations between values and table columns.
1.144     matthew  8559: 
1.41      ng       8560: $r is an Apache Request ref,
                   8561: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8562: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8563: 
                   8564: =cut
                   8565: 
1.144     matthew  8566: ######################################################
                   8567: ######################################################
1.31      albertel 8568: sub csv_print_select_table {
                   8569:     my ($r,$records,$d) = @_;
1.301     albertel 8570:     my $i=0;
                   8571:     my $samples = &get_samples($records,1);
1.144     matthew  8572:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8573: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8574:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8575:               '<th>'.&mt('Column').'</th>'.
                   8576:               &end_data_table_header_row()."\n");
1.356     albertel 8577:     foreach my $array_ref (@$d) {
                   8578: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8579: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8580: 
                   8581: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8582: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8583: 	$r->print('<option value="none"></option>');
1.356     albertel 8584: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8585: 	    $r->print('<option value="'.$sample.'"'.
                   8586:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8587:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8588: 	}
1.594     raeburn  8589: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8590: 	$i++;
                   8591:     }
1.594     raeburn  8592:     $r->print(&end_data_table());
1.31      albertel 8593:     $i--;
                   8594:     return $i;
                   8595: }
1.56      matthew  8596: 
1.144     matthew  8597: ######################################################
                   8598: ######################################################
                   8599: 
1.56      matthew  8600: =pod
1.31      albertel 8601: 
1.648     raeburn  8602: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8603: 
                   8604: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8605: 
                   8606: $r is an Apache Request ref,
                   8607: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8608: $d is an array of 2 element arrays (internal name, displayed name)
                   8609: 
                   8610: =cut
                   8611: 
1.144     matthew  8612: ######################################################
                   8613: ######################################################
1.31      albertel 8614: sub csv_samples_select_table {
                   8615:     my ($r,$records,$d) = @_;
                   8616:     my $i=0;
1.144     matthew  8617:     #
1.662     bisitz   8618:     my $max_samples = 5;
                   8619:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8620:     $r->print(&start_data_table().
                   8621:               &start_data_table_header_row().'<th>'.
                   8622:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8623:               &end_data_table_header_row());
1.301     albertel 8624: 
                   8625:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8626: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8627: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8628: 	foreach my $option (@$d) {
                   8629: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8630: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8631:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8632:                       $display.'</option>');
1.31      albertel 8633: 	}
                   8634: 	$r->print('</select></td><td>');
1.662     bisitz   8635: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8636: 	    if (defined($samples->[$line]{$key})) { 
                   8637: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8638: 	    }
                   8639: 	}
1.594     raeburn  8640: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8641: 	$i++;
                   8642:     }
1.594     raeburn  8643:     $r->print(&end_data_table());
1.31      albertel 8644:     $i--;
                   8645:     return($i);
1.115     matthew  8646: }
                   8647: 
1.144     matthew  8648: ######################################################
                   8649: ######################################################
                   8650: 
1.115     matthew  8651: =pod
                   8652: 
1.648     raeburn  8653: =item * &clean_excel_name($name)
1.115     matthew  8654: 
                   8655: Returns a replacement for $name which does not contain any illegal characters.
                   8656: 
                   8657: =cut
                   8658: 
1.144     matthew  8659: ######################################################
                   8660: ######################################################
1.115     matthew  8661: sub clean_excel_name {
                   8662:     my ($name) = @_;
                   8663:     $name =~ s/[:\*\?\/\\]//g;
                   8664:     if (length($name) > 31) {
                   8665:         $name = substr($name,0,31);
                   8666:     }
                   8667:     return $name;
1.25      albertel 8668: }
1.84      albertel 8669: 
1.85      albertel 8670: =pod
                   8671: 
1.648     raeburn  8672: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8673: 
                   8674: Returns either 1 or undef
                   8675: 
                   8676: 1 if the part is to be hidden, undef if it is to be shown
                   8677: 
                   8678: Arguments are:
                   8679: 
                   8680: $id the id of the part to be checked
                   8681: $symb, optional the symb of the resource to check
                   8682: $udom, optional the domain of the user to check for
                   8683: $uname, optional the username of the user to check for
                   8684: 
                   8685: =cut
1.84      albertel 8686: 
                   8687: sub check_if_partid_hidden {
                   8688:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8689:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8690: 					 $symb,$udom,$uname);
1.141     albertel 8691:     my $truth=1;
                   8692:     #if the string starts with !, then the list is the list to show not hide
                   8693:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8694:     my @hiddenlist=split(/,/,$hiddenparts);
                   8695:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8696: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8697:     }
1.141     albertel 8698:     return !$truth;
1.84      albertel 8699: }
1.127     matthew  8700: 
1.138     matthew  8701: 
                   8702: ############################################################
                   8703: ############################################################
                   8704: 
                   8705: =pod
                   8706: 
1.157     matthew  8707: =back 
                   8708: 
1.138     matthew  8709: =head1 cgi-bin script and graphing routines
                   8710: 
1.157     matthew  8711: =over 4
                   8712: 
1.648     raeburn  8713: =item * &get_cgi_id()
1.138     matthew  8714: 
                   8715: Inputs: none
                   8716: 
                   8717: Returns an id which can be used to pass environment variables
                   8718: to various cgi-bin scripts.  These environment variables will
                   8719: be removed from the users environment after a given time by
                   8720: the routine &Apache::lonnet::transfer_profile_to_env.
                   8721: 
                   8722: =cut
                   8723: 
                   8724: ############################################################
                   8725: ############################################################
1.152     albertel 8726: my $uniq=0;
1.136     matthew  8727: sub get_cgi_id {
1.154     albertel 8728:     $uniq=($uniq+1)%100000;
1.280     albertel 8729:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8730: }
                   8731: 
1.127     matthew  8732: ############################################################
                   8733: ############################################################
                   8734: 
                   8735: =pod
                   8736: 
1.648     raeburn  8737: =item * &DrawBarGraph()
1.127     matthew  8738: 
1.138     matthew  8739: Facilitates the plotting of data in a (stacked) bar graph.
                   8740: Puts plot definition data into the users environment in order for 
                   8741: graph.png to plot it.  Returns an <img> tag for the plot.
                   8742: The bars on the plot are labeled '1','2',...,'n'.
                   8743: 
                   8744: Inputs:
                   8745: 
                   8746: =over 4
                   8747: 
                   8748: =item $Title: string, the title of the plot
                   8749: 
                   8750: =item $xlabel: string, text describing the X-axis of the plot
                   8751: 
                   8752: =item $ylabel: string, text describing the Y-axis of the plot
                   8753: 
                   8754: =item $Max: scalar, the maximum Y value to use in the plot
                   8755: If $Max is < any data point, the graph will not be rendered.
                   8756: 
1.140     matthew  8757: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8758: they are plotted.  If undefined, default values will be used.
                   8759: 
1.178     matthew  8760: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8761: 
1.138     matthew  8762: =item @Values: An array of array references.  Each array reference holds data
                   8763: to be plotted in a stacked bar chart.
                   8764: 
1.239     matthew  8765: =item If the final element of @Values is a hash reference the key/value
                   8766: pairs will be added to the graph definition.
                   8767: 
1.138     matthew  8768: =back
                   8769: 
                   8770: Returns:
                   8771: 
                   8772: An <img> tag which references graph.png and the appropriate identifying
                   8773: information for the plot.
                   8774: 
1.127     matthew  8775: =cut
                   8776: 
                   8777: ############################################################
                   8778: ############################################################
1.134     matthew  8779: sub DrawBarGraph {
1.178     matthew  8780:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8781:     #
                   8782:     if (! defined($colors)) {
                   8783:         $colors = ['#33ff00', 
                   8784:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8785:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8786:                   ]; 
                   8787:     }
1.228     matthew  8788:     my $extra_settings = {};
                   8789:     if (ref($Values[-1]) eq 'HASH') {
                   8790:         $extra_settings = pop(@Values);
                   8791:     }
1.127     matthew  8792:     #
1.136     matthew  8793:     my $identifier = &get_cgi_id();
                   8794:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8795:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8796:         return '';
                   8797:     }
1.225     matthew  8798:     #
                   8799:     my @Labels;
                   8800:     if (defined($labels)) {
                   8801:         @Labels = @$labels;
                   8802:     } else {
                   8803:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8804:             push (@Labels,$i+1);
                   8805:         }
                   8806:     }
                   8807:     #
1.129     matthew  8808:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8809:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8810:     my %ValuesHash;
                   8811:     my $NumSets=1;
                   8812:     foreach my $array (@Values) {
                   8813:         next if (! ref($array));
1.136     matthew  8814:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8815:             join(',',@$array);
1.129     matthew  8816:     }
1.127     matthew  8817:     #
1.136     matthew  8818:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8819:     if ($NumBars < 3) {
                   8820:         $width = 120+$NumBars*32;
1.220     matthew  8821:         $xskip = 1;
1.225     matthew  8822:         $bar_width = 30;
                   8823:     } elsif ($NumBars < 5) {
                   8824:         $width = 120+$NumBars*20;
                   8825:         $xskip = 1;
                   8826:         $bar_width = 20;
1.220     matthew  8827:     } elsif ($NumBars < 10) {
1.136     matthew  8828:         $width = 120+$NumBars*15;
                   8829:         $xskip = 1;
                   8830:         $bar_width = 15;
                   8831:     } elsif ($NumBars <= 25) {
                   8832:         $width = 120+$NumBars*11;
                   8833:         $xskip = 5;
                   8834:         $bar_width = 8;
                   8835:     } elsif ($NumBars <= 50) {
                   8836:         $width = 120+$NumBars*8;
                   8837:         $xskip = 5;
                   8838:         $bar_width = 4;
                   8839:     } else {
                   8840:         $width = 120+$NumBars*8;
                   8841:         $xskip = 5;
                   8842:         $bar_width = 4;
                   8843:     }
                   8844:     #
1.137     matthew  8845:     $Max = 1 if ($Max < 1);
                   8846:     if ( int($Max) < $Max ) {
                   8847:         $Max++;
                   8848:         $Max = int($Max);
                   8849:     }
1.127     matthew  8850:     $Title  = '' if (! defined($Title));
                   8851:     $xlabel = '' if (! defined($xlabel));
                   8852:     $ylabel = '' if (! defined($ylabel));
1.369     www      8853:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8854:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8855:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8856:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8857:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8858:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8859:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8860:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8861:     $ValuesHash{$id.'.height'}   = $height;
                   8862:     $ValuesHash{$id.'.width'}    = $width;
                   8863:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8864:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8865:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8866:     #
1.228     matthew  8867:     # Deal with other parameters
                   8868:     while (my ($key,$value) = each(%$extra_settings)) {
                   8869:         $ValuesHash{$id.'.'.$key} = $value;
                   8870:     }
                   8871:     #
1.646     raeburn  8872:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8873:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8874: }
                   8875: 
                   8876: ############################################################
                   8877: ############################################################
                   8878: 
                   8879: =pod
                   8880: 
1.648     raeburn  8881: =item * &DrawXYGraph()
1.137     matthew  8882: 
1.138     matthew  8883: Facilitates the plotting of data in an XY graph.
                   8884: Puts plot definition data into the users environment in order for 
                   8885: graph.png to plot it.  Returns an <img> tag for the plot.
                   8886: 
                   8887: Inputs:
                   8888: 
                   8889: =over 4
                   8890: 
                   8891: =item $Title: string, the title of the plot
                   8892: 
                   8893: =item $xlabel: string, text describing the X-axis of the plot
                   8894: 
                   8895: =item $ylabel: string, text describing the Y-axis of the plot
                   8896: 
                   8897: =item $Max: scalar, the maximum Y value to use in the plot
                   8898: If $Max is < any data point, the graph will not be rendered.
                   8899: 
                   8900: =item $colors: Array ref containing the hex color codes for the data to be 
                   8901: plotted in.  If undefined, default values will be used.
                   8902: 
                   8903: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8904: 
                   8905: =item $Ydata: Array ref containing Array refs.  
1.185     www      8906: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8907: 
                   8908: =item %Values: hash indicating or overriding any default values which are 
                   8909: passed to graph.png.  
                   8910: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8911: 
                   8912: =back
                   8913: 
                   8914: Returns:
                   8915: 
                   8916: An <img> tag which references graph.png and the appropriate identifying
                   8917: information for the plot.
                   8918: 
1.137     matthew  8919: =cut
                   8920: 
                   8921: ############################################################
                   8922: ############################################################
                   8923: sub DrawXYGraph {
                   8924:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8925:     #
                   8926:     # Create the identifier for the graph
                   8927:     my $identifier = &get_cgi_id();
                   8928:     my $id = 'cgi.'.$identifier;
                   8929:     #
                   8930:     $Title  = '' if (! defined($Title));
                   8931:     $xlabel = '' if (! defined($xlabel));
                   8932:     $ylabel = '' if (! defined($ylabel));
                   8933:     my %ValuesHash = 
                   8934:         (
1.369     www      8935:          $id.'.title'  => &escape($Title),
                   8936:          $id.'.xlabel' => &escape($xlabel),
                   8937:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8938:          $id.'.y_max_value'=> $Max,
                   8939:          $id.'.labels'     => join(',',@$Xlabels),
                   8940:          $id.'.PlotType'   => 'XY',
                   8941:          );
                   8942:     #
                   8943:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8944:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8945:     }
                   8946:     #
                   8947:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8948:         return '';
                   8949:     }
                   8950:     my $NumSets=1;
1.138     matthew  8951:     foreach my $array (@{$Ydata}){
1.137     matthew  8952:         next if (! ref($array));
                   8953:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8954:     }
1.138     matthew  8955:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8956:     #
                   8957:     # Deal with other parameters
                   8958:     while (my ($key,$value) = each(%Values)) {
                   8959:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8960:     }
                   8961:     #
1.646     raeburn  8962:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  8963:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8964: }
                   8965: 
                   8966: ############################################################
                   8967: ############################################################
                   8968: 
                   8969: =pod
                   8970: 
1.648     raeburn  8971: =item * &DrawXYYGraph()
1.138     matthew  8972: 
                   8973: Facilitates the plotting of data in an XY graph with two Y axes.
                   8974: Puts plot definition data into the users environment in order for 
                   8975: graph.png to plot it.  Returns an <img> tag for the plot.
                   8976: 
                   8977: Inputs:
                   8978: 
                   8979: =over 4
                   8980: 
                   8981: =item $Title: string, the title of the plot
                   8982: 
                   8983: =item $xlabel: string, text describing the X-axis of the plot
                   8984: 
                   8985: =item $ylabel: string, text describing the Y-axis of the plot
                   8986: 
                   8987: =item $colors: Array ref containing the hex color codes for the data to be 
                   8988: plotted in.  If undefined, default values will be used.
                   8989: 
                   8990: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8991: 
                   8992: =item $Ydata1: The first data set
                   8993: 
                   8994: =item $Min1: The minimum value of the left Y-axis
                   8995: 
                   8996: =item $Max1: The maximum value of the left Y-axis
                   8997: 
                   8998: =item $Ydata2: The second data set
                   8999: 
                   9000: =item $Min2: The minimum value of the right Y-axis
                   9001: 
                   9002: =item $Max2: The maximum value of the left Y-axis
                   9003: 
                   9004: =item %Values: hash indicating or overriding any default values which are 
                   9005: passed to graph.png.  
                   9006: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9007: 
                   9008: =back
                   9009: 
                   9010: Returns:
                   9011: 
                   9012: An <img> tag which references graph.png and the appropriate identifying
                   9013: information for the plot.
1.136     matthew  9014: 
                   9015: =cut
                   9016: 
                   9017: ############################################################
                   9018: ############################################################
1.137     matthew  9019: sub DrawXYYGraph {
                   9020:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9021:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9022:     #
                   9023:     # Create the identifier for the graph
                   9024:     my $identifier = &get_cgi_id();
                   9025:     my $id = 'cgi.'.$identifier;
                   9026:     #
                   9027:     $Title  = '' if (! defined($Title));
                   9028:     $xlabel = '' if (! defined($xlabel));
                   9029:     $ylabel = '' if (! defined($ylabel));
                   9030:     my %ValuesHash = 
                   9031:         (
1.369     www      9032:          $id.'.title'  => &escape($Title),
                   9033:          $id.'.xlabel' => &escape($xlabel),
                   9034:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9035:          $id.'.labels' => join(',',@$Xlabels),
                   9036:          $id.'.PlotType' => 'XY',
                   9037:          $id.'.NumSets' => 2,
1.137     matthew  9038:          $id.'.two_axes' => 1,
                   9039:          $id.'.y1_max_value' => $Max1,
                   9040:          $id.'.y1_min_value' => $Min1,
                   9041:          $id.'.y2_max_value' => $Max2,
                   9042:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9043:          );
                   9044:     #
1.137     matthew  9045:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9046:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9047:     }
                   9048:     #
                   9049:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9050:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9051:         return '';
                   9052:     }
                   9053:     my $NumSets=1;
1.137     matthew  9054:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9055:         next if (! ref($array));
                   9056:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9057:     }
                   9058:     #
                   9059:     # Deal with other parameters
                   9060:     while (my ($key,$value) = each(%Values)) {
                   9061:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9062:     }
                   9063:     #
1.646     raeburn  9064:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9065:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9066: }
                   9067: 
                   9068: ############################################################
                   9069: ############################################################
                   9070: 
                   9071: =pod
                   9072: 
1.157     matthew  9073: =back 
                   9074: 
1.139     matthew  9075: =head1 Statistics helper routines?  
                   9076: 
                   9077: Bad place for them but what the hell.
                   9078: 
1.157     matthew  9079: =over 4
                   9080: 
1.648     raeburn  9081: =item * &chartlink()
1.139     matthew  9082: 
                   9083: Returns a link to the chart for a specific student.  
                   9084: 
                   9085: Inputs:
                   9086: 
                   9087: =over 4
                   9088: 
                   9089: =item $linktext: The text of the link
                   9090: 
                   9091: =item $sname: The students username
                   9092: 
                   9093: =item $sdomain: The students domain
                   9094: 
                   9095: =back
                   9096: 
1.157     matthew  9097: =back
                   9098: 
1.139     matthew  9099: =cut
                   9100: 
                   9101: ############################################################
                   9102: ############################################################
                   9103: sub chartlink {
                   9104:     my ($linktext, $sname, $sdomain) = @_;
                   9105:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9106:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9107:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9108:        '">'.$linktext.'</a>';
1.153     matthew  9109: }
                   9110: 
                   9111: #######################################################
                   9112: #######################################################
                   9113: 
                   9114: =pod
                   9115: 
                   9116: =head1 Course Environment Routines
1.157     matthew  9117: 
                   9118: =over 4
1.153     matthew  9119: 
1.648     raeburn  9120: =item * &restore_course_settings()
1.153     matthew  9121: 
1.648     raeburn  9122: =item * &store_course_settings()
1.153     matthew  9123: 
                   9124: Restores/Store indicated form parameters from the course environment.
                   9125: Will not overwrite existing values of the form parameters.
                   9126: 
                   9127: Inputs: 
                   9128: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9129: 
                   9130: a hash ref describing the data to be stored.  For example:
                   9131:    
                   9132: %Save_Parameters = ('Status' => 'scalar',
                   9133:     'chartoutputmode' => 'scalar',
                   9134:     'chartoutputdata' => 'scalar',
                   9135:     'Section' => 'array',
1.373     raeburn  9136:     'Group' => 'array',
1.153     matthew  9137:     'StudentData' => 'array',
                   9138:     'Maps' => 'array');
                   9139: 
                   9140: Returns: both routines return nothing
                   9141: 
1.631     raeburn  9142: =back
                   9143: 
1.153     matthew  9144: =cut
                   9145: 
                   9146: #######################################################
                   9147: #######################################################
                   9148: sub store_course_settings {
1.496     albertel 9149:     return &store_settings($env{'request.course.id'},@_);
                   9150: }
                   9151: 
                   9152: sub store_settings {
1.153     matthew  9153:     # save to the environment
                   9154:     # appenv the same items, just to be safe
1.300     albertel 9155:     my $udom  = $env{'user.domain'};
                   9156:     my $uname = $env{'user.name'};
1.496     albertel 9157:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9158:     my %SaveHash;
                   9159:     my %AppHash;
                   9160:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9161:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9162:         my $envname = 'environment.'.$basename;
1.258     albertel 9163:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9164:             # Save this value away
                   9165:             if ($type eq 'scalar' &&
1.258     albertel 9166:                 (! exists($env{$envname}) || 
                   9167:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9168:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9169:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9170:             } elsif ($type eq 'array') {
                   9171:                 my $stored_form;
1.258     albertel 9172:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9173:                     $stored_form = join(',',
                   9174:                                         map {
1.369     www      9175:                                             &escape($_);
1.258     albertel 9176:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9177:                 } else {
                   9178:                     $stored_form = 
1.369     www      9179:                         &escape($env{'form.'.$setting});
1.153     matthew  9180:                 }
                   9181:                 # Determine if the array contents are the same.
1.258     albertel 9182:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9183:                     $SaveHash{$basename} = $stored_form;
                   9184:                     $AppHash{$envname}   = $stored_form;
                   9185:                 }
                   9186:             }
                   9187:         }
                   9188:     }
                   9189:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9190:                                           $udom,$uname);
1.153     matthew  9191:     if ($put_result !~ /^(ok|delayed)/) {
                   9192:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9193:                                  'got error:'.$put_result);
                   9194:     }
                   9195:     # Make sure these settings stick around in this session, too
1.646     raeburn  9196:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9197:     return;
                   9198: }
                   9199: 
                   9200: sub restore_course_settings {
1.499     albertel 9201:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9202: }
                   9203: 
                   9204: sub restore_settings {
                   9205:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9206:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9207:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9208:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9209:             '.'.$setting;
1.258     albertel 9210:         if (exists($env{$envname})) {
1.153     matthew  9211:             if ($type eq 'scalar') {
1.258     albertel 9212:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9213:             } elsif ($type eq 'array') {
1.258     albertel 9214:                 $env{'form.'.$setting} = [ 
1.153     matthew  9215:                                            map { 
1.369     www      9216:                                                &unescape($_); 
1.258     albertel 9217:                                            } split(',',$env{$envname})
1.153     matthew  9218:                                            ];
                   9219:             }
                   9220:         }
                   9221:     }
1.127     matthew  9222: }
                   9223: 
1.618     raeburn  9224: #######################################################
                   9225: #######################################################
                   9226: 
                   9227: =pod
                   9228: 
                   9229: =head1 Domain E-mail Routines  
                   9230: 
                   9231: =over 4
                   9232: 
1.648     raeburn  9233: =item * &build_recipient_list()
1.618     raeburn  9234: 
1.766     raeburn  9235: Build recipient lists for four types of e-mail:
                   9236: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
                   9237: (d) Help requests, generated by
                   9238: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618     raeburn  9239: 
                   9240: Inputs:
1.619     raeburn  9241: defmail (scalar - email address of default recipient), 
1.618     raeburn  9242: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9243: defdom (domain for which to retrieve configuration settings),
                   9244: origmail (scalar - email address of recipient from loncapa.conf, 
                   9245: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9246: 
1.655     raeburn  9247: Returns: comma separated list of addresses to which to send e-mail.
                   9248: 
                   9249: =back
1.618     raeburn  9250: 
                   9251: =cut
                   9252: 
                   9253: ############################################################
                   9254: ############################################################
                   9255: sub build_recipient_list {
1.619     raeburn  9256:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9257:     my @recipients;
                   9258:     my $otheremails;
                   9259:     my %domconfig =
                   9260:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9261:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9262:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9263:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9264:                 my @contacts = ('adminemail','supportemail');
                   9265:                 foreach my $item (@contacts) {
                   9266:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9267:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9268:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9269:                             push(@recipients,$addr);
                   9270:                         }
1.619     raeburn  9271:                     }
1.766     raeburn  9272:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9273:                 }
                   9274:             }
1.766     raeburn  9275:         } elsif ($origmail ne '') {
                   9276:             push(@recipients,$origmail);
1.618     raeburn  9277:         }
1.619     raeburn  9278:     } elsif ($origmail ne '') {
                   9279:         push(@recipients,$origmail);
1.618     raeburn  9280:     }
1.688     raeburn  9281:     if (defined($defmail)) {
                   9282:         if ($defmail ne '') {
                   9283:             push(@recipients,$defmail);
                   9284:         }
1.618     raeburn  9285:     }
                   9286:     if ($otheremails) {
1.619     raeburn  9287:         my @others;
                   9288:         if ($otheremails =~ /,/) {
                   9289:             @others = split(/,/,$otheremails);
1.618     raeburn  9290:         } else {
1.619     raeburn  9291:             push(@others,$otheremails);
                   9292:         }
                   9293:         foreach my $addr (@others) {
                   9294:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9295:                 push(@recipients,$addr);
                   9296:             }
1.618     raeburn  9297:         }
                   9298:     }
1.619     raeburn  9299:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9300:     return $recipientlist;
                   9301: }
                   9302: 
1.127     matthew  9303: ############################################################
                   9304: ############################################################
1.154     albertel 9305: 
1.655     raeburn  9306: =pod
                   9307: 
                   9308: =head1 Course Catalog Routines
                   9309: 
                   9310: =over 4
                   9311: 
                   9312: =item * &gather_categories()
                   9313: 
                   9314: Converts category definitions - keys of categories hash stored in  
                   9315: coursecategories in configuration.db on the primary library server in a 
                   9316: domain - to an array.  Also generates javascript and idx hash used to 
                   9317: generate Domain Coordinator interface for editing Course Categories.
                   9318: 
                   9319: Inputs:
1.663     raeburn  9320: 
1.655     raeburn  9321: categories (reference to hash of category definitions).
1.663     raeburn  9322: 
1.655     raeburn  9323: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9324:       categories and subcategories).
1.663     raeburn  9325: 
1.655     raeburn  9326: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9327:       editing Course Categories).
1.663     raeburn  9328: 
1.655     raeburn  9329: jsarray (reference to array of categories used to create Javascript arrays for
                   9330:          Domain Coordinator interface for editing Course Categories).
                   9331: 
                   9332: Returns: nothing
                   9333: 
                   9334: Side effects: populates cats, idx and jsarray. 
                   9335: 
                   9336: =cut
                   9337: 
                   9338: sub gather_categories {
                   9339:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9340:     my %counters;
                   9341:     my $num = 0;
                   9342:     foreach my $item (keys(%{$categories})) {
                   9343:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9344:         if ($container eq '' && $depth == 0) {
                   9345:             $cats->[$depth][$categories->{$item}] = $cat;
                   9346:         } else {
                   9347:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9348:         }
                   9349:         my ($escitem,$tail) = split(/:/,$item,2);
                   9350:         if ($counters{$tail} eq '') {
                   9351:             $counters{$tail} = $num;
                   9352:             $num ++;
                   9353:         }
                   9354:         if (ref($idx) eq 'HASH') {
                   9355:             $idx->{$item} = $counters{$tail};
                   9356:         }
                   9357:         if (ref($jsarray) eq 'ARRAY') {
                   9358:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9359:         }
                   9360:     }
                   9361:     return;
                   9362: }
                   9363: 
                   9364: =pod
                   9365: 
                   9366: =item * &extract_categories()
                   9367: 
                   9368: Used to generate breadcrumb trails for course categories.
                   9369: 
                   9370: Inputs:
1.663     raeburn  9371: 
1.655     raeburn  9372: categories (reference to hash of category definitions).
1.663     raeburn  9373: 
1.655     raeburn  9374: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9375:       categories and subcategories).
1.663     raeburn  9376: 
1.655     raeburn  9377: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9378: 
1.655     raeburn  9379: allitems (reference to hash - key is category key 
                   9380:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9381: 
1.655     raeburn  9382: idx (reference to hash of counters used in Domain Coordinator interface for
                   9383:       editing Course Categories).
1.663     raeburn  9384: 
1.655     raeburn  9385: jsarray (reference to array of categories used to create Javascript arrays for
                   9386:          Domain Coordinator interface for editing Course Categories).
                   9387: 
1.665     raeburn  9388: subcats (reference to hash of arrays containing all subcategories within each 
                   9389:          category, -recursive)
                   9390: 
1.655     raeburn  9391: Returns: nothing
                   9392: 
                   9393: Side effects: populates trails and allitems hash references.
                   9394: 
                   9395: =cut
                   9396: 
                   9397: sub extract_categories {
1.665     raeburn  9398:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9399:     if (ref($categories) eq 'HASH') {
                   9400:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9401:         if (ref($cats->[0]) eq 'ARRAY') {
                   9402:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9403:                 my $name = $cats->[0][$i];
                   9404:                 my $item = &escape($name).'::0';
                   9405:                 my $trailstr;
                   9406:                 if ($name eq 'instcode') {
                   9407:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9408:                 } else {
                   9409:                     $trailstr = $name;
                   9410:                 }
                   9411:                 if ($allitems->{$item} eq '') {
                   9412:                     push(@{$trails},$trailstr);
                   9413:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9414:                 }
                   9415:                 my @parents = ($name);
                   9416:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9417:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9418:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9419:                         if (ref($subcats) eq 'HASH') {
                   9420:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9421:                         }
                   9422:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9423:                     }
                   9424:                 } else {
                   9425:                     if (ref($subcats) eq 'HASH') {
                   9426:                         $subcats->{$item} = [];
1.655     raeburn  9427:                     }
                   9428:                 }
                   9429:             }
                   9430:         }
                   9431:     }
                   9432:     return;
                   9433: }
                   9434: 
                   9435: =pod
                   9436: 
                   9437: =item *&recurse_categories()
                   9438: 
                   9439: Recursively used to generate breadcrumb trails for course categories.
                   9440: 
                   9441: Inputs:
1.663     raeburn  9442: 
1.655     raeburn  9443: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9444:       categories and subcategories).
1.663     raeburn  9445: 
1.655     raeburn  9446: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9447: 
                   9448: category (current course category, for which breadcrumb trail is being generated).
                   9449: 
                   9450: trails (reference to array of breadcrumb trails for each category).
                   9451: 
1.655     raeburn  9452: allitems (reference to hash - key is category key
                   9453:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9454: 
1.655     raeburn  9455: parents (array containing containers directories for current category, 
                   9456:          back to top level). 
                   9457: 
                   9458: Returns: nothing
                   9459: 
                   9460: Side effects: populates trails and allitems hash references
                   9461: 
                   9462: =cut
                   9463: 
                   9464: sub recurse_categories {
1.665     raeburn  9465:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9466:     my $shallower = $depth - 1;
                   9467:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9468:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9469:             my $name = $cats->[$depth]{$category}[$k];
                   9470:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9471:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9472:             if ($allitems->{$item} eq '') {
                   9473:                 push(@{$trails},$trailstr);
                   9474:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9475:             }
                   9476:             my $deeper = $depth+1;
                   9477:             push(@{$parents},$category);
1.665     raeburn  9478:             if (ref($subcats) eq 'HASH') {
                   9479:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9480:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9481:                     my $higher;
                   9482:                     if ($j > 0) {
                   9483:                         $higher = &escape($parents->[$j]).':'.
                   9484:                                   &escape($parents->[$j-1]).':'.$j;
                   9485:                     } else {
                   9486:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9487:                     }
                   9488:                     push(@{$subcats->{$higher}},$subcat);
                   9489:                 }
                   9490:             }
                   9491:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9492:                                 $subcats);
1.655     raeburn  9493:             pop(@{$parents});
                   9494:         }
                   9495:     } else {
                   9496:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9497:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9498:         if ($allitems->{$item} eq '') {
                   9499:             push(@{$trails},$trailstr);
                   9500:             $allitems->{$item} = scalar(@{$trails})-1;
                   9501:         }
                   9502:     }
                   9503:     return;
                   9504: }
                   9505: 
1.663     raeburn  9506: =pod
                   9507: 
                   9508: =item *&assign_categories_table()
                   9509: 
                   9510: Create a datatable for display of hierarchical categories in a domain,
                   9511: with checkboxes to allow a course to be categorized. 
                   9512: 
                   9513: Inputs:
                   9514: 
                   9515: cathash - reference to hash of categories defined for the domain (from
                   9516:           configuration.db)
                   9517: 
                   9518: currcat - scalar with an & separated list of categories assigned to a course. 
                   9519: 
                   9520: Returns: $output (markup to be displayed) 
                   9521: 
                   9522: =cut
                   9523: 
                   9524: sub assign_categories_table {
                   9525:     my ($cathash,$currcat) = @_;
                   9526:     my $output;
                   9527:     if (ref($cathash) eq 'HASH') {
                   9528:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9529:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9530:         $maxdepth = scalar(@cats);
                   9531:         if (@cats > 0) {
                   9532:             my $itemcount = 0;
                   9533:             if (ref($cats[0]) eq 'ARRAY') {
                   9534:                 $output = &Apache::loncommon::start_data_table();
                   9535:                 my @currcategories;
                   9536:                 if ($currcat ne '') {
                   9537:                     @currcategories = split('&',$currcat);
                   9538:                 }
                   9539:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9540:                     my $parent = $cats[0][$i];
                   9541:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9542:                     next if ($parent eq 'instcode');
                   9543:                     my $item = &escape($parent).'::0';
                   9544:                     my $checked = '';
                   9545:                     if (@currcategories > 0) {
                   9546:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9547:                             $checked = ' checked="checked"';
1.663     raeburn  9548:                         }
                   9549:                     }
1.675     raeburn  9550:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9551:                                '<input type="checkbox" name="usecategory" value="'.
                   9552:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9553:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9554:                     my $depth = 1;
                   9555:                     push(@path,$parent);
                   9556:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9557:                     pop(@path);
                   9558:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9559:                     $itemcount ++;
                   9560:                 }
                   9561:                 $output .= &Apache::loncommon::end_data_table();
                   9562:             }
                   9563:         }
                   9564:     }
                   9565:     return $output;
                   9566: }
                   9567: 
                   9568: =pod
                   9569: 
                   9570: =item *&assign_category_rows()
                   9571: 
                   9572: Create a datatable row for display of nested categories in a domain,
                   9573: with checkboxes to allow a course to be categorized,called recursively.
                   9574: 
                   9575: Inputs:
                   9576: 
                   9577: itemcount - track row number for alternating colors
                   9578: 
                   9579: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9580:       categories and subcategories.
                   9581: 
                   9582: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9583: 
                   9584: parent - parent of current category item
                   9585: 
                   9586: path - Array containing all categories back up through the hierarchy from the
                   9587:        current category to the top level.
                   9588: 
                   9589: currcategories - reference to array of current categories assigned to the course
                   9590: 
                   9591: Returns: $output (markup to be displayed).
                   9592: 
                   9593: =cut
                   9594: 
                   9595: sub assign_category_rows {
                   9596:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9597:     my ($text,$name,$item,$chgstr);
                   9598:     if (ref($cats) eq 'ARRAY') {
                   9599:         my $maxdepth = scalar(@{$cats});
                   9600:         if (ref($cats->[$depth]) eq 'HASH') {
                   9601:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9602:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9603:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9604:                 $text .= '<td><table class="LC_datatable">';
                   9605:                 for (my $j=0; $j<$numchildren; $j++) {
                   9606:                     $name = $cats->[$depth]{$parent}[$j];
                   9607:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9608:                     my $deeper = $depth+1;
                   9609:                     my $checked = '';
                   9610:                     if (ref($currcategories) eq 'ARRAY') {
                   9611:                         if (@{$currcategories} > 0) {
                   9612:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9613:                                 $checked = ' checked="checked"';
1.663     raeburn  9614:                             }
                   9615:                         }
                   9616:                     }
1.664     raeburn  9617:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9618:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9619:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9620:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9621:                              '</td><td>';
1.663     raeburn  9622:                     if (ref($path) eq 'ARRAY') {
                   9623:                         push(@{$path},$name);
                   9624:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9625:                         pop(@{$path});
                   9626:                     }
                   9627:                     $text .= '</td></tr>';
                   9628:                 }
                   9629:                 $text .= '</table></td>';
                   9630:             }
                   9631:         }
                   9632:     }
                   9633:     return $text;
                   9634: }
                   9635: 
1.655     raeburn  9636: ############################################################
                   9637: ############################################################
                   9638: 
                   9639: 
1.443     albertel 9640: sub commit_customrole {
1.664     raeburn  9641:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9642:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9643:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9644:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9645:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9646:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9647:                  '</b><br />';
                   9648:     return $output;
                   9649: }
                   9650: 
                   9651: sub commit_standardrole {
1.541     raeburn  9652:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9653:     my ($output,$logmsg,$linefeed);
                   9654:     if ($context eq 'auto') {
                   9655:         $linefeed = "\n";
                   9656:     } else {
                   9657:         $linefeed = "<br />\n";
                   9658:     }  
1.443     albertel 9659:     if ($three eq 'st') {
1.541     raeburn  9660:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9661:                                          $one,$two,$sec,$context);
                   9662:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9663:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9664:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9665:         } else {
1.541     raeburn  9666:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9667:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9668:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9669:             if ($context eq 'auto') {
                   9670:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9671:             } else {
                   9672:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9673:                &mt('Add to classlist').': <b>ok</b>';
                   9674:             }
                   9675:             $output .= $linefeed;
1.443     albertel 9676:         }
                   9677:     } else {
                   9678:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9679:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9680:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9681:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9682:         if ($context eq 'auto') {
                   9683:             $output .= $result.$linefeed;
                   9684:         } else {
                   9685:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9686:         }
1.443     albertel 9687:     }
                   9688:     return $output;
                   9689: }
                   9690: 
                   9691: sub commit_studentrole {
1.541     raeburn  9692:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9693:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9694:     if ($context eq 'auto') {
                   9695:         $linefeed = "\n";
                   9696:     } else {
                   9697:         $linefeed = '<br />'."\n";
                   9698:     }
1.443     albertel 9699:     if (defined($one) && defined($two)) {
                   9700:         my $cid=$one.'_'.$two;
                   9701:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9702:         my $secchange = 0;
                   9703:         my $expire_role_result;
                   9704:         my $modify_section_result;
1.628     raeburn  9705:         if ($oldsec ne '-1') { 
                   9706:             if ($oldsec ne $sec) {
1.443     albertel 9707:                 $secchange = 1;
1.628     raeburn  9708:                 my $now = time;
1.443     albertel 9709:                 my $uurl='/'.$cid;
                   9710:                 $uurl=~s/\_/\//g;
                   9711:                 if ($oldsec) {
                   9712:                     $uurl.='/'.$oldsec;
                   9713:                 }
1.626     raeburn  9714:                 $oldsecurl = $uurl;
1.628     raeburn  9715:                 $expire_role_result = 
1.652     raeburn  9716:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9717:                 if ($env{'request.course.sec'} ne '') { 
                   9718:                     if ($expire_role_result eq 'refused') {
                   9719:                         my @roles = ('st');
                   9720:                         my @statuses = ('previous');
                   9721:                         my @roledoms = ($one);
                   9722:                         my $withsec = 1;
                   9723:                         my %roleshash = 
                   9724:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9725:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9726:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9727:                             my ($oldstart,$oldend) = 
                   9728:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9729:                             if ($oldend > 0 && $oldend <= $now) {
                   9730:                                 $expire_role_result = 'ok';
                   9731:                             }
                   9732:                         }
                   9733:                     }
                   9734:                 }
1.443     albertel 9735:                 $result = $expire_role_result;
                   9736:             }
                   9737:         }
                   9738:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9739:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9740:             if ($modify_section_result =~ /^ok/) {
                   9741:                 if ($secchange == 1) {
1.628     raeburn  9742:                     if ($sec eq '') {
                   9743:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9744:                     } else {
                   9745:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9746:                     }
1.443     albertel 9747:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9748:                     if ($sec eq '') {
                   9749:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9750:                     } else {
                   9751:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9752:                     }
1.443     albertel 9753:                 } else {
1.628     raeburn  9754:                     if ($sec eq '') {
                   9755:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9756:                     } else {
                   9757:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9758:                     }
1.443     albertel 9759:                 }
                   9760:             } else {
1.628     raeburn  9761:                 if ($secchange) {       
                   9762:                     $$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;
                   9763:                 } else {
                   9764:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9765:                 }
1.443     albertel 9766:             }
                   9767:             $result = $modify_section_result;
                   9768:         } elsif ($secchange == 1) {
1.628     raeburn  9769:             if ($oldsec eq '') {
                   9770:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9771:             } else {
                   9772:                 $$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;
                   9773:             }
1.626     raeburn  9774:             if ($expire_role_result eq 'refused') {
                   9775:                 my $newsecurl = '/'.$cid;
                   9776:                 $newsecurl =~ s/\_/\//g;
                   9777:                 if ($sec ne '') {
                   9778:                     $newsecurl.='/'.$sec;
                   9779:                 }
                   9780:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9781:                     if ($sec eq '') {
                   9782:                         $$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;
                   9783:                     } else {
                   9784:                         $$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;
                   9785:                     }
                   9786:                 }
                   9787:             }
1.443     albertel 9788:         }
                   9789:     } else {
1.626     raeburn  9790:         $$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 9791:         $result = "error: incomplete course id\n";
                   9792:     }
                   9793:     return $result;
                   9794: }
                   9795: 
                   9796: ############################################################
                   9797: ############################################################
                   9798: 
1.566     albertel 9799: sub check_clone {
1.578     raeburn  9800:     my ($args,$linefeed) = @_;
1.566     albertel 9801:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9802:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9803:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9804:     my $clonemsg;
                   9805:     my $can_clone = 0;
                   9806: 
                   9807:     if ($clonehome eq 'no_host') {
1.578     raeburn  9808:         $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 9809:     } else {
                   9810: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9811: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9812: 	    $can_clone = 1;
                   9813: 	} else {
                   9814: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9815: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9816: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9817:             if (grep(/^\*$/,@cloners)) {
                   9818:                 $can_clone = 1;
                   9819:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9820:                 $can_clone = 1;
                   9821:             } else {
                   9822: 	        my %roleshash =
                   9823: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9824: 					 $args->{'ccdomain'},
                   9825:                                          'userroles',['active'],['cc'],
                   9826: 					 [$args->{'clonedomain'}]);
                   9827: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9828: 		    $can_clone = 1;
                   9829: 	        } else {
                   9830:                     $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'});
                   9831: 	        }
1.566     albertel 9832: 	    }
1.578     raeburn  9833:         }
1.566     albertel 9834:     }
                   9835:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9836: }
                   9837: 
1.444     albertel 9838: sub construct_course {
1.541     raeburn  9839:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9840:     my $outcome;
1.541     raeburn  9841:     my $linefeed =  '<br />'."\n";
                   9842:     if ($context eq 'auto') {
                   9843:         $linefeed = "\n";
                   9844:     }
1.566     albertel 9845: 
                   9846: #
                   9847: # Are we cloning?
                   9848: #
                   9849:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9850:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9851: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9852: 	if ($context ne 'auto') {
1.578     raeburn  9853:             if ($clonemsg ne '') {
                   9854: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9855:             }
1.566     albertel 9856: 	}
                   9857: 	$outcome .= $clonemsg.$linefeed;
                   9858: 
                   9859:         if (!$can_clone) {
                   9860: 	    return (0,$outcome);
                   9861: 	}
                   9862:     }
                   9863: 
1.444     albertel 9864: #
                   9865: # Open course
                   9866: #
                   9867:     my $crstype = lc($args->{'crstype'});
                   9868:     my %cenv=();
                   9869:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9870:                                              $args->{'cdescr'},
                   9871:                                              $args->{'curl'},
                   9872:                                              $args->{'course_home'},
                   9873:                                              $args->{'nonstandard'},
                   9874:                                              $args->{'crscode'},
                   9875:                                              $args->{'ccuname'}.':'.
                   9876:                                              $args->{'ccdomain'},
                   9877:                                              $args->{'crstype'});
                   9878: 
                   9879:     # Note: The testing routines depend on this being output; see 
                   9880:     # Utils::Course. This needs to at least be output as a comment
                   9881:     # if anyone ever decides to not show this, and Utils::Course::new
                   9882:     # will need to be suitably modified.
1.541     raeburn  9883:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9884: #
                   9885: # Check if created correctly
                   9886: #
1.479     albertel 9887:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9888:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9889:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9890: 
1.444     albertel 9891: #
1.566     albertel 9892: # Do the cloning
                   9893: #   
                   9894:     if ($can_clone && $cloneid) {
                   9895: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9896: 	if ($context ne 'auto') {
                   9897: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9898: 	}
                   9899: 	$outcome .= $clonemsg.$linefeed;
                   9900: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9901: # Copy all files
1.637     www      9902: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9903: # Restore URL
1.566     albertel 9904: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9905: # Restore title
1.566     albertel 9906: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9907: # Mark as cloned
1.566     albertel 9908: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9909: # Need to clone grading mode
                   9910:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9911:         $cenv{'grading'}=$newenv{'grading'};
                   9912: # Do not clone these environment entries
                   9913:         &Apache::lonnet::del('environment',
                   9914:                   ['default_enrollment_start_date',
                   9915:                    'default_enrollment_end_date',
                   9916:                    'question.email',
                   9917:                    'policy.email',
                   9918:                    'comment.email',
                   9919:                    'pch.users.denied',
1.725     raeburn  9920:                    'plc.users.denied',
                   9921:                    'hidefromcat',
                   9922:                    'categories'],
1.638     www      9923:                    $$crsudom,$$crsunum);
1.444     albertel 9924:     }
1.566     albertel 9925: 
1.444     albertel 9926: #
                   9927: # Set environment (will override cloned, if existing)
                   9928: #
                   9929:     my @sections = ();
                   9930:     my @xlists = ();
                   9931:     if ($args->{'crstype'}) {
                   9932:         $cenv{'type'}=$args->{'crstype'};
                   9933:     }
                   9934:     if ($args->{'crsid'}) {
                   9935:         $cenv{'courseid'}=$args->{'crsid'};
                   9936:     }
                   9937:     if ($args->{'crscode'}) {
                   9938:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9939:     }
                   9940:     if ($args->{'crsquota'} ne '') {
                   9941:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9942:     } else {
                   9943:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9944:     }
                   9945:     if ($args->{'ccuname'}) {
                   9946:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9947:                                         ':'.$args->{'ccdomain'};
                   9948:     } else {
                   9949:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9950:     }
                   9951:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9952:     if ($args->{'crssections'}) {
                   9953:         $cenv{'internal.sectionnums'} = '';
                   9954:         if ($args->{'crssections'} =~ m/,/) {
                   9955:             @sections = split/,/,$args->{'crssections'};
                   9956:         } else {
                   9957:             $sections[0] = $args->{'crssections'};
                   9958:         }
                   9959:         if (@sections > 0) {
                   9960:             foreach my $item (@sections) {
                   9961:                 my ($sec,$gp) = split/:/,$item;
                   9962:                 my $class = $args->{'crscode'}.$sec;
                   9963:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   9964:                 $cenv{'internal.sectionnums'} .= $item.',';
                   9965:                 unless ($addcheck eq 'ok') {
                   9966:                     push @badclasses, $class;
                   9967:                 }
                   9968:             }
                   9969:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   9970:         }
                   9971:     }
                   9972: # do not hide course coordinator from staff listing, 
                   9973: # even if privileged
                   9974:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9975: # add crosslistings
                   9976:     if ($args->{'crsxlist'}) {
                   9977:         $cenv{'internal.crosslistings'}='';
                   9978:         if ($args->{'crsxlist'} =~ m/,/) {
                   9979:             @xlists = split/,/,$args->{'crsxlist'};
                   9980:         } else {
                   9981:             $xlists[0] = $args->{'crsxlist'};
                   9982:         }
                   9983:         if (@xlists > 0) {
                   9984:             foreach my $item (@xlists) {
                   9985:                 my ($xl,$gp) = split/:/,$item;
                   9986:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   9987:                 $cenv{'internal.crosslistings'} .= $item.',';
                   9988:                 unless ($addcheck eq 'ok') {
                   9989:                     push @badclasses, $xl;
                   9990:                 }
                   9991:             }
                   9992:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   9993:         }
                   9994:     }
                   9995:     if ($args->{'autoadds'}) {
                   9996:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   9997:     }
                   9998:     if ($args->{'autodrops'}) {
                   9999:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10000:     }
                   10001: # check for notification of enrollment changes
                   10002:     my @notified = ();
                   10003:     if ($args->{'notify_owner'}) {
                   10004:         if ($args->{'ccuname'} ne '') {
                   10005:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10006:         }
                   10007:     }
                   10008:     if ($args->{'notify_dc'}) {
                   10009:         if ($uname ne '') { 
1.630     raeburn  10010:             push(@notified,$uname.':'.$udom);
1.444     albertel 10011:         }
                   10012:     }
                   10013:     if (@notified > 0) {
                   10014:         my $notifylist;
                   10015:         if (@notified > 1) {
                   10016:             $notifylist = join(',',@notified);
                   10017:         } else {
                   10018:             $notifylist = $notified[0];
                   10019:         }
                   10020:         $cenv{'internal.notifylist'} = $notifylist;
                   10021:     }
                   10022:     if (@badclasses > 0) {
                   10023:         my %lt=&Apache::lonlocal::texthash(
                   10024:                 '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',
                   10025:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10026:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10027:         );
1.541     raeburn  10028:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10029:                            ' ('.$lt{'adby'}.')';
                   10030:         if ($context eq 'auto') {
                   10031:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10032:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10033:             foreach my $item (@badclasses) {
                   10034:                 if ($context eq 'auto') {
                   10035:                     $outcome .= " - $item\n";
                   10036:                 } else {
                   10037:                     $outcome .= "<li>$item</li>\n";
                   10038:                 }
                   10039:             }
                   10040:             if ($context eq 'auto') {
                   10041:                 $outcome .= $linefeed;
                   10042:             } else {
1.566     albertel 10043:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10044:             }
                   10045:         } 
1.444     albertel 10046:     }
                   10047:     if ($args->{'no_end_date'}) {
                   10048:         $args->{'endaccess'} = 0;
                   10049:     }
                   10050:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10051:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10052:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10053:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10054:     if ($args->{'showphotos'}) {
                   10055:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10056:     }
                   10057:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10058:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10059:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10060:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10061:             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'); 
                   10062:             if ($context eq 'auto') {
                   10063:                 $outcome .= $krb_msg;
                   10064:             } else {
1.566     albertel 10065:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10066:             }
                   10067:             $outcome .= $linefeed;
1.444     albertel 10068:         }
                   10069:     }
                   10070:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10071:        if ($args->{'setpolicy'}) {
                   10072:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10073:        }
                   10074:        if ($args->{'setcontent'}) {
                   10075:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10076:        }
                   10077:     }
                   10078:     if ($args->{'reshome'}) {
                   10079: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10080: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10081:     }
                   10082: #
                   10083: # course has keyed access
                   10084: #
                   10085:     if ($args->{'setkeys'}) {
                   10086:        $cenv{'keyaccess'}='yes';
                   10087:     }
                   10088: # if specified, key authority is not course, but user
                   10089: # only active if keyaccess is yes
                   10090:     if ($args->{'keyauth'}) {
1.487     albertel 10091: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10092: 	$user = &LONCAPA::clean_username($user);
                   10093: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10094: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10095: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10096: 	}
                   10097:     }
                   10098: 
                   10099:     if ($args->{'disresdis'}) {
                   10100:         $cenv{'pch.roles.denied'}='st';
                   10101:     }
                   10102:     if ($args->{'disablechat'}) {
                   10103:         $cenv{'plc.roles.denied'}='st';
                   10104:     }
                   10105: 
                   10106:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10107:     # course
                   10108:     $cenv{'course.helper.not.run'} = 1;
                   10109:     #
                   10110:     # Use new Randomseed
                   10111:     #
                   10112:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10113:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10114:     #
                   10115:     # The encryption code and receipt prefix for this course
                   10116:     #
                   10117:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10118:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10119:     #
                   10120:     # By default, use standard grading
                   10121:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10122: 
1.541     raeburn  10123:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10124:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10125: #
                   10126: # Open all assignments
                   10127: #
                   10128:     if ($args->{'openall'}) {
                   10129:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10130:        my %storecontent = ($storeunder         => time,
                   10131:                            $storeunder.'.type' => 'date_start');
                   10132:        
                   10133:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10134:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10135:    }
                   10136: #
                   10137: # Set first page
                   10138: #
                   10139:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10140: 	    || ($cloneid)) {
1.445     albertel 10141: 	use LONCAPA::map;
1.444     albertel 10142: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10143: 
                   10144: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10145:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10146: 
1.444     albertel 10147:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10148:         my $title; my $url;
                   10149:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10150: 	    $title=&mt('Syllabus');
1.444     albertel 10151:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10152:         } else {
1.690     bisitz   10153:             $title=&mt('Navigate Contents');
1.444     albertel 10154:             $url='/adm/navmaps';
                   10155:         }
1.445     albertel 10156: 
                   10157:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10158: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10159: 
                   10160: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10161:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10162:     }
1.566     albertel 10163: 
                   10164:     return (1,$outcome);
1.444     albertel 10165: }
                   10166: 
                   10167: ############################################################
                   10168: ############################################################
                   10169: 
1.378     raeburn  10170: sub course_type {
                   10171:     my ($cid) = @_;
                   10172:     if (!defined($cid)) {
                   10173:         $cid = $env{'request.course.id'};
                   10174:     }
1.404     albertel 10175:     if (defined($env{'course.'.$cid.'.type'})) {
                   10176:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10177:     } else {
                   10178:         return 'Course';
1.377     raeburn  10179:     }
                   10180: }
1.156     albertel 10181: 
1.406     raeburn  10182: sub group_term {
                   10183:     my $crstype = &course_type();
                   10184:     my %names = (
                   10185:                   'Course' => 'group',
                   10186:                   'Group' => 'team',
                   10187:                 );
                   10188:     return $names{$crstype};
                   10189: }
                   10190: 
1.156     albertel 10191: sub icon {
                   10192:     my ($file)=@_;
1.505     albertel 10193:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10194:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10195:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10196:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10197: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10198: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10199: 	            $curfext.".gif") {
                   10200: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10201: 		$curfext.".gif";
                   10202: 	}
                   10203:     }
1.249     albertel 10204:     return &lonhttpdurl($iconname);
1.154     albertel 10205: } 
1.84      albertel 10206: 
1.575     albertel 10207: sub lonhttpdurl {
1.692     www      10208: #
                   10209: # Had been used for "small fry" static images on separate port 8080.
                   10210: # Modify here if lightweight http functionality desired again.
                   10211: # Currently eliminated due to increasing firewall issues.
                   10212: #
1.575     albertel 10213:     my ($url)=@_;
1.692     www      10214:     return $url;
1.215     albertel 10215: }
                   10216: 
1.213     albertel 10217: sub connection_aborted {
                   10218:     my ($r)=@_;
                   10219:     $r->print(" ");$r->rflush();
                   10220:     my $c = $r->connection;
                   10221:     return $c->aborted();
                   10222: }
                   10223: 
1.221     foxr     10224: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10225: #    strings as 'strings'.
                   10226: sub escape_single {
1.221     foxr     10227:     my ($input) = @_;
1.223     albertel 10228:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10229:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10230:     return $input;
                   10231: }
1.223     albertel 10232: 
1.222     foxr     10233: #  Same as escape_single, but escape's "'s  This 
                   10234: #  can be used for  "strings"
                   10235: sub escape_double {
                   10236:     my ($input) = @_;
                   10237:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10238:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10239:     return $input;
                   10240: }
1.223     albertel 10241:  
1.222     foxr     10242: #   Escapes the last element of a full URL.
                   10243: sub escape_url {
                   10244:     my ($url)   = @_;
1.238     raeburn  10245:     my @urlslices = split(/\//, $url,-1);
1.369     www      10246:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10247:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10248: }
1.462     albertel 10249: 
1.820     raeburn  10250: sub compare_arrays {
                   10251:     my ($arrayref1,$arrayref2) = @_;
                   10252:     my (@difference,%count);
                   10253:     @difference = ();
                   10254:     %count = ();
                   10255:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10256:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10257:         foreach my $element (keys(%count)) {
                   10258:             if ($count{$element} == 1) {
                   10259:                 push(@difference,$element);
                   10260:             }
                   10261:         }
                   10262:     }
                   10263:     return @difference;
                   10264: }
                   10265: 
1.817     bisitz   10266: # -------------------------------------------------------- Initialize user login
1.462     albertel 10267: sub init_user_environment {
1.463     albertel 10268:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10269:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10270: 
                   10271:     my $public=($username eq 'public' && $domain eq 'public');
                   10272: 
                   10273: # See if old ID present, if so, remove
                   10274: 
                   10275:     my ($filename,$cookie,$userroles);
                   10276:     my $now=time;
                   10277: 
                   10278:     if ($public) {
                   10279: 	my $max_public=100;
                   10280: 	my $oldest;
                   10281: 	my $oldest_time=0;
                   10282: 	for(my $next=1;$next<=$max_public;$next++) {
                   10283: 	    if (-e $lonids."/publicuser_$next.id") {
                   10284: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10285: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10286: 		    $oldest_time=$mtime;
                   10287: 		    $oldest=$next;
                   10288: 		}
                   10289: 	    } else {
                   10290: 		$cookie="publicuser_$next";
                   10291: 		last;
                   10292: 	    }
                   10293: 	}
                   10294: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10295:     } else {
1.463     albertel 10296: 	# if this isn't a robot, kill any existing non-robot sessions
                   10297: 	if (!$args->{'robot'}) {
                   10298: 	    opendir(DIR,$lonids);
                   10299: 	    while ($filename=readdir(DIR)) {
                   10300: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10301: 		    unlink($lonids.'/'.$filename);
                   10302: 		}
1.462     albertel 10303: 	    }
1.463     albertel 10304: 	    closedir(DIR);
1.462     albertel 10305: 	}
                   10306: # Give them a new cookie
1.463     albertel 10307: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10308: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10309: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10310:     
                   10311: # Initialize roles
                   10312: 
                   10313: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10314:     }
                   10315: # ------------------------------------ Check browser type and MathML capability
                   10316: 
                   10317:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10318:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10319: 
                   10320: # ------------------------------------------------------------- Get environment
                   10321: 
                   10322:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10323:     my ($tmp) = keys(%userenv);
                   10324:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10325: 	# default remote control to off
                   10326: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10327:     } else {
                   10328: 	undef(%userenv);
                   10329:     }
                   10330:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10331: 	$form->{'interface'}=$userenv{'interface'};
                   10332:     }
                   10333:     $env{'environment.remote'}=$userenv{'remote'};
                   10334:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10335: 
                   10336: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10337:     foreach my $option ('interface','localpath','localres') {
                   10338:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10339:     }
                   10340: # --------------------------------------------------------- Write first profile
                   10341: 
                   10342:     {
                   10343: 	my %initial_env = 
                   10344: 	    ("user.name"          => $username,
                   10345: 	     "user.domain"        => $domain,
                   10346: 	     "user.home"          => $authhost,
                   10347: 	     "browser.type"       => $clientbrowser,
                   10348: 	     "browser.version"    => $clientversion,
                   10349: 	     "browser.mathml"     => $clientmathml,
                   10350: 	     "browser.unicode"    => $clientunicode,
                   10351: 	     "browser.os"         => $clientos,
                   10352: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10353: 	     "request.course.fn"  => '',
                   10354: 	     "request.course.uri" => '',
                   10355: 	     "request.course.sec" => '',
                   10356: 	     "request.role"       => 'cm',
                   10357: 	     "request.role.adv"   => $env{'user.adv'},
                   10358: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10359: 
                   10360:         if ($form->{'localpath'}) {
                   10361: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10362: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10363:         }
                   10364: 	
                   10365: 	if ($public) {
                   10366: 	    $initial_env{"environment.remote"} = "off";
                   10367: 	}
                   10368: 	if ($form->{'interface'}) {
                   10369: 	    $form->{'interface'}=~s/\W//gs;
                   10370: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10371: 	    $env{'browser.interface'}=$form->{'interface'};
                   10372: 	}
                   10373: 
1.724     raeburn  10374:         foreach my $tool ('aboutme','blog','portfolio') {
                   10375:             $userenv{'availabletools.'.$tool} = 
                   10376:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10377:         }
                   10378: 
1.765     raeburn  10379:         foreach my $crstype ('official','unofficial') {
                   10380:             $userenv{'canrequest.'.$crstype} =
                   10381:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10382:                                                   'reload','requestcourses');
                   10383:         }
                   10384: 
1.462     albertel 10385: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10386: 	
                   10387: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10388: 		 &GDBM_WRCREAT(),0640)) {
                   10389: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10390: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10391: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10392: 	    if (ref($args->{'extra_env'})) {
                   10393: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10394: 	    }
1.462     albertel 10395: 	    untie(%disk_env);
                   10396: 	} else {
1.705     tempelho 10397: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10398: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10399: 	    return 'error: '.$!;
                   10400: 	}
                   10401:     }
                   10402:     $env{'request.role'}='cm';
                   10403:     $env{'request.role.adv'}=$env{'user.adv'};
                   10404:     $env{'browser.type'}=$clientbrowser;
                   10405: 
                   10406:     return $cookie;
                   10407: 
                   10408: }
                   10409: 
                   10410: sub _add_to_env {
                   10411:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10412:     if (ref($env_data) eq 'HASH') {
                   10413:         while (my ($key,$value) = each(%$env_data)) {
                   10414: 	    $idf->{$prefix.$key} = $value;
                   10415: 	    $env{$prefix.$key}   = $value;
                   10416:         }
1.462     albertel 10417:     }
                   10418: }
                   10419: 
1.685     tempelho 10420: # --- Get the symbolic name of a problem and the url
                   10421: sub get_symb {
                   10422:     my ($request,$silent) = @_;
1.726     raeburn  10423:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10424:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10425:     if ($symb eq '') {
                   10426:         if (!$silent) {
                   10427:             $request->print("Unable to handle ambiguous references:$url:.");
                   10428:             return ();
                   10429:         }
                   10430:     }
                   10431:     &Apache::lonenc::check_decrypt(\$symb);
                   10432:     return ($symb);
                   10433: }
                   10434: 
                   10435: # --------------------------------------------------------------Get annotation
                   10436: 
                   10437: sub get_annotation {
                   10438:     my ($symb,$enc) = @_;
                   10439: 
                   10440:     my $key = $symb;
                   10441:     if (!$enc) {
                   10442:         $key =
                   10443:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10444:     }
                   10445:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10446:     return $annotation{$key};
                   10447: }
                   10448: 
                   10449: sub clean_symb {
1.731     raeburn  10450:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10451: 
                   10452:     &Apache::lonenc::check_decrypt(\$symb);
                   10453:     my $enc = $env{'request.enc'};
1.731     raeburn  10454:     if ($delete_enc) {
1.730     raeburn  10455:         delete($env{'request.enc'});
                   10456:     }
1.685     tempelho 10457: 
                   10458:     return ($symb,$enc);
                   10459: }
1.462     albertel 10460: 
1.41      ng       10461: =pod
                   10462: 
                   10463: =back
                   10464: 
1.112     bowersj2 10465: =cut
1.41      ng       10466: 
1.112     bowersj2 10467: 1;
                   10468: __END__;
1.41      ng       10469: 

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