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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.981   ! raeburn     4: # $Id: loncommon.pm,v 1.980 2010/09/24 03:14:58 raeburn 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.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932     raeburn   486:     my $wintitle = 'Course_Browser';
1.931     raeburn   487:     if ($crstype eq 'Community') {
1.932     raeburn   488:         $wintitle = 'Community_Browser';
1.909     raeburn   489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
1.970     raeburn   903:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn   904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.973     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
1.973     raeburn  1093: be useful for certain help topics with big pictures included.
                   1094: 
                   1095: $imgid is the id of the img tag used for the help icon. This may be
                   1096: used in a javascript call to switch the image src.  See 
                   1097: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1098: 
                   1099: =cut
                   1100: 
                   1101: sub help_open_topic {
1.973     raeburn  1102:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1103:     $text = "" if (not defined $text);
1.44      bowersj2 1104:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1105:     $width = 350 if (not defined $width);
                   1106:     $height = 400 if (not defined $height);
                   1107:     my $filename = $topic;
                   1108:     $filename =~ s/ /_/g;
                   1109: 
1.48      bowersj2 1110:     my $template = "";
                   1111:     my $link;
1.572     banghart 1112:     
1.159     www      1113:     $topic=~s/\W/\_/g;
1.44      bowersj2 1114: 
1.572     banghart 1115:     if (!$stayOnPage) {
1.72      bowersj2 1116: 	$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 1117:     } else {
1.48      bowersj2 1118: 	$link = "/adm/help/${filename}.hlp";
                   1119:     }
                   1120: 
                   1121:     # Add the text
1.755     neumanie 1122:     if ($text ne "") {	
1.763     bisitz   1123: 	$template.='<span class="LC_help_open_topic">'
                   1124:                   .'<a target="_top" href="'.$link.'">'
                   1125:                   .$text.'</a>';
1.48      bowersj2 1126:     }
                   1127: 
1.763     bisitz   1128:     # (Always) Add the graphic
1.179     matthew  1129:     my $title = &mt('Online Help');
1.667     raeburn  1130:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1131:     if ($imgid ne '') {
                   1132:         $imgid = ' id="'.$imgid.'"';
                   1133:     }
1.763     bisitz   1134:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1135:               .'<img src="'.$helpicon.'" border="0"'
                   1136:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1137:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1138:               .' /></a>';
                   1139:     if ($text ne "") {	
                   1140:         $template.='</span>';
                   1141:     }
1.44      bowersj2 1142:     return $template;
                   1143: 
1.106     bowersj2 1144: }
                   1145: 
                   1146: # This is a quicky function for Latex cheatsheet editing, since it 
                   1147: # appears in at least four places
                   1148: sub helpLatexCheatsheet {
1.732     raeburn  1149:     my ($topic,$text,$not_author) = @_;
                   1150:     my $out;
1.106     bowersj2 1151:     my $addOther = '';
1.732     raeburn  1152:     if ($topic) {
1.763     bisitz   1153: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1154: 							       undef, undef, 600).
                   1155: 								   '</span> ';
                   1156:     }
                   1157:     $out = '<span>' # Start cheatsheet
                   1158: 	  .$addOther
                   1159:           .'<span>'
                   1160: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1161: 					       undef,undef,600)
                   1162: 	  .'</span> <span>'
                   1163: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1164: 					       undef,undef,600)
                   1165: 	  .'</span>';
1.732     raeburn  1166:     unless ($not_author) {
1.763     bisitz   1167:         $out .= ' <span>'
                   1168: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1169: 	                                            undef,undef,600)
                   1170: 	       .'</span>';
1.732     raeburn  1171:     }
1.763     bisitz   1172:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1173:     return $out;
1.172     www      1174: }
                   1175: 
1.430     albertel 1176: sub general_help {
                   1177:     my $helptopic='Student_Intro';
                   1178:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1179: 	$helptopic='Authoring_Intro';
1.907     raeburn  1180:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1181: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1182:     } elsif ($env{'request.role'}=~/^dc/) {
                   1183:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1184:     }
                   1185:     return $helptopic;
                   1186: }
                   1187: 
                   1188: sub update_help_link {
                   1189:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1190:     my $origurl = $ENV{'REQUEST_URI'};
                   1191:     $origurl=~s|^/~|/priv/|;
                   1192:     my $timestamp = time;
                   1193:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1194:         $$datum = &escape($$datum);
                   1195:     }
                   1196: 
                   1197:     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";
                   1198:     my $output .= <<"ENDOUTPUT";
                   1199: <script type="text/javascript">
1.824     bisitz   1200: // <![CDATA[
1.430     albertel 1201: banner_link = '$banner_link';
1.824     bisitz   1202: // ]]>
1.430     albertel 1203: </script>
                   1204: ENDOUTPUT
                   1205:     return $output;
                   1206: }
                   1207: 
                   1208: # now just updates the help link and generates a blue icon
1.193     raeburn  1209: sub help_open_menu {
1.430     albertel 1210:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1211: 	= @_;    
1.949     droeschl 1212:     $stayOnPage = 1;
1.430     albertel 1213:     my $output;
                   1214:     if ($component_help) {
                   1215: 	if (!$text) {
                   1216: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1217: 				       $width,$height);
                   1218: 	} else {
                   1219: 	    my $help_text;
                   1220: 	    $help_text=&unescape($topic);
                   1221: 	    $output='<table><tr><td>'.
                   1222: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1223: 				 $width,$height).'</td></tr></table>';
                   1224: 	}
                   1225:     }
                   1226:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1227:     return $output.$banner_link;
                   1228: }
                   1229: 
                   1230: sub top_nav_help {
                   1231:     my ($text) = @_;
1.436     albertel 1232:     $text = &mt($text);
1.949     droeschl 1233:     my $stay_on_page = 1;
                   1234: 
1.572     banghart 1235:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1236: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1237:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1238: 
1.201     raeburn  1239:     my $title = &mt('Get help');
1.436     albertel 1240: 
                   1241:     return <<"END";
                   1242: $banner_link
                   1243:  <a href="$link" title="$title">$text</a>
                   1244: END
                   1245: }
                   1246: 
                   1247: sub help_menu_js {
                   1248:     my ($text) = @_;
1.949     droeschl 1249:     my $stayOnPage = 1;
1.436     albertel 1250:     my $width = 620;
                   1251:     my $height = 600;
1.430     albertel 1252:     my $helptopic=&general_help();
                   1253:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1254:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1255:     my $start_page =
                   1256:         &Apache::loncommon::start_page('Help Menu', undef,
                   1257: 				       {'frameset'    => 1,
                   1258: 					'js_ready'    => 1,
                   1259: 					'add_entries' => {
                   1260: 					    'border' => '0',
1.579     raeburn  1261: 					    'rows'   => "110,*",},});
1.331     albertel 1262:     my $end_page =
                   1263:         &Apache::loncommon::end_page({'frameset' => 1,
                   1264: 				      'js_ready' => 1,});
                   1265: 
1.436     albertel 1266:     my $template .= <<"ENDTEMPLATE";
                   1267: <script type="text/javascript">
1.877     bisitz   1268: // <![CDATA[
1.253     albertel 1269: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1270: var banner_link = '';
1.243     raeburn  1271: function helpMenu(target) {
                   1272:     var caller = this;
                   1273:     if (target == 'open') {
                   1274:         var newWindow = null;
                   1275:         try {
1.262     albertel 1276:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1277:         }
                   1278:         catch(error) {
                   1279:             writeHelp(caller);
                   1280:             return;
                   1281:         }
                   1282:         if (newWindow) {
                   1283:             caller = newWindow;
                   1284:         }
1.193     raeburn  1285:     }
1.243     raeburn  1286:     writeHelp(caller);
                   1287:     return;
                   1288: }
                   1289: function writeHelp(caller) {
1.430     albertel 1290:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1291:     caller.document.close()
                   1292:     caller.focus()
1.193     raeburn  1293: }
1.877     bisitz   1294: // END LON-CAPA Internal -->
1.253     albertel 1295: // ]]>
1.436     albertel 1296: </script>
1.193     raeburn  1297: ENDTEMPLATE
                   1298:     return $template;
                   1299: }
                   1300: 
1.172     www      1301: sub help_open_bug {
                   1302:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1303:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1304:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1305:     $text = "" if (not defined $text);
                   1306: 	$stayOnPage=1;
1.184     albertel 1307:     $width = 600 if (not defined $width);
                   1308:     $height = 600 if (not defined $height);
1.172     www      1309: 
                   1310:     $topic=~s/\W+/\+/g;
                   1311:     my $link='';
                   1312:     my $template='';
1.379     albertel 1313:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1314: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1315:     if (!$stayOnPage)
                   1316:     {
                   1317: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1318:     }
                   1319:     else
                   1320:     {
                   1321: 	$link = $url;
                   1322:     }
                   1323:     # Add the text
                   1324:     if ($text ne "")
                   1325:     {
                   1326: 	$template .= 
                   1327:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1328:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1329:     }
                   1330: 
                   1331:     # Add the graphic
1.179     matthew  1332:     my $title = &mt('Report a Bug');
1.215     albertel 1333:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1334:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1335:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1336: ENDTEMPLATE
                   1337:     if ($text ne '') { $template.='</td></tr></table>' };
                   1338:     return $template;
                   1339: 
                   1340: }
                   1341: 
                   1342: sub help_open_faq {
                   1343:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1344:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1345:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1346:     $text = "" if (not defined $text);
                   1347: 	$stayOnPage=1;
                   1348:     $width = 350 if (not defined $width);
                   1349:     $height = 400 if (not defined $height);
                   1350: 
                   1351:     $topic=~s/\W+/\+/g;
                   1352:     my $link='';
                   1353:     my $template='';
                   1354:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1355:     if (!$stayOnPage)
                   1356:     {
                   1357: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1358:     }
                   1359:     else
                   1360:     {
                   1361: 	$link = $url;
                   1362:     }
                   1363: 
                   1364:     # Add the text
                   1365:     if ($text ne "")
                   1366:     {
                   1367: 	$template .= 
1.173     www      1368:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1369:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1370:     }
                   1371: 
                   1372:     # Add the graphic
1.179     matthew  1373:     my $title = &mt('View the FAQ');
1.215     albertel 1374:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1375:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1376:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1377: ENDTEMPLATE
                   1378:     if ($text ne '') { $template.='</td></tr></table>' };
                   1379:     return $template;
                   1380: 
1.44      bowersj2 1381: }
1.37      matthew  1382: 
1.180     matthew  1383: ###############################################################
                   1384: ###############################################################
                   1385: 
1.45      matthew  1386: =pod
                   1387: 
1.648     raeburn  1388: =item * &change_content_javascript():
1.256     matthew  1389: 
                   1390: This and the next function allow you to create small sections of an
                   1391: otherwise static HTML page that you can update on the fly with
                   1392: Javascript, even in Netscape 4.
                   1393: 
                   1394: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1395: must be written to the HTML page once. It will prove the Javascript
                   1396: function "change(name, content)". Calling the change function with the
                   1397: name of the section 
                   1398: you want to update, matching the name passed to C<changable_area>, and
                   1399: the new content you want to put in there, will put the content into
                   1400: that area.
                   1401: 
                   1402: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1403: to contain room for the original contents. You need to "make space"
                   1404: for whatever changes you wish to make, and be B<sure> to check your
                   1405: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1406: it's adequate for updating a one-line status display, but little more.
                   1407: This script will set the space to 100% width, so you only need to
                   1408: worry about height in Netscape 4.
                   1409: 
                   1410: Modern browsers are much less limiting, and if you can commit to the
                   1411: user not using Netscape 4, this feature may be used freely with
                   1412: pretty much any HTML.
                   1413: 
                   1414: =cut
                   1415: 
                   1416: sub change_content_javascript {
                   1417:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1418:     if ($env{'browser.type'} eq 'netscape' &&
                   1419: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1420: 	return (<<NETSCAPE4);
                   1421: 	function change(name, content) {
                   1422: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1423: 	    doc.open();
                   1424: 	    doc.write(content);
                   1425: 	    doc.close();
                   1426: 	}
                   1427: NETSCAPE4
                   1428:     } else {
                   1429: 	# Otherwise, we need to use semi-standards-compliant code
                   1430: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1431: 	# is really scary, and every useful browser supports it
                   1432: 	return (<<DOMBASED);
                   1433: 	function change(name, content) {
                   1434: 	    element = document.getElementById(name);
                   1435: 	    element.innerHTML = content;
                   1436: 	}
                   1437: DOMBASED
                   1438:     }
                   1439: }
                   1440: 
                   1441: =pod
                   1442: 
1.648     raeburn  1443: =item * &changable_area($name,$origContent):
1.256     matthew  1444: 
                   1445: This provides a "changable area" that can be modified on the fly via
                   1446: the Javascript code provided in C<change_content_javascript>. $name is
                   1447: the name you will use to reference the area later; do not repeat the
                   1448: same name on a given HTML page more then once. $origContent is what
                   1449: the area will originally contain, which can be left blank.
                   1450: 
                   1451: =cut
                   1452: 
                   1453: sub changable_area {
                   1454:     my ($name, $origContent) = @_;
                   1455: 
1.258     albertel 1456:     if ($env{'browser.type'} eq 'netscape' &&
                   1457: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1458: 	# If this is netscape 4, we need to use the Layer tag
                   1459: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1460:     } else {
                   1461: 	return "<span id='$name'>$origContent</span>";
                   1462:     }
                   1463: }
                   1464: 
                   1465: =pod
                   1466: 
1.648     raeburn  1467: =item * &viewport_geometry_js 
1.590     raeburn  1468: 
                   1469: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1470: 
                   1471: =cut
                   1472: 
                   1473: 
                   1474: sub viewport_geometry_js { 
                   1475:     return <<"GEOMETRY";
                   1476: var Geometry = {};
                   1477: function init_geometry() {
                   1478:     if (Geometry.init) { return };
                   1479:     Geometry.init=1;
                   1480:     if (window.innerHeight) {
                   1481:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1482:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1483:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1484:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1485:     }
                   1486:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1487:         Geometry.getViewportHeight =
                   1488:             function() { return document.documentElement.clientHeight; };
                   1489:         Geometry.getViewportWidth =
                   1490:             function() { return document.documentElement.clientWidth; };
                   1491: 
                   1492:         Geometry.getHorizontalScroll =
                   1493:             function() { return document.documentElement.scrollLeft; };
                   1494:         Geometry.getVerticalScroll =
                   1495:             function() { return document.documentElement.scrollTop; };
                   1496:     }
                   1497:     else if (document.body.clientHeight) {
                   1498:         Geometry.getViewportHeight =
                   1499:             function() { return document.body.clientHeight; };
                   1500:         Geometry.getViewportWidth =
                   1501:             function() { return document.body.clientWidth; };
                   1502:         Geometry.getHorizontalScroll =
                   1503:             function() { return document.body.scrollLeft; };
                   1504:         Geometry.getVerticalScroll =
                   1505:             function() { return document.body.scrollTop; };
                   1506:     }
                   1507: }
                   1508: 
                   1509: GEOMETRY
                   1510: }
                   1511: 
                   1512: =pod
                   1513: 
1.648     raeburn  1514: =item * &viewport_size_js()
1.590     raeburn  1515: 
                   1516: 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. 
                   1517: 
                   1518: =cut
                   1519: 
                   1520: sub viewport_size_js {
                   1521:     my $geometry = &viewport_geometry_js();
                   1522:     return <<"DIMS";
                   1523: 
                   1524: $geometry
                   1525: 
                   1526: function getViewportDims(width,height) {
                   1527:     init_geometry();
                   1528:     width.value = Geometry.getViewportWidth();
                   1529:     height.value = Geometry.getViewportHeight();
                   1530:     return;
                   1531: }
                   1532: 
                   1533: DIMS
                   1534: }
                   1535: 
                   1536: =pod
                   1537: 
1.648     raeburn  1538: =item * &resize_textarea_js()
1.565     albertel 1539: 
                   1540: emits the needed javascript to resize a textarea to be as big as possible
                   1541: 
                   1542: creates a function resize_textrea that takes two IDs first should be
                   1543: the id of the element to resize, second should be the id of a div that
                   1544: surrounds everything that comes after the textarea, this routine needs
                   1545: to be attached to the <body> for the onload and onresize events.
                   1546: 
1.648     raeburn  1547: =back
1.565     albertel 1548: 
                   1549: =cut
                   1550: 
                   1551: sub resize_textarea_js {
1.590     raeburn  1552:     my $geometry = &viewport_geometry_js();
1.565     albertel 1553:     return <<"RESIZE";
                   1554:     <script type="text/javascript">
1.824     bisitz   1555: // <![CDATA[
1.590     raeburn  1556: $geometry
1.565     albertel 1557: 
1.588     albertel 1558: function getX(element) {
                   1559:     var x = 0;
                   1560:     while (element) {
                   1561: 	x += element.offsetLeft;
                   1562: 	element = element.offsetParent;
                   1563:     }
                   1564:     return x;
                   1565: }
                   1566: function getY(element) {
                   1567:     var y = 0;
                   1568:     while (element) {
                   1569: 	y += element.offsetTop;
                   1570: 	element = element.offsetParent;
                   1571:     }
                   1572:     return y;
                   1573: }
                   1574: 
                   1575: 
1.565     albertel 1576: function resize_textarea(textarea_id,bottom_id) {
                   1577:     init_geometry();
                   1578:     var textarea        = document.getElementById(textarea_id);
                   1579:     //alert(textarea);
                   1580: 
1.588     albertel 1581:     var textarea_top    = getY(textarea);
1.565     albertel 1582:     var textarea_height = textarea.offsetHeight;
                   1583:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1584:     var bottom_top      = getY(bottom);
1.565     albertel 1585:     var bottom_height   = bottom.offsetHeight;
                   1586:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1587:     var fudge           = 23;
1.565     albertel 1588:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1589:     if (new_height < 300) {
                   1590: 	new_height = 300;
                   1591:     }
                   1592:     textarea.style.height=new_height+'px';
                   1593: }
1.824     bisitz   1594: // ]]>
1.565     albertel 1595: </script>
                   1596: RESIZE
                   1597: 
                   1598: }
                   1599: 
                   1600: =pod
                   1601: 
1.256     matthew  1602: =head1 Excel and CSV file utility routines
                   1603: 
                   1604: =over 4
                   1605: 
                   1606: =cut
                   1607: 
                   1608: ###############################################################
                   1609: ###############################################################
                   1610: 
                   1611: =pod
                   1612: 
1.648     raeburn  1613: =item * &csv_translate($text) 
1.37      matthew  1614: 
1.185     www      1615: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1616: format.
                   1617: 
                   1618: =cut
                   1619: 
1.180     matthew  1620: ###############################################################
                   1621: ###############################################################
1.37      matthew  1622: sub csv_translate {
                   1623:     my $text = shift;
                   1624:     $text =~ s/\"/\"\"/g;
1.209     albertel 1625:     $text =~ s/\n/ /g;
1.37      matthew  1626:     return $text;
                   1627: }
1.180     matthew  1628: 
                   1629: ###############################################################
                   1630: ###############################################################
                   1631: 
                   1632: =pod
                   1633: 
1.648     raeburn  1634: =item * &define_excel_formats()
1.180     matthew  1635: 
                   1636: Define some commonly used Excel cell formats.
                   1637: 
                   1638: Currently supported formats:
                   1639: 
                   1640: =over 4
                   1641: 
                   1642: =item header
                   1643: 
                   1644: =item bold
                   1645: 
                   1646: =item h1
                   1647: 
                   1648: =item h2
                   1649: 
                   1650: =item h3
                   1651: 
1.256     matthew  1652: =item h4
                   1653: 
                   1654: =item i
                   1655: 
1.180     matthew  1656: =item date
                   1657: 
                   1658: =back
                   1659: 
                   1660: Inputs: $workbook
                   1661: 
                   1662: Returns: $format, a hash reference.
                   1663: 
                   1664: =cut
                   1665: 
                   1666: ###############################################################
                   1667: ###############################################################
                   1668: sub define_excel_formats {
                   1669:     my ($workbook) = @_;
                   1670:     my $format;
                   1671:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1672:                                                 bottom    => 1,
                   1673:                                                 align     => 'center');
                   1674:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1675:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1676:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1677:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1678:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1679:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1680:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1681:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1682:     return $format;
                   1683: }
                   1684: 
                   1685: ###############################################################
                   1686: ###############################################################
1.113     bowersj2 1687: 
                   1688: =pod
                   1689: 
1.648     raeburn  1690: =item * &create_workbook()
1.255     matthew  1691: 
                   1692: Create an Excel worksheet.  If it fails, output message on the
                   1693: request object and return undefs.
                   1694: 
                   1695: Inputs: Apache request object
                   1696: 
                   1697: Returns (undef) on failure, 
                   1698:     Excel worksheet object, scalar with filename, and formats 
                   1699:     from &Apache::loncommon::define_excel_formats on success
                   1700: 
                   1701: =cut
                   1702: 
                   1703: ###############################################################
                   1704: ###############################################################
                   1705: sub create_workbook {
                   1706:     my ($r) = @_;
                   1707:         #
                   1708:     # Create the excel spreadsheet
                   1709:     my $filename = '/prtspool/'.
1.258     albertel 1710:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1711:         time.'_'.rand(1000000000).'.xls';
                   1712:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1713:     if (! defined($workbook)) {
                   1714:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1715:         $r->print(
                   1716:             '<p class="LC_error">'
                   1717:            .&mt('Problems occurred in creating the new Excel file.')
                   1718:            .' '.&mt('This error has been logged.')
                   1719:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1720:            .'</p>'
                   1721:         );
1.255     matthew  1722:         return (undef);
                   1723:     }
                   1724:     #
                   1725:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1726:     #
                   1727:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1728:     return ($workbook,$filename,$format);
                   1729: }
                   1730: 
                   1731: ###############################################################
                   1732: ###############################################################
                   1733: 
                   1734: =pod
                   1735: 
1.648     raeburn  1736: =item * &create_text_file()
1.113     bowersj2 1737: 
1.542     raeburn  1738: Create a file to write to and eventually make available to the user.
1.256     matthew  1739: If file creation fails, outputs an error message on the request object and 
                   1740: return undefs.
1.113     bowersj2 1741: 
1.256     matthew  1742: Inputs: Apache request object, and file suffix
1.113     bowersj2 1743: 
1.256     matthew  1744: Returns (undef) on failure, 
                   1745:     Filehandle and filename on success.
1.113     bowersj2 1746: 
                   1747: =cut
                   1748: 
1.256     matthew  1749: ###############################################################
                   1750: ###############################################################
                   1751: sub create_text_file {
                   1752:     my ($r,$suffix) = @_;
                   1753:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1754:     my $fh;
                   1755:     my $filename = '/prtspool/'.
1.258     albertel 1756:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1757:         time.'_'.rand(1000000000).'.'.$suffix;
                   1758:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1759:     if (! defined($fh)) {
                   1760:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1761:         $r->print(
                   1762:             '<p class="LC_error">'
                   1763:            .&mt('Problems occurred in creating the output file.')
                   1764:            .' '.&mt('This error has been logged.')
                   1765:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1766:            .'</p>'
                   1767:         );
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1796: 	return &select_form($name,$value,\%domains);
1.169     www      1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.970     raeburn  1858: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  1861: allow a user to select options from a ref to a hash containing:
                   1862: option_name => displayed text. An optional $onchange can include
                   1863: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   1864: 
1.88      www      1865: See lonrights.pm for an example invocation and use.
                   1866: 
                   1867: =cut
                   1868: 
                   1869: #-------------------------------------------
                   1870: sub select_form {
1.970     raeburn  1871:     my ($def,$name,$hashref,$onchange) = @_;
                   1872:     return unless (ref($hashref) eq 'HASH');
                   1873:     if ($onchange) {
                   1874:         $onchange = ' onchange="'.$onchange.'"';
                   1875:     }
                   1876:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 1877:     my @keys;
1.970     raeburn  1878:     if (exists($hashref->{'select_form_order'})) {
                   1879: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 1880:     } else {
1.970     raeburn  1881: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 1882:     }
1.356     albertel 1883:     foreach my $key (@keys) {
                   1884:         $selectform.=
                   1885: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1886:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  1887:                 ">".$hashref->{$key}."</option>\n";
1.88      www      1888:     }
                   1889:     $selectform.="</select>";
                   1890:     return $selectform;
                   1891: }
                   1892: 
1.475     www      1893: # For display filters
                   1894: 
                   1895: sub display_filter {
                   1896:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1897:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1898:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1899: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1900: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1901: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1902:            &mt('Filter [_1]',
1.477     www      1903: 	   &select_form($env{'form.displayfilter'},
                   1904: 			'displayfilter',
1.970     raeburn  1905: 			{'currentfolder' => 'Current folder/page',
1.477     www      1906: 			 'containing' => 'Containing phrase',
1.970     raeburn  1907: 			 'none' => 'None'})).
1.714     bisitz   1908: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1909: }
                   1910: 
1.167     www      1911: sub gradeleveldescription {
                   1912:     my $gradelevel=shift;
                   1913:     my %gradelevels=(0 => 'Not specified',
                   1914: 		     1 => 'Grade 1',
                   1915: 		     2 => 'Grade 2',
                   1916: 		     3 => 'Grade 3',
                   1917: 		     4 => 'Grade 4',
                   1918: 		     5 => 'Grade 5',
                   1919: 		     6 => 'Grade 6',
                   1920: 		     7 => 'Grade 7',
                   1921: 		     8 => 'Grade 8',
                   1922: 		     9 => 'Grade 9',
                   1923: 		     10 => 'Grade 10',
                   1924: 		     11 => 'Grade 11',
                   1925: 		     12 => 'Grade 12',
                   1926: 		     13 => 'Grade 13',
                   1927: 		     14 => '100 Level',
                   1928: 		     15 => '200 Level',
                   1929: 		     16 => '300 Level',
                   1930: 		     17 => '400 Level',
                   1931: 		     18 => 'Graduate Level');
                   1932:     return &mt($gradelevels{$gradelevel});
                   1933: }
                   1934: 
1.163     www      1935: sub select_level_form {
                   1936:     my ($deflevel,$name)=@_;
                   1937:     unless ($deflevel) { $deflevel=0; }
1.167     www      1938:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1939:     for (my $i=0; $i<=18; $i++) {
                   1940:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1941:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1942:                 ">".&gradeleveldescription($i)."</option>\n";
                   1943:     }
                   1944:     $selectform.="</select>";
                   1945:     return $selectform;
1.163     www      1946: }
1.167     www      1947: 
1.35      matthew  1948: #-------------------------------------------
                   1949: 
1.45      matthew  1950: =pod
                   1951: 
1.910     raeburn  1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1953: 
                   1954: Returns a string containing a <select name='$name' size='1'> form to 
                   1955: allow a user to select the domain to preform an operation in.  
                   1956: See loncreateuser.pm for an example invocation and use.
                   1957: 
1.90      www      1958: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1959: selected");
                   1960: 
1.743     raeburn  1961: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1962: 
1.910     raeburn  1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   1964: 
                   1965: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1966: 
1.35      matthew  1967: =cut
                   1968: 
                   1969: #-------------------------------------------
1.34      matthew  1970: sub select_dom_form {
1.910     raeburn  1971:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1972:     if ($onchange) {
1.874     raeburn  1973:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1974:     }
1.910     raeburn  1975:     my @domains;
                   1976:     if (ref($incdoms) eq 'ARRAY') {
                   1977:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   1978:     } else {
                   1979:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   1980:     }
1.90      www      1981:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1982:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1983:     foreach my $dom (@domains) {
                   1984:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1985:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1986:         if ($showdomdesc) {
                   1987:             if ($dom ne '') {
                   1988:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1989:                 if ($domdesc ne '') {
                   1990:                     $selectdomain .= ' ('.$domdesc.')';
                   1991:                 }
                   1992:             } 
                   1993:         }
                   1994:         $selectdomain .= "</option>\n";
1.34      matthew  1995:     }
                   1996:     $selectdomain.="</select>";
                   1997:     return $selectdomain;
                   1998: }
                   1999: 
1.35      matthew  2000: #-------------------------------------------
                   2001: 
1.45      matthew  2002: =pod
                   2003: 
1.648     raeburn  2004: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2005: 
1.586     raeburn  2006: input: 4 arguments (two required, two optional) - 
                   2007:     $domain - domain of new user
                   2008:     $name - name of form element
                   2009:     $default - Value of 'default' causes a default item to be first 
                   2010:                             option, and selected by default. 
                   2011:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2012:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2013: output: returns 2 items: 
1.586     raeburn  2014: (a) form element which contains either:
                   2015:    (i) <select name="$name">
                   2016:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2017:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2018:        </select>
                   2019:        form item if there are multiple library servers in $domain, or
                   2020:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2021:        if there is only one library server in $domain.
                   2022: 
                   2023: (b) number of library servers found.
                   2024: 
                   2025: See loncreateuser.pm for example of use.
1.35      matthew  2026: 
                   2027: =cut
                   2028: 
                   2029: #-------------------------------------------
1.586     raeburn  2030: sub home_server_form_item {
                   2031:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2032:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2033:     my $result;
                   2034:     my $numlib = keys(%servers);
                   2035:     if ($numlib > 1) {
                   2036:         $result .= '<select name="'.$name.'" />'."\n";
                   2037:         if ($default) {
1.804     bisitz   2038:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2039:                        '</option>'."\n";
                   2040:         }
                   2041:         foreach my $hostid (sort(keys(%servers))) {
                   2042:             $result.= '<option value="'.$hostid.'">'.
                   2043: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2044:         }
                   2045:         $result .= '</select>'."\n";
                   2046:     } elsif ($numlib == 1) {
                   2047:         my $hostid;
                   2048:         foreach my $item (keys(%servers)) {
                   2049:             $hostid = $item;
                   2050:         }
                   2051:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2052:                    $hostid.'" />';
                   2053:                    if (!$hide) {
                   2054:                        $result .= $hostid.' '.$servers{$hostid};
                   2055:                    }
                   2056:                    $result .= "\n";
                   2057:     } elsif ($default) {
                   2058:         $result .= '<input type="hidden" name="'.$name.
                   2059:                    '" value="default" />';
                   2060:                    if (!$hide) {
                   2061:                        $result .= &mt('default');
                   2062:                    }
                   2063:                    $result .= "\n";
1.33      matthew  2064:     }
1.586     raeburn  2065:     return ($result,$numlib);
1.33      matthew  2066: }
1.112     bowersj2 2067: 
                   2068: =pod
                   2069: 
1.534     albertel 2070: =back 
                   2071: 
1.112     bowersj2 2072: =cut
1.87      matthew  2073: 
                   2074: ###############################################################
1.112     bowersj2 2075: ##                  Decoding User Agent                      ##
1.87      matthew  2076: ###############################################################
                   2077: 
                   2078: =pod
                   2079: 
1.112     bowersj2 2080: =head1 Decoding the User Agent
                   2081: 
                   2082: =over 4
                   2083: 
                   2084: =item * &decode_user_agent()
1.87      matthew  2085: 
                   2086: Inputs: $r
                   2087: 
                   2088: Outputs:
                   2089: 
                   2090: =over 4
                   2091: 
1.112     bowersj2 2092: =item * $httpbrowser
1.87      matthew  2093: 
1.112     bowersj2 2094: =item * $clientbrowser
1.87      matthew  2095: 
1.112     bowersj2 2096: =item * $clientversion
1.87      matthew  2097: 
1.112     bowersj2 2098: =item * $clientmathml
1.87      matthew  2099: 
1.112     bowersj2 2100: =item * $clientunicode
1.87      matthew  2101: 
1.112     bowersj2 2102: =item * $clientos
1.87      matthew  2103: 
                   2104: =back
                   2105: 
1.157     matthew  2106: =back 
                   2107: 
1.87      matthew  2108: =cut
                   2109: 
                   2110: ###############################################################
                   2111: ###############################################################
                   2112: sub decode_user_agent {
1.247     albertel 2113:     my ($r)=@_;
1.87      matthew  2114:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2115:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2116:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2117:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2118:     my $clientbrowser='unknown';
                   2119:     my $clientversion='0';
                   2120:     my $clientmathml='';
                   2121:     my $clientunicode='0';
                   2122:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2123:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2124: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2125: 	    $clientbrowser=$bname;
                   2126:             $httpbrowser=~/$vreg/i;
                   2127: 	    $clientversion=$1;
                   2128:             $clientmathml=($clientversion>=$minv);
                   2129:             $clientunicode=($clientversion>=$univ);
                   2130: 	}
                   2131:     }
                   2132:     my $clientos='unknown';
                   2133:     if (($httpbrowser=~/linux/i) ||
                   2134:         ($httpbrowser=~/unix/i) ||
                   2135:         ($httpbrowser=~/ux/i) ||
                   2136:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2137:     if (($httpbrowser=~/vax/i) ||
                   2138:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2139:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2140:     if (($httpbrowser=~/mac/i) ||
                   2141:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2142:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2143:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2144:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2145:             $clientunicode,$clientos,);
                   2146: }
                   2147: 
1.32      matthew  2148: ###############################################################
                   2149: ##    Authentication changing form generation subroutines    ##
                   2150: ###############################################################
                   2151: ##
                   2152: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2153: ## hash, and have reasonable default values.
                   2154: ##
                   2155: ##    formname = the name given in the <form> tag.
1.35      matthew  2156: #-------------------------------------------
                   2157: 
1.45      matthew  2158: =pod
                   2159: 
1.112     bowersj2 2160: =head1 Authentication Routines
                   2161: 
                   2162: =over 4
                   2163: 
1.648     raeburn  2164: =item * &authform_xxxxxx()
1.35      matthew  2165: 
                   2166: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2167: handle some of the conveniences required for authentication forms.  
                   2168: This is not an optimal method, but it works.  
                   2169: 
                   2170: =over 4
                   2171: 
1.112     bowersj2 2172: =item * authform_header
1.35      matthew  2173: 
1.112     bowersj2 2174: =item * authform_authorwarning
1.35      matthew  2175: 
1.112     bowersj2 2176: =item * authform_nochange
1.35      matthew  2177: 
1.112     bowersj2 2178: =item * authform_kerberos
1.35      matthew  2179: 
1.112     bowersj2 2180: =item * authform_internal
1.35      matthew  2181: 
1.112     bowersj2 2182: =item * authform_filesystem
1.35      matthew  2183: 
                   2184: =back
                   2185: 
1.648     raeburn  2186: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2187: 
1.35      matthew  2188: =cut
                   2189: 
                   2190: #-------------------------------------------
1.32      matthew  2191: sub authform_header{  
                   2192:     my %in = (
                   2193:         formname => 'cu',
1.80      albertel 2194:         kerb_def_dom => '',
1.32      matthew  2195:         @_,
                   2196:     );
                   2197:     $in{'formname'} = 'document.' . $in{'formname'};
                   2198:     my $result='';
1.80      albertel 2199: 
                   2200: #---------------------------------------------- Code for upper case translation
                   2201:     my $Javascript_toUpperCase;
                   2202:     unless ($in{kerb_def_dom}) {
                   2203:         $Javascript_toUpperCase =<<"END";
                   2204:         switch (choice) {
                   2205:            case 'krb': currentform.elements[choicearg].value =
                   2206:                currentform.elements[choicearg].value.toUpperCase();
                   2207:                break;
                   2208:            default:
                   2209:         }
                   2210: END
                   2211:     } else {
                   2212:         $Javascript_toUpperCase = "";
                   2213:     }
                   2214: 
1.165     raeburn  2215:     my $radioval = "'nochange'";
1.591     raeburn  2216:     if (defined($in{'curr_authtype'})) {
                   2217:         if ($in{'curr_authtype'} ne '') {
                   2218:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2219:         }
1.174     matthew  2220:     }
1.165     raeburn  2221:     my $argfield = 'null';
1.591     raeburn  2222:     if (defined($in{'mode'})) {
1.165     raeburn  2223:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2224:             if (defined($in{'curr_autharg'})) {
                   2225:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2226:                     $argfield = "'$in{'curr_autharg'}'";
                   2227:                 }
                   2228:             }
                   2229:         }
                   2230:     }
                   2231: 
1.32      matthew  2232:     $result.=<<"END";
                   2233: var current = new Object();
1.165     raeburn  2234: current.radiovalue = $radioval;
                   2235: current.argfield = $argfield;
1.32      matthew  2236: 
                   2237: function changed_radio(choice,currentform) {
                   2238:     var choicearg = choice + 'arg';
                   2239:     // If a radio button in changed, we need to change the argfield
                   2240:     if (current.radiovalue != choice) {
                   2241:         current.radiovalue = choice;
                   2242:         if (current.argfield != null) {
                   2243:             currentform.elements[current.argfield].value = '';
                   2244:         }
                   2245:         if (choice == 'nochange') {
                   2246:             current.argfield = null;
                   2247:         } else {
                   2248:             current.argfield = choicearg;
                   2249:             switch(choice) {
                   2250:                 case 'krb': 
                   2251:                     currentform.elements[current.argfield].value = 
                   2252:                         "$in{'kerb_def_dom'}";
                   2253:                 break;
                   2254:               default:
                   2255:                 break;
                   2256:             }
                   2257:         }
                   2258:     }
                   2259:     return;
                   2260: }
1.22      www      2261: 
1.32      matthew  2262: function changed_text(choice,currentform) {
                   2263:     var choicearg = choice + 'arg';
                   2264:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2265:         $Javascript_toUpperCase
1.32      matthew  2266:         // clear old field
                   2267:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2268:             currentform.elements[current.argfield].value = '';
                   2269:         }
                   2270:         current.argfield = choicearg;
                   2271:     }
                   2272:     set_auth_radio_buttons(choice,currentform);
                   2273:     return;
1.20      www      2274: }
1.32      matthew  2275: 
                   2276: function set_auth_radio_buttons(newvalue,currentform) {
                   2277:     var i=0;
                   2278:     while (i < currentform.login.length) {
                   2279:         if (currentform.login[i].value == newvalue) { break; }
                   2280:         i++;
                   2281:     }
                   2282:     if (i == currentform.login.length) {
                   2283:         return;
                   2284:     }
                   2285:     current.radiovalue = newvalue;
                   2286:     currentform.login[i].checked = true;
                   2287:     return;
                   2288: }
                   2289: END
                   2290:     return $result;
                   2291: }
                   2292: 
                   2293: sub authform_authorwarning{
                   2294:     my $result='';
1.144     matthew  2295:     $result='<i>'.
                   2296:         &mt('As a general rule, only authors or co-authors should be '.
                   2297:             'filesystem authenticated '.
                   2298:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2299:     return $result;
                   2300: }
                   2301: 
                   2302: sub authform_nochange{  
                   2303:     my %in = (
                   2304:               formname => 'document.cu',
                   2305:               kerb_def_dom => 'MSU.EDU',
                   2306:               @_,
                   2307:           );
1.586     raeburn  2308:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2309:     my $result;
                   2310:     if (keys(%can_assign) == 0) {
                   2311:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2312:     } else {
                   2313:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2314:                   '<input type="radio" name="login" value="nochange" '.
                   2315:                   'checked="checked" onclick="'.
1.281     albertel 2316:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2317: 	    '</label>';
1.586     raeburn  2318:     }
1.32      matthew  2319:     return $result;
                   2320: }
                   2321: 
1.591     raeburn  2322: sub authform_kerberos {
1.32      matthew  2323:     my %in = (
                   2324:               formname => 'document.cu',
                   2325:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2326:               kerb_def_auth => 'krb4',
1.32      matthew  2327:               @_,
                   2328:               );
1.586     raeburn  2329:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2330:         $autharg,$jscall);
                   2331:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2332:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2333:        $check5 = ' checked="checked"';
1.80      albertel 2334:     } else {
1.772     bisitz   2335:        $check4 = ' checked="checked"';
1.80      albertel 2336:     }
1.165     raeburn  2337:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2338:     if (defined($in{'curr_authtype'})) {
                   2339:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2340:             $krbcheck = ' checked="checked"';
1.623     raeburn  2341:             if (defined($in{'mode'})) {
                   2342:                 if ($in{'mode'} eq 'modifyuser') {
                   2343:                     $krbcheck = '';
                   2344:                 }
                   2345:             }
1.591     raeburn  2346:             if (defined($in{'curr_kerb_ver'})) {
                   2347:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2348:                     $check5 = ' checked="checked"';
1.591     raeburn  2349:                     $check4 = '';
                   2350:                 } else {
1.772     bisitz   2351:                     $check4 = ' checked="checked"';
1.591     raeburn  2352:                     $check5 = '';
                   2353:                 }
1.586     raeburn  2354:             }
1.591     raeburn  2355:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2356:                 $krbarg = $in{'curr_autharg'};
                   2357:             }
1.586     raeburn  2358:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2359:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2360:                     $result = 
                   2361:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2362:         $in{'curr_autharg'},$krbver);
                   2363:                 } else {
                   2364:                     $result =
                   2365:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2366:                 }
                   2367:                 return $result; 
                   2368:             }
                   2369:         }
                   2370:     } else {
                   2371:         if ($authnum == 1) {
1.784     bisitz   2372:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2373:         }
                   2374:     }
1.586     raeburn  2375:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2376:         return;
1.587     raeburn  2377:     } elsif ($authtype eq '') {
1.591     raeburn  2378:         if (defined($in{'mode'})) {
1.587     raeburn  2379:             if ($in{'mode'} eq 'modifycourse') {
                   2380:                 if ($authnum == 1) {
1.784     bisitz   2381:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2382:                 }
                   2383:             }
                   2384:         }
1.586     raeburn  2385:     }
                   2386:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2387:     if ($authtype eq '') {
                   2388:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2389:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2390:                     $krbcheck.' />';
                   2391:     }
                   2392:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2393:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2394:          $in{'curr_authtype'} eq 'krb5') ||
                   2395:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2396:          $in{'curr_authtype'} eq 'krb4')) {
                   2397:         $result .= &mt
1.144     matthew  2398:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2399:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2400:          '<label>'.$authtype,
1.281     albertel 2401:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2402:              'value="'.$krbarg.'" '.
1.144     matthew  2403:              'onchange="'.$jscall.'" />',
1.281     albertel 2404:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2405:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2406: 	 '</label>');
1.586     raeburn  2407:     } elsif ($can_assign{'krb4'}) {
                   2408:         $result .= &mt
                   2409:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2410:          '[_3] Version 4 [_4]',
                   2411:          '<label>'.$authtype,
                   2412:          '</label><input type="text" size="10" name="krbarg" '.
                   2413:              'value="'.$krbarg.'" '.
                   2414:              'onchange="'.$jscall.'" />',
                   2415:          '<label><input type="hidden" name="krbver" value="4" />',
                   2416:          '</label>');
                   2417:     } elsif ($can_assign{'krb5'}) {
                   2418:         $result .= &mt
                   2419:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2420:          '[_3] Version 5 [_4]',
                   2421:          '<label>'.$authtype,
                   2422:          '</label><input type="text" size="10" name="krbarg" '.
                   2423:              'value="'.$krbarg.'" '.
                   2424:              'onchange="'.$jscall.'" />',
                   2425:          '<label><input type="hidden" name="krbver" value="5" />',
                   2426:          '</label>');
                   2427:     }
1.32      matthew  2428:     return $result;
                   2429: }
                   2430: 
                   2431: sub authform_internal{  
1.586     raeburn  2432:     my %in = (
1.32      matthew  2433:                 formname => 'document.cu',
                   2434:                 kerb_def_dom => 'MSU.EDU',
                   2435:                 @_,
                   2436:                 );
1.586     raeburn  2437:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2438:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2439:     if (defined($in{'curr_authtype'})) {
                   2440:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2441:             if ($can_assign{'int'}) {
1.772     bisitz   2442:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2443:                 if (defined($in{'mode'})) {
                   2444:                     if ($in{'mode'} eq 'modifyuser') {
                   2445:                         $intcheck = '';
                   2446:                     }
                   2447:                 }
1.591     raeburn  2448:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2449:                     $intarg = $in{'curr_autharg'};
                   2450:                 }
                   2451:             } else {
                   2452:                 $result = &mt('Currently internally authenticated.');
                   2453:                 return $result;
1.165     raeburn  2454:             }
                   2455:         }
1.586     raeburn  2456:     } else {
                   2457:         if ($authnum == 1) {
1.784     bisitz   2458:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2459:         }
                   2460:     }
                   2461:     if (!$can_assign{'int'}) {
                   2462:         return;
1.587     raeburn  2463:     } elsif ($authtype eq '') {
1.591     raeburn  2464:         if (defined($in{'mode'})) {
1.587     raeburn  2465:             if ($in{'mode'} eq 'modifycourse') {
                   2466:                 if ($authnum == 1) {
1.784     bisitz   2467:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2468:                 }
                   2469:             }
                   2470:         }
1.165     raeburn  2471:     }
1.586     raeburn  2472:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2473:     if ($authtype eq '') {
                   2474:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2475:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2476:     }
1.605     bisitz   2477:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2478:                $intarg.'" onchange="'.$jscall.'" />';
                   2479:     $result = &mt
1.144     matthew  2480:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2481:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2482:     $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  2483:     return $result;
                   2484: }
                   2485: 
                   2486: sub authform_local{  
                   2487:     my %in = (
                   2488:               formname => 'document.cu',
                   2489:               kerb_def_dom => 'MSU.EDU',
                   2490:               @_,
                   2491:               );
1.586     raeburn  2492:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2493:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2494:     if (defined($in{'curr_authtype'})) {
                   2495:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2496:             if ($can_assign{'loc'}) {
1.772     bisitz   2497:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2498:                 if (defined($in{'mode'})) {
                   2499:                     if ($in{'mode'} eq 'modifyuser') {
                   2500:                         $loccheck = '';
                   2501:                     }
                   2502:                 }
1.591     raeburn  2503:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2504:                     $locarg = $in{'curr_autharg'};
                   2505:                 }
                   2506:             } else {
                   2507:                 $result = &mt('Currently using local (institutional) authentication.');
                   2508:                 return $result;
1.165     raeburn  2509:             }
                   2510:         }
1.586     raeburn  2511:     } else {
                   2512:         if ($authnum == 1) {
1.784     bisitz   2513:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2514:         }
                   2515:     }
                   2516:     if (!$can_assign{'loc'}) {
                   2517:         return;
1.587     raeburn  2518:     } elsif ($authtype eq '') {
1.591     raeburn  2519:         if (defined($in{'mode'})) {
1.587     raeburn  2520:             if ($in{'mode'} eq 'modifycourse') {
                   2521:                 if ($authnum == 1) {
1.784     bisitz   2522:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2523:                 }
                   2524:             }
                   2525:         }
1.165     raeburn  2526:     }
1.586     raeburn  2527:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2528:     if ($authtype eq '') {
                   2529:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2530:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2531:                     $jscall.'" />';
                   2532:     }
                   2533:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2534:                $locarg.'" onchange="'.$jscall.'" />';
                   2535:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2536:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2537:     return $result;
                   2538: }
                   2539: 
                   2540: sub authform_filesystem{  
                   2541:     my %in = (
                   2542:               formname => 'document.cu',
                   2543:               kerb_def_dom => 'MSU.EDU',
                   2544:               @_,
                   2545:               );
1.586     raeburn  2546:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2547:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2548:     if (defined($in{'curr_authtype'})) {
                   2549:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2550:             if ($can_assign{'fsys'}) {
1.772     bisitz   2551:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2552:                 if (defined($in{'mode'})) {
                   2553:                     if ($in{'mode'} eq 'modifyuser') {
                   2554:                         $fsyscheck = '';
                   2555:                     }
                   2556:                 }
1.586     raeburn  2557:             } else {
                   2558:                 $result = &mt('Currently Filesystem Authenticated.');
                   2559:                 return $result;
                   2560:             }           
                   2561:         }
                   2562:     } else {
                   2563:         if ($authnum == 1) {
1.784     bisitz   2564:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2565:         }
                   2566:     }
                   2567:     if (!$can_assign{'fsys'}) {
                   2568:         return;
1.587     raeburn  2569:     } elsif ($authtype eq '') {
1.591     raeburn  2570:         if (defined($in{'mode'})) {
1.587     raeburn  2571:             if ($in{'mode'} eq 'modifycourse') {
                   2572:                 if ($authnum == 1) {
1.784     bisitz   2573:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2574:                 }
                   2575:             }
                   2576:         }
1.586     raeburn  2577:     }
                   2578:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2579:     if ($authtype eq '') {
                   2580:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2581:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2582:                     $jscall.'" />';
                   2583:     }
                   2584:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2585:                ' onchange="'.$jscall.'" />';
                   2586:     $result = &mt
1.144     matthew  2587:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2588:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2589:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2590:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2591:                   'onchange="'.$jscall.'" />');
1.32      matthew  2592:     return $result;
                   2593: }
                   2594: 
1.586     raeburn  2595: sub get_assignable_auth {
                   2596:     my ($dom) = @_;
                   2597:     if ($dom eq '') {
                   2598:         $dom = $env{'request.role.domain'};
                   2599:     }
                   2600:     my %can_assign = (
                   2601:                           krb4 => 1,
                   2602:                           krb5 => 1,
                   2603:                           int  => 1,
                   2604:                           loc  => 1,
                   2605:                      );
                   2606:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2607:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2608:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2609:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2610:             my $context;
                   2611:             if ($env{'request.role'} =~ /^au/) {
                   2612:                 $context = 'author';
                   2613:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2614:                 $context = 'domain';
                   2615:             } elsif ($env{'request.course.id'}) {
                   2616:                 $context = 'course';
                   2617:             }
                   2618:             if ($context) {
                   2619:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2620:                    %can_assign = %{$authhash->{$context}}; 
                   2621:                 }
                   2622:             }
                   2623:         }
                   2624:     }
                   2625:     my $authnum = 0;
                   2626:     foreach my $key (keys(%can_assign)) {
                   2627:         if ($can_assign{$key}) {
                   2628:             $authnum ++;
                   2629:         }
                   2630:     }
                   2631:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2632:         $authnum --;
                   2633:     }
                   2634:     return ($authnum,%can_assign);
                   2635: }
                   2636: 
1.80      albertel 2637: ###############################################################
                   2638: ##    Get Kerberos Defaults for Domain                 ##
                   2639: ###############################################################
                   2640: ##
                   2641: ## Returns default kerberos version and an associated argument
                   2642: ## as listed in file domain.tab. If not listed, provides
                   2643: ## appropriate default domain and kerberos version.
                   2644: ##
                   2645: #-------------------------------------------
                   2646: 
                   2647: =pod
                   2648: 
1.648     raeburn  2649: =item * &get_kerberos_defaults()
1.80      albertel 2650: 
                   2651: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2652: version and domain. If not found, it defaults to version 4 and the 
                   2653: domain of the server.
1.80      albertel 2654: 
1.648     raeburn  2655: =over 4
                   2656: 
1.80      albertel 2657: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2658: 
1.648     raeburn  2659: =back
                   2660: 
                   2661: =back
                   2662: 
1.80      albertel 2663: =cut
                   2664: 
                   2665: #-------------------------------------------
                   2666: sub get_kerberos_defaults {
                   2667:     my $domain=shift;
1.641     raeburn  2668:     my ($krbdef,$krbdefdom);
                   2669:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2670:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2671:         $krbdef = $domdefaults{'auth_def'};
                   2672:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2673:     } else {
1.80      albertel 2674:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2675:         my $krbdefdom=$1;
                   2676:         $krbdefdom=~tr/a-z/A-Z/;
                   2677:         $krbdef = "krb4";
                   2678:     }
                   2679:     return ($krbdef,$krbdefdom);
                   2680: }
1.112     bowersj2 2681: 
1.32      matthew  2682: 
1.46      matthew  2683: ###############################################################
                   2684: ##                Thesaurus Functions                        ##
                   2685: ###############################################################
1.20      www      2686: 
1.46      matthew  2687: =pod
1.20      www      2688: 
1.112     bowersj2 2689: =head1 Thesaurus Functions
                   2690: 
                   2691: =over 4
                   2692: 
1.648     raeburn  2693: =item * &initialize_keywords()
1.46      matthew  2694: 
                   2695: Initializes the package variable %Keywords if it is empty.  Uses the
                   2696: package variable $thesaurus_db_file.
                   2697: 
                   2698: =cut
                   2699: 
                   2700: ###################################################
                   2701: 
                   2702: sub initialize_keywords {
                   2703:     return 1 if (scalar keys(%Keywords));
                   2704:     # If we are here, %Keywords is empty, so fill it up
                   2705:     #   Make sure the file we need exists...
                   2706:     if (! -e $thesaurus_db_file) {
                   2707:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2708:                                  " failed because it does not exist");
                   2709:         return 0;
                   2710:     }
                   2711:     #   Set up the hash as a database
                   2712:     my %thesaurus_db;
                   2713:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2714:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2715:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2716:                                  $thesaurus_db_file);
                   2717:         return 0;
                   2718:     } 
                   2719:     #  Get the average number of appearances of a word.
                   2720:     my $avecount = $thesaurus_db{'average.count'};
                   2721:     #  Put keywords (those that appear > average) into %Keywords
                   2722:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2723:         my ($count,undef) = split /:/,$data;
                   2724:         $Keywords{$word}++ if ($count > $avecount);
                   2725:     }
                   2726:     untie %thesaurus_db;
                   2727:     # Remove special values from %Keywords.
1.356     albertel 2728:     foreach my $value ('total.count','average.count') {
                   2729:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2730:   }
1.46      matthew  2731:     return 1;
                   2732: }
                   2733: 
                   2734: ###################################################
                   2735: 
                   2736: =pod
                   2737: 
1.648     raeburn  2738: =item * &keyword($word)
1.46      matthew  2739: 
                   2740: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2741: than the average number of times in the thesaurus database.  Calls 
                   2742: &initialize_keywords
                   2743: 
                   2744: =cut
                   2745: 
                   2746: ###################################################
1.20      www      2747: 
                   2748: sub keyword {
1.46      matthew  2749:     return if (!&initialize_keywords());
                   2750:     my $word=lc(shift());
                   2751:     $word=~s/\W//g;
                   2752:     return exists($Keywords{$word});
1.20      www      2753: }
1.46      matthew  2754: 
                   2755: ###############################################################
                   2756: 
                   2757: =pod 
1.20      www      2758: 
1.648     raeburn  2759: =item * &get_related_words()
1.46      matthew  2760: 
1.160     matthew  2761: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2762: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2763: will be returned.  The order of the words returned is determined by the
                   2764: database which holds them.
                   2765: 
                   2766: Uses global $thesaurus_db_file.
                   2767: 
                   2768: =cut
                   2769: 
                   2770: ###############################################################
                   2771: sub get_related_words {
                   2772:     my $keyword = shift;
                   2773:     my %thesaurus_db;
                   2774:     if (! -e $thesaurus_db_file) {
                   2775:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2776:                                  "failed because the file does not exist");
                   2777:         return ();
                   2778:     }
                   2779:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2780:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2781:         return ();
                   2782:     } 
                   2783:     my @Words=();
1.429     www      2784:     my $count=0;
1.46      matthew  2785:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2786: 	# The first element is the number of times
                   2787: 	# the word appears.  We do not need it now.
1.429     www      2788: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2789: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2790: 	my $threshold=$mostfrequentcount/10;
                   2791:         foreach my $possibleword (@RelatedWords) {
                   2792:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2793:             if ($wordcount>$threshold) {
                   2794: 		push(@Words,$word);
                   2795:                 $count++;
                   2796:                 if ($count>10) { last; }
                   2797: 	    }
1.20      www      2798:         }
                   2799:     }
1.46      matthew  2800:     untie %thesaurus_db;
                   2801:     return @Words;
1.14      harris41 2802: }
1.46      matthew  2803: 
1.112     bowersj2 2804: =pod
                   2805: 
                   2806: =back
                   2807: 
                   2808: =cut
1.61      www      2809: 
                   2810: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2811: =pod
                   2812: 
1.112     bowersj2 2813: =head1 User Name Functions
                   2814: 
                   2815: =over 4
                   2816: 
1.648     raeburn  2817: =item * &plainname($uname,$udom,$first)
1.81      albertel 2818: 
1.112     bowersj2 2819: Takes a users logon name and returns it as a string in
1.226     albertel 2820: "first middle last generation" form 
                   2821: if $first is set to 'lastname' then it returns it as
                   2822: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2823: 
                   2824: =cut
1.61      www      2825: 
1.295     www      2826: 
1.81      albertel 2827: ###############################################################
1.61      www      2828: sub plainname {
1.226     albertel 2829:     my ($uname,$udom,$first)=@_;
1.537     albertel 2830:     return if (!defined($uname) || !defined($udom));
1.295     www      2831:     my %names=&getnames($uname,$udom);
1.226     albertel 2832:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2833: 					  $names{'middlename'},
                   2834: 					  $names{'lastname'},
                   2835: 					  $names{'generation'},$first);
                   2836:     $name=~s/^\s+//;
1.62      www      2837:     $name=~s/\s+$//;
                   2838:     $name=~s/\s+/ /g;
1.353     albertel 2839:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2840:     return $name;
1.61      www      2841: }
1.66      www      2842: 
                   2843: # -------------------------------------------------------------------- Nickname
1.81      albertel 2844: =pod
                   2845: 
1.648     raeburn  2846: =item * &nickname($uname,$udom)
1.81      albertel 2847: 
                   2848: Gets a users name and returns it as a string as
                   2849: 
                   2850: "&quot;nickname&quot;"
1.66      www      2851: 
1.81      albertel 2852: if the user has a nickname or
                   2853: 
                   2854: "first middle last generation"
                   2855: 
                   2856: if the user does not
                   2857: 
                   2858: =cut
1.66      www      2859: 
                   2860: sub nickname {
                   2861:     my ($uname,$udom)=@_;
1.537     albertel 2862:     return if (!defined($uname) || !defined($udom));
1.295     www      2863:     my %names=&getnames($uname,$udom);
1.68      albertel 2864:     my $name=$names{'nickname'};
1.66      www      2865:     if ($name) {
                   2866:        $name='&quot;'.$name.'&quot;'; 
                   2867:     } else {
                   2868:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2869: 	     $names{'lastname'}.' '.$names{'generation'};
                   2870:        $name=~s/\s+$//;
                   2871:        $name=~s/\s+/ /g;
                   2872:     }
                   2873:     return $name;
                   2874: }
                   2875: 
1.295     www      2876: sub getnames {
                   2877:     my ($uname,$udom)=@_;
1.537     albertel 2878:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2879:     if ($udom eq 'public' && $uname eq 'public') {
                   2880: 	return ('lastname' => &mt('Public'));
                   2881:     }
1.295     www      2882:     my $id=$uname.':'.$udom;
                   2883:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2884:     if ($cached) {
                   2885: 	return %{$names};
                   2886:     } else {
                   2887: 	my %loadnames=&Apache::lonnet::get('environment',
                   2888:                     ['firstname','middlename','lastname','generation','nickname'],
                   2889: 					 $udom,$uname);
                   2890: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2891: 	return %loadnames;
                   2892:     }
                   2893: }
1.61      www      2894: 
1.542     raeburn  2895: # -------------------------------------------------------------------- getemails
1.648     raeburn  2896: 
1.542     raeburn  2897: =pod
                   2898: 
1.648     raeburn  2899: =item * &getemails($uname,$udom)
1.542     raeburn  2900: 
                   2901: Gets a user's email information and returns it as a hash with keys:
                   2902: notification, critnotification, permanentemail
                   2903: 
                   2904: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2905: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2906:  
1.648     raeburn  2907: 
1.542     raeburn  2908: =cut
                   2909: 
1.648     raeburn  2910: 
1.466     albertel 2911: sub getemails {
                   2912:     my ($uname,$udom)=@_;
                   2913:     if ($udom eq 'public' && $uname eq 'public') {
                   2914: 	return;
                   2915:     }
1.467     www      2916:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2917:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2918:     my $id=$uname.':'.$udom;
                   2919:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2920:     if ($cached) {
                   2921: 	return %{$names};
                   2922:     } else {
                   2923: 	my %loadnames=&Apache::lonnet::get('environment',
                   2924:                     			   ['notification','critnotification',
                   2925: 					    'permanentemail'],
                   2926: 					   $udom,$uname);
                   2927: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2928: 	return %loadnames;
                   2929:     }
                   2930: }
                   2931: 
1.551     albertel 2932: sub flush_email_cache {
                   2933:     my ($uname,$udom)=@_;
                   2934:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2935:     if (!$uname) { $uname=$env{'user.name'};   }
                   2936:     return if ($udom eq 'public' && $uname eq 'public');
                   2937:     my $id=$uname.':'.$udom;
                   2938:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2939: }
                   2940: 
1.728     raeburn  2941: # -------------------------------------------------------------------- getlangs
                   2942: 
                   2943: =pod
                   2944: 
                   2945: =item * &getlangs($uname,$udom)
                   2946: 
                   2947: Gets a user's language preference and returns it as a hash with key:
                   2948: language.
                   2949: 
                   2950: =cut
                   2951: 
                   2952: 
                   2953: sub getlangs {
                   2954:     my ($uname,$udom) = @_;
                   2955:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2956:     if (!$uname) { $uname=$env{'user.name'};   }
                   2957:     my $id=$uname.':'.$udom;
                   2958:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2959:     if ($cached) {
                   2960:         return %{$langs};
                   2961:     } else {
                   2962:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2963:                                            $udom,$uname);
                   2964:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2965:         return %loadlangs;
                   2966:     }
                   2967: }
                   2968: 
                   2969: sub flush_langs_cache {
                   2970:     my ($uname,$udom)=@_;
                   2971:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2972:     if (!$uname) { $uname=$env{'user.name'};   }
                   2973:     return if ($udom eq 'public' && $uname eq 'public');
                   2974:     my $id=$uname.':'.$udom;
                   2975:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2976: }
                   2977: 
1.61      www      2978: # ------------------------------------------------------------------ Screenname
1.81      albertel 2979: 
                   2980: =pod
                   2981: 
1.648     raeburn  2982: =item * &screenname($uname,$udom)
1.81      albertel 2983: 
                   2984: Gets a users screenname and returns it as a string
                   2985: 
                   2986: =cut
1.61      www      2987: 
                   2988: sub screenname {
                   2989:     my ($uname,$udom)=@_;
1.258     albertel 2990:     if ($uname eq $env{'user.name'} &&
                   2991: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2992:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2993:     return $names{'screenname'};
1.62      www      2994: }
                   2995: 
1.212     albertel 2996: 
1.802     bisitz   2997: # ------------------------------------------------------------- Confirm Wrapper
                   2998: =pod
                   2999: 
                   3000: =item confirmwrapper
                   3001: 
                   3002: Wrap messages about completion of operation in box
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub confirmwrapper {
                   3007:     my ($message)=@_;
                   3008:     if ($message) {
                   3009:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3010:                .$message."\n"
                   3011:                .'</div>'."\n";
                   3012:     } else {
                   3013:         return $message;
                   3014:     }
                   3015: }
                   3016: 
1.62      www      3017: # ------------------------------------------------------------- Message Wrapper
                   3018: 
                   3019: sub messagewrapper {
1.369     www      3020:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3021:     return 
1.441     albertel 3022:         '<a href="/adm/email?compose=individual&amp;'.
                   3023:         'recname='.$username.'&amp;recdom='.$domain.
                   3024: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3025:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3026: }
1.802     bisitz   3027: 
1.74      www      3028: # --------------------------------------------------------------- Notes Wrapper
                   3029: 
                   3030: sub noteswrapper {
                   3031:     my ($link,$un,$do)=@_;
                   3032:     return 
1.896     amueller 3033: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3034: }
1.802     bisitz   3035: 
1.62      www      3036: # ------------------------------------------------------------- Aboutme Wrapper
                   3037: 
                   3038: sub aboutmewrapper {
1.166     www      3039:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3040:     if (!defined($username)  && !defined($domain)) {
                   3041:         return;
                   3042:     }
1.892     amueller 3043:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3044: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3045: }
                   3046: 
                   3047: # ------------------------------------------------------------ Syllabus Wrapper
                   3048: 
                   3049: sub syllabuswrapper {
1.707     bisitz   3050:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3051:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3052: }
1.14      harris41 3053: 
1.802     bisitz   3054: # -----------------------------------------------------------------------------
                   3055: 
1.208     matthew  3056: sub track_student_link {
1.887     raeburn  3057:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3058:     my $link ="/adm/trackstudent?";
1.208     matthew  3059:     my $title = 'View recent activity';
                   3060:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3061:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3062:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3063:         $title .= ' of this student';
1.268     albertel 3064:     } 
1.208     matthew  3065:     if (defined($target) && $target !~ /^\s*$/) {
                   3066:         $target = qq{target="$target"};
                   3067:     } else {
                   3068:         $target = '';
                   3069:     }
1.268     albertel 3070:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3071:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3072:     $title = &mt($title);
                   3073:     $linktext = &mt($linktext);
1.448     albertel 3074:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3075: 	&help_open_topic('View_recent_activity');
1.208     matthew  3076: }
                   3077: 
1.781     raeburn  3078: sub slot_reservations_link {
                   3079:     my ($linktext,$sname,$sdom,$target) = @_;
                   3080:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3081:     my $title = 'View slot reservation history';
                   3082:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3083:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3084:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3085:         $title .= ' of this student';
                   3086:     }
                   3087:     if (defined($target) && $target !~ /^\s*$/) {
                   3088:         $target = qq{target="$target"};
                   3089:     } else {
                   3090:         $target = '';
                   3091:     }
                   3092:     $title = &mt($title);
                   3093:     $linktext = &mt($linktext);
                   3094:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3095: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3096: 
                   3097: }
                   3098: 
1.508     www      3099: # ===================================================== Display a student photo
                   3100: 
                   3101: 
1.509     albertel 3102: sub student_image_tag {
1.508     www      3103:     my ($domain,$user)=@_;
                   3104:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3105:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3106: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3107:     } else {
                   3108: 	return '';
                   3109:     }
                   3110: }
                   3111: 
1.112     bowersj2 3112: =pod
                   3113: 
                   3114: =back
                   3115: 
                   3116: =head1 Access .tab File Data
                   3117: 
                   3118: =over 4
                   3119: 
1.648     raeburn  3120: =item * &languageids() 
1.112     bowersj2 3121: 
                   3122: returns list of all language ids
                   3123: 
                   3124: =cut
                   3125: 
1.14      harris41 3126: sub languageids {
1.16      harris41 3127:     return sort(keys(%language));
1.14      harris41 3128: }
                   3129: 
1.112     bowersj2 3130: =pod
                   3131: 
1.648     raeburn  3132: =item * &languagedescription() 
1.112     bowersj2 3133: 
                   3134: returns description of a specified language id
                   3135: 
                   3136: =cut
                   3137: 
1.14      harris41 3138: sub languagedescription {
1.125     www      3139:     my $code=shift;
                   3140:     return  ($supported_language{$code}?'* ':'').
                   3141:             $language{$code}.
1.126     www      3142: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3143: }
                   3144: 
                   3145: sub plainlanguagedescription {
                   3146:     my $code=shift;
                   3147:     return $language{$code};
                   3148: }
                   3149: 
                   3150: sub supportedlanguagecode {
                   3151:     my $code=shift;
                   3152:     return $supported_language{$code};
1.97      www      3153: }
                   3154: 
1.112     bowersj2 3155: =pod
                   3156: 
1.648     raeburn  3157: =item * &copyrightids() 
1.112     bowersj2 3158: 
                   3159: returns list of all copyrights
                   3160: 
                   3161: =cut
                   3162: 
                   3163: sub copyrightids {
                   3164:     return sort(keys(%cprtag));
                   3165: }
                   3166: 
                   3167: =pod
                   3168: 
1.648     raeburn  3169: =item * &copyrightdescription() 
1.112     bowersj2 3170: 
                   3171: returns description of a specified copyright id
                   3172: 
                   3173: =cut
                   3174: 
                   3175: sub copyrightdescription {
1.166     www      3176:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3177: }
1.197     matthew  3178: 
                   3179: =pod
                   3180: 
1.648     raeburn  3181: =item * &source_copyrightids() 
1.192     taceyjo1 3182: 
                   3183: returns list of all source copyrights
                   3184: 
                   3185: =cut
                   3186: 
                   3187: sub source_copyrightids {
                   3188:     return sort(keys(%scprtag));
                   3189: }
                   3190: 
                   3191: =pod
                   3192: 
1.648     raeburn  3193: =item * &source_copyrightdescription() 
1.192     taceyjo1 3194: 
                   3195: returns description of a specified source copyright id
                   3196: 
                   3197: =cut
                   3198: 
                   3199: sub source_copyrightdescription {
                   3200:     return &mt($scprtag{shift(@_)});
                   3201: }
1.112     bowersj2 3202: 
                   3203: =pod
                   3204: 
1.648     raeburn  3205: =item * &filecategories() 
1.112     bowersj2 3206: 
                   3207: returns list of all file categories
                   3208: 
                   3209: =cut
                   3210: 
                   3211: sub filecategories {
                   3212:     return sort(keys(%category_extensions));
                   3213: }
                   3214: 
                   3215: =pod
                   3216: 
1.648     raeburn  3217: =item * &filecategorytypes() 
1.112     bowersj2 3218: 
                   3219: returns list of file types belonging to a given file
                   3220: category
                   3221: 
                   3222: =cut
                   3223: 
                   3224: sub filecategorytypes {
1.356     albertel 3225:     my ($cat) = @_;
                   3226:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3227: }
                   3228: 
                   3229: =pod
                   3230: 
1.648     raeburn  3231: =item * &fileembstyle() 
1.112     bowersj2 3232: 
                   3233: returns embedding style for a specified file type
                   3234: 
                   3235: =cut
                   3236: 
                   3237: sub fileembstyle {
                   3238:     return $fe{lc(shift(@_))};
1.169     www      3239: }
                   3240: 
1.351     www      3241: sub filemimetype {
                   3242:     return $fm{lc(shift(@_))};
                   3243: }
                   3244: 
1.169     www      3245: 
                   3246: sub filecategoryselect {
                   3247:     my ($name,$value)=@_;
1.189     matthew  3248:     return &select_form($value,$name,
1.970     raeburn  3249:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3250: }
                   3251: 
                   3252: =pod
                   3253: 
1.648     raeburn  3254: =item * &filedescription() 
1.112     bowersj2 3255: 
                   3256: returns description for a specified file type
                   3257: 
                   3258: =cut
                   3259: 
                   3260: sub filedescription {
1.188     matthew  3261:     my $file_description = $fd{lc(shift())};
                   3262:     $file_description =~ s:([\[\]]):~$1:g;
                   3263:     return &mt($file_description);
1.112     bowersj2 3264: }
                   3265: 
                   3266: =pod
                   3267: 
1.648     raeburn  3268: =item * &filedescriptionex() 
1.112     bowersj2 3269: 
                   3270: returns description for a specified file type with
                   3271: extra formatting
                   3272: 
                   3273: =cut
                   3274: 
                   3275: sub filedescriptionex {
                   3276:     my $ex=shift;
1.188     matthew  3277:     my $file_description = $fd{lc($ex)};
                   3278:     $file_description =~ s:([\[\]]):~$1:g;
                   3279:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3280: }
                   3281: 
                   3282: # End of .tab access
                   3283: =pod
                   3284: 
                   3285: =back
                   3286: 
                   3287: =cut
                   3288: 
                   3289: # ------------------------------------------------------------------ File Types
                   3290: sub fileextensions {
                   3291:     return sort(keys(%fe));
                   3292: }
                   3293: 
1.97      www      3294: # ----------------------------------------------------------- Display Languages
                   3295: # returns a hash with all desired display languages
                   3296: #
                   3297: 
                   3298: sub display_languages {
                   3299:     my %languages=();
1.695     raeburn  3300:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3301: 	$languages{$lang}=1;
1.97      www      3302:     }
                   3303:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3304:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3305: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3306: 	    $languages{$lang}=1;
1.97      www      3307:         }
                   3308:     }
                   3309:     return %languages;
1.14      harris41 3310: }
                   3311: 
1.582     albertel 3312: sub languages {
                   3313:     my ($possible_langs) = @_;
1.695     raeburn  3314:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3315:     if (!ref($possible_langs)) {
                   3316: 	if( wantarray ) {
                   3317: 	    return @preferred_langs;
                   3318: 	} else {
                   3319: 	    return $preferred_langs[0];
                   3320: 	}
                   3321:     }
                   3322:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3323:     my @preferred_possibilities;
                   3324:     foreach my $preferred_lang (@preferred_langs) {
                   3325: 	if (exists($possibilities{$preferred_lang})) {
                   3326: 	    push(@preferred_possibilities, $preferred_lang);
                   3327: 	}
                   3328:     }
                   3329:     if( wantarray ) {
                   3330: 	return @preferred_possibilities;
                   3331:     }
                   3332:     return $preferred_possibilities[0];
                   3333: }
                   3334: 
1.742     raeburn  3335: sub user_lang {
                   3336:     my ($touname,$toudom,$fromcid) = @_;
                   3337:     my @userlangs;
                   3338:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3339:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3340:                     $env{'course.'.$fromcid.'.languages'}));
                   3341:     } else {
                   3342:         my %langhash = &getlangs($touname,$toudom);
                   3343:         if ($langhash{'languages'} ne '') {
                   3344:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3345:         } else {
                   3346:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3347:             if ($domdefs{'lang_def'} ne '') {
                   3348:                 @userlangs = ($domdefs{'lang_def'});
                   3349:             }
                   3350:         }
                   3351:     }
                   3352:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3353:     my $user_lh = Apache::localize->get_handle(@languages);
                   3354:     return $user_lh;
                   3355: }
                   3356: 
                   3357: 
1.112     bowersj2 3358: ###############################################################
                   3359: ##               Student Answer Attempts                     ##
                   3360: ###############################################################
                   3361: 
                   3362: =pod
                   3363: 
                   3364: =head1 Alternate Problem Views
                   3365: 
                   3366: =over 4
                   3367: 
1.648     raeburn  3368: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3369:     $getattempt, $regexp, $gradesub)
                   3370: 
                   3371: Return string with previous attempt on problem. Arguments:
                   3372: 
                   3373: =over 4
                   3374: 
                   3375: =item * $symb: Problem, including path
                   3376: 
                   3377: =item * $username: username of the desired student
                   3378: 
                   3379: =item * $domain: domain of the desired student
1.14      harris41 3380: 
1.112     bowersj2 3381: =item * $course: Course ID
1.14      harris41 3382: 
1.112     bowersj2 3383: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3384:     something
1.14      harris41 3385: 
1.112     bowersj2 3386: =item * $regexp: if string matches this regexp, the string will be
                   3387:     sent to $gradesub
1.14      harris41 3388: 
1.112     bowersj2 3389: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3390: 
1.112     bowersj2 3391: =back
1.14      harris41 3392: 
1.112     bowersj2 3393: The output string is a table containing all desired attempts, if any.
1.16      harris41 3394: 
1.112     bowersj2 3395: =cut
1.1       albertel 3396: 
                   3397: sub get_previous_attempt {
1.43      ng       3398:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3399:   my $prevattempts='';
1.43      ng       3400:   no strict 'refs';
1.1       albertel 3401:   if ($symb) {
1.3       albertel 3402:     my (%returnhash)=
                   3403:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3404:     if ($returnhash{'version'}) {
                   3405:       my %lasthash=();
                   3406:       my $version;
                   3407:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3408:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3409: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3410:         }
1.1       albertel 3411:       }
1.596     albertel 3412:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3413:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3414:       my (%typeparts,%lasthidden);
1.945     raeburn  3415:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3416:       foreach my $key (sort(keys(%lasthash))) {
                   3417: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3418: 	if ($#parts > 0) {
1.31      albertel 3419: 	  my $data=$parts[-1];
                   3420: 	  pop(@parts);
1.945     raeburn  3421:           if ($data eq 'type') {
                   3422:               unless ($showsurv) {
                   3423:                   my $id = join(',',@parts);
                   3424:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3425:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3426:                       $lasthidden{$ign.'.'.$id} = 1;
                   3427:                   }
1.945     raeburn  3428:               }
                   3429:               delete($lasthash{$key});
                   3430:           } else {
                   3431: 	      $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
                   3432:           }
1.31      albertel 3433: 	} else {
1.41      ng       3434: 	  if ($#parts == 0) {
                   3435: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3436: 	  } else {
                   3437: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3438: 	  }
1.31      albertel 3439: 	}
1.16      harris41 3440:       }
1.596     albertel 3441:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3442:       if ($getattempt eq '') {
                   3443: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3444:             my @hidden;
                   3445:             if (%typeparts) {
                   3446:                 foreach my $id (keys(%typeparts)) {
                   3447:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3448:                         push(@hidden,$id);
                   3449:                     }
                   3450:                 }
                   3451:             }
                   3452:             $prevattempts.=&start_data_table_row().
                   3453:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3454:             if (@hidden) {
                   3455:                 foreach my $key (sort(keys(%lasthash))) {
                   3456:                     my $hide;
                   3457:                     foreach my $id (@hidden) {
                   3458:                         if ($key =~ /^\Q$id\E/) {
                   3459:                             $hide = 1;
                   3460:                             last;
                   3461:                         }
                   3462:                     }
                   3463:                     if ($hide) {
                   3464:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3465:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3466:                             my $value = &format_previous_attempt_value($key,
                   3467:                                              $returnhash{$version.':'.$key});
                   3468:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3469:                         } else {
                   3470:                             $prevattempts.='<td>&nbsp;</td>';
                   3471:                         }
                   3472:                     } else {
                   3473:                         if ($key =~ /\./) {
                   3474:                             my $value = &format_previous_attempt_value($key,
                   3475:                                               $returnhash{$version.':'.$key});
                   3476:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3477:                         } else {
                   3478:                             $prevattempts.='<td>&nbsp;</td>';
                   3479:                         }
                   3480:                     }
                   3481:                 }
                   3482:             } else {
                   3483: 	        foreach my $key (sort(keys(%lasthash))) {
                   3484: 		    my $value = &format_previous_attempt_value($key,
                   3485: 			            $returnhash{$version.':'.$key});
                   3486: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3487: 	        }
                   3488:             }
                   3489: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3490: 	 }
1.1       albertel 3491:       }
1.945     raeburn  3492:       my @currhidden = keys(%lasthidden);
1.596     albertel 3493:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3494:       foreach my $key (sort(keys(%lasthash))) {
1.945     raeburn  3495:           if (%typeparts) {
                   3496:               my $hidden;
                   3497:               foreach my $id (@currhidden) {
                   3498:                   if ($key =~ /^\Q$id\E/) {
                   3499:                       $hidden = 1;
                   3500:                       last;
                   3501:                   }
                   3502:               }
                   3503:               if ($hidden) {
                   3504:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3505:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3506:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3507:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3508:                           $value = &$gradesub($value);
                   3509:                       }
                   3510:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3511:                   } else {
                   3512:                       $prevattempts.='<td>&nbsp;</td>';
                   3513:                   }
                   3514:               } else {
                   3515:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3516:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3517:                       $value = &$gradesub($value);
                   3518:                   }
                   3519:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3520:               }
                   3521:           } else {
                   3522: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3523: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3524:                   $value = &$gradesub($value);
                   3525:               }
                   3526: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3527:           }
1.16      harris41 3528:       }
1.596     albertel 3529:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3530:     } else {
1.596     albertel 3531:       $prevattempts=
                   3532: 	  &start_data_table().&start_data_table_row().
                   3533: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3534: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3535:     }
                   3536:   } else {
1.596     albertel 3537:     $prevattempts=
                   3538: 	  &start_data_table().&start_data_table_row().
                   3539: 	  '<td>'.&mt('No data.').'</td>'.
                   3540: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3541:   }
1.10      albertel 3542: }
                   3543: 
1.581     albertel 3544: sub format_previous_attempt_value {
                   3545:     my ($key,$value) = @_;
                   3546:     if ($key =~ /timestamp/) {
                   3547: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3548:     } elsif (ref($value) eq 'ARRAY') {
                   3549: 	$value = '('.join(', ', @{ $value }).')';
                   3550:     } else {
                   3551: 	$value = &unescape($value);
                   3552:     }
                   3553:     return $value;
                   3554: }
                   3555: 
                   3556: 
1.107     albertel 3557: sub relative_to_absolute {
                   3558:     my ($url,$output)=@_;
                   3559:     my $parser=HTML::TokeParser->new(\$output);
                   3560:     my $token;
                   3561:     my $thisdir=$url;
                   3562:     my @rlinks=();
                   3563:     while ($token=$parser->get_token) {
                   3564: 	if ($token->[0] eq 'S') {
                   3565: 	    if ($token->[1] eq 'a') {
                   3566: 		if ($token->[2]->{'href'}) {
                   3567: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3568: 		}
                   3569: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3570: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3571: 	    } elsif ($token->[1] eq 'base') {
                   3572: 		$thisdir=$token->[2]->{'href'};
                   3573: 	    }
                   3574: 	}
                   3575:     }
                   3576:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3577:     foreach my $link (@rlinks) {
1.726     raeburn  3578: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3579: 		($link=~/^\//) ||
                   3580: 		($link=~/^javascript:/i) ||
                   3581: 		($link=~/^mailto:/i) ||
                   3582: 		($link=~/^\#/)) {
                   3583: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3584: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3585: 	}
                   3586:     }
                   3587: # -------------------------------------------------- Deal with Applet codebases
                   3588:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3589:     return $output;
                   3590: }
                   3591: 
1.112     bowersj2 3592: =pod
                   3593: 
1.648     raeburn  3594: =item * &get_student_view()
1.112     bowersj2 3595: 
                   3596: show a snapshot of what student was looking at
                   3597: 
                   3598: =cut
                   3599: 
1.10      albertel 3600: sub get_student_view {
1.186     albertel 3601:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3602:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3603:   my (%form);
1.10      albertel 3604:   my @elements=('symb','courseid','domain','username');
                   3605:   foreach my $element (@elements) {
1.186     albertel 3606:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3607:   }
1.186     albertel 3608:   if (defined($moreenv)) {
                   3609:       %form=(%form,%{$moreenv});
                   3610:   }
1.236     albertel 3611:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3612:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3613:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3614:   $userview=~s/\<body[^\>]*\>//gi;
                   3615:   $userview=~s/\<\/body\>//gi;
                   3616:   $userview=~s/\<html\>//gi;
                   3617:   $userview=~s/\<\/html\>//gi;
                   3618:   $userview=~s/\<head\>//gi;
                   3619:   $userview=~s/\<\/head\>//gi;
                   3620:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3621:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3622:   if (wantarray) {
                   3623:      return ($userview,$response);
                   3624:   } else {
                   3625:      return $userview;
                   3626:   }
                   3627: }
                   3628: 
                   3629: sub get_student_view_with_retries {
                   3630:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3631: 
                   3632:     my $ok = 0;                 # True if we got a good response.
                   3633:     my $content;
                   3634:     my $response;
                   3635: 
                   3636:     # Try to get the student_view done. within the retries count:
                   3637:     
                   3638:     do {
                   3639:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3640:          $ok      = $response->is_success;
                   3641:          if (!$ok) {
                   3642:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3643:          }
                   3644:          $retries--;
                   3645:     } while (!$ok && ($retries > 0));
                   3646:     
                   3647:     if (!$ok) {
                   3648:        $content = '';          # On error return an empty content.
                   3649:     }
1.651     www      3650:     if (wantarray) {
                   3651:        return ($content, $response);
                   3652:     } else {
                   3653:        return $content;
                   3654:     }
1.11      albertel 3655: }
                   3656: 
1.112     bowersj2 3657: =pod
                   3658: 
1.648     raeburn  3659: =item * &get_student_answers() 
1.112     bowersj2 3660: 
                   3661: show a snapshot of how student was answering problem
                   3662: 
                   3663: =cut
                   3664: 
1.11      albertel 3665: sub get_student_answers {
1.100     sakharuk 3666:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3667:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3668:   my (%moreenv);
1.11      albertel 3669:   my @elements=('symb','courseid','domain','username');
                   3670:   foreach my $element (@elements) {
1.186     albertel 3671:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3672:   }
1.186     albertel 3673:   $moreenv{'grade_target'}='answer';
                   3674:   %moreenv=(%form,%moreenv);
1.497     raeburn  3675:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3676:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3677:   return $userview;
1.1       albertel 3678: }
1.116     albertel 3679: 
                   3680: =pod
                   3681: 
                   3682: =item * &submlink()
                   3683: 
1.242     albertel 3684: Inputs: $text $uname $udom $symb $target
1.116     albertel 3685: 
                   3686: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3687: 
                   3688: =cut
                   3689: 
                   3690: ###############################################
                   3691: sub submlink {
1.242     albertel 3692:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3693:     if (!($uname && $udom)) {
                   3694: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3695: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3696: 	if (!$symb) { $symb=$cursymb; }
                   3697:     }
1.254     matthew  3698:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3699:     $symb=&escape($symb);
1.960     bisitz   3700:     if ($target) { $target=" target=\"$target\""; }
                   3701:     return
                   3702:         '<a href="/adm/grades?command=submission'.
                   3703:         '&amp;symb='.$symb.
                   3704:         '&amp;student='.$uname.
                   3705:         '&amp;userdom='.$udom.'"'.
                   3706:         $target.'>'.$text.'</a>';
1.242     albertel 3707: }
                   3708: ##############################################
                   3709: 
                   3710: =pod
                   3711: 
                   3712: =item * &pgrdlink()
                   3713: 
                   3714: Inputs: $text $uname $udom $symb $target
                   3715: 
                   3716: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3717: 
                   3718: =cut
                   3719: 
                   3720: ###############################################
                   3721: sub pgrdlink {
                   3722:     my $link=&submlink(@_);
                   3723:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3724:     return $link;
                   3725: }
                   3726: ##############################################
                   3727: 
                   3728: =pod
                   3729: 
                   3730: =item * &pprmlink()
                   3731: 
                   3732: Inputs: $text $uname $udom $symb $target
                   3733: 
                   3734: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3735: student and a specific resource
1.242     albertel 3736: 
                   3737: =cut
                   3738: 
                   3739: ###############################################
                   3740: sub pprmlink {
                   3741:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3742:     if (!($uname && $udom)) {
                   3743: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3744: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3745: 	if (!$symb) { $symb=$cursymb; }
                   3746:     }
1.254     matthew  3747:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3748:     $symb=&escape($symb);
1.242     albertel 3749:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3750:     return '<a href="/adm/parmset?command=set&amp;'.
                   3751: 	'symb='.$symb.'&amp;uname='.$uname.
                   3752: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3753: }
                   3754: ##############################################
1.37      matthew  3755: 
1.112     bowersj2 3756: =pod
                   3757: 
                   3758: =back
                   3759: 
                   3760: =cut
                   3761: 
1.37      matthew  3762: ###############################################
1.51      www      3763: 
                   3764: 
                   3765: sub timehash {
1.687     raeburn  3766:     my ($thistime) = @_;
                   3767:     my $timezone = &Apache::lonlocal::gettimezone();
                   3768:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3769:                      ->set_time_zone($timezone);
                   3770:     my $wday = $dt->day_of_week();
                   3771:     if ($wday == 7) { $wday = 0; }
                   3772:     return ( 'second' => $dt->second(),
                   3773:              'minute' => $dt->minute(),
                   3774:              'hour'   => $dt->hour(),
                   3775:              'day'     => $dt->day_of_month(),
                   3776:              'month'   => $dt->month(),
                   3777:              'year'    => $dt->year(),
                   3778:              'weekday' => $wday,
                   3779:              'dayyear' => $dt->day_of_year(),
                   3780:              'dlsav'   => $dt->is_dst() );
1.51      www      3781: }
                   3782: 
1.370     www      3783: sub utc_string {
                   3784:     my ($date)=@_;
1.371     www      3785:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3786: }
                   3787: 
1.51      www      3788: sub maketime {
                   3789:     my %th=@_;
1.687     raeburn  3790:     my ($epoch_time,$timezone,$dt);
                   3791:     $timezone = &Apache::lonlocal::gettimezone();
                   3792:     eval {
                   3793:         $dt = DateTime->new( year   => $th{'year'},
                   3794:                              month  => $th{'month'},
                   3795:                              day    => $th{'day'},
                   3796:                              hour   => $th{'hour'},
                   3797:                              minute => $th{'minute'},
                   3798:                              second => $th{'second'},
                   3799:                              time_zone => $timezone,
                   3800:                          );
                   3801:     };
                   3802:     if (!$@) {
                   3803:         $epoch_time = $dt->epoch;
                   3804:         if ($epoch_time) {
                   3805:             return $epoch_time;
                   3806:         }
                   3807:     }
1.51      www      3808:     return POSIX::mktime(
                   3809:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3810:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3811: }
                   3812: 
                   3813: #########################################
1.51      www      3814: 
                   3815: sub findallcourses {
1.482     raeburn  3816:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3817:     my %roles;
                   3818:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3819:     my %courses;
1.51      www      3820:     my $now=time;
1.482     raeburn  3821:     if (!defined($uname)) {
                   3822:         $uname = $env{'user.name'};
                   3823:     }
                   3824:     if (!defined($udom)) {
                   3825:         $udom = $env{'user.domain'};
                   3826:     }
                   3827:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3828:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3829:         if (!%roles) {
                   3830:             %roles = (
                   3831:                        cc => 1,
1.907     raeburn  3832:                        co => 1,
1.482     raeburn  3833:                        in => 1,
                   3834:                        ep => 1,
                   3835:                        ta => 1,
                   3836:                        cr => 1,
                   3837:                        st => 1,
                   3838:              );
                   3839:         }
                   3840:         foreach my $entry (keys(%roleshash)) {
                   3841:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3842:             if ($trole =~ /^cr/) { 
                   3843:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3844:             } else {
                   3845:                 next if (!exists($roles{$trole}));
                   3846:             }
                   3847:             if ($tend) {
                   3848:                 next if ($tend < $now);
                   3849:             }
                   3850:             if ($tstart) {
                   3851:                 next if ($tstart > $now);
                   3852:             }
                   3853:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3854:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3855:             if ($secpart eq '') {
                   3856:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3857:                 $sec = 'none';
                   3858:                 $realsec = '';
                   3859:             } else {
                   3860:                 $cnum = $cnumpart;
                   3861:                 ($sec,$role) = split(/_/,$secpart);
                   3862:                 $realsec = $sec;
1.490     raeburn  3863:             }
1.482     raeburn  3864:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3865:         }
                   3866:     } else {
                   3867:         foreach my $key (keys(%env)) {
1.483     albertel 3868: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3869:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3870: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3871: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3872: 	        next if (%roles && !exists($roles{$role}));
                   3873: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3874:                 my $active=1;
                   3875:                 if ($starttime) {
                   3876: 		    if ($now<$starttime) { $active=0; }
                   3877:                 }
                   3878:                 if ($endtime) {
                   3879:                     if ($now>$endtime) { $active=0; }
                   3880:                 }
                   3881:                 if ($active) {
                   3882:                     if ($sec eq '') {
                   3883:                         $sec = 'none';
                   3884:                     }
                   3885:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3886:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3887:                 }
                   3888:             }
1.51      www      3889:         }
                   3890:     }
1.474     raeburn  3891:     return %courses;
1.51      www      3892: }
1.37      matthew  3893: 
1.54      www      3894: ###############################################
1.474     raeburn  3895: 
                   3896: sub blockcheck {
1.482     raeburn  3897:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3898: 
                   3899:     if (!defined($udom)) {
                   3900:         $udom = $env{'user.domain'};
                   3901:     }
                   3902:     if (!defined($uname)) {
                   3903:         $uname = $env{'user.name'};
                   3904:     }
                   3905: 
                   3906:     # If uname and udom are for a course, check for blocks in the course.
                   3907: 
                   3908:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3909:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3910:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3911:         return ($startblock,$endblock);
                   3912:     }
1.474     raeburn  3913: 
1.502     raeburn  3914:     my $startblock = 0;
                   3915:     my $endblock = 0;
1.482     raeburn  3916:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3917: 
1.490     raeburn  3918:     # If uname is for a user, and activity is course-specific, i.e.,
                   3919:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3920: 
1.490     raeburn  3921:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3922:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3923:         foreach my $key (keys(%live_courses)) {
                   3924:             if ($key ne $env{'request.course.id'}) {
                   3925:                 delete($live_courses{$key});
                   3926:             }
                   3927:         }
                   3928:     }
                   3929: 
                   3930:     my $otheruser = 0;
                   3931:     my %own_courses;
                   3932:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3933:         # Resource belongs to user other than current user.
                   3934:         $otheruser = 1;
                   3935:         # Gather courses for current user
                   3936:         %own_courses = 
                   3937:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3938:     }
                   3939: 
                   3940:     # Gather active course roles - course coordinator, instructor, 
                   3941:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3942: 
                   3943:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3944:         my ($cdom,$cnum);
                   3945:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3946:             $cdom = $env{'course.'.$course.'.domain'};
                   3947:             $cnum = $env{'course.'.$course.'.num'};
                   3948:         } else {
1.490     raeburn  3949:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3950:         }
                   3951:         my $no_ownblock = 0;
                   3952:         my $no_userblock = 0;
1.533     raeburn  3953:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3954:             # Check if current user has 'evb' priv for this
                   3955:             if (defined($own_courses{$course})) {
                   3956:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3957:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3958:                     if ($sec ne 'none') {
                   3959:                         $checkrole .= '/'.$sec;
                   3960:                     }
                   3961:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3962:                         $no_ownblock = 1;
                   3963:                         last;
                   3964:                     }
                   3965:                 }
                   3966:             }
                   3967:             # if they have 'evb' priv and are currently not playing student
                   3968:             next if (($no_ownblock) &&
                   3969:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3970:         }
1.474     raeburn  3971:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3972:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3973:             if ($sec ne 'none') {
1.482     raeburn  3974:                 $checkrole .= '/'.$sec;
1.474     raeburn  3975:             }
1.490     raeburn  3976:             if ($otheruser) {
                   3977:                 # Resource belongs to user other than current user.
                   3978:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3979:                 my ($trole,$tdom,$tnum,$tsec);
                   3980:                 my $entry = $live_courses{$course}{$sec};
                   3981:                 if ($entry =~ /^cr/) {
                   3982:                     ($trole,$tdom,$tnum,$tsec) = 
                   3983:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3984:                 } else {
                   3985:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3986:                 }
                   3987:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3988:                 $area = '/'.$tdom.'/'.$tnum;
                   3989:                 $trest = $tnum;
                   3990:                 if ($tsec ne '') {
                   3991:                     $area .= '/'.$tsec;
                   3992:                     $trest .= '/'.$tsec;
                   3993:                 }
                   3994:                 $spec = $trole.'.'.$area;
                   3995:                 if ($trole =~ /^cr/) {
                   3996:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3997:                                                       $tdom,$spec,$trest,$area);
                   3998:                 } else {
                   3999:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4000:                                                        $tdom,$spec,$trest,$area);
                   4001:                 }
                   4002:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  4003:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4004:                     if ($1) {
                   4005:                         $no_userblock = 1;
                   4006:                         last;
                   4007:                     }
                   4008:                 }
1.490     raeburn  4009:             } else {
                   4010:                 # Resource belongs to current user
                   4011:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4012:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4013:                     $no_ownblock = 1;
                   4014:                     last;
                   4015:                 }
1.474     raeburn  4016:             }
                   4017:         }
                   4018:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4019:         next if (($no_ownblock) &&
1.491     albertel 4020:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4021:         next if ($no_userblock);
1.474     raeburn  4022: 
1.866     kalberla 4023:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4024:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4025:         
                   4026:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   4027:         if (($start != 0) && 
                   4028:             (($startblock == 0) || ($startblock > $start))) {
                   4029:             $startblock = $start;
                   4030:         }
                   4031:         if (($end != 0)  &&
                   4032:             (($endblock == 0) || ($endblock < $end))) {
                   4033:             $endblock = $end;
                   4034:         }
1.490     raeburn  4035:     }
                   4036:     return ($startblock,$endblock);
                   4037: }
                   4038: 
                   4039: sub get_blocks {
                   4040:     my ($setters,$activity,$cdom,$cnum) = @_;
                   4041:     my $startblock = 0;
                   4042:     my $endblock = 0;
                   4043:     my $course = $cdom.'_'.$cnum;
                   4044:     $setters->{$course} = {};
                   4045:     $setters->{$course}{'staff'} = [];
                   4046:     $setters->{$course}{'times'} = [];
                   4047:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   4048:     foreach my $record (keys(%records)) {
                   4049:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   4050:         if ($start <= time && $end >= time) {
                   4051:             my ($staff_name,$staff_dom,$title,$blocks) =
                   4052:                 &parse_block_record($records{$record});
                   4053:             if ($blocks->{$activity} eq 'on') {
                   4054:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4055:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 4056:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   4057:                     $startblock = $start;
1.490     raeburn  4058:                 }
1.491     albertel 4059:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   4060:                     $endblock = $end;
1.474     raeburn  4061:                 }
                   4062:             }
                   4063:         }
                   4064:     }
                   4065:     return ($startblock,$endblock);
                   4066: }
                   4067: 
                   4068: sub parse_block_record {
                   4069:     my ($record) = @_;
                   4070:     my ($setuname,$setudom,$title,$blocks);
                   4071:     if (ref($record) eq 'HASH') {
                   4072:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4073:         $title = &unescape($record->{'event'});
                   4074:         $blocks = $record->{'blocks'};
                   4075:     } else {
                   4076:         my @data = split(/:/,$record,3);
                   4077:         if (scalar(@data) eq 2) {
                   4078:             $title = $data[1];
                   4079:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4080:         } else {
                   4081:             ($setuname,$setudom,$title) = @data;
                   4082:         }
                   4083:         $blocks = { 'com' => 'on' };
                   4084:     }
                   4085:     return ($setuname,$setudom,$title,$blocks);
                   4086: }
                   4087: 
1.854     kalberla 4088: sub blocking_status {
                   4089:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4090:   my %setters;
1.890     droeschl 4091: 
                   4092:   # check for active blocking
1.867     kalberla 4093:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4094: 
1.890     droeschl 4095:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4096: 
                   4097:   # caller just wants to know whether a block is active
                   4098:   if (!wantarray) { return $blocked; }
                   4099: 
                   4100:   # build a link to a popup window containing the details
                   4101:   my $querystring  = "?activity=$activity";
                   4102:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4103:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4104:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4105: 
                   4106:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4107:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4108:         var options = "width=" + w + ",height=" + h + ",";
                   4109:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4110:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4111:         var newWin = window.open(url, wdwName, options);
                   4112:         newWin.focus();
                   4113:     }
1.890     droeschl 4114: END_MYBLOCK
1.854     kalberla 4115: 
1.890     droeschl 4116:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4117:   
1.854     kalberla 4118:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4119:   my $text = mt('Communication Blocked');
                   4120: 
1.867     kalberla 4121:   $output .= <<"END_BLOCK";
                   4122: <div class='LC_comblock'>
1.869     kalberla 4123:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4124:   title='$text'>
                   4125:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4126:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4127:   title='$text'>$text</a>
1.867     kalberla 4128: </div>
                   4129: 
                   4130: END_BLOCK
1.474     raeburn  4131: 
1.854     kalberla 4132:   return ($blocked, $output);
                   4133: }
1.490     raeburn  4134: 
1.60      matthew  4135: ###############################################
                   4136: 
1.682     raeburn  4137: sub check_ip_acc {
                   4138:     my ($acc)=@_;
                   4139:     &Apache::lonxml::debug("acc is $acc");
                   4140:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4141:         return 1;
                   4142:     }
                   4143:     my $allowed=0;
                   4144:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4145: 
                   4146:     my $name;
                   4147:     foreach my $pattern (split(',',$acc)) {
                   4148:         $pattern =~ s/^\s*//;
                   4149:         $pattern =~ s/\s*$//;
                   4150:         if ($pattern =~ /\*$/) {
                   4151:             #35.8.*
                   4152:             $pattern=~s/\*//;
                   4153:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4154:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4155:             #35.8.3.[34-56]
                   4156:             my $low=$2;
                   4157:             my $high=$3;
                   4158:             $pattern=$1;
                   4159:             if ($ip =~ /^\Q$pattern\E/) {
                   4160:                 my $last=(split(/\./,$ip))[3];
                   4161:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4162:             }
                   4163:         } elsif ($pattern =~ /^\*/) {
                   4164:             #*.msu.edu
                   4165:             $pattern=~s/\*//;
                   4166:             if (!defined($name)) {
                   4167:                 use Socket;
                   4168:                 my $netaddr=inet_aton($ip);
                   4169:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4170:             }
                   4171:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4172:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4173:             #127.0.0.1
                   4174:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4175:         } else {
                   4176:             #some.name.com
                   4177:             if (!defined($name)) {
                   4178:                 use Socket;
                   4179:                 my $netaddr=inet_aton($ip);
                   4180:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4181:             }
                   4182:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4183:         }
                   4184:         if ($allowed) { last; }
                   4185:     }
                   4186:     return $allowed;
                   4187: }
                   4188: 
                   4189: ###############################################
                   4190: 
1.60      matthew  4191: =pod
                   4192: 
1.112     bowersj2 4193: =head1 Domain Template Functions
                   4194: 
                   4195: =over 4
                   4196: 
                   4197: =item * &determinedomain()
1.60      matthew  4198: 
                   4199: Inputs: $domain (usually will be undef)
                   4200: 
1.63      www      4201: Returns: Determines which domain should be used for designs
1.60      matthew  4202: 
                   4203: =cut
1.54      www      4204: 
1.60      matthew  4205: ###############################################
1.63      www      4206: sub determinedomain {
                   4207:     my $domain=shift;
1.531     albertel 4208:     if (! $domain) {
1.60      matthew  4209:         # Determine domain if we have not been given one
1.893     raeburn  4210:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4211:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4212:         if ($env{'request.role.domain'}) { 
                   4213:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4214:         }
                   4215:     }
1.63      www      4216:     return $domain;
                   4217: }
                   4218: ###############################################
1.517     raeburn  4219: 
1.518     albertel 4220: sub devalidate_domconfig_cache {
                   4221:     my ($udom)=@_;
                   4222:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4223: }
                   4224: 
                   4225: # ---------------------- Get domain configuration for a domain
                   4226: sub get_domainconf {
                   4227:     my ($udom) = @_;
                   4228:     my $cachetime=1800;
                   4229:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4230:     if (defined($cached)) { return %{$result}; }
                   4231: 
                   4232:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4233: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4234:     my (%designhash,%legacy);
1.518     albertel 4235:     if (keys(%domconfig) > 0) {
                   4236:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4237:             if (keys(%{$domconfig{'login'}})) {
                   4238:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4239:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4240:                         if ($key eq 'loginvia') {
                   4241:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
                   4242:                                 my @ids = &Apache::lonnet::current_machine_ids();
                   4243:                                 foreach my $hostname (@ids) {
1.948     raeburn  4244:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4245:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4246:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4247:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4248:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4249: 
                   4250:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4251:                                             } else {
                   4252:                                                  $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   4253:                                             }
                   4254:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4255:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4256:                                             }
1.946     raeburn  4257:                                         }
                   4258:                                     }
                   4259:                                 }
                   4260:                             }
                   4261:                         } else {
                   4262:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4263:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4264:                                     $domconfig{'login'}{$key}{$img};
                   4265:                             }
1.699     raeburn  4266:                         }
                   4267:                     } else {
                   4268:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4269:                     }
1.632     raeburn  4270:                 }
                   4271:             } else {
                   4272:                 $legacy{'login'} = 1;
1.518     albertel 4273:             }
1.632     raeburn  4274:         } else {
                   4275:             $legacy{'login'} = 1;
1.518     albertel 4276:         }
                   4277:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4278:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4279:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4280:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4281:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4282:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4283:                         }
1.518     albertel 4284:                     }
                   4285:                 }
1.632     raeburn  4286:             } else {
                   4287:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4288:             }
1.632     raeburn  4289:         } else {
                   4290:             $legacy{'rolecolors'} = 1;
1.518     albertel 4291:         }
1.948     raeburn  4292:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4293:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4294:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4295:             }
                   4296:         }
1.632     raeburn  4297:         if (keys(%legacy) > 0) {
                   4298:             my %legacyhash = &get_legacy_domconf($udom);
                   4299:             foreach my $item (keys(%legacyhash)) {
                   4300:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4301:                     if ($legacy{'login'}) { 
                   4302:                         $designhash{$item} = $legacyhash{$item};
                   4303:                     }
                   4304:                 } else {
                   4305:                     if ($legacy{'rolecolors'}) {
                   4306:                         $designhash{$item} = $legacyhash{$item};
                   4307:                     }
1.518     albertel 4308:                 }
                   4309:             }
                   4310:         }
1.632     raeburn  4311:     } else {
                   4312:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4313:     }
                   4314:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4315: 				  $cachetime);
                   4316:     return %designhash;
                   4317: }
                   4318: 
1.632     raeburn  4319: sub get_legacy_domconf {
                   4320:     my ($udom) = @_;
                   4321:     my %legacyhash;
                   4322:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4323:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4324:     if (-e $designfile) {
                   4325:         if ( open (my $fh,"<$designfile") ) {
                   4326:             while (my $line = <$fh>) {
                   4327:                 next if ($line =~ /^\#/);
                   4328:                 chomp($line);
                   4329:                 my ($key,$val)=(split(/\=/,$line));
                   4330:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4331:             }
                   4332:             close($fh);
                   4333:         }
                   4334:     }
                   4335:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4336:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4337:     }
                   4338:     return %legacyhash;
                   4339: }
                   4340: 
1.63      www      4341: =pod
                   4342: 
1.112     bowersj2 4343: =item * &domainlogo()
1.63      www      4344: 
                   4345: Inputs: $domain (usually will be undef)
                   4346: 
                   4347: Returns: A link to a domain logo, if the domain logo exists.
                   4348: If the domain logo does not exist, a description of the domain.
                   4349: 
                   4350: =cut
1.112     bowersj2 4351: 
1.63      www      4352: ###############################################
                   4353: sub domainlogo {
1.517     raeburn  4354:     my $domain = &determinedomain(shift);
1.518     albertel 4355:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4356:     # See if there is a logo
                   4357:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4358:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4359:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4360: 	    if ($imgsrc =~ m{^/res/}) {
                   4361: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4362: 		&Apache::lonnet::repcopy($local_name);
                   4363: 	    }
                   4364: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4365:         } 
                   4366:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4367:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4368:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4369:     } else {
1.60      matthew  4370:         return '';
1.59      www      4371:     }
                   4372: }
1.63      www      4373: ##############################################
                   4374: 
                   4375: =pod
                   4376: 
1.112     bowersj2 4377: =item * &designparm()
1.63      www      4378: 
                   4379: Inputs: $which parameter; $domain (usually will be undef)
                   4380: 
                   4381: Returns: value of designparamter $which
                   4382: 
                   4383: =cut
1.112     bowersj2 4384: 
1.397     albertel 4385: 
1.400     albertel 4386: ##############################################
1.397     albertel 4387: sub designparm {
                   4388:     my ($which,$domain)=@_;
                   4389:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4390:         return $env{'environment.color.'.$which};
1.96      www      4391:     }
1.63      www      4392:     $domain=&determinedomain($domain);
1.518     albertel 4393:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4394:     my $output;
1.517     raeburn  4395:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4396:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4397:     } else {
1.520     raeburn  4398:         $output = $defaultdesign{$which};
                   4399:     }
                   4400:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4401:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4402:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4403:             if ($output =~ m{^/res/}) {
                   4404:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4405:                 &Apache::lonnet::repcopy($local_name);
                   4406:             }
1.520     raeburn  4407:             $output = &lonhttpdurl($output);
                   4408:         }
1.63      www      4409:     }
1.520     raeburn  4410:     return $output;
1.63      www      4411: }
1.59      www      4412: 
1.822     bisitz   4413: ##############################################
                   4414: =pod
                   4415: 
1.832     bisitz   4416: =item * &authorspace()
                   4417: 
                   4418: Inputs: ./.
                   4419: 
                   4420: Returns: Path to the Construction Space of the current user's
                   4421:          accessed author space
                   4422:          The author space will be that of the current user
                   4423:          when accessing the own author space
                   4424:          and that of the co-author/assistent co-author
                   4425:          when accessing the co-author's/assistent co-author's
                   4426:          space
                   4427: 
                   4428: =cut
                   4429: 
                   4430: sub authorspace {
                   4431:     my $caname = '';
                   4432:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4433:         (undef,$caname) =
                   4434:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4435:     } else {
                   4436:         $caname = $env{'user.name'};
                   4437:     }
                   4438:     return '/priv/'.$caname.'/';
                   4439: }
                   4440: 
                   4441: ##############################################
                   4442: =pod
                   4443: 
1.822     bisitz   4444: =item * &head_subbox()
                   4445: 
                   4446: Inputs: $content (contains HTML code with page functions, etc.)
                   4447: 
                   4448: Returns: HTML div with $content
                   4449:          To be included in page header
                   4450: 
                   4451: =cut
                   4452: 
                   4453: sub head_subbox {
                   4454:     my ($content)=@_;
                   4455:     my $output =
1.844     bisitz   4456:         '<div id="LC_head_subbox">'
1.822     bisitz   4457:        .$content
                   4458:        .'</div>'
                   4459: }
                   4460: 
                   4461: ##############################################
                   4462: =pod
                   4463: 
                   4464: =item * &CSTR_pageheader()
                   4465: 
                   4466: Inputs: ./.
                   4467: 
                   4468: Returns: HTML div with CSTR path and recent box
                   4469:          To be included on Construction Space pages
                   4470: 
                   4471: =cut
                   4472: 
                   4473: sub CSTR_pageheader {
                   4474:     # this is for resources; directories have customtitle, and crumbs
                   4475:             # and select recent are created in lonpubdir.pm  
                   4476:     my ($uname,$thisdisfn)=
                   4477:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4478:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4479:     $formaction=~s/\/+/\//g;
                   4480: 
                   4481:     my $parentpath = '';
                   4482:     my $lastitem = '';
                   4483:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4484:         $parentpath = $1;
                   4485:         $lastitem = $2;
                   4486:     } else {
                   4487:         $lastitem = $thisdisfn;
                   4488:     }
1.921     bisitz   4489: 
                   4490:     my $output =
1.822     bisitz   4491:          '<div>'
                   4492:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4493:         .'<b>'.&mt('Construction Space:').'</b> '
                   4494:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4495:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
                   4496:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
                   4497: 
                   4498:     if ($lastitem) {
                   4499:         $output .=
                   4500:              '<span class="LC_filename">'
                   4501:             .$lastitem
                   4502:             .'</span>';
                   4503:     }
                   4504:     $output .=
                   4505:          '<br />'
1.822     bisitz   4506:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4507:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4508:         .'</form>'
                   4509:         .&Apache::lonmenu::constspaceform()
                   4510:         .'</div>';
1.921     bisitz   4511: 
                   4512:     return $output;
1.822     bisitz   4513: }
                   4514: 
1.60      matthew  4515: ###############################################
                   4516: ###############################################
                   4517: 
                   4518: =pod
                   4519: 
1.112     bowersj2 4520: =back
                   4521: 
1.549     albertel 4522: =head1 HTML Helpers
1.112     bowersj2 4523: 
                   4524: =over 4
                   4525: 
                   4526: =item * &bodytag()
1.60      matthew  4527: 
                   4528: Returns a uniform header for LON-CAPA web pages.
                   4529: 
                   4530: Inputs: 
                   4531: 
1.112     bowersj2 4532: =over 4
                   4533: 
                   4534: =item * $title, A title to be displayed on the page.
                   4535: 
                   4536: =item * $function, the current role (can be undef).
                   4537: 
                   4538: =item * $addentries, extra parameters for the <body> tag.
                   4539: 
                   4540: =item * $bodyonly, if defined, only return the <body> tag.
                   4541: 
                   4542: =item * $domain, if defined, force a given domain.
                   4543: 
                   4544: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4545:             text interface only)
1.60      matthew  4546: 
1.814     bisitz   4547: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4548:                      navigational links
1.317     albertel 4549: 
1.338     albertel 4550: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4551: 
1.460     albertel 4552: =item * $args, optional argument valid values are
                   4553:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4554:             inherit_jsmath -> when creating popup window in a page,
                   4555:                               should it have jsmath forced on by the
                   4556:                               current page
1.460     albertel 4557: 
1.112     bowersj2 4558: =back
                   4559: 
1.60      matthew  4560: Returns: A uniform header for LON-CAPA web pages.  
                   4561: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4562: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4563: other decorations will be returned.
                   4564: 
                   4565: =cut
                   4566: 
1.54      www      4567: sub bodytag {
1.831     bisitz   4568:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4569:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4570: 
1.954     raeburn  4571:     my $public;
                   4572:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4573:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4574:         $public = 1;
                   4575:     }
1.460     albertel 4576:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4577: 
1.183     matthew  4578:     $function = &get_users_function() if (!$function);
1.339     albertel 4579:     my $img =    &designparm($function.'.img',$domain);
                   4580:     my $font =   &designparm($function.'.font',$domain);
                   4581:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4582: 
1.803     bisitz   4583:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4584: 		   'bgcolor' => $pgbg,
1.339     albertel 4585: 		   'text'    => $font,
                   4586:                    'alink'   => &designparm($function.'.alink',$domain),
                   4587: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4588: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4589:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4590: 
1.63      www      4591:  # role and realm
1.378     raeburn  4592:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4593:     if ($role  eq 'ca') {
1.479     albertel 4594:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4595:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4596:     } 
1.55      www      4597: # realm
1.258     albertel 4598:     if ($env{'request.course.id'}) {
1.378     raeburn  4599:         if ($env{'request.role'} !~ /^cr/) {
                   4600:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4601:         }
1.898     raeburn  4602:         if ($env{'request.course.sec'}) {
                   4603:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4604:         }   
1.359     albertel 4605: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4606:     } else {
                   4607:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4608:     }
1.433     albertel 4609: 
1.359     albertel 4610:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4611: 
1.438     albertel 4612:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4613: 
1.101     www      4614: # construct main body tag
1.359     albertel 4615:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4616: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4617: 
1.530     albertel 4618:     if ($bodyonly) {
1.60      matthew  4619:         return $bodytag;
1.798     tempelho 4620:     } 
1.359     albertel 4621: 
1.410     albertel 4622:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4623:     if ($public) {
1.433     albertel 4624: 	undef($role);
1.434     albertel 4625:     } else {
                   4626: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4627:     }
1.359     albertel 4628:     
1.762     bisitz   4629:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4630:     #
                   4631:     # Extra info if you are the DC
                   4632:     my $dc_info = '';
                   4633:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4634:                         $env{'course.'.$env{'request.course.id'}.
                   4635:                                  '.domain'}.'/'})) {
                   4636:         my $cid = $env{'request.course.id'};
1.917     raeburn  4637:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4638:         $dc_info =~ s/\s+$//;
1.359     albertel 4639:     }
                   4640: 
1.898     raeburn  4641:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4642:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4643: 
1.916     droeschl 4644:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4645:             return $bodytag; 
                   4646:         } 
1.903     droeschl 4647: 
                   4648:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4649: 
                   4650:         #    if ($env{'request.state'} eq 'construct') {
                   4651:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4652:         #    }
                   4653: 
1.359     albertel 4654: 
                   4655: 
1.916     droeschl 4656:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4657:              if ($dc_info) {
                   4658:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4659:              }
1.916     droeschl 4660:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4661:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4662:             return $bodytag;
                   4663:         }
1.894     droeschl 4664: 
1.927     raeburn  4665:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4666:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4667:         }
1.916     droeschl 4668: 
1.903     droeschl 4669:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4670:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4671: 
1.903     droeschl 4672:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4673: 
1.917     raeburn  4674:         if ($dc_info) {
                   4675:             $dc_info = &dc_courseid_toggle($dc_info);
                   4676:         }
                   4677:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4678: 
1.903     droeschl 4679:         #don't show menus for public users
1.954     raeburn  4680:         if (!$public){
1.903     droeschl 4681:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4682:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4683:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4684:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4685:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  4686:                                 $args->{'bread_crumbs'});
                   4687:             } elsif ($forcereg) { 
                   4688:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   4689:             }
1.903     droeschl 4690:         }else{
                   4691:             # this is to seperate menu from content when there's no secondary
                   4692:             # menu. Especially needed for public accessible ressources.
                   4693:             $bodytag .= '<hr style="clear:both" />';
                   4694:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4695:         }
1.903     droeschl 4696: 
1.235     raeburn  4697:         return $bodytag;
1.182     matthew  4698: }
                   4699: 
1.917     raeburn  4700: sub dc_courseid_toggle {
                   4701:     my ($dc_info) = @_;
1.980     raeburn  4702:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917     raeburn  4703:            '<a href="javascript:showCourseID();">'.
                   4704:            &mt('(More ...)').'</a></span>'.
                   4705:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4706: }
                   4707: 
1.330     albertel 4708: sub make_attr_string {
                   4709:     my ($register,$attr_ref) = @_;
                   4710: 
                   4711:     if ($attr_ref && !ref($attr_ref)) {
                   4712: 	die("addentries Must be a hash ref ".
                   4713: 	    join(':',caller(1))." ".
                   4714: 	    join(':',caller(0))." ");
                   4715:     }
                   4716: 
                   4717:     if ($register) {
1.339     albertel 4718: 	my ($on_load,$on_unload);
                   4719: 	foreach my $key (keys(%{$attr_ref})) {
                   4720: 	    if      (lc($key) eq 'onload') {
                   4721: 		$on_load.=$attr_ref->{$key}.';';
                   4722: 		delete($attr_ref->{$key});
                   4723: 
                   4724: 	    } elsif (lc($key) eq 'onunload') {
                   4725: 		$on_unload.=$attr_ref->{$key}.';';
                   4726: 		delete($attr_ref->{$key});
                   4727: 	    }
                   4728: 	}
1.953     droeschl 4729: 	$attr_ref->{'onload'}  = $on_load;
                   4730: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 4731:     }
1.339     albertel 4732: 
1.330     albertel 4733:     my $attr_string;
                   4734:     foreach my $attr (keys(%$attr_ref)) {
                   4735: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4736:     }
                   4737:     return $attr_string;
                   4738: }
                   4739: 
                   4740: 
1.182     matthew  4741: ###############################################
1.251     albertel 4742: ###############################################
                   4743: 
                   4744: =pod
                   4745: 
                   4746: =item * &endbodytag()
                   4747: 
                   4748: Returns a uniform footer for LON-CAPA web pages.
                   4749: 
1.635     raeburn  4750: Inputs: 1 - optional reference to an args hash
                   4751: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4752: a 'Continue' link is not displayed if the page contains an
                   4753: internal redirect in the <head></head> section,
                   4754: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4755: 
                   4756: =cut
                   4757: 
                   4758: sub endbodytag {
1.635     raeburn  4759:     my ($args) = @_;
1.251     albertel 4760:     my $endbodytag='</body>';
1.269     albertel 4761:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4762:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4763:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4764: 	    $endbodytag=
                   4765: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4766: 	        &mt('Continue').'</a>'.
                   4767: 	        $endbodytag;
                   4768:         }
1.315     albertel 4769:     }
1.251     albertel 4770:     return $endbodytag;
                   4771: }
                   4772: 
1.352     albertel 4773: =pod
                   4774: 
                   4775: =item * &standard_css()
                   4776: 
                   4777: Returns a style sheet
                   4778: 
                   4779: Inputs: (all optional)
                   4780:             domain         -> force to color decorate a page for a specific
                   4781:                                domain
                   4782:             function       -> force usage of a specific rolish color scheme
                   4783:             bgcolor        -> override the default page bgcolor
                   4784: 
                   4785: =cut
                   4786: 
1.343     albertel 4787: sub standard_css {
1.345     albertel 4788:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4789:     $function  = &get_users_function() if (!$function);
                   4790:     my $img    = &designparm($function.'.img',   $domain);
                   4791:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4792:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4793:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4794: #second colour for later usage
1.345     albertel 4795:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4796:     my $pgbg_or_bgcolor =
                   4797: 	         $bgcolor ||
1.352     albertel 4798: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4799:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4800:     my $alink  = &designparm($function.'.alink', $domain);
                   4801:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4802:     my $link   = &designparm($function.'.link',  $domain);
                   4803: 
1.602     albertel 4804:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4805:     my $mono                 = 'monospace';
1.850     bisitz   4806:     my $data_table_head      = $sidebg;
                   4807:     my $data_table_light     = '#FAFAFA';
                   4808:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4809:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4810:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4811:     my $mail_new             = '#FFBB77';
                   4812:     my $mail_new_hover       = '#DD9955';
                   4813:     my $mail_read            = '#BBBB77';
                   4814:     my $mail_read_hover      = '#999944';
                   4815:     my $mail_replied         = '#AAAA88';
                   4816:     my $mail_replied_hover   = '#888855';
                   4817:     my $mail_other           = '#99BBBB';
                   4818:     my $mail_other_hover     = '#669999';
1.391     albertel 4819:     my $table_header         = '#DDDDDD';
1.489     raeburn  4820:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4821:     my $lg_border_color      = '#C8C8C8';
1.952     onken    4822:     my $button_hover         = '#BF2317';
1.392     albertel 4823: 
1.608     albertel 4824:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4825:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4826:                                              : '0 3px 0 4px';
1.448     albertel 4827: 
1.523     albertel 4828: 
1.343     albertel 4829:     return <<END;
1.947     droeschl 4830: 
                   4831: /* needed for iframe to allow 100% height in FF */
                   4832: body, html { 
                   4833:     margin: 0;
                   4834:     padding: 0 0.5%;
                   4835:     height: 99%; /* to avoid scrollbars */
                   4836: }
                   4837: 
1.795     www      4838: body {
1.911     bisitz   4839:   font-family: $sans;
                   4840:   line-height:130%;
                   4841:   font-size:0.83em;
                   4842:   color:$font;
1.795     www      4843: }
                   4844: 
1.959     onken    4845: a:focus,
                   4846: a:focus img {
1.795     www      4847:   color: red;
1.911     bisitz   4848:   background: yellow;
1.795     www      4849: }
1.698     harmsja  4850: 
1.911     bisitz   4851: form, .inline {
                   4852:   display: inline;
1.795     www      4853: }
1.721     harmsja  4854: 
1.795     www      4855: .LC_right {
1.911     bisitz   4856:   text-align:right;
1.795     www      4857: }
                   4858: 
                   4859: .LC_middle {
1.911     bisitz   4860:   vertical-align:middle;
1.795     www      4861: }
1.721     harmsja  4862: 
1.911     bisitz   4863: .LC_400Box {
                   4864:   width:400px;
                   4865: }
1.721     harmsja  4866: 
1.947     droeschl 4867: .LC_iframecontainer {
                   4868:     width: 98%;
                   4869:     margin: 0;
                   4870:     position: fixed;
                   4871:     top: 8.5em;
                   4872:     bottom: 0;
                   4873: }
                   4874: 
                   4875: .LC_iframecontainer iframe{
                   4876:     border: none;
                   4877:     width: 100%;
                   4878:     height: 100%;
                   4879: }
                   4880: 
1.778     bisitz   4881: .LC_filename {
                   4882:   font-family: $mono;
                   4883:   white-space:pre;
1.921     bisitz   4884:   font-size: 120%;
1.778     bisitz   4885: }
                   4886: 
                   4887: .LC_fileicon {
                   4888:   border: none;
                   4889:   height: 1.3em;
                   4890:   vertical-align: text-bottom;
                   4891:   margin-right: 0.3em;
                   4892:   text-decoration:none;
                   4893: }
                   4894: 
1.350     albertel 4895: .LC_error {
                   4896:   color: red;
                   4897:   font-size: larger;
                   4898: }
1.795     www      4899: 
1.457     albertel 4900: .LC_warning,
                   4901: .LC_diff_removed {
1.733     bisitz   4902:   color: red;
1.394     albertel 4903: }
1.532     albertel 4904: 
                   4905: .LC_info,
1.457     albertel 4906: .LC_success,
                   4907: .LC_diff_added {
1.350     albertel 4908:   color: green;
                   4909: }
1.795     www      4910: 
1.802     bisitz   4911: div.LC_confirm_box {
                   4912:   background-color: #FAFAFA;
                   4913:   border: 1px solid $lg_border_color;
                   4914:   margin-right: 0;
                   4915:   padding: 5px;
                   4916: }
                   4917: 
                   4918: div.LC_confirm_box .LC_error img,
                   4919: div.LC_confirm_box .LC_success img {
                   4920:   vertical-align: middle;
                   4921: }
                   4922: 
1.440     albertel 4923: .LC_icon {
1.771     droeschl 4924:   border: none;
1.790     droeschl 4925:   vertical-align: middle;
1.771     droeschl 4926: }
                   4927: 
1.543     albertel 4928: .LC_docs_spacer {
                   4929:   width: 25px;
                   4930:   height: 1px;
1.771     droeschl 4931:   border: none;
1.543     albertel 4932: }
1.346     albertel 4933: 
1.532     albertel 4934: .LC_internal_info {
1.735     bisitz   4935:   color: #999999;
1.532     albertel 4936: }
                   4937: 
1.794     www      4938: .LC_discussion {
1.911     bisitz   4939:   background: $tabbg;
                   4940:   border: 1px solid black;
                   4941:   margin: 2px;
1.794     www      4942: }
                   4943: 
                   4944: .LC_disc_action_links_bar {
1.911     bisitz   4945:   background: $tabbg;
                   4946:   border: none;
                   4947:   margin: 4px;
1.794     www      4948: }
                   4949: 
                   4950: .LC_disc_action_left {
1.911     bisitz   4951:   text-align: left;
1.794     www      4952: }
                   4953: 
                   4954: .LC_disc_action_right {
1.911     bisitz   4955:   text-align: right;
1.794     www      4956: }
                   4957: 
                   4958: .LC_disc_new_item {
1.911     bisitz   4959:   background: white;
                   4960:   border: 2px solid red;
                   4961:   margin: 2px;
1.794     www      4962: }
                   4963: 
                   4964: .LC_disc_old_item {
1.911     bisitz   4965:   background: white;
                   4966:   border: 1px solid black;
                   4967:   margin: 2px;
1.794     www      4968: }
                   4969: 
1.458     albertel 4970: table.LC_pastsubmission {
                   4971:   border: 1px solid black;
                   4972:   margin: 2px;
                   4973: }
                   4974: 
1.924     bisitz   4975: table#LC_menubuttons {
1.345     albertel 4976:   width: 100%;
                   4977:   background: $pgbg;
1.392     albertel 4978:   border: 2px;
1.402     albertel 4979:   border-collapse: separate;
1.803     bisitz   4980:   padding: 0;
1.345     albertel 4981: }
1.392     albertel 4982: 
1.801     tempelho 4983: table#LC_title_bar a {
                   4984:   color: $fontmenu;
                   4985: }
1.836     bisitz   4986: 
1.807     droeschl 4987: table#LC_title_bar {
1.819     tempelho 4988:   clear: both;
1.836     bisitz   4989:   display: none;
1.807     droeschl 4990: }
                   4991: 
1.795     www      4992: table#LC_title_bar,
1.933     droeschl 4993: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 4994: table#LC_title_bar.LC_with_remote {
1.359     albertel 4995:   width: 100%;
1.392     albertel 4996:   border-color: $pgbg;
                   4997:   border-style: solid;
                   4998:   border-width: $border;
1.379     albertel 4999:   background: $pgbg;
1.801     tempelho 5000:   color: $fontmenu;
1.392     albertel 5001:   border-collapse: collapse;
1.803     bisitz   5002:   padding: 0;
1.819     tempelho 5003:   margin: 0;
1.359     albertel 5004: }
1.795     www      5005: 
1.933     droeschl 5006: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5007:     margin: 0;
                   5008:     padding: 0;
1.933     droeschl 5009:     position: relative;
                   5010:     list-style: none;
1.913     droeschl 5011: }
1.933     droeschl 5012: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5013:     display: inline;
                   5014: }
1.933     droeschl 5015: 
                   5016: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5017:     padding: 0;
1.933     droeschl 5018:     margin: 0;
                   5019:     float: left;
1.913     droeschl 5020: }
1.933     droeschl 5021: .LC_breadcrumb_tools_tools {
                   5022:     padding: 0;
                   5023:     margin: 0;
1.913     droeschl 5024:     float: right;
                   5025: }
                   5026: 
1.359     albertel 5027: table#LC_title_bar td {
                   5028:   background: $tabbg;
                   5029: }
1.795     www      5030: 
1.911     bisitz   5031: table#LC_menubuttons img {
1.803     bisitz   5032:   border: none;
1.346     albertel 5033: }
1.795     www      5034: 
1.842     droeschl 5035: .LC_breadcrumbs_component {
1.911     bisitz   5036:   float: right;
                   5037:   margin: 0 1em;
1.357     albertel 5038: }
1.842     droeschl 5039: .LC_breadcrumbs_component img {
1.911     bisitz   5040:   vertical-align: middle;
1.777     tempelho 5041: }
1.795     www      5042: 
1.383     albertel 5043: td.LC_table_cell_checkbox {
                   5044:   text-align: center;
                   5045: }
1.795     www      5046: 
                   5047: .LC_fontsize_small {
1.911     bisitz   5048:   font-size: 70%;
1.705     tempelho 5049: }
                   5050: 
1.844     bisitz   5051: #LC_breadcrumbs {
1.911     bisitz   5052:   clear:both;
                   5053:   background: $sidebg;
                   5054:   border-bottom: 1px solid $lg_border_color;
                   5055:   line-height: 2.5em;
1.933     droeschl 5056:   overflow: hidden;
1.911     bisitz   5057:   margin: 0;
                   5058:   padding: 0;
1.819     tempelho 5059: }
1.862     bisitz   5060: 
1.844     bisitz   5061: #LC_head_subbox {
1.911     bisitz   5062:   clear:both;
                   5063:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5064:   border: 1px solid $sidebg;
                   5065:   margin: 0 0 10px 0;      
1.966     bisitz   5066:   padding: 3px;
1.822     bisitz   5067: }
                   5068: 
1.795     www      5069: .LC_fontsize_medium {
1.911     bisitz   5070:   font-size: 85%;
1.705     tempelho 5071: }
                   5072: 
1.795     www      5073: .LC_fontsize_large {
1.911     bisitz   5074:   font-size: 120%;
1.705     tempelho 5075: }
                   5076: 
1.346     albertel 5077: .LC_menubuttons_inline_text {
                   5078:   color: $font;
1.698     harmsja  5079:   font-size: 90%;
1.701     harmsja  5080:   padding-left:3px;
1.346     albertel 5081: }
                   5082: 
1.934     droeschl 5083: .LC_menubuttons_inline_text img{
                   5084:   vertical-align: middle;
                   5085: }
                   5086: 
1.951     onken    5087: li.LC_menubuttons_inline_text img,a {
                   5088:   cursor:pointer;
                   5089: }
                   5090: 
1.526     www      5091: .LC_menubuttons_link {
                   5092:   text-decoration: none;
                   5093: }
1.795     www      5094: 
1.522     albertel 5095: .LC_menubuttons_category {
1.521     www      5096:   color: $font;
1.526     www      5097:   background: $pgbg;
1.521     www      5098:   font-size: larger;
                   5099:   font-weight: bold;
                   5100: }
                   5101: 
1.346     albertel 5102: td.LC_menubuttons_text {
1.911     bisitz   5103:   color: $font;
1.346     albertel 5104: }
1.706     harmsja  5105: 
1.346     albertel 5106: .LC_current_location {
                   5107:   background: $tabbg;
                   5108: }
1.795     www      5109: 
1.938     bisitz   5110: table.LC_data_table {
1.347     albertel 5111:   border: 1px solid #000000;
1.402     albertel 5112:   border-collapse: separate;
1.426     albertel 5113:   border-spacing: 1px;
1.610     albertel 5114:   background: $pgbg;
1.347     albertel 5115: }
1.795     www      5116: 
1.422     albertel 5117: .LC_data_table_dense {
                   5118:   font-size: small;
                   5119: }
1.795     www      5120: 
1.507     raeburn  5121: table.LC_nested_outer {
                   5122:   border: 1px solid #000000;
1.589     raeburn  5123:   border-collapse: collapse;
1.803     bisitz   5124:   border-spacing: 0;
1.507     raeburn  5125:   width: 100%;
                   5126: }
1.795     www      5127: 
1.879     raeburn  5128: table.LC_innerpickbox,
1.507     raeburn  5129: table.LC_nested {
1.803     bisitz   5130:   border: none;
1.589     raeburn  5131:   border-collapse: collapse;
1.803     bisitz   5132:   border-spacing: 0;
1.507     raeburn  5133:   width: 100%;
                   5134: }
1.795     www      5135: 
1.930     faziophi 5136: .ui-accordion,
                   5137: .ui-accordion table.LC_data_table,
                   5138: .ui-accordion table.LC_nested_outer{
                   5139:   border: 0px;
                   5140:   border-spacing: 0px;
                   5141:   margin: 3px;
                   5142: }
                   5143: 
1.911     bisitz   5144: table.LC_data_table tr th,
                   5145: table.LC_calendar tr th,
1.879     raeburn  5146: table.LC_prior_tries tr th,
                   5147: table.LC_innerpickbox tr th {
1.349     albertel 5148:   font-weight: bold;
                   5149:   background-color: $data_table_head;
1.801     tempelho 5150:   color:$fontmenu;
1.701     harmsja  5151:   font-size:90%;
1.347     albertel 5152: }
1.795     www      5153: 
1.879     raeburn  5154: table.LC_innerpickbox tr th,
                   5155: table.LC_innerpickbox tr td {
                   5156:   vertical-align: top;
                   5157: }
                   5158: 
1.711     raeburn  5159: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5160:   background-color: #CCCCCC;
1.711     raeburn  5161:   font-weight: bold;
                   5162:   text-align: left;
                   5163: }
1.795     www      5164: 
1.912     bisitz   5165: table.LC_data_table tr.LC_odd_row > td {
                   5166:   background-color: $data_table_light;
                   5167:   padding: 2px;
                   5168:   vertical-align: top;
                   5169: }
                   5170: 
1.809     bisitz   5171: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5172:   background-color: $data_table_light;
1.912     bisitz   5173:   vertical-align: top;
                   5174: }
                   5175: 
                   5176: table.LC_data_table tr.LC_even_row > td {
                   5177:   background-color: $data_table_dark;
1.425     albertel 5178:   padding: 2px;
1.900     bisitz   5179:   vertical-align: top;
1.347     albertel 5180: }
1.795     www      5181: 
1.809     bisitz   5182: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5183:   background-color: $data_table_dark;
1.900     bisitz   5184:   vertical-align: top;
1.347     albertel 5185: }
1.795     www      5186: 
1.425     albertel 5187: table.LC_data_table tr.LC_data_table_highlight td {
                   5188:   background-color: $data_table_darker;
                   5189: }
1.795     www      5190: 
1.639     raeburn  5191: table.LC_data_table tr td.LC_leftcol_header {
                   5192:   background-color: $data_table_head;
                   5193:   font-weight: bold;
                   5194: }
1.795     www      5195: 
1.451     albertel 5196: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5197: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5198:   font-weight: bold;
                   5199:   font-style: italic;
                   5200:   text-align: center;
                   5201:   padding: 8px;
1.347     albertel 5202: }
1.795     www      5203: 
1.940     bisitz   5204: table.LC_data_table tr.LC_empty_row td {
                   5205:   background-color: $sidebg;
                   5206: }
                   5207: 
                   5208: table.LC_nested tr.LC_empty_row td {
                   5209:   background-color: #FFFFFF;
                   5210: }
                   5211: 
1.890     droeschl 5212: table.LC_caption {
                   5213: }
                   5214: 
1.507     raeburn  5215: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5216:   padding: 4ex
                   5217: }
1.795     www      5218: 
1.507     raeburn  5219: table.LC_nested_outer tr th {
                   5220:   font-weight: bold;
1.801     tempelho 5221:   color:$fontmenu;
1.507     raeburn  5222:   background-color: $data_table_head;
1.701     harmsja  5223:   font-size: small;
1.507     raeburn  5224:   border-bottom: 1px solid #000000;
                   5225: }
1.795     www      5226: 
1.507     raeburn  5227: table.LC_nested_outer tr td.LC_subheader {
                   5228:   background-color: $data_table_head;
                   5229:   font-weight: bold;
                   5230:   font-size: small;
                   5231:   border-bottom: 1px solid #000000;
                   5232:   text-align: right;
1.451     albertel 5233: }
1.795     www      5234: 
1.507     raeburn  5235: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5236:   background-color: #CCCCCC;
1.451     albertel 5237:   font-weight: bold;
                   5238:   font-size: small;
1.507     raeburn  5239:   text-align: center;
                   5240: }
1.795     www      5241: 
1.589     raeburn  5242: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5243: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5244:   text-align: left;
1.451     albertel 5245: }
1.795     www      5246: 
1.507     raeburn  5247: table.LC_nested td {
1.735     bisitz   5248:   background-color: #FFFFFF;
1.451     albertel 5249:   font-size: small;
1.507     raeburn  5250: }
1.795     www      5251: 
1.507     raeburn  5252: table.LC_nested_outer tr th.LC_right_item,
                   5253: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5254: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5255: table.LC_nested tr td.LC_right_item {
1.451     albertel 5256:   text-align: right;
                   5257: }
                   5258: 
1.930     faziophi 5259: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item,
                   5260: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item {
                   5261:   text-align: right;
                   5262:   width: 40%;
                   5263:   padding-right:10px;
                   5264:   vertical-align: top;
                   5265:   padding: 5px;
                   5266: }
                   5267: 
                   5268: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5269: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item {
                   5270:   text-align: left;
                   5271:   width: 60%;
                   5272:   padding: 2px 4px;
                   5273: }
                   5274: 
1.507     raeburn  5275: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5276:   background-color: #EEEEEE;
1.451     albertel 5277: }
                   5278: 
1.473     raeburn  5279: table.LC_createuser {
                   5280: }
                   5281: 
                   5282: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5283:   font-size: small;
1.473     raeburn  5284: }
                   5285: 
                   5286: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5287:   background-color: #CCCCCC;
1.473     raeburn  5288:   font-weight: bold;
                   5289:   text-align: center;
                   5290: }
                   5291: 
1.349     albertel 5292: table.LC_calendar {
                   5293:   border: 1px solid #000000;
                   5294:   border-collapse: collapse;
1.917     raeburn  5295:   width: 98%;
1.349     albertel 5296: }
1.795     www      5297: 
1.349     albertel 5298: table.LC_calendar_pickdate {
                   5299:   font-size: xx-small;
                   5300: }
1.795     www      5301: 
1.349     albertel 5302: table.LC_calendar tr td {
                   5303:   border: 1px solid #000000;
                   5304:   vertical-align: top;
1.917     raeburn  5305:   width: 14%;
1.349     albertel 5306: }
1.795     www      5307: 
1.349     albertel 5308: table.LC_calendar tr td.LC_calendar_day_empty {
                   5309:   background-color: $data_table_dark;
                   5310: }
1.795     www      5311: 
1.779     bisitz   5312: table.LC_calendar tr td.LC_calendar_day_current {
                   5313:   background-color: $data_table_highlight;
1.777     tempelho 5314: }
1.795     www      5315: 
1.938     bisitz   5316: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5317:   background-color: $mail_new;
                   5318: }
1.795     www      5319: 
1.938     bisitz   5320: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5321:   background-color: $mail_new_hover;
                   5322: }
1.795     www      5323: 
1.938     bisitz   5324: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5325:   background-color: $mail_read;
                   5326: }
1.795     www      5327: 
1.938     bisitz   5328: /*
                   5329: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5330:   background-color: $mail_read_hover;
                   5331: }
1.938     bisitz   5332: */
1.795     www      5333: 
1.938     bisitz   5334: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5335:   background-color: $mail_replied;
                   5336: }
1.795     www      5337: 
1.938     bisitz   5338: /*
                   5339: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5340:   background-color: $mail_replied_hover;
                   5341: }
1.938     bisitz   5342: */
1.795     www      5343: 
1.938     bisitz   5344: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5345:   background-color: $mail_other;
                   5346: }
1.795     www      5347: 
1.938     bisitz   5348: /*
                   5349: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5350:   background-color: $mail_other_hover;
                   5351: }
1.938     bisitz   5352: */
1.494     raeburn  5353: 
1.777     tempelho 5354: table.LC_data_table tr > td.LC_browser_file,
                   5355: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5356:   background: #AAEE77;
1.389     albertel 5357: }
1.795     www      5358: 
1.777     tempelho 5359: table.LC_data_table tr > td.LC_browser_file_locked,
                   5360: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5361:   background: #FFAA99;
1.387     albertel 5362: }
1.795     www      5363: 
1.777     tempelho 5364: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5365:   background: #888888;
1.779     bisitz   5366: }
1.795     www      5367: 
1.777     tempelho 5368: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5369: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5370:   background: #F8F866;
1.777     tempelho 5371: }
1.795     www      5372: 
1.696     bisitz   5373: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5374:   background: #E0E8FF;
1.387     albertel 5375: }
1.696     bisitz   5376: 
1.707     bisitz   5377: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5378:   /* background: #77FF77; */
1.707     bisitz   5379: }
1.795     www      5380: 
1.707     bisitz   5381: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5382:   border-right: 8px solid #FFFF77;
1.707     bisitz   5383: }
1.795     www      5384: 
1.707     bisitz   5385: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5386:   border-right: 8px solid #FFAA77;
1.707     bisitz   5387: }
1.795     www      5388: 
1.707     bisitz   5389: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5390:   border-right: 8px solid #FF7777;
1.707     bisitz   5391: }
1.795     www      5392: 
1.707     bisitz   5393: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5394:   border-right: 8px solid #AAFF77;
1.707     bisitz   5395: }
1.795     www      5396: 
1.707     bisitz   5397: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5398:   border-right: 8px solid #11CC55;
1.707     bisitz   5399: }
                   5400: 
1.388     albertel 5401: span.LC_current_location {
1.701     harmsja  5402:   font-size:larger;
1.388     albertel 5403:   background: $pgbg;
                   5404: }
1.387     albertel 5405: 
1.395     albertel 5406: span.LC_parm_menu_item {
                   5407:   font-size: larger;
                   5408: }
1.795     www      5409: 
1.395     albertel 5410: span.LC_parm_scope_all {
                   5411:   color: red;
                   5412: }
1.795     www      5413: 
1.395     albertel 5414: span.LC_parm_scope_folder {
                   5415:   color: green;
                   5416: }
1.795     www      5417: 
1.395     albertel 5418: span.LC_parm_scope_resource {
                   5419:   color: orange;
                   5420: }
1.795     www      5421: 
1.395     albertel 5422: span.LC_parm_part {
                   5423:   color: blue;
                   5424: }
1.795     www      5425: 
1.911     bisitz   5426: span.LC_parm_folder,
                   5427: span.LC_parm_symb {
1.395     albertel 5428:   font-size: x-small;
                   5429:   font-family: $mono;
                   5430:   color: #AAAAAA;
                   5431: }
                   5432: 
1.977     bisitz   5433: ul.LC_parm_parmlist li {
                   5434:   display: inline-block;
                   5435:   padding: 0.3em 0.8em;
                   5436:   vertical-align: top;
                   5437:   width: 150px;
                   5438:   border-top:1px solid $lg_border_color;
                   5439: }
                   5440: 
1.795     www      5441: td.LC_parm_overview_level_menu,
                   5442: td.LC_parm_overview_map_menu,
                   5443: td.LC_parm_overview_parm_selectors,
                   5444: td.LC_parm_overview_restrictions  {
1.396     albertel 5445:   border: 1px solid black;
                   5446:   border-collapse: collapse;
                   5447: }
1.795     www      5448: 
1.396     albertel 5449: table.LC_parm_overview_restrictions td {
                   5450:   border-width: 1px 4px 1px 4px;
                   5451:   border-style: solid;
                   5452:   border-color: $pgbg;
                   5453:   text-align: center;
                   5454: }
1.795     www      5455: 
1.396     albertel 5456: table.LC_parm_overview_restrictions th {
                   5457:   background: $tabbg;
                   5458:   border-width: 1px 4px 1px 4px;
                   5459:   border-style: solid;
                   5460:   border-color: $pgbg;
                   5461: }
1.795     www      5462: 
1.398     albertel 5463: table#LC_helpmenu {
1.803     bisitz   5464:   border: none;
1.398     albertel 5465:   height: 55px;
1.803     bisitz   5466:   border-spacing: 0;
1.398     albertel 5467: }
                   5468: 
                   5469: table#LC_helpmenu fieldset legend {
                   5470:   font-size: larger;
                   5471: }
1.795     www      5472: 
1.397     albertel 5473: table#LC_helpmenu_links {
                   5474:   width: 100%;
                   5475:   border: 1px solid black;
                   5476:   background: $pgbg;
1.803     bisitz   5477:   padding: 0;
1.397     albertel 5478:   border-spacing: 1px;
                   5479: }
1.795     www      5480: 
1.397     albertel 5481: table#LC_helpmenu_links tr td {
                   5482:   padding: 1px;
                   5483:   background: $tabbg;
1.399     albertel 5484:   text-align: center;
                   5485:   font-weight: bold;
1.397     albertel 5486: }
1.396     albertel 5487: 
1.795     www      5488: table#LC_helpmenu_links a:link,
                   5489: table#LC_helpmenu_links a:visited,
1.397     albertel 5490: table#LC_helpmenu_links a:active {
                   5491:   text-decoration: none;
                   5492:   color: $font;
                   5493: }
1.795     www      5494: 
1.397     albertel 5495: table#LC_helpmenu_links a:hover {
                   5496:   text-decoration: underline;
                   5497:   color: $vlink;
                   5498: }
1.396     albertel 5499: 
1.417     albertel 5500: .LC_chrt_popup_exists {
                   5501:   border: 1px solid #339933;
                   5502:   margin: -1px;
                   5503: }
1.795     www      5504: 
1.417     albertel 5505: .LC_chrt_popup_up {
                   5506:   border: 1px solid yellow;
                   5507:   margin: -1px;
                   5508: }
1.795     www      5509: 
1.417     albertel 5510: .LC_chrt_popup {
                   5511:   border: 1px solid #8888FF;
                   5512:   background: #CCCCFF;
                   5513: }
1.795     www      5514: 
1.421     albertel 5515: table.LC_pick_box {
                   5516:   border-collapse: separate;
                   5517:   background: white;
                   5518:   border: 1px solid black;
                   5519:   border-spacing: 1px;
                   5520: }
1.795     www      5521: 
1.421     albertel 5522: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5523:   background: $sidebg;
1.421     albertel 5524:   font-weight: bold;
1.900     bisitz   5525:   text-align: left;
1.740     bisitz   5526:   vertical-align: top;
1.421     albertel 5527:   width: 184px;
                   5528:   padding: 8px;
                   5529: }
1.795     www      5530: 
1.579     raeburn  5531: table.LC_pick_box td.LC_pick_box_value {
                   5532:   text-align: left;
                   5533:   padding: 8px;
                   5534: }
1.795     www      5535: 
1.579     raeburn  5536: table.LC_pick_box td.LC_pick_box_select {
                   5537:   text-align: left;
                   5538:   padding: 8px;
                   5539: }
1.795     www      5540: 
1.424     albertel 5541: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5542:   padding: 0;
1.421     albertel 5543:   height: 1px;
                   5544:   background: black;
                   5545: }
1.795     www      5546: 
1.421     albertel 5547: table.LC_pick_box td.LC_pick_box_submit {
                   5548:   text-align: right;
                   5549: }
1.795     www      5550: 
1.579     raeburn  5551: table.LC_pick_box td.LC_evenrow_value {
                   5552:   text-align: left;
                   5553:   padding: 8px;
                   5554:   background-color: $data_table_light;
                   5555: }
1.795     www      5556: 
1.579     raeburn  5557: table.LC_pick_box td.LC_oddrow_value {
                   5558:   text-align: left;
                   5559:   padding: 8px;
                   5560:   background-color: $data_table_light;
                   5561: }
1.795     www      5562: 
1.579     raeburn  5563: span.LC_helpform_receipt_cat {
                   5564:   font-weight: bold;
                   5565: }
1.795     www      5566: 
1.424     albertel 5567: table.LC_group_priv_box {
                   5568:   background: white;
                   5569:   border: 1px solid black;
                   5570:   border-spacing: 1px;
                   5571: }
1.795     www      5572: 
1.424     albertel 5573: table.LC_group_priv_box td.LC_pick_box_title {
                   5574:   background: $tabbg;
                   5575:   font-weight: bold;
                   5576:   text-align: right;
                   5577:   width: 184px;
                   5578: }
1.795     www      5579: 
1.424     albertel 5580: table.LC_group_priv_box td.LC_groups_fixed {
                   5581:   background: $data_table_light;
                   5582:   text-align: center;
                   5583: }
1.795     www      5584: 
1.424     albertel 5585: table.LC_group_priv_box td.LC_groups_optional {
                   5586:   background: $data_table_dark;
                   5587:   text-align: center;
                   5588: }
1.795     www      5589: 
1.424     albertel 5590: table.LC_group_priv_box td.LC_groups_functionality {
                   5591:   background: $data_table_darker;
                   5592:   text-align: center;
                   5593:   font-weight: bold;
                   5594: }
1.795     www      5595: 
1.424     albertel 5596: table.LC_group_priv td {
                   5597:   text-align: left;
1.803     bisitz   5598:   padding: 0;
1.424     albertel 5599: }
                   5600: 
                   5601: .LC_navbuttons {
                   5602:   margin: 2ex 0ex 2ex 0ex;
                   5603: }
1.795     www      5604: 
1.423     albertel 5605: .LC_topic_bar {
                   5606:   font-weight: bold;
                   5607:   background: $tabbg;
1.918     wenzelju 5608:   margin: 1em 0em 1em 2em;
1.805     bisitz   5609:   padding: 3px;
1.918     wenzelju 5610:   font-size: 1.2em;
1.423     albertel 5611: }
1.795     www      5612: 
1.423     albertel 5613: .LC_topic_bar span {
1.918     wenzelju 5614:   left: 0.5em;
                   5615:   position: absolute;
1.423     albertel 5616:   vertical-align: middle;
1.918     wenzelju 5617:   font-size: 1.2em;
1.423     albertel 5618: }
1.795     www      5619: 
1.423     albertel 5620: table.LC_course_group_status {
                   5621:   margin: 20px;
                   5622: }
1.795     www      5623: 
1.423     albertel 5624: table.LC_status_selector td {
                   5625:   vertical-align: top;
                   5626:   text-align: center;
1.424     albertel 5627:   padding: 4px;
                   5628: }
1.795     www      5629: 
1.599     albertel 5630: div.LC_feedback_link {
1.616     albertel 5631:   clear: both;
1.829     kalberla 5632:   background: $sidebg;
1.779     bisitz   5633:   width: 100%;
1.829     kalberla 5634:   padding-bottom: 10px;
                   5635:   border: 1px $tabbg solid;
1.833     kalberla 5636:   height: 22px;
                   5637:   line-height: 22px;
                   5638:   padding-top: 5px;
                   5639: }
                   5640: 
                   5641: div.LC_feedback_link img {
                   5642:   height: 22px;
1.867     kalberla 5643:   vertical-align:middle;
1.829     kalberla 5644: }
                   5645: 
1.911     bisitz   5646: div.LC_feedback_link a {
1.829     kalberla 5647:   text-decoration: none;
1.489     raeburn  5648: }
1.795     www      5649: 
1.867     kalberla 5650: div.LC_comblock {
1.911     bisitz   5651:   display:inline;
1.867     kalberla 5652:   color:$font;
                   5653:   font-size:90%;
                   5654: }
                   5655: 
                   5656: div.LC_feedback_link div.LC_comblock {
                   5657:   padding-left:5px;
                   5658: }
                   5659: 
                   5660: div.LC_feedback_link div.LC_comblock a {
                   5661:   color:$font;
                   5662: }
                   5663: 
1.489     raeburn  5664: span.LC_feedback_link {
1.858     bisitz   5665:   /* background: $feedback_link_bg; */
1.599     albertel 5666:   font-size: larger;
                   5667: }
1.795     www      5668: 
1.599     albertel 5669: span.LC_message_link {
1.858     bisitz   5670:   /* background: $feedback_link_bg; */
1.599     albertel 5671:   font-size: larger;
                   5672:   position: absolute;
                   5673:   right: 1em;
1.489     raeburn  5674: }
1.421     albertel 5675: 
1.515     albertel 5676: table.LC_prior_tries {
1.524     albertel 5677:   border: 1px solid #000000;
                   5678:   border-collapse: separate;
                   5679:   border-spacing: 1px;
1.515     albertel 5680: }
1.523     albertel 5681: 
1.515     albertel 5682: table.LC_prior_tries td {
1.524     albertel 5683:   padding: 2px;
1.515     albertel 5684: }
1.523     albertel 5685: 
                   5686: .LC_answer_correct {
1.795     www      5687:   background: lightgreen;
                   5688:   color: darkgreen;
                   5689:   padding: 6px;
1.523     albertel 5690: }
1.795     www      5691: 
1.523     albertel 5692: .LC_answer_charged_try {
1.797     www      5693:   background: #FFAAAA;
1.795     www      5694:   color: darkred;
                   5695:   padding: 6px;
1.523     albertel 5696: }
1.795     www      5697: 
1.779     bisitz   5698: .LC_answer_not_charged_try,
1.523     albertel 5699: .LC_answer_no_grade,
                   5700: .LC_answer_late {
1.795     www      5701:   background: lightyellow;
1.523     albertel 5702:   color: black;
1.795     www      5703:   padding: 6px;
1.523     albertel 5704: }
1.795     www      5705: 
1.523     albertel 5706: .LC_answer_previous {
1.795     www      5707:   background: lightblue;
                   5708:   color: darkblue;
                   5709:   padding: 6px;
1.523     albertel 5710: }
1.795     www      5711: 
1.779     bisitz   5712: .LC_answer_no_message {
1.777     tempelho 5713:   background: #FFFFFF;
                   5714:   color: black;
1.795     www      5715:   padding: 6px;
1.779     bisitz   5716: }
1.795     www      5717: 
1.779     bisitz   5718: .LC_answer_unknown {
                   5719:   background: orange;
                   5720:   color: black;
1.795     www      5721:   padding: 6px;
1.777     tempelho 5722: }
1.795     www      5723: 
1.529     albertel 5724: span.LC_prior_numerical,
                   5725: span.LC_prior_string,
                   5726: span.LC_prior_custom,
                   5727: span.LC_prior_reaction,
                   5728: span.LC_prior_math {
1.925     bisitz   5729:   font-family: $mono;
1.523     albertel 5730:   white-space: pre;
                   5731: }
                   5732: 
1.525     albertel 5733: span.LC_prior_string {
1.925     bisitz   5734:   font-family: $mono;
1.525     albertel 5735:   white-space: pre;
                   5736: }
                   5737: 
1.523     albertel 5738: table.LC_prior_option {
                   5739:   width: 100%;
                   5740:   border-collapse: collapse;
                   5741: }
1.795     www      5742: 
1.911     bisitz   5743: table.LC_prior_rank,
1.795     www      5744: table.LC_prior_match {
1.528     albertel 5745:   border-collapse: collapse;
                   5746: }
1.795     www      5747: 
1.528     albertel 5748: table.LC_prior_option tr td,
                   5749: table.LC_prior_rank tr td,
                   5750: table.LC_prior_match tr td {
1.524     albertel 5751:   border: 1px solid #000000;
1.515     albertel 5752: }
                   5753: 
1.855     bisitz   5754: .LC_nobreak {
1.544     albertel 5755:   white-space: nowrap;
1.519     raeburn  5756: }
                   5757: 
1.576     raeburn  5758: span.LC_cusr_emph {
                   5759:   font-style: italic;
                   5760: }
                   5761: 
1.633     raeburn  5762: span.LC_cusr_subheading {
                   5763:   font-weight: normal;
                   5764:   font-size: 85%;
                   5765: }
                   5766: 
1.861     bisitz   5767: div.LC_docs_entry_move {
1.859     bisitz   5768:   border: 1px solid #BBBBBB;
1.545     albertel 5769:   background: #DDDDDD;
1.861     bisitz   5770:   width: 22px;
1.859     bisitz   5771:   padding: 1px;
                   5772:   margin: 0;
1.545     albertel 5773: }
                   5774: 
1.861     bisitz   5775: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5776: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5777:   background: #DDDDDD;
                   5778:   font-size: x-small;
                   5779: }
1.795     www      5780: 
1.861     bisitz   5781: .LC_docs_entry_parameter {
                   5782:   white-space: nowrap;
                   5783: }
                   5784: 
1.544     albertel 5785: .LC_docs_copy {
1.545     albertel 5786:   color: #000099;
1.544     albertel 5787: }
1.795     www      5788: 
1.544     albertel 5789: .LC_docs_cut {
1.545     albertel 5790:   color: #550044;
1.544     albertel 5791: }
1.795     www      5792: 
1.544     albertel 5793: .LC_docs_rename {
1.545     albertel 5794:   color: #009900;
1.544     albertel 5795: }
1.795     www      5796: 
1.544     albertel 5797: .LC_docs_remove {
1.545     albertel 5798:   color: #990000;
                   5799: }
                   5800: 
1.547     albertel 5801: .LC_docs_reinit_warn,
                   5802: .LC_docs_ext_edit {
                   5803:   font-size: x-small;
                   5804: }
                   5805: 
1.545     albertel 5806: table.LC_docs_adddocs td,
                   5807: table.LC_docs_adddocs th {
                   5808:   border: 1px solid #BBBBBB;
                   5809:   padding: 4px;
                   5810:   background: #DDDDDD;
1.543     albertel 5811: }
                   5812: 
1.584     albertel 5813: table.LC_sty_begin {
                   5814:   background: #BBFFBB;
                   5815: }
1.795     www      5816: 
1.584     albertel 5817: table.LC_sty_end {
                   5818:   background: #FFBBBB;
                   5819: }
                   5820: 
1.589     raeburn  5821: table.LC_double_column {
1.803     bisitz   5822:   border-width: 0;
1.589     raeburn  5823:   border-collapse: collapse;
                   5824:   width: 100%;
                   5825:   padding: 2px;
                   5826: }
                   5827: 
                   5828: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5829:   top: 2px;
1.589     raeburn  5830:   left: 2px;
                   5831:   width: 47%;
                   5832:   vertical-align: top;
                   5833: }
                   5834: 
                   5835: table.LC_double_column tr td.LC_right_col {
                   5836:   top: 2px;
1.779     bisitz   5837:   right: 2px;
1.589     raeburn  5838:   width: 47%;
                   5839:   vertical-align: top;
                   5840: }
                   5841: 
1.591     raeburn  5842: div.LC_left_float {
                   5843:   float: left;
                   5844:   padding-right: 5%;
1.597     albertel 5845:   padding-bottom: 4px;
1.591     raeburn  5846: }
                   5847: 
                   5848: div.LC_clear_float_header {
1.597     albertel 5849:   padding-bottom: 2px;
1.591     raeburn  5850: }
                   5851: 
                   5852: div.LC_clear_float_footer {
1.597     albertel 5853:   padding-top: 10px;
1.591     raeburn  5854:   clear: both;
                   5855: }
                   5856: 
1.597     albertel 5857: div.LC_grade_show_user {
1.941     bisitz   5858: /*  border-left: 5px solid $sidebg; */
                   5859:   border-top: 5px solid #000000;
                   5860:   margin: 50px 0 0 0;
1.936     bisitz   5861:   padding: 15px 0 5px 10px;
1.597     albertel 5862: }
1.795     www      5863: 
1.936     bisitz   5864: div.LC_grade_show_user_odd_row {
1.941     bisitz   5865: /*  border-left: 5px solid #000000; */
                   5866: }
                   5867: 
                   5868: div.LC_grade_show_user div.LC_Box {
                   5869:   margin-right: 50px;
1.597     albertel 5870: }
                   5871: 
                   5872: div.LC_grade_submissions,
                   5873: div.LC_grade_message_center,
1.936     bisitz   5874: div.LC_grade_info_links {
1.597     albertel 5875:   margin: 5px;
                   5876:   width: 99%;
                   5877:   background: #FFFFFF;
                   5878: }
1.795     www      5879: 
1.597     albertel 5880: div.LC_grade_submissions_header,
1.936     bisitz   5881: div.LC_grade_message_center_header {
1.705     tempelho 5882:   font-weight: bold;
                   5883:   font-size: large;
1.597     albertel 5884: }
1.795     www      5885: 
1.597     albertel 5886: div.LC_grade_submissions_body,
1.936     bisitz   5887: div.LC_grade_message_center_body {
1.597     albertel 5888:   border: 1px solid black;
                   5889:   width: 99%;
                   5890:   background: #FFFFFF;
                   5891: }
1.795     www      5892: 
1.613     albertel 5893: table.LC_scantron_action {
                   5894:   width: 100%;
                   5895: }
1.795     www      5896: 
1.613     albertel 5897: table.LC_scantron_action tr th {
1.698     harmsja  5898:   font-weight:bold;
                   5899:   font-style:normal;
1.613     albertel 5900: }
1.795     www      5901: 
1.779     bisitz   5902: .LC_edit_problem_header,
1.614     albertel 5903: div.LC_edit_problem_footer {
1.705     tempelho 5904:   font-weight: normal;
                   5905:   font-size:  medium;
1.602     albertel 5906:   margin: 2px;
1.600     albertel 5907: }
1.795     www      5908: 
1.600     albertel 5909: div.LC_edit_problem_header,
1.602     albertel 5910: div.LC_edit_problem_header div,
1.614     albertel 5911: div.LC_edit_problem_footer,
                   5912: div.LC_edit_problem_footer div,
1.602     albertel 5913: div.LC_edit_problem_editxml_header,
                   5914: div.LC_edit_problem_editxml_header div {
1.600     albertel 5915:   margin-top: 5px;
                   5916: }
1.795     www      5917: 
1.600     albertel 5918: div.LC_edit_problem_header_title {
1.705     tempelho 5919:   font-weight: bold;
                   5920:   font-size: larger;
1.602     albertel 5921:   background: $tabbg;
                   5922:   padding: 3px;
                   5923: }
1.795     www      5924: 
1.602     albertel 5925: table.LC_edit_problem_header_title {
                   5926:   width: 100%;
1.600     albertel 5927:   background: $tabbg;
1.602     albertel 5928: }
                   5929: 
                   5930: div.LC_edit_problem_discards {
                   5931:   float: left;
                   5932:   padding-bottom: 5px;
                   5933: }
1.795     www      5934: 
1.602     albertel 5935: div.LC_edit_problem_saves {
                   5936:   float: right;
                   5937:   padding-bottom: 5px;
1.600     albertel 5938: }
1.795     www      5939: 
1.911     bisitz   5940: img.stift {
1.803     bisitz   5941:   border-width: 0;
                   5942:   vertical-align: middle;
1.677     riegler  5943: }
1.680     riegler  5944: 
1.923     bisitz   5945: table td.LC_mainmenu_col_fieldset {
1.680     riegler  5946:   vertical-align: top;
1.777     tempelho 5947: }
1.795     www      5948: 
1.716     raeburn  5949: div.LC_createcourse {
1.911     bisitz   5950:   margin: 10px 10px 10px 10px;
1.716     raeburn  5951: }
                   5952: 
1.917     raeburn  5953: .LC_dccid {
                   5954:   margin: 0.2em 0 0 0;
                   5955:   padding: 0;
                   5956:   font-size: 90%;
                   5957:   display:none;
                   5958: }
                   5959: 
1.698     harmsja  5960: a:hover,
1.897     wenzelju 5961: ol.LC_primary_menu a:hover,
1.721     harmsja  5962: ol#LC_MenuBreadcrumbs a:hover,
                   5963: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5964: ul#LC_secondary_menu a:hover,
1.721     harmsja  5965: .LC_FormSectionClearButton input:hover
1.795     www      5966: ul.LC_TabContent   li:hover a {
1.952     onken    5967:   color:$button_hover;
1.911     bisitz   5968:   text-decoration:none;
1.693     droeschl 5969: }
                   5970: 
1.779     bisitz   5971: h1 {
1.911     bisitz   5972:   padding: 0;
                   5973:   line-height:130%;
1.693     droeschl 5974: }
1.698     harmsja  5975: 
1.911     bisitz   5976: h2,
                   5977: h3,
                   5978: h4,
                   5979: h5,
                   5980: h6 {
                   5981:   margin: 5px 0 5px 0;
                   5982:   padding: 0;
                   5983:   line-height:130%;
1.693     droeschl 5984: }
1.795     www      5985: 
                   5986: .LC_hcell {
1.911     bisitz   5987:   padding:3px 15px 3px 15px;
                   5988:   margin: 0;
                   5989:   background-color:$tabbg;
                   5990:   color:$fontmenu;
                   5991:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5992: }
1.795     www      5993: 
1.840     bisitz   5994: .LC_Box > .LC_hcell {
1.911     bisitz   5995:   margin: 0 -10px 10px -10px;
1.835     bisitz   5996: }
                   5997: 
1.721     harmsja  5998: .LC_noBorder {
1.911     bisitz   5999:   border: 0;
1.698     harmsja  6000: }
1.693     droeschl 6001: 
1.721     harmsja  6002: .LC_FormSectionClearButton input {
1.911     bisitz   6003:   background-color:transparent;
                   6004:   border: none;
                   6005:   cursor:pointer;
                   6006:   text-decoration:underline;
1.693     droeschl 6007: }
1.763     bisitz   6008: 
                   6009: .LC_help_open_topic {
1.911     bisitz   6010:   color: #FFFFFF;
                   6011:   background-color: #EEEEFF;
                   6012:   margin: 1px;
                   6013:   padding: 4px;
                   6014:   border: 1px solid #000033;
                   6015:   white-space: nowrap;
                   6016:   /* vertical-align: middle; */
1.759     neumanie 6017: }
1.693     droeschl 6018: 
1.911     bisitz   6019: dl,
                   6020: ul,
                   6021: div,
                   6022: fieldset {
                   6023:   margin: 10px 10px 10px 0;
                   6024:   /* overflow: hidden; */
1.693     droeschl 6025: }
1.795     www      6026: 
1.838     bisitz   6027: fieldset > legend {
1.911     bisitz   6028:   font-weight: bold;
                   6029:   padding: 0 5px 0 5px;
1.838     bisitz   6030: }
                   6031: 
1.813     bisitz   6032: #LC_nav_bar {
1.911     bisitz   6033:   float: left;
1.966     bisitz   6034:   margin: 0 0 2px 0;
1.807     droeschl 6035: }
                   6036: 
1.916     droeschl 6037: #LC_realm {
                   6038:   margin: 0.2em 0 0 0;
                   6039:   padding: 0;
                   6040:   font-weight: bold;
                   6041:   text-align: center;
                   6042: }
                   6043: 
1.911     bisitz   6044: #LC_nav_bar em {
                   6045:   font-weight: bold;
                   6046:   font-style: normal;
1.807     droeschl 6047: }
                   6048: 
1.897     wenzelju 6049: ol.LC_primary_menu {
1.911     bisitz   6050:   float: right;
1.934     droeschl 6051:   margin: 0;
1.807     droeschl 6052: }
                   6053: 
1.852     droeschl 6054: ol#LC_PathBreadcrumbs {
1.911     bisitz   6055:   margin: 0;
1.693     droeschl 6056: }
                   6057: 
1.897     wenzelju 6058: ol.LC_primary_menu li {
1.911     bisitz   6059:   display: inline;
                   6060:   padding: 5px 5px 0 10px;
                   6061:   vertical-align: top;
1.693     droeschl 6062: }
                   6063: 
1.897     wenzelju 6064: ol.LC_primary_menu li img {
1.911     bisitz   6065:   vertical-align: bottom;
1.934     droeschl 6066:   height: 1.1em;
1.693     droeschl 6067: }
                   6068: 
1.897     wenzelju 6069: ol.LC_primary_menu a {
1.911     bisitz   6070:   color: RGB(80, 80, 80);
                   6071:   text-decoration: none;
1.693     droeschl 6072: }
1.795     www      6073: 
1.949     droeschl 6074: ol.LC_primary_menu a.LC_new_message {
                   6075:   font-weight:bold;
                   6076:   color: darkred;
                   6077: }
                   6078: 
1.975     raeburn  6079: ol.LC_docs_parameters {
                   6080:   margin-left: 0;
                   6081:   padding: 0;
                   6082:   list-style: none;
                   6083: }
                   6084: 
                   6085: ol.LC_docs_parameters li {
                   6086:   margin: 0;
                   6087:   padding-right: 20px;
                   6088:   display: inline;
                   6089: }
                   6090: 
1.976     raeburn  6091: ol.LC_docs_parameters li:before {
                   6092:   content: "\\002022 \\0020";
                   6093: }
                   6094: 
                   6095: li.LC_docs_parameters_title {
                   6096:   font-weight: bold;
                   6097: }
                   6098: 
                   6099: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6100:   content: "";
                   6101: }
                   6102: 
1.897     wenzelju 6103: ul#LC_secondary_menu {
1.911     bisitz   6104:   clear: both;
                   6105:   color: $fontmenu;
                   6106:   background: $tabbg;
                   6107:   list-style: none;
                   6108:   padding: 0;
                   6109:   margin: 0;
                   6110:   width: 100%;
1.808     droeschl 6111: }
                   6112: 
1.897     wenzelju 6113: ul#LC_secondary_menu li {
1.911     bisitz   6114:   font-weight: bold;
                   6115:   line-height: 1.8em;
                   6116:   padding: 0 0.8em;
                   6117:   border-right: 1px solid black;
                   6118:   display: inline;
                   6119:   vertical-align: middle;
1.807     droeschl 6120: }
                   6121: 
1.847     tempelho 6122: ul.LC_TabContent {
1.911     bisitz   6123:   display:block;
                   6124:   background: $sidebg;
                   6125:   border-bottom: solid 1px $lg_border_color;
                   6126:   list-style:none;
                   6127:   margin: 0 -10px;
                   6128:   padding: 0;
1.693     droeschl 6129: }
                   6130: 
1.795     www      6131: ul.LC_TabContent li,
                   6132: ul.LC_TabContentBigger li {
1.911     bisitz   6133:   float:left;
1.741     harmsja  6134: }
1.795     www      6135: 
1.897     wenzelju 6136: ul#LC_secondary_menu li a {
1.911     bisitz   6137:   color: $fontmenu;
                   6138:   text-decoration: none;
1.693     droeschl 6139: }
1.795     www      6140: 
1.721     harmsja  6141: ul.LC_TabContent {
1.952     onken    6142:   min-height:20px;
1.721     harmsja  6143: }
1.795     www      6144: 
                   6145: ul.LC_TabContent li {
1.911     bisitz   6146:   vertical-align:middle;
1.959     onken    6147:   padding: 0 16px 0 10px;
1.911     bisitz   6148:   background-color:$tabbg;
                   6149:   border-bottom:solid 1px $lg_border_color;
1.952     onken    6150:   border-right: solid 1px $font;
1.721     harmsja  6151: }
1.795     www      6152: 
1.847     tempelho 6153: ul.LC_TabContent .right {
1.911     bisitz   6154:   float:right;
1.847     tempelho 6155: }
                   6156: 
1.911     bisitz   6157: ul.LC_TabContent li a,
                   6158: ul.LC_TabContent li {
                   6159:   color:rgb(47,47,47);
                   6160:   text-decoration:none;
                   6161:   font-size:95%;
                   6162:   font-weight:bold;
1.952     onken    6163:   min-height:20px;
                   6164: }
                   6165: 
1.959     onken    6166: ul.LC_TabContent li a:hover,
                   6167: ul.LC_TabContent li a:focus {
1.952     onken    6168:   color: $button_hover;
1.959     onken    6169:   background:none;
                   6170:   outline:none;
1.952     onken    6171: }
                   6172: 
                   6173: ul.LC_TabContent li:hover {
                   6174:   color: $button_hover;
                   6175:   cursor:pointer;
1.721     harmsja  6176: }
1.795     www      6177: 
1.911     bisitz   6178: ul.LC_TabContent li.active {
1.952     onken    6179:   color: $font;
1.911     bisitz   6180:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6181:   border-bottom:solid 1px #FFFFFF;
                   6182:   cursor: default;
1.744     ehlerst  6183: }
1.795     www      6184: 
1.959     onken    6185: ul.LC_TabContent li.active a {
                   6186:   color:$font;
                   6187:   background:#FFFFFF;
                   6188:   outline: none;
                   6189: }
1.870     tempelho 6190: #maincoursedoc {
1.911     bisitz   6191:   clear:both;
1.870     tempelho 6192: }
                   6193: 
                   6194: ul.LC_TabContentBigger {
1.911     bisitz   6195:   display:block;
                   6196:   list-style:none;
                   6197:   padding: 0;
1.870     tempelho 6198: }
                   6199: 
1.795     www      6200: ul.LC_TabContentBigger li {
1.911     bisitz   6201:   vertical-align:bottom;
                   6202:   height: 30px;
                   6203:   font-size:110%;
                   6204:   font-weight:bold;
                   6205:   color: #737373;
1.841     tempelho 6206: }
                   6207: 
1.957     onken    6208: ul.LC_TabContentBigger li.active {
                   6209:   position: relative;
                   6210:   top: 1px;
                   6211: }
                   6212: 
1.870     tempelho 6213: ul.LC_TabContentBigger li a {
1.911     bisitz   6214:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6215:   height: 30px;
                   6216:   line-height: 30px;
                   6217:   text-align: center;
                   6218:   display: block;
                   6219:   text-decoration: none;
1.958     onken    6220:   outline: none;  
1.741     harmsja  6221: }
1.795     www      6222: 
1.870     tempelho 6223: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6224:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6225:   color:$font;
1.744     ehlerst  6226: }
1.795     www      6227: 
1.870     tempelho 6228: ul.LC_TabContentBigger li b {
1.911     bisitz   6229:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6230:   display: block;
                   6231:   float: left;
                   6232:   padding: 0 30px;
1.957     onken    6233:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6234: }
                   6235: 
1.956     onken    6236: ul.LC_TabContentBigger li:hover b {
                   6237:   color:$button_hover;
                   6238: }
                   6239: 
1.870     tempelho 6240: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6241:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6242:   color:$font;
1.957     onken    6243:   border: 0;
1.956     onken    6244:   cursor:default;
1.741     harmsja  6245: }
1.693     droeschl 6246: 
1.870     tempelho 6247: 
1.862     bisitz   6248: ul.LC_CourseBreadcrumbs {
                   6249:   background: $sidebg;
                   6250:   line-height: 32px;
                   6251:   padding-left: 10px;
                   6252:   margin: 0 0 10px 0;
                   6253:   list-style-position: inside;
                   6254: 
                   6255: }
                   6256: 
1.911     bisitz   6257: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6258: ol#LC_PathBreadcrumbs {
1.911     bisitz   6259:   padding-left: 10px;
                   6260:   margin: 0;
1.933     droeschl 6261:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6262: }
                   6263: 
1.911     bisitz   6264: ol#LC_MenuBreadcrumbs li,
                   6265: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6266: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6267:   display: inline;
1.933     droeschl 6268:   white-space: normal;  
1.693     droeschl 6269: }
                   6270: 
1.823     bisitz   6271: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6272: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6273:   text-decoration: none;
                   6274:   font-size:90%;
1.693     droeschl 6275: }
1.795     www      6276: 
1.969     droeschl 6277: ol#LC_MenuBreadcrumbs h1 {
                   6278:   display: inline;
                   6279:   font-size: 90%;
                   6280:   line-height: 2.5em;
                   6281:   margin: 0;
                   6282:   padding: 0;
                   6283: }
                   6284: 
1.795     www      6285: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6286:   text-decoration:none;
                   6287:   font-size:100%;
                   6288:   font-weight:bold;
1.693     droeschl 6289: }
1.795     www      6290: 
1.840     bisitz   6291: .LC_Box {
1.911     bisitz   6292:   border: solid 1px $lg_border_color;
                   6293:   padding: 0 10px 10px 10px;
1.746     neumanie 6294: }
1.795     www      6295: 
                   6296: .LC_AboutMe_Image {
1.911     bisitz   6297:   float:left;
                   6298:   margin-right:10px;
1.747     neumanie 6299: }
1.795     www      6300: 
                   6301: .LC_Clear_AboutMe_Image {
1.911     bisitz   6302:   clear:left;
1.747     neumanie 6303: }
1.795     www      6304: 
1.721     harmsja  6305: dl.LC_ListStyleClean dt {
1.911     bisitz   6306:   padding-right: 5px;
                   6307:   display: table-header-group;
1.693     droeschl 6308: }
                   6309: 
1.721     harmsja  6310: dl.LC_ListStyleClean dd {
1.911     bisitz   6311:   display: table-row;
1.693     droeschl 6312: }
                   6313: 
1.721     harmsja  6314: .LC_ListStyleClean,
                   6315: .LC_ListStyleSimple,
                   6316: .LC_ListStyleNormal,
1.795     www      6317: .LC_ListStyleSpecial {
1.911     bisitz   6318:   /* display:block; */
                   6319:   list-style-position: inside;
                   6320:   list-style-type: none;
                   6321:   overflow: hidden;
                   6322:   padding: 0;
1.693     droeschl 6323: }
                   6324: 
1.721     harmsja  6325: .LC_ListStyleSimple li,
                   6326: .LC_ListStyleSimple dd,
                   6327: .LC_ListStyleNormal li,
                   6328: .LC_ListStyleNormal dd,
                   6329: .LC_ListStyleSpecial li,
1.795     www      6330: .LC_ListStyleSpecial dd {
1.911     bisitz   6331:   margin: 0;
                   6332:   padding: 5px 5px 5px 10px;
                   6333:   clear: both;
1.693     droeschl 6334: }
                   6335: 
1.721     harmsja  6336: .LC_ListStyleClean li,
                   6337: .LC_ListStyleClean dd {
1.911     bisitz   6338:   padding-top: 0;
                   6339:   padding-bottom: 0;
1.693     droeschl 6340: }
                   6341: 
1.721     harmsja  6342: .LC_ListStyleSimple dd,
1.795     www      6343: .LC_ListStyleSimple li {
1.911     bisitz   6344:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6345: }
                   6346: 
1.721     harmsja  6347: .LC_ListStyleSpecial li,
                   6348: .LC_ListStyleSpecial dd {
1.911     bisitz   6349:   list-style-type: none;
                   6350:   background-color: RGB(220, 220, 220);
                   6351:   margin-bottom: 4px;
1.693     droeschl 6352: }
                   6353: 
1.721     harmsja  6354: table.LC_SimpleTable {
1.911     bisitz   6355:   margin:5px;
                   6356:   border:solid 1px $lg_border_color;
1.795     www      6357: }
1.693     droeschl 6358: 
1.721     harmsja  6359: table.LC_SimpleTable tr {
1.911     bisitz   6360:   padding: 0;
                   6361:   border:solid 1px $lg_border_color;
1.693     droeschl 6362: }
1.795     www      6363: 
                   6364: table.LC_SimpleTable thead {
1.911     bisitz   6365:   background:rgb(220,220,220);
1.693     droeschl 6366: }
                   6367: 
1.721     harmsja  6368: div.LC_columnSection {
1.911     bisitz   6369:   display: block;
                   6370:   clear: both;
                   6371:   overflow: hidden;
                   6372:   margin: 0;
1.693     droeschl 6373: }
                   6374: 
1.721     harmsja  6375: div.LC_columnSection>* {
1.911     bisitz   6376:   float: left;
                   6377:   margin: 10px 20px 10px 0;
                   6378:   overflow:hidden;
1.693     droeschl 6379: }
1.721     harmsja  6380: 
1.795     www      6381: table em {
1.911     bisitz   6382:   font-weight: bold;
                   6383:   font-style: normal;
1.748     schulted 6384: }
1.795     www      6385: 
1.779     bisitz   6386: table.LC_tableBrowseRes,
1.795     www      6387: table.LC_tableOfContent {
1.911     bisitz   6388:   border:none;
                   6389:   border-spacing: 1px;
                   6390:   padding: 3px;
                   6391:   background-color: #FFFFFF;
                   6392:   font-size: 90%;
1.753     droeschl 6393: }
1.789     droeschl 6394: 
1.911     bisitz   6395: table.LC_tableOfContent {
                   6396:   border-collapse: collapse;
1.789     droeschl 6397: }
                   6398: 
1.771     droeschl 6399: table.LC_tableBrowseRes a,
1.768     schulted 6400: table.LC_tableOfContent a {
1.911     bisitz   6401:   background-color: transparent;
                   6402:   text-decoration: none;
1.753     droeschl 6403: }
                   6404: 
1.795     www      6405: table.LC_tableOfContent img {
1.911     bisitz   6406:   border: none;
                   6407:   height: 1.3em;
                   6408:   vertical-align: text-bottom;
                   6409:   margin-right: 0.3em;
1.753     droeschl 6410: }
1.757     schulted 6411: 
1.795     www      6412: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6413:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6414: }
                   6415: 
1.795     www      6416: a#LC_content_toolbar_everything {
1.911     bisitz   6417:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6418: }
                   6419: 
1.795     www      6420: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6421:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6422: }
                   6423: 
1.795     www      6424: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6425:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6426: }
                   6427: 
1.795     www      6428: a#LC_content_toolbar_changefolder {
1.911     bisitz   6429:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6430: }
                   6431: 
1.795     www      6432: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6433:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6434: }
                   6435: 
1.795     www      6436: ul#LC_toolbar li a:hover {
1.911     bisitz   6437:   background-position: bottom center;
1.757     schulted 6438: }
                   6439: 
1.795     www      6440: ul#LC_toolbar {
1.911     bisitz   6441:   padding: 0;
                   6442:   margin: 2px;
                   6443:   list-style:none;
                   6444:   position:relative;
                   6445:   background-color:white;
1.757     schulted 6446: }
                   6447: 
1.795     www      6448: ul#LC_toolbar li {
1.911     bisitz   6449:   border:1px solid white;
                   6450:   padding: 0;
                   6451:   margin: 0;
                   6452:   float: left;
                   6453:   display:inline;
                   6454:   vertical-align:middle;
                   6455: }
1.757     schulted 6456: 
1.783     amueller 6457: 
1.795     www      6458: a.LC_toolbarItem {
1.911     bisitz   6459:   display:block;
                   6460:   padding: 0;
                   6461:   margin: 0;
                   6462:   height: 32px;
                   6463:   width: 32px;
                   6464:   color:white;
                   6465:   border: none;
                   6466:   background-repeat:no-repeat;
                   6467:   background-color:transparent;
1.757     schulted 6468: }
                   6469: 
1.915     droeschl 6470: ul.LC_funclist {
                   6471:     margin: 0;
                   6472:     padding: 0.5em 1em 0.5em 0;
                   6473: }
                   6474: 
1.933     droeschl 6475: ul.LC_funclist > li:first-child {
                   6476:     font-weight:bold; 
                   6477:     margin-left:0.8em;
                   6478: }
                   6479: 
1.915     droeschl 6480: ul.LC_funclist + ul.LC_funclist {
                   6481:     /* 
                   6482:        left border as a seperator if we have more than
                   6483:        one list 
                   6484:     */
                   6485:     border-left: 1px solid $sidebg;
                   6486:     /* 
                   6487:        this hides the left border behind the border of the 
                   6488:        outer box if element is wrapped to the next 'line' 
                   6489:     */
                   6490:     margin-left: -1px;
                   6491: }
                   6492: 
1.843     bisitz   6493: ul.LC_funclist li {
1.915     droeschl 6494:   display: inline;
1.782     bisitz   6495:   white-space: nowrap;
1.915     droeschl 6496:   margin: 0 0 0 25px;
                   6497:   line-height: 150%;
1.782     bisitz   6498: }
                   6499: 
1.930     faziophi 6500: .ui-accordion .LC_advanced_toggle {
                   6501:   float: right;
                   6502:   font-size: 90%;
                   6503:   padding: 0px 4px
                   6504: }
1.757     schulted 6505: 
1.974     wenzelju 6506: .LC_hidden {
                   6507:   display: none;
                   6508: }
                   6509: 
1.343     albertel 6510: END
                   6511: }
                   6512: 
1.306     albertel 6513: =pod
                   6514: 
                   6515: =item * &headtag()
                   6516: 
                   6517: Returns a uniform footer for LON-CAPA web pages.
                   6518: 
1.307     albertel 6519: Inputs: $title - optional title for the head
                   6520:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6521:         $args - optional arguments
1.319     albertel 6522:             force_register - if is true call registerurl so the remote is 
                   6523:                              informed
1.415     albertel 6524:             redirect       -> array ref of
                   6525:                                    1- seconds before redirect occurs
                   6526:                                    2- url to redirect to
                   6527:                                    3- whether the side effect should occur
1.315     albertel 6528:                            (side effect of setting 
                   6529:                                $env{'internal.head.redirect'} to the url 
                   6530:                                redirected too)
1.352     albertel 6531:             domain         -> force to color decorate a page for a specific
                   6532:                                domain
                   6533:             function       -> force usage of a specific rolish color scheme
                   6534:             bgcolor        -> override the default page bgcolor
1.460     albertel 6535:             no_auto_mt_title
                   6536:                            -> prevent &mt()ing the title arg
1.464     albertel 6537: 
1.306     albertel 6538: =cut
                   6539: 
                   6540: sub headtag {
1.313     albertel 6541:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6542:     
1.363     albertel 6543:     my $function = $args->{'function'} || &get_users_function();
                   6544:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6545:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6546:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6547: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6548: 		   #time(),
1.418     albertel 6549: 		   $env{'environment.color.timestamp'},
1.363     albertel 6550: 		   $function,$domain,$bgcolor);
                   6551: 
1.369     www      6552:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6553: 
1.308     albertel 6554:     my $result =
                   6555: 	'<head>'.
1.461     albertel 6556: 	&font_settings();
1.319     albertel 6557: 
1.461     albertel 6558:     if (!$args->{'frameset'}) {
                   6559: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6560:     }
1.962     droeschl 6561:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6562:         $result .= Apache::lonxml::display_title();
1.319     albertel 6563:     }
1.436     albertel 6564:     if (!$args->{'no_nav_bar'} 
                   6565: 	&& !$args->{'only_body'}
                   6566: 	&& !$args->{'frameset'}) {
                   6567: 	$result .= &help_menu_js();
                   6568:     }
1.319     albertel 6569: 
1.314     albertel 6570:     if (ref($args->{'redirect'})) {
1.414     albertel 6571: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6572: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6573: 	if (!$inhibit_continue) {
                   6574: 	    $env{'internal.head.redirect'} = $url;
                   6575: 	}
1.313     albertel 6576: 	$result.=<<ADDMETA
                   6577: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6578: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6579: ADDMETA
                   6580:     }
1.306     albertel 6581:     if (!defined($title)) {
                   6582: 	$title = 'The LearningOnline Network with CAPA';
                   6583:     }
1.460     albertel 6584:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6585:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6586: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6587: 	.$head_extra;
1.962     droeschl 6588:     return $result.'</head>';
1.306     albertel 6589: }
                   6590: 
                   6591: =pod
                   6592: 
1.340     albertel 6593: =item * &font_settings()
                   6594: 
                   6595: Returns neccessary <meta> to set the proper encoding
                   6596: 
                   6597: Inputs: none
                   6598: 
                   6599: =cut
                   6600: 
                   6601: sub font_settings {
                   6602:     my $headerstring='';
1.647     www      6603:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6604: 	$headerstring.=
                   6605: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6606:     }
                   6607:     return $headerstring;
                   6608: }
                   6609: 
1.341     albertel 6610: =pod
                   6611: 
                   6612: =item * &xml_begin()
                   6613: 
                   6614: Returns the needed doctype and <html>
                   6615: 
                   6616: Inputs: none
                   6617: 
                   6618: =cut
                   6619: 
                   6620: sub xml_begin {
                   6621:     my $output='';
                   6622: 
                   6623:     if ($env{'browser.mathml'}) {
                   6624: 	$output='<?xml version="1.0"?>'
                   6625:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6626: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6627:             
                   6628: #	    .'<!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">] >'
                   6629: 	    .'<!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">'
                   6630:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6631: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6632:     } else {
1.849     bisitz   6633: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6634:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6635:     }
                   6636:     return $output;
                   6637: }
1.340     albertel 6638: 
                   6639: =pod
                   6640: 
1.306     albertel 6641: =item * &start_page()
                   6642: 
                   6643: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6644: 
1.648     raeburn  6645: Inputs:
                   6646: 
                   6647: =over 4
                   6648: 
                   6649: $title - optional title for the page
                   6650: 
                   6651: $head_extra - optional extra HTML to incude inside the <head>
                   6652: 
                   6653: $args - additional optional args supported are:
                   6654: 
                   6655: =over 8
                   6656: 
                   6657:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6658:                                     arg on
1.814     bisitz   6659:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6660:              add_entries    -> additional attributes to add to the  <body>
                   6661:              domain         -> force to color decorate a page for a 
1.317     albertel 6662:                                     specific domain
1.648     raeburn  6663:              function       -> force usage of a specific rolish color
1.317     albertel 6664:                                     scheme
1.648     raeburn  6665:              redirect       -> see &headtag()
                   6666:              bgcolor        -> override the default page bg color
                   6667:              js_ready       -> return a string ready for being used in 
1.317     albertel 6668:                                     a javascript writeln
1.648     raeburn  6669:              html_encode    -> return a string ready for being used in 
1.320     albertel 6670:                                     a html attribute
1.648     raeburn  6671:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6672:                                     $forcereg arg
1.648     raeburn  6673:              frameset       -> if true will start with a <frameset>
1.330     albertel 6674:                                     rather than <body>
1.648     raeburn  6675:              skip_phases    -> hash ref of 
1.338     albertel 6676:                                     head -> skip the <html><head> generation
                   6677:                                     body -> skip all <body> generation
1.648     raeburn  6678:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6679:              inherit_jsmath -> when creating popup window in a page,
                   6680:                                     should it have jsmath forced on by the
                   6681:                                     current page
1.867     kalberla 6682:              bread_crumbs ->             Array containing breadcrumbs
                   6683:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6684: 
1.648     raeburn  6685: =back
1.460     albertel 6686: 
1.648     raeburn  6687: =back
1.562     albertel 6688: 
1.306     albertel 6689: =cut
                   6690: 
                   6691: sub start_page {
1.309     albertel 6692:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6693:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.964     droeschl 6694: #SD
                   6695: #I don't see why we copy certain elements of %$args to %head_args
                   6696: #head args is passed to headtag() and this routine only reads those
                   6697: #keys that are needed. There doesn't happen any writes or any processing
                   6698: #of other keys.
                   6699: #proposal: just pass $args to headtag instead of \%head_args and delete 
                   6700: #marked lines
                   6701: #<- MARK
1.313     albertel 6702:     my %head_args;
1.352     albertel 6703:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6704: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6705: 		     'no_auto_mt_title') {
1.319     albertel 6706: 	if (defined($args->{$arg})) {
1.324     raeburn  6707: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6708: 	}
1.313     albertel 6709:     }
1.964     droeschl 6710: #MARK ->
1.319     albertel 6711: 
1.315     albertel 6712:     $env{'internal.start_page'}++;
1.338     albertel 6713:     my $result;
1.964     droeschl 6714: 
1.338     albertel 6715:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.964     droeschl 6716:         $result .= 
                   6717:                   &xml_begin() . &headtag($title,$head_extra,\%head_args);
                   6718: #replace prev line by
                   6719: #                 &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 6720:     }
                   6721:     
                   6722:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6723: 	if ($args->{'frameset'}) {
                   6724: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6725: 						$args->{'add_entries'});
                   6726: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6727:         } else {
                   6728:             $result .=
                   6729:                 &bodytag($title, 
                   6730:                          $args->{'function'},       $args->{'add_entries'},
                   6731:                          $args->{'only_body'},      $args->{'domain'},
                   6732:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 6733:                          $args->{'bgcolor'},        $args);
1.831     bisitz   6734:         }
1.330     albertel 6735:     }
1.338     albertel 6736: 
1.315     albertel 6737:     if ($args->{'js_ready'}) {
1.713     kaisler  6738: 		$result = &js_ready($result);
1.315     albertel 6739:     }
1.320     albertel 6740:     if ($args->{'html_encode'}) {
1.713     kaisler  6741: 		$result = &html_encode($result);
                   6742:     }
                   6743: 
1.813     bisitz   6744:     # Preparation for new and consistent functionlist at top of screen
                   6745:     # if ($args->{'functionlist'}) {
                   6746:     #            $result .= &build_functionlist();
                   6747:     #}
                   6748: 
1.964     droeschl 6749:     # Don't add anything more if only_body wanted or in const space
                   6750:     return $result if    $args->{'only_body'} 
                   6751:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   6752: 
                   6753:     #Breadcrumbs
1.758     kaisler  6754:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6755: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6756: 		#if any br links exists, add them to the breadcrumbs
                   6757: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6758: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6759: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6760: 			}
                   6761: 		}
                   6762: 
                   6763: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6764: 		if(exists($args->{'bread_crumbs_component'})){
                   6765: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6766: 		}else{
                   6767: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6768: 		}
1.320     albertel 6769:     }
1.315     albertel 6770:     return $result;
1.306     albertel 6771: }
                   6772: 
                   6773: sub end_page {
1.315     albertel 6774:     my ($args) = @_;
                   6775:     $env{'internal.end_page'}++;
1.330     albertel 6776:     my $result;
1.335     albertel 6777:     if ($args->{'discussion'}) {
                   6778: 	my ($target,$parser);
                   6779: 	if (ref($args->{'discussion'})) {
                   6780: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6781: 				$args->{'discussion'}{'parser'});
                   6782: 	}
                   6783: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6784:     }
                   6785: 
1.330     albertel 6786:     if ($args->{'frameset'}) {
                   6787: 	$result .= '</frameset>';
                   6788:     } else {
1.635     raeburn  6789: 	$result .= &endbodytag($args);
1.330     albertel 6790:     }
                   6791:     $result .= "\n</html>";
                   6792: 
1.315     albertel 6793:     if ($args->{'js_ready'}) {
1.317     albertel 6794: 	$result = &js_ready($result);
1.315     albertel 6795:     }
1.335     albertel 6796: 
1.320     albertel 6797:     if ($args->{'html_encode'}) {
                   6798: 	$result = &html_encode($result);
                   6799:     }
1.335     albertel 6800: 
1.315     albertel 6801:     return $result;
                   6802: }
                   6803: 
1.320     albertel 6804: sub html_encode {
                   6805:     my ($result) = @_;
                   6806: 
1.322     albertel 6807:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6808:     
                   6809:     return $result;
                   6810: }
1.317     albertel 6811: sub js_ready {
                   6812:     my ($result) = @_;
                   6813: 
1.323     albertel 6814:     $result =~ s/[\n\r]/ /xmsg;
                   6815:     $result =~ s/\\/\\\\/xmsg;
                   6816:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6817:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6818:     
                   6819:     return $result;
                   6820: }
                   6821: 
1.315     albertel 6822: sub validate_page {
                   6823:     if (  exists($env{'internal.start_page'})
1.316     albertel 6824: 	  &&     $env{'internal.start_page'} > 1) {
                   6825: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6826: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6827: 				 $ENV{'request.filename'});
1.315     albertel 6828:     }
                   6829:     if (  exists($env{'internal.end_page'})
1.316     albertel 6830: 	  &&     $env{'internal.end_page'} > 1) {
                   6831: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6832: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6833: 				 $env{'request.filename'});
1.315     albertel 6834:     }
                   6835:     if (     exists($env{'internal.start_page'})
                   6836: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6837: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6838: 				 $env{'request.filename'});
1.315     albertel 6839:     }
                   6840:     if (   ! exists($env{'internal.start_page'})
                   6841: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6842: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6843: 				 $env{'request.filename'});
1.315     albertel 6844:     }
1.306     albertel 6845: }
1.315     albertel 6846: 
1.318     albertel 6847: sub simple_error_page {
                   6848:     my ($r,$title,$msg) = @_;
                   6849:     my $page =
                   6850: 	&Apache::loncommon::start_page($title).
                   6851: 	&mt($msg).
                   6852: 	&Apache::loncommon::end_page();
                   6853:     if (ref($r)) {
                   6854: 	$r->print($page);
1.327     albertel 6855: 	return;
1.318     albertel 6856:     }
                   6857:     return $page;
                   6858: }
1.347     albertel 6859: 
                   6860: {
1.610     albertel 6861:     my @row_count;
1.961     onken    6862: 
                   6863:     sub start_data_table_count {
                   6864:         unshift(@row_count, 0);
                   6865:         return;
                   6866:     }
                   6867: 
                   6868:     sub end_data_table_count {
                   6869:         shift(@row_count);
                   6870:         return;
                   6871:     }
                   6872: 
1.347     albertel 6873:     sub start_data_table {
1.422     albertel 6874: 	my ($add_class) = @_;
                   6875: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.961     onken    6876: 	&start_data_table_count();
1.422     albertel 6877: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6878:     }
                   6879: 
                   6880:     sub end_data_table {
1.961     onken    6881: 	&end_data_table_count();
1.389     albertel 6882: 	return '</table>'."\n";;
1.347     albertel 6883:     }
                   6884: 
                   6885:     sub start_data_table_row {
1.974     wenzelju 6886: 	my ($add_class, $id) = @_;
1.610     albertel 6887: 	$row_count[0]++;
                   6888: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6889: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 6890:         $id = (' id="'.$id.'"') unless ($id eq '');
                   6891:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 6892:     }
1.471     banghart 6893:     
                   6894:     sub continue_data_table_row {
1.974     wenzelju 6895: 	my ($add_class, $id) = @_;
1.610     albertel 6896: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 6897: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   6898:         $id = (' id="'.$id.'"') unless ($id eq '');
                   6899:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 6900:     }
1.347     albertel 6901: 
                   6902:     sub end_data_table_row {
1.389     albertel 6903: 	return '</tr>'."\n";;
1.347     albertel 6904:     }
1.367     www      6905: 
1.421     albertel 6906:     sub start_data_table_empty_row {
1.707     bisitz   6907: #	$row_count[0]++;
1.421     albertel 6908: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6909:     }
                   6910: 
                   6911:     sub end_data_table_empty_row {
                   6912: 	return '</tr>'."\n";;
                   6913:     }
                   6914: 
1.367     www      6915:     sub start_data_table_header_row {
1.389     albertel 6916: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6917:     }
                   6918: 
                   6919:     sub end_data_table_header_row {
1.389     albertel 6920: 	return '</tr>'."\n";;
1.367     www      6921:     }
1.890     droeschl 6922: 
                   6923:     sub data_table_caption {
                   6924:         my $caption = shift;
                   6925:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6926:     }
1.347     albertel 6927: }
                   6928: 
1.548     albertel 6929: =pod
                   6930: 
                   6931: =item * &inhibit_menu_check($arg)
                   6932: 
                   6933: Checks for a inhibitmenu state and generates output to preserve it
                   6934: 
                   6935: Inputs:         $arg - can be any of
                   6936:                      - undef - in which case the return value is a string 
                   6937:                                to add  into arguments list of a uri
                   6938:                      - 'input' - in which case the return value is a HTML
                   6939:                                  <form> <input> field of type hidden to
                   6940:                                  preserve the value
                   6941:                      - a url - in which case the return value is the url with
                   6942:                                the neccesary cgi args added to preserve the
                   6943:                                inhibitmenu state
                   6944:                      - a ref to a url - no return value, but the string is
                   6945:                                         updated to include the neccessary cgi
                   6946:                                         args to preserve the inhibitmenu state
                   6947: 
                   6948: =cut
                   6949: 
                   6950: sub inhibit_menu_check {
                   6951:     my ($arg) = @_;
                   6952:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6953:     if ($arg eq 'input') {
                   6954: 	if ($env{'form.inhibitmenu'}) {
                   6955: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6956: 	} else {
                   6957: 	    return
                   6958: 	}
                   6959:     }
                   6960:     if ($env{'form.inhibitmenu'}) {
                   6961: 	if (ref($arg)) {
                   6962: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6963: 	} elsif ($arg eq '') {
                   6964: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6965: 	} else {
                   6966: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6967: 	}
                   6968:     }
                   6969:     if (!ref($arg)) {
                   6970: 	return $arg;
                   6971:     }
                   6972: }
                   6973: 
1.251     albertel 6974: ###############################################
1.182     matthew  6975: 
                   6976: =pod
                   6977: 
1.549     albertel 6978: =back
                   6979: 
                   6980: =head1 User Information Routines
                   6981: 
                   6982: =over 4
                   6983: 
1.405     albertel 6984: =item * &get_users_function()
1.182     matthew  6985: 
                   6986: Used by &bodytag to determine the current users primary role.
                   6987: Returns either 'student','coordinator','admin', or 'author'.
                   6988: 
                   6989: =cut
                   6990: 
                   6991: ###############################################
                   6992: sub get_users_function {
1.815     tempelho 6993:     my $function = 'norole';
1.818     tempelho 6994:     if ($env{'request.role'}=~/^(st)/) {
                   6995:         $function='student';
                   6996:     }
1.907     raeburn  6997:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  6998:         $function='coordinator';
                   6999:     }
1.258     albertel 7000:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7001:         $function='admin';
                   7002:     }
1.826     bisitz   7003:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7004:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7005:         $function='author';
                   7006:     }
                   7007:     return $function;
1.54      www      7008: }
1.99      www      7009: 
                   7010: ###############################################
                   7011: 
1.233     raeburn  7012: =pod
                   7013: 
1.821     raeburn  7014: =item * &show_course()
                   7015: 
                   7016: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7017: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7018: 
                   7019: Inputs:
                   7020: None
                   7021: 
                   7022: Outputs:
                   7023: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7024: 
                   7025: =cut
                   7026: 
                   7027: ###############################################
                   7028: sub show_course {
                   7029:     my $course = !$env{'user.adv'};
                   7030:     if (!$env{'user.adv'}) {
                   7031:         foreach my $env (keys(%env)) {
                   7032:             next if ($env !~ m/^user\.priv\./);
                   7033:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7034:                 $course = 0;
                   7035:                 last;
                   7036:             }
                   7037:         }
                   7038:     }
                   7039:     return $course;
                   7040: }
                   7041: 
                   7042: ###############################################
                   7043: 
                   7044: =pod
                   7045: 
1.542     raeburn  7046: =item * &check_user_status()
1.274     raeburn  7047: 
                   7048: Determines current status of supplied role for a
                   7049: specific user. Roles can be active, previous or future.
                   7050: 
                   7051: Inputs: 
                   7052: user's domain, user's username, course's domain,
1.375     raeburn  7053: course's number, optional section ID.
1.274     raeburn  7054: 
                   7055: Outputs:
                   7056: role status: active, previous or future. 
                   7057: 
                   7058: =cut
                   7059: 
                   7060: sub check_user_status {
1.412     raeburn  7061:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7062:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7063:     my @uroles = keys %userinfo;
                   7064:     my $srchstr;
                   7065:     my $active_chk = 'none';
1.412     raeburn  7066:     my $now = time;
1.274     raeburn  7067:     if (@uroles > 0) {
1.908     raeburn  7068:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7069:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7070:         } else {
1.412     raeburn  7071:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7072:         }
                   7073:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7074:             my $role_end = 0;
                   7075:             my $role_start = 0;
                   7076:             $active_chk = 'active';
1.412     raeburn  7077:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7078:                 $role_end = $1;
                   7079:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7080:                     $role_start = $1;
1.274     raeburn  7081:                 }
                   7082:             }
                   7083:             if ($role_start > 0) {
1.412     raeburn  7084:                 if ($now < $role_start) {
1.274     raeburn  7085:                     $active_chk = 'future';
                   7086:                 }
                   7087:             }
                   7088:             if ($role_end > 0) {
1.412     raeburn  7089:                 if ($now > $role_end) {
1.274     raeburn  7090:                     $active_chk = 'previous';
                   7091:                 }
                   7092:             }
                   7093:         }
                   7094:     }
                   7095:     return $active_chk;
                   7096: }
                   7097: 
                   7098: ###############################################
                   7099: 
                   7100: =pod
                   7101: 
1.405     albertel 7102: =item * &get_sections()
1.233     raeburn  7103: 
                   7104: Determines all the sections for a course including
                   7105: sections with students and sections containing other roles.
1.419     raeburn  7106: Incoming parameters: 
                   7107: 
                   7108: 1. domain
                   7109: 2. course number 
                   7110: 3. reference to array containing roles for which sections should 
                   7111: be gathered (optional).
                   7112: 4. reference to array containing status types for which sections 
                   7113: should be gathered (optional).
                   7114: 
                   7115: If the third argument is undefined, sections are gathered for any role. 
                   7116: If the fourth argument is undefined, sections are gathered for any status.
                   7117: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7118:  
1.374     raeburn  7119: Returns section hash (keys are section IDs, values are
                   7120: number of users in each section), subject to the
1.419     raeburn  7121: optional roles filter, optional status filter 
1.233     raeburn  7122: 
                   7123: =cut
                   7124: 
                   7125: ###############################################
                   7126: sub get_sections {
1.419     raeburn  7127:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7128:     if (!defined($cdom) || !defined($cnum)) {
                   7129:         my $cid =  $env{'request.course.id'};
                   7130: 
                   7131: 	return if (!defined($cid));
                   7132: 
                   7133:         $cdom = $env{'course.'.$cid.'.domain'};
                   7134:         $cnum = $env{'course.'.$cid.'.num'};
                   7135:     }
                   7136: 
                   7137:     my %sectioncount;
1.419     raeburn  7138:     my $now = time;
1.240     albertel 7139: 
1.366     albertel 7140:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7141: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7142: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7143: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7144:         my $start_index = &Apache::loncoursedata::CL_START();
                   7145:         my $end_index = &Apache::loncoursedata::CL_END();
                   7146:         my $status;
1.366     albertel 7147: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7148: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7149: 				                     $data->[$status_index],
                   7150:                                                      $data->[$start_index],
                   7151:                                                      $data->[$end_index]);
                   7152:             if ($stu_status eq 'Active') {
                   7153:                 $status = 'active';
                   7154:             } elsif ($end < $now) {
                   7155:                 $status = 'previous';
                   7156:             } elsif ($start > $now) {
                   7157:                 $status = 'future';
                   7158:             } 
                   7159: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7160:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7161:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7162: 		    $sectioncount{$section}++;
                   7163:                 }
1.240     albertel 7164: 	    }
                   7165: 	}
                   7166:     }
                   7167:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7168:     foreach my $user (sort(keys(%courseroles))) {
                   7169: 	if ($user !~ /^(\w{2})/) { next; }
                   7170: 	my ($role) = ($user =~ /^(\w{2})/);
                   7171: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7172: 	my ($section,$status);
1.240     albertel 7173: 	if ($role eq 'cr' &&
                   7174: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7175: 	    $section=$1;
                   7176: 	}
                   7177: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7178: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7179:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7180:         if ($end == -1 && $start == -1) {
                   7181:             next; #deleted role
                   7182:         }
                   7183:         if (!defined($possible_status)) { 
                   7184:             $sectioncount{$section}++;
                   7185:         } else {
                   7186:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7187:                 $status = 'active';
                   7188:             } elsif ($end < $now) {
                   7189:                 $status = 'future';
                   7190:             } elsif ($start > $now) {
                   7191:                 $status = 'previous';
                   7192:             }
                   7193:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7194:                 $sectioncount{$section}++;
                   7195:             }
                   7196:         }
1.233     raeburn  7197:     }
1.366     albertel 7198:     return %sectioncount;
1.233     raeburn  7199: }
                   7200: 
1.274     raeburn  7201: ###############################################
1.294     raeburn  7202: 
                   7203: =pod
1.405     albertel 7204: 
                   7205: =item * &get_course_users()
                   7206: 
1.275     raeburn  7207: Retrieves usernames:domains for users in the specified course
                   7208: with specific role(s), and access status. 
                   7209: 
                   7210: Incoming parameters:
1.277     albertel 7211: 1. course domain
                   7212: 2. course number
                   7213: 3. access status: users must have - either active, 
1.275     raeburn  7214: previous, future, or all.
1.277     albertel 7215: 4. reference to array of permissible roles
1.288     raeburn  7216: 5. reference to array of section restrictions (optional)
                   7217: 6. reference to results object (hash of hashes).
                   7218: 7. reference to optional userdata hash
1.609     raeburn  7219: 8. reference to optional statushash
1.630     raeburn  7220: 9. flag if privileged users (except those set to unhide in
                   7221:    course settings) should be excluded    
1.609     raeburn  7222: Keys of top level results hash are roles.
1.275     raeburn  7223: Keys of inner hashes are username:domain, with 
                   7224: values set to access type.
1.288     raeburn  7225: Optional userdata hash returns an array with arguments in the 
                   7226: same order as loncoursedata::get_classlist() for student data.
                   7227: 
1.609     raeburn  7228: Optional statushash returns
                   7229: 
1.288     raeburn  7230: Entries for end, start, section and status are blank because
                   7231: of the possibility of multiple values for non-student roles.
                   7232: 
1.275     raeburn  7233: =cut
1.405     albertel 7234: 
1.275     raeburn  7235: ###############################################
1.405     albertel 7236: 
1.275     raeburn  7237: sub get_course_users {
1.630     raeburn  7238:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7239:     my %idx = ();
1.419     raeburn  7240:     my %seclists;
1.288     raeburn  7241: 
                   7242:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7243:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7244:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7245:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7246:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7247:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7248:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7249:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7250: 
1.290     albertel 7251:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7252:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7253:         my $now = time;
1.277     albertel 7254:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7255:             my $match = 0;
1.412     raeburn  7256:             my $secmatch = 0;
1.419     raeburn  7257:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7258:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7259:             if ($section eq '') {
                   7260:                 $section = 'none';
                   7261:             }
1.291     albertel 7262:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7263:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7264:                     $secmatch = 1;
                   7265:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7266:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7267:                         $secmatch = 1;
                   7268:                     }
                   7269:                 } else {  
1.419     raeburn  7270: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7271: 		        $secmatch = 1;
                   7272:                     }
1.290     albertel 7273: 		}
1.412     raeburn  7274:                 if (!$secmatch) {
                   7275:                     next;
                   7276:                 }
1.419     raeburn  7277:             }
1.275     raeburn  7278:             if (defined($$types{'active'})) {
1.288     raeburn  7279:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7280:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7281:                     $match = 1;
1.275     raeburn  7282:                 }
                   7283:             }
                   7284:             if (defined($$types{'previous'})) {
1.609     raeburn  7285:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7286:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7287:                     $match = 1;
1.275     raeburn  7288:                 }
                   7289:             }
                   7290:             if (defined($$types{'future'})) {
1.609     raeburn  7291:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7292:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7293:                     $match = 1;
1.275     raeburn  7294:                 }
                   7295:             }
1.609     raeburn  7296:             if ($match) {
                   7297:                 push(@{$seclists{$student}},$section);
                   7298:                 if (ref($userdata) eq 'HASH') {
                   7299:                     $$userdata{$student} = $$classlist{$student};
                   7300:                 }
                   7301:                 if (ref($statushash) eq 'HASH') {
                   7302:                     $statushash->{$student}{'st'}{$section} = $status;
                   7303:                 }
1.288     raeburn  7304:             }
1.275     raeburn  7305:         }
                   7306:     }
1.412     raeburn  7307:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7308:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7309:         my $now = time;
1.609     raeburn  7310:         my %displaystatus = ( previous => 'Expired',
                   7311:                               active   => 'Active',
                   7312:                               future   => 'Future',
                   7313:                             );
1.630     raeburn  7314:         my %nothide;
                   7315:         if ($hidepriv) {
                   7316:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7317:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7318:                 if ($user !~ /:/) {
                   7319:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7320:                 } else {
                   7321:                     $nothide{$user} = 1;
                   7322:                 }
                   7323:             }
                   7324:         }
1.439     raeburn  7325:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7326:             my $match = 0;
1.412     raeburn  7327:             my $secmatch = 0;
1.439     raeburn  7328:             my $status;
1.412     raeburn  7329:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7330:             $user =~ s/:$//;
1.439     raeburn  7331:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7332:             if ($end == -1 || $start == -1) {
                   7333:                 next;
                   7334:             }
                   7335:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7336:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7337:                 my ($uname,$udom) = split(/:/,$user);
                   7338:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7339:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7340:                         $secmatch = 1;
                   7341:                     } elsif ($usec eq '') {
1.420     albertel 7342:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7343:                             $secmatch = 1;
                   7344:                         }
                   7345:                     } else {
                   7346:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7347:                             $secmatch = 1;
                   7348:                         }
                   7349:                     }
                   7350:                     if (!$secmatch) {
                   7351:                         next;
                   7352:                     }
1.288     raeburn  7353:                 }
1.419     raeburn  7354:                 if ($usec eq '') {
                   7355:                     $usec = 'none';
                   7356:                 }
1.275     raeburn  7357:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7358:                     if ($hidepriv) {
                   7359:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7360:                             (!$nothide{$uname.':'.$udom})) {
                   7361:                             next;
                   7362:                         }
                   7363:                     }
1.503     raeburn  7364:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7365:                         $status = 'previous';
                   7366:                     } elsif ($start > $now) {
                   7367:                         $status = 'future';
                   7368:                     } else {
                   7369:                         $status = 'active';
                   7370:                     }
1.277     albertel 7371:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7372:                         if ($status eq $type) {
1.420     albertel 7373:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7374:                                 push(@{$$users{$role}{$user}},$type);
                   7375:                             }
1.288     raeburn  7376:                             $match = 1;
                   7377:                         }
                   7378:                     }
1.419     raeburn  7379:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7380:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7381: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7382:                         }
1.420     albertel 7383:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7384:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7385:                         }
1.609     raeburn  7386:                         if (ref($statushash) eq 'HASH') {
                   7387:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7388:                         }
1.275     raeburn  7389:                     }
                   7390:                 }
                   7391:             }
                   7392:         }
1.290     albertel 7393:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7394:             if ((defined($cdom)) && (defined($cnum))) {
                   7395:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7396:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7397:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7398:                     next if ($owner eq '');
                   7399:                     my ($ownername,$ownerdom);
                   7400:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7401:                         $ownername = $1;
                   7402:                         $ownerdom = $2;
                   7403:                     } else {
                   7404:                         $ownername = $owner;
                   7405:                         $ownerdom = $cdom;
                   7406:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7407:                     }
                   7408:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7409:                     if (defined($userdata) && 
1.609     raeburn  7410: 			!exists($$userdata{$owner})) {
                   7411: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7412:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7413:                             push(@{$seclists{$owner}},'none');
                   7414:                         }
                   7415:                         if (ref($statushash) eq 'HASH') {
                   7416:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7417:                         }
1.290     albertel 7418: 		    }
1.279     raeburn  7419:                 }
                   7420:             }
                   7421:         }
1.419     raeburn  7422:         foreach my $user (keys(%seclists)) {
                   7423:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7424:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7425:         }
1.275     raeburn  7426:     }
                   7427:     return;
                   7428: }
                   7429: 
1.288     raeburn  7430: sub get_user_info {
                   7431:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7432:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7433: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7434:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7435:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7436:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7437:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7438:     return;
                   7439: }
1.275     raeburn  7440: 
1.472     raeburn  7441: ###############################################
                   7442: 
                   7443: =pod
                   7444: 
                   7445: =item * &get_user_quota()
                   7446: 
                   7447: Retrieves quota assigned for storage of portfolio files for a user  
                   7448: 
                   7449: Incoming parameters:
                   7450: 1. user's username
                   7451: 2. user's domain
                   7452: 
                   7453: Returns:
1.536     raeburn  7454: 1. Disk quota (in Mb) assigned to student.
                   7455: 2. (Optional) Type of setting: custom or default
                   7456:    (individually assigned or default for user's 
                   7457:    institutional status).
                   7458: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7459:    or student - types as defined in localenroll::inst_usertypes 
                   7460:    for user's domain, which determines default quota for user.
                   7461: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7462: 
                   7463: If a value has been stored in the user's environment, 
1.536     raeburn  7464: it will return that, otherwise it returns the maximal default
                   7465: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7466: 
                   7467: =cut
                   7468: 
                   7469: ###############################################
                   7470: 
                   7471: 
                   7472: sub get_user_quota {
                   7473:     my ($uname,$udom) = @_;
1.536     raeburn  7474:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7475:     if (!defined($udom)) {
                   7476:         $udom = $env{'user.domain'};
                   7477:     }
                   7478:     if (!defined($uname)) {
                   7479:         $uname = $env{'user.name'};
                   7480:     }
                   7481:     if (($udom eq '' || $uname eq '') ||
                   7482:         ($udom eq 'public') && ($uname eq 'public')) {
                   7483:         $quota = 0;
1.536     raeburn  7484:         $quotatype = 'default';
                   7485:         $defquota = 0; 
1.472     raeburn  7486:     } else {
1.536     raeburn  7487:         my $inststatus;
1.472     raeburn  7488:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7489:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7490:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7491:         } else {
1.536     raeburn  7492:             my %userenv = 
                   7493:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7494:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7495:             my ($tmp) = keys(%userenv);
                   7496:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7497:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7498:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7499:             } else {
                   7500:                 undef(%userenv);
                   7501:             }
                   7502:         }
1.536     raeburn  7503:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7504:         if ($quota eq '') {
1.536     raeburn  7505:             $quota = $defquota;
                   7506:             $quotatype = 'default';
                   7507:         } else {
                   7508:             $quotatype = 'custom';
1.472     raeburn  7509:         }
                   7510:     }
1.536     raeburn  7511:     if (wantarray) {
                   7512:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7513:     } else {
                   7514:         return $quota;
                   7515:     }
1.472     raeburn  7516: }
                   7517: 
                   7518: ###############################################
                   7519: 
                   7520: =pod
                   7521: 
                   7522: =item * &default_quota()
                   7523: 
1.536     raeburn  7524: Retrieves default quota assigned for storage of user portfolio files,
                   7525: given an (optional) user's institutional status.
1.472     raeburn  7526: 
                   7527: Incoming parameters:
                   7528: 1. domain
1.536     raeburn  7529: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7530:    status types (e.g., faculty, staff, student etc.)
                   7531:    which apply to the user for whom the default is being retrieved.
                   7532:    If the institutional status string in undefined, the domain
                   7533:    default quota will be returned. 
1.472     raeburn  7534: 
                   7535: Returns:
                   7536: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7537: 2. (Optional) institutional type which determined the value of the
                   7538:    default quota.
1.472     raeburn  7539: 
                   7540: If a value has been stored in the domain's configuration db,
                   7541: it will return that, otherwise it returns 20 (for backwards 
                   7542: compatibility with domains which have not set up a configuration
                   7543: db file; the original statically defined portfolio quota was 20 Mb). 
                   7544: 
1.536     raeburn  7545: If the user's status includes multiple types (e.g., staff and student),
                   7546: the largest default quota which applies to the user determines the
                   7547: default quota returned.
                   7548: 
1.780     raeburn  7549: =back
                   7550: 
1.472     raeburn  7551: =cut
                   7552: 
                   7553: ###############################################
                   7554: 
                   7555: 
                   7556: sub default_quota {
1.536     raeburn  7557:     my ($udom,$inststatus) = @_;
                   7558:     my ($defquota,$settingstatus);
                   7559:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7560:                                             ['quotas'],$udom);
                   7561:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7562:         if ($inststatus ne '') {
1.765     raeburn  7563:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7564:             foreach my $item (@statuses) {
1.711     raeburn  7565:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7566:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7567:                         if ($defquota eq '') {
                   7568:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7569:                             $settingstatus = $item;
                   7570:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7571:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7572:                             $settingstatus = $item;
                   7573:                         }
                   7574:                     }
                   7575:                 } else {
                   7576:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7577:                         if ($defquota eq '') {
                   7578:                             $defquota = $quotahash{'quotas'}{$item};
                   7579:                             $settingstatus = $item;
                   7580:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7581:                             $defquota = $quotahash{'quotas'}{$item};
                   7582:                             $settingstatus = $item;
                   7583:                         }
1.536     raeburn  7584:                     }
                   7585:                 }
                   7586:             }
                   7587:         }
                   7588:         if ($defquota eq '') {
1.711     raeburn  7589:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7590:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7591:             } else {
                   7592:                 $defquota = $quotahash{'quotas'}{'default'};
                   7593:             }
1.536     raeburn  7594:             $settingstatus = 'default';
                   7595:         }
                   7596:     } else {
                   7597:         $settingstatus = 'default';
                   7598:         $defquota = 20;
                   7599:     }
                   7600:     if (wantarray) {
                   7601:         return ($defquota,$settingstatus);
1.472     raeburn  7602:     } else {
1.536     raeburn  7603:         return $defquota;
1.472     raeburn  7604:     }
                   7605: }
                   7606: 
1.384     raeburn  7607: sub get_secgrprole_info {
                   7608:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7609:     my %sections_count = &get_sections($cdom,$cnum);
                   7610:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7611:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7612:     my @groups = sort(keys(%curr_groups));
                   7613:     my $allroles = [];
                   7614:     my $rolehash;
                   7615:     my $accesshash = {
                   7616:                      active => 'Currently has access',
                   7617:                      future => 'Will have future access',
                   7618:                      previous => 'Previously had access',
                   7619:                   };
                   7620:     if ($needroles) {
                   7621:         $rolehash = {'all' => 'all'};
1.385     albertel 7622:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7623: 	if (&Apache::lonnet::error(%user_roles)) {
                   7624: 	    undef(%user_roles);
                   7625: 	}
                   7626:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7627:             my ($role)=split(/\:/,$item,2);
                   7628:             if ($role eq 'cr') { next; }
                   7629:             if ($role =~ /^cr/) {
                   7630:                 $$rolehash{$role} = (split('/',$role))[3];
                   7631:             } else {
                   7632:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7633:             }
                   7634:         }
                   7635:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7636:             push(@{$allroles},$key);
                   7637:         }
                   7638:         push (@{$allroles},'st');
                   7639:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7640:     }
                   7641:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7642: }
                   7643: 
1.555     raeburn  7644: sub user_picker {
1.627     raeburn  7645:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7646:     my $currdom = $dom;
                   7647:     my %curr_selected = (
                   7648:                         srchin => 'dom',
1.580     raeburn  7649:                         srchby => 'lastname',
1.555     raeburn  7650:                       );
                   7651:     my $srchterm;
1.625     raeburn  7652:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7653:         if ($srch->{'srchby'} ne '') {
                   7654:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7655:         }
                   7656:         if ($srch->{'srchin'} ne '') {
                   7657:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7658:         }
                   7659:         if ($srch->{'srchtype'} ne '') {
                   7660:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7661:         }
                   7662:         if ($srch->{'srchdomain'} ne '') {
                   7663:             $currdom = $srch->{'srchdomain'};
                   7664:         }
                   7665:         $srchterm = $srch->{'srchterm'};
                   7666:     }
                   7667:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7668:                     'usr'       => 'Search criteria',
1.563     raeburn  7669:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7670:                     'uname'     => 'username',
                   7671:                     'lastname'  => 'last name',
1.555     raeburn  7672:                     'lastfirst' => 'last name, first name',
1.558     albertel 7673:                     'crs'       => 'in this course',
1.576     raeburn  7674:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7675:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7676:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7677:                     'exact'     => 'is',
                   7678:                     'contains'  => 'contains',
1.569     raeburn  7679:                     'begins'    => 'begins with',
1.571     raeburn  7680:                     'youm'      => "You must include some text to search for.",
                   7681:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7682:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7683:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7684:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7685:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7686:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7687:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7688:                                        );
1.563     raeburn  7689:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7690:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7691: 
                   7692:     my @srchins = ('crs','dom','alc','instd');
                   7693: 
                   7694:     foreach my $option (@srchins) {
                   7695:         # FIXME 'alc' option unavailable until 
                   7696:         #       loncreateuser::print_user_query_page()
                   7697:         #       has been completed.
                   7698:         next if ($option eq 'alc');
1.880     raeburn  7699:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7700:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7701:         if ($curr_selected{'srchin'} eq $option) {
                   7702:             $srchinsel .= ' 
                   7703:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7704:         } else {
                   7705:             $srchinsel .= '
                   7706:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7707:         }
1.555     raeburn  7708:     }
1.563     raeburn  7709:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7710: 
                   7711:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7712:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7713:         if ($curr_selected{'srchby'} eq $option) {
                   7714:             $srchbysel .= '
                   7715:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7716:         } else {
                   7717:             $srchbysel .= '
                   7718:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7719:          }
                   7720:     }
                   7721:     $srchbysel .= "\n  </select>\n";
                   7722: 
                   7723:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7724:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7725:         if ($curr_selected{'srchtype'} eq $option) {
                   7726:             $srchtypesel .= '
                   7727:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7728:         } else {
                   7729:             $srchtypesel .= '
                   7730:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7731:         }
                   7732:     }
                   7733:     $srchtypesel .= "\n  </select>\n";
                   7734: 
1.558     albertel 7735:     my ($newuserscript,$new_user_create);
1.556     raeburn  7736: 
                   7737:     if ($forcenewuser) {
1.576     raeburn  7738:         if (ref($srch) eq 'HASH') {
                   7739:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7740:                 if ($cancreate) {
                   7741:                     $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>';
                   7742:                 } else {
1.799     bisitz   7743:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7744:                     my %usertypetext = (
                   7745:                         official   => 'institutional',
                   7746:                         unofficial => 'non-institutional',
                   7747:                     );
1.799     bisitz   7748:                     $new_user_create = '<p class="LC_warning">'
                   7749:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7750:                                       .' '
                   7751:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7752:                                           ,'<a href="'.$helplink.'">','</a>')
                   7753:                                       .'</p><br />';
1.627     raeburn  7754:                 }
1.576     raeburn  7755:             }
                   7756:         }
                   7757: 
1.556     raeburn  7758:         $newuserscript = <<"ENDSCRIPT";
                   7759: 
1.570     raeburn  7760: function setSearch(createnew,callingForm) {
1.556     raeburn  7761:     if (createnew == 1) {
1.570     raeburn  7762:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7763:             if (callingForm.srchby.options[i].value == 'uname') {
                   7764:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7765:             }
                   7766:         }
1.570     raeburn  7767:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7768:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7769: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7770:             }
                   7771:         }
1.570     raeburn  7772:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7773:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7774:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7775:             }
                   7776:         }
1.570     raeburn  7777:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7778:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7779:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7780:             }
                   7781:         }
                   7782:     }
                   7783: }
                   7784: ENDSCRIPT
1.558     albertel 7785: 
1.556     raeburn  7786:     }
                   7787: 
1.555     raeburn  7788:     my $output = <<"END_BLOCK";
1.556     raeburn  7789: <script type="text/javascript">
1.824     bisitz   7790: // <![CDATA[
1.570     raeburn  7791: function validateEntry(callingForm) {
1.558     albertel 7792: 
1.556     raeburn  7793:     var checkok = 1;
1.558     albertel 7794:     var srchin;
1.570     raeburn  7795:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7796: 	if ( callingForm.srchin[i].checked ) {
                   7797: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7798: 	}
                   7799:     }
                   7800: 
1.570     raeburn  7801:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7802:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7803:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7804:     var srchterm =  callingForm.srchterm.value;
                   7805:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7806:     var msg = "";
                   7807: 
                   7808:     if (srchterm == "") {
                   7809:         checkok = 0;
1.571     raeburn  7810:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7811:     }
                   7812: 
1.569     raeburn  7813:     if (srchtype== 'begins') {
                   7814:         if (srchterm.length < 2) {
                   7815:             checkok = 0;
1.571     raeburn  7816:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7817:         }
                   7818:     }
                   7819: 
1.556     raeburn  7820:     if (srchtype== 'contains') {
                   7821:         if (srchterm.length < 3) {
                   7822:             checkok = 0;
1.571     raeburn  7823:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7824:         }
                   7825:     }
                   7826:     if (srchin == 'instd') {
                   7827:         if (srchdomain == '') {
                   7828:             checkok = 0;
1.571     raeburn  7829:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7830:         }
                   7831:     }
                   7832:     if (srchin == 'dom') {
                   7833:         if (srchdomain == '') {
                   7834:             checkok = 0;
1.571     raeburn  7835:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7836:         }
                   7837:     }
                   7838:     if (srchby == 'lastfirst') {
                   7839:         if (srchterm.indexOf(",") == -1) {
                   7840:             checkok = 0;
1.571     raeburn  7841:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7842:         }
                   7843:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7844:             checkok = 0;
1.571     raeburn  7845:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7846:         }
                   7847:     }
                   7848:     if (checkok == 0) {
1.571     raeburn  7849:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7850:         return;
                   7851:     }
                   7852:     if (checkok == 1) {
1.570     raeburn  7853:         callingForm.submit();
1.556     raeburn  7854:     }
                   7855: }
                   7856: 
                   7857: $newuserscript
                   7858: 
1.824     bisitz   7859: // ]]>
1.556     raeburn  7860: </script>
1.558     albertel 7861: 
                   7862: $new_user_create
                   7863: 
1.555     raeburn  7864: END_BLOCK
1.558     albertel 7865: 
1.876     raeburn  7866:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7867:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7868:                $domform.
                   7869:                &Apache::lonhtmlcommon::row_closure().
                   7870:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7871:                $srchbysel.
                   7872:                $srchtypesel. 
                   7873:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7874:                $srchinsel.
                   7875:                &Apache::lonhtmlcommon::row_closure(1). 
                   7876:                &Apache::lonhtmlcommon::end_pick_box().
                   7877:                '<br />';
1.555     raeburn  7878:     return $output;
                   7879: }
                   7880: 
1.612     raeburn  7881: sub user_rule_check {
1.615     raeburn  7882:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7883:     my $response;
                   7884:     if (ref($usershash) eq 'HASH') {
                   7885:         foreach my $user (keys(%{$usershash})) {
                   7886:             my ($uname,$udom) = split(/:/,$user);
                   7887:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7888:             my ($id,$newuser);
1.612     raeburn  7889:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7890:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7891:                 $id = $usershash->{$user}->{'id'};
                   7892:             }
                   7893:             my $inst_response;
                   7894:             if (ref($checks) eq 'HASH') {
                   7895:                 if (defined($checks->{'username'})) {
1.615     raeburn  7896:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7897:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7898:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7899:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7900:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7901:                 }
1.615     raeburn  7902:             } else {
                   7903:                 ($inst_response,%{$inst_results->{$user}}) =
                   7904:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7905:                 return;
1.612     raeburn  7906:             }
1.615     raeburn  7907:             if (!$got_rules->{$udom}) {
1.612     raeburn  7908:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7909:                                                   ['usercreation'],$udom);
                   7910:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7911:                     foreach my $item ('username','id') {
1.612     raeburn  7912:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7913:                             $$curr_rules{$udom}{$item} = 
                   7914:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7915:                         }
                   7916:                     }
                   7917:                 }
1.615     raeburn  7918:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7919:             }
1.612     raeburn  7920:             foreach my $item (keys(%{$checks})) {
                   7921:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7922:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7923:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7924:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7925:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7926:                                 if ($rule_check{$rule}) {
                   7927:                                     $$rulematch{$user}{$item} = $rule;
                   7928:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7929:                                         if (ref($inst_results) eq 'HASH') {
                   7930:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7931:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7932:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7933:                                                 }
1.612     raeburn  7934:                                             }
                   7935:                                         }
1.615     raeburn  7936:                                     }
                   7937:                                     last;
1.585     raeburn  7938:                                 }
                   7939:                             }
                   7940:                         }
                   7941:                     }
                   7942:                 }
                   7943:             }
                   7944:         }
                   7945:     }
1.612     raeburn  7946:     return;
                   7947: }
                   7948: 
                   7949: sub user_rule_formats {
                   7950:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7951:     my %text = ( 
                   7952:                  'username' => 'Usernames',
                   7953:                  'id'       => 'IDs',
                   7954:                );
                   7955:     my $output;
                   7956:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7957:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7958:         if (@{$ruleorder} > 0) {
                   7959:             $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>';
                   7960:             foreach my $rule (@{$ruleorder}) {
                   7961:                 if (ref($curr_rules) eq 'ARRAY') {
                   7962:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7963:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7964:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7965:                                         $rules->{$rule}{'desc'}.'</li>';
                   7966:                         }
                   7967:                     }
                   7968:                 }
                   7969:             }
                   7970:             $output .= '</ul>';
                   7971:         }
                   7972:     }
                   7973:     return $output;
                   7974: }
                   7975: 
                   7976: sub instrule_disallow_msg {
1.615     raeburn  7977:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7978:     my $response;
                   7979:     my %text = (
                   7980:                   item   => 'username',
                   7981:                   items  => 'usernames',
                   7982:                   match  => 'matches',
                   7983:                   do     => 'does',
                   7984:                   action => 'a username',
                   7985:                   one    => 'one',
                   7986:                );
                   7987:     if ($count > 1) {
                   7988:         $text{'item'} = 'usernames';
                   7989:         $text{'match'} ='match';
                   7990:         $text{'do'} = 'do';
                   7991:         $text{'action'} = 'usernames',
                   7992:         $text{'one'} = 'ones';
                   7993:     }
                   7994:     if ($checkitem eq 'id') {
                   7995:         $text{'items'} = 'IDs';
                   7996:         $text{'item'} = 'ID';
                   7997:         $text{'action'} = 'an ID';
1.615     raeburn  7998:         if ($count > 1) {
                   7999:             $text{'item'} = 'IDs';
                   8000:             $text{'action'} = 'IDs';
                   8001:         }
1.612     raeburn  8002:     }
1.674     bisitz   8003:     $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  8004:     if ($mode eq 'upload') {
                   8005:         if ($checkitem eq 'username') {
                   8006:             $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'}.");
                   8007:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8008:             $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  8009:         }
1.669     raeburn  8010:     } elsif ($mode eq 'selfcreate') {
                   8011:         if ($checkitem eq 'id') {
                   8012:             $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.");
                   8013:         }
1.615     raeburn  8014:     } else {
                   8015:         if ($checkitem eq 'username') {
                   8016:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8017:         } elsif ($checkitem eq 'id') {
                   8018:             $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.");
                   8019:         }
1.612     raeburn  8020:     }
                   8021:     return $response;
1.585     raeburn  8022: }
                   8023: 
1.624     raeburn  8024: sub personal_data_fieldtitles {
                   8025:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8026:                         id => 'Student/Employee ID',
                   8027:                         permanentemail => 'E-mail address',
                   8028:                         lastname => 'Last Name',
                   8029:                         firstname => 'First Name',
                   8030:                         middlename => 'Middle Name',
                   8031:                         generation => 'Generation',
                   8032:                         gen => 'Generation',
1.765     raeburn  8033:                         inststatus => 'Affiliation',
1.624     raeburn  8034:                    );
                   8035:     return %fieldtitles;
                   8036: }
                   8037: 
1.642     raeburn  8038: sub sorted_inst_types {
                   8039:     my ($dom) = @_;
                   8040:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8041:     my $othertitle = &mt('All users');
                   8042:     if ($env{'request.course.id'}) {
1.668     raeburn  8043:         $othertitle  = &mt('Any users');
1.642     raeburn  8044:     }
                   8045:     my @types;
                   8046:     if (ref($order) eq 'ARRAY') {
                   8047:         @types = @{$order};
                   8048:     }
                   8049:     if (@types == 0) {
                   8050:         if (ref($usertypes) eq 'HASH') {
                   8051:             @types = sort(keys(%{$usertypes}));
                   8052:         }
                   8053:     }
                   8054:     if (keys(%{$usertypes}) > 0) {
                   8055:         $othertitle = &mt('Other users');
                   8056:     }
                   8057:     return ($othertitle,$usertypes,\@types);
                   8058: }
                   8059: 
1.645     raeburn  8060: sub get_institutional_codes {
                   8061:     my ($settings,$allcourses,$LC_code) = @_;
                   8062: # Get complete list of course sections to update
                   8063:     my @currsections = ();
                   8064:     my @currxlists = ();
                   8065:     my $coursecode = $$settings{'internal.coursecode'};
                   8066: 
                   8067:     if ($$settings{'internal.sectionnums'} ne '') {
                   8068:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8069:     }
                   8070: 
                   8071:     if ($$settings{'internal.crosslistings'} ne '') {
                   8072:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8073:     }
                   8074: 
                   8075:     if (@currxlists > 0) {
                   8076:         foreach (@currxlists) {
                   8077:             if (m/^([^:]+):(\w*)$/) {
                   8078:                 unless (grep/^$1$/,@{$allcourses}) {
                   8079:                     push @{$allcourses},$1;
                   8080:                     $$LC_code{$1} = $2;
                   8081:                 }
                   8082:             }
                   8083:         }
                   8084:     }
                   8085:  
                   8086:     if (@currsections > 0) {
                   8087:         foreach (@currsections) {
                   8088:             if (m/^(\w+):(\w*)$/) {
                   8089:                 my $sec = $coursecode.$1;
                   8090:                 my $lc_sec = $2;
                   8091:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8092:                     push @{$allcourses},$sec;
                   8093:                     $$LC_code{$sec} = $lc_sec;
                   8094:                 }
                   8095:             }
                   8096:         }
                   8097:     }
                   8098:     return;
                   8099: }
                   8100: 
1.971     raeburn  8101: sub get_standard_codeitems {
                   8102:     return ('Year','Semester','Department','Number','Section');
                   8103: }
                   8104: 
1.112     bowersj2 8105: =pod
                   8106: 
1.780     raeburn  8107: =head1 Slot Helpers
                   8108: 
                   8109: =over 4
                   8110: 
                   8111: =item * sorted_slots()
                   8112: 
                   8113: Sorts an array of slot names in order of slot start time (earliest first). 
                   8114: 
                   8115: Inputs:
                   8116: 
                   8117: =over 4
                   8118: 
                   8119: slotsarr  - Reference to array of unsorted slot names.
                   8120: 
                   8121: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8122: 
1.549     albertel 8123: =back
                   8124: 
1.780     raeburn  8125: Returns:
                   8126: 
                   8127: =over 4
                   8128: 
                   8129: sorted   - An array of slot names sorted by the start time of the slot.
                   8130: 
                   8131: =back
                   8132: 
                   8133: =back
                   8134: 
                   8135: =cut
                   8136: 
                   8137: 
                   8138: sub sorted_slots {
                   8139:     my ($slotsarr,$slots) = @_;
                   8140:     my @sorted;
                   8141:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8142:         @sorted =
                   8143:             sort {
                   8144:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8145:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8146:                      }
                   8147:                      if (ref($slots->{$a})) { return -1;}
                   8148:                      if (ref($slots->{$b})) { return 1;}
                   8149:                      return 0;
                   8150:                  } @{$slotsarr};
                   8151:     }
                   8152:     return @sorted;
                   8153: }
                   8154: 
                   8155: 
                   8156: =pod
                   8157: 
1.549     albertel 8158: =head1 HTTP Helpers
                   8159: 
                   8160: =over 4
                   8161: 
1.648     raeburn  8162: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8163: 
1.258     albertel 8164: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8165: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8166: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8167: 
                   8168: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8169: $possible_names is an ref to an array of form element names.  As an example:
                   8170: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8171: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8172: 
                   8173: =cut
1.1       albertel 8174: 
1.6       albertel 8175: sub get_unprocessed_cgi {
1.25      albertel 8176:   my ($query,$possible_names)= @_;
1.26      matthew  8177:   # $Apache::lonxml::debug=1;
1.356     albertel 8178:   foreach my $pair (split(/&/,$query)) {
                   8179:     my ($name, $value) = split(/=/,$pair);
1.369     www      8180:     $name = &unescape($name);
1.25      albertel 8181:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8182:       $value =~ tr/+/ /;
                   8183:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8184:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8185:     }
1.16      harris41 8186:   }
1.6       albertel 8187: }
                   8188: 
1.112     bowersj2 8189: =pod
                   8190: 
1.648     raeburn  8191: =item * &cacheheader() 
1.112     bowersj2 8192: 
                   8193: returns cache-controlling header code
                   8194: 
                   8195: =cut
                   8196: 
1.7       albertel 8197: sub cacheheader {
1.258     albertel 8198:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8199:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8200:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8201:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8202:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8203:     return $output;
1.7       albertel 8204: }
                   8205: 
1.112     bowersj2 8206: =pod
                   8207: 
1.648     raeburn  8208: =item * &no_cache($r) 
1.112     bowersj2 8209: 
                   8210: specifies header code to not have cache
                   8211: 
                   8212: =cut
                   8213: 
1.9       albertel 8214: sub no_cache {
1.216     albertel 8215:     my ($r) = @_;
                   8216:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8217: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8218:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8219:     $r->no_cache(1);
                   8220:     $r->header_out("Expires" => $date);
                   8221:     $r->header_out("Pragma" => "no-cache");
1.123     www      8222: }
                   8223: 
                   8224: sub content_type {
1.181     albertel 8225:     my ($r,$type,$charset) = @_;
1.299     foxr     8226:     if ($r) {
                   8227: 	#  Note that printout.pl calls this with undef for $r.
                   8228: 	&no_cache($r);
                   8229:     }
1.258     albertel 8230:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8231:     unless ($charset) {
                   8232: 	$charset=&Apache::lonlocal::current_encoding;
                   8233:     }
                   8234:     if ($charset) { $type.='; charset='.$charset; }
                   8235:     if ($r) {
                   8236: 	$r->content_type($type);
                   8237:     } else {
                   8238: 	print("Content-type: $type\n\n");
                   8239:     }
1.9       albertel 8240: }
1.25      albertel 8241: 
1.112     bowersj2 8242: =pod
                   8243: 
1.648     raeburn  8244: =item * &add_to_env($name,$value) 
1.112     bowersj2 8245: 
1.258     albertel 8246: adds $name to the %env hash with value
1.112     bowersj2 8247: $value, if $name already exists, the entry is converted to an array
                   8248: reference and $value is added to the array.
                   8249: 
                   8250: =cut
                   8251: 
1.25      albertel 8252: sub add_to_env {
                   8253:   my ($name,$value)=@_;
1.258     albertel 8254:   if (defined($env{$name})) {
                   8255:     if (ref($env{$name})) {
1.25      albertel 8256:       #already have multiple values
1.258     albertel 8257:       push(@{ $env{$name} },$value);
1.25      albertel 8258:     } else {
                   8259:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8260:       my $first=$env{$name};
                   8261:       undef($env{$name});
                   8262:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8263:     }
                   8264:   } else {
1.258     albertel 8265:     $env{$name}=$value;
1.25      albertel 8266:   }
1.31      albertel 8267: }
1.149     albertel 8268: 
                   8269: =pod
                   8270: 
1.648     raeburn  8271: =item * &get_env_multiple($name) 
1.149     albertel 8272: 
1.258     albertel 8273: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8274: values may be defined and end up as an array ref.
                   8275: 
                   8276: returns an array of values
                   8277: 
                   8278: =cut
                   8279: 
                   8280: sub get_env_multiple {
                   8281:     my ($name) = @_;
                   8282:     my @values;
1.258     albertel 8283:     if (defined($env{$name})) {
1.149     albertel 8284:         # exists is it an array
1.258     albertel 8285:         if (ref($env{$name})) {
                   8286:             @values=@{ $env{$name} };
1.149     albertel 8287:         } else {
1.258     albertel 8288:             $values[0]=$env{$name};
1.149     albertel 8289:         }
                   8290:     }
                   8291:     return(@values);
                   8292: }
                   8293: 
1.660     raeburn  8294: sub ask_for_embedded_content {
                   8295:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8296:     my $upload_output = '
                   8297:    <form name="upload_embedded" action="'.$actionurl.'"
                   8298:                   method="post" enctype="multipart/form-data">';
                   8299:     $upload_output .= $state;
1.661     raeburn  8300:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8301: 
                   8302:     my $num = 0;
                   8303:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8304:         $upload_output .= &start_data_table_row().
                   8305:             '<td>'.$embed_file.'</td><td>';
                   8306:         if ($args->{'ignore_remote_references'}
                   8307:             && $embed_file =~ m{^\w+://}) {
                   8308:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8309:         } elsif ($args->{'error_on_invalid_names'}
                   8310:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8311: 
                   8312:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8313: 
                   8314:         } else {
                   8315:             $upload_output .='
1.661     raeburn  8316:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8317:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8318:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8319:             $upload_output .=
                   8320:                 "\n\t\t".
                   8321:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8322:                 $attrib.'" />';
                   8323:             if (exists($$codebase{$embed_file})) {
                   8324:                 $upload_output .=
                   8325:                     "\n\t\t".
                   8326:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8327:                     &escape($$codebase{$embed_file}).'" />';
                   8328:             }
                   8329:         }
                   8330:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8331:         $num++;
                   8332:     }
                   8333:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8334:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8335:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8336:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8337:    </form>';
                   8338:     return $upload_output;
                   8339: }
                   8340: 
1.661     raeburn  8341: sub upload_embedded {
                   8342:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8343:         $current_disk_usage) = @_;
                   8344:     my $output;
                   8345:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8346:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8347:         my $orig_uploaded_filename =
                   8348:             $env{'form.embedded_item_'.$i.'.filename'};
                   8349: 
                   8350:         $env{'form.embedded_orig_'.$i} =
                   8351:             &unescape($env{'form.embedded_orig_'.$i});
                   8352:         my ($path,$fname) =
                   8353:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8354:         # no path, whole string is fname
                   8355:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8356: 
                   8357:         $path = $env{'form.currentpath'}.$path;
                   8358:         $fname = &Apache::lonnet::clean_filename($fname);
                   8359:         # See if there is anything left
                   8360:         next if ($fname eq '');
                   8361: 
                   8362:         # Check if file already exists as a file or directory.
                   8363:         my ($state,$msg);
                   8364:         if ($context eq 'portfolio') {
                   8365:             my $port_path = $dirpath;
                   8366:             if ($group ne '') {
                   8367:                 $port_path = "groups/$group/$port_path";
                   8368:             }
                   8369:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8370:                                               $dir_root,$port_path,$disk_quota,
                   8371:                                               $current_disk_usage,$uname,$udom);
                   8372:             if ($state eq 'will_exceed_quota'
                   8373:                 || $state eq 'file_locked'
                   8374:                 || $state eq 'file_exists' ) {
                   8375:                 $output .= $msg;
                   8376:                 next;
                   8377:             }
                   8378:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8379:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8380:             if ($state eq 'exists') {
                   8381:                 $output .= $msg;
                   8382:                 next;
                   8383:             }
                   8384:         }
                   8385:         # Check if extension is valid
                   8386:         if (($fname =~ /\.(\w+)$/) &&
                   8387:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8388:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8389:             next;
                   8390:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8391:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8392:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8393:             next;
                   8394:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8395:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8396:             next;
                   8397:         }
                   8398: 
                   8399:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8400:         if ($context eq 'portfolio') {
                   8401:             my $result=
                   8402:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8403:                                                 $dirpath.$path);
                   8404:             if ($result !~ m|^/uploaded/|) {
                   8405:                 $output .= '<span class="LC_error">'
                   8406:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8407:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8408:                       .'</span><br />';
                   8409:                 next;
                   8410:             } else {
                   8411:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8412:                            $path.$fname.'</span>').'</p>';     
                   8413:             }
                   8414:         } else {
                   8415: # Save the file
                   8416:             my $target = $env{'form.embedded_item_'.$i};
                   8417:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8418:             my $dest = $fullpath.$fname;
                   8419:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8420:             my @parts=split(/\//,$fullpath);
                   8421:             my $count;
                   8422:             my $filepath = $dir_root;
                   8423:             for ($count=4;$count<=$#parts;$count++) {
                   8424:                 $filepath .= "/$parts[$count]";
                   8425:                 if ((-e $filepath)!=1) {
                   8426:                     mkdir($filepath,0770);
                   8427:                 }
                   8428:             }
                   8429:             my $fh;
                   8430:             if (!open($fh,'>'.$dest)) {
                   8431:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8432:                 $output .= '<span class="LC_error">'.
                   8433:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8434:                            '</span><br />';
                   8435:             } else {
                   8436:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8437:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8438:                     $output .= '<span class="LC_error">'.
                   8439:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8440:                               '</span><br />';
                   8441:                 } else {
                   8442:                     if ($context eq 'testbank') {
                   8443:                         $output .= &mt('Embedded file uploaded successfully:').
                   8444:                                    '&nbsp;<a href="'.$url.'">'.
                   8445:                                    $orig_uploaded_filename.'</a><br />';
                   8446:                     } else {
1.705     tempelho 8447:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8448:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8449:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8450:                     }
                   8451:                 }
                   8452:                 close($fh);
                   8453:             }
                   8454:         }
                   8455:     }
                   8456:     return $output;
                   8457: }
                   8458: 
                   8459: sub check_for_existing {
                   8460:     my ($path,$fname,$element) = @_;
                   8461:     my ($state,$msg);
                   8462:     if (-d $path.'/'.$fname) {
                   8463:         $state = 'exists';
                   8464:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8465:     } elsif (-e $path.'/'.$fname) {
                   8466:         $state = 'exists';
                   8467:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8468:     }
                   8469:     if ($state eq 'exists') {
                   8470:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8471:     }
                   8472:     return ($state,$msg);
                   8473: }
                   8474: 
                   8475: sub check_for_upload {
                   8476:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8477:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8478:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8479:     my $getpropath = 1;
                   8480:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8481:                                             $getpropath);
                   8482:     my $found_file = 0;
                   8483:     my $locked_file = 0;
                   8484:     foreach my $line (@dir_list) {
                   8485:         my ($file_name)=split(/\&/,$line,2);
                   8486:         if ($file_name eq $fname){
                   8487:             $file_name = $path.$file_name;
                   8488:             if ($group ne '') {
                   8489:                 $file_name = $group.$file_name;
                   8490:             }
                   8491:             $found_file = 1;
                   8492:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8493:                 $locked_file = 1;
                   8494:             }
                   8495:         }
                   8496:     }
                   8497:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8498:         my $msg = '<span class="LC_error">'.
                   8499:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8500:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8501:         return ('will_exceed_quota',$msg);
                   8502:     } elsif ($found_file) {
                   8503:         if ($locked_file) {
                   8504:             my $msg = '<span class="LC_error">';
                   8505:             $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>');
                   8506:             $msg .= '</span><br />';
                   8507:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8508:             return ('file_locked',$msg);
                   8509:         } else {
                   8510:             my $msg = '<span class="LC_error">';
                   8511:             $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'});
                   8512:             $msg .= '</span>';
                   8513:             $msg .= '<br />';
                   8514:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8515:             return ('file_exists',$msg);
                   8516:         }
                   8517:     }
                   8518: }
                   8519: 
1.31      albertel 8520: 
1.41      ng       8521: =pod
1.45      matthew  8522: 
1.464     albertel 8523: =back
1.41      ng       8524: 
1.112     bowersj2 8525: =head1 CSV Upload/Handling functions
1.38      albertel 8526: 
1.41      ng       8527: =over 4
                   8528: 
1.648     raeburn  8529: =item * &upfile_store($r)
1.41      ng       8530: 
                   8531: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8532: needs $env{'form.upfile'}
1.41      ng       8533: returns $datatoken to be put into hidden field
                   8534: 
                   8535: =cut
1.31      albertel 8536: 
                   8537: sub upfile_store {
                   8538:     my $r=shift;
1.258     albertel 8539:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8540:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8541:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8542:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8543: 
1.258     albertel 8544:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8545: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8546:     {
1.158     raeburn  8547:         my $datafile = $r->dir_config('lonDaemons').
                   8548:                            '/tmp/'.$datatoken.'.tmp';
                   8549:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8550:             print $fh $env{'form.upfile'};
1.158     raeburn  8551:             close($fh);
                   8552:         }
1.31      albertel 8553:     }
                   8554:     return $datatoken;
                   8555: }
                   8556: 
1.56      matthew  8557: =pod
                   8558: 
1.648     raeburn  8559: =item * &load_tmp_file($r)
1.41      ng       8560: 
                   8561: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8562: needs $env{'form.datatoken'},
                   8563: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8564: 
                   8565: =cut
1.31      albertel 8566: 
                   8567: sub load_tmp_file {
                   8568:     my $r=shift;
                   8569:     my @studentdata=();
                   8570:     {
1.158     raeburn  8571:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8572:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8573:         if ( open(my $fh,"<$studentfile") ) {
                   8574:             @studentdata=<$fh>;
                   8575:             close($fh);
                   8576:         }
1.31      albertel 8577:     }
1.258     albertel 8578:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8579: }
                   8580: 
1.56      matthew  8581: =pod
                   8582: 
1.648     raeburn  8583: =item * &upfile_record_sep()
1.41      ng       8584: 
                   8585: Separate uploaded file into records
                   8586: returns array of records,
1.258     albertel 8587: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8588: 
                   8589: =cut
1.31      albertel 8590: 
                   8591: sub upfile_record_sep {
1.258     albertel 8592:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8593:     } else {
1.248     albertel 8594: 	my @records;
1.258     albertel 8595: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8596: 	    if ($line=~/^\s*$/) { next; }
                   8597: 	    push(@records,$line);
                   8598: 	}
                   8599: 	return @records;
1.31      albertel 8600:     }
                   8601: }
                   8602: 
1.56      matthew  8603: =pod
                   8604: 
1.648     raeburn  8605: =item * &record_sep($record)
1.41      ng       8606: 
1.258     albertel 8607: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8608: 
                   8609: =cut
                   8610: 
1.263     www      8611: sub takeleft {
                   8612:     my $index=shift;
                   8613:     return substr('0000'.$index,-4,4);
                   8614: }
                   8615: 
1.31      albertel 8616: sub record_sep {
                   8617:     my $record=shift;
                   8618:     my %components=();
1.258     albertel 8619:     if ($env{'form.upfiletype'} eq 'xml') {
                   8620:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8621:         my $i=0;
1.356     albertel 8622:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8623:             $field=~s/^(\"|\')//;
                   8624:             $field=~s/(\"|\')$//;
1.263     www      8625:             $components{&takeleft($i)}=$field;
1.31      albertel 8626:             $i++;
                   8627:         }
1.258     albertel 8628:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8629:         my $i=0;
1.356     albertel 8630:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8631:             $field=~s/^(\"|\')//;
                   8632:             $field=~s/(\"|\')$//;
1.263     www      8633:             $components{&takeleft($i)}=$field;
1.31      albertel 8634:             $i++;
                   8635:         }
                   8636:     } else {
1.561     www      8637:         my $separator=',';
1.480     banghart 8638:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8639:             $separator=';';
1.480     banghart 8640:         }
1.31      albertel 8641:         my $i=0;
1.561     www      8642: # the character we are looking for to indicate the end of a quote or a record 
                   8643:         my $looking_for=$separator;
                   8644: # do not add the characters to the fields
                   8645:         my $ignore=0;
                   8646: # we just encountered a separator (or the beginning of the record)
                   8647:         my $just_found_separator=1;
                   8648: # store the field we are working on here
                   8649:         my $field='';
                   8650: # work our way through all characters in record
                   8651:         foreach my $character ($record=~/(.)/g) {
                   8652:             if ($character eq $looking_for) {
                   8653:                if ($character ne $separator) {
                   8654: # Found the end of a quote, again looking for separator
                   8655:                   $looking_for=$separator;
                   8656:                   $ignore=1;
                   8657:                } else {
                   8658: # Found a separator, store away what we got
                   8659:                   $components{&takeleft($i)}=$field;
                   8660: 	          $i++;
                   8661:                   $just_found_separator=1;
                   8662:                   $ignore=0;
                   8663:                   $field='';
                   8664:                }
                   8665:                next;
                   8666:             }
                   8667: # single or double quotation marks after a separator indicate beginning of a quote
                   8668: # we are now looking for the end of the quote and need to ignore separators
                   8669:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8670:                $looking_for=$character;
                   8671:                next;
                   8672:             }
                   8673: # ignore would be true after we reached the end of a quote
                   8674:             if ($ignore) { next; }
                   8675:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8676:             $field.=$character;
                   8677:             $just_found_separator=0; 
1.31      albertel 8678:         }
1.561     www      8679: # catch the very last entry, since we never encountered the separator
                   8680:         $components{&takeleft($i)}=$field;
1.31      albertel 8681:     }
                   8682:     return %components;
                   8683: }
                   8684: 
1.144     matthew  8685: ######################################################
                   8686: ######################################################
                   8687: 
1.56      matthew  8688: =pod
                   8689: 
1.648     raeburn  8690: =item * &upfile_select_html()
1.41      ng       8691: 
1.144     matthew  8692: Return HTML code to select a file from the users machine and specify 
                   8693: the file type.
1.41      ng       8694: 
                   8695: =cut
                   8696: 
1.144     matthew  8697: ######################################################
                   8698: ######################################################
1.31      albertel 8699: sub upfile_select_html {
1.144     matthew  8700:     my %Types = (
                   8701:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8702:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8703:                  space => &mt('Space separated'),
                   8704:                  tab   => &mt('Tabulator separated'),
                   8705: #                 xml   => &mt('HTML/XML'),
                   8706:                  );
                   8707:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8708:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8709:     foreach my $type (sort(keys(%Types))) {
                   8710:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8711:     }
                   8712:     $Str .= "</select>\n";
                   8713:     return $Str;
1.31      albertel 8714: }
                   8715: 
1.301     albertel 8716: sub get_samples {
                   8717:     my ($records,$toget) = @_;
                   8718:     my @samples=({});
                   8719:     my $got=0;
                   8720:     foreach my $rec (@$records) {
                   8721: 	my %temp = &record_sep($rec);
                   8722: 	if (! grep(/\S/, values(%temp))) { next; }
                   8723: 	if (%temp) {
                   8724: 	    $samples[$got]=\%temp;
                   8725: 	    $got++;
                   8726: 	    if ($got == $toget) { last; }
                   8727: 	}
                   8728:     }
                   8729:     return \@samples;
                   8730: }
                   8731: 
1.144     matthew  8732: ######################################################
                   8733: ######################################################
                   8734: 
1.56      matthew  8735: =pod
                   8736: 
1.648     raeburn  8737: =item * &csv_print_samples($r,$records)
1.41      ng       8738: 
                   8739: Prints a table of sample values from each column uploaded $r is an
                   8740: Apache Request ref, $records is an arrayref from
                   8741: &Apache::loncommon::upfile_record_sep
                   8742: 
                   8743: =cut
                   8744: 
1.144     matthew  8745: ######################################################
                   8746: ######################################################
1.31      albertel 8747: sub csv_print_samples {
                   8748:     my ($r,$records) = @_;
1.662     bisitz   8749:     my $samples = &get_samples($records,5);
1.301     albertel 8750: 
1.594     raeburn  8751:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8752:               &start_data_table_header_row());
1.356     albertel 8753:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8754:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8755:     $r->print(&end_data_table_header_row());
1.301     albertel 8756:     foreach my $hash (@$samples) {
1.594     raeburn  8757: 	$r->print(&start_data_table_row());
1.356     albertel 8758: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8759: 	    $r->print('<td>');
1.356     albertel 8760: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8761: 	    $r->print('</td>');
                   8762: 	}
1.594     raeburn  8763: 	$r->print(&end_data_table_row());
1.31      albertel 8764:     }
1.594     raeburn  8765:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8766: }
                   8767: 
1.144     matthew  8768: ######################################################
                   8769: ######################################################
                   8770: 
1.56      matthew  8771: =pod
                   8772: 
1.648     raeburn  8773: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8774: 
                   8775: Prints a table to create associations between values and table columns.
1.144     matthew  8776: 
1.41      ng       8777: $r is an Apache Request ref,
                   8778: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8779: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8780: 
                   8781: =cut
                   8782: 
1.144     matthew  8783: ######################################################
                   8784: ######################################################
1.31      albertel 8785: sub csv_print_select_table {
                   8786:     my ($r,$records,$d) = @_;
1.301     albertel 8787:     my $i=0;
                   8788:     my $samples = &get_samples($records,1);
1.144     matthew  8789:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8790: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8791:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8792:               '<th>'.&mt('Column').'</th>'.
                   8793:               &end_data_table_header_row()."\n");
1.356     albertel 8794:     foreach my $array_ref (@$d) {
                   8795: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8796: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8797: 
1.875     bisitz   8798: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8799: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8800: 	$r->print('<option value="none"></option>');
1.356     albertel 8801: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8802: 	    $r->print('<option value="'.$sample.'"'.
                   8803:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8804:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8805: 	}
1.594     raeburn  8806: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8807: 	$i++;
                   8808:     }
1.594     raeburn  8809:     $r->print(&end_data_table());
1.31      albertel 8810:     $i--;
                   8811:     return $i;
                   8812: }
1.56      matthew  8813: 
1.144     matthew  8814: ######################################################
                   8815: ######################################################
                   8816: 
1.56      matthew  8817: =pod
1.31      albertel 8818: 
1.648     raeburn  8819: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8820: 
                   8821: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8822: 
                   8823: $r is an Apache Request ref,
                   8824: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8825: $d is an array of 2 element arrays (internal name, displayed name)
                   8826: 
                   8827: =cut
                   8828: 
1.144     matthew  8829: ######################################################
                   8830: ######################################################
1.31      albertel 8831: sub csv_samples_select_table {
                   8832:     my ($r,$records,$d) = @_;
                   8833:     my $i=0;
1.144     matthew  8834:     #
1.662     bisitz   8835:     my $max_samples = 5;
                   8836:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8837:     $r->print(&start_data_table().
                   8838:               &start_data_table_header_row().'<th>'.
                   8839:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8840:               &end_data_table_header_row());
1.301     albertel 8841: 
                   8842:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8843: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8844: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8845: 	foreach my $option (@$d) {
                   8846: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8847: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8848:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8849:                       $display.'</option>');
1.31      albertel 8850: 	}
                   8851: 	$r->print('</select></td><td>');
1.662     bisitz   8852: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8853: 	    if (defined($samples->[$line]{$key})) { 
                   8854: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8855: 	    }
                   8856: 	}
1.594     raeburn  8857: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8858: 	$i++;
                   8859:     }
1.594     raeburn  8860:     $r->print(&end_data_table());
1.31      albertel 8861:     $i--;
                   8862:     return($i);
1.115     matthew  8863: }
                   8864: 
1.144     matthew  8865: ######################################################
                   8866: ######################################################
                   8867: 
1.115     matthew  8868: =pod
                   8869: 
1.648     raeburn  8870: =item * &clean_excel_name($name)
1.115     matthew  8871: 
                   8872: Returns a replacement for $name which does not contain any illegal characters.
                   8873: 
                   8874: =cut
                   8875: 
1.144     matthew  8876: ######################################################
                   8877: ######################################################
1.115     matthew  8878: sub clean_excel_name {
                   8879:     my ($name) = @_;
                   8880:     $name =~ s/[:\*\?\/\\]//g;
                   8881:     if (length($name) > 31) {
                   8882:         $name = substr($name,0,31);
                   8883:     }
                   8884:     return $name;
1.25      albertel 8885: }
1.84      albertel 8886: 
1.85      albertel 8887: =pod
                   8888: 
1.648     raeburn  8889: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8890: 
                   8891: Returns either 1 or undef
                   8892: 
                   8893: 1 if the part is to be hidden, undef if it is to be shown
                   8894: 
                   8895: Arguments are:
                   8896: 
                   8897: $id the id of the part to be checked
                   8898: $symb, optional the symb of the resource to check
                   8899: $udom, optional the domain of the user to check for
                   8900: $uname, optional the username of the user to check for
                   8901: 
                   8902: =cut
1.84      albertel 8903: 
                   8904: sub check_if_partid_hidden {
                   8905:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8906:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8907: 					 $symb,$udom,$uname);
1.141     albertel 8908:     my $truth=1;
                   8909:     #if the string starts with !, then the list is the list to show not hide
                   8910:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8911:     my @hiddenlist=split(/,/,$hiddenparts);
                   8912:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8913: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8914:     }
1.141     albertel 8915:     return !$truth;
1.84      albertel 8916: }
1.127     matthew  8917: 
1.138     matthew  8918: 
                   8919: ############################################################
                   8920: ############################################################
                   8921: 
                   8922: =pod
                   8923: 
1.157     matthew  8924: =back 
                   8925: 
1.138     matthew  8926: =head1 cgi-bin script and graphing routines
                   8927: 
1.157     matthew  8928: =over 4
                   8929: 
1.648     raeburn  8930: =item * &get_cgi_id()
1.138     matthew  8931: 
                   8932: Inputs: none
                   8933: 
                   8934: Returns an id which can be used to pass environment variables
                   8935: to various cgi-bin scripts.  These environment variables will
                   8936: be removed from the users environment after a given time by
                   8937: the routine &Apache::lonnet::transfer_profile_to_env.
                   8938: 
                   8939: =cut
                   8940: 
                   8941: ############################################################
                   8942: ############################################################
1.152     albertel 8943: my $uniq=0;
1.136     matthew  8944: sub get_cgi_id {
1.154     albertel 8945:     $uniq=($uniq+1)%100000;
1.280     albertel 8946:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8947: }
                   8948: 
1.127     matthew  8949: ############################################################
                   8950: ############################################################
                   8951: 
                   8952: =pod
                   8953: 
1.648     raeburn  8954: =item * &DrawBarGraph()
1.127     matthew  8955: 
1.138     matthew  8956: Facilitates the plotting of data in a (stacked) bar graph.
                   8957: Puts plot definition data into the users environment in order for 
                   8958: graph.png to plot it.  Returns an <img> tag for the plot.
                   8959: The bars on the plot are labeled '1','2',...,'n'.
                   8960: 
                   8961: Inputs:
                   8962: 
                   8963: =over 4
                   8964: 
                   8965: =item $Title: string, the title of the plot
                   8966: 
                   8967: =item $xlabel: string, text describing the X-axis of the plot
                   8968: 
                   8969: =item $ylabel: string, text describing the Y-axis of the plot
                   8970: 
                   8971: =item $Max: scalar, the maximum Y value to use in the plot
                   8972: If $Max is < any data point, the graph will not be rendered.
                   8973: 
1.140     matthew  8974: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8975: they are plotted.  If undefined, default values will be used.
                   8976: 
1.178     matthew  8977: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8978: 
1.138     matthew  8979: =item @Values: An array of array references.  Each array reference holds data
                   8980: to be plotted in a stacked bar chart.
                   8981: 
1.239     matthew  8982: =item If the final element of @Values is a hash reference the key/value
                   8983: pairs will be added to the graph definition.
                   8984: 
1.138     matthew  8985: =back
                   8986: 
                   8987: Returns:
                   8988: 
                   8989: An <img> tag which references graph.png and the appropriate identifying
                   8990: information for the plot.
                   8991: 
1.127     matthew  8992: =cut
                   8993: 
                   8994: ############################################################
                   8995: ############################################################
1.134     matthew  8996: sub DrawBarGraph {
1.178     matthew  8997:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8998:     #
                   8999:     if (! defined($colors)) {
                   9000:         $colors = ['#33ff00', 
                   9001:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9002:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9003:                   ]; 
                   9004:     }
1.228     matthew  9005:     my $extra_settings = {};
                   9006:     if (ref($Values[-1]) eq 'HASH') {
                   9007:         $extra_settings = pop(@Values);
                   9008:     }
1.127     matthew  9009:     #
1.136     matthew  9010:     my $identifier = &get_cgi_id();
                   9011:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9012:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9013:         return '';
                   9014:     }
1.225     matthew  9015:     #
                   9016:     my @Labels;
                   9017:     if (defined($labels)) {
                   9018:         @Labels = @$labels;
                   9019:     } else {
                   9020:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9021:             push (@Labels,$i+1);
                   9022:         }
                   9023:     }
                   9024:     #
1.129     matthew  9025:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9026:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9027:     my %ValuesHash;
                   9028:     my $NumSets=1;
                   9029:     foreach my $array (@Values) {
                   9030:         next if (! ref($array));
1.136     matthew  9031:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9032:             join(',',@$array);
1.129     matthew  9033:     }
1.127     matthew  9034:     #
1.136     matthew  9035:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9036:     if ($NumBars < 3) {
                   9037:         $width = 120+$NumBars*32;
1.220     matthew  9038:         $xskip = 1;
1.225     matthew  9039:         $bar_width = 30;
                   9040:     } elsif ($NumBars < 5) {
                   9041:         $width = 120+$NumBars*20;
                   9042:         $xskip = 1;
                   9043:         $bar_width = 20;
1.220     matthew  9044:     } elsif ($NumBars < 10) {
1.136     matthew  9045:         $width = 120+$NumBars*15;
                   9046:         $xskip = 1;
                   9047:         $bar_width = 15;
                   9048:     } elsif ($NumBars <= 25) {
                   9049:         $width = 120+$NumBars*11;
                   9050:         $xskip = 5;
                   9051:         $bar_width = 8;
                   9052:     } elsif ($NumBars <= 50) {
                   9053:         $width = 120+$NumBars*8;
                   9054:         $xskip = 5;
                   9055:         $bar_width = 4;
                   9056:     } else {
                   9057:         $width = 120+$NumBars*8;
                   9058:         $xskip = 5;
                   9059:         $bar_width = 4;
                   9060:     }
                   9061:     #
1.137     matthew  9062:     $Max = 1 if ($Max < 1);
                   9063:     if ( int($Max) < $Max ) {
                   9064:         $Max++;
                   9065:         $Max = int($Max);
                   9066:     }
1.127     matthew  9067:     $Title  = '' if (! defined($Title));
                   9068:     $xlabel = '' if (! defined($xlabel));
                   9069:     $ylabel = '' if (! defined($ylabel));
1.369     www      9070:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9071:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9072:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9073:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9074:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9075:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9076:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9077:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9078:     $ValuesHash{$id.'.height'}   = $height;
                   9079:     $ValuesHash{$id.'.width'}    = $width;
                   9080:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9081:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9082:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9083:     #
1.228     matthew  9084:     # Deal with other parameters
                   9085:     while (my ($key,$value) = each(%$extra_settings)) {
                   9086:         $ValuesHash{$id.'.'.$key} = $value;
                   9087:     }
                   9088:     #
1.646     raeburn  9089:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9090:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9091: }
                   9092: 
                   9093: ############################################################
                   9094: ############################################################
                   9095: 
                   9096: =pod
                   9097: 
1.648     raeburn  9098: =item * &DrawXYGraph()
1.137     matthew  9099: 
1.138     matthew  9100: Facilitates the plotting of data in an XY graph.
                   9101: Puts plot definition data into the users environment in order for 
                   9102: graph.png to plot it.  Returns an <img> tag for the plot.
                   9103: 
                   9104: Inputs:
                   9105: 
                   9106: =over 4
                   9107: 
                   9108: =item $Title: string, the title of the plot
                   9109: 
                   9110: =item $xlabel: string, text describing the X-axis of the plot
                   9111: 
                   9112: =item $ylabel: string, text describing the Y-axis of the plot
                   9113: 
                   9114: =item $Max: scalar, the maximum Y value to use in the plot
                   9115: If $Max is < any data point, the graph will not be rendered.
                   9116: 
                   9117: =item $colors: Array ref containing the hex color codes for the data to be 
                   9118: plotted in.  If undefined, default values will be used.
                   9119: 
                   9120: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9121: 
                   9122: =item $Ydata: Array ref containing Array refs.  
1.185     www      9123: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9124: 
                   9125: =item %Values: hash indicating or overriding any default values which are 
                   9126: passed to graph.png.  
                   9127: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9128: 
                   9129: =back
                   9130: 
                   9131: Returns:
                   9132: 
                   9133: An <img> tag which references graph.png and the appropriate identifying
                   9134: information for the plot.
                   9135: 
1.137     matthew  9136: =cut
                   9137: 
                   9138: ############################################################
                   9139: ############################################################
                   9140: sub DrawXYGraph {
                   9141:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9142:     #
                   9143:     # Create the identifier for the graph
                   9144:     my $identifier = &get_cgi_id();
                   9145:     my $id = 'cgi.'.$identifier;
                   9146:     #
                   9147:     $Title  = '' if (! defined($Title));
                   9148:     $xlabel = '' if (! defined($xlabel));
                   9149:     $ylabel = '' if (! defined($ylabel));
                   9150:     my %ValuesHash = 
                   9151:         (
1.369     www      9152:          $id.'.title'  => &escape($Title),
                   9153:          $id.'.xlabel' => &escape($xlabel),
                   9154:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9155:          $id.'.y_max_value'=> $Max,
                   9156:          $id.'.labels'     => join(',',@$Xlabels),
                   9157:          $id.'.PlotType'   => 'XY',
                   9158:          );
                   9159:     #
                   9160:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9161:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9162:     }
                   9163:     #
                   9164:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9165:         return '';
                   9166:     }
                   9167:     my $NumSets=1;
1.138     matthew  9168:     foreach my $array (@{$Ydata}){
1.137     matthew  9169:         next if (! ref($array));
                   9170:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9171:     }
1.138     matthew  9172:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9173:     #
                   9174:     # Deal with other parameters
                   9175:     while (my ($key,$value) = each(%Values)) {
                   9176:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9177:     }
                   9178:     #
1.646     raeburn  9179:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9180:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9181: }
                   9182: 
                   9183: ############################################################
                   9184: ############################################################
                   9185: 
                   9186: =pod
                   9187: 
1.648     raeburn  9188: =item * &DrawXYYGraph()
1.138     matthew  9189: 
                   9190: Facilitates the plotting of data in an XY graph with two Y axes.
                   9191: Puts plot definition data into the users environment in order for 
                   9192: graph.png to plot it.  Returns an <img> tag for the plot.
                   9193: 
                   9194: Inputs:
                   9195: 
                   9196: =over 4
                   9197: 
                   9198: =item $Title: string, the title of the plot
                   9199: 
                   9200: =item $xlabel: string, text describing the X-axis of the plot
                   9201: 
                   9202: =item $ylabel: string, text describing the Y-axis of the plot
                   9203: 
                   9204: =item $colors: Array ref containing the hex color codes for the data to be 
                   9205: plotted in.  If undefined, default values will be used.
                   9206: 
                   9207: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9208: 
                   9209: =item $Ydata1: The first data set
                   9210: 
                   9211: =item $Min1: The minimum value of the left Y-axis
                   9212: 
                   9213: =item $Max1: The maximum value of the left Y-axis
                   9214: 
                   9215: =item $Ydata2: The second data set
                   9216: 
                   9217: =item $Min2: The minimum value of the right Y-axis
                   9218: 
                   9219: =item $Max2: The maximum value of the left Y-axis
                   9220: 
                   9221: =item %Values: hash indicating or overriding any default values which are 
                   9222: passed to graph.png.  
                   9223: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9224: 
                   9225: =back
                   9226: 
                   9227: Returns:
                   9228: 
                   9229: An <img> tag which references graph.png and the appropriate identifying
                   9230: information for the plot.
1.136     matthew  9231: 
                   9232: =cut
                   9233: 
                   9234: ############################################################
                   9235: ############################################################
1.137     matthew  9236: sub DrawXYYGraph {
                   9237:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9238:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9239:     #
                   9240:     # Create the identifier for the graph
                   9241:     my $identifier = &get_cgi_id();
                   9242:     my $id = 'cgi.'.$identifier;
                   9243:     #
                   9244:     $Title  = '' if (! defined($Title));
                   9245:     $xlabel = '' if (! defined($xlabel));
                   9246:     $ylabel = '' if (! defined($ylabel));
                   9247:     my %ValuesHash = 
                   9248:         (
1.369     www      9249:          $id.'.title'  => &escape($Title),
                   9250:          $id.'.xlabel' => &escape($xlabel),
                   9251:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9252:          $id.'.labels' => join(',',@$Xlabels),
                   9253:          $id.'.PlotType' => 'XY',
                   9254:          $id.'.NumSets' => 2,
1.137     matthew  9255:          $id.'.two_axes' => 1,
                   9256:          $id.'.y1_max_value' => $Max1,
                   9257:          $id.'.y1_min_value' => $Min1,
                   9258:          $id.'.y2_max_value' => $Max2,
                   9259:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9260:          );
                   9261:     #
1.137     matthew  9262:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9263:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9264:     }
                   9265:     #
                   9266:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9267:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9268:         return '';
                   9269:     }
                   9270:     my $NumSets=1;
1.137     matthew  9271:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9272:         next if (! ref($array));
                   9273:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9274:     }
                   9275:     #
                   9276:     # Deal with other parameters
                   9277:     while (my ($key,$value) = each(%Values)) {
                   9278:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9279:     }
                   9280:     #
1.646     raeburn  9281:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9282:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9283: }
                   9284: 
                   9285: ############################################################
                   9286: ############################################################
                   9287: 
                   9288: =pod
                   9289: 
1.157     matthew  9290: =back 
                   9291: 
1.139     matthew  9292: =head1 Statistics helper routines?  
                   9293: 
                   9294: Bad place for them but what the hell.
                   9295: 
1.157     matthew  9296: =over 4
                   9297: 
1.648     raeburn  9298: =item * &chartlink()
1.139     matthew  9299: 
                   9300: Returns a link to the chart for a specific student.  
                   9301: 
                   9302: Inputs:
                   9303: 
                   9304: =over 4
                   9305: 
                   9306: =item $linktext: The text of the link
                   9307: 
                   9308: =item $sname: The students username
                   9309: 
                   9310: =item $sdomain: The students domain
                   9311: 
                   9312: =back
                   9313: 
1.157     matthew  9314: =back
                   9315: 
1.139     matthew  9316: =cut
                   9317: 
                   9318: ############################################################
                   9319: ############################################################
                   9320: sub chartlink {
                   9321:     my ($linktext, $sname, $sdomain) = @_;
                   9322:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9323:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9324:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9325:        '">'.$linktext.'</a>';
1.153     matthew  9326: }
                   9327: 
                   9328: #######################################################
                   9329: #######################################################
                   9330: 
                   9331: =pod
                   9332: 
                   9333: =head1 Course Environment Routines
1.157     matthew  9334: 
                   9335: =over 4
1.153     matthew  9336: 
1.648     raeburn  9337: =item * &restore_course_settings()
1.153     matthew  9338: 
1.648     raeburn  9339: =item * &store_course_settings()
1.153     matthew  9340: 
                   9341: Restores/Store indicated form parameters from the course environment.
                   9342: Will not overwrite existing values of the form parameters.
                   9343: 
                   9344: Inputs: 
                   9345: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9346: 
                   9347: a hash ref describing the data to be stored.  For example:
                   9348:    
                   9349: %Save_Parameters = ('Status' => 'scalar',
                   9350:     'chartoutputmode' => 'scalar',
                   9351:     'chartoutputdata' => 'scalar',
                   9352:     'Section' => 'array',
1.373     raeburn  9353:     'Group' => 'array',
1.153     matthew  9354:     'StudentData' => 'array',
                   9355:     'Maps' => 'array');
                   9356: 
                   9357: Returns: both routines return nothing
                   9358: 
1.631     raeburn  9359: =back
                   9360: 
1.153     matthew  9361: =cut
                   9362: 
                   9363: #######################################################
                   9364: #######################################################
                   9365: sub store_course_settings {
1.496     albertel 9366:     return &store_settings($env{'request.course.id'},@_);
                   9367: }
                   9368: 
                   9369: sub store_settings {
1.153     matthew  9370:     # save to the environment
                   9371:     # appenv the same items, just to be safe
1.300     albertel 9372:     my $udom  = $env{'user.domain'};
                   9373:     my $uname = $env{'user.name'};
1.496     albertel 9374:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9375:     my %SaveHash;
                   9376:     my %AppHash;
                   9377:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9378:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9379:         my $envname = 'environment.'.$basename;
1.258     albertel 9380:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9381:             # Save this value away
                   9382:             if ($type eq 'scalar' &&
1.258     albertel 9383:                 (! exists($env{$envname}) || 
                   9384:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9385:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9386:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9387:             } elsif ($type eq 'array') {
                   9388:                 my $stored_form;
1.258     albertel 9389:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9390:                     $stored_form = join(',',
                   9391:                                         map {
1.369     www      9392:                                             &escape($_);
1.258     albertel 9393:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9394:                 } else {
                   9395:                     $stored_form = 
1.369     www      9396:                         &escape($env{'form.'.$setting});
1.153     matthew  9397:                 }
                   9398:                 # Determine if the array contents are the same.
1.258     albertel 9399:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9400:                     $SaveHash{$basename} = $stored_form;
                   9401:                     $AppHash{$envname}   = $stored_form;
                   9402:                 }
                   9403:             }
                   9404:         }
                   9405:     }
                   9406:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9407:                                           $udom,$uname);
1.153     matthew  9408:     if ($put_result !~ /^(ok|delayed)/) {
                   9409:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9410:                                  'got error:'.$put_result);
                   9411:     }
                   9412:     # Make sure these settings stick around in this session, too
1.646     raeburn  9413:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9414:     return;
                   9415: }
                   9416: 
                   9417: sub restore_course_settings {
1.499     albertel 9418:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9419: }
                   9420: 
                   9421: sub restore_settings {
                   9422:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9423:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9424:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9425:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9426:             '.'.$setting;
1.258     albertel 9427:         if (exists($env{$envname})) {
1.153     matthew  9428:             if ($type eq 'scalar') {
1.258     albertel 9429:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9430:             } elsif ($type eq 'array') {
1.258     albertel 9431:                 $env{'form.'.$setting} = [ 
1.153     matthew  9432:                                            map { 
1.369     www      9433:                                                &unescape($_); 
1.258     albertel 9434:                                            } split(',',$env{$envname})
1.153     matthew  9435:                                            ];
                   9436:             }
                   9437:         }
                   9438:     }
1.127     matthew  9439: }
                   9440: 
1.618     raeburn  9441: #######################################################
                   9442: #######################################################
                   9443: 
                   9444: =pod
                   9445: 
                   9446: =head1 Domain E-mail Routines  
                   9447: 
                   9448: =over 4
                   9449: 
1.648     raeburn  9450: =item * &build_recipient_list()
1.618     raeburn  9451: 
1.884     raeburn  9452: Build recipient lists for five types of e-mail:
1.766     raeburn  9453: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9454: (d) Help requests, (e) Course requests needing approval,  generated by
                   9455: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9456: loncoursequeueadmin.pm respectively.
1.618     raeburn  9457: 
                   9458: Inputs:
1.619     raeburn  9459: defmail (scalar - email address of default recipient), 
1.618     raeburn  9460: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9461: defdom (domain for which to retrieve configuration settings),
                   9462: origmail (scalar - email address of recipient from loncapa.conf, 
                   9463: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9464: 
1.655     raeburn  9465: Returns: comma separated list of addresses to which to send e-mail.
                   9466: 
                   9467: =back
1.618     raeburn  9468: 
                   9469: =cut
                   9470: 
                   9471: ############################################################
                   9472: ############################################################
                   9473: sub build_recipient_list {
1.619     raeburn  9474:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9475:     my @recipients;
                   9476:     my $otheremails;
                   9477:     my %domconfig =
                   9478:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9479:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9480:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9481:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9482:                 my @contacts = ('adminemail','supportemail');
                   9483:                 foreach my $item (@contacts) {
                   9484:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9485:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9486:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9487:                             push(@recipients,$addr);
                   9488:                         }
1.619     raeburn  9489:                     }
1.766     raeburn  9490:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9491:                 }
                   9492:             }
1.766     raeburn  9493:         } elsif ($origmail ne '') {
                   9494:             push(@recipients,$origmail);
1.618     raeburn  9495:         }
1.619     raeburn  9496:     } elsif ($origmail ne '') {
                   9497:         push(@recipients,$origmail);
1.618     raeburn  9498:     }
1.688     raeburn  9499:     if (defined($defmail)) {
                   9500:         if ($defmail ne '') {
                   9501:             push(@recipients,$defmail);
                   9502:         }
1.618     raeburn  9503:     }
                   9504:     if ($otheremails) {
1.619     raeburn  9505:         my @others;
                   9506:         if ($otheremails =~ /,/) {
                   9507:             @others = split(/,/,$otheremails);
1.618     raeburn  9508:         } else {
1.619     raeburn  9509:             push(@others,$otheremails);
                   9510:         }
                   9511:         foreach my $addr (@others) {
                   9512:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9513:                 push(@recipients,$addr);
                   9514:             }
1.618     raeburn  9515:         }
                   9516:     }
1.619     raeburn  9517:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9518:     return $recipientlist;
                   9519: }
                   9520: 
1.127     matthew  9521: ############################################################
                   9522: ############################################################
1.154     albertel 9523: 
1.655     raeburn  9524: =pod
                   9525: 
                   9526: =head1 Course Catalog Routines
                   9527: 
                   9528: =over 4
                   9529: 
                   9530: =item * &gather_categories()
                   9531: 
                   9532: Converts category definitions - keys of categories hash stored in  
                   9533: coursecategories in configuration.db on the primary library server in a 
                   9534: domain - to an array.  Also generates javascript and idx hash used to 
                   9535: generate Domain Coordinator interface for editing Course Categories.
                   9536: 
                   9537: Inputs:
1.663     raeburn  9538: 
1.655     raeburn  9539: categories (reference to hash of category definitions).
1.663     raeburn  9540: 
1.655     raeburn  9541: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9542:       categories and subcategories).
1.663     raeburn  9543: 
1.655     raeburn  9544: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9545:       editing Course Categories).
1.663     raeburn  9546: 
1.655     raeburn  9547: jsarray (reference to array of categories used to create Javascript arrays for
                   9548:          Domain Coordinator interface for editing Course Categories).
                   9549: 
                   9550: Returns: nothing
                   9551: 
                   9552: Side effects: populates cats, idx and jsarray. 
                   9553: 
                   9554: =cut
                   9555: 
                   9556: sub gather_categories {
                   9557:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9558:     my %counters;
                   9559:     my $num = 0;
                   9560:     foreach my $item (keys(%{$categories})) {
                   9561:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9562:         if ($container eq '' && $depth == 0) {
                   9563:             $cats->[$depth][$categories->{$item}] = $cat;
                   9564:         } else {
                   9565:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9566:         }
                   9567:         my ($escitem,$tail) = split(/:/,$item,2);
                   9568:         if ($counters{$tail} eq '') {
                   9569:             $counters{$tail} = $num;
                   9570:             $num ++;
                   9571:         }
                   9572:         if (ref($idx) eq 'HASH') {
                   9573:             $idx->{$item} = $counters{$tail};
                   9574:         }
                   9575:         if (ref($jsarray) eq 'ARRAY') {
                   9576:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9577:         }
                   9578:     }
                   9579:     return;
                   9580: }
                   9581: 
                   9582: =pod
                   9583: 
                   9584: =item * &extract_categories()
                   9585: 
                   9586: Used to generate breadcrumb trails for course categories.
                   9587: 
                   9588: Inputs:
1.663     raeburn  9589: 
1.655     raeburn  9590: categories (reference to hash of category definitions).
1.663     raeburn  9591: 
1.655     raeburn  9592: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9593:       categories and subcategories).
1.663     raeburn  9594: 
1.655     raeburn  9595: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9596: 
1.655     raeburn  9597: allitems (reference to hash - key is category key 
                   9598:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9599: 
1.655     raeburn  9600: idx (reference to hash of counters used in Domain Coordinator interface for
                   9601:       editing Course Categories).
1.663     raeburn  9602: 
1.655     raeburn  9603: jsarray (reference to array of categories used to create Javascript arrays for
                   9604:          Domain Coordinator interface for editing Course Categories).
                   9605: 
1.665     raeburn  9606: subcats (reference to hash of arrays containing all subcategories within each 
                   9607:          category, -recursive)
                   9608: 
1.655     raeburn  9609: Returns: nothing
                   9610: 
                   9611: Side effects: populates trails and allitems hash references.
                   9612: 
                   9613: =cut
                   9614: 
                   9615: sub extract_categories {
1.665     raeburn  9616:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9617:     if (ref($categories) eq 'HASH') {
                   9618:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9619:         if (ref($cats->[0]) eq 'ARRAY') {
                   9620:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9621:                 my $name = $cats->[0][$i];
                   9622:                 my $item = &escape($name).'::0';
                   9623:                 my $trailstr;
                   9624:                 if ($name eq 'instcode') {
                   9625:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9626:                 } elsif ($name eq 'communities') {
                   9627:                     $trailstr = &mt('Communities');
1.655     raeburn  9628:                 } else {
                   9629:                     $trailstr = $name;
                   9630:                 }
                   9631:                 if ($allitems->{$item} eq '') {
                   9632:                     push(@{$trails},$trailstr);
                   9633:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9634:                 }
                   9635:                 my @parents = ($name);
                   9636:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9637:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9638:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9639:                         if (ref($subcats) eq 'HASH') {
                   9640:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9641:                         }
                   9642:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9643:                     }
                   9644:                 } else {
                   9645:                     if (ref($subcats) eq 'HASH') {
                   9646:                         $subcats->{$item} = [];
1.655     raeburn  9647:                     }
                   9648:                 }
                   9649:             }
                   9650:         }
                   9651:     }
                   9652:     return;
                   9653: }
                   9654: 
                   9655: =pod
                   9656: 
                   9657: =item *&recurse_categories()
                   9658: 
                   9659: Recursively used to generate breadcrumb trails for course categories.
                   9660: 
                   9661: Inputs:
1.663     raeburn  9662: 
1.655     raeburn  9663: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9664:       categories and subcategories).
1.663     raeburn  9665: 
1.655     raeburn  9666: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9667: 
                   9668: category (current course category, for which breadcrumb trail is being generated).
                   9669: 
                   9670: trails (reference to array of breadcrumb trails for each category).
                   9671: 
1.655     raeburn  9672: allitems (reference to hash - key is category key
                   9673:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9674: 
1.655     raeburn  9675: parents (array containing containers directories for current category, 
                   9676:          back to top level). 
                   9677: 
                   9678: Returns: nothing
                   9679: 
                   9680: Side effects: populates trails and allitems hash references
                   9681: 
                   9682: =cut
                   9683: 
                   9684: sub recurse_categories {
1.665     raeburn  9685:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9686:     my $shallower = $depth - 1;
                   9687:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9688:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9689:             my $name = $cats->[$depth]{$category}[$k];
                   9690:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9691:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9692:             if ($allitems->{$item} eq '') {
                   9693:                 push(@{$trails},$trailstr);
                   9694:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9695:             }
                   9696:             my $deeper = $depth+1;
                   9697:             push(@{$parents},$category);
1.665     raeburn  9698:             if (ref($subcats) eq 'HASH') {
                   9699:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9700:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9701:                     my $higher;
                   9702:                     if ($j > 0) {
                   9703:                         $higher = &escape($parents->[$j]).':'.
                   9704:                                   &escape($parents->[$j-1]).':'.$j;
                   9705:                     } else {
                   9706:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9707:                     }
                   9708:                     push(@{$subcats->{$higher}},$subcat);
                   9709:                 }
                   9710:             }
                   9711:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9712:                                 $subcats);
1.655     raeburn  9713:             pop(@{$parents});
                   9714:         }
                   9715:     } else {
                   9716:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9717:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9718:         if ($allitems->{$item} eq '') {
                   9719:             push(@{$trails},$trailstr);
                   9720:             $allitems->{$item} = scalar(@{$trails})-1;
                   9721:         }
                   9722:     }
                   9723:     return;
                   9724: }
                   9725: 
1.663     raeburn  9726: =pod
                   9727: 
                   9728: =item *&assign_categories_table()
                   9729: 
                   9730: Create a datatable for display of hierarchical categories in a domain,
                   9731: with checkboxes to allow a course to be categorized. 
                   9732: 
                   9733: Inputs:
                   9734: 
                   9735: cathash - reference to hash of categories defined for the domain (from
                   9736:           configuration.db)
                   9737: 
                   9738: currcat - scalar with an & separated list of categories assigned to a course. 
                   9739: 
1.919     raeburn  9740: type    - scalar contains course type (Course or Community).
                   9741: 
1.663     raeburn  9742: Returns: $output (markup to be displayed) 
                   9743: 
                   9744: =cut
                   9745: 
                   9746: sub assign_categories_table {
1.919     raeburn  9747:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9748:     my $output;
                   9749:     if (ref($cathash) eq 'HASH') {
                   9750:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9751:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9752:         $maxdepth = scalar(@cats);
                   9753:         if (@cats > 0) {
                   9754:             my $itemcount = 0;
                   9755:             if (ref($cats[0]) eq 'ARRAY') {
                   9756:                 my @currcategories;
                   9757:                 if ($currcat ne '') {
                   9758:                     @currcategories = split('&',$currcat);
                   9759:                 }
1.919     raeburn  9760:                 my $table;
1.663     raeburn  9761:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9762:                     my $parent = $cats[0][$i];
1.919     raeburn  9763:                     next if ($parent eq 'instcode');
                   9764:                     if ($type eq 'Community') {
                   9765:                         next unless ($parent eq 'communities');
                   9766:                     } else {
                   9767:                         next if ($parent eq 'communities');
                   9768:                     }
1.663     raeburn  9769:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9770:                     my $item = &escape($parent).'::0';
                   9771:                     my $checked = '';
                   9772:                     if (@currcategories > 0) {
                   9773:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9774:                             $checked = ' checked="checked"';
1.663     raeburn  9775:                         }
                   9776:                     }
1.919     raeburn  9777:                     my $parent_title = $parent;
                   9778:                     if ($parent eq 'communities') {
                   9779:                         $parent_title = &mt('Communities');
                   9780:                     }
                   9781:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9782:                               '<input type="checkbox" name="usecategory" value="'.
                   9783:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9784:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9785:                     my $depth = 1;
                   9786:                     push(@path,$parent);
1.919     raeburn  9787:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  9788:                     pop(@path);
1.919     raeburn  9789:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  9790:                     $itemcount ++;
                   9791:                 }
1.919     raeburn  9792:                 if ($itemcount) {
                   9793:                     $output = &Apache::loncommon::start_data_table().
                   9794:                               $table.
                   9795:                               &Apache::loncommon::end_data_table();
                   9796:                 }
1.663     raeburn  9797:             }
                   9798:         }
                   9799:     }
                   9800:     return $output;
                   9801: }
                   9802: 
                   9803: =pod
                   9804: 
                   9805: =item *&assign_category_rows()
                   9806: 
                   9807: Create a datatable row for display of nested categories in a domain,
                   9808: with checkboxes to allow a course to be categorized,called recursively.
                   9809: 
                   9810: Inputs:
                   9811: 
                   9812: itemcount - track row number for alternating colors
                   9813: 
                   9814: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9815:       categories and subcategories.
                   9816: 
                   9817: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9818: 
                   9819: parent - parent of current category item
                   9820: 
                   9821: path - Array containing all categories back up through the hierarchy from the
                   9822:        current category to the top level.
                   9823: 
                   9824: currcategories - reference to array of current categories assigned to the course
                   9825: 
                   9826: Returns: $output (markup to be displayed).
                   9827: 
                   9828: =cut
                   9829: 
                   9830: sub assign_category_rows {
                   9831:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9832:     my ($text,$name,$item,$chgstr);
                   9833:     if (ref($cats) eq 'ARRAY') {
                   9834:         my $maxdepth = scalar(@{$cats});
                   9835:         if (ref($cats->[$depth]) eq 'HASH') {
                   9836:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9837:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9838:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9839:                 $text .= '<td><table class="LC_datatable">';
                   9840:                 for (my $j=0; $j<$numchildren; $j++) {
                   9841:                     $name = $cats->[$depth]{$parent}[$j];
                   9842:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9843:                     my $deeper = $depth+1;
                   9844:                     my $checked = '';
                   9845:                     if (ref($currcategories) eq 'ARRAY') {
                   9846:                         if (@{$currcategories} > 0) {
                   9847:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9848:                                 $checked = ' checked="checked"';
1.663     raeburn  9849:                             }
                   9850:                         }
                   9851:                     }
1.664     raeburn  9852:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9853:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9854:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9855:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9856:                              '</td><td>';
1.663     raeburn  9857:                     if (ref($path) eq 'ARRAY') {
                   9858:                         push(@{$path},$name);
                   9859:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9860:                         pop(@{$path});
                   9861:                     }
                   9862:                     $text .= '</td></tr>';
                   9863:                 }
                   9864:                 $text .= '</table></td>';
                   9865:             }
                   9866:         }
                   9867:     }
                   9868:     return $text;
                   9869: }
                   9870: 
1.655     raeburn  9871: ############################################################
                   9872: ############################################################
                   9873: 
                   9874: 
1.443     albertel 9875: sub commit_customrole {
1.664     raeburn  9876:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9877:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9878:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9879:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9880:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9881:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9882:                  '</b><br />';
                   9883:     return $output;
                   9884: }
                   9885: 
                   9886: sub commit_standardrole {
1.541     raeburn  9887:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9888:     my ($output,$logmsg,$linefeed);
                   9889:     if ($context eq 'auto') {
                   9890:         $linefeed = "\n";
                   9891:     } else {
                   9892:         $linefeed = "<br />\n";
                   9893:     }  
1.443     albertel 9894:     if ($three eq 'st') {
1.541     raeburn  9895:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9896:                                          $one,$two,$sec,$context);
                   9897:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9898:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9899:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9900:         } else {
1.541     raeburn  9901:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9902:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9903:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9904:             if ($context eq 'auto') {
                   9905:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9906:             } else {
                   9907:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9908:                &mt('Add to classlist').': <b>ok</b>';
                   9909:             }
                   9910:             $output .= $linefeed;
1.443     albertel 9911:         }
                   9912:     } else {
                   9913:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9914:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9915:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9916:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9917:         if ($context eq 'auto') {
                   9918:             $output .= $result.$linefeed;
                   9919:         } else {
                   9920:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9921:         }
1.443     albertel 9922:     }
                   9923:     return $output;
                   9924: }
                   9925: 
                   9926: sub commit_studentrole {
1.541     raeburn  9927:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9928:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9929:     if ($context eq 'auto') {
                   9930:         $linefeed = "\n";
                   9931:     } else {
                   9932:         $linefeed = '<br />'."\n";
                   9933:     }
1.443     albertel 9934:     if (defined($one) && defined($two)) {
                   9935:         my $cid=$one.'_'.$two;
                   9936:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9937:         my $secchange = 0;
                   9938:         my $expire_role_result;
                   9939:         my $modify_section_result;
1.628     raeburn  9940:         if ($oldsec ne '-1') { 
                   9941:             if ($oldsec ne $sec) {
1.443     albertel 9942:                 $secchange = 1;
1.628     raeburn  9943:                 my $now = time;
1.443     albertel 9944:                 my $uurl='/'.$cid;
                   9945:                 $uurl=~s/\_/\//g;
                   9946:                 if ($oldsec) {
                   9947:                     $uurl.='/'.$oldsec;
                   9948:                 }
1.626     raeburn  9949:                 $oldsecurl = $uurl;
1.628     raeburn  9950:                 $expire_role_result = 
1.652     raeburn  9951:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9952:                 if ($env{'request.course.sec'} ne '') { 
                   9953:                     if ($expire_role_result eq 'refused') {
                   9954:                         my @roles = ('st');
                   9955:                         my @statuses = ('previous');
                   9956:                         my @roledoms = ($one);
                   9957:                         my $withsec = 1;
                   9958:                         my %roleshash = 
                   9959:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9960:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9961:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9962:                             my ($oldstart,$oldend) = 
                   9963:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9964:                             if ($oldend > 0 && $oldend <= $now) {
                   9965:                                 $expire_role_result = 'ok';
                   9966:                             }
                   9967:                         }
                   9968:                     }
                   9969:                 }
1.443     albertel 9970:                 $result = $expire_role_result;
                   9971:             }
                   9972:         }
                   9973:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9974:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9975:             if ($modify_section_result =~ /^ok/) {
                   9976:                 if ($secchange == 1) {
1.628     raeburn  9977:                     if ($sec eq '') {
                   9978:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9979:                     } else {
                   9980:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9981:                     }
1.443     albertel 9982:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9983:                     if ($sec eq '') {
                   9984:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9985:                     } else {
                   9986:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9987:                     }
1.443     albertel 9988:                 } else {
1.628     raeburn  9989:                     if ($sec eq '') {
                   9990:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9991:                     } else {
                   9992:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9993:                     }
1.443     albertel 9994:                 }
                   9995:             } else {
1.628     raeburn  9996:                 if ($secchange) {       
                   9997:                     $$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;
                   9998:                 } else {
                   9999:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10000:                 }
1.443     albertel 10001:             }
                   10002:             $result = $modify_section_result;
                   10003:         } elsif ($secchange == 1) {
1.628     raeburn  10004:             if ($oldsec eq '') {
                   10005:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10006:             } else {
                   10007:                 $$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;
                   10008:             }
1.626     raeburn  10009:             if ($expire_role_result eq 'refused') {
                   10010:                 my $newsecurl = '/'.$cid;
                   10011:                 $newsecurl =~ s/\_/\//g;
                   10012:                 if ($sec ne '') {
                   10013:                     $newsecurl.='/'.$sec;
                   10014:                 }
                   10015:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10016:                     if ($sec eq '') {
                   10017:                         $$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;
                   10018:                     } else {
                   10019:                         $$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;
                   10020:                     }
                   10021:                 }
                   10022:             }
1.443     albertel 10023:         }
                   10024:     } else {
1.626     raeburn  10025:         $$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 10026:         $result = "error: incomplete course id\n";
                   10027:     }
                   10028:     return $result;
                   10029: }
                   10030: 
                   10031: ############################################################
                   10032: ############################################################
                   10033: 
1.566     albertel 10034: sub check_clone {
1.578     raeburn  10035:     my ($args,$linefeed) = @_;
1.566     albertel 10036:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10037:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10038:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10039:     my $clonemsg;
                   10040:     my $can_clone = 0;
1.944     raeburn  10041:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10042:     if ($lctype ne 'community') {
                   10043:         $lctype = 'course';
                   10044:     }
1.566     albertel 10045:     if ($clonehome eq 'no_host') {
1.944     raeburn  10046:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10047:             $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   10048:         } else {
                   10049:             $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'});
                   10050:         }     
1.566     albertel 10051:     } else {
                   10052: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  10053:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10054:             if ($clonedesc{'type'} ne 'Community') {
                   10055:                  $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   10056:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10057:             }
                   10058:         }
1.882     raeburn  10059: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10060:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10061: 	    $can_clone = 1;
                   10062: 	} else {
                   10063: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10064: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10065: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10066:             if (grep(/^\*$/,@cloners)) {
                   10067:                 $can_clone = 1;
                   10068:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10069:                 $can_clone = 1;
                   10070:             } else {
1.908     raeburn  10071:                 my $ccrole = 'cc';
1.944     raeburn  10072:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10073:                     $ccrole = 'co';
                   10074:                 }
1.578     raeburn  10075: 	        my %roleshash =
                   10076: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10077: 					 $args->{'ccdomain'},
1.908     raeburn  10078:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10079: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10080: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  10081:                     $can_clone = 1;
                   10082:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   10083:                     $can_clone = 1;
                   10084:                 } else {
1.944     raeburn  10085:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10086:                         $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   10087:                     } else {
                   10088:                         $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'});
                   10089:                     }
1.578     raeburn  10090: 	        }
1.566     albertel 10091: 	    }
1.578     raeburn  10092:         }
1.566     albertel 10093:     }
                   10094:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10095: }
                   10096: 
1.444     albertel 10097: sub construct_course {
1.885     raeburn  10098:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10099:     my $outcome;
1.541     raeburn  10100:     my $linefeed =  '<br />'."\n";
                   10101:     if ($context eq 'auto') {
                   10102:         $linefeed = "\n";
                   10103:     }
1.566     albertel 10104: 
                   10105: #
                   10106: # Are we cloning?
                   10107: #
                   10108:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10109:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10110: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10111: 	if ($context ne 'auto') {
1.578     raeburn  10112:             if ($clonemsg ne '') {
                   10113: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10114:             }
1.566     albertel 10115: 	}
                   10116: 	$outcome .= $clonemsg.$linefeed;
                   10117: 
                   10118:         if (!$can_clone) {
                   10119: 	    return (0,$outcome);
                   10120: 	}
                   10121:     }
                   10122: 
1.444     albertel 10123: #
                   10124: # Open course
                   10125: #
                   10126:     my $crstype = lc($args->{'crstype'});
                   10127:     my %cenv=();
                   10128:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10129:                                              $args->{'cdescr'},
                   10130:                                              $args->{'curl'},
                   10131:                                              $args->{'course_home'},
                   10132:                                              $args->{'nonstandard'},
                   10133:                                              $args->{'crscode'},
                   10134:                                              $args->{'ccuname'}.':'.
                   10135:                                              $args->{'ccdomain'},
1.882     raeburn  10136:                                              $args->{'crstype'},
1.885     raeburn  10137:                                              $cnum,$context,$category);
1.444     albertel 10138: 
                   10139:     # Note: The testing routines depend on this being output; see 
                   10140:     # Utils::Course. This needs to at least be output as a comment
                   10141:     # if anyone ever decides to not show this, and Utils::Course::new
                   10142:     # will need to be suitably modified.
1.541     raeburn  10143:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  10144:     if ($$courseid =~ /^error:/) {
                   10145:         return (0,$outcome);
                   10146:     }
                   10147: 
1.444     albertel 10148: #
                   10149: # Check if created correctly
                   10150: #
1.479     albertel 10151:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10152:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  10153:     if ($crsuhome eq 'no_host') {
                   10154:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   10155:         return (0,$outcome);
                   10156:     }
1.541     raeburn  10157:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10158: 
1.444     albertel 10159: #
1.566     albertel 10160: # Do the cloning
                   10161: #   
                   10162:     if ($can_clone && $cloneid) {
                   10163: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10164: 	if ($context ne 'auto') {
                   10165: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10166: 	}
                   10167: 	$outcome .= $clonemsg.$linefeed;
                   10168: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10169: # Copy all files
1.637     www      10170: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10171: # Restore URL
1.566     albertel 10172: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10173: # Restore title
1.566     albertel 10174: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  10175: # Restore creation date, creator and creation context.
                   10176:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   10177:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   10178:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 10179: # Mark as cloned
1.566     albertel 10180: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10181: # Need to clone grading mode
                   10182:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10183:         $cenv{'grading'}=$newenv{'grading'};
                   10184: # Do not clone these environment entries
                   10185:         &Apache::lonnet::del('environment',
                   10186:                   ['default_enrollment_start_date',
                   10187:                    'default_enrollment_end_date',
                   10188:                    'question.email',
                   10189:                    'policy.email',
                   10190:                    'comment.email',
                   10191:                    'pch.users.denied',
1.725     raeburn  10192:                    'plc.users.denied',
                   10193:                    'hidefromcat',
                   10194:                    'categories'],
1.638     www      10195:                    $$crsudom,$$crsunum);
1.444     albertel 10196:     }
1.566     albertel 10197: 
1.444     albertel 10198: #
                   10199: # Set environment (will override cloned, if existing)
                   10200: #
                   10201:     my @sections = ();
                   10202:     my @xlists = ();
                   10203:     if ($args->{'crstype'}) {
                   10204:         $cenv{'type'}=$args->{'crstype'};
                   10205:     }
                   10206:     if ($args->{'crsid'}) {
                   10207:         $cenv{'courseid'}=$args->{'crsid'};
                   10208:     }
                   10209:     if ($args->{'crscode'}) {
                   10210:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10211:     }
                   10212:     if ($args->{'crsquota'} ne '') {
                   10213:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10214:     } else {
                   10215:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10216:     }
                   10217:     if ($args->{'ccuname'}) {
                   10218:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10219:                                         ':'.$args->{'ccdomain'};
                   10220:     } else {
                   10221:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10222:     }
                   10223:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10224:     if ($args->{'crssections'}) {
                   10225:         $cenv{'internal.sectionnums'} = '';
                   10226:         if ($args->{'crssections'} =~ m/,/) {
                   10227:             @sections = split/,/,$args->{'crssections'};
                   10228:         } else {
                   10229:             $sections[0] = $args->{'crssections'};
                   10230:         }
                   10231:         if (@sections > 0) {
                   10232:             foreach my $item (@sections) {
                   10233:                 my ($sec,$gp) = split/:/,$item;
                   10234:                 my $class = $args->{'crscode'}.$sec;
                   10235:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10236:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10237:                 unless ($addcheck eq 'ok') {
                   10238:                     push @badclasses, $class;
                   10239:                 }
                   10240:             }
                   10241:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10242:         }
                   10243:     }
                   10244: # do not hide course coordinator from staff listing, 
                   10245: # even if privileged
                   10246:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10247: # add crosslistings
                   10248:     if ($args->{'crsxlist'}) {
                   10249:         $cenv{'internal.crosslistings'}='';
                   10250:         if ($args->{'crsxlist'} =~ m/,/) {
                   10251:             @xlists = split/,/,$args->{'crsxlist'};
                   10252:         } else {
                   10253:             $xlists[0] = $args->{'crsxlist'};
                   10254:         }
                   10255:         if (@xlists > 0) {
                   10256:             foreach my $item (@xlists) {
                   10257:                 my ($xl,$gp) = split/:/,$item;
                   10258:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10259:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10260:                 unless ($addcheck eq 'ok') {
                   10261:                     push @badclasses, $xl;
                   10262:                 }
                   10263:             }
                   10264:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10265:         }
                   10266:     }
                   10267:     if ($args->{'autoadds'}) {
                   10268:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10269:     }
                   10270:     if ($args->{'autodrops'}) {
                   10271:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10272:     }
                   10273: # check for notification of enrollment changes
                   10274:     my @notified = ();
                   10275:     if ($args->{'notify_owner'}) {
                   10276:         if ($args->{'ccuname'} ne '') {
                   10277:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10278:         }
                   10279:     }
                   10280:     if ($args->{'notify_dc'}) {
                   10281:         if ($uname ne '') { 
1.630     raeburn  10282:             push(@notified,$uname.':'.$udom);
1.444     albertel 10283:         }
                   10284:     }
                   10285:     if (@notified > 0) {
                   10286:         my $notifylist;
                   10287:         if (@notified > 1) {
                   10288:             $notifylist = join(',',@notified);
                   10289:         } else {
                   10290:             $notifylist = $notified[0];
                   10291:         }
                   10292:         $cenv{'internal.notifylist'} = $notifylist;
                   10293:     }
                   10294:     if (@badclasses > 0) {
                   10295:         my %lt=&Apache::lonlocal::texthash(
                   10296:                 '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',
                   10297:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10298:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10299:         );
1.541     raeburn  10300:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10301:                            ' ('.$lt{'adby'}.')';
                   10302:         if ($context eq 'auto') {
                   10303:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10304:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10305:             foreach my $item (@badclasses) {
                   10306:                 if ($context eq 'auto') {
                   10307:                     $outcome .= " - $item\n";
                   10308:                 } else {
                   10309:                     $outcome .= "<li>$item</li>\n";
                   10310:                 }
                   10311:             }
                   10312:             if ($context eq 'auto') {
                   10313:                 $outcome .= $linefeed;
                   10314:             } else {
1.566     albertel 10315:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10316:             }
                   10317:         } 
1.444     albertel 10318:     }
                   10319:     if ($args->{'no_end_date'}) {
                   10320:         $args->{'endaccess'} = 0;
                   10321:     }
                   10322:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10323:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10324:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10325:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10326:     if ($args->{'showphotos'}) {
                   10327:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10328:     }
                   10329:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10330:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10331:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10332:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10333:             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'); 
                   10334:             if ($context eq 'auto') {
                   10335:                 $outcome .= $krb_msg;
                   10336:             } else {
1.566     albertel 10337:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10338:             }
                   10339:             $outcome .= $linefeed;
1.444     albertel 10340:         }
                   10341:     }
                   10342:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10343:        if ($args->{'setpolicy'}) {
                   10344:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10345:        }
                   10346:        if ($args->{'setcontent'}) {
                   10347:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10348:        }
                   10349:     }
                   10350:     if ($args->{'reshome'}) {
                   10351: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10352: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10353:     }
                   10354: #
                   10355: # course has keyed access
                   10356: #
                   10357:     if ($args->{'setkeys'}) {
                   10358:        $cenv{'keyaccess'}='yes';
                   10359:     }
                   10360: # if specified, key authority is not course, but user
                   10361: # only active if keyaccess is yes
                   10362:     if ($args->{'keyauth'}) {
1.487     albertel 10363: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10364: 	$user = &LONCAPA::clean_username($user);
                   10365: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10366: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10367: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10368: 	}
                   10369:     }
                   10370: 
                   10371:     if ($args->{'disresdis'}) {
                   10372:         $cenv{'pch.roles.denied'}='st';
                   10373:     }
                   10374:     if ($args->{'disablechat'}) {
                   10375:         $cenv{'plc.roles.denied'}='st';
                   10376:     }
                   10377: 
                   10378:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10379:     # course
                   10380:     $cenv{'course.helper.not.run'} = 1;
                   10381:     #
                   10382:     # Use new Randomseed
                   10383:     #
                   10384:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10385:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10386:     #
                   10387:     # The encryption code and receipt prefix for this course
                   10388:     #
                   10389:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10390:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10391:     #
                   10392:     # By default, use standard grading
                   10393:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10394: 
1.541     raeburn  10395:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10396:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10397: #
                   10398: # Open all assignments
                   10399: #
                   10400:     if ($args->{'openall'}) {
                   10401:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10402:        my %storecontent = ($storeunder         => time,
                   10403:                            $storeunder.'.type' => 'date_start');
                   10404:        
                   10405:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10406:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10407:    }
                   10408: #
                   10409: # Set first page
                   10410: #
                   10411:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10412: 	    || ($cloneid)) {
1.445     albertel 10413: 	use LONCAPA::map;
1.444     albertel 10414: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10415: 
                   10416: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10417:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10418: 
1.444     albertel 10419:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10420:         my $title; my $url;
                   10421:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10422: 	    $title=&mt('Syllabus');
1.444     albertel 10423:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10424:         } else {
1.963     raeburn  10425:             $title=&mt('Table of Contents');
1.444     albertel 10426:             $url='/adm/navmaps';
                   10427:         }
1.445     albertel 10428: 
                   10429:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10430: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10431: 
                   10432: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10433:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10434:     }
1.566     albertel 10435: 
                   10436:     return (1,$outcome);
1.444     albertel 10437: }
                   10438: 
                   10439: ############################################################
                   10440: ############################################################
                   10441: 
1.953     droeschl 10442: #SD
                   10443: # only Community and Course, or anything else?
1.378     raeburn  10444: sub course_type {
                   10445:     my ($cid) = @_;
                   10446:     if (!defined($cid)) {
                   10447:         $cid = $env{'request.course.id'};
                   10448:     }
1.404     albertel 10449:     if (defined($env{'course.'.$cid.'.type'})) {
                   10450:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10451:     } else {
                   10452:         return 'Course';
1.377     raeburn  10453:     }
                   10454: }
1.156     albertel 10455: 
1.406     raeburn  10456: sub group_term {
                   10457:     my $crstype = &course_type();
                   10458:     my %names = (
                   10459:                   'Course' => 'group',
1.865     raeburn  10460:                   'Community' => 'group',
1.406     raeburn  10461:                 );
                   10462:     return $names{$crstype};
                   10463: }
                   10464: 
1.902     raeburn  10465: sub course_types {
                   10466:     my @types = ('official','unofficial','community');
                   10467:     my %typename = (
                   10468:                          official   => 'Official course',
                   10469:                          unofficial => 'Unofficial course',
                   10470:                          community  => 'Community',
                   10471:                    );
                   10472:     return (\@types,\%typename);
                   10473: }
                   10474: 
1.156     albertel 10475: sub icon {
                   10476:     my ($file)=@_;
1.505     albertel 10477:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10478:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10479:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10480:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10481: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10482: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10483: 	            $curfext.".gif") {
                   10484: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10485: 		$curfext.".gif";
                   10486: 	}
                   10487:     }
1.249     albertel 10488:     return &lonhttpdurl($iconname);
1.154     albertel 10489: } 
1.84      albertel 10490: 
1.575     albertel 10491: sub lonhttpdurl {
1.692     www      10492: #
                   10493: # Had been used for "small fry" static images on separate port 8080.
                   10494: # Modify here if lightweight http functionality desired again.
                   10495: # Currently eliminated due to increasing firewall issues.
                   10496: #
1.575     albertel 10497:     my ($url)=@_;
1.692     www      10498:     return $url;
1.215     albertel 10499: }
                   10500: 
1.213     albertel 10501: sub connection_aborted {
                   10502:     my ($r)=@_;
                   10503:     $r->print(" ");$r->rflush();
                   10504:     my $c = $r->connection;
                   10505:     return $c->aborted();
                   10506: }
                   10507: 
1.221     foxr     10508: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10509: #    strings as 'strings'.
                   10510: sub escape_single {
1.221     foxr     10511:     my ($input) = @_;
1.223     albertel 10512:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10513:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10514:     return $input;
                   10515: }
1.223     albertel 10516: 
1.222     foxr     10517: #  Same as escape_single, but escape's "'s  This 
                   10518: #  can be used for  "strings"
                   10519: sub escape_double {
                   10520:     my ($input) = @_;
                   10521:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10522:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10523:     return $input;
                   10524: }
1.223     albertel 10525:  
1.222     foxr     10526: #   Escapes the last element of a full URL.
                   10527: sub escape_url {
                   10528:     my ($url)   = @_;
1.238     raeburn  10529:     my @urlslices = split(/\//, $url,-1);
1.369     www      10530:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10531:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10532: }
1.462     albertel 10533: 
1.820     raeburn  10534: sub compare_arrays {
                   10535:     my ($arrayref1,$arrayref2) = @_;
                   10536:     my (@difference,%count);
                   10537:     @difference = ();
                   10538:     %count = ();
                   10539:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10540:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10541:         foreach my $element (keys(%count)) {
                   10542:             if ($count{$element} == 1) {
                   10543:                 push(@difference,$element);
                   10544:             }
                   10545:         }
                   10546:     }
                   10547:     return @difference;
                   10548: }
                   10549: 
1.817     bisitz   10550: # -------------------------------------------------------- Initialize user login
1.462     albertel 10551: sub init_user_environment {
1.463     albertel 10552:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10553:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10554: 
                   10555:     my $public=($username eq 'public' && $domain eq 'public');
                   10556: 
                   10557: # See if old ID present, if so, remove
                   10558: 
                   10559:     my ($filename,$cookie,$userroles);
                   10560:     my $now=time;
                   10561: 
                   10562:     if ($public) {
                   10563: 	my $max_public=100;
                   10564: 	my $oldest;
                   10565: 	my $oldest_time=0;
                   10566: 	for(my $next=1;$next<=$max_public;$next++) {
                   10567: 	    if (-e $lonids."/publicuser_$next.id") {
                   10568: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10569: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10570: 		    $oldest_time=$mtime;
                   10571: 		    $oldest=$next;
                   10572: 		}
                   10573: 	    } else {
                   10574: 		$cookie="publicuser_$next";
                   10575: 		last;
                   10576: 	    }
                   10577: 	}
                   10578: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10579:     } else {
1.463     albertel 10580: 	# if this isn't a robot, kill any existing non-robot sessions
                   10581: 	if (!$args->{'robot'}) {
                   10582: 	    opendir(DIR,$lonids);
                   10583: 	    while ($filename=readdir(DIR)) {
                   10584: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10585: 		    unlink($lonids.'/'.$filename);
                   10586: 		}
1.462     albertel 10587: 	    }
1.463     albertel 10588: 	    closedir(DIR);
1.462     albertel 10589: 	}
                   10590: # Give them a new cookie
1.463     albertel 10591: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10592: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10593: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10594:     
                   10595: # Initialize roles
                   10596: 
                   10597: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10598:     }
                   10599: # ------------------------------------ Check browser type and MathML capability
                   10600: 
                   10601:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10602:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10603: 
                   10604: # ------------------------------------------------------------- Get environment
                   10605: 
                   10606:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10607:     my ($tmp) = keys(%userenv);
                   10608:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10609:     } else {
                   10610: 	undef(%userenv);
                   10611:     }
                   10612:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10613: 	$form->{'interface'}=$userenv{'interface'};
                   10614:     }
                   10615:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10616: 
                   10617: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10618:     foreach my $option ('interface','localpath','localres') {
                   10619:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10620:     }
                   10621: # --------------------------------------------------------- Write first profile
                   10622: 
                   10623:     {
                   10624: 	my %initial_env = 
                   10625: 	    ("user.name"          => $username,
                   10626: 	     "user.domain"        => $domain,
                   10627: 	     "user.home"          => $authhost,
                   10628: 	     "browser.type"       => $clientbrowser,
                   10629: 	     "browser.version"    => $clientversion,
                   10630: 	     "browser.mathml"     => $clientmathml,
                   10631: 	     "browser.unicode"    => $clientunicode,
                   10632: 	     "browser.os"         => $clientos,
                   10633: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10634: 	     "request.course.fn"  => '',
                   10635: 	     "request.course.uri" => '',
                   10636: 	     "request.course.sec" => '',
                   10637: 	     "request.role"       => 'cm',
                   10638: 	     "request.role.adv"   => $env{'user.adv'},
                   10639: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10640: 
                   10641:         if ($form->{'localpath'}) {
                   10642: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10643: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10644:         }
                   10645: 	
                   10646: 	if ($form->{'interface'}) {
                   10647: 	    $form->{'interface'}=~s/\W//gs;
                   10648: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10649: 	    $env{'browser.interface'}=$form->{'interface'};
                   10650: 	}
                   10651: 
1.981   ! raeburn  10652:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.980     raeburn  10653:         my %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   10654: 
1.724     raeburn  10655:         foreach my $tool ('aboutme','blog','portfolio') {
                   10656:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  10657:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   10658:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  10659:         }
                   10660: 
1.864     raeburn  10661:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10662:             $userenv{'canrequest.'.$crstype} =
                   10663:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  10664:                                                   'reload','requestcourses',
                   10665:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  10666:         }
                   10667: 
1.462     albertel 10668: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10669: 	
                   10670: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10671: 		 &GDBM_WRCREAT(),0640)) {
                   10672: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10673: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10674: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10675: 	    if (ref($args->{'extra_env'})) {
                   10676: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10677: 	    }
1.462     albertel 10678: 	    untie(%disk_env);
                   10679: 	} else {
1.705     tempelho 10680: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10681: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10682: 	    return 'error: '.$!;
                   10683: 	}
                   10684:     }
                   10685:     $env{'request.role'}='cm';
                   10686:     $env{'request.role.adv'}=$env{'user.adv'};
                   10687:     $env{'browser.type'}=$clientbrowser;
                   10688: 
                   10689:     return $cookie;
                   10690: 
                   10691: }
                   10692: 
                   10693: sub _add_to_env {
                   10694:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10695:     if (ref($env_data) eq 'HASH') {
                   10696:         while (my ($key,$value) = each(%$env_data)) {
                   10697: 	    $idf->{$prefix.$key} = $value;
                   10698: 	    $env{$prefix.$key}   = $value;
                   10699:         }
1.462     albertel 10700:     }
                   10701: }
                   10702: 
1.685     tempelho 10703: # --- Get the symbolic name of a problem and the url
                   10704: sub get_symb {
                   10705:     my ($request,$silent) = @_;
1.726     raeburn  10706:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10707:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10708:     if ($symb eq '') {
                   10709:         if (!$silent) {
                   10710:             $request->print("Unable to handle ambiguous references:$url:.");
                   10711:             return ();
                   10712:         }
                   10713:     }
                   10714:     &Apache::lonenc::check_decrypt(\$symb);
                   10715:     return ($symb);
                   10716: }
                   10717: 
                   10718: # --------------------------------------------------------------Get annotation
                   10719: 
                   10720: sub get_annotation {
                   10721:     my ($symb,$enc) = @_;
                   10722: 
                   10723:     my $key = $symb;
                   10724:     if (!$enc) {
                   10725:         $key =
                   10726:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10727:     }
                   10728:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10729:     return $annotation{$key};
                   10730: }
                   10731: 
                   10732: sub clean_symb {
1.731     raeburn  10733:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10734: 
                   10735:     &Apache::lonenc::check_decrypt(\$symb);
                   10736:     my $enc = $env{'request.enc'};
1.731     raeburn  10737:     if ($delete_enc) {
1.730     raeburn  10738:         delete($env{'request.enc'});
                   10739:     }
1.685     tempelho 10740: 
                   10741:     return ($symb,$enc);
                   10742: }
1.462     albertel 10743: 
1.41      ng       10744: =pod
                   10745: 
                   10746: =back
                   10747: 
1.112     bowersj2 10748: =cut
1.41      ng       10749: 
1.112     bowersj2 10750: 1;
                   10751: __END__;
1.41      ng       10752: 

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