Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.150
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1075.2.150! raeburn 4: # $Id: loncommon.pm,v 1.1075.2.149 2020/11/12 01:18:26 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.1075.2.25 raeburn 70: use Apache::lonuserutils();
1.1075.2.27 raeburn 71: use Apache::lonuserstate();
1.1075.2.69 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1075.2.135 raeburn 74: use HTTP::Request;
1.657 raeburn 75: use DateTime::TimeZone;
1.1075.2.102 raeburn 76: use DateTime::Locale;
1.1075.2.94 raeburn 77: use Encode();
1.1075.2.14 raeburn 78: use Authen::Captcha;
79: use Captcha::reCAPTCHA;
1.1075.2.107 raeburn 80: use JSON::DWIW;
81: use LWP::UserAgent;
1.1075.2.64 raeburn 82: use Crypt::DES;
83: use DynaLoader; # for Crypt::DES version
1.1075.2.128 raeburn 84: use File::Copy();
85: use File::Path();
1.117 www 86:
1.517 raeburn 87: # ---------------------------------------------- Designs
88: use vars qw(%defaultdesign);
89:
1.22 www 90: my $readit;
91:
1.517 raeburn 92:
1.157 matthew 93: ##
94: ## Global Variables
95: ##
1.46 matthew 96:
1.643 foxr 97:
98: # ----------------------------------------------- SSI with retries:
99: #
100:
101: =pod
102:
1.648 raeburn 103: =head1 Server Side include with retries:
1.643 foxr 104:
105: =over 4
106:
1.648 raeburn 107: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 108:
109: Performs an ssi with some number of retries. Retries continue either
110: until the result is ok or until the retry count supplied by the
111: caller is exhausted.
112:
113: Inputs:
1.648 raeburn 114:
115: =over 4
116:
1.643 foxr 117: resource - Identifies the resource to insert.
1.648 raeburn 118:
1.643 foxr 119: retries - Count of the number of retries allowed.
1.648 raeburn 120:
1.643 foxr 121: form - Hash that identifies the rendering options.
122:
1.648 raeburn 123: =back
124:
125: Returns:
126:
127: =over 4
128:
1.643 foxr 129: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 130:
1.643 foxr 131: response - The response from the last attempt (which may or may not have been successful.
132:
1.648 raeburn 133: =back
134:
135: =back
136:
1.643 foxr 137: =cut
138:
139: sub ssi_with_retries {
140: my ($resource, $retries, %form) = @_;
141:
142:
143: my $ok = 0; # True if we got a good response.
144: my $content;
145: my $response;
146:
147: # Try to get the ssi done. within the retries count:
148:
149: do {
150: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
151: $ok = $response->is_success;
1.650 www 152: if (!$ok) {
153: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
154: }
1.643 foxr 155: $retries--;
156: } while (!$ok && ($retries > 0));
157:
158: if (!$ok) {
159: $content = ''; # On error return an empty content.
160: }
161: return ($content, $response);
162:
163: }
164:
165:
166:
1.20 www 167: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 168: my %language;
1.124 www 169: my %supported_language;
1.1048 foxr 170: my %latex_language; # For choosing hyphenation in <transl..>
171: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 172: my %cprtag;
1.192 taceyjo1 173: my %scprtag;
1.351 www 174: my %fe; my %fd; my %fm;
1.41 ng 175: my %category_extensions;
1.12 harris41 176:
1.46 matthew 177: # ---------------------------------------------- Thesaurus variables
1.144 matthew 178: #
179: # %Keywords:
180: # A hash used by &keyword to determine if a word is considered a keyword.
181: # $thesaurus_db_file
182: # Scalar containing the full path to the thesaurus database.
1.46 matthew 183:
184: my %Keywords;
185: my $thesaurus_db_file;
186:
1.144 matthew 187: #
188: # Initialize values from language.tab, copyright.tab, filetypes.tab,
189: # thesaurus.tab, and filecategories.tab.
190: #
1.18 www 191: BEGIN {
1.46 matthew 192: # Variable initialization
193: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
194: #
1.22 www 195: unless ($readit) {
1.12 harris41 196: # ------------------------------------------------------------------- languages
197: {
1.158 raeburn 198: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
199: '/language.tab';
1.1075.2.128 raeburn 200: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 201: while (my $line = <$fh>) {
202: next if ($line=~/^\#/);
203: chomp($line);
1.1048 foxr 204: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 205: $language{$key}=$val.' - '.$enc;
206: if ($sup) {
207: $supported_language{$key}=$sup;
208: }
1.1048 foxr 209: if ($latex) {
210: $latex_language_bykey{$key} = $latex;
211: $latex_language{$two} = $latex;
212: }
1.158 raeburn 213: }
214: close($fh);
215: }
1.12 harris41 216: }
217: # ------------------------------------------------------------------ copyrights
218: {
1.158 raeburn 219: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
220: '/copyright.tab';
1.1075.2.128 raeburn 221: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 222: while (my $line = <$fh>) {
223: next if ($line=~/^\#/);
224: chomp($line);
225: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 226: $cprtag{$key}=$val;
227: }
228: close($fh);
229: }
1.12 harris41 230: }
1.351 www 231: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 232: {
233: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
234: '/source_copyright.tab';
1.1075.2.128 raeburn 235: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 236: while (my $line = <$fh>) {
237: next if ($line =~ /^\#/);
238: chomp($line);
239: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 240: $scprtag{$key}=$val;
241: }
242: close($fh);
243: }
244: }
1.63 www 245:
1.517 raeburn 246: # -------------------------------------------------------------- default domain designs
1.63 www 247: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 248: my $designfile = $designdir.'/default.tab';
1.1075.2.128 raeburn 249: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 250: while (my $line = <$fh>) {
251: next if ($line =~ /^\#/);
252: chomp($line);
253: my ($key,$val)=(split(/\=/,$line));
254: if ($val) { $defaultdesign{$key}=$val; }
255: }
256: close($fh);
1.63 www 257: }
258:
1.15 harris41 259: # ------------------------------------------------------------- file categories
260: {
1.158 raeburn 261: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
262: '/filecategories.tab';
1.1075.2.128 raeburn 263: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 264: while (my $line = <$fh>) {
265: next if ($line =~ /^\#/);
266: chomp($line);
267: my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119 raeburn 268: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 269: }
270: close($fh);
271: }
272:
1.15 harris41 273: }
1.12 harris41 274: # ------------------------------------------------------------------ file types
275: {
1.158 raeburn 276: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
277: '/filetypes.tab';
1.1075.2.128 raeburn 278: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 279: while (my $line = <$fh>) {
280: next if ($line =~ /^\#/);
281: chomp($line);
282: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 283: if ($descr ne '') {
284: $fe{$ending}=lc($emb);
285: $fd{$ending}=$descr;
1.351 www 286: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 287: }
288: }
289: close($fh);
290: }
1.12 harris41 291: }
1.22 www 292: &Apache::lonnet::logthis(
1.705 tempelho 293: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 294: $readit=1;
1.46 matthew 295: } # end of unless($readit)
1.32 matthew 296:
297: }
1.112 bowersj2 298:
1.42 matthew 299: ###############################################################
300: ## HTML and Javascript Helper Functions ##
301: ###############################################################
302:
303: =pod
304:
1.112 bowersj2 305: =head1 HTML and Javascript Functions
1.42 matthew 306:
1.112 bowersj2 307: =over 4
308:
1.648 raeburn 309: =item * &browser_and_searcher_javascript()
1.112 bowersj2 310:
311: X<browsing, javascript>X<searching, javascript>Returns a string
312: containing javascript with two functions, C<openbrowser> and
313: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
314: tags.
1.42 matthew 315:
1.648 raeburn 316: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 317:
318: inputs: formname, elementname, only, omit
319:
320: formname and elementname indicate the name of the html form and name of
321: the element that the results of the browsing selection are to be placed in.
322:
323: Specifying 'only' will restrict the browser to displaying only files
1.185 www 324: with the given extension. Can be a comma separated list.
1.42 matthew 325:
326: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 327: with the given extension. Can be a comma separated list.
1.42 matthew 328:
1.648 raeburn 329: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 330:
331: Inputs: formname, elementname
332:
333: formname and elementname specify the name of the html form and the name
334: of the element the selection from the search results will be placed in.
1.542 raeburn 335:
1.42 matthew 336: =cut
337:
338: sub browser_and_searcher_javascript {
1.199 albertel 339: my ($mode)=@_;
340: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 341: my $resurl=&escape_single(&lastresurl());
1.42 matthew 342: return <<END;
1.219 albertel 343: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 344: var editbrowser = null;
1.135 albertel 345: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 346: var url = '$resurl/?';
1.42 matthew 347: if (editbrowser == null) {
348: url += 'launch=1&';
349: }
350: url += 'catalogmode=interactive&';
1.199 albertel 351: url += 'mode=$mode&';
1.611 albertel 352: url += 'inhibitmenu=yes&';
1.42 matthew 353: url += 'form=' + formname + '&';
354: if (only != null) {
355: url += 'only=' + only + '&';
1.217 albertel 356: } else {
357: url += 'only=&';
358: }
1.42 matthew 359: if (omit != null) {
360: url += 'omit=' + omit + '&';
1.217 albertel 361: } else {
362: url += 'omit=&';
363: }
1.135 albertel 364: if (titleelement != null) {
365: url += 'titleelement=' + titleelement + '&';
1.217 albertel 366: } else {
367: url += 'titleelement=&';
368: }
1.42 matthew 369: url += 'element=' + elementname + '';
370: var title = 'Browser';
1.435 albertel 371: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 372: options += ',width=700,height=600';
373: editbrowser = open(url,title,options,'1');
374: editbrowser.focus();
375: }
376: var editsearcher;
1.135 albertel 377: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 378: var url = '/adm/searchcat?';
379: if (editsearcher == null) {
380: url += 'launch=1&';
381: }
382: url += 'catalogmode=interactive&';
1.199 albertel 383: url += 'mode=$mode&';
1.42 matthew 384: url += 'form=' + formname + '&';
1.135 albertel 385: if (titleelement != null) {
386: url += 'titleelement=' + titleelement + '&';
1.217 albertel 387: } else {
388: url += 'titleelement=&';
389: }
1.42 matthew 390: url += 'element=' + elementname + '';
391: var title = 'Search';
1.435 albertel 392: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 393: options += ',width=700,height=600';
394: editsearcher = open(url,title,options,'1');
395: editsearcher.focus();
396: }
1.219 albertel 397: // END LON-CAPA Internal -->
1.42 matthew 398: END
1.170 www 399: }
400:
401: sub lastresurl {
1.258 albertel 402: if ($env{'environment.lastresurl'}) {
403: return $env{'environment.lastresurl'}
1.170 www 404: } else {
405: return '/res';
406: }
407: }
408:
409: sub storeresurl {
410: my $resurl=&Apache::lonnet::clutter(shift);
411: unless ($resurl=~/^\/res/) { return 0; }
412: $resurl=~s/\/$//;
413: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 414: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 415: return 1;
1.42 matthew 416: }
417:
1.74 www 418: sub studentbrowser_javascript {
1.111 www 419: unless (
1.258 albertel 420: (($env{'request.course.id'}) &&
1.302 albertel 421: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
422: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
423: '/'.$env{'request.course.sec'})
424: ))
1.258 albertel 425: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 426: ) { return ''; }
1.74 www 427: return (<<'ENDSTDBRW');
1.776 bisitz 428: <script type="text/javascript" language="Javascript">
1.824 bisitz 429: // <![CDATA[
1.74 www 430: var stdeditbrowser;
1.1075.2.143 raeburn 431: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74 www 432: var url = '/adm/pickstudent?';
433: var filter;
1.558 albertel 434: if (!ignorefilter) {
435: eval('filter=document.'+formname+'.'+uname+'.value;');
436: }
1.74 www 437: if (filter != null) {
438: if (filter != '') {
439: url += 'filter='+filter+'&';
440: }
441: }
442: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 443: '&udomelement='+udom+
444: '&clicker='+clicker;
1.111 www 445: if (roleflag) { url+="&roles=1"; }
1.1075.2.143 raeburn 446: if (courseadv == 'condition') {
447: if (document.getElementById('courseadv')) {
448: courseadv = document.getElementById('courseadv').value;
449: }
450: }
451: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102 www 452: var title = 'Student_Browser';
1.74 www 453: var options = 'scrollbars=1,resizable=1,menubar=0';
454: options += ',width=700,height=600';
455: stdeditbrowser = open(url,title,options,'1');
456: stdeditbrowser.focus();
457: }
1.824 bisitz 458: // ]]>
1.74 www 459: </script>
460: ENDSTDBRW
461: }
1.42 matthew 462:
1.1003 www 463: sub resourcebrowser_javascript {
464: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 465: return (<<'ENDRESBRW');
1.1003 www 466: <script type="text/javascript" language="Javascript">
467: // <![CDATA[
468: var reseditbrowser;
1.1004 www 469: function openresbrowser(formname,reslink) {
1.1005 www 470: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 471: var title = 'Resource_Browser';
472: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 473: options += ',width=700,height=500';
1.1004 www 474: reseditbrowser = open(url,title,options,'1');
475: reseditbrowser.focus();
1.1003 www 476: }
477: // ]]>
478: </script>
1.1004 www 479: ENDRESBRW
1.1003 www 480: }
481:
1.74 www 482: sub selectstudent_link {
1.1075.2.143 raeburn 483: my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999 www 484: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
485: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
486: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 487: if ($env{'request.course.id'}) {
1.302 albertel 488: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
489: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
490: '/'.$env{'request.course.sec'})) {
1.111 www 491: return '';
492: }
1.999 www 493: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.143 raeburn 494: if ($courseadv eq 'only') {
495: $callargs .= ",'',1,'$courseadv'";
496: } elsif ($courseadv eq 'none') {
497: $callargs .= ",'','','$courseadv'";
498: } elsif ($courseadv eq 'condition') {
499: $callargs .= ",'','','$courseadv'";
1.793 raeburn 500: }
501: return '<span class="LC_nobreak">'.
502: '<a href="javascript:openstdbrowser('.$callargs.');">'.
503: &mt('Select User').'</a></span>';
1.74 www 504: }
1.258 albertel 505: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 506: $callargs .= ",'',1";
1.793 raeburn 507: return '<span class="LC_nobreak">'.
508: '<a href="javascript:openstdbrowser('.$callargs.');">'.
509: &mt('Select User').'</a></span>';
1.111 www 510: }
511: return '';
1.91 www 512: }
513:
1.1004 www 514: sub selectresource_link {
515: my ($form,$reslink,$arg)=@_;
516:
517: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
518: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
519: unless ($env{'request.course.id'}) { return $arg; }
520: return '<span class="LC_nobreak">'.
521: '<a href="javascript:openresbrowser('.$callargs.');">'.
522: $arg.'</a></span>';
523: }
524:
525:
526:
1.653 raeburn 527: sub authorbrowser_javascript {
528: return <<"ENDAUTHORBRW";
1.776 bisitz 529: <script type="text/javascript" language="JavaScript">
1.824 bisitz 530: // <![CDATA[
1.653 raeburn 531: var stdeditbrowser;
532:
533: function openauthorbrowser(formname,udom) {
534: var url = '/adm/pickauthor?';
535: url += 'form='+formname+'&roledom='+udom;
536: var title = 'Author_Browser';
537: var options = 'scrollbars=1,resizable=1,menubar=0';
538: options += ',width=700,height=600';
539: stdeditbrowser = open(url,title,options,'1');
540: stdeditbrowser.focus();
541: }
542:
1.824 bisitz 543: // ]]>
1.653 raeburn 544: </script>
545: ENDAUTHORBRW
546: }
547:
1.91 www 548: sub coursebrowser_javascript {
1.1075.2.31 raeburn 549: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95 raeburn 550: $credits_element,$instcode) = @_;
1.932 raeburn 551: my $wintitle = 'Course_Browser';
1.931 raeburn 552: if ($crstype eq 'Community') {
1.932 raeburn 553: $wintitle = 'Community_Browser';
1.909 raeburn 554: }
1.876 raeburn 555: my $id_functions = &javascript_index_functions();
556: my $output = '
1.776 bisitz 557: <script type="text/javascript" language="JavaScript">
1.824 bisitz 558: // <![CDATA[
1.468 raeburn 559: var stdeditbrowser;'."\n";
1.876 raeburn 560:
561: $output .= <<"ENDSTDBRW";
1.909 raeburn 562: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 563: var url = '/adm/pickcourse?';
1.895 raeburn 564: var formid = getFormIdByName(formname);
1.876 raeburn 565: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 566: if (domainfilter != null) {
567: if (domainfilter != '') {
568: url += 'domainfilter='+domainfilter+'&';
569: }
570: }
1.91 www 571: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 572: '&cdomelement='+udom+
573: '&cnameelement='+desc;
1.468 raeburn 574: if (extra_element !=null && extra_element != '') {
1.594 raeburn 575: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 576: url += '&roleelement='+extra_element;
577: if (domainfilter == null || domainfilter == '') {
578: url += '&domainfilter='+extra_element;
579: }
1.234 raeburn 580: }
1.468 raeburn 581: else {
582: if (formname == 'portform') {
583: url += '&setroles='+extra_element;
1.800 raeburn 584: } else {
585: if (formname == 'rules') {
586: url += '&fixeddom='+extra_element;
587: }
1.468 raeburn 588: }
589: }
1.230 raeburn 590: }
1.909 raeburn 591: if (type != null && type != '') {
592: url += '&type='+type;
593: }
594: if (type_elem != null && type_elem != '') {
595: url += '&typeelement='+type_elem;
596: }
1.872 raeburn 597: if (formname == 'ccrs') {
598: var ownername = document.forms[formid].ccuname.value;
599: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101 raeburn 600: url += '&cloner='+ownername+':'+ownerdom;
601: if (type == 'Course') {
602: url += '&crscode='+document.forms[formid].crscode.value;
603: }
1.1075.2.95 raeburn 604: }
605: if (formname == 'requestcrs') {
606: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 607: }
1.293 raeburn 608: if (multflag !=null && multflag != '') {
609: url += '&multiple='+multflag;
610: }
1.909 raeburn 611: var title = '$wintitle';
1.91 www 612: var options = 'scrollbars=1,resizable=1,menubar=0';
613: options += ',width=700,height=600';
614: stdeditbrowser = open(url,title,options,'1');
615: stdeditbrowser.focus();
616: }
1.876 raeburn 617: $id_functions
618: ENDSTDBRW
1.1075.2.31 raeburn 619: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
620: $output .= &setsec_javascript($sec_element,$formname,$role_element,
621: $credits_element);
1.876 raeburn 622: }
623: $output .= '
624: // ]]>
625: </script>';
626: return $output;
627: }
628:
629: sub javascript_index_functions {
630: return <<"ENDJS";
631:
632: function getFormIdByName(formname) {
633: for (var i=0;i<document.forms.length;i++) {
634: if (document.forms[i].name == formname) {
635: return i;
636: }
637: }
638: return -1;
639: }
640:
641: function getIndexByName(formid,item) {
642: for (var i=0;i<document.forms[formid].elements.length;i++) {
643: if (document.forms[formid].elements[i].name == item) {
644: return i;
645: }
646: }
647: return -1;
648: }
1.468 raeburn 649:
1.876 raeburn 650: function getDomainFromSelectbox(formname,udom) {
651: var userdom;
652: var formid = getFormIdByName(formname);
653: if (formid > -1) {
654: var domid = getIndexByName(formid,udom);
655: if (domid > -1) {
656: if (document.forms[formid].elements[domid].type == 'select-one') {
657: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
658: }
659: if (document.forms[formid].elements[domid].type == 'hidden') {
660: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 661: }
662: }
663: }
1.876 raeburn 664: return userdom;
665: }
666:
667: ENDJS
1.468 raeburn 668:
1.876 raeburn 669: }
670:
1.1017 raeburn 671: sub javascript_array_indexof {
1.1018 raeburn 672: return <<ENDJS;
1.1017 raeburn 673: <script type="text/javascript" language="JavaScript">
674: // <![CDATA[
675:
676: if (!Array.prototype.indexOf) {
677: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
678: "use strict";
679: if (this === void 0 || this === null) {
680: throw new TypeError();
681: }
682: var t = Object(this);
683: var len = t.length >>> 0;
684: if (len === 0) {
685: return -1;
686: }
687: var n = 0;
688: if (arguments.length > 0) {
689: n = Number(arguments[1]);
690: if (n !== n) { // shortcut for verifying if it's NaN
691: n = 0;
692: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
693: n = (n > 0 || -1) * Math.floor(Math.abs(n));
694: }
695: }
696: if (n >= len) {
697: return -1;
698: }
699: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
700: for (; k < len; k++) {
701: if (k in t && t[k] === searchElement) {
702: return k;
703: }
704: }
705: return -1;
706: }
707: }
708:
709: // ]]>
710: </script>
711:
712: ENDJS
713:
714: }
715:
1.876 raeburn 716: sub userbrowser_javascript {
717: my $id_functions = &javascript_index_functions();
718: return <<"ENDUSERBRW";
719:
1.888 raeburn 720: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 721: var url = '/adm/pickuser?';
722: var userdom = getDomainFromSelectbox(formname,udom);
723: if (userdom != null) {
724: if (userdom != '') {
725: url += 'srchdom='+userdom+'&';
726: }
727: }
728: url += 'form=' + formname + '&unameelement='+uname+
729: '&udomelement='+udom+
730: '&ulastelement='+ulast+
731: '&ufirstelement='+ufirst+
732: '&uemailelement='+uemail+
1.881 raeburn 733: '&hideudomelement='+hideudom+
734: '&coursedom='+crsdom;
1.888 raeburn 735: if ((caller != null) && (caller != undefined)) {
736: url += '&caller='+caller;
737: }
1.876 raeburn 738: var title = 'User_Browser';
739: var options = 'scrollbars=1,resizable=1,menubar=0';
740: options += ',width=700,height=600';
741: var stdeditbrowser = open(url,title,options,'1');
742: stdeditbrowser.focus();
743: }
744:
1.888 raeburn 745: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 746: var formid = getFormIdByName(formname);
747: if (formid > -1) {
1.888 raeburn 748: var unameid = getIndexByName(formid,uname);
1.876 raeburn 749: var domid = getIndexByName(formid,udom);
750: var hidedomid = getIndexByName(formid,origdom);
751: if (hidedomid > -1) {
752: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 753: var unameval = document.forms[formid].elements[unameid].value;
754: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
755: if (domid > -1) {
756: var slct = document.forms[formid].elements[domid];
757: if (slct.type == 'select-one') {
758: var i;
759: for (i=0;i<slct.length;i++) {
760: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
761: }
762: }
763: if (slct.type == 'hidden') {
764: slct.value = fixeddom;
1.876 raeburn 765: }
766: }
1.468 raeburn 767: }
768: }
769: }
1.876 raeburn 770: return;
771: }
772:
773: $id_functions
774: ENDUSERBRW
1.468 raeburn 775: }
776:
777: sub setsec_javascript {
1.1075.2.31 raeburn 778: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 779: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
780: $communityrolestr);
781: if ($role_element ne '') {
782: my @allroles = ('st','ta','ep','in','ad');
783: foreach my $crstype ('Course','Community') {
784: if ($crstype eq 'Community') {
785: foreach my $role (@allroles) {
786: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
787: }
788: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
789: } else {
790: foreach my $role (@allroles) {
791: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
792: }
793: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
794: }
795: }
796: $rolestr = '"'.join('","',@allroles).'"';
797: $courserolestr = '"'.join('","',@courserolenames).'"';
798: $communityrolestr = '"'.join('","',@communityrolenames).'"';
799: }
1.468 raeburn 800: my $setsections = qq|
801: function setSect(sectionlist) {
1.629 raeburn 802: var sectionsArray = new Array();
803: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
804: sectionsArray = sectionlist.split(",");
805: }
1.468 raeburn 806: var numSections = sectionsArray.length;
807: document.$formname.$sec_element.length = 0;
808: if (numSections == 0) {
809: document.$formname.$sec_element.multiple=false;
810: document.$formname.$sec_element.size=1;
811: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
812: } else {
813: if (numSections == 1) {
814: document.$formname.$sec_element.multiple=false;
815: document.$formname.$sec_element.size=1;
816: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
817: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
818: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
819: } else {
820: for (var i=0; i<numSections; i++) {
821: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
822: }
823: document.$formname.$sec_element.multiple=true
824: if (numSections < 3) {
825: document.$formname.$sec_element.size=numSections;
826: } else {
827: document.$formname.$sec_element.size=3;
828: }
829: document.$formname.$sec_element.options[0].selected = false
830: }
831: }
1.91 www 832: }
1.905 raeburn 833:
834: function setRole(crstype) {
1.468 raeburn 835: |;
1.905 raeburn 836: if ($role_element eq '') {
837: $setsections .= ' return;
838: }
839: ';
840: } else {
841: $setsections .= qq|
842: var elementLength = document.$formname.$role_element.length;
843: var allroles = Array($rolestr);
844: var courserolenames = Array($courserolestr);
845: var communityrolenames = Array($communityrolestr);
846: if (elementLength != undefined) {
847: if (document.$formname.$role_element.options[5].value == 'cc') {
848: if (crstype == 'Course') {
849: return;
850: } else {
851: allroles[5] = 'co';
852: for (var i=0; i<6; i++) {
853: document.$formname.$role_element.options[i].value = allroles[i];
854: document.$formname.$role_element.options[i].text = communityrolenames[i];
855: }
856: }
857: } else {
858: if (crstype == 'Community') {
859: return;
860: } else {
861: allroles[5] = 'cc';
862: for (var i=0; i<6; i++) {
863: document.$formname.$role_element.options[i].value = allroles[i];
864: document.$formname.$role_element.options[i].text = courserolenames[i];
865: }
866: }
867: }
868: }
869: return;
870: }
871: |;
872: }
1.1075.2.31 raeburn 873: if ($credits_element) {
874: $setsections .= qq|
875: function setCredits(defaultcredits) {
876: document.$formname.$credits_element.value = defaultcredits;
877: return;
878: }
879: |;
880: }
1.468 raeburn 881: return $setsections;
882: }
883:
1.91 www 884: sub selectcourse_link {
1.909 raeburn 885: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
886: $typeelement) = @_;
887: my $type = $selecttype;
1.871 raeburn 888: my $linktext = &mt('Select Course');
889: if ($selecttype eq 'Community') {
1.909 raeburn 890: $linktext = &mt('Select Community');
1.906 raeburn 891: } elsif ($selecttype eq 'Course/Community') {
892: $linktext = &mt('Select Course/Community');
1.909 raeburn 893: $type = '';
1.1019 raeburn 894: } elsif ($selecttype eq 'Select') {
895: $linktext = &mt('Select');
896: $type = '';
1.871 raeburn 897: }
1.787 bisitz 898: return '<span class="LC_nobreak">'
899: ."<a href='"
900: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
901: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 902: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 903: ."'>".$linktext.'</a>'
1.787 bisitz 904: .'</span>';
1.74 www 905: }
1.42 matthew 906:
1.653 raeburn 907: sub selectauthor_link {
908: my ($form,$udom)=@_;
909: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
910: &mt('Select Author').'</a>';
911: }
912:
1.876 raeburn 913: sub selectuser_link {
1.881 raeburn 914: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 915: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 916: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 917: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 918: ');">'.$linktext.'</a>';
1.876 raeburn 919: }
920:
1.273 raeburn 921: sub check_uncheck_jscript {
922: my $jscript = <<"ENDSCRT";
923: function checkAll(field) {
924: if (field.length > 0) {
925: for (i = 0; i < field.length; i++) {
1.1075.2.14 raeburn 926: if (!field[i].disabled) {
927: field[i].checked = true;
928: }
1.273 raeburn 929: }
930: } else {
1.1075.2.14 raeburn 931: if (!field.disabled) {
932: field.checked = true;
933: }
1.273 raeburn 934: }
935: }
936:
937: function uncheckAll(field) {
938: if (field.length > 0) {
939: for (i = 0; i < field.length; i++) {
940: field[i].checked = false ;
1.543 albertel 941: }
942: } else {
1.273 raeburn 943: field.checked = false ;
944: }
945: }
946: ENDSCRT
947: return $jscript;
948: }
949:
1.656 www 950: sub select_timezone {
1.1075.2.115 raeburn 951: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
952: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659 raeburn 953: if ($includeempty) {
954: $output .= '<option value=""';
955: if (($selected eq '') || ($selected eq 'local')) {
956: $output .= ' selected="selected" ';
957: }
958: $output .= '> </option>';
959: }
1.657 raeburn 960: my @timezones = DateTime::TimeZone->all_names;
961: foreach my $tzone (@timezones) {
962: $output.= '<option value="'.$tzone.'"';
963: if ($tzone eq $selected) {
964: $output.=' selected="selected"';
965: }
966: $output.=">$tzone</option>\n";
1.656 www 967: }
968: $output.="</select>";
969: return $output;
970: }
1.273 raeburn 971:
1.687 raeburn 972: sub select_datelocale {
1.1075.2.115 raeburn 973: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
974: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 975: if ($includeempty) {
976: $output .= '<option value=""';
977: if ($selected eq '') {
978: $output .= ' selected="selected" ';
979: }
980: $output .= '> </option>';
981: }
1.1075.2.102 raeburn 982: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 983: my (@possibles,%locale_names);
1.1075.2.102 raeburn 984: my @locales = DateTime::Locale->ids();
985: foreach my $id (@locales) {
986: if ($id ne '') {
987: my ($en_terr,$native_terr);
988: my $loc = DateTime::Locale->load($id);
989: if (ref($loc)) {
990: $en_terr = $loc->name();
991: $native_terr = $loc->native_name();
1.687 raeburn 992: if (grep(/^en$/,@languages) || !@languages) {
993: if ($en_terr ne '') {
994: $locale_names{$id} = '('.$en_terr.')';
995: } elsif ($native_terr ne '') {
996: $locale_names{$id} = $native_terr;
997: }
998: } else {
999: if ($native_terr ne '') {
1000: $locale_names{$id} = $native_terr.' ';
1001: } elsif ($en_terr ne '') {
1002: $locale_names{$id} = '('.$en_terr.')';
1003: }
1004: }
1.1075.2.94 raeburn 1005: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102 raeburn 1006: push(@possibles,$id);
1.687 raeburn 1007: }
1008: }
1009: }
1010: foreach my $item (sort(@possibles)) {
1011: $output.= '<option value="'.$item.'"';
1012: if ($item eq $selected) {
1013: $output.=' selected="selected"';
1014: }
1015: $output.=">$item";
1016: if ($locale_names{$item} ne '') {
1.1075.2.94 raeburn 1017: $output.=' '.$locale_names{$item};
1.687 raeburn 1018: }
1019: $output.="</option>\n";
1020: }
1021: $output.="</select>";
1022: return $output;
1023: }
1024:
1.792 raeburn 1025: sub select_language {
1.1075.2.115 raeburn 1026: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1027: my %langchoices;
1028: if ($includeempty) {
1.1075.2.32 raeburn 1029: %langchoices = ('' => 'No language preference');
1.792 raeburn 1030: }
1031: foreach my $id (&languageids()) {
1032: my $code = &supportedlanguagecode($id);
1033: if ($code) {
1034: $langchoices{$code} = &plainlanguagedescription($id);
1035: }
1036: }
1.1075.2.32 raeburn 1037: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115 raeburn 1038: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1039: }
1040:
1.42 matthew 1041: =pod
1.36 matthew 1042:
1.648 raeburn 1043: =item * &linked_select_forms(...)
1.36 matthew 1044:
1045: linked_select_forms returns a string containing a <script></script> block
1046: and html for two <select> menus. The select menus will be linked in that
1047: changing the value of the first menu will result in new values being placed
1048: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1049: order unless a defined order is provided.
1.36 matthew 1050:
1051: linked_select_forms takes the following ordered inputs:
1052:
1053: =over 4
1054:
1.112 bowersj2 1055: =item * $formname, the name of the <form> tag
1.36 matthew 1056:
1.112 bowersj2 1057: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1058:
1.112 bowersj2 1059: =item * $firstdefault, the default value for the first menu
1.36 matthew 1060:
1.112 bowersj2 1061: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1062:
1.112 bowersj2 1063: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1064:
1.112 bowersj2 1065: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1066:
1.609 raeburn 1067: =item * $menuorder, the order of values in the first menu
1068:
1.1075.2.31 raeburn 1069: =item * $onchangefirst, additional javascript call to execute for an onchange
1070: event for the first <select> tag
1071:
1072: =item * $onchangesecond, additional javascript call to execute for an onchange
1073: event for the second <select> tag
1074:
1.41 ng 1075: =back
1076:
1.36 matthew 1077: Below is an example of such a hash. Only the 'text', 'default', and
1078: 'select2' keys must appear as stated. keys(%menu) are the possible
1079: values for the first select menu. The text that coincides with the
1.41 ng 1080: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1081: and text for the second menu are given in the hash pointed to by
1082: $menu{$choice1}->{'select2'}.
1083:
1.112 bowersj2 1084: my %menu = ( A1 => { text =>"Choice A1" ,
1085: default => "B3",
1086: select2 => {
1087: B1 => "Choice B1",
1088: B2 => "Choice B2",
1089: B3 => "Choice B3",
1090: B4 => "Choice B4"
1.609 raeburn 1091: },
1092: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1093: },
1094: A2 => { text =>"Choice A2" ,
1095: default => "C2",
1096: select2 => {
1097: C1 => "Choice C1",
1098: C2 => "Choice C2",
1099: C3 => "Choice C3"
1.609 raeburn 1100: },
1101: order => ['C2','C1','C3'],
1.112 bowersj2 1102: },
1103: A3 => { text =>"Choice A3" ,
1104: default => "D6",
1105: select2 => {
1106: D1 => "Choice D1",
1107: D2 => "Choice D2",
1108: D3 => "Choice D3",
1109: D4 => "Choice D4",
1110: D5 => "Choice D5",
1111: D6 => "Choice D6",
1112: D7 => "Choice D7"
1.609 raeburn 1113: },
1114: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1115: }
1116: );
1.36 matthew 1117:
1118: =cut
1119:
1120: sub linked_select_forms {
1121: my ($formname,
1122: $middletext,
1123: $firstdefault,
1124: $firstselectname,
1125: $secondselectname,
1.609 raeburn 1126: $hashref,
1127: $menuorder,
1.1075.2.31 raeburn 1128: $onchangefirst,
1129: $onchangesecond
1.36 matthew 1130: ) = @_;
1131: my $second = "document.$formname.$secondselectname";
1132: my $first = "document.$formname.$firstselectname";
1133: # output the javascript to do the changing
1134: my $result = '';
1.776 bisitz 1135: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1136: $result.="// <![CDATA[\n";
1.36 matthew 1137: $result.="var select2data = new Object();\n";
1138: $" = '","';
1139: my $debug = '';
1140: foreach my $s1 (sort(keys(%$hashref))) {
1141: $result.="select2data.d_$s1 = new Object();\n";
1142: $result.="select2data.d_$s1.def = new String('".
1143: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1144: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1145: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1146: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1147: @s2values = @{$hashref->{$s1}->{'order'}};
1148: }
1.36 matthew 1149: $result.="\"@s2values\");\n";
1150: $result.="select2data.d_$s1.texts = new Array(";
1151: my @s2texts;
1152: foreach my $value (@s2values) {
1.1075.2.119 raeburn 1153: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1154: }
1155: $result.="\"@s2texts\");\n";
1156: }
1157: $"=' ';
1158: $result.= <<"END";
1159:
1160: function select1_changed() {
1161: // Determine new choice
1162: var newvalue = "d_" + $first.value;
1163: // update select2
1164: var values = select2data[newvalue].values;
1165: var texts = select2data[newvalue].texts;
1166: var select2def = select2data[newvalue].def;
1167: var i;
1168: // out with the old
1169: for (i = 0; i < $second.options.length; i++) {
1170: $second.options[i] = null;
1171: }
1172: // in with the nuclear
1173: for (i=0;i<values.length; i++) {
1174: $second.options[i] = new Option(values[i]);
1.143 matthew 1175: $second.options[i].value = values[i];
1.36 matthew 1176: $second.options[i].text = texts[i];
1177: if (values[i] == select2def) {
1178: $second.options[i].selected = true;
1179: }
1180: }
1181: }
1.824 bisitz 1182: // ]]>
1.36 matthew 1183: </script>
1184: END
1185: # output the initial values for the selection lists
1.1075.2.31 raeburn 1186: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1187: my @order = sort(keys(%{$hashref}));
1188: if (ref($menuorder) eq 'ARRAY') {
1189: @order = @{$menuorder};
1190: }
1191: foreach my $value (@order) {
1.36 matthew 1192: $result.=" <option value=\"$value\" ";
1.253 albertel 1193: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1194: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1195: }
1196: $result .= "</select>\n";
1197: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1198: $result .= $middletext;
1.1075.2.31 raeburn 1199: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1200: if ($onchangesecond) {
1201: $result .= ' onchange="'.$onchangesecond.'"';
1202: }
1203: $result .= ">\n";
1.36 matthew 1204: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1205:
1206: my @secondorder = sort(keys(%select2));
1207: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1208: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1209: }
1210: foreach my $value (@secondorder) {
1.36 matthew 1211: $result.=" <option value=\"$value\" ";
1.253 albertel 1212: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1213: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1214: }
1215: $result .= "</select>\n";
1216: # return $debug;
1217: return $result;
1218: } # end of sub linked_select_forms {
1219:
1.45 matthew 1220: =pod
1.44 bowersj2 1221:
1.973 raeburn 1222: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1223:
1.112 bowersj2 1224: Returns a string corresponding to an HTML link to the given help
1225: $topic, where $topic corresponds to the name of a .tex file in
1226: /home/httpd/html/adm/help/tex, with underscores replaced by
1227: spaces.
1228:
1229: $text will optionally be linked to the same topic, allowing you to
1230: link text in addition to the graphic. If you do not want to link
1231: text, but wish to specify one of the later parameters, pass an
1232: empty string.
1233:
1234: $stayOnPage is a value that will be interpreted as a boolean. If true,
1235: the link will not open a new window. If false, the link will open
1236: a new window using Javascript. (Default is false.)
1237:
1238: $width and $height are optional numerical parameters that will
1239: override the width and height of the popped up window, which may
1.973 raeburn 1240: be useful for certain help topics with big pictures included.
1241:
1242: $imgid is the id of the img tag used for the help icon. This may be
1243: used in a javascript call to switch the image src. See
1244: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1245:
1246: =cut
1247:
1248: sub help_open_topic {
1.973 raeburn 1249: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1250: $text = "" if (not defined $text);
1.44 bowersj2 1251: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1252: $width = 500 if (not defined $width);
1.44 bowersj2 1253: $height = 400 if (not defined $height);
1254: my $filename = $topic;
1255: $filename =~ s/ /_/g;
1256:
1.48 bowersj2 1257: my $template = "";
1258: my $link;
1.572 banghart 1259:
1.159 www 1260: $topic=~s/\W/\_/g;
1.44 bowersj2 1261:
1.572 banghart 1262: if (!$stayOnPage) {
1.1075.2.50 raeburn 1263: if ($env{'browser.mobile'}) {
1264: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1265: } else {
1266: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1267: }
1.1037 www 1268: } elsif ($stayOnPage eq 'popup') {
1269: $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 1270: } else {
1.48 bowersj2 1271: $link = "/adm/help/${filename}.hlp";
1272: }
1273:
1274: # Add the text
1.755 neumanie 1275: if ($text ne "") {
1.763 bisitz 1276: $template.='<span class="LC_help_open_topic">'
1277: .'<a target="_top" href="'.$link.'">'
1278: .$text.'</a>';
1.48 bowersj2 1279: }
1280:
1.763 bisitz 1281: # (Always) Add the graphic
1.179 matthew 1282: my $title = &mt('Online Help');
1.667 raeburn 1283: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1284: if ($imgid ne '') {
1285: $imgid = ' id="'.$imgid.'"';
1286: }
1.763 bisitz 1287: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1288: .'<img src="'.$helpicon.'" border="0"'
1289: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1290: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1291: .' /></a>';
1292: if ($text ne "") {
1293: $template.='</span>';
1294: }
1.44 bowersj2 1295: return $template;
1296:
1.106 bowersj2 1297: }
1298:
1299: # This is a quicky function for Latex cheatsheet editing, since it
1300: # appears in at least four places
1301: sub helpLatexCheatsheet {
1.1037 www 1302: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1303: my $out;
1.106 bowersj2 1304: my $addOther = '';
1.732 raeburn 1305: if ($topic) {
1.1037 www 1306: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1307: }
1308: $out = '<span>' # Start cheatsheet
1309: .$addOther
1310: .'<span>'
1.1037 www 1311: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1312: .'</span> <span>'
1.1037 www 1313: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1314: .'</span>';
1.732 raeburn 1315: unless ($not_author) {
1.763 bisitz 1316: $out .= ' <span>'
1.1037 www 1317: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1318: .'</span> <span>'
1.1075.2.78 raeburn 1319: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1320: .'</span>';
1.732 raeburn 1321: }
1.763 bisitz 1322: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1323: return $out;
1.172 www 1324: }
1325:
1.430 albertel 1326: sub general_help {
1327: my $helptopic='Student_Intro';
1328: if ($env{'request.role'}=~/^(ca|au)/) {
1329: $helptopic='Authoring_Intro';
1.907 raeburn 1330: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1331: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1332: } elsif ($env{'request.role'}=~/^dc/) {
1333: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1334: }
1335: return $helptopic;
1336: }
1337:
1338: sub update_help_link {
1339: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1340: my $origurl = $ENV{'REQUEST_URI'};
1341: $origurl=~s|^/~|/priv/|;
1342: my $timestamp = time;
1343: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1344: $$datum = &escape($$datum);
1345: }
1346:
1347: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1348: my $output .= <<"ENDOUTPUT";
1349: <script type="text/javascript">
1.824 bisitz 1350: // <![CDATA[
1.430 albertel 1351: banner_link = '$banner_link';
1.824 bisitz 1352: // ]]>
1.430 albertel 1353: </script>
1354: ENDOUTPUT
1355: return $output;
1356: }
1357:
1358: # now just updates the help link and generates a blue icon
1.193 raeburn 1359: sub help_open_menu {
1.430 albertel 1360: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1361: = @_;
1.949 droeschl 1362: $stayOnPage = 1;
1.430 albertel 1363: my $output;
1364: if ($component_help) {
1365: if (!$text) {
1366: $output=&help_open_topic($component_help,undef,$stayOnPage,
1367: $width,$height);
1368: } else {
1369: my $help_text;
1370: $help_text=&unescape($topic);
1371: $output='<table><tr><td>'.
1372: &help_open_topic($component_help,$help_text,$stayOnPage,
1373: $width,$height).'</td></tr></table>';
1374: }
1375: }
1376: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1377: return $output.$banner_link;
1378: }
1379:
1380: sub top_nav_help {
1381: my ($text) = @_;
1.436 albertel 1382: $text = &mt($text);
1.1075.2.60 raeburn 1383: my $stay_on_page;
1384: unless ($env{'environment.remote'} eq 'on') {
1385: $stay_on_page = 1;
1386: }
1.1075.2.61 raeburn 1387: my ($link,$banner_link);
1388: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1389: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1390: : "javascript:helpMenu('open')";
1391: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1392: }
1.201 raeburn 1393: my $title = &mt('Get help');
1.1075.2.61 raeburn 1394: if ($link) {
1395: return <<"END";
1.436 albertel 1396: $banner_link
1.1075.2.56 raeburn 1397: <a href="$link" title="$title">$text</a>
1.436 albertel 1398: END
1.1075.2.61 raeburn 1399: } else {
1400: return ' '.$text.' ';
1401: }
1.436 albertel 1402: }
1403:
1404: sub help_menu_js {
1.1075.2.52 raeburn 1405: my ($httphost) = @_;
1.949 droeschl 1406: my $stayOnPage = 1;
1.436 albertel 1407: my $width = 620;
1408: my $height = 600;
1.430 albertel 1409: my $helptopic=&general_help();
1.1075.2.52 raeburn 1410: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1411: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1412: my $start_page =
1413: &Apache::loncommon::start_page('Help Menu', undef,
1414: {'frameset' => 1,
1415: 'js_ready' => 1,
1.1075.2.136 raeburn 1416: 'use_absolute' => $httphost,
1.331 albertel 1417: 'add_entries' => {
1418: 'border' => '0',
1.579 raeburn 1419: 'rows' => "110,*",},});
1.331 albertel 1420: my $end_page =
1421: &Apache::loncommon::end_page({'frameset' => 1,
1422: 'js_ready' => 1,});
1423:
1.436 albertel 1424: my $template .= <<"ENDTEMPLATE";
1425: <script type="text/javascript">
1.877 bisitz 1426: // <![CDATA[
1.253 albertel 1427: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1428: var banner_link = '';
1.243 raeburn 1429: function helpMenu(target) {
1430: var caller = this;
1431: if (target == 'open') {
1432: var newWindow = null;
1433: try {
1.262 albertel 1434: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1435: }
1436: catch(error) {
1437: writeHelp(caller);
1438: return;
1439: }
1440: if (newWindow) {
1441: caller = newWindow;
1442: }
1.193 raeburn 1443: }
1.243 raeburn 1444: writeHelp(caller);
1445: return;
1446: }
1447: function writeHelp(caller) {
1.1075.2.61 raeburn 1448: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1449: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1450: caller.document.close();
1451: caller.focus();
1.193 raeburn 1452: }
1.877 bisitz 1453: // END LON-CAPA Internal -->
1.253 albertel 1454: // ]]>
1.436 albertel 1455: </script>
1.193 raeburn 1456: ENDTEMPLATE
1457: return $template;
1458: }
1459:
1.172 www 1460: sub help_open_bug {
1461: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1462: unless ($env{'user.adv'}) { return ''; }
1.172 www 1463: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1464: $text = "" if (not defined $text);
1465: $stayOnPage=1;
1.184 albertel 1466: $width = 600 if (not defined $width);
1467: $height = 600 if (not defined $height);
1.172 www 1468:
1469: $topic=~s/\W+/\+/g;
1470: my $link='';
1471: my $template='';
1.379 albertel 1472: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1473: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1474: if (!$stayOnPage)
1475: {
1476: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1477: }
1478: else
1479: {
1480: $link = $url;
1481: }
1482: # Add the text
1483: if ($text ne "")
1484: {
1485: $template .=
1486: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1487: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1488: }
1489:
1490: # Add the graphic
1.179 matthew 1491: my $title = &mt('Report a Bug');
1.215 albertel 1492: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1493: $template .= <<"ENDTEMPLATE";
1.436 albertel 1494: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1495: ENDTEMPLATE
1496: if ($text ne '') { $template.='</td></tr></table>' };
1497: return $template;
1498:
1499: }
1500:
1501: sub help_open_faq {
1502: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1503: unless ($env{'user.adv'}) { return ''; }
1.172 www 1504: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1505: $text = "" if (not defined $text);
1506: $stayOnPage=1;
1507: $width = 350 if (not defined $width);
1508: $height = 400 if (not defined $height);
1509:
1510: $topic=~s/\W+/\+/g;
1511: my $link='';
1512: my $template='';
1513: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1514: if (!$stayOnPage)
1515: {
1516: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1517: }
1518: else
1519: {
1520: $link = $url;
1521: }
1522:
1523: # Add the text
1524: if ($text ne "")
1525: {
1526: $template .=
1.173 www 1527: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1528: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1529: }
1530:
1531: # Add the graphic
1.179 matthew 1532: my $title = &mt('View the FAQ');
1.215 albertel 1533: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1534: $template .= <<"ENDTEMPLATE";
1.436 albertel 1535: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1536: ENDTEMPLATE
1537: if ($text ne '') { $template.='</td></tr></table>' };
1538: return $template;
1539:
1.44 bowersj2 1540: }
1.37 matthew 1541:
1.180 matthew 1542: ###############################################################
1543: ###############################################################
1544:
1.45 matthew 1545: =pod
1546:
1.648 raeburn 1547: =item * &change_content_javascript():
1.256 matthew 1548:
1549: This and the next function allow you to create small sections of an
1550: otherwise static HTML page that you can update on the fly with
1551: Javascript, even in Netscape 4.
1552:
1553: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1554: must be written to the HTML page once. It will prove the Javascript
1555: function "change(name, content)". Calling the change function with the
1556: name of the section
1557: you want to update, matching the name passed to C<changable_area>, and
1558: the new content you want to put in there, will put the content into
1559: that area.
1560:
1561: B<Note>: Netscape 4 only reserves enough space for the changable area
1562: to contain room for the original contents. You need to "make space"
1563: for whatever changes you wish to make, and be B<sure> to check your
1564: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1565: it's adequate for updating a one-line status display, but little more.
1566: This script will set the space to 100% width, so you only need to
1567: worry about height in Netscape 4.
1568:
1569: Modern browsers are much less limiting, and if you can commit to the
1570: user not using Netscape 4, this feature may be used freely with
1571: pretty much any HTML.
1572:
1573: =cut
1574:
1575: sub change_content_javascript {
1576: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1577: if ($env{'browser.type'} eq 'netscape' &&
1578: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1579: return (<<NETSCAPE4);
1580: function change(name, content) {
1581: doc = document.layers[name+"___escape"].layers[0].document;
1582: doc.open();
1583: doc.write(content);
1584: doc.close();
1585: }
1586: NETSCAPE4
1587: } else {
1588: # Otherwise, we need to use semi-standards-compliant code
1589: # (technically, "innerHTML" isn't standard but the equivalent
1590: # is really scary, and every useful browser supports it
1591: return (<<DOMBASED);
1592: function change(name, content) {
1593: element = document.getElementById(name);
1594: element.innerHTML = content;
1595: }
1596: DOMBASED
1597: }
1598: }
1599:
1600: =pod
1601:
1.648 raeburn 1602: =item * &changable_area($name,$origContent):
1.256 matthew 1603:
1604: This provides a "changable area" that can be modified on the fly via
1605: the Javascript code provided in C<change_content_javascript>. $name is
1606: the name you will use to reference the area later; do not repeat the
1607: same name on a given HTML page more then once. $origContent is what
1608: the area will originally contain, which can be left blank.
1609:
1610: =cut
1611:
1612: sub changable_area {
1613: my ($name, $origContent) = @_;
1614:
1.258 albertel 1615: if ($env{'browser.type'} eq 'netscape' &&
1616: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1617: # If this is netscape 4, we need to use the Layer tag
1618: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1619: } else {
1620: return "<span id='$name'>$origContent</span>";
1621: }
1622: }
1623:
1624: =pod
1625:
1.648 raeburn 1626: =item * &viewport_geometry_js
1.590 raeburn 1627:
1628: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1629:
1630: =cut
1631:
1632:
1633: sub viewport_geometry_js {
1634: return <<"GEOMETRY";
1635: var Geometry = {};
1636: function init_geometry() {
1637: if (Geometry.init) { return };
1638: Geometry.init=1;
1639: if (window.innerHeight) {
1640: Geometry.getViewportHeight = function() { return window.innerHeight; };
1641: Geometry.getViewportWidth = function() { return window.innerWidth; };
1642: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1643: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1644: }
1645: else if (document.documentElement && document.documentElement.clientHeight) {
1646: Geometry.getViewportHeight =
1647: function() { return document.documentElement.clientHeight; };
1648: Geometry.getViewportWidth =
1649: function() { return document.documentElement.clientWidth; };
1650:
1651: Geometry.getHorizontalScroll =
1652: function() { return document.documentElement.scrollLeft; };
1653: Geometry.getVerticalScroll =
1654: function() { return document.documentElement.scrollTop; };
1655: }
1656: else if (document.body.clientHeight) {
1657: Geometry.getViewportHeight =
1658: function() { return document.body.clientHeight; };
1659: Geometry.getViewportWidth =
1660: function() { return document.body.clientWidth; };
1661: Geometry.getHorizontalScroll =
1662: function() { return document.body.scrollLeft; };
1663: Geometry.getVerticalScroll =
1664: function() { return document.body.scrollTop; };
1665: }
1666: }
1667:
1668: GEOMETRY
1669: }
1670:
1671: =pod
1672:
1.648 raeburn 1673: =item * &viewport_size_js()
1.590 raeburn 1674:
1675: 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.
1676:
1677: =cut
1678:
1679: sub viewport_size_js {
1680: my $geometry = &viewport_geometry_js();
1681: return <<"DIMS";
1682:
1683: $geometry
1684:
1685: function getViewportDims(width,height) {
1686: init_geometry();
1687: width.value = Geometry.getViewportWidth();
1688: height.value = Geometry.getViewportHeight();
1689: return;
1690: }
1691:
1692: DIMS
1693: }
1694:
1695: =pod
1696:
1.648 raeburn 1697: =item * &resize_textarea_js()
1.565 albertel 1698:
1699: emits the needed javascript to resize a textarea to be as big as possible
1700:
1701: creates a function resize_textrea that takes two IDs first should be
1702: the id of the element to resize, second should be the id of a div that
1703: surrounds everything that comes after the textarea, this routine needs
1704: to be attached to the <body> for the onload and onresize events.
1705:
1.648 raeburn 1706: =back
1.565 albertel 1707:
1708: =cut
1709:
1710: sub resize_textarea_js {
1.590 raeburn 1711: my $geometry = &viewport_geometry_js();
1.565 albertel 1712: return <<"RESIZE";
1713: <script type="text/javascript">
1.824 bisitz 1714: // <![CDATA[
1.590 raeburn 1715: $geometry
1.565 albertel 1716:
1.588 albertel 1717: function getX(element) {
1718: var x = 0;
1719: while (element) {
1720: x += element.offsetLeft;
1721: element = element.offsetParent;
1722: }
1723: return x;
1724: }
1725: function getY(element) {
1726: var y = 0;
1727: while (element) {
1728: y += element.offsetTop;
1729: element = element.offsetParent;
1730: }
1731: return y;
1732: }
1733:
1734:
1.565 albertel 1735: function resize_textarea(textarea_id,bottom_id) {
1736: init_geometry();
1737: var textarea = document.getElementById(textarea_id);
1738: //alert(textarea);
1739:
1.588 albertel 1740: var textarea_top = getY(textarea);
1.565 albertel 1741: var textarea_height = textarea.offsetHeight;
1742: var bottom = document.getElementById(bottom_id);
1.588 albertel 1743: var bottom_top = getY(bottom);
1.565 albertel 1744: var bottom_height = bottom.offsetHeight;
1745: var window_height = Geometry.getViewportHeight();
1.588 albertel 1746: var fudge = 23;
1.565 albertel 1747: var new_height = window_height-fudge-textarea_top-bottom_height;
1748: if (new_height < 300) {
1749: new_height = 300;
1750: }
1751: textarea.style.height=new_height+'px';
1752: }
1.824 bisitz 1753: // ]]>
1.565 albertel 1754: </script>
1755: RESIZE
1756:
1757: }
1758:
1.1075.2.112 raeburn 1759: sub colorfuleditor_js {
1760: return <<"COLORFULEDIT"
1761: <script type="text/javascript">
1762: // <![CDATA[>
1763: function fold_box(curDepth, lastresource){
1764:
1765: // we need a list because there can be several blocks you need to fold in one tag
1766: var block = document.getElementsByName('foldblock_'+curDepth);
1767: // but there is only one folding button per tag
1768: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1769:
1770: if(block.item(0).style.display == 'none'){
1771:
1772: foldbutton.value = '@{[&mt("Hide")]}';
1773: for (i = 0; i < block.length; i++){
1774: block.item(i).style.display = '';
1775: }
1776: }else{
1777:
1778: foldbutton.value = '@{[&mt("Show")]}';
1779: for (i = 0; i < block.length; i++){
1780: // block.item(i).style.visibility = 'collapse';
1781: block.item(i).style.display = 'none';
1782: }
1783: };
1784: saveState(lastresource);
1785: }
1786:
1787: function saveState (lastresource) {
1788:
1789: var tag_list = getTagList();
1790: if(tag_list != null){
1791: var timestamp = new Date().getTime();
1792: var key = lastresource;
1793:
1794: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1795: // starting with timestamp
1796: var value = timestamp+';';
1797:
1798: // building the list of key-value pairs
1799: for(var i = 0; i < tag_list.length; i++){
1800: value += tag_list[i]+',';
1801: value += document.getElementsByName(tag_list[i])[0].style.display+';';
1802: }
1803:
1804: // only iterate whole storage if nothing to override
1805: if(localStorage.getItem(key) == null){
1806:
1807: // prevent storage from growing large
1808: if(localStorage.length > 50){
1809: var regex_getTimestamp = /^(?:\d)+;/;
1810: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
1811: var oldest_key;
1812:
1813: for(var i = 1; i < localStorage.length; i++){
1814: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
1815: oldest_key = localStorage.key(i);
1816: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
1817: }
1818: }
1819: localStorage.removeItem(oldest_key);
1820: }
1821: }
1822: localStorage.setItem(key,value);
1823: }
1824: }
1825:
1826: // restore folding status of blocks (on page load)
1827: function restoreState (lastresource) {
1828: if(localStorage.getItem(lastresource) != null){
1829: var key = lastresource;
1830: var value = localStorage.getItem(key);
1831: var regex_delTimestamp = /^\d+;/;
1832:
1833: value.replace(regex_delTimestamp, '');
1834:
1835: var valueArr = value.split(';');
1836: var pairs;
1837: var elements;
1838: for (var i = 0; i < valueArr.length; i++){
1839: pairs = valueArr[i].split(',');
1840: elements = document.getElementsByName(pairs[0]);
1841:
1842: for (var j = 0; j < elements.length; j++){
1843: elements[j].style.display = pairs[1];
1844: if (pairs[1] == "none"){
1845: var regex_id = /([_\\d]+)\$/;
1846: regex_id.exec(pairs[0]);
1847: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
1848: }
1849: }
1850: }
1851: }
1852: }
1853:
1854: function getTagList () {
1855:
1856: var stringToSearch = document.lonhomework.innerHTML;
1857:
1858: var ret = new Array();
1859: var regex_findBlock = /(foldblock_.*?)"/g;
1860: var tag_list = stringToSearch.match(regex_findBlock);
1861:
1862: if(tag_list != null){
1863: for(var i = 0; i < tag_list.length; i++){
1864: ret.push(tag_list[i].replace(/"/, ''));
1865: }
1866: }
1867: return ret;
1868: }
1869:
1870: function saveScrollPosition (resource) {
1871: var tag_list = getTagList();
1872:
1873: // we dont always want to jump to the first block
1874: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
1875: if(\$(window).scrollTop() > 170){
1876: if(tag_list != null){
1877: var result;
1878: for(var i = 0; i < tag_list.length; i++){
1879: if(isElementInViewport(tag_list[i])){
1880: result += tag_list[i]+';';
1881: }
1882: }
1883: sessionStorage.setItem('anchor_'+resource, result);
1884: }
1885: } else {
1886: // we dont need to save zero, just delete the item to leave everything tidy
1887: sessionStorage.removeItem('anchor_'+resource);
1888: }
1889: }
1890:
1891: function restoreScrollPosition(resource){
1892:
1893: var elem = sessionStorage.getItem('anchor_'+resource);
1894: if(elem != null){
1895: var tag_list = elem.split(';');
1896: var elem_list;
1897:
1898: for(var i = 0; i < tag_list.length; i++){
1899: elem_list = document.getElementsByName(tag_list[i]);
1900:
1901: if(elem_list.length > 0){
1902: elem = elem_list[0];
1903: break;
1904: }
1905: }
1906: elem.scrollIntoView();
1907: }
1908: }
1909:
1910: function isElementInViewport(el) {
1911:
1912: // change to last element instead of first
1913: var elem = document.getElementsByName(el);
1914: var rect = elem[0].getBoundingClientRect();
1915:
1916: return (
1917: rect.top >= 0 &&
1918: rect.left >= 0 &&
1919: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
1920: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
1921: );
1922: }
1923:
1924: function autosize(depth){
1925: var cmInst = window['cm'+depth];
1926: var fitsizeButton = document.getElementById('fitsize'+depth);
1927:
1928: // is fixed size, switching to dynamic
1929: if (sessionStorage.getItem("autosized_"+depth) == null) {
1930: cmInst.setSize("","auto");
1931: fitsizeButton.value = "@{[&mt('Fixed size')]}";
1932: sessionStorage.setItem("autosized_"+depth, "yes");
1933:
1934: // is dynamic size, switching to fixed
1935: } else {
1936: cmInst.setSize("","300px");
1937: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
1938: sessionStorage.removeItem("autosized_"+depth);
1939: }
1940: }
1941:
1942:
1943:
1944: // ]]>
1945: </script>
1946: COLORFULEDIT
1947: }
1948:
1949: sub xmleditor_js {
1950: return <<XMLEDIT
1951: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
1952: <script type="text/javascript">
1953: // <![CDATA[>
1954:
1955: function saveScrollPosition (resource) {
1956:
1957: var scrollPos = \$(window).scrollTop();
1958: sessionStorage.setItem(resource,scrollPos);
1959: }
1960:
1961: function restoreScrollPosition(resource){
1962:
1963: var scrollPos = sessionStorage.getItem(resource);
1964: \$(window).scrollTop(scrollPos);
1965: }
1966:
1967: // unless internet explorer
1968: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
1969:
1970: \$(document).ready(function() {
1971: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
1972: });
1973: }
1974:
1975: // inserts text at cursor position into codemirror (xml editor only)
1976: function insertText(text){
1977: cm.focus();
1978: var curPos = cm.getCursor();
1979: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
1980: }
1981: // ]]>
1982: </script>
1983: XMLEDIT
1984: }
1985:
1986: sub insert_folding_button {
1987: my $curDepth = $Apache::lonxml::curdepth;
1988: my $lastresource = $env{'request.ambiguous'};
1989:
1990: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
1991: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
1992: }
1993:
1994:
1.565 albertel 1995: =pod
1996:
1.256 matthew 1997: =head1 Excel and CSV file utility routines
1998:
1999: =cut
2000:
2001: ###############################################################
2002: ###############################################################
2003:
2004: =pod
2005:
1.1075.2.56 raeburn 2006: =over 4
2007:
1.648 raeburn 2008: =item * &csv_translate($text)
1.37 matthew 2009:
1.185 www 2010: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2011: format.
2012:
2013: =cut
2014:
1.180 matthew 2015: ###############################################################
2016: ###############################################################
1.37 matthew 2017: sub csv_translate {
2018: my $text = shift;
2019: $text =~ s/\"/\"\"/g;
1.209 albertel 2020: $text =~ s/\n/ /g;
1.37 matthew 2021: return $text;
2022: }
1.180 matthew 2023:
2024: ###############################################################
2025: ###############################################################
2026:
2027: =pod
2028:
1.648 raeburn 2029: =item * &define_excel_formats()
1.180 matthew 2030:
2031: Define some commonly used Excel cell formats.
2032:
2033: Currently supported formats:
2034:
2035: =over 4
2036:
2037: =item header
2038:
2039: =item bold
2040:
2041: =item h1
2042:
2043: =item h2
2044:
2045: =item h3
2046:
1.256 matthew 2047: =item h4
2048:
2049: =item i
2050:
1.180 matthew 2051: =item date
2052:
2053: =back
2054:
2055: Inputs: $workbook
2056:
2057: Returns: $format, a hash reference.
2058:
1.1057 foxr 2059:
1.180 matthew 2060: =cut
2061:
2062: ###############################################################
2063: ###############################################################
2064: sub define_excel_formats {
2065: my ($workbook) = @_;
2066: my $format;
2067: $format->{'header'} = $workbook->add_format(bold => 1,
2068: bottom => 1,
2069: align => 'center');
2070: $format->{'bold'} = $workbook->add_format(bold=>1);
2071: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2072: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2073: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2074: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2075: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2076: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2077: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2078: return $format;
2079: }
2080:
2081: ###############################################################
2082: ###############################################################
1.113 bowersj2 2083:
2084: =pod
2085:
1.648 raeburn 2086: =item * &create_workbook()
1.255 matthew 2087:
2088: Create an Excel worksheet. If it fails, output message on the
2089: request object and return undefs.
2090:
2091: Inputs: Apache request object
2092:
2093: Returns (undef) on failure,
2094: Excel worksheet object, scalar with filename, and formats
2095: from &Apache::loncommon::define_excel_formats on success
2096:
2097: =cut
2098:
2099: ###############################################################
2100: ###############################################################
2101: sub create_workbook {
2102: my ($r) = @_;
2103: #
2104: # Create the excel spreadsheet
2105: my $filename = '/prtspool/'.
1.258 albertel 2106: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2107: time.'_'.rand(1000000000).'.xls';
2108: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2109: if (! defined($workbook)) {
2110: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2111: $r->print(
2112: '<p class="LC_error">'
2113: .&mt('Problems occurred in creating the new Excel file.')
2114: .' '.&mt('This error has been logged.')
2115: .' '.&mt('Please alert your LON-CAPA administrator.')
2116: .'</p>'
2117: );
1.255 matthew 2118: return (undef);
2119: }
2120: #
1.1014 foxr 2121: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2122: #
2123: my $format = &Apache::loncommon::define_excel_formats($workbook);
2124: return ($workbook,$filename,$format);
2125: }
2126:
2127: ###############################################################
2128: ###############################################################
2129:
2130: =pod
2131:
1.648 raeburn 2132: =item * &create_text_file()
1.113 bowersj2 2133:
1.542 raeburn 2134: Create a file to write to and eventually make available to the user.
1.256 matthew 2135: If file creation fails, outputs an error message on the request object and
2136: return undefs.
1.113 bowersj2 2137:
1.256 matthew 2138: Inputs: Apache request object, and file suffix
1.113 bowersj2 2139:
1.256 matthew 2140: Returns (undef) on failure,
2141: Filehandle and filename on success.
1.113 bowersj2 2142:
2143: =cut
2144:
1.256 matthew 2145: ###############################################################
2146: ###############################################################
2147: sub create_text_file {
2148: my ($r,$suffix) = @_;
2149: if (! defined($suffix)) { $suffix = 'txt'; };
2150: my $fh;
2151: my $filename = '/prtspool/'.
1.258 albertel 2152: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2153: time.'_'.rand(1000000000).'.'.$suffix;
2154: $fh = Apache::File->new('>/home/httpd'.$filename);
2155: if (! defined($fh)) {
2156: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2157: $r->print(
2158: '<p class="LC_error">'
2159: .&mt('Problems occurred in creating the output file.')
2160: .' '.&mt('This error has been logged.')
2161: .' '.&mt('Please alert your LON-CAPA administrator.')
2162: .'</p>'
2163: );
1.113 bowersj2 2164: }
1.256 matthew 2165: return ($fh,$filename)
1.113 bowersj2 2166: }
2167:
2168:
1.256 matthew 2169: =pod
1.113 bowersj2 2170:
2171: =back
2172:
2173: =cut
1.37 matthew 2174:
2175: ###############################################################
1.33 matthew 2176: ## Home server <option> list generating code ##
2177: ###############################################################
1.35 matthew 2178:
1.169 www 2179: # ------------------------------------------
2180:
2181: sub domain_select {
2182: my ($name,$value,$multiple)=@_;
2183: my %domains=map {
1.514 albertel 2184: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 2185: } &Apache::lonnet::all_domains();
1.169 www 2186: if ($multiple) {
2187: $domains{''}=&mt('Any domain');
1.550 albertel 2188: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2189: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2190: } else {
1.550 albertel 2191: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2192: return &select_form($name,$value,\%domains);
1.169 www 2193: }
2194: }
2195:
1.282 albertel 2196: #-------------------------------------------
2197:
2198: =pod
2199:
1.519 raeburn 2200: =head1 Routines for form select boxes
2201:
2202: =over 4
2203:
1.648 raeburn 2204: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2205:
2206: Returns a string containing a <select> element int multiple mode
2207:
2208:
2209: Args:
2210: $name - name of the <select> element
1.506 raeburn 2211: $value - scalar or array ref of values that should already be selected
1.282 albertel 2212: $size - number of rows long the select element is
1.283 albertel 2213: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2214: (shown text should already have been &mt())
1.506 raeburn 2215: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2216:
1.282 albertel 2217: =cut
2218:
2219: #-------------------------------------------
1.169 www 2220: sub multiple_select_form {
1.284 albertel 2221: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2222: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2223: my $output='';
1.191 matthew 2224: if (! defined($size)) {
2225: $size = 4;
1.283 albertel 2226: if (scalar(keys(%$hash))<4) {
2227: $size = scalar(keys(%$hash));
1.191 matthew 2228: }
2229: }
1.734 bisitz 2230: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2231: my @order;
1.506 raeburn 2232: if (ref($order) eq 'ARRAY') {
2233: @order = @{$order};
2234: } else {
2235: @order = sort(keys(%$hash));
1.501 banghart 2236: }
2237: if (exists($$hash{'select_form_order'})) {
2238: @order = @{$$hash{'select_form_order'}};
2239: }
2240:
1.284 albertel 2241: foreach my $key (@order) {
1.356 albertel 2242: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2243: $output.='selected="selected" ' if ($selected{$key});
2244: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2245: }
2246: $output.="</select>\n";
2247: return $output;
2248: }
2249:
1.88 www 2250: #-------------------------------------------
2251:
2252: =pod
2253:
1.1075.2.115 raeburn 2254: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2255:
2256: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2257: allow a user to select options from a ref to a hash containing:
2258: option_name => displayed text. An optional $onchange can include
1.1075.2.115 raeburn 2259: a javascript onchange item, e.g., onchange="this.form.submit();".
2260: An optional arg -- $readonly -- if true will cause the select form
2261: to be disabled, e.g., for the case where an instructor has a section-
2262: specific role, and is viewing/modifying parameters.
1.970 raeburn 2263:
1.88 www 2264: See lonrights.pm for an example invocation and use.
2265:
2266: =cut
2267:
2268: #-------------------------------------------
2269: sub select_form {
1.1075.2.115 raeburn 2270: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2271: return unless (ref($hashref) eq 'HASH');
2272: if ($onchange) {
2273: $onchange = ' onchange="'.$onchange.'"';
2274: }
1.1075.2.129 raeburn 2275: my $disabled;
2276: if ($readonly) {
2277: $disabled = ' disabled="disabled"';
2278: }
2279: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2280: my @keys;
1.970 raeburn 2281: if (exists($hashref->{'select_form_order'})) {
2282: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2283: } else {
1.970 raeburn 2284: @keys=sort(keys(%{$hashref}));
1.128 albertel 2285: }
1.356 albertel 2286: foreach my $key (@keys) {
2287: $selectform.=
2288: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2289: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2290: ">".$hashref->{$key}."</option>\n";
1.88 www 2291: }
2292: $selectform.="</select>";
2293: return $selectform;
2294: }
2295:
1.475 www 2296: # For display filters
2297:
2298: sub display_filter {
1.1074 raeburn 2299: my ($context) = @_;
1.475 www 2300: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2301: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2302: my $phraseinput = 'hidden';
2303: my $includeinput = 'hidden';
2304: my ($checked,$includetypestext);
2305: if ($env{'form.displayfilter'} eq 'containing') {
2306: $phraseinput = 'text';
2307: if ($context eq 'parmslog') {
2308: $includeinput = 'checkbox';
2309: if ($env{'form.includetypes'}) {
2310: $checked = ' checked="checked"';
2311: }
2312: $includetypestext = &mt('Include parameter types');
2313: }
2314: } else {
2315: $includetypestext = ' ';
2316: }
2317: my ($additional,$secondid,$thirdid);
2318: if ($context eq 'parmslog') {
2319: $additional =
2320: '<label><input type="'.$includeinput.'" name="includetypes"'.
2321: $checked.' name="includetypes" value="1" id="includetypes" />'.
2322: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2323: '</label>';
2324: $secondid = 'includetypes';
2325: $thirdid = 'includetypestext';
2326: }
2327: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2328: '$secondid','$thirdid')";
2329: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2330: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2331: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2332: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2333: &mt('Filter: [_1]',
1.477 www 2334: &select_form($env{'form.displayfilter'},
2335: 'displayfilter',
1.970 raeburn 2336: {'currentfolder' => 'Current folder/page',
1.477 www 2337: 'containing' => 'Containing phrase',
1.1074 raeburn 2338: 'none' => 'None'},$onchange)).' '.
2339: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2340: &HTML::Entities::encode($env{'form.containingphrase'}).
2341: '" />'.$additional;
2342: }
2343:
2344: sub display_filter_js {
2345: my $includetext = &mt('Include parameter types');
2346: return <<"ENDJS";
2347:
2348: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2349: var firstType = 'hidden';
2350: if (setter.options[setter.selectedIndex].value == 'containing') {
2351: firstType = 'text';
2352: }
2353: firstObject = document.getElementById(firstid);
2354: if (typeof(firstObject) == 'object') {
2355: if (firstObject.type != firstType) {
2356: changeInputType(firstObject,firstType);
2357: }
2358: }
2359: if (context == 'parmslog') {
2360: var secondType = 'hidden';
2361: if (firstType == 'text') {
2362: secondType = 'checkbox';
2363: }
2364: secondObject = document.getElementById(secondid);
2365: if (typeof(secondObject) == 'object') {
2366: if (secondObject.type != secondType) {
2367: changeInputType(secondObject,secondType);
2368: }
2369: }
2370: var textItem = document.getElementById(thirdid);
2371: var currtext = textItem.innerHTML;
2372: var newtext;
2373: if (firstType == 'text') {
2374: newtext = '$includetext';
2375: } else {
2376: newtext = ' ';
2377: }
2378: if (currtext != newtext) {
2379: textItem.innerHTML = newtext;
2380: }
2381: }
2382: return;
2383: }
2384:
2385: function changeInputType(oldObject,newType) {
2386: var newObject = document.createElement('input');
2387: newObject.type = newType;
2388: if (oldObject.size) {
2389: newObject.size = oldObject.size;
2390: }
2391: if (oldObject.value) {
2392: newObject.value = oldObject.value;
2393: }
2394: if (oldObject.name) {
2395: newObject.name = oldObject.name;
2396: }
2397: if (oldObject.id) {
2398: newObject.id = oldObject.id;
2399: }
2400: oldObject.parentNode.replaceChild(newObject,oldObject);
2401: return;
2402: }
2403:
2404: ENDJS
1.475 www 2405: }
2406:
1.167 www 2407: sub gradeleveldescription {
2408: my $gradelevel=shift;
2409: my %gradelevels=(0 => 'Not specified',
2410: 1 => 'Grade 1',
2411: 2 => 'Grade 2',
2412: 3 => 'Grade 3',
2413: 4 => 'Grade 4',
2414: 5 => 'Grade 5',
2415: 6 => 'Grade 6',
2416: 7 => 'Grade 7',
2417: 8 => 'Grade 8',
2418: 9 => 'Grade 9',
2419: 10 => 'Grade 10',
2420: 11 => 'Grade 11',
2421: 12 => 'Grade 12',
2422: 13 => 'Grade 13',
2423: 14 => '100 Level',
2424: 15 => '200 Level',
2425: 16 => '300 Level',
2426: 17 => '400 Level',
2427: 18 => 'Graduate Level');
2428: return &mt($gradelevels{$gradelevel});
2429: }
2430:
1.163 www 2431: sub select_level_form {
2432: my ($deflevel,$name)=@_;
2433: unless ($deflevel) { $deflevel=0; }
1.167 www 2434: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2435: for (my $i=0; $i<=18; $i++) {
2436: $selectform.="<option value=\"$i\" ".
1.253 albertel 2437: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2438: ">".&gradeleveldescription($i)."</option>\n";
2439: }
2440: $selectform.="</select>";
2441: return $selectform;
1.163 www 2442: }
1.167 www 2443:
1.35 matthew 2444: #-------------------------------------------
2445:
1.45 matthew 2446: =pod
2447:
1.1075.2.115 raeburn 2448: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2449:
2450: Returns a string containing a <select name='$name' size='1'> form to
2451: allow a user to select the domain to preform an operation in.
2452: See loncreateuser.pm for an example invocation and use.
2453:
1.90 www 2454: If the $includeempty flag is set, it also includes an empty choice ("no domain
2455: selected");
2456:
1.743 raeburn 2457: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2458:
1.910 raeburn 2459: 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.
2460:
1.1075.2.36 raeburn 2461: The optional $incdoms is a reference to an array of domains which will be the only available options.
2462:
1.1075.2.115 raeburn 2463: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
2464:
2465: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
1.563 raeburn 2466:
1.35 matthew 2467: =cut
2468:
2469: #-------------------------------------------
1.34 matthew 2470: sub select_dom_form {
1.1075.2.115 raeburn 2471: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2472: if ($onchange) {
1.874 raeburn 2473: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2474: }
1.1075.2.115 raeburn 2475: if ($disabled) {
2476: $disabled = ' disabled="disabled"';
2477: }
1.1075.2.36 raeburn 2478: my (@domains,%exclude);
1.910 raeburn 2479: if (ref($incdoms) eq 'ARRAY') {
2480: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2481: } else {
2482: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2483: }
1.90 www 2484: if ($includeempty) { @domains=('',@domains); }
1.1075.2.36 raeburn 2485: if (ref($excdoms) eq 'ARRAY') {
2486: map { $exclude{$_} = 1; } @{$excdoms};
2487: }
1.1075.2.115 raeburn 2488: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2489: foreach my $dom (@domains) {
1.1075.2.36 raeburn 2490: next if ($exclude{$dom});
1.356 albertel 2491: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2492: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2493: if ($showdomdesc) {
2494: if ($dom ne '') {
2495: my $domdesc = &Apache::lonnet::domain($dom,'description');
2496: if ($domdesc ne '') {
2497: $selectdomain .= ' ('.$domdesc.')';
2498: }
2499: }
2500: }
2501: $selectdomain .= "</option>\n";
1.34 matthew 2502: }
2503: $selectdomain.="</select>";
2504: return $selectdomain;
2505: }
2506:
1.35 matthew 2507: #-------------------------------------------
2508:
1.45 matthew 2509: =pod
2510:
1.648 raeburn 2511: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2512:
1.586 raeburn 2513: input: 4 arguments (two required, two optional) -
2514: $domain - domain of new user
2515: $name - name of form element
2516: $default - Value of 'default' causes a default item to be first
2517: option, and selected by default.
2518: $hide - Value of 'hide' causes hiding of the name of the server,
2519: if 1 server found, or default, if 0 found.
1.594 raeburn 2520: output: returns 2 items:
1.586 raeburn 2521: (a) form element which contains either:
2522: (i) <select name="$name">
2523: <option value="$hostid1">$hostid $servers{$hostid}</option>
2524: <option value="$hostid2">$hostid $servers{$hostid}</option>
2525: </select>
2526: form item if there are multiple library servers in $domain, or
2527: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2528: if there is only one library server in $domain.
2529:
2530: (b) number of library servers found.
2531:
2532: See loncreateuser.pm for example of use.
1.35 matthew 2533:
2534: =cut
2535:
2536: #-------------------------------------------
1.586 raeburn 2537: sub home_server_form_item {
2538: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2539: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2540: my $result;
2541: my $numlib = keys(%servers);
2542: if ($numlib > 1) {
2543: $result .= '<select name="'.$name.'" />'."\n";
2544: if ($default) {
1.804 bisitz 2545: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2546: '</option>'."\n";
2547: }
2548: foreach my $hostid (sort(keys(%servers))) {
2549: $result.= '<option value="'.$hostid.'">'.
2550: $hostid.' '.$servers{$hostid}."</option>\n";
2551: }
2552: $result .= '</select>'."\n";
2553: } elsif ($numlib == 1) {
2554: my $hostid;
2555: foreach my $item (keys(%servers)) {
2556: $hostid = $item;
2557: }
2558: $result .= '<input type="hidden" name="'.$name.'" value="'.
2559: $hostid.'" />';
2560: if (!$hide) {
2561: $result .= $hostid.' '.$servers{$hostid};
2562: }
2563: $result .= "\n";
2564: } elsif ($default) {
2565: $result .= '<input type="hidden" name="'.$name.
2566: '" value="default" />';
2567: if (!$hide) {
2568: $result .= &mt('default');
2569: }
2570: $result .= "\n";
1.33 matthew 2571: }
1.586 raeburn 2572: return ($result,$numlib);
1.33 matthew 2573: }
1.112 bowersj2 2574:
2575: =pod
2576:
1.534 albertel 2577: =back
2578:
1.112 bowersj2 2579: =cut
1.87 matthew 2580:
2581: ###############################################################
1.112 bowersj2 2582: ## Decoding User Agent ##
1.87 matthew 2583: ###############################################################
2584:
2585: =pod
2586:
1.112 bowersj2 2587: =head1 Decoding the User Agent
2588:
2589: =over 4
2590:
2591: =item * &decode_user_agent()
1.87 matthew 2592:
2593: Inputs: $r
2594:
2595: Outputs:
2596:
2597: =over 4
2598:
1.112 bowersj2 2599: =item * $httpbrowser
1.87 matthew 2600:
1.112 bowersj2 2601: =item * $clientbrowser
1.87 matthew 2602:
1.112 bowersj2 2603: =item * $clientversion
1.87 matthew 2604:
1.112 bowersj2 2605: =item * $clientmathml
1.87 matthew 2606:
1.112 bowersj2 2607: =item * $clientunicode
1.87 matthew 2608:
1.112 bowersj2 2609: =item * $clientos
1.87 matthew 2610:
1.1075.2.42 raeburn 2611: =item * $clientmobile
2612:
2613: =item * $clientinfo
2614:
1.1075.2.77 raeburn 2615: =item * $clientosversion
2616:
1.87 matthew 2617: =back
2618:
1.157 matthew 2619: =back
2620:
1.87 matthew 2621: =cut
2622:
2623: ###############################################################
2624: ###############################################################
2625: sub decode_user_agent {
1.247 albertel 2626: my ($r)=@_;
1.87 matthew 2627: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2628: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2629: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2630: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2631: my $clientbrowser='unknown';
2632: my $clientversion='0';
2633: my $clientmathml='';
2634: my $clientunicode='0';
1.1075.2.42 raeburn 2635: my $clientmobile=0;
1.1075.2.77 raeburn 2636: my $clientosversion='';
1.87 matthew 2637: for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76 raeburn 2638: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2639: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2640: $clientbrowser=$bname;
2641: $httpbrowser=~/$vreg/i;
2642: $clientversion=$1;
2643: $clientmathml=($clientversion>=$minv);
2644: $clientunicode=($clientversion>=$univ);
2645: }
2646: }
2647: my $clientos='unknown';
1.1075.2.42 raeburn 2648: my $clientinfo;
1.87 matthew 2649: if (($httpbrowser=~/linux/i) ||
2650: ($httpbrowser=~/unix/i) ||
2651: ($httpbrowser=~/ux/i) ||
2652: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2653: if (($httpbrowser=~/vax/i) ||
2654: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2655: if ($httpbrowser=~/next/i) { $clientos='next'; }
2656: if (($httpbrowser=~/mac/i) ||
2657: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77 raeburn 2658: if ($httpbrowser=~/win/i) {
2659: $clientos='win';
2660: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2661: $clientosversion = $1;
2662: }
2663: }
1.87 matthew 2664: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42 raeburn 2665: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2666: $clientmobile=lc($1);
2667: }
2668: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2669: $clientinfo = 'firefox-'.$1;
2670: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2671: $clientinfo = 'chromeframe-'.$1;
2672: }
1.87 matthew 2673: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77 raeburn 2674: $clientunicode,$clientos,$clientmobile,$clientinfo,
2675: $clientosversion);
1.87 matthew 2676: }
2677:
1.32 matthew 2678: ###############################################################
2679: ## Authentication changing form generation subroutines ##
2680: ###############################################################
2681: ##
2682: ## All of the authform_xxxxxxx subroutines take their inputs in a
2683: ## hash, and have reasonable default values.
2684: ##
2685: ## formname = the name given in the <form> tag.
1.35 matthew 2686: #-------------------------------------------
2687:
1.45 matthew 2688: =pod
2689:
1.112 bowersj2 2690: =head1 Authentication Routines
2691:
2692: =over 4
2693:
1.648 raeburn 2694: =item * &authform_xxxxxx()
1.35 matthew 2695:
2696: The authform_xxxxxx subroutines provide javascript and html forms which
2697: handle some of the conveniences required for authentication forms.
2698: This is not an optimal method, but it works.
2699:
2700: =over 4
2701:
1.112 bowersj2 2702: =item * authform_header
1.35 matthew 2703:
1.112 bowersj2 2704: =item * authform_authorwarning
1.35 matthew 2705:
1.112 bowersj2 2706: =item * authform_nochange
1.35 matthew 2707:
1.112 bowersj2 2708: =item * authform_kerberos
1.35 matthew 2709:
1.112 bowersj2 2710: =item * authform_internal
1.35 matthew 2711:
1.112 bowersj2 2712: =item * authform_filesystem
1.35 matthew 2713:
2714: =back
2715:
1.648 raeburn 2716: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2717:
1.35 matthew 2718: =cut
2719:
2720: #-------------------------------------------
1.32 matthew 2721: sub authform_header{
2722: my %in = (
2723: formname => 'cu',
1.80 albertel 2724: kerb_def_dom => '',
1.32 matthew 2725: @_,
2726: );
2727: $in{'formname'} = 'document.' . $in{'formname'};
2728: my $result='';
1.80 albertel 2729:
2730: #---------------------------------------------- Code for upper case translation
2731: my $Javascript_toUpperCase;
2732: unless ($in{kerb_def_dom}) {
2733: $Javascript_toUpperCase =<<"END";
2734: switch (choice) {
2735: case 'krb': currentform.elements[choicearg].value =
2736: currentform.elements[choicearg].value.toUpperCase();
2737: break;
2738: default:
2739: }
2740: END
2741: } else {
2742: $Javascript_toUpperCase = "";
2743: }
2744:
1.165 raeburn 2745: my $radioval = "'nochange'";
1.591 raeburn 2746: if (defined($in{'curr_authtype'})) {
2747: if ($in{'curr_authtype'} ne '') {
2748: $radioval = "'".$in{'curr_authtype'}."arg'";
2749: }
1.174 matthew 2750: }
1.165 raeburn 2751: my $argfield = 'null';
1.591 raeburn 2752: if (defined($in{'mode'})) {
1.165 raeburn 2753: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2754: if (defined($in{'curr_autharg'})) {
2755: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2756: $argfield = "'$in{'curr_autharg'}'";
2757: }
2758: }
2759: }
2760: }
2761:
1.32 matthew 2762: $result.=<<"END";
2763: var current = new Object();
1.165 raeburn 2764: current.radiovalue = $radioval;
2765: current.argfield = $argfield;
1.32 matthew 2766:
2767: function changed_radio(choice,currentform) {
2768: var choicearg = choice + 'arg';
2769: // If a radio button in changed, we need to change the argfield
2770: if (current.radiovalue != choice) {
2771: current.radiovalue = choice;
2772: if (current.argfield != null) {
2773: currentform.elements[current.argfield].value = '';
2774: }
2775: if (choice == 'nochange') {
2776: current.argfield = null;
2777: } else {
2778: current.argfield = choicearg;
2779: switch(choice) {
2780: case 'krb':
2781: currentform.elements[current.argfield].value =
2782: "$in{'kerb_def_dom'}";
2783: break;
2784: default:
2785: break;
2786: }
2787: }
2788: }
2789: return;
2790: }
1.22 www 2791:
1.32 matthew 2792: function changed_text(choice,currentform) {
2793: var choicearg = choice + 'arg';
2794: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2795: $Javascript_toUpperCase
1.32 matthew 2796: // clear old field
2797: if ((current.argfield != choicearg) && (current.argfield != null)) {
2798: currentform.elements[current.argfield].value = '';
2799: }
2800: current.argfield = choicearg;
2801: }
2802: set_auth_radio_buttons(choice,currentform);
2803: return;
1.20 www 2804: }
1.32 matthew 2805:
2806: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2807: var numauthchoices = currentform.login.length;
2808: if (typeof numauthchoices == "undefined") {
2809: return;
2810: }
1.32 matthew 2811: var i=0;
1.986 raeburn 2812: while (i < numauthchoices) {
1.32 matthew 2813: if (currentform.login[i].value == newvalue) { break; }
2814: i++;
2815: }
1.986 raeburn 2816: if (i == numauthchoices) {
1.32 matthew 2817: return;
2818: }
2819: current.radiovalue = newvalue;
2820: currentform.login[i].checked = true;
2821: return;
2822: }
2823: END
2824: return $result;
2825: }
2826:
1.1075.2.20 raeburn 2827: sub authform_authorwarning {
1.32 matthew 2828: my $result='';
1.144 matthew 2829: $result='<i>'.
2830: &mt('As a general rule, only authors or co-authors should be '.
2831: 'filesystem authenticated '.
2832: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2833: return $result;
2834: }
2835:
1.1075.2.20 raeburn 2836: sub authform_nochange {
1.32 matthew 2837: my %in = (
2838: formname => 'document.cu',
2839: kerb_def_dom => 'MSU.EDU',
2840: @_,
2841: );
1.1075.2.20 raeburn 2842: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2843: my $result;
1.1075.2.20 raeburn 2844: if (!$authnum) {
2845: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2846: } else {
2847: $result = '<label>'.&mt('[_1] Do not change login data',
2848: '<input type="radio" name="login" value="nochange" '.
2849: 'checked="checked" onclick="'.
1.281 albertel 2850: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2851: '</label>';
1.586 raeburn 2852: }
1.32 matthew 2853: return $result;
2854: }
2855:
1.591 raeburn 2856: sub authform_kerberos {
1.32 matthew 2857: my %in = (
2858: formname => 'document.cu',
2859: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2860: kerb_def_auth => 'krb4',
1.32 matthew 2861: @_,
2862: );
1.586 raeburn 2863: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117 raeburn 2864: $autharg,$jscall,$disabled);
1.1075.2.20 raeburn 2865: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2866: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2867: $check5 = ' checked="checked"';
1.80 albertel 2868: } else {
1.772 bisitz 2869: $check4 = ' checked="checked"';
1.80 albertel 2870: }
1.1075.2.117 raeburn 2871: if ($in{'readonly'}) {
2872: $disabled = ' disabled="disabled"';
2873: }
1.165 raeburn 2874: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2875: if (defined($in{'curr_authtype'})) {
2876: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2877: $krbcheck = ' checked="checked"';
1.623 raeburn 2878: if (defined($in{'mode'})) {
2879: if ($in{'mode'} eq 'modifyuser') {
2880: $krbcheck = '';
2881: }
2882: }
1.591 raeburn 2883: if (defined($in{'curr_kerb_ver'})) {
2884: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2885: $check5 = ' checked="checked"';
1.591 raeburn 2886: $check4 = '';
2887: } else {
1.772 bisitz 2888: $check4 = ' checked="checked"';
1.591 raeburn 2889: $check5 = '';
2890: }
1.586 raeburn 2891: }
1.591 raeburn 2892: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2893: $krbarg = $in{'curr_autharg'};
2894: }
1.586 raeburn 2895: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2896: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2897: $result =
2898: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2899: $in{'curr_autharg'},$krbver);
2900: } else {
2901: $result =
2902: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2903: }
2904: return $result;
2905: }
2906: }
2907: } else {
2908: if ($authnum == 1) {
1.784 bisitz 2909: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2910: }
2911: }
1.586 raeburn 2912: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2913: return;
1.587 raeburn 2914: } elsif ($authtype eq '') {
1.591 raeburn 2915: if (defined($in{'mode'})) {
1.587 raeburn 2916: if ($in{'mode'} eq 'modifycourse') {
2917: if ($authnum == 1) {
1.1075.2.117 raeburn 2918: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 2919: }
2920: }
2921: }
1.586 raeburn 2922: }
2923: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2924: if ($authtype eq '') {
2925: $authtype = '<input type="radio" name="login" value="krb" '.
2926: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117 raeburn 2927: $krbcheck.$disabled.' />';
1.586 raeburn 2928: }
2929: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20 raeburn 2930: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2931: $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20 raeburn 2932: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2933: $in{'curr_authtype'} eq 'krb4')) {
2934: $result .= &mt
1.144 matthew 2935: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2936: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2937: '<label>'.$authtype,
1.281 albertel 2938: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2939: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2940: 'onchange="'.$jscall.'"'.$disabled.' />',
2941: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
2942: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 2943: '</label>');
1.586 raeburn 2944: } elsif ($can_assign{'krb4'}) {
2945: $result .= &mt
2946: ('[_1] Kerberos authenticated with domain [_2] '.
2947: '[_3] Version 4 [_4]',
2948: '<label>'.$authtype,
2949: '</label><input type="text" size="10" name="krbarg" '.
2950: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2951: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 2952: '<label><input type="hidden" name="krbver" value="4" />',
2953: '</label>');
2954: } elsif ($can_assign{'krb5'}) {
2955: $result .= &mt
2956: ('[_1] Kerberos authenticated with domain [_2] '.
2957: '[_3] Version 5 [_4]',
2958: '<label>'.$authtype,
2959: '</label><input type="text" size="10" name="krbarg" '.
2960: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2961: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 2962: '<label><input type="hidden" name="krbver" value="5" />',
2963: '</label>');
2964: }
1.32 matthew 2965: return $result;
2966: }
2967:
1.1075.2.20 raeburn 2968: sub authform_internal {
1.586 raeburn 2969: my %in = (
1.32 matthew 2970: formname => 'document.cu',
2971: kerb_def_dom => 'MSU.EDU',
2972: @_,
2973: );
1.1075.2.117 raeburn 2974: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 2975: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 2976: if ($in{'readonly'}) {
2977: $disabled = ' disabled="disabled"';
2978: }
1.591 raeburn 2979: if (defined($in{'curr_authtype'})) {
2980: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2981: if ($can_assign{'int'}) {
1.772 bisitz 2982: $intcheck = 'checked="checked" ';
1.623 raeburn 2983: if (defined($in{'mode'})) {
2984: if ($in{'mode'} eq 'modifyuser') {
2985: $intcheck = '';
2986: }
2987: }
1.591 raeburn 2988: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2989: $intarg = $in{'curr_autharg'};
2990: }
2991: } else {
2992: $result = &mt('Currently internally authenticated.');
2993: return $result;
1.165 raeburn 2994: }
2995: }
1.586 raeburn 2996: } else {
2997: if ($authnum == 1) {
1.784 bisitz 2998: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 2999: }
3000: }
3001: if (!$can_assign{'int'}) {
3002: return;
1.587 raeburn 3003: } elsif ($authtype eq '') {
1.591 raeburn 3004: if (defined($in{'mode'})) {
1.587 raeburn 3005: if ($in{'mode'} eq 'modifycourse') {
3006: if ($authnum == 1) {
1.1075.2.117 raeburn 3007: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3008: }
3009: }
3010: }
1.165 raeburn 3011: }
1.586 raeburn 3012: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3013: if ($authtype eq '') {
3014: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117 raeburn 3015: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3016: }
1.605 bisitz 3017: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117 raeburn 3018: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3019: $result = &mt
1.144 matthew 3020: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3021: '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118 raeburn 3022: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3023: return $result;
3024: }
3025:
1.1075.2.20 raeburn 3026: sub authform_local {
1.32 matthew 3027: my %in = (
3028: formname => 'document.cu',
3029: kerb_def_dom => 'MSU.EDU',
3030: @_,
3031: );
1.1075.2.117 raeburn 3032: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 3033: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 3034: if ($in{'readonly'}) {
3035: $disabled = ' disabled="disabled"';
3036: }
1.591 raeburn 3037: if (defined($in{'curr_authtype'})) {
3038: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3039: if ($can_assign{'loc'}) {
1.772 bisitz 3040: $loccheck = 'checked="checked" ';
1.623 raeburn 3041: if (defined($in{'mode'})) {
3042: if ($in{'mode'} eq 'modifyuser') {
3043: $loccheck = '';
3044: }
3045: }
1.591 raeburn 3046: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3047: $locarg = $in{'curr_autharg'};
3048: }
3049: } else {
3050: $result = &mt('Currently using local (institutional) authentication.');
3051: return $result;
1.165 raeburn 3052: }
3053: }
1.586 raeburn 3054: } else {
3055: if ($authnum == 1) {
1.784 bisitz 3056: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3057: }
3058: }
3059: if (!$can_assign{'loc'}) {
3060: return;
1.587 raeburn 3061: } elsif ($authtype eq '') {
1.591 raeburn 3062: if (defined($in{'mode'})) {
1.587 raeburn 3063: if ($in{'mode'} eq 'modifycourse') {
3064: if ($authnum == 1) {
1.1075.2.117 raeburn 3065: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3066: }
3067: }
3068: }
1.165 raeburn 3069: }
1.586 raeburn 3070: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3071: if ($authtype eq '') {
3072: $authtype = '<input type="radio" name="login" value="loc" '.
3073: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117 raeburn 3074: $jscall.'"'.$disabled.' />';
1.586 raeburn 3075: }
3076: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117 raeburn 3077: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3078: $result = &mt('[_1] Local Authentication with argument [_2]',
3079: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3080: return $result;
3081: }
3082:
1.1075.2.20 raeburn 3083: sub authform_filesystem {
1.32 matthew 3084: my %in = (
3085: formname => 'document.cu',
3086: kerb_def_dom => 'MSU.EDU',
3087: @_,
3088: );
1.1075.2.117 raeburn 3089: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 3090: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 3091: if ($in{'readonly'}) {
3092: $disabled = ' disabled="disabled"';
3093: }
1.591 raeburn 3094: if (defined($in{'curr_authtype'})) {
3095: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3096: if ($can_assign{'fsys'}) {
1.772 bisitz 3097: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3098: if (defined($in{'mode'})) {
3099: if ($in{'mode'} eq 'modifyuser') {
3100: $fsyscheck = '';
3101: }
3102: }
1.586 raeburn 3103: } else {
3104: $result = &mt('Currently Filesystem Authenticated.');
3105: return $result;
3106: }
3107: }
3108: } else {
3109: if ($authnum == 1) {
1.784 bisitz 3110: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3111: }
3112: }
3113: if (!$can_assign{'fsys'}) {
3114: return;
1.587 raeburn 3115: } elsif ($authtype eq '') {
1.591 raeburn 3116: if (defined($in{'mode'})) {
1.587 raeburn 3117: if ($in{'mode'} eq 'modifycourse') {
3118: if ($authnum == 1) {
1.1075.2.117 raeburn 3119: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3120: }
3121: }
3122: }
1.586 raeburn 3123: }
3124: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3125: if ($authtype eq '') {
3126: $authtype = '<input type="radio" name="login" value="fsys" '.
3127: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117 raeburn 3128: $jscall.'"'.$disabled.' />';
1.586 raeburn 3129: }
3130: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1075.2.117 raeburn 3131: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3132: $result = &mt
1.144 matthew 3133: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 3134: '<label><input type="radio" name="login" value="fsys" '.
1.1075.2.117 raeburn 3135: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605 bisitz 3136: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1075.2.117 raeburn 3137: 'onchange="'.$jscall.'"'.$disabled.' />');
1.32 matthew 3138: return $result;
3139: }
3140:
1.586 raeburn 3141: sub get_assignable_auth {
3142: my ($dom) = @_;
3143: if ($dom eq '') {
3144: $dom = $env{'request.role.domain'};
3145: }
3146: my %can_assign = (
3147: krb4 => 1,
3148: krb5 => 1,
3149: int => 1,
3150: loc => 1,
3151: );
3152: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3153: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3154: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3155: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3156: my $context;
3157: if ($env{'request.role'} =~ /^au/) {
3158: $context = 'author';
1.1075.2.117 raeburn 3159: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3160: $context = 'domain';
3161: } elsif ($env{'request.course.id'}) {
3162: $context = 'course';
3163: }
3164: if ($context) {
3165: if (ref($authhash->{$context}) eq 'HASH') {
3166: %can_assign = %{$authhash->{$context}};
3167: }
3168: }
3169: }
3170: }
3171: my $authnum = 0;
3172: foreach my $key (keys(%can_assign)) {
3173: if ($can_assign{$key}) {
3174: $authnum ++;
3175: }
3176: }
3177: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3178: $authnum --;
3179: }
3180: return ($authnum,%can_assign);
3181: }
3182:
1.1075.2.137 raeburn 3183: sub check_passwd_rules {
3184: my ($domain,$plainpass) = @_;
3185: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3186: my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138 raeburn 3187: $min = $Apache::lonnet::passwdmin;
1.1075.2.137 raeburn 3188: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3189: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138 raeburn 3190: if ($passwdconf{'min'} > $min) {
3191: $min = $passwdconf{'min'};
3192: }
1.1075.2.137 raeburn 3193: }
3194: if ($passwdconf{'max'} =~ /^\d+$/) {
3195: $max = $passwdconf{'max'};
3196: }
3197: @chars = @{$passwdconf{'chars'}};
3198: }
3199: if (($min) && (length($plainpass) < $min)) {
3200: push(@brokerule,'min');
3201: }
3202: if (($max) && (length($plainpass) > $max)) {
3203: push(@brokerule,'max');
3204: }
3205: if (@chars) {
3206: my %rules;
3207: map { $rules{$_} = 1; } @chars;
3208: if ($rules{'uc'}) {
3209: unless ($plainpass =~ /[A-Z]/) {
3210: push(@brokerule,'uc');
3211: }
3212: }
3213: if ($rules{'lc'}) {
3214: unless ($plainpass =~ /[a-z]/) {
3215: push(@brokerule,'lc');
3216: }
3217: }
3218: if ($rules{'num'}) {
3219: unless ($plainpass =~ /\d/) {
3220: push(@brokerule,'num');
3221: }
3222: }
3223: if ($rules{'spec'}) {
3224: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3225: push(@brokerule,'spec');
3226: }
3227: }
3228: }
3229: if (@brokerule) {
3230: my %rulenames = &Apache::lonlocal::texthash(
3231: uc => 'At least one upper case letter',
3232: lc => 'At least one lower case letter',
3233: num => 'At least one number',
3234: spec => 'At least one non-alphanumeric',
3235: );
3236: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3237: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3238: $rulenames{'num'} .= ': 0123456789';
3239: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3240: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3241: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3242: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143 raeburn 3243: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137 raeburn 3244: if (grep(/^$rule$/,@brokerule)) {
3245: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3246: }
3247: }
3248: $warning .= '</ul>';
3249: }
3250: if (wantarray) {
3251: return @brokerule;
3252: }
3253: return $warning;
3254: }
3255:
1.80 albertel 3256: ###############################################################
3257: ## Get Kerberos Defaults for Domain ##
3258: ###############################################################
3259: ##
3260: ## Returns default kerberos version and an associated argument
3261: ## as listed in file domain.tab. If not listed, provides
3262: ## appropriate default domain and kerberos version.
3263: ##
3264: #-------------------------------------------
3265:
3266: =pod
3267:
1.648 raeburn 3268: =item * &get_kerberos_defaults()
1.80 albertel 3269:
3270: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3271: version and domain. If not found, it defaults to version 4 and the
3272: domain of the server.
1.80 albertel 3273:
1.648 raeburn 3274: =over 4
3275:
1.80 albertel 3276: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3277:
1.648 raeburn 3278: =back
3279:
3280: =back
3281:
1.80 albertel 3282: =cut
3283:
3284: #-------------------------------------------
3285: sub get_kerberos_defaults {
3286: my $domain=shift;
1.641 raeburn 3287: my ($krbdef,$krbdefdom);
3288: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3289: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3290: $krbdef = $domdefaults{'auth_def'};
3291: $krbdefdom = $domdefaults{'auth_arg_def'};
3292: } else {
1.80 albertel 3293: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3294: my $krbdefdom=$1;
3295: $krbdefdom=~tr/a-z/A-Z/;
3296: $krbdef = "krb4";
3297: }
3298: return ($krbdef,$krbdefdom);
3299: }
1.112 bowersj2 3300:
1.32 matthew 3301:
1.46 matthew 3302: ###############################################################
3303: ## Thesaurus Functions ##
3304: ###############################################################
1.20 www 3305:
1.46 matthew 3306: =pod
1.20 www 3307:
1.112 bowersj2 3308: =head1 Thesaurus Functions
3309:
3310: =over 4
3311:
1.648 raeburn 3312: =item * &initialize_keywords()
1.46 matthew 3313:
3314: Initializes the package variable %Keywords if it is empty. Uses the
3315: package variable $thesaurus_db_file.
3316:
3317: =cut
3318:
3319: ###################################################
3320:
3321: sub initialize_keywords {
3322: return 1 if (scalar keys(%Keywords));
3323: # If we are here, %Keywords is empty, so fill it up
3324: # Make sure the file we need exists...
3325: if (! -e $thesaurus_db_file) {
3326: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3327: " failed because it does not exist");
3328: return 0;
3329: }
3330: # Set up the hash as a database
3331: my %thesaurus_db;
3332: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3333: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3334: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3335: $thesaurus_db_file);
3336: return 0;
3337: }
3338: # Get the average number of appearances of a word.
3339: my $avecount = $thesaurus_db{'average.count'};
3340: # Put keywords (those that appear > average) into %Keywords
3341: while (my ($word,$data)=each (%thesaurus_db)) {
3342: my ($count,undef) = split /:/,$data;
3343: $Keywords{$word}++ if ($count > $avecount);
3344: }
3345: untie %thesaurus_db;
3346: # Remove special values from %Keywords.
1.356 albertel 3347: foreach my $value ('total.count','average.count') {
3348: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3349: }
1.46 matthew 3350: return 1;
3351: }
3352:
3353: ###################################################
3354:
3355: =pod
3356:
1.648 raeburn 3357: =item * &keyword($word)
1.46 matthew 3358:
3359: Returns true if $word is a keyword. A keyword is a word that appears more
3360: than the average number of times in the thesaurus database. Calls
3361: &initialize_keywords
3362:
3363: =cut
3364:
3365: ###################################################
1.20 www 3366:
3367: sub keyword {
1.46 matthew 3368: return if (!&initialize_keywords());
3369: my $word=lc(shift());
3370: $word=~s/\W//g;
3371: return exists($Keywords{$word});
1.20 www 3372: }
1.46 matthew 3373:
3374: ###############################################################
3375:
3376: =pod
1.20 www 3377:
1.648 raeburn 3378: =item * &get_related_words()
1.46 matthew 3379:
1.160 matthew 3380: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3381: an array of words. If the keyword is not in the thesaurus, an empty array
3382: will be returned. The order of the words returned is determined by the
3383: database which holds them.
3384:
3385: Uses global $thesaurus_db_file.
3386:
1.1057 foxr 3387:
1.46 matthew 3388: =cut
3389:
3390: ###############################################################
3391: sub get_related_words {
3392: my $keyword = shift;
3393: my %thesaurus_db;
3394: if (! -e $thesaurus_db_file) {
3395: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3396: "failed because the file does not exist");
3397: return ();
3398: }
3399: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3400: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3401: return ();
3402: }
3403: my @Words=();
1.429 www 3404: my $count=0;
1.46 matthew 3405: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3406: # The first element is the number of times
3407: # the word appears. We do not need it now.
1.429 www 3408: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3409: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3410: my $threshold=$mostfrequentcount/10;
3411: foreach my $possibleword (@RelatedWords) {
3412: my ($word,$wordcount)=split(/\,/,$possibleword);
3413: if ($wordcount>$threshold) {
3414: push(@Words,$word);
3415: $count++;
3416: if ($count>10) { last; }
3417: }
1.20 www 3418: }
3419: }
1.46 matthew 3420: untie %thesaurus_db;
3421: return @Words;
1.14 harris41 3422: }
1.46 matthew 3423:
1.112 bowersj2 3424: =pod
3425:
3426: =back
3427:
3428: =cut
1.61 www 3429:
3430: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3431: =pod
3432:
1.112 bowersj2 3433: =head1 User Name Functions
3434:
3435: =over 4
3436:
1.648 raeburn 3437: =item * &plainname($uname,$udom,$first)
1.81 albertel 3438:
1.112 bowersj2 3439: Takes a users logon name and returns it as a string in
1.226 albertel 3440: "first middle last generation" form
3441: if $first is set to 'lastname' then it returns it as
3442: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3443:
3444: =cut
1.61 www 3445:
1.295 www 3446:
1.81 albertel 3447: ###############################################################
1.61 www 3448: sub plainname {
1.226 albertel 3449: my ($uname,$udom,$first)=@_;
1.537 albertel 3450: return if (!defined($uname) || !defined($udom));
1.295 www 3451: my %names=&getnames($uname,$udom);
1.226 albertel 3452: my $name=&Apache::lonnet::format_name($names{'firstname'},
3453: $names{'middlename'},
3454: $names{'lastname'},
3455: $names{'generation'},$first);
3456: $name=~s/^\s+//;
1.62 www 3457: $name=~s/\s+$//;
3458: $name=~s/\s+/ /g;
1.353 albertel 3459: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3460: return $name;
1.61 www 3461: }
1.66 www 3462:
3463: # -------------------------------------------------------------------- Nickname
1.81 albertel 3464: =pod
3465:
1.648 raeburn 3466: =item * &nickname($uname,$udom)
1.81 albertel 3467:
3468: Gets a users name and returns it as a string as
3469:
3470: ""nickname""
1.66 www 3471:
1.81 albertel 3472: if the user has a nickname or
3473:
3474: "first middle last generation"
3475:
3476: if the user does not
3477:
3478: =cut
1.66 www 3479:
3480: sub nickname {
3481: my ($uname,$udom)=@_;
1.537 albertel 3482: return if (!defined($uname) || !defined($udom));
1.295 www 3483: my %names=&getnames($uname,$udom);
1.68 albertel 3484: my $name=$names{'nickname'};
1.66 www 3485: if ($name) {
3486: $name='"'.$name.'"';
3487: } else {
3488: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3489: $names{'lastname'}.' '.$names{'generation'};
3490: $name=~s/\s+$//;
3491: $name=~s/\s+/ /g;
3492: }
3493: return $name;
3494: }
3495:
1.295 www 3496: sub getnames {
3497: my ($uname,$udom)=@_;
1.537 albertel 3498: return if (!defined($uname) || !defined($udom));
1.433 albertel 3499: if ($udom eq 'public' && $uname eq 'public') {
3500: return ('lastname' => &mt('Public'));
3501: }
1.295 www 3502: my $id=$uname.':'.$udom;
3503: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3504: if ($cached) {
3505: return %{$names};
3506: } else {
3507: my %loadnames=&Apache::lonnet::get('environment',
3508: ['firstname','middlename','lastname','generation','nickname'],
3509: $udom,$uname);
3510: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3511: return %loadnames;
3512: }
3513: }
1.61 www 3514:
1.542 raeburn 3515: # -------------------------------------------------------------------- getemails
1.648 raeburn 3516:
1.542 raeburn 3517: =pod
3518:
1.648 raeburn 3519: =item * &getemails($uname,$udom)
1.542 raeburn 3520:
3521: Gets a user's email information and returns it as a hash with keys:
3522: notification, critnotification, permanentemail
3523:
3524: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3525: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3526:
1.648 raeburn 3527:
1.542 raeburn 3528: =cut
3529:
1.648 raeburn 3530:
1.466 albertel 3531: sub getemails {
3532: my ($uname,$udom)=@_;
3533: if ($udom eq 'public' && $uname eq 'public') {
3534: return;
3535: }
1.467 www 3536: if (!$udom) { $udom=$env{'user.domain'}; }
3537: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3538: my $id=$uname.':'.$udom;
3539: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3540: if ($cached) {
3541: return %{$names};
3542: } else {
3543: my %loadnames=&Apache::lonnet::get('environment',
3544: ['notification','critnotification',
3545: 'permanentemail'],
3546: $udom,$uname);
3547: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3548: return %loadnames;
3549: }
3550: }
3551:
1.551 albertel 3552: sub flush_email_cache {
3553: my ($uname,$udom)=@_;
3554: if (!$udom) { $udom =$env{'user.domain'}; }
3555: if (!$uname) { $uname=$env{'user.name'}; }
3556: return if ($udom eq 'public' && $uname eq 'public');
3557: my $id=$uname.':'.$udom;
3558: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3559: }
3560:
1.728 raeburn 3561: # -------------------------------------------------------------------- getlangs
3562:
3563: =pod
3564:
3565: =item * &getlangs($uname,$udom)
3566:
3567: Gets a user's language preference and returns it as a hash with key:
3568: language.
3569:
3570: =cut
3571:
3572:
3573: sub getlangs {
3574: my ($uname,$udom) = @_;
3575: if (!$udom) { $udom =$env{'user.domain'}; }
3576: if (!$uname) { $uname=$env{'user.name'}; }
3577: my $id=$uname.':'.$udom;
3578: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3579: if ($cached) {
3580: return %{$langs};
3581: } else {
3582: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3583: $udom,$uname);
3584: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3585: return %loadlangs;
3586: }
3587: }
3588:
3589: sub flush_langs_cache {
3590: my ($uname,$udom)=@_;
3591: if (!$udom) { $udom =$env{'user.domain'}; }
3592: if (!$uname) { $uname=$env{'user.name'}; }
3593: return if ($udom eq 'public' && $uname eq 'public');
3594: my $id=$uname.':'.$udom;
3595: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3596: }
3597:
1.61 www 3598: # ------------------------------------------------------------------ Screenname
1.81 albertel 3599:
3600: =pod
3601:
1.648 raeburn 3602: =item * &screenname($uname,$udom)
1.81 albertel 3603:
3604: Gets a users screenname and returns it as a string
3605:
3606: =cut
1.61 www 3607:
3608: sub screenname {
3609: my ($uname,$udom)=@_;
1.258 albertel 3610: if ($uname eq $env{'user.name'} &&
3611: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3612: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3613: return $names{'screenname'};
1.62 www 3614: }
3615:
1.212 albertel 3616:
1.802 bisitz 3617: # ------------------------------------------------------------- Confirm Wrapper
3618: =pod
3619:
1.1075.2.42 raeburn 3620: =item * &confirmwrapper($message)
1.802 bisitz 3621:
3622: Wrap messages about completion of operation in box
3623:
3624: =cut
3625:
3626: sub confirmwrapper {
3627: my ($message)=@_;
3628: if ($message) {
3629: return "\n".'<div class="LC_confirm_box">'."\n"
3630: .$message."\n"
3631: .'</div>'."\n";
3632: } else {
3633: return $message;
3634: }
3635: }
3636:
1.62 www 3637: # ------------------------------------------------------------- Message Wrapper
3638:
3639: sub messagewrapper {
1.369 www 3640: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3641: return
1.441 albertel 3642: '<a href="/adm/email?compose=individual&'.
3643: 'recname='.$username.'&recdom='.$domain.
3644: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3645: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3646: }
1.802 bisitz 3647:
1.74 www 3648: # --------------------------------------------------------------- Notes Wrapper
3649:
3650: sub noteswrapper {
3651: my ($link,$un,$do)=@_;
3652: return
1.896 amueller 3653: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3654: }
1.802 bisitz 3655:
1.62 www 3656: # ------------------------------------------------------------- Aboutme Wrapper
3657:
3658: sub aboutmewrapper {
1.1070 raeburn 3659: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3660: if (!defined($username) && !defined($domain)) {
3661: return;
3662: }
1.1075.2.15 raeburn 3663: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3664: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3665: }
3666:
3667: # ------------------------------------------------------------ Syllabus Wrapper
3668:
3669: sub syllabuswrapper {
1.707 bisitz 3670: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3671: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3672: }
1.14 harris41 3673:
1.802 bisitz 3674: # -----------------------------------------------------------------------------
3675:
1.208 matthew 3676: sub track_student_link {
1.887 raeburn 3677: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3678: my $link ="/adm/trackstudent?";
1.208 matthew 3679: my $title = 'View recent activity';
3680: if (defined($sname) && $sname !~ /^\s*$/ &&
3681: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3682: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3683: $title .= ' of this student';
1.268 albertel 3684: }
1.208 matthew 3685: if (defined($target) && $target !~ /^\s*$/) {
3686: $target = qq{target="$target"};
3687: } else {
3688: $target = '';
3689: }
1.268 albertel 3690: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3691: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3692: $title = &mt($title);
3693: $linktext = &mt($linktext);
1.448 albertel 3694: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3695: &help_open_topic('View_recent_activity');
1.208 matthew 3696: }
3697:
1.781 raeburn 3698: sub slot_reservations_link {
3699: my ($linktext,$sname,$sdom,$target) = @_;
3700: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3701: my $title = 'View slot reservation history';
3702: if (defined($sname) && $sname !~ /^\s*$/ &&
3703: defined($sdom) && $sdom !~ /^\s*$/) {
3704: $link .= "&uname=$sname&udom=$sdom";
3705: $title .= ' of this student';
3706: }
3707: if (defined($target) && $target !~ /^\s*$/) {
3708: $target = qq{target="$target"};
3709: } else {
3710: $target = '';
3711: }
3712: $title = &mt($title);
3713: $linktext = &mt($linktext);
3714: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3715: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3716:
3717: }
3718:
1.508 www 3719: # ===================================================== Display a student photo
3720:
3721:
1.509 albertel 3722: sub student_image_tag {
1.508 www 3723: my ($domain,$user)=@_;
3724: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3725: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3726: return '<img src="'.$imgsrc.'" align="right" />';
3727: } else {
3728: return '';
3729: }
3730: }
3731:
1.112 bowersj2 3732: =pod
3733:
3734: =back
3735:
3736: =head1 Access .tab File Data
3737:
3738: =over 4
3739:
1.648 raeburn 3740: =item * &languageids()
1.112 bowersj2 3741:
3742: returns list of all language ids
3743:
3744: =cut
3745:
1.14 harris41 3746: sub languageids {
1.16 harris41 3747: return sort(keys(%language));
1.14 harris41 3748: }
3749:
1.112 bowersj2 3750: =pod
3751:
1.648 raeburn 3752: =item * &languagedescription()
1.112 bowersj2 3753:
3754: returns description of a specified language id
3755:
3756: =cut
3757:
1.14 harris41 3758: sub languagedescription {
1.125 www 3759: my $code=shift;
3760: return ($supported_language{$code}?'* ':'').
3761: $language{$code}.
1.126 www 3762: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3763: }
3764:
1.1048 foxr 3765: =pod
3766:
3767: =item * &plainlanguagedescription
3768:
3769: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3770: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3771:
3772: =cut
3773:
1.145 www 3774: sub plainlanguagedescription {
3775: my $code=shift;
3776: return $language{$code};
3777: }
3778:
1.1048 foxr 3779: =pod
3780:
3781: =item * &supportedlanguagecode
3782:
3783: Returns the supported language code (e.g. sptutf maps to pt) given a language
3784: code.
3785:
3786: =cut
3787:
1.145 www 3788: sub supportedlanguagecode {
3789: my $code=shift;
3790: return $supported_language{$code};
1.97 www 3791: }
3792:
1.112 bowersj2 3793: =pod
3794:
1.1048 foxr 3795: =item * &latexlanguage()
3796:
3797: Given a language key code returns the correspondnig language to use
3798: to select the correct hyphenation on LaTeX printouts. This is undef if there
3799: is no supported hyphenation for the language code.
3800:
3801: =cut
3802:
3803: sub latexlanguage {
3804: my $code = shift;
3805: return $latex_language{$code};
3806: }
3807:
3808: =pod
3809:
3810: =item * &latexhyphenation()
3811:
3812: Same as above but what's supplied is the language as it might be stored
3813: in the metadata.
3814:
3815: =cut
3816:
3817: sub latexhyphenation {
3818: my $key = shift;
3819: return $latex_language_bykey{$key};
3820: }
3821:
3822: =pod
3823:
1.648 raeburn 3824: =item * ©rightids()
1.112 bowersj2 3825:
3826: returns list of all copyrights
3827:
3828: =cut
3829:
3830: sub copyrightids {
3831: return sort(keys(%cprtag));
3832: }
3833:
3834: =pod
3835:
1.648 raeburn 3836: =item * ©rightdescription()
1.112 bowersj2 3837:
3838: returns description of a specified copyright id
3839:
3840: =cut
3841:
3842: sub copyrightdescription {
1.166 www 3843: return &mt($cprtag{shift(@_)});
1.112 bowersj2 3844: }
1.197 matthew 3845:
3846: =pod
3847:
1.648 raeburn 3848: =item * &source_copyrightids()
1.192 taceyjo1 3849:
3850: returns list of all source copyrights
3851:
3852: =cut
3853:
3854: sub source_copyrightids {
3855: return sort(keys(%scprtag));
3856: }
3857:
3858: =pod
3859:
1.648 raeburn 3860: =item * &source_copyrightdescription()
1.192 taceyjo1 3861:
3862: returns description of a specified source copyright id
3863:
3864: =cut
3865:
3866: sub source_copyrightdescription {
3867: return &mt($scprtag{shift(@_)});
3868: }
1.112 bowersj2 3869:
3870: =pod
3871:
1.648 raeburn 3872: =item * &filecategories()
1.112 bowersj2 3873:
3874: returns list of all file categories
3875:
3876: =cut
3877:
3878: sub filecategories {
3879: return sort(keys(%category_extensions));
3880: }
3881:
3882: =pod
3883:
1.648 raeburn 3884: =item * &filecategorytypes()
1.112 bowersj2 3885:
3886: returns list of file types belonging to a given file
3887: category
3888:
3889: =cut
3890:
3891: sub filecategorytypes {
1.356 albertel 3892: my ($cat) = @_;
3893: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 3894: }
3895:
3896: =pod
3897:
1.648 raeburn 3898: =item * &fileembstyle()
1.112 bowersj2 3899:
3900: returns embedding style for a specified file type
3901:
3902: =cut
3903:
3904: sub fileembstyle {
3905: return $fe{lc(shift(@_))};
1.169 www 3906: }
3907:
1.351 www 3908: sub filemimetype {
3909: return $fm{lc(shift(@_))};
3910: }
3911:
1.169 www 3912:
3913: sub filecategoryselect {
3914: my ($name,$value)=@_;
1.189 matthew 3915: return &select_form($value,$name,
1.970 raeburn 3916: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 3917: }
3918:
3919: =pod
3920:
1.648 raeburn 3921: =item * &filedescription()
1.112 bowersj2 3922:
3923: returns description for a specified file type
3924:
3925: =cut
3926:
3927: sub filedescription {
1.188 matthew 3928: my $file_description = $fd{lc(shift())};
3929: $file_description =~ s:([\[\]]):~$1:g;
3930: return &mt($file_description);
1.112 bowersj2 3931: }
3932:
3933: =pod
3934:
1.648 raeburn 3935: =item * &filedescriptionex()
1.112 bowersj2 3936:
3937: returns description for a specified file type with
3938: extra formatting
3939:
3940: =cut
3941:
3942: sub filedescriptionex {
3943: my $ex=shift;
1.188 matthew 3944: my $file_description = $fd{lc($ex)};
3945: $file_description =~ s:([\[\]]):~$1:g;
3946: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3947: }
3948:
3949: # End of .tab access
3950: =pod
3951:
3952: =back
3953:
3954: =cut
3955:
3956: # ------------------------------------------------------------------ File Types
3957: sub fileextensions {
3958: return sort(keys(%fe));
3959: }
3960:
1.97 www 3961: # ----------------------------------------------------------- Display Languages
3962: # returns a hash with all desired display languages
3963: #
3964:
3965: sub display_languages {
3966: my %languages=();
1.695 raeburn 3967: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3968: $languages{$lang}=1;
1.97 www 3969: }
3970: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3971: if ($env{'form.displaylanguage'}) {
1.356 albertel 3972: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3973: $languages{$lang}=1;
1.97 www 3974: }
3975: }
3976: return %languages;
1.14 harris41 3977: }
3978:
1.582 albertel 3979: sub languages {
3980: my ($possible_langs) = @_;
1.695 raeburn 3981: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3982: if (!ref($possible_langs)) {
3983: if( wantarray ) {
3984: return @preferred_langs;
3985: } else {
3986: return $preferred_langs[0];
3987: }
3988: }
3989: my %possibilities = map { $_ => 1 } (@$possible_langs);
3990: my @preferred_possibilities;
3991: foreach my $preferred_lang (@preferred_langs) {
3992: if (exists($possibilities{$preferred_lang})) {
3993: push(@preferred_possibilities, $preferred_lang);
3994: }
3995: }
3996: if( wantarray ) {
3997: return @preferred_possibilities;
3998: }
3999: return $preferred_possibilities[0];
4000: }
4001:
1.742 raeburn 4002: sub user_lang {
4003: my ($touname,$toudom,$fromcid) = @_;
4004: my @userlangs;
4005: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4006: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4007: $env{'course.'.$fromcid.'.languages'}));
4008: } else {
4009: my %langhash = &getlangs($touname,$toudom);
4010: if ($langhash{'languages'} ne '') {
4011: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4012: } else {
4013: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4014: if ($domdefs{'lang_def'} ne '') {
4015: @userlangs = ($domdefs{'lang_def'});
4016: }
4017: }
4018: }
4019: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4020: my $user_lh = Apache::localize->get_handle(@languages);
4021: return $user_lh;
4022: }
4023:
4024:
1.112 bowersj2 4025: ###############################################################
4026: ## Student Answer Attempts ##
4027: ###############################################################
4028:
4029: =pod
4030:
4031: =head1 Alternate Problem Views
4032:
4033: =over 4
4034:
1.648 raeburn 4035: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86 raeburn 4036: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4037:
4038: Return string with previous attempt on problem. Arguments:
4039:
4040: =over 4
4041:
4042: =item * $symb: Problem, including path
4043:
4044: =item * $username: username of the desired student
4045:
4046: =item * $domain: domain of the desired student
1.14 harris41 4047:
1.112 bowersj2 4048: =item * $course: Course ID
1.14 harris41 4049:
1.112 bowersj2 4050: =item * $getattempt: Leave blank for all attempts, otherwise put
4051: something
1.14 harris41 4052:
1.112 bowersj2 4053: =item * $regexp: if string matches this regexp, the string will be
4054: sent to $gradesub
1.14 harris41 4055:
1.112 bowersj2 4056: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4057:
1.1075.2.86 raeburn 4058: =item * $usec: section of the desired student
4059:
4060: =item * $identifier: counter for student (multiple students one problem) or
4061: problem (one student; whole sequence).
4062:
1.112 bowersj2 4063: =back
1.14 harris41 4064:
1.112 bowersj2 4065: The output string is a table containing all desired attempts, if any.
1.16 harris41 4066:
1.112 bowersj2 4067: =cut
1.1 albertel 4068:
4069: sub get_previous_attempt {
1.1075.2.86 raeburn 4070: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4071: my $prevattempts='';
1.43 ng 4072: no strict 'refs';
1.1 albertel 4073: if ($symb) {
1.3 albertel 4074: my (%returnhash)=
4075: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4076: if ($returnhash{'version'}) {
4077: my %lasthash=();
4078: my $version;
4079: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91 raeburn 4080: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4081: if ($key =~ /\.rawrndseed$/) {
4082: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4083: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4084: } else {
4085: $lasthash{$key}=$returnhash{$version.':'.$key};
4086: }
1.19 harris41 4087: }
1.1 albertel 4088: }
1.596 albertel 4089: $prevattempts=&start_data_table().&start_data_table_header_row();
4090: $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86 raeburn 4091: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4092: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4093: foreach my $key (sort(keys(%lasthash))) {
4094: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4095: if ($#parts > 0) {
1.31 albertel 4096: my $data=$parts[-1];
1.989 raeburn 4097: next if ($data eq 'foilorder');
1.31 albertel 4098: pop(@parts);
1.1010 www 4099: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4100: if ($data eq 'type') {
4101: unless ($showsurv) {
4102: my $id = join(',',@parts);
4103: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4104: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4105: $lasthidden{$ign.'.'.$id} = 1;
4106: }
1.945 raeburn 4107: }
1.1075.2.86 raeburn 4108: if ($identifier ne '') {
4109: my $id = join(',',@parts);
4110: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4111: $domain,$username,$usec,undef,$course) =~ /^no/) {
4112: $hidestatus{$ign.'.'.$id} = 1;
4113: }
4114: }
4115: } elsif ($data eq 'regrader') {
4116: if (($identifier ne '') && (@parts)) {
4117: my $id = join(',',@parts);
4118: $regraded{$ign.'.'.$id} = 1;
4119: }
1.1010 www 4120: }
1.31 albertel 4121: } else {
1.41 ng 4122: if ($#parts == 0) {
4123: $prevattempts.='<th>'.$parts[0].'</th>';
4124: } else {
4125: $prevattempts.='<th>'.$ign.'</th>';
4126: }
1.31 albertel 4127: }
1.16 harris41 4128: }
1.596 albertel 4129: $prevattempts.=&end_data_table_header_row();
1.40 ng 4130: if ($getattempt eq '') {
1.1075.2.86 raeburn 4131: my (%solved,%resets,%probstatus);
4132: if (($identifier ne '') && (keys(%regraded) > 0)) {
4133: for ($version=1;$version<=$returnhash{'version'};$version++) {
4134: foreach my $id (keys(%regraded)) {
4135: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4136: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4137: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4138: push(@{$resets{$id}},$version);
4139: }
4140: }
4141: }
4142: }
1.40 ng 4143: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86 raeburn 4144: my (@hidden,@unsolved);
1.945 raeburn 4145: if (%typeparts) {
4146: foreach my $id (keys(%typeparts)) {
1.1075.2.86 raeburn 4147: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4148: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4149: push(@hidden,$id);
1.1075.2.86 raeburn 4150: } elsif ($identifier ne '') {
4151: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4152: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4153: ($hidestatus{$id})) {
4154: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
4155: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4156: push(@{$solved{$id}},$version);
4157: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4158: (ref($solved{$id}) eq 'ARRAY')) {
4159: my $skip;
4160: if (ref($resets{$id}) eq 'ARRAY') {
4161: foreach my $reset (@{$resets{$id}}) {
4162: if ($reset > $solved{$id}[-1]) {
4163: $skip=1;
4164: last;
4165: }
4166: }
4167: }
4168: unless ($skip) {
4169: my ($ign,$partslist) = split(/\./,$id,2);
4170: push(@unsolved,$partslist);
4171: }
4172: }
4173: }
1.945 raeburn 4174: }
4175: }
4176: }
4177: $prevattempts.=&start_data_table_row().
1.1075.2.86 raeburn 4178: '<td>'.&mt('Transaction [_1]',$version);
4179: if (@unsolved) {
4180: $prevattempts .= '<span class="LC_nobreak"><label>'.
4181: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4182: &mt('Hide').'</label></span>';
4183: }
4184: $prevattempts .= '</td>';
1.945 raeburn 4185: if (@hidden) {
4186: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4187: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4188: my $hide;
4189: foreach my $id (@hidden) {
4190: if ($key =~ /^\Q$id\E/) {
4191: $hide = 1;
4192: last;
4193: }
4194: }
4195: if ($hide) {
4196: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4197: if (($data eq 'award') || ($data eq 'awarddetail')) {
4198: my $value = &format_previous_attempt_value($key,
4199: $returnhash{$version.':'.$key});
4200: $prevattempts.='<td>'.$value.' </td>';
4201: } else {
4202: $prevattempts.='<td> </td>';
4203: }
4204: } else {
4205: if ($key =~ /\./) {
1.1075.2.91 raeburn 4206: my $value = $returnhash{$version.':'.$key};
4207: if ($key =~ /\.rndseed$/) {
4208: my ($id) = ($key =~ /^(.+)\.rndseed$/);
4209: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4210: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4211: }
4212: }
4213: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4214: ' </td>';
1.945 raeburn 4215: } else {
4216: $prevattempts.='<td> </td>';
4217: }
4218: }
4219: }
4220: } else {
4221: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4222: next if ($key =~ /\.foilorder$/);
1.1075.2.91 raeburn 4223: my $value = $returnhash{$version.':'.$key};
4224: if ($key =~ /\.rndseed$/) {
4225: my ($id) = ($key =~ /^(.+)\.rndseed$/);
4226: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4227: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4228: }
4229: }
4230: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4231: ' </td>';
1.945 raeburn 4232: }
4233: }
4234: $prevattempts.=&end_data_table_row();
1.40 ng 4235: }
1.1 albertel 4236: }
1.945 raeburn 4237: my @currhidden = keys(%lasthidden);
1.596 albertel 4238: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4239: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4240: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4241: if (%typeparts) {
4242: my $hidden;
4243: foreach my $id (@currhidden) {
4244: if ($key =~ /^\Q$id\E/) {
4245: $hidden = 1;
4246: last;
4247: }
4248: }
4249: if ($hidden) {
4250: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4251: if (($data eq 'award') || ($data eq 'awarddetail')) {
4252: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4253: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4254: $value = &$gradesub($value);
4255: }
4256: $prevattempts.='<td>'.$value.' </td>';
4257: } else {
4258: $prevattempts.='<td> </td>';
4259: }
4260: } else {
4261: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4262: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4263: $value = &$gradesub($value);
4264: }
4265: $prevattempts.='<td>'.$value.' </td>';
4266: }
4267: } else {
4268: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4269: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4270: $value = &$gradesub($value);
4271: }
4272: $prevattempts.='<td>'.$value.' </td>';
4273: }
1.16 harris41 4274: }
1.596 albertel 4275: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4276: } else {
1.596 albertel 4277: $prevattempts=
4278: &start_data_table().&start_data_table_row().
4279: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
4280: &end_data_table_row().&end_data_table();
1.1 albertel 4281: }
4282: } else {
1.596 albertel 4283: $prevattempts=
4284: &start_data_table().&start_data_table_row().
4285: '<td>'.&mt('No data.').'</td>'.
4286: &end_data_table_row().&end_data_table();
1.1 albertel 4287: }
1.10 albertel 4288: }
4289:
1.581 albertel 4290: sub format_previous_attempt_value {
4291: my ($key,$value) = @_;
1.1011 www 4292: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 4293: $value = &Apache::lonlocal::locallocaltime($value);
4294: } elsif (ref($value) eq 'ARRAY') {
4295: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 4296: } elsif ($key =~ /answerstring$/) {
4297: my %answers = &Apache::lonnet::str2hash($value);
4298: my @anskeys = sort(keys(%answers));
4299: if (@anskeys == 1) {
4300: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4301: if ($answer =~ m{\0}) {
4302: $answer =~ s{\0}{,}g;
1.988 raeburn 4303: }
4304: my $tag_internal_answer_name = 'INTERNAL';
4305: if ($anskeys[0] eq $tag_internal_answer_name) {
4306: $value = $answer;
4307: } else {
4308: $value = $anskeys[0].'='.$answer;
4309: }
4310: } else {
4311: foreach my $ans (@anskeys) {
4312: my $answer = $answers{$ans};
1.1001 raeburn 4313: if ($answer =~ m{\0}) {
4314: $answer =~ s{\0}{,}g;
1.988 raeburn 4315: }
4316: $value .= $ans.'='.$answer.'<br />';;
4317: }
4318: }
1.581 albertel 4319: } else {
4320: $value = &unescape($value);
4321: }
4322: return $value;
4323: }
4324:
4325:
1.107 albertel 4326: sub relative_to_absolute {
4327: my ($url,$output)=@_;
4328: my $parser=HTML::TokeParser->new(\$output);
4329: my $token;
4330: my $thisdir=$url;
4331: my @rlinks=();
4332: while ($token=$parser->get_token) {
4333: if ($token->[0] eq 'S') {
4334: if ($token->[1] eq 'a') {
4335: if ($token->[2]->{'href'}) {
4336: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4337: }
4338: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4339: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4340: } elsif ($token->[1] eq 'base') {
4341: $thisdir=$token->[2]->{'href'};
4342: }
4343: }
4344: }
4345: $thisdir=~s-/[^/]*$--;
1.356 albertel 4346: foreach my $link (@rlinks) {
1.726 raeburn 4347: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4348: ($link=~/^\//) ||
4349: ($link=~/^javascript:/i) ||
4350: ($link=~/^mailto:/i) ||
4351: ($link=~/^\#/)) {
4352: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4353: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4354: }
4355: }
4356: # -------------------------------------------------- Deal with Applet codebases
4357: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4358: return $output;
4359: }
4360:
1.112 bowersj2 4361: =pod
4362:
1.648 raeburn 4363: =item * &get_student_view()
1.112 bowersj2 4364:
4365: show a snapshot of what student was looking at
4366:
4367: =cut
4368:
1.10 albertel 4369: sub get_student_view {
1.186 albertel 4370: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4371: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4372: my (%form);
1.10 albertel 4373: my @elements=('symb','courseid','domain','username');
4374: foreach my $element (@elements) {
1.186 albertel 4375: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4376: }
1.186 albertel 4377: if (defined($moreenv)) {
4378: %form=(%form,%{$moreenv});
4379: }
1.236 albertel 4380: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4381: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4382: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4383: $userview=~s/\<body[^\>]*\>//gi;
4384: $userview=~s/\<\/body\>//gi;
4385: $userview=~s/\<html\>//gi;
4386: $userview=~s/\<\/html\>//gi;
4387: $userview=~s/\<head\>//gi;
4388: $userview=~s/\<\/head\>//gi;
4389: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4390: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4391: if (wantarray) {
4392: return ($userview,$response);
4393: } else {
4394: return $userview;
4395: }
4396: }
4397:
4398: sub get_student_view_with_retries {
4399: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4400:
4401: my $ok = 0; # True if we got a good response.
4402: my $content;
4403: my $response;
4404:
4405: # Try to get the student_view done. within the retries count:
4406:
4407: do {
4408: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4409: $ok = $response->is_success;
4410: if (!$ok) {
4411: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4412: }
4413: $retries--;
4414: } while (!$ok && ($retries > 0));
4415:
4416: if (!$ok) {
4417: $content = ''; # On error return an empty content.
4418: }
1.651 www 4419: if (wantarray) {
4420: return ($content, $response);
4421: } else {
4422: return $content;
4423: }
1.11 albertel 4424: }
4425:
1.1075.2.149 raeburn 4426: sub css_links {
4427: my ($currsymb,$level) = @_;
4428: my ($links,@symbs,%cssrefs,%httpref);
4429: if ($level eq 'map') {
4430: my $navmap = Apache::lonnavmaps::navmap->new();
4431: if (ref($navmap)) {
4432: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
4433: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
4434: foreach my $res (@resources) {
4435: if (ref($res) && $res->symb()) {
4436: push(@symbs,$res->symb());
4437: }
4438: }
4439: }
4440: } else {
4441: @symbs = ($currsymb);
4442: }
4443: foreach my $symb (@symbs) {
4444: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
4445: if ($css_href =~ /\S/) {
4446: unless ($css_href =~ m{https?://}) {
4447: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
4448: my $proburl = &Apache::lonnet::clutter($url);
4449: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
4450: unless ($css_href =~ m{^/}) {
4451: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
4452: }
4453: if ($css_href =~ m{^/(res|uploaded)/}) {
4454: unless (($httpref{'httpref.'.$css_href}) ||
4455: (&Apache::lonnet::is_on_map($css_href))) {
4456: my $thisurl = $proburl;
4457: if ($env{'httpref.'.$proburl}) {
4458: $thisurl = $env{'httpref.'.$proburl};
4459: }
4460: $httpref{'httpref.'.$css_href} = $thisurl;
4461: }
4462: }
4463: }
4464: $cssrefs{$css_href} = 1;
4465: }
4466: }
4467: if (keys(%httpref)) {
4468: &Apache::lonnet::appenv(\%httpref);
4469: }
4470: if (keys(%cssrefs)) {
4471: foreach my $css_href (keys(%cssrefs)) {
4472: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
4473: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
4474: }
4475: }
4476: return $links;
4477: }
4478:
1.112 bowersj2 4479: =pod
4480:
1.648 raeburn 4481: =item * &get_student_answers()
1.112 bowersj2 4482:
4483: show a snapshot of how student was answering problem
4484:
4485: =cut
4486:
1.11 albertel 4487: sub get_student_answers {
1.100 sakharuk 4488: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4489: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4490: my (%moreenv);
1.11 albertel 4491: my @elements=('symb','courseid','domain','username');
4492: foreach my $element (@elements) {
1.186 albertel 4493: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4494: }
1.186 albertel 4495: $moreenv{'grade_target'}='answer';
4496: %moreenv=(%form,%moreenv);
1.497 raeburn 4497: $feedurl = &Apache::lonnet::clutter($feedurl);
4498: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4499: return $userview;
1.1 albertel 4500: }
1.116 albertel 4501:
4502: =pod
4503:
4504: =item * &submlink()
4505:
1.242 albertel 4506: Inputs: $text $uname $udom $symb $target
1.116 albertel 4507:
4508: Returns: A link to grades.pm such as to see the SUBM view of a student
4509:
4510: =cut
4511:
4512: ###############################################
4513: sub submlink {
1.242 albertel 4514: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4515: if (!($uname && $udom)) {
4516: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4517: &Apache::lonnet::whichuser($symb);
1.116 albertel 4518: if (!$symb) { $symb=$cursymb; }
4519: }
1.254 matthew 4520: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4521: $symb=&escape($symb);
1.960 bisitz 4522: if ($target) { $target=" target=\"$target\""; }
4523: return
4524: '<a href="/adm/grades?command=submission'.
4525: '&symb='.$symb.
4526: '&student='.$uname.
4527: '&userdom='.$udom.'"'.
4528: $target.'>'.$text.'</a>';
1.242 albertel 4529: }
4530: ##############################################
4531:
4532: =pod
4533:
4534: =item * &pgrdlink()
4535:
4536: Inputs: $text $uname $udom $symb $target
4537:
4538: Returns: A link to grades.pm such as to see the PGRD view of a student
4539:
4540: =cut
4541:
4542: ###############################################
4543: sub pgrdlink {
4544: my $link=&submlink(@_);
4545: $link=~s/(&command=submission)/$1&showgrading=yes/;
4546: return $link;
4547: }
4548: ##############################################
4549:
4550: =pod
4551:
4552: =item * &pprmlink()
4553:
4554: Inputs: $text $uname $udom $symb $target
4555:
4556: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4557: student and a specific resource
1.242 albertel 4558:
4559: =cut
4560:
4561: ###############################################
4562: sub pprmlink {
4563: my ($text,$uname,$udom,$symb,$target)=@_;
4564: if (!($uname && $udom)) {
4565: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4566: &Apache::lonnet::whichuser($symb);
1.242 albertel 4567: if (!$symb) { $symb=$cursymb; }
4568: }
1.254 matthew 4569: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4570: $symb=&escape($symb);
1.242 albertel 4571: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4572: return '<a href="/adm/parmset?command=set&'.
4573: 'symb='.$symb.'&uname='.$uname.
4574: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4575: }
4576: ##############################################
1.37 matthew 4577:
1.112 bowersj2 4578: =pod
4579:
4580: =back
4581:
4582: =cut
4583:
1.37 matthew 4584: ###############################################
1.51 www 4585:
4586:
4587: sub timehash {
1.687 raeburn 4588: my ($thistime) = @_;
4589: my $timezone = &Apache::lonlocal::gettimezone();
4590: my $dt = DateTime->from_epoch(epoch => $thistime)
4591: ->set_time_zone($timezone);
4592: my $wday = $dt->day_of_week();
4593: if ($wday == 7) { $wday = 0; }
4594: return ( 'second' => $dt->second(),
4595: 'minute' => $dt->minute(),
4596: 'hour' => $dt->hour(),
4597: 'day' => $dt->day_of_month(),
4598: 'month' => $dt->month(),
4599: 'year' => $dt->year(),
4600: 'weekday' => $wday,
4601: 'dayyear' => $dt->day_of_year(),
4602: 'dlsav' => $dt->is_dst() );
1.51 www 4603: }
4604:
1.370 www 4605: sub utc_string {
4606: my ($date)=@_;
1.371 www 4607: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4608: }
4609:
1.51 www 4610: sub maketime {
4611: my %th=@_;
1.687 raeburn 4612: my ($epoch_time,$timezone,$dt);
4613: $timezone = &Apache::lonlocal::gettimezone();
4614: eval {
4615: $dt = DateTime->new( year => $th{'year'},
4616: month => $th{'month'},
4617: day => $th{'day'},
4618: hour => $th{'hour'},
4619: minute => $th{'minute'},
4620: second => $th{'second'},
4621: time_zone => $timezone,
4622: );
4623: };
4624: if (!$@) {
4625: $epoch_time = $dt->epoch;
4626: if ($epoch_time) {
4627: return $epoch_time;
4628: }
4629: }
1.51 www 4630: return POSIX::mktime(
4631: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4632: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4633: }
4634:
4635: #########################################
1.51 www 4636:
4637: sub findallcourses {
1.482 raeburn 4638: my ($roles,$uname,$udom) = @_;
1.355 albertel 4639: my %roles;
4640: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4641: my %courses;
1.51 www 4642: my $now=time;
1.482 raeburn 4643: if (!defined($uname)) {
4644: $uname = $env{'user.name'};
4645: }
4646: if (!defined($udom)) {
4647: $udom = $env{'user.domain'};
4648: }
4649: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4650: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4651: if (!%roles) {
4652: %roles = (
4653: cc => 1,
1.907 raeburn 4654: co => 1,
1.482 raeburn 4655: in => 1,
4656: ep => 1,
4657: ta => 1,
4658: cr => 1,
4659: st => 1,
4660: );
4661: }
4662: foreach my $entry (keys(%roleshash)) {
4663: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4664: if ($trole =~ /^cr/) {
4665: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4666: } else {
4667: next if (!exists($roles{$trole}));
4668: }
4669: if ($tend) {
4670: next if ($tend < $now);
4671: }
4672: if ($tstart) {
4673: next if ($tstart > $now);
4674: }
1.1058 raeburn 4675: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4676: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4677: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4678: if ($secpart eq '') {
4679: ($cnum,$role) = split(/_/,$cnumpart);
4680: $sec = 'none';
1.1058 raeburn 4681: $value .= $cnum.'/';
1.482 raeburn 4682: } else {
4683: $cnum = $cnumpart;
4684: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4685: $value .= $cnum.'/'.$sec;
4686: }
4687: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4688: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4689: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4690: }
4691: } else {
4692: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4693: }
1.482 raeburn 4694: }
4695: } else {
4696: foreach my $key (keys(%env)) {
1.483 albertel 4697: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4698: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4699: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4700: next if ($role eq 'ca' || $role eq 'aa');
4701: next if (%roles && !exists($roles{$role}));
4702: my ($starttime,$endtime)=split(/\./,$env{$key});
4703: my $active=1;
4704: if ($starttime) {
4705: if ($now<$starttime) { $active=0; }
4706: }
4707: if ($endtime) {
4708: if ($now>$endtime) { $active=0; }
4709: }
4710: if ($active) {
1.1058 raeburn 4711: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4712: if ($sec eq '') {
4713: $sec = 'none';
1.1058 raeburn 4714: } else {
4715: $value .= $sec;
4716: }
4717: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4718: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4719: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4720: }
4721: } else {
4722: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4723: }
1.474 raeburn 4724: }
4725: }
1.51 www 4726: }
4727: }
1.474 raeburn 4728: return %courses;
1.51 www 4729: }
1.37 matthew 4730:
1.54 www 4731: ###############################################
1.474 raeburn 4732:
4733: sub blockcheck {
1.1075.2.147 raeburn 4734: my ($setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490 raeburn 4735:
1.1075.2.73 raeburn 4736: if (defined($udom) && defined($uname)) {
4737: # If uname and udom are for a course, check for blocks in the course.
4738: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
4739: my ($startblock,$endblock,$triggerblock) =
1.1075.2.147 raeburn 4740: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73 raeburn 4741: return ($startblock,$endblock,$triggerblock);
4742: }
4743: } else {
1.490 raeburn 4744: $udom = $env{'user.domain'};
4745: $uname = $env{'user.name'};
4746: }
4747:
1.502 raeburn 4748: my $startblock = 0;
4749: my $endblock = 0;
1.1062 raeburn 4750: my $triggerblock = '';
1.482 raeburn 4751: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 4752:
1.490 raeburn 4753: # If uname is for a user, and activity is course-specific, i.e.,
4754: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 4755:
1.490 raeburn 4756: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73 raeburn 4757: $activity eq 'groups' || $activity eq 'printout') &&
4758: ($env{'request.course.id'})) {
1.490 raeburn 4759: foreach my $key (keys(%live_courses)) {
4760: if ($key ne $env{'request.course.id'}) {
4761: delete($live_courses{$key});
4762: }
4763: }
4764: }
4765:
4766: my $otheruser = 0;
4767: my %own_courses;
4768: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
4769: # Resource belongs to user other than current user.
4770: $otheruser = 1;
4771: # Gather courses for current user
4772: %own_courses =
4773: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
4774: }
4775:
4776: # Gather active course roles - course coordinator, instructor,
4777: # exam proctor, ta, student, or custom role.
1.474 raeburn 4778:
4779: foreach my $course (keys(%live_courses)) {
1.482 raeburn 4780: my ($cdom,$cnum);
4781: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
4782: $cdom = $env{'course.'.$course.'.domain'};
4783: $cnum = $env{'course.'.$course.'.num'};
4784: } else {
1.490 raeburn 4785: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 4786: }
4787: my $no_ownblock = 0;
4788: my $no_userblock = 0;
1.533 raeburn 4789: if ($otheruser && $activity ne 'com') {
1.490 raeburn 4790: # Check if current user has 'evb' priv for this
4791: if (defined($own_courses{$course})) {
4792: foreach my $sec (keys(%{$own_courses{$course}})) {
4793: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
4794: if ($sec ne 'none') {
4795: $checkrole .= '/'.$sec;
4796: }
4797: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4798: $no_ownblock = 1;
4799: last;
4800: }
4801: }
4802: }
4803: # if they have 'evb' priv and are currently not playing student
4804: next if (($no_ownblock) &&
4805: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
4806: }
1.474 raeburn 4807: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 4808: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 4809: if ($sec ne 'none') {
1.482 raeburn 4810: $checkrole .= '/'.$sec;
1.474 raeburn 4811: }
1.490 raeburn 4812: if ($otheruser) {
4813: # Resource belongs to user other than current user.
4814: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 4815: my (%allroles,%userroles);
4816: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
4817: foreach my $entry (@{$live_courses{$course}{$sec}}) {
4818: my ($trole,$tdom,$tnum,$tsec);
4819: if ($entry =~ /^cr/) {
4820: ($trole,$tdom,$tnum,$tsec) =
4821: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
4822: } else {
4823: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
4824: }
4825: my ($spec,$area,$trest);
4826: $area = '/'.$tdom.'/'.$tnum;
4827: $trest = $tnum;
4828: if ($tsec ne '') {
4829: $area .= '/'.$tsec;
4830: $trest .= '/'.$tsec;
4831: }
4832: $spec = $trole.'.'.$area;
4833: if ($trole =~ /^cr/) {
4834: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
4835: $tdom,$spec,$trest,$area);
4836: } else {
4837: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
4838: $tdom,$spec,$trest,$area);
4839: }
4840: }
1.1075.2.124 raeburn 4841: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 4842: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
4843: if ($1) {
4844: $no_userblock = 1;
4845: last;
4846: }
1.486 raeburn 4847: }
4848: }
1.490 raeburn 4849: } else {
4850: # Resource belongs to current user
4851: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 4852: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
4853: $no_ownblock = 1;
4854: last;
4855: }
1.474 raeburn 4856: }
4857: }
4858: # if they have the evb priv and are currently not playing student
1.482 raeburn 4859: next if (($no_ownblock) &&
1.491 albertel 4860: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 4861: next if ($no_userblock);
1.474 raeburn 4862:
1.1075.2.128 raeburn 4863: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 4864: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 4865:
1.1062 raeburn 4866: my ($start,$end,$trigger) =
1.1075.2.147 raeburn 4867: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 4868: if (($start != 0) &&
4869: (($startblock == 0) || ($startblock > $start))) {
4870: $startblock = $start;
1.1062 raeburn 4871: if ($trigger ne '') {
4872: $triggerblock = $trigger;
4873: }
1.502 raeburn 4874: }
4875: if (($end != 0) &&
4876: (($endblock == 0) || ($endblock < $end))) {
4877: $endblock = $end;
1.1062 raeburn 4878: if ($trigger ne '') {
4879: $triggerblock = $trigger;
4880: }
1.502 raeburn 4881: }
1.490 raeburn 4882: }
1.1062 raeburn 4883: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 4884: }
4885:
4886: sub get_blocks {
1.1075.2.147 raeburn 4887: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 4888: my $startblock = 0;
4889: my $endblock = 0;
1.1062 raeburn 4890: my $triggerblock = '';
1.490 raeburn 4891: my $course = $cdom.'_'.$cnum;
4892: $setters->{$course} = {};
4893: $setters->{$course}{'staff'} = [];
4894: $setters->{$course}{'times'} = [];
1.1062 raeburn 4895: $setters->{$course}{'triggers'} = [];
4896: my (@blockers,%triggered);
4897: my $now = time;
4898: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
4899: if ($activity eq 'docs') {
1.1075.2.148 raeburn 4900: my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147 raeburn 4901: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
4902: $blocked = 1;
4903: $nosymbcache = 1;
1.1075.2.148 raeburn 4904: $noenccheck = 1;
1.1075.2.147 raeburn 4905: }
1.1075.2.148 raeburn 4906: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 4907: foreach my $block (@blockers) {
4908: if ($block =~ /^firstaccess____(.+)$/) {
4909: my $item = $1;
4910: my $type = 'map';
4911: my $timersymb = $item;
4912: if ($item eq 'course') {
4913: $type = 'course';
4914: } elsif ($item =~ /___\d+___/) {
4915: $type = 'resource';
4916: } else {
4917: $timersymb = &Apache::lonnet::symbread($item);
4918: }
4919: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4920: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4921: $triggered{$block} = {
4922: start => $start,
4923: end => $end,
4924: type => $type,
4925: };
4926: }
4927: }
4928: } else {
4929: foreach my $block (keys(%commblocks)) {
4930: if ($block =~ m/^(\d+)____(\d+)$/) {
4931: my ($start,$end) = ($1,$2);
4932: if ($start <= time && $end >= time) {
4933: if (ref($commblocks{$block}) eq 'HASH') {
4934: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
4935: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
4936: unless(grep(/^\Q$block\E$/,@blockers)) {
4937: push(@blockers,$block);
4938: }
4939: }
4940: }
4941: }
4942: }
4943: } elsif ($block =~ /^firstaccess____(.+)$/) {
4944: my $item = $1;
4945: my $timersymb = $item;
4946: my $type = 'map';
4947: if ($item eq 'course') {
4948: $type = 'course';
4949: } elsif ($item =~ /___\d+___/) {
4950: $type = 'resource';
4951: } else {
4952: $timersymb = &Apache::lonnet::symbread($item);
4953: }
4954: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
4955: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
4956: if ($start && $end) {
4957: if (($start <= time) && ($end >= time)) {
4958: unless (grep(/^\Q$block\E$/,@blockers)) {
4959: push(@blockers,$block);
4960: $triggered{$block} = {
4961: start => $start,
4962: end => $end,
4963: type => $type,
4964: };
4965: }
4966: }
1.490 raeburn 4967: }
1.1062 raeburn 4968: }
4969: }
4970: }
4971: foreach my $blocker (@blockers) {
4972: my ($staff_name,$staff_dom,$title,$blocks) =
4973: &parse_block_record($commblocks{$blocker});
4974: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
4975: my ($start,$end,$triggertype);
4976: if ($blocker =~ m/^(\d+)____(\d+)$/) {
4977: ($start,$end) = ($1,$2);
4978: } elsif (ref($triggered{$blocker}) eq 'HASH') {
4979: $start = $triggered{$blocker}{'start'};
4980: $end = $triggered{$blocker}{'end'};
4981: $triggertype = $triggered{$blocker}{'type'};
4982: }
4983: if ($start) {
4984: push(@{$$setters{$course}{'times'}}, [$start,$end]);
4985: if ($triggertype) {
4986: push(@{$$setters{$course}{'triggers'}},$triggertype);
4987: } else {
4988: push(@{$$setters{$course}{'triggers'}},0);
4989: }
4990: if ( ($startblock == 0) || ($startblock > $start) ) {
4991: $startblock = $start;
4992: if ($triggertype) {
4993: $triggerblock = $blocker;
1.474 raeburn 4994: }
4995: }
1.1062 raeburn 4996: if ( ($endblock == 0) || ($endblock < $end) ) {
4997: $endblock = $end;
4998: if ($triggertype) {
4999: $triggerblock = $blocker;
5000: }
5001: }
1.474 raeburn 5002: }
5003: }
1.1062 raeburn 5004: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5005: }
5006:
5007: sub parse_block_record {
5008: my ($record) = @_;
5009: my ($setuname,$setudom,$title,$blocks);
5010: if (ref($record) eq 'HASH') {
5011: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5012: $title = &unescape($record->{'event'});
5013: $blocks = $record->{'blocks'};
5014: } else {
5015: my @data = split(/:/,$record,3);
5016: if (scalar(@data) eq 2) {
5017: $title = $data[1];
5018: ($setuname,$setudom) = split(/@/,$data[0]);
5019: } else {
5020: ($setuname,$setudom,$title) = @data;
5021: }
5022: $blocks = { 'com' => 'on' };
5023: }
5024: return ($setuname,$setudom,$title,$blocks);
5025: }
5026:
1.854 kalberla 5027: sub blocking_status {
1.1075.2.147 raeburn 5028: my ($activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 5029: my %setters;
1.890 droeschl 5030:
1.1061 raeburn 5031: # check for active blocking
1.1062 raeburn 5032: my ($startblock,$endblock,$triggerblock) =
1.1075.2.147 raeburn 5033: &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 5034: my $blocked = 0;
5035: if ($startblock && $endblock) {
5036: $blocked = 1;
5037: }
1.890 droeschl 5038:
1.1061 raeburn 5039: # caller just wants to know whether a block is active
5040: if (!wantarray) { return $blocked; }
5041:
5042: # build a link to a popup window containing the details
5043: my $querystring = "?activity=$activity";
5044: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97 raeburn 5045: if (($activity eq 'port') || ($activity eq 'passwd')) {
5046: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5047: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5048: } elsif ($activity eq 'docs') {
1.1075.2.147 raeburn 5049: my $showurl = &Apache::lonenc::check_encrypt($url);
5050: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
5051: if ($symb) {
5052: my $showsymb = &Apache::lonenc::check_encrypt($symb);
5053: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
5054: }
1.1062 raeburn 5055: }
1.1061 raeburn 5056:
5057: my $output .= <<'END_MYBLOCK';
5058: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5059: var options = "width=" + w + ",height=" + h + ",";
5060: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5061: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5062: var newWin = window.open(url, wdwName, options);
5063: newWin.focus();
5064: }
1.890 droeschl 5065: END_MYBLOCK
1.854 kalberla 5066:
1.1061 raeburn 5067: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5068:
1.1061 raeburn 5069: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5070: my $text = &mt('Communication Blocked');
1.1075.2.93 raeburn 5071: my $class = 'LC_comblock';
1.1062 raeburn 5072: if ($activity eq 'docs') {
5073: $text = &mt('Content Access Blocked');
1.1075.2.93 raeburn 5074: $class = '';
1.1063 raeburn 5075: } elsif ($activity eq 'printout') {
5076: $text = &mt('Printing Blocked');
1.1075.2.97 raeburn 5077: } elsif ($activity eq 'passwd') {
5078: $text = &mt('Password Changing Blocked');
1.1062 raeburn 5079: }
1.1061 raeburn 5080: $output .= <<"END_BLOCK";
1.1075.2.93 raeburn 5081: <div class='$class'>
1.869 kalberla 5082: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5083: title='$text'>
5084: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5085: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5086: title='$text'>$text</a>
1.867 kalberla 5087: </div>
5088:
5089: END_BLOCK
1.474 raeburn 5090:
1.1061 raeburn 5091: return ($blocked, $output);
1.854 kalberla 5092: }
1.490 raeburn 5093:
1.60 matthew 5094: ###############################################
5095:
1.682 raeburn 5096: sub check_ip_acc {
1.1075.2.105 raeburn 5097: my ($acc,$clientip)=@_;
1.682 raeburn 5098: &Apache::lonxml::debug("acc is $acc");
5099: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5100: return 1;
5101: }
5102: my $allowed=0;
1.1075.2.144 raeburn 5103: my $ip;
5104: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5105: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5106: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5107: } else {
1.1075.2.150! raeburn 5108: my $remote_ip = &Apache::lonnet::get_requestor_ip();
! 5109: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144 raeburn 5110: }
1.682 raeburn 5111:
5112: my $name;
5113: foreach my $pattern (split(',',$acc)) {
5114: $pattern =~ s/^\s*//;
5115: $pattern =~ s/\s*$//;
5116: if ($pattern =~ /\*$/) {
5117: #35.8.*
5118: $pattern=~s/\*//;
5119: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
5120: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5121: #35.8.3.[34-56]
5122: my $low=$2;
5123: my $high=$3;
5124: $pattern=$1;
5125: if ($ip =~ /^\Q$pattern\E/) {
5126: my $last=(split(/\./,$ip))[3];
5127: if ($last <=$high && $last >=$low) { $allowed=1; }
5128: }
5129: } elsif ($pattern =~ /^\*/) {
5130: #*.msu.edu
5131: $pattern=~s/\*//;
5132: if (!defined($name)) {
5133: use Socket;
5134: my $netaddr=inet_aton($ip);
5135: ($name)=gethostbyaddr($netaddr,AF_INET);
5136: }
5137: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
5138: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5139: #127.0.0.1
5140: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
5141: } else {
5142: #some.name.com
5143: if (!defined($name)) {
5144: use Socket;
5145: my $netaddr=inet_aton($ip);
5146: ($name)=gethostbyaddr($netaddr,AF_INET);
5147: }
5148: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
5149: }
5150: if ($allowed) { last; }
5151: }
5152: return $allowed;
5153: }
5154:
5155: ###############################################
5156:
1.60 matthew 5157: =pod
5158:
1.112 bowersj2 5159: =head1 Domain Template Functions
5160:
5161: =over 4
5162:
5163: =item * &determinedomain()
1.60 matthew 5164:
5165: Inputs: $domain (usually will be undef)
5166:
1.63 www 5167: Returns: Determines which domain should be used for designs
1.60 matthew 5168:
5169: =cut
1.54 www 5170:
1.60 matthew 5171: ###############################################
1.63 www 5172: sub determinedomain {
5173: my $domain=shift;
1.531 albertel 5174: if (! $domain) {
1.60 matthew 5175: # Determine domain if we have not been given one
1.893 raeburn 5176: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5177: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5178: if ($env{'request.role.domain'}) {
5179: $domain=$env{'request.role.domain'};
1.60 matthew 5180: }
5181: }
1.63 www 5182: return $domain;
5183: }
5184: ###############################################
1.517 raeburn 5185:
1.518 albertel 5186: sub devalidate_domconfig_cache {
5187: my ($udom)=@_;
5188: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5189: }
5190:
5191: # ---------------------- Get domain configuration for a domain
5192: sub get_domainconf {
5193: my ($udom) = @_;
5194: my $cachetime=1800;
5195: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5196: if (defined($cached)) { return %{$result}; }
5197:
5198: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5199: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5200: my (%designhash,%legacy);
1.518 albertel 5201: if (keys(%domconfig) > 0) {
5202: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5203: if (keys(%{$domconfig{'login'}})) {
5204: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5205: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87 raeburn 5206: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5207: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5208: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5209: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5210: if ($key eq 'loginvia') {
5211: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5212: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5213: $designhash{$udom.'.login.loginvia'} = $server;
5214: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5215: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5216: } else {
5217: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5218: }
1.948 raeburn 5219: }
1.1075.2.87 raeburn 5220: } elsif ($key eq 'headtag') {
5221: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5222: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5223: }
1.946 raeburn 5224: }
1.1075.2.87 raeburn 5225: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5226: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5227: }
1.946 raeburn 5228: }
5229: }
5230: }
5231: } else {
5232: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5233: $designhash{$udom.'.login.'.$key.'_'.$img} =
5234: $domconfig{'login'}{$key}{$img};
5235: }
1.699 raeburn 5236: }
5237: } else {
5238: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5239: }
1.632 raeburn 5240: }
5241: } else {
5242: $legacy{'login'} = 1;
1.518 albertel 5243: }
1.632 raeburn 5244: } else {
5245: $legacy{'login'} = 1;
1.518 albertel 5246: }
5247: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5248: if (keys(%{$domconfig{'rolecolors'}})) {
5249: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5250: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5251: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5252: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5253: }
1.518 albertel 5254: }
5255: }
1.632 raeburn 5256: } else {
5257: $legacy{'rolecolors'} = 1;
1.518 albertel 5258: }
1.632 raeburn 5259: } else {
5260: $legacy{'rolecolors'} = 1;
1.518 albertel 5261: }
1.948 raeburn 5262: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5263: if ($domconfig{'autoenroll'}{'co-owners'}) {
5264: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5265: }
5266: }
1.632 raeburn 5267: if (keys(%legacy) > 0) {
5268: my %legacyhash = &get_legacy_domconf($udom);
5269: foreach my $item (keys(%legacyhash)) {
5270: if ($item =~ /^\Q$udom\E\.login/) {
5271: if ($legacy{'login'}) {
5272: $designhash{$item} = $legacyhash{$item};
5273: }
5274: } else {
5275: if ($legacy{'rolecolors'}) {
5276: $designhash{$item} = $legacyhash{$item};
5277: }
1.518 albertel 5278: }
5279: }
5280: }
1.632 raeburn 5281: } else {
5282: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5283: }
5284: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5285: $cachetime);
5286: return %designhash;
5287: }
5288:
1.632 raeburn 5289: sub get_legacy_domconf {
5290: my ($udom) = @_;
5291: my %legacyhash;
5292: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5293: my $designfile = $designdir.'/'.$udom.'.tab';
5294: if (-e $designfile) {
1.1075.2.128 raeburn 5295: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 5296: while (my $line = <$fh>) {
5297: next if ($line =~ /^\#/);
5298: chomp($line);
5299: my ($key,$val)=(split(/\=/,$line));
5300: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5301: }
5302: close($fh);
5303: }
5304: }
1.1026 raeburn 5305: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5306: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5307: }
5308: return %legacyhash;
5309: }
5310:
1.63 www 5311: =pod
5312:
1.112 bowersj2 5313: =item * &domainlogo()
1.63 www 5314:
5315: Inputs: $domain (usually will be undef)
5316:
5317: Returns: A link to a domain logo, if the domain logo exists.
5318: If the domain logo does not exist, a description of the domain.
5319:
5320: =cut
1.112 bowersj2 5321:
1.63 www 5322: ###############################################
5323: sub domainlogo {
1.517 raeburn 5324: my $domain = &determinedomain(shift);
1.518 albertel 5325: my %designhash = &get_domainconf($domain);
1.517 raeburn 5326: # See if there is a logo
5327: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5328: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5329: if ($imgsrc =~ m{^/(adm|res)/}) {
5330: if ($imgsrc =~ m{^/res/}) {
5331: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5332: &Apache::lonnet::repcopy($local_name);
5333: }
5334: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5335: }
5336: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5337: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5338: return &Apache::lonnet::domain($domain,'description');
1.59 www 5339: } else {
1.60 matthew 5340: return '';
1.59 www 5341: }
5342: }
1.63 www 5343: ##############################################
5344:
5345: =pod
5346:
1.112 bowersj2 5347: =item * &designparm()
1.63 www 5348:
5349: Inputs: $which parameter; $domain (usually will be undef)
5350:
5351: Returns: value of designparamter $which
5352:
5353: =cut
1.112 bowersj2 5354:
1.397 albertel 5355:
1.400 albertel 5356: ##############################################
1.397 albertel 5357: sub designparm {
5358: my ($which,$domain)=@_;
5359: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5360: return $env{'environment.color.'.$which};
1.96 www 5361: }
1.63 www 5362: $domain=&determinedomain($domain);
1.1016 raeburn 5363: my %domdesign;
5364: unless ($domain eq 'public') {
5365: %domdesign = &get_domainconf($domain);
5366: }
1.520 raeburn 5367: my $output;
1.517 raeburn 5368: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5369: $output = $domdesign{$domain.'.'.$which};
1.63 www 5370: } else {
1.520 raeburn 5371: $output = $defaultdesign{$which};
5372: }
5373: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5374: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5375: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5376: if ($output =~ m{^/res/}) {
5377: my $local_name = &Apache::lonnet::filelocation('',$output);
5378: &Apache::lonnet::repcopy($local_name);
5379: }
1.520 raeburn 5380: $output = &lonhttpdurl($output);
5381: }
1.63 www 5382: }
1.520 raeburn 5383: return $output;
1.63 www 5384: }
1.59 www 5385:
1.822 bisitz 5386: ##############################################
5387: =pod
5388:
1.832 bisitz 5389: =item * &authorspace()
5390:
1.1028 raeburn 5391: Inputs: $url (usually will be undef).
1.832 bisitz 5392:
1.1075.2.40 raeburn 5393: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5394: directory being viewed (or for which action is being taken).
5395: If $url is provided, and begins /priv/<domain>/<uname>
5396: the path will be that portion of the $context argument.
5397: Otherwise the path will be for the author space of the current
5398: user when the current role is author, or for that of the
5399: co-author/assistant co-author space when the current role
5400: is co-author or assistant co-author.
1.832 bisitz 5401:
5402: =cut
5403:
5404: sub authorspace {
1.1028 raeburn 5405: my ($url) = @_;
5406: if ($url ne '') {
5407: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5408: return $1;
5409: }
5410: }
1.832 bisitz 5411: my $caname = '';
1.1024 www 5412: my $cadom = '';
1.1028 raeburn 5413: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5414: ($cadom,$caname) =
1.832 bisitz 5415: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5416: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5417: $caname = $env{'user.name'};
1.1024 www 5418: $cadom = $env{'user.domain'};
1.832 bisitz 5419: }
1.1028 raeburn 5420: if (($caname ne '') && ($cadom ne '')) {
5421: return "/priv/$cadom/$caname/";
5422: }
5423: return;
1.832 bisitz 5424: }
5425:
5426: ##############################################
5427: =pod
5428:
1.822 bisitz 5429: =item * &head_subbox()
5430:
5431: Inputs: $content (contains HTML code with page functions, etc.)
5432:
5433: Returns: HTML div with $content
5434: To be included in page header
5435:
5436: =cut
5437:
5438: sub head_subbox {
5439: my ($content)=@_;
5440: my $output =
1.993 raeburn 5441: '<div class="LC_head_subbox">'
1.822 bisitz 5442: .$content
5443: .'</div>'
5444: }
5445:
5446: ##############################################
5447: =pod
5448:
5449: =item * &CSTR_pageheader()
5450:
1.1026 raeburn 5451: Input: (optional) filename from which breadcrumb trail is built.
5452: In most cases no input as needed, as $env{'request.filename'}
5453: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5454:
5455: Returns: HTML div with CSTR path and recent box
1.1075.2.40 raeburn 5456: To be included on Authoring Space pages
1.822 bisitz 5457:
5458: =cut
5459:
5460: sub CSTR_pageheader {
1.1026 raeburn 5461: my ($trailfile) = @_;
5462: if ($trailfile eq '') {
5463: $trailfile = $env{'request.filename'};
5464: }
5465:
5466: # this is for resources; directories have customtitle, and crumbs
5467: # and select recent are created in lonpubdir.pm
5468:
5469: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5470: my ($udom,$uname,$thisdisfn)=
1.1075.2.29 raeburn 5471: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5472: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5473: $formaction =~ s{/+}{/}g;
1.822 bisitz 5474:
5475: my $parentpath = '';
5476: my $lastitem = '';
5477: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5478: $parentpath = $1;
5479: $lastitem = $2;
5480: } else {
5481: $lastitem = $thisdisfn;
5482: }
1.921 bisitz 5483:
5484: my $output =
1.822 bisitz 5485: '<div>'
5486: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40 raeburn 5487: .'<b>'.&mt('Authoring Space:').'</b> '
1.822 bisitz 5488: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5489: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5490: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5491:
5492: if ($lastitem) {
5493: $output .=
5494: '<span class="LC_filename">'
5495: .$lastitem
5496: .'</span>';
5497: }
5498: $output .=
5499: '<br />'
1.822 bisitz 5500: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5501: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5502: .'</form>'
5503: .&Apache::lonmenu::constspaceform()
5504: .'</div>';
1.921 bisitz 5505:
5506: return $output;
1.822 bisitz 5507: }
5508:
1.60 matthew 5509: ###############################################
5510: ###############################################
5511:
5512: =pod
5513:
1.112 bowersj2 5514: =back
5515:
1.549 albertel 5516: =head1 HTML Helpers
1.112 bowersj2 5517:
5518: =over 4
5519:
5520: =item * &bodytag()
1.60 matthew 5521:
5522: Returns a uniform header for LON-CAPA web pages.
5523:
5524: Inputs:
5525:
1.112 bowersj2 5526: =over 4
5527:
5528: =item * $title, A title to be displayed on the page.
5529:
5530: =item * $function, the current role (can be undef).
5531:
5532: =item * $addentries, extra parameters for the <body> tag.
5533:
5534: =item * $bodyonly, if defined, only return the <body> tag.
5535:
5536: =item * $domain, if defined, force a given domain.
5537:
5538: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5539: text interface only)
1.60 matthew 5540:
1.814 bisitz 5541: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5542: navigational links
1.317 albertel 5543:
1.338 albertel 5544: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5545:
1.1075.2.12 raeburn 5546: =item * $no_inline_link, if true and in remote mode, don't show the
5547: 'Switch To Inline Menu' link
5548:
1.460 albertel 5549: =item * $args, optional argument valid values are
5550: no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133 raeburn 5551: use_absolute -> for external resource or syllabus, this will
5552: contain https://<hostname> if server uses
5553: https (as per hosts.tab), but request is for http
5554: hostname -> hostname, from $r->hostname().
1.460 albertel 5555:
1.1075.2.15 raeburn 5556: =item * $advtoolsref, optional argument, ref to an array containing
5557: inlineremote items to be added in "Functions" menu below
5558: breadcrumbs.
5559:
1.112 bowersj2 5560: =back
5561:
1.60 matthew 5562: Returns: A uniform header for LON-CAPA web pages.
5563: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5564: If $bodyonly is undef or zero, an html string containing a <body> tag and
5565: other decorations will be returned.
5566:
5567: =cut
5568:
1.54 www 5569: sub bodytag {
1.831 bisitz 5570: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15 raeburn 5571: $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339 albertel 5572:
1.954 raeburn 5573: my $public;
5574: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5575: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5576: $public = 1;
5577: }
1.460 albertel 5578: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52 raeburn 5579: my $httphost = $args->{'use_absolute'};
1.1075.2.133 raeburn 5580: my $hostname = $args->{'hostname'};
1.339 albertel 5581:
1.183 matthew 5582: $function = &get_users_function() if (!$function);
1.339 albertel 5583: my $img = &designparm($function.'.img',$domain);
5584: my $font = &designparm($function.'.font',$domain);
5585: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5586:
1.803 bisitz 5587: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5588: 'bgcolor' => $pgbg,
1.339 albertel 5589: 'text' => $font,
5590: 'alink' => &designparm($function.'.alink',$domain),
5591: 'vlink' => &designparm($function.'.vlink',$domain),
5592: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5593: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5594:
1.63 www 5595: # role and realm
1.1075.2.68 raeburn 5596: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5597: if ($realm) {
5598: $realm = '/'.$realm;
5599: }
1.378 raeburn 5600: if ($role eq 'ca') {
1.479 albertel 5601: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5602: $realm = &plainname($rname,$rdom);
1.378 raeburn 5603: }
1.55 www 5604: # realm
1.258 albertel 5605: if ($env{'request.course.id'}) {
1.378 raeburn 5606: if ($env{'request.role'} !~ /^cr/) {
5607: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115 raeburn 5608: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121 raeburn 5609: if ($env{'request.role.desc'}) {
5610: $role = $env{'request.role.desc'};
5611: } else {
5612: $role = &mt('Helpdesk[_1]',' '.$2);
5613: }
1.1075.2.115 raeburn 5614: } else {
5615: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 5616: }
1.898 raeburn 5617: if ($env{'request.course.sec'}) {
5618: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5619: }
1.359 albertel 5620: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5621: } else {
5622: $role = &Apache::lonnet::plaintext($role);
1.54 www 5623: }
1.433 albertel 5624:
1.359 albertel 5625: if (!$realm) { $realm=' '; }
1.330 albertel 5626:
1.438 albertel 5627: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5628:
1.101 www 5629: # construct main body tag
1.359 albertel 5630: my $bodytag = "<body $extra_body_attr>".
1.1075.2.100 raeburn 5631: &Apache::lontexconvert::init_math_support();
1.252 albertel 5632:
1.1075.2.38 raeburn 5633: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5634:
5635: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5636: return $bodytag;
1.1075.2.38 raeburn 5637: }
1.359 albertel 5638:
1.954 raeburn 5639: if ($public) {
1.433 albertel 5640: undef($role);
5641: }
1.359 albertel 5642:
1.762 bisitz 5643: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5644: #
5645: # Extra info if you are the DC
5646: my $dc_info = '';
5647: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5648: $env{'course.'.$env{'request.course.id'}.
5649: '.domain'}.'/'})) {
5650: my $cid = $env{'request.course.id'};
1.917 raeburn 5651: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5652: $dc_info =~ s/\s+$//;
1.359 albertel 5653: }
5654:
1.1075.2.108 raeburn 5655: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903 droeschl 5656:
1.1075.2.13 raeburn 5657: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5658:
1.1075.2.38 raeburn 5659:
5660:
1.1075.2.21 raeburn 5661: my $funclist;
5662: if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52 raeburn 5663: $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21 raeburn 5664: Apache::lonmenu::serverform();
5665: my $forbodytag;
5666: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5667: $forcereg,$args->{'group'},
5668: $args->{'bread_crumbs'},
1.1075.2.133 raeburn 5669: $advtoolsref,'','',\$forbodytag);
1.1075.2.21 raeburn 5670: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5671: $funclist = $forbodytag;
5672: }
5673: } else {
1.903 droeschl 5674:
5675: # if ($env{'request.state'} eq 'construct') {
5676: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5677: # }
5678:
1.1075.2.38 raeburn 5679: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 5680: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 5681:
1.1075.2.38 raeburn 5682: my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2 raeburn 5683:
1.916 droeschl 5684: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22 raeburn 5685: if ($dc_info) {
5686: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1 raeburn 5687: }
1.1075.2.38 raeburn 5688: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22 raeburn 5689: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5690: return $bodytag;
5691: }
1.894 droeschl 5692:
1.927 raeburn 5693: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38 raeburn 5694: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5695: }
1.916 droeschl 5696:
1.1075.2.38 raeburn 5697: $bodytag .= $right;
1.852 droeschl 5698:
1.917 raeburn 5699: if ($dc_info) {
5700: $dc_info = &dc_courseid_toggle($dc_info);
5701: }
5702: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5703:
1.1075.2.61 raeburn 5704: #if directed to not display the secondary menu, don't.
5705: if ($args->{'no_secondary_menu'}) {
5706: return $bodytag;
5707: }
1.903 droeschl 5708: #don't show menus for public users
1.954 raeburn 5709: if (!$public){
1.1075.2.52 raeburn 5710: $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903 droeschl 5711: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 5712: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
5713: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 5714: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133 raeburn 5715: $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116 raeburn 5716: } elsif ($forcereg) {
1.1075.2.22 raeburn 5717: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116 raeburn 5718: $args->{'group'},
1.1075.2.133 raeburn 5719: $args->{'hide_buttons',
5720: $hostname});
1.1075.2.15 raeburn 5721: } else {
1.1075.2.21 raeburn 5722: my $forbodytag;
5723: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
5724: $forcereg,$args->{'group'},
5725: $args->{'bread_crumbs'},
1.1075.2.133 raeburn 5726: $advtoolsref,'',$hostname,
5727: \$forbodytag);
1.1075.2.21 raeburn 5728: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
5729: $bodytag .= $forbodytag;
5730: }
1.920 raeburn 5731: }
1.903 droeschl 5732: }else{
5733: # this is to seperate menu from content when there's no secondary
5734: # menu. Especially needed for public accessible ressources.
5735: $bodytag .= '<hr style="clear:both" />';
5736: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 5737: }
1.903 droeschl 5738:
1.235 raeburn 5739: return $bodytag;
1.1075.2.12 raeburn 5740: }
5741:
5742: #
5743: # Top frame rendering, Remote is up
5744: #
5745:
5746: my $imgsrc = $img;
5747: if ($img =~ /^\/adm/) {
5748: $imgsrc = &lonhttpdurl($img);
5749: }
5750: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
5751:
1.1075.2.60 raeburn 5752: my $help=($no_inline_link?''
5753: :&Apache::loncommon::top_nav_help('Help'));
5754:
1.1075.2.12 raeburn 5755: # Explicit link to get inline menu
5756: my $menu= ($no_inline_link?''
5757: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
5758:
5759: if ($dc_info) {
5760: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
5761: }
5762:
1.1075.2.38 raeburn 5763: my $name = &plainname($env{'user.name'},$env{'user.domain'});
5764: unless ($public) {
5765: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
5766: undef,'LC_menubuttons_link');
5767: }
5768:
1.1075.2.12 raeburn 5769: unless ($env{'form.inhibitmenu'}) {
5770: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38 raeburn 5771: <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60 raeburn 5772: <li>$help</li>
1.1075.2.12 raeburn 5773: <li>$menu</li>
5774: </ol><div id="LC_realm"> $realm $dc_info</div>|;
5775: }
1.1075.2.13 raeburn 5776: if ($env{'request.state'} eq 'construct') {
5777: if (!$public){
5778: if ($env{'request.state'} eq 'construct') {
5779: $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 5780: &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13 raeburn 5781: &Apache::lonhtmlcommon::scripttag('','end').
5782: &Apache::lonmenu::innerregister($forcereg,
5783: $args->{'bread_crumbs'});
5784: }
5785: }
5786: }
1.1075.2.21 raeburn 5787: return $bodytag."\n".$funclist;
1.182 matthew 5788: }
5789:
1.917 raeburn 5790: sub dc_courseid_toggle {
5791: my ($dc_info) = @_;
1.980 raeburn 5792: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 5793: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 5794: &mt('(More ...)').'</a></span>'.
5795: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
5796: }
5797:
1.330 albertel 5798: sub make_attr_string {
5799: my ($register,$attr_ref) = @_;
5800:
5801: if ($attr_ref && !ref($attr_ref)) {
5802: die("addentries Must be a hash ref ".
5803: join(':',caller(1))." ".
5804: join(':',caller(0))." ");
5805: }
5806:
5807: if ($register) {
1.339 albertel 5808: my ($on_load,$on_unload);
5809: foreach my $key (keys(%{$attr_ref})) {
5810: if (lc($key) eq 'onload') {
5811: $on_load.=$attr_ref->{$key}.';';
5812: delete($attr_ref->{$key});
5813:
5814: } elsif (lc($key) eq 'onunload') {
5815: $on_unload.=$attr_ref->{$key}.';';
5816: delete($attr_ref->{$key});
5817: }
5818: }
1.1075.2.12 raeburn 5819: if ($env{'environment.remote'} eq 'on') {
5820: $attr_ref->{'onload'} =
5821: &Apache::lonmenu::loadevents(). $on_load;
5822: $attr_ref->{'onunload'}=
5823: &Apache::lonmenu::unloadevents().$on_unload;
5824: } else {
5825: $attr_ref->{'onload'} = $on_load;
5826: $attr_ref->{'onunload'}= $on_unload;
5827: }
1.330 albertel 5828: }
1.339 albertel 5829:
1.330 albertel 5830: my $attr_string;
1.1075.2.56 raeburn 5831: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 5832: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
5833: }
5834: return $attr_string;
5835: }
5836:
5837:
1.182 matthew 5838: ###############################################
1.251 albertel 5839: ###############################################
5840:
5841: =pod
5842:
5843: =item * &endbodytag()
5844:
5845: Returns a uniform footer for LON-CAPA web pages.
5846:
1.635 raeburn 5847: Inputs: 1 - optional reference to an args hash
5848: If in the hash, key for noredirectlink has a value which evaluates to true,
5849: a 'Continue' link is not displayed if the page contains an
5850: internal redirect in the <head></head> section,
5851: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 5852:
5853: =cut
5854:
5855: sub endbodytag {
1.635 raeburn 5856: my ($args) = @_;
1.1075.2.6 raeburn 5857: my $endbodytag;
5858: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
5859: $endbodytag='</body>';
5860: }
1.315 albertel 5861: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 5862: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
5863: $endbodytag=
5864: "<br /><a href=\"$env{'internal.head.redirect'}\">".
5865: &mt('Continue').'</a>'.
5866: $endbodytag;
5867: }
1.315 albertel 5868: }
1.251 albertel 5869: return $endbodytag;
5870: }
5871:
1.352 albertel 5872: =pod
5873:
5874: =item * &standard_css()
5875:
5876: Returns a style sheet
5877:
5878: Inputs: (all optional)
5879: domain -> force to color decorate a page for a specific
5880: domain
5881: function -> force usage of a specific rolish color scheme
5882: bgcolor -> override the default page bgcolor
5883:
5884: =cut
5885:
1.343 albertel 5886: sub standard_css {
1.345 albertel 5887: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 5888: $function = &get_users_function() if (!$function);
5889: my $img = &designparm($function.'.img', $domain);
5890: my $tabbg = &designparm($function.'.tabbg', $domain);
5891: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 5892: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 5893: #second colour for later usage
1.345 albertel 5894: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 5895: my $pgbg_or_bgcolor =
5896: $bgcolor ||
1.352 albertel 5897: &designparm($function.'.pgbg', $domain);
1.382 albertel 5898: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 5899: my $alink = &designparm($function.'.alink', $domain);
5900: my $vlink = &designparm($function.'.vlink', $domain);
5901: my $link = &designparm($function.'.link', $domain);
5902:
1.602 albertel 5903: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 5904: my $mono = 'monospace';
1.850 bisitz 5905: my $data_table_head = $sidebg;
5906: my $data_table_light = '#FAFAFA';
1.1060 bisitz 5907: my $data_table_dark = '#E0E0E0';
1.470 banghart 5908: my $data_table_darker = '#CCCCCC';
1.349 albertel 5909: my $data_table_highlight = '#FFFF00';
1.352 albertel 5910: my $mail_new = '#FFBB77';
5911: my $mail_new_hover = '#DD9955';
5912: my $mail_read = '#BBBB77';
5913: my $mail_read_hover = '#999944';
5914: my $mail_replied = '#AAAA88';
5915: my $mail_replied_hover = '#888855';
5916: my $mail_other = '#99BBBB';
5917: my $mail_other_hover = '#669999';
1.391 albertel 5918: my $table_header = '#DDDDDD';
1.489 raeburn 5919: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 5920: my $lg_border_color = '#C8C8C8';
1.952 onken 5921: my $button_hover = '#BF2317';
1.392 albertel 5922:
1.608 albertel 5923: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 5924: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
5925: : '0 3px 0 4px';
1.448 albertel 5926:
1.523 albertel 5927:
1.343 albertel 5928: return <<END;
1.947 droeschl 5929:
5930: /* needed for iframe to allow 100% height in FF */
5931: body, html {
5932: margin: 0;
5933: padding: 0 0.5%;
5934: height: 99%; /* to avoid scrollbars */
5935: }
5936:
1.795 www 5937: body {
1.911 bisitz 5938: font-family: $sans;
5939: line-height:130%;
5940: font-size:0.83em;
5941: color:$font;
1.795 www 5942: }
5943:
1.959 onken 5944: a:focus,
5945: a:focus img {
1.795 www 5946: color: red;
5947: }
1.698 harmsja 5948:
1.911 bisitz 5949: form, .inline {
5950: display: inline;
1.795 www 5951: }
1.721 harmsja 5952:
1.795 www 5953: .LC_right {
1.911 bisitz 5954: text-align:right;
1.795 www 5955: }
5956:
5957: .LC_middle {
1.911 bisitz 5958: vertical-align:middle;
1.795 www 5959: }
1.721 harmsja 5960:
1.1075.2.38 raeburn 5961: .LC_floatleft {
5962: float: left;
5963: }
5964:
5965: .LC_floatright {
5966: float: right;
5967: }
5968:
1.911 bisitz 5969: .LC_400Box {
5970: width:400px;
5971: }
1.721 harmsja 5972:
1.947 droeschl 5973: .LC_iframecontainer {
5974: width: 98%;
5975: margin: 0;
5976: position: fixed;
5977: top: 8.5em;
5978: bottom: 0;
5979: }
5980:
5981: .LC_iframecontainer iframe{
5982: border: none;
5983: width: 100%;
5984: height: 100%;
5985: }
5986:
1.778 bisitz 5987: .LC_filename {
5988: font-family: $mono;
5989: white-space:pre;
1.921 bisitz 5990: font-size: 120%;
1.778 bisitz 5991: }
5992:
5993: .LC_fileicon {
5994: border: none;
5995: height: 1.3em;
5996: vertical-align: text-bottom;
5997: margin-right: 0.3em;
5998: text-decoration:none;
5999: }
6000:
1.1008 www 6001: .LC_setting {
6002: text-decoration:underline;
6003: }
6004:
1.350 albertel 6005: .LC_error {
6006: color: red;
6007: }
1.795 www 6008:
1.1075.2.15 raeburn 6009: .LC_warning {
6010: color: darkorange;
6011: }
6012:
1.457 albertel 6013: .LC_diff_removed {
1.733 bisitz 6014: color: red;
1.394 albertel 6015: }
1.532 albertel 6016:
6017: .LC_info,
1.457 albertel 6018: .LC_success,
6019: .LC_diff_added {
1.350 albertel 6020: color: green;
6021: }
1.795 www 6022:
1.802 bisitz 6023: div.LC_confirm_box {
6024: background-color: #FAFAFA;
6025: border: 1px solid $lg_border_color;
6026: margin-right: 0;
6027: padding: 5px;
6028: }
6029:
6030: div.LC_confirm_box .LC_error img,
6031: div.LC_confirm_box .LC_success img {
6032: vertical-align: middle;
6033: }
6034:
1.1075.2.108 raeburn 6035: .LC_maxwidth {
6036: max-width: 100%;
6037: height: auto;
6038: }
6039:
6040: .LC_textsize_mobile {
6041: \@media only screen and (max-device-width: 480px) {
6042: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6043: }
6044: }
6045:
1.440 albertel 6046: .LC_icon {
1.771 droeschl 6047: border: none;
1.790 droeschl 6048: vertical-align: middle;
1.771 droeschl 6049: }
6050:
1.543 albertel 6051: .LC_docs_spacer {
6052: width: 25px;
6053: height: 1px;
1.771 droeschl 6054: border: none;
1.543 albertel 6055: }
1.346 albertel 6056:
1.532 albertel 6057: .LC_internal_info {
1.735 bisitz 6058: color: #999999;
1.532 albertel 6059: }
6060:
1.794 www 6061: .LC_discussion {
1.1050 www 6062: background: $data_table_dark;
1.911 bisitz 6063: border: 1px solid black;
6064: margin: 2px;
1.794 www 6065: }
6066:
6067: .LC_disc_action_left {
1.1050 www 6068: background: $sidebg;
1.911 bisitz 6069: text-align: left;
1.1050 www 6070: padding: 4px;
6071: margin: 2px;
1.794 www 6072: }
6073:
6074: .LC_disc_action_right {
1.1050 www 6075: background: $sidebg;
1.911 bisitz 6076: text-align: right;
1.1050 www 6077: padding: 4px;
6078: margin: 2px;
1.794 www 6079: }
6080:
6081: .LC_disc_new_item {
1.911 bisitz 6082: background: white;
6083: border: 2px solid red;
1.1050 www 6084: margin: 4px;
6085: padding: 4px;
1.794 www 6086: }
6087:
6088: .LC_disc_old_item {
1.911 bisitz 6089: background: white;
1.1050 www 6090: margin: 4px;
6091: padding: 4px;
1.794 www 6092: }
6093:
1.458 albertel 6094: table.LC_pastsubmission {
6095: border: 1px solid black;
6096: margin: 2px;
6097: }
6098:
1.924 bisitz 6099: table#LC_menubuttons {
1.345 albertel 6100: width: 100%;
6101: background: $pgbg;
1.392 albertel 6102: border: 2px;
1.402 albertel 6103: border-collapse: separate;
1.803 bisitz 6104: padding: 0;
1.345 albertel 6105: }
1.392 albertel 6106:
1.801 tempelho 6107: table#LC_title_bar a {
6108: color: $fontmenu;
6109: }
1.836 bisitz 6110:
1.807 droeschl 6111: table#LC_title_bar {
1.819 tempelho 6112: clear: both;
1.836 bisitz 6113: display: none;
1.807 droeschl 6114: }
6115:
1.795 www 6116: table#LC_title_bar,
1.933 droeschl 6117: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6118: table#LC_title_bar.LC_with_remote {
1.359 albertel 6119: width: 100%;
1.392 albertel 6120: border-color: $pgbg;
6121: border-style: solid;
6122: border-width: $border;
1.379 albertel 6123: background: $pgbg;
1.801 tempelho 6124: color: $fontmenu;
1.392 albertel 6125: border-collapse: collapse;
1.803 bisitz 6126: padding: 0;
1.819 tempelho 6127: margin: 0;
1.359 albertel 6128: }
1.795 www 6129:
1.933 droeschl 6130: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6131: margin: 0;
6132: padding: 0;
1.933 droeschl 6133: position: relative;
6134: list-style: none;
1.913 droeschl 6135: }
1.933 droeschl 6136: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6137: display: inline;
6138: }
1.933 droeschl 6139:
6140: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6141: padding: 0;
1.933 droeschl 6142: margin: 0;
6143: float: left;
1.913 droeschl 6144: }
1.933 droeschl 6145: .LC_breadcrumb_tools_tools {
6146: padding: 0;
6147: margin: 0;
1.913 droeschl 6148: float: right;
6149: }
6150:
1.359 albertel 6151: table#LC_title_bar td {
6152: background: $tabbg;
6153: }
1.795 www 6154:
1.911 bisitz 6155: table#LC_menubuttons img {
1.803 bisitz 6156: border: none;
1.346 albertel 6157: }
1.795 www 6158:
1.842 droeschl 6159: .LC_breadcrumbs_component {
1.911 bisitz 6160: float: right;
6161: margin: 0 1em;
1.357 albertel 6162: }
1.842 droeschl 6163: .LC_breadcrumbs_component img {
1.911 bisitz 6164: vertical-align: middle;
1.777 tempelho 6165: }
1.795 www 6166:
1.1075.2.108 raeburn 6167: .LC_breadcrumbs_hoverable {
6168: background: $sidebg;
6169: }
6170:
1.383 albertel 6171: td.LC_table_cell_checkbox {
6172: text-align: center;
6173: }
1.795 www 6174:
6175: .LC_fontsize_small {
1.911 bisitz 6176: font-size: 70%;
1.705 tempelho 6177: }
6178:
1.844 bisitz 6179: #LC_breadcrumbs {
1.911 bisitz 6180: clear:both;
6181: background: $sidebg;
6182: border-bottom: 1px solid $lg_border_color;
6183: line-height: 2.5em;
1.933 droeschl 6184: overflow: hidden;
1.911 bisitz 6185: margin: 0;
6186: padding: 0;
1.995 raeburn 6187: text-align: left;
1.819 tempelho 6188: }
1.862 bisitz 6189:
1.1075.2.16 raeburn 6190: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 6191: clear:both;
6192: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 6193: border: 1px solid $sidebg;
1.1075.2.16 raeburn 6194: margin: 0 0 10px 0;
1.966 bisitz 6195: padding: 3px;
1.995 raeburn 6196: text-align: left;
1.822 bisitz 6197: }
6198:
1.795 www 6199: .LC_fontsize_medium {
1.911 bisitz 6200: font-size: 85%;
1.705 tempelho 6201: }
6202:
1.795 www 6203: .LC_fontsize_large {
1.911 bisitz 6204: font-size: 120%;
1.705 tempelho 6205: }
6206:
1.346 albertel 6207: .LC_menubuttons_inline_text {
6208: color: $font;
1.698 harmsja 6209: font-size: 90%;
1.701 harmsja 6210: padding-left:3px;
1.346 albertel 6211: }
6212:
1.934 droeschl 6213: .LC_menubuttons_inline_text img{
6214: vertical-align: middle;
6215: }
6216:
1.1051 www 6217: li.LC_menubuttons_inline_text img {
1.951 onken 6218: cursor:pointer;
1.1002 droeschl 6219: text-decoration: none;
1.951 onken 6220: }
6221:
1.526 www 6222: .LC_menubuttons_link {
6223: text-decoration: none;
6224: }
1.795 www 6225:
1.522 albertel 6226: .LC_menubuttons_category {
1.521 www 6227: color: $font;
1.526 www 6228: background: $pgbg;
1.521 www 6229: font-size: larger;
6230: font-weight: bold;
6231: }
6232:
1.346 albertel 6233: td.LC_menubuttons_text {
1.911 bisitz 6234: color: $font;
1.346 albertel 6235: }
1.706 harmsja 6236:
1.346 albertel 6237: .LC_current_location {
6238: background: $tabbg;
6239: }
1.795 www 6240:
1.1075.2.134 raeburn 6241: td.LC_zero_height {
6242: line-height: 0;
6243: cellpadding: 0;
6244: }
6245:
1.938 bisitz 6246: table.LC_data_table {
1.347 albertel 6247: border: 1px solid #000000;
1.402 albertel 6248: border-collapse: separate;
1.426 albertel 6249: border-spacing: 1px;
1.610 albertel 6250: background: $pgbg;
1.347 albertel 6251: }
1.795 www 6252:
1.422 albertel 6253: .LC_data_table_dense {
6254: font-size: small;
6255: }
1.795 www 6256:
1.507 raeburn 6257: table.LC_nested_outer {
6258: border: 1px solid #000000;
1.589 raeburn 6259: border-collapse: collapse;
1.803 bisitz 6260: border-spacing: 0;
1.507 raeburn 6261: width: 100%;
6262: }
1.795 www 6263:
1.879 raeburn 6264: table.LC_innerpickbox,
1.507 raeburn 6265: table.LC_nested {
1.803 bisitz 6266: border: none;
1.589 raeburn 6267: border-collapse: collapse;
1.803 bisitz 6268: border-spacing: 0;
1.507 raeburn 6269: width: 100%;
6270: }
1.795 www 6271:
1.911 bisitz 6272: table.LC_data_table tr th,
6273: table.LC_calendar tr th,
1.879 raeburn 6274: table.LC_prior_tries tr th,
6275: table.LC_innerpickbox tr th {
1.349 albertel 6276: font-weight: bold;
6277: background-color: $data_table_head;
1.801 tempelho 6278: color:$fontmenu;
1.701 harmsja 6279: font-size:90%;
1.347 albertel 6280: }
1.795 www 6281:
1.879 raeburn 6282: table.LC_innerpickbox tr th,
6283: table.LC_innerpickbox tr td {
6284: vertical-align: top;
6285: }
6286:
1.711 raeburn 6287: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6288: background-color: #CCCCCC;
1.711 raeburn 6289: font-weight: bold;
6290: text-align: left;
6291: }
1.795 www 6292:
1.912 bisitz 6293: table.LC_data_table tr.LC_odd_row > td {
6294: background-color: $data_table_light;
6295: padding: 2px;
6296: vertical-align: top;
6297: }
6298:
1.809 bisitz 6299: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6300: background-color: $data_table_light;
1.912 bisitz 6301: vertical-align: top;
6302: }
6303:
6304: table.LC_data_table tr.LC_even_row > td {
6305: background-color: $data_table_dark;
1.425 albertel 6306: padding: 2px;
1.900 bisitz 6307: vertical-align: top;
1.347 albertel 6308: }
1.795 www 6309:
1.809 bisitz 6310: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6311: background-color: $data_table_dark;
1.900 bisitz 6312: vertical-align: top;
1.347 albertel 6313: }
1.795 www 6314:
1.425 albertel 6315: table.LC_data_table tr.LC_data_table_highlight td {
6316: background-color: $data_table_darker;
6317: }
1.795 www 6318:
1.639 raeburn 6319: table.LC_data_table tr td.LC_leftcol_header {
6320: background-color: $data_table_head;
6321: font-weight: bold;
6322: }
1.795 www 6323:
1.451 albertel 6324: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6325: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6326: font-weight: bold;
6327: font-style: italic;
6328: text-align: center;
6329: padding: 8px;
1.347 albertel 6330: }
1.795 www 6331:
1.1075.2.30 raeburn 6332: table.LC_data_table tr.LC_empty_row td,
6333: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6334: background-color: $sidebg;
6335: }
6336:
6337: table.LC_nested tr.LC_empty_row td {
6338: background-color: #FFFFFF;
6339: }
6340:
1.890 droeschl 6341: table.LC_caption {
6342: }
6343:
1.507 raeburn 6344: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6345: padding: 4ex
6346: }
1.795 www 6347:
1.507 raeburn 6348: table.LC_nested_outer tr th {
6349: font-weight: bold;
1.801 tempelho 6350: color:$fontmenu;
1.507 raeburn 6351: background-color: $data_table_head;
1.701 harmsja 6352: font-size: small;
1.507 raeburn 6353: border-bottom: 1px solid #000000;
6354: }
1.795 www 6355:
1.507 raeburn 6356: table.LC_nested_outer tr td.LC_subheader {
6357: background-color: $data_table_head;
6358: font-weight: bold;
6359: font-size: small;
6360: border-bottom: 1px solid #000000;
6361: text-align: right;
1.451 albertel 6362: }
1.795 www 6363:
1.507 raeburn 6364: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6365: background-color: #CCCCCC;
1.451 albertel 6366: font-weight: bold;
6367: font-size: small;
1.507 raeburn 6368: text-align: center;
6369: }
1.795 www 6370:
1.589 raeburn 6371: table.LC_nested tr.LC_info_row td.LC_left_item,
6372: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6373: text-align: left;
1.451 albertel 6374: }
1.795 www 6375:
1.507 raeburn 6376: table.LC_nested td {
1.735 bisitz 6377: background-color: #FFFFFF;
1.451 albertel 6378: font-size: small;
1.507 raeburn 6379: }
1.795 www 6380:
1.507 raeburn 6381: table.LC_nested_outer tr th.LC_right_item,
6382: table.LC_nested tr.LC_info_row td.LC_right_item,
6383: table.LC_nested tr.LC_odd_row td.LC_right_item,
6384: table.LC_nested tr td.LC_right_item {
1.451 albertel 6385: text-align: right;
6386: }
6387:
1.507 raeburn 6388: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6389: background-color: #EEEEEE;
1.451 albertel 6390: }
6391:
1.473 raeburn 6392: table.LC_createuser {
6393: }
6394:
6395: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6396: font-size: small;
1.473 raeburn 6397: }
6398:
6399: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6400: background-color: #CCCCCC;
1.473 raeburn 6401: font-weight: bold;
6402: text-align: center;
6403: }
6404:
1.349 albertel 6405: table.LC_calendar {
6406: border: 1px solid #000000;
6407: border-collapse: collapse;
1.917 raeburn 6408: width: 98%;
1.349 albertel 6409: }
1.795 www 6410:
1.349 albertel 6411: table.LC_calendar_pickdate {
6412: font-size: xx-small;
6413: }
1.795 www 6414:
1.349 albertel 6415: table.LC_calendar tr td {
6416: border: 1px solid #000000;
6417: vertical-align: top;
1.917 raeburn 6418: width: 14%;
1.349 albertel 6419: }
1.795 www 6420:
1.349 albertel 6421: table.LC_calendar tr td.LC_calendar_day_empty {
6422: background-color: $data_table_dark;
6423: }
1.795 www 6424:
1.779 bisitz 6425: table.LC_calendar tr td.LC_calendar_day_current {
6426: background-color: $data_table_highlight;
1.777 tempelho 6427: }
1.795 www 6428:
1.938 bisitz 6429: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6430: background-color: $mail_new;
6431: }
1.795 www 6432:
1.938 bisitz 6433: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6434: background-color: $mail_new_hover;
6435: }
1.795 www 6436:
1.938 bisitz 6437: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6438: background-color: $mail_read;
6439: }
1.795 www 6440:
1.938 bisitz 6441: /*
6442: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6443: background-color: $mail_read_hover;
6444: }
1.938 bisitz 6445: */
1.795 www 6446:
1.938 bisitz 6447: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6448: background-color: $mail_replied;
6449: }
1.795 www 6450:
1.938 bisitz 6451: /*
6452: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6453: background-color: $mail_replied_hover;
6454: }
1.938 bisitz 6455: */
1.795 www 6456:
1.938 bisitz 6457: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6458: background-color: $mail_other;
6459: }
1.795 www 6460:
1.938 bisitz 6461: /*
6462: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6463: background-color: $mail_other_hover;
6464: }
1.938 bisitz 6465: */
1.494 raeburn 6466:
1.777 tempelho 6467: table.LC_data_table tr > td.LC_browser_file,
6468: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6469: background: #AAEE77;
1.389 albertel 6470: }
1.795 www 6471:
1.777 tempelho 6472: table.LC_data_table tr > td.LC_browser_file_locked,
6473: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6474: background: #FFAA99;
1.387 albertel 6475: }
1.795 www 6476:
1.777 tempelho 6477: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6478: background: #888888;
1.779 bisitz 6479: }
1.795 www 6480:
1.777 tempelho 6481: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6482: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6483: background: #F8F866;
1.777 tempelho 6484: }
1.795 www 6485:
1.696 bisitz 6486: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6487: background: #E0E8FF;
1.387 albertel 6488: }
1.696 bisitz 6489:
1.707 bisitz 6490: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6491: /* background: #77FF77; */
1.707 bisitz 6492: }
1.795 www 6493:
1.707 bisitz 6494: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6495: border-right: 8px solid #FFFF77;
1.707 bisitz 6496: }
1.795 www 6497:
1.707 bisitz 6498: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6499: border-right: 8px solid #FFAA77;
1.707 bisitz 6500: }
1.795 www 6501:
1.707 bisitz 6502: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6503: border-right: 8px solid #FF7777;
1.707 bisitz 6504: }
1.795 www 6505:
1.707 bisitz 6506: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6507: border-right: 8px solid #AAFF77;
1.707 bisitz 6508: }
1.795 www 6509:
1.707 bisitz 6510: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6511: border-right: 8px solid #11CC55;
1.707 bisitz 6512: }
6513:
1.388 albertel 6514: span.LC_current_location {
1.701 harmsja 6515: font-size:larger;
1.388 albertel 6516: background: $pgbg;
6517: }
1.387 albertel 6518:
1.1029 www 6519: span.LC_current_nav_location {
6520: font-weight:bold;
6521: background: $sidebg;
6522: }
6523:
1.395 albertel 6524: span.LC_parm_menu_item {
6525: font-size: larger;
6526: }
1.795 www 6527:
1.395 albertel 6528: span.LC_parm_scope_all {
6529: color: red;
6530: }
1.795 www 6531:
1.395 albertel 6532: span.LC_parm_scope_folder {
6533: color: green;
6534: }
1.795 www 6535:
1.395 albertel 6536: span.LC_parm_scope_resource {
6537: color: orange;
6538: }
1.795 www 6539:
1.395 albertel 6540: span.LC_parm_part {
6541: color: blue;
6542: }
1.795 www 6543:
1.911 bisitz 6544: span.LC_parm_folder,
6545: span.LC_parm_symb {
1.395 albertel 6546: font-size: x-small;
6547: font-family: $mono;
6548: color: #AAAAAA;
6549: }
6550:
1.977 bisitz 6551: ul.LC_parm_parmlist li {
6552: display: inline-block;
6553: padding: 0.3em 0.8em;
6554: vertical-align: top;
6555: width: 150px;
6556: border-top:1px solid $lg_border_color;
6557: }
6558:
1.795 www 6559: td.LC_parm_overview_level_menu,
6560: td.LC_parm_overview_map_menu,
6561: td.LC_parm_overview_parm_selectors,
6562: td.LC_parm_overview_restrictions {
1.396 albertel 6563: border: 1px solid black;
6564: border-collapse: collapse;
6565: }
1.795 www 6566:
1.396 albertel 6567: table.LC_parm_overview_restrictions td {
6568: border-width: 1px 4px 1px 4px;
6569: border-style: solid;
6570: border-color: $pgbg;
6571: text-align: center;
6572: }
1.795 www 6573:
1.396 albertel 6574: table.LC_parm_overview_restrictions th {
6575: background: $tabbg;
6576: border-width: 1px 4px 1px 4px;
6577: border-style: solid;
6578: border-color: $pgbg;
6579: }
1.795 www 6580:
1.398 albertel 6581: table#LC_helpmenu {
1.803 bisitz 6582: border: none;
1.398 albertel 6583: height: 55px;
1.803 bisitz 6584: border-spacing: 0;
1.398 albertel 6585: }
6586:
6587: table#LC_helpmenu fieldset legend {
6588: font-size: larger;
6589: }
1.795 www 6590:
1.397 albertel 6591: table#LC_helpmenu_links {
6592: width: 100%;
6593: border: 1px solid black;
6594: background: $pgbg;
1.803 bisitz 6595: padding: 0;
1.397 albertel 6596: border-spacing: 1px;
6597: }
1.795 www 6598:
1.397 albertel 6599: table#LC_helpmenu_links tr td {
6600: padding: 1px;
6601: background: $tabbg;
1.399 albertel 6602: text-align: center;
6603: font-weight: bold;
1.397 albertel 6604: }
1.396 albertel 6605:
1.795 www 6606: table#LC_helpmenu_links a:link,
6607: table#LC_helpmenu_links a:visited,
1.397 albertel 6608: table#LC_helpmenu_links a:active {
6609: text-decoration: none;
6610: color: $font;
6611: }
1.795 www 6612:
1.397 albertel 6613: table#LC_helpmenu_links a:hover {
6614: text-decoration: underline;
6615: color: $vlink;
6616: }
1.396 albertel 6617:
1.417 albertel 6618: .LC_chrt_popup_exists {
6619: border: 1px solid #339933;
6620: margin: -1px;
6621: }
1.795 www 6622:
1.417 albertel 6623: .LC_chrt_popup_up {
6624: border: 1px solid yellow;
6625: margin: -1px;
6626: }
1.795 www 6627:
1.417 albertel 6628: .LC_chrt_popup {
6629: border: 1px solid #8888FF;
6630: background: #CCCCFF;
6631: }
1.795 www 6632:
1.421 albertel 6633: table.LC_pick_box {
6634: border-collapse: separate;
6635: background: white;
6636: border: 1px solid black;
6637: border-spacing: 1px;
6638: }
1.795 www 6639:
1.421 albertel 6640: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6641: background: $sidebg;
1.421 albertel 6642: font-weight: bold;
1.900 bisitz 6643: text-align: left;
1.740 bisitz 6644: vertical-align: top;
1.421 albertel 6645: width: 184px;
6646: padding: 8px;
6647: }
1.795 www 6648:
1.579 raeburn 6649: table.LC_pick_box td.LC_pick_box_value {
6650: text-align: left;
6651: padding: 8px;
6652: }
1.795 www 6653:
1.579 raeburn 6654: table.LC_pick_box td.LC_pick_box_select {
6655: text-align: left;
6656: padding: 8px;
6657: }
1.795 www 6658:
1.424 albertel 6659: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6660: padding: 0;
1.421 albertel 6661: height: 1px;
6662: background: black;
6663: }
1.795 www 6664:
1.421 albertel 6665: table.LC_pick_box td.LC_pick_box_submit {
6666: text-align: right;
6667: }
1.795 www 6668:
1.579 raeburn 6669: table.LC_pick_box td.LC_evenrow_value {
6670: text-align: left;
6671: padding: 8px;
6672: background-color: $data_table_light;
6673: }
1.795 www 6674:
1.579 raeburn 6675: table.LC_pick_box td.LC_oddrow_value {
6676: text-align: left;
6677: padding: 8px;
6678: background-color: $data_table_light;
6679: }
1.795 www 6680:
1.579 raeburn 6681: span.LC_helpform_receipt_cat {
6682: font-weight: bold;
6683: }
1.795 www 6684:
1.424 albertel 6685: table.LC_group_priv_box {
6686: background: white;
6687: border: 1px solid black;
6688: border-spacing: 1px;
6689: }
1.795 www 6690:
1.424 albertel 6691: table.LC_group_priv_box td.LC_pick_box_title {
6692: background: $tabbg;
6693: font-weight: bold;
6694: text-align: right;
6695: width: 184px;
6696: }
1.795 www 6697:
1.424 albertel 6698: table.LC_group_priv_box td.LC_groups_fixed {
6699: background: $data_table_light;
6700: text-align: center;
6701: }
1.795 www 6702:
1.424 albertel 6703: table.LC_group_priv_box td.LC_groups_optional {
6704: background: $data_table_dark;
6705: text-align: center;
6706: }
1.795 www 6707:
1.424 albertel 6708: table.LC_group_priv_box td.LC_groups_functionality {
6709: background: $data_table_darker;
6710: text-align: center;
6711: font-weight: bold;
6712: }
1.795 www 6713:
1.424 albertel 6714: table.LC_group_priv td {
6715: text-align: left;
1.803 bisitz 6716: padding: 0;
1.424 albertel 6717: }
6718:
6719: .LC_navbuttons {
6720: margin: 2ex 0ex 2ex 0ex;
6721: }
1.795 www 6722:
1.423 albertel 6723: .LC_topic_bar {
6724: font-weight: bold;
6725: background: $tabbg;
1.918 wenzelju 6726: margin: 1em 0em 1em 2em;
1.805 bisitz 6727: padding: 3px;
1.918 wenzelju 6728: font-size: 1.2em;
1.423 albertel 6729: }
1.795 www 6730:
1.423 albertel 6731: .LC_topic_bar span {
1.918 wenzelju 6732: left: 0.5em;
6733: position: absolute;
1.423 albertel 6734: vertical-align: middle;
1.918 wenzelju 6735: font-size: 1.2em;
1.423 albertel 6736: }
1.795 www 6737:
1.423 albertel 6738: table.LC_course_group_status {
6739: margin: 20px;
6740: }
1.795 www 6741:
1.423 albertel 6742: table.LC_status_selector td {
6743: vertical-align: top;
6744: text-align: center;
1.424 albertel 6745: padding: 4px;
6746: }
1.795 www 6747:
1.599 albertel 6748: div.LC_feedback_link {
1.616 albertel 6749: clear: both;
1.829 kalberla 6750: background: $sidebg;
1.779 bisitz 6751: width: 100%;
1.829 kalberla 6752: padding-bottom: 10px;
6753: border: 1px $tabbg solid;
1.833 kalberla 6754: height: 22px;
6755: line-height: 22px;
6756: padding-top: 5px;
6757: }
6758:
6759: div.LC_feedback_link img {
6760: height: 22px;
1.867 kalberla 6761: vertical-align:middle;
1.829 kalberla 6762: }
6763:
1.911 bisitz 6764: div.LC_feedback_link a {
1.829 kalberla 6765: text-decoration: none;
1.489 raeburn 6766: }
1.795 www 6767:
1.867 kalberla 6768: div.LC_comblock {
1.911 bisitz 6769: display:inline;
1.867 kalberla 6770: color:$font;
6771: font-size:90%;
6772: }
6773:
6774: div.LC_feedback_link div.LC_comblock {
6775: padding-left:5px;
6776: }
6777:
6778: div.LC_feedback_link div.LC_comblock a {
6779: color:$font;
6780: }
6781:
1.489 raeburn 6782: span.LC_feedback_link {
1.858 bisitz 6783: /* background: $feedback_link_bg; */
1.599 albertel 6784: font-size: larger;
6785: }
1.795 www 6786:
1.599 albertel 6787: span.LC_message_link {
1.858 bisitz 6788: /* background: $feedback_link_bg; */
1.599 albertel 6789: font-size: larger;
6790: position: absolute;
6791: right: 1em;
1.489 raeburn 6792: }
1.421 albertel 6793:
1.515 albertel 6794: table.LC_prior_tries {
1.524 albertel 6795: border: 1px solid #000000;
6796: border-collapse: separate;
6797: border-spacing: 1px;
1.515 albertel 6798: }
1.523 albertel 6799:
1.515 albertel 6800: table.LC_prior_tries td {
1.524 albertel 6801: padding: 2px;
1.515 albertel 6802: }
1.523 albertel 6803:
6804: .LC_answer_correct {
1.795 www 6805: background: lightgreen;
6806: color: darkgreen;
6807: padding: 6px;
1.523 albertel 6808: }
1.795 www 6809:
1.523 albertel 6810: .LC_answer_charged_try {
1.797 www 6811: background: #FFAAAA;
1.795 www 6812: color: darkred;
6813: padding: 6px;
1.523 albertel 6814: }
1.795 www 6815:
1.779 bisitz 6816: .LC_answer_not_charged_try,
1.523 albertel 6817: .LC_answer_no_grade,
6818: .LC_answer_late {
1.795 www 6819: background: lightyellow;
1.523 albertel 6820: color: black;
1.795 www 6821: padding: 6px;
1.523 albertel 6822: }
1.795 www 6823:
1.523 albertel 6824: .LC_answer_previous {
1.795 www 6825: background: lightblue;
6826: color: darkblue;
6827: padding: 6px;
1.523 albertel 6828: }
1.795 www 6829:
1.779 bisitz 6830: .LC_answer_no_message {
1.777 tempelho 6831: background: #FFFFFF;
6832: color: black;
1.795 www 6833: padding: 6px;
1.779 bisitz 6834: }
1.795 www 6835:
1.1075.2.140 raeburn 6836: .LC_answer_unknown,
6837: .LC_answer_warning {
1.779 bisitz 6838: background: orange;
6839: color: black;
1.795 www 6840: padding: 6px;
1.777 tempelho 6841: }
1.795 www 6842:
1.529 albertel 6843: span.LC_prior_numerical,
6844: span.LC_prior_string,
6845: span.LC_prior_custom,
6846: span.LC_prior_reaction,
6847: span.LC_prior_math {
1.925 bisitz 6848: font-family: $mono;
1.523 albertel 6849: white-space: pre;
6850: }
6851:
1.525 albertel 6852: span.LC_prior_string {
1.925 bisitz 6853: font-family: $mono;
1.525 albertel 6854: white-space: pre;
6855: }
6856:
1.523 albertel 6857: table.LC_prior_option {
6858: width: 100%;
6859: border-collapse: collapse;
6860: }
1.795 www 6861:
1.911 bisitz 6862: table.LC_prior_rank,
1.795 www 6863: table.LC_prior_match {
1.528 albertel 6864: border-collapse: collapse;
6865: }
1.795 www 6866:
1.528 albertel 6867: table.LC_prior_option tr td,
6868: table.LC_prior_rank tr td,
6869: table.LC_prior_match tr td {
1.524 albertel 6870: border: 1px solid #000000;
1.515 albertel 6871: }
6872:
1.855 bisitz 6873: .LC_nobreak {
1.544 albertel 6874: white-space: nowrap;
1.519 raeburn 6875: }
6876:
1.576 raeburn 6877: span.LC_cusr_emph {
6878: font-style: italic;
6879: }
6880:
1.633 raeburn 6881: span.LC_cusr_subheading {
6882: font-weight: normal;
6883: font-size: 85%;
6884: }
6885:
1.861 bisitz 6886: div.LC_docs_entry_move {
1.859 bisitz 6887: border: 1px solid #BBBBBB;
1.545 albertel 6888: background: #DDDDDD;
1.861 bisitz 6889: width: 22px;
1.859 bisitz 6890: padding: 1px;
6891: margin: 0;
1.545 albertel 6892: }
6893:
1.861 bisitz 6894: table.LC_data_table tr > td.LC_docs_entry_commands,
6895: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 6896: font-size: x-small;
6897: }
1.795 www 6898:
1.861 bisitz 6899: .LC_docs_entry_parameter {
6900: white-space: nowrap;
6901: }
6902:
1.544 albertel 6903: .LC_docs_copy {
1.545 albertel 6904: color: #000099;
1.544 albertel 6905: }
1.795 www 6906:
1.544 albertel 6907: .LC_docs_cut {
1.545 albertel 6908: color: #550044;
1.544 albertel 6909: }
1.795 www 6910:
1.544 albertel 6911: .LC_docs_rename {
1.545 albertel 6912: color: #009900;
1.544 albertel 6913: }
1.795 www 6914:
1.544 albertel 6915: .LC_docs_remove {
1.545 albertel 6916: color: #990000;
6917: }
6918:
1.1075.2.134 raeburn 6919: .LC_domprefs_email,
1.547 albertel 6920: .LC_docs_reinit_warn,
6921: .LC_docs_ext_edit {
6922: font-size: x-small;
6923: }
6924:
1.545 albertel 6925: table.LC_docs_adddocs td,
6926: table.LC_docs_adddocs th {
6927: border: 1px solid #BBBBBB;
6928: padding: 4px;
6929: background: #DDDDDD;
1.543 albertel 6930: }
6931:
1.584 albertel 6932: table.LC_sty_begin {
6933: background: #BBFFBB;
6934: }
1.795 www 6935:
1.584 albertel 6936: table.LC_sty_end {
6937: background: #FFBBBB;
6938: }
6939:
1.589 raeburn 6940: table.LC_double_column {
1.803 bisitz 6941: border-width: 0;
1.589 raeburn 6942: border-collapse: collapse;
6943: width: 100%;
6944: padding: 2px;
6945: }
6946:
6947: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 6948: top: 2px;
1.589 raeburn 6949: left: 2px;
6950: width: 47%;
6951: vertical-align: top;
6952: }
6953:
6954: table.LC_double_column tr td.LC_right_col {
6955: top: 2px;
1.779 bisitz 6956: right: 2px;
1.589 raeburn 6957: width: 47%;
6958: vertical-align: top;
6959: }
6960:
1.591 raeburn 6961: div.LC_left_float {
6962: float: left;
6963: padding-right: 5%;
1.597 albertel 6964: padding-bottom: 4px;
1.591 raeburn 6965: }
6966:
6967: div.LC_clear_float_header {
1.597 albertel 6968: padding-bottom: 2px;
1.591 raeburn 6969: }
6970:
6971: div.LC_clear_float_footer {
1.597 albertel 6972: padding-top: 10px;
1.591 raeburn 6973: clear: both;
6974: }
6975:
1.597 albertel 6976: div.LC_grade_show_user {
1.941 bisitz 6977: /* border-left: 5px solid $sidebg; */
6978: border-top: 5px solid #000000;
6979: margin: 50px 0 0 0;
1.936 bisitz 6980: padding: 15px 0 5px 10px;
1.597 albertel 6981: }
1.795 www 6982:
1.936 bisitz 6983: div.LC_grade_show_user_odd_row {
1.941 bisitz 6984: /* border-left: 5px solid #000000; */
6985: }
6986:
6987: div.LC_grade_show_user div.LC_Box {
6988: margin-right: 50px;
1.597 albertel 6989: }
6990:
6991: div.LC_grade_submissions,
6992: div.LC_grade_message_center,
1.936 bisitz 6993: div.LC_grade_info_links {
1.597 albertel 6994: margin: 5px;
6995: width: 99%;
6996: background: #FFFFFF;
6997: }
1.795 www 6998:
1.597 albertel 6999: div.LC_grade_submissions_header,
1.936 bisitz 7000: div.LC_grade_message_center_header {
1.705 tempelho 7001: font-weight: bold;
7002: font-size: large;
1.597 albertel 7003: }
1.795 www 7004:
1.597 albertel 7005: div.LC_grade_submissions_body,
1.936 bisitz 7006: div.LC_grade_message_center_body {
1.597 albertel 7007: border: 1px solid black;
7008: width: 99%;
7009: background: #FFFFFF;
7010: }
1.795 www 7011:
1.613 albertel 7012: table.LC_scantron_action {
7013: width: 100%;
7014: }
1.795 www 7015:
1.613 albertel 7016: table.LC_scantron_action tr th {
1.698 harmsja 7017: font-weight:bold;
7018: font-style:normal;
1.613 albertel 7019: }
1.795 www 7020:
1.779 bisitz 7021: .LC_edit_problem_header,
1.614 albertel 7022: div.LC_edit_problem_footer {
1.705 tempelho 7023: font-weight: normal;
7024: font-size: medium;
1.602 albertel 7025: margin: 2px;
1.1060 bisitz 7026: background-color: $sidebg;
1.600 albertel 7027: }
1.795 www 7028:
1.600 albertel 7029: div.LC_edit_problem_header,
1.602 albertel 7030: div.LC_edit_problem_header div,
1.614 albertel 7031: div.LC_edit_problem_footer,
7032: div.LC_edit_problem_footer div,
1.602 albertel 7033: div.LC_edit_problem_editxml_header,
7034: div.LC_edit_problem_editxml_header div {
1.1075.2.112 raeburn 7035: z-index: 100;
1.600 albertel 7036: }
1.795 www 7037:
1.600 albertel 7038: div.LC_edit_problem_header_title {
1.705 tempelho 7039: font-weight: bold;
7040: font-size: larger;
1.602 albertel 7041: background: $tabbg;
7042: padding: 3px;
1.1060 bisitz 7043: margin: 0 0 5px 0;
1.602 albertel 7044: }
1.795 www 7045:
1.602 albertel 7046: table.LC_edit_problem_header_title {
7047: width: 100%;
1.600 albertel 7048: background: $tabbg;
1.602 albertel 7049: }
7050:
1.1075.2.112 raeburn 7051: div.LC_edit_actionbar {
7052: background-color: $sidebg;
7053: margin: 0;
7054: padding: 0;
7055: line-height: 200%;
1.602 albertel 7056: }
1.795 www 7057:
1.1075.2.112 raeburn 7058: div.LC_edit_actionbar div{
7059: padding: 0;
7060: margin: 0;
7061: display: inline-block;
1.600 albertel 7062: }
1.795 www 7063:
1.1075.2.34 raeburn 7064: .LC_edit_opt {
7065: padding-left: 1em;
7066: white-space: nowrap;
7067: }
7068:
1.1075.2.57 raeburn 7069: .LC_edit_problem_latexhelper{
7070: text-align: right;
7071: }
7072:
7073: #LC_edit_problem_colorful div{
7074: margin-left: 40px;
7075: }
7076:
1.1075.2.112 raeburn 7077: #LC_edit_problem_codemirror div{
7078: margin-left: 0px;
7079: }
7080:
1.911 bisitz 7081: img.stift {
1.803 bisitz 7082: border-width: 0;
7083: vertical-align: middle;
1.677 riegler 7084: }
1.680 riegler 7085:
1.923 bisitz 7086: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7087: vertical-align: top;
1.777 tempelho 7088: }
1.795 www 7089:
1.716 raeburn 7090: div.LC_createcourse {
1.911 bisitz 7091: margin: 10px 10px 10px 10px;
1.716 raeburn 7092: }
7093:
1.917 raeburn 7094: .LC_dccid {
1.1075.2.38 raeburn 7095: float: right;
1.917 raeburn 7096: margin: 0.2em 0 0 0;
7097: padding: 0;
7098: font-size: 90%;
7099: display:none;
7100: }
7101:
1.897 wenzelju 7102: ol.LC_primary_menu a:hover,
1.721 harmsja 7103: ol#LC_MenuBreadcrumbs a:hover,
7104: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7105: ul#LC_secondary_menu a:hover,
1.721 harmsja 7106: .LC_FormSectionClearButton input:hover
1.795 www 7107: ul.LC_TabContent li:hover a {
1.952 onken 7108: color:$button_hover;
1.911 bisitz 7109: text-decoration:none;
1.693 droeschl 7110: }
7111:
1.779 bisitz 7112: h1 {
1.911 bisitz 7113: padding: 0;
7114: line-height:130%;
1.693 droeschl 7115: }
1.698 harmsja 7116:
1.911 bisitz 7117: h2,
7118: h3,
7119: h4,
7120: h5,
7121: h6 {
7122: margin: 5px 0 5px 0;
7123: padding: 0;
7124: line-height:130%;
1.693 droeschl 7125: }
1.795 www 7126:
7127: .LC_hcell {
1.911 bisitz 7128: padding:3px 15px 3px 15px;
7129: margin: 0;
7130: background-color:$tabbg;
7131: color:$fontmenu;
7132: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7133: }
1.795 www 7134:
1.840 bisitz 7135: .LC_Box > .LC_hcell {
1.911 bisitz 7136: margin: 0 -10px 10px -10px;
1.835 bisitz 7137: }
7138:
1.721 harmsja 7139: .LC_noBorder {
1.911 bisitz 7140: border: 0;
1.698 harmsja 7141: }
1.693 droeschl 7142:
1.721 harmsja 7143: .LC_FormSectionClearButton input {
1.911 bisitz 7144: background-color:transparent;
7145: border: none;
7146: cursor:pointer;
7147: text-decoration:underline;
1.693 droeschl 7148: }
1.763 bisitz 7149:
7150: .LC_help_open_topic {
1.911 bisitz 7151: color: #FFFFFF;
7152: background-color: #EEEEFF;
7153: margin: 1px;
7154: padding: 4px;
7155: border: 1px solid #000033;
7156: white-space: nowrap;
7157: /* vertical-align: middle; */
1.759 neumanie 7158: }
1.693 droeschl 7159:
1.911 bisitz 7160: dl,
7161: ul,
7162: div,
7163: fieldset {
7164: margin: 10px 10px 10px 0;
7165: /* overflow: hidden; */
1.693 droeschl 7166: }
1.795 www 7167:
1.1075.2.90 raeburn 7168: article.geogebraweb div {
7169: margin: 0;
7170: }
7171:
1.838 bisitz 7172: fieldset > legend {
1.911 bisitz 7173: font-weight: bold;
7174: padding: 0 5px 0 5px;
1.838 bisitz 7175: }
7176:
1.813 bisitz 7177: #LC_nav_bar {
1.911 bisitz 7178: float: left;
1.995 raeburn 7179: background-color: $pgbg_or_bgcolor;
1.966 bisitz 7180: margin: 0 0 2px 0;
1.807 droeschl 7181: }
7182:
1.916 droeschl 7183: #LC_realm {
7184: margin: 0.2em 0 0 0;
7185: padding: 0;
7186: font-weight: bold;
7187: text-align: center;
1.995 raeburn 7188: background-color: $pgbg_or_bgcolor;
1.916 droeschl 7189: }
7190:
1.911 bisitz 7191: #LC_nav_bar em {
7192: font-weight: bold;
7193: font-style: normal;
1.807 droeschl 7194: }
7195:
1.897 wenzelju 7196: ol.LC_primary_menu {
1.934 droeschl 7197: margin: 0;
1.1075.2.2 raeburn 7198: padding: 0;
1.807 droeschl 7199: }
7200:
1.852 droeschl 7201: ol#LC_PathBreadcrumbs {
1.911 bisitz 7202: margin: 0;
1.693 droeschl 7203: }
7204:
1.897 wenzelju 7205: ol.LC_primary_menu li {
1.1075.2.2 raeburn 7206: color: RGB(80, 80, 80);
7207: vertical-align: middle;
7208: text-align: left;
7209: list-style: none;
1.1075.2.112 raeburn 7210: position: relative;
1.1075.2.2 raeburn 7211: float: left;
1.1075.2.112 raeburn 7212: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
7213: line-height: 1.5em;
1.1075.2.2 raeburn 7214: }
7215:
1.1075.2.113 raeburn 7216: ol.LC_primary_menu li a,
1.1075.2.112 raeburn 7217: ol.LC_primary_menu li p {
1.1075.2.2 raeburn 7218: display: block;
7219: margin: 0;
7220: padding: 0 5px 0 10px;
7221: text-decoration: none;
7222: }
7223:
1.1075.2.112 raeburn 7224: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
7225: display: inline-block;
7226: width: 95%;
7227: text-align: left;
7228: }
7229:
7230: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
7231: display: inline-block;
7232: width: 5%;
7233: float: right;
7234: text-align: right;
7235: font-size: 70%;
7236: }
7237:
7238: ol.LC_primary_menu ul {
1.1075.2.2 raeburn 7239: display: none;
1.1075.2.112 raeburn 7240: width: 15em;
1.1075.2.2 raeburn 7241: background-color: $data_table_light;
1.1075.2.112 raeburn 7242: position: absolute;
7243: top: 100%;
7244: }
7245:
7246: ol.LC_primary_menu ul ul {
7247: left: 100%;
7248: top: 0;
1.1075.2.2 raeburn 7249: }
7250:
1.1075.2.112 raeburn 7251: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2 raeburn 7252: display: block;
7253: position: absolute;
7254: margin: 0;
7255: padding: 0;
1.1075.2.5 raeburn 7256: z-index: 2;
1.1075.2.2 raeburn 7257: }
7258:
7259: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112 raeburn 7260: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2 raeburn 7261: font-size: 90%;
1.911 bisitz 7262: vertical-align: top;
1.1075.2.2 raeburn 7263: float: none;
1.1075.2.5 raeburn 7264: border-left: 1px solid black;
7265: border-right: 1px solid black;
1.1075.2.112 raeburn 7266: /* A dark bottom border to visualize different menu options;
7267: overwritten in the create_submenu routine for the last border-bottom of the menu */
7268: border-bottom: 1px solid $data_table_dark;
1.1075.2.2 raeburn 7269: }
7270:
1.1075.2.112 raeburn 7271: ol.LC_primary_menu li li p:hover {
7272: color:$button_hover;
7273: text-decoration:none;
7274: background-color:$data_table_dark;
1.1075.2.2 raeburn 7275: }
7276:
7277: ol.LC_primary_menu li li a:hover {
7278: color:$button_hover;
7279: background-color:$data_table_dark;
1.693 droeschl 7280: }
7281:
1.1075.2.112 raeburn 7282: /* Font-size equal to the size of the predecessors*/
7283: ol.LC_primary_menu li:hover li li {
7284: font-size: 100%;
7285: }
7286:
1.897 wenzelju 7287: ol.LC_primary_menu li img {
1.911 bisitz 7288: vertical-align: bottom;
1.934 droeschl 7289: height: 1.1em;
1.1075.2.3 raeburn 7290: margin: 0.2em 0 0 0;
1.693 droeschl 7291: }
7292:
1.897 wenzelju 7293: ol.LC_primary_menu a {
1.911 bisitz 7294: color: RGB(80, 80, 80);
7295: text-decoration: none;
1.693 droeschl 7296: }
1.795 www 7297:
1.949 droeschl 7298: ol.LC_primary_menu a.LC_new_message {
7299: font-weight:bold;
7300: color: darkred;
7301: }
7302:
1.975 raeburn 7303: ol.LC_docs_parameters {
7304: margin-left: 0;
7305: padding: 0;
7306: list-style: none;
7307: }
7308:
7309: ol.LC_docs_parameters li {
7310: margin: 0;
7311: padding-right: 20px;
7312: display: inline;
7313: }
7314:
1.976 raeburn 7315: ol.LC_docs_parameters li:before {
7316: content: "\\002022 \\0020";
7317: }
7318:
7319: li.LC_docs_parameters_title {
7320: font-weight: bold;
7321: }
7322:
7323: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7324: content: "";
7325: }
7326:
1.897 wenzelju 7327: ul#LC_secondary_menu {
1.1075.2.23 raeburn 7328: clear: right;
1.911 bisitz 7329: color: $fontmenu;
7330: background: $tabbg;
7331: list-style: none;
7332: padding: 0;
7333: margin: 0;
7334: width: 100%;
1.995 raeburn 7335: text-align: left;
1.1075.2.4 raeburn 7336: float: left;
1.808 droeschl 7337: }
7338:
1.897 wenzelju 7339: ul#LC_secondary_menu li {
1.911 bisitz 7340: font-weight: bold;
7341: line-height: 1.8em;
7342: border-right: 1px solid black;
1.1075.2.4 raeburn 7343: float: left;
7344: }
7345:
7346: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7347: background-color: $data_table_light;
7348: }
7349:
7350: ul#LC_secondary_menu li a {
7351: padding: 0 0.8em;
7352: }
7353:
7354: ul#LC_secondary_menu li ul {
7355: display: none;
7356: }
7357:
7358: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7359: display: block;
7360: position: absolute;
7361: margin: 0;
7362: padding: 0;
7363: list-style:none;
7364: float: none;
7365: background-color: $data_table_light;
1.1075.2.5 raeburn 7366: z-index: 2;
1.1075.2.10 raeburn 7367: margin-left: -1px;
1.1075.2.4 raeburn 7368: }
7369:
7370: ul#LC_secondary_menu li ul li {
7371: font-size: 90%;
7372: vertical-align: top;
7373: border-left: 1px solid black;
7374: border-right: 1px solid black;
1.1075.2.33 raeburn 7375: background-color: $data_table_light;
1.1075.2.4 raeburn 7376: list-style:none;
7377: float: none;
7378: }
7379:
7380: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7381: background-color: $data_table_dark;
1.807 droeschl 7382: }
7383:
1.847 tempelho 7384: ul.LC_TabContent {
1.911 bisitz 7385: display:block;
7386: background: $sidebg;
7387: border-bottom: solid 1px $lg_border_color;
7388: list-style:none;
1.1020 raeburn 7389: margin: -1px -10px 0 -10px;
1.911 bisitz 7390: padding: 0;
1.693 droeschl 7391: }
7392:
1.795 www 7393: ul.LC_TabContent li,
7394: ul.LC_TabContentBigger li {
1.911 bisitz 7395: float:left;
1.741 harmsja 7396: }
1.795 www 7397:
1.897 wenzelju 7398: ul#LC_secondary_menu li a {
1.911 bisitz 7399: color: $fontmenu;
7400: text-decoration: none;
1.693 droeschl 7401: }
1.795 www 7402:
1.721 harmsja 7403: ul.LC_TabContent {
1.952 onken 7404: min-height:20px;
1.721 harmsja 7405: }
1.795 www 7406:
7407: ul.LC_TabContent li {
1.911 bisitz 7408: vertical-align:middle;
1.959 onken 7409: padding: 0 16px 0 10px;
1.911 bisitz 7410: background-color:$tabbg;
7411: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7412: border-left: solid 1px $font;
1.721 harmsja 7413: }
1.795 www 7414:
1.847 tempelho 7415: ul.LC_TabContent .right {
1.911 bisitz 7416: float:right;
1.847 tempelho 7417: }
7418:
1.911 bisitz 7419: ul.LC_TabContent li a,
7420: ul.LC_TabContent li {
7421: color:rgb(47,47,47);
7422: text-decoration:none;
7423: font-size:95%;
7424: font-weight:bold;
1.952 onken 7425: min-height:20px;
7426: }
7427:
1.959 onken 7428: ul.LC_TabContent li a:hover,
7429: ul.LC_TabContent li a:focus {
1.952 onken 7430: color: $button_hover;
1.959 onken 7431: background:none;
7432: outline:none;
1.952 onken 7433: }
7434:
7435: ul.LC_TabContent li:hover {
7436: color: $button_hover;
7437: cursor:pointer;
1.721 harmsja 7438: }
1.795 www 7439:
1.911 bisitz 7440: ul.LC_TabContent li.active {
1.952 onken 7441: color: $font;
1.911 bisitz 7442: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7443: border-bottom:solid 1px #FFFFFF;
7444: cursor: default;
1.744 ehlerst 7445: }
1.795 www 7446:
1.959 onken 7447: ul.LC_TabContent li.active a {
7448: color:$font;
7449: background:#FFFFFF;
7450: outline: none;
7451: }
1.1047 raeburn 7452:
7453: ul.LC_TabContent li.goback {
7454: float: left;
7455: border-left: none;
7456: }
7457:
1.870 tempelho 7458: #maincoursedoc {
1.911 bisitz 7459: clear:both;
1.870 tempelho 7460: }
7461:
7462: ul.LC_TabContentBigger {
1.911 bisitz 7463: display:block;
7464: list-style:none;
7465: padding: 0;
1.870 tempelho 7466: }
7467:
1.795 www 7468: ul.LC_TabContentBigger li {
1.911 bisitz 7469: vertical-align:bottom;
7470: height: 30px;
7471: font-size:110%;
7472: font-weight:bold;
7473: color: #737373;
1.841 tempelho 7474: }
7475:
1.957 onken 7476: ul.LC_TabContentBigger li.active {
7477: position: relative;
7478: top: 1px;
7479: }
7480:
1.870 tempelho 7481: ul.LC_TabContentBigger li a {
1.911 bisitz 7482: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7483: height: 30px;
7484: line-height: 30px;
7485: text-align: center;
7486: display: block;
7487: text-decoration: none;
1.958 onken 7488: outline: none;
1.741 harmsja 7489: }
1.795 www 7490:
1.870 tempelho 7491: ul.LC_TabContentBigger li.active a {
1.911 bisitz 7492: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
7493: color:$font;
1.744 ehlerst 7494: }
1.795 www 7495:
1.870 tempelho 7496: ul.LC_TabContentBigger li b {
1.911 bisitz 7497: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7498: display: block;
7499: float: left;
7500: padding: 0 30px;
1.957 onken 7501: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7502: }
7503:
1.956 onken 7504: ul.LC_TabContentBigger li:hover b {
7505: color:$button_hover;
7506: }
7507:
1.870 tempelho 7508: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7509: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7510: color:$font;
1.957 onken 7511: border: 0;
1.741 harmsja 7512: }
1.693 droeschl 7513:
1.870 tempelho 7514:
1.862 bisitz 7515: ul.LC_CourseBreadcrumbs {
7516: background: $sidebg;
1.1020 raeburn 7517: height: 2em;
1.862 bisitz 7518: padding-left: 10px;
1.1020 raeburn 7519: margin: 0;
1.862 bisitz 7520: list-style-position: inside;
7521: }
7522:
1.911 bisitz 7523: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7524: ol#LC_PathBreadcrumbs {
1.911 bisitz 7525: padding-left: 10px;
7526: margin: 0;
1.933 droeschl 7527: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7528: }
7529:
1.911 bisitz 7530: ol#LC_MenuBreadcrumbs li,
7531: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7532: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7533: display: inline;
1.933 droeschl 7534: white-space: normal;
1.693 droeschl 7535: }
7536:
1.823 bisitz 7537: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7538: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7539: text-decoration: none;
7540: font-size:90%;
1.693 droeschl 7541: }
1.795 www 7542:
1.969 droeschl 7543: ol#LC_MenuBreadcrumbs h1 {
7544: display: inline;
7545: font-size: 90%;
7546: line-height: 2.5em;
7547: margin: 0;
7548: padding: 0;
7549: }
7550:
1.795 www 7551: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7552: text-decoration:none;
7553: font-size:100%;
7554: font-weight:bold;
1.693 droeschl 7555: }
1.795 www 7556:
1.840 bisitz 7557: .LC_Box {
1.911 bisitz 7558: border: solid 1px $lg_border_color;
7559: padding: 0 10px 10px 10px;
1.746 neumanie 7560: }
1.795 www 7561:
1.1020 raeburn 7562: .LC_DocsBox {
7563: border: solid 1px $lg_border_color;
7564: padding: 0 0 10px 10px;
7565: }
7566:
1.795 www 7567: .LC_AboutMe_Image {
1.911 bisitz 7568: float:left;
7569: margin-right:10px;
1.747 neumanie 7570: }
1.795 www 7571:
7572: .LC_Clear_AboutMe_Image {
1.911 bisitz 7573: clear:left;
1.747 neumanie 7574: }
1.795 www 7575:
1.721 harmsja 7576: dl.LC_ListStyleClean dt {
1.911 bisitz 7577: padding-right: 5px;
7578: display: table-header-group;
1.693 droeschl 7579: }
7580:
1.721 harmsja 7581: dl.LC_ListStyleClean dd {
1.911 bisitz 7582: display: table-row;
1.693 droeschl 7583: }
7584:
1.721 harmsja 7585: .LC_ListStyleClean,
7586: .LC_ListStyleSimple,
7587: .LC_ListStyleNormal,
1.795 www 7588: .LC_ListStyleSpecial {
1.911 bisitz 7589: /* display:block; */
7590: list-style-position: inside;
7591: list-style-type: none;
7592: overflow: hidden;
7593: padding: 0;
1.693 droeschl 7594: }
7595:
1.721 harmsja 7596: .LC_ListStyleSimple li,
7597: .LC_ListStyleSimple dd,
7598: .LC_ListStyleNormal li,
7599: .LC_ListStyleNormal dd,
7600: .LC_ListStyleSpecial li,
1.795 www 7601: .LC_ListStyleSpecial dd {
1.911 bisitz 7602: margin: 0;
7603: padding: 5px 5px 5px 10px;
7604: clear: both;
1.693 droeschl 7605: }
7606:
1.721 harmsja 7607: .LC_ListStyleClean li,
7608: .LC_ListStyleClean dd {
1.911 bisitz 7609: padding-top: 0;
7610: padding-bottom: 0;
1.693 droeschl 7611: }
7612:
1.721 harmsja 7613: .LC_ListStyleSimple dd,
1.795 www 7614: .LC_ListStyleSimple li {
1.911 bisitz 7615: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 7616: }
7617:
1.721 harmsja 7618: .LC_ListStyleSpecial li,
7619: .LC_ListStyleSpecial dd {
1.911 bisitz 7620: list-style-type: none;
7621: background-color: RGB(220, 220, 220);
7622: margin-bottom: 4px;
1.693 droeschl 7623: }
7624:
1.721 harmsja 7625: table.LC_SimpleTable {
1.911 bisitz 7626: margin:5px;
7627: border:solid 1px $lg_border_color;
1.795 www 7628: }
1.693 droeschl 7629:
1.721 harmsja 7630: table.LC_SimpleTable tr {
1.911 bisitz 7631: padding: 0;
7632: border:solid 1px $lg_border_color;
1.693 droeschl 7633: }
1.795 www 7634:
7635: table.LC_SimpleTable thead {
1.911 bisitz 7636: background:rgb(220,220,220);
1.693 droeschl 7637: }
7638:
1.721 harmsja 7639: div.LC_columnSection {
1.911 bisitz 7640: display: block;
7641: clear: both;
7642: overflow: hidden;
7643: margin: 0;
1.693 droeschl 7644: }
7645:
1.721 harmsja 7646: div.LC_columnSection>* {
1.911 bisitz 7647: float: left;
7648: margin: 10px 20px 10px 0;
7649: overflow:hidden;
1.693 droeschl 7650: }
1.721 harmsja 7651:
1.795 www 7652: table em {
1.911 bisitz 7653: font-weight: bold;
7654: font-style: normal;
1.748 schulted 7655: }
1.795 www 7656:
1.779 bisitz 7657: table.LC_tableBrowseRes,
1.795 www 7658: table.LC_tableOfContent {
1.911 bisitz 7659: border:none;
7660: border-spacing: 1px;
7661: padding: 3px;
7662: background-color: #FFFFFF;
7663: font-size: 90%;
1.753 droeschl 7664: }
1.789 droeschl 7665:
1.911 bisitz 7666: table.LC_tableOfContent {
7667: border-collapse: collapse;
1.789 droeschl 7668: }
7669:
1.771 droeschl 7670: table.LC_tableBrowseRes a,
1.768 schulted 7671: table.LC_tableOfContent a {
1.911 bisitz 7672: background-color: transparent;
7673: text-decoration: none;
1.753 droeschl 7674: }
7675:
1.795 www 7676: table.LC_tableOfContent img {
1.911 bisitz 7677: border: none;
7678: height: 1.3em;
7679: vertical-align: text-bottom;
7680: margin-right: 0.3em;
1.753 droeschl 7681: }
1.757 schulted 7682:
1.795 www 7683: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7684: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7685: }
7686:
1.795 www 7687: a#LC_content_toolbar_everything {
1.911 bisitz 7688: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7689: }
7690:
1.795 www 7691: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7692: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7693: }
7694:
1.795 www 7695: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7696: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7697: }
7698:
1.795 www 7699: a#LC_content_toolbar_changefolder {
1.911 bisitz 7700: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7701: }
7702:
1.795 www 7703: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7704: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7705: }
7706:
1.1043 raeburn 7707: a#LC_content_toolbar_edittoplevel {
7708: background-image:url(/res/adm/pages/edittoplevel.gif);
7709: }
7710:
1.795 www 7711: ul#LC_toolbar li a:hover {
1.911 bisitz 7712: background-position: bottom center;
1.757 schulted 7713: }
7714:
1.795 www 7715: ul#LC_toolbar {
1.911 bisitz 7716: padding: 0;
7717: margin: 2px;
7718: list-style:none;
7719: position:relative;
7720: background-color:white;
1.1075.2.9 raeburn 7721: overflow: auto;
1.757 schulted 7722: }
7723:
1.795 www 7724: ul#LC_toolbar li {
1.911 bisitz 7725: border:1px solid white;
7726: padding: 0;
7727: margin: 0;
7728: float: left;
7729: display:inline;
7730: vertical-align:middle;
1.1075.2.9 raeburn 7731: white-space: nowrap;
1.911 bisitz 7732: }
1.757 schulted 7733:
1.783 amueller 7734:
1.795 www 7735: a.LC_toolbarItem {
1.911 bisitz 7736: display:block;
7737: padding: 0;
7738: margin: 0;
7739: height: 32px;
7740: width: 32px;
7741: color:white;
7742: border: none;
7743: background-repeat:no-repeat;
7744: background-color:transparent;
1.757 schulted 7745: }
7746:
1.915 droeschl 7747: ul.LC_funclist {
7748: margin: 0;
7749: padding: 0.5em 1em 0.5em 0;
7750: }
7751:
1.933 droeschl 7752: ul.LC_funclist > li:first-child {
7753: font-weight:bold;
7754: margin-left:0.8em;
7755: }
7756:
1.915 droeschl 7757: ul.LC_funclist + ul.LC_funclist {
7758: /*
7759: left border as a seperator if we have more than
7760: one list
7761: */
7762: border-left: 1px solid $sidebg;
7763: /*
7764: this hides the left border behind the border of the
7765: outer box if element is wrapped to the next 'line'
7766: */
7767: margin-left: -1px;
7768: }
7769:
1.843 bisitz 7770: ul.LC_funclist li {
1.915 droeschl 7771: display: inline;
1.782 bisitz 7772: white-space: nowrap;
1.915 droeschl 7773: margin: 0 0 0 25px;
7774: line-height: 150%;
1.782 bisitz 7775: }
7776:
1.974 wenzelju 7777: .LC_hidden {
7778: display: none;
7779: }
7780:
1.1030 www 7781: .LCmodal-overlay {
7782: position:fixed;
7783: top:0;
7784: right:0;
7785: bottom:0;
7786: left:0;
7787: height:100%;
7788: width:100%;
7789: margin:0;
7790: padding:0;
7791: background:#999;
7792: opacity:.75;
7793: filter: alpha(opacity=75);
7794: -moz-opacity: 0.75;
7795: z-index:101;
7796: }
7797:
7798: * html .LCmodal-overlay {
7799: position: absolute;
7800: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
7801: }
7802:
7803: .LCmodal-window {
7804: position:fixed;
7805: top:50%;
7806: left:50%;
7807: margin:0;
7808: padding:0;
7809: z-index:102;
7810: }
7811:
7812: * html .LCmodal-window {
7813: position:absolute;
7814: }
7815:
7816: .LCclose-window {
7817: position:absolute;
7818: width:32px;
7819: height:32px;
7820: right:8px;
7821: top:8px;
7822: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
7823: text-indent:-99999px;
7824: overflow:hidden;
7825: cursor:pointer;
7826: }
7827:
1.1075.2.141 raeburn 7828: pre.LC_wordwrap {
7829: white-space: pre-wrap;
7830: white-space: -moz-pre-wrap;
7831: white-space: -pre-wrap;
7832: white-space: -o-pre-wrap;
7833: word-wrap: break-word;
7834: }
7835:
1.1075.2.17 raeburn 7836: /*
7837: styles used by TTH when "Default set of options to pass to tth/m
7838: when converting TeX" in course settings has been set
7839:
7840: option passed: -t
7841:
7842: */
7843:
7844: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
7845: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
7846: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
7847: td div.norm {line-height:normal;}
7848:
7849: /*
7850: option passed -y3
7851: */
7852:
7853: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
7854: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
7855: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
7856:
1.1075.2.121 raeburn 7857: #LC_minitab_header {
7858: float:left;
7859: width:100%;
7860: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
7861: font-size:93%;
7862: line-height:normal;
7863: margin: 0.5em 0 0.5em 0;
7864: }
7865: #LC_minitab_header ul {
7866: margin:0;
7867: padding:10px 10px 0;
7868: list-style:none;
7869: }
7870: #LC_minitab_header li {
7871: float:left;
7872: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
7873: margin:0;
7874: padding:0 0 0 9px;
7875: }
7876: #LC_minitab_header a {
7877: display:block;
7878: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
7879: padding:5px 15px 4px 6px;
7880: }
7881: #LC_minitab_header #LC_current_minitab {
7882: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
7883: }
7884: #LC_minitab_header #LC_current_minitab a {
7885: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
7886: padding-bottom:5px;
7887: }
7888:
7889:
1.343 albertel 7890: END
7891: }
7892:
1.306 albertel 7893: =pod
7894:
7895: =item * &headtag()
7896:
7897: Returns a uniform footer for LON-CAPA web pages.
7898:
1.307 albertel 7899: Inputs: $title - optional title for the head
7900: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 7901: $args - optional arguments
1.319 albertel 7902: force_register - if is true call registerurl so the remote is
7903: informed
1.415 albertel 7904: redirect -> array ref of
7905: 1- seconds before redirect occurs
7906: 2- url to redirect to
7907: 3- whether the side effect should occur
1.315 albertel 7908: (side effect of setting
7909: $env{'internal.head.redirect'} to the url
7910: redirected too)
1.352 albertel 7911: domain -> force to color decorate a page for a specific
7912: domain
7913: function -> force usage of a specific rolish color scheme
7914: bgcolor -> override the default page bgcolor
1.460 albertel 7915: no_auto_mt_title
7916: -> prevent &mt()ing the title arg
1.464 albertel 7917:
1.306 albertel 7918: =cut
7919:
7920: sub headtag {
1.313 albertel 7921: my ($title,$head_extra,$args) = @_;
1.306 albertel 7922:
1.363 albertel 7923: my $function = $args->{'function'} || &get_users_function();
7924: my $domain = $args->{'domain'} || &determinedomain();
7925: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1075.2.52 raeburn 7926: my $httphost = $args->{'use_absolute'};
1.418 albertel 7927: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 7928: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 7929: #time(),
1.418 albertel 7930: $env{'environment.color.timestamp'},
1.363 albertel 7931: $function,$domain,$bgcolor);
7932:
1.369 www 7933: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 7934:
1.308 albertel 7935: my $result =
7936: '<head>'.
1.1075.2.56 raeburn 7937: &font_settings($args);
1.319 albertel 7938:
1.1075.2.72 raeburn 7939: my $inhibitprint;
7940: if ($args->{'print_suppress'}) {
7941: $inhibitprint = &print_suppression();
7942: }
1.1064 raeburn 7943:
1.461 albertel 7944: if (!$args->{'frameset'}) {
7945: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
7946: }
1.1075.2.12 raeburn 7947: if ($args->{'force_register'}) {
7948: $result .= &Apache::lonmenu::registerurl(1);
1.319 albertel 7949: }
1.436 albertel 7950: if (!$args->{'no_nav_bar'}
7951: && !$args->{'only_body'}
7952: && !$args->{'frameset'}) {
1.1075.2.52 raeburn 7953: $result .= &help_menu_js($httphost);
1.1032 www 7954: $result.=&modal_window();
1.1038 www 7955: $result.=&togglebox_script();
1.1034 www 7956: $result.=&wishlist_window();
1.1041 www 7957: $result.=&LCprogressbarUpdate_script();
1.1034 www 7958: } else {
7959: if ($args->{'add_modal'}) {
7960: $result.=&modal_window();
7961: }
7962: if ($args->{'add_wishlist'}) {
7963: $result.=&wishlist_window();
7964: }
1.1038 www 7965: if ($args->{'add_togglebox'}) {
7966: $result.=&togglebox_script();
7967: }
1.1041 www 7968: if ($args->{'add_progressbar'}) {
7969: $result.=&LCprogressbarUpdate_script();
7970: }
1.436 albertel 7971: }
1.314 albertel 7972: if (ref($args->{'redirect'})) {
1.414 albertel 7973: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 7974: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 7975: if (!$inhibit_continue) {
7976: $env{'internal.head.redirect'} = $url;
7977: }
1.313 albertel 7978: $result.=<<ADDMETA
7979: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 7980: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 7981: ADDMETA
1.1075.2.89 raeburn 7982: } else {
7983: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
7984: my $requrl = $env{'request.uri'};
7985: if ($requrl eq '') {
7986: $requrl = $ENV{'REQUEST_URI'};
7987: $requrl =~ s/\?.+$//;
7988: }
7989: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
7990: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
7991: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
7992: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
7993: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
7994: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145 raeburn 7995: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
7996: my $offload;
1.1075.2.89 raeburn 7997: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
7998: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145 raeburn 7999: $offload = 1;
8000: }
8001: }
8002: unless ($offload) {
8003: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
8004: if ($domdefs{'offloadoth'}{$lonhost}) {
8005: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8006: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8007: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8008: $offload = 1;
8009: $dom_in_use = $env{'user.domain'};
8010: }
1.1075.2.89 raeburn 8011: }
1.1075.2.145 raeburn 8012: }
8013: }
8014: }
8015: if ($offload) {
8016: my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
8017: if (($newserver) && ($newserver ne $lonhost)) {
8018: my $numsec = 5;
8019: my $timeout = $numsec * 1000;
8020: my ($newurl,$locknum,%locks,$msg);
8021: if ($env{'request.role.adv'}) {
8022: ($locknum,%locks) = &Apache::lonnet::get_locks();
8023: }
8024: my $disable_submit = 0;
8025: if ($requrl =~ /$LONCAPA::assess_re/) {
8026: $disable_submit = 1;
8027: }
8028: if ($locknum) {
8029: my @lockinfo = sort(values(%locks));
8030: $msg = &mt('Once the following tasks are complete: ')."\n".
8031: join(", ",sort(values(%locks)))."\n";
8032: if (&show_course()) {
8033: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89 raeburn 8034: } else {
1.1075.2.145 raeburn 8035: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
8036: }
8037: } else {
8038: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8039: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
8040: }
8041: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8042: $newurl = '/adm/switchserver?otherserver='.$newserver;
8043: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8044: $newurl .= '&role='.$env{'request.role'};
8045: }
8046: if ($env{'request.symb'}) {
8047: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
8048: if ($shownsymb =~ m{^/enc/}) {
8049: my $reqdmajor = 2;
8050: my $reqdminor = 11;
8051: my $reqdsubminor = 3;
8052: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
8053: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
8054: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
8055: if (($major eq '' && $minor eq '') ||
8056: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
8057: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
8058: ($reqdsubminor > $subminor))))) {
8059: undef($shownsymb);
8060: }
1.1075.2.89 raeburn 8061: }
1.1075.2.145 raeburn 8062: if ($shownsymb) {
8063: &js_escape(\$shownsymb);
8064: $newurl .= '&symb='.$shownsymb;
1.1075.2.89 raeburn 8065: }
1.1075.2.145 raeburn 8066: } else {
8067: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
8068: &js_escape(\$shownurl);
8069: $newurl .= '&origurl='.$shownurl;
1.1075.2.89 raeburn 8070: }
1.1075.2.145 raeburn 8071: }
8072: &js_escape(\$msg);
8073: $result.=<<OFFLOAD
1.1075.2.89 raeburn 8074: <meta http-equiv="pragma" content="no-cache" />
8075: <script type="text/javascript">
1.1075.2.92 raeburn 8076: // <![CDATA[
1.1075.2.89 raeburn 8077: function LC_Offload_Now() {
8078: var dest = "$newurl";
8079: if (dest != '') {
8080: window.location.href="$newurl";
8081: }
8082: }
1.1075.2.92 raeburn 8083: \$(document).ready(function () {
8084: window.alert('$msg');
8085: if ($disable_submit) {
1.1075.2.89 raeburn 8086: \$(".LC_hwk_submit").prop("disabled", true);
8087: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92 raeburn 8088: }
8089: setTimeout('LC_Offload_Now()', $timeout);
8090: });
8091: // ]]>
1.1075.2.89 raeburn 8092: </script>
8093: OFFLOAD
8094: }
8095: }
8096: }
8097: }
8098: }
1.313 albertel 8099: }
1.306 albertel 8100: if (!defined($title)) {
8101: $title = 'The LearningOnline Network with CAPA';
8102: }
1.460 albertel 8103: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
8104: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61 raeburn 8105: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
8106: if (!$args->{'frameset'}) {
8107: $result .= ' /';
8108: }
8109: $result .= '>'
1.1064 raeburn 8110: .$inhibitprint
1.414 albertel 8111: .$head_extra;
1.1075.2.108 raeburn 8112: my $clientmobile;
8113: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
8114: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
8115: } else {
8116: $clientmobile = $env{'browser.mobile'};
8117: }
8118: if ($clientmobile) {
1.1075.2.42 raeburn 8119: $result .= '
8120: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
8121: <meta name="apple-mobile-web-app-capable" content="yes" />';
8122: }
1.1075.2.126 raeburn 8123: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 8124: return $result.'</head>';
1.306 albertel 8125: }
8126:
8127: =pod
8128:
1.340 albertel 8129: =item * &font_settings()
8130:
8131: Returns neccessary <meta> to set the proper encoding
8132:
1.1075.2.56 raeburn 8133: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 8134:
8135: =cut
8136:
8137: sub font_settings {
1.1075.2.56 raeburn 8138: my ($args) = @_;
1.340 albertel 8139: my $headerstring='';
1.1075.2.56 raeburn 8140: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
8141: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340 albertel 8142: $headerstring.=
1.1075.2.61 raeburn 8143: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
8144: if (!$args->{'frameset'}) {
8145: $headerstring.= ' /';
8146: }
8147: $headerstring .= '>'."\n";
1.340 albertel 8148: }
8149: return $headerstring;
8150: }
8151:
1.341 albertel 8152: =pod
8153:
1.1064 raeburn 8154: =item * &print_suppression()
8155:
8156: In course context returns css which causes the body to be blank when media="print",
8157: if printout generation is unavailable for the current resource.
8158:
8159: This could be because:
8160:
8161: (a) printstartdate is in the future
8162:
8163: (b) printenddate is in the past
8164:
8165: (c) there is an active exam block with "printout"
8166: functionality blocked
8167:
8168: Users with pav, pfo or evb privileges are exempt.
8169:
8170: Inputs: none
8171:
8172: =cut
8173:
8174:
8175: sub print_suppression {
8176: my $noprint;
8177: if ($env{'request.course.id'}) {
8178: my $scope = $env{'request.course.id'};
8179: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8180: (&Apache::lonnet::allowed('pfo',$scope))) {
8181: return;
8182: }
8183: if ($env{'request.course.sec'} ne '') {
8184: $scope .= "/$env{'request.course.sec'}";
8185: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8186: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 8187: return;
1.1064 raeburn 8188: }
8189: }
8190: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8191: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73 raeburn 8192: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 8193: if ($blocked) {
8194: my $checkrole = "cm./$cdom/$cnum";
8195: if ($env{'request.course.sec'} ne '') {
8196: $checkrole .= "/$env{'request.course.sec'}";
8197: }
8198: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
8199: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
8200: $noprint = 1;
8201: }
8202: }
8203: unless ($noprint) {
8204: my $symb = &Apache::lonnet::symbread();
8205: if ($symb ne '') {
8206: my $navmap = Apache::lonnavmaps::navmap->new();
8207: if (ref($navmap)) {
8208: my $res = $navmap->getBySymb($symb);
8209: if (ref($res)) {
8210: if (!$res->resprintable()) {
8211: $noprint = 1;
8212: }
8213: }
8214: }
8215: }
8216: }
8217: if ($noprint) {
8218: return <<"ENDSTYLE";
8219: <style type="text/css" media="print">
8220: body { display:none }
8221: </style>
8222: ENDSTYLE
8223: }
8224: }
8225: return;
8226: }
8227:
8228: =pod
8229:
1.341 albertel 8230: =item * &xml_begin()
8231:
8232: Returns the needed doctype and <html>
8233:
8234: Inputs: none
8235:
8236: =cut
8237:
8238: sub xml_begin {
1.1075.2.61 raeburn 8239: my ($is_frameset) = @_;
1.341 albertel 8240: my $output='';
8241:
8242: if ($env{'browser.mathml'}) {
8243: $output='<?xml version="1.0"?>'
8244: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
8245: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
8246:
8247: # .'<!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">] >'
8248: .'<!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">'
8249: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
8250: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61 raeburn 8251: } elsif ($is_frameset) {
8252: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
8253: '<html>'."\n";
1.341 albertel 8254: } else {
1.1075.2.61 raeburn 8255: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
8256: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 8257: }
8258: return $output;
8259: }
1.340 albertel 8260:
8261: =pod
8262:
1.306 albertel 8263: =item * &start_page()
8264:
8265: Returns a complete <html> .. <body> section for LON-CAPA web pages.
8266:
1.648 raeburn 8267: Inputs:
8268:
8269: =over 4
8270:
8271: $title - optional title for the page
8272:
8273: $head_extra - optional extra HTML to incude inside the <head>
8274:
8275: $args - additional optional args supported are:
8276:
8277: =over 8
8278:
8279: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 8280: arg on
1.814 bisitz 8281: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 8282: add_entries -> additional attributes to add to the <body>
8283: domain -> force to color decorate a page for a
1.317 albertel 8284: specific domain
1.648 raeburn 8285: function -> force usage of a specific rolish color
1.317 albertel 8286: scheme
1.648 raeburn 8287: redirect -> see &headtag()
8288: bgcolor -> override the default page bg color
8289: js_ready -> return a string ready for being used in
1.317 albertel 8290: a javascript writeln
1.648 raeburn 8291: html_encode -> return a string ready for being used in
1.320 albertel 8292: a html attribute
1.648 raeburn 8293: force_register -> if is true will turn on the &bodytag()
1.317 albertel 8294: $forcereg arg
1.648 raeburn 8295: frameset -> if true will start with a <frameset>
1.330 albertel 8296: rather than <body>
1.648 raeburn 8297: skip_phases -> hash ref of
1.338 albertel 8298: head -> skip the <html><head> generation
8299: body -> skip all <body> generation
1.1075.2.12 raeburn 8300: no_inline_link -> if true and in remote mode, don't show the
8301: 'Switch To Inline Menu' link
1.648 raeburn 8302: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 8303: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 8304: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1075.2.123 raeburn 8305: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
8306: to lonhtmlcommon::breadcrumbs
1.1075.2.15 raeburn 8307: group -> includes the current group, if page is for a
8308: specific group
1.1075.2.133 raeburn 8309: use_absolute -> for request for external resource or syllabus, this
8310: will contain https://<hostname> if server uses
8311: https (as per hosts.tab), but request is for http
8312: hostname -> hostname, originally from $r->hostname(), (optional).
1.361 albertel 8313:
1.648 raeburn 8314: =back
1.460 albertel 8315:
1.648 raeburn 8316: =back
1.562 albertel 8317:
1.306 albertel 8318: =cut
8319:
8320: sub start_page {
1.309 albertel 8321: my ($title,$head_extra,$args) = @_;
1.318 albertel 8322: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 8323:
1.315 albertel 8324: $env{'internal.start_page'}++;
1.1075.2.15 raeburn 8325: my ($result,@advtools);
1.964 droeschl 8326:
1.338 albertel 8327: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62 raeburn 8328: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 8329: }
8330:
8331: if (! exists($args->{'skip_phases'}{'body'}) ) {
8332: if ($args->{'frameset'}) {
8333: my $attr_string = &make_attr_string($args->{'force_register'},
8334: $args->{'add_entries'});
8335: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 8336: } else {
8337: $result .=
8338: &bodytag($title,
8339: $args->{'function'}, $args->{'add_entries'},
8340: $args->{'only_body'}, $args->{'domain'},
8341: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12 raeburn 8342: $args->{'bgcolor'}, $args->{'no_inline_link'},
1.1075.2.15 raeburn 8343: $args, \@advtools);
1.831 bisitz 8344: }
1.330 albertel 8345: }
1.338 albertel 8346:
1.315 albertel 8347: if ($args->{'js_ready'}) {
1.713 kaisler 8348: $result = &js_ready($result);
1.315 albertel 8349: }
1.320 albertel 8350: if ($args->{'html_encode'}) {
1.713 kaisler 8351: $result = &html_encode($result);
8352: }
8353:
1.813 bisitz 8354: # Preparation for new and consistent functionlist at top of screen
8355: # if ($args->{'functionlist'}) {
8356: # $result .= &build_functionlist();
8357: #}
8358:
1.964 droeschl 8359: # Don't add anything more if only_body wanted or in const space
8360: return $result if $args->{'only_body'}
8361: || $env{'request.state'} eq 'construct';
1.813 bisitz 8362:
8363: #Breadcrumbs
1.758 kaisler 8364: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
8365: &Apache::lonhtmlcommon::clear_breadcrumbs();
8366: #if any br links exists, add them to the breadcrumbs
8367: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
8368: foreach my $crumb (@{$args->{'bread_crumbs'}}){
8369: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
8370: }
8371: }
1.1075.2.19 raeburn 8372: # if @advtools array contains items add then to the breadcrumbs
8373: if (@advtools > 0) {
8374: &Apache::lonmenu::advtools_crumbs(@advtools);
8375: }
1.1075.2.123 raeburn 8376: my $menulink;
8377: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
8378: if (exists($args->{'bread_crumbs_nomenu'})) {
8379: $menulink = 0;
8380: } else {
8381: undef($menulink);
8382: }
1.758 kaisler 8383: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
8384: if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123 raeburn 8385: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758 kaisler 8386: }else{
1.1075.2.123 raeburn 8387: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 8388: }
1.1075.2.24 raeburn 8389: } elsif (($env{'environment.remote'} eq 'on') &&
8390: ($env{'form.inhibitmenu'} ne 'yes') &&
8391: ($env{'request.noversionuri'} =~ m{^/res/}) &&
8392: ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21 raeburn 8393: $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320 albertel 8394: }
1.315 albertel 8395: return $result;
1.306 albertel 8396: }
8397:
8398: sub end_page {
1.315 albertel 8399: my ($args) = @_;
8400: $env{'internal.end_page'}++;
1.330 albertel 8401: my $result;
1.335 albertel 8402: if ($args->{'discussion'}) {
8403: my ($target,$parser);
8404: if (ref($args->{'discussion'})) {
8405: ($target,$parser) =($args->{'discussion'}{'target'},
8406: $args->{'discussion'}{'parser'});
8407: }
8408: $result .= &Apache::lonxml::xmlend($target,$parser);
8409: }
1.330 albertel 8410: if ($args->{'frameset'}) {
8411: $result .= '</frameset>';
8412: } else {
1.635 raeburn 8413: $result .= &endbodytag($args);
1.330 albertel 8414: }
1.1075.2.6 raeburn 8415: unless ($args->{'notbody'}) {
8416: $result .= "\n</html>";
8417: }
1.330 albertel 8418:
1.315 albertel 8419: if ($args->{'js_ready'}) {
1.317 albertel 8420: $result = &js_ready($result);
1.315 albertel 8421: }
1.335 albertel 8422:
1.320 albertel 8423: if ($args->{'html_encode'}) {
8424: $result = &html_encode($result);
8425: }
1.335 albertel 8426:
1.315 albertel 8427: return $result;
8428: }
8429:
1.1034 www 8430: sub wishlist_window {
8431: return(<<'ENDWISHLIST');
1.1046 raeburn 8432: <script type="text/javascript">
1.1034 www 8433: // <![CDATA[
8434: // <!-- BEGIN LON-CAPA Internal
8435: function set_wishlistlink(title, path) {
8436: if (!title) {
8437: title = document.title;
8438: title = title.replace(/^LON-CAPA /,'');
8439: }
1.1075.2.65 raeburn 8440: title = encodeURIComponent(title);
1.1075.2.83 raeburn 8441: title = title.replace("'","\\\'");
1.1034 www 8442: if (!path) {
8443: path = location.pathname;
8444: }
1.1075.2.65 raeburn 8445: path = encodeURIComponent(path);
1.1075.2.83 raeburn 8446: path = path.replace("'","\\\'");
1.1034 www 8447: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
8448: 'wishlistNewLink','width=560,height=350,scrollbars=0');
8449: }
8450: // END LON-CAPA Internal -->
8451: // ]]>
8452: </script>
8453: ENDWISHLIST
8454: }
8455:
1.1030 www 8456: sub modal_window {
8457: return(<<'ENDMODAL');
1.1046 raeburn 8458: <script type="text/javascript">
1.1030 www 8459: // <![CDATA[
8460: // <!-- BEGIN LON-CAPA Internal
8461: var modalWindow = {
8462: parent:"body",
8463: windowId:null,
8464: content:null,
8465: width:null,
8466: height:null,
8467: close:function()
8468: {
8469: $(".LCmodal-window").remove();
8470: $(".LCmodal-overlay").remove();
8471: },
8472: open:function()
8473: {
8474: var modal = "";
8475: modal += "<div class=\"LCmodal-overlay\"></div>";
8476: modal += "<div id=\"" + this.windowId + "\" class=\"LCmodal-window\" style=\"width:" + this.width + "px; height:" + this.height + "px; margin-top:-" + (this.height / 2) + "px; margin-left:-" + (this.width / 2) + "px;\">";
8477: modal += this.content;
8478: modal += "</div>";
8479:
8480: $(this.parent).append(modal);
8481:
8482: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
8483: $(".LCclose-window").click(function(){modalWindow.close();});
8484: $(".LCmodal-overlay").click(function(){modalWindow.close();});
8485: }
8486: };
1.1075.2.42 raeburn 8487: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 8488: {
1.1075.2.119 raeburn 8489: source = source.replace(/'/g,"'");
1.1030 www 8490: modalWindow.windowId = "myModal";
8491: modalWindow.width = width;
8492: modalWindow.height = height;
1.1075.2.80 raeburn 8493: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 8494: modalWindow.open();
1.1075.2.87 raeburn 8495: };
1.1030 www 8496: // END LON-CAPA Internal -->
8497: // ]]>
8498: </script>
8499: ENDMODAL
8500: }
8501:
8502: sub modal_link {
1.1075.2.42 raeburn 8503: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 8504: unless ($width) { $width=480; }
8505: unless ($height) { $height=400; }
1.1031 www 8506: unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42 raeburn 8507: unless ($transparency) { $transparency='true'; }
8508:
1.1074 raeburn 8509: my $target_attr;
8510: if (defined($target)) {
8511: $target_attr = 'target="'.$target.'"';
8512: }
8513: return <<"ENDLINK";
1.1075.2.143 raeburn 8514: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 8515: ENDLINK
1.1030 www 8516: }
8517:
1.1032 www 8518: sub modal_adhoc_script {
8519: my ($funcname,$width,$height,$content)=@_;
8520: return (<<ENDADHOC);
1.1046 raeburn 8521: <script type="text/javascript">
1.1032 www 8522: // <![CDATA[
8523: var $funcname = function()
8524: {
8525: modalWindow.windowId = "myModal";
8526: modalWindow.width = $width;
8527: modalWindow.height = $height;
8528: modalWindow.content = '$content';
8529: modalWindow.open();
8530: };
8531: // ]]>
8532: </script>
8533: ENDADHOC
8534: }
8535:
1.1041 www 8536: sub modal_adhoc_inner {
8537: my ($funcname,$width,$height,$content)=@_;
8538: my $innerwidth=$width-20;
8539: $content=&js_ready(
1.1042 www 8540: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42 raeburn 8541: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
8542: $content.
1.1041 www 8543: &end_scrollbox().
1.1075.2.42 raeburn 8544: &end_page()
1.1041 www 8545: );
8546: return &modal_adhoc_script($funcname,$width,$height,$content);
8547: }
8548:
8549: sub modal_adhoc_window {
8550: my ($funcname,$width,$height,$content,$linktext)=@_;
8551: return &modal_adhoc_inner($funcname,$width,$height,$content).
8552: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
8553: }
8554:
8555: sub modal_adhoc_launch {
8556: my ($funcname,$width,$height,$content)=@_;
8557: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
8558: <script type="text/javascript">
8559: // <![CDATA[
8560: $funcname();
8561: // ]]>
8562: </script>
8563: ENDLAUNCH
8564: }
8565:
8566: sub modal_adhoc_close {
8567: return (<<ENDCLOSE);
8568: <script type="text/javascript">
8569: // <![CDATA[
8570: modalWindow.close();
8571: // ]]>
8572: </script>
8573: ENDCLOSE
8574: }
8575:
1.1038 www 8576: sub togglebox_script {
8577: return(<<ENDTOGGLE);
8578: <script type="text/javascript">
8579: // <![CDATA[
8580: function LCtoggleDisplay(id,hidetext,showtext) {
8581: link = document.getElementById(id + "link").childNodes[0];
8582: with (document.getElementById(id).style) {
8583: if (display == "none" ) {
8584: display = "inline";
8585: link.nodeValue = hidetext;
8586: } else {
8587: display = "none";
8588: link.nodeValue = showtext;
8589: }
8590: }
8591: }
8592: // ]]>
8593: </script>
8594: ENDTOGGLE
8595: }
8596:
1.1039 www 8597: sub start_togglebox {
8598: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
8599: unless ($heading) { $heading=''; } else { $heading.=' '; }
8600: unless ($showtext) { $showtext=&mt('show'); }
8601: unless ($hidetext) { $hidetext=&mt('hide'); }
8602: unless ($headerbg) { $headerbg='#FFFFFF'; }
8603: return &start_data_table().
8604: &start_data_table_header_row().
8605: '<td bgcolor="'.$headerbg.'">'.$heading.
8606: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
8607: $showtext.'\')">'.$showtext.'</a>]</td>'.
8608: &end_data_table_header_row().
8609: '<tr id="'.$id.'" style="display:none""><td>';
8610: }
8611:
8612: sub end_togglebox {
8613: return '</td></tr>'.&end_data_table();
8614: }
8615:
1.1041 www 8616: sub LCprogressbar_script {
1.1075.2.130 raeburn 8617: my ($id,$number_to_do)=@_;
8618: if ($number_to_do) {
8619: return(<<ENDPROGRESS);
1.1041 www 8620: <script type="text/javascript">
8621: // <![CDATA[
1.1045 www 8622: \$('#progressbar$id').progressbar({
1.1041 www 8623: value: 0,
8624: change: function(event, ui) {
8625: var newVal = \$(this).progressbar('option', 'value');
8626: \$('.pblabel', this).text(LCprogressTxt);
8627: }
8628: });
8629: // ]]>
8630: </script>
8631: ENDPROGRESS
1.1075.2.130 raeburn 8632: } else {
8633: return(<<ENDPROGRESS);
8634: <script type="text/javascript">
8635: // <![CDATA[
8636: \$('#progressbar$id').progressbar({
8637: value: false,
8638: create: function(event, ui) {
8639: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
8640: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
8641: }
8642: });
8643: // ]]>
8644: </script>
8645: ENDPROGRESS
8646: }
1.1041 www 8647: }
8648:
8649: sub LCprogressbarUpdate_script {
8650: return(<<ENDPROGRESSUPDATE);
8651: <style type="text/css">
8652: .ui-progressbar { position:relative; }
1.1075.2.130 raeburn 8653: .progress-label {position: absolute; width: 100%; text-align: center; top: 1px; font-weight: bold; text-shadow: 1px 1px 0 #fff;margin: 0; line-height: 200%; }
1.1041 www 8654: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
8655: </style>
8656: <script type="text/javascript">
8657: // <![CDATA[
1.1045 www 8658: var LCprogressTxt='---';
8659:
1.1075.2.130 raeburn 8660: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 8661: LCprogressTxt=progresstext;
1.1075.2.130 raeburn 8662: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
8663: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
8664: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
8665: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
8666: } else {
8667: \$('#progressbar'+id).progressbar('value',percent);
8668: }
1.1041 www 8669: }
8670: // ]]>
8671: </script>
8672: ENDPROGRESSUPDATE
8673: }
8674:
1.1042 www 8675: my $LClastpercent;
1.1045 www 8676: my $LCidcnt;
8677: my $LCcurrentid;
1.1042 www 8678:
1.1041 www 8679: sub LCprogressbar {
1.1075.2.130 raeburn 8680: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 8681: $LClastpercent=0;
1.1045 www 8682: $LCidcnt++;
8683: $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130 raeburn 8684: my ($starting,$content);
8685: if ($number_to_do) {
8686: $starting=&mt('Starting');
8687: $content=(<<ENDPROGBAR);
8688: $preamble
1.1045 www 8689: <div id="progressbar$LCcurrentid">
1.1041 www 8690: <span class="pblabel">$starting</span>
8691: </div>
8692: ENDPROGBAR
1.1075.2.130 raeburn 8693: } else {
8694: $starting=&mt('Loading...');
8695: $LClastpercent='false';
8696: $content=(<<ENDPROGBAR);
8697: $preamble
8698: <div id="progressbar$LCcurrentid">
8699: <div class="progress-label">$starting</div>
8700: </div>
8701: ENDPROGBAR
8702: }
8703: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 8704: }
8705:
8706: sub LCprogressbarUpdate {
1.1075.2.130 raeburn 8707: my ($r,$val,$text,$number_to_do)=@_;
8708: if ($number_to_do) {
8709: unless ($val) {
8710: if ($LClastpercent) {
8711: $val=$LClastpercent;
8712: } else {
8713: $val=0;
8714: }
8715: }
8716: if ($val<0) { $val=0; }
8717: if ($val>100) { $val=0; }
8718: $LClastpercent=$val;
8719: unless ($text) { $text=$val.'%'; }
8720: } else {
8721: $val = 'false';
1.1042 www 8722: }
1.1041 www 8723: $text=&js_ready($text);
1.1044 www 8724: &r_print($r,<<ENDUPDATE);
1.1041 www 8725: <script type="text/javascript">
8726: // <![CDATA[
1.1075.2.130 raeburn 8727: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 8728: // ]]>
8729: </script>
8730: ENDUPDATE
1.1035 www 8731: }
8732:
1.1042 www 8733: sub LCprogressbarClose {
8734: my ($r)=@_;
8735: $LClastpercent=0;
1.1044 www 8736: &r_print($r,<<ENDCLOSE);
1.1042 www 8737: <script type="text/javascript">
8738: // <![CDATA[
1.1045 www 8739: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 8740: // ]]>
8741: </script>
8742: ENDCLOSE
1.1044 www 8743: }
8744:
8745: sub r_print {
8746: my ($r,$to_print)=@_;
8747: if ($r) {
8748: $r->print($to_print);
8749: $r->rflush();
8750: } else {
8751: print($to_print);
8752: }
1.1042 www 8753: }
8754:
1.320 albertel 8755: sub html_encode {
8756: my ($result) = @_;
8757:
1.322 albertel 8758: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 8759:
8760: return $result;
8761: }
1.1044 www 8762:
1.317 albertel 8763: sub js_ready {
8764: my ($result) = @_;
8765:
1.323 albertel 8766: $result =~ s/[\n\r]/ /xmsg;
8767: $result =~ s/\\/\\\\/xmsg;
8768: $result =~ s/'/\\'/xmsg;
1.372 albertel 8769: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 8770:
8771: return $result;
8772: }
8773:
1.315 albertel 8774: sub validate_page {
8775: if ( exists($env{'internal.start_page'})
1.316 albertel 8776: && $env{'internal.start_page'} > 1) {
8777: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 8778: $env{'internal.start_page'}.' '.
1.316 albertel 8779: $ENV{'request.filename'});
1.315 albertel 8780: }
8781: if ( exists($env{'internal.end_page'})
1.316 albertel 8782: && $env{'internal.end_page'} > 1) {
8783: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 8784: $env{'internal.end_page'}.' '.
1.316 albertel 8785: $env{'request.filename'});
1.315 albertel 8786: }
8787: if ( exists($env{'internal.start_page'})
8788: && ! exists($env{'internal.end_page'})) {
1.316 albertel 8789: &Apache::lonnet::logthis('start_page called without end_page '.
8790: $env{'request.filename'});
1.315 albertel 8791: }
8792: if ( ! exists($env{'internal.start_page'})
8793: && exists($env{'internal.end_page'})) {
1.316 albertel 8794: &Apache::lonnet::logthis('end_page called without start_page'.
8795: $env{'request.filename'});
1.315 albertel 8796: }
1.306 albertel 8797: }
1.315 albertel 8798:
1.996 www 8799:
8800: sub start_scrollbox {
1.1075.2.56 raeburn 8801: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 8802: unless ($outerwidth) { $outerwidth='520px'; }
8803: unless ($width) { $width='500px'; }
8804: unless ($height) { $height='200px'; }
1.1075 raeburn 8805: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 8806: if ($id ne '') {
1.1075.2.42 raeburn 8807: $table_id = ' id="table_'.$id.'"';
8808: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 8809: }
1.1075 raeburn 8810: if ($bgcolor ne '') {
8811: $tdcol = "background-color: $bgcolor;";
8812: }
1.1075.2.42 raeburn 8813: my $nicescroll_js;
8814: if ($env{'browser.mobile'}) {
8815: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
8816: }
1.1075 raeburn 8817: return <<"END";
1.1075.2.42 raeburn 8818: $nicescroll_js
8819:
8820: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56 raeburn 8821: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075 raeburn 8822: END
1.996 www 8823: }
8824:
8825: sub end_scrollbox {
1.1036 www 8826: return '</div></td></tr></table>';
1.996 www 8827: }
8828:
1.1075.2.42 raeburn 8829: sub nicescroll_javascript {
8830: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
8831: my %options;
8832: if (ref($cursor) eq 'HASH') {
8833: %options = %{$cursor};
8834: }
8835: unless ($options{'railalign'} =~ /^left|right$/) {
8836: $options{'railalign'} = 'left';
8837: }
8838: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8839: my $function = &get_users_function();
8840: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
8841: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
8842: $options{'cursorcolor'} = '#00F';
8843: }
8844: }
8845: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
8846: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
8847: $options{'cursoropacity'}='1.0';
8848: }
8849: } else {
8850: $options{'cursoropacity'}='1.0';
8851: }
8852: if ($options{'cursorfixedheight'} eq 'none') {
8853: delete($options{'cursorfixedheight'});
8854: } else {
8855: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
8856: }
8857: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
8858: delete($options{'railoffset'});
8859: }
8860: my @niceoptions;
8861: while (my($key,$value) = each(%options)) {
8862: if ($value =~ /^\{.+\}$/) {
8863: push(@niceoptions,$key.':'.$value);
8864: } else {
8865: push(@niceoptions,$key.':"'.$value.'"');
8866: }
8867: }
8868: my $nicescroll_js = '
8869: $(document).ready(
8870: function() {
8871: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
8872: }
8873: );
8874: ';
8875: if ($framecheck) {
8876: $nicescroll_js .= '
8877: function expand_div(caller) {
8878: if (top === self) {
8879: document.getElementById("'.$id.'").style.width = "auto";
8880: document.getElementById("'.$id.'").style.height = "auto";
8881: } else {
8882: try {
8883: if (parent.frames) {
8884: if (parent.frames.length > 1) {
8885: var framesrc = parent.frames[1].location.href;
8886: var currsrc = framesrc.replace(/\#.*$/,"");
8887: if ((caller == "search") || (currsrc == "'.$location.'")) {
8888: document.getElementById("'.$id.'").style.width = "auto";
8889: document.getElementById("'.$id.'").style.height = "auto";
8890: }
8891: }
8892: }
8893: } catch (e) {
8894: return;
8895: }
8896: }
8897: return;
8898: }
8899: ';
8900: }
8901: if ($needjsready) {
8902: $nicescroll_js = '
8903: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
8904: } else {
8905: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
8906: }
8907: return $nicescroll_js;
8908: }
8909:
1.318 albertel 8910: sub simple_error_page {
1.1075.2.49 raeburn 8911: my ($r,$title,$msg,$args) = @_;
8912: if (ref($args) eq 'HASH') {
8913: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
8914: } else {
8915: $msg = &mt($msg);
8916: }
8917:
1.318 albertel 8918: my $page =
8919: &Apache::loncommon::start_page($title).
1.1075.2.49 raeburn 8920: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 8921: &Apache::loncommon::end_page();
8922: if (ref($r)) {
8923: $r->print($page);
1.327 albertel 8924: return;
1.318 albertel 8925: }
8926: return $page;
8927: }
1.347 albertel 8928:
8929: {
1.610 albertel 8930: my @row_count;
1.961 onken 8931:
8932: sub start_data_table_count {
8933: unshift(@row_count, 0);
8934: return;
8935: }
8936:
8937: sub end_data_table_count {
8938: shift(@row_count);
8939: return;
8940: }
8941:
1.347 albertel 8942: sub start_data_table {
1.1018 raeburn 8943: my ($add_class,$id) = @_;
1.422 albertel 8944: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 8945: my $table_id;
8946: if (defined($id)) {
8947: $table_id = ' id="'.$id.'"';
8948: }
1.961 onken 8949: &start_data_table_count();
1.1018 raeburn 8950: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 8951: }
8952:
8953: sub end_data_table {
1.961 onken 8954: &end_data_table_count();
1.389 albertel 8955: return '</table>'."\n";;
1.347 albertel 8956: }
8957:
8958: sub start_data_table_row {
1.974 wenzelju 8959: my ($add_class, $id) = @_;
1.610 albertel 8960: $row_count[0]++;
8961: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 8962: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 8963: $id = (' id="'.$id.'"') unless ($id eq '');
8964: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 8965: }
1.471 banghart 8966:
8967: sub continue_data_table_row {
1.974 wenzelju 8968: my ($add_class, $id) = @_;
1.610 albertel 8969: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 8970: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
8971: $id = (' id="'.$id.'"') unless ($id eq '');
8972: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 8973: }
1.347 albertel 8974:
8975: sub end_data_table_row {
1.389 albertel 8976: return '</tr>'."\n";;
1.347 albertel 8977: }
1.367 www 8978:
1.421 albertel 8979: sub start_data_table_empty_row {
1.707 bisitz 8980: # $row_count[0]++;
1.421 albertel 8981: return '<tr class="LC_empty_row" >'."\n";;
8982: }
8983:
8984: sub end_data_table_empty_row {
8985: return '</tr>'."\n";;
8986: }
8987:
1.367 www 8988: sub start_data_table_header_row {
1.389 albertel 8989: return '<tr class="LC_header_row">'."\n";;
1.367 www 8990: }
8991:
8992: sub end_data_table_header_row {
1.389 albertel 8993: return '</tr>'."\n";;
1.367 www 8994: }
1.890 droeschl 8995:
8996: sub data_table_caption {
8997: my $caption = shift;
8998: return "<caption class=\"LC_caption\">$caption</caption>";
8999: }
1.347 albertel 9000: }
9001:
1.548 albertel 9002: =pod
9003:
9004: =item * &inhibit_menu_check($arg)
9005:
9006: Checks for a inhibitmenu state and generates output to preserve it
9007:
9008: Inputs: $arg - can be any of
9009: - undef - in which case the return value is a string
9010: to add into arguments list of a uri
9011: - 'input' - in which case the return value is a HTML
9012: <form> <input> field of type hidden to
9013: preserve the value
9014: - a url - in which case the return value is the url with
9015: the neccesary cgi args added to preserve the
9016: inhibitmenu state
9017: - a ref to a url - no return value, but the string is
9018: updated to include the neccessary cgi
9019: args to preserve the inhibitmenu state
9020:
9021: =cut
9022:
9023: sub inhibit_menu_check {
9024: my ($arg) = @_;
9025: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
9026: if ($arg eq 'input') {
9027: if ($env{'form.inhibitmenu'}) {
9028: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
9029: } else {
9030: return
9031: }
9032: }
9033: if ($env{'form.inhibitmenu'}) {
9034: if (ref($arg)) {
9035: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9036: } elsif ($arg eq '') {
9037: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
9038: } else {
9039: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9040: }
9041: }
9042: if (!ref($arg)) {
9043: return $arg;
9044: }
9045: }
9046:
1.251 albertel 9047: ###############################################
1.182 matthew 9048:
9049: =pod
9050:
1.549 albertel 9051: =back
9052:
9053: =head1 User Information Routines
9054:
9055: =over 4
9056:
1.405 albertel 9057: =item * &get_users_function()
1.182 matthew 9058:
9059: Used by &bodytag to determine the current users primary role.
9060: Returns either 'student','coordinator','admin', or 'author'.
9061:
9062: =cut
9063:
9064: ###############################################
9065: sub get_users_function {
1.815 tempelho 9066: my $function = 'norole';
1.818 tempelho 9067: if ($env{'request.role'}=~/^(st)/) {
9068: $function='student';
9069: }
1.907 raeburn 9070: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 9071: $function='coordinator';
9072: }
1.258 albertel 9073: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 9074: $function='admin';
9075: }
1.826 bisitz 9076: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 9077: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 9078: $function='author';
9079: }
9080: return $function;
1.54 www 9081: }
1.99 www 9082:
9083: ###############################################
9084:
1.233 raeburn 9085: =pod
9086:
1.821 raeburn 9087: =item * &show_course()
9088:
9089: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
9090: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
9091:
9092: Inputs:
9093: None
9094:
9095: Outputs:
9096: Scalar: 1 if 'Course' to be used, 0 otherwise.
9097:
9098: =cut
9099:
9100: ###############################################
9101: sub show_course {
9102: my $course = !$env{'user.adv'};
9103: if (!$env{'user.adv'}) {
9104: foreach my $env (keys(%env)) {
9105: next if ($env !~ m/^user\.priv\./);
9106: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
9107: $course = 0;
9108: last;
9109: }
9110: }
9111: }
9112: return $course;
9113: }
9114:
9115: ###############################################
9116:
9117: =pod
9118:
1.542 raeburn 9119: =item * &check_user_status()
1.274 raeburn 9120:
9121: Determines current status of supplied role for a
9122: specific user. Roles can be active, previous or future.
9123:
9124: Inputs:
9125: user's domain, user's username, course's domain,
1.375 raeburn 9126: course's number, optional section ID.
1.274 raeburn 9127:
9128: Outputs:
9129: role status: active, previous or future.
9130:
9131: =cut
9132:
9133: sub check_user_status {
1.412 raeburn 9134: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 9135: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85 raeburn 9136: my @uroles = keys(%userinfo);
1.274 raeburn 9137: my $srchstr;
9138: my $active_chk = 'none';
1.412 raeburn 9139: my $now = time;
1.274 raeburn 9140: if (@uroles > 0) {
1.908 raeburn 9141: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 9142: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
9143: } else {
1.412 raeburn 9144: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
9145: }
9146: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 9147: my $role_end = 0;
9148: my $role_start = 0;
9149: $active_chk = 'active';
1.412 raeburn 9150: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
9151: $role_end = $1;
9152: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
9153: $role_start = $1;
1.274 raeburn 9154: }
9155: }
9156: if ($role_start > 0) {
1.412 raeburn 9157: if ($now < $role_start) {
1.274 raeburn 9158: $active_chk = 'future';
9159: }
9160: }
9161: if ($role_end > 0) {
1.412 raeburn 9162: if ($now > $role_end) {
1.274 raeburn 9163: $active_chk = 'previous';
9164: }
9165: }
9166: }
9167: }
9168: return $active_chk;
9169: }
9170:
9171: ###############################################
9172:
9173: =pod
9174:
1.405 albertel 9175: =item * &get_sections()
1.233 raeburn 9176:
9177: Determines all the sections for a course including
9178: sections with students and sections containing other roles.
1.419 raeburn 9179: Incoming parameters:
9180:
9181: 1. domain
9182: 2. course number
9183: 3. reference to array containing roles for which sections should
9184: be gathered (optional).
9185: 4. reference to array containing status types for which sections
9186: should be gathered (optional).
9187:
9188: If the third argument is undefined, sections are gathered for any role.
9189: If the fourth argument is undefined, sections are gathered for any status.
9190: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 9191:
1.374 raeburn 9192: Returns section hash (keys are section IDs, values are
9193: number of users in each section), subject to the
1.419 raeburn 9194: optional roles filter, optional status filter
1.233 raeburn 9195:
9196: =cut
9197:
9198: ###############################################
9199: sub get_sections {
1.419 raeburn 9200: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 9201: if (!defined($cdom) || !defined($cnum)) {
9202: my $cid = $env{'request.course.id'};
9203:
9204: return if (!defined($cid));
9205:
9206: $cdom = $env{'course.'.$cid.'.domain'};
9207: $cnum = $env{'course.'.$cid.'.num'};
9208: }
9209:
9210: my %sectioncount;
1.419 raeburn 9211: my $now = time;
1.240 albertel 9212:
1.1075.2.33 raeburn 9213: my $check_students = 1;
9214: my $only_students = 0;
9215: if (ref($possible_roles) eq 'ARRAY') {
9216: if (grep(/^st$/,@{$possible_roles})) {
9217: if (@{$possible_roles} == 1) {
9218: $only_students = 1;
9219: }
9220: } else {
9221: $check_students = 0;
9222: }
9223: }
9224:
9225: if ($check_students) {
1.276 albertel 9226: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 9227: my $sec_index = &Apache::loncoursedata::CL_SECTION();
9228: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 9229: my $start_index = &Apache::loncoursedata::CL_START();
9230: my $end_index = &Apache::loncoursedata::CL_END();
9231: my $status;
1.366 albertel 9232: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 9233: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
9234: $data->[$status_index],
9235: $data->[$start_index],
9236: $data->[$end_index]);
9237: if ($stu_status eq 'Active') {
9238: $status = 'active';
9239: } elsif ($end < $now) {
9240: $status = 'previous';
9241: } elsif ($start > $now) {
9242: $status = 'future';
9243: }
9244: if ($section ne '-1' && $section !~ /^\s*$/) {
9245: if ((!defined($possible_status)) || (($status ne '') &&
9246: (grep/^\Q$status\E$/,@{$possible_status}))) {
9247: $sectioncount{$section}++;
9248: }
1.240 albertel 9249: }
9250: }
9251: }
1.1075.2.33 raeburn 9252: if ($only_students) {
9253: return %sectioncount;
9254: }
1.240 albertel 9255: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9256: foreach my $user (sort(keys(%courseroles))) {
9257: if ($user !~ /^(\w{2})/) { next; }
9258: my ($role) = ($user =~ /^(\w{2})/);
9259: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 9260: my ($section,$status);
1.240 albertel 9261: if ($role eq 'cr' &&
9262: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
9263: $section=$1;
9264: }
9265: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
9266: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 9267: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
9268: if ($end == -1 && $start == -1) {
9269: next; #deleted role
9270: }
9271: if (!defined($possible_status)) {
9272: $sectioncount{$section}++;
9273: } else {
9274: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
9275: $status = 'active';
9276: } elsif ($end < $now) {
9277: $status = 'future';
9278: } elsif ($start > $now) {
9279: $status = 'previous';
9280: }
9281: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
9282: $sectioncount{$section}++;
9283: }
9284: }
1.233 raeburn 9285: }
1.366 albertel 9286: return %sectioncount;
1.233 raeburn 9287: }
9288:
1.274 raeburn 9289: ###############################################
1.294 raeburn 9290:
9291: =pod
1.405 albertel 9292:
9293: =item * &get_course_users()
9294:
1.275 raeburn 9295: Retrieves usernames:domains for users in the specified course
9296: with specific role(s), and access status.
9297:
9298: Incoming parameters:
1.277 albertel 9299: 1. course domain
9300: 2. course number
9301: 3. access status: users must have - either active,
1.275 raeburn 9302: previous, future, or all.
1.277 albertel 9303: 4. reference to array of permissible roles
1.288 raeburn 9304: 5. reference to array of section restrictions (optional)
9305: 6. reference to results object (hash of hashes).
9306: 7. reference to optional userdata hash
1.609 raeburn 9307: 8. reference to optional statushash
1.630 raeburn 9308: 9. flag if privileged users (except those set to unhide in
9309: course settings) should be excluded
1.609 raeburn 9310: Keys of top level results hash are roles.
1.275 raeburn 9311: Keys of inner hashes are username:domain, with
9312: values set to access type.
1.288 raeburn 9313: Optional userdata hash returns an array with arguments in the
9314: same order as loncoursedata::get_classlist() for student data.
9315:
1.609 raeburn 9316: Optional statushash returns
9317:
1.288 raeburn 9318: Entries for end, start, section and status are blank because
9319: of the possibility of multiple values for non-student roles.
9320:
1.275 raeburn 9321: =cut
1.405 albertel 9322:
1.275 raeburn 9323: ###############################################
1.405 albertel 9324:
1.275 raeburn 9325: sub get_course_users {
1.630 raeburn 9326: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 9327: my %idx = ();
1.419 raeburn 9328: my %seclists;
1.288 raeburn 9329:
9330: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
9331: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
9332: $idx{end} = &Apache::loncoursedata::CL_END();
9333: $idx{start} = &Apache::loncoursedata::CL_START();
9334: $idx{id} = &Apache::loncoursedata::CL_ID();
9335: $idx{section} = &Apache::loncoursedata::CL_SECTION();
9336: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
9337: $idx{status} = &Apache::loncoursedata::CL_STATUS();
9338:
1.290 albertel 9339: if (grep(/^st$/,@{$roles})) {
1.276 albertel 9340: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 9341: my $now = time;
1.277 albertel 9342: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 9343: my $match = 0;
1.412 raeburn 9344: my $secmatch = 0;
1.419 raeburn 9345: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 9346: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 9347: if ($section eq '') {
9348: $section = 'none';
9349: }
1.291 albertel 9350: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9351: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9352: $secmatch = 1;
9353: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 9354: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9355: $secmatch = 1;
9356: }
9357: } else {
1.419 raeburn 9358: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 9359: $secmatch = 1;
9360: }
1.290 albertel 9361: }
1.412 raeburn 9362: if (!$secmatch) {
9363: next;
9364: }
1.419 raeburn 9365: }
1.275 raeburn 9366: if (defined($$types{'active'})) {
1.288 raeburn 9367: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 9368: push(@{$$users{st}{$student}},'active');
1.288 raeburn 9369: $match = 1;
1.275 raeburn 9370: }
9371: }
9372: if (defined($$types{'previous'})) {
1.609 raeburn 9373: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 9374: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 9375: $match = 1;
1.275 raeburn 9376: }
9377: }
9378: if (defined($$types{'future'})) {
1.609 raeburn 9379: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 9380: push(@{$$users{st}{$student}},'future');
1.288 raeburn 9381: $match = 1;
1.275 raeburn 9382: }
9383: }
1.609 raeburn 9384: if ($match) {
9385: push(@{$seclists{$student}},$section);
9386: if (ref($userdata) eq 'HASH') {
9387: $$userdata{$student} = $$classlist{$student};
9388: }
9389: if (ref($statushash) eq 'HASH') {
9390: $statushash->{$student}{'st'}{$section} = $status;
9391: }
1.288 raeburn 9392: }
1.275 raeburn 9393: }
9394: }
1.412 raeburn 9395: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 9396: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9397: my $now = time;
1.609 raeburn 9398: my %displaystatus = ( previous => 'Expired',
9399: active => 'Active',
9400: future => 'Future',
9401: );
1.1075.2.36 raeburn 9402: my (%nothide,@possdoms);
1.630 raeburn 9403: if ($hidepriv) {
9404: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
9405: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
9406: if ($user !~ /:/) {
9407: $nothide{join(':',split(/[\@]/,$user))}=1;
9408: } else {
9409: $nothide{$user} = 1;
9410: }
9411: }
1.1075.2.36 raeburn 9412: my @possdoms = ($cdom);
9413: if ($coursehash{'checkforpriv'}) {
9414: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
9415: }
1.630 raeburn 9416: }
1.439 raeburn 9417: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 9418: my $match = 0;
1.412 raeburn 9419: my $secmatch = 0;
1.439 raeburn 9420: my $status;
1.412 raeburn 9421: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 9422: $user =~ s/:$//;
1.439 raeburn 9423: my ($end,$start) = split(/:/,$coursepersonnel{$person});
9424: if ($end == -1 || $start == -1) {
9425: next;
9426: }
9427: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
9428: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 9429: my ($uname,$udom) = split(/:/,$user);
9430: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9431: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9432: $secmatch = 1;
9433: } elsif ($usec eq '') {
1.420 albertel 9434: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9435: $secmatch = 1;
9436: }
9437: } else {
9438: if (grep(/^\Q$usec\E$/,@{$sections})) {
9439: $secmatch = 1;
9440: }
9441: }
9442: if (!$secmatch) {
9443: next;
9444: }
1.288 raeburn 9445: }
1.419 raeburn 9446: if ($usec eq '') {
9447: $usec = 'none';
9448: }
1.275 raeburn 9449: if ($uname ne '' && $udom ne '') {
1.630 raeburn 9450: if ($hidepriv) {
1.1075.2.36 raeburn 9451: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 9452: (!$nothide{$uname.':'.$udom})) {
9453: next;
9454: }
9455: }
1.503 raeburn 9456: if ($end > 0 && $end < $now) {
1.439 raeburn 9457: $status = 'previous';
9458: } elsif ($start > $now) {
9459: $status = 'future';
9460: } else {
9461: $status = 'active';
9462: }
1.277 albertel 9463: foreach my $type (keys(%{$types})) {
1.275 raeburn 9464: if ($status eq $type) {
1.420 albertel 9465: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 9466: push(@{$$users{$role}{$user}},$type);
9467: }
1.288 raeburn 9468: $match = 1;
9469: }
9470: }
1.419 raeburn 9471: if (($match) && (ref($userdata) eq 'HASH')) {
9472: if (!exists($$userdata{$uname.':'.$udom})) {
9473: &get_user_info($udom,$uname,\%idx,$userdata);
9474: }
1.420 albertel 9475: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 9476: push(@{$seclists{$uname.':'.$udom}},$usec);
9477: }
1.609 raeburn 9478: if (ref($statushash) eq 'HASH') {
9479: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
9480: }
1.275 raeburn 9481: }
9482: }
9483: }
9484: }
1.290 albertel 9485: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 9486: if ((defined($cdom)) && (defined($cnum))) {
9487: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
9488: if ( defined($csettings{'internal.courseowner'}) ) {
9489: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 9490: next if ($owner eq '');
9491: my ($ownername,$ownerdom);
9492: if ($owner =~ /^([^:]+):([^:]+)$/) {
9493: $ownername = $1;
9494: $ownerdom = $2;
9495: } else {
9496: $ownername = $owner;
9497: $ownerdom = $cdom;
9498: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 9499: }
9500: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 9501: if (defined($userdata) &&
1.609 raeburn 9502: !exists($$userdata{$owner})) {
9503: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
9504: if (!grep(/^none$/,@{$seclists{$owner}})) {
9505: push(@{$seclists{$owner}},'none');
9506: }
9507: if (ref($statushash) eq 'HASH') {
9508: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 9509: }
1.290 albertel 9510: }
1.279 raeburn 9511: }
9512: }
9513: }
1.419 raeburn 9514: foreach my $user (keys(%seclists)) {
9515: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
9516: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
9517: }
1.275 raeburn 9518: }
9519: return;
9520: }
9521:
1.288 raeburn 9522: sub get_user_info {
9523: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 9524: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
9525: &plainname($uname,$udom,'lastname');
1.291 albertel 9526: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 9527: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 9528: my %idhash = &Apache::lonnet::idrget($udom,($uname));
9529: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 9530: return;
9531: }
1.275 raeburn 9532:
1.472 raeburn 9533: ###############################################
9534:
9535: =pod
9536:
9537: =item * &get_user_quota()
9538:
1.1075.2.41 raeburn 9539: Retrieves quota assigned for storage of user files.
9540: Default is to report quota for portfolio files.
1.472 raeburn 9541:
9542: Incoming parameters:
9543: 1. user's username
9544: 2. user's domain
1.1075.2.41 raeburn 9545: 3. quota name - portfolio, author, or course
9546: (if no quota name provided, defaults to portfolio).
1.1075.2.59 raeburn 9547: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42 raeburn 9548: course
1.472 raeburn 9549:
9550: Returns:
1.1075.2.58 raeburn 9551: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 9552: 2. (Optional) Type of setting: custom or default
9553: (individually assigned or default for user's
9554: institutional status).
9555: 3. (Optional) - User's institutional status (e.g., faculty, staff
9556: or student - types as defined in localenroll::inst_usertypes
9557: for user's domain, which determines default quota for user.
9558: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 9559:
9560: If a value has been stored in the user's environment,
1.536 raeburn 9561: it will return that, otherwise it returns the maximal default
1.1075.2.41 raeburn 9562: defined for the user's institutional status(es) in the domain.
1.472 raeburn 9563:
9564: =cut
9565:
9566: ###############################################
9567:
9568:
9569: sub get_user_quota {
1.1075.2.42 raeburn 9570: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 9571: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 9572: if (!defined($udom)) {
9573: $udom = $env{'user.domain'};
9574: }
9575: if (!defined($uname)) {
9576: $uname = $env{'user.name'};
9577: }
9578: if (($udom eq '' || $uname eq '') ||
9579: ($udom eq 'public') && ($uname eq 'public')) {
9580: $quota = 0;
1.536 raeburn 9581: $quotatype = 'default';
9582: $defquota = 0;
1.472 raeburn 9583: } else {
1.536 raeburn 9584: my $inststatus;
1.1075.2.41 raeburn 9585: if ($quotaname eq 'course') {
9586: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
9587: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
9588: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
9589: } else {
9590: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
9591: $quota = $cenv{'internal.uploadquota'};
9592: }
1.536 raeburn 9593: } else {
1.1075.2.41 raeburn 9594: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
9595: if ($quotaname eq 'author') {
9596: $quota = $env{'environment.authorquota'};
9597: } else {
9598: $quota = $env{'environment.portfolioquota'};
9599: }
9600: $inststatus = $env{'environment.inststatus'};
9601: } else {
9602: my %userenv =
9603: &Apache::lonnet::get('environment',['portfolioquota',
9604: 'authorquota','inststatus'],$udom,$uname);
9605: my ($tmp) = keys(%userenv);
9606: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9607: if ($quotaname eq 'author') {
9608: $quota = $userenv{'authorquota'};
9609: } else {
9610: $quota = $userenv{'portfolioquota'};
9611: }
9612: $inststatus = $userenv{'inststatus'};
9613: } else {
9614: undef(%userenv);
9615: }
9616: }
9617: }
9618: if ($quota eq '' || wantarray) {
9619: if ($quotaname eq 'course') {
9620: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59 raeburn 9621: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
9622: ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42 raeburn 9623: $defquota = $domdefs{$crstype.'quota'};
9624: }
9625: if ($defquota eq '') {
9626: $defquota = 500;
9627: }
1.1075.2.41 raeburn 9628: } else {
9629: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
9630: }
9631: if ($quota eq '') {
9632: $quota = $defquota;
9633: $quotatype = 'default';
9634: } else {
9635: $quotatype = 'custom';
9636: }
1.472 raeburn 9637: }
9638: }
1.536 raeburn 9639: if (wantarray) {
9640: return ($quota,$quotatype,$settingstatus,$defquota);
9641: } else {
9642: return $quota;
9643: }
1.472 raeburn 9644: }
9645:
9646: ###############################################
9647:
9648: =pod
9649:
9650: =item * &default_quota()
9651:
1.536 raeburn 9652: Retrieves default quota assigned for storage of user portfolio files,
9653: given an (optional) user's institutional status.
1.472 raeburn 9654:
9655: Incoming parameters:
1.1075.2.42 raeburn 9656:
1.472 raeburn 9657: 1. domain
1.536 raeburn 9658: 2. (Optional) institutional status(es). This is a : separated list of
9659: status types (e.g., faculty, staff, student etc.)
9660: which apply to the user for whom the default is being retrieved.
9661: If the institutional status string in undefined, the domain
1.1075.2.41 raeburn 9662: default quota will be returned.
9663: 3. quota name - portfolio, author, or course
9664: (if no quota name provided, defaults to portfolio).
1.472 raeburn 9665:
9666: Returns:
1.1075.2.42 raeburn 9667:
1.1075.2.58 raeburn 9668: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 9669: 2. (Optional) institutional type which determined the value of the
9670: default quota.
1.472 raeburn 9671:
9672: If a value has been stored in the domain's configuration db,
9673: it will return that, otherwise it returns 20 (for backwards
9674: compatibility with domains which have not set up a configuration
1.1075.2.58 raeburn 9675: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 9676:
1.536 raeburn 9677: If the user's status includes multiple types (e.g., staff and student),
9678: the largest default quota which applies to the user determines the
9679: default quota returned.
9680:
1.472 raeburn 9681: =cut
9682:
9683: ###############################################
9684:
9685:
9686: sub default_quota {
1.1075.2.41 raeburn 9687: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 9688: my ($defquota,$settingstatus);
9689: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 9690: ['quotas'],$udom);
1.1075.2.41 raeburn 9691: my $key = 'defaultquota';
9692: if ($quotaname eq 'author') {
9693: $key = 'authorquota';
9694: }
1.622 raeburn 9695: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 9696: if ($inststatus ne '') {
1.765 raeburn 9697: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 9698: foreach my $item (@statuses) {
1.1075.2.41 raeburn 9699: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9700: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 9701: if ($defquota eq '') {
1.1075.2.41 raeburn 9702: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9703: $settingstatus = $item;
1.1075.2.41 raeburn 9704: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
9705: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9706: $settingstatus = $item;
9707: }
9708: }
1.1075.2.41 raeburn 9709: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9710: if ($quotahash{'quotas'}{$item} ne '') {
9711: if ($defquota eq '') {
9712: $defquota = $quotahash{'quotas'}{$item};
9713: $settingstatus = $item;
9714: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
9715: $defquota = $quotahash{'quotas'}{$item};
9716: $settingstatus = $item;
9717: }
1.536 raeburn 9718: }
9719: }
9720: }
9721: }
9722: if ($defquota eq '') {
1.1075.2.41 raeburn 9723: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9724: $defquota = $quotahash{'quotas'}{$key}{'default'};
9725: } elsif ($key eq 'defaultquota') {
1.711 raeburn 9726: $defquota = $quotahash{'quotas'}{'default'};
9727: }
1.536 raeburn 9728: $settingstatus = 'default';
1.1075.2.42 raeburn 9729: if ($defquota eq '') {
9730: if ($quotaname eq 'author') {
9731: $defquota = 500;
9732: }
9733: }
1.536 raeburn 9734: }
9735: } else {
9736: $settingstatus = 'default';
1.1075.2.41 raeburn 9737: if ($quotaname eq 'author') {
9738: $defquota = 500;
9739: } else {
9740: $defquota = 20;
9741: }
1.536 raeburn 9742: }
9743: if (wantarray) {
9744: return ($defquota,$settingstatus);
1.472 raeburn 9745: } else {
1.536 raeburn 9746: return $defquota;
1.472 raeburn 9747: }
9748: }
9749:
1.1075.2.41 raeburn 9750: ###############################################
9751:
9752: =pod
9753:
1.1075.2.42 raeburn 9754: =item * &excess_filesize_warning()
1.1075.2.41 raeburn 9755:
9756: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42 raeburn 9757: of existing file within authoring space will cause quota for the authoring
9758: space to be exceeded.
9759:
9760: Same, if upload of a file directly to a course/community via Course Editor
9761: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41 raeburn 9762:
1.1075.2.61 raeburn 9763: Inputs: 7
1.1075.2.42 raeburn 9764: 1. username or coursenum
1.1075.2.41 raeburn 9765: 2. domain
1.1075.2.42 raeburn 9766: 3. context ('author' or 'course')
1.1075.2.41 raeburn 9767: 4. filename of file for which action is being requested
9768: 5. filesize (kB) of file
9769: 6. action being taken: copy or upload.
1.1075.2.59 raeburn 9770: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41 raeburn 9771:
9772: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
9773: otherwise return null.
9774:
1.1075.2.42 raeburn 9775: =back
9776:
1.1075.2.41 raeburn 9777: =cut
9778:
1.1075.2.42 raeburn 9779: sub excess_filesize_warning {
1.1075.2.59 raeburn 9780: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42 raeburn 9781: my $current_disk_usage = 0;
1.1075.2.59 raeburn 9782: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42 raeburn 9783: if ($context eq 'author') {
9784: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
9785: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
9786: } else {
9787: foreach my $subdir ('docs','supplemental') {
9788: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
9789: }
9790: }
1.1075.2.41 raeburn 9791: $disk_quota = int($disk_quota * 1000);
9792: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69 raeburn 9793: return '<p class="LC_warning">'.
1.1075.2.41 raeburn 9794: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69 raeburn 9795: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
9796: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41 raeburn 9797: $disk_quota,$current_disk_usage).
9798: '</p>';
9799: }
9800: return;
9801: }
9802:
9803: ###############################################
9804:
9805:
1.384 raeburn 9806: sub get_secgrprole_info {
9807: my ($cdom,$cnum,$needroles,$type) = @_;
9808: my %sections_count = &get_sections($cdom,$cnum);
9809: my @sections = (sort {$a <=> $b} keys(%sections_count));
9810: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
9811: my @groups = sort(keys(%curr_groups));
9812: my $allroles = [];
9813: my $rolehash;
9814: my $accesshash = {
9815: active => 'Currently has access',
9816: future => 'Will have future access',
9817: previous => 'Previously had access',
9818: };
9819: if ($needroles) {
9820: $rolehash = {'all' => 'all'};
1.385 albertel 9821: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9822: if (&Apache::lonnet::error(%user_roles)) {
9823: undef(%user_roles);
9824: }
9825: foreach my $item (keys(%user_roles)) {
1.384 raeburn 9826: my ($role)=split(/\:/,$item,2);
9827: if ($role eq 'cr') { next; }
9828: if ($role =~ /^cr/) {
9829: $$rolehash{$role} = (split('/',$role))[3];
9830: } else {
9831: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
9832: }
9833: }
9834: foreach my $key (sort(keys(%{$rolehash}))) {
9835: push(@{$allroles},$key);
9836: }
9837: push (@{$allroles},'st');
9838: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
9839: }
9840: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
9841: }
9842:
1.555 raeburn 9843: sub user_picker {
1.1075.2.127 raeburn 9844: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 9845: my $currdom = $dom;
1.1075.2.114 raeburn 9846: my @alldoms = &Apache::lonnet::all_domains();
9847: if (@alldoms == 1) {
9848: my %domsrch = &Apache::lonnet::get_dom('configuration',
9849: ['directorysrch'],$alldoms[0]);
9850: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
9851: my $showdom = $domdesc;
9852: if ($showdom eq '') {
9853: $showdom = $dom;
9854: }
9855: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
9856: if ((!$domsrch{'directorysrch'}{'available'}) &&
9857: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
9858: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
9859: }
9860: }
9861: }
1.555 raeburn 9862: my %curr_selected = (
9863: srchin => 'dom',
1.580 raeburn 9864: srchby => 'lastname',
1.555 raeburn 9865: );
9866: my $srchterm;
1.625 raeburn 9867: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 9868: if ($srch->{'srchby'} ne '') {
9869: $curr_selected{'srchby'} = $srch->{'srchby'};
9870: }
9871: if ($srch->{'srchin'} ne '') {
9872: $curr_selected{'srchin'} = $srch->{'srchin'};
9873: }
9874: if ($srch->{'srchtype'} ne '') {
9875: $curr_selected{'srchtype'} = $srch->{'srchtype'};
9876: }
9877: if ($srch->{'srchdomain'} ne '') {
9878: $currdom = $srch->{'srchdomain'};
9879: }
9880: $srchterm = $srch->{'srchterm'};
9881: }
1.1075.2.98 raeburn 9882: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 9883: 'usr' => 'Search criteria',
1.563 raeburn 9884: 'doma' => 'Domain/institution to search',
1.558 albertel 9885: 'uname' => 'username',
9886: 'lastname' => 'last name',
1.555 raeburn 9887: 'lastfirst' => 'last name, first name',
1.558 albertel 9888: 'crs' => 'in this course',
1.576 raeburn 9889: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 9890: 'alc' => 'all LON-CAPA',
1.573 raeburn 9891: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 9892: 'exact' => 'is',
9893: 'contains' => 'contains',
1.569 raeburn 9894: 'begins' => 'begins with',
1.1075.2.98 raeburn 9895: );
9896: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 9897: 'youm' => "You must include some text to search for.",
9898: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
9899: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
9900: 'yomc' => "You must choose a domain when using an institutional directory search.",
9901: 'ymcd' => "You must choose a domain when using a domain search.",
9902: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
9903: 'whse' => "When searching by last,first you must include at least one character in the first name.",
9904: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 9905: );
1.1075.2.98 raeburn 9906: &html_escape(\%html_lt);
9907: &js_escape(\%js_lt);
1.1075.2.115 raeburn 9908: my $domform;
1.1075.2.126 raeburn 9909: my $allow_blank = 1;
1.1075.2.115 raeburn 9910: if ($fixeddom) {
1.1075.2.126 raeburn 9911: $allow_blank = 0;
9912: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115 raeburn 9913: } else {
1.1075.2.126 raeburn 9914: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115 raeburn 9915: }
1.563 raeburn 9916: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 9917:
9918: my @srchins = ('crs','dom','alc','instd');
9919:
9920: foreach my $option (@srchins) {
9921: # FIXME 'alc' option unavailable until
9922: # loncreateuser::print_user_query_page()
9923: # has been completed.
9924: next if ($option eq 'alc');
1.880 raeburn 9925: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 9926: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127 raeburn 9927: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 9928: if ($curr_selected{'srchin'} eq $option) {
9929: $srchinsel .= '
1.1075.2.98 raeburn 9930: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 9931: } else {
9932: $srchinsel .= '
1.1075.2.98 raeburn 9933: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 9934: }
1.555 raeburn 9935: }
1.563 raeburn 9936: $srchinsel .= "\n </select>\n";
1.555 raeburn 9937:
9938: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 9939: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 9940: if ($curr_selected{'srchby'} eq $option) {
9941: $srchbysel .= '
1.1075.2.98 raeburn 9942: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 9943: } else {
9944: $srchbysel .= '
1.1075.2.98 raeburn 9945: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 9946: }
9947: }
9948: $srchbysel .= "\n </select>\n";
9949:
9950: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 9951: foreach my $option ('begins','contains','exact') {
1.555 raeburn 9952: if ($curr_selected{'srchtype'} eq $option) {
9953: $srchtypesel .= '
1.1075.2.98 raeburn 9954: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 9955: } else {
9956: $srchtypesel .= '
1.1075.2.98 raeburn 9957: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 9958: }
9959: }
9960: $srchtypesel .= "\n </select>\n";
9961:
1.558 albertel 9962: my ($newuserscript,$new_user_create);
1.994 raeburn 9963: my $context_dom = $env{'request.role.domain'};
9964: if ($context eq 'requestcrs') {
9965: if ($env{'form.coursedom'} ne '') {
9966: $context_dom = $env{'form.coursedom'};
9967: }
9968: }
1.556 raeburn 9969: if ($forcenewuser) {
1.576 raeburn 9970: if (ref($srch) eq 'HASH') {
1.994 raeburn 9971: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 9972: if ($cancreate) {
9973: $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>';
9974: } else {
1.799 bisitz 9975: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 9976: my %usertypetext = (
9977: official => 'institutional',
9978: unofficial => 'non-institutional',
9979: );
1.799 bisitz 9980: $new_user_create = '<p class="LC_warning">'
9981: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
9982: .' '
9983: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
9984: ,'<a href="'.$helplink.'">','</a>')
9985: .'</p><br />';
1.627 raeburn 9986: }
1.576 raeburn 9987: }
9988: }
9989:
1.556 raeburn 9990: $newuserscript = <<"ENDSCRIPT";
9991:
1.570 raeburn 9992: function setSearch(createnew,callingForm) {
1.556 raeburn 9993: if (createnew == 1) {
1.570 raeburn 9994: for (var i=0; i<callingForm.srchby.length; i++) {
9995: if (callingForm.srchby.options[i].value == 'uname') {
9996: callingForm.srchby.selectedIndex = i;
1.556 raeburn 9997: }
9998: }
1.570 raeburn 9999: for (var i=0; i<callingForm.srchin.length; i++) {
10000: if ( callingForm.srchin.options[i].value == 'dom') {
10001: callingForm.srchin.selectedIndex = i;
1.556 raeburn 10002: }
10003: }
1.570 raeburn 10004: for (var i=0; i<callingForm.srchtype.length; i++) {
10005: if (callingForm.srchtype.options[i].value == 'exact') {
10006: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 10007: }
10008: }
1.570 raeburn 10009: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 10010: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 10011: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 10012: }
10013: }
10014: }
10015: }
10016: ENDSCRIPT
1.558 albertel 10017:
1.556 raeburn 10018: }
10019:
1.555 raeburn 10020: my $output = <<"END_BLOCK";
1.556 raeburn 10021: <script type="text/javascript">
1.824 bisitz 10022: // <![CDATA[
1.570 raeburn 10023: function validateEntry(callingForm) {
1.558 albertel 10024:
1.556 raeburn 10025: var checkok = 1;
1.558 albertel 10026: var srchin;
1.570 raeburn 10027: for (var i=0; i<callingForm.srchin.length; i++) {
10028: if ( callingForm.srchin[i].checked ) {
10029: srchin = callingForm.srchin[i].value;
1.558 albertel 10030: }
10031: }
10032:
1.570 raeburn 10033: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
10034: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
10035: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
10036: var srchterm = callingForm.srchterm.value;
10037: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 10038: var msg = "";
10039:
10040: if (srchterm == "") {
10041: checkok = 0;
1.1075.2.98 raeburn 10042: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 10043: }
10044:
1.569 raeburn 10045: if (srchtype== 'begins') {
10046: if (srchterm.length < 2) {
10047: checkok = 0;
1.1075.2.98 raeburn 10048: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 10049: }
10050: }
10051:
1.556 raeburn 10052: if (srchtype== 'contains') {
10053: if (srchterm.length < 3) {
10054: checkok = 0;
1.1075.2.98 raeburn 10055: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 10056: }
10057: }
10058: if (srchin == 'instd') {
10059: if (srchdomain == '') {
10060: checkok = 0;
1.1075.2.98 raeburn 10061: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 10062: }
10063: }
10064: if (srchin == 'dom') {
10065: if (srchdomain == '') {
10066: checkok = 0;
1.1075.2.98 raeburn 10067: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 10068: }
10069: }
10070: if (srchby == 'lastfirst') {
10071: if (srchterm.indexOf(",") == -1) {
10072: checkok = 0;
1.1075.2.98 raeburn 10073: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 10074: }
10075: if (srchterm.indexOf(",") == srchterm.length -1) {
10076: checkok = 0;
1.1075.2.98 raeburn 10077: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 10078: }
10079: }
10080: if (checkok == 0) {
1.1075.2.98 raeburn 10081: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 10082: return;
10083: }
10084: if (checkok == 1) {
1.570 raeburn 10085: callingForm.submit();
1.556 raeburn 10086: }
10087: }
10088:
10089: $newuserscript
10090:
1.824 bisitz 10091: // ]]>
1.556 raeburn 10092: </script>
1.558 albertel 10093:
10094: $new_user_create
10095:
1.555 raeburn 10096: END_BLOCK
1.558 albertel 10097:
1.876 raeburn 10098: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98 raeburn 10099: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 10100: $domform.
10101: &Apache::lonhtmlcommon::row_closure().
1.1075.2.98 raeburn 10102: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 10103: $srchbysel.
10104: $srchtypesel.
10105: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
10106: $srchinsel.
10107: &Apache::lonhtmlcommon::row_closure(1).
10108: &Apache::lonhtmlcommon::end_pick_box().
10109: '<br />';
1.1075.2.114 raeburn 10110: return ($output,1);
1.555 raeburn 10111: }
10112:
1.612 raeburn 10113: sub user_rule_check {
1.615 raeburn 10114: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99 raeburn 10115: my ($response,%inst_response);
1.612 raeburn 10116: if (ref($usershash) eq 'HASH') {
1.1075.2.99 raeburn 10117: if (keys(%{$usershash}) > 1) {
10118: my (%by_username,%by_id,%userdoms);
10119: my $checkid;
1.612 raeburn 10120: if (ref($checks) eq 'HASH') {
1.1075.2.99 raeburn 10121: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
10122: $checkid = 1;
10123: }
10124: }
10125: foreach my $user (keys(%{$usershash})) {
10126: my ($uname,$udom) = split(/:/,$user);
10127: if ($checkid) {
10128: if (ref($usershash->{$user}) eq 'HASH') {
10129: if ($usershash->{$user}->{'id'} ne '') {
10130: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
10131: $userdoms{$udom} = 1;
10132: if (ref($inst_results) eq 'HASH') {
10133: $inst_results->{$uname.':'.$udom} = {};
10134: }
10135: }
10136: }
10137: } else {
10138: $by_username{$udom}{$uname} = 1;
10139: $userdoms{$udom} = 1;
10140: if (ref($inst_results) eq 'HASH') {
10141: $inst_results->{$uname.':'.$udom} = {};
10142: }
10143: }
10144: }
10145: foreach my $udom (keys(%userdoms)) {
10146: if (!$got_rules->{$udom}) {
10147: my %domconfig = &Apache::lonnet::get_dom('configuration',
10148: ['usercreation'],$udom);
10149: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10150: foreach my $item ('username','id') {
10151: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10152: $$curr_rules{$udom}{$item} =
10153: $domconfig{'usercreation'}{$item.'_rule'};
10154: }
10155: }
10156: }
10157: $got_rules->{$udom} = 1;
10158: }
10159: }
10160: if ($checkid) {
10161: foreach my $udom (keys(%by_id)) {
10162: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
10163: if ($outcome eq 'ok') {
10164: foreach my $id (keys(%{$by_id{$udom}})) {
10165: my $uname = $by_id{$udom}{$id};
10166: $inst_response{$uname.':'.$udom} = $outcome;
10167: }
10168: if (ref($results) eq 'HASH') {
10169: foreach my $uname (keys(%{$results})) {
10170: if (exists($inst_response{$uname.':'.$udom})) {
10171: $inst_response{$uname.':'.$udom} = $outcome;
10172: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10173: }
10174: }
10175: }
10176: }
1.612 raeburn 10177: }
1.615 raeburn 10178: } else {
1.1075.2.99 raeburn 10179: foreach my $udom (keys(%by_username)) {
10180: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
10181: if ($outcome eq 'ok') {
10182: foreach my $uname (keys(%{$by_username{$udom}})) {
10183: $inst_response{$uname.':'.$udom} = $outcome;
10184: }
10185: if (ref($results) eq 'HASH') {
10186: foreach my $uname (keys(%{$results})) {
10187: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10188: }
10189: }
10190: }
10191: }
1.612 raeburn 10192: }
1.1075.2.99 raeburn 10193: } elsif (keys(%{$usershash}) == 1) {
10194: my $user = (keys(%{$usershash}))[0];
10195: my ($uname,$udom) = split(/:/,$user);
10196: if (($udom ne '') && ($uname ne '')) {
10197: if (ref($usershash->{$user}) eq 'HASH') {
10198: if (ref($checks) eq 'HASH') {
10199: if (defined($checks->{'username'})) {
10200: ($inst_response{$user},%{$inst_results->{$user}}) =
10201: &Apache::lonnet::get_instuser($udom,$uname);
10202: } elsif (defined($checks->{'id'})) {
10203: if ($usershash->{$user}->{'id'} ne '') {
10204: ($inst_response{$user},%{$inst_results->{$user}}) =
10205: &Apache::lonnet::get_instuser($udom,undef,
10206: $usershash->{$user}->{'id'});
10207: } else {
10208: ($inst_response{$user},%{$inst_results->{$user}}) =
10209: &Apache::lonnet::get_instuser($udom,$uname);
10210: }
10211: }
10212: } else {
10213: ($inst_response{$user},%{$inst_results->{$user}}) =
10214: &Apache::lonnet::get_instuser($udom,$uname);
10215: return;
10216: }
10217: if (!$got_rules->{$udom}) {
10218: my %domconfig = &Apache::lonnet::get_dom('configuration',
10219: ['usercreation'],$udom);
10220: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10221: foreach my $item ('username','id') {
10222: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10223: $$curr_rules{$udom}{$item} =
10224: $domconfig{'usercreation'}{$item.'_rule'};
10225: }
10226: }
1.585 raeburn 10227: }
1.1075.2.99 raeburn 10228: $got_rules->{$udom} = 1;
1.585 raeburn 10229: }
10230: }
1.1075.2.99 raeburn 10231: } else {
10232: return;
10233: }
10234: } else {
10235: return;
10236: }
10237: foreach my $user (keys(%{$usershash})) {
10238: my ($uname,$udom) = split(/:/,$user);
10239: next if (($udom eq '') || ($uname eq ''));
10240: my $id;
10241: if (ref($inst_results) eq 'HASH') {
10242: if (ref($inst_results->{$user}) eq 'HASH') {
10243: $id = $inst_results->{$user}->{'id'};
10244: }
10245: }
10246: if ($id eq '') {
10247: if (ref($usershash->{$user})) {
10248: $id = $usershash->{$user}->{'id'};
10249: }
1.585 raeburn 10250: }
1.612 raeburn 10251: foreach my $item (keys(%{$checks})) {
10252: if (ref($$curr_rules{$udom}) eq 'HASH') {
10253: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
10254: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99 raeburn 10255: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
10256: $$curr_rules{$udom}{$item});
1.612 raeburn 10257: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
10258: if ($rule_check{$rule}) {
10259: $$rulematch{$user}{$item} = $rule;
1.1075.2.99 raeburn 10260: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 10261: if (ref($inst_results) eq 'HASH') {
10262: if (ref($inst_results->{$user}) eq 'HASH') {
10263: if (keys(%{$inst_results->{$user}}) == 0) {
10264: $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99 raeburn 10265: } elsif ($item eq 'id') {
10266: if ($inst_results->{$user}->{'id'} eq '') {
10267: $$alerts{$item}{$udom}{$uname} = 1;
10268: }
1.615 raeburn 10269: }
1.612 raeburn 10270: }
10271: }
1.615 raeburn 10272: }
10273: last;
1.585 raeburn 10274: }
10275: }
10276: }
10277: }
10278: }
10279: }
10280: }
10281: }
1.612 raeburn 10282: return;
10283: }
10284:
10285: sub user_rule_formats {
10286: my ($domain,$domdesc,$curr_rules,$check) = @_;
10287: my %text = (
10288: 'username' => 'Usernames',
10289: 'id' => 'IDs',
10290: );
10291: my $output;
10292: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
10293: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
10294: if (@{$ruleorder} > 0) {
1.1075.2.20 raeburn 10295: $output = '<br />'.
10296: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
10297: '<span class="LC_cusr_emph">','</span>',$domdesc).
10298: ' <ul>';
1.612 raeburn 10299: foreach my $rule (@{$ruleorder}) {
10300: if (ref($curr_rules) eq 'ARRAY') {
10301: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
10302: if (ref($rules->{$rule}) eq 'HASH') {
10303: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
10304: $rules->{$rule}{'desc'}.'</li>';
10305: }
10306: }
10307: }
10308: }
10309: $output .= '</ul>';
10310: }
10311: }
10312: return $output;
10313: }
10314:
10315: sub instrule_disallow_msg {
1.615 raeburn 10316: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 10317: my $response;
10318: my %text = (
10319: item => 'username',
10320: items => 'usernames',
10321: match => 'matches',
10322: do => 'does',
10323: action => 'a username',
10324: one => 'one',
10325: );
10326: if ($count > 1) {
10327: $text{'item'} = 'usernames';
10328: $text{'match'} ='match';
10329: $text{'do'} = 'do';
10330: $text{'action'} = 'usernames',
10331: $text{'one'} = 'ones';
10332: }
10333: if ($checkitem eq 'id') {
10334: $text{'items'} = 'IDs';
10335: $text{'item'} = 'ID';
10336: $text{'action'} = 'an ID';
1.615 raeburn 10337: if ($count > 1) {
10338: $text{'item'} = 'IDs';
10339: $text{'action'} = 'IDs';
10340: }
1.612 raeburn 10341: }
1.674 bisitz 10342: $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 10343: if ($mode eq 'upload') {
10344: if ($checkitem eq 'username') {
10345: $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'}.");
10346: } elsif ($checkitem eq 'id') {
1.674 bisitz 10347: $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 10348: }
1.669 raeburn 10349: } elsif ($mode eq 'selfcreate') {
10350: if ($checkitem eq 'id') {
10351: $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.");
10352: }
1.615 raeburn 10353: } else {
10354: if ($checkitem eq 'username') {
10355: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
10356: } elsif ($checkitem eq 'id') {
10357: $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.");
10358: }
1.612 raeburn 10359: }
10360: return $response;
1.585 raeburn 10361: }
10362:
1.624 raeburn 10363: sub personal_data_fieldtitles {
10364: my %fieldtitles = &Apache::lonlocal::texthash (
10365: id => 'Student/Employee ID',
10366: permanentemail => 'E-mail address',
10367: lastname => 'Last Name',
10368: firstname => 'First Name',
10369: middlename => 'Middle Name',
10370: generation => 'Generation',
10371: gen => 'Generation',
1.765 raeburn 10372: inststatus => 'Affiliation',
1.624 raeburn 10373: );
10374: return %fieldtitles;
10375: }
10376:
1.642 raeburn 10377: sub sorted_inst_types {
10378: my ($dom) = @_;
1.1075.2.70 raeburn 10379: my ($usertypes,$order);
10380: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
10381: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
10382: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
10383: $order = $domdefaults{'inststatus'}{'inststatusorder'};
10384: } else {
10385: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
10386: }
1.642 raeburn 10387: my $othertitle = &mt('All users');
10388: if ($env{'request.course.id'}) {
1.668 raeburn 10389: $othertitle = &mt('Any users');
1.642 raeburn 10390: }
10391: my @types;
10392: if (ref($order) eq 'ARRAY') {
10393: @types = @{$order};
10394: }
10395: if (@types == 0) {
10396: if (ref($usertypes) eq 'HASH') {
10397: @types = sort(keys(%{$usertypes}));
10398: }
10399: }
10400: if (keys(%{$usertypes}) > 0) {
10401: $othertitle = &mt('Other users');
10402: }
10403: return ($othertitle,$usertypes,\@types);
10404: }
10405:
1.645 raeburn 10406: sub get_institutional_codes {
10407: my ($settings,$allcourses,$LC_code) = @_;
10408: # Get complete list of course sections to update
10409: my @currsections = ();
10410: my @currxlists = ();
10411: my $coursecode = $$settings{'internal.coursecode'};
10412:
10413: if ($$settings{'internal.sectionnums'} ne '') {
10414: @currsections = split(/,/,$$settings{'internal.sectionnums'});
10415: }
10416:
10417: if ($$settings{'internal.crosslistings'} ne '') {
10418: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
10419: }
10420:
10421: if (@currxlists > 0) {
10422: foreach (@currxlists) {
10423: if (m/^([^:]+):(\w*)$/) {
10424: unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119 raeburn 10425: push(@{$allcourses},$1);
1.645 raeburn 10426: $$LC_code{$1} = $2;
10427: }
10428: }
10429: }
10430: }
10431:
10432: if (@currsections > 0) {
10433: foreach (@currsections) {
10434: if (m/^(\w+):(\w*)$/) {
10435: my $sec = $coursecode.$1;
10436: my $lc_sec = $2;
10437: unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119 raeburn 10438: push(@{$allcourses},$sec);
1.645 raeburn 10439: $$LC_code{$sec} = $lc_sec;
10440: }
10441: }
10442: }
10443: }
10444: return;
10445: }
10446:
1.971 raeburn 10447: sub get_standard_codeitems {
10448: return ('Year','Semester','Department','Number','Section');
10449: }
10450:
1.112 bowersj2 10451: =pod
10452:
1.780 raeburn 10453: =head1 Slot Helpers
10454:
10455: =over 4
10456:
10457: =item * sorted_slots()
10458:
1.1040 raeburn 10459: Sorts an array of slot names in order of an optional sort key,
10460: default sort is by slot start time (earliest first).
1.780 raeburn 10461:
10462: Inputs:
10463:
10464: =over 4
10465:
10466: slotsarr - Reference to array of unsorted slot names.
10467:
10468: slots - Reference to hash of hash, where outer hash keys are slot names.
10469:
1.1040 raeburn 10470: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
10471:
1.549 albertel 10472: =back
10473:
1.780 raeburn 10474: Returns:
10475:
10476: =over 4
10477:
1.1040 raeburn 10478: sorted - An array of slot names sorted by a specified sort key
10479: (default sort key is start time of the slot).
1.780 raeburn 10480:
10481: =back
10482:
10483: =cut
10484:
10485:
10486: sub sorted_slots {
1.1040 raeburn 10487: my ($slotsarr,$slots,$sortkey) = @_;
10488: if ($sortkey eq '') {
10489: $sortkey = 'starttime';
10490: }
1.780 raeburn 10491: my @sorted;
10492: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
10493: @sorted =
10494: sort {
10495: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 10496: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 10497: }
10498: if (ref($slots->{$a})) { return -1;}
10499: if (ref($slots->{$b})) { return 1;}
10500: return 0;
10501: } @{$slotsarr};
10502: }
10503: return @sorted;
10504: }
10505:
1.1040 raeburn 10506: =pod
10507:
10508: =item * get_future_slots()
10509:
10510: Inputs:
10511:
10512: =over 4
10513:
10514: cnum - course number
10515:
10516: cdom - course domain
10517:
10518: now - current UNIX time
10519:
10520: symb - optional symb
10521:
10522: =back
10523:
10524: Returns:
10525:
10526: =over 4
10527:
10528: sorted_reservable - ref to array of student_schedulable slots currently
10529: reservable, ordered by end date of reservation period.
10530:
10531: reservable_now - ref to hash of student_schedulable slots currently
10532: reservable.
10533:
10534: Keys in inner hash are:
10535: (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104 raeburn 10536: (b) endreserve: end date of reservation period.
10537: (c) uniqueperiod: start,end dates when slot is to be uniquely
10538: selected.
1.1040 raeburn 10539:
10540: sorted_future - ref to array of student_schedulable slots reservable in
10541: the future, ordered by start date of reservation period.
10542:
10543: future_reservable - ref to hash of student_schedulable slots reservable
10544: in the future.
10545:
10546: Keys in inner hash are:
10547: (a) symb: either blank or symb to which slot use is restricted.
10548: (b) startreserve: start date of reservation period.
1.1075.2.104 raeburn 10549: (c) uniqueperiod: start,end dates when slot is to be uniquely
10550: selected.
1.1040 raeburn 10551:
10552: =back
10553:
10554: =cut
10555:
10556: sub get_future_slots {
10557: my ($cnum,$cdom,$now,$symb) = @_;
10558: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
10559: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
10560: foreach my $slot (keys(%slots)) {
10561: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
10562: if ($symb) {
10563: next if (($slots{$slot}->{'symb'} ne '') &&
10564: ($slots{$slot}->{'symb'} ne $symb));
10565: }
10566: if (($slots{$slot}->{'starttime'} > $now) &&
10567: ($slots{$slot}->{'endtime'} > $now)) {
10568: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
10569: my $userallowed = 0;
10570: if ($slots{$slot}->{'allowedsections'}) {
10571: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
10572: if (!defined($env{'request.role.sec'})
10573: && grep(/^No section assigned$/,@allowed_sec)) {
10574: $userallowed=1;
10575: } else {
10576: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
10577: $userallowed=1;
10578: }
10579: }
10580: unless ($userallowed) {
10581: if (defined($env{'request.course.groups'})) {
10582: my @groups = split(/:/,$env{'request.course.groups'});
10583: foreach my $group (@groups) {
10584: if (grep(/^\Q$group\E$/,@allowed_sec)) {
10585: $userallowed=1;
10586: last;
10587: }
10588: }
10589: }
10590: }
10591: }
10592: if ($slots{$slot}->{'allowedusers'}) {
10593: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
10594: my $user = $env{'user.name'}.':'.$env{'user.domain'};
10595: if (grep(/^\Q$user\E$/,@allowed_users)) {
10596: $userallowed = 1;
10597: }
10598: }
10599: next unless($userallowed);
10600: }
10601: my $startreserve = $slots{$slot}->{'startreserve'};
10602: my $endreserve = $slots{$slot}->{'endreserve'};
10603: my $symb = $slots{$slot}->{'symb'};
1.1075.2.104 raeburn 10604: my $uniqueperiod;
10605: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
10606: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
10607: }
1.1040 raeburn 10608: if (($startreserve < $now) &&
10609: (!$endreserve || $endreserve > $now)) {
10610: my $lastres = $endreserve;
10611: if (!$lastres) {
10612: $lastres = $slots{$slot}->{'starttime'};
10613: }
10614: $reservable_now{$slot} = {
10615: symb => $symb,
1.1075.2.104 raeburn 10616: endreserve => $lastres,
10617: uniqueperiod => $uniqueperiod,
1.1040 raeburn 10618: };
10619: } elsif (($startreserve > $now) &&
10620: (!$endreserve || $endreserve > $startreserve)) {
10621: $future_reservable{$slot} = {
10622: symb => $symb,
1.1075.2.104 raeburn 10623: startreserve => $startreserve,
10624: uniqueperiod => $uniqueperiod,
1.1040 raeburn 10625: };
10626: }
10627: }
10628: }
10629: my @unsorted_reservable = keys(%reservable_now);
10630: if (@unsorted_reservable > 0) {
10631: @sorted_reservable =
10632: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
10633: }
10634: my @unsorted_future = keys(%future_reservable);
10635: if (@unsorted_future > 0) {
10636: @sorted_future =
10637: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
10638: }
10639: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
10640: }
1.780 raeburn 10641:
10642: =pod
10643:
1.1057 foxr 10644: =back
10645:
1.549 albertel 10646: =head1 HTTP Helpers
10647:
10648: =over 4
10649:
1.648 raeburn 10650: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 10651:
1.258 albertel 10652: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 10653: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 10654: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 10655:
10656: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
10657: $possible_names is an ref to an array of form element names. As an example:
10658: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 10659: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 10660:
10661: =cut
1.1 albertel 10662:
1.6 albertel 10663: sub get_unprocessed_cgi {
1.25 albertel 10664: my ($query,$possible_names)= @_;
1.26 matthew 10665: # $Apache::lonxml::debug=1;
1.356 albertel 10666: foreach my $pair (split(/&/,$query)) {
10667: my ($name, $value) = split(/=/,$pair);
1.369 www 10668: $name = &unescape($name);
1.25 albertel 10669: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
10670: $value =~ tr/+/ /;
10671: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 10672: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 10673: }
1.16 harris41 10674: }
1.6 albertel 10675: }
10676:
1.112 bowersj2 10677: =pod
10678:
1.648 raeburn 10679: =item * &cacheheader()
1.112 bowersj2 10680:
10681: returns cache-controlling header code
10682:
10683: =cut
10684:
1.7 albertel 10685: sub cacheheader {
1.258 albertel 10686: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 10687: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
10688: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 10689: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
10690: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 10691: return $output;
1.7 albertel 10692: }
10693:
1.112 bowersj2 10694: =pod
10695:
1.648 raeburn 10696: =item * &no_cache($r)
1.112 bowersj2 10697:
10698: specifies header code to not have cache
10699:
10700: =cut
10701:
1.9 albertel 10702: sub no_cache {
1.216 albertel 10703: my ($r) = @_;
10704: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 10705: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 10706: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
10707: $r->no_cache(1);
10708: $r->header_out("Expires" => $date);
10709: $r->header_out("Pragma" => "no-cache");
1.123 www 10710: }
10711:
10712: sub content_type {
1.181 albertel 10713: my ($r,$type,$charset) = @_;
1.299 foxr 10714: if ($r) {
10715: # Note that printout.pl calls this with undef for $r.
10716: &no_cache($r);
10717: }
1.258 albertel 10718: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 10719: unless ($charset) {
10720: $charset=&Apache::lonlocal::current_encoding;
10721: }
10722: if ($charset) { $type.='; charset='.$charset; }
10723: if ($r) {
10724: $r->content_type($type);
10725: } else {
10726: print("Content-type: $type\n\n");
10727: }
1.9 albertel 10728: }
1.25 albertel 10729:
1.112 bowersj2 10730: =pod
10731:
1.648 raeburn 10732: =item * &add_to_env($name,$value)
1.112 bowersj2 10733:
1.258 albertel 10734: adds $name to the %env hash with value
1.112 bowersj2 10735: $value, if $name already exists, the entry is converted to an array
10736: reference and $value is added to the array.
10737:
10738: =cut
10739:
1.25 albertel 10740: sub add_to_env {
10741: my ($name,$value)=@_;
1.258 albertel 10742: if (defined($env{$name})) {
10743: if (ref($env{$name})) {
1.25 albertel 10744: #already have multiple values
1.258 albertel 10745: push(@{ $env{$name} },$value);
1.25 albertel 10746: } else {
10747: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 10748: my $first=$env{$name};
10749: undef($env{$name});
10750: push(@{ $env{$name} },$first,$value);
1.25 albertel 10751: }
10752: } else {
1.258 albertel 10753: $env{$name}=$value;
1.25 albertel 10754: }
1.31 albertel 10755: }
1.149 albertel 10756:
10757: =pod
10758:
1.648 raeburn 10759: =item * &get_env_multiple($name)
1.149 albertel 10760:
1.258 albertel 10761: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 10762: values may be defined and end up as an array ref.
10763:
10764: returns an array of values
10765:
10766: =cut
10767:
10768: sub get_env_multiple {
10769: my ($name) = @_;
10770: my @values;
1.258 albertel 10771: if (defined($env{$name})) {
1.149 albertel 10772: # exists is it an array
1.258 albertel 10773: if (ref($env{$name})) {
10774: @values=@{ $env{$name} };
1.149 albertel 10775: } else {
1.258 albertel 10776: $values[0]=$env{$name};
1.149 albertel 10777: }
10778: }
10779: return(@values);
10780: }
10781:
1.660 raeburn 10782: sub ask_for_embedded_content {
10783: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 10784: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11 raeburn 10785: %currsubfile,%unused,$rem);
1.1071 raeburn 10786: my $counter = 0;
10787: my $numnew = 0;
1.987 raeburn 10788: my $numremref = 0;
10789: my $numinvalid = 0;
10790: my $numpathchg = 0;
10791: my $numexisting = 0;
1.1071 raeburn 10792: my $numunused = 0;
10793: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53 raeburn 10794: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 10795: my $heading = &mt('Upload embedded files');
10796: my $buttontext = &mt('Upload');
10797:
1.1075.2.11 raeburn 10798: if ($env{'request.course.id'}) {
1.1075.2.35 raeburn 10799: if ($actionurl eq '/adm/dependencies') {
10800: $navmap = Apache::lonnavmaps::navmap->new();
10801: }
10802: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10803: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11 raeburn 10804: }
1.1075.2.35 raeburn 10805: if (($actionurl eq '/adm/portfolio') ||
10806: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 10807: my $current_path='/';
10808: if ($env{'form.currentpath'}) {
10809: $current_path = $env{'form.currentpath'};
10810: }
10811: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35 raeburn 10812: $udom = $cdom;
10813: $uname = $cnum;
1.984 raeburn 10814: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
10815: } else {
10816: $udom = $env{'user.domain'};
10817: $uname = $env{'user.name'};
10818: $url = '/userfiles/portfolio';
10819: }
1.987 raeburn 10820: $toplevel = $url.'/';
1.984 raeburn 10821: $url .= $current_path;
10822: $getpropath = 1;
1.987 raeburn 10823: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
10824: ($actionurl eq '/adm/imsimport')) {
1.1022 www 10825: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 10826: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 10827: $toplevel = $url;
1.984 raeburn 10828: if ($rest ne '') {
1.987 raeburn 10829: $url .= $rest;
10830: }
10831: } elsif ($actionurl eq '/adm/coursedocs') {
10832: if (ref($args) eq 'HASH') {
1.1071 raeburn 10833: $url = $args->{'docs_url'};
10834: $toplevel = $url;
1.1075.2.11 raeburn 10835: if ($args->{'context'} eq 'paste') {
10836: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
10837: ($path) =
10838: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10839: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10840: $fileloc =~ s{^/}{};
10841: }
1.1071 raeburn 10842: }
10843: } elsif ($actionurl eq '/adm/dependencies') {
10844: if ($env{'request.course.id'} ne '') {
10845: if (ref($args) eq 'HASH') {
10846: $url = $args->{'docs_url'};
10847: $title = $args->{'docs_title'};
1.1075.2.35 raeburn 10848: $toplevel = $url;
10849: unless ($toplevel =~ m{^/}) {
10850: $toplevel = "/$url";
10851: }
1.1075.2.11 raeburn 10852: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35 raeburn 10853: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
10854: $path = $1;
10855: } else {
10856: ($path) =
10857: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
10858: }
1.1075.2.79 raeburn 10859: if ($toplevel=~/^\/*(uploaded|editupload)/) {
10860: $fileloc = $toplevel;
10861: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
10862: my ($udom,$uname,$fname) =
10863: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
10864: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
10865: } else {
10866: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
10867: }
1.1071 raeburn 10868: $fileloc =~ s{^/}{};
10869: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
10870: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
10871: }
1.987 raeburn 10872: }
1.1075.2.35 raeburn 10873: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10874: $udom = $cdom;
10875: $uname = $cnum;
10876: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
10877: $toplevel = $url;
10878: $path = $url;
10879: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
10880: $fileloc =~ s{^/}{};
10881: }
10882: foreach my $file (keys(%{$allfiles})) {
10883: my $embed_file;
10884: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
10885: $embed_file = $1;
10886: } else {
10887: $embed_file = $file;
10888: }
1.1075.2.55 raeburn 10889: my ($absolutepath,$cleaned_file);
10890: if ($embed_file =~ m{^\w+://}) {
10891: $cleaned_file = $embed_file;
1.1075.2.47 raeburn 10892: $newfiles{$cleaned_file} = 1;
10893: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10894: } else {
1.1075.2.55 raeburn 10895: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 10896: if ($embed_file =~ m{^/}) {
10897: $absolutepath = $embed_file;
10898: }
1.1075.2.47 raeburn 10899: if ($cleaned_file =~ m{/}) {
10900: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 10901: $path = &check_for_traversal($path,$url,$toplevel);
10902: my $item = $fname;
10903: if ($path ne '') {
10904: $item = $path.'/'.$fname;
10905: $subdependencies{$path}{$fname} = 1;
10906: } else {
10907: $dependencies{$item} = 1;
10908: }
10909: if ($absolutepath) {
10910: $mapping{$item} = $absolutepath;
10911: } else {
10912: $mapping{$item} = $embed_file;
10913: }
10914: } else {
10915: $dependencies{$embed_file} = 1;
10916: if ($absolutepath) {
1.1075.2.47 raeburn 10917: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 10918: } else {
1.1075.2.47 raeburn 10919: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 10920: }
10921: }
1.984 raeburn 10922: }
10923: }
1.1071 raeburn 10924: my $dirptr = 16384;
1.984 raeburn 10925: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 10926: $currsubfile{$path} = {};
1.1075.2.35 raeburn 10927: if (($actionurl eq '/adm/portfolio') ||
10928: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 10929: my ($sublistref,$listerror) =
10930: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
10931: if (ref($sublistref) eq 'ARRAY') {
10932: foreach my $line (@{$sublistref}) {
10933: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 10934: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 10935: }
1.984 raeburn 10936: }
1.987 raeburn 10937: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 10938: if (opendir(my $dir,$url.'/'.$path)) {
10939: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 10940: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
10941: }
1.1075.2.11 raeburn 10942: } elsif (($actionurl eq '/adm/dependencies') ||
10943: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 10944: ($args->{'context'} eq 'paste')) ||
10945: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 10946: if ($env{'request.course.id'} ne '') {
1.1075.2.35 raeburn 10947: my $dir;
10948: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
10949: $dir = $fileloc;
10950: } else {
10951: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
10952: }
1.1071 raeburn 10953: if ($dir ne '') {
10954: my ($sublistref,$listerror) =
10955: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
10956: if (ref($sublistref) eq 'ARRAY') {
10957: foreach my $line (@{$sublistref}) {
10958: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
10959: undef,$mtime)=split(/\&/,$line,12);
10960: unless (($testdir&$dirptr) ||
10961: ($file_name =~ /^\.\.?$/)) {
10962: $currsubfile{$path}{$file_name} = [$size,$mtime];
10963: }
10964: }
10965: }
10966: }
1.984 raeburn 10967: }
10968: }
10969: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 10970: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 10971: my $item = $path.'/'.$file;
10972: unless ($mapping{$item} eq $item) {
10973: $pathchanges{$item} = 1;
10974: }
10975: $existing{$item} = 1;
10976: $numexisting ++;
10977: } else {
10978: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 10979: }
10980: }
1.1071 raeburn 10981: if ($actionurl eq '/adm/dependencies') {
10982: foreach my $path (keys(%currsubfile)) {
10983: if (ref($currsubfile{$path}) eq 'HASH') {
10984: foreach my $file (keys(%{$currsubfile{$path}})) {
10985: unless ($subdependencies{$path}{$file}) {
1.1075.2.11 raeburn 10986: next if (($rem ne '') &&
10987: (($env{"httpref.$rem"."$path/$file"} ne '') ||
10988: (ref($navmap) &&
10989: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
10990: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
10991: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 10992: $unused{$path.'/'.$file} = 1;
10993: }
10994: }
10995: }
10996: }
10997: }
1.984 raeburn 10998: }
1.987 raeburn 10999: my %currfile;
1.1075.2.35 raeburn 11000: if (($actionurl eq '/adm/portfolio') ||
11001: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11002: my ($dirlistref,$listerror) =
11003: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
11004: if (ref($dirlistref) eq 'ARRAY') {
11005: foreach my $line (@{$dirlistref}) {
11006: my ($file_name,$rest) = split(/\&/,$line,2);
11007: $currfile{$file_name} = 1;
11008: }
1.984 raeburn 11009: }
1.987 raeburn 11010: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11011: if (opendir(my $dir,$url)) {
1.987 raeburn 11012: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 11013: map {$currfile{$_} = 1;} @dir_list;
11014: }
1.1075.2.11 raeburn 11015: } elsif (($actionurl eq '/adm/dependencies') ||
11016: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 11017: ($args->{'context'} eq 'paste')) ||
11018: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11019: if ($env{'request.course.id'} ne '') {
11020: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11021: if ($dir ne '') {
11022: my ($dirlistref,$listerror) =
11023: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
11024: if (ref($dirlistref) eq 'ARRAY') {
11025: foreach my $line (@{$dirlistref}) {
11026: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
11027: $size,undef,$mtime)=split(/\&/,$line,12);
11028: unless (($testdir&$dirptr) ||
11029: ($file_name =~ /^\.\.?$/)) {
11030: $currfile{$file_name} = [$size,$mtime];
11031: }
11032: }
11033: }
11034: }
11035: }
1.984 raeburn 11036: }
11037: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 11038: if (exists($currfile{$file})) {
1.987 raeburn 11039: unless ($mapping{$file} eq $file) {
11040: $pathchanges{$file} = 1;
11041: }
11042: $existing{$file} = 1;
11043: $numexisting ++;
11044: } else {
1.984 raeburn 11045: $newfiles{$file} = 1;
11046: }
11047: }
1.1071 raeburn 11048: foreach my $file (keys(%currfile)) {
11049: unless (($file eq $filename) ||
11050: ($file eq $filename.'.bak') ||
11051: ($dependencies{$file})) {
1.1075.2.11 raeburn 11052: if ($actionurl eq '/adm/dependencies') {
1.1075.2.35 raeburn 11053: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
11054: next if (($rem ne '') &&
11055: (($env{"httpref.$rem".$file} ne '') ||
11056: (ref($navmap) &&
11057: (($navmap->getResourceByUrl($rem.$file) ne '') ||
11058: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11059: ($navmap->getResourceByUrl($rem.$1)))))));
11060: }
1.1075.2.11 raeburn 11061: }
1.1071 raeburn 11062: $unused{$file} = 1;
11063: }
11064: }
1.1075.2.11 raeburn 11065: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
11066: ($args->{'context'} eq 'paste')) {
11067: $counter = scalar(keys(%existing));
11068: $numpathchg = scalar(keys(%pathchanges));
11069: return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35 raeburn 11070: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
11071: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
11072: $counter = scalar(keys(%existing));
11073: $numpathchg = scalar(keys(%pathchanges));
11074: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11 raeburn 11075: }
1.984 raeburn 11076: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 11077: if ($actionurl eq '/adm/dependencies') {
11078: next if ($embed_file =~ m{^\w+://});
11079: }
1.660 raeburn 11080: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 11081: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 11082: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 11083: unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35 raeburn 11084: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
11085: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 11086: }
1.1075.2.35 raeburn 11087: $upload_output .= '</td>';
1.1071 raeburn 11088: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1075.2.35 raeburn 11089: $upload_output.='<td align="right">'.
11090: '<span class="LC_info LC_fontsize_medium">'.
11091: &mt("URL points to web address").'</span>';
1.987 raeburn 11092: $numremref++;
1.660 raeburn 11093: } elsif ($args->{'error_on_invalid_names'}
11094: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35 raeburn 11095: $upload_output.='<td align="right"><span class="LC_warning">'.
11096: &mt('Invalid characters').'</span>';
1.987 raeburn 11097: $numinvalid++;
1.660 raeburn 11098: } else {
1.1075.2.35 raeburn 11099: $upload_output .= '<td>'.
11100: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 11101: $embed_file,\%mapping,
1.1071 raeburn 11102: $allfiles,$codebase,'upload');
11103: $counter ++;
11104: $numnew ++;
1.987 raeburn 11105: }
11106: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
11107: }
11108: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 11109: if ($actionurl eq '/adm/dependencies') {
11110: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
11111: $modify_output .= &start_data_table_row().
11112: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
11113: '<img src="'.&icon($embed_file).'" border="0" />'.
11114: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
11115: '<td>'.$size.'</td>'.
11116: '<td>'.$mtime.'</td>'.
11117: '<td><label><input type="checkbox" name="mod_upload_dep" '.
11118: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
11119: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
11120: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
11121: &embedded_file_element('upload_embedded',$counter,
11122: $embed_file,\%mapping,
11123: $allfiles,$codebase,'modify').
11124: '</div></td>'.
11125: &end_data_table_row()."\n";
11126: $counter ++;
11127: } else {
11128: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 11129: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
11130: '<span class="LC_filename">'.$embed_file.'</span></td>'.
11131: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 11132: &Apache::loncommon::end_data_table_row()."\n";
11133: }
11134: }
11135: my $delidx = $counter;
11136: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
11137: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
11138: $delete_output .= &start_data_table_row().
11139: '<td><img src="'.&icon($oldfile).'" />'.
11140: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
11141: '<td>'.$size.'</td>'.
11142: '<td>'.$mtime.'</td>'.
11143: '<td><label><input type="checkbox" name="del_upload_dep" '.
11144: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
11145: &embedded_file_element('upload_embedded',$delidx,
11146: $oldfile,\%mapping,$allfiles,
11147: $codebase,'delete').'</td>'.
11148: &end_data_table_row()."\n";
11149: $numunused ++;
11150: $delidx ++;
1.987 raeburn 11151: }
11152: if ($upload_output) {
11153: $upload_output = &start_data_table().
11154: $upload_output.
11155: &end_data_table()."\n";
11156: }
1.1071 raeburn 11157: if ($modify_output) {
11158: $modify_output = &start_data_table().
11159: &start_data_table_header_row().
11160: '<th>'.&mt('File').'</th>'.
11161: '<th>'.&mt('Size (KB)').'</th>'.
11162: '<th>'.&mt('Modified').'</th>'.
11163: '<th>'.&mt('Upload replacement?').'</th>'.
11164: &end_data_table_header_row().
11165: $modify_output.
11166: &end_data_table()."\n";
11167: }
11168: if ($delete_output) {
11169: $delete_output = &start_data_table().
11170: &start_data_table_header_row().
11171: '<th>'.&mt('File').'</th>'.
11172: '<th>'.&mt('Size (KB)').'</th>'.
11173: '<th>'.&mt('Modified').'</th>'.
11174: '<th>'.&mt('Delete?').'</th>'.
11175: &end_data_table_header_row().
11176: $delete_output.
11177: &end_data_table()."\n";
11178: }
1.987 raeburn 11179: my $applies = 0;
11180: if ($numremref) {
11181: $applies ++;
11182: }
11183: if ($numinvalid) {
11184: $applies ++;
11185: }
11186: if ($numexisting) {
11187: $applies ++;
11188: }
1.1071 raeburn 11189: if ($counter || $numunused) {
1.987 raeburn 11190: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
11191: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 11192: $state.'<h3>'.$heading.'</h3>';
11193: if ($actionurl eq '/adm/dependencies') {
11194: if ($numnew) {
11195: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
11196: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
11197: $upload_output.'<br />'."\n";
11198: }
11199: if ($numexisting) {
11200: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
11201: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
11202: $modify_output.'<br />'."\n";
11203: $buttontext = &mt('Save changes');
11204: }
11205: if ($numunused) {
11206: $output .= '<h4>'.&mt('Unused files').'</h4>'.
11207: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
11208: $delete_output.'<br />'."\n";
11209: $buttontext = &mt('Save changes');
11210: }
11211: } else {
11212: $output .= $upload_output.'<br />'."\n";
11213: }
11214: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
11215: $counter.'" />'."\n";
11216: if ($actionurl eq '/adm/dependencies') {
11217: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
11218: $numnew.'" />'."\n";
11219: } elsif ($actionurl eq '') {
1.987 raeburn 11220: $output .= '<input type="hidden" name="phase" value="three" />';
11221: }
11222: } elsif ($applies) {
11223: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
11224: if ($applies > 1) {
11225: $output .=
1.1075.2.35 raeburn 11226: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 11227: if ($numremref) {
11228: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
11229: }
11230: if ($numinvalid) {
11231: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
11232: }
11233: if ($numexisting) {
11234: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
11235: }
11236: $output .= '</ul><br />';
11237: } elsif ($numremref) {
11238: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
11239: } elsif ($numinvalid) {
11240: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
11241: } elsif ($numexisting) {
11242: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
11243: }
11244: $output .= $upload_output.'<br />';
11245: }
11246: my ($pathchange_output,$chgcount);
1.1071 raeburn 11247: $chgcount = $counter;
1.987 raeburn 11248: if (keys(%pathchanges) > 0) {
11249: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 11250: if ($counter) {
1.987 raeburn 11251: $output .= &embedded_file_element('pathchange',$chgcount,
11252: $embed_file,\%mapping,
1.1071 raeburn 11253: $allfiles,$codebase,'change');
1.987 raeburn 11254: } else {
11255: $pathchange_output .=
11256: &start_data_table_row().
11257: '<td><input type ="checkbox" name="namechange" value="'.
11258: $chgcount.'" checked="checked" /></td>'.
11259: '<td>'.$mapping{$embed_file}.'</td>'.
11260: '<td>'.$embed_file.
11261: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 11262: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 11263: '</td>'.&end_data_table_row();
1.660 raeburn 11264: }
1.987 raeburn 11265: $numpathchg ++;
11266: $chgcount ++;
1.660 raeburn 11267: }
11268: }
1.1075.2.35 raeburn 11269: if (($counter) || ($numunused)) {
1.987 raeburn 11270: if ($numpathchg) {
11271: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
11272: $numpathchg.'" />'."\n";
11273: }
11274: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11275: ($actionurl eq '/adm/imsimport')) {
11276: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
11277: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
11278: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 11279: } elsif ($actionurl eq '/adm/dependencies') {
11280: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 11281: }
1.1075.2.35 raeburn 11282: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 11283: } elsif ($numpathchg) {
11284: my %pathchange = ();
11285: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
11286: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11287: $output .= '<p>'.&mt('or').'</p>';
1.1075.2.35 raeburn 11288: }
1.987 raeburn 11289: }
1.1071 raeburn 11290: return ($output,$counter,$numpathchg);
1.987 raeburn 11291: }
11292:
1.1075.2.47 raeburn 11293: =pod
11294:
11295: =item * clean_path($name)
11296:
11297: Performs clean-up of directories, subdirectories and filename in an
11298: embedded object, referenced in an HTML file which is being uploaded
11299: to a course or portfolio, where
11300: "Upload embedded images/multimedia files if HTML file" checkbox was
11301: checked.
11302:
11303: Clean-up is similar to replacements in lonnet::clean_filename()
11304: except each / between sub-directory and next level is preserved.
11305:
11306: =cut
11307:
11308: sub clean_path {
11309: my ($embed_file) = @_;
11310: $embed_file =~s{^/+}{};
11311: my @contents;
11312: if ($embed_file =~ m{/}) {
11313: @contents = split(/\//,$embed_file);
11314: } else {
11315: @contents = ($embed_file);
11316: }
11317: my $lastidx = scalar(@contents)-1;
11318: for (my $i=0; $i<=$lastidx; $i++) {
11319: $contents[$i]=~s{\\}{/}g;
11320: $contents[$i]=~s/\s+/\_/g;
11321: $contents[$i]=~s{[^/\w\.\-]}{}g;
11322: if ($i == $lastidx) {
11323: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
11324: }
11325: }
11326: if ($lastidx > 0) {
11327: return join('/',@contents);
11328: } else {
11329: return $contents[0];
11330: }
11331: }
11332:
1.987 raeburn 11333: sub embedded_file_element {
1.1071 raeburn 11334: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 11335: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
11336: (ref($codebase) eq 'HASH'));
11337: my $output;
1.1071 raeburn 11338: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 11339: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
11340: }
11341: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
11342: &escape($embed_file).'" />';
11343: unless (($context eq 'upload_embedded') &&
11344: ($mapping->{$embed_file} eq $embed_file)) {
11345: $output .='
11346: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
11347: }
11348: my $attrib;
11349: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
11350: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
11351: }
11352: $output .=
11353: "\n\t\t".
11354: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
11355: $attrib.'" />';
11356: if (exists($codebase->{$mapping->{$embed_file}})) {
11357: $output .=
11358: "\n\t\t".
11359: '<input name="codebase_'.$num.'" type="hidden" value="'.
11360: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 11361: }
1.987 raeburn 11362: return $output;
1.660 raeburn 11363: }
11364:
1.1071 raeburn 11365: sub get_dependency_details {
11366: my ($currfile,$currsubfile,$embed_file) = @_;
11367: my ($size,$mtime,$showsize,$showmtime);
11368: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
11369: if ($embed_file =~ m{/}) {
11370: my ($path,$fname) = split(/\//,$embed_file);
11371: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
11372: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
11373: }
11374: } else {
11375: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
11376: ($size,$mtime) = @{$currfile->{$embed_file}};
11377: }
11378: }
11379: $showsize = $size/1024.0;
11380: $showsize = sprintf("%.1f",$showsize);
11381: if ($mtime > 0) {
11382: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
11383: }
11384: }
11385: return ($showsize,$showmtime);
11386: }
11387:
11388: sub ask_embedded_js {
11389: return <<"END";
11390: <script type="text/javascript"">
11391: // <![CDATA[
11392: function toggleBrowse(counter) {
11393: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
11394: var fileid = document.getElementById('embedded_item_'+counter);
11395: var uploaddivid = document.getElementById('moduploaddep_'+counter);
11396: if (chkboxid.checked == true) {
11397: uploaddivid.style.display='block';
11398: } else {
11399: uploaddivid.style.display='none';
11400: fileid.value = '';
11401: }
11402: }
11403: // ]]>
11404: </script>
11405:
11406: END
11407: }
11408:
1.661 raeburn 11409: sub upload_embedded {
11410: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 11411: $current_disk_usage,$hiddenstate,$actionurl) = @_;
11412: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 11413: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
11414: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
11415: my $orig_uploaded_filename =
11416: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 11417: foreach my $type ('orig','ref','attrib','codebase') {
11418: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
11419: $env{'form.embedded_'.$type.'_'.$i} =
11420: &unescape($env{'form.embedded_'.$type.'_'.$i});
11421: }
11422: }
1.661 raeburn 11423: my ($path,$fname) =
11424: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
11425: # no path, whole string is fname
11426: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
11427: $fname = &Apache::lonnet::clean_filename($fname);
11428: # See if there is anything left
11429: next if ($fname eq '');
11430:
11431: # Check if file already exists as a file or directory.
11432: my ($state,$msg);
11433: if ($context eq 'portfolio') {
11434: my $port_path = $dirpath;
11435: if ($group ne '') {
11436: $port_path = "groups/$group/$port_path";
11437: }
1.987 raeburn 11438: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
11439: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 11440: $dir_root,$port_path,$disk_quota,
11441: $current_disk_usage,$uname,$udom);
11442: if ($state eq 'will_exceed_quota'
1.984 raeburn 11443: || $state eq 'file_locked') {
1.661 raeburn 11444: $output .= $msg;
11445: next;
11446: }
11447: } elsif (($context eq 'author') || ($context eq 'testbank')) {
11448: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
11449: if ($state eq 'exists') {
11450: $output .= $msg;
11451: next;
11452: }
11453: }
11454: # Check if extension is valid
11455: if (($fname =~ /\.(\w+)$/) &&
11456: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53 raeburn 11457: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
11458: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 11459: next;
11460: } elsif (($fname =~ /\.(\w+)$/) &&
11461: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 11462: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 11463: next;
11464: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34 raeburn 11465: $output .= &mt('Filename not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 11466: next;
11467: }
11468: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35 raeburn 11469: my $subdir = $path;
11470: $subdir =~ s{/+$}{};
1.661 raeburn 11471: if ($context eq 'portfolio') {
1.984 raeburn 11472: my $result;
11473: if ($state eq 'existingfile') {
11474: $result=
11475: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35 raeburn 11476: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 11477: } else {
1.984 raeburn 11478: $result=
11479: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 11480: $dirpath.
1.1075.2.35 raeburn 11481: $env{'form.currentpath'}.$subdir);
1.984 raeburn 11482: if ($result !~ m|^/uploaded/|) {
11483: $output .= '<span class="LC_error">'
11484: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
11485: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
11486: .'</span><br />';
11487: next;
11488: } else {
1.987 raeburn 11489: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11490: $path.$fname.'</span>').'<br />';
1.984 raeburn 11491: }
1.661 raeburn 11492: }
1.1075.2.35 raeburn 11493: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
11494: my $extendedsubdir = $dirpath.'/'.$subdir;
11495: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 11496: my $result =
1.1075.2.35 raeburn 11497: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 11498: if ($result !~ m|^/uploaded/|) {
11499: $output .= '<span class="LC_error">'
11500: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
11501: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
11502: .'</span><br />';
11503: next;
11504: } else {
11505: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11506: $path.$fname.'</span>').'<br />';
1.1075.2.35 raeburn 11507: if ($context eq 'syllabus') {
11508: &Apache::lonnet::make_public_indefinitely($result);
11509: }
1.987 raeburn 11510: }
1.661 raeburn 11511: } else {
11512: # Save the file
11513: my $target = $env{'form.embedded_item_'.$i};
11514: my $fullpath = $dir_root.$dirpath.'/'.$path;
11515: my $dest = $fullpath.$fname;
11516: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 11517: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 11518: my $count;
11519: my $filepath = $dir_root;
1.1027 raeburn 11520: foreach my $subdir (@parts) {
11521: $filepath .= "/$subdir";
11522: if (!-e $filepath) {
1.661 raeburn 11523: mkdir($filepath,0770);
11524: }
11525: }
11526: my $fh;
11527: if (!open($fh,'>'.$dest)) {
11528: &Apache::lonnet::logthis('Failed to create '.$dest);
11529: $output .= '<span class="LC_error">'.
1.1071 raeburn 11530: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
11531: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 11532: '</span><br />';
11533: } else {
11534: if (!print $fh $env{'form.embedded_item_'.$i}) {
11535: &Apache::lonnet::logthis('Failed to write to '.$dest);
11536: $output .= '<span class="LC_error">'.
1.1071 raeburn 11537: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
11538: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 11539: '</span><br />';
11540: } else {
1.987 raeburn 11541: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11542: $url.'</span>').'<br />';
11543: unless ($context eq 'testbank') {
11544: $footer .= &mt('View embedded file: [_1]',
11545: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
11546: }
11547: }
11548: close($fh);
11549: }
11550: }
11551: if ($env{'form.embedded_ref_'.$i}) {
11552: $pathchange{$i} = 1;
11553: }
11554: }
11555: if ($output) {
11556: $output = '<p>'.$output.'</p>';
11557: }
11558: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
11559: $returnflag = 'ok';
1.1071 raeburn 11560: my $numpathchgs = scalar(keys(%pathchange));
11561: if ($numpathchgs > 0) {
1.987 raeburn 11562: if ($context eq 'portfolio') {
11563: $output .= '<p>'.&mt('or').'</p>';
11564: } elsif ($context eq 'testbank') {
1.1071 raeburn 11565: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
11566: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 11567: $returnflag = 'modify_orightml';
11568: }
11569: }
1.1071 raeburn 11570: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 11571: }
11572:
11573: sub modify_html_form {
11574: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
11575: my $end = 0;
11576: my $modifyform;
11577: if ($context eq 'upload_embedded') {
11578: return unless (ref($pathchange) eq 'HASH');
11579: if ($env{'form.number_embedded_items'}) {
11580: $end += $env{'form.number_embedded_items'};
11581: }
11582: if ($env{'form.number_pathchange_items'}) {
11583: $end += $env{'form.number_pathchange_items'};
11584: }
11585: if ($end) {
11586: for (my $i=0; $i<$end; $i++) {
11587: if ($i < $env{'form.number_embedded_items'}) {
11588: next unless($pathchange->{$i});
11589: }
11590: $modifyform .=
11591: &start_data_table_row().
11592: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
11593: 'checked="checked" /></td>'.
11594: '<td>'.$env{'form.embedded_ref_'.$i}.
11595: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
11596: &escape($env{'form.embedded_ref_'.$i}).'" />'.
11597: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
11598: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
11599: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
11600: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
11601: '<td>'.$env{'form.embedded_orig_'.$i}.
11602: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
11603: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
11604: &end_data_table_row();
1.1071 raeburn 11605: }
1.987 raeburn 11606: }
11607: } else {
11608: $modifyform = $pathchgtable;
11609: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
11610: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
11611: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11612: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
11613: }
11614: }
11615: if ($modifyform) {
1.1071 raeburn 11616: if ($actionurl eq '/adm/dependencies') {
11617: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
11618: }
1.987 raeburn 11619: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
11620: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
11621: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
11622: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
11623: '</ol></p>'."\n".'<p>'.
11624: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
11625: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
11626: &start_data_table()."\n".
11627: &start_data_table_header_row().
11628: '<th>'.&mt('Change?').'</th>'.
11629: '<th>'.&mt('Current reference').'</th>'.
11630: '<th>'.&mt('Required reference').'</th>'.
11631: &end_data_table_header_row()."\n".
11632: $modifyform.
11633: &end_data_table().'<br />'."\n".$hiddenstate.
11634: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
11635: '</form>'."\n";
11636: }
11637: return;
11638: }
11639:
11640: sub modify_html_refs {
1.1075.2.35 raeburn 11641: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 11642: my $container;
11643: if ($context eq 'portfolio') {
11644: $container = $env{'form.container'};
11645: } elsif ($context eq 'coursedoc') {
11646: $container = $env{'form.primaryurl'};
1.1071 raeburn 11647: } elsif ($context eq 'manage_dependencies') {
11648: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
11649: $container = "/$container";
1.1075.2.35 raeburn 11650: } elsif ($context eq 'syllabus') {
11651: $container = $url;
1.987 raeburn 11652: } else {
1.1027 raeburn 11653: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 11654: }
11655: my (%allfiles,%codebase,$output,$content);
11656: my @changes = &get_env_multiple('form.namechange');
1.1075.2.35 raeburn 11657: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 11658: if (wantarray) {
11659: return ('',0,0);
11660: } else {
11661: return;
11662: }
11663: }
11664: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 11665: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 11666: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
11667: if (wantarray) {
11668: return ('',0,0);
11669: } else {
11670: return;
11671: }
11672: }
1.987 raeburn 11673: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 11674: if ($content eq '-1') {
11675: if (wantarray) {
11676: return ('',0,0);
11677: } else {
11678: return;
11679: }
11680: }
1.987 raeburn 11681: } else {
1.1071 raeburn 11682: unless ($container =~ /^\Q$dir_root\E/) {
11683: if (wantarray) {
11684: return ('',0,0);
11685: } else {
11686: return;
11687: }
11688: }
1.1075.2.128 raeburn 11689: if (open(my $fh,'<',$container)) {
1.987 raeburn 11690: $content = join('', <$fh>);
11691: close($fh);
11692: } else {
1.1071 raeburn 11693: if (wantarray) {
11694: return ('',0,0);
11695: } else {
11696: return;
11697: }
1.987 raeburn 11698: }
11699: }
11700: my ($count,$codebasecount) = (0,0);
11701: my $mm = new File::MMagic;
11702: my $mime_type = $mm->checktype_contents($content);
11703: if ($mime_type eq 'text/html') {
11704: my $parse_result =
11705: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
11706: \%codebase,\$content);
11707: if ($parse_result eq 'ok') {
11708: foreach my $i (@changes) {
11709: my $orig = &unescape($env{'form.embedded_orig_'.$i});
11710: my $ref = &unescape($env{'form.embedded_ref_'.$i});
11711: if ($allfiles{$ref}) {
11712: my $newname = $orig;
11713: my ($attrib_regexp,$codebase);
1.1006 raeburn 11714: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 11715: if ($attrib_regexp =~ /:/) {
11716: $attrib_regexp =~ s/\:/|/g;
11717: }
11718: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11719: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11720: $count += $numchg;
1.1075.2.35 raeburn 11721: $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48 raeburn 11722: delete($allfiles{$ref});
1.987 raeburn 11723: }
11724: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 11725: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 11726: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
11727: $codebasecount ++;
11728: }
11729: }
11730: }
1.1075.2.35 raeburn 11731: my $skiprewrites;
1.987 raeburn 11732: if ($count || $codebasecount) {
11733: my $saveresult;
1.1071 raeburn 11734: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 11735: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 11736: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11737: if ($url eq $container) {
11738: my ($fname) = ($container =~ m{/([^/]+)$});
11739: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11740: $count,'<span class="LC_filename">'.
1.1071 raeburn 11741: $fname.'</span>').'</p>';
1.987 raeburn 11742: } else {
11743: $output = '<p class="LC_error">'.
11744: &mt('Error: update failed for: [_1].',
11745: '<span class="LC_filename">'.
11746: $container.'</span>').'</p>';
11747: }
1.1075.2.35 raeburn 11748: if ($context eq 'syllabus') {
11749: unless ($saveresult eq 'ok') {
11750: $skiprewrites = 1;
11751: }
11752: }
1.987 raeburn 11753: } else {
1.1075.2.128 raeburn 11754: if (open(my $fh,'>',$container)) {
1.987 raeburn 11755: print $fh $content;
11756: close($fh);
11757: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
11758: $count,'<span class="LC_filename">'.
11759: $container.'</span>').'</p>';
1.661 raeburn 11760: } else {
1.987 raeburn 11761: $output = '<p class="LC_error">'.
11762: &mt('Error: could not update [_1].',
11763: '<span class="LC_filename">'.
11764: $container.'</span>').'</p>';
1.661 raeburn 11765: }
11766: }
11767: }
1.1075.2.35 raeburn 11768: if (($context eq 'syllabus') && (!$skiprewrites)) {
11769: my ($actionurl,$state);
11770: $actionurl = "/public/$udom/$uname/syllabus";
11771: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
11772: &ask_for_embedded_content($actionurl,$state,\%allfiles,
11773: \%codebase,
11774: {'context' => 'rewrites',
11775: 'ignore_remote_references' => 1,});
11776: if (ref($mapping) eq 'HASH') {
11777: my $rewrites = 0;
11778: foreach my $key (keys(%{$mapping})) {
11779: next if ($key =~ m{^https?://});
11780: my $ref = $mapping->{$key};
11781: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
11782: my $attrib;
11783: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
11784: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
11785: }
11786: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
11787: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
11788: $rewrites += $numchg;
11789: }
11790: }
11791: if ($rewrites) {
11792: my $saveresult;
11793: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
11794: if ($url eq $container) {
11795: my ($fname) = ($container =~ m{/([^/]+)$});
11796: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
11797: $count,'<span class="LC_filename">'.
11798: $fname.'</span>').'</p>';
11799: } else {
11800: $output .= '<p class="LC_error">'.
11801: &mt('Error: could not update links in [_1].',
11802: '<span class="LC_filename">'.
11803: $container.'</span>').'</p>';
11804:
11805: }
11806: }
11807: }
11808: }
1.987 raeburn 11809: } else {
11810: &logthis('Failed to parse '.$container.
11811: ' to modify references: '.$parse_result);
1.661 raeburn 11812: }
11813: }
1.1071 raeburn 11814: if (wantarray) {
11815: return ($output,$count,$codebasecount);
11816: } else {
11817: return $output;
11818: }
1.661 raeburn 11819: }
11820:
11821: sub check_for_existing {
11822: my ($path,$fname,$element) = @_;
11823: my ($state,$msg);
11824: if (-d $path.'/'.$fname) {
11825: $state = 'exists';
11826: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11827: } elsif (-e $path.'/'.$fname) {
11828: $state = 'exists';
11829: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
11830: }
11831: if ($state eq 'exists') {
11832: $msg = '<span class="LC_error">'.$msg.'</span><br />';
11833: }
11834: return ($state,$msg);
11835: }
11836:
11837: sub check_for_upload {
11838: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
11839: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 11840: my $filesize = length($env{'form.'.$element});
11841: if (!$filesize) {
11842: my $msg = '<span class="LC_error">'.
11843: &mt('Unable to upload [_1]. (size = [_2] bytes)',
11844: '<span class="LC_filename">'.$fname.'</span>',
11845: $filesize).'<br />'.
1.1007 raeburn 11846: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 11847: '</span>';
11848: return ('zero_bytes',$msg);
11849: }
11850: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 11851: my $getpropath = 1;
1.1021 raeburn 11852: my ($dirlistref,$listerror) =
11853: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 11854: my $found_file = 0;
11855: my $locked_file = 0;
1.991 raeburn 11856: my @lockers;
11857: my $navmap;
11858: if ($env{'request.course.id'}) {
11859: $navmap = Apache::lonnavmaps::navmap->new();
11860: }
1.1021 raeburn 11861: if (ref($dirlistref) eq 'ARRAY') {
11862: foreach my $line (@{$dirlistref}) {
11863: my ($file_name,$rest)=split(/\&/,$line,2);
11864: if ($file_name eq $fname){
11865: $file_name = $path.$file_name;
11866: if ($group ne '') {
11867: $file_name = $group.$file_name;
11868: }
11869: $found_file = 1;
11870: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
11871: foreach my $lock (@lockers) {
11872: if (ref($lock) eq 'ARRAY') {
11873: my ($symb,$crsid) = @{$lock};
11874: if ($crsid eq $env{'request.course.id'}) {
11875: if (ref($navmap)) {
11876: my $res = $navmap->getBySymb($symb);
11877: foreach my $part (@{$res->parts()}) {
11878: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
11879: unless (($slot_status == $res->RESERVED) ||
11880: ($slot_status == $res->RESERVED_LOCATION)) {
11881: $locked_file = 1;
11882: }
1.991 raeburn 11883: }
1.1021 raeburn 11884: } else {
11885: $locked_file = 1;
1.991 raeburn 11886: }
11887: } else {
11888: $locked_file = 1;
11889: }
11890: }
1.1021 raeburn 11891: }
11892: } else {
11893: my @info = split(/\&/,$rest);
11894: my $currsize = $info[6]/1000;
11895: if ($currsize < $filesize) {
11896: my $extra = $filesize - $currsize;
11897: if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69 raeburn 11898: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 11899: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
1.1075.2.69 raeburn 11900: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
11901: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
11902: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 11903: return ('will_exceed_quota',$msg);
11904: }
1.984 raeburn 11905: }
11906: }
1.661 raeburn 11907: }
11908: }
11909: }
11910: if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69 raeburn 11911: my $msg = '<p class="LC_warning">'.
11912: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
11913: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 11914: return ('will_exceed_quota',$msg);
11915: } elsif ($found_file) {
11916: if ($locked_file) {
1.1075.2.69 raeburn 11917: my $msg = '<p class="LC_warning">';
1.661 raeburn 11918: $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>');
1.1075.2.69 raeburn 11919: $msg .= '</p>';
1.661 raeburn 11920: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
11921: return ('file_locked',$msg);
11922: } else {
1.1075.2.69 raeburn 11923: my $msg = '<p class="LC_error">';
1.984 raeburn 11924: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1075.2.69 raeburn 11925: $msg .= '</p>';
1.984 raeburn 11926: return ('existingfile',$msg);
1.661 raeburn 11927: }
11928: }
11929: }
11930:
1.987 raeburn 11931: sub check_for_traversal {
11932: my ($path,$url,$toplevel) = @_;
11933: my @parts=split(/\//,$path);
11934: my $cleanpath;
11935: my $fullpath = $url;
11936: for (my $i=0;$i<@parts;$i++) {
11937: next if ($parts[$i] eq '.');
11938: if ($parts[$i] eq '..') {
11939: $fullpath =~ s{([^/]+/)$}{};
11940: } else {
11941: $fullpath .= $parts[$i].'/';
11942: }
11943: }
11944: if ($fullpath =~ /^\Q$url\E(.*)$/) {
11945: $cleanpath = $1;
11946: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
11947: my $curr_toprel = $1;
11948: my @parts = split(/\//,$curr_toprel);
11949: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
11950: my @urlparts = split(/\//,$url_toprel);
11951: my $doubledots;
11952: my $startdiff = -1;
11953: for (my $i=0; $i<@urlparts; $i++) {
11954: if ($startdiff == -1) {
11955: unless ($urlparts[$i] eq $parts[$i]) {
11956: $startdiff = $i;
11957: $doubledots .= '../';
11958: }
11959: } else {
11960: $doubledots .= '../';
11961: }
11962: }
11963: if ($startdiff > -1) {
11964: $cleanpath = $doubledots;
11965: for (my $i=$startdiff; $i<@parts; $i++) {
11966: $cleanpath .= $parts[$i].'/';
11967: }
11968: }
11969: }
11970: $cleanpath =~ s{(/)$}{};
11971: return $cleanpath;
11972: }
1.31 albertel 11973:
1.1053 raeburn 11974: sub is_archive_file {
11975: my ($mimetype) = @_;
11976: if (($mimetype eq 'application/octet-stream') ||
11977: ($mimetype eq 'application/x-stuffit') ||
11978: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
11979: return 1;
11980: }
11981: return;
11982: }
11983:
11984: sub decompress_form {
1.1065 raeburn 11985: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 11986: my %lt = &Apache::lonlocal::texthash (
11987: this => 'This file is an archive file.',
1.1067 raeburn 11988: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 11989: itsc => 'Its contents are as follows:',
1.1053 raeburn 11990: youm => 'You may wish to extract its contents.',
11991: extr => 'Extract contents',
1.1067 raeburn 11992: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
11993: proa => 'Process automatically?',
1.1053 raeburn 11994: yes => 'Yes',
11995: no => 'No',
1.1067 raeburn 11996: fold => 'Title for folder containing movie',
11997: movi => 'Title for page containing embedded movie',
1.1053 raeburn 11998: );
1.1065 raeburn 11999: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 12000: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 12001: my $info = &list_archive_contents($fileloc,\@paths);
12002: if (@paths) {
12003: foreach my $path (@paths) {
12004: $path =~ s{^/}{};
1.1067 raeburn 12005: if ($path =~ m{^([^/]+)/$}) {
12006: $topdir = $1;
12007: }
1.1065 raeburn 12008: if ($path =~ m{^([^/]+)/}) {
12009: $toplevel{$1} = $path;
12010: } else {
12011: $toplevel{$path} = $path;
12012: }
12013: }
12014: }
1.1067 raeburn 12015: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59 raeburn 12016: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 12017: "$topdir/media/",
12018: "$topdir/media/$topdir.mp4",
12019: "$topdir/media/FirstFrame.png",
12020: "$topdir/media/player.swf",
12021: "$topdir/media/swfobject.js",
12022: "$topdir/media/expressInstall.swf");
1.1075.2.81 raeburn 12023: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59 raeburn 12024: "$topdir/$topdir.mp4",
12025: "$topdir/$topdir\_config.xml",
12026: "$topdir/$topdir\_controller.swf",
12027: "$topdir/$topdir\_embed.css",
12028: "$topdir/$topdir\_First_Frame.png",
12029: "$topdir/$topdir\_player.html",
12030: "$topdir/$topdir\_Thumbnails.png",
12031: "$topdir/playerProductInstall.swf",
12032: "$topdir/scripts/",
12033: "$topdir/scripts/config_xml.js",
12034: "$topdir/scripts/handlebars.js",
12035: "$topdir/scripts/jquery-1.7.1.min.js",
12036: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
12037: "$topdir/scripts/modernizr.js",
12038: "$topdir/scripts/player-min.js",
12039: "$topdir/scripts/swfobject.js",
12040: "$topdir/skins/",
12041: "$topdir/skins/configuration_express.xml",
12042: "$topdir/skins/express_show/",
12043: "$topdir/skins/express_show/player-min.css",
12044: "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81 raeburn 12045: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
12046: "$topdir/$topdir.mp4",
12047: "$topdir/$topdir\_config.xml",
12048: "$topdir/$topdir\_controller.swf",
12049: "$topdir/$topdir\_embed.css",
12050: "$topdir/$topdir\_First_Frame.png",
12051: "$topdir/$topdir\_player.html",
12052: "$topdir/$topdir\_Thumbnails.png",
12053: "$topdir/playerProductInstall.swf",
12054: "$topdir/scripts/",
12055: "$topdir/scripts/config_xml.js",
12056: "$topdir/scripts/techsmith-smart-player.min.js",
12057: "$topdir/skins/",
12058: "$topdir/skins/configuration_express.xml",
12059: "$topdir/skins/express_show/",
12060: "$topdir/skins/express_show/spritesheet.min.css",
12061: "$topdir/skins/express_show/spritesheet.png",
12062: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59 raeburn 12063: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 12064: if (@diffs == 0) {
1.1075.2.59 raeburn 12065: $is_camtasia = 6;
12066: } else {
1.1075.2.81 raeburn 12067: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59 raeburn 12068: if (@diffs == 0) {
12069: $is_camtasia = 8;
1.1075.2.81 raeburn 12070: } else {
12071: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
12072: if (@diffs == 0) {
12073: $is_camtasia = 8;
12074: }
1.1075.2.59 raeburn 12075: }
1.1067 raeburn 12076: }
12077: }
12078: my $output;
12079: if ($is_camtasia) {
12080: $output = <<"ENDCAM";
12081: <script type="text/javascript" language="Javascript">
12082: // <![CDATA[
12083:
12084: function camtasiaToggle() {
12085: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
12086: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59 raeburn 12087: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 12088: document.getElementById('camtasia_titles').style.display='block';
12089: } else {
12090: document.getElementById('camtasia_titles').style.display='none';
12091: }
12092: }
12093: }
12094: return;
12095: }
12096:
12097: // ]]>
12098: </script>
12099: <p>$lt{'camt'}</p>
12100: ENDCAM
1.1065 raeburn 12101: } else {
1.1067 raeburn 12102: $output = '<p>'.$lt{'this'};
12103: if ($info eq '') {
12104: $output .= ' '.$lt{'youm'}.'</p>'."\n";
12105: } else {
12106: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
12107: '<div><pre>'.$info.'</pre></div>';
12108: }
1.1065 raeburn 12109: }
1.1067 raeburn 12110: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 12111: my $duplicates;
12112: my $num = 0;
12113: if (ref($dirlist) eq 'ARRAY') {
12114: foreach my $item (@{$dirlist}) {
12115: if (ref($item) eq 'ARRAY') {
12116: if (exists($toplevel{$item->[0]})) {
12117: $duplicates .=
12118: &start_data_table_row().
12119: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
12120: 'value="0" checked="checked" />'.&mt('No').'</label>'.
12121: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
12122: 'value="1" />'.&mt('Yes').'</label>'.
12123: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
12124: '<td>'.$item->[0].'</td>';
12125: if ($item->[2]) {
12126: $duplicates .= '<td>'.&mt('Directory').'</td>';
12127: } else {
12128: $duplicates .= '<td>'.&mt('File').'</td>';
12129: }
12130: $duplicates .= '<td>'.$item->[3].'</td>'.
12131: '<td>'.
12132: &Apache::lonlocal::locallocaltime($item->[4]).
12133: '</td>'.
12134: &end_data_table_row();
12135: $num ++;
12136: }
12137: }
12138: }
12139: }
12140: my $itemcount;
12141: if (@paths > 0) {
12142: $itemcount = scalar(@paths);
12143: } else {
12144: $itemcount = 1;
12145: }
1.1067 raeburn 12146: if ($is_camtasia) {
12147: $output .= $lt{'auto'}.'<br />'.
12148: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59 raeburn 12149: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 12150: $lt{'yes'}.'</label> <label>'.
12151: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
12152: $lt{'no'}.'</label></span><br />'.
12153: '<div id="camtasia_titles" style="display:block">'.
12154: &Apache::lonhtmlcommon::start_pick_box().
12155: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
12156: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
12157: &Apache::lonhtmlcommon::row_closure().
12158: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
12159: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
12160: &Apache::lonhtmlcommon::row_closure(1).
12161: &Apache::lonhtmlcommon::end_pick_box().
12162: '</div>';
12163: }
1.1065 raeburn 12164: $output .=
12165: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 12166: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
12167: "\n";
1.1065 raeburn 12168: if ($duplicates ne '') {
12169: $output .= '<p><span class="LC_warning">'.
12170: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
12171: &start_data_table().
12172: &start_data_table_header_row().
12173: '<th>'.&mt('Overwrite?').'</th>'.
12174: '<th>'.&mt('Name').'</th>'.
12175: '<th>'.&mt('Type').'</th>'.
12176: '<th>'.&mt('Size').'</th>'.
12177: '<th>'.&mt('Last modified').'</th>'.
12178: &end_data_table_header_row().
12179: $duplicates.
12180: &end_data_table().
12181: '</p>';
12182: }
1.1067 raeburn 12183: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 12184: if (ref($hiddenelements) eq 'HASH') {
12185: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
12186: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
12187: }
12188: }
12189: $output .= <<"END";
1.1067 raeburn 12190: <br />
1.1053 raeburn 12191: <input type="submit" name="decompress" value="$lt{'extr'}" />
12192: </form>
12193: $noextract
12194: END
12195: return $output;
12196: }
12197:
1.1065 raeburn 12198: sub decompression_utility {
12199: my ($program) = @_;
12200: my @utilities = ('tar','gunzip','bunzip2','unzip');
12201: my $location;
12202: if (grep(/^\Q$program\E$/,@utilities)) {
12203: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
12204: '/usr/sbin/') {
12205: if (-x $dir.$program) {
12206: $location = $dir.$program;
12207: last;
12208: }
12209: }
12210: }
12211: return $location;
12212: }
12213:
12214: sub list_archive_contents {
12215: my ($file,$pathsref) = @_;
12216: my (@cmd,$output);
12217: my $needsregexp;
12218: if ($file =~ /\.zip$/) {
12219: @cmd = (&decompression_utility('unzip'),"-l");
12220: $needsregexp = 1;
12221: } elsif (($file =~ m/\.tar\.gz$/) ||
12222: ($file =~ /\.tgz$/)) {
12223: @cmd = (&decompression_utility('tar'),"-ztf");
12224: } elsif ($file =~ /\.tar\.bz2$/) {
12225: @cmd = (&decompression_utility('tar'),"-jtf");
12226: } elsif ($file =~ m|\.tar$|) {
12227: @cmd = (&decompression_utility('tar'),"-tf");
12228: }
12229: if (@cmd) {
12230: undef($!);
12231: undef($@);
12232: if (open(my $fh,"-|", @cmd, $file)) {
12233: while (my $line = <$fh>) {
12234: $output .= $line;
12235: chomp($line);
12236: my $item;
12237: if ($needsregexp) {
12238: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
12239: } else {
12240: $item = $line;
12241: }
12242: if ($item ne '') {
12243: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
12244: push(@{$pathsref},$item);
12245: }
12246: }
12247: }
12248: close($fh);
12249: }
12250: }
12251: return $output;
12252: }
12253:
1.1053 raeburn 12254: sub decompress_uploaded_file {
12255: my ($file,$dir) = @_;
12256: &Apache::lonnet::appenv({'cgi.file' => $file});
12257: &Apache::lonnet::appenv({'cgi.dir' => $dir});
12258: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
12259: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
12260: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
12261: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
12262: my $decompressed = $env{'cgi.decompressed'};
12263: &Apache::lonnet::delenv('cgi.file');
12264: &Apache::lonnet::delenv('cgi.dir');
12265: &Apache::lonnet::delenv('cgi.decompressed');
12266: return ($decompressed,$result);
12267: }
12268:
1.1055 raeburn 12269: sub process_decompression {
12270: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128 raeburn 12271: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
12272: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12273: &mt('Unexpected file path.').'</p>'."\n";
12274: }
12275: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
12276: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12277: &mt('Unexpected course context.').'</p>'."\n";
12278: }
12279: unless ($file eq &Apache::lonnet::clean_filename($file)) {
12280: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12281: &mt('Filename contained unexpected characters.').'</p>'."\n";
12282: }
1.1055 raeburn 12283: my ($dir,$error,$warning,$output);
1.1075.2.69 raeburn 12284: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34 raeburn 12285: $error = &mt('Filename not a supported archive file type.').
12286: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 12287: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
12288: } else {
12289: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12290: if ($docuhome eq 'no_host') {
12291: $error = &mt('Could not determine home server for course.');
12292: } else {
12293: my @ids=&Apache::lonnet::current_machine_ids();
12294: my $currdir = "$dir_root/$destination";
12295: if (grep(/^\Q$docuhome\E$/,@ids)) {
12296: $dir = &LONCAPA::propath($docudom,$docuname).
12297: "$dir_root/$destination";
12298: } else {
12299: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
12300: "$dir_root/$docudom/$docuname/$destination";
12301: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
12302: $error = &mt('Archive file not found.');
12303: }
12304: }
1.1065 raeburn 12305: my (@to_overwrite,@to_skip);
12306: if ($env{'form.archive_overwrite_total'} > 0) {
12307: my $total = $env{'form.archive_overwrite_total'};
12308: for (my $i=0; $i<$total; $i++) {
12309: if ($env{'form.archive_overwrite_'.$i} == 1) {
12310: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
12311: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
12312: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
12313: }
12314: }
12315: }
12316: my $numskip = scalar(@to_skip);
1.1075.2.128 raeburn 12317: my $numoverwrite = scalar(@to_overwrite);
12318: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 12319: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
12320: } elsif ($dir eq '') {
1.1055 raeburn 12321: $error = &mt('Directory containing archive file unavailable.');
12322: } elsif (!$error) {
1.1065 raeburn 12323: my ($decompressed,$display);
1.1075.2.128 raeburn 12324: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 12325: my $tempdir = time.'_'.$$.int(rand(10000));
12326: mkdir("$dir/$tempdir",0755);
1.1075.2.128 raeburn 12327: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
12328: ($decompressed,$display) =
12329: &decompress_uploaded_file($file,"$dir/$tempdir");
12330: foreach my $item (@to_skip) {
12331: if (($item ne '') && ($item !~ /\.\./)) {
12332: if (-f "$dir/$tempdir/$item") {
12333: unlink("$dir/$tempdir/$item");
12334: } elsif (-d "$dir/$tempdir/$item") {
12335: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
12336: }
12337: }
12338: }
12339: foreach my $item (@to_overwrite) {
12340: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
12341: if (($item ne '') && ($item !~ /\.\./)) {
12342: if (-f "$dir/$item") {
12343: unlink("$dir/$item");
12344: } elsif (-d "$dir/$item") {
12345: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
12346: }
12347: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
12348: }
1.1065 raeburn 12349: }
12350: }
1.1075.2.128 raeburn 12351: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
12352: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
12353: }
1.1065 raeburn 12354: }
12355: } else {
12356: ($decompressed,$display) =
12357: &decompress_uploaded_file($file,$dir);
12358: }
1.1055 raeburn 12359: if ($decompressed eq 'ok') {
1.1065 raeburn 12360: $output = '<p class="LC_info">'.
12361: &mt('Files extracted successfully from archive.').
12362: '</p>'."\n";
1.1055 raeburn 12363: my ($warning,$result,@contents);
12364: my ($newdirlistref,$newlisterror) =
12365: &Apache::lonnet::dirlist($currdir,$docudom,
12366: $docuname,1);
12367: my (%is_dir,%changes,@newitems);
12368: my $dirptr = 16384;
1.1065 raeburn 12369: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 12370: foreach my $dir_line (@{$newdirlistref}) {
12371: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128 raeburn 12372: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 12373: push(@newitems,$item);
12374: if ($dirptr&$testdir) {
12375: $is_dir{$item} = 1;
12376: }
12377: $changes{$item} = 1;
12378: }
12379: }
12380: }
12381: if (keys(%changes) > 0) {
12382: foreach my $item (sort(@newitems)) {
12383: if ($changes{$item}) {
12384: push(@contents,$item);
12385: }
12386: }
12387: }
12388: if (@contents > 0) {
1.1067 raeburn 12389: my $wantform;
12390: unless ($env{'form.autoextract_camtasia'}) {
12391: $wantform = 1;
12392: }
1.1056 raeburn 12393: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 12394: my ($count,$datatable) = &get_extracted($docudom,$docuname,
12395: $currdir,\%is_dir,
12396: \%children,\%parent,
1.1056 raeburn 12397: \@contents,\%dirorder,
12398: \%titles,$wantform);
1.1055 raeburn 12399: if ($datatable ne '') {
12400: $output .= &archive_options_form('decompressed',$datatable,
12401: $count,$hiddenelem);
1.1065 raeburn 12402: my $startcount = 6;
1.1055 raeburn 12403: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 12404: \%titles,\%children);
1.1055 raeburn 12405: }
1.1067 raeburn 12406: if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59 raeburn 12407: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 12408: my %displayed;
12409: my $total = 1;
12410: $env{'form.archive_directory'} = [];
12411: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
12412: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
12413: $path =~ s{/$}{};
12414: my $item;
12415: if ($path ne '') {
12416: $item = "$path/$titles{$i}";
12417: } else {
12418: $item = $titles{$i};
12419: }
12420: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
12421: if ($item eq $contents[0]) {
12422: push(@{$env{'form.archive_directory'}},$i);
12423: $env{'form.archive_'.$i} = 'display';
12424: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
12425: $displayed{'folder'} = $i;
1.1075.2.59 raeburn 12426: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
12427: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 12428: $env{'form.archive_'.$i} = 'display';
12429: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
12430: $displayed{'web'} = $i;
12431: } else {
1.1075.2.59 raeburn 12432: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
12433: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
12434: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 12435: push(@{$env{'form.archive_directory'}},$i);
12436: }
12437: $env{'form.archive_'.$i} = 'dependency';
12438: }
12439: $total ++;
12440: }
12441: for (my $i=1; $i<$total; $i++) {
12442: next if ($i == $displayed{'web'});
12443: next if ($i == $displayed{'folder'});
12444: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
12445: }
12446: $env{'form.phase'} = 'decompress_cleanup';
12447: $env{'form.archivedelete'} = 1;
12448: $env{'form.archive_count'} = $total-1;
12449: $output .=
12450: &process_extracted_files('coursedocs',$docudom,
12451: $docuname,$destination,
12452: $dir_root,$hiddenelem);
12453: }
1.1055 raeburn 12454: } else {
12455: $warning = &mt('No new items extracted from archive file.');
12456: }
12457: } else {
12458: $output = $display;
12459: $error = &mt('An error occurred during extraction from the archive file.');
12460: }
12461: }
12462: }
12463: }
12464: if ($error) {
12465: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12466: $error.'</p>'."\n";
12467: }
12468: if ($warning) {
12469: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12470: }
12471: return $output;
12472: }
12473:
12474: sub get_extracted {
1.1056 raeburn 12475: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
12476: $titles,$wantform) = @_;
1.1055 raeburn 12477: my $count = 0;
12478: my $depth = 0;
12479: my $datatable;
1.1056 raeburn 12480: my @hierarchy;
1.1055 raeburn 12481: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 12482: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
12483: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 12484: foreach my $item (@{$contents}) {
12485: $count ++;
1.1056 raeburn 12486: @{$dirorder->{$count}} = @hierarchy;
12487: $titles->{$count} = $item;
1.1055 raeburn 12488: &archive_hierarchy($depth,$count,$parent,$children);
12489: if ($wantform) {
12490: $datatable .= &archive_row($is_dir->{$item},$item,
12491: $currdir,$depth,$count);
12492: }
12493: if ($is_dir->{$item}) {
12494: $depth ++;
1.1056 raeburn 12495: push(@hierarchy,$count);
12496: $parent->{$depth} = $count;
1.1055 raeburn 12497: $datatable .=
12498: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 12499: \$depth,\$count,\@hierarchy,$dirorder,
12500: $children,$parent,$titles,$wantform);
1.1055 raeburn 12501: $depth --;
1.1056 raeburn 12502: pop(@hierarchy);
1.1055 raeburn 12503: }
12504: }
12505: return ($count,$datatable);
12506: }
12507:
12508: sub recurse_extracted_archive {
1.1056 raeburn 12509: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
12510: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 12511: my $result='';
1.1056 raeburn 12512: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
12513: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
12514: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 12515: return $result;
12516: }
12517: my $dirptr = 16384;
12518: my ($newdirlistref,$newlisterror) =
12519: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
12520: if (ref($newdirlistref) eq 'ARRAY') {
12521: foreach my $dir_line (@{$newdirlistref}) {
12522: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
12523: unless ($item =~ /^\.+$/) {
12524: $$count ++;
1.1056 raeburn 12525: @{$dirorder->{$$count}} = @{$hierarchy};
12526: $titles->{$$count} = $item;
1.1055 raeburn 12527: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 12528:
1.1055 raeburn 12529: my $is_dir;
12530: if ($dirptr&$testdir) {
12531: $is_dir = 1;
12532: }
12533: if ($wantform) {
12534: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
12535: }
12536: if ($is_dir) {
12537: $$depth ++;
1.1056 raeburn 12538: push(@{$hierarchy},$$count);
12539: $parent->{$$depth} = $$count;
1.1055 raeburn 12540: $result .=
12541: &recurse_extracted_archive("$currdir/$item",$docudom,
12542: $docuname,$depth,$count,
1.1056 raeburn 12543: $hierarchy,$dirorder,$children,
12544: $parent,$titles,$wantform);
1.1055 raeburn 12545: $$depth --;
1.1056 raeburn 12546: pop(@{$hierarchy});
1.1055 raeburn 12547: }
12548: }
12549: }
12550: }
12551: return $result;
12552: }
12553:
12554: sub archive_hierarchy {
12555: my ($depth,$count,$parent,$children) =@_;
12556: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
12557: if (exists($parent->{$depth})) {
12558: $children->{$parent->{$depth}} .= $count.':';
12559: }
12560: }
12561: return;
12562: }
12563:
12564: sub archive_row {
12565: my ($is_dir,$item,$currdir,$depth,$count) = @_;
12566: my ($name) = ($item =~ m{([^/]+)$});
12567: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 12568: 'display' => 'Add as file',
1.1055 raeburn 12569: 'dependency' => 'Include as dependency',
12570: 'discard' => 'Discard',
12571: );
12572: if ($is_dir) {
1.1059 raeburn 12573: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 12574: }
1.1056 raeburn 12575: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
12576: my $offset = 0;
1.1055 raeburn 12577: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 12578: $offset ++;
1.1065 raeburn 12579: if ($action ne 'display') {
12580: $offset ++;
12581: }
1.1055 raeburn 12582: $output .= '<td><span class="LC_nobreak">'.
12583: '<label><input type="radio" name="archive_'.$count.
12584: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
12585: my $text = $choices{$action};
12586: if ($is_dir) {
12587: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
12588: if ($action eq 'display') {
1.1059 raeburn 12589: $text = &mt('Add as folder');
1.1055 raeburn 12590: }
1.1056 raeburn 12591: } else {
12592: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
12593:
12594: }
12595: $output .= ' /> '.$choices{$action}.'</label></span>';
12596: if ($action eq 'dependency') {
12597: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
12598: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
12599: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
12600: '<option value=""></option>'."\n".
12601: '</select>'."\n".
12602: '</div>';
1.1059 raeburn 12603: } elsif ($action eq 'display') {
12604: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
12605: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
12606: '</div>';
1.1055 raeburn 12607: }
1.1056 raeburn 12608: $output .= '</td>';
1.1055 raeburn 12609: }
12610: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
12611: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
12612: for (my $i=0; $i<$depth; $i++) {
12613: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
12614: }
12615: if ($is_dir) {
12616: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
12617: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
12618: } else {
12619: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
12620: }
12621: $output .= ' '.$name.'</td>'."\n".
12622: &end_data_table_row();
12623: return $output;
12624: }
12625:
12626: sub archive_options_form {
1.1065 raeburn 12627: my ($form,$display,$count,$hiddenelem) = @_;
12628: my %lt = &Apache::lonlocal::texthash(
12629: perm => 'Permanently remove archive file?',
12630: hows => 'How should each extracted item be incorporated in the course?',
12631: cont => 'Content actions for all',
12632: addf => 'Add as folder/file',
12633: incd => 'Include as dependency for a displayed file',
12634: disc => 'Discard',
12635: no => 'No',
12636: yes => 'Yes',
12637: save => 'Save',
12638: );
12639: my $output = <<"END";
12640: <form name="$form" method="post" action="">
12641: <p><span class="LC_nobreak">$lt{'perm'}
12642: <label>
12643: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
12644: </label>
12645:
12646: <label>
12647: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
12648: </span>
12649: </p>
12650: <input type="hidden" name="phase" value="decompress_cleanup" />
12651: <br />$lt{'hows'}
12652: <div class="LC_columnSection">
12653: <fieldset>
12654: <legend>$lt{'cont'}</legend>
12655: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
12656: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
12657: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
12658: </fieldset>
12659: </div>
12660: END
12661: return $output.
1.1055 raeburn 12662: &start_data_table()."\n".
1.1065 raeburn 12663: $display."\n".
1.1055 raeburn 12664: &end_data_table()."\n".
12665: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
12666: $hiddenelem.
1.1065 raeburn 12667: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 12668: '</form>';
12669: }
12670:
12671: sub archive_javascript {
1.1056 raeburn 12672: my ($startcount,$numitems,$titles,$children) = @_;
12673: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 12674: my $maintitle = $env{'form.comment'};
1.1055 raeburn 12675: my $scripttag = <<START;
12676: <script type="text/javascript">
12677: // <![CDATA[
12678:
12679: function checkAll(form,prefix) {
12680: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
12681: for (var i=0; i < form.elements.length; i++) {
12682: var id = form.elements[i].id;
12683: if ((id != '') && (id != undefined)) {
12684: if (idstr.test(id)) {
12685: if (form.elements[i].type == 'radio') {
12686: form.elements[i].checked = true;
1.1056 raeburn 12687: var nostart = i-$startcount;
1.1059 raeburn 12688: var offset = nostart%7;
12689: var count = (nostart-offset)/7;
1.1056 raeburn 12690: dependencyCheck(form,count,offset);
1.1055 raeburn 12691: }
12692: }
12693: }
12694: }
12695: }
12696:
12697: function propagateCheck(form,count) {
12698: if (count > 0) {
1.1059 raeburn 12699: var startelement = $startcount + ((count-1) * 7);
12700: for (var j=1; j<6; j++) {
12701: if ((j != 2) && (j != 4)) {
1.1056 raeburn 12702: var item = startelement + j;
12703: if (form.elements[item].type == 'radio') {
12704: if (form.elements[item].checked) {
12705: containerCheck(form,count,j);
12706: break;
12707: }
1.1055 raeburn 12708: }
12709: }
12710: }
12711: }
12712: }
12713:
12714: numitems = $numitems
1.1056 raeburn 12715: var titles = new Array(numitems);
12716: var parents = new Array(numitems);
1.1055 raeburn 12717: for (var i=0; i<numitems; i++) {
1.1056 raeburn 12718: parents[i] = new Array;
1.1055 raeburn 12719: }
1.1059 raeburn 12720: var maintitle = '$maintitle';
1.1055 raeburn 12721:
12722: START
12723:
1.1056 raeburn 12724: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
12725: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 12726: for (my $i=0; $i<@contents; $i ++) {
12727: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
12728: }
12729: }
12730:
1.1056 raeburn 12731: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
12732: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
12733: }
12734:
1.1055 raeburn 12735: $scripttag .= <<END;
12736:
12737: function containerCheck(form,count,offset) {
12738: if (count > 0) {
1.1056 raeburn 12739: dependencyCheck(form,count,offset);
1.1059 raeburn 12740: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 12741: form.elements[item].checked = true;
12742: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
12743: if (parents[count].length > 0) {
12744: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 12745: containerCheck(form,parents[count][j],offset);
12746: }
12747: }
12748: }
12749: }
12750: }
12751:
12752: function dependencyCheck(form,count,offset) {
12753: if (count > 0) {
1.1059 raeburn 12754: var chosen = (offset+$startcount)+7*(count-1);
12755: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 12756: var currtype = form.elements[depitem].type;
12757: if (form.elements[chosen].value == 'dependency') {
12758: document.getElementById('arc_depon_'+count).style.display='block';
12759: form.elements[depitem].options.length = 0;
12760: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11 raeburn 12761: for (var i=1; i<=numitems; i++) {
12762: if (i == count) {
12763: continue;
12764: }
1.1059 raeburn 12765: var startelement = $startcount + (i-1) * 7;
12766: for (var j=1; j<6; j++) {
12767: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 12768: var item = startelement + j;
12769: if (form.elements[item].type == 'radio') {
12770: if (form.elements[item].checked) {
12771: if (form.elements[item].value == 'display') {
12772: var n = form.elements[depitem].options.length;
12773: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
12774: }
12775: }
12776: }
12777: }
12778: }
12779: }
12780: } else {
12781: document.getElementById('arc_depon_'+count).style.display='none';
12782: form.elements[depitem].options.length = 0;
12783: form.elements[depitem].options[0] = new Option('Select','',true,true);
12784: }
1.1059 raeburn 12785: titleCheck(form,count,offset);
1.1056 raeburn 12786: }
12787: }
12788:
12789: function propagateSelect(form,count,offset) {
12790: if (count > 0) {
1.1065 raeburn 12791: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 12792: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
12793: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12794: if (parents[count].length > 0) {
12795: for (var j=0; j<parents[count].length; j++) {
12796: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 12797: }
12798: }
12799: }
12800: }
12801: }
1.1056 raeburn 12802:
12803: function containerSelect(form,count,offset,picked) {
12804: if (count > 0) {
1.1065 raeburn 12805: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 12806: if (form.elements[item].type == 'radio') {
12807: if (form.elements[item].value == 'dependency') {
12808: if (form.elements[item+1].type == 'select-one') {
12809: for (var i=0; i<form.elements[item+1].options.length; i++) {
12810: if (form.elements[item+1].options[i].value == picked) {
12811: form.elements[item+1].selectedIndex = i;
12812: break;
12813: }
12814: }
12815: }
12816: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
12817: if (parents[count].length > 0) {
12818: for (var j=0; j<parents[count].length; j++) {
12819: containerSelect(form,parents[count][j],offset,picked);
12820: }
12821: }
12822: }
12823: }
12824: }
12825: }
12826: }
12827:
1.1059 raeburn 12828: function titleCheck(form,count,offset) {
12829: if (count > 0) {
12830: var chosen = (offset+$startcount)+7*(count-1);
12831: var depitem = $startcount + ((count-1) * 7) + 2;
12832: var currtype = form.elements[depitem].type;
12833: if (form.elements[chosen].value == 'display') {
12834: document.getElementById('arc_title_'+count).style.display='block';
12835: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
12836: document.getElementById('archive_title_'+count).value=maintitle;
12837: }
12838: } else {
12839: document.getElementById('arc_title_'+count).style.display='none';
12840: if (currtype == 'text') {
12841: document.getElementById('archive_title_'+count).value='';
12842: }
12843: }
12844: }
12845: return;
12846: }
12847:
1.1055 raeburn 12848: // ]]>
12849: </script>
12850: END
12851: return $scripttag;
12852: }
12853:
12854: sub process_extracted_files {
1.1067 raeburn 12855: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 12856: my $numitems = $env{'form.archive_count'};
1.1075.2.128 raeburn 12857: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 12858: my @ids=&Apache::lonnet::current_machine_ids();
12859: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 12860: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 12861: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12862: if (grep(/^\Q$docuhome\E$/,@ids)) {
12863: $prefix = &LONCAPA::propath($docudom,$docuname);
12864: $pathtocheck = "$dir_root/$destination";
12865: $dir = $dir_root;
12866: $ishome = 1;
12867: } else {
12868: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
12869: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128 raeburn 12870: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 12871: }
12872: my $currdir = "$dir_root/$destination";
12873: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
12874: if ($env{'form.folderpath'}) {
12875: my @items = split('&',$env{'form.folderpath'});
12876: $folders{'0'} = $items[-2];
1.1075.2.17 raeburn 12877: if ($env{'form.folderpath'} =~ /\:1$/) {
12878: $containers{'0'}='page';
12879: } else {
12880: $containers{'0'}='sequence';
12881: }
1.1055 raeburn 12882: }
12883: my @archdirs = &get_env_multiple('form.archive_directory');
12884: if ($numitems) {
12885: for (my $i=1; $i<=$numitems; $i++) {
12886: my $path = $env{'form.archive_content_'.$i};
12887: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
12888: my $item = $1;
12889: $toplevelitems{$item} = $i;
12890: if (grep(/^\Q$i\E$/,@archdirs)) {
12891: $is_dir{$item} = 1;
12892: }
12893: }
12894: }
12895: }
1.1067 raeburn 12896: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 12897: if (keys(%toplevelitems) > 0) {
12898: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 12899: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
12900: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 12901: }
1.1066 raeburn 12902: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 12903: if ($numitems) {
12904: for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11 raeburn 12905: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 12906: my $path = $env{'form.archive_content_'.$i};
12907: if ($path =~ /^\Q$pathtocheck\E/) {
12908: if ($env{'form.archive_'.$i} eq 'discard') {
12909: if ($prefix ne '' && $path ne '') {
12910: if (-e $prefix.$path) {
1.1066 raeburn 12911: if ((@archdirs > 0) &&
12912: (grep(/^\Q$i\E$/,@archdirs))) {
12913: $todeletedir{$prefix.$path} = 1;
12914: } else {
12915: $todelete{$prefix.$path} = 1;
12916: }
1.1055 raeburn 12917: }
12918: }
12919: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 12920: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 12921: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 12922: $docstitle = $env{'form.archive_title_'.$i};
12923: if ($docstitle eq '') {
12924: $docstitle = $title;
12925: }
1.1055 raeburn 12926: $outer = 0;
1.1056 raeburn 12927: if (ref($dirorder{$i}) eq 'ARRAY') {
12928: if (@{$dirorder{$i}} > 0) {
12929: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 12930: if ($env{'form.archive_'.$item} eq 'display') {
12931: $outer = $item;
12932: last;
12933: }
12934: }
12935: }
12936: }
12937: my ($errtext,$fatal) =
12938: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
12939: '/'.$folders{$outer}.'.'.
12940: $containers{$outer});
12941: next if ($fatal);
12942: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
12943: if ($context eq 'coursedocs') {
1.1056 raeburn 12944: $mapinner{$i} = time;
1.1055 raeburn 12945: $folders{$i} = 'default_'.$mapinner{$i};
12946: $containers{$i} = 'sequence';
12947: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12948: $folders{$i}.'.'.$containers{$i};
12949: my $newidx = &LONCAPA::map::getresidx();
12950: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 12951: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 12952: push(@LONCAPA::map::order,$newidx);
12953: my ($outtext,$errtext) =
12954: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12955: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 12956: '.'.$containers{$outer},1,1);
1.1056 raeburn 12957: $newseqid{$i} = $newidx;
1.1067 raeburn 12958: unless ($errtext) {
1.1075.2.128 raeburn 12959: $result .= '<li>'.&mt('Folder: [_1] added to course',
12960: &HTML::Entities::encode($docstitle,'<>&"'))..
12961: '</li>'."\n";
1.1067 raeburn 12962: }
1.1055 raeburn 12963: }
12964: } else {
12965: if ($context eq 'coursedocs') {
12966: my $newidx=&LONCAPA::map::getresidx();
12967: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
12968: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
12969: $title;
1.1075.2.128 raeburn 12970: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
12971: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
12972: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067 raeburn 12973: }
1.1075.2.128 raeburn 12974: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12975: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
12976: }
12977: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
12978: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
12979: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
12980: unless ($ishome) {
12981: my $fetch = "$newdest{$i}/$title";
12982: $fetch =~ s/^\Q$prefix$dir\E//;
12983: $prompttofetch{$fetch} = 1;
12984: }
12985: }
12986: }
12987: $LONCAPA::map::resources[$newidx]=
12988: $docstitle.':'.$url.':false:normal:res';
12989: push(@LONCAPA::map::order, $newidx);
12990: my ($outtext,$errtext)=
12991: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
12992: $docuname.'/'.$folders{$outer}.
12993: '.'.$containers{$outer},1,1);
12994: unless ($errtext) {
12995: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
12996: $result .= '<li>'.&mt('File: [_1] added to course',
12997: &HTML::Entities::encode($docstitle,'<>&"')).
12998: '</li>'."\n";
12999: }
1.1067 raeburn 13000: }
1.1075.2.128 raeburn 13001: } else {
13002: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13003: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067 raeburn 13004: }
1.1055 raeburn 13005: }
13006: }
1.1075.2.11 raeburn 13007: }
13008: } else {
1.1075.2.128 raeburn 13009: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13010: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11 raeburn 13011: }
13012: }
13013: for (my $i=1; $i<=$numitems; $i++) {
13014: next unless ($env{'form.archive_'.$i} eq 'dependency');
13015: my $path = $env{'form.archive_content_'.$i};
13016: if ($path =~ /^\Q$pathtocheck\E/) {
13017: my ($title) = ($path =~ m{/([^/]+)$});
13018: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
13019: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
13020: if (ref($dirorder{$i}) eq 'ARRAY') {
13021: my ($itemidx,$fullpath,$relpath);
13022: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
13023: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 13024: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11 raeburn 13025: if ($dirorder{$i}->[$j] eq $container) {
13026: $itemidx = $j;
1.1056 raeburn 13027: }
13028: }
1.1075.2.11 raeburn 13029: }
13030: if ($itemidx eq '') {
13031: $itemidx = 0;
13032: }
13033: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
13034: if ($mapinner{$referrer{$i}}) {
13035: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
13036: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13037: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13038: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13039: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13040: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13041: if (!-e $fullpath) {
13042: mkdir($fullpath,0755);
1.1056 raeburn 13043: }
13044: }
1.1075.2.11 raeburn 13045: } else {
13046: last;
1.1056 raeburn 13047: }
1.1075.2.11 raeburn 13048: }
13049: }
13050: } elsif ($newdest{$referrer{$i}}) {
13051: $fullpath = $newdest{$referrer{$i}};
13052: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13053: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
13054: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
13055: last;
13056: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13057: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13058: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13059: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13060: if (!-e $fullpath) {
13061: mkdir($fullpath,0755);
1.1056 raeburn 13062: }
13063: }
1.1075.2.11 raeburn 13064: } else {
13065: last;
1.1056 raeburn 13066: }
1.1075.2.11 raeburn 13067: }
13068: }
13069: if ($fullpath ne '') {
13070: if (-e "$prefix$path") {
1.1075.2.128 raeburn 13071: unless (rename("$prefix$path","$fullpath/$title")) {
13072: $warning .= &mt('Failed to rename dependency').'<br />';
13073: }
1.1075.2.11 raeburn 13074: }
13075: if (-e "$fullpath/$title") {
13076: my $showpath;
13077: if ($relpath ne '') {
13078: $showpath = "$relpath/$title";
13079: } else {
13080: $showpath = "/$title";
1.1056 raeburn 13081: }
1.1075.2.128 raeburn 13082: $result .= '<li>'.&mt('[_1] included as a dependency',
13083: &HTML::Entities::encode($showpath,'<>&"')).
13084: '</li>'."\n";
13085: unless ($ishome) {
13086: my $fetch = "$fullpath/$title";
13087: $fetch =~ s/^\Q$prefix$dir\E//;
13088: $prompttofetch{$fetch} = 1;
13089: }
1.1055 raeburn 13090: }
13091: }
13092: }
1.1075.2.11 raeburn 13093: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
13094: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128 raeburn 13095: &HTML::Entities::encode($path,'<>&"'),
13096: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
13097: '<br />';
1.1055 raeburn 13098: }
13099: } else {
1.1075.2.128 raeburn 13100: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13101: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 13102: }
13103: }
13104: if (keys(%todelete)) {
13105: foreach my $key (keys(%todelete)) {
13106: unlink($key);
1.1066 raeburn 13107: }
13108: }
13109: if (keys(%todeletedir)) {
13110: foreach my $key (keys(%todeletedir)) {
13111: rmdir($key);
13112: }
13113: }
13114: foreach my $dir (sort(keys(%is_dir))) {
13115: if (($pathtocheck ne '') && ($dir ne '')) {
13116: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 13117: }
13118: }
1.1067 raeburn 13119: if ($result ne '') {
13120: $output .= '<ul>'."\n".
13121: $result."\n".
13122: '</ul>';
13123: }
13124: unless ($ishome) {
13125: my $replicationfail;
13126: foreach my $item (keys(%prompttofetch)) {
13127: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
13128: unless ($fetchresult eq 'ok') {
13129: $replicationfail .= '<li>'.$item.'</li>'."\n";
13130: }
13131: }
13132: if ($replicationfail) {
13133: $output .= '<p class="LC_error">'.
13134: &mt('Course home server failed to retrieve:').'<ul>'.
13135: $replicationfail.
13136: '</ul></p>';
13137: }
13138: }
1.1055 raeburn 13139: } else {
13140: $warning = &mt('No items found in archive.');
13141: }
13142: if ($error) {
13143: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13144: $error.'</p>'."\n";
13145: }
13146: if ($warning) {
13147: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13148: }
13149: return $output;
13150: }
13151:
1.1066 raeburn 13152: sub cleanup_empty_dirs {
13153: my ($path) = @_;
13154: if (($path ne '') && (-d $path)) {
13155: if (opendir(my $dirh,$path)) {
13156: my @dircontents = grep(!/^\./,readdir($dirh));
13157: my $numitems = 0;
13158: foreach my $item (@dircontents) {
13159: if (-d "$path/$item") {
1.1075.2.28 raeburn 13160: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 13161: if (-e "$path/$item") {
13162: $numitems ++;
13163: }
13164: } else {
13165: $numitems ++;
13166: }
13167: }
13168: if ($numitems == 0) {
13169: rmdir($path);
13170: }
13171: closedir($dirh);
13172: }
13173: }
13174: return;
13175: }
13176:
1.41 ng 13177: =pod
1.45 matthew 13178:
1.1075.2.56 raeburn 13179: =item * &get_folder_hierarchy()
1.1068 raeburn 13180:
13181: Provides hierarchy of names of folders/sub-folders containing the current
13182: item,
13183:
13184: Inputs: 3
13185: - $navmap - navmaps object
13186:
13187: - $map - url for map (either the trigger itself, or map containing
13188: the resource, which is the trigger).
13189:
13190: - $showitem - 1 => show title for map itself; 0 => do not show.
13191:
13192: Outputs: 1 @pathitems - array of folder/subfolder names.
13193:
13194: =cut
13195:
13196: sub get_folder_hierarchy {
13197: my ($navmap,$map,$showitem) = @_;
13198: my @pathitems;
13199: if (ref($navmap)) {
13200: my $mapres = $navmap->getResourceByUrl($map);
13201: if (ref($mapres)) {
13202: my $pcslist = $mapres->map_hierarchy();
13203: if ($pcslist ne '') {
13204: my @pcs = split(/,/,$pcslist);
13205: foreach my $pc (@pcs) {
13206: if ($pc == 1) {
1.1075.2.38 raeburn 13207: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 13208: } else {
13209: my $res = $navmap->getByMapPc($pc);
13210: if (ref($res)) {
13211: my $title = $res->compTitle();
13212: $title =~ s/\W+/_/g;
13213: if ($title ne '') {
13214: push(@pathitems,$title);
13215: }
13216: }
13217: }
13218: }
13219: }
1.1071 raeburn 13220: if ($showitem) {
13221: if ($mapres->{ID} eq '0.0') {
1.1075.2.38 raeburn 13222: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 13223: } else {
13224: my $maptitle = $mapres->compTitle();
13225: $maptitle =~ s/\W+/_/g;
13226: if ($maptitle ne '') {
13227: push(@pathitems,$maptitle);
13228: }
1.1068 raeburn 13229: }
13230: }
13231: }
13232: }
13233: return @pathitems;
13234: }
13235:
13236: =pod
13237:
1.1015 raeburn 13238: =item * &get_turnedin_filepath()
13239:
13240: Determines path in a user's portfolio file for storage of files uploaded
13241: to a specific essayresponse or dropbox item.
13242:
13243: Inputs: 3 required + 1 optional.
13244: $symb is symb for resource, $uname and $udom are for current user (required).
13245: $caller is optional (can be "submission", if routine is called when storing
13246: an upoaded file when "Submit Answer" button was pressed).
13247:
13248: Returns array containing $path and $multiresp.
13249: $path is path in portfolio. $multiresp is 1 if this resource contains more
13250: than one file upload item. Callers of routine should append partid as a
13251: subdirectory to $path in cases where $multiresp is 1.
13252:
13253: Called by: homework/essayresponse.pm and homework/structuretags.pm
13254:
13255: =cut
13256:
13257: sub get_turnedin_filepath {
13258: my ($symb,$uname,$udom,$caller) = @_;
13259: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
13260: my $turnindir;
13261: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
13262: $turnindir = $userhash{'turnindir'};
13263: my ($path,$multiresp);
13264: if ($turnindir eq '') {
13265: if ($caller eq 'submission') {
13266: $turnindir = &mt('turned in');
13267: $turnindir =~ s/\W+/_/g;
13268: my %newhash = (
13269: 'turnindir' => $turnindir,
13270: );
13271: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
13272: }
13273: }
13274: if ($turnindir ne '') {
13275: $path = '/'.$turnindir.'/';
13276: my ($multipart,$turnin,@pathitems);
13277: my $navmap = Apache::lonnavmaps::navmap->new();
13278: if (defined($navmap)) {
13279: my $mapres = $navmap->getResourceByUrl($map);
13280: if (ref($mapres)) {
13281: my $pcslist = $mapres->map_hierarchy();
13282: if ($pcslist ne '') {
13283: foreach my $pc (split(/,/,$pcslist)) {
13284: my $res = $navmap->getByMapPc($pc);
13285: if (ref($res)) {
13286: my $title = $res->compTitle();
13287: $title =~ s/\W+/_/g;
13288: if ($title ne '') {
1.1075.2.48 raeburn 13289: if (($pc > 1) && (length($title) > 12)) {
13290: $title = substr($title,0,12);
13291: }
1.1015 raeburn 13292: push(@pathitems,$title);
13293: }
13294: }
13295: }
13296: }
13297: my $maptitle = $mapres->compTitle();
13298: $maptitle =~ s/\W+/_/g;
13299: if ($maptitle ne '') {
1.1075.2.48 raeburn 13300: if (length($maptitle) > 12) {
13301: $maptitle = substr($maptitle,0,12);
13302: }
1.1015 raeburn 13303: push(@pathitems,$maptitle);
13304: }
13305: unless ($env{'request.state'} eq 'construct') {
13306: my $res = $navmap->getBySymb($symb);
13307: if (ref($res)) {
13308: my $partlist = $res->parts();
13309: my $totaluploads = 0;
13310: if (ref($partlist) eq 'ARRAY') {
13311: foreach my $part (@{$partlist}) {
13312: my @types = $res->responseType($part);
13313: my @ids = $res->responseIds($part);
13314: for (my $i=0; $i < scalar(@ids); $i++) {
13315: if ($types[$i] eq 'essay') {
13316: my $partid = $part.'_'.$ids[$i];
13317: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
13318: $totaluploads ++;
13319: }
13320: }
13321: }
13322: }
13323: if ($totaluploads > 1) {
13324: $multiresp = 1;
13325: }
13326: }
13327: }
13328: }
13329: } else {
13330: return;
13331: }
13332: } else {
13333: return;
13334: }
13335: my $restitle=&Apache::lonnet::gettitle($symb);
13336: $restitle =~ s/\W+/_/g;
13337: if ($restitle eq '') {
13338: $restitle = ($resurl =~ m{/[^/]+$});
13339: if ($restitle eq '') {
13340: $restitle = time;
13341: }
13342: }
1.1075.2.48 raeburn 13343: if (length($restitle) > 12) {
13344: $restitle = substr($restitle,0,12);
13345: }
1.1015 raeburn 13346: push(@pathitems,$restitle);
13347: $path .= join('/',@pathitems);
13348: }
13349: return ($path,$multiresp);
13350: }
13351:
13352: =pod
13353:
1.464 albertel 13354: =back
1.41 ng 13355:
1.112 bowersj2 13356: =head1 CSV Upload/Handling functions
1.38 albertel 13357:
1.41 ng 13358: =over 4
13359:
1.648 raeburn 13360: =item * &upfile_store($r)
1.41 ng 13361:
13362: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 13363: needs $env{'form.upfile'}
1.41 ng 13364: returns $datatoken to be put into hidden field
13365:
13366: =cut
1.31 albertel 13367:
13368: sub upfile_store {
13369: my $r=shift;
1.258 albertel 13370: $env{'form.upfile'}=~s/\r/\n/gs;
13371: $env{'form.upfile'}=~s/\f/\n/gs;
13372: $env{'form.upfile'}=~s/\n+/\n/gs;
13373: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 13374:
1.1075.2.128 raeburn 13375: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
13376: '_enroll_'.$env{'request.course.id'}.'_'.
13377: time.'_'.$$);
13378: return if ($datatoken eq '');
13379:
1.31 albertel 13380: {
1.158 raeburn 13381: my $datafile = $r->dir_config('lonDaemons').
13382: '/tmp/'.$datatoken.'.tmp';
1.1075.2.128 raeburn 13383: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 13384: print $fh $env{'form.upfile'};
1.158 raeburn 13385: close($fh);
13386: }
1.31 albertel 13387: }
13388: return $datatoken;
13389: }
13390:
1.56 matthew 13391: =pod
13392:
1.1075.2.128 raeburn 13393: =item * &load_tmp_file($r,$datatoken)
1.41 ng 13394:
13395: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128 raeburn 13396: $datatoken is the name to assign to the temporary file.
1.258 albertel 13397: sets $env{'form.upfile'} to the contents of the file
1.41 ng 13398:
13399: =cut
1.31 albertel 13400:
13401: sub load_tmp_file {
1.1075.2.128 raeburn 13402: my ($r,$datatoken) = @_;
13403: return if ($datatoken eq '');
1.31 albertel 13404: my @studentdata=();
13405: {
1.158 raeburn 13406: my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128 raeburn 13407: '/tmp/'.$datatoken.'.tmp';
13408: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 13409: @studentdata=<$fh>;
13410: close($fh);
13411: }
1.31 albertel 13412: }
1.258 albertel 13413: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 13414: }
13415:
1.1075.2.128 raeburn 13416: sub valid_datatoken {
13417: my ($datatoken) = @_;
1.1075.2.131 raeburn 13418: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128 raeburn 13419: return $datatoken;
13420: }
13421: return;
13422: }
13423:
1.56 matthew 13424: =pod
13425:
1.648 raeburn 13426: =item * &upfile_record_sep()
1.41 ng 13427:
13428: Separate uploaded file into records
13429: returns array of records,
1.258 albertel 13430: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 13431:
13432: =cut
1.31 albertel 13433:
13434: sub upfile_record_sep {
1.258 albertel 13435: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 13436: } else {
1.248 albertel 13437: my @records;
1.258 albertel 13438: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 13439: if ($line=~/^\s*$/) { next; }
13440: push(@records,$line);
13441: }
13442: return @records;
1.31 albertel 13443: }
13444: }
13445:
1.56 matthew 13446: =pod
13447:
1.648 raeburn 13448: =item * &record_sep($record)
1.41 ng 13449:
1.258 albertel 13450: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 13451:
13452: =cut
13453:
1.263 www 13454: sub takeleft {
13455: my $index=shift;
13456: return substr('0000'.$index,-4,4);
13457: }
13458:
1.31 albertel 13459: sub record_sep {
13460: my $record=shift;
13461: my %components=();
1.258 albertel 13462: if ($env{'form.upfiletype'} eq 'xml') {
13463: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 13464: my $i=0;
1.356 albertel 13465: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 13466: $field=~s/^(\"|\')//;
13467: $field=~s/(\"|\')$//;
1.263 www 13468: $components{&takeleft($i)}=$field;
1.31 albertel 13469: $i++;
13470: }
1.258 albertel 13471: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 13472: my $i=0;
1.356 albertel 13473: foreach my $field (split(/\t/,$record)) {
1.31 albertel 13474: $field=~s/^(\"|\')//;
13475: $field=~s/(\"|\')$//;
1.263 www 13476: $components{&takeleft($i)}=$field;
1.31 albertel 13477: $i++;
13478: }
13479: } else {
1.561 www 13480: my $separator=',';
1.480 banghart 13481: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 13482: $separator=';';
1.480 banghart 13483: }
1.31 albertel 13484: my $i=0;
1.561 www 13485: # the character we are looking for to indicate the end of a quote or a record
13486: my $looking_for=$separator;
13487: # do not add the characters to the fields
13488: my $ignore=0;
13489: # we just encountered a separator (or the beginning of the record)
13490: my $just_found_separator=1;
13491: # store the field we are working on here
13492: my $field='';
13493: # work our way through all characters in record
13494: foreach my $character ($record=~/(.)/g) {
13495: if ($character eq $looking_for) {
13496: if ($character ne $separator) {
13497: # Found the end of a quote, again looking for separator
13498: $looking_for=$separator;
13499: $ignore=1;
13500: } else {
13501: # Found a separator, store away what we got
13502: $components{&takeleft($i)}=$field;
13503: $i++;
13504: $just_found_separator=1;
13505: $ignore=0;
13506: $field='';
13507: }
13508: next;
13509: }
13510: # single or double quotation marks after a separator indicate beginning of a quote
13511: # we are now looking for the end of the quote and need to ignore separators
13512: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
13513: $looking_for=$character;
13514: next;
13515: }
13516: # ignore would be true after we reached the end of a quote
13517: if ($ignore) { next; }
13518: if (($just_found_separator) && ($character=~/\s/)) { next; }
13519: $field.=$character;
13520: $just_found_separator=0;
1.31 albertel 13521: }
1.561 www 13522: # catch the very last entry, since we never encountered the separator
13523: $components{&takeleft($i)}=$field;
1.31 albertel 13524: }
13525: return %components;
13526: }
13527:
1.144 matthew 13528: ######################################################
13529: ######################################################
13530:
1.56 matthew 13531: =pod
13532:
1.648 raeburn 13533: =item * &upfile_select_html()
1.41 ng 13534:
1.144 matthew 13535: Return HTML code to select a file from the users machine and specify
13536: the file type.
1.41 ng 13537:
13538: =cut
13539:
1.144 matthew 13540: ######################################################
13541: ######################################################
1.31 albertel 13542: sub upfile_select_html {
1.144 matthew 13543: my %Types = (
13544: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 13545: semisv => &mt('Semicolon separated values'),
1.144 matthew 13546: space => &mt('Space separated'),
13547: tab => &mt('Tabulator separated'),
13548: # xml => &mt('HTML/XML'),
13549: );
13550: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 13551: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 13552: foreach my $type (sort(keys(%Types))) {
13553: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
13554: }
13555: $Str .= "</select>\n";
13556: return $Str;
1.31 albertel 13557: }
13558:
1.301 albertel 13559: sub get_samples {
13560: my ($records,$toget) = @_;
13561: my @samples=({});
13562: my $got=0;
13563: foreach my $rec (@$records) {
13564: my %temp = &record_sep($rec);
13565: if (! grep(/\S/, values(%temp))) { next; }
13566: if (%temp) {
13567: $samples[$got]=\%temp;
13568: $got++;
13569: if ($got == $toget) { last; }
13570: }
13571: }
13572: return \@samples;
13573: }
13574:
1.144 matthew 13575: ######################################################
13576: ######################################################
13577:
1.56 matthew 13578: =pod
13579:
1.648 raeburn 13580: =item * &csv_print_samples($r,$records)
1.41 ng 13581:
13582: Prints a table of sample values from each column uploaded $r is an
13583: Apache Request ref, $records is an arrayref from
13584: &Apache::loncommon::upfile_record_sep
13585:
13586: =cut
13587:
1.144 matthew 13588: ######################################################
13589: ######################################################
1.31 albertel 13590: sub csv_print_samples {
13591: my ($r,$records) = @_;
1.662 bisitz 13592: my $samples = &get_samples($records,5);
1.301 albertel 13593:
1.594 raeburn 13594: $r->print(&mt('Samples').'<br />'.&start_data_table().
13595: &start_data_table_header_row());
1.356 albertel 13596: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 13597: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 13598: $r->print(&end_data_table_header_row());
1.301 albertel 13599: foreach my $hash (@$samples) {
1.594 raeburn 13600: $r->print(&start_data_table_row());
1.356 albertel 13601: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 13602: $r->print('<td>');
1.356 albertel 13603: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 13604: $r->print('</td>');
13605: }
1.594 raeburn 13606: $r->print(&end_data_table_row());
1.31 albertel 13607: }
1.594 raeburn 13608: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 13609: }
13610:
1.144 matthew 13611: ######################################################
13612: ######################################################
13613:
1.56 matthew 13614: =pod
13615:
1.648 raeburn 13616: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 13617:
13618: Prints a table to create associations between values and table columns.
1.144 matthew 13619:
1.41 ng 13620: $r is an Apache Request ref,
13621: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 13622: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 13623:
13624: =cut
13625:
1.144 matthew 13626: ######################################################
13627: ######################################################
1.31 albertel 13628: sub csv_print_select_table {
13629: my ($r,$records,$d) = @_;
1.301 albertel 13630: my $i=0;
13631: my $samples = &get_samples($records,1);
1.144 matthew 13632: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 13633: &start_data_table().&start_data_table_header_row().
1.144 matthew 13634: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 13635: '<th>'.&mt('Column').'</th>'.
13636: &end_data_table_header_row()."\n");
1.356 albertel 13637: foreach my $array_ref (@$d) {
13638: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 13639: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 13640:
1.875 bisitz 13641: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 13642: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 13643: $r->print('<option value="none"></option>');
1.356 albertel 13644: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
13645: $r->print('<option value="'.$sample.'"'.
13646: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 13647: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 13648: }
1.594 raeburn 13649: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 13650: $i++;
13651: }
1.594 raeburn 13652: $r->print(&end_data_table());
1.31 albertel 13653: $i--;
13654: return $i;
13655: }
1.56 matthew 13656:
1.144 matthew 13657: ######################################################
13658: ######################################################
13659:
1.56 matthew 13660: =pod
1.31 albertel 13661:
1.648 raeburn 13662: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 13663:
13664: Prints a table of sample values from the upload and can make associate samples to internal names.
13665:
13666: $r is an Apache Request ref,
13667: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
13668: $d is an array of 2 element arrays (internal name, displayed name)
13669:
13670: =cut
13671:
1.144 matthew 13672: ######################################################
13673: ######################################################
1.31 albertel 13674: sub csv_samples_select_table {
13675: my ($r,$records,$d) = @_;
13676: my $i=0;
1.144 matthew 13677: #
1.662 bisitz 13678: my $max_samples = 5;
13679: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 13680: $r->print(&start_data_table().
13681: &start_data_table_header_row().'<th>'.
13682: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
13683: &end_data_table_header_row());
1.301 albertel 13684:
13685: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 13686: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 13687: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 13688: foreach my $option (@$d) {
13689: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 13690: $r->print('<option value="'.$value.'"'.
1.253 albertel 13691: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 13692: $display.'</option>');
1.31 albertel 13693: }
13694: $r->print('</select></td><td>');
1.662 bisitz 13695: foreach my $line (0..($max_samples-1)) {
1.301 albertel 13696: if (defined($samples->[$line]{$key})) {
13697: $r->print($samples->[$line]{$key}."<br />\n");
13698: }
13699: }
1.594 raeburn 13700: $r->print('</td>'.&end_data_table_row());
1.31 albertel 13701: $i++;
13702: }
1.594 raeburn 13703: $r->print(&end_data_table());
1.31 albertel 13704: $i--;
13705: return($i);
1.115 matthew 13706: }
13707:
1.144 matthew 13708: ######################################################
13709: ######################################################
13710:
1.115 matthew 13711: =pod
13712:
1.648 raeburn 13713: =item * &clean_excel_name($name)
1.115 matthew 13714:
13715: Returns a replacement for $name which does not contain any illegal characters.
13716:
13717: =cut
13718:
1.144 matthew 13719: ######################################################
13720: ######################################################
1.115 matthew 13721: sub clean_excel_name {
13722: my ($name) = @_;
13723: $name =~ s/[:\*\?\/\\]//g;
13724: if (length($name) > 31) {
13725: $name = substr($name,0,31);
13726: }
13727: return $name;
1.25 albertel 13728: }
1.84 albertel 13729:
1.85 albertel 13730: =pod
13731:
1.648 raeburn 13732: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 13733:
13734: Returns either 1 or undef
13735:
13736: 1 if the part is to be hidden, undef if it is to be shown
13737:
13738: Arguments are:
13739:
13740: $id the id of the part to be checked
13741: $symb, optional the symb of the resource to check
13742: $udom, optional the domain of the user to check for
13743: $uname, optional the username of the user to check for
13744:
13745: =cut
1.84 albertel 13746:
13747: sub check_if_partid_hidden {
13748: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 13749: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 13750: $symb,$udom,$uname);
1.141 albertel 13751: my $truth=1;
13752: #if the string starts with !, then the list is the list to show not hide
13753: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 13754: my @hiddenlist=split(/,/,$hiddenparts);
13755: foreach my $checkid (@hiddenlist) {
1.141 albertel 13756: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 13757: }
1.141 albertel 13758: return !$truth;
1.84 albertel 13759: }
1.127 matthew 13760:
1.138 matthew 13761:
13762: ############################################################
13763: ############################################################
13764:
13765: =pod
13766:
1.157 matthew 13767: =back
13768:
1.138 matthew 13769: =head1 cgi-bin script and graphing routines
13770:
1.157 matthew 13771: =over 4
13772:
1.648 raeburn 13773: =item * &get_cgi_id()
1.138 matthew 13774:
13775: Inputs: none
13776:
13777: Returns an id which can be used to pass environment variables
13778: to various cgi-bin scripts. These environment variables will
13779: be removed from the users environment after a given time by
13780: the routine &Apache::lonnet::transfer_profile_to_env.
13781:
13782: =cut
13783:
13784: ############################################################
13785: ############################################################
1.152 albertel 13786: my $uniq=0;
1.136 matthew 13787: sub get_cgi_id {
1.154 albertel 13788: $uniq=($uniq+1)%100000;
1.280 albertel 13789: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 13790: }
13791:
1.127 matthew 13792: ############################################################
13793: ############################################################
13794:
13795: =pod
13796:
1.648 raeburn 13797: =item * &DrawBarGraph()
1.127 matthew 13798:
1.138 matthew 13799: Facilitates the plotting of data in a (stacked) bar graph.
13800: Puts plot definition data into the users environment in order for
13801: graph.png to plot it. Returns an <img> tag for the plot.
13802: The bars on the plot are labeled '1','2',...,'n'.
13803:
13804: Inputs:
13805:
13806: =over 4
13807:
13808: =item $Title: string, the title of the plot
13809:
13810: =item $xlabel: string, text describing the X-axis of the plot
13811:
13812: =item $ylabel: string, text describing the Y-axis of the plot
13813:
13814: =item $Max: scalar, the maximum Y value to use in the plot
13815: If $Max is < any data point, the graph will not be rendered.
13816:
1.140 matthew 13817: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 13818: they are plotted. If undefined, default values will be used.
13819:
1.178 matthew 13820: =item $labels: array ref holding the labels to use on the x-axis for the bars.
13821:
1.138 matthew 13822: =item @Values: An array of array references. Each array reference holds data
13823: to be plotted in a stacked bar chart.
13824:
1.239 matthew 13825: =item If the final element of @Values is a hash reference the key/value
13826: pairs will be added to the graph definition.
13827:
1.138 matthew 13828: =back
13829:
13830: Returns:
13831:
13832: An <img> tag which references graph.png and the appropriate identifying
13833: information for the plot.
13834:
1.127 matthew 13835: =cut
13836:
13837: ############################################################
13838: ############################################################
1.134 matthew 13839: sub DrawBarGraph {
1.178 matthew 13840: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 13841: #
13842: if (! defined($colors)) {
13843: $colors = ['#33ff00',
13844: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
13845: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
13846: ];
13847: }
1.228 matthew 13848: my $extra_settings = {};
13849: if (ref($Values[-1]) eq 'HASH') {
13850: $extra_settings = pop(@Values);
13851: }
1.127 matthew 13852: #
1.136 matthew 13853: my $identifier = &get_cgi_id();
13854: my $id = 'cgi.'.$identifier;
1.129 matthew 13855: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 13856: return '';
13857: }
1.225 matthew 13858: #
13859: my @Labels;
13860: if (defined($labels)) {
13861: @Labels = @$labels;
13862: } else {
13863: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119 raeburn 13864: push(@Labels,$i+1);
1.225 matthew 13865: }
13866: }
13867: #
1.129 matthew 13868: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 13869: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 13870: my %ValuesHash;
13871: my $NumSets=1;
13872: foreach my $array (@Values) {
13873: next if (! ref($array));
1.136 matthew 13874: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 13875: join(',',@$array);
1.129 matthew 13876: }
1.127 matthew 13877: #
1.136 matthew 13878: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 13879: if ($NumBars < 3) {
13880: $width = 120+$NumBars*32;
1.220 matthew 13881: $xskip = 1;
1.225 matthew 13882: $bar_width = 30;
13883: } elsif ($NumBars < 5) {
13884: $width = 120+$NumBars*20;
13885: $xskip = 1;
13886: $bar_width = 20;
1.220 matthew 13887: } elsif ($NumBars < 10) {
1.136 matthew 13888: $width = 120+$NumBars*15;
13889: $xskip = 1;
13890: $bar_width = 15;
13891: } elsif ($NumBars <= 25) {
13892: $width = 120+$NumBars*11;
13893: $xskip = 5;
13894: $bar_width = 8;
13895: } elsif ($NumBars <= 50) {
13896: $width = 120+$NumBars*8;
13897: $xskip = 5;
13898: $bar_width = 4;
13899: } else {
13900: $width = 120+$NumBars*8;
13901: $xskip = 5;
13902: $bar_width = 4;
13903: }
13904: #
1.137 matthew 13905: $Max = 1 if ($Max < 1);
13906: if ( int($Max) < $Max ) {
13907: $Max++;
13908: $Max = int($Max);
13909: }
1.127 matthew 13910: $Title = '' if (! defined($Title));
13911: $xlabel = '' if (! defined($xlabel));
13912: $ylabel = '' if (! defined($ylabel));
1.369 www 13913: $ValuesHash{$id.'.title'} = &escape($Title);
13914: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
13915: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 13916: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 13917: $ValuesHash{$id.'.NumBars'} = $NumBars;
13918: $ValuesHash{$id.'.NumSets'} = $NumSets;
13919: $ValuesHash{$id.'.PlotType'} = 'bar';
13920: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
13921: $ValuesHash{$id.'.height'} = $height;
13922: $ValuesHash{$id.'.width'} = $width;
13923: $ValuesHash{$id.'.xskip'} = $xskip;
13924: $ValuesHash{$id.'.bar_width'} = $bar_width;
13925: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 13926: #
1.228 matthew 13927: # Deal with other parameters
13928: while (my ($key,$value) = each(%$extra_settings)) {
13929: $ValuesHash{$id.'.'.$key} = $value;
13930: }
13931: #
1.646 raeburn 13932: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 13933: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
13934: }
13935:
13936: ############################################################
13937: ############################################################
13938:
13939: =pod
13940:
1.648 raeburn 13941: =item * &DrawXYGraph()
1.137 matthew 13942:
1.138 matthew 13943: Facilitates the plotting of data in an XY graph.
13944: Puts plot definition data into the users environment in order for
13945: graph.png to plot it. Returns an <img> tag for the plot.
13946:
13947: Inputs:
13948:
13949: =over 4
13950:
13951: =item $Title: string, the title of the plot
13952:
13953: =item $xlabel: string, text describing the X-axis of the plot
13954:
13955: =item $ylabel: string, text describing the Y-axis of the plot
13956:
13957: =item $Max: scalar, the maximum Y value to use in the plot
13958: If $Max is < any data point, the graph will not be rendered.
13959:
13960: =item $colors: Array ref containing the hex color codes for the data to be
13961: plotted in. If undefined, default values will be used.
13962:
13963: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
13964:
13965: =item $Ydata: Array ref containing Array refs.
1.185 www 13966: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 13967:
13968: =item %Values: hash indicating or overriding any default values which are
13969: passed to graph.png.
13970: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
13971:
13972: =back
13973:
13974: Returns:
13975:
13976: An <img> tag which references graph.png and the appropriate identifying
13977: information for the plot.
13978:
1.137 matthew 13979: =cut
13980:
13981: ############################################################
13982: ############################################################
13983: sub DrawXYGraph {
13984: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
13985: #
13986: # Create the identifier for the graph
13987: my $identifier = &get_cgi_id();
13988: my $id = 'cgi.'.$identifier;
13989: #
13990: $Title = '' if (! defined($Title));
13991: $xlabel = '' if (! defined($xlabel));
13992: $ylabel = '' if (! defined($ylabel));
13993: my %ValuesHash =
13994: (
1.369 www 13995: $id.'.title' => &escape($Title),
13996: $id.'.xlabel' => &escape($xlabel),
13997: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 13998: $id.'.y_max_value'=> $Max,
13999: $id.'.labels' => join(',',@$Xlabels),
14000: $id.'.PlotType' => 'XY',
14001: );
14002: #
14003: if (defined($colors) && ref($colors) eq 'ARRAY') {
14004: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14005: }
14006: #
14007: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
14008: return '';
14009: }
14010: my $NumSets=1;
1.138 matthew 14011: foreach my $array (@{$Ydata}){
1.137 matthew 14012: next if (! ref($array));
14013: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
14014: }
1.138 matthew 14015: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 14016: #
14017: # Deal with other parameters
14018: while (my ($key,$value) = each(%Values)) {
14019: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 14020: }
14021: #
1.646 raeburn 14022: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 14023: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14024: }
14025:
14026: ############################################################
14027: ############################################################
14028:
14029: =pod
14030:
1.648 raeburn 14031: =item * &DrawXYYGraph()
1.138 matthew 14032:
14033: Facilitates the plotting of data in an XY graph with two Y axes.
14034: Puts plot definition data into the users environment in order for
14035: graph.png to plot it. Returns an <img> tag for the plot.
14036:
14037: Inputs:
14038:
14039: =over 4
14040:
14041: =item $Title: string, the title of the plot
14042:
14043: =item $xlabel: string, text describing the X-axis of the plot
14044:
14045: =item $ylabel: string, text describing the Y-axis of the plot
14046:
14047: =item $colors: Array ref containing the hex color codes for the data to be
14048: plotted in. If undefined, default values will be used.
14049:
14050: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14051:
14052: =item $Ydata1: The first data set
14053:
14054: =item $Min1: The minimum value of the left Y-axis
14055:
14056: =item $Max1: The maximum value of the left Y-axis
14057:
14058: =item $Ydata2: The second data set
14059:
14060: =item $Min2: The minimum value of the right Y-axis
14061:
14062: =item $Max2: The maximum value of the left Y-axis
14063:
14064: =item %Values: hash indicating or overriding any default values which are
14065: passed to graph.png.
14066: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14067:
14068: =back
14069:
14070: Returns:
14071:
14072: An <img> tag which references graph.png and the appropriate identifying
14073: information for the plot.
1.136 matthew 14074:
14075: =cut
14076:
14077: ############################################################
14078: ############################################################
1.137 matthew 14079: sub DrawXYYGraph {
14080: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
14081: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 14082: #
14083: # Create the identifier for the graph
14084: my $identifier = &get_cgi_id();
14085: my $id = 'cgi.'.$identifier;
14086: #
14087: $Title = '' if (! defined($Title));
14088: $xlabel = '' if (! defined($xlabel));
14089: $ylabel = '' if (! defined($ylabel));
14090: my %ValuesHash =
14091: (
1.369 www 14092: $id.'.title' => &escape($Title),
14093: $id.'.xlabel' => &escape($xlabel),
14094: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 14095: $id.'.labels' => join(',',@$Xlabels),
14096: $id.'.PlotType' => 'XY',
14097: $id.'.NumSets' => 2,
1.137 matthew 14098: $id.'.two_axes' => 1,
14099: $id.'.y1_max_value' => $Max1,
14100: $id.'.y1_min_value' => $Min1,
14101: $id.'.y2_max_value' => $Max2,
14102: $id.'.y2_min_value' => $Min2,
1.136 matthew 14103: );
14104: #
1.137 matthew 14105: if (defined($colors) && ref($colors) eq 'ARRAY') {
14106: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14107: }
14108: #
14109: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
14110: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 14111: return '';
14112: }
14113: my $NumSets=1;
1.137 matthew 14114: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 14115: next if (! ref($array));
14116: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 14117: }
14118: #
14119: # Deal with other parameters
14120: while (my ($key,$value) = each(%Values)) {
14121: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 14122: }
14123: #
1.646 raeburn 14124: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 14125: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 14126: }
14127:
14128: ############################################################
14129: ############################################################
14130:
14131: =pod
14132:
1.157 matthew 14133: =back
14134:
1.139 matthew 14135: =head1 Statistics helper routines?
14136:
14137: Bad place for them but what the hell.
14138:
1.157 matthew 14139: =over 4
14140:
1.648 raeburn 14141: =item * &chartlink()
1.139 matthew 14142:
14143: Returns a link to the chart for a specific student.
14144:
14145: Inputs:
14146:
14147: =over 4
14148:
14149: =item $linktext: The text of the link
14150:
14151: =item $sname: The students username
14152:
14153: =item $sdomain: The students domain
14154:
14155: =back
14156:
1.157 matthew 14157: =back
14158:
1.139 matthew 14159: =cut
14160:
14161: ############################################################
14162: ############################################################
14163: sub chartlink {
14164: my ($linktext, $sname, $sdomain) = @_;
14165: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 14166: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 14167: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 14168: '">'.$linktext.'</a>';
1.153 matthew 14169: }
14170:
14171: #######################################################
14172: #######################################################
14173:
14174: =pod
14175:
14176: =head1 Course Environment Routines
1.157 matthew 14177:
14178: =over 4
1.153 matthew 14179:
1.648 raeburn 14180: =item * &restore_course_settings()
1.153 matthew 14181:
1.648 raeburn 14182: =item * &store_course_settings()
1.153 matthew 14183:
14184: Restores/Store indicated form parameters from the course environment.
14185: Will not overwrite existing values of the form parameters.
14186:
14187: Inputs:
14188: a scalar describing the data (e.g. 'chart', 'problem_analysis')
14189:
14190: a hash ref describing the data to be stored. For example:
14191:
14192: %Save_Parameters = ('Status' => 'scalar',
14193: 'chartoutputmode' => 'scalar',
14194: 'chartoutputdata' => 'scalar',
14195: 'Section' => 'array',
1.373 raeburn 14196: 'Group' => 'array',
1.153 matthew 14197: 'StudentData' => 'array',
14198: 'Maps' => 'array');
14199:
14200: Returns: both routines return nothing
14201:
1.631 raeburn 14202: =back
14203:
1.153 matthew 14204: =cut
14205:
14206: #######################################################
14207: #######################################################
14208: sub store_course_settings {
1.496 albertel 14209: return &store_settings($env{'request.course.id'},@_);
14210: }
14211:
14212: sub store_settings {
1.153 matthew 14213: # save to the environment
14214: # appenv the same items, just to be safe
1.300 albertel 14215: my $udom = $env{'user.domain'};
14216: my $uname = $env{'user.name'};
1.496 albertel 14217: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14218: my %SaveHash;
14219: my %AppHash;
14220: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 14221: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 14222: my $envname = 'environment.'.$basename;
1.258 albertel 14223: if (exists($env{'form.'.$setting})) {
1.153 matthew 14224: # Save this value away
14225: if ($type eq 'scalar' &&
1.258 albertel 14226: (! exists($env{$envname}) ||
14227: $env{$envname} ne $env{'form.'.$setting})) {
14228: $SaveHash{$basename} = $env{'form.'.$setting};
14229: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 14230: } elsif ($type eq 'array') {
14231: my $stored_form;
1.258 albertel 14232: if (ref($env{'form.'.$setting})) {
1.153 matthew 14233: $stored_form = join(',',
14234: map {
1.369 www 14235: &escape($_);
1.258 albertel 14236: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 14237: } else {
14238: $stored_form =
1.369 www 14239: &escape($env{'form.'.$setting});
1.153 matthew 14240: }
14241: # Determine if the array contents are the same.
1.258 albertel 14242: if ($stored_form ne $env{$envname}) {
1.153 matthew 14243: $SaveHash{$basename} = $stored_form;
14244: $AppHash{$envname} = $stored_form;
14245: }
14246: }
14247: }
14248: }
14249: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 14250: $udom,$uname);
1.153 matthew 14251: if ($put_result !~ /^(ok|delayed)/) {
14252: &Apache::lonnet::logthis('unable to save form parameters, '.
14253: 'got error:'.$put_result);
14254: }
14255: # Make sure these settings stick around in this session, too
1.646 raeburn 14256: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 14257: return;
14258: }
14259:
14260: sub restore_course_settings {
1.499 albertel 14261: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 14262: }
14263:
14264: sub restore_settings {
14265: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14266: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 14267: next if (exists($env{'form.'.$setting}));
1.496 albertel 14268: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 14269: '.'.$setting;
1.258 albertel 14270: if (exists($env{$envname})) {
1.153 matthew 14271: if ($type eq 'scalar') {
1.258 albertel 14272: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 14273: } elsif ($type eq 'array') {
1.258 albertel 14274: $env{'form.'.$setting} = [
1.153 matthew 14275: map {
1.369 www 14276: &unescape($_);
1.258 albertel 14277: } split(',',$env{$envname})
1.153 matthew 14278: ];
14279: }
14280: }
14281: }
1.127 matthew 14282: }
14283:
1.618 raeburn 14284: #######################################################
14285: #######################################################
14286:
14287: =pod
14288:
14289: =head1 Domain E-mail Routines
14290:
14291: =over 4
14292:
1.648 raeburn 14293: =item * &build_recipient_list()
1.618 raeburn 14294:
1.1075.2.44 raeburn 14295: Build recipient lists for following types of e-mail:
1.766 raeburn 14296: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44 raeburn 14297: (d) Help requests, (e) Course requests needing approval, (f) loncapa
14298: module change checking, student/employee ID conflict checks, as
14299: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
14300: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 14301:
14302: Inputs:
1.1075.2.44 raeburn 14303: defmail (scalar - email address of default recipient),
14304: mailing type (scalar: errormail, packagesmail, helpdeskmail,
14305: requestsmail, updatesmail, or idconflictsmail).
14306:
1.619 raeburn 14307: defdom (domain for which to retrieve configuration settings),
1.1075.2.44 raeburn 14308:
14309: origmail (scalar - email address of recipient from loncapa.conf,
14310: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 14311:
1.1075.2.139 raeburn 14312: $requname username of requester (if mailing type is helpdeskmail)
14313:
14314: $requdom domain of requester (if mailing type is helpdeskmail)
14315:
14316: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
14317:
1.655 raeburn 14318: Returns: comma separated list of addresses to which to send e-mail.
14319:
14320: =back
1.618 raeburn 14321:
14322: =cut
14323:
14324: ############################################################
14325: ############################################################
14326: sub build_recipient_list {
1.1075.2.139 raeburn 14327: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 14328: my @recipients;
1.1075.2.122 raeburn 14329: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 14330: my %domconfig =
1.1075.2.122 raeburn 14331: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 14332: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 14333: if (exists($domconfig{'contacts'}{$mailing})) {
14334: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
14335: my @contacts = ('adminemail','supportemail');
14336: foreach my $item (@contacts) {
14337: if ($domconfig{'contacts'}{$mailing}{$item}) {
14338: my $addr = $domconfig{'contacts'}{$item};
14339: if (!grep(/^\Q$addr\E$/,@recipients)) {
14340: push(@recipients,$addr);
14341: }
1.619 raeburn 14342: }
1.1075.2.122 raeburn 14343: }
14344: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
14345: if ($mailing eq 'helpdeskmail') {
14346: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
14347: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
14348: my @ok_bccs;
14349: foreach my $bcc (@bccs) {
14350: $bcc =~ s/^\s+//g;
14351: $bcc =~ s/\s+$//g;
14352: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14353: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14354: push(@ok_bccs,$bcc);
14355: }
14356: }
14357: }
14358: if (@ok_bccs > 0) {
14359: $allbcc = join(', ',@ok_bccs);
14360: }
14361: }
14362: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 14363: }
14364: }
1.766 raeburn 14365: } elsif ($origmail ne '') {
1.1075.2.122 raeburn 14366: $lastresort = $origmail;
1.618 raeburn 14367: }
1.1075.2.139 raeburn 14368: if ($mailing eq 'helpdeskmail') {
14369: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
14370: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
14371: my ($inststatus,$inststatus_checked);
14372: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
14373: ($env{'user.domain'} ne 'public')) {
14374: $inststatus_checked = 1;
14375: $inststatus = $env{'environment.inststatus'};
14376: }
14377: unless ($inststatus_checked) {
14378: if (($requname ne '') && ($requdom ne '')) {
14379: if (($requname =~ /^$match_username$/) &&
14380: ($requdom =~ /^$match_domain$/) &&
14381: (&Apache::lonnet::domain($requdom))) {
14382: my $requhome = &Apache::lonnet::homeserver($requname,
14383: $requdom);
14384: unless ($requhome eq 'no_host') {
14385: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
14386: $inststatus = $userenv{'inststatus'};
14387: $inststatus_checked = 1;
14388: }
14389: }
14390: }
14391: }
14392: unless ($inststatus_checked) {
14393: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
14394: my %srch = (srchby => 'email',
14395: srchdomain => $defdom,
14396: srchterm => $reqemail,
14397: srchtype => 'exact');
14398: my %srch_results = &Apache::lonnet::usersearch(\%srch);
14399: foreach my $uname (keys(%srch_results)) {
14400: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
14401: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
14402: $inststatus_checked = 1;
14403: last;
14404: }
14405: }
14406: unless ($inststatus_checked) {
14407: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
14408: if ($dirsrchres eq 'ok') {
14409: foreach my $uname (keys(%srch_results)) {
14410: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
14411: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
14412: $inststatus_checked = 1;
14413: last;
14414: }
14415: }
14416: }
14417: }
14418: }
14419: }
14420: if ($inststatus ne '') {
14421: foreach my $status (split(/\:/,$inststatus)) {
14422: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
14423: my @contacts = ('adminemail','supportemail');
14424: foreach my $item (@contacts) {
14425: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
14426: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
14427: if (!grep(/^\Q$addr\E$/,@recipients)) {
14428: push(@recipients,$addr);
14429: }
14430: }
14431: }
14432: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
14433: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
14434: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
14435: my @ok_bccs;
14436: foreach my $bcc (@bccs) {
14437: $bcc =~ s/^\s+//g;
14438: $bcc =~ s/\s+$//g;
14439: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14440: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14441: push(@ok_bccs,$bcc);
14442: }
14443: }
14444: }
14445: if (@ok_bccs > 0) {
14446: $allbcc = join(', ',@ok_bccs);
14447: }
14448: }
14449: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
14450: last;
14451: }
14452: }
14453: }
14454: }
14455: }
1.619 raeburn 14456: } elsif ($origmail ne '') {
1.1075.2.122 raeburn 14457: $lastresort = $origmail;
14458: }
1.1075.2.128 raeburn 14459: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122 raeburn 14460: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
14461: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
14462: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
14463: my %what = (
14464: perlvar => 1,
14465: );
14466: my $primary = &Apache::lonnet::domain($defdom,'primary');
14467: if ($primary) {
14468: my $gotaddr;
14469: my ($result,$returnhash) =
14470: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
14471: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
14472: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
14473: $lastresort = $returnhash->{'lonSupportEMail'};
14474: $gotaddr = 1;
14475: }
14476: }
14477: unless ($gotaddr) {
14478: my $uintdom = &Apache::lonnet::internet_dom($primary);
14479: my $intdom = &Apache::lonnet::internet_dom($lonhost);
14480: unless ($uintdom eq $intdom) {
14481: my %domconfig =
14482: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
14483: if (ref($domconfig{'contacts'}) eq 'HASH') {
14484: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
14485: my @contacts = ('adminemail','supportemail');
14486: foreach my $item (@contacts) {
14487: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
14488: my $addr = $domconfig{'contacts'}{$item};
14489: if (!grep(/^\Q$addr\E$/,@recipients)) {
14490: push(@recipients,$addr);
14491: }
14492: }
14493: }
14494: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
14495: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
14496: }
14497: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
14498: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
14499: my @ok_bccs;
14500: foreach my $bcc (@bccs) {
14501: $bcc =~ s/^\s+//g;
14502: $bcc =~ s/\s+$//g;
14503: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14504: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14505: push(@ok_bccs,$bcc);
14506: }
14507: }
14508: }
14509: if (@ok_bccs > 0) {
14510: $allbcc = join(', ',@ok_bccs);
14511: }
14512: }
14513: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
14514: }
14515: }
14516: }
14517: }
14518: }
14519: }
1.618 raeburn 14520: }
1.688 raeburn 14521: if (defined($defmail)) {
14522: if ($defmail ne '') {
14523: push(@recipients,$defmail);
14524: }
1.618 raeburn 14525: }
14526: if ($otheremails) {
1.619 raeburn 14527: my @others;
14528: if ($otheremails =~ /,/) {
14529: @others = split(/,/,$otheremails);
1.618 raeburn 14530: } else {
1.619 raeburn 14531: push(@others,$otheremails);
14532: }
14533: foreach my $addr (@others) {
14534: if (!grep(/^\Q$addr\E$/,@recipients)) {
14535: push(@recipients,$addr);
14536: }
1.618 raeburn 14537: }
14538: }
1.1075.2.128 raeburn 14539: if ($mailing eq 'helpdeskmail') {
1.1075.2.122 raeburn 14540: if ((!@recipients) && ($lastresort ne '')) {
14541: push(@recipients,$lastresort);
14542: }
14543: } elsif ($lastresort ne '') {
14544: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
14545: push(@recipients,$lastresort);
14546: }
14547: }
14548: my $recipientlist = join(',',@recipients);
14549: if (wantarray) {
14550: return ($recipientlist,$allbcc,$addtext);
14551: } else {
14552: return $recipientlist;
14553: }
1.618 raeburn 14554: }
14555:
1.127 matthew 14556: ############################################################
14557: ############################################################
1.154 albertel 14558:
1.655 raeburn 14559: =pod
14560:
14561: =head1 Course Catalog Routines
14562:
14563: =over 4
14564:
14565: =item * &gather_categories()
14566:
14567: Converts category definitions - keys of categories hash stored in
14568: coursecategories in configuration.db on the primary library server in a
14569: domain - to an array. Also generates javascript and idx hash used to
14570: generate Domain Coordinator interface for editing Course Categories.
14571:
14572: Inputs:
1.663 raeburn 14573:
1.655 raeburn 14574: categories (reference to hash of category definitions).
1.663 raeburn 14575:
1.655 raeburn 14576: cats (reference to array of arrays/hashes which encapsulates hierarchy of
14577: categories and subcategories).
1.663 raeburn 14578:
1.655 raeburn 14579: idx (reference to hash of counters used in Domain Coordinator interface for
14580: editing Course Categories).
1.663 raeburn 14581:
1.655 raeburn 14582: jsarray (reference to array of categories used to create Javascript arrays for
14583: Domain Coordinator interface for editing Course Categories).
14584:
14585: Returns: nothing
14586:
14587: Side effects: populates cats, idx and jsarray.
14588:
14589: =cut
14590:
14591: sub gather_categories {
14592: my ($categories,$cats,$idx,$jsarray) = @_;
14593: my %counters;
14594: my $num = 0;
14595: foreach my $item (keys(%{$categories})) {
14596: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
14597: if ($container eq '' && $depth == 0) {
14598: $cats->[$depth][$categories->{$item}] = $cat;
14599: } else {
14600: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
14601: }
14602: my ($escitem,$tail) = split(/:/,$item,2);
14603: if ($counters{$tail} eq '') {
14604: $counters{$tail} = $num;
14605: $num ++;
14606: }
14607: if (ref($idx) eq 'HASH') {
14608: $idx->{$item} = $counters{$tail};
14609: }
14610: if (ref($jsarray) eq 'ARRAY') {
14611: push(@{$jsarray->[$counters{$tail}]},$item);
14612: }
14613: }
14614: return;
14615: }
14616:
14617: =pod
14618:
14619: =item * &extract_categories()
14620:
14621: Used to generate breadcrumb trails for course categories.
14622:
14623: Inputs:
1.663 raeburn 14624:
1.655 raeburn 14625: categories (reference to hash of category definitions).
1.663 raeburn 14626:
1.655 raeburn 14627: cats (reference to array of arrays/hashes which encapsulates hierarchy of
14628: categories and subcategories).
1.663 raeburn 14629:
1.655 raeburn 14630: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 14631:
1.655 raeburn 14632: allitems (reference to hash - key is category key
14633: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 14634:
1.655 raeburn 14635: idx (reference to hash of counters used in Domain Coordinator interface for
14636: editing Course Categories).
1.663 raeburn 14637:
1.655 raeburn 14638: jsarray (reference to array of categories used to create Javascript arrays for
14639: Domain Coordinator interface for editing Course Categories).
14640:
1.665 raeburn 14641: subcats (reference to hash of arrays containing all subcategories within each
14642: category, -recursive)
14643:
1.1075.2.132 raeburn 14644: maxd (reference to hash used to hold max depth for all top-level categories).
14645:
1.655 raeburn 14646: Returns: nothing
14647:
14648: Side effects: populates trails and allitems hash references.
14649:
14650: =cut
14651:
14652: sub extract_categories {
1.1075.2.132 raeburn 14653: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 14654: if (ref($categories) eq 'HASH') {
14655: &gather_categories($categories,$cats,$idx,$jsarray);
14656: if (ref($cats->[0]) eq 'ARRAY') {
14657: for (my $i=0; $i<@{$cats->[0]}; $i++) {
14658: my $name = $cats->[0][$i];
14659: my $item = &escape($name).'::0';
14660: my $trailstr;
14661: if ($name eq 'instcode') {
14662: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 14663: } elsif ($name eq 'communities') {
14664: $trailstr = &mt('Communities');
1.655 raeburn 14665: } else {
14666: $trailstr = $name;
14667: }
14668: if ($allitems->{$item} eq '') {
14669: push(@{$trails},$trailstr);
14670: $allitems->{$item} = scalar(@{$trails})-1;
14671: }
14672: my @parents = ($name);
14673: if (ref($cats->[1]{$name}) eq 'ARRAY') {
14674: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
14675: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 14676: if (ref($subcats) eq 'HASH') {
14677: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
14678: }
1.1075.2.132 raeburn 14679: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 14680: }
14681: } else {
14682: if (ref($subcats) eq 'HASH') {
14683: $subcats->{$item} = [];
1.655 raeburn 14684: }
1.1075.2.132 raeburn 14685: if (ref($maxd) eq 'HASH') {
14686: $maxd->{$name} = 1;
14687: }
1.655 raeburn 14688: }
14689: }
14690: }
14691: }
14692: return;
14693: }
14694:
14695: =pod
14696:
1.1075.2.56 raeburn 14697: =item * &recurse_categories()
1.655 raeburn 14698:
14699: Recursively used to generate breadcrumb trails for course categories.
14700:
14701: Inputs:
1.663 raeburn 14702:
1.655 raeburn 14703: cats (reference to array of arrays/hashes which encapsulates hierarchy of
14704: categories and subcategories).
1.663 raeburn 14705:
1.655 raeburn 14706: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 14707:
14708: category (current course category, for which breadcrumb trail is being generated).
14709:
14710: trails (reference to array of breadcrumb trails for each category).
14711:
1.655 raeburn 14712: allitems (reference to hash - key is category key
14713: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 14714:
1.655 raeburn 14715: parents (array containing containers directories for current category,
14716: back to top level).
14717:
14718: Returns: nothing
14719:
14720: Side effects: populates trails and allitems hash references
14721:
14722: =cut
14723:
14724: sub recurse_categories {
1.1075.2.132 raeburn 14725: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 14726: my $shallower = $depth - 1;
14727: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
14728: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
14729: my $name = $cats->[$depth]{$category}[$k];
14730: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
14731: my $trailstr = join(' -> ',(@{$parents},$category));
14732: if ($allitems->{$item} eq '') {
14733: push(@{$trails},$trailstr);
14734: $allitems->{$item} = scalar(@{$trails})-1;
14735: }
14736: my $deeper = $depth+1;
14737: push(@{$parents},$category);
1.665 raeburn 14738: if (ref($subcats) eq 'HASH') {
14739: my $subcat = &escape($name).':'.$category.':'.$depth;
14740: for (my $j=@{$parents}; $j>=0; $j--) {
14741: my $higher;
14742: if ($j > 0) {
14743: $higher = &escape($parents->[$j]).':'.
14744: &escape($parents->[$j-1]).':'.$j;
14745: } else {
14746: $higher = &escape($parents->[$j]).'::'.$j;
14747: }
14748: push(@{$subcats->{$higher}},$subcat);
14749: }
14750: }
14751: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132 raeburn 14752: $subcats,$maxd);
1.655 raeburn 14753: pop(@{$parents});
14754: }
14755: } else {
14756: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132 raeburn 14757: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 14758: if ($allitems->{$item} eq '') {
14759: push(@{$trails},$trailstr);
14760: $allitems->{$item} = scalar(@{$trails})-1;
14761: }
1.1075.2.132 raeburn 14762: if (ref($maxd) eq 'HASH') {
14763: if ($depth > $maxd->{$parents->[0]}) {
14764: $maxd->{$parents->[0]} = $depth;
14765: }
14766: }
1.655 raeburn 14767: }
14768: return;
14769: }
14770:
1.663 raeburn 14771: =pod
14772:
1.1075.2.56 raeburn 14773: =item * &assign_categories_table()
1.663 raeburn 14774:
14775: Create a datatable for display of hierarchical categories in a domain,
14776: with checkboxes to allow a course to be categorized.
14777:
14778: Inputs:
14779:
14780: cathash - reference to hash of categories defined for the domain (from
14781: configuration.db)
14782:
14783: currcat - scalar with an & separated list of categories assigned to a course.
14784:
1.919 raeburn 14785: type - scalar contains course type (Course or Community).
14786:
1.1075.2.117 raeburn 14787: disabled - scalar (optional) contains disabled="disabled" if input elements are
14788: to be readonly (e.g., Domain Helpdesk role viewing course settings).
14789:
1.663 raeburn 14790: Returns: $output (markup to be displayed)
14791:
14792: =cut
14793:
14794: sub assign_categories_table {
1.1075.2.117 raeburn 14795: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 14796: my $output;
14797: if (ref($cathash) eq 'HASH') {
1.1075.2.132 raeburn 14798: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
14799: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 14800: $maxdepth = scalar(@cats);
14801: if (@cats > 0) {
14802: my $itemcount = 0;
14803: if (ref($cats[0]) eq 'ARRAY') {
14804: my @currcategories;
14805: if ($currcat ne '') {
14806: @currcategories = split('&',$currcat);
14807: }
1.919 raeburn 14808: my $table;
1.663 raeburn 14809: for (my $i=0; $i<@{$cats[0]}; $i++) {
14810: my $parent = $cats[0][$i];
1.919 raeburn 14811: next if ($parent eq 'instcode');
14812: if ($type eq 'Community') {
14813: next unless ($parent eq 'communities');
14814: } else {
14815: next if ($parent eq 'communities');
14816: }
1.663 raeburn 14817: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
14818: my $item = &escape($parent).'::0';
14819: my $checked = '';
14820: if (@currcategories > 0) {
14821: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 14822: $checked = ' checked="checked"';
1.663 raeburn 14823: }
14824: }
1.919 raeburn 14825: my $parent_title = $parent;
14826: if ($parent eq 'communities') {
14827: $parent_title = &mt('Communities');
14828: }
14829: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
14830: '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117 raeburn 14831: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 14832: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 14833: my $depth = 1;
14834: push(@path,$parent);
1.1075.2.117 raeburn 14835: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 14836: pop(@path);
1.919 raeburn 14837: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 14838: $itemcount ++;
14839: }
1.919 raeburn 14840: if ($itemcount) {
14841: $output = &Apache::loncommon::start_data_table().
14842: $table.
14843: &Apache::loncommon::end_data_table();
14844: }
1.663 raeburn 14845: }
14846: }
14847: }
14848: return $output;
14849: }
14850:
14851: =pod
14852:
1.1075.2.56 raeburn 14853: =item * &assign_category_rows()
1.663 raeburn 14854:
14855: Create a datatable row for display of nested categories in a domain,
14856: with checkboxes to allow a course to be categorized,called recursively.
14857:
14858: Inputs:
14859:
14860: itemcount - track row number for alternating colors
14861:
14862: cats - reference to array of arrays/hashes which encapsulates hierarchy of
14863: categories and subcategories.
14864:
14865: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
14866:
14867: parent - parent of current category item
14868:
14869: path - Array containing all categories back up through the hierarchy from the
14870: current category to the top level.
14871:
14872: currcategories - reference to array of current categories assigned to the course
14873:
1.1075.2.117 raeburn 14874: disabled - scalar (optional) contains disabled="disabled" if input elements are
14875: to be readonly (e.g., Domain Helpdesk role viewing course settings).
14876:
1.663 raeburn 14877: Returns: $output (markup to be displayed).
14878:
14879: =cut
14880:
14881: sub assign_category_rows {
1.1075.2.117 raeburn 14882: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 14883: my ($text,$name,$item,$chgstr);
14884: if (ref($cats) eq 'ARRAY') {
14885: my $maxdepth = scalar(@{$cats});
14886: if (ref($cats->[$depth]) eq 'HASH') {
14887: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
14888: my $numchildren = @{$cats->[$depth]{$parent}};
14889: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45 raeburn 14890: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 14891: for (my $j=0; $j<$numchildren; $j++) {
14892: $name = $cats->[$depth]{$parent}[$j];
14893: $item = &escape($name).':'.&escape($parent).':'.$depth;
14894: my $deeper = $depth+1;
14895: my $checked = '';
14896: if (ref($currcategories) eq 'ARRAY') {
14897: if (@{$currcategories} > 0) {
14898: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 14899: $checked = ' checked="checked"';
1.663 raeburn 14900: }
14901: }
14902: }
1.664 raeburn 14903: $text .= '<tr><td><span class="LC_nobreak"><label>'.
14904: '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117 raeburn 14905: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 14906: '<input type="hidden" name="catname" value="'.$name.'" />'.
14907: '</td><td>';
1.663 raeburn 14908: if (ref($path) eq 'ARRAY') {
14909: push(@{$path},$name);
1.1075.2.117 raeburn 14910: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 14911: pop(@{$path});
14912: }
14913: $text .= '</td></tr>';
14914: }
14915: $text .= '</table></td>';
14916: }
14917: }
14918: }
14919: return $text;
14920: }
14921:
1.1075.2.69 raeburn 14922: =pod
14923:
14924: =back
14925:
14926: =cut
14927:
1.655 raeburn 14928: ############################################################
14929: ############################################################
14930:
14931:
1.443 albertel 14932: sub commit_customrole {
1.664 raeburn 14933: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 14934: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 14935: ($start?', '.&mt('starting').' '.localtime($start):'').
14936: ($end?', ending '.localtime($end):'').': <b>'.
14937: &Apache::lonnet::assigncustomrole(
1.664 raeburn 14938: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 14939: '</b><br />';
14940: return $output;
14941: }
14942:
14943: sub commit_standardrole {
1.1075.2.31 raeburn 14944: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 14945: my ($output,$logmsg,$linefeed);
14946: if ($context eq 'auto') {
14947: $linefeed = "\n";
14948: } else {
14949: $linefeed = "<br />\n";
14950: }
1.443 albertel 14951: if ($three eq 'st') {
1.541 raeburn 14952: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31 raeburn 14953: $one,$two,$sec,$context,$credits);
1.541 raeburn 14954: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 14955: ($result eq 'unknown_course') || ($result eq 'refused')) {
14956: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 14957: } else {
1.541 raeburn 14958: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 14959: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14960: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
14961: if ($context eq 'auto') {
14962: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
14963: } else {
14964: $output .= '<b>'.$result.'</b>'.$linefeed.
14965: &mt('Add to classlist').': <b>ok</b>';
14966: }
14967: $output .= $linefeed;
1.443 albertel 14968: }
14969: } else {
14970: $output = &mt('Assigning').' '.$three.' in '.$url.
14971: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 14972: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 14973: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 14974: if ($context eq 'auto') {
14975: $output .= $result.$linefeed;
14976: } else {
14977: $output .= '<b>'.$result.'</b>'.$linefeed;
14978: }
1.443 albertel 14979: }
14980: return $output;
14981: }
14982:
14983: sub commit_studentrole {
1.1075.2.31 raeburn 14984: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
14985: $credits) = @_;
1.626 raeburn 14986: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 14987: if ($context eq 'auto') {
14988: $linefeed = "\n";
14989: } else {
14990: $linefeed = '<br />'."\n";
14991: }
1.443 albertel 14992: if (defined($one) && defined($two)) {
14993: my $cid=$one.'_'.$two;
14994: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
14995: my $secchange = 0;
14996: my $expire_role_result;
14997: my $modify_section_result;
1.628 raeburn 14998: if ($oldsec ne '-1') {
14999: if ($oldsec ne $sec) {
1.443 albertel 15000: $secchange = 1;
1.628 raeburn 15001: my $now = time;
1.443 albertel 15002: my $uurl='/'.$cid;
15003: $uurl=~s/\_/\//g;
15004: if ($oldsec) {
15005: $uurl.='/'.$oldsec;
15006: }
1.626 raeburn 15007: $oldsecurl = $uurl;
1.628 raeburn 15008: $expire_role_result =
1.652 raeburn 15009: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 15010: if ($env{'request.course.sec'} ne '') {
15011: if ($expire_role_result eq 'refused') {
15012: my @roles = ('st');
15013: my @statuses = ('previous');
15014: my @roledoms = ($one);
15015: my $withsec = 1;
15016: my %roleshash =
15017: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
15018: \@statuses,\@roles,\@roledoms,$withsec);
15019: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
15020: my ($oldstart,$oldend) =
15021: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
15022: if ($oldend > 0 && $oldend <= $now) {
15023: $expire_role_result = 'ok';
15024: }
15025: }
15026: }
15027: }
1.443 albertel 15028: $result = $expire_role_result;
15029: }
15030: }
15031: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31 raeburn 15032: $modify_section_result =
15033: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
15034: undef,undef,undef,$sec,
15035: $end,$start,'','',$cid,
15036: '',$context,$credits);
1.443 albertel 15037: if ($modify_section_result =~ /^ok/) {
15038: if ($secchange == 1) {
1.628 raeburn 15039: if ($sec eq '') {
15040: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
15041: } else {
15042: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
15043: }
1.443 albertel 15044: } elsif ($oldsec eq '-1') {
1.628 raeburn 15045: if ($sec eq '') {
15046: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
15047: } else {
15048: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15049: }
1.443 albertel 15050: } else {
1.628 raeburn 15051: if ($sec eq '') {
15052: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
15053: } else {
15054: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15055: }
1.443 albertel 15056: }
15057: } else {
1.628 raeburn 15058: if ($secchange) {
15059: $$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;
15060: } else {
15061: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
15062: }
1.443 albertel 15063: }
15064: $result = $modify_section_result;
15065: } elsif ($secchange == 1) {
1.628 raeburn 15066: if ($oldsec eq '') {
1.1075.2.20 raeburn 15067: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
1.628 raeburn 15068: } else {
15069: $$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;
15070: }
1.626 raeburn 15071: if ($expire_role_result eq 'refused') {
15072: my $newsecurl = '/'.$cid;
15073: $newsecurl =~ s/\_/\//g;
15074: if ($sec ne '') {
15075: $newsecurl.='/'.$sec;
15076: }
15077: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
15078: if ($sec eq '') {
15079: $$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;
15080: } else {
15081: $$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;
15082: }
15083: }
15084: }
1.443 albertel 15085: }
15086: } else {
1.626 raeburn 15087: $$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 15088: $result = "error: incomplete course id\n";
15089: }
15090: return $result;
15091: }
15092:
1.1075.2.25 raeburn 15093: sub show_role_extent {
15094: my ($scope,$context,$role) = @_;
15095: $scope =~ s{^/}{};
15096: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
15097: push(@courseroles,'co');
15098: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
15099: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
15100: $scope =~ s{/}{_};
15101: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
15102: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
15103: my ($audom,$auname) = split(/\//,$scope);
15104: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
15105: &Apache::loncommon::plainname($auname,$audom).'</span>');
15106: } else {
15107: $scope =~ s{/$}{};
15108: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
15109: &Apache::lonnet::domain($scope,'description').'</span>');
15110: }
15111: }
15112:
1.443 albertel 15113: ############################################################
15114: ############################################################
15115:
1.566 albertel 15116: sub check_clone {
1.578 raeburn 15117: my ($args,$linefeed) = @_;
1.566 albertel 15118: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
15119: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
15120: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
15121: my $clonemsg;
15122: my $can_clone = 0;
1.944 raeburn 15123: my $lctype = lc($args->{'crstype'});
1.908 raeburn 15124: if ($lctype ne 'community') {
15125: $lctype = 'course';
15126: }
1.566 albertel 15127: if ($clonehome eq 'no_host') {
1.944 raeburn 15128: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15129: $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'});
15130: } else {
15131: $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'});
15132: }
1.566 albertel 15133: } else {
15134: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 15135: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15136: if ($clonedesc{'type'} ne 'Community') {
15137: $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'});
15138: return ($can_clone, $clonemsg, $cloneid, $clonehome);
15139: }
15140: }
1.1075.2.119 raeburn 15141: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 15142: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 15143: $can_clone = 1;
15144: } else {
1.1075.2.95 raeburn 15145: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 15146: $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95 raeburn 15147: if ($clonehash{'cloners'} eq '') {
15148: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
15149: if ($domdefs{'canclone'}) {
15150: unless ($domdefs{'canclone'} eq 'none') {
15151: if ($domdefs{'canclone'} eq 'domain') {
15152: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
15153: $can_clone = 1;
15154: }
15155: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15156: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
15157: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
15158: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
15159: $can_clone = 1;
15160: }
15161: }
15162: }
1.908 raeburn 15163: }
1.1075.2.95 raeburn 15164: } else {
15165: my @cloners = split(/,/,$clonehash{'cloners'});
15166: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 15167: $can_clone = 1;
1.1075.2.95 raeburn 15168: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 15169: $can_clone = 1;
1.1075.2.96 raeburn 15170: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
15171: $can_clone = 1;
1.1075.2.95 raeburn 15172: }
15173: unless ($can_clone) {
1.1075.2.96 raeburn 15174: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15175: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1075.2.95 raeburn 15176: my (%gotdomdefaults,%gotcodedefaults);
15177: foreach my $cloner (@cloners) {
15178: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
15179: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
15180: my (%codedefaults,@code_order);
15181: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
15182: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
15183: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
15184: }
15185: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
15186: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
15187: }
15188: } else {
15189: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
15190: \%codedefaults,
15191: \@code_order);
15192: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
15193: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
15194: }
15195: if (@code_order > 0) {
15196: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
15197: $cloner,$clonehash{'internal.coursecode'},
15198: $args->{'crscode'})) {
15199: $can_clone = 1;
15200: last;
15201: }
15202: }
15203: }
15204: }
15205: }
1.1075.2.96 raeburn 15206: }
15207: }
15208: unless ($can_clone) {
15209: my $ccrole = 'cc';
15210: if ($args->{'crstype'} eq 'Community') {
15211: $ccrole = 'co';
15212: }
15213: my %roleshash =
15214: &Apache::lonnet::get_my_roles($args->{'ccuname'},
15215: $args->{'ccdomain'},
15216: 'userroles',['active'],[$ccrole],
15217: [$args->{'clonedomain'}]);
15218: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
15219: $can_clone = 1;
15220: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
15221: $args->{'ccuname'},$args->{'ccdomain'})) {
15222: $can_clone = 1;
1.1075.2.95 raeburn 15223: }
15224: }
15225: unless ($can_clone) {
15226: if ($args->{'crstype'} eq 'Community') {
15227: $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'});
15228: } else {
15229: $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'});
1.578 raeburn 15230: }
1.566 albertel 15231: }
1.578 raeburn 15232: }
1.566 albertel 15233: }
15234: return ($can_clone, $clonemsg, $cloneid, $clonehome);
15235: }
15236:
1.444 albertel 15237: sub construct_course {
1.1075.2.119 raeburn 15238: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
15239: $cnum,$category,$coderef) = @_;
1.444 albertel 15240: my $outcome;
1.541 raeburn 15241: my $linefeed = '<br />'."\n";
15242: if ($context eq 'auto') {
15243: $linefeed = "\n";
15244: }
1.566 albertel 15245:
15246: #
15247: # Are we cloning?
15248: #
15249: my ($can_clone, $clonemsg, $cloneid, $clonehome);
15250: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 15251: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 15252: if ($context ne 'auto') {
1.578 raeburn 15253: if ($clonemsg ne '') {
15254: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
15255: }
1.566 albertel 15256: }
15257: $outcome .= $clonemsg.$linefeed;
15258:
15259: if (!$can_clone) {
15260: return (0,$outcome);
15261: }
15262: }
15263:
1.444 albertel 15264: #
15265: # Open course
15266: #
15267: my $crstype = lc($args->{'crstype'});
15268: my %cenv=();
15269: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
15270: $args->{'cdescr'},
15271: $args->{'curl'},
15272: $args->{'course_home'},
15273: $args->{'nonstandard'},
15274: $args->{'crscode'},
15275: $args->{'ccuname'}.':'.
15276: $args->{'ccdomain'},
1.882 raeburn 15277: $args->{'crstype'},
1.885 raeburn 15278: $cnum,$context,$category);
1.444 albertel 15279:
15280: # Note: The testing routines depend on this being output; see
15281: # Utils::Course. This needs to at least be output as a comment
15282: # if anyone ever decides to not show this, and Utils::Course::new
15283: # will need to be suitably modified.
1.541 raeburn 15284: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943 raeburn 15285: if ($$courseid =~ /^error:/) {
15286: return (0,$outcome);
15287: }
15288:
1.444 albertel 15289: #
15290: # Check if created correctly
15291: #
1.479 albertel 15292: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 15293: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 15294: if ($crsuhome eq 'no_host') {
15295: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
15296: return (0,$outcome);
15297: }
1.541 raeburn 15298: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 15299:
1.444 albertel 15300: #
1.566 albertel 15301: # Do the cloning
15302: #
15303: if ($can_clone && $cloneid) {
15304: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
15305: if ($context ne 'auto') {
15306: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
15307: }
15308: $outcome .= $clonemsg.$linefeed;
15309: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 15310: # Copy all files
1.637 www 15311: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 15312: # Restore URL
1.566 albertel 15313: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 15314: # Restore title
1.566 albertel 15315: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 15316: # Restore creation date, creator and creation context.
15317: $cenv{'internal.created'}=$oldcenv{'internal.created'};
15318: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
15319: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 15320: # Mark as cloned
1.566 albertel 15321: $cenv{'clonedfrom'}=$cloneid;
1.638 www 15322: # Need to clone grading mode
15323: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
15324: $cenv{'grading'}=$newenv{'grading'};
15325: # Do not clone these environment entries
15326: &Apache::lonnet::del('environment',
15327: ['default_enrollment_start_date',
15328: 'default_enrollment_end_date',
15329: 'question.email',
15330: 'policy.email',
15331: 'comment.email',
15332: 'pch.users.denied',
1.725 raeburn 15333: 'plc.users.denied',
15334: 'hidefromcat',
1.1075.2.36 raeburn 15335: 'checkforpriv',
1.1075.2.59 raeburn 15336: 'categories',
15337: 'internal.uniquecode'],
1.638 www 15338: $$crsudom,$$crsunum);
1.1075.2.63 raeburn 15339: if ($args->{'textbook'}) {
15340: $cenv{'internal.textbook'} = $args->{'textbook'};
15341: }
1.444 albertel 15342: }
1.566 albertel 15343:
1.444 albertel 15344: #
15345: # Set environment (will override cloned, if existing)
15346: #
15347: my @sections = ();
15348: my @xlists = ();
15349: if ($args->{'crstype'}) {
15350: $cenv{'type'}=$args->{'crstype'};
15351: }
15352: if ($args->{'crsid'}) {
15353: $cenv{'courseid'}=$args->{'crsid'};
15354: }
15355: if ($args->{'crscode'}) {
15356: $cenv{'internal.coursecode'}=$args->{'crscode'};
15357: }
15358: if ($args->{'crsquota'} ne '') {
15359: $cenv{'internal.coursequota'}=$args->{'crsquota'};
15360: } else {
15361: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
15362: }
15363: if ($args->{'ccuname'}) {
15364: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
15365: ':'.$args->{'ccdomain'};
15366: } else {
15367: $cenv{'internal.courseowner'} = $args->{'curruser'};
15368: }
1.1075.2.31 raeburn 15369: if ($args->{'defaultcredits'}) {
15370: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
15371: }
1.444 albertel 15372: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
15373: if ($args->{'crssections'}) {
15374: $cenv{'internal.sectionnums'} = '';
15375: if ($args->{'crssections'} =~ m/,/) {
15376: @sections = split/,/,$args->{'crssections'};
15377: } else {
15378: $sections[0] = $args->{'crssections'};
15379: }
15380: if (@sections > 0) {
15381: foreach my $item (@sections) {
15382: my ($sec,$gp) = split/:/,$item;
15383: my $class = $args->{'crscode'}.$sec;
15384: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
15385: $cenv{'internal.sectionnums'} .= $item.',';
15386: unless ($addcheck eq 'ok') {
1.1075.2.119 raeburn 15387: push(@badclasses,$class);
1.444 albertel 15388: }
15389: }
15390: $cenv{'internal.sectionnums'} =~ s/,$//;
15391: }
15392: }
15393: # do not hide course coordinator from staff listing,
15394: # even if privileged
15395: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36 raeburn 15396: # add course coordinator's domain to domains to check for privileged users
15397: # if different to course domain
15398: if ($$crsudom ne $args->{'ccdomain'}) {
15399: $cenv{'checkforpriv'} = $args->{'ccdomain'};
15400: }
1.444 albertel 15401: # add crosslistings
15402: if ($args->{'crsxlist'}) {
15403: $cenv{'internal.crosslistings'}='';
15404: if ($args->{'crsxlist'} =~ m/,/) {
15405: @xlists = split/,/,$args->{'crsxlist'};
15406: } else {
15407: $xlists[0] = $args->{'crsxlist'};
15408: }
15409: if (@xlists > 0) {
15410: foreach my $item (@xlists) {
15411: my ($xl,$gp) = split/:/,$item;
15412: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
15413: $cenv{'internal.crosslistings'} .= $item.',';
15414: unless ($addcheck eq 'ok') {
1.1075.2.119 raeburn 15415: push(@badclasses,$xl);
1.444 albertel 15416: }
15417: }
15418: $cenv{'internal.crosslistings'} =~ s/,$//;
15419: }
15420: }
15421: if ($args->{'autoadds'}) {
15422: $cenv{'internal.autoadds'}=$args->{'autoadds'};
15423: }
15424: if ($args->{'autodrops'}) {
15425: $cenv{'internal.autodrops'}=$args->{'autodrops'};
15426: }
15427: # check for notification of enrollment changes
15428: my @notified = ();
15429: if ($args->{'notify_owner'}) {
15430: if ($args->{'ccuname'} ne '') {
15431: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
15432: }
15433: }
15434: if ($args->{'notify_dc'}) {
15435: if ($uname ne '') {
1.630 raeburn 15436: push(@notified,$uname.':'.$udom);
1.444 albertel 15437: }
15438: }
15439: if (@notified > 0) {
15440: my $notifylist;
15441: if (@notified > 1) {
15442: $notifylist = join(',',@notified);
15443: } else {
15444: $notifylist = $notified[0];
15445: }
15446: $cenv{'internal.notifylist'} = $notifylist;
15447: }
15448: if (@badclasses > 0) {
15449: my %lt=&Apache::lonlocal::texthash(
1.1075.2.119 raeburn 15450: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
15451: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
15452: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 15453: );
1.1075.2.119 raeburn 15454: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
15455: &mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
1.541 raeburn 15456: if ($context eq 'auto') {
15457: $outcome .= $badclass_msg.$linefeed;
1.1075.2.119 raeburn 15458: } else {
1.566 albertel 15459: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119 raeburn 15460: }
15461: foreach my $item (@badclasses) {
1.541 raeburn 15462: if ($context eq 'auto') {
1.1075.2.119 raeburn 15463: $outcome .= " - $item\n";
1.541 raeburn 15464: } else {
1.1075.2.119 raeburn 15465: $outcome .= "<li>$item</li>\n";
1.541 raeburn 15466: }
1.1075.2.119 raeburn 15467: }
15468: if ($context eq 'auto') {
15469: $outcome .= $linefeed;
15470: } else {
15471: $outcome .= "</ul><br /><br /></div>\n";
15472: }
1.444 albertel 15473: }
15474: if ($args->{'no_end_date'}) {
15475: $args->{'endaccess'} = 0;
15476: }
15477: $cenv{'internal.autostart'}=$args->{'enrollstart'};
15478: $cenv{'internal.autoend'}=$args->{'enrollend'};
15479: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
15480: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
15481: if ($args->{'showphotos'}) {
15482: $cenv{'internal.showphotos'}=$args->{'showphotos'};
15483: }
15484: $cenv{'internal.authtype'} = $args->{'authtype'};
15485: $cenv{'internal.autharg'} = $args->{'autharg'};
15486: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
15487: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 15488: 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');
15489: if ($context eq 'auto') {
15490: $outcome .= $krb_msg;
15491: } else {
1.566 albertel 15492: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 15493: }
15494: $outcome .= $linefeed;
1.444 albertel 15495: }
15496: }
15497: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
15498: if ($args->{'setpolicy'}) {
15499: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15500: }
15501: if ($args->{'setcontent'}) {
15502: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15503: }
1.1075.2.110 raeburn 15504: if ($args->{'setcomment'}) {
15505: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15506: }
1.444 albertel 15507: }
15508: if ($args->{'reshome'}) {
15509: $cenv{'reshome'}=$args->{'reshome'}.'/';
15510: $cenv{'reshome'}=~s/\/+$/\//;
15511: }
15512: #
15513: # course has keyed access
15514: #
15515: if ($args->{'setkeys'}) {
15516: $cenv{'keyaccess'}='yes';
15517: }
15518: # if specified, key authority is not course, but user
15519: # only active if keyaccess is yes
15520: if ($args->{'keyauth'}) {
1.487 albertel 15521: my ($user,$domain) = split(':',$args->{'keyauth'});
15522: $user = &LONCAPA::clean_username($user);
15523: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 15524: if ($user ne '' && $domain ne '') {
1.487 albertel 15525: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 15526: }
15527: }
15528:
1.1075.2.59 raeburn 15529: #
15530: # generate and store uniquecode (available to course requester), if course should have one.
15531: #
15532: if ($args->{'uniquecode'}) {
15533: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
15534: if ($code) {
15535: $cenv{'internal.uniquecode'} = $code;
15536: my %crsinfo =
15537: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
15538: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
15539: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
15540: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
15541: }
15542: if (ref($coderef)) {
15543: $$coderef = $code;
15544: }
15545: }
15546: }
15547:
1.444 albertel 15548: if ($args->{'disresdis'}) {
15549: $cenv{'pch.roles.denied'}='st';
15550: }
15551: if ($args->{'disablechat'}) {
15552: $cenv{'plc.roles.denied'}='st';
15553: }
15554:
15555: # Record we've not yet viewed the Course Initialization Helper for this
15556: # course
15557: $cenv{'course.helper.not.run'} = 1;
15558: #
15559: # Use new Randomseed
15560: #
15561: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
15562: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
15563: #
15564: # The encryption code and receipt prefix for this course
15565: #
15566: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
15567: $cenv{'internal.encpref'}=100+int(9*rand(99));
15568: #
15569: # By default, use standard grading
15570: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
15571:
1.541 raeburn 15572: $outcome .= $linefeed.&mt('Setting environment').': '.
15573: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 15574: #
15575: # Open all assignments
15576: #
15577: if ($args->{'openall'}) {
1.1075.2.146 raeburn 15578: my $opendate = time;
15579: if ($args->{'openallfrom'} =~ /^\d+$/) {
15580: $opendate = $args->{'openallfrom'};
15581: }
1.444 albertel 15582: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146 raeburn 15583: my %storecontent = ($storeunder => $opendate,
1.444 albertel 15584: $storeunder.'.type' => 'date_start');
1.1075.2.146 raeburn 15585: $outcome .= &mt('All assignments open starting [_1]',
15586: &Apache::lonlocal::locallocaltime($opendate)).': '.
15587: &Apache::lonnet::cput
15588: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 15589: }
15590: #
15591: # Set first page
15592: #
15593: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
15594: || ($cloneid)) {
1.445 albertel 15595: use LONCAPA::map;
1.444 albertel 15596: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 15597:
15598: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
15599: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
15600:
1.444 albertel 15601: $outcome .= ($fatal?$errtext:'read ok').' - ';
15602: my $title; my $url;
15603: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 15604: $title=&mt('Syllabus');
1.444 albertel 15605: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
15606: } else {
1.963 raeburn 15607: $title=&mt('Table of Contents');
1.444 albertel 15608: $url='/adm/navmaps';
15609: }
1.445 albertel 15610:
15611: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
15612: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
15613:
15614: if ($errtext) { $fatal=2; }
1.541 raeburn 15615: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 15616: }
1.566 albertel 15617:
15618: return (1,$outcome);
1.444 albertel 15619: }
15620:
1.1075.2.59 raeburn 15621: sub make_unique_code {
15622: my ($cdom,$cnum) = @_;
15623: # get lock on uniquecodes db
15624: my $lockhash = {
15625: $cnum."\0".'uniquecodes' => $env{'user.name'}.
15626: ':'.$env{'user.domain'},
15627: };
15628: my $tries = 0;
15629: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
15630: my ($code,$error);
15631:
15632: while (($gotlock ne 'ok') && ($tries<3)) {
15633: $tries ++;
15634: sleep 1;
15635: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
15636: }
15637: if ($gotlock eq 'ok') {
15638: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
15639: my $gotcode;
15640: my $attempts = 0;
15641: while ((!$gotcode) && ($attempts < 100)) {
15642: $code = &generate_code();
15643: if (!exists($currcodes{$code})) {
15644: $gotcode = 1;
15645: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
15646: $error = 'nostore';
15647: }
15648: }
15649: $attempts ++;
15650: }
15651: my @del_lock = ($cnum."\0".'uniquecodes');
15652: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
15653: } else {
15654: $error = 'nolock';
15655: }
15656: return ($code,$error);
15657: }
15658:
15659: sub generate_code {
15660: my $code;
15661: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
15662: for (my $i=0; $i<6; $i++) {
15663: my $lettnum = int (rand 2);
15664: my $item = '';
15665: if ($lettnum) {
15666: $item = $letts[int( rand(18) )];
15667: } else {
15668: $item = 1+int( rand(8) );
15669: }
15670: $code .= $item;
15671: }
15672: return $code;
15673: }
15674:
1.444 albertel 15675: ############################################################
15676: ############################################################
15677:
1.953 droeschl 15678: #SD
15679: # only Community and Course, or anything else?
1.378 raeburn 15680: sub course_type {
15681: my ($cid) = @_;
15682: if (!defined($cid)) {
15683: $cid = $env{'request.course.id'};
15684: }
1.404 albertel 15685: if (defined($env{'course.'.$cid.'.type'})) {
15686: return $env{'course.'.$cid.'.type'};
1.378 raeburn 15687: } else {
15688: return 'Course';
1.377 raeburn 15689: }
15690: }
1.156 albertel 15691:
1.406 raeburn 15692: sub group_term {
15693: my $crstype = &course_type();
15694: my %names = (
15695: 'Course' => 'group',
1.865 raeburn 15696: 'Community' => 'group',
1.406 raeburn 15697: );
15698: return $names{$crstype};
15699: }
15700:
1.902 raeburn 15701: sub course_types {
1.1075.2.59 raeburn 15702: my @types = ('official','unofficial','community','textbook');
1.902 raeburn 15703: my %typename = (
15704: official => 'Official course',
15705: unofficial => 'Unofficial course',
15706: community => 'Community',
1.1075.2.59 raeburn 15707: textbook => 'Textbook course',
1.902 raeburn 15708: );
15709: return (\@types,\%typename);
15710: }
15711:
1.156 albertel 15712: sub icon {
15713: my ($file)=@_;
1.505 albertel 15714: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 15715: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 15716: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 15717: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
15718: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
15719: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
15720: $curfext.".gif") {
15721: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
15722: $curfext.".gif";
15723: }
15724: }
1.249 albertel 15725: return &lonhttpdurl($iconname);
1.154 albertel 15726: }
1.84 albertel 15727:
1.575 albertel 15728: sub lonhttpdurl {
1.692 www 15729: #
15730: # Had been used for "small fry" static images on separate port 8080.
15731: # Modify here if lightweight http functionality desired again.
15732: # Currently eliminated due to increasing firewall issues.
15733: #
1.575 albertel 15734: my ($url)=@_;
1.692 www 15735: return $url;
1.215 albertel 15736: }
15737:
1.213 albertel 15738: sub connection_aborted {
15739: my ($r)=@_;
15740: $r->print(" ");$r->rflush();
15741: my $c = $r->connection;
15742: return $c->aborted();
15743: }
15744:
1.221 foxr 15745: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 15746: # strings as 'strings'.
15747: sub escape_single {
1.221 foxr 15748: my ($input) = @_;
1.223 albertel 15749: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 15750: $input =~ s/\'/\\\'/g; # Esacpe the 's....
15751: return $input;
15752: }
1.223 albertel 15753:
1.222 foxr 15754: # Same as escape_single, but escape's "'s This
15755: # can be used for "strings"
15756: sub escape_double {
15757: my ($input) = @_;
15758: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
15759: $input =~ s/\"/\\\"/g; # Esacpe the "s....
15760: return $input;
15761: }
1.223 albertel 15762:
1.222 foxr 15763: # Escapes the last element of a full URL.
15764: sub escape_url {
15765: my ($url) = @_;
1.238 raeburn 15766: my @urlslices = split(/\//, $url,-1);
1.369 www 15767: my $lastitem = &escape(pop(@urlslices));
1.1075.2.83 raeburn 15768: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 15769: }
1.462 albertel 15770:
1.820 raeburn 15771: sub compare_arrays {
15772: my ($arrayref1,$arrayref2) = @_;
15773: my (@difference,%count);
15774: @difference = ();
15775: %count = ();
15776: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
15777: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
15778: foreach my $element (keys(%count)) {
15779: if ($count{$element} == 1) {
15780: push(@difference,$element);
15781: }
15782: }
15783: }
15784: return @difference;
15785: }
15786:
1.817 bisitz 15787: # -------------------------------------------------------- Initialize user login
1.462 albertel 15788: sub init_user_environment {
1.463 albertel 15789: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 15790: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
15791:
15792: my $public=($username eq 'public' && $domain eq 'public');
15793:
15794: # See if old ID present, if so, remove
15795:
1.1062 raeburn 15796: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 15797: my $now=time;
15798:
15799: if ($public) {
15800: my $max_public=100;
15801: my $oldest;
15802: my $oldest_time=0;
15803: for(my $next=1;$next<=$max_public;$next++) {
15804: if (-e $lonids."/publicuser_$next.id") {
15805: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
15806: if ($mtime<$oldest_time || !$oldest_time) {
15807: $oldest_time=$mtime;
15808: $oldest=$next;
15809: }
15810: } else {
15811: $cookie="publicuser_$next";
15812: last;
15813: }
15814: }
15815: if (!$cookie) { $cookie="publicuser_$oldest"; }
15816: } else {
1.463 albertel 15817: # if this isn't a robot, kill any existing non-robot sessions
15818: if (!$args->{'robot'}) {
15819: opendir(DIR,$lonids);
15820: while ($filename=readdir(DIR)) {
15821: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136 raeburn 15822: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
15823: &GDBM_READER(),0640)) {
15824: my $linkedfile;
15825: if (exists($oldenv{'user.linkedenv'})) {
15826: $linkedfile = $oldenv{'user.linkedenv'};
15827: }
15828: untie(%oldenv);
15829: if (unlink("$lonids/$filename")) {
15830: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
15831: if (-l "$lonids/$linkedfile.id") {
15832: unlink("$lonids/$linkedfile.id");
15833: }
15834: }
15835: }
15836: } else {
15837: unlink($lonids.'/'.$filename);
15838: }
1.463 albertel 15839: }
1.462 albertel 15840: }
1.463 albertel 15841: closedir(DIR);
1.1075.2.84 raeburn 15842: # If there is a undeleted lockfile for the user's paste buffer remove it.
15843: my $namespace = 'nohist_courseeditor';
15844: my $lockingkey = 'paste'."\0".'locked_num';
15845: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
15846: $domain,$username);
15847: if (exists($lockhash{$lockingkey})) {
15848: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
15849: unless ($delresult eq 'ok') {
15850: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
15851: }
15852: }
1.462 albertel 15853: }
15854: # Give them a new cookie
1.463 albertel 15855: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 15856: : $now.$$.int(rand(10000)));
1.463 albertel 15857: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 15858:
15859: # Initialize roles
15860:
1.1062 raeburn 15861: ($userroles,$firstaccenv,$timerintenv) =
15862: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 15863: }
15864: # ------------------------------------ Check browser type and MathML capability
15865:
1.1075.2.77 raeburn 15866: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
15867: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 15868:
15869: # ------------------------------------------------------------- Get environment
15870:
15871: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
15872: my ($tmp) = keys(%userenv);
15873: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
15874: } else {
15875: undef(%userenv);
15876: }
15877: if (($userenv{'interface'}) && (!$form->{'interface'})) {
15878: $form->{'interface'}=$userenv{'interface'};
15879: }
15880: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
15881:
15882: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 15883: foreach my $option ('interface','localpath','localres') {
15884: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 15885: }
15886: # --------------------------------------------------------- Write first profile
15887:
15888: {
1.1075.2.150! raeburn 15889: my $ip = &Apache::lonnet::get_requestor_ip();
1.462 albertel 15890: my %initial_env =
15891: ("user.name" => $username,
15892: "user.domain" => $domain,
15893: "user.home" => $authhost,
15894: "browser.type" => $clientbrowser,
15895: "browser.version" => $clientversion,
15896: "browser.mathml" => $clientmathml,
15897: "browser.unicode" => $clientunicode,
15898: "browser.os" => $clientos,
1.1075.2.42 raeburn 15899: "browser.mobile" => $clientmobile,
15900: "browser.info" => $clientinfo,
1.1075.2.77 raeburn 15901: "browser.osversion" => $clientosversion,
1.462 albertel 15902: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
15903: "request.course.fn" => '',
15904: "request.course.uri" => '',
15905: "request.course.sec" => '',
15906: "request.role" => 'cm',
15907: "request.role.adv" => $env{'user.adv'},
1.1075.2.150! raeburn 15908: "request.host" => $ip,);
1.462 albertel 15909:
15910: if ($form->{'localpath'}) {
15911: $initial_env{"browser.localpath"} = $form->{'localpath'};
15912: $initial_env{"browser.localres"} = $form->{'localres'};
15913: }
15914:
15915: if ($form->{'interface'}) {
15916: $form->{'interface'}=~s/\W//gs;
15917: $initial_env{"browser.interface"} = $form->{'interface'};
15918: $env{'browser.interface'}=$form->{'interface'};
15919: }
15920:
1.1075.2.54 raeburn 15921: if ($form->{'iptoken'}) {
15922: my $lonhost = $r->dir_config('lonHostID');
15923: $initial_env{"user.noloadbalance"} = $lonhost;
15924: $env{'user.noloadbalance'} = $lonhost;
15925: }
15926:
1.1075.2.120 raeburn 15927: if ($form->{'noloadbalance'}) {
15928: my @hosts = &Apache::lonnet::current_machine_ids();
15929: my $hosthere = $form->{'noloadbalance'};
15930: if (grep(/^\Q$hosthere\E$/,@hosts)) {
15931: $initial_env{"user.noloadbalance"} = $hosthere;
15932: $env{'user.noloadbalance'} = $hosthere;
15933: }
15934: }
15935:
1.1016 raeburn 15936: unless ($domain eq 'public') {
1.1075.2.125 raeburn 15937: my %is_adv = ( is_adv => $env{'user.adv'} );
15938: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980 raeburn 15939:
1.1075.2.125 raeburn 15940: foreach my $tool ('aboutme','blog','webdav','portfolio') {
15941: $userenv{'availabletools.'.$tool} =
15942: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
15943: undef,\%userenv,\%domdef,\%is_adv);
15944: }
1.724 raeburn 15945:
1.1075.2.125 raeburn 15946: foreach my $crstype ('official','unofficial','community','textbook') {
15947: $userenv{'canrequest.'.$crstype} =
15948: &Apache::lonnet::usertools_access($username,$domain,$crstype,
15949: 'reload','requestcourses',
15950: \%userenv,\%domdef,\%is_adv);
15951: }
1.765 raeburn 15952:
1.1075.2.125 raeburn 15953: $userenv{'canrequest.author'} =
15954: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
15955: 'reload','requestauthor',
15956: \%userenv,\%domdef,\%is_adv);
15957: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
15958: $domain,$username);
15959: my $reqstatus = $reqauthor{'author_status'};
15960: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
15961: if (ref($reqauthor{'author'}) eq 'HASH') {
15962: $userenv{'requestauthorqueued'} = $reqstatus.':'.
15963: $reqauthor{'author'}{'timestamp'};
15964: }
1.1075.2.14 raeburn 15965: }
15966: }
15967:
1.462 albertel 15968: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 15969:
1.462 albertel 15970: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
15971: &GDBM_WRCREAT(),0640)) {
15972: &_add_to_env(\%disk_env,\%initial_env);
15973: &_add_to_env(\%disk_env,\%userenv,'environment.');
15974: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 15975: if (ref($firstaccenv) eq 'HASH') {
15976: &_add_to_env(\%disk_env,$firstaccenv);
15977: }
15978: if (ref($timerintenv) eq 'HASH') {
15979: &_add_to_env(\%disk_env,$timerintenv);
15980: }
1.463 albertel 15981: if (ref($args->{'extra_env'})) {
15982: &_add_to_env(\%disk_env,$args->{'extra_env'});
15983: }
1.462 albertel 15984: untie(%disk_env);
15985: } else {
1.705 tempelho 15986: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
15987: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 15988: return 'error: '.$!;
15989: }
15990: }
15991: $env{'request.role'}='cm';
15992: $env{'request.role.adv'}=$env{'user.adv'};
15993: $env{'browser.type'}=$clientbrowser;
15994:
15995: return $cookie;
15996:
15997: }
15998:
15999: sub _add_to_env {
16000: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 16001: if (ref($env_data) eq 'HASH') {
16002: while (my ($key,$value) = each(%$env_data)) {
16003: $idf->{$prefix.$key} = $value;
16004: $env{$prefix.$key} = $value;
16005: }
1.462 albertel 16006: }
16007: }
16008:
1.685 tempelho 16009: # --- Get the symbolic name of a problem and the url
16010: sub get_symb {
16011: my ($request,$silent) = @_;
1.726 raeburn 16012: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 16013: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
16014: if ($symb eq '') {
16015: if (!$silent) {
1.1071 raeburn 16016: if (ref($request)) {
16017: $request->print("Unable to handle ambiguous references:$url:.");
16018: }
1.685 tempelho 16019: return ();
16020: }
16021: }
16022: &Apache::lonenc::check_decrypt(\$symb);
16023: return ($symb);
16024: }
16025:
16026: # --------------------------------------------------------------Get annotation
16027:
16028: sub get_annotation {
16029: my ($symb,$enc) = @_;
16030:
16031: my $key = $symb;
16032: if (!$enc) {
16033: $key =
16034: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
16035: }
16036: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
16037: return $annotation{$key};
16038: }
16039:
16040: sub clean_symb {
1.731 raeburn 16041: my ($symb,$delete_enc) = @_;
1.685 tempelho 16042:
16043: &Apache::lonenc::check_decrypt(\$symb);
16044: my $enc = $env{'request.enc'};
1.731 raeburn 16045: if ($delete_enc) {
1.730 raeburn 16046: delete($env{'request.enc'});
16047: }
1.685 tempelho 16048:
16049: return ($symb,$enc);
16050: }
1.462 albertel 16051:
1.1075.2.69 raeburn 16052: ############################################################
16053: ############################################################
16054:
16055: =pod
16056:
16057: =head1 Routines for building display used to search for courses
16058:
16059:
16060: =over 4
16061:
16062: =item * &build_filters()
16063:
16064: Create markup for a table used to set filters to use when selecting
16065: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
16066: and quotacheck.pl
16067:
16068:
16069: Inputs:
16070:
16071: filterlist - anonymous array of fields to include as potential filters
16072:
16073: crstype - course type
16074:
16075: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
16076: to pop-open a course selector (will contain "extra element").
16077:
16078: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
16079:
16080: filter - anonymous hash of criteria and their values
16081:
16082: action - form action
16083:
16084: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
16085:
16086: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
16087:
16088: cloneruname - username of owner of new course who wants to clone
16089:
16090: clonerudom - domain of owner of new course who wants to clone
16091:
16092: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
16093:
16094: codetitlesref - reference to array of titles of components in institutional codes (official courses)
16095:
16096: codedom - domain
16097:
16098: formname - value of form element named "form".
16099:
16100: fixeddom - domain, if fixed.
16101:
16102: prevphase - value to assign to form element named "phase" when going back to the previous screen
16103:
16104: cnameelement - name of form element in form on opener page which will receive title of selected course
16105:
16106: cnumelement - name of form element in form on opener page which will receive courseID of selected course
16107:
16108: cdomelement - name of form element in form on opener page which will receive domain of selected course
16109:
16110: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
16111:
16112: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
16113:
16114: clonewarning - warning message about missing information for intended course owner when DC creates a course
16115:
16116:
16117: Returns: $output - HTML for display of search criteria, and hidden form elements.
16118:
16119:
16120: Side Effects: None
16121:
16122: =cut
16123:
16124: # ---------------------------------------------- search for courses based on last activity etc.
16125:
16126: sub build_filters {
16127: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
16128: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
16129: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
16130: $cnameelement,$cnumelement,$cdomelement,$setroles,
16131: $clonetext,$clonewarning) = @_;
16132: my ($list,$jscript);
16133: my $onchange = 'javascript:updateFilters(this)';
16134: my ($domainselectform,$sincefilterform,$createdfilterform,
16135: $ownerdomselectform,$persondomselectform,$instcodeform,
16136: $typeselectform,$instcodetitle);
16137: if ($formname eq '') {
16138: $formname = $caller;
16139: }
16140: foreach my $item (@{$filterlist}) {
16141: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
16142: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
16143: if ($item eq 'domainfilter') {
16144: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
16145: } elsif ($item eq 'coursefilter') {
16146: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
16147: } elsif ($item eq 'ownerfilter') {
16148: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16149: } elsif ($item eq 'ownerdomfilter') {
16150: $filter->{'ownerdomfilter'} =
16151: &LONCAPA::clean_domain($filter->{$item});
16152: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
16153: 'ownerdomfilter',1);
16154: } elsif ($item eq 'personfilter') {
16155: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16156: } elsif ($item eq 'persondomfilter') {
16157: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
16158: 'persondomfilter',1);
16159: } else {
16160: $filter->{$item} =~ s/\W//g;
16161: }
16162: if (!$filter->{$item}) {
16163: $filter->{$item} = '';
16164: }
16165: }
16166: if ($item eq 'domainfilter') {
16167: my $allow_blank = 1;
16168: if ($formname eq 'portform') {
16169: $allow_blank=0;
16170: } elsif ($formname eq 'studentform') {
16171: $allow_blank=0;
16172: }
16173: if ($fixeddom) {
16174: $domainselectform = '<input type="hidden" name="domainfilter"'.
16175: ' value="'.$codedom.'" />'.
16176: &Apache::lonnet::domain($codedom,'description');
16177: } else {
16178: $domainselectform = &select_dom_form($filter->{$item},
16179: 'domainfilter',
16180: $allow_blank,'',$onchange);
16181: }
16182: } else {
16183: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
16184: }
16185: }
16186:
16187: # last course activity filter and selection
16188: $sincefilterform = &timebased_select_form('sincefilter',$filter);
16189:
16190: # course created filter and selection
16191: if (exists($filter->{'createdfilter'})) {
16192: $createdfilterform = &timebased_select_form('createdfilter',$filter);
16193: }
16194:
16195: my %lt = &Apache::lonlocal::texthash(
16196: 'cac' => "$crstype Activity",
16197: 'ccr' => "$crstype Created",
16198: 'cde' => "$crstype Title",
16199: 'cdo' => "$crstype Domain",
16200: 'ins' => 'Institutional Code',
16201: 'inc' => 'Institutional Categorization',
16202: 'cow' => "$crstype Owner/Co-owner",
16203: 'cop' => "$crstype Personnel Includes",
16204: 'cog' => 'Type',
16205: );
16206:
16207: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
16208: my $typeval = 'Course';
16209: if ($crstype eq 'Community') {
16210: $typeval = 'Community';
16211: }
16212: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
16213: } else {
16214: $typeselectform = '<select name="type" size="1"';
16215: if ($onchange) {
16216: $typeselectform .= ' onchange="'.$onchange.'"';
16217: }
16218: $typeselectform .= '>'."\n";
16219: foreach my $posstype ('Course','Community') {
16220: $typeselectform.='<option value="'.$posstype.'"'.
16221: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
16222: }
16223: $typeselectform.="</select>";
16224: }
16225:
16226: my ($cloneableonlyform,$cloneabletitle);
16227: if (exists($filter->{'cloneableonly'})) {
16228: my $cloneableon = '';
16229: my $cloneableoff = ' checked="checked"';
16230: if ($filter->{'cloneableonly'}) {
16231: $cloneableon = $cloneableoff;
16232: $cloneableoff = '';
16233: }
16234: $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/> '.&mt('Required').'</label>'.(' 'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' /> '.&mt('No restriction').'</label></span>';
16235: if ($formname eq 'ccrs') {
1.1075.2.71 raeburn 16236: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69 raeburn 16237: } else {
16238: $cloneabletitle = &mt('Cloneable by you');
16239: }
16240: }
16241: my $officialjs;
16242: if ($crstype eq 'Course') {
16243: if (exists($filter->{'instcodefilter'})) {
16244: # if (($fixeddom) || ($formname eq 'requestcrs') ||
16245: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
16246: if ($codedom) {
16247: $officialjs = 1;
16248: ($instcodeform,$jscript,$$numtitlesref) =
16249: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
16250: $officialjs,$codetitlesref);
16251: if ($jscript) {
16252: $jscript = '<script type="text/javascript">'."\n".
16253: '// <![CDATA['."\n".
16254: $jscript."\n".
16255: '// ]]>'."\n".
16256: '</script>'."\n";
16257: }
16258: }
16259: if ($instcodeform eq '') {
16260: $instcodeform =
16261: '<input type="text" name="instcodefilter" size="10" value="'.
16262: $list->{'instcodefilter'}.'" />';
16263: $instcodetitle = $lt{'ins'};
16264: } else {
16265: $instcodetitle = $lt{'inc'};
16266: }
16267: if ($fixeddom) {
16268: $instcodetitle .= '<br />('.$codedom.')';
16269: }
16270: }
16271: }
16272: my $output = qq|
16273: <form method="post" name="filterpicker" action="$action">
16274: <input type="hidden" name="form" value="$formname" />
16275: |;
16276: if ($formname eq 'modifycourse') {
16277: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
16278: '<input type="hidden" name="prevphase" value="'.
16279: $prevphase.'" />'."\n";
1.1075.2.82 raeburn 16280: } elsif ($formname eq 'quotacheck') {
16281: $output .= qq|
16282: <input type="hidden" name="sortby" value="" />
16283: <input type="hidden" name="sortorder" value="" />
16284: |;
16285: } else {
1.1075.2.69 raeburn 16286: my $name_input;
16287: if ($cnameelement ne '') {
16288: $name_input = '<input type="hidden" name="cnameelement" value="'.
16289: $cnameelement.'" />';
16290: }
16291: $output .= qq|
16292: <input type="hidden" name="cnumelement" value="$cnumelement" />
16293: <input type="hidden" name="cdomelement" value="$cdomelement" />
16294: $name_input
16295: $roleelement
16296: $multelement
16297: $typeelement
16298: |;
16299: if ($formname eq 'portform') {
16300: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
16301: }
16302: }
16303: if ($fixeddom) {
16304: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
16305: }
16306: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
16307: if ($sincefilterform) {
16308: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
16309: .$sincefilterform
16310: .&Apache::lonhtmlcommon::row_closure();
16311: }
16312: if ($createdfilterform) {
16313: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
16314: .$createdfilterform
16315: .&Apache::lonhtmlcommon::row_closure();
16316: }
16317: if ($domainselectform) {
16318: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
16319: .$domainselectform
16320: .&Apache::lonhtmlcommon::row_closure();
16321: }
16322: if ($typeselectform) {
16323: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
16324: $output .= $typeselectform;
16325: } else {
16326: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
16327: .$typeselectform
16328: .&Apache::lonhtmlcommon::row_closure();
16329: }
16330: }
16331: if ($instcodeform) {
16332: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
16333: .$instcodeform
16334: .&Apache::lonhtmlcommon::row_closure();
16335: }
16336: if (exists($filter->{'ownerfilter'})) {
16337: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
16338: '<table><tr><td>'.&mt('Username').'<br />'.
16339: '<input type="text" name="ownerfilter" size="20" value="'.
16340: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
16341: $ownerdomselectform.'</td></tr></table>'.
16342: &Apache::lonhtmlcommon::row_closure();
16343: }
16344: if (exists($filter->{'personfilter'})) {
16345: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
16346: '<table><tr><td>'.&mt('Username').'<br />'.
16347: '<input type="text" name="personfilter" size="20" value="'.
16348: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
16349: $persondomselectform.'</td></tr></table>'.
16350: &Apache::lonhtmlcommon::row_closure();
16351: }
16352: if (exists($filter->{'coursefilter'})) {
16353: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
16354: .'<input type="text" name="coursefilter" size="25" value="'
16355: .$list->{'coursefilter'}.'" />'
16356: .&Apache::lonhtmlcommon::row_closure();
16357: }
16358: if ($cloneableonlyform) {
16359: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
16360: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
16361: }
16362: if (exists($filter->{'descriptfilter'})) {
16363: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
16364: .'<input type="text" name="descriptfilter" size="40" value="'
16365: .$list->{'descriptfilter'}.'" />'
16366: .&Apache::lonhtmlcommon::row_closure(1);
16367: }
16368: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
16369: '<input type="hidden" name="updater" value="" />'."\n".
16370: '<input type="submit" name="gosearch" value="'.
16371: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
16372: return $jscript.$clonewarning.$output;
16373: }
16374:
16375: =pod
16376:
16377: =item * &timebased_select_form()
16378:
16379: Create markup for a dropdown list used to select a time-based
16380: filter e.g., Course Activity, Course Created, when searching for courses
16381: or communities
16382:
16383: Inputs:
16384:
16385: item - name of form element (sincefilter or createdfilter)
16386:
16387: filter - anonymous hash of criteria and their values
16388:
16389: Returns: HTML for a select box contained a blank, then six time selections,
16390: with value set in incoming form variables currently selected.
16391:
16392: Side Effects: None
16393:
16394: =cut
16395:
16396: sub timebased_select_form {
16397: my ($item,$filter) = @_;
16398: if (ref($filter) eq 'HASH') {
16399: $filter->{$item} =~ s/[^\d-]//g;
16400: if (!$filter->{$item}) { $filter->{$item}=-1; }
16401: return &select_form(
16402: $filter->{$item},
16403: $item,
16404: { '-1' => '',
16405: '86400' => &mt('today'),
16406: '604800' => &mt('last week'),
16407: '2592000' => &mt('last month'),
16408: '7776000' => &mt('last three months'),
16409: '15552000' => &mt('last six months'),
16410: '31104000' => &mt('last year'),
16411: 'select_form_order' =>
16412: ['-1','86400','604800','2592000','7776000',
16413: '15552000','31104000']});
16414: }
16415: }
16416:
16417: =pod
16418:
16419: =item * &js_changer()
16420:
16421: Create script tag containing Javascript used to submit course search form
16422: when course type or domain is changed, and also to hide 'Searching ...' on
16423: page load completion for page showing search result.
16424:
16425: Inputs: None
16426:
16427: Returns: markup containing updateFilters() and hideSearching() javascript functions.
16428:
16429: Side Effects: None
16430:
16431: =cut
16432:
16433: sub js_changer {
16434: return <<ENDJS;
16435: <script type="text/javascript">
16436: // <![CDATA[
16437: function updateFilters(caller) {
16438: if (typeof(caller) != "undefined") {
16439: document.filterpicker.updater.value = caller.name;
16440: }
16441: document.filterpicker.submit();
16442: }
16443:
16444: function hideSearching() {
16445: if (document.getElementById('searching')) {
16446: document.getElementById('searching').style.display = 'none';
16447: }
16448: return;
16449: }
16450:
16451: // ]]>
16452: </script>
16453:
16454: ENDJS
16455: }
16456:
16457: =pod
16458:
16459: =item * &search_courses()
16460:
16461: Process selected filters form course search form and pass to lonnet::courseiddump
16462: to retrieve a hash for which keys are courseIDs which match the selected filters.
16463:
16464: Inputs:
16465:
16466: dom - domain being searched
16467:
16468: type - course type ('Course' or 'Community' or '.' if any).
16469:
16470: filter - anonymous hash of criteria and their values
16471:
16472: numtitles - for institutional codes - number of categories
16473:
16474: cloneruname - optional username of new course owner
16475:
16476: clonerudom - optional domain of new course owner
16477:
1.1075.2.95 raeburn 16478: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69 raeburn 16479: (used when DC is using course creation form)
16480:
16481: codetitles - reference to array of titles of components in institutional codes (official courses).
16482:
1.1075.2.95 raeburn 16483: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
16484: (and so can clone automatically)
16485:
16486: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
16487:
16488: reqinstcode - institutional code of new course, where search_courses is used to identify potential
16489: courses to clone
1.1075.2.69 raeburn 16490:
16491: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
16492:
16493:
16494: Side Effects: None
16495:
16496: =cut
16497:
16498:
16499: sub search_courses {
1.1075.2.95 raeburn 16500: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
16501: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69 raeburn 16502: my (%courses,%showcourses,$cloner);
16503: if (($filter->{'ownerfilter'} ne '') ||
16504: ($filter->{'ownerdomfilter'} ne '')) {
16505: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
16506: $filter->{'ownerdomfilter'};
16507: }
16508: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
16509: if (!$filter->{$item}) {
16510: $filter->{$item}='.';
16511: }
16512: }
16513: my $now = time;
16514: my $timefilter =
16515: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
16516: my ($createdbefore,$createdafter);
16517: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
16518: $createdbefore = $now;
16519: $createdafter = $now-$filter->{'createdfilter'};
16520: }
16521: my ($instcodefilter,$regexpok);
16522: if ($numtitles) {
16523: if ($env{'form.official'} eq 'on') {
16524: $instcodefilter =
16525: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
16526: $regexpok = 1;
16527: } elsif ($env{'form.official'} eq 'off') {
16528: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
16529: unless ($instcodefilter eq '') {
16530: $regexpok = -1;
16531: }
16532: }
16533: } else {
16534: $instcodefilter = $filter->{'instcodefilter'};
16535: }
16536: if ($instcodefilter eq '') { $instcodefilter = '.'; }
16537: if ($type eq '') { $type = '.'; }
16538:
16539: if (($clonerudom ne '') && ($cloneruname ne '')) {
16540: $cloner = $cloneruname.':'.$clonerudom;
16541: }
16542: %courses = &Apache::lonnet::courseiddump($dom,
16543: $filter->{'descriptfilter'},
16544: $timefilter,
16545: $instcodefilter,
16546: $filter->{'combownerfilter'},
16547: $filter->{'coursefilter'},
16548: undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95 raeburn 16549: undef,undef,$cloner,$cc_clone,
1.1075.2.69 raeburn 16550: $filter->{'cloneableonly'},
16551: $createdbefore,$createdafter,undef,
1.1075.2.95 raeburn 16552: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69 raeburn 16553: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
16554: my $ccrole;
16555: if ($type eq 'Community') {
16556: $ccrole = 'co';
16557: } else {
16558: $ccrole = 'cc';
16559: }
16560: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
16561: $filter->{'persondomfilter'},
16562: 'userroles',undef,
16563: [$ccrole,'in','ad','ep','ta','cr'],
16564: $dom);
16565: foreach my $role (keys(%rolehash)) {
16566: my ($cnum,$cdom,$courserole) = split(':',$role);
16567: my $cid = $cdom.'_'.$cnum;
16568: if (exists($courses{$cid})) {
16569: if (ref($courses{$cid}) eq 'HASH') {
16570: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
16571: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119 raeburn 16572: push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69 raeburn 16573: }
16574: } else {
16575: $courses{$cid}{roles} = [$courserole];
16576: }
16577: $showcourses{$cid} = $courses{$cid};
16578: }
16579: }
16580: }
16581: %courses = %showcourses;
16582: }
16583: return %courses;
16584: }
16585:
16586: =pod
16587:
16588: =back
16589:
1.1075.2.88 raeburn 16590: =head1 Routines for version requirements for current course.
16591:
16592: =over 4
16593:
16594: =item * &check_release_required()
16595:
16596: Compares required LON-CAPA version with version on server, and
16597: if required version is newer looks for a server with the required version.
16598:
16599: Looks first at servers in user's owen domain; if none suitable, looks at
16600: servers in course's domain are permitted to host sessions for user's domain.
16601:
16602: Inputs:
16603:
16604: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
16605:
16606: $courseid - Course ID of current course
16607:
16608: $rolecode - User's current role in course (for switchserver query string).
16609:
16610: $required - LON-CAPA version needed by course (format: Major.Minor).
16611:
16612:
16613: Returns:
16614:
16615: $switchserver - query string tp append to /adm/switchserver call (if
16616: current server's LON-CAPA version is too old.
16617:
16618: $warning - Message is displayed if no suitable server could be found.
16619:
16620: =cut
16621:
16622: sub check_release_required {
16623: my ($loncaparev,$courseid,$rolecode,$required) = @_;
16624: my ($switchserver,$warning);
16625: if ($required ne '') {
16626: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
16627: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
16628: if ($reqdmajor ne '' && $reqdminor ne '') {
16629: my $otherserver;
16630: if (($major eq '' && $minor eq '') ||
16631: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
16632: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
16633: my $switchlcrev =
16634: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
16635: $userdomserver);
16636: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
16637: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
16638: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
16639: my $cdom = $env{'course.'.$courseid.'.domain'};
16640: if ($cdom ne $env{'user.domain'}) {
16641: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
16642: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
16643: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
16644: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
16645: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
16646: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
16647: my $canhost =
16648: &Apache::lonnet::can_host_session($env{'user.domain'},
16649: $coursedomserver,
16650: $remoterev,
16651: $udomdefaults{'remotesessions'},
16652: $defdomdefaults{'hostedsessions'});
16653:
16654: if ($canhost) {
16655: $otherserver = $coursedomserver;
16656: } else {
16657: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
16658: }
16659: } else {
16660: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
16661: }
16662: } else {
16663: $otherserver = $userdomserver;
16664: }
16665: }
16666: if ($otherserver ne '') {
16667: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
16668: }
16669: }
16670: }
16671: return ($switchserver,$warning);
16672: }
16673:
16674: =pod
16675:
16676: =item * &check_release_result()
16677:
16678: Inputs:
16679:
16680: $switchwarning - Warning message if no suitable server found to host session.
16681:
16682: $switchserver - query string to append to /adm/switchserver containing lonHostID
16683: and current role.
16684:
16685: Returns: HTML to display with information about requirement to switch server.
16686: Either displaying warning with link to Roles/Courses screen or
16687: display link to switchserver.
16688:
1.1075.2.69 raeburn 16689: =cut
16690:
1.1075.2.88 raeburn 16691: sub check_release_result {
16692: my ($switchwarning,$switchserver) = @_;
16693: my $output = &start_page('Selected course unavailable on this server').
16694: '<p class="LC_warning">';
16695: if ($switchwarning) {
16696: $output .= $switchwarning.'<br /><a href="/adm/roles">';
16697: if (&show_course()) {
16698: $output .= &mt('Display courses');
16699: } else {
16700: $output .= &mt('Display roles');
16701: }
16702: $output .= '</a>';
16703: } elsif ($switchserver) {
16704: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
16705: '<br />'.
16706: '<a href="/adm/switchserver?'.$switchserver.'">'.
16707: &mt('Switch Server').
16708: '</a>';
16709: }
16710: $output .= '</p>'.&end_page();
16711: return $output;
16712: }
16713:
16714: =pod
16715:
16716: =item * &needs_coursereinit()
16717:
16718: Determine if course contents stored for user's session needs to be
16719: refreshed, because content has changed since "Big Hash" last tied.
16720:
16721: Check for change is made if time last checked is more than 10 minutes ago
16722: (by default).
16723:
16724: Inputs:
16725:
16726: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
16727:
16728: $interval (optional) - Time which may elapse (in s) between last check for content
16729: change in current course. (default: 600 s).
16730:
16731: Returns: an array; first element is:
16732:
16733: =over 4
16734:
16735: 'switch' - if content updates mean user's session
16736: needs to be switched to a server running a newer LON-CAPA version
16737:
16738: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
16739: on current server hosting user's session
16740:
16741: '' - if no action required.
16742:
16743: =back
16744:
16745: If first item element is 'switch':
16746:
16747: second item is $switchwarning - Warning message if no suitable server found to host session.
16748:
16749: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
16750: and current role.
16751:
16752: otherwise: no other elements returned.
16753:
16754: =back
16755:
16756: =cut
16757:
16758: sub needs_coursereinit {
16759: my ($loncaparev,$interval) = @_;
16760: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
16761: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
16762: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
16763: my $now = time;
16764: if ($interval eq '') {
16765: $interval = 600;
16766: }
16767: if (($now-$env{'request.course.timechecked'})>$interval) {
16768: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
16769: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
16770: if ($lastchange > $env{'request.course.tied'}) {
16771: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
16772: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
16773: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
16774: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
16775: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
16776: $curr_reqd_hash{'internal.releaserequired'}});
16777: my ($switchserver,$switchwarning) =
16778: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
16779: $curr_reqd_hash{'internal.releaserequired'});
16780: if ($switchwarning ne '' || $switchserver ne '') {
16781: return ('switch',$switchwarning,$switchserver);
16782: }
16783: }
16784: }
16785: return ('update');
16786: }
16787: }
16788: return ();
16789: }
1.1075.2.69 raeburn 16790:
1.1075.2.11 raeburn 16791: sub update_content_constraints {
16792: my ($cdom,$cnum,$chome,$cid) = @_;
16793: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
16794: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
16795: my %checkresponsetypes;
16796: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
16797: my ($item,$name,$value) = split(/:/,$key);
16798: if ($item eq 'resourcetag') {
16799: if ($name eq 'responsetype') {
16800: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
16801: }
16802: }
16803: }
16804: my $navmap = Apache::lonnavmaps::navmap->new();
16805: if (defined($navmap)) {
16806: my %allresponses;
16807: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
16808: my %responses = $res->responseTypes();
16809: foreach my $key (keys(%responses)) {
16810: next unless(exists($checkresponsetypes{$key}));
16811: $allresponses{$key} += $responses{$key};
16812: }
16813: }
16814: foreach my $key (keys(%allresponses)) {
16815: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
16816: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
16817: ($reqdmajor,$reqdminor) = ($major,$minor);
16818: }
16819: }
16820: undef($navmap);
16821: }
16822: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
16823: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
16824: }
16825: return;
16826: }
16827:
1.1075.2.27 raeburn 16828: sub allmaps_incourse {
16829: my ($cdom,$cnum,$chome,$cid) = @_;
16830: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
16831: $cid = $env{'request.course.id'};
16832: $cdom = $env{'course.'.$cid.'.domain'};
16833: $cnum = $env{'course.'.$cid.'.num'};
16834: $chome = $env{'course.'.$cid.'.home'};
16835: }
16836: my %allmaps = ();
16837: my $lastchange =
16838: &Apache::lonnet::get_coursechange($cdom,$cnum);
16839: if ($lastchange > $env{'request.course.tied'}) {
16840: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
16841: unless ($ferr) {
16842: &update_content_constraints($cdom,$cnum,$chome,$cid);
16843: }
16844: }
16845: my $navmap = Apache::lonnavmaps::navmap->new();
16846: if (defined($navmap)) {
16847: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
16848: $allmaps{$res->src()} = 1;
16849: }
16850: }
16851: return \%allmaps;
16852: }
16853:
1.1075.2.11 raeburn 16854: sub parse_supplemental_title {
16855: my ($title) = @_;
16856:
16857: my ($foldertitle,$renametitle);
16858: if ($title =~ /&&&/) {
16859: $title = &HTML::Entites::decode($title);
16860: }
16861: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
16862: $renametitle=$4;
16863: my ($time,$uname,$udom) = ($1,$2,$3);
16864: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
16865: my $name = &plainname($uname,$udom);
16866: $name = &HTML::Entities::encode($name,'"<>&\'');
16867: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
16868: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
16869: $name.': <br />'.$foldertitle;
16870: }
16871: if (wantarray) {
16872: return ($title,$foldertitle,$renametitle);
16873: }
16874: return $title;
16875: }
16876:
1.1075.2.43 raeburn 16877: sub recurse_supplemental {
16878: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
16879: if ($suppmap) {
16880: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
16881: if ($fatal) {
16882: $errors ++;
16883: } else {
16884: if ($#LONCAPA::map::resources > 0) {
16885: foreach my $res (@LONCAPA::map::resources) {
16886: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
16887: if (($src ne '') && ($status eq 'res')) {
1.1075.2.46 raeburn 16888: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
16889: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43 raeburn 16890: } else {
16891: $numfiles ++;
16892: }
16893: }
16894: }
16895: }
16896: }
16897: }
16898: return ($numfiles,$errors);
16899: }
16900:
1.1075.2.18 raeburn 16901: sub symb_to_docspath {
1.1075.2.119 raeburn 16902: my ($symb,$navmapref) = @_;
16903: return unless ($symb && ref($navmapref));
1.1075.2.18 raeburn 16904: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
16905: if ($resurl=~/\.(sequence|page)$/) {
16906: $mapurl=$resurl;
16907: } elsif ($resurl eq 'adm/navmaps') {
16908: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
16909: }
16910: my $mapresobj;
1.1075.2.119 raeburn 16911: unless (ref($$navmapref)) {
16912: $$navmapref = Apache::lonnavmaps::navmap->new();
16913: }
16914: if (ref($$navmapref)) {
16915: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18 raeburn 16916: }
16917: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
16918: my $type=$2;
16919: my $path;
16920: if (ref($mapresobj)) {
16921: my $pcslist = $mapresobj->map_hierarchy();
16922: if ($pcslist ne '') {
16923: foreach my $pc (split(/,/,$pcslist)) {
16924: next if ($pc <= 1);
1.1075.2.119 raeburn 16925: my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18 raeburn 16926: if (ref($res)) {
16927: my $thisurl = $res->src();
16928: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
16929: my $thistitle = $res->title();
16930: $path .= '&'.
16931: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46 raeburn 16932: &escape($thistitle).
1.1075.2.18 raeburn 16933: ':'.$res->randompick().
16934: ':'.$res->randomout().
16935: ':'.$res->encrypted().
16936: ':'.$res->randomorder().
16937: ':'.$res->is_page();
16938: }
16939: }
16940: }
16941: $path =~ s/^\&//;
16942: my $maptitle = $mapresobj->title();
16943: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 16944: $maptitle = 'Main Content';
1.1075.2.18 raeburn 16945: }
16946: $path .= (($path ne '')? '&' : '').
16947: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 16948: &escape($maptitle).
1.1075.2.18 raeburn 16949: ':'.$mapresobj->randompick().
16950: ':'.$mapresobj->randomout().
16951: ':'.$mapresobj->encrypted().
16952: ':'.$mapresobj->randomorder().
16953: ':'.$mapresobj->is_page();
16954: } else {
16955: my $maptitle = &Apache::lonnet::gettitle($mapurl);
16956: my $ispage = (($type eq 'page')? 1 : '');
16957: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 16958: $maptitle = 'Main Content';
1.1075.2.18 raeburn 16959: }
16960: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 16961: &escape($maptitle).':::::'.$ispage;
1.1075.2.18 raeburn 16962: }
16963: unless ($mapurl eq 'default') {
16964: $path = 'default&'.
1.1075.2.46 raeburn 16965: &escape('Main Content').
1.1075.2.18 raeburn 16966: ':::::&'.$path;
16967: }
16968: return $path;
16969: }
16970:
1.1075.2.14 raeburn 16971: sub captcha_display {
1.1075.2.137 raeburn 16972: my ($context,$lonhost,$defdom) = @_;
1.1075.2.14 raeburn 16973: my ($output,$error);
1.1075.2.107 raeburn 16974: my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137 raeburn 16975: &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14 raeburn 16976: if ($captcha eq 'original') {
16977: $output = &create_captcha();
16978: unless ($output) {
16979: $error = 'captcha';
16980: }
16981: } elsif ($captcha eq 'recaptcha') {
1.1075.2.107 raeburn 16982: $output = &create_recaptcha($pubkey,$version);
1.1075.2.14 raeburn 16983: unless ($output) {
16984: $error = 'recaptcha';
16985: }
16986: }
1.1075.2.107 raeburn 16987: return ($output,$error,$captcha,$version);
1.1075.2.14 raeburn 16988: }
16989:
16990: sub captcha_response {
1.1075.2.137 raeburn 16991: my ($context,$lonhost,$defdom) = @_;
1.1075.2.14 raeburn 16992: my ($captcha_chk,$captcha_error);
1.1075.2.137 raeburn 16993: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14 raeburn 16994: if ($captcha eq 'original') {
16995: ($captcha_chk,$captcha_error) = &check_captcha();
16996: } elsif ($captcha eq 'recaptcha') {
1.1075.2.107 raeburn 16997: $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14 raeburn 16998: } else {
16999: $captcha_chk = 1;
17000: }
17001: return ($captcha_chk,$captcha_error);
17002: }
17003:
17004: sub get_captcha_config {
1.1075.2.137 raeburn 17005: my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107 raeburn 17006: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14 raeburn 17007: my $hostname = &Apache::lonnet::hostname($lonhost);
17008: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
17009: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17010: if ($context eq 'usercreation') {
17011: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
17012: if (ref($domconfig{$context}) eq 'HASH') {
17013: $hashtocheck = $domconfig{$context}{'cancreate'};
17014: if (ref($hashtocheck) eq 'HASH') {
17015: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
17016: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
17017: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
17018: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
17019: }
17020: if ($privkey && $pubkey) {
17021: $captcha = 'recaptcha';
1.1075.2.107 raeburn 17022: $version = $hashtocheck->{'recaptchaversion'};
17023: if ($version ne '2') {
17024: $version = 1;
17025: }
1.1075.2.14 raeburn 17026: } else {
17027: $captcha = 'original';
17028: }
17029: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
17030: $captcha = 'original';
17031: }
17032: }
17033: } else {
17034: $captcha = 'captcha';
17035: }
17036: } elsif ($context eq 'login') {
17037: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
17038: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
17039: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
17040: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
17041: if ($privkey && $pubkey) {
17042: $captcha = 'recaptcha';
1.1075.2.107 raeburn 17043: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
17044: if ($version ne '2') {
17045: $version = 1;
17046: }
1.1075.2.14 raeburn 17047: } else {
17048: $captcha = 'original';
17049: }
17050: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
17051: $captcha = 'original';
17052: }
1.1075.2.137 raeburn 17053: } elsif ($context eq 'passwords') {
17054: if ($dom_in_effect) {
17055: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
17056: if ($passwdconf{'captcha'} eq 'recaptcha') {
17057: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
17058: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
17059: $privkey = $passwdconf{'recaptchakeys'}{'private'};
17060: }
17061: if ($privkey && $pubkey) {
17062: $captcha = 'recaptcha';
17063: $version = $passwdconf{'recaptchaversion'};
17064: if ($version ne '2') {
17065: $version = 1;
17066: }
17067: } else {
17068: $captcha = 'original';
17069: }
17070: } elsif ($passwdconf{'captcha'} ne 'notused') {
17071: $captcha = 'original';
17072: }
17073: }
1.1075.2.14 raeburn 17074: }
1.1075.2.107 raeburn 17075: return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14 raeburn 17076: }
17077:
17078: sub create_captcha {
17079: my %captcha_params = &captcha_settings();
17080: my ($output,$maxtries,$tries) = ('',10,0);
17081: while ($tries < $maxtries) {
17082: $tries ++;
17083: my $captcha = Authen::Captcha->new (
17084: output_folder => $captcha_params{'output_dir'},
17085: data_folder => $captcha_params{'db_dir'},
17086: );
17087: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
17088:
17089: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
17090: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
17091: &mt('Type in the letters/numbers shown below').' '.
1.1075.2.66 raeburn 17092: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
17093: '<br />'.
17094: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14 raeburn 17095: last;
17096: }
17097: }
17098: return $output;
17099: }
17100:
17101: sub captcha_settings {
17102: my %captcha_params = (
17103: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
17104: www_output_dir => "/captchaspool",
17105: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
17106: numchars => '5',
17107: );
17108: return %captcha_params;
17109: }
17110:
17111: sub check_captcha {
17112: my ($captcha_chk,$captcha_error);
17113: my $code = $env{'form.code'};
17114: my $md5sum = $env{'form.crypt'};
17115: my %captcha_params = &captcha_settings();
17116: my $captcha = Authen::Captcha->new(
17117: output_folder => $captcha_params{'output_dir'},
17118: data_folder => $captcha_params{'db_dir'},
17119: );
1.1075.2.26 raeburn 17120: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14 raeburn 17121: my %captcha_hash = (
17122: 0 => 'Code not checked (file error)',
17123: -1 => 'Failed: code expired',
17124: -2 => 'Failed: invalid code (not in database)',
17125: -3 => 'Failed: invalid code (code does not match crypt)',
17126: );
17127: if ($captcha_chk != 1) {
17128: $captcha_error = $captcha_hash{$captcha_chk}
17129: }
17130: return ($captcha_chk,$captcha_error);
17131: }
17132:
17133: sub create_recaptcha {
1.1075.2.107 raeburn 17134: my ($pubkey,$version) = @_;
17135: if ($version >= 2) {
17136: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
17137: } else {
17138: my $use_ssl;
17139: if ($ENV{'SERVER_PORT'} == 443) {
17140: $use_ssl = 1;
17141: }
17142: my $captcha = Captcha::reCAPTCHA->new;
17143: return $captcha->get_options_setter({theme => 'white'})."\n".
17144: $captcha->get_html($pubkey,undef,$use_ssl).
17145: &mt('If the text is hard to read, [_1] will replace them.',
17146: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
17147: '<br /><br />';
17148: }
1.1075.2.14 raeburn 17149: }
17150:
17151: sub check_recaptcha {
1.1075.2.107 raeburn 17152: my ($privkey,$version) = @_;
1.1075.2.14 raeburn 17153: my $captcha_chk;
1.1075.2.150! raeburn 17154: my $ip = &Apache::lonnet::get_requestor_ip();
1.1075.2.107 raeburn 17155: if ($version >= 2) {
17156: my $ua = LWP::UserAgent->new;
17157: $ua->timeout(10);
17158: my %info = (
17159: secret => $privkey,
17160: response => $env{'form.g-recaptcha-response'},
1.1075.2.150! raeburn 17161: remoteip => $ip,
1.1075.2.107 raeburn 17162: );
17163: my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
17164: if ($response->is_success) {
17165: my $data = JSON::DWIW->from_json($response->decoded_content);
17166: if (ref($data) eq 'HASH') {
17167: if ($data->{'success'}) {
17168: $captcha_chk = 1;
17169: }
17170: }
17171: }
17172: } else {
17173: my $captcha = Captcha::reCAPTCHA->new;
17174: my $captcha_result =
17175: $captcha->check_answer(
17176: $privkey,
1.1075.2.150! raeburn 17177: $ip,
1.1075.2.107 raeburn 17178: $env{'form.recaptcha_challenge_field'},
17179: $env{'form.recaptcha_response_field'},
17180: );
17181: if ($captcha_result->{is_valid}) {
17182: $captcha_chk = 1;
17183: }
1.1075.2.14 raeburn 17184: }
17185: return $captcha_chk;
17186: }
17187:
1.1075.2.64 raeburn 17188: sub emailusername_info {
1.1075.2.103 raeburn 17189: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64 raeburn 17190: my %titles = &Apache::lonlocal::texthash (
17191: lastname => 'Last Name',
17192: firstname => 'First Name',
17193: institution => 'School/college/university',
17194: location => "School's city, state/province, country",
17195: web => "School's web address",
17196: officialemail => 'E-mail address at institution (if different)',
1.1075.2.103 raeburn 17197: id => 'Student/Employee ID',
1.1075.2.64 raeburn 17198: );
17199: return (\@fields,\%titles);
17200: }
17201:
1.1075.2.56 raeburn 17202: sub cleanup_html {
17203: my ($incoming) = @_;
17204: my $outgoing;
17205: if ($incoming ne '') {
17206: $outgoing = $incoming;
17207: $outgoing =~ s/;/;/g;
17208: $outgoing =~ s/\#/#/g;
17209: $outgoing =~ s/\&/&/g;
17210: $outgoing =~ s/</</g;
17211: $outgoing =~ s/>/>/g;
17212: $outgoing =~ s/\(/(/g;
17213: $outgoing =~ s/\)/)/g;
17214: $outgoing =~ s/"/"/g;
17215: $outgoing =~ s/'/'/g;
17216: $outgoing =~ s/\$/$/g;
17217: $outgoing =~ s{/}{/}g;
17218: $outgoing =~ s/=/=/g;
17219: $outgoing =~ s/\\/\/g
17220: }
17221: return $outgoing;
17222: }
17223:
1.1075.2.74 raeburn 17224: # Checks for critical messages and returns a redirect url if one exists.
17225: # $interval indicates how often to check for messages.
17226: sub critical_redirect {
17227: my ($interval) = @_;
17228: if ((time-$env{'user.criticalcheck.time'})>$interval) {
17229: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
17230: $env{'user.name'});
17231: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
17232: my $redirecturl;
17233: if ($what[0]) {
17234: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
17235: $redirecturl='/adm/email?critical=display';
17236: my $url=&Apache::lonnet::absolute_url().$redirecturl;
17237: return (1, $url);
17238: }
17239: }
17240: }
17241: return ();
17242: }
17243:
1.1075.2.64 raeburn 17244: # Use:
17245: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
17246: #
17247: ##################################################
17248: # password associated functions #
17249: ##################################################
17250: sub des_keys {
17251: # Make a new key for DES encryption.
17252: # Each key has two parts which are returned separately.
17253: # Please note: Each key must be passed through the &hex function
17254: # before it is output to the web browser. The hex versions cannot
17255: # be used to decrypt.
17256: my @hexstr=('0','1','2','3','4','5','6','7',
17257: '8','9','a','b','c','d','e','f');
17258: my $lkey='';
17259: for (0..7) {
17260: $lkey.=$hexstr[rand(15)];
17261: }
17262: my $ukey='';
17263: for (0..7) {
17264: $ukey.=$hexstr[rand(15)];
17265: }
17266: return ($lkey,$ukey);
17267: }
17268:
17269: sub des_decrypt {
17270: my ($key,$cyphertext) = @_;
17271: my $keybin=pack("H16",$key);
17272: my $cypher;
17273: if ($Crypt::DES::VERSION>=2.03) {
17274: $cypher=new Crypt::DES $keybin;
17275: } else {
17276: $cypher=new DES $keybin;
17277: }
1.1075.2.106 raeburn 17278: my $plaintext='';
17279: my $cypherlength = length($cyphertext);
17280: my $numchunks = int($cypherlength/32);
17281: for (my $j=0; $j<$numchunks; $j++) {
17282: my $start = $j*32;
17283: my $cypherblock = substr($cyphertext,$start,32);
17284: my $chunk =
17285: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
17286: $chunk .=
17287: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
17288: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
17289: $plaintext .= $chunk;
17290: }
1.1075.2.64 raeburn 17291: return $plaintext;
17292: }
17293:
1.1075.2.135 raeburn 17294: sub is_nonframeable {
17295: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
17296: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
17297: return if (($remprotocol eq '') || ($remhost eq ''));
17298:
17299: $remprotocol = lc($remprotocol);
17300: $remhost = lc($remhost);
17301: my $remport = 80;
17302: if ($remprotocol eq 'https') {
17303: $remport = 443;
17304: }
17305: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
17306: if ($cached) {
17307: unless ($nocache) {
17308: if ($result) {
17309: return 1;
17310: } else {
17311: return 0;
17312: }
17313: }
17314: }
17315: my $uselink;
17316: my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142 raeburn 17317: my $ua = LWP::UserAgent->new;
17318: $ua->timeout(5);
17319: my $response=$ua->request($request);
1.1075.2.135 raeburn 17320: if ($response->is_success()) {
17321: my $secpolicy = lc($response->header('content-security-policy'));
17322: my $xframeop = lc($response->header('x-frame-options'));
17323: $secpolicy =~ s/^\s+|\s+$//g;
17324: $xframeop =~ s/^\s+|\s+$//g;
17325: if (($secpolicy ne '') || ($xframeop ne '')) {
17326: my $remotehost = $remprotocol.'://'.$remhost;
17327: my ($origin,$protocol,$port);
17328: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
17329: $port = $ENV{'SERVER_PORT'};
17330: } else {
17331: $port = 80;
17332: }
17333: if ($absolute eq '') {
17334: $protocol = 'http:';
17335: if ($port == 443) {
17336: $protocol = 'https:';
17337: }
17338: $origin = $protocol.'//'.lc($hostname);
17339: } else {
17340: $origin = lc($absolute);
17341: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
17342: }
17343: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
17344: my $framepolicy = $1;
17345: $framepolicy =~ s/^\s+|\s+$//g;
17346: my @policies = split(/\s+/,$framepolicy);
17347: if (@policies) {
17348: if (grep(/^\Q'none'\E$/,@policies)) {
17349: $uselink = 1;
17350: } else {
17351: $uselink = 1;
17352: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
17353: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
17354: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
17355: undef($uselink);
17356: }
17357: if ($uselink) {
17358: if (grep(/^\Q'self'\E$/,@policies)) {
17359: if (($origin ne '') && ($remotehost eq $origin)) {
17360: undef($uselink);
17361: }
17362: }
17363: }
17364: if ($uselink) {
17365: my @possok;
17366: if ($ip ne '') {
17367: push(@possok,$ip);
17368: }
17369: my $hoststr = '';
17370: foreach my $part (reverse(split(/\./,$hostname))) {
17371: if ($hoststr eq '') {
17372: $hoststr = $part;
17373: } else {
17374: $hoststr = "$part.$hoststr";
17375: }
17376: if ($hoststr eq $hostname) {
17377: push(@possok,$hostname);
17378: } else {
17379: push(@possok,"*.$hoststr");
17380: }
17381: }
17382: if (@possok) {
17383: foreach my $poss (@possok) {
17384: last if (!$uselink);
17385: foreach my $policy (@policies) {
17386: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
17387: undef($uselink);
17388: last;
17389: }
17390: }
17391: }
17392: }
17393: }
17394: }
17395: }
17396: } elsif ($xframeop ne '') {
17397: $uselink = 1;
17398: my @policies = split(/\s*,\s*/,$xframeop);
17399: if (@policies) {
17400: unless (grep(/^deny$/,@policies)) {
17401: if ($origin ne '') {
17402: if (grep(/^sameorigin$/,@policies)) {
17403: if ($remotehost eq $origin) {
17404: undef($uselink);
17405: }
17406: }
17407: if ($uselink) {
17408: foreach my $policy (@policies) {
17409: if ($policy =~ /^allow-from\s*(.+)$/) {
17410: my $allowfrom = $1;
17411: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
17412: undef($uselink);
17413: last;
17414: }
17415: }
17416: }
17417: }
17418: }
17419: }
17420: }
17421: }
17422: }
17423: }
17424: if ($nocache) {
17425: if ($cached) {
17426: my $devalidate;
17427: if ($uselink && !$result) {
17428: $devalidate = 1;
17429: } elsif (!$uselink && $result) {
17430: $devalidate = 1;
17431: }
17432: if ($devalidate) {
17433: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
17434: }
17435: }
17436: } else {
17437: if ($uselink) {
17438: $result = 1;
17439: } else {
17440: $result = 0;
17441: }
17442: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
17443: }
17444: return $uselink;
17445: }
17446:
1.112 bowersj2 17447: 1;
17448: __END__;
1.41 ng 17449:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface