Annotation of loncom/interface/loncommon.pm, revision 1.1385
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1385 ! raeburn 4: # $Id: loncommon.pm,v 1.1384 2022/06/11 14:51:49 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.1383 raeburn 64: use Apache::lonnavmaps();
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.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1280 raeburn 74: use LONCAPA::LWPReq;
1.1328 raeburn 75: use HTTP::Request;
1.657 raeburn 76: use DateTime::TimeZone;
1.1241 raeburn 77: use DateTime::Locale;
1.1220 raeburn 78: use Encode();
1.1091 foxr 79: use Text::Aspell;
1.1094 raeburn 80: use Authen::Captcha;
81: use Captcha::reCAPTCHA;
1.1234 raeburn 82: use JSON::DWIW;
1.1174 raeburn 83: use Crypt::DES;
84: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 85: use MIME::Lite;
86: use MIME::Types;
1.1292 raeburn 87: use File::Copy();
1.1300 raeburn 88: use File::Path();
1.1309 raeburn 89: use String::CRC32();
90: use Short::URL();
1.117 www 91:
1.517 raeburn 92: # ---------------------------------------------- Designs
93: use vars qw(%defaultdesign);
94:
1.22 www 95: my $readit;
96:
1.517 raeburn 97:
1.157 matthew 98: ##
99: ## Global Variables
100: ##
1.46 matthew 101:
1.643 foxr 102:
103: # ----------------------------------------------- SSI with retries:
104: #
105:
106: =pod
107:
1.648 raeburn 108: =head1 Server Side include with retries:
1.643 foxr 109:
110: =over 4
111:
1.648 raeburn 112: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 113:
114: Performs an ssi with some number of retries. Retries continue either
115: until the result is ok or until the retry count supplied by the
116: caller is exhausted.
117:
118: Inputs:
1.648 raeburn 119:
120: =over 4
121:
1.643 foxr 122: resource - Identifies the resource to insert.
1.648 raeburn 123:
1.643 foxr 124: retries - Count of the number of retries allowed.
1.648 raeburn 125:
1.643 foxr 126: form - Hash that identifies the rendering options.
127:
1.648 raeburn 128: =back
129:
130: Returns:
131:
132: =over 4
133:
1.643 foxr 134: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 135:
1.643 foxr 136: response - The response from the last attempt (which may or may not have been successful.
137:
1.648 raeburn 138: =back
139:
140: =back
141:
1.643 foxr 142: =cut
143:
144: sub ssi_with_retries {
145: my ($resource, $retries, %form) = @_;
146:
147:
148: my $ok = 0; # True if we got a good response.
149: my $content;
150: my $response;
151:
152: # Try to get the ssi done. within the retries count:
153:
154: do {
155: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
156: $ok = $response->is_success;
1.650 www 157: if (!$ok) {
158: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
159: }
1.643 foxr 160: $retries--;
161: } while (!$ok && ($retries > 0));
162:
163: if (!$ok) {
164: $content = ''; # On error return an empty content.
165: }
166: return ($content, $response);
167:
168: }
169:
170:
171:
1.20 www 172: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 173: my %language;
1.124 www 174: my %supported_language;
1.1088 foxr 175: my %supported_codes;
1.1048 foxr 176: my %latex_language; # For choosing hyphenation in <transl..>
177: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 178: my %cprtag;
1.192 taceyjo1 179: my %scprtag;
1.351 www 180: my %fe; my %fd; my %fm;
1.41 ng 181: my %category_extensions;
1.12 harris41 182:
1.46 matthew 183: # ---------------------------------------------- Thesaurus variables
1.144 matthew 184: #
185: # %Keywords:
186: # A hash used by &keyword to determine if a word is considered a keyword.
187: # $thesaurus_db_file
188: # Scalar containing the full path to the thesaurus database.
1.46 matthew 189:
190: my %Keywords;
191: my $thesaurus_db_file;
192:
1.144 matthew 193: #
194: # Initialize values from language.tab, copyright.tab, filetypes.tab,
195: # thesaurus.tab, and filecategories.tab.
196: #
1.18 www 197: BEGIN {
1.46 matthew 198: # Variable initialization
199: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
200: #
1.22 www 201: unless ($readit) {
1.12 harris41 202: # ------------------------------------------------------------------- languages
203: {
1.158 raeburn 204: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
205: '/language.tab';
1.1317 raeburn 206: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 207: while (my $line = <$fh>) {
208: next if ($line=~/^\#/);
209: chomp($line);
1.1088 foxr 210: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 211: $language{$key}=$val.' - '.$enc;
212: if ($sup) {
213: $supported_language{$key}=$sup;
1.1088 foxr 214: $supported_codes{$key} = $code;
1.158 raeburn 215: }
1.1048 foxr 216: if ($latex) {
217: $latex_language_bykey{$key} = $latex;
1.1088 foxr 218: $latex_language{$code} = $latex;
1.1048 foxr 219: }
1.158 raeburn 220: }
221: close($fh);
222: }
1.12 harris41 223: }
224: # ------------------------------------------------------------------ copyrights
225: {
1.158 raeburn 226: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
227: '/copyright.tab';
1.1317 raeburn 228: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 229: while (my $line = <$fh>) {
230: next if ($line=~/^\#/);
231: chomp($line);
232: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 233: $cprtag{$key}=$val;
234: }
235: close($fh);
236: }
1.12 harris41 237: }
1.351 www 238: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 239: {
240: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
241: '/source_copyright.tab';
1.1317 raeburn 242: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 243: while (my $line = <$fh>) {
244: next if ($line =~ /^\#/);
245: chomp($line);
246: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 247: $scprtag{$key}=$val;
248: }
249: close($fh);
250: }
251: }
1.63 www 252:
1.517 raeburn 253: # -------------------------------------------------------------- default domain designs
1.63 www 254: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 255: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 256: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 257: while (my $line = <$fh>) {
258: next if ($line =~ /^\#/);
259: chomp($line);
260: my ($key,$val)=(split(/\=/,$line));
261: if ($val) { $defaultdesign{$key}=$val; }
262: }
263: close($fh);
1.63 www 264: }
265:
1.15 harris41 266: # ------------------------------------------------------------- file categories
267: {
1.158 raeburn 268: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
269: '/filecategories.tab';
1.1317 raeburn 270: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 271: while (my $line = <$fh>) {
272: next if ($line =~ /^\#/);
273: chomp($line);
274: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 275: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 276: }
277: close($fh);
278: }
279:
1.15 harris41 280: }
1.12 harris41 281: # ------------------------------------------------------------------ file types
282: {
1.158 raeburn 283: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
284: '/filetypes.tab';
1.1317 raeburn 285: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 286: while (my $line = <$fh>) {
287: next if ($line =~ /^\#/);
288: chomp($line);
289: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 290: if ($descr ne '') {
291: $fe{$ending}=lc($emb);
292: $fd{$ending}=$descr;
1.351 www 293: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 294: }
295: }
296: close($fh);
297: }
1.12 harris41 298: }
1.22 www 299: &Apache::lonnet::logthis(
1.705 tempelho 300: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 301: $readit=1;
1.46 matthew 302: } # end of unless($readit)
1.32 matthew 303:
304: }
1.112 bowersj2 305:
1.42 matthew 306: ###############################################################
307: ## HTML and Javascript Helper Functions ##
308: ###############################################################
309:
310: =pod
311:
1.112 bowersj2 312: =head1 HTML and Javascript Functions
1.42 matthew 313:
1.112 bowersj2 314: =over 4
315:
1.648 raeburn 316: =item * &browser_and_searcher_javascript()
1.112 bowersj2 317:
318: X<browsing, javascript>X<searching, javascript>Returns a string
319: containing javascript with two functions, C<openbrowser> and
320: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
321: tags.
1.42 matthew 322:
1.648 raeburn 323: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 324:
325: inputs: formname, elementname, only, omit
326:
327: formname and elementname indicate the name of the html form and name of
328: the element that the results of the browsing selection are to be placed in.
329:
330: Specifying 'only' will restrict the browser to displaying only files
1.185 www 331: with the given extension. Can be a comma separated list.
1.42 matthew 332:
333: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 334: with the given extension. Can be a comma separated list.
1.42 matthew 335:
1.648 raeburn 336: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 337:
338: Inputs: formname, elementname
339:
340: formname and elementname specify the name of the html form and the name
341: of the element the selection from the search results will be placed in.
1.542 raeburn 342:
1.42 matthew 343: =cut
344:
345: sub browser_and_searcher_javascript {
1.199 albertel 346: my ($mode)=@_;
347: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 348: my $resurl=&escape_single(&lastresurl());
1.42 matthew 349: return <<END;
1.219 albertel 350: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 351: var editbrowser = null;
1.135 albertel 352: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 353: var url = '$resurl/?';
1.42 matthew 354: if (editbrowser == null) {
355: url += 'launch=1&';
356: }
357: url += 'catalogmode=interactive&';
1.199 albertel 358: url += 'mode=$mode&';
1.611 albertel 359: url += 'inhibitmenu=yes&';
1.42 matthew 360: url += 'form=' + formname + '&';
361: if (only != null) {
362: url += 'only=' + only + '&';
1.217 albertel 363: } else {
364: url += 'only=&';
365: }
1.42 matthew 366: if (omit != null) {
367: url += 'omit=' + omit + '&';
1.217 albertel 368: } else {
369: url += 'omit=&';
370: }
1.135 albertel 371: if (titleelement != null) {
372: url += 'titleelement=' + titleelement + '&';
1.217 albertel 373: } else {
374: url += 'titleelement=&';
375: }
1.42 matthew 376: url += 'element=' + elementname + '';
377: var title = 'Browser';
1.435 albertel 378: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 379: options += ',width=700,height=600';
380: editbrowser = open(url,title,options,'1');
381: editbrowser.focus();
382: }
383: var editsearcher;
1.135 albertel 384: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 385: var url = '/adm/searchcat?';
386: if (editsearcher == null) {
387: url += 'launch=1&';
388: }
389: url += 'catalogmode=interactive&';
1.199 albertel 390: url += 'mode=$mode&';
1.42 matthew 391: url += 'form=' + formname + '&';
1.135 albertel 392: if (titleelement != null) {
393: url += 'titleelement=' + titleelement + '&';
1.217 albertel 394: } else {
395: url += 'titleelement=&';
396: }
1.42 matthew 397: url += 'element=' + elementname + '';
398: var title = 'Search';
1.435 albertel 399: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 400: options += ',width=700,height=600';
401: editsearcher = open(url,title,options,'1');
402: editsearcher.focus();
403: }
1.219 albertel 404: // END LON-CAPA Internal -->
1.42 matthew 405: END
1.170 www 406: }
407:
408: sub lastresurl {
1.258 albertel 409: if ($env{'environment.lastresurl'}) {
410: return $env{'environment.lastresurl'}
1.170 www 411: } else {
412: return '/res';
413: }
414: }
415:
416: sub storeresurl {
417: my $resurl=&Apache::lonnet::clutter(shift);
418: unless ($resurl=~/^\/res/) { return 0; }
419: $resurl=~s/\/$//;
420: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 421: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 422: return 1;
1.42 matthew 423: }
424:
1.74 www 425: sub studentbrowser_javascript {
1.111 www 426: unless (
1.258 albertel 427: (($env{'request.course.id'}) &&
1.302 albertel 428: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
429: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
430: '/'.$env{'request.course.sec'})
431: ))
1.258 albertel 432: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 433: ) { return ''; }
1.74 www 434: return (<<'ENDSTDBRW');
1.776 bisitz 435: <script type="text/javascript" language="Javascript">
1.824 bisitz 436: // <![CDATA[
1.74 www 437: var stdeditbrowser;
1.1337 raeburn 438: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74 www 439: var url = '/adm/pickstudent?';
440: var filter;
1.558 albertel 441: if (!ignorefilter) {
442: eval('filter=document.'+formname+'.'+uname+'.value;');
443: }
1.74 www 444: if (filter != null) {
445: if (filter != '') {
446: url += 'filter='+filter+'&';
447: }
448: }
449: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 450: '&udomelement='+udom+
451: '&clicker='+clicker;
1.111 www 452: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 453: if (courseadv == 'condition') {
454: if (document.getElementById('courseadv')) {
455: courseadv = document.getElementById('courseadv').value;
456: }
457: }
458: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102 www 459: var title = 'Student_Browser';
1.74 www 460: var options = 'scrollbars=1,resizable=1,menubar=0';
461: options += ',width=700,height=600';
462: stdeditbrowser = open(url,title,options,'1');
463: stdeditbrowser.focus();
464: }
1.824 bisitz 465: // ]]>
1.74 www 466: </script>
467: ENDSTDBRW
468: }
1.42 matthew 469:
1.1003 www 470: sub resourcebrowser_javascript {
471: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 472: return (<<'ENDRESBRW');
1.1003 www 473: <script type="text/javascript" language="Javascript">
474: // <![CDATA[
475: var reseditbrowser;
1.1004 www 476: function openresbrowser(formname,reslink) {
1.1005 www 477: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 478: var title = 'Resource_Browser';
479: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 480: options += ',width=700,height=500';
1.1004 www 481: reseditbrowser = open(url,title,options,'1');
482: reseditbrowser.focus();
1.1003 www 483: }
484: // ]]>
485: </script>
1.1004 www 486: ENDRESBRW
1.1003 www 487: }
488:
1.74 www 489: sub selectstudent_link {
1.1337 raeburn 490: my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999 www 491: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
492: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
493: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 494: if ($env{'request.course.id'}) {
1.302 albertel 495: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
496: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
497: '/'.$env{'request.course.sec'})) {
1.111 www 498: return '';
499: }
1.999 www 500: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 501: if ($courseadv eq 'only') {
502: $callargs .= ",'',1,'$courseadv'";
503: } elsif ($courseadv eq 'none') {
504: $callargs .= ",'','','$courseadv'";
505: } elsif ($courseadv eq 'condition') {
506: $callargs .= ",'','','$courseadv'";
1.793 raeburn 507: }
508: return '<span class="LC_nobreak">'.
509: '<a href="javascript:openstdbrowser('.$callargs.');">'.
510: &mt('Select User').'</a></span>';
1.74 www 511: }
1.258 albertel 512: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 513: $callargs .= ",'',1";
1.793 raeburn 514: return '<span class="LC_nobreak">'.
515: '<a href="javascript:openstdbrowser('.$callargs.');">'.
516: &mt('Select User').'</a></span>';
1.111 www 517: }
518: return '';
1.91 www 519: }
520:
1.1004 www 521: sub selectresource_link {
522: my ($form,$reslink,$arg)=@_;
523:
524: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
525: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
526: unless ($env{'request.course.id'}) { return $arg; }
527: return '<span class="LC_nobreak">'.
528: '<a href="javascript:openresbrowser('.$callargs.');">'.
529: $arg.'</a></span>';
530: }
531:
532:
533:
1.653 raeburn 534: sub authorbrowser_javascript {
535: return <<"ENDAUTHORBRW";
1.776 bisitz 536: <script type="text/javascript" language="JavaScript">
1.824 bisitz 537: // <![CDATA[
1.653 raeburn 538: var stdeditbrowser;
539:
540: function openauthorbrowser(formname,udom) {
541: var url = '/adm/pickauthor?';
542: url += 'form='+formname+'&roledom='+udom;
543: var title = 'Author_Browser';
544: var options = 'scrollbars=1,resizable=1,menubar=0';
545: options += ',width=700,height=600';
546: stdeditbrowser = open(url,title,options,'1');
547: stdeditbrowser.focus();
548: }
549:
1.824 bisitz 550: // ]]>
1.653 raeburn 551: </script>
552: ENDAUTHORBRW
553: }
554:
1.91 www 555: sub coursebrowser_javascript {
1.1116 raeburn 556: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 557: $credits_element,$instcode) = @_;
1.932 raeburn 558: my $wintitle = 'Course_Browser';
1.931 raeburn 559: if ($crstype eq 'Community') {
1.932 raeburn 560: $wintitle = 'Community_Browser';
1.909 raeburn 561: }
1.876 raeburn 562: my $id_functions = &javascript_index_functions();
563: my $output = '
1.776 bisitz 564: <script type="text/javascript" language="JavaScript">
1.824 bisitz 565: // <![CDATA[
1.468 raeburn 566: var stdeditbrowser;'."\n";
1.876 raeburn 567:
568: $output .= <<"ENDSTDBRW";
1.909 raeburn 569: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 570: var url = '/adm/pickcourse?';
1.895 raeburn 571: var formid = getFormIdByName(formname);
1.876 raeburn 572: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 573: if (domainfilter != null) {
574: if (domainfilter != '') {
575: url += 'domainfilter='+domainfilter+'&';
576: }
577: }
1.91 www 578: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 579: '&cdomelement='+udom+
580: '&cnameelement='+desc;
1.468 raeburn 581: if (extra_element !=null && extra_element != '') {
1.594 raeburn 582: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 583: url += '&roleelement='+extra_element;
584: if (domainfilter == null || domainfilter == '') {
585: url += '&domainfilter='+extra_element;
586: }
1.234 raeburn 587: }
1.468 raeburn 588: else {
589: if (formname == 'portform') {
590: url += '&setroles='+extra_element;
1.800 raeburn 591: } else {
592: if (formname == 'rules') {
593: url += '&fixeddom='+extra_element;
594: }
1.468 raeburn 595: }
596: }
1.230 raeburn 597: }
1.909 raeburn 598: if (type != null && type != '') {
599: url += '&type='+type;
600: }
601: if (type_elem != null && type_elem != '') {
602: url += '&typeelement='+type_elem;
603: }
1.872 raeburn 604: if (formname == 'ccrs') {
605: var ownername = document.forms[formid].ccuname.value;
606: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 607: url += '&cloner='+ownername+':'+ownerdom;
608: if (type == 'Course') {
609: url += '&crscode='+document.forms[formid].crscode.value;
610: }
1.1221 raeburn 611: }
612: if (formname == 'requestcrs') {
613: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 614: }
1.293 raeburn 615: if (multflag !=null && multflag != '') {
616: url += '&multiple='+multflag;
617: }
1.909 raeburn 618: var title = '$wintitle';
1.91 www 619: var options = 'scrollbars=1,resizable=1,menubar=0';
620: options += ',width=700,height=600';
621: stdeditbrowser = open(url,title,options,'1');
622: stdeditbrowser.focus();
623: }
1.876 raeburn 624: $id_functions
625: ENDSTDBRW
1.1116 raeburn 626: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
627: $output .= &setsec_javascript($sec_element,$formname,$role_element,
628: $credits_element);
1.876 raeburn 629: }
630: $output .= '
631: // ]]>
632: </script>';
633: return $output;
634: }
635:
636: sub javascript_index_functions {
637: return <<"ENDJS";
638:
639: function getFormIdByName(formname) {
640: for (var i=0;i<document.forms.length;i++) {
641: if (document.forms[i].name == formname) {
642: return i;
643: }
644: }
645: return -1;
646: }
647:
648: function getIndexByName(formid,item) {
649: for (var i=0;i<document.forms[formid].elements.length;i++) {
650: if (document.forms[formid].elements[i].name == item) {
651: return i;
652: }
653: }
654: return -1;
655: }
1.468 raeburn 656:
1.876 raeburn 657: function getDomainFromSelectbox(formname,udom) {
658: var userdom;
659: var formid = getFormIdByName(formname);
660: if (formid > -1) {
661: var domid = getIndexByName(formid,udom);
662: if (domid > -1) {
663: if (document.forms[formid].elements[domid].type == 'select-one') {
664: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
665: }
666: if (document.forms[formid].elements[domid].type == 'hidden') {
667: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 668: }
669: }
670: }
1.876 raeburn 671: return userdom;
672: }
673:
674: ENDJS
1.468 raeburn 675:
1.876 raeburn 676: }
677:
1.1017 raeburn 678: sub javascript_array_indexof {
1.1018 raeburn 679: return <<ENDJS;
1.1017 raeburn 680: <script type="text/javascript" language="JavaScript">
681: // <![CDATA[
682:
683: if (!Array.prototype.indexOf) {
684: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
685: "use strict";
686: if (this === void 0 || this === null) {
687: throw new TypeError();
688: }
689: var t = Object(this);
690: var len = t.length >>> 0;
691: if (len === 0) {
692: return -1;
693: }
694: var n = 0;
695: if (arguments.length > 0) {
696: n = Number(arguments[1]);
1.1088 foxr 697: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 698: n = 0;
699: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
700: n = (n > 0 || -1) * Math.floor(Math.abs(n));
701: }
702: }
703: if (n >= len) {
704: return -1;
705: }
706: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
707: for (; k < len; k++) {
708: if (k in t && t[k] === searchElement) {
709: return k;
710: }
711: }
712: return -1;
713: }
714: }
715:
716: // ]]>
717: </script>
718:
719: ENDJS
720:
721: }
722:
1.876 raeburn 723: sub userbrowser_javascript {
724: my $id_functions = &javascript_index_functions();
725: return <<"ENDUSERBRW";
726:
1.888 raeburn 727: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 728: var url = '/adm/pickuser?';
729: var userdom = getDomainFromSelectbox(formname,udom);
730: if (userdom != null) {
731: if (userdom != '') {
732: url += 'srchdom='+userdom+'&';
733: }
734: }
735: url += 'form=' + formname + '&unameelement='+uname+
736: '&udomelement='+udom+
737: '&ulastelement='+ulast+
738: '&ufirstelement='+ufirst+
739: '&uemailelement='+uemail+
1.881 raeburn 740: '&hideudomelement='+hideudom+
741: '&coursedom='+crsdom;
1.888 raeburn 742: if ((caller != null) && (caller != undefined)) {
743: url += '&caller='+caller;
744: }
1.876 raeburn 745: var title = 'User_Browser';
746: var options = 'scrollbars=1,resizable=1,menubar=0';
747: options += ',width=700,height=600';
748: var stdeditbrowser = open(url,title,options,'1');
749: stdeditbrowser.focus();
750: }
751:
1.888 raeburn 752: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 753: var formid = getFormIdByName(formname);
754: if (formid > -1) {
1.888 raeburn 755: var unameid = getIndexByName(formid,uname);
1.876 raeburn 756: var domid = getIndexByName(formid,udom);
757: var hidedomid = getIndexByName(formid,origdom);
758: if (hidedomid > -1) {
759: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 760: var unameval = document.forms[formid].elements[unameid].value;
761: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
762: if (domid > -1) {
763: var slct = document.forms[formid].elements[domid];
764: if (slct.type == 'select-one') {
765: var i;
766: for (i=0;i<slct.length;i++) {
767: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
768: }
769: }
770: if (slct.type == 'hidden') {
771: slct.value = fixeddom;
1.876 raeburn 772: }
773: }
1.468 raeburn 774: }
775: }
776: }
1.876 raeburn 777: return;
778: }
779:
780: $id_functions
781: ENDUSERBRW
1.468 raeburn 782: }
783:
784: sub setsec_javascript {
1.1116 raeburn 785: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 786: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
787: $communityrolestr);
788: if ($role_element ne '') {
789: my @allroles = ('st','ta','ep','in','ad');
790: foreach my $crstype ('Course','Community') {
791: if ($crstype eq 'Community') {
792: foreach my $role (@allroles) {
793: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
794: }
795: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
796: } else {
797: foreach my $role (@allroles) {
798: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
799: }
800: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
801: }
802: }
803: $rolestr = '"'.join('","',@allroles).'"';
804: $courserolestr = '"'.join('","',@courserolenames).'"';
805: $communityrolestr = '"'.join('","',@communityrolenames).'"';
806: }
1.468 raeburn 807: my $setsections = qq|
808: function setSect(sectionlist) {
1.629 raeburn 809: var sectionsArray = new Array();
810: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
811: sectionsArray = sectionlist.split(",");
812: }
1.468 raeburn 813: var numSections = sectionsArray.length;
814: document.$formname.$sec_element.length = 0;
815: if (numSections == 0) {
816: document.$formname.$sec_element.multiple=false;
817: document.$formname.$sec_element.size=1;
818: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
819: } else {
820: if (numSections == 1) {
821: document.$formname.$sec_element.multiple=false;
822: document.$formname.$sec_element.size=1;
823: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
824: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
825: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
826: } else {
827: for (var i=0; i<numSections; i++) {
828: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
829: }
830: document.$formname.$sec_element.multiple=true
831: if (numSections < 3) {
832: document.$formname.$sec_element.size=numSections;
833: } else {
834: document.$formname.$sec_element.size=3;
835: }
836: document.$formname.$sec_element.options[0].selected = false
837: }
838: }
1.91 www 839: }
1.905 raeburn 840:
841: function setRole(crstype) {
1.468 raeburn 842: |;
1.905 raeburn 843: if ($role_element eq '') {
844: $setsections .= ' return;
845: }
846: ';
847: } else {
848: $setsections .= qq|
849: var elementLength = document.$formname.$role_element.length;
850: var allroles = Array($rolestr);
851: var courserolenames = Array($courserolestr);
852: var communityrolenames = Array($communityrolestr);
853: if (elementLength != undefined) {
854: if (document.$formname.$role_element.options[5].value == 'cc') {
855: if (crstype == 'Course') {
856: return;
857: } else {
858: allroles[5] = 'co';
859: for (var i=0; i<6; i++) {
860: document.$formname.$role_element.options[i].value = allroles[i];
861: document.$formname.$role_element.options[i].text = communityrolenames[i];
862: }
863: }
864: } else {
865: if (crstype == 'Community') {
866: return;
867: } else {
868: allroles[5] = 'cc';
869: for (var i=0; i<6; i++) {
870: document.$formname.$role_element.options[i].value = allroles[i];
871: document.$formname.$role_element.options[i].text = courserolenames[i];
872: }
873: }
874: }
875: }
876: return;
877: }
878: |;
879: }
1.1116 raeburn 880: if ($credits_element) {
881: $setsections .= qq|
882: function setCredits(defaultcredits) {
883: document.$formname.$credits_element.value = defaultcredits;
884: return;
885: }
886: |;
887: }
1.468 raeburn 888: return $setsections;
889: }
890:
1.91 www 891: sub selectcourse_link {
1.909 raeburn 892: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
893: $typeelement) = @_;
894: my $type = $selecttype;
1.871 raeburn 895: my $linktext = &mt('Select Course');
896: if ($selecttype eq 'Community') {
1.909 raeburn 897: $linktext = &mt('Select Community');
1.1239 raeburn 898: } elsif ($selecttype eq 'Placement') {
899: $linktext = &mt('Select Placement Test');
1.906 raeburn 900: } elsif ($selecttype eq 'Course/Community') {
901: $linktext = &mt('Select Course/Community');
1.909 raeburn 902: $type = '';
1.1019 raeburn 903: } elsif ($selecttype eq 'Select') {
904: $linktext = &mt('Select');
905: $type = '';
1.871 raeburn 906: }
1.787 bisitz 907: return '<span class="LC_nobreak">'
908: ."<a href='"
909: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
910: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 911: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 912: ."'>".$linktext.'</a>'
1.787 bisitz 913: .'</span>';
1.74 www 914: }
1.42 matthew 915:
1.653 raeburn 916: sub selectauthor_link {
917: my ($form,$udom)=@_;
918: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
919: &mt('Select Author').'</a>';
920: }
921:
1.876 raeburn 922: sub selectuser_link {
1.881 raeburn 923: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 924: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 925: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 926: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 927: ');">'.$linktext.'</a>';
1.876 raeburn 928: }
929:
1.273 raeburn 930: sub check_uncheck_jscript {
931: my $jscript = <<"ENDSCRT";
932: function checkAll(field) {
933: if (field.length > 0) {
934: for (i = 0; i < field.length; i++) {
1.1093 raeburn 935: if (!field[i].disabled) {
936: field[i].checked = true;
937: }
1.273 raeburn 938: }
939: } else {
1.1093 raeburn 940: if (!field.disabled) {
941: field.checked = true;
942: }
1.273 raeburn 943: }
944: }
945:
946: function uncheckAll(field) {
947: if (field.length > 0) {
948: for (i = 0; i < field.length; i++) {
949: field[i].checked = false ;
1.543 albertel 950: }
951: } else {
1.273 raeburn 952: field.checked = false ;
953: }
954: }
955: ENDSCRT
956: return $jscript;
957: }
958:
1.656 www 959: sub select_timezone {
1.1256 raeburn 960: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
961: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659 raeburn 962: if ($includeempty) {
963: $output .= '<option value=""';
964: if (($selected eq '') || ($selected eq 'local')) {
965: $output .= ' selected="selected" ';
966: }
967: $output .= '> </option>';
968: }
1.657 raeburn 969: my @timezones = DateTime::TimeZone->all_names;
970: foreach my $tzone (@timezones) {
971: $output.= '<option value="'.$tzone.'"';
972: if ($tzone eq $selected) {
973: $output.=' selected="selected"';
974: }
975: $output.=">$tzone</option>\n";
1.656 www 976: }
977: $output.="</select>";
978: return $output;
979: }
1.273 raeburn 980:
1.687 raeburn 981: sub select_datelocale {
1.1256 raeburn 982: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
983: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 984: if ($includeempty) {
985: $output .= '<option value=""';
986: if ($selected eq '') {
987: $output .= ' selected="selected" ';
988: }
989: $output .= '> </option>';
990: }
1.1241 raeburn 991: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 992: my (@possibles,%locale_names);
1.1241 raeburn 993: my @locales = DateTime::Locale->ids();
994: foreach my $id (@locales) {
995: if ($id ne '') {
996: my ($en_terr,$native_terr);
997: my $loc = DateTime::Locale->load($id);
998: if (ref($loc)) {
999: $en_terr = $loc->name();
1000: $native_terr = $loc->native_name();
1.687 raeburn 1001: if (grep(/^en$/,@languages) || !@languages) {
1002: if ($en_terr ne '') {
1003: $locale_names{$id} = '('.$en_terr.')';
1004: } elsif ($native_terr ne '') {
1005: $locale_names{$id} = $native_terr;
1006: }
1007: } else {
1008: if ($native_terr ne '') {
1009: $locale_names{$id} = $native_terr.' ';
1010: } elsif ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: }
1013: }
1.1220 raeburn 1014: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1015: push(@possibles,$id);
1016: }
1.687 raeburn 1017: }
1018: }
1019: foreach my $item (sort(@possibles)) {
1020: $output.= '<option value="'.$item.'"';
1021: if ($item eq $selected) {
1022: $output.=' selected="selected"';
1023: }
1024: $output.=">$item";
1025: if ($locale_names{$item} ne '') {
1.1220 raeburn 1026: $output.=' '.$locale_names{$item};
1.687 raeburn 1027: }
1028: $output.="</option>\n";
1029: }
1030: $output.="</select>";
1031: return $output;
1032: }
1033:
1.792 raeburn 1034: sub select_language {
1.1256 raeburn 1035: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1036: my %langchoices;
1037: if ($includeempty) {
1.1117 raeburn 1038: %langchoices = ('' => 'No language preference');
1.792 raeburn 1039: }
1040: foreach my $id (&languageids()) {
1041: my $code = &supportedlanguagecode($id);
1042: if ($code) {
1043: $langchoices{$code} = &plainlanguagedescription($id);
1044: }
1045: }
1.1117 raeburn 1046: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1047: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1048: }
1049:
1.42 matthew 1050: =pod
1.36 matthew 1051:
1.1088 foxr 1052:
1053: =item * &list_languages()
1054:
1055: Returns an array reference that is suitable for use in language prompters.
1056: Each array element is itself a two element array. The first element
1057: is the language code. The second element a descsriptiuon of the
1058: language itself. This is suitable for use in e.g.
1059: &Apache::edit::select_arg (once dereferenced that is).
1060:
1061: =cut
1062:
1063: sub list_languages {
1064: my @lang_choices;
1065:
1066: foreach my $id (&languageids()) {
1067: my $code = &supportedlanguagecode($id);
1068: if ($code) {
1069: my $selector = $supported_codes{$id};
1070: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1071: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1072: }
1073: }
1074: return \@lang_choices;
1075: }
1076:
1077: =pod
1078:
1.648 raeburn 1079: =item * &linked_select_forms(...)
1.36 matthew 1080:
1081: linked_select_forms returns a string containing a <script></script> block
1082: and html for two <select> menus. The select menus will be linked in that
1083: changing the value of the first menu will result in new values being placed
1084: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1085: order unless a defined order is provided.
1.36 matthew 1086:
1087: linked_select_forms takes the following ordered inputs:
1088:
1089: =over 4
1090:
1.112 bowersj2 1091: =item * $formname, the name of the <form> tag
1.36 matthew 1092:
1.112 bowersj2 1093: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1094:
1.112 bowersj2 1095: =item * $firstdefault, the default value for the first menu
1.36 matthew 1096:
1.112 bowersj2 1097: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1098:
1.112 bowersj2 1099: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1102:
1.609 raeburn 1103: =item * $menuorder, the order of values in the first menu
1104:
1.1115 raeburn 1105: =item * $onchangefirst, additional javascript call to execute for an onchange
1106: event for the first <select> tag
1107:
1108: =item * $onchangesecond, additional javascript call to execute for an onchange
1109: event for the second <select> tag
1110:
1.1245 raeburn 1111: =item * $suffix, to differentiate separate uses of select2data javascript
1112: objects in a page.
1113:
1.41 ng 1114: =back
1115:
1.36 matthew 1116: Below is an example of such a hash. Only the 'text', 'default', and
1117: 'select2' keys must appear as stated. keys(%menu) are the possible
1118: values for the first select menu. The text that coincides with the
1.41 ng 1119: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1120: and text for the second menu are given in the hash pointed to by
1121: $menu{$choice1}->{'select2'}.
1122:
1.112 bowersj2 1123: my %menu = ( A1 => { text =>"Choice A1" ,
1124: default => "B3",
1125: select2 => {
1126: B1 => "Choice B1",
1127: B2 => "Choice B2",
1128: B3 => "Choice B3",
1129: B4 => "Choice B4"
1.609 raeburn 1130: },
1131: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1132: },
1133: A2 => { text =>"Choice A2" ,
1134: default => "C2",
1135: select2 => {
1136: C1 => "Choice C1",
1137: C2 => "Choice C2",
1138: C3 => "Choice C3"
1.609 raeburn 1139: },
1140: order => ['C2','C1','C3'],
1.112 bowersj2 1141: },
1142: A3 => { text =>"Choice A3" ,
1143: default => "D6",
1144: select2 => {
1145: D1 => "Choice D1",
1146: D2 => "Choice D2",
1147: D3 => "Choice D3",
1148: D4 => "Choice D4",
1149: D5 => "Choice D5",
1150: D6 => "Choice D6",
1151: D7 => "Choice D7"
1.609 raeburn 1152: },
1153: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1154: }
1155: );
1.36 matthew 1156:
1157: =cut
1158:
1159: sub linked_select_forms {
1160: my ($formname,
1161: $middletext,
1162: $firstdefault,
1163: $firstselectname,
1164: $secondselectname,
1.609 raeburn 1165: $hashref,
1166: $menuorder,
1.1115 raeburn 1167: $onchangefirst,
1.1245 raeburn 1168: $onchangesecond,
1169: $suffix
1.36 matthew 1170: ) = @_;
1171: my $second = "document.$formname.$secondselectname";
1172: my $first = "document.$formname.$firstselectname";
1173: # output the javascript to do the changing
1174: my $result = '';
1.776 bisitz 1175: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1176: $result.="// <![CDATA[\n";
1.1245 raeburn 1177: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1178: $" = '","';
1179: my $debug = '';
1180: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1181: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1182: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1183: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1184: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1185: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1186: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1187: @s2values = @{$hashref->{$s1}->{'order'}};
1188: }
1.36 matthew 1189: $result.="\"@s2values\");\n";
1.1245 raeburn 1190: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1191: my @s2texts;
1192: foreach my $value (@s2values) {
1.1263 raeburn 1193: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1194: }
1195: $result.="\"@s2texts\");\n";
1196: }
1197: $"=' ';
1198: $result.= <<"END";
1199:
1.1245 raeburn 1200: function select1${suffix}_changed() {
1.36 matthew 1201: // Determine new choice
1.1245 raeburn 1202: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1203: // update select2
1.1245 raeburn 1204: var values = select2data${suffix}[newvalue].values;
1205: var texts = select2data${suffix}[newvalue].texts;
1206: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1207: var i;
1208: // out with the old
1.1245 raeburn 1209: $second.options.length = 0;
1210: // in with the new
1.36 matthew 1211: for (i=0;i<values.length; i++) {
1212: $second.options[i] = new Option(values[i]);
1.143 matthew 1213: $second.options[i].value = values[i];
1.36 matthew 1214: $second.options[i].text = texts[i];
1215: if (values[i] == select2def) {
1216: $second.options[i].selected = true;
1217: }
1218: }
1219: }
1.824 bisitz 1220: // ]]>
1.36 matthew 1221: </script>
1222: END
1223: # output the initial values for the selection lists
1.1245 raeburn 1224: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1225: my @order = sort(keys(%{$hashref}));
1226: if (ref($menuorder) eq 'ARRAY') {
1227: @order = @{$menuorder};
1228: }
1229: foreach my $value (@order) {
1.36 matthew 1230: $result.=" <option value=\"$value\" ";
1.253 albertel 1231: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1232: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1233: }
1234: $result .= "</select>\n";
1235: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1236: $result .= $middletext;
1.1115 raeburn 1237: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1238: if ($onchangesecond) {
1239: $result .= ' onchange="'.$onchangesecond.'"';
1240: }
1241: $result .= ">\n";
1.36 matthew 1242: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1243:
1244: my @secondorder = sort(keys(%select2));
1245: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1246: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1247: }
1248: foreach my $value (@secondorder) {
1.36 matthew 1249: $result.=" <option value=\"$value\" ";
1.253 albertel 1250: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1251: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1252: }
1253: $result .= "</select>\n";
1254: # return $debug;
1255: return $result;
1256: } # end of sub linked_select_forms {
1257:
1.45 matthew 1258: =pod
1.44 bowersj2 1259:
1.1381 raeburn 1260: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1261:
1.112 bowersj2 1262: Returns a string corresponding to an HTML link to the given help
1263: $topic, where $topic corresponds to the name of a .tex file in
1264: /home/httpd/html/adm/help/tex, with underscores replaced by
1265: spaces.
1266:
1267: $text will optionally be linked to the same topic, allowing you to
1268: link text in addition to the graphic. If you do not want to link
1269: text, but wish to specify one of the later parameters, pass an
1270: empty string.
1271:
1272: $stayOnPage is a value that will be interpreted as a boolean. If true,
1273: the link will not open a new window. If false, the link will open
1274: a new window using Javascript. (Default is false.)
1275:
1276: $width and $height are optional numerical parameters that will
1277: override the width and height of the popped up window, which may
1.973 raeburn 1278: be useful for certain help topics with big pictures included.
1279:
1280: $imgid is the id of the img tag used for the help icon. This may be
1281: used in a javascript call to switch the image src. See
1282: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1283:
1.1381 raeburn 1284: $links_target will optionally be set to a target (_top, _parent or _self).
1285:
1.44 bowersj2 1286: =cut
1287:
1288: sub help_open_topic {
1.1381 raeburn 1289: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1290: $text = "" if (not defined $text);
1.44 bowersj2 1291: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1292: $width = 500 if (not defined $width);
1.44 bowersj2 1293: $height = 400 if (not defined $height);
1294: my $filename = $topic;
1295: $filename =~ s/ /_/g;
1296:
1.48 bowersj2 1297: my $template = "";
1298: my $link;
1.572 banghart 1299:
1.159 www 1300: $topic=~s/\W/\_/g;
1.44 bowersj2 1301:
1.572 banghart 1302: if (!$stayOnPage) {
1.1033 www 1303: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1304: } elsif ($stayOnPage eq 'popup') {
1305: $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 1306: } else {
1.48 bowersj2 1307: $link = "/adm/help/${filename}.hlp";
1308: }
1309:
1310: # Add the text
1.1314 raeburn 1311: my $target = ' target="_top"';
1.1381 raeburn 1312: if ($links_target) {
1313: $target = ' target="'.$links_target.'"';
1314: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1315: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1316: $target = '';
1.1378 raeburn 1317: }
1.1380 raeburn 1318: if ($text ne "") {
1.763 bisitz 1319: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1320: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1321: .$text.'</a>';
1.48 bowersj2 1322: }
1323:
1.763 bisitz 1324: # (Always) Add the graphic
1.179 matthew 1325: my $title = &mt('Online Help');
1.667 raeburn 1326: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1327: if ($imgid ne '') {
1328: $imgid = ' id="'.$imgid.'"';
1329: }
1.1314 raeburn 1330: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1331: .'<img src="'.$helpicon.'" border="0"'
1332: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1333: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1334: .' /></a>';
1335: if ($text ne "") {
1336: $template.='</span>';
1337: }
1.44 bowersj2 1338: return $template;
1339:
1.106 bowersj2 1340: }
1341:
1342: # This is a quicky function for Latex cheatsheet editing, since it
1343: # appears in at least four places
1344: sub helpLatexCheatsheet {
1.1037 www 1345: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1346: my $out;
1.106 bowersj2 1347: my $addOther = '';
1.732 raeburn 1348: if ($topic) {
1.1037 www 1349: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1350: }
1351: $out = '<span>' # Start cheatsheet
1352: .$addOther
1353: .'<span>'
1.1037 www 1354: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1355: .'</span> <span>'
1.1037 www 1356: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1357: .'</span>';
1.732 raeburn 1358: unless ($not_author) {
1.1186 kruse 1359: $out .= '<span>'
1360: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1361: .'</span> <span>'
1362: .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763 bisitz 1363: .'</span>';
1.732 raeburn 1364: }
1.763 bisitz 1365: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1366: return $out;
1.172 www 1367: }
1368:
1.430 albertel 1369: sub general_help {
1370: my $helptopic='Student_Intro';
1371: if ($env{'request.role'}=~/^(ca|au)/) {
1372: $helptopic='Authoring_Intro';
1.907 raeburn 1373: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1374: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1375: } elsif ($env{'request.role'}=~/^dc/) {
1376: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1377: }
1378: return $helptopic;
1379: }
1380:
1381: sub update_help_link {
1382: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1383: my $origurl = $ENV{'REQUEST_URI'};
1384: $origurl=~s|^/~|/priv/|;
1385: my $timestamp = time;
1386: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1387: $$datum = &escape($$datum);
1388: }
1389:
1390: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1391: my $output .= <<"ENDOUTPUT";
1392: <script type="text/javascript">
1.824 bisitz 1393: // <![CDATA[
1.430 albertel 1394: banner_link = '$banner_link';
1.824 bisitz 1395: // ]]>
1.430 albertel 1396: </script>
1397: ENDOUTPUT
1398: return $output;
1399: }
1400:
1401: # now just updates the help link and generates a blue icon
1.193 raeburn 1402: sub help_open_menu {
1.1381 raeburn 1403: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1404: = @_;
1.949 droeschl 1405: $stayOnPage = 1;
1.430 albertel 1406: my $output;
1407: if ($component_help) {
1408: if (!$text) {
1409: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1410: $width,$height,'',$links_target);
1.430 albertel 1411: } else {
1412: my $help_text;
1413: $help_text=&unescape($topic);
1414: $output='<table><tr><td>'.
1415: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1416: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1417: }
1418: }
1419: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1420: return $output.$banner_link;
1421: }
1422:
1423: sub top_nav_help {
1.1369 raeburn 1424: my ($text,$linkattr) = @_;
1.436 albertel 1425: $text = &mt($text);
1.949 droeschl 1426: my $stay_on_page = 1;
1427:
1.1168 raeburn 1428: my ($link,$banner_link);
1429: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1430: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1431: : "javascript:helpMenu('open')";
1432: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1433: }
1.201 raeburn 1434: my $title = &mt('Get help');
1.1168 raeburn 1435: if ($link) {
1436: return <<"END";
1.436 albertel 1437: $banner_link
1.1369 raeburn 1438: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1439: END
1.1168 raeburn 1440: } else {
1441: return ' '.$text.' ';
1442: }
1.436 albertel 1443: }
1444:
1445: sub help_menu_js {
1.1154 raeburn 1446: my ($httphost) = @_;
1.949 droeschl 1447: my $stayOnPage = 1;
1.436 albertel 1448: my $width = 620;
1449: my $height = 600;
1.430 albertel 1450: my $helptopic=&general_help();
1.1154 raeburn 1451: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1452: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1453: my $start_page =
1454: &Apache::loncommon::start_page('Help Menu', undef,
1455: {'frameset' => 1,
1456: 'js_ready' => 1,
1.1154 raeburn 1457: 'use_absolute' => $httphost,
1.331 albertel 1458: 'add_entries' => {
1.1168 raeburn 1459: 'border' => '0',
1.579 raeburn 1460: 'rows' => "110,*",},});
1.331 albertel 1461: my $end_page =
1462: &Apache::loncommon::end_page({'frameset' => 1,
1463: 'js_ready' => 1,});
1464:
1.436 albertel 1465: my $template .= <<"ENDTEMPLATE";
1466: <script type="text/javascript">
1.877 bisitz 1467: // <![CDATA[
1.253 albertel 1468: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1469: var banner_link = '';
1.243 raeburn 1470: function helpMenu(target) {
1471: var caller = this;
1472: if (target == 'open') {
1473: var newWindow = null;
1474: try {
1.262 albertel 1475: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1476: }
1477: catch(error) {
1478: writeHelp(caller);
1479: return;
1480: }
1481: if (newWindow) {
1482: caller = newWindow;
1483: }
1.193 raeburn 1484: }
1.243 raeburn 1485: writeHelp(caller);
1486: return;
1487: }
1488: function writeHelp(caller) {
1.1168 raeburn 1489: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1490: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1491: caller.document.close();
1492: caller.focus();
1.193 raeburn 1493: }
1.877 bisitz 1494: // END LON-CAPA Internal -->
1.253 albertel 1495: // ]]>
1.436 albertel 1496: </script>
1.193 raeburn 1497: ENDTEMPLATE
1498: return $template;
1499: }
1500:
1.172 www 1501: sub help_open_bug {
1502: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1503: unless ($env{'user.adv'}) { return ''; }
1.172 www 1504: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1505: $text = "" if (not defined $text);
1506: $stayOnPage=1;
1.184 albertel 1507: $width = 600 if (not defined $width);
1508: $height = 600 if (not defined $height);
1.172 www 1509:
1510: $topic=~s/\W+/\+/g;
1511: my $link='';
1512: my $template='';
1.379 albertel 1513: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1514: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1515: if (!$stayOnPage)
1516: {
1517: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1518: }
1519: else
1520: {
1521: $link = $url;
1522: }
1.1314 raeburn 1523:
1.1382 raeburn 1524: my $target = '_top';
1525: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1526: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1527: $target = '_blank';
1.1378 raeburn 1528: }
1.1382 raeburn 1529:
1.172 www 1530: # Add the text
1531: if ($text ne "")
1532: {
1533: $template .=
1534: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1535: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1536: }
1537:
1538: # Add the graphic
1.179 matthew 1539: my $title = &mt('Report a Bug');
1.215 albertel 1540: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1541: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1542: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1543: ENDTEMPLATE
1544: if ($text ne '') { $template.='</td></tr></table>' };
1545: return $template;
1546:
1547: }
1548:
1549: sub help_open_faq {
1550: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1551: unless ($env{'user.adv'}) { return ''; }
1.172 www 1552: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1553: $text = "" if (not defined $text);
1554: $stayOnPage=1;
1555: $width = 350 if (not defined $width);
1556: $height = 400 if (not defined $height);
1557:
1558: $topic=~s/\W+/\+/g;
1559: my $link='';
1560: my $template='';
1561: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1562: if (!$stayOnPage)
1563: {
1564: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1565: }
1566: else
1567: {
1568: $link = $url;
1569: }
1570:
1571: # Add the text
1572: if ($text ne "")
1573: {
1574: $template .=
1.173 www 1575: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1576: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1577: }
1578:
1579: # Add the graphic
1.179 matthew 1580: my $title = &mt('View the FAQ');
1.215 albertel 1581: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1582: $template .= <<"ENDTEMPLATE";
1.436 albertel 1583: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1584: ENDTEMPLATE
1585: if ($text ne '') { $template.='</td></tr></table>' };
1586: return $template;
1587:
1.44 bowersj2 1588: }
1.37 matthew 1589:
1.180 matthew 1590: ###############################################################
1591: ###############################################################
1592:
1.45 matthew 1593: =pod
1594:
1.648 raeburn 1595: =item * &change_content_javascript():
1.256 matthew 1596:
1597: This and the next function allow you to create small sections of an
1598: otherwise static HTML page that you can update on the fly with
1599: Javascript, even in Netscape 4.
1600:
1601: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1602: must be written to the HTML page once. It will prove the Javascript
1603: function "change(name, content)". Calling the change function with the
1604: name of the section
1605: you want to update, matching the name passed to C<changable_area>, and
1606: the new content you want to put in there, will put the content into
1607: that area.
1608:
1609: B<Note>: Netscape 4 only reserves enough space for the changable area
1610: to contain room for the original contents. You need to "make space"
1611: for whatever changes you wish to make, and be B<sure> to check your
1612: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1613: it's adequate for updating a one-line status display, but little more.
1614: This script will set the space to 100% width, so you only need to
1615: worry about height in Netscape 4.
1616:
1617: Modern browsers are much less limiting, and if you can commit to the
1618: user not using Netscape 4, this feature may be used freely with
1619: pretty much any HTML.
1620:
1621: =cut
1622:
1623: sub change_content_javascript {
1624: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1625: if ($env{'browser.type'} eq 'netscape' &&
1626: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1627: return (<<NETSCAPE4);
1628: function change(name, content) {
1629: doc = document.layers[name+"___escape"].layers[0].document;
1630: doc.open();
1631: doc.write(content);
1632: doc.close();
1633: }
1634: NETSCAPE4
1635: } else {
1636: # Otherwise, we need to use semi-standards-compliant code
1637: # (technically, "innerHTML" isn't standard but the equivalent
1638: # is really scary, and every useful browser supports it
1639: return (<<DOMBASED);
1640: function change(name, content) {
1641: element = document.getElementById(name);
1642: element.innerHTML = content;
1643: }
1644: DOMBASED
1645: }
1646: }
1647:
1648: =pod
1649:
1.648 raeburn 1650: =item * &changable_area($name,$origContent):
1.256 matthew 1651:
1652: This provides a "changable area" that can be modified on the fly via
1653: the Javascript code provided in C<change_content_javascript>. $name is
1654: the name you will use to reference the area later; do not repeat the
1655: same name on a given HTML page more then once. $origContent is what
1656: the area will originally contain, which can be left blank.
1657:
1658: =cut
1659:
1660: sub changable_area {
1661: my ($name, $origContent) = @_;
1662:
1.258 albertel 1663: if ($env{'browser.type'} eq 'netscape' &&
1664: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1665: # If this is netscape 4, we need to use the Layer tag
1666: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1667: } else {
1668: return "<span id='$name'>$origContent</span>";
1669: }
1670: }
1671:
1672: =pod
1673:
1.648 raeburn 1674: =item * &viewport_geometry_js
1.590 raeburn 1675:
1676: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1677:
1678: =cut
1679:
1680:
1681: sub viewport_geometry_js {
1682: return <<"GEOMETRY";
1683: var Geometry = {};
1684: function init_geometry() {
1685: if (Geometry.init) { return };
1686: Geometry.init=1;
1687: if (window.innerHeight) {
1688: Geometry.getViewportHeight = function() { return window.innerHeight; };
1689: Geometry.getViewportWidth = function() { return window.innerWidth; };
1690: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1691: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1692: }
1693: else if (document.documentElement && document.documentElement.clientHeight) {
1694: Geometry.getViewportHeight =
1695: function() { return document.documentElement.clientHeight; };
1696: Geometry.getViewportWidth =
1697: function() { return document.documentElement.clientWidth; };
1698:
1699: Geometry.getHorizontalScroll =
1700: function() { return document.documentElement.scrollLeft; };
1701: Geometry.getVerticalScroll =
1702: function() { return document.documentElement.scrollTop; };
1703: }
1704: else if (document.body.clientHeight) {
1705: Geometry.getViewportHeight =
1706: function() { return document.body.clientHeight; };
1707: Geometry.getViewportWidth =
1708: function() { return document.body.clientWidth; };
1709: Geometry.getHorizontalScroll =
1710: function() { return document.body.scrollLeft; };
1711: Geometry.getVerticalScroll =
1712: function() { return document.body.scrollTop; };
1713: }
1714: }
1715:
1716: GEOMETRY
1717: }
1718:
1719: =pod
1720:
1.648 raeburn 1721: =item * &viewport_size_js()
1.590 raeburn 1722:
1723: 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.
1724:
1725: =cut
1726:
1727: sub viewport_size_js {
1728: my $geometry = &viewport_geometry_js();
1729: return <<"DIMS";
1730:
1731: $geometry
1732:
1733: function getViewportDims(width,height) {
1734: init_geometry();
1735: width.value = Geometry.getViewportWidth();
1736: height.value = Geometry.getViewportHeight();
1737: return;
1738: }
1739:
1740: DIMS
1741: }
1742:
1743: =pod
1744:
1.648 raeburn 1745: =item * &resize_textarea_js()
1.565 albertel 1746:
1747: emits the needed javascript to resize a textarea to be as big as possible
1748:
1749: creates a function resize_textrea that takes two IDs first should be
1750: the id of the element to resize, second should be the id of a div that
1751: surrounds everything that comes after the textarea, this routine needs
1752: to be attached to the <body> for the onload and onresize events.
1753:
1.648 raeburn 1754: =back
1.565 albertel 1755:
1756: =cut
1757:
1758: sub resize_textarea_js {
1.590 raeburn 1759: my $geometry = &viewport_geometry_js();
1.565 albertel 1760: return <<"RESIZE";
1761: <script type="text/javascript">
1.824 bisitz 1762: // <![CDATA[
1.590 raeburn 1763: $geometry
1.565 albertel 1764:
1.588 albertel 1765: function getX(element) {
1766: var x = 0;
1767: while (element) {
1768: x += element.offsetLeft;
1769: element = element.offsetParent;
1770: }
1771: return x;
1772: }
1773: function getY(element) {
1774: var y = 0;
1775: while (element) {
1776: y += element.offsetTop;
1777: element = element.offsetParent;
1778: }
1779: return y;
1780: }
1781:
1782:
1.565 albertel 1783: function resize_textarea(textarea_id,bottom_id) {
1784: init_geometry();
1785: var textarea = document.getElementById(textarea_id);
1786: //alert(textarea);
1787:
1.588 albertel 1788: var textarea_top = getY(textarea);
1.565 albertel 1789: var textarea_height = textarea.offsetHeight;
1790: var bottom = document.getElementById(bottom_id);
1.588 albertel 1791: var bottom_top = getY(bottom);
1.565 albertel 1792: var bottom_height = bottom.offsetHeight;
1793: var window_height = Geometry.getViewportHeight();
1.588 albertel 1794: var fudge = 23;
1.565 albertel 1795: var new_height = window_height-fudge-textarea_top-bottom_height;
1796: if (new_height < 300) {
1797: new_height = 300;
1798: }
1799: textarea.style.height=new_height+'px';
1800: }
1.824 bisitz 1801: // ]]>
1.565 albertel 1802: </script>
1803: RESIZE
1804:
1805: }
1806:
1.1205 golterma 1807: sub colorfuleditor_js {
1.1248 raeburn 1808: my $browse_or_search;
1809: my $respath;
1810: my ($cnum,$cdom) = &crsauthor_url();
1811: if ($cnum) {
1812: $respath = "/res/$cdom/$cnum/";
1813: my %js_lt = &Apache::lonlocal::texthash(
1814: sunm => 'Sub-directory name',
1815: save => 'Save page to make this permanent',
1816: );
1817: &js_escape(\%js_lt);
1818: $browse_or_search = <<"END";
1819:
1820: function toggleChooser(form,element,titleid,only,search) {
1821: var disp = 'none';
1822: if (document.getElementById('chooser_'+element)) {
1823: var curr = document.getElementById('chooser_'+element).style.display;
1824: if (curr == 'none') {
1825: disp='inline';
1826: if (form.elements['chooser_'+element].length) {
1827: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1828: form.elements['chooser_'+element][i].checked = false;
1829: }
1830: }
1831: toggleResImport(form,element);
1832: }
1833: document.getElementById('chooser_'+element).style.display = disp;
1834: }
1835: }
1836:
1837: function toggleCrsFile(form,element,numdirs) {
1838: if (document.getElementById('chooser_'+element+'_crsres')) {
1839: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1840: if (curr == 'none') {
1841: if (numdirs) {
1842: form.elements['coursepath_'+element].selectedIndex = 0;
1843: if (numdirs > 1) {
1844: window['select1'+element+'_changed']();
1845: }
1846: }
1847: }
1848: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1849:
1850: }
1851: if (document.getElementById('chooser_'+element+'_upload')) {
1852: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1853: if (document.getElementById('uploadcrsres_'+element)) {
1854: document.getElementById('uploadcrsres_'+element).value = '';
1855: }
1856: }
1857: return;
1858: }
1859:
1860: function toggleCrsUpload(form,element,numcrsdirs) {
1861: if (document.getElementById('chooser_'+element+'_crsres')) {
1862: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1863: }
1864: if (document.getElementById('chooser_'+element+'_upload')) {
1865: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1866: if (curr == 'none') {
1867: if (numcrsdirs) {
1868: form.elements['crsauthorpath_'+element].selectedIndex = 0;
1869: form.elements['newsubdir_'+element][0].checked = true;
1870: toggleNewsubdir(form,element);
1871: }
1872: }
1873: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1874: }
1875: return;
1876: }
1877:
1878: function toggleResImport(form,element) {
1879: var choices = new Array('crsres','upload');
1880: for (var i=0; i<choices.length; i++) {
1881: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1882: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1883: }
1884: }
1885: }
1886:
1887: function toggleNewsubdir(form,element) {
1888: var newsub = form.elements['newsubdir_'+element];
1889: if (newsub) {
1890: if (newsub.length) {
1891: for (var j=0; j<newsub.length; j++) {
1892: if (newsub[j].checked) {
1893: if (document.getElementById('newsubdirname_'+element)) {
1894: if (newsub[j].value == '1') {
1895: document.getElementById('newsubdirname_'+element).type = "text";
1896: if (document.getElementById('newsubdir_'+element)) {
1897: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1898: }
1899: } else {
1900: document.getElementById('newsubdirname_'+element).type = "hidden";
1901: document.getElementById('newsubdirname_'+element).value = "";
1902: document.getElementById('newsubdir_'+element).innerHTML = "";
1903: }
1904: }
1905: break;
1906: }
1907: }
1908: }
1909: }
1910: }
1911:
1912: function updateCrsFile(form,element) {
1913: var directory = form.elements['coursepath_'+element];
1914: var filename = form.elements['coursefile_'+element];
1915: var path = directory.options[directory.selectedIndex].value;
1916: var file = filename.options[filename.selectedIndex].value;
1917: form.elements[element].value = '$respath';
1918: if (path == '/') {
1919: form.elements[element].value += file;
1920: } else {
1921: form.elements[element].value += path+'/'+file;
1922: }
1923: unClean();
1924: if (document.getElementById('previewimg_'+element)) {
1925: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1926: var newsrc = document.getElementById('previewimg_'+element).src;
1927: }
1928: if (document.getElementById('showimg_'+element)) {
1929: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1930: }
1931: toggleChooser(form,element);
1932: return;
1933: }
1934:
1935: function uploadDone(suffix,name) {
1936: if (name) {
1937: document.forms["lonhomework"].elements[suffix].value = name;
1938: unClean();
1939: toggleChooser(document.forms["lonhomework"],suffix);
1940: }
1941: }
1942:
1943: \$(document).ready(function(){
1944:
1945: \$(document).delegate('form :submit', 'click', function( event ) {
1946: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
1947: var buttonId = this.id;
1948: var suffix = buttonId.toString();
1949: suffix = suffix.replace(/^crsupload_/,'');
1950: event.preventDefault();
1951: document.lonhomework.target = 'crsupload_target_'+suffix;
1952: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
1953: \$(this.form).submit();
1954: document.lonhomework.target = '';
1955: if (document.getElementById('crsuploadto_'+suffix)) {
1956: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
1957: }
1958: return false;
1959: }
1960: });
1961: });
1962: END
1963: }
1.1205 golterma 1964: return <<"COLORFULEDIT"
1965: <script type="text/javascript">
1966: // <![CDATA[>
1967: function fold_box(curDepth, lastresource){
1968:
1969: // we need a list because there can be several blocks you need to fold in one tag
1970: var block = document.getElementsByName('foldblock_'+curDepth);
1971: // but there is only one folding button per tag
1972: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1973:
1974: if(block.item(0).style.display == 'none'){
1975:
1976: foldbutton.value = '@{[&mt("Hide")]}';
1977: for (i = 0; i < block.length; i++){
1978: block.item(i).style.display = '';
1979: }
1980: }else{
1981:
1982: foldbutton.value = '@{[&mt("Show")]}';
1983: for (i = 0; i < block.length; i++){
1984: // block.item(i).style.visibility = 'collapse';
1985: block.item(i).style.display = 'none';
1986: }
1987: };
1988: saveState(lastresource);
1989: }
1990:
1991: function saveState (lastresource) {
1992:
1993: var tag_list = getTagList();
1994: if(tag_list != null){
1995: var timestamp = new Date().getTime();
1996: var key = lastresource;
1997:
1998: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1999: // starting with timestamp
2000: var value = timestamp+';';
2001:
2002: // building the list of key-value pairs
2003: for(var i = 0; i < tag_list.length; i++){
2004: value += tag_list[i]+',';
2005: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2006: }
2007:
2008: // only iterate whole storage if nothing to override
2009: if(localStorage.getItem(key) == null){
2010:
2011: // prevent storage from growing large
2012: if(localStorage.length > 50){
2013: var regex_getTimestamp = /^(?:\d)+;/;
2014: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2015: var oldest_key;
2016:
2017: for(var i = 1; i < localStorage.length; i++){
2018: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2019: oldest_key = localStorage.key(i);
2020: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2021: }
2022: }
2023: localStorage.removeItem(oldest_key);
2024: }
2025: }
2026: localStorage.setItem(key,value);
2027: }
2028: }
2029:
2030: // restore folding status of blocks (on page load)
2031: function restoreState (lastresource) {
2032: if(localStorage.getItem(lastresource) != null){
2033: var key = lastresource;
2034: var value = localStorage.getItem(key);
2035: var regex_delTimestamp = /^\d+;/;
2036:
2037: value.replace(regex_delTimestamp, '');
2038:
2039: var valueArr = value.split(';');
2040: var pairs;
2041: var elements;
2042: for (var i = 0; i < valueArr.length; i++){
2043: pairs = valueArr[i].split(',');
2044: elements = document.getElementsByName(pairs[0]);
2045:
2046: for (var j = 0; j < elements.length; j++){
2047: elements[j].style.display = pairs[1];
2048: if (pairs[1] == "none"){
2049: var regex_id = /([_\\d]+)\$/;
2050: regex_id.exec(pairs[0]);
2051: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2052: }
2053: }
2054: }
2055: }
2056: }
2057:
2058: function getTagList () {
2059:
2060: var stringToSearch = document.lonhomework.innerHTML;
2061:
2062: var ret = new Array();
2063: var regex_findBlock = /(foldblock_.*?)"/g;
2064: var tag_list = stringToSearch.match(regex_findBlock);
2065:
2066: if(tag_list != null){
2067: for(var i = 0; i < tag_list.length; i++){
2068: ret.push(tag_list[i].replace(/"/, ''));
2069: }
2070: }
2071: return ret;
2072: }
2073:
2074: function saveScrollPosition (resource) {
2075: var tag_list = getTagList();
2076:
2077: // we dont always want to jump to the first block
2078: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2079: if(\$(window).scrollTop() > 170){
2080: if(tag_list != null){
2081: var result;
2082: for(var i = 0; i < tag_list.length; i++){
2083: if(isElementInViewport(tag_list[i])){
2084: result += tag_list[i]+';';
2085: }
2086: }
2087: sessionStorage.setItem('anchor_'+resource, result);
2088: }
2089: } else {
2090: // we dont need to save zero, just delete the item to leave everything tidy
2091: sessionStorage.removeItem('anchor_'+resource);
2092: }
2093: }
2094:
2095: function restoreScrollPosition(resource){
2096:
2097: var elem = sessionStorage.getItem('anchor_'+resource);
2098: if(elem != null){
2099: var tag_list = elem.split(';');
2100: var elem_list;
2101:
2102: for(var i = 0; i < tag_list.length; i++){
2103: elem_list = document.getElementsByName(tag_list[i]);
2104:
2105: if(elem_list.length > 0){
2106: elem = elem_list[0];
2107: break;
2108: }
2109: }
2110: elem.scrollIntoView();
2111: }
2112: }
2113:
2114: function isElementInViewport(el) {
2115:
2116: // change to last element instead of first
2117: var elem = document.getElementsByName(el);
2118: var rect = elem[0].getBoundingClientRect();
2119:
2120: return (
2121: rect.top >= 0 &&
2122: rect.left >= 0 &&
2123: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2124: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2125: );
2126: }
2127:
2128: function autosize(depth){
2129: var cmInst = window['cm'+depth];
2130: var fitsizeButton = document.getElementById('fitsize'+depth);
2131:
2132: // is fixed size, switching to dynamic
2133: if (sessionStorage.getItem("autosized_"+depth) == null) {
2134: cmInst.setSize("","auto");
2135: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2136: sessionStorage.setItem("autosized_"+depth, "yes");
2137:
2138: // is dynamic size, switching to fixed
2139: } else {
2140: cmInst.setSize("","300px");
2141: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2142: sessionStorage.removeItem("autosized_"+depth);
2143: }
2144: }
2145:
1.1248 raeburn 2146: $browse_or_search
1.1205 golterma 2147:
2148: // ]]>
2149: </script>
2150: COLORFULEDIT
2151: }
2152:
2153: sub xmleditor_js {
2154: return <<XMLEDIT
2155: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2156: <script type="text/javascript">
2157: // <![CDATA[>
2158:
2159: function saveScrollPosition (resource) {
2160:
2161: var scrollPos = \$(window).scrollTop();
2162: sessionStorage.setItem(resource,scrollPos);
2163: }
2164:
2165: function restoreScrollPosition(resource){
2166:
2167: var scrollPos = sessionStorage.getItem(resource);
2168: \$(window).scrollTop(scrollPos);
2169: }
2170:
2171: // unless internet explorer
2172: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2173:
2174: \$(document).ready(function() {
2175: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2176: });
2177: }
2178:
2179: // inserts text at cursor position into codemirror (xml editor only)
2180: function insertText(text){
2181: cm.focus();
2182: var curPos = cm.getCursor();
2183: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2184: }
2185: // ]]>
2186: </script>
2187: XMLEDIT
2188: }
2189:
2190: sub insert_folding_button {
2191: my $curDepth = $Apache::lonxml::curdepth;
2192: my $lastresource = $env{'request.ambiguous'};
2193:
2194: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2195: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2196: }
2197:
1.1248 raeburn 2198: sub crsauthor_url {
2199: my ($url) = @_;
2200: if ($url eq '') {
2201: $url = $ENV{'REQUEST_URI'};
2202: }
2203: my ($cnum,$cdom);
2204: if ($env{'request.course.id'}) {
2205: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2206: if ($audom ne '' && $auname ne '') {
2207: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2208: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2209: $cnum = $auname;
2210: $cdom = $audom;
2211: }
2212: }
2213: }
2214: return ($cnum,$cdom);
2215: }
2216:
2217: sub import_crsauthor_form {
1.1265 raeburn 2218: my ($form,$firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2219: return (0) unless ($env{'request.course.id'});
2220: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2221: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2222: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2223: return (0) unless (($cnum ne '') && ($cdom ne ''));
2224: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
2225: my @ids=&Apache::lonnet::current_machine_ids();
2226: my ($output,$is_home,$relpath,%subdirs,%files,%selimport_menus);
2227:
2228: if (grep(/^\Q$crshome\E$/,@ids)) {
2229: $is_home = 1;
2230: }
2231: $relpath = "/priv/$cdom/$cnum";
2232: &Apache::lonnet::recursedirs($is_home,'priv',$londocroot,$relpath,'',\%subdirs,\%files);
2233: my %lt = &Apache::lonlocal::texthash (
2234: fnam => 'Filename',
2235: dire => 'Directory',
2236: );
2237: my $numdirs = scalar(keys(%files));
2238: my (%possexts,$singledir,@singledirfiles);
2239: if ($only) {
2240: map { $possexts{$_} = 1; } split(/\s*,\s*/,$only);
2241: }
2242: my (%nonemptydirs,$possdirs);
2243: if ($numdirs > 1) {
2244: my @order;
2245: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
2246: if (ref($files{$key}) eq 'HASH') {
2247: my $shown = $key;
2248: if ($key eq '') {
2249: $shown = '/';
2250: }
2251: my @ordered = ();
2252: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$key}}))) {
1.1315 raeburn 2253: next if ($file =~ /\.rights$/);
1.1248 raeburn 2254: if ($only) {
2255: my ($ext) = ($file =~ /\.([^.]+)$/);
2256: unless ($possexts{lc($ext)}) {
2257: next;
2258: }
2259: }
2260: $selimport_menus{$key}->{'select2'}->{$file} = $file;
2261: push(@ordered,$file);
2262: }
2263: if (@ordered) {
2264: push(@order,$key);
2265: $nonemptydirs{$key} = 1;
2266: $selimport_menus{$key}->{'text'} = $shown;
2267: $selimport_menus{$key}->{'default'} = '';
2268: $selimport_menus{$key}->{'select2'}->{''} = '';
2269: $selimport_menus{$key}->{'order'} = \@ordered;
2270: }
2271: }
2272: }
2273: $possdirs = scalar(keys(%nonemptydirs));
2274: if ($possdirs > 1) {
2275: my @order = sort { lc($a) cmp lc($b) } (keys(%nonemptydirs));
2276: $output = $lt{'dire'}.
2277: &linked_select_forms($form,'<br />'.
2278: $lt{'fnam'},'',
2279: $firstselectname,$secondselectname,
2280: \%selimport_menus,\@order,
2281: $onchangefirst,'',$suffix).'<br />';
2282: } elsif ($possdirs == 1) {
2283: $singledir = (keys(%nonemptydirs))[0];
2284: if (ref($selimport_menus{$singledir}->{'order'}) eq 'ARRAY') {
2285: @singledirfiles = @{$selimport_menus{$singledir}->{'order'}};
2286: }
2287: delete($selimport_menus{$singledir});
2288: }
2289: } elsif ($numdirs == 1) {
2290: $singledir = (keys(%files))[0];
2291: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$singledir}}))) {
2292: if ($only) {
2293: my ($ext) = ($file =~ /\.([^.]+)$/);
2294: unless ($possexts{lc($ext)}) {
2295: next;
2296: }
1.1315 raeburn 2297: } else {
2298: next if ($file =~ /\.rights$/);
1.1248 raeburn 2299: }
2300: push(@singledirfiles,$file);
2301: }
2302: if (@singledirfiles) {
1.1315 raeburn 2303: $possdirs = 1;
1.1248 raeburn 2304: }
2305: }
2306: if (($possdirs == 1) && (@singledirfiles)) {
2307: my $showdir = $singledir;
2308: if ($singledir eq '') {
2309: $showdir = '/';
2310: }
2311: $output = $lt{'dire'}.
2312: '<select name="'.$firstselectname.'">'.
2313: '<option value="'.$singledir.'">'.$showdir.'</option>'."\n".
2314: '</select><br />'.
2315: $lt{'fnam'}.'<select name="'.$secondselectname.'">'."\n".
2316: '<option value="" selected="selected">'.$lt{'se'}.'</option>'."\n";
2317: foreach my $file (@singledirfiles) {
2318: $output .= '<option value="'.$file.'">'.$file.'</option>'."\n";
2319: }
2320: $output .= '</select><br />'."\n";
2321: }
2322: return ($possdirs,$output);
2323: }
2324:
1.565 albertel 2325: =pod
2326:
1.256 matthew 2327: =head1 Excel and CSV file utility routines
2328:
2329: =cut
2330:
2331: ###############################################################
2332: ###############################################################
2333:
2334: =pod
2335:
1.1162 raeburn 2336: =over 4
2337:
1.648 raeburn 2338: =item * &csv_translate($text)
1.37 matthew 2339:
1.185 www 2340: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2341: format.
2342:
2343: =cut
2344:
1.180 matthew 2345: ###############################################################
2346: ###############################################################
1.37 matthew 2347: sub csv_translate {
2348: my $text = shift;
2349: $text =~ s/\"/\"\"/g;
1.209 albertel 2350: $text =~ s/\n/ /g;
1.37 matthew 2351: return $text;
2352: }
1.180 matthew 2353:
2354: ###############################################################
2355: ###############################################################
2356:
2357: =pod
2358:
1.648 raeburn 2359: =item * &define_excel_formats()
1.180 matthew 2360:
2361: Define some commonly used Excel cell formats.
2362:
2363: Currently supported formats:
2364:
2365: =over 4
2366:
2367: =item header
2368:
2369: =item bold
2370:
2371: =item h1
2372:
2373: =item h2
2374:
2375: =item h3
2376:
1.256 matthew 2377: =item h4
2378:
2379: =item i
2380:
1.180 matthew 2381: =item date
2382:
2383: =back
2384:
2385: Inputs: $workbook
2386:
2387: Returns: $format, a hash reference.
2388:
1.1057 foxr 2389:
1.180 matthew 2390: =cut
2391:
2392: ###############################################################
2393: ###############################################################
2394: sub define_excel_formats {
2395: my ($workbook) = @_;
2396: my $format;
2397: $format->{'header'} = $workbook->add_format(bold => 1,
2398: bottom => 1,
2399: align => 'center');
2400: $format->{'bold'} = $workbook->add_format(bold=>1);
2401: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2402: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2403: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2404: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2405: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2406: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2407: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2408: return $format;
2409: }
2410:
2411: ###############################################################
2412: ###############################################################
1.113 bowersj2 2413:
2414: =pod
2415:
1.648 raeburn 2416: =item * &create_workbook()
1.255 matthew 2417:
2418: Create an Excel worksheet. If it fails, output message on the
2419: request object and return undefs.
2420:
2421: Inputs: Apache request object
2422:
2423: Returns (undef) on failure,
2424: Excel worksheet object, scalar with filename, and formats
2425: from &Apache::loncommon::define_excel_formats on success
2426:
2427: =cut
2428:
2429: ###############################################################
2430: ###############################################################
2431: sub create_workbook {
2432: my ($r) = @_;
2433: #
2434: # Create the excel spreadsheet
2435: my $filename = '/prtspool/'.
1.258 albertel 2436: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2437: time.'_'.rand(1000000000).'.xls';
2438: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2439: if (! defined($workbook)) {
2440: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2441: $r->print(
2442: '<p class="LC_error">'
2443: .&mt('Problems occurred in creating the new Excel file.')
2444: .' '.&mt('This error has been logged.')
2445: .' '.&mt('Please alert your LON-CAPA administrator.')
2446: .'</p>'
2447: );
1.255 matthew 2448: return (undef);
2449: }
2450: #
1.1014 foxr 2451: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2452: #
2453: my $format = &Apache::loncommon::define_excel_formats($workbook);
2454: return ($workbook,$filename,$format);
2455: }
2456:
2457: ###############################################################
2458: ###############################################################
2459:
2460: =pod
2461:
1.648 raeburn 2462: =item * &create_text_file()
1.113 bowersj2 2463:
1.542 raeburn 2464: Create a file to write to and eventually make available to the user.
1.256 matthew 2465: If file creation fails, outputs an error message on the request object and
2466: return undefs.
1.113 bowersj2 2467:
1.256 matthew 2468: Inputs: Apache request object, and file suffix
1.113 bowersj2 2469:
1.256 matthew 2470: Returns (undef) on failure,
2471: Filehandle and filename on success.
1.113 bowersj2 2472:
2473: =cut
2474:
1.256 matthew 2475: ###############################################################
2476: ###############################################################
2477: sub create_text_file {
2478: my ($r,$suffix) = @_;
2479: if (! defined($suffix)) { $suffix = 'txt'; };
2480: my $fh;
2481: my $filename = '/prtspool/'.
1.258 albertel 2482: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2483: time.'_'.rand(1000000000).'.'.$suffix;
2484: $fh = Apache::File->new('>/home/httpd'.$filename);
2485: if (! defined($fh)) {
2486: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2487: $r->print(
2488: '<p class="LC_error">'
2489: .&mt('Problems occurred in creating the output file.')
2490: .' '.&mt('This error has been logged.')
2491: .' '.&mt('Please alert your LON-CAPA administrator.')
2492: .'</p>'
2493: );
1.113 bowersj2 2494: }
1.256 matthew 2495: return ($fh,$filename)
1.113 bowersj2 2496: }
2497:
2498:
1.256 matthew 2499: =pod
1.113 bowersj2 2500:
2501: =back
2502:
2503: =cut
1.37 matthew 2504:
2505: ###############################################################
1.33 matthew 2506: ## Home server <option> list generating code ##
2507: ###############################################################
1.35 matthew 2508:
1.169 www 2509: # ------------------------------------------
2510:
2511: sub domain_select {
1.1289 raeburn 2512: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2513: my @possdoms;
2514: if (ref($incdoms) eq 'ARRAY') {
2515: @possdoms = @{$incdoms};
2516: } else {
2517: @possdoms = &Apache::lonnet::all_domains();
2518: }
2519:
1.169 www 2520: my %domains=map {
1.514 albertel 2521: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2522: } @possdoms;
2523:
2524: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2525: foreach my $dom (@{$excdoms}) {
2526: delete($domains{$dom});
2527: }
2528: }
2529:
1.169 www 2530: if ($multiple) {
2531: $domains{''}=&mt('Any domain');
1.550 albertel 2532: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2533: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2534: } else {
1.550 albertel 2535: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2536: return &select_form($name,$value,\%domains);
1.169 www 2537: }
2538: }
2539:
1.282 albertel 2540: #-------------------------------------------
2541:
2542: =pod
2543:
1.519 raeburn 2544: =head1 Routines for form select boxes
2545:
2546: =over 4
2547:
1.648 raeburn 2548: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2549:
2550: Returns a string containing a <select> element int multiple mode
2551:
2552:
2553: Args:
2554: $name - name of the <select> element
1.506 raeburn 2555: $value - scalar or array ref of values that should already be selected
1.282 albertel 2556: $size - number of rows long the select element is
1.283 albertel 2557: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2558: (shown text should already have been &mt())
1.506 raeburn 2559: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2560:
1.282 albertel 2561: =cut
2562:
2563: #-------------------------------------------
1.169 www 2564: sub multiple_select_form {
1.284 albertel 2565: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2566: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2567: my $output='';
1.191 matthew 2568: if (! defined($size)) {
2569: $size = 4;
1.283 albertel 2570: if (scalar(keys(%$hash))<4) {
2571: $size = scalar(keys(%$hash));
1.191 matthew 2572: }
2573: }
1.734 bisitz 2574: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2575: my @order;
1.506 raeburn 2576: if (ref($order) eq 'ARRAY') {
2577: @order = @{$order};
2578: } else {
2579: @order = sort(keys(%$hash));
1.501 banghart 2580: }
2581: if (exists($$hash{'select_form_order'})) {
2582: @order = @{$$hash{'select_form_order'}};
2583: }
2584:
1.284 albertel 2585: foreach my $key (@order) {
1.356 albertel 2586: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2587: $output.='selected="selected" ' if ($selected{$key});
2588: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2589: }
2590: $output.="</select>\n";
2591: return $output;
2592: }
2593:
1.88 www 2594: #-------------------------------------------
2595:
2596: =pod
2597:
1.1254 raeburn 2598: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2599:
2600: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2601: allow a user to select options from a ref to a hash containing:
2602: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2603: a javascript onchange item, e.g., onchange="this.form.submit();".
2604: An optional arg -- $readonly -- if true will cause the select form
2605: to be disabled, e.g., for the case where an instructor has a section-
2606: specific role, and is viewing/modifying parameters.
1.970 raeburn 2607:
1.88 www 2608: See lonrights.pm for an example invocation and use.
2609:
2610: =cut
2611:
2612: #-------------------------------------------
2613: sub select_form {
1.1228 raeburn 2614: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2615: return unless (ref($hashref) eq 'HASH');
2616: if ($onchange) {
2617: $onchange = ' onchange="'.$onchange.'"';
2618: }
1.1228 raeburn 2619: my $disabled;
2620: if ($readonly) {
2621: $disabled = ' disabled="disabled"';
2622: }
2623: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2624: my @keys;
1.970 raeburn 2625: if (exists($hashref->{'select_form_order'})) {
2626: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2627: } else {
1.970 raeburn 2628: @keys=sort(keys(%{$hashref}));
1.128 albertel 2629: }
1.356 albertel 2630: foreach my $key (@keys) {
2631: $selectform.=
2632: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2633: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2634: ">".$hashref->{$key}."</option>\n";
1.88 www 2635: }
2636: $selectform.="</select>";
2637: return $selectform;
2638: }
2639:
1.475 www 2640: # For display filters
2641:
2642: sub display_filter {
1.1074 raeburn 2643: my ($context) = @_;
1.475 www 2644: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2645: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2646: my $phraseinput = 'hidden';
2647: my $includeinput = 'hidden';
2648: my ($checked,$includetypestext);
2649: if ($env{'form.displayfilter'} eq 'containing') {
2650: $phraseinput = 'text';
2651: if ($context eq 'parmslog') {
2652: $includeinput = 'checkbox';
2653: if ($env{'form.includetypes'}) {
2654: $checked = ' checked="checked"';
2655: }
2656: $includetypestext = &mt('Include parameter types');
2657: }
2658: } else {
2659: $includetypestext = ' ';
2660: }
2661: my ($additional,$secondid,$thirdid);
2662: if ($context eq 'parmslog') {
2663: $additional =
2664: '<label><input type="'.$includeinput.'" name="includetypes"'.
2665: $checked.' name="includetypes" value="1" id="includetypes" />'.
2666: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2667: '</label>';
2668: $secondid = 'includetypes';
2669: $thirdid = 'includetypestext';
2670: }
2671: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2672: '$secondid','$thirdid')";
2673: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2674: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2675: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2676: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2677: &mt('Filter: [_1]',
1.477 www 2678: &select_form($env{'form.displayfilter'},
2679: 'displayfilter',
1.970 raeburn 2680: {'currentfolder' => 'Current folder/page',
1.477 www 2681: 'containing' => 'Containing phrase',
1.1074 raeburn 2682: 'none' => 'None'},$onchange)).' '.
2683: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2684: &HTML::Entities::encode($env{'form.containingphrase'}).
2685: '" />'.$additional;
2686: }
2687:
2688: sub display_filter_js {
2689: my $includetext = &mt('Include parameter types');
2690: return <<"ENDJS";
2691:
2692: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2693: var firstType = 'hidden';
2694: if (setter.options[setter.selectedIndex].value == 'containing') {
2695: firstType = 'text';
2696: }
2697: firstObject = document.getElementById(firstid);
2698: if (typeof(firstObject) == 'object') {
2699: if (firstObject.type != firstType) {
2700: changeInputType(firstObject,firstType);
2701: }
2702: }
2703: if (context == 'parmslog') {
2704: var secondType = 'hidden';
2705: if (firstType == 'text') {
2706: secondType = 'checkbox';
2707: }
2708: secondObject = document.getElementById(secondid);
2709: if (typeof(secondObject) == 'object') {
2710: if (secondObject.type != secondType) {
2711: changeInputType(secondObject,secondType);
2712: }
2713: }
2714: var textItem = document.getElementById(thirdid);
2715: var currtext = textItem.innerHTML;
2716: var newtext;
2717: if (firstType == 'text') {
2718: newtext = '$includetext';
2719: } else {
2720: newtext = ' ';
2721: }
2722: if (currtext != newtext) {
2723: textItem.innerHTML = newtext;
2724: }
2725: }
2726: return;
2727: }
2728:
2729: function changeInputType(oldObject,newType) {
2730: var newObject = document.createElement('input');
2731: newObject.type = newType;
2732: if (oldObject.size) {
2733: newObject.size = oldObject.size;
2734: }
2735: if (oldObject.value) {
2736: newObject.value = oldObject.value;
2737: }
2738: if (oldObject.name) {
2739: newObject.name = oldObject.name;
2740: }
2741: if (oldObject.id) {
2742: newObject.id = oldObject.id;
2743: }
2744: oldObject.parentNode.replaceChild(newObject,oldObject);
2745: return;
2746: }
2747:
2748: ENDJS
1.475 www 2749: }
2750:
1.167 www 2751: sub gradeleveldescription {
2752: my $gradelevel=shift;
2753: my %gradelevels=(0 => 'Not specified',
2754: 1 => 'Grade 1',
2755: 2 => 'Grade 2',
2756: 3 => 'Grade 3',
2757: 4 => 'Grade 4',
2758: 5 => 'Grade 5',
2759: 6 => 'Grade 6',
2760: 7 => 'Grade 7',
2761: 8 => 'Grade 8',
2762: 9 => 'Grade 9',
2763: 10 => 'Grade 10',
2764: 11 => 'Grade 11',
2765: 12 => 'Grade 12',
2766: 13 => 'Grade 13',
2767: 14 => '100 Level',
2768: 15 => '200 Level',
2769: 16 => '300 Level',
2770: 17 => '400 Level',
2771: 18 => 'Graduate Level');
2772: return &mt($gradelevels{$gradelevel});
2773: }
2774:
1.163 www 2775: sub select_level_form {
2776: my ($deflevel,$name)=@_;
2777: unless ($deflevel) { $deflevel=0; }
1.167 www 2778: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2779: for (my $i=0; $i<=18; $i++) {
2780: $selectform.="<option value=\"$i\" ".
1.253 albertel 2781: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2782: ">".&gradeleveldescription($i)."</option>\n";
2783: }
2784: $selectform.="</select>";
2785: return $selectform;
1.163 www 2786: }
1.167 www 2787:
1.35 matthew 2788: #-------------------------------------------
2789:
1.45 matthew 2790: =pod
2791:
1.1256 raeburn 2792: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2793:
2794: Returns a string containing a <select name='$name' size='1'> form to
2795: allow a user to select the domain to preform an operation in.
2796: See loncreateuser.pm for an example invocation and use.
2797:
1.90 www 2798: If the $includeempty flag is set, it also includes an empty choice ("no domain
2799: selected");
2800:
1.743 raeburn 2801: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2802:
1.910 raeburn 2803: 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.
2804:
1.1121 raeburn 2805: The optional $incdoms is a reference to an array of domains which will be the only available options.
2806:
2807: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2808:
1.1256 raeburn 2809: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
2810:
1.35 matthew 2811: =cut
2812:
2813: #-------------------------------------------
1.34 matthew 2814: sub select_dom_form {
1.1256 raeburn 2815: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2816: if ($onchange) {
1.874 raeburn 2817: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2818: }
1.1256 raeburn 2819: if ($disabled) {
2820: $disabled = ' disabled="disabled"';
2821: }
1.1121 raeburn 2822: my (@domains,%exclude);
1.910 raeburn 2823: if (ref($incdoms) eq 'ARRAY') {
2824: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2825: } else {
2826: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2827: }
1.90 www 2828: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2829: if (ref($excdoms) eq 'ARRAY') {
2830: map { $exclude{$_} = 1; } @{$excdoms};
2831: }
1.1256 raeburn 2832: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2833: foreach my $dom (@domains) {
1.1121 raeburn 2834: next if ($exclude{$dom});
1.356 albertel 2835: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2836: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2837: if ($showdomdesc) {
2838: if ($dom ne '') {
2839: my $domdesc = &Apache::lonnet::domain($dom,'description');
2840: if ($domdesc ne '') {
2841: $selectdomain .= ' ('.$domdesc.')';
2842: }
2843: }
2844: }
2845: $selectdomain .= "</option>\n";
1.34 matthew 2846: }
2847: $selectdomain.="</select>";
2848: return $selectdomain;
2849: }
2850:
1.35 matthew 2851: #-------------------------------------------
2852:
1.45 matthew 2853: =pod
2854:
1.648 raeburn 2855: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2856:
1.586 raeburn 2857: input: 4 arguments (two required, two optional) -
2858: $domain - domain of new user
2859: $name - name of form element
2860: $default - Value of 'default' causes a default item to be first
2861: option, and selected by default.
2862: $hide - Value of 'hide' causes hiding of the name of the server,
2863: if 1 server found, or default, if 0 found.
1.594 raeburn 2864: output: returns 2 items:
1.586 raeburn 2865: (a) form element which contains either:
2866: (i) <select name="$name">
2867: <option value="$hostid1">$hostid $servers{$hostid}</option>
2868: <option value="$hostid2">$hostid $servers{$hostid}</option>
2869: </select>
2870: form item if there are multiple library servers in $domain, or
2871: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2872: if there is only one library server in $domain.
2873:
2874: (b) number of library servers found.
2875:
2876: See loncreateuser.pm for example of use.
1.35 matthew 2877:
2878: =cut
2879:
2880: #-------------------------------------------
1.586 raeburn 2881: sub home_server_form_item {
2882: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2883: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2884: my $result;
2885: my $numlib = keys(%servers);
2886: if ($numlib > 1) {
2887: $result .= '<select name="'.$name.'" />'."\n";
2888: if ($default) {
1.804 bisitz 2889: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2890: '</option>'."\n";
2891: }
2892: foreach my $hostid (sort(keys(%servers))) {
2893: $result.= '<option value="'.$hostid.'">'.
2894: $hostid.' '.$servers{$hostid}."</option>\n";
2895: }
2896: $result .= '</select>'."\n";
2897: } elsif ($numlib == 1) {
2898: my $hostid;
2899: foreach my $item (keys(%servers)) {
2900: $hostid = $item;
2901: }
2902: $result .= '<input type="hidden" name="'.$name.'" value="'.
2903: $hostid.'" />';
2904: if (!$hide) {
2905: $result .= $hostid.' '.$servers{$hostid};
2906: }
2907: $result .= "\n";
2908: } elsif ($default) {
2909: $result .= '<input type="hidden" name="'.$name.
2910: '" value="default" />';
2911: if (!$hide) {
2912: $result .= &mt('default');
2913: }
2914: $result .= "\n";
1.33 matthew 2915: }
1.586 raeburn 2916: return ($result,$numlib);
1.33 matthew 2917: }
1.112 bowersj2 2918:
2919: =pod
2920:
1.534 albertel 2921: =back
2922:
1.112 bowersj2 2923: =cut
1.87 matthew 2924:
2925: ###############################################################
1.112 bowersj2 2926: ## Decoding User Agent ##
1.87 matthew 2927: ###############################################################
2928:
2929: =pod
2930:
1.112 bowersj2 2931: =head1 Decoding the User Agent
2932:
2933: =over 4
2934:
2935: =item * &decode_user_agent()
1.87 matthew 2936:
2937: Inputs: $r
2938:
2939: Outputs:
2940:
2941: =over 4
2942:
1.112 bowersj2 2943: =item * $httpbrowser
1.87 matthew 2944:
1.112 bowersj2 2945: =item * $clientbrowser
1.87 matthew 2946:
1.112 bowersj2 2947: =item * $clientversion
1.87 matthew 2948:
1.112 bowersj2 2949: =item * $clientmathml
1.87 matthew 2950:
1.112 bowersj2 2951: =item * $clientunicode
1.87 matthew 2952:
1.112 bowersj2 2953: =item * $clientos
1.87 matthew 2954:
1.1137 raeburn 2955: =item * $clientmobile
2956:
1.1141 raeburn 2957: =item * $clientinfo
2958:
1.1194 raeburn 2959: =item * $clientosversion
2960:
1.87 matthew 2961: =back
2962:
1.157 matthew 2963: =back
2964:
1.87 matthew 2965: =cut
2966:
2967: ###############################################################
2968: ###############################################################
2969: sub decode_user_agent {
1.247 albertel 2970: my ($r)=@_;
1.87 matthew 2971: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2972: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2973: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2974: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2975: my $clientbrowser='unknown';
2976: my $clientversion='0';
2977: my $clientmathml='';
2978: my $clientunicode='0';
1.1137 raeburn 2979: my $clientmobile=0;
1.1194 raeburn 2980: my $clientosversion='';
1.87 matthew 2981: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 2982: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2983: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2984: $clientbrowser=$bname;
2985: $httpbrowser=~/$vreg/i;
2986: $clientversion=$1;
2987: $clientmathml=($clientversion>=$minv);
2988: $clientunicode=($clientversion>=$univ);
2989: }
2990: }
2991: my $clientos='unknown';
1.1141 raeburn 2992: my $clientinfo;
1.87 matthew 2993: if (($httpbrowser=~/linux/i) ||
2994: ($httpbrowser=~/unix/i) ||
2995: ($httpbrowser=~/ux/i) ||
2996: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2997: if (($httpbrowser=~/vax/i) ||
2998: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2999: if ($httpbrowser=~/next/i) { $clientos='next'; }
3000: if (($httpbrowser=~/mac/i) ||
3001: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3002: if ($httpbrowser=~/win/i) {
3003: $clientos='win';
3004: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3005: $clientosversion = $1;
3006: }
3007: }
1.87 matthew 3008: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3009: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3010: $clientmobile=lc($1);
3011: }
1.1141 raeburn 3012: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3013: $clientinfo = 'firefox-'.$1;
3014: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3015: $clientinfo = 'chromeframe-'.$1;
3016: }
1.87 matthew 3017: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3018: $clientunicode,$clientos,$clientmobile,$clientinfo,
3019: $clientosversion);
1.87 matthew 3020: }
3021:
1.32 matthew 3022: ###############################################################
3023: ## Authentication changing form generation subroutines ##
3024: ###############################################################
3025: ##
3026: ## All of the authform_xxxxxxx subroutines take their inputs in a
3027: ## hash, and have reasonable default values.
3028: ##
3029: ## formname = the name given in the <form> tag.
1.35 matthew 3030: #-------------------------------------------
3031:
1.45 matthew 3032: =pod
3033:
1.112 bowersj2 3034: =head1 Authentication Routines
3035:
3036: =over 4
3037:
1.648 raeburn 3038: =item * &authform_xxxxxx()
1.35 matthew 3039:
3040: The authform_xxxxxx subroutines provide javascript and html forms which
3041: handle some of the conveniences required for authentication forms.
3042: This is not an optimal method, but it works.
3043:
3044: =over 4
3045:
1.112 bowersj2 3046: =item * authform_header
1.35 matthew 3047:
1.112 bowersj2 3048: =item * authform_authorwarning
1.35 matthew 3049:
1.112 bowersj2 3050: =item * authform_nochange
1.35 matthew 3051:
1.112 bowersj2 3052: =item * authform_kerberos
1.35 matthew 3053:
1.112 bowersj2 3054: =item * authform_internal
1.35 matthew 3055:
1.112 bowersj2 3056: =item * authform_filesystem
1.35 matthew 3057:
1.1310 raeburn 3058: =item * authform_lti
3059:
1.35 matthew 3060: =back
3061:
1.648 raeburn 3062: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3063:
1.35 matthew 3064: =cut
3065:
3066: #-------------------------------------------
1.32 matthew 3067: sub authform_header{
3068: my %in = (
3069: formname => 'cu',
1.80 albertel 3070: kerb_def_dom => '',
1.32 matthew 3071: @_,
3072: );
3073: $in{'formname'} = 'document.' . $in{'formname'};
3074: my $result='';
1.80 albertel 3075:
3076: #---------------------------------------------- Code for upper case translation
3077: my $Javascript_toUpperCase;
3078: unless ($in{kerb_def_dom}) {
3079: $Javascript_toUpperCase =<<"END";
3080: switch (choice) {
3081: case 'krb': currentform.elements[choicearg].value =
3082: currentform.elements[choicearg].value.toUpperCase();
3083: break;
3084: default:
3085: }
3086: END
3087: } else {
3088: $Javascript_toUpperCase = "";
3089: }
3090:
1.165 raeburn 3091: my $radioval = "'nochange'";
1.591 raeburn 3092: if (defined($in{'curr_authtype'})) {
3093: if ($in{'curr_authtype'} ne '') {
3094: $radioval = "'".$in{'curr_authtype'}."arg'";
3095: }
1.174 matthew 3096: }
1.165 raeburn 3097: my $argfield = 'null';
1.591 raeburn 3098: if (defined($in{'mode'})) {
1.165 raeburn 3099: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3100: if (defined($in{'curr_autharg'})) {
3101: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3102: $argfield = "'$in{'curr_autharg'}'";
3103: }
3104: }
3105: }
3106: }
3107:
1.32 matthew 3108: $result.=<<"END";
3109: var current = new Object();
1.165 raeburn 3110: current.radiovalue = $radioval;
3111: current.argfield = $argfield;
1.32 matthew 3112:
3113: function changed_radio(choice,currentform) {
3114: var choicearg = choice + 'arg';
3115: // If a radio button in changed, we need to change the argfield
3116: if (current.radiovalue != choice) {
3117: current.radiovalue = choice;
3118: if (current.argfield != null) {
3119: currentform.elements[current.argfield].value = '';
3120: }
3121: if (choice == 'nochange') {
3122: current.argfield = null;
3123: } else {
3124: current.argfield = choicearg;
3125: switch(choice) {
3126: case 'krb':
3127: currentform.elements[current.argfield].value =
3128: "$in{'kerb_def_dom'}";
3129: break;
3130: default:
3131: break;
3132: }
3133: }
3134: }
3135: return;
3136: }
1.22 www 3137:
1.32 matthew 3138: function changed_text(choice,currentform) {
3139: var choicearg = choice + 'arg';
3140: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3141: $Javascript_toUpperCase
1.32 matthew 3142: // clear old field
3143: if ((current.argfield != choicearg) && (current.argfield != null)) {
3144: currentform.elements[current.argfield].value = '';
3145: }
3146: current.argfield = choicearg;
3147: }
3148: set_auth_radio_buttons(choice,currentform);
3149: return;
1.20 www 3150: }
1.32 matthew 3151:
3152: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3153: var numauthchoices = currentform.login.length;
3154: if (typeof numauthchoices == "undefined") {
3155: return;
3156: }
1.32 matthew 3157: var i=0;
1.986 raeburn 3158: while (i < numauthchoices) {
1.32 matthew 3159: if (currentform.login[i].value == newvalue) { break; }
3160: i++;
3161: }
1.986 raeburn 3162: if (i == numauthchoices) {
1.32 matthew 3163: return;
3164: }
3165: current.radiovalue = newvalue;
3166: currentform.login[i].checked = true;
3167: return;
3168: }
3169: END
3170: return $result;
3171: }
3172:
1.1106 raeburn 3173: sub authform_authorwarning {
1.32 matthew 3174: my $result='';
1.144 matthew 3175: $result='<i>'.
3176: &mt('As a general rule, only authors or co-authors should be '.
3177: 'filesystem authenticated '.
3178: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3179: return $result;
3180: }
3181:
1.1106 raeburn 3182: sub authform_nochange {
1.32 matthew 3183: my %in = (
3184: formname => 'document.cu',
3185: kerb_def_dom => 'MSU.EDU',
3186: @_,
3187: );
1.1106 raeburn 3188: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3189: my $result;
1.1104 raeburn 3190: if (!$authnum) {
1.1105 raeburn 3191: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3192: } else {
3193: $result = '<label>'.&mt('[_1] Do not change login data',
3194: '<input type="radio" name="login" value="nochange" '.
3195: 'checked="checked" onclick="'.
1.281 albertel 3196: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3197: '</label>';
1.586 raeburn 3198: }
1.32 matthew 3199: return $result;
3200: }
3201:
1.591 raeburn 3202: sub authform_kerberos {
1.32 matthew 3203: my %in = (
3204: formname => 'document.cu',
3205: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3206: kerb_def_auth => 'krb4',
1.32 matthew 3207: @_,
3208: );
1.586 raeburn 3209: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3210: $autharg,$jscall,$disabled);
1.1106 raeburn 3211: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3212: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3213: $check5 = ' checked="checked"';
1.80 albertel 3214: } else {
1.772 bisitz 3215: $check4 = ' checked="checked"';
1.80 albertel 3216: }
1.1259 raeburn 3217: if ($in{'readonly'}) {
3218: $disabled = ' disabled="disabled"';
3219: }
1.165 raeburn 3220: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3221: if (defined($in{'curr_authtype'})) {
3222: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3223: $krbcheck = ' checked="checked"';
1.623 raeburn 3224: if (defined($in{'mode'})) {
3225: if ($in{'mode'} eq 'modifyuser') {
3226: $krbcheck = '';
3227: }
3228: }
1.591 raeburn 3229: if (defined($in{'curr_kerb_ver'})) {
3230: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3231: $check5 = ' checked="checked"';
1.591 raeburn 3232: $check4 = '';
3233: } else {
1.772 bisitz 3234: $check4 = ' checked="checked"';
1.591 raeburn 3235: $check5 = '';
3236: }
1.586 raeburn 3237: }
1.591 raeburn 3238: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3239: $krbarg = $in{'curr_autharg'};
3240: }
1.586 raeburn 3241: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3242: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3243: $result =
3244: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3245: $in{'curr_autharg'},$krbver);
3246: } else {
3247: $result =
3248: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3249: }
3250: return $result;
3251: }
3252: }
3253: } else {
3254: if ($authnum == 1) {
1.784 bisitz 3255: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3256: }
3257: }
1.586 raeburn 3258: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3259: return;
1.587 raeburn 3260: } elsif ($authtype eq '') {
1.591 raeburn 3261: if (defined($in{'mode'})) {
1.587 raeburn 3262: if ($in{'mode'} eq 'modifycourse') {
3263: if ($authnum == 1) {
1.1259 raeburn 3264: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3265: }
3266: }
3267: }
1.586 raeburn 3268: }
3269: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3270: if ($authtype eq '') {
3271: $authtype = '<input type="radio" name="login" value="krb" '.
3272: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3273: $krbcheck.$disabled.' />';
1.586 raeburn 3274: }
3275: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3276: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3277: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3278: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3279: $in{'curr_authtype'} eq 'krb4')) {
3280: $result .= &mt
1.144 matthew 3281: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3282: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3283: '<label>'.$authtype,
1.281 albertel 3284: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3285: 'value="'.$krbarg.'" '.
1.1259 raeburn 3286: 'onchange="'.$jscall.'"'.$disabled.' />',
3287: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3288: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3289: '</label>');
1.586 raeburn 3290: } elsif ($can_assign{'krb4'}) {
3291: $result .= &mt
3292: ('[_1] Kerberos authenticated with domain [_2] '.
3293: '[_3] Version 4 [_4]',
3294: '<label>'.$authtype,
3295: '</label><input type="text" size="10" name="krbarg" '.
3296: 'value="'.$krbarg.'" '.
1.1259 raeburn 3297: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3298: '<label><input type="hidden" name="krbver" value="4" />',
3299: '</label>');
3300: } elsif ($can_assign{'krb5'}) {
3301: $result .= &mt
3302: ('[_1] Kerberos authenticated with domain [_2] '.
3303: '[_3] Version 5 [_4]',
3304: '<label>'.$authtype,
3305: '</label><input type="text" size="10" name="krbarg" '.
3306: 'value="'.$krbarg.'" '.
1.1259 raeburn 3307: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3308: '<label><input type="hidden" name="krbver" value="5" />',
3309: '</label>');
3310: }
1.32 matthew 3311: return $result;
3312: }
3313:
1.1106 raeburn 3314: sub authform_internal {
1.586 raeburn 3315: my %in = (
1.32 matthew 3316: formname => 'document.cu',
3317: kerb_def_dom => 'MSU.EDU',
3318: @_,
3319: );
1.1259 raeburn 3320: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3321: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3322: if ($in{'readonly'}) {
3323: $disabled = ' disabled="disabled"';
3324: }
1.591 raeburn 3325: if (defined($in{'curr_authtype'})) {
3326: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3327: if ($can_assign{'int'}) {
1.772 bisitz 3328: $intcheck = 'checked="checked" ';
1.623 raeburn 3329: if (defined($in{'mode'})) {
3330: if ($in{'mode'} eq 'modifyuser') {
3331: $intcheck = '';
3332: }
3333: }
1.591 raeburn 3334: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3335: $intarg = $in{'curr_autharg'};
3336: }
3337: } else {
3338: $result = &mt('Currently internally authenticated.');
3339: return $result;
1.165 raeburn 3340: }
3341: }
1.586 raeburn 3342: } else {
3343: if ($authnum == 1) {
1.784 bisitz 3344: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3345: }
3346: }
3347: if (!$can_assign{'int'}) {
3348: return;
1.587 raeburn 3349: } elsif ($authtype eq '') {
1.591 raeburn 3350: if (defined($in{'mode'})) {
1.587 raeburn 3351: if ($in{'mode'} eq 'modifycourse') {
3352: if ($authnum == 1) {
1.1259 raeburn 3353: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3354: }
3355: }
3356: }
1.165 raeburn 3357: }
1.586 raeburn 3358: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3359: if ($authtype eq '') {
3360: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3361: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3362: }
1.605 bisitz 3363: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3364: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3365: $result = &mt
1.144 matthew 3366: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3367: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3368: $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 3369: return $result;
3370: }
3371:
1.1104 raeburn 3372: sub authform_local {
1.32 matthew 3373: my %in = (
3374: formname => 'document.cu',
3375: kerb_def_dom => 'MSU.EDU',
3376: @_,
3377: );
1.1259 raeburn 3378: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3379: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3380: if ($in{'readonly'}) {
3381: $disabled = ' disabled="disabled"';
3382: }
1.591 raeburn 3383: if (defined($in{'curr_authtype'})) {
3384: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3385: if ($can_assign{'loc'}) {
1.772 bisitz 3386: $loccheck = 'checked="checked" ';
1.623 raeburn 3387: if (defined($in{'mode'})) {
3388: if ($in{'mode'} eq 'modifyuser') {
3389: $loccheck = '';
3390: }
3391: }
1.591 raeburn 3392: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3393: $locarg = $in{'curr_autharg'};
3394: }
3395: } else {
3396: $result = &mt('Currently using local (institutional) authentication.');
3397: return $result;
1.165 raeburn 3398: }
3399: }
1.586 raeburn 3400: } else {
3401: if ($authnum == 1) {
1.784 bisitz 3402: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3403: }
3404: }
3405: if (!$can_assign{'loc'}) {
3406: return;
1.587 raeburn 3407: } elsif ($authtype eq '') {
1.591 raeburn 3408: if (defined($in{'mode'})) {
1.587 raeburn 3409: if ($in{'mode'} eq 'modifycourse') {
3410: if ($authnum == 1) {
1.1259 raeburn 3411: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3412: }
3413: }
3414: }
1.165 raeburn 3415: }
1.586 raeburn 3416: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3417: if ($authtype eq '') {
3418: $authtype = '<input type="radio" name="login" value="loc" '.
3419: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3420: $jscall.'"'.$disabled.' />';
1.586 raeburn 3421: }
3422: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3423: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3424: $result = &mt('[_1] Local Authentication with argument [_2]',
3425: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3426: return $result;
3427: }
3428:
1.1106 raeburn 3429: sub authform_filesystem {
1.32 matthew 3430: my %in = (
3431: formname => 'document.cu',
3432: kerb_def_dom => 'MSU.EDU',
3433: @_,
3434: );
1.1259 raeburn 3435: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3436: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3437: if ($in{'readonly'}) {
3438: $disabled = ' disabled="disabled"';
3439: }
1.591 raeburn 3440: if (defined($in{'curr_authtype'})) {
3441: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3442: if ($can_assign{'fsys'}) {
1.772 bisitz 3443: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3444: if (defined($in{'mode'})) {
3445: if ($in{'mode'} eq 'modifyuser') {
3446: $fsyscheck = '';
3447: }
3448: }
1.586 raeburn 3449: } else {
3450: $result = &mt('Currently Filesystem Authenticated.');
3451: return $result;
1.1259 raeburn 3452: }
1.586 raeburn 3453: }
3454: } else {
3455: if ($authnum == 1) {
1.784 bisitz 3456: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3457: }
3458: }
3459: if (!$can_assign{'fsys'}) {
3460: return;
1.587 raeburn 3461: } elsif ($authtype eq '') {
1.591 raeburn 3462: if (defined($in{'mode'})) {
1.587 raeburn 3463: if ($in{'mode'} eq 'modifycourse') {
3464: if ($authnum == 1) {
1.1259 raeburn 3465: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3466: }
3467: }
3468: }
1.586 raeburn 3469: }
3470: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3471: if ($authtype eq '') {
3472: $authtype = '<input type="radio" name="login" value="fsys" '.
3473: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3474: $jscall.'"'.$disabled.' />';
1.586 raeburn 3475: }
1.1310 raeburn 3476: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3477: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3478: $result = &mt
1.144 matthew 3479: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3480: '<label>'.$authtype,'</label>'.$autharg);
3481: return $result;
3482: }
3483:
3484: sub authform_lti {
3485: my %in = (
3486: formname => 'document.cu',
3487: kerb_def_dom => 'MSU.EDU',
3488: @_,
3489: );
3490: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3491: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3492: if ($in{'readonly'}) {
3493: $disabled = ' disabled="disabled"';
3494: }
3495: if (defined($in{'curr_authtype'})) {
3496: if ($in{'curr_authtype'} eq 'lti') {
3497: if ($can_assign{'lti'}) {
3498: $lticheck = 'checked="checked" ';
3499: if (defined($in{'mode'})) {
3500: if ($in{'mode'} eq 'modifyuser') {
3501: $lticheck = '';
3502: }
3503: }
3504: } else {
3505: $result = &mt('Currently LTI Authenticated.');
3506: return $result;
3507: }
3508: }
3509: } else {
3510: if ($authnum == 1) {
3511: $authtype = '<input type="hidden" name="login" value="lti" />';
3512: }
3513: }
3514: if (!$can_assign{'lti'}) {
3515: return;
3516: } elsif ($authtype eq '') {
3517: if (defined($in{'mode'})) {
3518: if ($in{'mode'} eq 'modifycourse') {
3519: if ($authnum == 1) {
3520: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3521: }
3522: }
3523: }
3524: }
3525: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3526: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3527: $authtype = '<input type="radio" name="login" value="lti" '.
3528: $lticheck.' onchange="'.$jscall.'" onclick="'.
3529: $jscall.'"'.$disabled.' />';
3530: }
3531: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3532: if ($authtype) {
3533: $result = &mt('[_1] LTI Authenticated',
3534: '<label>'.$authtype.'</label>'.$autharg);
3535: } else {
3536: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3537: $autharg;
3538: }
1.32 matthew 3539: return $result;
3540: }
3541:
1.586 raeburn 3542: sub get_assignable_auth {
3543: my ($dom) = @_;
3544: if ($dom eq '') {
3545: $dom = $env{'request.role.domain'};
3546: }
3547: my %can_assign = (
3548: krb4 => 1,
3549: krb5 => 1,
3550: int => 1,
3551: loc => 1,
1.1310 raeburn 3552: lti => 1,
1.586 raeburn 3553: );
3554: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3555: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3556: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3557: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3558: my $context;
3559: if ($env{'request.role'} =~ /^au/) {
3560: $context = 'author';
1.1259 raeburn 3561: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3562: $context = 'domain';
3563: } elsif ($env{'request.course.id'}) {
3564: $context = 'course';
3565: }
3566: if ($context) {
3567: if (ref($authhash->{$context}) eq 'HASH') {
3568: %can_assign = %{$authhash->{$context}};
3569: }
3570: }
3571: }
3572: }
3573: my $authnum = 0;
3574: foreach my $key (keys(%can_assign)) {
3575: if ($can_assign{$key}) {
3576: $authnum ++;
3577: }
3578: }
3579: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3580: $authnum --;
3581: }
3582: return ($authnum,%can_assign);
3583: }
3584:
1.1331 raeburn 3585: sub check_passwd_rules {
3586: my ($domain,$plainpass) = @_;
3587: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3588: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3589: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3590: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3591: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3592: if ($passwdconf{'min'} > $min) {
3593: $min = $passwdconf{'min'};
3594: }
1.1331 raeburn 3595: }
3596: if ($passwdconf{'max'} =~ /^\d+$/) {
3597: $max = $passwdconf{'max'};
3598: }
3599: @chars = @{$passwdconf{'chars'}};
3600: }
3601: if (($min) && (length($plainpass) < $min)) {
3602: push(@brokerule,'min');
3603: }
3604: if (($max) && (length($plainpass) > $max)) {
3605: push(@brokerule,'max');
3606: }
3607: if (@chars) {
3608: my %rules;
3609: map { $rules{$_} = 1; } @chars;
3610: if ($rules{'uc'}) {
3611: unless ($plainpass =~ /[A-Z]/) {
3612: push(@brokerule,'uc');
3613: }
3614: }
3615: if ($rules{'lc'}) {
1.1332 raeburn 3616: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3617: push(@brokerule,'lc');
3618: }
3619: }
3620: if ($rules{'num'}) {
3621: unless ($plainpass =~ /\d/) {
3622: push(@brokerule,'num');
3623: }
3624: }
3625: if ($rules{'spec'}) {
3626: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3627: push(@brokerule,'spec');
3628: }
3629: }
3630: }
3631: if (@brokerule) {
3632: my %rulenames = &Apache::lonlocal::texthash(
3633: uc => 'At least one upper case letter',
3634: lc => 'At least one lower case letter',
3635: num => 'At least one number',
3636: spec => 'At least one non-alphanumeric',
3637: );
3638: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3639: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3640: $rulenames{'num'} .= ': 0123456789';
3641: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3642: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3643: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3644: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3645: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3646: if (grep(/^$rule$/,@brokerule)) {
3647: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3648: }
3649: }
3650: $warning .= '</ul>';
3651: }
1.1332 raeburn 3652: if (wantarray) {
3653: return @brokerule;
3654: }
1.1331 raeburn 3655: return $warning;
3656: }
3657:
1.1376 raeburn 3658: sub passwd_validation_js {
1.1377 raeburn 3659: my ($currpasswdval,$domain,$context,$id) = @_;
3660: my (%passwdconf,$alertmsg);
3661: if ($context eq 'linkprot') {
3662: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3663: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3664: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3665: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3666: }
3667: }
3668: if ($id eq 'add') {
3669: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3670: } elsif ($id =~ /^\d+$/) {
3671: my $pos = $id+1;
3672: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3673: } else {
3674: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3675: }
3676: } else {
3677: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3678: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3679: }
1.1376 raeburn 3680: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3681: $numrules = 0;
3682: $min = $Apache::lonnet::passwdmin;
3683: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3684: if ($passwdconf{'min'} =~ /^\d+$/) {
3685: if ($passwdconf{'min'} > $min) {
3686: $min = $passwdconf{'min'};
3687: }
3688: }
3689: if ($passwdconf{'max'} =~ /^\d+$/) {
3690: $max = $passwdconf{'max'};
3691: $numrules ++;
3692: }
3693: @chars = @{$passwdconf{'chars'}};
3694: if (@chars) {
3695: $numrules ++;
3696: }
3697: }
3698: if ($min > 0) {
3699: $numrules ++;
3700: }
3701: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3702: if ($min) {
3703: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3704: }
3705: if ($max) {
3706: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3707: }
3708: my (@charalerts,@charrules);
3709: if (@chars) {
3710: if (grep(/^uc$/,@chars)) {
3711: push(@charalerts,&mt('contain at least one upper case letter'));
3712: push(@charrules,'uc');
3713: }
3714: if (grep(/^lc$/,@chars)) {
3715: push(@charalerts,&mt('contain at least one lower case letter'));
3716: push(@charrules,'lc');
3717: }
3718: if (grep(/^num$/,@chars)) {
3719: push(@charalerts,&mt('contain at least one number'));
3720: push(@charrules,'num');
3721: }
3722: if (grep(/^spec$/,@chars)) {
3723: push(@charalerts,&mt('contain at least one non-alphanumeric'));
3724: push(@charrules,'spec');
3725: }
3726: }
3727: $intargjs = qq| var rulesmsg = '';\n|.
3728: qq| var currpwval = $currpasswdval;\n|;
3729: if ($min) {
3730: $intargjs .= qq|
3731: if (currpwval.length < $min) {
3732: rulesmsg += ' - $alert{min}';
3733: }
3734: |;
3735: }
3736: if ($max) {
3737: $intargjs .= qq|
3738: if (currpwval.length > $max) {
3739: rulesmsg += ' - $alert{max}';
3740: }
3741: |;
3742: }
3743: if (@chars > 0) {
3744: my $charrulestr = '"'.join('","',@charrules).'"';
3745: my $charalertstr = '"'.join('","',@charalerts).'"';
3746: $intargjs .= qq| var brokerules = new Array();\n|.
3747: qq| var charrules = new Array($charrulestr);\n|.
3748: qq| var charalerts = new Array($charalertstr);\n|;
3749: my %rules;
3750: map { $rules{$_} = 1; } @chars;
3751: if ($rules{'uc'}) {
3752: $intargjs .= qq|
3753: var ucRegExp = /[A-Z]/;
3754: if (!ucRegExp.test(currpwval)) {
3755: brokerules.push('uc');
3756: }
3757: |;
3758: }
3759: if ($rules{'lc'}) {
3760: $intargjs .= qq|
3761: var lcRegExp = /[a-z]/;
3762: if (!lcRegExp.test(currpwval)) {
3763: brokerules.push('lc');
3764: }
3765: |;
3766: }
3767: if ($rules{'num'}) {
3768: $intargjs .= qq|
3769: var numRegExp = /[0-9]/;
3770: if (!numRegExp.test(currpwval)) {
3771: brokerules.push('num');
3772: }
3773: |;
3774: }
3775: if ($rules{'spec'}) {
3776: $intargjs .= q|
3777: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
3778: if (!specRegExp.test(currpwval)) {
3779: brokerules.push('spec');
3780: }
3781: |;
3782: }
3783: $intargjs .= qq|
3784: if (brokerules.length > 0) {
3785: for (var i=0; i<brokerules.length; i++) {
3786: for (var j=0; j<charrules.length; j++) {
3787: if (brokerules[i] == charrules[j]) {
3788: rulesmsg += ' - '+charalerts[j]+'\\n';
3789: break;
3790: }
3791: }
3792: }
3793: }
3794: |;
3795: }
3796: $intargjs .= qq|
3797: if (rulesmsg != '') {
3798: rulesmsg = '$alertmsg'+rulesmsg;
3799: alert(rulesmsg);
3800: return false;
3801: }
3802: |;
3803: }
3804: return ($numrules,$intargjs);
3805: }
3806:
1.80 albertel 3807: ###############################################################
3808: ## Get Kerberos Defaults for Domain ##
3809: ###############################################################
3810: ##
3811: ## Returns default kerberos version and an associated argument
3812: ## as listed in file domain.tab. If not listed, provides
3813: ## appropriate default domain and kerberos version.
3814: ##
3815: #-------------------------------------------
3816:
3817: =pod
3818:
1.648 raeburn 3819: =item * &get_kerberos_defaults()
1.80 albertel 3820:
3821: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3822: version and domain. If not found, it defaults to version 4 and the
3823: domain of the server.
1.80 albertel 3824:
1.648 raeburn 3825: =over 4
3826:
1.80 albertel 3827: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3828:
1.648 raeburn 3829: =back
3830:
3831: =back
3832:
1.80 albertel 3833: =cut
3834:
3835: #-------------------------------------------
3836: sub get_kerberos_defaults {
3837: my $domain=shift;
1.641 raeburn 3838: my ($krbdef,$krbdefdom);
3839: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3840: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3841: $krbdef = $domdefaults{'auth_def'};
3842: $krbdefdom = $domdefaults{'auth_arg_def'};
3843: } else {
1.80 albertel 3844: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3845: my $krbdefdom=$1;
3846: $krbdefdom=~tr/a-z/A-Z/;
3847: $krbdef = "krb4";
3848: }
3849: return ($krbdef,$krbdefdom);
3850: }
1.112 bowersj2 3851:
1.32 matthew 3852:
1.46 matthew 3853: ###############################################################
3854: ## Thesaurus Functions ##
3855: ###############################################################
1.20 www 3856:
1.46 matthew 3857: =pod
1.20 www 3858:
1.112 bowersj2 3859: =head1 Thesaurus Functions
3860:
3861: =over 4
3862:
1.648 raeburn 3863: =item * &initialize_keywords()
1.46 matthew 3864:
3865: Initializes the package variable %Keywords if it is empty. Uses the
3866: package variable $thesaurus_db_file.
3867:
3868: =cut
3869:
3870: ###################################################
3871:
3872: sub initialize_keywords {
3873: return 1 if (scalar keys(%Keywords));
3874: # If we are here, %Keywords is empty, so fill it up
3875: # Make sure the file we need exists...
3876: if (! -e $thesaurus_db_file) {
3877: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3878: " failed because it does not exist");
3879: return 0;
3880: }
3881: # Set up the hash as a database
3882: my %thesaurus_db;
3883: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3884: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3885: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3886: $thesaurus_db_file);
3887: return 0;
3888: }
3889: # Get the average number of appearances of a word.
3890: my $avecount = $thesaurus_db{'average.count'};
3891: # Put keywords (those that appear > average) into %Keywords
3892: while (my ($word,$data)=each (%thesaurus_db)) {
3893: my ($count,undef) = split /:/,$data;
3894: $Keywords{$word}++ if ($count > $avecount);
3895: }
3896: untie %thesaurus_db;
3897: # Remove special values from %Keywords.
1.356 albertel 3898: foreach my $value ('total.count','average.count') {
3899: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3900: }
1.46 matthew 3901: return 1;
3902: }
3903:
3904: ###################################################
3905:
3906: =pod
3907:
1.648 raeburn 3908: =item * &keyword($word)
1.46 matthew 3909:
3910: Returns true if $word is a keyword. A keyword is a word that appears more
3911: than the average number of times in the thesaurus database. Calls
3912: &initialize_keywords
3913:
3914: =cut
3915:
3916: ###################################################
1.20 www 3917:
3918: sub keyword {
1.46 matthew 3919: return if (!&initialize_keywords());
3920: my $word=lc(shift());
3921: $word=~s/\W//g;
3922: return exists($Keywords{$word});
1.20 www 3923: }
1.46 matthew 3924:
3925: ###############################################################
3926:
3927: =pod
1.20 www 3928:
1.648 raeburn 3929: =item * &get_related_words()
1.46 matthew 3930:
1.160 matthew 3931: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3932: an array of words. If the keyword is not in the thesaurus, an empty array
3933: will be returned. The order of the words returned is determined by the
3934: database which holds them.
3935:
3936: Uses global $thesaurus_db_file.
3937:
1.1057 foxr 3938:
1.46 matthew 3939: =cut
3940:
3941: ###############################################################
3942: sub get_related_words {
3943: my $keyword = shift;
3944: my %thesaurus_db;
3945: if (! -e $thesaurus_db_file) {
3946: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3947: "failed because the file does not exist");
3948: return ();
3949: }
3950: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3951: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3952: return ();
3953: }
3954: my @Words=();
1.429 www 3955: my $count=0;
1.46 matthew 3956: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3957: # The first element is the number of times
3958: # the word appears. We do not need it now.
1.429 www 3959: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3960: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3961: my $threshold=$mostfrequentcount/10;
3962: foreach my $possibleword (@RelatedWords) {
3963: my ($word,$wordcount)=split(/\,/,$possibleword);
3964: if ($wordcount>$threshold) {
3965: push(@Words,$word);
3966: $count++;
3967: if ($count>10) { last; }
3968: }
1.20 www 3969: }
3970: }
1.46 matthew 3971: untie %thesaurus_db;
3972: return @Words;
1.14 harris41 3973: }
1.1090 foxr 3974: ###############################################################
3975: #
3976: # Spell checking
3977: #
3978:
3979: =pod
3980:
1.1142 raeburn 3981: =back
3982:
1.1090 foxr 3983: =head1 Spell checking
3984:
3985: =over 4
3986:
3987: =item * &check_spelling($wordlist $language)
3988:
3989: Takes a string containing words and feeds it to an external
3990: spellcheck program via a pipeline. Returns a string containing
3991: them mis-spelled words.
3992:
3993: Parameters:
3994:
3995: =over 4
3996:
3997: =item - $wordlist
3998:
3999: String that will be fed into the spellcheck program.
4000:
4001: =item - $language
4002:
4003: Language string that specifies the language for which the spell
4004: check will be performed.
4005:
4006: =back
4007:
4008: =back
4009:
4010: Note: This sub assumes that aspell is installed.
4011:
4012:
4013: =cut
4014:
1.46 matthew 4015:
1.1090 foxr 4016: sub check_spelling {
4017: my ($wordlist, $language) = @_;
1.1091 foxr 4018: my @misspellings;
4019:
4020: # Generate the speller and set the langauge.
4021: # if explicitly selected:
1.1090 foxr 4022:
1.1091 foxr 4023: my $speller = Text::Aspell->new;
1.1090 foxr 4024: if ($language) {
1.1091 foxr 4025: $speller->set_option('lang', $language);
1.1090 foxr 4026: }
4027:
1.1091 foxr 4028: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4029:
1.1091 foxr 4030: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4031:
1.1091 foxr 4032: foreach my $word (@words) {
4033: if(! $speller->check($word)) {
4034: push(@misspellings, $word);
1.1090 foxr 4035: }
4036: }
1.1091 foxr 4037: return join(' ', @misspellings);
4038:
1.1090 foxr 4039: }
4040:
1.61 www 4041: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4042: =pod
4043:
1.112 bowersj2 4044: =head1 User Name Functions
4045:
4046: =over 4
4047:
1.648 raeburn 4048: =item * &plainname($uname,$udom,$first)
1.81 albertel 4049:
1.112 bowersj2 4050: Takes a users logon name and returns it as a string in
1.226 albertel 4051: "first middle last generation" form
4052: if $first is set to 'lastname' then it returns it as
4053: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4054:
4055: =cut
1.61 www 4056:
1.295 www 4057:
1.81 albertel 4058: ###############################################################
1.61 www 4059: sub plainname {
1.226 albertel 4060: my ($uname,$udom,$first)=@_;
1.537 albertel 4061: return if (!defined($uname) || !defined($udom));
1.295 www 4062: my %names=&getnames($uname,$udom);
1.226 albertel 4063: my $name=&Apache::lonnet::format_name($names{'firstname'},
4064: $names{'middlename'},
4065: $names{'lastname'},
4066: $names{'generation'},$first);
4067: $name=~s/^\s+//;
1.62 www 4068: $name=~s/\s+$//;
4069: $name=~s/\s+/ /g;
1.353 albertel 4070: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4071: return $name;
1.61 www 4072: }
1.66 www 4073:
4074: # -------------------------------------------------------------------- Nickname
1.81 albertel 4075: =pod
4076:
1.648 raeburn 4077: =item * &nickname($uname,$udom)
1.81 albertel 4078:
4079: Gets a users name and returns it as a string as
4080:
4081: ""nickname""
1.66 www 4082:
1.81 albertel 4083: if the user has a nickname or
4084:
4085: "first middle last generation"
4086:
4087: if the user does not
4088:
4089: =cut
1.66 www 4090:
4091: sub nickname {
4092: my ($uname,$udom)=@_;
1.537 albertel 4093: return if (!defined($uname) || !defined($udom));
1.295 www 4094: my %names=&getnames($uname,$udom);
1.68 albertel 4095: my $name=$names{'nickname'};
1.66 www 4096: if ($name) {
4097: $name='"'.$name.'"';
4098: } else {
4099: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4100: $names{'lastname'}.' '.$names{'generation'};
4101: $name=~s/\s+$//;
4102: $name=~s/\s+/ /g;
4103: }
4104: return $name;
4105: }
4106:
1.295 www 4107: sub getnames {
4108: my ($uname,$udom)=@_;
1.537 albertel 4109: return if (!defined($uname) || !defined($udom));
1.433 albertel 4110: if ($udom eq 'public' && $uname eq 'public') {
4111: return ('lastname' => &mt('Public'));
4112: }
1.295 www 4113: my $id=$uname.':'.$udom;
4114: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4115: if ($cached) {
4116: return %{$names};
4117: } else {
4118: my %loadnames=&Apache::lonnet::get('environment',
4119: ['firstname','middlename','lastname','generation','nickname'],
4120: $udom,$uname);
4121: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4122: return %loadnames;
4123: }
4124: }
1.61 www 4125:
1.542 raeburn 4126: # -------------------------------------------------------------------- getemails
1.648 raeburn 4127:
1.542 raeburn 4128: =pod
4129:
1.648 raeburn 4130: =item * &getemails($uname,$udom)
1.542 raeburn 4131:
4132: Gets a user's email information and returns it as a hash with keys:
4133: notification, critnotification, permanentemail
4134:
4135: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4136: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4137:
1.648 raeburn 4138:
1.542 raeburn 4139: =cut
4140:
1.648 raeburn 4141:
1.466 albertel 4142: sub getemails {
4143: my ($uname,$udom)=@_;
4144: if ($udom eq 'public' && $uname eq 'public') {
4145: return;
4146: }
1.467 www 4147: if (!$udom) { $udom=$env{'user.domain'}; }
4148: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4149: my $id=$uname.':'.$udom;
4150: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4151: if ($cached) {
4152: return %{$names};
4153: } else {
4154: my %loadnames=&Apache::lonnet::get('environment',
4155: ['notification','critnotification',
4156: 'permanentemail'],
4157: $udom,$uname);
4158: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4159: return %loadnames;
4160: }
4161: }
4162:
1.551 albertel 4163: sub flush_email_cache {
4164: my ($uname,$udom)=@_;
4165: if (!$udom) { $udom =$env{'user.domain'}; }
4166: if (!$uname) { $uname=$env{'user.name'}; }
4167: return if ($udom eq 'public' && $uname eq 'public');
4168: my $id=$uname.':'.$udom;
4169: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4170: }
4171:
1.728 raeburn 4172: # -------------------------------------------------------------------- getlangs
4173:
4174: =pod
4175:
4176: =item * &getlangs($uname,$udom)
4177:
4178: Gets a user's language preference and returns it as a hash with key:
4179: language.
4180:
4181: =cut
4182:
4183:
4184: sub getlangs {
4185: my ($uname,$udom) = @_;
4186: if (!$udom) { $udom =$env{'user.domain'}; }
4187: if (!$uname) { $uname=$env{'user.name'}; }
4188: my $id=$uname.':'.$udom;
4189: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4190: if ($cached) {
4191: return %{$langs};
4192: } else {
4193: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4194: $udom,$uname);
4195: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4196: return %loadlangs;
4197: }
4198: }
4199:
4200: sub flush_langs_cache {
4201: my ($uname,$udom)=@_;
4202: if (!$udom) { $udom =$env{'user.domain'}; }
4203: if (!$uname) { $uname=$env{'user.name'}; }
4204: return if ($udom eq 'public' && $uname eq 'public');
4205: my $id=$uname.':'.$udom;
4206: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4207: }
4208:
1.61 www 4209: # ------------------------------------------------------------------ Screenname
1.81 albertel 4210:
4211: =pod
4212:
1.648 raeburn 4213: =item * &screenname($uname,$udom)
1.81 albertel 4214:
4215: Gets a users screenname and returns it as a string
4216:
4217: =cut
1.61 www 4218:
4219: sub screenname {
4220: my ($uname,$udom)=@_;
1.258 albertel 4221: if ($uname eq $env{'user.name'} &&
4222: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4223: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4224: return $names{'screenname'};
1.62 www 4225: }
4226:
1.212 albertel 4227:
1.802 bisitz 4228: # ------------------------------------------------------------- Confirm Wrapper
4229: =pod
4230:
1.1142 raeburn 4231: =item * &confirmwrapper($message)
1.802 bisitz 4232:
4233: Wrap messages about completion of operation in box
4234:
4235: =cut
4236:
4237: sub confirmwrapper {
4238: my ($message)=@_;
4239: if ($message) {
4240: return "\n".'<div class="LC_confirm_box">'."\n"
4241: .$message."\n"
4242: .'</div>'."\n";
4243: } else {
4244: return $message;
4245: }
4246: }
4247:
1.62 www 4248: # ------------------------------------------------------------- Message Wrapper
4249:
4250: sub messagewrapper {
1.369 www 4251: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4252: return
1.441 albertel 4253: '<a href="/adm/email?compose=individual&'.
4254: 'recname='.$username.'&recdom='.$domain.
4255: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4256: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4257: }
1.802 bisitz 4258:
1.74 www 4259: # --------------------------------------------------------------- Notes Wrapper
4260:
4261: sub noteswrapper {
4262: my ($link,$un,$do)=@_;
4263: return
1.896 amueller 4264: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4265: }
1.802 bisitz 4266:
1.62 www 4267: # ------------------------------------------------------------- Aboutme Wrapper
4268:
4269: sub aboutmewrapper {
1.1070 raeburn 4270: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4271: if (!defined($username) && !defined($domain)) {
4272: return;
4273: }
1.1096 raeburn 4274: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4275: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4276: }
4277:
4278: # ------------------------------------------------------------ Syllabus Wrapper
4279:
4280: sub syllabuswrapper {
1.707 bisitz 4281: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4282: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4283: }
1.14 harris41 4284:
1.802 bisitz 4285: # -----------------------------------------------------------------------------
4286:
1.208 matthew 4287: sub track_student_link {
1.887 raeburn 4288: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4289: my $link ="/adm/trackstudent?";
1.208 matthew 4290: my $title = 'View recent activity';
4291: if (defined($sname) && $sname !~ /^\s*$/ &&
4292: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4293: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4294: $title .= ' of this student';
1.268 albertel 4295: }
1.208 matthew 4296: if (defined($target) && $target !~ /^\s*$/) {
4297: $target = qq{target="$target"};
4298: } else {
4299: $target = '';
4300: }
1.268 albertel 4301: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4302: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4303: $title = &mt($title);
4304: $linktext = &mt($linktext);
1.448 albertel 4305: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4306: &help_open_topic('View_recent_activity');
1.208 matthew 4307: }
4308:
1.781 raeburn 4309: sub slot_reservations_link {
4310: my ($linktext,$sname,$sdom,$target) = @_;
4311: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4312: my $title = 'View slot reservation history';
4313: if (defined($sname) && $sname !~ /^\s*$/ &&
4314: defined($sdom) && $sdom !~ /^\s*$/) {
4315: $link .= "&uname=$sname&udom=$sdom";
4316: $title .= ' of this student';
4317: }
4318: if (defined($target) && $target !~ /^\s*$/) {
4319: $target = qq{target="$target"};
4320: } else {
4321: $target = '';
4322: }
4323: $title = &mt($title);
4324: $linktext = &mt($linktext);
4325: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4326: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4327:
4328: }
4329:
1.508 www 4330: # ===================================================== Display a student photo
4331:
4332:
1.509 albertel 4333: sub student_image_tag {
1.508 www 4334: my ($domain,$user)=@_;
4335: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4336: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4337: return '<img src="'.$imgsrc.'" align="right" />';
4338: } else {
4339: return '';
4340: }
4341: }
4342:
1.112 bowersj2 4343: =pod
4344:
4345: =back
4346:
4347: =head1 Access .tab File Data
4348:
4349: =over 4
4350:
1.648 raeburn 4351: =item * &languageids()
1.112 bowersj2 4352:
4353: returns list of all language ids
4354:
4355: =cut
4356:
1.14 harris41 4357: sub languageids {
1.16 harris41 4358: return sort(keys(%language));
1.14 harris41 4359: }
4360:
1.112 bowersj2 4361: =pod
4362:
1.648 raeburn 4363: =item * &languagedescription()
1.112 bowersj2 4364:
4365: returns description of a specified language id
4366:
4367: =cut
4368:
1.14 harris41 4369: sub languagedescription {
1.125 www 4370: my $code=shift;
4371: return ($supported_language{$code}?'* ':'').
4372: $language{$code}.
1.126 www 4373: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4374: }
4375:
1.1048 foxr 4376: =pod
4377:
4378: =item * &plainlanguagedescription
4379:
4380: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4381: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4382:
4383: =cut
4384:
1.145 www 4385: sub plainlanguagedescription {
4386: my $code=shift;
4387: return $language{$code};
4388: }
4389:
1.1048 foxr 4390: =pod
4391:
4392: =item * &supportedlanguagecode
4393:
4394: Returns the supported language code (e.g. sptutf maps to pt) given a language
4395: code.
4396:
4397: =cut
4398:
1.145 www 4399: sub supportedlanguagecode {
4400: my $code=shift;
4401: return $supported_language{$code};
1.97 www 4402: }
4403:
1.112 bowersj2 4404: =pod
4405:
1.1048 foxr 4406: =item * &latexlanguage()
4407:
4408: Given a language key code returns the correspondnig language to use
4409: to select the correct hyphenation on LaTeX printouts. This is undef if there
4410: is no supported hyphenation for the language code.
4411:
4412: =cut
4413:
4414: sub latexlanguage {
4415: my $code = shift;
4416: return $latex_language{$code};
4417: }
4418:
4419: =pod
4420:
4421: =item * &latexhyphenation()
4422:
4423: Same as above but what's supplied is the language as it might be stored
4424: in the metadata.
4425:
4426: =cut
4427:
4428: sub latexhyphenation {
4429: my $key = shift;
4430: return $latex_language_bykey{$key};
4431: }
4432:
4433: =pod
4434:
1.648 raeburn 4435: =item * ©rightids()
1.112 bowersj2 4436:
4437: returns list of all copyrights
4438:
4439: =cut
4440:
4441: sub copyrightids {
4442: return sort(keys(%cprtag));
4443: }
4444:
4445: =pod
4446:
1.648 raeburn 4447: =item * ©rightdescription()
1.112 bowersj2 4448:
4449: returns description of a specified copyright id
4450:
4451: =cut
4452:
4453: sub copyrightdescription {
1.166 www 4454: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4455: }
1.197 matthew 4456:
4457: =pod
4458:
1.648 raeburn 4459: =item * &source_copyrightids()
1.192 taceyjo1 4460:
4461: returns list of all source copyrights
4462:
4463: =cut
4464:
4465: sub source_copyrightids {
4466: return sort(keys(%scprtag));
4467: }
4468:
4469: =pod
4470:
1.648 raeburn 4471: =item * &source_copyrightdescription()
1.192 taceyjo1 4472:
4473: returns description of a specified source copyright id
4474:
4475: =cut
4476:
4477: sub source_copyrightdescription {
4478: return &mt($scprtag{shift(@_)});
4479: }
1.112 bowersj2 4480:
4481: =pod
4482:
1.648 raeburn 4483: =item * &filecategories()
1.112 bowersj2 4484:
4485: returns list of all file categories
4486:
4487: =cut
4488:
4489: sub filecategories {
4490: return sort(keys(%category_extensions));
4491: }
4492:
4493: =pod
4494:
1.648 raeburn 4495: =item * &filecategorytypes()
1.112 bowersj2 4496:
4497: returns list of file types belonging to a given file
4498: category
4499:
4500: =cut
4501:
4502: sub filecategorytypes {
1.356 albertel 4503: my ($cat) = @_;
1.1248 raeburn 4504: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4505: return @{$category_extensions{lc($cat)}};
4506: } else {
4507: return ();
4508: }
1.112 bowersj2 4509: }
4510:
4511: =pod
4512:
1.648 raeburn 4513: =item * &fileembstyle()
1.112 bowersj2 4514:
4515: returns embedding style for a specified file type
4516:
4517: =cut
4518:
4519: sub fileembstyle {
4520: return $fe{lc(shift(@_))};
1.169 www 4521: }
4522:
1.351 www 4523: sub filemimetype {
4524: return $fm{lc(shift(@_))};
4525: }
4526:
1.169 www 4527:
4528: sub filecategoryselect {
4529: my ($name,$value)=@_;
1.189 matthew 4530: return &select_form($value,$name,
1.970 raeburn 4531: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4532: }
4533:
4534: =pod
4535:
1.648 raeburn 4536: =item * &filedescription()
1.112 bowersj2 4537:
4538: returns description for a specified file type
4539:
4540: =cut
4541:
4542: sub filedescription {
1.188 matthew 4543: my $file_description = $fd{lc(shift())};
4544: $file_description =~ s:([\[\]]):~$1:g;
4545: return &mt($file_description);
1.112 bowersj2 4546: }
4547:
4548: =pod
4549:
1.648 raeburn 4550: =item * &filedescriptionex()
1.112 bowersj2 4551:
4552: returns description for a specified file type with
4553: extra formatting
4554:
4555: =cut
4556:
4557: sub filedescriptionex {
4558: my $ex=shift;
1.188 matthew 4559: my $file_description = $fd{lc($ex)};
4560: $file_description =~ s:([\[\]]):~$1:g;
4561: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4562: }
4563:
4564: # End of .tab access
4565: =pod
4566:
4567: =back
4568:
4569: =cut
4570:
4571: # ------------------------------------------------------------------ File Types
4572: sub fileextensions {
4573: return sort(keys(%fe));
4574: }
4575:
1.97 www 4576: # ----------------------------------------------------------- Display Languages
4577: # returns a hash with all desired display languages
4578: #
4579:
4580: sub display_languages {
4581: my %languages=();
1.695 raeburn 4582: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4583: $languages{$lang}=1;
1.97 www 4584: }
4585: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4586: if ($env{'form.displaylanguage'}) {
1.356 albertel 4587: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4588: $languages{$lang}=1;
1.97 www 4589: }
4590: }
4591: return %languages;
1.14 harris41 4592: }
4593:
1.582 albertel 4594: sub languages {
4595: my ($possible_langs) = @_;
1.695 raeburn 4596: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4597: if (!ref($possible_langs)) {
4598: if( wantarray ) {
4599: return @preferred_langs;
4600: } else {
4601: return $preferred_langs[0];
4602: }
4603: }
4604: my %possibilities = map { $_ => 1 } (@$possible_langs);
4605: my @preferred_possibilities;
4606: foreach my $preferred_lang (@preferred_langs) {
4607: if (exists($possibilities{$preferred_lang})) {
4608: push(@preferred_possibilities, $preferred_lang);
4609: }
4610: }
4611: if( wantarray ) {
4612: return @preferred_possibilities;
4613: }
4614: return $preferred_possibilities[0];
4615: }
4616:
1.742 raeburn 4617: sub user_lang {
4618: my ($touname,$toudom,$fromcid) = @_;
4619: my @userlangs;
4620: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4621: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4622: $env{'course.'.$fromcid.'.languages'}));
4623: } else {
4624: my %langhash = &getlangs($touname,$toudom);
4625: if ($langhash{'languages'} ne '') {
4626: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4627: } else {
4628: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4629: if ($domdefs{'lang_def'} ne '') {
4630: @userlangs = ($domdefs{'lang_def'});
4631: }
4632: }
4633: }
4634: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4635: my $user_lh = Apache::localize->get_handle(@languages);
4636: return $user_lh;
4637: }
4638:
4639:
1.112 bowersj2 4640: ###############################################################
4641: ## Student Answer Attempts ##
4642: ###############################################################
4643:
4644: =pod
4645:
4646: =head1 Alternate Problem Views
4647:
4648: =over 4
4649:
1.648 raeburn 4650: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4651: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4652:
4653: Return string with previous attempt on problem. Arguments:
4654:
4655: =over 4
4656:
4657: =item * $symb: Problem, including path
4658:
4659: =item * $username: username of the desired student
4660:
4661: =item * $domain: domain of the desired student
1.14 harris41 4662:
1.112 bowersj2 4663: =item * $course: Course ID
1.14 harris41 4664:
1.112 bowersj2 4665: =item * $getattempt: Leave blank for all attempts, otherwise put
4666: something
1.14 harris41 4667:
1.112 bowersj2 4668: =item * $regexp: if string matches this regexp, the string will be
4669: sent to $gradesub
1.14 harris41 4670:
1.112 bowersj2 4671: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4672:
1.1199 raeburn 4673: =item * $usec: section of the desired student
4674:
4675: =item * $identifier: counter for student (multiple students one problem) or
4676: problem (one student; whole sequence).
4677:
1.112 bowersj2 4678: =back
1.14 harris41 4679:
1.112 bowersj2 4680: The output string is a table containing all desired attempts, if any.
1.16 harris41 4681:
1.112 bowersj2 4682: =cut
1.1 albertel 4683:
4684: sub get_previous_attempt {
1.1199 raeburn 4685: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4686: my $prevattempts='';
1.43 ng 4687: no strict 'refs';
1.1 albertel 4688: if ($symb) {
1.3 albertel 4689: my (%returnhash)=
4690: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4691: if ($returnhash{'version'}) {
4692: my %lasthash=();
4693: my $version;
4694: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 4695: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4696: if ($key =~ /\.rawrndseed$/) {
4697: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4698: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4699: } else {
4700: $lasthash{$key}=$returnhash{$version.':'.$key};
4701: }
1.19 harris41 4702: }
1.1 albertel 4703: }
1.596 albertel 4704: $prevattempts=&start_data_table().&start_data_table_header_row();
4705: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 4706: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4707: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4708: foreach my $key (sort(keys(%lasthash))) {
4709: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4710: if ($#parts > 0) {
1.31 albertel 4711: my $data=$parts[-1];
1.989 raeburn 4712: next if ($data eq 'foilorder');
1.31 albertel 4713: pop(@parts);
1.1010 www 4714: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4715: if ($data eq 'type') {
4716: unless ($showsurv) {
4717: my $id = join(',',@parts);
4718: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4719: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4720: $lasthidden{$ign.'.'.$id} = 1;
4721: }
1.945 raeburn 4722: }
1.1199 raeburn 4723: if ($identifier ne '') {
4724: my $id = join(',',@parts);
4725: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4726: $domain,$username,$usec,undef,$course) =~ /^no/) {
4727: $hidestatus{$ign.'.'.$id} = 1;
4728: }
4729: }
4730: } elsif ($data eq 'regrader') {
4731: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 4732: my $id = join(',',@parts);
4733: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 4734: }
1.1010 www 4735: }
1.31 albertel 4736: } else {
1.41 ng 4737: if ($#parts == 0) {
4738: $prevattempts.='<th>'.$parts[0].'</th>';
4739: } else {
4740: $prevattempts.='<th>'.$ign.'</th>';
4741: }
1.31 albertel 4742: }
1.16 harris41 4743: }
1.596 albertel 4744: $prevattempts.=&end_data_table_header_row();
1.40 ng 4745: if ($getattempt eq '') {
1.1199 raeburn 4746: my (%solved,%resets,%probstatus);
1.1200 raeburn 4747: if (($identifier ne '') && (keys(%regraded) > 0)) {
4748: for ($version=1;$version<=$returnhash{'version'};$version++) {
4749: foreach my $id (keys(%regraded)) {
4750: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4751: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4752: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4753: push(@{$resets{$id}},$version);
1.1199 raeburn 4754: }
4755: }
4756: }
1.1200 raeburn 4757: }
4758: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 4759: my (@hidden,@unsolved);
1.945 raeburn 4760: if (%typeparts) {
4761: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 4762: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4763: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4764: push(@hidden,$id);
1.1199 raeburn 4765: } elsif ($identifier ne '') {
4766: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4767: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4768: ($hidestatus{$id})) {
1.1200 raeburn 4769: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 4770: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4771: push(@{$solved{$id}},$version);
4772: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4773: (ref($solved{$id}) eq 'ARRAY')) {
4774: my $skip;
4775: if (ref($resets{$id}) eq 'ARRAY') {
4776: foreach my $reset (@{$resets{$id}}) {
4777: if ($reset > $solved{$id}[-1]) {
4778: $skip=1;
4779: last;
4780: }
4781: }
4782: }
4783: unless ($skip) {
4784: my ($ign,$partslist) = split(/\./,$id,2);
4785: push(@unsolved,$partslist);
4786: }
4787: }
4788: }
1.945 raeburn 4789: }
4790: }
4791: }
4792: $prevattempts.=&start_data_table_row().
1.1199 raeburn 4793: '<td>'.&mt('Transaction [_1]',$version);
4794: if (@unsolved) {
4795: $prevattempts .= '<span class="LC_nobreak"><label>'.
4796: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4797: &mt('Hide').'</label></span>';
4798: }
4799: $prevattempts .= '</td>';
1.945 raeburn 4800: if (@hidden) {
4801: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4802: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4803: my $hide;
4804: foreach my $id (@hidden) {
4805: if ($key =~ /^\Q$id\E/) {
4806: $hide = 1;
4807: last;
4808: }
4809: }
4810: if ($hide) {
4811: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4812: if (($data eq 'award') || ($data eq 'awarddetail')) {
4813: my $value = &format_previous_attempt_value($key,
4814: $returnhash{$version.':'.$key});
1.1173 kruse 4815: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4816: } else {
4817: $prevattempts.='<td> </td>';
4818: }
4819: } else {
4820: if ($key =~ /\./) {
1.1212 raeburn 4821: my $value = $returnhash{$version.':'.$key};
4822: if ($key =~ /\.rndseed$/) {
4823: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4824: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4825: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4826: }
4827: }
4828: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4829: ' </td>';
1.945 raeburn 4830: } else {
4831: $prevattempts.='<td> </td>';
4832: }
4833: }
4834: }
4835: } else {
4836: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4837: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 4838: my $value = $returnhash{$version.':'.$key};
4839: if ($key =~ /\.rndseed$/) {
4840: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4841: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4842: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4843: }
4844: }
4845: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4846: ' </td>';
1.945 raeburn 4847: }
4848: }
4849: $prevattempts.=&end_data_table_row();
1.40 ng 4850: }
1.1 albertel 4851: }
1.945 raeburn 4852: my @currhidden = keys(%lasthidden);
1.596 albertel 4853: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4854: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4855: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4856: if (%typeparts) {
4857: my $hidden;
4858: foreach my $id (@currhidden) {
4859: if ($key =~ /^\Q$id\E/) {
4860: $hidden = 1;
4861: last;
4862: }
4863: }
4864: if ($hidden) {
4865: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4866: if (($data eq 'award') || ($data eq 'awarddetail')) {
4867: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4868: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4869: $value = &$gradesub($value);
4870: }
1.1173 kruse 4871: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 4872: } else {
4873: $prevattempts.='<td> </td>';
4874: }
4875: } else {
4876: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4877: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4878: $value = &$gradesub($value);
4879: }
1.1173 kruse 4880: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4881: }
4882: } else {
4883: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4884: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4885: $value = &$gradesub($value);
4886: }
1.1173 kruse 4887: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4888: }
1.16 harris41 4889: }
1.596 albertel 4890: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4891: } else {
1.1305 raeburn 4892: my $msg;
4893: if ($symb =~ /ext\.tool$/) {
4894: $msg = &mt('No grade passed back.');
4895: } else {
4896: $msg = &mt('Nothing submitted - no attempts.');
4897: }
1.596 albertel 4898: $prevattempts=
4899: &start_data_table().&start_data_table_row().
1.1305 raeburn 4900: '<td>'.$msg.'</td>'.
1.596 albertel 4901: &end_data_table_row().&end_data_table();
1.1 albertel 4902: }
4903: } else {
1.596 albertel 4904: $prevattempts=
4905: &start_data_table().&start_data_table_row().
4906: '<td>'.&mt('No data.').'</td>'.
4907: &end_data_table_row().&end_data_table();
1.1 albertel 4908: }
1.10 albertel 4909: }
4910:
1.581 albertel 4911: sub format_previous_attempt_value {
4912: my ($key,$value) = @_;
1.1011 www 4913: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 4914: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 4915: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 4916: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 4917: } elsif ($key =~ /answerstring$/) {
4918: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 4919: my @answer = %answers;
4920: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 4921: my @anskeys = sort(keys(%answers));
4922: if (@anskeys == 1) {
4923: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4924: if ($answer =~ m{\0}) {
4925: $answer =~ s{\0}{,}g;
1.988 raeburn 4926: }
4927: my $tag_internal_answer_name = 'INTERNAL';
4928: if ($anskeys[0] eq $tag_internal_answer_name) {
4929: $value = $answer;
4930: } else {
4931: $value = $anskeys[0].'='.$answer;
4932: }
4933: } else {
4934: foreach my $ans (@anskeys) {
4935: my $answer = $answers{$ans};
1.1001 raeburn 4936: if ($answer =~ m{\0}) {
4937: $answer =~ s{\0}{,}g;
1.988 raeburn 4938: }
4939: $value .= $ans.'='.$answer.'<br />';;
4940: }
4941: }
1.581 albertel 4942: } else {
1.1173 kruse 4943: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 4944: }
4945: return $value;
4946: }
4947:
4948:
1.107 albertel 4949: sub relative_to_absolute {
4950: my ($url,$output)=@_;
4951: my $parser=HTML::TokeParser->new(\$output);
4952: my $token;
4953: my $thisdir=$url;
4954: my @rlinks=();
4955: while ($token=$parser->get_token) {
4956: if ($token->[0] eq 'S') {
4957: if ($token->[1] eq 'a') {
4958: if ($token->[2]->{'href'}) {
4959: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4960: }
4961: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4962: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4963: } elsif ($token->[1] eq 'base') {
4964: $thisdir=$token->[2]->{'href'};
4965: }
4966: }
4967: }
4968: $thisdir=~s-/[^/]*$--;
1.356 albertel 4969: foreach my $link (@rlinks) {
1.726 raeburn 4970: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4971: ($link=~/^\//) ||
4972: ($link=~/^javascript:/i) ||
4973: ($link=~/^mailto:/i) ||
4974: ($link=~/^\#/)) {
4975: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4976: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4977: }
4978: }
4979: # -------------------------------------------------- Deal with Applet codebases
4980: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4981: return $output;
4982: }
4983:
1.112 bowersj2 4984: =pod
4985:
1.648 raeburn 4986: =item * &get_student_view()
1.112 bowersj2 4987:
4988: show a snapshot of what student was looking at
4989:
4990: =cut
4991:
1.10 albertel 4992: sub get_student_view {
1.186 albertel 4993: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4994: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4995: my (%form);
1.10 albertel 4996: my @elements=('symb','courseid','domain','username');
4997: foreach my $element (@elements) {
1.186 albertel 4998: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4999: }
1.186 albertel 5000: if (defined($moreenv)) {
5001: %form=(%form,%{$moreenv});
5002: }
1.236 albertel 5003: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5004: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5005: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5006: $feedurl =~ s{^/adm/wrapper}{};
5007: }
1.650 www 5008: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5009: $userview=~s/\<body[^\>]*\>//gi;
5010: $userview=~s/\<\/body\>//gi;
5011: $userview=~s/\<html\>//gi;
5012: $userview=~s/\<\/html\>//gi;
5013: $userview=~s/\<head\>//gi;
5014: $userview=~s/\<\/head\>//gi;
5015: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5016: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5017: if (wantarray) {
5018: return ($userview,$response);
5019: } else {
5020: return $userview;
5021: }
5022: }
5023:
5024: sub get_student_view_with_retries {
5025: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5026:
5027: my $ok = 0; # True if we got a good response.
5028: my $content;
5029: my $response;
5030:
5031: # Try to get the student_view done. within the retries count:
5032:
5033: do {
5034: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5035: $ok = $response->is_success;
5036: if (!$ok) {
5037: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5038: }
5039: $retries--;
5040: } while (!$ok && ($retries > 0));
5041:
5042: if (!$ok) {
5043: $content = ''; # On error return an empty content.
5044: }
1.651 www 5045: if (wantarray) {
5046: return ($content, $response);
5047: } else {
5048: return $content;
5049: }
1.11 albertel 5050: }
5051:
1.1349 raeburn 5052: sub css_links {
5053: my ($currsymb,$level) = @_;
5054: my ($links,@symbs,%cssrefs,%httpref);
5055: if ($level eq 'map') {
5056: my $navmap = Apache::lonnavmaps::navmap->new();
5057: if (ref($navmap)) {
5058: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5059: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5060: foreach my $res (@resources) {
5061: if (ref($res) && $res->symb()) {
5062: push(@symbs,$res->symb());
5063: }
5064: }
5065: }
5066: } else {
5067: @symbs = ($currsymb);
5068: }
5069: foreach my $symb (@symbs) {
5070: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5071: if ($css_href =~ /\S/) {
5072: unless ($css_href =~ m{https?://}) {
5073: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5074: my $proburl = &Apache::lonnet::clutter($url);
5075: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5076: unless ($css_href =~ m{^/}) {
5077: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5078: }
5079: if ($css_href =~ m{^/(res|uploaded)/}) {
5080: unless (($httpref{'httpref.'.$css_href}) ||
5081: (&Apache::lonnet::is_on_map($css_href))) {
5082: my $thisurl = $proburl;
5083: if ($env{'httpref.'.$proburl}) {
5084: $thisurl = $env{'httpref.'.$proburl};
5085: }
5086: $httpref{'httpref.'.$css_href} = $thisurl;
5087: }
5088: }
5089: }
5090: $cssrefs{$css_href} = 1;
5091: }
5092: }
5093: if (keys(%httpref)) {
5094: &Apache::lonnet::appenv(\%httpref);
5095: }
5096: if (keys(%cssrefs)) {
5097: foreach my $css_href (keys(%cssrefs)) {
5098: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5099: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5100: }
5101: }
5102: return $links;
5103: }
5104:
1.112 bowersj2 5105: =pod
5106:
1.648 raeburn 5107: =item * &get_student_answers()
1.112 bowersj2 5108:
5109: show a snapshot of how student was answering problem
5110:
5111: =cut
5112:
1.11 albertel 5113: sub get_student_answers {
1.100 sakharuk 5114: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5115: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5116: my (%moreenv);
1.11 albertel 5117: my @elements=('symb','courseid','domain','username');
5118: foreach my $element (@elements) {
1.186 albertel 5119: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5120: }
1.186 albertel 5121: $moreenv{'grade_target'}='answer';
5122: %moreenv=(%form,%moreenv);
1.497 raeburn 5123: $feedurl = &Apache::lonnet::clutter($feedurl);
5124: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5125: return $userview;
1.1 albertel 5126: }
1.116 albertel 5127:
5128: =pod
5129:
5130: =item * &submlink()
5131:
1.242 albertel 5132: Inputs: $text $uname $udom $symb $target
1.116 albertel 5133:
5134: Returns: A link to grades.pm such as to see the SUBM view of a student
5135:
5136: =cut
5137:
5138: ###############################################
5139: sub submlink {
1.242 albertel 5140: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5141: if (!($uname && $udom)) {
5142: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5143: &Apache::lonnet::whichuser($symb);
1.116 albertel 5144: if (!$symb) { $symb=$cursymb; }
5145: }
1.254 matthew 5146: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5147: $symb=&escape($symb);
1.960 bisitz 5148: if ($target) { $target=" target=\"$target\""; }
5149: return
5150: '<a href="/adm/grades?command=submission'.
5151: '&symb='.$symb.
5152: '&student='.$uname.
5153: '&userdom='.$udom.'"'.
5154: $target.'>'.$text.'</a>';
1.242 albertel 5155: }
5156: ##############################################
5157:
5158: =pod
5159:
5160: =item * &pgrdlink()
5161:
5162: Inputs: $text $uname $udom $symb $target
5163:
5164: Returns: A link to grades.pm such as to see the PGRD view of a student
5165:
5166: =cut
5167:
5168: ###############################################
5169: sub pgrdlink {
5170: my $link=&submlink(@_);
5171: $link=~s/(&command=submission)/$1&showgrading=yes/;
5172: return $link;
5173: }
5174: ##############################################
5175:
5176: =pod
5177:
5178: =item * &pprmlink()
5179:
5180: Inputs: $text $uname $udom $symb $target
5181:
5182: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5183: student and a specific resource
1.242 albertel 5184:
5185: =cut
5186:
5187: ###############################################
5188: sub pprmlink {
5189: my ($text,$uname,$udom,$symb,$target)=@_;
5190: if (!($uname && $udom)) {
5191: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5192: &Apache::lonnet::whichuser($symb);
1.242 albertel 5193: if (!$symb) { $symb=$cursymb; }
5194: }
1.254 matthew 5195: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5196: $symb=&escape($symb);
1.242 albertel 5197: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5198: return '<a href="/adm/parmset?command=set&'.
5199: 'symb='.$symb.'&uname='.$uname.
5200: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5201: }
5202: ##############################################
1.37 matthew 5203:
1.112 bowersj2 5204: =pod
5205:
5206: =back
5207:
5208: =cut
5209:
1.37 matthew 5210: ###############################################
1.51 www 5211:
5212:
5213: sub timehash {
1.687 raeburn 5214: my ($thistime) = @_;
5215: my $timezone = &Apache::lonlocal::gettimezone();
5216: my $dt = DateTime->from_epoch(epoch => $thistime)
5217: ->set_time_zone($timezone);
5218: my $wday = $dt->day_of_week();
5219: if ($wday == 7) { $wday = 0; }
5220: return ( 'second' => $dt->second(),
5221: 'minute' => $dt->minute(),
5222: 'hour' => $dt->hour(),
5223: 'day' => $dt->day_of_month(),
5224: 'month' => $dt->month(),
5225: 'year' => $dt->year(),
5226: 'weekday' => $wday,
5227: 'dayyear' => $dt->day_of_year(),
5228: 'dlsav' => $dt->is_dst() );
1.51 www 5229: }
5230:
1.370 www 5231: sub utc_string {
5232: my ($date)=@_;
1.371 www 5233: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5234: }
5235:
1.51 www 5236: sub maketime {
5237: my %th=@_;
1.687 raeburn 5238: my ($epoch_time,$timezone,$dt);
5239: $timezone = &Apache::lonlocal::gettimezone();
5240: eval {
5241: $dt = DateTime->new( year => $th{'year'},
5242: month => $th{'month'},
5243: day => $th{'day'},
5244: hour => $th{'hour'},
5245: minute => $th{'minute'},
5246: second => $th{'second'},
5247: time_zone => $timezone,
5248: );
5249: };
5250: if (!$@) {
5251: $epoch_time = $dt->epoch;
5252: if ($epoch_time) {
5253: return $epoch_time;
5254: }
5255: }
1.51 www 5256: return POSIX::mktime(
5257: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5258: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5259: }
5260:
5261: #########################################
1.51 www 5262:
5263: sub findallcourses {
1.482 raeburn 5264: my ($roles,$uname,$udom) = @_;
1.355 albertel 5265: my %roles;
5266: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5267: my %courses;
1.51 www 5268: my $now=time;
1.482 raeburn 5269: if (!defined($uname)) {
5270: $uname = $env{'user.name'};
5271: }
5272: if (!defined($udom)) {
5273: $udom = $env{'user.domain'};
5274: }
5275: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5276: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5277: if (!%roles) {
5278: %roles = (
5279: cc => 1,
1.907 raeburn 5280: co => 1,
1.482 raeburn 5281: in => 1,
5282: ep => 1,
5283: ta => 1,
5284: cr => 1,
5285: st => 1,
5286: );
5287: }
5288: foreach my $entry (keys(%roleshash)) {
5289: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5290: if ($trole =~ /^cr/) {
5291: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5292: } else {
5293: next if (!exists($roles{$trole}));
5294: }
5295: if ($tend) {
5296: next if ($tend < $now);
5297: }
5298: if ($tstart) {
5299: next if ($tstart > $now);
5300: }
1.1058 raeburn 5301: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5302: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5303: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5304: if ($secpart eq '') {
5305: ($cnum,$role) = split(/_/,$cnumpart);
5306: $sec = 'none';
1.1058 raeburn 5307: $value .= $cnum.'/';
1.482 raeburn 5308: } else {
5309: $cnum = $cnumpart;
5310: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5311: $value .= $cnum.'/'.$sec;
5312: }
5313: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5314: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5315: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5316: }
5317: } else {
5318: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5319: }
1.482 raeburn 5320: }
5321: } else {
5322: foreach my $key (keys(%env)) {
1.483 albertel 5323: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5324: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5325: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5326: next if ($role eq 'ca' || $role eq 'aa');
5327: next if (%roles && !exists($roles{$role}));
5328: my ($starttime,$endtime)=split(/\./,$env{$key});
5329: my $active=1;
5330: if ($starttime) {
5331: if ($now<$starttime) { $active=0; }
5332: }
5333: if ($endtime) {
5334: if ($now>$endtime) { $active=0; }
5335: }
5336: if ($active) {
1.1058 raeburn 5337: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5338: if ($sec eq '') {
5339: $sec = 'none';
1.1058 raeburn 5340: } else {
5341: $value .= $sec;
5342: }
5343: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5344: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5345: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5346: }
5347: } else {
5348: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5349: }
1.474 raeburn 5350: }
5351: }
1.51 www 5352: }
5353: }
1.474 raeburn 5354: return %courses;
1.51 www 5355: }
1.37 matthew 5356:
1.54 www 5357: ###############################################
1.474 raeburn 5358:
5359: sub blockcheck {
1.1372 raeburn 5360: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5361: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5362: my ($has_evb,$check_ipaccess);
5363: my $dom = $env{'user.domain'};
5364: if ($env{'request.course.id'}) {
5365: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5366: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5367: my $checkrole = "cm./$cdom/$cnum";
5368: my $sec = $env{'request.course.sec'};
5369: if ($sec ne '') {
5370: $checkrole .= "/$sec";
5371: }
5372: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5373: ($env{'request.role'} !~ /^st/)) {
5374: $has_evb = 1;
5375: }
5376: unless ($has_evb) {
5377: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
5378: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
5379: if ($udom eq $cdom) {
5380: $check_ipaccess = 1;
5381: }
5382: }
5383: }
1.1375 raeburn 5384: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5385: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5386: my $checkrole;
5387: if ($env{'request.role.domain'} eq '') {
5388: $checkrole = "cm./$env{'user.domain'}/";
5389: } else {
5390: $checkrole = "cm./$env{'request.role.domain'}/";
5391: }
5392: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5393: $has_evb = 1;
5394: }
1.1372 raeburn 5395: }
5396: unless ($has_evb || $check_ipaccess) {
5397: my @machinedoms = &Apache::lonnet::current_machine_domains();
5398: if (($dom eq 'public') && ($activity eq 'port')) {
5399: $dom = $udom;
5400: }
5401: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5402: $check_ipaccess = 1;
5403: } else {
5404: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5405: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5406: my $prim = &Apache::lonnet::domain($dom,'primary');
5407: my $intdom = &Apache::lonnet::internet_dom($prim);
5408: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5409: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5410: $check_ipaccess = 1;
5411: }
5412: }
5413: }
5414: }
5415: if ($check_ipaccess) {
5416: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5417: unless (defined($cached)) {
5418: my %domconfig =
5419: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5420: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5421: }
5422: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5423: foreach my $id (keys(%{$ipaccessref})) {
5424: if (ref($ipaccessref->{$id}) eq 'HASH') {
5425: my $range = $ipaccessref->{$id}->{'ip'};
5426: if ($range) {
5427: if (&Apache::lonnet::ip_match($clientip,$range)) {
5428: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5429: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5430: return ('','','',$id,$dom);
5431: last;
5432: }
5433: }
5434: }
5435: }
5436: }
5437: }
5438: }
5439: }
1.1373 raeburn 5440: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5441: return ();
5442: }
1.1372 raeburn 5443: }
1.1189 raeburn 5444: if (defined($udom) && defined($uname)) {
5445: # If uname and udom are for a course, check for blocks in the course.
5446: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5447: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5448: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5449: return ($startblock,$endblock,$triggerblock);
5450: }
5451: } else {
1.490 raeburn 5452: $udom = $env{'user.domain'};
5453: $uname = $env{'user.name'};
5454: }
5455:
1.502 raeburn 5456: my $startblock = 0;
5457: my $endblock = 0;
1.1062 raeburn 5458: my $triggerblock = '';
1.1373 raeburn 5459: my %live_courses;
5460: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5461: %live_courses = &findallcourses(undef,$uname,$udom);
5462: }
1.474 raeburn 5463:
1.490 raeburn 5464: # If uname is for a user, and activity is course-specific, i.e.,
5465: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5466:
1.490 raeburn 5467: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5468: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5469: $activity eq 'search' || $activity eq 'reinit' ||
5470: $activity eq 'alert') &&
1.1189 raeburn 5471: ($env{'request.course.id'})) {
1.490 raeburn 5472: foreach my $key (keys(%live_courses)) {
5473: if ($key ne $env{'request.course.id'}) {
5474: delete($live_courses{$key});
5475: }
5476: }
5477: }
5478:
5479: my $otheruser = 0;
5480: my %own_courses;
5481: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5482: # Resource belongs to user other than current user.
5483: $otheruser = 1;
5484: # Gather courses for current user
5485: %own_courses =
5486: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5487: }
5488:
5489: # Gather active course roles - course coordinator, instructor,
5490: # exam proctor, ta, student, or custom role.
1.474 raeburn 5491:
5492: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5493: my ($cdom,$cnum);
5494: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5495: $cdom = $env{'course.'.$course.'.domain'};
5496: $cnum = $env{'course.'.$course.'.num'};
5497: } else {
1.490 raeburn 5498: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5499: }
5500: my $no_ownblock = 0;
5501: my $no_userblock = 0;
1.533 raeburn 5502: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5503: # Check if current user has 'evb' priv for this
5504: if (defined($own_courses{$course})) {
5505: foreach my $sec (keys(%{$own_courses{$course}})) {
5506: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5507: if ($sec ne 'none') {
5508: $checkrole .= '/'.$sec;
5509: }
5510: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5511: $no_ownblock = 1;
5512: last;
5513: }
5514: }
5515: }
5516: # if they have 'evb' priv and are currently not playing student
5517: next if (($no_ownblock) &&
5518: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5519: }
1.474 raeburn 5520: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5521: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5522: if ($sec ne 'none') {
1.482 raeburn 5523: $checkrole .= '/'.$sec;
1.474 raeburn 5524: }
1.490 raeburn 5525: if ($otheruser) {
5526: # Resource belongs to user other than current user.
5527: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5528: my (%allroles,%userroles);
5529: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5530: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5531: my ($trole,$tdom,$tnum,$tsec);
5532: if ($entry =~ /^cr/) {
5533: ($trole,$tdom,$tnum,$tsec) =
5534: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5535: } else {
5536: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5537: }
5538: my ($spec,$area,$trest);
5539: $area = '/'.$tdom.'/'.$tnum;
5540: $trest = $tnum;
5541: if ($tsec ne '') {
5542: $area .= '/'.$tsec;
5543: $trest .= '/'.$tsec;
5544: }
5545: $spec = $trole.'.'.$area;
5546: if ($trole =~ /^cr/) {
5547: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5548: $tdom,$spec,$trest,$area);
5549: } else {
5550: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5551: $tdom,$spec,$trest,$area);
5552: }
5553: }
1.1276 raeburn 5554: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5555: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5556: if ($1) {
5557: $no_userblock = 1;
5558: last;
5559: }
1.486 raeburn 5560: }
5561: }
1.490 raeburn 5562: } else {
5563: # Resource belongs to current user
5564: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5565: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5566: $no_ownblock = 1;
5567: last;
5568: }
1.474 raeburn 5569: }
5570: }
5571: # if they have the evb priv and are currently not playing student
1.482 raeburn 5572: next if (($no_ownblock) &&
1.491 albertel 5573: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5574: next if ($no_userblock);
1.474 raeburn 5575:
1.1303 raeburn 5576: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5577: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5578:
1.1062 raeburn 5579: my ($start,$end,$trigger) =
1.1347 raeburn 5580: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5581: if (($start != 0) &&
5582: (($startblock == 0) || ($startblock > $start))) {
5583: $startblock = $start;
1.1062 raeburn 5584: if ($trigger ne '') {
5585: $triggerblock = $trigger;
5586: }
1.502 raeburn 5587: }
5588: if (($end != 0) &&
5589: (($endblock == 0) || ($endblock < $end))) {
5590: $endblock = $end;
1.1062 raeburn 5591: if ($trigger ne '') {
5592: $triggerblock = $trigger;
5593: }
1.502 raeburn 5594: }
1.490 raeburn 5595: }
1.1062 raeburn 5596: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5597: }
5598:
5599: sub get_blocks {
1.1347 raeburn 5600: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5601: my $startblock = 0;
5602: my $endblock = 0;
1.1062 raeburn 5603: my $triggerblock = '';
1.490 raeburn 5604: my $course = $cdom.'_'.$cnum;
5605: $setters->{$course} = {};
5606: $setters->{$course}{'staff'} = [];
5607: $setters->{$course}{'times'} = [];
1.1062 raeburn 5608: $setters->{$course}{'triggers'} = [];
5609: my (@blockers,%triggered);
5610: my $now = time;
5611: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5612: if ($activity eq 'docs') {
1.1348 raeburn 5613: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5614: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5615: $blocked = 1;
5616: $nosymbcache = 1;
1.1348 raeburn 5617: $noenccheck = 1;
1.1347 raeburn 5618: }
1.1348 raeburn 5619: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5620: foreach my $block (@blockers) {
5621: if ($block =~ /^firstaccess____(.+)$/) {
5622: my $item = $1;
5623: my $type = 'map';
5624: my $timersymb = $item;
5625: if ($item eq 'course') {
5626: $type = 'course';
5627: } elsif ($item =~ /___\d+___/) {
5628: $type = 'resource';
5629: } else {
5630: $timersymb = &Apache::lonnet::symbread($item);
5631: }
5632: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5633: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5634: $triggered{$block} = {
5635: start => $start,
5636: end => $end,
5637: type => $type,
5638: };
5639: }
5640: }
5641: } else {
5642: foreach my $block (keys(%commblocks)) {
5643: if ($block =~ m/^(\d+)____(\d+)$/) {
5644: my ($start,$end) = ($1,$2);
5645: if ($start <= time && $end >= time) {
5646: if (ref($commblocks{$block}) eq 'HASH') {
5647: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5648: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5649: unless(grep(/^\Q$block\E$/,@blockers)) {
5650: push(@blockers,$block);
5651: }
5652: }
5653: }
5654: }
5655: }
5656: } elsif ($block =~ /^firstaccess____(.+)$/) {
5657: my $item = $1;
5658: my $timersymb = $item;
5659: my $type = 'map';
5660: if ($item eq 'course') {
5661: $type = 'course';
5662: } elsif ($item =~ /___\d+___/) {
5663: $type = 'resource';
5664: } else {
5665: $timersymb = &Apache::lonnet::symbread($item);
5666: }
5667: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5668: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5669: if ($start && $end) {
5670: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5671: if (ref($commblocks{$block}) eq 'HASH') {
5672: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5673: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5674: unless(grep(/^\Q$block\E$/,@blockers)) {
5675: push(@blockers,$block);
5676: $triggered{$block} = {
5677: start => $start,
5678: end => $end,
5679: type => $type,
5680: };
5681: }
5682: }
5683: }
1.1062 raeburn 5684: }
5685: }
1.490 raeburn 5686: }
1.1062 raeburn 5687: }
5688: }
5689: }
5690: foreach my $blocker (@blockers) {
5691: my ($staff_name,$staff_dom,$title,$blocks) =
5692: &parse_block_record($commblocks{$blocker});
5693: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5694: my ($start,$end,$triggertype);
5695: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5696: ($start,$end) = ($1,$2);
5697: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5698: $start = $triggered{$blocker}{'start'};
5699: $end = $triggered{$blocker}{'end'};
5700: $triggertype = $triggered{$blocker}{'type'};
5701: }
5702: if ($start) {
5703: push(@{$$setters{$course}{'times'}}, [$start,$end]);
5704: if ($triggertype) {
5705: push(@{$$setters{$course}{'triggers'}},$triggertype);
5706: } else {
5707: push(@{$$setters{$course}{'triggers'}},0);
5708: }
5709: if ( ($startblock == 0) || ($startblock > $start) ) {
5710: $startblock = $start;
5711: if ($triggertype) {
5712: $triggerblock = $blocker;
1.474 raeburn 5713: }
5714: }
1.1062 raeburn 5715: if ( ($endblock == 0) || ($endblock < $end) ) {
5716: $endblock = $end;
5717: if ($triggertype) {
5718: $triggerblock = $blocker;
5719: }
5720: }
1.474 raeburn 5721: }
5722: }
1.1062 raeburn 5723: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5724: }
5725:
5726: sub parse_block_record {
5727: my ($record) = @_;
5728: my ($setuname,$setudom,$title,$blocks);
5729: if (ref($record) eq 'HASH') {
5730: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5731: $title = &unescape($record->{'event'});
5732: $blocks = $record->{'blocks'};
5733: } else {
5734: my @data = split(/:/,$record,3);
5735: if (scalar(@data) eq 2) {
5736: $title = $data[1];
5737: ($setuname,$setudom) = split(/@/,$data[0]);
5738: } else {
5739: ($setuname,$setudom,$title) = @data;
5740: }
5741: $blocks = { 'com' => 'on' };
5742: }
5743: return ($setuname,$setudom,$title,$blocks);
5744: }
5745:
1.854 kalberla 5746: sub blocking_status {
1.1372 raeburn 5747: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 5748: my %setters;
1.890 droeschl 5749:
1.1061 raeburn 5750: # check for active blocking
1.1372 raeburn 5751: if ($clientip eq '') {
5752: $clientip = &Apache::lonnet::get_requestor_ip();
5753: }
5754: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
5755: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 5756: my $blocked = 0;
1.1372 raeburn 5757: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 5758: $blocked = 1;
5759: }
1.890 droeschl 5760:
1.1061 raeburn 5761: # caller just wants to know whether a block is active
5762: if (!wantarray) { return $blocked; }
5763:
5764: # build a link to a popup window containing the details
5765: my $querystring = "?activity=$activity";
1.1351 raeburn 5766: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
5767: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 5768: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5769: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5770: } elsif ($activity eq 'docs') {
1.1347 raeburn 5771: my $showurl = &Apache::lonenc::check_encrypt($url);
5772: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
5773: if ($symb) {
5774: my $showsymb = &Apache::lonenc::check_encrypt($symb);
5775: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
5776: }
1.1062 raeburn 5777: }
1.1061 raeburn 5778:
5779: my $output .= <<'END_MYBLOCK';
5780: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5781: var options = "width=" + w + ",height=" + h + ",";
5782: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5783: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5784: var newWin = window.open(url, wdwName, options);
5785: newWin.focus();
5786: }
1.890 droeschl 5787: END_MYBLOCK
1.854 kalberla 5788:
1.1061 raeburn 5789: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5790:
1.1061 raeburn 5791: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5792: my $text = &mt('Communication Blocked');
1.1217 raeburn 5793: my $class = 'LC_comblock';
1.1062 raeburn 5794: if ($activity eq 'docs') {
5795: $text = &mt('Content Access Blocked');
1.1217 raeburn 5796: $class = '';
1.1063 raeburn 5797: } elsif ($activity eq 'printout') {
5798: $text = &mt('Printing Blocked');
1.1232 raeburn 5799: } elsif ($activity eq 'passwd') {
5800: $text = &mt('Password Changing Blocked');
1.1345 raeburn 5801: } elsif ($activity eq 'grades') {
5802: $text = &mt('Gradebook Blocked');
1.1346 raeburn 5803: } elsif ($activity eq 'search') {
5804: $text = &mt('Search Blocked');
1.1282 raeburn 5805: } elsif ($activity eq 'alert') {
5806: $text = &mt('Checking Critical Messages Blocked');
5807: } elsif ($activity eq 'reinit') {
5808: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 5809: } elsif ($activity eq 'about') {
5810: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 5811: } elsif ($activity eq 'wishlist') {
5812: $text = &mt('Access to Stored Links Blocked');
5813: } elsif ($activity eq 'annotate') {
5814: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 5815: }
1.1061 raeburn 5816: $output .= <<"END_BLOCK";
1.1217 raeburn 5817: <div class='$class'>
1.869 kalberla 5818: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5819: title='$text'>
5820: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5821: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5822: title='$text'>$text</a>
1.867 kalberla 5823: </div>
5824:
5825: END_BLOCK
1.474 raeburn 5826:
1.1061 raeburn 5827: return ($blocked, $output);
1.854 kalberla 5828: }
1.490 raeburn 5829:
1.60 matthew 5830: ###############################################
5831:
1.682 raeburn 5832: sub check_ip_acc {
1.1201 raeburn 5833: my ($acc,$clientip)=@_;
1.682 raeburn 5834: &Apache::lonxml::debug("acc is $acc");
5835: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5836: return 1;
5837: }
1.1339 raeburn 5838: my ($ip,$allowed);
5839: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5840: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5841: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5842: } else {
1.1350 raeburn 5843: my $remote_ip = &Apache::lonnet::get_requestor_ip();
5844: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 5845: }
1.682 raeburn 5846:
5847: my $name;
1.1219 raeburn 5848: my %access = (
5849: allowfrom => 1,
5850: denyfrom => 0,
5851: );
5852: my @allows;
5853: my @denies;
5854: foreach my $item (split(',',$acc)) {
5855: $item =~ s/^\s*//;
5856: $item =~ s/\s*$//;
5857: my $pattern;
5858: if ($item =~ /^\!(.+)$/) {
5859: push(@denies,$1);
5860: } else {
5861: push(@allows,$item);
5862: }
5863: }
5864: my $numdenies = scalar(@denies);
5865: my $numallows = scalar(@allows);
5866: my $count = 0;
5867: foreach my $pattern (@denies,@allows) {
5868: $count ++;
5869: my $acctype = 'allowfrom';
5870: if ($count <= $numdenies) {
5871: $acctype = 'denyfrom';
5872: }
1.682 raeburn 5873: if ($pattern =~ /\*$/) {
5874: #35.8.*
5875: $pattern=~s/\*//;
1.1219 raeburn 5876: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5877: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5878: #35.8.3.[34-56]
5879: my $low=$2;
5880: my $high=$3;
5881: $pattern=$1;
5882: if ($ip =~ /^\Q$pattern\E/) {
5883: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 5884: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 5885: }
5886: } elsif ($pattern =~ /^\*/) {
5887: #*.msu.edu
5888: $pattern=~s/\*//;
5889: if (!defined($name)) {
5890: use Socket;
5891: my $netaddr=inet_aton($ip);
5892: ($name)=gethostbyaddr($netaddr,AF_INET);
5893: }
1.1219 raeburn 5894: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 5895: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5896: #127.0.0.1
1.1219 raeburn 5897: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5898: } else {
5899: #some.name.com
5900: if (!defined($name)) {
5901: use Socket;
5902: my $netaddr=inet_aton($ip);
5903: ($name)=gethostbyaddr($netaddr,AF_INET);
5904: }
1.1219 raeburn 5905: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
5906: }
5907: if ($allowed =~ /^(0|1)$/) { last; }
5908: }
5909: if ($allowed eq '') {
5910: if ($numdenies && !$numallows) {
5911: $allowed = 1;
5912: } else {
5913: $allowed = 0;
1.682 raeburn 5914: }
5915: }
5916: return $allowed;
5917: }
5918:
5919: ###############################################
5920:
1.60 matthew 5921: =pod
5922:
1.112 bowersj2 5923: =head1 Domain Template Functions
5924:
5925: =over 4
5926:
5927: =item * &determinedomain()
1.60 matthew 5928:
5929: Inputs: $domain (usually will be undef)
5930:
1.63 www 5931: Returns: Determines which domain should be used for designs
1.60 matthew 5932:
5933: =cut
1.54 www 5934:
1.60 matthew 5935: ###############################################
1.63 www 5936: sub determinedomain {
5937: my $domain=shift;
1.531 albertel 5938: if (! $domain) {
1.60 matthew 5939: # Determine domain if we have not been given one
1.893 raeburn 5940: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5941: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5942: if ($env{'request.role.domain'}) {
5943: $domain=$env{'request.role.domain'};
1.60 matthew 5944: }
5945: }
1.63 www 5946: return $domain;
5947: }
5948: ###############################################
1.517 raeburn 5949:
1.518 albertel 5950: sub devalidate_domconfig_cache {
5951: my ($udom)=@_;
5952: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5953: }
5954:
5955: # ---------------------- Get domain configuration for a domain
5956: sub get_domainconf {
5957: my ($udom) = @_;
5958: my $cachetime=1800;
5959: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5960: if (defined($cached)) { return %{$result}; }
5961:
5962: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5963: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5964: my (%designhash,%legacy);
1.518 albertel 5965: if (keys(%domconfig) > 0) {
5966: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5967: if (keys(%{$domconfig{'login'}})) {
5968: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5969: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 5970: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5971: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5972: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5973: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5974: if ($key eq 'loginvia') {
5975: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5976: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5977: $designhash{$udom.'.login.loginvia'} = $server;
5978: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5979:
5980: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5981: } else {
5982: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5983: }
1.948 raeburn 5984: }
1.1208 raeburn 5985: } elsif ($key eq 'headtag') {
5986: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5987: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5988: }
1.946 raeburn 5989: }
1.1208 raeburn 5990: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5991: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5992: }
1.946 raeburn 5993: }
5994: }
5995: }
1.1366 raeburn 5996: } elsif ($key eq 'saml') {
5997: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5998: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
5999: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6000: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
6001: foreach my $item ('text','img','alt','url','title','notsso') {
6002: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6003: }
6004: }
6005: }
6006: }
1.946 raeburn 6007: } else {
6008: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6009: $designhash{$udom.'.login.'.$key.'_'.$img} =
6010: $domconfig{'login'}{$key}{$img};
6011: }
1.699 raeburn 6012: }
6013: } else {
6014: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6015: }
1.632 raeburn 6016: }
6017: } else {
6018: $legacy{'login'} = 1;
1.518 albertel 6019: }
1.632 raeburn 6020: } else {
6021: $legacy{'login'} = 1;
1.518 albertel 6022: }
6023: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6024: if (keys(%{$domconfig{'rolecolors'}})) {
6025: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6026: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6027: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6028: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6029: }
1.518 albertel 6030: }
6031: }
1.632 raeburn 6032: } else {
6033: $legacy{'rolecolors'} = 1;
1.518 albertel 6034: }
1.632 raeburn 6035: } else {
6036: $legacy{'rolecolors'} = 1;
1.518 albertel 6037: }
1.948 raeburn 6038: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6039: if ($domconfig{'autoenroll'}{'co-owners'}) {
6040: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6041: }
6042: }
1.632 raeburn 6043: if (keys(%legacy) > 0) {
6044: my %legacyhash = &get_legacy_domconf($udom);
6045: foreach my $item (keys(%legacyhash)) {
6046: if ($item =~ /^\Q$udom\E\.login/) {
6047: if ($legacy{'login'}) {
6048: $designhash{$item} = $legacyhash{$item};
6049: }
6050: } else {
6051: if ($legacy{'rolecolors'}) {
6052: $designhash{$item} = $legacyhash{$item};
6053: }
1.518 albertel 6054: }
6055: }
6056: }
1.632 raeburn 6057: } else {
6058: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6059: }
6060: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6061: $cachetime);
6062: return %designhash;
6063: }
6064:
1.632 raeburn 6065: sub get_legacy_domconf {
6066: my ($udom) = @_;
6067: my %legacyhash;
6068: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6069: my $designfile = $designdir.'/'.$udom.'.tab';
6070: if (-e $designfile) {
1.1317 raeburn 6071: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6072: while (my $line = <$fh>) {
6073: next if ($line =~ /^\#/);
6074: chomp($line);
6075: my ($key,$val)=(split(/\=/,$line));
6076: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6077: }
6078: close($fh);
6079: }
6080: }
1.1026 raeburn 6081: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6082: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6083: }
6084: return %legacyhash;
6085: }
6086:
1.63 www 6087: =pod
6088:
1.112 bowersj2 6089: =item * &domainlogo()
1.63 www 6090:
6091: Inputs: $domain (usually will be undef)
6092:
6093: Returns: A link to a domain logo, if the domain logo exists.
6094: If the domain logo does not exist, a description of the domain.
6095:
6096: =cut
1.112 bowersj2 6097:
1.63 www 6098: ###############################################
6099: sub domainlogo {
1.517 raeburn 6100: my $domain = &determinedomain(shift);
1.518 albertel 6101: my %designhash = &get_domainconf($domain);
1.517 raeburn 6102: # See if there is a logo
6103: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6104: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6105: if ($imgsrc =~ m{^/(adm|res)/}) {
6106: if ($imgsrc =~ m{^/res/}) {
6107: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6108: &Apache::lonnet::repcopy($local_name);
6109: }
6110: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6111: }
6112: my $alttext = $domain;
6113: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6114: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6115: }
6116: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6117: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6118: return &Apache::lonnet::domain($domain,'description');
1.59 www 6119: } else {
1.60 matthew 6120: return '';
1.59 www 6121: }
6122: }
1.63 www 6123: ##############################################
6124:
6125: =pod
6126:
1.112 bowersj2 6127: =item * &designparm()
1.63 www 6128:
6129: Inputs: $which parameter; $domain (usually will be undef)
6130:
6131: Returns: value of designparamter $which
6132:
6133: =cut
1.112 bowersj2 6134:
1.397 albertel 6135:
1.400 albertel 6136: ##############################################
1.397 albertel 6137: sub designparm {
6138: my ($which,$domain)=@_;
6139: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6140: return $env{'environment.color.'.$which};
1.96 www 6141: }
1.63 www 6142: $domain=&determinedomain($domain);
1.1016 raeburn 6143: my %domdesign;
6144: unless ($domain eq 'public') {
6145: %domdesign = &get_domainconf($domain);
6146: }
1.520 raeburn 6147: my $output;
1.517 raeburn 6148: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6149: $output = $domdesign{$domain.'.'.$which};
1.63 www 6150: } else {
1.520 raeburn 6151: $output = $defaultdesign{$which};
6152: }
6153: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6154: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6155: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6156: if ($output =~ m{^/res/}) {
6157: my $local_name = &Apache::lonnet::filelocation('',$output);
6158: &Apache::lonnet::repcopy($local_name);
6159: }
1.520 raeburn 6160: $output = &lonhttpdurl($output);
6161: }
1.63 www 6162: }
1.520 raeburn 6163: return $output;
1.63 www 6164: }
1.59 www 6165:
1.822 bisitz 6166: ##############################################
6167: =pod
6168:
1.832 bisitz 6169: =item * &authorspace()
6170:
1.1028 raeburn 6171: Inputs: $url (usually will be undef).
1.832 bisitz 6172:
1.1132 raeburn 6173: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6174: directory being viewed (or for which action is being taken).
6175: If $url is provided, and begins /priv/<domain>/<uname>
6176: the path will be that portion of the $context argument.
6177: Otherwise the path will be for the author space of the current
6178: user when the current role is author, or for that of the
6179: co-author/assistant co-author space when the current role
6180: is co-author or assistant co-author.
1.832 bisitz 6181:
6182: =cut
6183:
6184: sub authorspace {
1.1028 raeburn 6185: my ($url) = @_;
6186: if ($url ne '') {
6187: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6188: return $1;
6189: }
6190: }
1.832 bisitz 6191: my $caname = '';
1.1024 www 6192: my $cadom = '';
1.1028 raeburn 6193: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6194: ($cadom,$caname) =
1.832 bisitz 6195: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6196: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6197: $caname = $env{'user.name'};
1.1024 www 6198: $cadom = $env{'user.domain'};
1.832 bisitz 6199: }
1.1028 raeburn 6200: if (($caname ne '') && ($cadom ne '')) {
6201: return "/priv/$cadom/$caname/";
6202: }
6203: return;
1.832 bisitz 6204: }
6205:
6206: ##############################################
6207: =pod
6208:
1.822 bisitz 6209: =item * &head_subbox()
6210:
6211: Inputs: $content (contains HTML code with page functions, etc.)
6212:
6213: Returns: HTML div with $content
6214: To be included in page header
6215:
6216: =cut
6217:
6218: sub head_subbox {
6219: my ($content)=@_;
6220: my $output =
1.993 raeburn 6221: '<div class="LC_head_subbox">'
1.822 bisitz 6222: .$content
6223: .'</div>'
6224: }
6225:
6226: ##############################################
6227: =pod
6228:
6229: =item * &CSTR_pageheader()
6230:
1.1026 raeburn 6231: Input: (optional) filename from which breadcrumb trail is built.
6232: In most cases no input as needed, as $env{'request.filename'}
6233: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6234: frameset flag
6235: If page header is being requested for use in a frameset, then
6236: the second (option) argument -- frameset will be true, and
6237: the target attribute set for links should be target="_parent".
1.822 bisitz 6238:
6239: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6240: To be included on Authoring Space pages
1.822 bisitz 6241:
6242: =cut
6243:
6244: sub CSTR_pageheader {
1.1379 raeburn 6245: my ($trailfile,$frameset) = @_;
1.1026 raeburn 6246: if ($trailfile eq '') {
6247: $trailfile = $env{'request.filename'};
6248: }
6249:
6250: # this is for resources; directories have customtitle, and crumbs
6251: # and select recent are created in lonpubdir.pm
6252:
6253: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6254: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6255: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6256: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6257: $formaction =~ s{/+}{/}g;
1.822 bisitz 6258:
6259: my $parentpath = '';
6260: my $lastitem = '';
6261: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6262: $parentpath = $1;
6263: $lastitem = $2;
6264: } else {
6265: $lastitem = $thisdisfn;
6266: }
1.921 bisitz 6267:
1.1246 raeburn 6268: my ($crsauthor,$title);
6269: if (($env{'request.course.id'}) &&
6270: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6271: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6272: $crsauthor = 1;
6273: $title = &mt('Course Authoring Space');
6274: } else {
6275: $title = &mt('Authoring Space');
6276: }
6277:
1.1379 raeburn 6278: my ($target,$crumbtarget) = (' target="_top"','_top');
6279: if ($frameset) {
6280: $target = ' target="_parent"';
6281: $crumbtarget = '_parent';
6282: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6283: $target = '';
6284: $crumbtarget = '';
1.1379 raeburn 6285: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6286: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6287: $crumbtarget = $env{'request.deeplink.target'};
6288: }
1.1313 raeburn 6289:
1.921 bisitz 6290: my $output =
1.822 bisitz 6291: '<div>'
6292: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6293: .'<b>'.$title.'</b> '
1.1314 raeburn 6294: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6295: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6296:
6297: if ($lastitem) {
6298: $output .=
6299: '<span class="LC_filename">'
6300: .$lastitem
6301: .'</span>';
6302: }
1.1245 raeburn 6303:
1.1246 raeburn 6304: if ($crsauthor) {
1.1379 raeburn 6305: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6306: } else {
6307: $output .=
6308: '<br />'
1.1314 raeburn 6309: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6310: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6311: .'</form>'
1.1379 raeburn 6312: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6313: }
6314: $output .= '</div>';
1.921 bisitz 6315:
6316: return $output;
1.822 bisitz 6317: }
6318:
1.60 matthew 6319: ###############################################
6320: ###############################################
6321:
6322: =pod
6323:
1.112 bowersj2 6324: =back
6325:
1.549 albertel 6326: =head1 HTML Helpers
1.112 bowersj2 6327:
6328: =over 4
6329:
6330: =item * &bodytag()
1.60 matthew 6331:
6332: Returns a uniform header for LON-CAPA web pages.
6333:
6334: Inputs:
6335:
1.112 bowersj2 6336: =over 4
6337:
6338: =item * $title, A title to be displayed on the page.
6339:
6340: =item * $function, the current role (can be undef).
6341:
6342: =item * $addentries, extra parameters for the <body> tag.
6343:
6344: =item * $bodyonly, if defined, only return the <body> tag.
6345:
6346: =item * $domain, if defined, force a given domain.
6347:
6348: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6349: text interface only)
1.60 matthew 6350:
1.814 bisitz 6351: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6352: navigational links
1.317 albertel 6353:
1.338 albertel 6354: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6355:
1.460 albertel 6356: =item * $args, optional argument valid values are
6357: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6358: use_absolute -> for external resource or syllabus, this will
6359: contain https://<hostname> if server uses
6360: https (as per hosts.tab), but request is for http
6361: hostname -> hostname, from $r->hostname().
1.460 albertel 6362:
1.1096 raeburn 6363: =item * $advtoolsref, optional argument, ref to an array containing
6364: inlineremote items to be added in "Functions" menu below
6365: breadcrumbs.
6366:
1.1316 raeburn 6367: =item * $ltiscope, optional argument, will be one of: resource, map or
6368: course, if LON-CAPA is in LTI Provider context. Value is
6369: the scope of use, i.e., launch was for access to a single, a map
6370: or the entire course.
6371:
6372: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6373: context, this will contain the URL for the landing item in
6374: the course, after launch from an LTI Consumer
6375:
1.1318 raeburn 6376: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6377: context, this will contain a reference to hash of items
6378: to be included in the page header and/or inline menu.
6379:
1.1385 ! raeburn 6380: =item * $menucoll, optional argument, if specific menu collection is in
! 6381: effect, either set as the default for the course, or set for
! 6382: the deeplink paramater for $env{'request.deeplink.login'}
! 6383: then $menucoll will be the number of that collection.
! 6384:
! 6385: =item * $menuref, optional argument, reference to a hash, containing the
! 6386: menu options included for the menu in effect, based on the
! 6387: configuration for the numbered menu collection in use.
! 6388:
! 6389: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
! 6390: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
! 6391: if so, $showncrumbsref is set there to 1, and will propagate back
! 6392: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
! 6393: being called a second time.
! 6394:
1.112 bowersj2 6395: =back
6396:
1.60 matthew 6397: Returns: A uniform header for LON-CAPA web pages.
6398: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6399: If $bodyonly is undef or zero, an html string containing a <body> tag and
6400: other decorations will be returned.
6401:
6402: =cut
6403:
1.54 www 6404: sub bodytag {
1.831 bisitz 6405: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6406: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 ! raeburn 6407: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6408:
1.954 raeburn 6409: my $public;
6410: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6411: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6412: $public = 1;
6413: }
1.460 albertel 6414: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6415: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6416: my $hostname = $args->{'hostname'};
1.339 albertel 6417:
1.183 matthew 6418: $function = &get_users_function() if (!$function);
1.339 albertel 6419: my $img = &designparm($function.'.img',$domain);
6420: my $font = &designparm($function.'.font',$domain);
6421: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6422:
1.803 bisitz 6423: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6424: 'bgcolor' => $pgbg,
1.339 albertel 6425: 'text' => $font,
6426: 'alink' => &designparm($function.'.alink',$domain),
6427: 'vlink' => &designparm($function.'.vlink',$domain),
6428: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6429: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6430:
1.63 www 6431: # role and realm
1.1178 raeburn 6432: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6433: if ($realm) {
6434: $realm = '/'.$realm;
6435: }
1.1357 raeburn 6436: if ($role eq 'ca') {
1.479 albertel 6437: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6438: $realm = &plainname($rname,$rdom);
1.378 raeburn 6439: }
1.55 www 6440: # realm
1.1357 raeburn 6441: my ($cid,$sec);
1.258 albertel 6442: if ($env{'request.course.id'}) {
1.1357 raeburn 6443: $cid = $env{'request.course.id'};
6444: if ($env{'request.course.sec'}) {
6445: $sec = $env{'request.course.sec'};
6446: }
6447: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6448: if (&Apache::lonnet::is_course($1,$2)) {
6449: $cid = $1.'_'.$2;
6450: $sec = $3;
6451: }
6452: }
6453: if ($cid) {
1.378 raeburn 6454: if ($env{'request.role'} !~ /^cr/) {
6455: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6456: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6457: if ($env{'request.role.desc'}) {
6458: $role = $env{'request.role.desc'};
6459: } else {
6460: $role = &mt('Helpdesk[_1]',' '.$2);
6461: }
1.1257 raeburn 6462: } else {
6463: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6464: }
1.1357 raeburn 6465: if ($sec) {
6466: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6467: }
1.1357 raeburn 6468: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6469: } else {
6470: $role = &Apache::lonnet::plaintext($role);
1.54 www 6471: }
1.433 albertel 6472:
1.359 albertel 6473: if (!$realm) { $realm=' '; }
1.330 albertel 6474:
1.438 albertel 6475: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6476:
1.101 www 6477: # construct main body tag
1.359 albertel 6478: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6479: &Apache::lontexconvert::init_math_support();
1.252 albertel 6480:
1.1131 raeburn 6481: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6482:
1.1130 raeburn 6483: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6484: return $bodytag;
1.1130 raeburn 6485: }
1.359 albertel 6486:
1.954 raeburn 6487: if ($public) {
1.433 albertel 6488: undef($role);
6489: }
1.1318 raeburn 6490:
1.1359 raeburn 6491: my $showcrstitle = 1;
1.1357 raeburn 6492: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6493: if (ref($ltimenu) eq 'HASH') {
6494: unless ($ltimenu->{'role'}) {
6495: undef($role);
6496: }
6497: unless ($ltimenu->{'coursetitle'}) {
6498: $realm=' ';
1.1359 raeburn 6499: $showcrstitle = 0;
6500: }
6501: }
6502: } elsif (($cid) && ($menucoll)) {
6503: if (ref($menuref) eq 'HASH') {
6504: unless ($menuref->{'role'}) {
6505: undef($role);
6506: }
6507: unless ($menuref->{'crs'}) {
6508: $realm=' ';
6509: $showcrstitle = 0;
1.1318 raeburn 6510: }
6511: }
6512: }
6513:
1.762 bisitz 6514: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6515: #
6516: # Extra info if you are the DC
6517: my $dc_info = '';
1.1359 raeburn 6518: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6519: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6520: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6521: $dc_info =~ s/\s+$//;
1.359 albertel 6522: }
6523:
1.1237 raeburn 6524: my $crstype;
1.1357 raeburn 6525: if ($cid) {
6526: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6527: } elsif ($args->{'crstype'}) {
6528: $crstype = $args->{'crstype'};
6529: }
6530: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6531: undef($role);
6532: } else {
1.1242 raeburn 6533: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6534: }
1.853 droeschl 6535:
1.903 droeschl 6536: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6537:
6538: # if ($env{'request.state'} eq 'construct') {
6539: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6540: # }
6541:
1.1130 raeburn 6542: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 6543: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6544:
1.1318 raeburn 6545: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 6546: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 6547: $args->{'links_disabled'},
6548: $args->{'links_target'});
1.359 albertel 6549:
1.1318 raeburn 6550: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
6551: if ($dc_info) {
6552: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
6553: }
6554: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
6555: <em>$realm</em> $dc_info</div>|;
6556: return $bodytag;
6557: }
1.894 droeschl 6558:
1.1318 raeburn 6559: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
6560: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
6561: }
1.916 droeschl 6562:
1.1318 raeburn 6563: $bodytag .= $right;
1.852 droeschl 6564:
1.1318 raeburn 6565: if ($dc_info) {
6566: $dc_info = &dc_courseid_toggle($dc_info);
6567: }
6568: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 6569: }
1.916 droeschl 6570:
1.1169 raeburn 6571: #if directed to not display the secondary menu, don't.
1.1168 raeburn 6572: if ($args->{'no_secondary_menu'}) {
6573: return $bodytag;
6574: }
1.1169 raeburn 6575: #don't show menus for public users
1.954 raeburn 6576: if (!$public){
1.1318 raeburn 6577: unless ($args->{'no_inline_menu'}) {
6578: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 6579: $args->{'no_primary_menu'},
1.1369 raeburn 6580: $menucoll,$menuref,
1.1380 raeburn 6581: $args->{'links_disabled'},
6582: $args->{'links_target'});
1.1318 raeburn 6583: }
1.903 droeschl 6584: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6585: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6586: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6587: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 ! raeburn 6588: $args->{'bread_crumbs'},'','',$hostname,
! 6589: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 6590: } elsif ($forcereg) {
6591: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 ! raeburn 6592: $args->{'group'},$args->{'hide_buttons'},
! 6593: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 6594: } else {
6595: $bodytag .=
6596: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6597: $forcereg,$args->{'group'},
6598: $args->{'bread_crumbs'},
1.1274 raeburn 6599: $advtoolsref,'',$hostname);
1.920 raeburn 6600: }
1.903 droeschl 6601: }else{
6602: # this is to seperate menu from content when there's no secondary
6603: # menu. Especially needed for public accessible ressources.
6604: $bodytag .= '<hr style="clear:both" />';
6605: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6606: }
1.903 droeschl 6607:
1.235 raeburn 6608: return $bodytag;
1.182 matthew 6609: }
6610:
1.917 raeburn 6611: sub dc_courseid_toggle {
6612: my ($dc_info) = @_;
1.980 raeburn 6613: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6614: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6615: &mt('(More ...)').'</a></span>'.
6616: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6617: }
6618:
1.330 albertel 6619: sub make_attr_string {
6620: my ($register,$attr_ref) = @_;
6621:
6622: if ($attr_ref && !ref($attr_ref)) {
6623: die("addentries Must be a hash ref ".
6624: join(':',caller(1))." ".
6625: join(':',caller(0))." ");
6626: }
6627:
6628: if ($register) {
1.339 albertel 6629: my ($on_load,$on_unload);
6630: foreach my $key (keys(%{$attr_ref})) {
6631: if (lc($key) eq 'onload') {
6632: $on_load.=$attr_ref->{$key}.';';
6633: delete($attr_ref->{$key});
6634:
6635: } elsif (lc($key) eq 'onunload') {
6636: $on_unload.=$attr_ref->{$key}.';';
6637: delete($attr_ref->{$key});
6638: }
6639: }
1.953 droeschl 6640: $attr_ref->{'onload'} = $on_load;
6641: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 6642: }
1.339 albertel 6643:
1.330 albertel 6644: my $attr_string;
1.1159 raeburn 6645: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6646: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6647: }
6648: return $attr_string;
6649: }
6650:
6651:
1.182 matthew 6652: ###############################################
1.251 albertel 6653: ###############################################
6654:
6655: =pod
6656:
6657: =item * &endbodytag()
6658:
6659: Returns a uniform footer for LON-CAPA web pages.
6660:
1.635 raeburn 6661: Inputs: 1 - optional reference to an args hash
6662: If in the hash, key for noredirectlink has a value which evaluates to true,
6663: a 'Continue' link is not displayed if the page contains an
6664: internal redirect in the <head></head> section,
6665: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6666:
6667: =cut
6668:
6669: sub endbodytag {
1.635 raeburn 6670: my ($args) = @_;
1.1080 raeburn 6671: my $endbodytag;
6672: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6673: $endbodytag='</body>';
6674: }
1.315 albertel 6675: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6676: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
6677: $endbodytag=
6678: "<br /><a href=\"$env{'internal.head.redirect'}\">".
6679: &mt('Continue').'</a>'.
6680: $endbodytag;
6681: }
1.315 albertel 6682: }
1.251 albertel 6683: return $endbodytag;
6684: }
6685:
1.352 albertel 6686: =pod
6687:
6688: =item * &standard_css()
6689:
6690: Returns a style sheet
6691:
6692: Inputs: (all optional)
6693: domain -> force to color decorate a page for a specific
6694: domain
6695: function -> force usage of a specific rolish color scheme
6696: bgcolor -> override the default page bgcolor
6697:
6698: =cut
6699:
1.343 albertel 6700: sub standard_css {
1.345 albertel 6701: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6702: $function = &get_users_function() if (!$function);
6703: my $img = &designparm($function.'.img', $domain);
6704: my $tabbg = &designparm($function.'.tabbg', $domain);
6705: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6706: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6707: #second colour for later usage
1.345 albertel 6708: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6709: my $pgbg_or_bgcolor =
6710: $bgcolor ||
1.352 albertel 6711: &designparm($function.'.pgbg', $domain);
1.382 albertel 6712: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6713: my $alink = &designparm($function.'.alink', $domain);
6714: my $vlink = &designparm($function.'.vlink', $domain);
6715: my $link = &designparm($function.'.link', $domain);
6716:
1.602 albertel 6717: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6718: my $mono = 'monospace';
1.850 bisitz 6719: my $data_table_head = $sidebg;
6720: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6721: my $data_table_dark = '#E0E0E0';
1.470 banghart 6722: my $data_table_darker = '#CCCCCC';
1.349 albertel 6723: my $data_table_highlight = '#FFFF00';
1.352 albertel 6724: my $mail_new = '#FFBB77';
6725: my $mail_new_hover = '#DD9955';
6726: my $mail_read = '#BBBB77';
6727: my $mail_read_hover = '#999944';
6728: my $mail_replied = '#AAAA88';
6729: my $mail_replied_hover = '#888855';
6730: my $mail_other = '#99BBBB';
6731: my $mail_other_hover = '#669999';
1.391 albertel 6732: my $table_header = '#DDDDDD';
1.489 raeburn 6733: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6734: my $lg_border_color = '#C8C8C8';
1.952 onken 6735: my $button_hover = '#BF2317';
1.392 albertel 6736:
1.608 albertel 6737: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6738: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6739: : '0 3px 0 4px';
1.448 albertel 6740:
1.523 albertel 6741:
1.343 albertel 6742: return <<END;
1.947 droeschl 6743:
6744: /* needed for iframe to allow 100% height in FF */
6745: body, html {
6746: margin: 0;
6747: padding: 0 0.5%;
6748: height: 99%; /* to avoid scrollbars */
6749: }
6750:
1.795 www 6751: body {
1.911 bisitz 6752: font-family: $sans;
6753: line-height:130%;
6754: font-size:0.83em;
6755: color:$font;
1.795 www 6756: }
6757:
1.959 onken 6758: a:focus,
6759: a:focus img {
1.795 www 6760: color: red;
6761: }
1.698 harmsja 6762:
1.911 bisitz 6763: form, .inline {
6764: display: inline;
1.795 www 6765: }
1.721 harmsja 6766:
1.795 www 6767: .LC_right {
1.911 bisitz 6768: text-align:right;
1.795 www 6769: }
6770:
6771: .LC_middle {
1.911 bisitz 6772: vertical-align:middle;
1.795 www 6773: }
1.721 harmsja 6774:
1.1130 raeburn 6775: .LC_floatleft {
6776: float: left;
6777: }
6778:
6779: .LC_floatright {
6780: float: right;
6781: }
6782:
1.911 bisitz 6783: .LC_400Box {
6784: width:400px;
6785: }
1.721 harmsja 6786:
1.947 droeschl 6787: .LC_iframecontainer {
6788: width: 98%;
6789: margin: 0;
6790: position: fixed;
6791: top: 8.5em;
6792: bottom: 0;
6793: }
6794:
6795: .LC_iframecontainer iframe{
6796: border: none;
6797: width: 100%;
6798: height: 100%;
6799: }
6800:
1.778 bisitz 6801: .LC_filename {
6802: font-family: $mono;
6803: white-space:pre;
1.921 bisitz 6804: font-size: 120%;
1.778 bisitz 6805: }
6806:
6807: .LC_fileicon {
6808: border: none;
6809: height: 1.3em;
6810: vertical-align: text-bottom;
6811: margin-right: 0.3em;
6812: text-decoration:none;
6813: }
6814:
1.1008 www 6815: .LC_setting {
6816: text-decoration:underline;
6817: }
6818:
1.350 albertel 6819: .LC_error {
6820: color: red;
6821: }
1.795 www 6822:
1.1097 bisitz 6823: .LC_warning {
6824: color: darkorange;
6825: }
6826:
1.457 albertel 6827: .LC_diff_removed {
1.733 bisitz 6828: color: red;
1.394 albertel 6829: }
1.532 albertel 6830:
6831: .LC_info,
1.457 albertel 6832: .LC_success,
6833: .LC_diff_added {
1.350 albertel 6834: color: green;
6835: }
1.795 www 6836:
1.802 bisitz 6837: div.LC_confirm_box {
6838: background-color: #FAFAFA;
6839: border: 1px solid $lg_border_color;
6840: margin-right: 0;
6841: padding: 5px;
6842: }
6843:
6844: div.LC_confirm_box .LC_error img,
6845: div.LC_confirm_box .LC_success img {
6846: vertical-align: middle;
6847: }
6848:
1.1242 raeburn 6849: .LC_maxwidth {
6850: max-width: 100%;
6851: height: auto;
6852: }
6853:
1.1243 raeburn 6854: .LC_textsize_mobile {
6855: \@media only screen and (max-device-width: 480px) {
6856: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6857: }
6858: }
6859:
1.440 albertel 6860: .LC_icon {
1.771 droeschl 6861: border: none;
1.790 droeschl 6862: vertical-align: middle;
1.771 droeschl 6863: }
6864:
1.543 albertel 6865: .LC_docs_spacer {
6866: width: 25px;
6867: height: 1px;
1.771 droeschl 6868: border: none;
1.543 albertel 6869: }
1.346 albertel 6870:
1.532 albertel 6871: .LC_internal_info {
1.735 bisitz 6872: color: #999999;
1.532 albertel 6873: }
6874:
1.794 www 6875: .LC_discussion {
1.1050 www 6876: background: $data_table_dark;
1.911 bisitz 6877: border: 1px solid black;
6878: margin: 2px;
1.794 www 6879: }
6880:
6881: .LC_disc_action_left {
1.1050 www 6882: background: $sidebg;
1.911 bisitz 6883: text-align: left;
1.1050 www 6884: padding: 4px;
6885: margin: 2px;
1.794 www 6886: }
6887:
6888: .LC_disc_action_right {
1.1050 www 6889: background: $sidebg;
1.911 bisitz 6890: text-align: right;
1.1050 www 6891: padding: 4px;
6892: margin: 2px;
1.794 www 6893: }
6894:
6895: .LC_disc_new_item {
1.911 bisitz 6896: background: white;
6897: border: 2px solid red;
1.1050 www 6898: margin: 4px;
6899: padding: 4px;
1.794 www 6900: }
6901:
6902: .LC_disc_old_item {
1.911 bisitz 6903: background: white;
1.1050 www 6904: margin: 4px;
6905: padding: 4px;
1.794 www 6906: }
6907:
1.458 albertel 6908: table.LC_pastsubmission {
6909: border: 1px solid black;
6910: margin: 2px;
6911: }
6912:
1.924 bisitz 6913: table#LC_menubuttons {
1.345 albertel 6914: width: 100%;
6915: background: $pgbg;
1.392 albertel 6916: border: 2px;
1.402 albertel 6917: border-collapse: separate;
1.803 bisitz 6918: padding: 0;
1.345 albertel 6919: }
1.392 albertel 6920:
1.801 tempelho 6921: table#LC_title_bar a {
6922: color: $fontmenu;
6923: }
1.836 bisitz 6924:
1.807 droeschl 6925: table#LC_title_bar {
1.819 tempelho 6926: clear: both;
1.836 bisitz 6927: display: none;
1.807 droeschl 6928: }
6929:
1.795 www 6930: table#LC_title_bar,
1.933 droeschl 6931: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6932: table#LC_title_bar.LC_with_remote {
1.359 albertel 6933: width: 100%;
1.392 albertel 6934: border-color: $pgbg;
6935: border-style: solid;
6936: border-width: $border;
1.379 albertel 6937: background: $pgbg;
1.801 tempelho 6938: color: $fontmenu;
1.392 albertel 6939: border-collapse: collapse;
1.803 bisitz 6940: padding: 0;
1.819 tempelho 6941: margin: 0;
1.359 albertel 6942: }
1.795 www 6943:
1.933 droeschl 6944: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6945: margin: 0;
6946: padding: 0;
1.933 droeschl 6947: position: relative;
6948: list-style: none;
1.913 droeschl 6949: }
1.933 droeschl 6950: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6951: display: inline;
6952: }
1.933 droeschl 6953:
6954: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6955: padding: 0;
1.933 droeschl 6956: margin: 0;
6957: float: left;
1.913 droeschl 6958: }
1.933 droeschl 6959: .LC_breadcrumb_tools_tools {
6960: padding: 0;
6961: margin: 0;
1.913 droeschl 6962: float: right;
6963: }
6964:
1.1240 raeburn 6965: .LC_placement_prog {
6966: padding-right: 20px;
6967: font-weight: bold;
6968: font-size: 90%;
6969: }
6970:
1.359 albertel 6971: table#LC_title_bar td {
6972: background: $tabbg;
6973: }
1.795 www 6974:
1.911 bisitz 6975: table#LC_menubuttons img {
1.803 bisitz 6976: border: none;
1.346 albertel 6977: }
1.795 www 6978:
1.842 droeschl 6979: .LC_breadcrumbs_component {
1.911 bisitz 6980: float: right;
6981: margin: 0 1em;
1.357 albertel 6982: }
1.842 droeschl 6983: .LC_breadcrumbs_component img {
1.911 bisitz 6984: vertical-align: middle;
1.777 tempelho 6985: }
1.795 www 6986:
1.1243 raeburn 6987: .LC_breadcrumbs_hoverable {
6988: background: $sidebg;
6989: }
6990:
1.383 albertel 6991: td.LC_table_cell_checkbox {
6992: text-align: center;
6993: }
1.795 www 6994:
6995: .LC_fontsize_small {
1.911 bisitz 6996: font-size: 70%;
1.705 tempelho 6997: }
6998:
1.844 bisitz 6999: #LC_breadcrumbs {
1.911 bisitz 7000: clear:both;
7001: background: $sidebg;
7002: border-bottom: 1px solid $lg_border_color;
7003: line-height: 2.5em;
1.933 droeschl 7004: overflow: hidden;
1.911 bisitz 7005: margin: 0;
7006: padding: 0;
1.995 raeburn 7007: text-align: left;
1.819 tempelho 7008: }
1.862 bisitz 7009:
1.1098 bisitz 7010: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7011: clear:both;
7012: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7013: border: 1px solid $sidebg;
1.1098 bisitz 7014: margin: 0 0 10px 0;
1.966 bisitz 7015: padding: 3px;
1.995 raeburn 7016: text-align: left;
1.822 bisitz 7017: }
7018:
1.795 www 7019: .LC_fontsize_medium {
1.911 bisitz 7020: font-size: 85%;
1.705 tempelho 7021: }
7022:
1.795 www 7023: .LC_fontsize_large {
1.911 bisitz 7024: font-size: 120%;
1.705 tempelho 7025: }
7026:
1.346 albertel 7027: .LC_menubuttons_inline_text {
7028: color: $font;
1.698 harmsja 7029: font-size: 90%;
1.701 harmsja 7030: padding-left:3px;
1.346 albertel 7031: }
7032:
1.934 droeschl 7033: .LC_menubuttons_inline_text img{
7034: vertical-align: middle;
7035: }
7036:
1.1051 www 7037: li.LC_menubuttons_inline_text img {
1.951 onken 7038: cursor:pointer;
1.1002 droeschl 7039: text-decoration: none;
1.951 onken 7040: }
7041:
1.526 www 7042: .LC_menubuttons_link {
7043: text-decoration: none;
7044: }
1.795 www 7045:
1.522 albertel 7046: .LC_menubuttons_category {
1.521 www 7047: color: $font;
1.526 www 7048: background: $pgbg;
1.521 www 7049: font-size: larger;
7050: font-weight: bold;
7051: }
7052:
1.346 albertel 7053: td.LC_menubuttons_text {
1.911 bisitz 7054: color: $font;
1.346 albertel 7055: }
1.706 harmsja 7056:
1.346 albertel 7057: .LC_current_location {
7058: background: $tabbg;
7059: }
1.795 www 7060:
1.1286 raeburn 7061: td.LC_zero_height {
7062: line-height: 0;
7063: cellpadding: 0;
7064: }
7065:
1.938 bisitz 7066: table.LC_data_table {
1.347 albertel 7067: border: 1px solid #000000;
1.402 albertel 7068: border-collapse: separate;
1.426 albertel 7069: border-spacing: 1px;
1.610 albertel 7070: background: $pgbg;
1.347 albertel 7071: }
1.795 www 7072:
1.422 albertel 7073: .LC_data_table_dense {
7074: font-size: small;
7075: }
1.795 www 7076:
1.507 raeburn 7077: table.LC_nested_outer {
7078: border: 1px solid #000000;
1.589 raeburn 7079: border-collapse: collapse;
1.803 bisitz 7080: border-spacing: 0;
1.507 raeburn 7081: width: 100%;
7082: }
1.795 www 7083:
1.879 raeburn 7084: table.LC_innerpickbox,
1.507 raeburn 7085: table.LC_nested {
1.803 bisitz 7086: border: none;
1.589 raeburn 7087: border-collapse: collapse;
1.803 bisitz 7088: border-spacing: 0;
1.507 raeburn 7089: width: 100%;
7090: }
1.795 www 7091:
1.911 bisitz 7092: table.LC_data_table tr th,
7093: table.LC_calendar tr th,
1.879 raeburn 7094: table.LC_prior_tries tr th,
7095: table.LC_innerpickbox tr th {
1.349 albertel 7096: font-weight: bold;
7097: background-color: $data_table_head;
1.801 tempelho 7098: color:$fontmenu;
1.701 harmsja 7099: font-size:90%;
1.347 albertel 7100: }
1.795 www 7101:
1.879 raeburn 7102: table.LC_innerpickbox tr th,
7103: table.LC_innerpickbox tr td {
7104: vertical-align: top;
7105: }
7106:
1.711 raeburn 7107: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7108: background-color: #CCCCCC;
1.711 raeburn 7109: font-weight: bold;
7110: text-align: left;
7111: }
1.795 www 7112:
1.912 bisitz 7113: table.LC_data_table tr.LC_odd_row > td {
7114: background-color: $data_table_light;
7115: padding: 2px;
7116: vertical-align: top;
7117: }
7118:
1.809 bisitz 7119: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7120: background-color: $data_table_light;
1.912 bisitz 7121: vertical-align: top;
7122: }
7123:
7124: table.LC_data_table tr.LC_even_row > td {
7125: background-color: $data_table_dark;
1.425 albertel 7126: padding: 2px;
1.900 bisitz 7127: vertical-align: top;
1.347 albertel 7128: }
1.795 www 7129:
1.809 bisitz 7130: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7131: background-color: $data_table_dark;
1.900 bisitz 7132: vertical-align: top;
1.347 albertel 7133: }
1.795 www 7134:
1.425 albertel 7135: table.LC_data_table tr.LC_data_table_highlight td {
7136: background-color: $data_table_darker;
7137: }
1.795 www 7138:
1.639 raeburn 7139: table.LC_data_table tr td.LC_leftcol_header {
7140: background-color: $data_table_head;
7141: font-weight: bold;
7142: }
1.795 www 7143:
1.451 albertel 7144: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7145: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7146: font-weight: bold;
7147: font-style: italic;
7148: text-align: center;
7149: padding: 8px;
1.347 albertel 7150: }
1.795 www 7151:
1.1114 raeburn 7152: table.LC_data_table tr.LC_empty_row td,
7153: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7154: background-color: $sidebg;
7155: }
7156:
7157: table.LC_nested tr.LC_empty_row td {
7158: background-color: #FFFFFF;
7159: }
7160:
1.890 droeschl 7161: table.LC_caption {
7162: }
7163:
1.507 raeburn 7164: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7165: padding: 4ex
7166: }
1.795 www 7167:
1.507 raeburn 7168: table.LC_nested_outer tr th {
7169: font-weight: bold;
1.801 tempelho 7170: color:$fontmenu;
1.507 raeburn 7171: background-color: $data_table_head;
1.701 harmsja 7172: font-size: small;
1.507 raeburn 7173: border-bottom: 1px solid #000000;
7174: }
1.795 www 7175:
1.507 raeburn 7176: table.LC_nested_outer tr td.LC_subheader {
7177: background-color: $data_table_head;
7178: font-weight: bold;
7179: font-size: small;
7180: border-bottom: 1px solid #000000;
7181: text-align: right;
1.451 albertel 7182: }
1.795 www 7183:
1.507 raeburn 7184: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7185: background-color: #CCCCCC;
1.451 albertel 7186: font-weight: bold;
7187: font-size: small;
1.507 raeburn 7188: text-align: center;
7189: }
1.795 www 7190:
1.589 raeburn 7191: table.LC_nested tr.LC_info_row td.LC_left_item,
7192: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7193: text-align: left;
1.451 albertel 7194: }
1.795 www 7195:
1.507 raeburn 7196: table.LC_nested td {
1.735 bisitz 7197: background-color: #FFFFFF;
1.451 albertel 7198: font-size: small;
1.507 raeburn 7199: }
1.795 www 7200:
1.507 raeburn 7201: table.LC_nested_outer tr th.LC_right_item,
7202: table.LC_nested tr.LC_info_row td.LC_right_item,
7203: table.LC_nested tr.LC_odd_row td.LC_right_item,
7204: table.LC_nested tr td.LC_right_item {
1.451 albertel 7205: text-align: right;
7206: }
7207:
1.507 raeburn 7208: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7209: background-color: #EEEEEE;
1.451 albertel 7210: }
7211:
1.473 raeburn 7212: table.LC_createuser {
7213: }
7214:
7215: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7216: font-size: small;
1.473 raeburn 7217: }
7218:
7219: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7220: background-color: #CCCCCC;
1.473 raeburn 7221: font-weight: bold;
7222: text-align: center;
7223: }
7224:
1.349 albertel 7225: table.LC_calendar {
7226: border: 1px solid #000000;
7227: border-collapse: collapse;
1.917 raeburn 7228: width: 98%;
1.349 albertel 7229: }
1.795 www 7230:
1.349 albertel 7231: table.LC_calendar_pickdate {
7232: font-size: xx-small;
7233: }
1.795 www 7234:
1.349 albertel 7235: table.LC_calendar tr td {
7236: border: 1px solid #000000;
7237: vertical-align: top;
1.917 raeburn 7238: width: 14%;
1.349 albertel 7239: }
1.795 www 7240:
1.349 albertel 7241: table.LC_calendar tr td.LC_calendar_day_empty {
7242: background-color: $data_table_dark;
7243: }
1.795 www 7244:
1.779 bisitz 7245: table.LC_calendar tr td.LC_calendar_day_current {
7246: background-color: $data_table_highlight;
1.777 tempelho 7247: }
1.795 www 7248:
1.938 bisitz 7249: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7250: background-color: $mail_new;
7251: }
1.795 www 7252:
1.938 bisitz 7253: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7254: background-color: $mail_new_hover;
7255: }
1.795 www 7256:
1.938 bisitz 7257: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7258: background-color: $mail_read;
7259: }
1.795 www 7260:
1.938 bisitz 7261: /*
7262: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7263: background-color: $mail_read_hover;
7264: }
1.938 bisitz 7265: */
1.795 www 7266:
1.938 bisitz 7267: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7268: background-color: $mail_replied;
7269: }
1.795 www 7270:
1.938 bisitz 7271: /*
7272: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7273: background-color: $mail_replied_hover;
7274: }
1.938 bisitz 7275: */
1.795 www 7276:
1.938 bisitz 7277: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7278: background-color: $mail_other;
7279: }
1.795 www 7280:
1.938 bisitz 7281: /*
7282: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7283: background-color: $mail_other_hover;
7284: }
1.938 bisitz 7285: */
1.494 raeburn 7286:
1.777 tempelho 7287: table.LC_data_table tr > td.LC_browser_file,
7288: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7289: background: #AAEE77;
1.389 albertel 7290: }
1.795 www 7291:
1.777 tempelho 7292: table.LC_data_table tr > td.LC_browser_file_locked,
7293: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7294: background: #FFAA99;
1.387 albertel 7295: }
1.795 www 7296:
1.777 tempelho 7297: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7298: background: #888888;
1.779 bisitz 7299: }
1.795 www 7300:
1.777 tempelho 7301: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7302: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7303: background: #F8F866;
1.777 tempelho 7304: }
1.795 www 7305:
1.696 bisitz 7306: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7307: background: #E0E8FF;
1.387 albertel 7308: }
1.696 bisitz 7309:
1.707 bisitz 7310: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7311: /* background: #77FF77; */
1.707 bisitz 7312: }
1.795 www 7313:
1.707 bisitz 7314: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7315: border-right: 8px solid #FFFF77;
1.707 bisitz 7316: }
1.795 www 7317:
1.707 bisitz 7318: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7319: border-right: 8px solid #FFAA77;
1.707 bisitz 7320: }
1.795 www 7321:
1.707 bisitz 7322: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7323: border-right: 8px solid #FF7777;
1.707 bisitz 7324: }
1.795 www 7325:
1.707 bisitz 7326: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7327: border-right: 8px solid #AAFF77;
1.707 bisitz 7328: }
1.795 www 7329:
1.707 bisitz 7330: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7331: border-right: 8px solid #11CC55;
1.707 bisitz 7332: }
7333:
1.388 albertel 7334: span.LC_current_location {
1.701 harmsja 7335: font-size:larger;
1.388 albertel 7336: background: $pgbg;
7337: }
1.387 albertel 7338:
1.1029 www 7339: span.LC_current_nav_location {
7340: font-weight:bold;
7341: background: $sidebg;
7342: }
7343:
1.395 albertel 7344: span.LC_parm_menu_item {
7345: font-size: larger;
7346: }
1.795 www 7347:
1.395 albertel 7348: span.LC_parm_scope_all {
7349: color: red;
7350: }
1.795 www 7351:
1.395 albertel 7352: span.LC_parm_scope_folder {
7353: color: green;
7354: }
1.795 www 7355:
1.395 albertel 7356: span.LC_parm_scope_resource {
7357: color: orange;
7358: }
1.795 www 7359:
1.395 albertel 7360: span.LC_parm_part {
7361: color: blue;
7362: }
1.795 www 7363:
1.911 bisitz 7364: span.LC_parm_folder,
7365: span.LC_parm_symb {
1.395 albertel 7366: font-size: x-small;
7367: font-family: $mono;
7368: color: #AAAAAA;
7369: }
7370:
1.977 bisitz 7371: ul.LC_parm_parmlist li {
7372: display: inline-block;
7373: padding: 0.3em 0.8em;
7374: vertical-align: top;
7375: width: 150px;
7376: border-top:1px solid $lg_border_color;
7377: }
7378:
1.795 www 7379: td.LC_parm_overview_level_menu,
7380: td.LC_parm_overview_map_menu,
7381: td.LC_parm_overview_parm_selectors,
7382: td.LC_parm_overview_restrictions {
1.396 albertel 7383: border: 1px solid black;
7384: border-collapse: collapse;
7385: }
1.795 www 7386:
1.1285 raeburn 7387: span.LC_parm_recursive,
7388: td.LC_parm_recursive {
7389: font-weight: bold;
7390: font-size: smaller;
7391: }
7392:
1.396 albertel 7393: table.LC_parm_overview_restrictions td {
7394: border-width: 1px 4px 1px 4px;
7395: border-style: solid;
7396: border-color: $pgbg;
7397: text-align: center;
7398: }
1.795 www 7399:
1.396 albertel 7400: table.LC_parm_overview_restrictions th {
7401: background: $tabbg;
7402: border-width: 1px 4px 1px 4px;
7403: border-style: solid;
7404: border-color: $pgbg;
7405: }
1.795 www 7406:
1.398 albertel 7407: table#LC_helpmenu {
1.803 bisitz 7408: border: none;
1.398 albertel 7409: height: 55px;
1.803 bisitz 7410: border-spacing: 0;
1.398 albertel 7411: }
7412:
7413: table#LC_helpmenu fieldset legend {
7414: font-size: larger;
7415: }
1.795 www 7416:
1.397 albertel 7417: table#LC_helpmenu_links {
7418: width: 100%;
7419: border: 1px solid black;
7420: background: $pgbg;
1.803 bisitz 7421: padding: 0;
1.397 albertel 7422: border-spacing: 1px;
7423: }
1.795 www 7424:
1.397 albertel 7425: table#LC_helpmenu_links tr td {
7426: padding: 1px;
7427: background: $tabbg;
1.399 albertel 7428: text-align: center;
7429: font-weight: bold;
1.397 albertel 7430: }
1.396 albertel 7431:
1.795 www 7432: table#LC_helpmenu_links a:link,
7433: table#LC_helpmenu_links a:visited,
1.397 albertel 7434: table#LC_helpmenu_links a:active {
7435: text-decoration: none;
7436: color: $font;
7437: }
1.795 www 7438:
1.397 albertel 7439: table#LC_helpmenu_links a:hover {
7440: text-decoration: underline;
7441: color: $vlink;
7442: }
1.396 albertel 7443:
1.417 albertel 7444: .LC_chrt_popup_exists {
7445: border: 1px solid #339933;
7446: margin: -1px;
7447: }
1.795 www 7448:
1.417 albertel 7449: .LC_chrt_popup_up {
7450: border: 1px solid yellow;
7451: margin: -1px;
7452: }
1.795 www 7453:
1.417 albertel 7454: .LC_chrt_popup {
7455: border: 1px solid #8888FF;
7456: background: #CCCCFF;
7457: }
1.795 www 7458:
1.421 albertel 7459: table.LC_pick_box {
7460: border-collapse: separate;
7461: background: white;
7462: border: 1px solid black;
7463: border-spacing: 1px;
7464: }
1.795 www 7465:
1.421 albertel 7466: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7467: background: $sidebg;
1.421 albertel 7468: font-weight: bold;
1.900 bisitz 7469: text-align: left;
1.740 bisitz 7470: vertical-align: top;
1.421 albertel 7471: width: 184px;
7472: padding: 8px;
7473: }
1.795 www 7474:
1.579 raeburn 7475: table.LC_pick_box td.LC_pick_box_value {
7476: text-align: left;
7477: padding: 8px;
7478: }
1.795 www 7479:
1.579 raeburn 7480: table.LC_pick_box td.LC_pick_box_select {
7481: text-align: left;
7482: padding: 8px;
7483: }
1.795 www 7484:
1.424 albertel 7485: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 7486: padding: 0;
1.421 albertel 7487: height: 1px;
7488: background: black;
7489: }
1.795 www 7490:
1.421 albertel 7491: table.LC_pick_box td.LC_pick_box_submit {
7492: text-align: right;
7493: }
1.795 www 7494:
1.579 raeburn 7495: table.LC_pick_box td.LC_evenrow_value {
7496: text-align: left;
7497: padding: 8px;
7498: background-color: $data_table_light;
7499: }
1.795 www 7500:
1.579 raeburn 7501: table.LC_pick_box td.LC_oddrow_value {
7502: text-align: left;
7503: padding: 8px;
7504: background-color: $data_table_light;
7505: }
1.795 www 7506:
1.579 raeburn 7507: span.LC_helpform_receipt_cat {
7508: font-weight: bold;
7509: }
1.795 www 7510:
1.424 albertel 7511: table.LC_group_priv_box {
7512: background: white;
7513: border: 1px solid black;
7514: border-spacing: 1px;
7515: }
1.795 www 7516:
1.424 albertel 7517: table.LC_group_priv_box td.LC_pick_box_title {
7518: background: $tabbg;
7519: font-weight: bold;
7520: text-align: right;
7521: width: 184px;
7522: }
1.795 www 7523:
1.424 albertel 7524: table.LC_group_priv_box td.LC_groups_fixed {
7525: background: $data_table_light;
7526: text-align: center;
7527: }
1.795 www 7528:
1.424 albertel 7529: table.LC_group_priv_box td.LC_groups_optional {
7530: background: $data_table_dark;
7531: text-align: center;
7532: }
1.795 www 7533:
1.424 albertel 7534: table.LC_group_priv_box td.LC_groups_functionality {
7535: background: $data_table_darker;
7536: text-align: center;
7537: font-weight: bold;
7538: }
1.795 www 7539:
1.424 albertel 7540: table.LC_group_priv td {
7541: text-align: left;
1.803 bisitz 7542: padding: 0;
1.424 albertel 7543: }
7544:
7545: .LC_navbuttons {
7546: margin: 2ex 0ex 2ex 0ex;
7547: }
1.795 www 7548:
1.423 albertel 7549: .LC_topic_bar {
7550: font-weight: bold;
7551: background: $tabbg;
1.918 wenzelju 7552: margin: 1em 0em 1em 2em;
1.805 bisitz 7553: padding: 3px;
1.918 wenzelju 7554: font-size: 1.2em;
1.423 albertel 7555: }
1.795 www 7556:
1.423 albertel 7557: .LC_topic_bar span {
1.918 wenzelju 7558: left: 0.5em;
7559: position: absolute;
1.423 albertel 7560: vertical-align: middle;
1.918 wenzelju 7561: font-size: 1.2em;
1.423 albertel 7562: }
1.795 www 7563:
1.423 albertel 7564: table.LC_course_group_status {
7565: margin: 20px;
7566: }
1.795 www 7567:
1.423 albertel 7568: table.LC_status_selector td {
7569: vertical-align: top;
7570: text-align: center;
1.424 albertel 7571: padding: 4px;
7572: }
1.795 www 7573:
1.599 albertel 7574: div.LC_feedback_link {
1.616 albertel 7575: clear: both;
1.829 kalberla 7576: background: $sidebg;
1.779 bisitz 7577: width: 100%;
1.829 kalberla 7578: padding-bottom: 10px;
7579: border: 1px $tabbg solid;
1.833 kalberla 7580: height: 22px;
7581: line-height: 22px;
7582: padding-top: 5px;
7583: }
7584:
7585: div.LC_feedback_link img {
7586: height: 22px;
1.867 kalberla 7587: vertical-align:middle;
1.829 kalberla 7588: }
7589:
1.911 bisitz 7590: div.LC_feedback_link a {
1.829 kalberla 7591: text-decoration: none;
1.489 raeburn 7592: }
1.795 www 7593:
1.867 kalberla 7594: div.LC_comblock {
1.911 bisitz 7595: display:inline;
1.867 kalberla 7596: color:$font;
7597: font-size:90%;
7598: }
7599:
7600: div.LC_feedback_link div.LC_comblock {
7601: padding-left:5px;
7602: }
7603:
7604: div.LC_feedback_link div.LC_comblock a {
7605: color:$font;
7606: }
7607:
1.489 raeburn 7608: span.LC_feedback_link {
1.858 bisitz 7609: /* background: $feedback_link_bg; */
1.599 albertel 7610: font-size: larger;
7611: }
1.795 www 7612:
1.599 albertel 7613: span.LC_message_link {
1.858 bisitz 7614: /* background: $feedback_link_bg; */
1.599 albertel 7615: font-size: larger;
7616: position: absolute;
7617: right: 1em;
1.489 raeburn 7618: }
1.421 albertel 7619:
1.515 albertel 7620: table.LC_prior_tries {
1.524 albertel 7621: border: 1px solid #000000;
7622: border-collapse: separate;
7623: border-spacing: 1px;
1.515 albertel 7624: }
1.523 albertel 7625:
1.515 albertel 7626: table.LC_prior_tries td {
1.524 albertel 7627: padding: 2px;
1.515 albertel 7628: }
1.523 albertel 7629:
7630: .LC_answer_correct {
1.795 www 7631: background: lightgreen;
7632: color: darkgreen;
7633: padding: 6px;
1.523 albertel 7634: }
1.795 www 7635:
1.523 albertel 7636: .LC_answer_charged_try {
1.797 www 7637: background: #FFAAAA;
1.795 www 7638: color: darkred;
7639: padding: 6px;
1.523 albertel 7640: }
1.795 www 7641:
1.779 bisitz 7642: .LC_answer_not_charged_try,
1.523 albertel 7643: .LC_answer_no_grade,
7644: .LC_answer_late {
1.795 www 7645: background: lightyellow;
1.523 albertel 7646: color: black;
1.795 www 7647: padding: 6px;
1.523 albertel 7648: }
1.795 www 7649:
1.523 albertel 7650: .LC_answer_previous {
1.795 www 7651: background: lightblue;
7652: color: darkblue;
7653: padding: 6px;
1.523 albertel 7654: }
1.795 www 7655:
1.779 bisitz 7656: .LC_answer_no_message {
1.777 tempelho 7657: background: #FFFFFF;
7658: color: black;
1.795 www 7659: padding: 6px;
1.779 bisitz 7660: }
1.795 www 7661:
1.1334 raeburn 7662: .LC_answer_unknown,
7663: .LC_answer_warning {
1.779 bisitz 7664: background: orange;
7665: color: black;
1.795 www 7666: padding: 6px;
1.777 tempelho 7667: }
1.795 www 7668:
1.529 albertel 7669: span.LC_prior_numerical,
7670: span.LC_prior_string,
7671: span.LC_prior_custom,
7672: span.LC_prior_reaction,
7673: span.LC_prior_math {
1.925 bisitz 7674: font-family: $mono;
1.523 albertel 7675: white-space: pre;
7676: }
7677:
1.525 albertel 7678: span.LC_prior_string {
1.925 bisitz 7679: font-family: $mono;
1.525 albertel 7680: white-space: pre;
7681: }
7682:
1.523 albertel 7683: table.LC_prior_option {
7684: width: 100%;
7685: border-collapse: collapse;
7686: }
1.795 www 7687:
1.911 bisitz 7688: table.LC_prior_rank,
1.795 www 7689: table.LC_prior_match {
1.528 albertel 7690: border-collapse: collapse;
7691: }
1.795 www 7692:
1.528 albertel 7693: table.LC_prior_option tr td,
7694: table.LC_prior_rank tr td,
7695: table.LC_prior_match tr td {
1.524 albertel 7696: border: 1px solid #000000;
1.515 albertel 7697: }
7698:
1.855 bisitz 7699: .LC_nobreak {
1.544 albertel 7700: white-space: nowrap;
1.519 raeburn 7701: }
7702:
1.576 raeburn 7703: span.LC_cusr_emph {
7704: font-style: italic;
7705: }
7706:
1.633 raeburn 7707: span.LC_cusr_subheading {
7708: font-weight: normal;
7709: font-size: 85%;
7710: }
7711:
1.861 bisitz 7712: div.LC_docs_entry_move {
1.859 bisitz 7713: border: 1px solid #BBBBBB;
1.545 albertel 7714: background: #DDDDDD;
1.861 bisitz 7715: width: 22px;
1.859 bisitz 7716: padding: 1px;
7717: margin: 0;
1.545 albertel 7718: }
7719:
1.861 bisitz 7720: table.LC_data_table tr > td.LC_docs_entry_commands,
7721: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7722: font-size: x-small;
7723: }
1.795 www 7724:
1.861 bisitz 7725: .LC_docs_entry_parameter {
7726: white-space: nowrap;
7727: }
7728:
1.544 albertel 7729: .LC_docs_copy {
1.545 albertel 7730: color: #000099;
1.544 albertel 7731: }
1.795 www 7732:
1.544 albertel 7733: .LC_docs_cut {
1.545 albertel 7734: color: #550044;
1.544 albertel 7735: }
1.795 www 7736:
1.544 albertel 7737: .LC_docs_rename {
1.545 albertel 7738: color: #009900;
1.544 albertel 7739: }
1.795 www 7740:
1.544 albertel 7741: .LC_docs_remove {
1.545 albertel 7742: color: #990000;
7743: }
7744:
1.1284 raeburn 7745: .LC_docs_alias {
7746: color: #440055;
7747: }
7748:
1.1286 raeburn 7749: .LC_domprefs_email,
1.1284 raeburn 7750: .LC_docs_alias_name,
1.547 albertel 7751: .LC_docs_reinit_warn,
7752: .LC_docs_ext_edit {
7753: font-size: x-small;
7754: }
7755:
1.545 albertel 7756: table.LC_docs_adddocs td,
7757: table.LC_docs_adddocs th {
7758: border: 1px solid #BBBBBB;
7759: padding: 4px;
7760: background: #DDDDDD;
1.543 albertel 7761: }
7762:
1.584 albertel 7763: table.LC_sty_begin {
7764: background: #BBFFBB;
7765: }
1.795 www 7766:
1.584 albertel 7767: table.LC_sty_end {
7768: background: #FFBBBB;
7769: }
7770:
1.589 raeburn 7771: table.LC_double_column {
1.803 bisitz 7772: border-width: 0;
1.589 raeburn 7773: border-collapse: collapse;
7774: width: 100%;
7775: padding: 2px;
7776: }
7777:
7778: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7779: top: 2px;
1.589 raeburn 7780: left: 2px;
7781: width: 47%;
7782: vertical-align: top;
7783: }
7784:
7785: table.LC_double_column tr td.LC_right_col {
7786: top: 2px;
1.779 bisitz 7787: right: 2px;
1.589 raeburn 7788: width: 47%;
7789: vertical-align: top;
7790: }
7791:
1.591 raeburn 7792: div.LC_left_float {
7793: float: left;
7794: padding-right: 5%;
1.597 albertel 7795: padding-bottom: 4px;
1.591 raeburn 7796: }
7797:
7798: div.LC_clear_float_header {
1.597 albertel 7799: padding-bottom: 2px;
1.591 raeburn 7800: }
7801:
7802: div.LC_clear_float_footer {
1.597 albertel 7803: padding-top: 10px;
1.591 raeburn 7804: clear: both;
7805: }
7806:
1.597 albertel 7807: div.LC_grade_show_user {
1.941 bisitz 7808: /* border-left: 5px solid $sidebg; */
7809: border-top: 5px solid #000000;
7810: margin: 50px 0 0 0;
1.936 bisitz 7811: padding: 15px 0 5px 10px;
1.597 albertel 7812: }
1.795 www 7813:
1.936 bisitz 7814: div.LC_grade_show_user_odd_row {
1.941 bisitz 7815: /* border-left: 5px solid #000000; */
7816: }
7817:
7818: div.LC_grade_show_user div.LC_Box {
7819: margin-right: 50px;
1.597 albertel 7820: }
7821:
7822: div.LC_grade_submissions,
7823: div.LC_grade_message_center,
1.936 bisitz 7824: div.LC_grade_info_links {
1.597 albertel 7825: margin: 5px;
7826: width: 99%;
7827: background: #FFFFFF;
7828: }
1.795 www 7829:
1.597 albertel 7830: div.LC_grade_submissions_header,
1.936 bisitz 7831: div.LC_grade_message_center_header {
1.705 tempelho 7832: font-weight: bold;
7833: font-size: large;
1.597 albertel 7834: }
1.795 www 7835:
1.597 albertel 7836: div.LC_grade_submissions_body,
1.936 bisitz 7837: div.LC_grade_message_center_body {
1.597 albertel 7838: border: 1px solid black;
7839: width: 99%;
7840: background: #FFFFFF;
7841: }
1.795 www 7842:
1.613 albertel 7843: table.LC_scantron_action {
7844: width: 100%;
7845: }
1.795 www 7846:
1.613 albertel 7847: table.LC_scantron_action tr th {
1.698 harmsja 7848: font-weight:bold;
7849: font-style:normal;
1.613 albertel 7850: }
1.795 www 7851:
1.779 bisitz 7852: .LC_edit_problem_header,
1.614 albertel 7853: div.LC_edit_problem_footer {
1.705 tempelho 7854: font-weight: normal;
7855: font-size: medium;
1.602 albertel 7856: margin: 2px;
1.1060 bisitz 7857: background-color: $sidebg;
1.600 albertel 7858: }
1.795 www 7859:
1.600 albertel 7860: div.LC_edit_problem_header,
1.602 albertel 7861: div.LC_edit_problem_header div,
1.614 albertel 7862: div.LC_edit_problem_footer,
7863: div.LC_edit_problem_footer div,
1.602 albertel 7864: div.LC_edit_problem_editxml_header,
7865: div.LC_edit_problem_editxml_header div {
1.1205 golterma 7866: z-index: 100;
1.600 albertel 7867: }
1.795 www 7868:
1.600 albertel 7869: div.LC_edit_problem_header_title {
1.705 tempelho 7870: font-weight: bold;
7871: font-size: larger;
1.602 albertel 7872: background: $tabbg;
7873: padding: 3px;
1.1060 bisitz 7874: margin: 0 0 5px 0;
1.602 albertel 7875: }
1.795 www 7876:
1.602 albertel 7877: table.LC_edit_problem_header_title {
7878: width: 100%;
1.600 albertel 7879: background: $tabbg;
1.602 albertel 7880: }
7881:
1.1205 golterma 7882: div.LC_edit_actionbar {
7883: background-color: $sidebg;
1.1218 droeschl 7884: margin: 0;
7885: padding: 0;
7886: line-height: 200%;
1.602 albertel 7887: }
1.795 www 7888:
1.1218 droeschl 7889: div.LC_edit_actionbar div{
7890: padding: 0;
7891: margin: 0;
7892: display: inline-block;
1.600 albertel 7893: }
1.795 www 7894:
1.1124 bisitz 7895: .LC_edit_opt {
7896: padding-left: 1em;
7897: white-space: nowrap;
7898: }
7899:
1.1152 golterma 7900: .LC_edit_problem_latexhelper{
7901: text-align: right;
7902: }
7903:
7904: #LC_edit_problem_colorful div{
7905: margin-left: 40px;
7906: }
7907:
1.1205 golterma 7908: #LC_edit_problem_codemirror div{
7909: margin-left: 0px;
7910: }
7911:
1.911 bisitz 7912: img.stift {
1.803 bisitz 7913: border-width: 0;
7914: vertical-align: middle;
1.677 riegler 7915: }
1.680 riegler 7916:
1.923 bisitz 7917: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7918: vertical-align: top;
1.777 tempelho 7919: }
1.795 www 7920:
1.716 raeburn 7921: div.LC_createcourse {
1.911 bisitz 7922: margin: 10px 10px 10px 10px;
1.716 raeburn 7923: }
7924:
1.917 raeburn 7925: .LC_dccid {
1.1130 raeburn 7926: float: right;
1.917 raeburn 7927: margin: 0.2em 0 0 0;
7928: padding: 0;
7929: font-size: 90%;
7930: display:none;
7931: }
7932:
1.897 wenzelju 7933: ol.LC_primary_menu a:hover,
1.721 harmsja 7934: ol#LC_MenuBreadcrumbs a:hover,
7935: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7936: ul#LC_secondary_menu a:hover,
1.721 harmsja 7937: .LC_FormSectionClearButton input:hover
1.795 www 7938: ul.LC_TabContent li:hover a {
1.952 onken 7939: color:$button_hover;
1.911 bisitz 7940: text-decoration:none;
1.693 droeschl 7941: }
7942:
1.779 bisitz 7943: h1 {
1.911 bisitz 7944: padding: 0;
7945: line-height:130%;
1.693 droeschl 7946: }
1.698 harmsja 7947:
1.911 bisitz 7948: h2,
7949: h3,
7950: h4,
7951: h5,
7952: h6 {
7953: margin: 5px 0 5px 0;
7954: padding: 0;
7955: line-height:130%;
1.693 droeschl 7956: }
1.795 www 7957:
7958: .LC_hcell {
1.911 bisitz 7959: padding:3px 15px 3px 15px;
7960: margin: 0;
7961: background-color:$tabbg;
7962: color:$fontmenu;
7963: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7964: }
1.795 www 7965:
1.840 bisitz 7966: .LC_Box > .LC_hcell {
1.911 bisitz 7967: margin: 0 -10px 10px -10px;
1.835 bisitz 7968: }
7969:
1.721 harmsja 7970: .LC_noBorder {
1.911 bisitz 7971: border: 0;
1.698 harmsja 7972: }
1.693 droeschl 7973:
1.721 harmsja 7974: .LC_FormSectionClearButton input {
1.911 bisitz 7975: background-color:transparent;
7976: border: none;
7977: cursor:pointer;
7978: text-decoration:underline;
1.693 droeschl 7979: }
1.763 bisitz 7980:
7981: .LC_help_open_topic {
1.911 bisitz 7982: color: #FFFFFF;
7983: background-color: #EEEEFF;
7984: margin: 1px;
7985: padding: 4px;
7986: border: 1px solid #000033;
7987: white-space: nowrap;
7988: /* vertical-align: middle; */
1.759 neumanie 7989: }
1.693 droeschl 7990:
1.911 bisitz 7991: dl,
7992: ul,
7993: div,
7994: fieldset {
7995: margin: 10px 10px 10px 0;
7996: /* overflow: hidden; */
1.693 droeschl 7997: }
1.795 www 7998:
1.1211 raeburn 7999: article.geogebraweb div {
8000: margin: 0;
8001: }
8002:
1.838 bisitz 8003: fieldset > legend {
1.911 bisitz 8004: font-weight: bold;
8005: padding: 0 5px 0 5px;
1.838 bisitz 8006: }
8007:
1.813 bisitz 8008: #LC_nav_bar {
1.911 bisitz 8009: float: left;
1.995 raeburn 8010: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8011: margin: 0 0 2px 0;
1.807 droeschl 8012: }
8013:
1.916 droeschl 8014: #LC_realm {
8015: margin: 0.2em 0 0 0;
8016: padding: 0;
8017: font-weight: bold;
8018: text-align: center;
1.995 raeburn 8019: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8020: }
8021:
1.911 bisitz 8022: #LC_nav_bar em {
8023: font-weight: bold;
8024: font-style: normal;
1.807 droeschl 8025: }
8026:
1.897 wenzelju 8027: ol.LC_primary_menu {
1.934 droeschl 8028: margin: 0;
1.1076 raeburn 8029: padding: 0;
1.807 droeschl 8030: }
8031:
1.852 droeschl 8032: ol#LC_PathBreadcrumbs {
1.911 bisitz 8033: margin: 0;
1.693 droeschl 8034: }
8035:
1.897 wenzelju 8036: ol.LC_primary_menu li {
1.1076 raeburn 8037: color: RGB(80, 80, 80);
8038: vertical-align: middle;
8039: text-align: left;
8040: list-style: none;
1.1205 golterma 8041: position: relative;
1.1076 raeburn 8042: float: left;
1.1205 golterma 8043: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8044: line-height: 1.5em;
1.1076 raeburn 8045: }
8046:
1.1205 golterma 8047: ol.LC_primary_menu li a,
8048: ol.LC_primary_menu li p {
1.1076 raeburn 8049: display: block;
8050: margin: 0;
8051: padding: 0 5px 0 10px;
8052: text-decoration: none;
8053: }
8054:
1.1205 golterma 8055: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8056: display: inline-block;
8057: width: 95%;
8058: text-align: left;
8059: }
8060:
8061: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8062: display: inline-block;
8063: width: 5%;
8064: float: right;
8065: text-align: right;
8066: font-size: 70%;
8067: }
8068:
8069: ol.LC_primary_menu ul {
1.1076 raeburn 8070: display: none;
1.1205 golterma 8071: width: 15em;
1.1076 raeburn 8072: background-color: $data_table_light;
1.1205 golterma 8073: position: absolute;
8074: top: 100%;
1.1076 raeburn 8075: }
8076:
1.1205 golterma 8077: ol.LC_primary_menu ul ul {
8078: left: 100%;
8079: top: 0;
8080: }
8081:
8082: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8083: display: block;
8084: position: absolute;
8085: margin: 0;
8086: padding: 0;
1.1078 raeburn 8087: z-index: 2;
1.1076 raeburn 8088: }
8089:
8090: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8091: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8092: font-size: 90%;
1.911 bisitz 8093: vertical-align: top;
1.1076 raeburn 8094: float: none;
1.1079 raeburn 8095: border-left: 1px solid black;
8096: border-right: 1px solid black;
1.1205 golterma 8097: /* A dark bottom border to visualize different menu options;
8098: overwritten in the create_submenu routine for the last border-bottom of the menu */
8099: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8100: }
8101:
1.1205 golterma 8102: ol.LC_primary_menu li li p:hover {
8103: color:$button_hover;
8104: text-decoration:none;
8105: background-color:$data_table_dark;
1.1076 raeburn 8106: }
8107:
8108: ol.LC_primary_menu li li a:hover {
8109: color:$button_hover;
8110: background-color:$data_table_dark;
1.693 droeschl 8111: }
8112:
1.1205 golterma 8113: /* Font-size equal to the size of the predecessors*/
8114: ol.LC_primary_menu li:hover li li {
8115: font-size: 100%;
8116: }
8117:
1.897 wenzelju 8118: ol.LC_primary_menu li img {
1.911 bisitz 8119: vertical-align: bottom;
1.934 droeschl 8120: height: 1.1em;
1.1077 raeburn 8121: margin: 0.2em 0 0 0;
1.693 droeschl 8122: }
8123:
1.897 wenzelju 8124: ol.LC_primary_menu a {
1.911 bisitz 8125: color: RGB(80, 80, 80);
8126: text-decoration: none;
1.693 droeschl 8127: }
1.795 www 8128:
1.949 droeschl 8129: ol.LC_primary_menu a.LC_new_message {
8130: font-weight:bold;
8131: color: darkred;
8132: }
8133:
1.975 raeburn 8134: ol.LC_docs_parameters {
8135: margin-left: 0;
8136: padding: 0;
8137: list-style: none;
8138: }
8139:
8140: ol.LC_docs_parameters li {
8141: margin: 0;
8142: padding-right: 20px;
8143: display: inline;
8144: }
8145:
1.976 raeburn 8146: ol.LC_docs_parameters li:before {
8147: content: "\\002022 \\0020";
8148: }
8149:
8150: li.LC_docs_parameters_title {
8151: font-weight: bold;
8152: }
8153:
8154: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8155: content: "";
8156: }
8157:
1.897 wenzelju 8158: ul#LC_secondary_menu {
1.1107 raeburn 8159: clear: right;
1.911 bisitz 8160: color: $fontmenu;
8161: background: $tabbg;
8162: list-style: none;
8163: padding: 0;
8164: margin: 0;
8165: width: 100%;
1.995 raeburn 8166: text-align: left;
1.1107 raeburn 8167: float: left;
1.808 droeschl 8168: }
8169:
1.897 wenzelju 8170: ul#LC_secondary_menu li {
1.911 bisitz 8171: font-weight: bold;
8172: line-height: 1.8em;
1.1107 raeburn 8173: border-right: 1px solid black;
8174: float: left;
8175: }
8176:
8177: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8178: background-color: $data_table_light;
8179: }
8180:
8181: ul#LC_secondary_menu li a {
1.911 bisitz 8182: padding: 0 0.8em;
1.1107 raeburn 8183: }
8184:
8185: ul#LC_secondary_menu li ul {
8186: display: none;
8187: }
8188:
8189: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8190: display: block;
8191: position: absolute;
8192: margin: 0;
8193: padding: 0;
8194: list-style:none;
8195: float: none;
8196: background-color: $data_table_light;
8197: z-index: 2;
8198: margin-left: -1px;
8199: }
8200:
8201: ul#LC_secondary_menu li ul li {
8202: font-size: 90%;
8203: vertical-align: top;
8204: border-left: 1px solid black;
1.911 bisitz 8205: border-right: 1px solid black;
1.1119 raeburn 8206: background-color: $data_table_light;
1.1107 raeburn 8207: list-style:none;
8208: float: none;
8209: }
8210:
8211: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8212: background-color: $data_table_dark;
1.807 droeschl 8213: }
8214:
1.847 tempelho 8215: ul.LC_TabContent {
1.911 bisitz 8216: display:block;
8217: background: $sidebg;
8218: border-bottom: solid 1px $lg_border_color;
8219: list-style:none;
1.1020 raeburn 8220: margin: -1px -10px 0 -10px;
1.911 bisitz 8221: padding: 0;
1.693 droeschl 8222: }
8223:
1.795 www 8224: ul.LC_TabContent li,
8225: ul.LC_TabContentBigger li {
1.911 bisitz 8226: float:left;
1.741 harmsja 8227: }
1.795 www 8228:
1.897 wenzelju 8229: ul#LC_secondary_menu li a {
1.911 bisitz 8230: color: $fontmenu;
8231: text-decoration: none;
1.693 droeschl 8232: }
1.795 www 8233:
1.721 harmsja 8234: ul.LC_TabContent {
1.952 onken 8235: min-height:20px;
1.721 harmsja 8236: }
1.795 www 8237:
8238: ul.LC_TabContent li {
1.911 bisitz 8239: vertical-align:middle;
1.959 onken 8240: padding: 0 16px 0 10px;
1.911 bisitz 8241: background-color:$tabbg;
8242: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8243: border-left: solid 1px $font;
1.721 harmsja 8244: }
1.795 www 8245:
1.847 tempelho 8246: ul.LC_TabContent .right {
1.911 bisitz 8247: float:right;
1.847 tempelho 8248: }
8249:
1.911 bisitz 8250: ul.LC_TabContent li a,
8251: ul.LC_TabContent li {
8252: color:rgb(47,47,47);
8253: text-decoration:none;
8254: font-size:95%;
8255: font-weight:bold;
1.952 onken 8256: min-height:20px;
8257: }
8258:
1.959 onken 8259: ul.LC_TabContent li a:hover,
8260: ul.LC_TabContent li a:focus {
1.952 onken 8261: color: $button_hover;
1.959 onken 8262: background:none;
8263: outline:none;
1.952 onken 8264: }
8265:
8266: ul.LC_TabContent li:hover {
8267: color: $button_hover;
8268: cursor:pointer;
1.721 harmsja 8269: }
1.795 www 8270:
1.911 bisitz 8271: ul.LC_TabContent li.active {
1.952 onken 8272: color: $font;
1.911 bisitz 8273: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8274: border-bottom:solid 1px #FFFFFF;
8275: cursor: default;
1.744 ehlerst 8276: }
1.795 www 8277:
1.959 onken 8278: ul.LC_TabContent li.active a {
8279: color:$font;
8280: background:#FFFFFF;
8281: outline: none;
8282: }
1.1047 raeburn 8283:
8284: ul.LC_TabContent li.goback {
8285: float: left;
8286: border-left: none;
8287: }
8288:
1.870 tempelho 8289: #maincoursedoc {
1.911 bisitz 8290: clear:both;
1.870 tempelho 8291: }
8292:
8293: ul.LC_TabContentBigger {
1.911 bisitz 8294: display:block;
8295: list-style:none;
8296: padding: 0;
1.870 tempelho 8297: }
8298:
1.795 www 8299: ul.LC_TabContentBigger li {
1.911 bisitz 8300: vertical-align:bottom;
8301: height: 30px;
8302: font-size:110%;
8303: font-weight:bold;
8304: color: #737373;
1.841 tempelho 8305: }
8306:
1.957 onken 8307: ul.LC_TabContentBigger li.active {
8308: position: relative;
8309: top: 1px;
8310: }
8311:
1.870 tempelho 8312: ul.LC_TabContentBigger li a {
1.911 bisitz 8313: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8314: height: 30px;
8315: line-height: 30px;
8316: text-align: center;
8317: display: block;
8318: text-decoration: none;
1.958 onken 8319: outline: none;
1.741 harmsja 8320: }
1.795 www 8321:
1.870 tempelho 8322: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8323: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8324: color:$font;
1.744 ehlerst 8325: }
1.795 www 8326:
1.870 tempelho 8327: ul.LC_TabContentBigger li b {
1.911 bisitz 8328: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8329: display: block;
8330: float: left;
8331: padding: 0 30px;
1.957 onken 8332: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8333: }
8334:
1.956 onken 8335: ul.LC_TabContentBigger li:hover b {
8336: color:$button_hover;
8337: }
8338:
1.870 tempelho 8339: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8340: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8341: color:$font;
1.957 onken 8342: border: 0;
1.741 harmsja 8343: }
1.693 droeschl 8344:
1.870 tempelho 8345:
1.862 bisitz 8346: ul.LC_CourseBreadcrumbs {
8347: background: $sidebg;
1.1020 raeburn 8348: height: 2em;
1.862 bisitz 8349: padding-left: 10px;
1.1020 raeburn 8350: margin: 0;
1.862 bisitz 8351: list-style-position: inside;
8352: }
8353:
1.911 bisitz 8354: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8355: ol#LC_PathBreadcrumbs {
1.911 bisitz 8356: padding-left: 10px;
8357: margin: 0;
1.933 droeschl 8358: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8359: }
8360:
1.911 bisitz 8361: ol#LC_MenuBreadcrumbs li,
8362: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8363: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8364: display: inline;
1.933 droeschl 8365: white-space: normal;
1.693 droeschl 8366: }
8367:
1.823 bisitz 8368: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8369: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8370: text-decoration: none;
8371: font-size:90%;
1.693 droeschl 8372: }
1.795 www 8373:
1.969 droeschl 8374: ol#LC_MenuBreadcrumbs h1 {
8375: display: inline;
8376: font-size: 90%;
8377: line-height: 2.5em;
8378: margin: 0;
8379: padding: 0;
8380: }
8381:
1.795 www 8382: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8383: text-decoration:none;
8384: font-size:100%;
8385: font-weight:bold;
1.693 droeschl 8386: }
1.795 www 8387:
1.840 bisitz 8388: .LC_Box {
1.911 bisitz 8389: border: solid 1px $lg_border_color;
8390: padding: 0 10px 10px 10px;
1.746 neumanie 8391: }
1.795 www 8392:
1.1020 raeburn 8393: .LC_DocsBox {
8394: border: solid 1px $lg_border_color;
8395: padding: 0 0 10px 10px;
8396: }
8397:
1.795 www 8398: .LC_AboutMe_Image {
1.911 bisitz 8399: float:left;
8400: margin-right:10px;
1.747 neumanie 8401: }
1.795 www 8402:
8403: .LC_Clear_AboutMe_Image {
1.911 bisitz 8404: clear:left;
1.747 neumanie 8405: }
1.795 www 8406:
1.721 harmsja 8407: dl.LC_ListStyleClean dt {
1.911 bisitz 8408: padding-right: 5px;
8409: display: table-header-group;
1.693 droeschl 8410: }
8411:
1.721 harmsja 8412: dl.LC_ListStyleClean dd {
1.911 bisitz 8413: display: table-row;
1.693 droeschl 8414: }
8415:
1.721 harmsja 8416: .LC_ListStyleClean,
8417: .LC_ListStyleSimple,
8418: .LC_ListStyleNormal,
1.795 www 8419: .LC_ListStyleSpecial {
1.911 bisitz 8420: /* display:block; */
8421: list-style-position: inside;
8422: list-style-type: none;
8423: overflow: hidden;
8424: padding: 0;
1.693 droeschl 8425: }
8426:
1.721 harmsja 8427: .LC_ListStyleSimple li,
8428: .LC_ListStyleSimple dd,
8429: .LC_ListStyleNormal li,
8430: .LC_ListStyleNormal dd,
8431: .LC_ListStyleSpecial li,
1.795 www 8432: .LC_ListStyleSpecial dd {
1.911 bisitz 8433: margin: 0;
8434: padding: 5px 5px 5px 10px;
8435: clear: both;
1.693 droeschl 8436: }
8437:
1.721 harmsja 8438: .LC_ListStyleClean li,
8439: .LC_ListStyleClean dd {
1.911 bisitz 8440: padding-top: 0;
8441: padding-bottom: 0;
1.693 droeschl 8442: }
8443:
1.721 harmsja 8444: .LC_ListStyleSimple dd,
1.795 www 8445: .LC_ListStyleSimple li {
1.911 bisitz 8446: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8447: }
8448:
1.721 harmsja 8449: .LC_ListStyleSpecial li,
8450: .LC_ListStyleSpecial dd {
1.911 bisitz 8451: list-style-type: none;
8452: background-color: RGB(220, 220, 220);
8453: margin-bottom: 4px;
1.693 droeschl 8454: }
8455:
1.721 harmsja 8456: table.LC_SimpleTable {
1.911 bisitz 8457: margin:5px;
8458: border:solid 1px $lg_border_color;
1.795 www 8459: }
1.693 droeschl 8460:
1.721 harmsja 8461: table.LC_SimpleTable tr {
1.911 bisitz 8462: padding: 0;
8463: border:solid 1px $lg_border_color;
1.693 droeschl 8464: }
1.795 www 8465:
8466: table.LC_SimpleTable thead {
1.911 bisitz 8467: background:rgb(220,220,220);
1.693 droeschl 8468: }
8469:
1.721 harmsja 8470: div.LC_columnSection {
1.911 bisitz 8471: display: block;
8472: clear: both;
8473: overflow: hidden;
8474: margin: 0;
1.693 droeschl 8475: }
8476:
1.721 harmsja 8477: div.LC_columnSection>* {
1.911 bisitz 8478: float: left;
8479: margin: 10px 20px 10px 0;
8480: overflow:hidden;
1.693 droeschl 8481: }
1.721 harmsja 8482:
1.795 www 8483: table em {
1.911 bisitz 8484: font-weight: bold;
8485: font-style: normal;
1.748 schulted 8486: }
1.795 www 8487:
1.779 bisitz 8488: table.LC_tableBrowseRes,
1.795 www 8489: table.LC_tableOfContent {
1.911 bisitz 8490: border:none;
8491: border-spacing: 1px;
8492: padding: 3px;
8493: background-color: #FFFFFF;
8494: font-size: 90%;
1.753 droeschl 8495: }
1.789 droeschl 8496:
1.911 bisitz 8497: table.LC_tableOfContent {
8498: border-collapse: collapse;
1.789 droeschl 8499: }
8500:
1.771 droeschl 8501: table.LC_tableBrowseRes a,
1.768 schulted 8502: table.LC_tableOfContent a {
1.911 bisitz 8503: background-color: transparent;
8504: text-decoration: none;
1.753 droeschl 8505: }
8506:
1.795 www 8507: table.LC_tableOfContent img {
1.911 bisitz 8508: border: none;
8509: height: 1.3em;
8510: vertical-align: text-bottom;
8511: margin-right: 0.3em;
1.753 droeschl 8512: }
1.757 schulted 8513:
1.795 www 8514: a#LC_content_toolbar_firsthomework {
1.911 bisitz 8515: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 8516: }
8517:
1.795 www 8518: a#LC_content_toolbar_everything {
1.911 bisitz 8519: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 8520: }
8521:
1.795 www 8522: a#LC_content_toolbar_uncompleted {
1.911 bisitz 8523: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 8524: }
8525:
1.795 www 8526: #LC_content_toolbar_clearbubbles {
1.911 bisitz 8527: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 8528: }
8529:
1.795 www 8530: a#LC_content_toolbar_changefolder {
1.911 bisitz 8531: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 8532: }
8533:
1.795 www 8534: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 8535: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 8536: }
8537:
1.1043 raeburn 8538: a#LC_content_toolbar_edittoplevel {
8539: background-image:url(/res/adm/pages/edittoplevel.gif);
8540: }
8541:
1.1384 raeburn 8542: a#LC_content_toolbar_printout {
8543: background-image:url(/res/adm/pages/printout.gif);
8544: }
8545:
1.795 www 8546: ul#LC_toolbar li a:hover {
1.911 bisitz 8547: background-position: bottom center;
1.757 schulted 8548: }
8549:
1.795 www 8550: ul#LC_toolbar {
1.911 bisitz 8551: padding: 0;
8552: margin: 2px;
8553: list-style:none;
8554: position:relative;
8555: background-color:white;
1.1082 raeburn 8556: overflow: auto;
1.757 schulted 8557: }
8558:
1.795 www 8559: ul#LC_toolbar li {
1.911 bisitz 8560: border:1px solid white;
8561: padding: 0;
8562: margin: 0;
8563: float: left;
8564: display:inline;
8565: vertical-align:middle;
1.1082 raeburn 8566: white-space: nowrap;
1.911 bisitz 8567: }
1.757 schulted 8568:
1.783 amueller 8569:
1.795 www 8570: a.LC_toolbarItem {
1.911 bisitz 8571: display:block;
8572: padding: 0;
8573: margin: 0;
8574: height: 32px;
8575: width: 32px;
8576: color:white;
8577: border: none;
8578: background-repeat:no-repeat;
8579: background-color:transparent;
1.757 schulted 8580: }
8581:
1.915 droeschl 8582: ul.LC_funclist {
8583: margin: 0;
8584: padding: 0.5em 1em 0.5em 0;
8585: }
8586:
1.933 droeschl 8587: ul.LC_funclist > li:first-child {
8588: font-weight:bold;
8589: margin-left:0.8em;
8590: }
8591:
1.915 droeschl 8592: ul.LC_funclist + ul.LC_funclist {
8593: /*
8594: left border as a seperator if we have more than
8595: one list
8596: */
8597: border-left: 1px solid $sidebg;
8598: /*
8599: this hides the left border behind the border of the
8600: outer box if element is wrapped to the next 'line'
8601: */
8602: margin-left: -1px;
8603: }
8604:
1.843 bisitz 8605: ul.LC_funclist li {
1.915 droeschl 8606: display: inline;
1.782 bisitz 8607: white-space: nowrap;
1.915 droeschl 8608: margin: 0 0 0 25px;
8609: line-height: 150%;
1.782 bisitz 8610: }
8611:
1.974 wenzelju 8612: .LC_hidden {
8613: display: none;
8614: }
8615:
1.1030 www 8616: .LCmodal-overlay {
8617: position:fixed;
8618: top:0;
8619: right:0;
8620: bottom:0;
8621: left:0;
8622: height:100%;
8623: width:100%;
8624: margin:0;
8625: padding:0;
8626: background:#999;
8627: opacity:.75;
8628: filter: alpha(opacity=75);
8629: -moz-opacity: 0.75;
8630: z-index:101;
8631: }
8632:
8633: * html .LCmodal-overlay {
8634: position: absolute;
8635: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8636: }
8637:
8638: .LCmodal-window {
8639: position:fixed;
8640: top:50%;
8641: left:50%;
8642: margin:0;
8643: padding:0;
8644: z-index:102;
8645: }
8646:
8647: * html .LCmodal-window {
8648: position:absolute;
8649: }
8650:
8651: .LCclose-window {
8652: position:absolute;
8653: width:32px;
8654: height:32px;
8655: right:8px;
8656: top:8px;
8657: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8658: text-indent:-99999px;
8659: overflow:hidden;
8660: cursor:pointer;
8661: }
8662:
1.1369 raeburn 8663: .LCisDisabled {
8664: cursor: not-allowed;
8665: opacity: 0.5;
8666: }
8667:
8668: a[aria-disabled="true"] {
8669: color: currentColor;
8670: display: inline-block; /* For IE11/ MS Edge bug */
8671: pointer-events: none;
8672: text-decoration: none;
8673: }
8674:
1.1335 raeburn 8675: pre.LC_wordwrap {
8676: white-space: pre-wrap;
8677: white-space: -moz-pre-wrap;
8678: white-space: -pre-wrap;
8679: white-space: -o-pre-wrap;
8680: word-wrap: break-word;
8681: }
8682:
1.1100 raeburn 8683: /*
1.1231 damieng 8684: styles used for response display
8685: */
8686: div.LC_radiofoil, div.LC_rankfoil {
8687: margin: .5em 0em .5em 0em;
8688: }
8689: table.LC_itemgroup {
8690: margin-top: 1em;
8691: }
8692:
8693: /*
1.1100 raeburn 8694: styles used by TTH when "Default set of options to pass to tth/m
8695: when converting TeX" in course settings has been set
8696:
8697: option passed: -t
8698:
8699: */
8700:
8701: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8702: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8703: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8704: td div.norm {line-height:normal;}
8705:
8706: /*
8707: option passed -y3
8708: */
8709:
8710: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8711: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8712: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8713:
1.1230 damieng 8714: /*
8715: sections with roles, for content only
8716: */
8717: section[class^="role-"] {
8718: padding-left: 10px;
8719: padding-right: 5px;
8720: margin-top: 8px;
8721: margin-bottom: 8px;
8722: border: 1px solid #2A4;
8723: border-radius: 5px;
8724: box-shadow: 0px 1px 1px #BBB;
8725: }
8726: section[class^="role-"]>h1 {
8727: position: relative;
8728: margin: 0px;
8729: padding-top: 10px;
8730: padding-left: 40px;
8731: }
8732: section[class^="role-"]>h1:before {
8733: position: absolute;
8734: left: -5px;
8735: top: 5px;
8736: }
8737: section.role-activity>h1:before {
8738: content:url('/adm/daxe/images/section_icons/activity.png');
8739: }
8740: section.role-advice>h1:before {
8741: content:url('/adm/daxe/images/section_icons/advice.png');
8742: }
8743: section.role-bibliography>h1:before {
8744: content:url('/adm/daxe/images/section_icons/bibliography.png');
8745: }
8746: section.role-citation>h1:before {
8747: content:url('/adm/daxe/images/section_icons/citation.png');
8748: }
8749: section.role-conclusion>h1:before {
8750: content:url('/adm/daxe/images/section_icons/conclusion.png');
8751: }
8752: section.role-definition>h1:before {
8753: content:url('/adm/daxe/images/section_icons/definition.png');
8754: }
8755: section.role-demonstration>h1:before {
8756: content:url('/adm/daxe/images/section_icons/demonstration.png');
8757: }
8758: section.role-example>h1:before {
8759: content:url('/adm/daxe/images/section_icons/example.png');
8760: }
8761: section.role-explanation>h1:before {
8762: content:url('/adm/daxe/images/section_icons/explanation.png');
8763: }
8764: section.role-introduction>h1:before {
8765: content:url('/adm/daxe/images/section_icons/introduction.png');
8766: }
8767: section.role-method>h1:before {
8768: content:url('/adm/daxe/images/section_icons/method.png');
8769: }
8770: section.role-more_information>h1:before {
8771: content:url('/adm/daxe/images/section_icons/more_information.png');
8772: }
8773: section.role-objectives>h1:before {
8774: content:url('/adm/daxe/images/section_icons/objectives.png');
8775: }
8776: section.role-prerequisites>h1:before {
8777: content:url('/adm/daxe/images/section_icons/prerequisites.png');
8778: }
8779: section.role-remark>h1:before {
8780: content:url('/adm/daxe/images/section_icons/remark.png');
8781: }
8782: section.role-reminder>h1:before {
8783: content:url('/adm/daxe/images/section_icons/reminder.png');
8784: }
8785: section.role-summary>h1:before {
8786: content:url('/adm/daxe/images/section_icons/summary.png');
8787: }
8788: section.role-syntax>h1:before {
8789: content:url('/adm/daxe/images/section_icons/syntax.png');
8790: }
8791: section.role-warning>h1:before {
8792: content:url('/adm/daxe/images/section_icons/warning.png');
8793: }
8794:
1.1269 raeburn 8795: #LC_minitab_header {
8796: float:left;
8797: width:100%;
8798: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8799: font-size:93%;
8800: line-height:normal;
8801: margin: 0.5em 0 0.5em 0;
8802: }
8803: #LC_minitab_header ul {
8804: margin:0;
8805: padding:10px 10px 0;
8806: list-style:none;
8807: }
8808: #LC_minitab_header li {
8809: float:left;
8810: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8811: margin:0;
8812: padding:0 0 0 9px;
8813: }
8814: #LC_minitab_header a {
8815: display:block;
8816: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8817: padding:5px 15px 4px 6px;
8818: }
8819: #LC_minitab_header #LC_current_minitab {
8820: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8821: }
8822: #LC_minitab_header #LC_current_minitab a {
8823: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8824: padding-bottom:5px;
8825: }
8826:
8827:
1.343 albertel 8828: END
8829: }
8830:
1.306 albertel 8831: =pod
8832:
8833: =item * &headtag()
8834:
8835: Returns a uniform footer for LON-CAPA web pages.
8836:
1.307 albertel 8837: Inputs: $title - optional title for the head
8838: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 8839: $args - optional arguments
1.319 albertel 8840: force_register - if is true call registerurl so the remote is
8841: informed
1.415 albertel 8842: redirect -> array ref of
8843: 1- seconds before redirect occurs
8844: 2- url to redirect to
8845: 3- whether the side effect should occur
1.315 albertel 8846: (side effect of setting
8847: $env{'internal.head.redirect'} to the url
8848: redirected too)
1.352 albertel 8849: domain -> force to color decorate a page for a specific
8850: domain
8851: function -> force usage of a specific rolish color scheme
8852: bgcolor -> override the default page bgcolor
1.460 albertel 8853: no_auto_mt_title
8854: -> prevent &mt()ing the title arg
1.464 albertel 8855:
1.306 albertel 8856: =cut
8857:
8858: sub headtag {
1.313 albertel 8859: my ($title,$head_extra,$args) = @_;
1.306 albertel 8860:
1.363 albertel 8861: my $function = $args->{'function'} || &get_users_function();
8862: my $domain = $args->{'domain'} || &determinedomain();
8863: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 8864: my $httphost = $args->{'use_absolute'};
1.418 albertel 8865: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 8866: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 8867: #time(),
1.418 albertel 8868: $env{'environment.color.timestamp'},
1.363 albertel 8869: $function,$domain,$bgcolor);
8870:
1.369 www 8871: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 8872:
1.308 albertel 8873: my $result =
8874: '<head>'.
1.1160 raeburn 8875: &font_settings($args);
1.319 albertel 8876:
1.1188 raeburn 8877: my $inhibitprint;
8878: if ($args->{'print_suppress'}) {
8879: $inhibitprint = &print_suppression();
8880: }
1.1064 raeburn 8881:
1.461 albertel 8882: if (!$args->{'frameset'}) {
8883: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
8884: }
1.962 droeschl 8885: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
8886: $result .= Apache::lonxml::display_title();
1.319 albertel 8887: }
1.436 albertel 8888: if (!$args->{'no_nav_bar'}
8889: && !$args->{'only_body'}
8890: && !$args->{'frameset'}) {
1.1154 raeburn 8891: $result .= &help_menu_js($httphost);
1.1032 www 8892: $result.=&modal_window();
1.1038 www 8893: $result.=&togglebox_script();
1.1034 www 8894: $result.=&wishlist_window();
1.1041 www 8895: $result.=&LCprogressbarUpdate_script();
1.1034 www 8896: } else {
8897: if ($args->{'add_modal'}) {
8898: $result.=&modal_window();
8899: }
8900: if ($args->{'add_wishlist'}) {
8901: $result.=&wishlist_window();
8902: }
1.1038 www 8903: if ($args->{'add_togglebox'}) {
8904: $result.=&togglebox_script();
8905: }
1.1041 www 8906: if ($args->{'add_progressbar'}) {
8907: $result.=&LCprogressbarUpdate_script();
8908: }
1.436 albertel 8909: }
1.314 albertel 8910: if (ref($args->{'redirect'})) {
1.414 albertel 8911: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 8912: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 8913: if (!$inhibit_continue) {
8914: $env{'internal.head.redirect'} = $url;
8915: }
1.313 albertel 8916: $result.=<<ADDMETA
8917: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 8918: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 8919: ADDMETA
1.1210 raeburn 8920: } else {
8921: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
8922: my $requrl = $env{'request.uri'};
8923: if ($requrl eq '') {
8924: $requrl = $ENV{'REQUEST_URI'};
8925: $requrl =~ s/\?.+$//;
8926: }
8927: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
8928: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
8929: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
8930: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
8931: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
8932: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 8933: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 8934: my ($offload,$offloadoth);
1.1210 raeburn 8935: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
8936: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 8937: $offload = 1;
1.1353 raeburn 8938: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8939: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8940: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8941: $offloadoth = 1;
8942: $dom_in_use = $env{'user.domain'};
8943: }
8944: }
1.1340 raeburn 8945: }
8946: }
8947: unless ($offload) {
8948: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
8949: if ($domdefs{'offloadoth'}{$lonhost}) {
8950: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8951: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8952: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8953: $offload = 1;
1.1352 raeburn 8954: $offloadoth = 1;
1.1340 raeburn 8955: $dom_in_use = $env{'user.domain'};
8956: }
1.1210 raeburn 8957: }
1.1340 raeburn 8958: }
8959: }
8960: }
8961: if ($offload) {
1.1358 raeburn 8962: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 8963: if (($newserver eq '') && ($offloadoth)) {
8964: my @domains = &Apache::lonnet::current_machine_domains();
8965: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
8966: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
8967: }
8968: }
1.1340 raeburn 8969: if (($newserver) && ($newserver ne $lonhost)) {
8970: my $numsec = 5;
8971: my $timeout = $numsec * 1000;
8972: my ($newurl,$locknum,%locks,$msg);
8973: if ($env{'request.role.adv'}) {
8974: ($locknum,%locks) = &Apache::lonnet::get_locks();
8975: }
8976: my $disable_submit = 0;
8977: if ($requrl =~ /$LONCAPA::assess_re/) {
8978: $disable_submit = 1;
8979: }
8980: if ($locknum) {
8981: my @lockinfo = sort(values(%locks));
1.1354 raeburn 8982: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 8983: join(", ",sort(values(%locks)))."\n";
8984: if (&show_course()) {
8985: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
8986: } else {
8987: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 8988: }
1.1340 raeburn 8989: } else {
8990: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8991: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
8992: }
8993: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8994: $newurl = '/adm/switchserver?otherserver='.$newserver;
8995: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8996: $newurl .= '&role='.$env{'request.role'};
8997: }
8998: if ($env{'request.symb'}) {
8999: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9000: if ($shownsymb =~ m{^/enc/}) {
9001: my $reqdmajor = 2;
9002: my $reqdminor = 11;
9003: my $reqdsubminor = 3;
9004: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9005: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9006: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9007: if (($major eq '' && $minor eq '') ||
9008: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9009: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9010: ($reqdsubminor > $subminor))))) {
9011: undef($shownsymb);
9012: }
1.1210 raeburn 9013: }
1.1340 raeburn 9014: if ($shownsymb) {
9015: &js_escape(\$shownsymb);
9016: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9017: }
1.1340 raeburn 9018: } else {
9019: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9020: &js_escape(\$shownurl);
9021: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9022: }
1.1340 raeburn 9023: }
9024: &js_escape(\$msg);
9025: $result.=<<OFFLOAD
1.1210 raeburn 9026: <meta http-equiv="pragma" content="no-cache" />
9027: <script type="text/javascript">
1.1215 raeburn 9028: // <![CDATA[
1.1210 raeburn 9029: function LC_Offload_Now() {
9030: var dest = "$newurl";
9031: if (dest != '') {
9032: window.location.href="$newurl";
9033: }
9034: }
1.1214 raeburn 9035: \$(document).ready(function () {
9036: window.alert('$msg');
9037: if ($disable_submit) {
1.1210 raeburn 9038: \$(".LC_hwk_submit").prop("disabled", true);
9039: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9040: }
9041: setTimeout('LC_Offload_Now()', $timeout);
9042: });
1.1215 raeburn 9043: // ]]>
1.1210 raeburn 9044: </script>
9045: OFFLOAD
9046: }
9047: }
9048: }
9049: }
9050: }
1.313 albertel 9051: }
1.306 albertel 9052: if (!defined($title)) {
9053: $title = 'The LearningOnline Network with CAPA';
9054: }
1.460 albertel 9055: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
9056: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 9057: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
9058: if (!$args->{'frameset'}) {
9059: $result .= ' /';
9060: }
9061: $result .= '>'
1.1064 raeburn 9062: .$inhibitprint
1.414 albertel 9063: .$head_extra;
1.1242 raeburn 9064: my $clientmobile;
9065: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9066: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9067: } else {
9068: $clientmobile = $env{'browser.mobile'};
9069: }
9070: if ($clientmobile) {
1.1137 raeburn 9071: $result .= '
9072: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
9073: <meta name="apple-mobile-web-app-capable" content="yes" />';
9074: }
1.1278 raeburn 9075: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9076: return $result.'</head>';
1.306 albertel 9077: }
9078:
9079: =pod
9080:
1.340 albertel 9081: =item * &font_settings()
9082:
9083: Returns neccessary <meta> to set the proper encoding
9084:
1.1160 raeburn 9085: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9086:
9087: =cut
9088:
9089: sub font_settings {
1.1160 raeburn 9090: my ($args) = @_;
1.340 albertel 9091: my $headerstring='';
1.1160 raeburn 9092: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9093: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9094: $headerstring.=
9095: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9096: if (!$args->{'frameset'}) {
9097: $headerstring.= ' /';
9098: }
9099: $headerstring .= '>'."\n";
1.340 albertel 9100: }
9101: return $headerstring;
9102: }
9103:
1.341 albertel 9104: =pod
9105:
1.1064 raeburn 9106: =item * &print_suppression()
9107:
9108: In course context returns css which causes the body to be blank when media="print",
9109: if printout generation is unavailable for the current resource.
9110:
9111: This could be because:
9112:
9113: (a) printstartdate is in the future
9114:
9115: (b) printenddate is in the past
9116:
9117: (c) there is an active exam block with "printout"
9118: functionality blocked
9119:
9120: Users with pav, pfo or evb privileges are exempt.
9121:
9122: Inputs: none
9123:
9124: =cut
9125:
9126:
9127: sub print_suppression {
9128: my $noprint;
9129: if ($env{'request.course.id'}) {
9130: my $scope = $env{'request.course.id'};
9131: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9132: (&Apache::lonnet::allowed('pfo',$scope))) {
9133: return;
9134: }
9135: if ($env{'request.course.sec'} ne '') {
9136: $scope .= "/$env{'request.course.sec'}";
9137: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9138: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9139: return;
1.1064 raeburn 9140: }
9141: }
9142: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9143: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9144: my $clientip = &Apache::lonnet::get_requestor_ip();
9145: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9146: if ($blocked) {
9147: my $checkrole = "cm./$cdom/$cnum";
9148: if ($env{'request.course.sec'} ne '') {
9149: $checkrole .= "/$env{'request.course.sec'}";
9150: }
9151: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9152: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9153: $noprint = 1;
9154: }
9155: }
9156: unless ($noprint) {
9157: my $symb = &Apache::lonnet::symbread();
9158: if ($symb ne '') {
9159: my $navmap = Apache::lonnavmaps::navmap->new();
9160: if (ref($navmap)) {
9161: my $res = $navmap->getBySymb($symb);
9162: if (ref($res)) {
9163: if (!$res->resprintable()) {
9164: $noprint = 1;
9165: }
9166: }
9167: }
9168: }
9169: }
9170: if ($noprint) {
9171: return <<"ENDSTYLE";
9172: <style type="text/css" media="print">
9173: body { display:none }
9174: </style>
9175: ENDSTYLE
9176: }
9177: }
9178: return;
9179: }
9180:
9181: =pod
9182:
1.341 albertel 9183: =item * &xml_begin()
9184:
9185: Returns the needed doctype and <html>
9186:
9187: Inputs: none
9188:
9189: =cut
9190:
9191: sub xml_begin {
1.1168 raeburn 9192: my ($is_frameset) = @_;
1.341 albertel 9193: my $output='';
9194:
9195: if ($env{'browser.mathml'}) {
9196: $output='<?xml version="1.0"?>'
9197: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9198: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9199:
9200: # .'<!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">] >'
9201: .'<!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">'
9202: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9203: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9204: } elsif ($is_frameset) {
9205: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9206: '<html>'."\n";
1.341 albertel 9207: } else {
1.1168 raeburn 9208: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9209: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9210: }
9211: return $output;
9212: }
1.340 albertel 9213:
9214: =pod
9215:
1.306 albertel 9216: =item * &start_page()
9217:
9218: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9219:
1.648 raeburn 9220: Inputs:
9221:
9222: =over 4
9223:
9224: $title - optional title for the page
9225:
9226: $head_extra - optional extra HTML to incude inside the <head>
9227:
9228: $args - additional optional args supported are:
9229:
9230: =over 8
9231:
9232: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9233: arg on
1.814 bisitz 9234: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9235: add_entries -> additional attributes to add to the <body>
9236: domain -> force to color decorate a page for a
1.317 albertel 9237: specific domain
1.648 raeburn 9238: function -> force usage of a specific rolish color
1.317 albertel 9239: scheme
1.648 raeburn 9240: redirect -> see &headtag()
9241: bgcolor -> override the default page bg color
9242: js_ready -> return a string ready for being used in
1.317 albertel 9243: a javascript writeln
1.648 raeburn 9244: html_encode -> return a string ready for being used in
1.320 albertel 9245: a html attribute
1.648 raeburn 9246: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9247: $forcereg arg
1.648 raeburn 9248: frameset -> if true will start with a <frameset>
1.330 albertel 9249: rather than <body>
1.648 raeburn 9250: skip_phases -> hash ref of
1.338 albertel 9251: head -> skip the <html><head> generation
9252: body -> skip all <body> generation
1.648 raeburn 9253: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9254: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9255: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 9256: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9257: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9258: group -> includes the current group, if page is for a
1.1274 raeburn 9259: specific group
9260: use_absolute -> for request for external resource or syllabus, this
9261: will contain https://<hostname> if server uses
9262: https (as per hosts.tab), but request is for http
9263: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9264: links_disabled -> Links in primary and secondary menus are disabled
9265: (Can enable them once page has loaded - see lonroles.pm
9266: for an example).
1.1380 raeburn 9267: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9268:
1.648 raeburn 9269: =back
1.460 albertel 9270:
1.648 raeburn 9271: =back
1.562 albertel 9272:
1.306 albertel 9273: =cut
9274:
9275: sub start_page {
1.309 albertel 9276: my ($title,$head_extra,$args) = @_;
1.318 albertel 9277: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9278:
1.315 albertel 9279: $env{'internal.start_page'}++;
1.1359 raeburn 9280: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9281:
1.338 albertel 9282: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9283: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9284: }
1.1316 raeburn 9285:
9286: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9287: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9288: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9289: $args->{'no_primary_menu'} = 1;
9290: }
9291: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9292: $args->{'no_inline_menu'} = 1;
9293: }
9294: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9295: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9296: }
9297: } else {
9298: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9299: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9300: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9301: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9302: $args->{'no_primary_menu'} = 1;
9303: }
9304: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9305: $args->{'no_inline_menu'} = 1;
9306: }
9307: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9308: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9309: }
9310: }
9311: }
1.1316 raeburn 9312: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9313: $env{'course.'.$env{'request.course.id'}.'.domain'},
9314: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9315: } elsif ($env{'request.course.id'}) {
9316: my $expiretime=600;
9317: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9318: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9319: }
9320: my ($deeplinkmenu,$menuref);
9321: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9322: if ($menucoll) {
9323: if (ref($menuref) eq 'HASH') {
9324: %menu = %{$menuref};
9325: }
9326: if ($menu{'top'} eq 'n') {
9327: $args->{'no_primary_menu'} = 1;
9328: }
9329: if ($menu{'inline'} eq 'n') {
9330: unless (&Apache::lonnet::allowed('opa')) {
9331: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9332: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9333: my $crstype = &course_type();
9334: my $now = time;
9335: my $ccrole;
9336: if ($crstype eq 'Community') {
9337: $ccrole = 'co';
9338: } else {
9339: $ccrole = 'cc';
9340: }
9341: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9342: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9343: if ((($start) && ($start<0)) ||
9344: (($end) && ($end<$now)) ||
9345: (($start) && ($now<$start))) {
9346: $args->{'no_inline_menu'} = 1;
9347: }
9348: } else {
9349: $args->{'no_inline_menu'} = 1;
9350: }
9351: }
9352: }
9353: }
1.1316 raeburn 9354: }
1.1359 raeburn 9355:
1.1385 ! raeburn 9356: my $showncrumbs;
1.338 albertel 9357: if (! exists($args->{'skip_phases'}{'body'}) ) {
9358: if ($args->{'frameset'}) {
9359: my $attr_string = &make_attr_string($args->{'force_register'},
9360: $args->{'add_entries'});
9361: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9362: } else {
9363: $result .=
9364: &bodytag($title,
9365: $args->{'function'}, $args->{'add_entries'},
9366: $args->{'only_body'}, $args->{'domain'},
9367: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9368: $args->{'bgcolor'}, $args,
1.1385 ! raeburn 9369: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
! 9370: \%menu,\$showncrumbs);
1.831 bisitz 9371: }
1.330 albertel 9372: }
1.338 albertel 9373:
1.315 albertel 9374: if ($args->{'js_ready'}) {
1.713 kaisler 9375: $result = &js_ready($result);
1.315 albertel 9376: }
1.320 albertel 9377: if ($args->{'html_encode'}) {
1.713 kaisler 9378: $result = &html_encode($result);
9379: }
9380:
1.813 bisitz 9381: # Preparation for new and consistent functionlist at top of screen
9382: # if ($args->{'functionlist'}) {
9383: # $result .= &build_functionlist();
9384: #}
9385:
1.964 droeschl 9386: # Don't add anything more if only_body wanted or in const space
9387: return $result if $args->{'only_body'}
9388: || $env{'request.state'} eq 'construct';
1.813 bisitz 9389:
9390: #Breadcrumbs
1.758 kaisler 9391: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 ! raeburn 9392: unless ($showncrumbs) {
1.758 kaisler 9393: &Apache::lonhtmlcommon::clear_breadcrumbs();
9394: #if any br links exists, add them to the breadcrumbs
9395: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9396: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9397: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9398: }
9399: }
1.1096 raeburn 9400: # if @advtools array contains items add then to the breadcrumbs
9401: if (@advtools > 0) {
9402: &Apache::lonmenu::advtools_crumbs(@advtools);
9403: }
1.1272 raeburn 9404: my $menulink;
9405: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9406: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9407: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9408: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9409: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9410: (!$env{'request.role.adv'}))) {
9411: $menulink = 0;
9412: } else {
9413: undef($menulink);
9414: }
1.1385 ! raeburn 9415: my $linkprotout;
! 9416: if ($env{'request.deeplink.login'}) {
! 9417: my $linkprotout = &Apache::lonmenu::linkprot_exit();
! 9418: if ($linkprotout) {
! 9419: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
! 9420: }
! 9421: }
1.758 kaisler 9422: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
9423: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 9424: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 9425: } else {
1.1272 raeburn 9426: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 9427: }
1.1385 ! raeburn 9428: }
1.320 albertel 9429: }
1.315 albertel 9430: return $result;
1.306 albertel 9431: }
9432:
9433: sub end_page {
1.315 albertel 9434: my ($args) = @_;
9435: $env{'internal.end_page'}++;
1.330 albertel 9436: my $result;
1.335 albertel 9437: if ($args->{'discussion'}) {
9438: my ($target,$parser);
9439: if (ref($args->{'discussion'})) {
9440: ($target,$parser) =($args->{'discussion'}{'target'},
9441: $args->{'discussion'}{'parser'});
9442: }
9443: $result .= &Apache::lonxml::xmlend($target,$parser);
9444: }
1.330 albertel 9445: if ($args->{'frameset'}) {
9446: $result .= '</frameset>';
9447: } else {
1.635 raeburn 9448: $result .= &endbodytag($args);
1.330 albertel 9449: }
1.1080 raeburn 9450: unless ($args->{'notbody'}) {
9451: $result .= "\n</html>";
9452: }
1.330 albertel 9453:
1.315 albertel 9454: if ($args->{'js_ready'}) {
1.317 albertel 9455: $result = &js_ready($result);
1.315 albertel 9456: }
1.335 albertel 9457:
1.320 albertel 9458: if ($args->{'html_encode'}) {
9459: $result = &html_encode($result);
9460: }
1.335 albertel 9461:
1.315 albertel 9462: return $result;
9463: }
9464:
1.1359 raeburn 9465: sub menucoll_in_effect {
9466: my ($menucoll,$deeplinkmenu,%menu);
9467: if ($env{'request.course.id'}) {
9468: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 9469: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 9470: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 9471: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9472: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9473: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
9474: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
9475: my $navmap = Apache::lonnavmaps::navmap->new();
9476: if (ref($navmap)) {
9477: $deeplink = $navmap->get_mapparam(undef,
9478: &Apache::lonnet::declutter($env{'request.noversionuri'}),
9479: '0.deeplink');
1.1370 raeburn 9480: } else {
9481: $check_login_symb = 1;
1.1362 raeburn 9482: }
9483: } else {
1.1370 raeburn 9484: my $symb = &Apache::lonnet::symbread();
9485: if ($symb) {
9486: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
9487: } else {
9488: $check_login_symb = 1;
9489: }
1.1362 raeburn 9490: }
9491: } else {
1.1370 raeburn 9492: $check_login_symb = 1;
9493: }
9494: if ($check_login_symb) {
1.1362 raeburn 9495: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
9496: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9497: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
9498: my $navmap = Apache::lonnavmaps::navmap->new();
9499: if (ref($navmap)) {
9500: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
9501: }
9502: } else {
9503: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
9504: }
9505: }
1.1359 raeburn 9506: if ($deeplink ne '') {
1.1378 raeburn 9507: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 9508: if ($display =~ /^\d+$/) {
9509: $deeplinkmenu = 1;
9510: $menucoll = $display;
9511: }
9512: }
9513: }
9514: if ($menucoll) {
9515: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
9516: }
9517: }
9518: return ($menucoll,$deeplinkmenu,\%menu);
9519: }
9520:
1.1362 raeburn 9521: sub deeplink_login_symb {
9522: my ($cnum,$cdom) = @_;
9523: my $login_symb;
9524: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 9525: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
9526: }
9527: return $login_symb;
9528: }
9529:
9530: sub symb_from_tinyurl {
9531: my ($url,$cnum,$cdom) = @_;
9532: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
9533: my $key = $1;
9534: my ($tinyurl,$login);
9535: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
9536: if (defined($cached)) {
9537: $tinyurl = $result;
9538: } else {
9539: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
9540: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
9541: if ($currtiny{$key} ne '') {
9542: $tinyurl = $currtiny{$key};
9543: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 9544: }
1.1364 raeburn 9545: }
9546: if ($tinyurl ne '') {
9547: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
9548: if (wantarray) {
9549: return ($cnumreq,$symb);
9550: } elsif ($cnumreq eq $cnum) {
9551: return $symb;
1.1362 raeburn 9552: }
9553: }
9554: }
1.1364 raeburn 9555: if (wantarray) {
9556: return ();
9557: } else {
9558: return;
9559: }
1.1362 raeburn 9560: }
9561:
1.1034 www 9562: sub wishlist_window {
9563: return(<<'ENDWISHLIST');
1.1046 raeburn 9564: <script type="text/javascript">
1.1034 www 9565: // <![CDATA[
9566: // <!-- BEGIN LON-CAPA Internal
9567: function set_wishlistlink(title, path) {
9568: if (!title) {
9569: title = document.title;
9570: title = title.replace(/^LON-CAPA /,'');
9571: }
1.1175 raeburn 9572: title = encodeURIComponent(title);
1.1203 raeburn 9573: title = title.replace("'","\\\'");
1.1034 www 9574: if (!path) {
9575: path = location.pathname;
9576: }
1.1175 raeburn 9577: path = encodeURIComponent(path);
1.1203 raeburn 9578: path = path.replace("'","\\\'");
1.1034 www 9579: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
9580: 'wishlistNewLink','width=560,height=350,scrollbars=0');
9581: }
9582: // END LON-CAPA Internal -->
9583: // ]]>
9584: </script>
9585: ENDWISHLIST
9586: }
9587:
1.1030 www 9588: sub modal_window {
9589: return(<<'ENDMODAL');
1.1046 raeburn 9590: <script type="text/javascript">
1.1030 www 9591: // <![CDATA[
9592: // <!-- BEGIN LON-CAPA Internal
9593: var modalWindow = {
9594: parent:"body",
9595: windowId:null,
9596: content:null,
9597: width:null,
9598: height:null,
9599: close:function()
9600: {
9601: $(".LCmodal-window").remove();
9602: $(".LCmodal-overlay").remove();
9603: },
9604: open:function()
9605: {
9606: var modal = "";
9607: modal += "<div class=\"LCmodal-overlay\"></div>";
9608: 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;\">";
9609: modal += this.content;
9610: modal += "</div>";
9611:
9612: $(this.parent).append(modal);
9613:
9614: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
9615: $(".LCclose-window").click(function(){modalWindow.close();});
9616: $(".LCmodal-overlay").click(function(){modalWindow.close();});
9617: }
9618: };
1.1140 raeburn 9619: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 9620: {
1.1266 raeburn 9621: source = source.replace(/'/g,"'");
1.1030 www 9622: modalWindow.windowId = "myModal";
9623: modalWindow.width = width;
9624: modalWindow.height = height;
1.1196 raeburn 9625: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 9626: modalWindow.open();
1.1208 raeburn 9627: };
1.1030 www 9628: // END LON-CAPA Internal -->
9629: // ]]>
9630: </script>
9631: ENDMODAL
9632: }
9633:
9634: sub modal_link {
1.1140 raeburn 9635: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 9636: unless ($width) { $width=480; }
9637: unless ($height) { $height=400; }
1.1031 www 9638: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 9639: unless ($transparency) { $transparency='true'; }
9640:
1.1074 raeburn 9641: my $target_attr;
9642: if (defined($target)) {
9643: $target_attr = 'target="'.$target.'"';
9644: }
9645: return <<"ENDLINK";
1.1336 raeburn 9646: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 9647: ENDLINK
1.1030 www 9648: }
9649:
1.1032 www 9650: sub modal_adhoc_script {
1.1365 raeburn 9651: my ($funcname,$width,$height,$content,$possmathjax)=@_;
9652: my $mathjax;
9653: if ($possmathjax) {
9654: $mathjax = <<'ENDJAX';
9655: if (typeof MathJax == 'object') {
9656: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
9657: }
9658: ENDJAX
9659: }
1.1032 www 9660: return (<<ENDADHOC);
1.1046 raeburn 9661: <script type="text/javascript">
1.1032 www 9662: // <![CDATA[
9663: var $funcname = function()
9664: {
9665: modalWindow.windowId = "myModal";
9666: modalWindow.width = $width;
9667: modalWindow.height = $height;
9668: modalWindow.content = '$content';
9669: modalWindow.open();
1.1365 raeburn 9670: $mathjax
1.1032 www 9671: };
9672: // ]]>
9673: </script>
9674: ENDADHOC
9675: }
9676:
1.1041 www 9677: sub modal_adhoc_inner {
1.1365 raeburn 9678: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 9679: my $innerwidth=$width-20;
9680: $content=&js_ready(
1.1140 raeburn 9681: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
9682: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
9683: $content.
1.1041 www 9684: &end_scrollbox().
1.1140 raeburn 9685: &end_page()
1.1041 www 9686: );
1.1365 raeburn 9687: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 9688: }
9689:
9690: sub modal_adhoc_window {
1.1365 raeburn 9691: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
9692: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 9693: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
9694: }
9695:
9696: sub modal_adhoc_launch {
9697: my ($funcname,$width,$height,$content)=@_;
9698: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
9699: <script type="text/javascript">
9700: // <![CDATA[
9701: $funcname();
9702: // ]]>
9703: </script>
9704: ENDLAUNCH
9705: }
9706:
9707: sub modal_adhoc_close {
9708: return (<<ENDCLOSE);
9709: <script type="text/javascript">
9710: // <![CDATA[
9711: modalWindow.close();
9712: // ]]>
9713: </script>
9714: ENDCLOSE
9715: }
9716:
1.1038 www 9717: sub togglebox_script {
9718: return(<<ENDTOGGLE);
9719: <script type="text/javascript">
9720: // <![CDATA[
9721: function LCtoggleDisplay(id,hidetext,showtext) {
9722: link = document.getElementById(id + "link").childNodes[0];
9723: with (document.getElementById(id).style) {
9724: if (display == "none" ) {
9725: display = "inline";
9726: link.nodeValue = hidetext;
9727: } else {
9728: display = "none";
9729: link.nodeValue = showtext;
9730: }
9731: }
9732: }
9733: // ]]>
9734: </script>
9735: ENDTOGGLE
9736: }
9737:
1.1039 www 9738: sub start_togglebox {
9739: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
9740: unless ($heading) { $heading=''; } else { $heading.=' '; }
9741: unless ($showtext) { $showtext=&mt('show'); }
9742: unless ($hidetext) { $hidetext=&mt('hide'); }
9743: unless ($headerbg) { $headerbg='#FFFFFF'; }
9744: return &start_data_table().
9745: &start_data_table_header_row().
9746: '<td bgcolor="'.$headerbg.'">'.$heading.
9747: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
9748: $showtext.'\')">'.$showtext.'</a>]</td>'.
9749: &end_data_table_header_row().
9750: '<tr id="'.$id.'" style="display:none""><td>';
9751: }
9752:
9753: sub end_togglebox {
9754: return '</td></tr>'.&end_data_table();
9755: }
9756:
1.1041 www 9757: sub LCprogressbar_script {
1.1302 raeburn 9758: my ($id,$number_to_do)=@_;
9759: if ($number_to_do) {
9760: return(<<ENDPROGRESS);
1.1041 www 9761: <script type="text/javascript">
9762: // <![CDATA[
1.1045 www 9763: \$('#progressbar$id').progressbar({
1.1041 www 9764: value: 0,
9765: change: function(event, ui) {
9766: var newVal = \$(this).progressbar('option', 'value');
9767: \$('.pblabel', this).text(LCprogressTxt);
9768: }
9769: });
9770: // ]]>
9771: </script>
9772: ENDPROGRESS
1.1302 raeburn 9773: } else {
9774: return(<<ENDPROGRESS);
9775: <script type="text/javascript">
9776: // <![CDATA[
9777: \$('#progressbar$id').progressbar({
9778: value: false,
9779: create: function(event, ui) {
9780: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
9781: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
9782: }
9783: });
9784: // ]]>
9785: </script>
9786: ENDPROGRESS
9787: }
1.1041 www 9788: }
9789:
9790: sub LCprogressbarUpdate_script {
9791: return(<<ENDPROGRESSUPDATE);
9792: <style type="text/css">
9793: .ui-progressbar { position:relative; }
1.1302 raeburn 9794: .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 9795: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
9796: </style>
9797: <script type="text/javascript">
9798: // <![CDATA[
1.1045 www 9799: var LCprogressTxt='---';
9800:
1.1302 raeburn 9801: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 9802: LCprogressTxt=progresstext;
1.1302 raeburn 9803: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
9804: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
9805: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 9806: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
9807: } else {
9808: \$('#progressbar'+id).progressbar('value',percent);
9809: }
1.1041 www 9810: }
9811: // ]]>
9812: </script>
9813: ENDPROGRESSUPDATE
9814: }
9815:
1.1042 www 9816: my $LClastpercent;
1.1045 www 9817: my $LCidcnt;
9818: my $LCcurrentid;
1.1042 www 9819:
1.1041 www 9820: sub LCprogressbar {
1.1302 raeburn 9821: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 9822: $LClastpercent=0;
1.1045 www 9823: $LCidcnt++;
9824: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 9825: my ($starting,$content);
9826: if ($number_to_do) {
9827: $starting=&mt('Starting');
9828: $content=(<<ENDPROGBAR);
9829: $preamble
1.1045 www 9830: <div id="progressbar$LCcurrentid">
1.1041 www 9831: <span class="pblabel">$starting</span>
9832: </div>
9833: ENDPROGBAR
1.1302 raeburn 9834: } else {
9835: $starting=&mt('Loading...');
9836: $LClastpercent='false';
9837: $content=(<<ENDPROGBAR);
9838: $preamble
9839: <div id="progressbar$LCcurrentid">
9840: <div class="progress-label">$starting</div>
9841: </div>
9842: ENDPROGBAR
9843: }
9844: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 9845: }
9846:
9847: sub LCprogressbarUpdate {
1.1302 raeburn 9848: my ($r,$val,$text,$number_to_do)=@_;
9849: if ($number_to_do) {
9850: unless ($val) {
9851: if ($LClastpercent) {
9852: $val=$LClastpercent;
9853: } else {
9854: $val=0;
9855: }
9856: }
9857: if ($val<0) { $val=0; }
9858: if ($val>100) { $val=0; }
9859: $LClastpercent=$val;
9860: unless ($text) { $text=$val.'%'; }
9861: } else {
9862: $val = 'false';
1.1042 www 9863: }
1.1041 www 9864: $text=&js_ready($text);
1.1044 www 9865: &r_print($r,<<ENDUPDATE);
1.1041 www 9866: <script type="text/javascript">
9867: // <![CDATA[
1.1302 raeburn 9868: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 9869: // ]]>
9870: </script>
9871: ENDUPDATE
1.1035 www 9872: }
9873:
1.1042 www 9874: sub LCprogressbarClose {
9875: my ($r)=@_;
9876: $LClastpercent=0;
1.1044 www 9877: &r_print($r,<<ENDCLOSE);
1.1042 www 9878: <script type="text/javascript">
9879: // <![CDATA[
1.1045 www 9880: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 9881: // ]]>
9882: </script>
9883: ENDCLOSE
1.1044 www 9884: }
9885:
9886: sub r_print {
9887: my ($r,$to_print)=@_;
9888: if ($r) {
9889: $r->print($to_print);
9890: $r->rflush();
9891: } else {
9892: print($to_print);
9893: }
1.1042 www 9894: }
9895:
1.320 albertel 9896: sub html_encode {
9897: my ($result) = @_;
9898:
1.322 albertel 9899: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 9900:
9901: return $result;
9902: }
1.1044 www 9903:
1.317 albertel 9904: sub js_ready {
9905: my ($result) = @_;
9906:
1.323 albertel 9907: $result =~ s/[\n\r]/ /xmsg;
9908: $result =~ s/\\/\\\\/xmsg;
9909: $result =~ s/'/\\'/xmsg;
1.372 albertel 9910: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 9911:
9912: return $result;
9913: }
9914:
1.315 albertel 9915: sub validate_page {
9916: if ( exists($env{'internal.start_page'})
1.316 albertel 9917: && $env{'internal.start_page'} > 1) {
9918: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 9919: $env{'internal.start_page'}.' '.
1.316 albertel 9920: $ENV{'request.filename'});
1.315 albertel 9921: }
9922: if ( exists($env{'internal.end_page'})
1.316 albertel 9923: && $env{'internal.end_page'} > 1) {
9924: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 9925: $env{'internal.end_page'}.' '.
1.316 albertel 9926: $env{'request.filename'});
1.315 albertel 9927: }
9928: if ( exists($env{'internal.start_page'})
9929: && ! exists($env{'internal.end_page'})) {
1.316 albertel 9930: &Apache::lonnet::logthis('start_page called without end_page '.
9931: $env{'request.filename'});
1.315 albertel 9932: }
9933: if ( ! exists($env{'internal.start_page'})
9934: && exists($env{'internal.end_page'})) {
1.316 albertel 9935: &Apache::lonnet::logthis('end_page called without start_page'.
9936: $env{'request.filename'});
1.315 albertel 9937: }
1.306 albertel 9938: }
1.315 albertel 9939:
1.996 www 9940:
9941: sub start_scrollbox {
1.1140 raeburn 9942: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 9943: unless ($outerwidth) { $outerwidth='520px'; }
9944: unless ($width) { $width='500px'; }
9945: unless ($height) { $height='200px'; }
1.1075 raeburn 9946: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 9947: if ($id ne '') {
1.1140 raeburn 9948: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 9949: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 9950: }
1.1075 raeburn 9951: if ($bgcolor ne '') {
9952: $tdcol = "background-color: $bgcolor;";
9953: }
1.1137 raeburn 9954: my $nicescroll_js;
9955: if ($env{'browser.mobile'}) {
1.1140 raeburn 9956: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
9957: }
9958: return <<"END";
9959: $nicescroll_js
9960:
9961: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
9962: <div style="overflow:auto; width:$width; height:$height;"$div_id>
9963: END
9964: }
9965:
9966: sub end_scrollbox {
9967: return '</div></td></tr></table>';
9968: }
9969:
9970: sub nicescroll_javascript {
9971: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
9972: my %options;
9973: if (ref($cursor) eq 'HASH') {
9974: %options = %{$cursor};
9975: }
9976: unless ($options{'railalign'} =~ /^left|right$/) {
9977: $options{'railalign'} = 'left';
9978: }
9979: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9980: my $function = &get_users_function();
9981: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 9982: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 9983: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 9984: }
1.1140 raeburn 9985: }
9986: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
9987: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 9988: $options{'cursoropacity'}='1.0';
9989: }
1.1140 raeburn 9990: } else {
9991: $options{'cursoropacity'}='1.0';
9992: }
9993: if ($options{'cursorfixedheight'} eq 'none') {
9994: delete($options{'cursorfixedheight'});
9995: } else {
9996: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
9997: }
9998: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
9999: delete($options{'railoffset'});
10000: }
10001: my @niceoptions;
10002: while (my($key,$value) = each(%options)) {
10003: if ($value =~ /^\{.+\}$/) {
10004: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10005: } else {
1.1140 raeburn 10006: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10007: }
1.1140 raeburn 10008: }
10009: my $nicescroll_js = '
1.1137 raeburn 10010: $(document).ready(
1.1140 raeburn 10011: function() {
10012: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10013: }
1.1137 raeburn 10014: );
10015: ';
1.1140 raeburn 10016: if ($framecheck) {
10017: $nicescroll_js .= '
10018: function expand_div(caller) {
10019: if (top === self) {
10020: document.getElementById("'.$id.'").style.width = "auto";
10021: document.getElementById("'.$id.'").style.height = "auto";
10022: } else {
10023: try {
10024: if (parent.frames) {
10025: if (parent.frames.length > 1) {
10026: var framesrc = parent.frames[1].location.href;
10027: var currsrc = framesrc.replace(/\#.*$/,"");
10028: if ((caller == "search") || (currsrc == "'.$location.'")) {
10029: document.getElementById("'.$id.'").style.width = "auto";
10030: document.getElementById("'.$id.'").style.height = "auto";
10031: }
10032: }
10033: }
10034: } catch (e) {
10035: return;
10036: }
1.1137 raeburn 10037: }
1.1140 raeburn 10038: return;
1.996 www 10039: }
1.1140 raeburn 10040: ';
10041: }
10042: if ($needjsready) {
10043: $nicescroll_js = '
10044: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10045: } else {
10046: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10047: }
10048: return $nicescroll_js;
1.996 www 10049: }
10050:
1.318 albertel 10051: sub simple_error_page {
1.1150 bisitz 10052: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10053: my %displayargs;
1.1151 raeburn 10054: if (ref($args) eq 'HASH') {
10055: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10056: if ($args->{'only_body'}) {
10057: $displayargs{'only_body'} = 1;
10058: }
10059: if ($args->{'no_nav_bar'}) {
10060: $displayargs{'no_nav_bar'} = 1;
10061: }
1.1151 raeburn 10062: } else {
10063: $msg = &mt($msg);
10064: }
1.1150 bisitz 10065:
1.318 albertel 10066: my $page =
1.1304 raeburn 10067: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10068: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10069: &Apache::loncommon::end_page();
10070: if (ref($r)) {
10071: $r->print($page);
1.327 albertel 10072: return;
1.318 albertel 10073: }
10074: return $page;
10075: }
1.347 albertel 10076:
10077: {
1.610 albertel 10078: my @row_count;
1.961 onken 10079:
10080: sub start_data_table_count {
10081: unshift(@row_count, 0);
10082: return;
10083: }
10084:
10085: sub end_data_table_count {
10086: shift(@row_count);
10087: return;
10088: }
10089:
1.347 albertel 10090: sub start_data_table {
1.1018 raeburn 10091: my ($add_class,$id) = @_;
1.422 albertel 10092: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10093: my $table_id;
10094: if (defined($id)) {
10095: $table_id = ' id="'.$id.'"';
10096: }
1.961 onken 10097: &start_data_table_count();
1.1018 raeburn 10098: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10099: }
10100:
10101: sub end_data_table {
1.961 onken 10102: &end_data_table_count();
1.389 albertel 10103: return '</table>'."\n";;
1.347 albertel 10104: }
10105:
10106: sub start_data_table_row {
1.974 wenzelju 10107: my ($add_class, $id) = @_;
1.610 albertel 10108: $row_count[0]++;
10109: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10110: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10111: $id = (' id="'.$id.'"') unless ($id eq '');
10112: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10113: }
1.471 banghart 10114:
10115: sub continue_data_table_row {
1.974 wenzelju 10116: my ($add_class, $id) = @_;
1.610 albertel 10117: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10118: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10119: $id = (' id="'.$id.'"') unless ($id eq '');
10120: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10121: }
1.347 albertel 10122:
10123: sub end_data_table_row {
1.389 albertel 10124: return '</tr>'."\n";;
1.347 albertel 10125: }
1.367 www 10126:
1.421 albertel 10127: sub start_data_table_empty_row {
1.707 bisitz 10128: # $row_count[0]++;
1.421 albertel 10129: return '<tr class="LC_empty_row" >'."\n";;
10130: }
10131:
10132: sub end_data_table_empty_row {
10133: return '</tr>'."\n";;
10134: }
10135:
1.367 www 10136: sub start_data_table_header_row {
1.389 albertel 10137: return '<tr class="LC_header_row">'."\n";;
1.367 www 10138: }
10139:
10140: sub end_data_table_header_row {
1.389 albertel 10141: return '</tr>'."\n";;
1.367 www 10142: }
1.890 droeschl 10143:
10144: sub data_table_caption {
10145: my $caption = shift;
10146: return "<caption class=\"LC_caption\">$caption</caption>";
10147: }
1.347 albertel 10148: }
10149:
1.548 albertel 10150: =pod
10151:
10152: =item * &inhibit_menu_check($arg)
10153:
10154: Checks for a inhibitmenu state and generates output to preserve it
10155:
10156: Inputs: $arg - can be any of
10157: - undef - in which case the return value is a string
10158: to add into arguments list of a uri
10159: - 'input' - in which case the return value is a HTML
10160: <form> <input> field of type hidden to
10161: preserve the value
10162: - a url - in which case the return value is the url with
10163: the neccesary cgi args added to preserve the
10164: inhibitmenu state
10165: - a ref to a url - no return value, but the string is
10166: updated to include the neccessary cgi
10167: args to preserve the inhibitmenu state
10168:
10169: =cut
10170:
10171: sub inhibit_menu_check {
10172: my ($arg) = @_;
10173: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10174: if ($arg eq 'input') {
10175: if ($env{'form.inhibitmenu'}) {
10176: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10177: } else {
10178: return
10179: }
10180: }
10181: if ($env{'form.inhibitmenu'}) {
10182: if (ref($arg)) {
10183: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10184: } elsif ($arg eq '') {
10185: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10186: } else {
10187: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10188: }
10189: }
10190: if (!ref($arg)) {
10191: return $arg;
10192: }
10193: }
10194:
1.251 albertel 10195: ###############################################
1.182 matthew 10196:
10197: =pod
10198:
1.549 albertel 10199: =back
10200:
10201: =head1 User Information Routines
10202:
10203: =over 4
10204:
1.405 albertel 10205: =item * &get_users_function()
1.182 matthew 10206:
10207: Used by &bodytag to determine the current users primary role.
10208: Returns either 'student','coordinator','admin', or 'author'.
10209:
10210: =cut
10211:
10212: ###############################################
10213: sub get_users_function {
1.815 tempelho 10214: my $function = 'norole';
1.818 tempelho 10215: if ($env{'request.role'}=~/^(st)/) {
10216: $function='student';
10217: }
1.907 raeburn 10218: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10219: $function='coordinator';
10220: }
1.258 albertel 10221: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10222: $function='admin';
10223: }
1.826 bisitz 10224: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10225: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10226: $function='author';
10227: }
10228: return $function;
1.54 www 10229: }
1.99 www 10230:
10231: ###############################################
10232:
1.233 raeburn 10233: =pod
10234:
1.821 raeburn 10235: =item * &show_course()
10236:
10237: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10238: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10239:
10240: Inputs:
10241: None
10242:
10243: Outputs:
10244: Scalar: 1 if 'Course' to be used, 0 otherwise.
10245:
10246: =cut
10247:
10248: ###############################################
10249: sub show_course {
10250: my $course = !$env{'user.adv'};
10251: if (!$env{'user.adv'}) {
10252: foreach my $env (keys(%env)) {
10253: next if ($env !~ m/^user\.priv\./);
10254: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10255: $course = 0;
10256: last;
10257: }
10258: }
10259: }
10260: return $course;
10261: }
10262:
10263: ###############################################
10264:
10265: =pod
10266:
1.542 raeburn 10267: =item * &check_user_status()
1.274 raeburn 10268:
10269: Determines current status of supplied role for a
10270: specific user. Roles can be active, previous or future.
10271:
10272: Inputs:
10273: user's domain, user's username, course's domain,
1.375 raeburn 10274: course's number, optional section ID.
1.274 raeburn 10275:
10276: Outputs:
10277: role status: active, previous or future.
10278:
10279: =cut
10280:
10281: sub check_user_status {
1.412 raeburn 10282: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10283: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10284: my @uroles = keys(%userinfo);
1.274 raeburn 10285: my $srchstr;
10286: my $active_chk = 'none';
1.412 raeburn 10287: my $now = time;
1.274 raeburn 10288: if (@uroles > 0) {
1.908 raeburn 10289: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10290: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10291: } else {
1.412 raeburn 10292: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10293: }
10294: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10295: my $role_end = 0;
10296: my $role_start = 0;
10297: $active_chk = 'active';
1.412 raeburn 10298: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10299: $role_end = $1;
10300: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10301: $role_start = $1;
1.274 raeburn 10302: }
10303: }
10304: if ($role_start > 0) {
1.412 raeburn 10305: if ($now < $role_start) {
1.274 raeburn 10306: $active_chk = 'future';
10307: }
10308: }
10309: if ($role_end > 0) {
1.412 raeburn 10310: if ($now > $role_end) {
1.274 raeburn 10311: $active_chk = 'previous';
10312: }
10313: }
10314: }
10315: }
10316: return $active_chk;
10317: }
10318:
10319: ###############################################
10320:
10321: =pod
10322:
1.405 albertel 10323: =item * &get_sections()
1.233 raeburn 10324:
10325: Determines all the sections for a course including
10326: sections with students and sections containing other roles.
1.419 raeburn 10327: Incoming parameters:
10328:
10329: 1. domain
10330: 2. course number
10331: 3. reference to array containing roles for which sections should
10332: be gathered (optional).
10333: 4. reference to array containing status types for which sections
10334: should be gathered (optional).
10335:
10336: If the third argument is undefined, sections are gathered for any role.
10337: If the fourth argument is undefined, sections are gathered for any status.
10338: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10339:
1.374 raeburn 10340: Returns section hash (keys are section IDs, values are
10341: number of users in each section), subject to the
1.419 raeburn 10342: optional roles filter, optional status filter
1.233 raeburn 10343:
10344: =cut
10345:
10346: ###############################################
10347: sub get_sections {
1.419 raeburn 10348: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 10349: if (!defined($cdom) || !defined($cnum)) {
10350: my $cid = $env{'request.course.id'};
10351:
10352: return if (!defined($cid));
10353:
10354: $cdom = $env{'course.'.$cid.'.domain'};
10355: $cnum = $env{'course.'.$cid.'.num'};
10356: }
10357:
10358: my %sectioncount;
1.419 raeburn 10359: my $now = time;
1.240 albertel 10360:
1.1118 raeburn 10361: my $check_students = 1;
10362: my $only_students = 0;
10363: if (ref($possible_roles) eq 'ARRAY') {
10364: if (grep(/^st$/,@{$possible_roles})) {
10365: if (@{$possible_roles} == 1) {
10366: $only_students = 1;
10367: }
10368: } else {
10369: $check_students = 0;
10370: }
10371: }
10372:
10373: if ($check_students) {
1.276 albertel 10374: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 10375: my $sec_index = &Apache::loncoursedata::CL_SECTION();
10376: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 10377: my $start_index = &Apache::loncoursedata::CL_START();
10378: my $end_index = &Apache::loncoursedata::CL_END();
10379: my $status;
1.366 albertel 10380: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 10381: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
10382: $data->[$status_index],
10383: $data->[$start_index],
10384: $data->[$end_index]);
10385: if ($stu_status eq 'Active') {
10386: $status = 'active';
10387: } elsif ($end < $now) {
10388: $status = 'previous';
10389: } elsif ($start > $now) {
10390: $status = 'future';
10391: }
10392: if ($section ne '-1' && $section !~ /^\s*$/) {
10393: if ((!defined($possible_status)) || (($status ne '') &&
10394: (grep/^\Q$status\E$/,@{$possible_status}))) {
10395: $sectioncount{$section}++;
10396: }
1.240 albertel 10397: }
10398: }
10399: }
1.1118 raeburn 10400: if ($only_students) {
10401: return %sectioncount;
10402: }
1.240 albertel 10403: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10404: foreach my $user (sort(keys(%courseroles))) {
10405: if ($user !~ /^(\w{2})/) { next; }
10406: my ($role) = ($user =~ /^(\w{2})/);
10407: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 10408: my ($section,$status);
1.240 albertel 10409: if ($role eq 'cr' &&
10410: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
10411: $section=$1;
10412: }
10413: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
10414: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 10415: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
10416: if ($end == -1 && $start == -1) {
10417: next; #deleted role
10418: }
10419: if (!defined($possible_status)) {
10420: $sectioncount{$section}++;
10421: } else {
10422: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
10423: $status = 'active';
10424: } elsif ($end < $now) {
10425: $status = 'future';
10426: } elsif ($start > $now) {
10427: $status = 'previous';
10428: }
10429: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
10430: $sectioncount{$section}++;
10431: }
10432: }
1.233 raeburn 10433: }
1.366 albertel 10434: return %sectioncount;
1.233 raeburn 10435: }
10436:
1.274 raeburn 10437: ###############################################
1.294 raeburn 10438:
10439: =pod
1.405 albertel 10440:
10441: =item * &get_course_users()
10442:
1.275 raeburn 10443: Retrieves usernames:domains for users in the specified course
10444: with specific role(s), and access status.
10445:
10446: Incoming parameters:
1.277 albertel 10447: 1. course domain
10448: 2. course number
10449: 3. access status: users must have - either active,
1.275 raeburn 10450: previous, future, or all.
1.277 albertel 10451: 4. reference to array of permissible roles
1.288 raeburn 10452: 5. reference to array of section restrictions (optional)
10453: 6. reference to results object (hash of hashes).
10454: 7. reference to optional userdata hash
1.609 raeburn 10455: 8. reference to optional statushash
1.630 raeburn 10456: 9. flag if privileged users (except those set to unhide in
10457: course settings) should be excluded
1.609 raeburn 10458: Keys of top level results hash are roles.
1.275 raeburn 10459: Keys of inner hashes are username:domain, with
10460: values set to access type.
1.288 raeburn 10461: Optional userdata hash returns an array with arguments in the
10462: same order as loncoursedata::get_classlist() for student data.
10463:
1.609 raeburn 10464: Optional statushash returns
10465:
1.288 raeburn 10466: Entries for end, start, section and status are blank because
10467: of the possibility of multiple values for non-student roles.
10468:
1.275 raeburn 10469: =cut
1.405 albertel 10470:
1.275 raeburn 10471: ###############################################
1.405 albertel 10472:
1.275 raeburn 10473: sub get_course_users {
1.630 raeburn 10474: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 10475: my %idx = ();
1.419 raeburn 10476: my %seclists;
1.288 raeburn 10477:
10478: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
10479: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
10480: $idx{end} = &Apache::loncoursedata::CL_END();
10481: $idx{start} = &Apache::loncoursedata::CL_START();
10482: $idx{id} = &Apache::loncoursedata::CL_ID();
10483: $idx{section} = &Apache::loncoursedata::CL_SECTION();
10484: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
10485: $idx{status} = &Apache::loncoursedata::CL_STATUS();
10486:
1.290 albertel 10487: if (grep(/^st$/,@{$roles})) {
1.276 albertel 10488: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 10489: my $now = time;
1.277 albertel 10490: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 10491: my $match = 0;
1.412 raeburn 10492: my $secmatch = 0;
1.419 raeburn 10493: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 10494: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 10495: if ($section eq '') {
10496: $section = 'none';
10497: }
1.291 albertel 10498: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10499: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10500: $secmatch = 1;
10501: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 10502: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10503: $secmatch = 1;
10504: }
10505: } else {
1.419 raeburn 10506: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 10507: $secmatch = 1;
10508: }
1.290 albertel 10509: }
1.412 raeburn 10510: if (!$secmatch) {
10511: next;
10512: }
1.419 raeburn 10513: }
1.275 raeburn 10514: if (defined($$types{'active'})) {
1.288 raeburn 10515: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 10516: push(@{$$users{st}{$student}},'active');
1.288 raeburn 10517: $match = 1;
1.275 raeburn 10518: }
10519: }
10520: if (defined($$types{'previous'})) {
1.609 raeburn 10521: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 10522: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 10523: $match = 1;
1.275 raeburn 10524: }
10525: }
10526: if (defined($$types{'future'})) {
1.609 raeburn 10527: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 10528: push(@{$$users{st}{$student}},'future');
1.288 raeburn 10529: $match = 1;
1.275 raeburn 10530: }
10531: }
1.609 raeburn 10532: if ($match) {
10533: push(@{$seclists{$student}},$section);
10534: if (ref($userdata) eq 'HASH') {
10535: $$userdata{$student} = $$classlist{$student};
10536: }
10537: if (ref($statushash) eq 'HASH') {
10538: $statushash->{$student}{'st'}{$section} = $status;
10539: }
1.288 raeburn 10540: }
1.275 raeburn 10541: }
10542: }
1.412 raeburn 10543: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 10544: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10545: my $now = time;
1.609 raeburn 10546: my %displaystatus = ( previous => 'Expired',
10547: active => 'Active',
10548: future => 'Future',
10549: );
1.1121 raeburn 10550: my (%nothide,@possdoms);
1.630 raeburn 10551: if ($hidepriv) {
10552: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
10553: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
10554: if ($user !~ /:/) {
10555: $nothide{join(':',split(/[\@]/,$user))}=1;
10556: } else {
10557: $nothide{$user} = 1;
10558: }
10559: }
1.1121 raeburn 10560: my @possdoms = ($cdom);
10561: if ($coursehash{'checkforpriv'}) {
10562: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
10563: }
1.630 raeburn 10564: }
1.439 raeburn 10565: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 10566: my $match = 0;
1.412 raeburn 10567: my $secmatch = 0;
1.439 raeburn 10568: my $status;
1.412 raeburn 10569: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 10570: $user =~ s/:$//;
1.439 raeburn 10571: my ($end,$start) = split(/:/,$coursepersonnel{$person});
10572: if ($end == -1 || $start == -1) {
10573: next;
10574: }
10575: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
10576: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 10577: my ($uname,$udom) = split(/:/,$user);
10578: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10579: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10580: $secmatch = 1;
10581: } elsif ($usec eq '') {
1.420 albertel 10582: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10583: $secmatch = 1;
10584: }
10585: } else {
10586: if (grep(/^\Q$usec\E$/,@{$sections})) {
10587: $secmatch = 1;
10588: }
10589: }
10590: if (!$secmatch) {
10591: next;
10592: }
1.288 raeburn 10593: }
1.419 raeburn 10594: if ($usec eq '') {
10595: $usec = 'none';
10596: }
1.275 raeburn 10597: if ($uname ne '' && $udom ne '') {
1.630 raeburn 10598: if ($hidepriv) {
1.1121 raeburn 10599: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 10600: (!$nothide{$uname.':'.$udom})) {
10601: next;
10602: }
10603: }
1.503 raeburn 10604: if ($end > 0 && $end < $now) {
1.439 raeburn 10605: $status = 'previous';
10606: } elsif ($start > $now) {
10607: $status = 'future';
10608: } else {
10609: $status = 'active';
10610: }
1.277 albertel 10611: foreach my $type (keys(%{$types})) {
1.275 raeburn 10612: if ($status eq $type) {
1.420 albertel 10613: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 10614: push(@{$$users{$role}{$user}},$type);
10615: }
1.288 raeburn 10616: $match = 1;
10617: }
10618: }
1.419 raeburn 10619: if (($match) && (ref($userdata) eq 'HASH')) {
10620: if (!exists($$userdata{$uname.':'.$udom})) {
10621: &get_user_info($udom,$uname,\%idx,$userdata);
10622: }
1.420 albertel 10623: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 10624: push(@{$seclists{$uname.':'.$udom}},$usec);
10625: }
1.609 raeburn 10626: if (ref($statushash) eq 'HASH') {
10627: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
10628: }
1.275 raeburn 10629: }
10630: }
10631: }
10632: }
1.290 albertel 10633: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 10634: if ((defined($cdom)) && (defined($cnum))) {
10635: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
10636: if ( defined($csettings{'internal.courseowner'}) ) {
10637: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 10638: next if ($owner eq '');
10639: my ($ownername,$ownerdom);
10640: if ($owner =~ /^([^:]+):([^:]+)$/) {
10641: $ownername = $1;
10642: $ownerdom = $2;
10643: } else {
10644: $ownername = $owner;
10645: $ownerdom = $cdom;
10646: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 10647: }
10648: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 10649: if (defined($userdata) &&
1.609 raeburn 10650: !exists($$userdata{$owner})) {
10651: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
10652: if (!grep(/^none$/,@{$seclists{$owner}})) {
10653: push(@{$seclists{$owner}},'none');
10654: }
10655: if (ref($statushash) eq 'HASH') {
10656: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 10657: }
1.290 albertel 10658: }
1.279 raeburn 10659: }
10660: }
10661: }
1.419 raeburn 10662: foreach my $user (keys(%seclists)) {
10663: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
10664: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
10665: }
1.275 raeburn 10666: }
10667: return;
10668: }
10669:
1.288 raeburn 10670: sub get_user_info {
10671: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 10672: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
10673: &plainname($uname,$udom,'lastname');
1.291 albertel 10674: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 10675: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 10676: my %idhash = &Apache::lonnet::idrget($udom,($uname));
10677: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 10678: return;
10679: }
1.275 raeburn 10680:
1.472 raeburn 10681: ###############################################
10682:
10683: =pod
10684:
10685: =item * &get_user_quota()
10686:
1.1134 raeburn 10687: Retrieves quota assigned for storage of user files.
10688: Default is to report quota for portfolio files.
1.472 raeburn 10689:
10690: Incoming parameters:
10691: 1. user's username
10692: 2. user's domain
1.1134 raeburn 10693: 3. quota name - portfolio, author, or course
1.1136 raeburn 10694: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 10695: 4. crstype - official, unofficial, textbook, placement or community,
10696: if quota name is course
1.472 raeburn 10697:
10698: Returns:
1.1163 raeburn 10699: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 10700: 2. (Optional) Type of setting: custom or default
10701: (individually assigned or default for user's
10702: institutional status).
10703: 3. (Optional) - User's institutional status (e.g., faculty, staff
10704: or student - types as defined in localenroll::inst_usertypes
10705: for user's domain, which determines default quota for user.
10706: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 10707:
10708: If a value has been stored in the user's environment,
1.536 raeburn 10709: it will return that, otherwise it returns the maximal default
1.1134 raeburn 10710: defined for the user's institutional status(es) in the domain.
1.472 raeburn 10711:
10712: =cut
10713:
10714: ###############################################
10715:
10716:
10717: sub get_user_quota {
1.1136 raeburn 10718: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 10719: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 10720: if (!defined($udom)) {
10721: $udom = $env{'user.domain'};
10722: }
10723: if (!defined($uname)) {
10724: $uname = $env{'user.name'};
10725: }
10726: if (($udom eq '' || $uname eq '') ||
10727: ($udom eq 'public') && ($uname eq 'public')) {
10728: $quota = 0;
1.536 raeburn 10729: $quotatype = 'default';
10730: $defquota = 0;
1.472 raeburn 10731: } else {
1.536 raeburn 10732: my $inststatus;
1.1134 raeburn 10733: if ($quotaname eq 'course') {
10734: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
10735: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
10736: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
10737: } else {
10738: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
10739: $quota = $cenv{'internal.uploadquota'};
10740: }
1.536 raeburn 10741: } else {
1.1134 raeburn 10742: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
10743: if ($quotaname eq 'author') {
10744: $quota = $env{'environment.authorquota'};
10745: } else {
10746: $quota = $env{'environment.portfolioquota'};
10747: }
10748: $inststatus = $env{'environment.inststatus'};
10749: } else {
10750: my %userenv =
10751: &Apache::lonnet::get('environment',['portfolioquota',
10752: 'authorquota','inststatus'],$udom,$uname);
10753: my ($tmp) = keys(%userenv);
10754: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10755: if ($quotaname eq 'author') {
10756: $quota = $userenv{'authorquota'};
10757: } else {
10758: $quota = $userenv{'portfolioquota'};
10759: }
10760: $inststatus = $userenv{'inststatus'};
10761: } else {
10762: undef(%userenv);
10763: }
10764: }
10765: }
10766: if ($quota eq '' || wantarray) {
10767: if ($quotaname eq 'course') {
10768: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 10769: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 10770: ($crstype eq 'community') || ($crstype eq 'textbook') ||
10771: ($crstype eq 'placement')) {
1.1136 raeburn 10772: $defquota = $domdefs{$crstype.'quota'};
10773: }
10774: if ($defquota eq '') {
10775: $defquota = 500;
10776: }
1.1134 raeburn 10777: } else {
10778: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
10779: }
10780: if ($quota eq '') {
10781: $quota = $defquota;
10782: $quotatype = 'default';
10783: } else {
10784: $quotatype = 'custom';
10785: }
1.472 raeburn 10786: }
10787: }
1.536 raeburn 10788: if (wantarray) {
10789: return ($quota,$quotatype,$settingstatus,$defquota);
10790: } else {
10791: return $quota;
10792: }
1.472 raeburn 10793: }
10794:
10795: ###############################################
10796:
10797: =pod
10798:
10799: =item * &default_quota()
10800:
1.536 raeburn 10801: Retrieves default quota assigned for storage of user portfolio files,
10802: given an (optional) user's institutional status.
1.472 raeburn 10803:
10804: Incoming parameters:
1.1142 raeburn 10805:
1.472 raeburn 10806: 1. domain
1.536 raeburn 10807: 2. (Optional) institutional status(es). This is a : separated list of
10808: status types (e.g., faculty, staff, student etc.)
10809: which apply to the user for whom the default is being retrieved.
10810: If the institutional status string in undefined, the domain
1.1134 raeburn 10811: default quota will be returned.
10812: 3. quota name - portfolio, author, or course
10813: (if no quota name provided, defaults to portfolio).
1.472 raeburn 10814:
10815: Returns:
1.1142 raeburn 10816:
1.1163 raeburn 10817: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 10818: 2. (Optional) institutional type which determined the value of the
10819: default quota.
1.472 raeburn 10820:
10821: If a value has been stored in the domain's configuration db,
10822: it will return that, otherwise it returns 20 (for backwards
10823: compatibility with domains which have not set up a configuration
1.1163 raeburn 10824: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 10825:
1.536 raeburn 10826: If the user's status includes multiple types (e.g., staff and student),
10827: the largest default quota which applies to the user determines the
10828: default quota returned.
10829:
1.472 raeburn 10830: =cut
10831:
10832: ###############################################
10833:
10834:
10835: sub default_quota {
1.1134 raeburn 10836: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 10837: my ($defquota,$settingstatus);
10838: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 10839: ['quotas'],$udom);
1.1134 raeburn 10840: my $key = 'defaultquota';
10841: if ($quotaname eq 'author') {
10842: $key = 'authorquota';
10843: }
1.622 raeburn 10844: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 10845: if ($inststatus ne '') {
1.765 raeburn 10846: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 10847: foreach my $item (@statuses) {
1.1134 raeburn 10848: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10849: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 10850: if ($defquota eq '') {
1.1134 raeburn 10851: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10852: $settingstatus = $item;
1.1134 raeburn 10853: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
10854: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10855: $settingstatus = $item;
10856: }
10857: }
1.1134 raeburn 10858: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10859: if ($quotahash{'quotas'}{$item} ne '') {
10860: if ($defquota eq '') {
10861: $defquota = $quotahash{'quotas'}{$item};
10862: $settingstatus = $item;
10863: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
10864: $defquota = $quotahash{'quotas'}{$item};
10865: $settingstatus = $item;
10866: }
1.536 raeburn 10867: }
10868: }
10869: }
10870: }
10871: if ($defquota eq '') {
1.1134 raeburn 10872: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10873: $defquota = $quotahash{'quotas'}{$key}{'default'};
10874: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10875: $defquota = $quotahash{'quotas'}{'default'};
10876: }
1.536 raeburn 10877: $settingstatus = 'default';
1.1139 raeburn 10878: if ($defquota eq '') {
10879: if ($quotaname eq 'author') {
10880: $defquota = 500;
10881: }
10882: }
1.536 raeburn 10883: }
10884: } else {
10885: $settingstatus = 'default';
1.1134 raeburn 10886: if ($quotaname eq 'author') {
10887: $defquota = 500;
10888: } else {
10889: $defquota = 20;
10890: }
1.536 raeburn 10891: }
10892: if (wantarray) {
10893: return ($defquota,$settingstatus);
1.472 raeburn 10894: } else {
1.536 raeburn 10895: return $defquota;
1.472 raeburn 10896: }
10897: }
10898:
1.1135 raeburn 10899: ###############################################
10900:
10901: =pod
10902:
1.1136 raeburn 10903: =item * &excess_filesize_warning()
1.1135 raeburn 10904:
10905: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 10906: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 10907: space to be exceeded.
1.1136 raeburn 10908:
10909: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 10910: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 10911:
1.1165 raeburn 10912: Inputs: 7
1.1136 raeburn 10913: 1. username or coursenum
1.1135 raeburn 10914: 2. domain
1.1136 raeburn 10915: 3. context ('author' or 'course')
1.1135 raeburn 10916: 4. filename of file for which action is being requested
10917: 5. filesize (kB) of file
10918: 6. action being taken: copy or upload.
1.1237 raeburn 10919: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 10920:
10921: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 10922: otherwise return null.
10923:
10924: =back
1.1135 raeburn 10925:
10926: =cut
10927:
1.1136 raeburn 10928: sub excess_filesize_warning {
1.1165 raeburn 10929: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 10930: my $current_disk_usage = 0;
1.1165 raeburn 10931: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 10932: if ($context eq 'author') {
10933: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
10934: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
10935: } else {
10936: foreach my $subdir ('docs','supplemental') {
10937: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
10938: }
10939: }
1.1135 raeburn 10940: $disk_quota = int($disk_quota * 1000);
10941: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 10942: return '<p class="LC_warning">'.
1.1135 raeburn 10943: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 10944: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
10945: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 10946: $disk_quota,$current_disk_usage).
10947: '</p>';
10948: }
10949: return;
10950: }
10951:
10952: ###############################################
10953:
10954:
1.1136 raeburn 10955:
10956:
1.384 raeburn 10957: sub get_secgrprole_info {
10958: my ($cdom,$cnum,$needroles,$type) = @_;
10959: my %sections_count = &get_sections($cdom,$cnum);
10960: my @sections = (sort {$a <=> $b} keys(%sections_count));
10961: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
10962: my @groups = sort(keys(%curr_groups));
10963: my $allroles = [];
10964: my $rolehash;
10965: my $accesshash = {
10966: active => 'Currently has access',
10967: future => 'Will have future access',
10968: previous => 'Previously had access',
10969: };
10970: if ($needroles) {
10971: $rolehash = {'all' => 'all'};
1.385 albertel 10972: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10973: if (&Apache::lonnet::error(%user_roles)) {
10974: undef(%user_roles);
10975: }
10976: foreach my $item (keys(%user_roles)) {
1.384 raeburn 10977: my ($role)=split(/\:/,$item,2);
10978: if ($role eq 'cr') { next; }
10979: if ($role =~ /^cr/) {
10980: $$rolehash{$role} = (split('/',$role))[3];
10981: } else {
10982: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
10983: }
10984: }
10985: foreach my $key (sort(keys(%{$rolehash}))) {
10986: push(@{$allroles},$key);
10987: }
10988: push (@{$allroles},'st');
10989: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
10990: }
10991: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
10992: }
10993:
1.555 raeburn 10994: sub user_picker {
1.1279 raeburn 10995: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 10996: my $currdom = $dom;
1.1253 raeburn 10997: my @alldoms = &Apache::lonnet::all_domains();
10998: if (@alldoms == 1) {
10999: my %domsrch = &Apache::lonnet::get_dom('configuration',
11000: ['directorysrch'],$alldoms[0]);
11001: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11002: my $showdom = $domdesc;
11003: if ($showdom eq '') {
11004: $showdom = $dom;
11005: }
11006: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11007: if ((!$domsrch{'directorysrch'}{'available'}) &&
11008: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11009: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11010: }
11011: }
11012: }
1.555 raeburn 11013: my %curr_selected = (
11014: srchin => 'dom',
1.580 raeburn 11015: srchby => 'lastname',
1.555 raeburn 11016: );
11017: my $srchterm;
1.625 raeburn 11018: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11019: if ($srch->{'srchby'} ne '') {
11020: $curr_selected{'srchby'} = $srch->{'srchby'};
11021: }
11022: if ($srch->{'srchin'} ne '') {
11023: $curr_selected{'srchin'} = $srch->{'srchin'};
11024: }
11025: if ($srch->{'srchtype'} ne '') {
11026: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11027: }
11028: if ($srch->{'srchdomain'} ne '') {
11029: $currdom = $srch->{'srchdomain'};
11030: }
11031: $srchterm = $srch->{'srchterm'};
11032: }
1.1222 damieng 11033: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11034: 'usr' => 'Search criteria',
1.563 raeburn 11035: 'doma' => 'Domain/institution to search',
1.558 albertel 11036: 'uname' => 'username',
11037: 'lastname' => 'last name',
1.555 raeburn 11038: 'lastfirst' => 'last name, first name',
1.558 albertel 11039: 'crs' => 'in this course',
1.576 raeburn 11040: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11041: 'alc' => 'all LON-CAPA',
1.573 raeburn 11042: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11043: 'exact' => 'is',
11044: 'contains' => 'contains',
1.569 raeburn 11045: 'begins' => 'begins with',
1.1222 damieng 11046: );
11047: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11048: 'youm' => "You must include some text to search for.",
11049: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11050: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11051: 'yomc' => "You must choose a domain when using an institutional directory search.",
11052: 'ymcd' => "You must choose a domain when using a domain search.",
11053: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11054: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11055: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11056: );
1.1222 damieng 11057: &html_escape(\%html_lt);
11058: &js_escape(\%js_lt);
1.1255 raeburn 11059: my $domform;
1.1277 raeburn 11060: my $allow_blank = 1;
1.1255 raeburn 11061: if ($fixeddom) {
1.1277 raeburn 11062: $allow_blank = 0;
11063: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11064: } else {
1.1287 raeburn 11065: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11066: my ($trusted,$untrusted);
1.1287 raeburn 11067: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11068: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11069: } elsif ($context eq 'author') {
1.1288 raeburn 11070: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11071: } elsif ($context eq 'domain') {
1.1288 raeburn 11072: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11073: }
1.1288 raeburn 11074: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11075: }
1.563 raeburn 11076: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11077:
11078: my @srchins = ('crs','dom','alc','instd');
11079:
11080: foreach my $option (@srchins) {
11081: # FIXME 'alc' option unavailable until
11082: # loncreateuser::print_user_query_page()
11083: # has been completed.
11084: next if ($option eq 'alc');
1.880 raeburn 11085: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11086: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11087: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11088: if ($curr_selected{'srchin'} eq $option) {
11089: $srchinsel .= '
1.1222 damieng 11090: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11091: } else {
11092: $srchinsel .= '
1.1222 damieng 11093: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11094: }
1.555 raeburn 11095: }
1.563 raeburn 11096: $srchinsel .= "\n </select>\n";
1.555 raeburn 11097:
11098: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11099: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11100: if ($curr_selected{'srchby'} eq $option) {
11101: $srchbysel .= '
1.1222 damieng 11102: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11103: } else {
11104: $srchbysel .= '
1.1222 damieng 11105: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11106: }
11107: }
11108: $srchbysel .= "\n </select>\n";
11109:
11110: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11111: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11112: if ($curr_selected{'srchtype'} eq $option) {
11113: $srchtypesel .= '
1.1222 damieng 11114: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11115: } else {
11116: $srchtypesel .= '
1.1222 damieng 11117: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11118: }
11119: }
11120: $srchtypesel .= "\n </select>\n";
11121:
1.558 albertel 11122: my ($newuserscript,$new_user_create);
1.994 raeburn 11123: my $context_dom = $env{'request.role.domain'};
11124: if ($context eq 'requestcrs') {
11125: if ($env{'form.coursedom'} ne '') {
11126: $context_dom = $env{'form.coursedom'};
11127: }
11128: }
1.556 raeburn 11129: if ($forcenewuser) {
1.576 raeburn 11130: if (ref($srch) eq 'HASH') {
1.994 raeburn 11131: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11132: if ($cancreate) {
11133: $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>';
11134: } else {
1.799 bisitz 11135: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11136: my %usertypetext = (
11137: official => 'institutional',
11138: unofficial => 'non-institutional',
11139: );
1.799 bisitz 11140: $new_user_create = '<p class="LC_warning">'
11141: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11142: .' '
11143: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11144: ,'<a href="'.$helplink.'">','</a>')
11145: .'</p><br />';
1.627 raeburn 11146: }
1.576 raeburn 11147: }
11148: }
11149:
1.556 raeburn 11150: $newuserscript = <<"ENDSCRIPT";
11151:
1.570 raeburn 11152: function setSearch(createnew,callingForm) {
1.556 raeburn 11153: if (createnew == 1) {
1.570 raeburn 11154: for (var i=0; i<callingForm.srchby.length; i++) {
11155: if (callingForm.srchby.options[i].value == 'uname') {
11156: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11157: }
11158: }
1.570 raeburn 11159: for (var i=0; i<callingForm.srchin.length; i++) {
11160: if ( callingForm.srchin.options[i].value == 'dom') {
11161: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11162: }
11163: }
1.570 raeburn 11164: for (var i=0; i<callingForm.srchtype.length; i++) {
11165: if (callingForm.srchtype.options[i].value == 'exact') {
11166: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11167: }
11168: }
1.570 raeburn 11169: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11170: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11171: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11172: }
11173: }
11174: }
11175: }
11176: ENDSCRIPT
1.558 albertel 11177:
1.556 raeburn 11178: }
11179:
1.555 raeburn 11180: my $output = <<"END_BLOCK";
1.556 raeburn 11181: <script type="text/javascript">
1.824 bisitz 11182: // <![CDATA[
1.570 raeburn 11183: function validateEntry(callingForm) {
1.558 albertel 11184:
1.556 raeburn 11185: var checkok = 1;
1.558 albertel 11186: var srchin;
1.570 raeburn 11187: for (var i=0; i<callingForm.srchin.length; i++) {
11188: if ( callingForm.srchin[i].checked ) {
11189: srchin = callingForm.srchin[i].value;
1.558 albertel 11190: }
11191: }
11192:
1.570 raeburn 11193: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11194: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11195: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11196: var srchterm = callingForm.srchterm.value;
11197: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11198: var msg = "";
11199:
11200: if (srchterm == "") {
11201: checkok = 0;
1.1222 damieng 11202: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11203: }
11204:
1.569 raeburn 11205: if (srchtype== 'begins') {
11206: if (srchterm.length < 2) {
11207: checkok = 0;
1.1222 damieng 11208: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11209: }
11210: }
11211:
1.556 raeburn 11212: if (srchtype== 'contains') {
11213: if (srchterm.length < 3) {
11214: checkok = 0;
1.1222 damieng 11215: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11216: }
11217: }
11218: if (srchin == 'instd') {
11219: if (srchdomain == '') {
11220: checkok = 0;
1.1222 damieng 11221: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11222: }
11223: }
11224: if (srchin == 'dom') {
11225: if (srchdomain == '') {
11226: checkok = 0;
1.1222 damieng 11227: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11228: }
11229: }
11230: if (srchby == 'lastfirst') {
11231: if (srchterm.indexOf(",") == -1) {
11232: checkok = 0;
1.1222 damieng 11233: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11234: }
11235: if (srchterm.indexOf(",") == srchterm.length -1) {
11236: checkok = 0;
1.1222 damieng 11237: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11238: }
11239: }
11240: if (checkok == 0) {
1.1222 damieng 11241: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11242: return;
11243: }
11244: if (checkok == 1) {
1.570 raeburn 11245: callingForm.submit();
1.556 raeburn 11246: }
11247: }
11248:
11249: $newuserscript
11250:
1.824 bisitz 11251: // ]]>
1.556 raeburn 11252: </script>
1.558 albertel 11253:
11254: $new_user_create
11255:
1.555 raeburn 11256: END_BLOCK
1.558 albertel 11257:
1.876 raeburn 11258: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11259: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11260: $domform.
11261: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11262: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11263: $srchbysel.
11264: $srchtypesel.
11265: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11266: $srchinsel.
11267: &Apache::lonhtmlcommon::row_closure(1).
11268: &Apache::lonhtmlcommon::end_pick_box().
11269: '<br />';
1.1253 raeburn 11270: return ($output,1);
1.555 raeburn 11271: }
11272:
1.612 raeburn 11273: sub user_rule_check {
1.615 raeburn 11274: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11275: my ($response,%inst_response);
1.612 raeburn 11276: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11277: if (keys(%{$usershash}) > 1) {
11278: my (%by_username,%by_id,%userdoms);
11279: my $checkid;
11280: if (ref($checks) eq 'HASH') {
11281: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11282: $checkid = 1;
11283: }
11284: }
11285: foreach my $user (keys(%{$usershash})) {
11286: my ($uname,$udom) = split(/:/,$user);
11287: if ($checkid) {
11288: if (ref($usershash->{$user}) eq 'HASH') {
11289: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11290: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11291: $userdoms{$udom} = 1;
1.1227 raeburn 11292: if (ref($inst_results) eq 'HASH') {
11293: $inst_results->{$uname.':'.$udom} = {};
11294: }
1.1226 raeburn 11295: }
11296: }
11297: } else {
11298: $by_username{$udom}{$uname} = 1;
11299: $userdoms{$udom} = 1;
1.1227 raeburn 11300: if (ref($inst_results) eq 'HASH') {
11301: $inst_results->{$uname.':'.$udom} = {};
11302: }
1.1226 raeburn 11303: }
11304: }
11305: foreach my $udom (keys(%userdoms)) {
11306: if (!$got_rules->{$udom}) {
11307: my %domconfig = &Apache::lonnet::get_dom('configuration',
11308: ['usercreation'],$udom);
11309: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11310: foreach my $item ('username','id') {
11311: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11312: $$curr_rules{$udom}{$item} =
11313: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11314: }
11315: }
11316: }
11317: $got_rules->{$udom} = 1;
11318: }
1.612 raeburn 11319: }
1.1226 raeburn 11320: if ($checkid) {
11321: foreach my $udom (keys(%by_id)) {
11322: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11323: if ($outcome eq 'ok') {
1.1227 raeburn 11324: foreach my $id (keys(%{$by_id{$udom}})) {
11325: my $uname = $by_id{$udom}{$id};
11326: $inst_response{$uname.':'.$udom} = $outcome;
11327: }
1.1226 raeburn 11328: if (ref($results) eq 'HASH') {
11329: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11330: if (exists($inst_response{$uname.':'.$udom})) {
11331: $inst_response{$uname.':'.$udom} = $outcome;
11332: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11333: }
1.1226 raeburn 11334: }
11335: }
11336: }
1.612 raeburn 11337: }
1.615 raeburn 11338: } else {
1.1226 raeburn 11339: foreach my $udom (keys(%by_username)) {
11340: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11341: if ($outcome eq 'ok') {
1.1227 raeburn 11342: foreach my $uname (keys(%{$by_username{$udom}})) {
11343: $inst_response{$uname.':'.$udom} = $outcome;
11344: }
1.1226 raeburn 11345: if (ref($results) eq 'HASH') {
11346: foreach my $uname (keys(%{$results})) {
11347: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11348: }
11349: }
11350: }
11351: }
1.612 raeburn 11352: }
1.1226 raeburn 11353: } elsif (keys(%{$usershash}) == 1) {
11354: my $user = (keys(%{$usershash}))[0];
11355: my ($uname,$udom) = split(/:/,$user);
11356: if (($udom ne '') && ($uname ne '')) {
11357: if (ref($usershash->{$user}) eq 'HASH') {
11358: if (ref($checks) eq 'HASH') {
11359: if (defined($checks->{'username'})) {
11360: ($inst_response{$user},%{$inst_results->{$user}}) =
11361: &Apache::lonnet::get_instuser($udom,$uname);
11362: } elsif (defined($checks->{'id'})) {
11363: if ($usershash->{$user}->{'id'} ne '') {
11364: ($inst_response{$user},%{$inst_results->{$user}}) =
11365: &Apache::lonnet::get_instuser($udom,undef,
11366: $usershash->{$user}->{'id'});
11367: } else {
11368: ($inst_response{$user},%{$inst_results->{$user}}) =
11369: &Apache::lonnet::get_instuser($udom,$uname);
11370: }
1.585 raeburn 11371: }
1.1226 raeburn 11372: } else {
11373: ($inst_response{$user},%{$inst_results->{$user}}) =
11374: &Apache::lonnet::get_instuser($udom,$uname);
11375: return;
11376: }
11377: if (!$got_rules->{$udom}) {
11378: my %domconfig = &Apache::lonnet::get_dom('configuration',
11379: ['usercreation'],$udom);
11380: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11381: foreach my $item ('username','id') {
11382: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
11383: $$curr_rules{$udom}{$item} =
11384: $domconfig{'usercreation'}{$item.'_rule'};
11385: }
11386: }
11387: }
11388: $got_rules->{$udom} = 1;
1.585 raeburn 11389: }
11390: }
1.1226 raeburn 11391: } else {
11392: return;
11393: }
11394: } else {
11395: return;
11396: }
11397: foreach my $user (keys(%{$usershash})) {
11398: my ($uname,$udom) = split(/:/,$user);
11399: next if (($udom eq '') || ($uname eq ''));
11400: my $id;
1.1227 raeburn 11401: if (ref($inst_results) eq 'HASH') {
11402: if (ref($inst_results->{$user}) eq 'HASH') {
11403: $id = $inst_results->{$user}->{'id'};
11404: }
11405: }
11406: if ($id eq '') {
11407: if (ref($usershash->{$user})) {
11408: $id = $usershash->{$user}->{'id'};
11409: }
1.585 raeburn 11410: }
1.612 raeburn 11411: foreach my $item (keys(%{$checks})) {
11412: if (ref($$curr_rules{$udom}) eq 'HASH') {
11413: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
11414: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 11415: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
11416: $$curr_rules{$udom}{$item});
1.612 raeburn 11417: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
11418: if ($rule_check{$rule}) {
11419: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 11420: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 11421: if (ref($inst_results) eq 'HASH') {
11422: if (ref($inst_results->{$user}) eq 'HASH') {
11423: if (keys(%{$inst_results->{$user}}) == 0) {
11424: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 11425: } elsif ($item eq 'id') {
11426: if ($inst_results->{$user}->{'id'} eq '') {
11427: $$alerts{$item}{$udom}{$uname} = 1;
11428: }
1.615 raeburn 11429: }
1.612 raeburn 11430: }
11431: }
1.615 raeburn 11432: }
11433: last;
1.585 raeburn 11434: }
11435: }
11436: }
11437: }
11438: }
11439: }
11440: }
11441: }
1.612 raeburn 11442: return;
11443: }
11444:
11445: sub user_rule_formats {
11446: my ($domain,$domdesc,$curr_rules,$check) = @_;
11447: my %text = (
11448: 'username' => 'Usernames',
11449: 'id' => 'IDs',
11450: );
11451: my $output;
11452: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
11453: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
11454: if (@{$ruleorder} > 0) {
1.1102 raeburn 11455: $output = '<br />'.
11456: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
11457: '<span class="LC_cusr_emph">','</span>',$domdesc).
11458: ' <ul>';
1.612 raeburn 11459: foreach my $rule (@{$ruleorder}) {
11460: if (ref($curr_rules) eq 'ARRAY') {
11461: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
11462: if (ref($rules->{$rule}) eq 'HASH') {
11463: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
11464: $rules->{$rule}{'desc'}.'</li>';
11465: }
11466: }
11467: }
11468: }
11469: $output .= '</ul>';
11470: }
11471: }
11472: return $output;
11473: }
11474:
11475: sub instrule_disallow_msg {
1.615 raeburn 11476: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 11477: my $response;
11478: my %text = (
11479: item => 'username',
11480: items => 'usernames',
11481: match => 'matches',
11482: do => 'does',
11483: action => 'a username',
11484: one => 'one',
11485: );
11486: if ($count > 1) {
11487: $text{'item'} = 'usernames';
11488: $text{'match'} ='match';
11489: $text{'do'} = 'do';
11490: $text{'action'} = 'usernames',
11491: $text{'one'} = 'ones';
11492: }
11493: if ($checkitem eq 'id') {
11494: $text{'items'} = 'IDs';
11495: $text{'item'} = 'ID';
11496: $text{'action'} = 'an ID';
1.615 raeburn 11497: if ($count > 1) {
11498: $text{'item'} = 'IDs';
11499: $text{'action'} = 'IDs';
11500: }
1.612 raeburn 11501: }
1.674 bisitz 11502: $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 11503: if ($mode eq 'upload') {
11504: if ($checkitem eq 'username') {
11505: $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'}.");
11506: } elsif ($checkitem eq 'id') {
1.674 bisitz 11507: $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 11508: }
1.669 raeburn 11509: } elsif ($mode eq 'selfcreate') {
11510: if ($checkitem eq 'id') {
11511: $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.");
11512: }
1.615 raeburn 11513: } else {
11514: if ($checkitem eq 'username') {
11515: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
11516: } elsif ($checkitem eq 'id') {
11517: $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.");
11518: }
1.612 raeburn 11519: }
11520: return $response;
1.585 raeburn 11521: }
11522:
1.624 raeburn 11523: sub personal_data_fieldtitles {
11524: my %fieldtitles = &Apache::lonlocal::texthash (
11525: id => 'Student/Employee ID',
11526: permanentemail => 'E-mail address',
11527: lastname => 'Last Name',
11528: firstname => 'First Name',
11529: middlename => 'Middle Name',
11530: generation => 'Generation',
11531: gen => 'Generation',
1.765 raeburn 11532: inststatus => 'Affiliation',
1.624 raeburn 11533: );
11534: return %fieldtitles;
11535: }
11536:
1.642 raeburn 11537: sub sorted_inst_types {
11538: my ($dom) = @_;
1.1185 raeburn 11539: my ($usertypes,$order);
11540: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
11541: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
11542: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
11543: $order = $domdefaults{'inststatus'}{'inststatusorder'};
11544: } else {
11545: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
11546: }
1.642 raeburn 11547: my $othertitle = &mt('All users');
11548: if ($env{'request.course.id'}) {
1.668 raeburn 11549: $othertitle = &mt('Any users');
1.642 raeburn 11550: }
11551: my @types;
11552: if (ref($order) eq 'ARRAY') {
11553: @types = @{$order};
11554: }
11555: if (@types == 0) {
11556: if (ref($usertypes) eq 'HASH') {
11557: @types = sort(keys(%{$usertypes}));
11558: }
11559: }
11560: if (keys(%{$usertypes}) > 0) {
11561: $othertitle = &mt('Other users');
11562: }
11563: return ($othertitle,$usertypes,\@types);
11564: }
11565:
1.645 raeburn 11566: sub get_institutional_codes {
1.1361 raeburn 11567: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 11568: # Get complete list of course sections to update
11569: my @currsections = ();
11570: my @currxlists = ();
1.1361 raeburn 11571: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 11572: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 11573: my $crskey = $crs.':'.$coursecode;
11574: @{$unclutteredsec{$crskey}} = ();
11575: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 11576:
11577: if ($$settings{'internal.sectionnums'} ne '') {
11578: @currsections = split(/,/,$$settings{'internal.sectionnums'});
11579: }
11580:
11581: if ($$settings{'internal.crosslistings'} ne '') {
11582: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
11583: }
11584:
11585: if (@currxlists > 0) {
1.1361 raeburn 11586: foreach my $xl (@currxlists) {
11587: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 11588: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 11589: push(@{$allcourses},$1);
1.645 raeburn 11590: $$LC_code{$1} = $2;
11591: }
11592: }
11593: }
11594: }
1.1361 raeburn 11595:
1.645 raeburn 11596: if (@currsections > 0) {
1.1361 raeburn 11597: foreach my $sec (@currsections) {
11598: if ($sec =~ m/^(\w+):(\w*)$/ ) {
11599: my $instsec = $1;
1.645 raeburn 11600: my $lc_sec = $2;
1.1361 raeburn 11601: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
11602: push(@{$unclutteredsec{$crskey}},$instsec);
11603: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
11604: }
11605: }
11606: }
11607: }
11608:
11609: if (@{$unclutteredsec{$crskey}} > 0) {
11610: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
11611: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
11612: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
11613: my $sec = $coursecode.$formattedsec{$crskey}[$i];
11614: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 11615: push(@{$allcourses},$sec);
1.1361 raeburn 11616: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 11617: }
11618: }
11619: }
11620: }
11621: return;
11622: }
11623:
1.971 raeburn 11624: sub get_standard_codeitems {
11625: return ('Year','Semester','Department','Number','Section');
11626: }
11627:
1.112 bowersj2 11628: =pod
11629:
1.780 raeburn 11630: =head1 Slot Helpers
11631:
11632: =over 4
11633:
11634: =item * sorted_slots()
11635:
1.1040 raeburn 11636: Sorts an array of slot names in order of an optional sort key,
11637: default sort is by slot start time (earliest first).
1.780 raeburn 11638:
11639: Inputs:
11640:
11641: =over 4
11642:
11643: slotsarr - Reference to array of unsorted slot names.
11644:
11645: slots - Reference to hash of hash, where outer hash keys are slot names.
11646:
1.1040 raeburn 11647: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
11648:
1.549 albertel 11649: =back
11650:
1.780 raeburn 11651: Returns:
11652:
11653: =over 4
11654:
1.1040 raeburn 11655: sorted - An array of slot names sorted by a specified sort key
11656: (default sort key is start time of the slot).
1.780 raeburn 11657:
11658: =back
11659:
11660: =cut
11661:
11662:
11663: sub sorted_slots {
1.1040 raeburn 11664: my ($slotsarr,$slots,$sortkey) = @_;
11665: if ($sortkey eq '') {
11666: $sortkey = 'starttime';
11667: }
1.780 raeburn 11668: my @sorted;
11669: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
11670: @sorted =
11671: sort {
11672: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 11673: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 11674: }
11675: if (ref($slots->{$a})) { return -1;}
11676: if (ref($slots->{$b})) { return 1;}
11677: return 0;
11678: } @{$slotsarr};
11679: }
11680: return @sorted;
11681: }
11682:
1.1040 raeburn 11683: =pod
11684:
11685: =item * get_future_slots()
11686:
11687: Inputs:
11688:
11689: =over 4
11690:
11691: cnum - course number
11692:
11693: cdom - course domain
11694:
11695: now - current UNIX time
11696:
11697: symb - optional symb
11698:
11699: =back
11700:
11701: Returns:
11702:
11703: =over 4
11704:
11705: sorted_reservable - ref to array of student_schedulable slots currently
11706: reservable, ordered by end date of reservation period.
11707:
11708: reservable_now - ref to hash of student_schedulable slots currently
11709: reservable.
11710:
11711: Keys in inner hash are:
11712: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11713: (b) endreserve: end date of reservation period.
11714: (c) uniqueperiod: start,end dates when slot is to be uniquely
11715: selected.
1.1040 raeburn 11716:
11717: sorted_future - ref to array of student_schedulable slots reservable in
11718: the future, ordered by start date of reservation period.
11719:
11720: future_reservable - ref to hash of student_schedulable slots reservable
11721: in the future.
11722:
11723: Keys in inner hash are:
11724: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11725: (b) startreserve: start date of reservation period.
11726: (c) uniqueperiod: start,end dates when slot is to be uniquely
11727: selected.
1.1040 raeburn 11728:
11729: =back
11730:
11731: =cut
11732:
11733: sub get_future_slots {
11734: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 11735: my $map;
11736: if ($symb) {
11737: ($map) = &Apache::lonnet::decode_symb($symb);
11738: }
1.1040 raeburn 11739: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
11740: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
11741: foreach my $slot (keys(%slots)) {
11742: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
11743: if ($symb) {
1.1229 raeburn 11744: if ($slots{$slot}->{'symb'} ne '') {
11745: my $canuse;
11746: my %oksymbs;
11747: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
11748: map { $oksymbs{$_} = 1; } @slotsymbs;
11749: if ($oksymbs{$symb}) {
11750: $canuse = 1;
11751: } else {
11752: foreach my $item (@slotsymbs) {
11753: if ($item =~ /\.(page|sequence)$/) {
11754: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
11755: if (($map ne '') && ($map eq $sloturl)) {
11756: $canuse = 1;
11757: last;
11758: }
11759: }
11760: }
11761: }
11762: next unless ($canuse);
11763: }
1.1040 raeburn 11764: }
11765: if (($slots{$slot}->{'starttime'} > $now) &&
11766: ($slots{$slot}->{'endtime'} > $now)) {
11767: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
11768: my $userallowed = 0;
11769: if ($slots{$slot}->{'allowedsections'}) {
11770: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
11771: if (!defined($env{'request.role.sec'})
11772: && grep(/^No section assigned$/,@allowed_sec)) {
11773: $userallowed=1;
11774: } else {
11775: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
11776: $userallowed=1;
11777: }
11778: }
11779: unless ($userallowed) {
11780: if (defined($env{'request.course.groups'})) {
11781: my @groups = split(/:/,$env{'request.course.groups'});
11782: foreach my $group (@groups) {
11783: if (grep(/^\Q$group\E$/,@allowed_sec)) {
11784: $userallowed=1;
11785: last;
11786: }
11787: }
11788: }
11789: }
11790: }
11791: if ($slots{$slot}->{'allowedusers'}) {
11792: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
11793: my $user = $env{'user.name'}.':'.$env{'user.domain'};
11794: if (grep(/^\Q$user\E$/,@allowed_users)) {
11795: $userallowed = 1;
11796: }
11797: }
11798: next unless($userallowed);
11799: }
11800: my $startreserve = $slots{$slot}->{'startreserve'};
11801: my $endreserve = $slots{$slot}->{'endreserve'};
11802: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 11803: my $uniqueperiod;
11804: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
11805: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
11806: }
1.1040 raeburn 11807: if (($startreserve < $now) &&
11808: (!$endreserve || $endreserve > $now)) {
11809: my $lastres = $endreserve;
11810: if (!$lastres) {
11811: $lastres = $slots{$slot}->{'starttime'};
11812: }
11813: $reservable_now{$slot} = {
11814: symb => $symb,
1.1250 raeburn 11815: endreserve => $lastres,
11816: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11817: };
11818: } elsif (($startreserve > $now) &&
11819: (!$endreserve || $endreserve > $startreserve)) {
11820: $future_reservable{$slot} = {
11821: symb => $symb,
1.1250 raeburn 11822: startreserve => $startreserve,
11823: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11824: };
11825: }
11826: }
11827: }
11828: my @unsorted_reservable = keys(%reservable_now);
11829: if (@unsorted_reservable > 0) {
11830: @sorted_reservable =
11831: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
11832: }
11833: my @unsorted_future = keys(%future_reservable);
11834: if (@unsorted_future > 0) {
11835: @sorted_future =
11836: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
11837: }
11838: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
11839: }
1.780 raeburn 11840:
11841: =pod
11842:
1.1057 foxr 11843: =back
11844:
1.549 albertel 11845: =head1 HTTP Helpers
11846:
11847: =over 4
11848:
1.648 raeburn 11849: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 11850:
1.258 albertel 11851: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 11852: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 11853: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 11854:
11855: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
11856: $possible_names is an ref to an array of form element names. As an example:
11857: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 11858: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 11859:
11860: =cut
1.1 albertel 11861:
1.6 albertel 11862: sub get_unprocessed_cgi {
1.25 albertel 11863: my ($query,$possible_names)= @_;
1.26 matthew 11864: # $Apache::lonxml::debug=1;
1.356 albertel 11865: foreach my $pair (split(/&/,$query)) {
11866: my ($name, $value) = split(/=/,$pair);
1.369 www 11867: $name = &unescape($name);
1.25 albertel 11868: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
11869: $value =~ tr/+/ /;
11870: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 11871: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 11872: }
1.16 harris41 11873: }
1.6 albertel 11874: }
11875:
1.112 bowersj2 11876: =pod
11877:
1.648 raeburn 11878: =item * &cacheheader()
1.112 bowersj2 11879:
11880: returns cache-controlling header code
11881:
11882: =cut
11883:
1.7 albertel 11884: sub cacheheader {
1.258 albertel 11885: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 11886: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
11887: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 11888: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
11889: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 11890: return $output;
1.7 albertel 11891: }
11892:
1.112 bowersj2 11893: =pod
11894:
1.648 raeburn 11895: =item * &no_cache($r)
1.112 bowersj2 11896:
11897: specifies header code to not have cache
11898:
11899: =cut
11900:
1.9 albertel 11901: sub no_cache {
1.216 albertel 11902: my ($r) = @_;
11903: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 11904: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 11905: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
11906: $r->no_cache(1);
11907: $r->header_out("Expires" => $date);
11908: $r->header_out("Pragma" => "no-cache");
1.123 www 11909: }
11910:
11911: sub content_type {
1.181 albertel 11912: my ($r,$type,$charset) = @_;
1.299 foxr 11913: if ($r) {
11914: # Note that printout.pl calls this with undef for $r.
11915: &no_cache($r);
11916: }
1.258 albertel 11917: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 11918: unless ($charset) {
11919: $charset=&Apache::lonlocal::current_encoding;
11920: }
11921: if ($charset) { $type.='; charset='.$charset; }
11922: if ($r) {
11923: $r->content_type($type);
11924: } else {
11925: print("Content-type: $type\n\n");
11926: }
1.9 albertel 11927: }
1.25 albertel 11928:
1.112 bowersj2 11929: =pod
11930:
1.648 raeburn 11931: =item * &add_to_env($name,$value)
1.112 bowersj2 11932:
1.258 albertel 11933: adds $name to the %env hash with value
1.112 bowersj2 11934: $value, if $name already exists, the entry is converted to an array
11935: reference and $value is added to the array.
11936:
11937: =cut
11938:
1.25 albertel 11939: sub add_to_env {
11940: my ($name,$value)=@_;
1.258 albertel 11941: if (defined($env{$name})) {
11942: if (ref($env{$name})) {
1.25 albertel 11943: #already have multiple values
1.258 albertel 11944: push(@{ $env{$name} },$value);
1.25 albertel 11945: } else {
11946: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 11947: my $first=$env{$name};
11948: undef($env{$name});
11949: push(@{ $env{$name} },$first,$value);
1.25 albertel 11950: }
11951: } else {
1.258 albertel 11952: $env{$name}=$value;
1.25 albertel 11953: }
1.31 albertel 11954: }
1.149 albertel 11955:
11956: =pod
11957:
1.648 raeburn 11958: =item * &get_env_multiple($name)
1.149 albertel 11959:
1.258 albertel 11960: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 11961: values may be defined and end up as an array ref.
11962:
11963: returns an array of values
11964:
11965: =cut
11966:
11967: sub get_env_multiple {
11968: my ($name) = @_;
11969: my @values;
1.258 albertel 11970: if (defined($env{$name})) {
1.149 albertel 11971: # exists is it an array
1.258 albertel 11972: if (ref($env{$name})) {
11973: @values=@{ $env{$name} };
1.149 albertel 11974: } else {
1.258 albertel 11975: $values[0]=$env{$name};
1.149 albertel 11976: }
11977: }
11978: return(@values);
11979: }
11980:
1.1249 damieng 11981: # Looks at given dependencies, and returns something depending on the context.
11982: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
11983: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
11984: # For all other contexts, returns ($output, $counter, $numpathchg).
11985: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
11986: # $counter: integer with the number of existing dependencies when no HTML output is returned, and the number of missing dependencies when an HTML output is returned.
11987: # $numpathchg: integer with the number of cleaned up dependency paths.
11988: # \%existing: hash reference clean path -> 1 only for existing dependencies.
11989: # \%mapping: hash reference clean path -> original path for all dependencies.
11990: # @param {string} actionurl - The path to the handler, indicative of the context.
11991: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
11992: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
11993: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
11994: # @param {hash reference} args - More parameters ! Possible keys: error_on_invalid_names (boolean), ignore_remote_references (boolean), current_path (string), docs_url (string), docs_title (string), context (string)
11995: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 11996: sub ask_for_embedded_content {
1.1249 damieng 11997: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 11998: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 11999: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12000: %currsubfile,%unused,$rem);
1.1071 raeburn 12001: my $counter = 0;
12002: my $numnew = 0;
1.987 raeburn 12003: my $numremref = 0;
12004: my $numinvalid = 0;
12005: my $numpathchg = 0;
12006: my $numexisting = 0;
1.1071 raeburn 12007: my $numunused = 0;
12008: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12009: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12010: my $heading = &mt('Upload embedded files');
12011: my $buttontext = &mt('Upload');
12012:
1.1249 damieng 12013: # fills these variables based on the context:
12014: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12015: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12016: if ($env{'request.course.id'}) {
1.1123 raeburn 12017: if ($actionurl eq '/adm/dependencies') {
12018: $navmap = Apache::lonnavmaps::navmap->new();
12019: }
12020: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12021: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12022: }
1.1123 raeburn 12023: if (($actionurl eq '/adm/portfolio') ||
12024: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12025: my $current_path='/';
12026: if ($env{'form.currentpath'}) {
12027: $current_path = $env{'form.currentpath'};
12028: }
12029: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12030: $udom = $cdom;
12031: $uname = $cnum;
1.984 raeburn 12032: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12033: } else {
12034: $udom = $env{'user.domain'};
12035: $uname = $env{'user.name'};
12036: $url = '/userfiles/portfolio';
12037: }
1.987 raeburn 12038: $toplevel = $url.'/';
1.984 raeburn 12039: $url .= $current_path;
12040: $getpropath = 1;
1.987 raeburn 12041: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12042: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12043: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12044: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12045: $toplevel = $url;
1.984 raeburn 12046: if ($rest ne '') {
1.987 raeburn 12047: $url .= $rest;
12048: }
12049: } elsif ($actionurl eq '/adm/coursedocs') {
12050: if (ref($args) eq 'HASH') {
1.1071 raeburn 12051: $url = $args->{'docs_url'};
12052: $toplevel = $url;
1.1084 raeburn 12053: if ($args->{'context'} eq 'paste') {
12054: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12055: ($path) =
12056: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12057: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12058: $fileloc =~ s{^/}{};
12059: }
1.1071 raeburn 12060: }
1.1084 raeburn 12061: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12062: if ($env{'request.course.id'} ne '') {
12063: if (ref($args) eq 'HASH') {
12064: $url = $args->{'docs_url'};
12065: $title = $args->{'docs_title'};
1.1126 raeburn 12066: $toplevel = $url;
12067: unless ($toplevel =~ m{^/}) {
12068: $toplevel = "/$url";
12069: }
1.1085 raeburn 12070: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12071: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12072: $path = $1;
12073: } else {
12074: ($path) =
12075: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12076: }
1.1195 raeburn 12077: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12078: $fileloc = $toplevel;
12079: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12080: my ($udom,$uname,$fname) =
12081: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12082: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12083: } else {
12084: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12085: }
1.1071 raeburn 12086: $fileloc =~ s{^/}{};
12087: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12088: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12089: }
1.987 raeburn 12090: }
1.1123 raeburn 12091: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12092: $udom = $cdom;
12093: $uname = $cnum;
12094: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12095: $toplevel = $url;
12096: $path = $url;
12097: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12098: $fileloc =~ s{^/}{};
1.987 raeburn 12099: }
1.1249 damieng 12100:
12101: # parses the dependency paths to get some info
12102: # fills $newfiles, $mapping, $subdependencies, $dependencies
12103: # $newfiles: hash URL -> 1 for new files or external URLs
12104: # (will be completed later)
12105: # $mapping:
12106: # for external URLs: external URL -> external URL
12107: # for relative paths: clean path -> original path
12108: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12109: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12110: foreach my $file (keys(%{$allfiles})) {
12111: my $embed_file;
12112: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12113: $embed_file = $1;
12114: } else {
12115: $embed_file = $file;
12116: }
1.1158 raeburn 12117: my ($absolutepath,$cleaned_file);
12118: if ($embed_file =~ m{^\w+://}) {
12119: $cleaned_file = $embed_file;
1.1147 raeburn 12120: $newfiles{$cleaned_file} = 1;
12121: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12122: } else {
1.1158 raeburn 12123: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12124: if ($embed_file =~ m{^/}) {
12125: $absolutepath = $embed_file;
12126: }
1.1147 raeburn 12127: if ($cleaned_file =~ m{/}) {
12128: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12129: $path = &check_for_traversal($path,$url,$toplevel);
12130: my $item = $fname;
12131: if ($path ne '') {
12132: $item = $path.'/'.$fname;
12133: $subdependencies{$path}{$fname} = 1;
12134: } else {
12135: $dependencies{$item} = 1;
12136: }
12137: if ($absolutepath) {
12138: $mapping{$item} = $absolutepath;
12139: } else {
12140: $mapping{$item} = $embed_file;
12141: }
12142: } else {
12143: $dependencies{$embed_file} = 1;
12144: if ($absolutepath) {
1.1147 raeburn 12145: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12146: } else {
1.1147 raeburn 12147: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12148: }
12149: }
1.984 raeburn 12150: }
12151: }
1.1249 damieng 12152:
12153: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12154: # and lists
12155: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12156: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12157: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12158: # the path had to be cleaned up
12159: # $existing: hash clean path -> 1 if the file exists
12160: # $numexisting: number of keys in $existing
12161: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12162: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12163: # dependency subdirectories that are
12164: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12165: my $dirptr = 16384;
1.984 raeburn 12166: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12167: $currsubfile{$path} = {};
1.1123 raeburn 12168: if (($actionurl eq '/adm/portfolio') ||
12169: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12170: my ($sublistref,$listerror) =
12171: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12172: if (ref($sublistref) eq 'ARRAY') {
12173: foreach my $line (@{$sublistref}) {
12174: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12175: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12176: }
1.984 raeburn 12177: }
1.987 raeburn 12178: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12179: if (opendir(my $dir,$url.'/'.$path)) {
12180: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12181: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12182: }
1.1084 raeburn 12183: } elsif (($actionurl eq '/adm/dependencies') ||
12184: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12185: ($args->{'context'} eq 'paste')) ||
12186: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12187: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12188: my $dir;
12189: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12190: $dir = $fileloc;
12191: } else {
12192: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12193: }
1.1071 raeburn 12194: if ($dir ne '') {
12195: my ($sublistref,$listerror) =
12196: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12197: if (ref($sublistref) eq 'ARRAY') {
12198: foreach my $line (@{$sublistref}) {
12199: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12200: undef,$mtime)=split(/\&/,$line,12);
12201: unless (($testdir&$dirptr) ||
12202: ($file_name =~ /^\.\.?$/)) {
12203: $currsubfile{$path}{$file_name} = [$size,$mtime];
12204: }
12205: }
12206: }
12207: }
1.984 raeburn 12208: }
12209: }
12210: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12211: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12212: my $item = $path.'/'.$file;
12213: unless ($mapping{$item} eq $item) {
12214: $pathchanges{$item} = 1;
12215: }
12216: $existing{$item} = 1;
12217: $numexisting ++;
12218: } else {
12219: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12220: }
12221: }
1.1071 raeburn 12222: if ($actionurl eq '/adm/dependencies') {
12223: foreach my $path (keys(%currsubfile)) {
12224: if (ref($currsubfile{$path}) eq 'HASH') {
12225: foreach my $file (keys(%{$currsubfile{$path}})) {
12226: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12227: next if (($rem ne '') &&
12228: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12229: (ref($navmap) &&
12230: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12231: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12232: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12233: $unused{$path.'/'.$file} = 1;
12234: }
12235: }
12236: }
12237: }
12238: }
1.984 raeburn 12239: }
1.1249 damieng 12240:
12241: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12242: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12243: my %currfile;
1.1123 raeburn 12244: if (($actionurl eq '/adm/portfolio') ||
12245: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12246: my ($dirlistref,$listerror) =
12247: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12248: if (ref($dirlistref) eq 'ARRAY') {
12249: foreach my $line (@{$dirlistref}) {
12250: my ($file_name,$rest) = split(/\&/,$line,2);
12251: $currfile{$file_name} = 1;
12252: }
1.984 raeburn 12253: }
1.987 raeburn 12254: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12255: if (opendir(my $dir,$url)) {
1.987 raeburn 12256: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12257: map {$currfile{$_} = 1;} @dir_list;
12258: }
1.1084 raeburn 12259: } elsif (($actionurl eq '/adm/dependencies') ||
12260: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12261: ($args->{'context'} eq 'paste')) ||
12262: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12263: if ($env{'request.course.id'} ne '') {
12264: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12265: if ($dir ne '') {
12266: my ($dirlistref,$listerror) =
12267: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12268: if (ref($dirlistref) eq 'ARRAY') {
12269: foreach my $line (@{$dirlistref}) {
12270: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12271: $size,undef,$mtime)=split(/\&/,$line,12);
12272: unless (($testdir&$dirptr) ||
12273: ($file_name =~ /^\.\.?$/)) {
12274: $currfile{$file_name} = [$size,$mtime];
12275: }
12276: }
12277: }
12278: }
12279: }
1.984 raeburn 12280: }
1.1249 damieng 12281: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12282: # are not in subdirectories, using $currfile
1.984 raeburn 12283: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12284: if (exists($currfile{$file})) {
1.987 raeburn 12285: unless ($mapping{$file} eq $file) {
12286: $pathchanges{$file} = 1;
12287: }
12288: $existing{$file} = 1;
12289: $numexisting ++;
12290: } else {
1.984 raeburn 12291: $newfiles{$file} = 1;
12292: }
12293: }
1.1071 raeburn 12294: foreach my $file (keys(%currfile)) {
12295: unless (($file eq $filename) ||
12296: ($file eq $filename.'.bak') ||
12297: ($dependencies{$file})) {
1.1085 raeburn 12298: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12299: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12300: next if (($rem ne '') &&
12301: (($env{"httpref.$rem".$file} ne '') ||
12302: (ref($navmap) &&
12303: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12304: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12305: ($navmap->getResourceByUrl($rem.$1)))))));
12306: }
1.1085 raeburn 12307: }
1.1071 raeburn 12308: $unused{$file} = 1;
12309: }
12310: }
1.1249 damieng 12311:
12312: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12313: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12314: ($args->{'context'} eq 'paste')) {
12315: $counter = scalar(keys(%existing));
12316: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12317: return ($output,$counter,$numpathchg,\%existing);
12318: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12319: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12320: $counter = scalar(keys(%existing));
12321: $numpathchg = scalar(keys(%pathchanges));
12322: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12323: }
1.1249 damieng 12324:
12325: # returns HTML otherwise, with dependency results and to ask for more uploads
12326:
12327: # $upload_output: missing dependencies (with upload form)
12328: # $modify_output: uploaded dependencies (in use)
12329: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12330: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12331: if ($actionurl eq '/adm/dependencies') {
12332: next if ($embed_file =~ m{^\w+://});
12333: }
1.660 raeburn 12334: $upload_output .= &start_data_table_row().
1.1123 raeburn 12335: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12336: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12337: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12338: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12339: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12340: }
1.1123 raeburn 12341: $upload_output .= '</td>';
1.1071 raeburn 12342: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12343: $upload_output.='<td align="right">'.
12344: '<span class="LC_info LC_fontsize_medium">'.
12345: &mt("URL points to web address").'</span>';
1.987 raeburn 12346: $numremref++;
1.660 raeburn 12347: } elsif ($args->{'error_on_invalid_names'}
12348: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 12349: $upload_output.='<td align="right"><span class="LC_warning">'.
12350: &mt('Invalid characters').'</span>';
1.987 raeburn 12351: $numinvalid++;
1.660 raeburn 12352: } else {
1.1123 raeburn 12353: $upload_output .= '<td>'.
12354: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12355: $embed_file,\%mapping,
1.1071 raeburn 12356: $allfiles,$codebase,'upload');
12357: $counter ++;
12358: $numnew ++;
1.987 raeburn 12359: }
12360: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12361: }
12362: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12363: if ($actionurl eq '/adm/dependencies') {
12364: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
12365: $modify_output .= &start_data_table_row().
12366: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
12367: '<img src="'.&icon($embed_file).'" border="0" />'.
12368: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
12369: '<td>'.$size.'</td>'.
12370: '<td>'.$mtime.'</td>'.
12371: '<td><label><input type="checkbox" name="mod_upload_dep" '.
12372: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
12373: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
12374: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
12375: &embedded_file_element('upload_embedded',$counter,
12376: $embed_file,\%mapping,
12377: $allfiles,$codebase,'modify').
12378: '</div></td>'.
12379: &end_data_table_row()."\n";
12380: $counter ++;
12381: } else {
12382: $upload_output .= &start_data_table_row().
1.1123 raeburn 12383: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
12384: '<span class="LC_filename">'.$embed_file.'</span></td>'.
12385: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 12386: &Apache::loncommon::end_data_table_row()."\n";
12387: }
12388: }
12389: my $delidx = $counter;
12390: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
12391: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
12392: $delete_output .= &start_data_table_row().
12393: '<td><img src="'.&icon($oldfile).'" />'.
12394: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
12395: '<td>'.$size.'</td>'.
12396: '<td>'.$mtime.'</td>'.
12397: '<td><label><input type="checkbox" name="del_upload_dep" '.
12398: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
12399: &embedded_file_element('upload_embedded',$delidx,
12400: $oldfile,\%mapping,$allfiles,
12401: $codebase,'delete').'</td>'.
12402: &end_data_table_row()."\n";
12403: $numunused ++;
12404: $delidx ++;
1.987 raeburn 12405: }
12406: if ($upload_output) {
12407: $upload_output = &start_data_table().
12408: $upload_output.
12409: &end_data_table()."\n";
12410: }
1.1071 raeburn 12411: if ($modify_output) {
12412: $modify_output = &start_data_table().
12413: &start_data_table_header_row().
12414: '<th>'.&mt('File').'</th>'.
12415: '<th>'.&mt('Size (KB)').'</th>'.
12416: '<th>'.&mt('Modified').'</th>'.
12417: '<th>'.&mt('Upload replacement?').'</th>'.
12418: &end_data_table_header_row().
12419: $modify_output.
12420: &end_data_table()."\n";
12421: }
12422: if ($delete_output) {
12423: $delete_output = &start_data_table().
12424: &start_data_table_header_row().
12425: '<th>'.&mt('File').'</th>'.
12426: '<th>'.&mt('Size (KB)').'</th>'.
12427: '<th>'.&mt('Modified').'</th>'.
12428: '<th>'.&mt('Delete?').'</th>'.
12429: &end_data_table_header_row().
12430: $delete_output.
12431: &end_data_table()."\n";
12432: }
1.987 raeburn 12433: my $applies = 0;
12434: if ($numremref) {
12435: $applies ++;
12436: }
12437: if ($numinvalid) {
12438: $applies ++;
12439: }
12440: if ($numexisting) {
12441: $applies ++;
12442: }
1.1071 raeburn 12443: if ($counter || $numunused) {
1.987 raeburn 12444: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
12445: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 12446: $state.'<h3>'.$heading.'</h3>';
12447: if ($actionurl eq '/adm/dependencies') {
12448: if ($numnew) {
12449: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
12450: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
12451: $upload_output.'<br />'."\n";
12452: }
12453: if ($numexisting) {
12454: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
12455: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
12456: $modify_output.'<br />'."\n";
12457: $buttontext = &mt('Save changes');
12458: }
12459: if ($numunused) {
12460: $output .= '<h4>'.&mt('Unused files').'</h4>'.
12461: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
12462: $delete_output.'<br />'."\n";
12463: $buttontext = &mt('Save changes');
12464: }
12465: } else {
12466: $output .= $upload_output.'<br />'."\n";
12467: }
12468: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
12469: $counter.'" />'."\n";
12470: if ($actionurl eq '/adm/dependencies') {
12471: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
12472: $numnew.'" />'."\n";
12473: } elsif ($actionurl eq '') {
1.987 raeburn 12474: $output .= '<input type="hidden" name="phase" value="three" />';
12475: }
12476: } elsif ($applies) {
12477: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
12478: if ($applies > 1) {
12479: $output .=
1.1123 raeburn 12480: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 12481: if ($numremref) {
12482: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
12483: }
12484: if ($numinvalid) {
12485: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
12486: }
12487: if ($numexisting) {
12488: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
12489: }
12490: $output .= '</ul><br />';
12491: } elsif ($numremref) {
12492: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
12493: } elsif ($numinvalid) {
12494: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
12495: } elsif ($numexisting) {
12496: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
12497: }
12498: $output .= $upload_output.'<br />';
12499: }
12500: my ($pathchange_output,$chgcount);
1.1071 raeburn 12501: $chgcount = $counter;
1.987 raeburn 12502: if (keys(%pathchanges) > 0) {
12503: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 12504: if ($counter) {
1.987 raeburn 12505: $output .= &embedded_file_element('pathchange',$chgcount,
12506: $embed_file,\%mapping,
1.1071 raeburn 12507: $allfiles,$codebase,'change');
1.987 raeburn 12508: } else {
12509: $pathchange_output .=
12510: &start_data_table_row().
12511: '<td><input type ="checkbox" name="namechange" value="'.
12512: $chgcount.'" checked="checked" /></td>'.
12513: '<td>'.$mapping{$embed_file}.'</td>'.
12514: '<td>'.$embed_file.
12515: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 12516: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 12517: '</td>'.&end_data_table_row();
1.660 raeburn 12518: }
1.987 raeburn 12519: $numpathchg ++;
12520: $chgcount ++;
1.660 raeburn 12521: }
12522: }
1.1127 raeburn 12523: if (($counter) || ($numunused)) {
1.987 raeburn 12524: if ($numpathchg) {
12525: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
12526: $numpathchg.'" />'."\n";
12527: }
12528: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12529: ($actionurl eq '/adm/imsimport')) {
12530: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
12531: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
12532: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 12533: } elsif ($actionurl eq '/adm/dependencies') {
12534: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 12535: }
1.1123 raeburn 12536: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 12537: } elsif ($numpathchg) {
12538: my %pathchange = ();
12539: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
12540: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12541: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 12542: }
1.987 raeburn 12543: }
1.1071 raeburn 12544: return ($output,$counter,$numpathchg);
1.987 raeburn 12545: }
12546:
1.1147 raeburn 12547: =pod
12548:
12549: =item * clean_path($name)
12550:
12551: Performs clean-up of directories, subdirectories and filename in an
12552: embedded object, referenced in an HTML file which is being uploaded
12553: to a course or portfolio, where
12554: "Upload embedded images/multimedia files if HTML file" checkbox was
12555: checked.
12556:
12557: Clean-up is similar to replacements in lonnet::clean_filename()
12558: except each / between sub-directory and next level is preserved.
12559:
12560: =cut
12561:
12562: sub clean_path {
12563: my ($embed_file) = @_;
12564: $embed_file =~s{^/+}{};
12565: my @contents;
12566: if ($embed_file =~ m{/}) {
12567: @contents = split(/\//,$embed_file);
12568: } else {
12569: @contents = ($embed_file);
12570: }
12571: my $lastidx = scalar(@contents)-1;
12572: for (my $i=0; $i<=$lastidx; $i++) {
12573: $contents[$i]=~s{\\}{/}g;
12574: $contents[$i]=~s/\s+/\_/g;
12575: $contents[$i]=~s{[^/\w\.\-]}{}g;
12576: if ($i == $lastidx) {
12577: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
12578: }
12579: }
12580: if ($lastidx > 0) {
12581: return join('/',@contents);
12582: } else {
12583: return $contents[0];
12584: }
12585: }
12586:
1.987 raeburn 12587: sub embedded_file_element {
1.1071 raeburn 12588: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 12589: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
12590: (ref($codebase) eq 'HASH'));
12591: my $output;
1.1071 raeburn 12592: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 12593: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
12594: }
12595: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
12596: &escape($embed_file).'" />';
12597: unless (($context eq 'upload_embedded') &&
12598: ($mapping->{$embed_file} eq $embed_file)) {
12599: $output .='
12600: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
12601: }
12602: my $attrib;
12603: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
12604: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
12605: }
12606: $output .=
12607: "\n\t\t".
12608: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
12609: $attrib.'" />';
12610: if (exists($codebase->{$mapping->{$embed_file}})) {
12611: $output .=
12612: "\n\t\t".
12613: '<input name="codebase_'.$num.'" type="hidden" value="'.
12614: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 12615: }
1.987 raeburn 12616: return $output;
1.660 raeburn 12617: }
12618:
1.1071 raeburn 12619: sub get_dependency_details {
12620: my ($currfile,$currsubfile,$embed_file) = @_;
12621: my ($size,$mtime,$showsize,$showmtime);
12622: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
12623: if ($embed_file =~ m{/}) {
12624: my ($path,$fname) = split(/\//,$embed_file);
12625: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
12626: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
12627: }
12628: } else {
12629: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
12630: ($size,$mtime) = @{$currfile->{$embed_file}};
12631: }
12632: }
12633: $showsize = $size/1024.0;
12634: $showsize = sprintf("%.1f",$showsize);
12635: if ($mtime > 0) {
12636: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
12637: }
12638: }
12639: return ($showsize,$showmtime);
12640: }
12641:
12642: sub ask_embedded_js {
12643: return <<"END";
12644: <script type="text/javascript"">
12645: // <![CDATA[
12646: function toggleBrowse(counter) {
12647: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
12648: var fileid = document.getElementById('embedded_item_'+counter);
12649: var uploaddivid = document.getElementById('moduploaddep_'+counter);
12650: if (chkboxid.checked == true) {
12651: uploaddivid.style.display='block';
12652: } else {
12653: uploaddivid.style.display='none';
12654: fileid.value = '';
12655: }
12656: }
12657: // ]]>
12658: </script>
12659:
12660: END
12661: }
12662:
1.661 raeburn 12663: sub upload_embedded {
12664: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 12665: $current_disk_usage,$hiddenstate,$actionurl) = @_;
12666: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 12667: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
12668: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
12669: my $orig_uploaded_filename =
12670: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 12671: foreach my $type ('orig','ref','attrib','codebase') {
12672: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
12673: $env{'form.embedded_'.$type.'_'.$i} =
12674: &unescape($env{'form.embedded_'.$type.'_'.$i});
12675: }
12676: }
1.661 raeburn 12677: my ($path,$fname) =
12678: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
12679: # no path, whole string is fname
12680: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
12681: $fname = &Apache::lonnet::clean_filename($fname);
12682: # See if there is anything left
12683: next if ($fname eq '');
12684:
12685: # Check if file already exists as a file or directory.
12686: my ($state,$msg);
12687: if ($context eq 'portfolio') {
12688: my $port_path = $dirpath;
12689: if ($group ne '') {
12690: $port_path = "groups/$group/$port_path";
12691: }
1.987 raeburn 12692: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
12693: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 12694: $dir_root,$port_path,$disk_quota,
12695: $current_disk_usage,$uname,$udom);
12696: if ($state eq 'will_exceed_quota'
1.984 raeburn 12697: || $state eq 'file_locked') {
1.661 raeburn 12698: $output .= $msg;
12699: next;
12700: }
12701: } elsif (($context eq 'author') || ($context eq 'testbank')) {
12702: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
12703: if ($state eq 'exists') {
12704: $output .= $msg;
12705: next;
12706: }
12707: }
12708: # Check if extension is valid
12709: if (($fname =~ /\.(\w+)$/) &&
12710: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 12711: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
12712: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 12713: next;
12714: } elsif (($fname =~ /\.(\w+)$/) &&
12715: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 12716: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 12717: next;
12718: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 12719: $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 12720: next;
12721: }
12722: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 12723: my $subdir = $path;
12724: $subdir =~ s{/+$}{};
1.661 raeburn 12725: if ($context eq 'portfolio') {
1.984 raeburn 12726: my $result;
12727: if ($state eq 'existingfile') {
12728: $result=
12729: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 12730: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 12731: } else {
1.984 raeburn 12732: $result=
12733: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 12734: $dirpath.
1.1123 raeburn 12735: $env{'form.currentpath'}.$subdir);
1.984 raeburn 12736: if ($result !~ m|^/uploaded/|) {
12737: $output .= '<span class="LC_error">'
12738: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12739: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12740: .'</span><br />';
12741: next;
12742: } else {
1.987 raeburn 12743: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12744: $path.$fname.'</span>').'<br />';
1.984 raeburn 12745: }
1.661 raeburn 12746: }
1.1123 raeburn 12747: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 12748: my $extendedsubdir = $dirpath.'/'.$subdir;
12749: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 12750: my $result =
1.1126 raeburn 12751: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 12752: if ($result !~ m|^/uploaded/|) {
12753: $output .= '<span class="LC_error">'
12754: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12755: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12756: .'</span><br />';
12757: next;
12758: } else {
12759: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12760: $path.$fname.'</span>').'<br />';
1.1125 raeburn 12761: if ($context eq 'syllabus') {
12762: &Apache::lonnet::make_public_indefinitely($result);
12763: }
1.987 raeburn 12764: }
1.661 raeburn 12765: } else {
12766: # Save the file
12767: my $target = $env{'form.embedded_item_'.$i};
12768: my $fullpath = $dir_root.$dirpath.'/'.$path;
12769: my $dest = $fullpath.$fname;
12770: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 12771: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 12772: my $count;
12773: my $filepath = $dir_root;
1.1027 raeburn 12774: foreach my $subdir (@parts) {
12775: $filepath .= "/$subdir";
12776: if (!-e $filepath) {
1.661 raeburn 12777: mkdir($filepath,0770);
12778: }
12779: }
12780: my $fh;
12781: if (!open($fh,'>'.$dest)) {
12782: &Apache::lonnet::logthis('Failed to create '.$dest);
12783: $output .= '<span class="LC_error">'.
1.1071 raeburn 12784: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
12785: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12786: '</span><br />';
12787: } else {
12788: if (!print $fh $env{'form.embedded_item_'.$i}) {
12789: &Apache::lonnet::logthis('Failed to write to '.$dest);
12790: $output .= '<span class="LC_error">'.
1.1071 raeburn 12791: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
12792: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12793: '</span><br />';
12794: } else {
1.987 raeburn 12795: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12796: $url.'</span>').'<br />';
12797: unless ($context eq 'testbank') {
12798: $footer .= &mt('View embedded file: [_1]',
12799: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
12800: }
12801: }
12802: close($fh);
12803: }
12804: }
12805: if ($env{'form.embedded_ref_'.$i}) {
12806: $pathchange{$i} = 1;
12807: }
12808: }
12809: if ($output) {
12810: $output = '<p>'.$output.'</p>';
12811: }
12812: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
12813: $returnflag = 'ok';
1.1071 raeburn 12814: my $numpathchgs = scalar(keys(%pathchange));
12815: if ($numpathchgs > 0) {
1.987 raeburn 12816: if ($context eq 'portfolio') {
12817: $output .= '<p>'.&mt('or').'</p>';
12818: } elsif ($context eq 'testbank') {
1.1071 raeburn 12819: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
12820: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 12821: $returnflag = 'modify_orightml';
12822: }
12823: }
1.1071 raeburn 12824: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 12825: }
12826:
12827: sub modify_html_form {
12828: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
12829: my $end = 0;
12830: my $modifyform;
12831: if ($context eq 'upload_embedded') {
12832: return unless (ref($pathchange) eq 'HASH');
12833: if ($env{'form.number_embedded_items'}) {
12834: $end += $env{'form.number_embedded_items'};
12835: }
12836: if ($env{'form.number_pathchange_items'}) {
12837: $end += $env{'form.number_pathchange_items'};
12838: }
12839: if ($end) {
12840: for (my $i=0; $i<$end; $i++) {
12841: if ($i < $env{'form.number_embedded_items'}) {
12842: next unless($pathchange->{$i});
12843: }
12844: $modifyform .=
12845: &start_data_table_row().
12846: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
12847: 'checked="checked" /></td>'.
12848: '<td>'.$env{'form.embedded_ref_'.$i}.
12849: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
12850: &escape($env{'form.embedded_ref_'.$i}).'" />'.
12851: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
12852: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
12853: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
12854: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
12855: '<td>'.$env{'form.embedded_orig_'.$i}.
12856: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
12857: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
12858: &end_data_table_row();
1.1071 raeburn 12859: }
1.987 raeburn 12860: }
12861: } else {
12862: $modifyform = $pathchgtable;
12863: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
12864: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
12865: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12866: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
12867: }
12868: }
12869: if ($modifyform) {
1.1071 raeburn 12870: if ($actionurl eq '/adm/dependencies') {
12871: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
12872: }
1.987 raeburn 12873: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
12874: '<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".
12875: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
12876: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
12877: '</ol></p>'."\n".'<p>'.
12878: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
12879: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
12880: &start_data_table()."\n".
12881: &start_data_table_header_row().
12882: '<th>'.&mt('Change?').'</th>'.
12883: '<th>'.&mt('Current reference').'</th>'.
12884: '<th>'.&mt('Required reference').'</th>'.
12885: &end_data_table_header_row()."\n".
12886: $modifyform.
12887: &end_data_table().'<br />'."\n".$hiddenstate.
12888: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
12889: '</form>'."\n";
12890: }
12891: return;
12892: }
12893:
12894: sub modify_html_refs {
1.1123 raeburn 12895: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 12896: my $container;
12897: if ($context eq 'portfolio') {
12898: $container = $env{'form.container'};
12899: } elsif ($context eq 'coursedoc') {
12900: $container = $env{'form.primaryurl'};
1.1071 raeburn 12901: } elsif ($context eq 'manage_dependencies') {
12902: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
12903: $container = "/$container";
1.1123 raeburn 12904: } elsif ($context eq 'syllabus') {
12905: $container = $url;
1.987 raeburn 12906: } else {
1.1027 raeburn 12907: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 12908: }
12909: my (%allfiles,%codebase,$output,$content);
12910: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 12911: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 12912: if (wantarray) {
12913: return ('',0,0);
12914: } else {
12915: return;
12916: }
12917: }
12918: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12919: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 12920: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
12921: if (wantarray) {
12922: return ('',0,0);
12923: } else {
12924: return;
12925: }
12926: }
1.987 raeburn 12927: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 12928: if ($content eq '-1') {
12929: if (wantarray) {
12930: return ('',0,0);
12931: } else {
12932: return;
12933: }
12934: }
1.987 raeburn 12935: } else {
1.1071 raeburn 12936: unless ($container =~ /^\Q$dir_root\E/) {
12937: if (wantarray) {
12938: return ('',0,0);
12939: } else {
12940: return;
12941: }
12942: }
1.1317 raeburn 12943: if (open(my $fh,'<',$container)) {
1.987 raeburn 12944: $content = join('', <$fh>);
12945: close($fh);
12946: } else {
1.1071 raeburn 12947: if (wantarray) {
12948: return ('',0,0);
12949: } else {
12950: return;
12951: }
1.987 raeburn 12952: }
12953: }
12954: my ($count,$codebasecount) = (0,0);
12955: my $mm = new File::MMagic;
12956: my $mime_type = $mm->checktype_contents($content);
12957: if ($mime_type eq 'text/html') {
12958: my $parse_result =
12959: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
12960: \%codebase,\$content);
12961: if ($parse_result eq 'ok') {
12962: foreach my $i (@changes) {
12963: my $orig = &unescape($env{'form.embedded_orig_'.$i});
12964: my $ref = &unescape($env{'form.embedded_ref_'.$i});
12965: if ($allfiles{$ref}) {
12966: my $newname = $orig;
12967: my ($attrib_regexp,$codebase);
1.1006 raeburn 12968: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 12969: if ($attrib_regexp =~ /:/) {
12970: $attrib_regexp =~ s/\:/|/g;
12971: }
12972: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12973: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12974: $count += $numchg;
1.1123 raeburn 12975: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 12976: delete($allfiles{$ref});
1.987 raeburn 12977: }
12978: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 12979: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 12980: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
12981: $codebasecount ++;
12982: }
12983: }
12984: }
1.1123 raeburn 12985: my $skiprewrites;
1.987 raeburn 12986: if ($count || $codebasecount) {
12987: my $saveresult;
1.1071 raeburn 12988: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12989: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 12990: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12991: if ($url eq $container) {
12992: my ($fname) = ($container =~ m{/([^/]+)$});
12993: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12994: $count,'<span class="LC_filename">'.
1.1071 raeburn 12995: $fname.'</span>').'</p>';
1.987 raeburn 12996: } else {
12997: $output = '<p class="LC_error">'.
12998: &mt('Error: update failed for: [_1].',
12999: '<span class="LC_filename">'.
13000: $container.'</span>').'</p>';
13001: }
1.1123 raeburn 13002: if ($context eq 'syllabus') {
13003: unless ($saveresult eq 'ok') {
13004: $skiprewrites = 1;
13005: }
13006: }
1.987 raeburn 13007: } else {
1.1317 raeburn 13008: if (open(my $fh,'>',$container)) {
1.987 raeburn 13009: print $fh $content;
13010: close($fh);
13011: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13012: $count,'<span class="LC_filename">'.
13013: $container.'</span>').'</p>';
1.661 raeburn 13014: } else {
1.987 raeburn 13015: $output = '<p class="LC_error">'.
13016: &mt('Error: could not update [_1].',
13017: '<span class="LC_filename">'.
13018: $container.'</span>').'</p>';
1.661 raeburn 13019: }
13020: }
13021: }
1.1123 raeburn 13022: if (($context eq 'syllabus') && (!$skiprewrites)) {
13023: my ($actionurl,$state);
13024: $actionurl = "/public/$udom/$uname/syllabus";
13025: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13026: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13027: \%codebase,
13028: {'context' => 'rewrites',
13029: 'ignore_remote_references' => 1,});
13030: if (ref($mapping) eq 'HASH') {
13031: my $rewrites = 0;
13032: foreach my $key (keys(%{$mapping})) {
13033: next if ($key =~ m{^https?://});
13034: my $ref = $mapping->{$key};
13035: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13036: my $attrib;
13037: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13038: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13039: }
13040: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13041: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13042: $rewrites += $numchg;
13043: }
13044: }
13045: if ($rewrites) {
13046: my $saveresult;
13047: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13048: if ($url eq $container) {
13049: my ($fname) = ($container =~ m{/([^/]+)$});
13050: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13051: $count,'<span class="LC_filename">'.
13052: $fname.'</span>').'</p>';
13053: } else {
13054: $output .= '<p class="LC_error">'.
13055: &mt('Error: could not update links in [_1].',
13056: '<span class="LC_filename">'.
13057: $container.'</span>').'</p>';
13058:
13059: }
13060: }
13061: }
13062: }
1.987 raeburn 13063: } else {
13064: &logthis('Failed to parse '.$container.
13065: ' to modify references: '.$parse_result);
1.661 raeburn 13066: }
13067: }
1.1071 raeburn 13068: if (wantarray) {
13069: return ($output,$count,$codebasecount);
13070: } else {
13071: return $output;
13072: }
1.661 raeburn 13073: }
13074:
13075: sub check_for_existing {
13076: my ($path,$fname,$element) = @_;
13077: my ($state,$msg);
13078: if (-d $path.'/'.$fname) {
13079: $state = 'exists';
13080: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13081: } elsif (-e $path.'/'.$fname) {
13082: $state = 'exists';
13083: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13084: }
13085: if ($state eq 'exists') {
13086: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13087: }
13088: return ($state,$msg);
13089: }
13090:
13091: sub check_for_upload {
13092: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13093: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13094: my $filesize = length($env{'form.'.$element});
13095: if (!$filesize) {
13096: my $msg = '<span class="LC_error">'.
13097: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13098: '<span class="LC_filename">'.$fname.'</span>',
13099: $filesize).'<br />'.
1.1007 raeburn 13100: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13101: '</span>';
13102: return ('zero_bytes',$msg);
13103: }
13104: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13105: my $getpropath = 1;
1.1021 raeburn 13106: my ($dirlistref,$listerror) =
13107: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13108: my $found_file = 0;
13109: my $locked_file = 0;
1.991 raeburn 13110: my @lockers;
13111: my $navmap;
13112: if ($env{'request.course.id'}) {
13113: $navmap = Apache::lonnavmaps::navmap->new();
13114: }
1.1021 raeburn 13115: if (ref($dirlistref) eq 'ARRAY') {
13116: foreach my $line (@{$dirlistref}) {
13117: my ($file_name,$rest)=split(/\&/,$line,2);
13118: if ($file_name eq $fname){
13119: $file_name = $path.$file_name;
13120: if ($group ne '') {
13121: $file_name = $group.$file_name;
13122: }
13123: $found_file = 1;
13124: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13125: foreach my $lock (@lockers) {
13126: if (ref($lock) eq 'ARRAY') {
13127: my ($symb,$crsid) = @{$lock};
13128: if ($crsid eq $env{'request.course.id'}) {
13129: if (ref($navmap)) {
13130: my $res = $navmap->getBySymb($symb);
13131: foreach my $part (@{$res->parts()}) {
13132: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13133: unless (($slot_status == $res->RESERVED) ||
13134: ($slot_status == $res->RESERVED_LOCATION)) {
13135: $locked_file = 1;
13136: }
1.991 raeburn 13137: }
1.1021 raeburn 13138: } else {
13139: $locked_file = 1;
1.991 raeburn 13140: }
13141: } else {
13142: $locked_file = 1;
13143: }
13144: }
1.1021 raeburn 13145: }
13146: } else {
13147: my @info = split(/\&/,$rest);
13148: my $currsize = $info[6]/1000;
13149: if ($currsize < $filesize) {
13150: my $extra = $filesize - $currsize;
13151: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13152: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13153: &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.1179 bisitz 13154: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13155: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13156: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13157: return ('will_exceed_quota',$msg);
13158: }
1.984 raeburn 13159: }
13160: }
1.661 raeburn 13161: }
13162: }
13163: }
13164: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13165: my $msg = '<p class="LC_warning">'.
13166: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13167: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13168: return ('will_exceed_quota',$msg);
13169: } elsif ($found_file) {
13170: if ($locked_file) {
1.1179 bisitz 13171: my $msg = '<p class="LC_warning">';
1.661 raeburn 13172: $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.1179 bisitz 13173: $msg .= '</p>';
1.661 raeburn 13174: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13175: return ('file_locked',$msg);
13176: } else {
1.1179 bisitz 13177: my $msg = '<p class="LC_error">';
1.984 raeburn 13178: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179 bisitz 13179: $msg .= '</p>';
1.984 raeburn 13180: return ('existingfile',$msg);
1.661 raeburn 13181: }
13182: }
13183: }
13184:
1.987 raeburn 13185: sub check_for_traversal {
13186: my ($path,$url,$toplevel) = @_;
13187: my @parts=split(/\//,$path);
13188: my $cleanpath;
13189: my $fullpath = $url;
13190: for (my $i=0;$i<@parts;$i++) {
13191: next if ($parts[$i] eq '.');
13192: if ($parts[$i] eq '..') {
13193: $fullpath =~ s{([^/]+/)$}{};
13194: } else {
13195: $fullpath .= $parts[$i].'/';
13196: }
13197: }
13198: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13199: $cleanpath = $1;
13200: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13201: my $curr_toprel = $1;
13202: my @parts = split(/\//,$curr_toprel);
13203: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13204: my @urlparts = split(/\//,$url_toprel);
13205: my $doubledots;
13206: my $startdiff = -1;
13207: for (my $i=0; $i<@urlparts; $i++) {
13208: if ($startdiff == -1) {
13209: unless ($urlparts[$i] eq $parts[$i]) {
13210: $startdiff = $i;
13211: $doubledots .= '../';
13212: }
13213: } else {
13214: $doubledots .= '../';
13215: }
13216: }
13217: if ($startdiff > -1) {
13218: $cleanpath = $doubledots;
13219: for (my $i=$startdiff; $i<@parts; $i++) {
13220: $cleanpath .= $parts[$i].'/';
13221: }
13222: }
13223: }
13224: $cleanpath =~ s{(/)$}{};
13225: return $cleanpath;
13226: }
1.31 albertel 13227:
1.1053 raeburn 13228: sub is_archive_file {
13229: my ($mimetype) = @_;
13230: if (($mimetype eq 'application/octet-stream') ||
13231: ($mimetype eq 'application/x-stuffit') ||
13232: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13233: return 1;
13234: }
13235: return;
13236: }
13237:
13238: sub decompress_form {
1.1065 raeburn 13239: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13240: my %lt = &Apache::lonlocal::texthash (
13241: this => 'This file is an archive file.',
1.1067 raeburn 13242: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13243: itsc => 'Its contents are as follows:',
1.1053 raeburn 13244: youm => 'You may wish to extract its contents.',
13245: extr => 'Extract contents',
1.1067 raeburn 13246: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13247: proa => 'Process automatically?',
1.1053 raeburn 13248: yes => 'Yes',
13249: no => 'No',
1.1067 raeburn 13250: fold => 'Title for folder containing movie',
13251: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13252: );
1.1065 raeburn 13253: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13254: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13255: my $info = &list_archive_contents($fileloc,\@paths);
13256: if (@paths) {
13257: foreach my $path (@paths) {
13258: $path =~ s{^/}{};
1.1067 raeburn 13259: if ($path =~ m{^([^/]+)/$}) {
13260: $topdir = $1;
13261: }
1.1065 raeburn 13262: if ($path =~ m{^([^/]+)/}) {
13263: $toplevel{$1} = $path;
13264: } else {
13265: $toplevel{$path} = $path;
13266: }
13267: }
13268: }
1.1067 raeburn 13269: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13270: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13271: "$topdir/media/",
13272: "$topdir/media/$topdir.mp4",
13273: "$topdir/media/FirstFrame.png",
13274: "$topdir/media/player.swf",
13275: "$topdir/media/swfobject.js",
13276: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13277: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13278: "$topdir/$topdir.mp4",
13279: "$topdir/$topdir\_config.xml",
13280: "$topdir/$topdir\_controller.swf",
13281: "$topdir/$topdir\_embed.css",
13282: "$topdir/$topdir\_First_Frame.png",
13283: "$topdir/$topdir\_player.html",
13284: "$topdir/$topdir\_Thumbnails.png",
13285: "$topdir/playerProductInstall.swf",
13286: "$topdir/scripts/",
13287: "$topdir/scripts/config_xml.js",
13288: "$topdir/scripts/handlebars.js",
13289: "$topdir/scripts/jquery-1.7.1.min.js",
13290: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13291: "$topdir/scripts/modernizr.js",
13292: "$topdir/scripts/player-min.js",
13293: "$topdir/scripts/swfobject.js",
13294: "$topdir/skins/",
13295: "$topdir/skins/configuration_express.xml",
13296: "$topdir/skins/express_show/",
13297: "$topdir/skins/express_show/player-min.css",
13298: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13299: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13300: "$topdir/$topdir.mp4",
13301: "$topdir/$topdir\_config.xml",
13302: "$topdir/$topdir\_controller.swf",
13303: "$topdir/$topdir\_embed.css",
13304: "$topdir/$topdir\_First_Frame.png",
13305: "$topdir/$topdir\_player.html",
13306: "$topdir/$topdir\_Thumbnails.png",
13307: "$topdir/playerProductInstall.swf",
13308: "$topdir/scripts/",
13309: "$topdir/scripts/config_xml.js",
13310: "$topdir/scripts/techsmith-smart-player.min.js",
13311: "$topdir/skins/",
13312: "$topdir/skins/configuration_express.xml",
13313: "$topdir/skins/express_show/",
13314: "$topdir/skins/express_show/spritesheet.min.css",
13315: "$topdir/skins/express_show/spritesheet.png",
13316: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13317: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13318: if (@diffs == 0) {
1.1164 raeburn 13319: $is_camtasia = 6;
13320: } else {
1.1197 raeburn 13321: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13322: if (@diffs == 0) {
13323: $is_camtasia = 8;
1.1197 raeburn 13324: } else {
13325: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13326: if (@diffs == 0) {
13327: $is_camtasia = 8;
13328: }
1.1164 raeburn 13329: }
1.1067 raeburn 13330: }
13331: }
13332: my $output;
13333: if ($is_camtasia) {
13334: $output = <<"ENDCAM";
13335: <script type="text/javascript" language="Javascript">
13336: // <![CDATA[
13337:
13338: function camtasiaToggle() {
13339: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13340: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13341: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13342: document.getElementById('camtasia_titles').style.display='block';
13343: } else {
13344: document.getElementById('camtasia_titles').style.display='none';
13345: }
13346: }
13347: }
13348: return;
13349: }
13350:
13351: // ]]>
13352: </script>
13353: <p>$lt{'camt'}</p>
13354: ENDCAM
1.1065 raeburn 13355: } else {
1.1067 raeburn 13356: $output = '<p>'.$lt{'this'};
13357: if ($info eq '') {
13358: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13359: } else {
13360: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13361: '<div><pre>'.$info.'</pre></div>';
13362: }
1.1065 raeburn 13363: }
1.1067 raeburn 13364: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 13365: my $duplicates;
13366: my $num = 0;
13367: if (ref($dirlist) eq 'ARRAY') {
13368: foreach my $item (@{$dirlist}) {
13369: if (ref($item) eq 'ARRAY') {
13370: if (exists($toplevel{$item->[0]})) {
13371: $duplicates .=
13372: &start_data_table_row().
13373: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
13374: 'value="0" checked="checked" />'.&mt('No').'</label>'.
13375: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
13376: 'value="1" />'.&mt('Yes').'</label>'.
13377: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
13378: '<td>'.$item->[0].'</td>';
13379: if ($item->[2]) {
13380: $duplicates .= '<td>'.&mt('Directory').'</td>';
13381: } else {
13382: $duplicates .= '<td>'.&mt('File').'</td>';
13383: }
13384: $duplicates .= '<td>'.$item->[3].'</td>'.
13385: '<td>'.
13386: &Apache::lonlocal::locallocaltime($item->[4]).
13387: '</td>'.
13388: &end_data_table_row();
13389: $num ++;
13390: }
13391: }
13392: }
13393: }
13394: my $itemcount;
13395: if (@paths > 0) {
13396: $itemcount = scalar(@paths);
13397: } else {
13398: $itemcount = 1;
13399: }
1.1067 raeburn 13400: if ($is_camtasia) {
13401: $output .= $lt{'auto'}.'<br />'.
13402: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 13403: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 13404: $lt{'yes'}.'</label> <label>'.
13405: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
13406: $lt{'no'}.'</label></span><br />'.
13407: '<div id="camtasia_titles" style="display:block">'.
13408: &Apache::lonhtmlcommon::start_pick_box().
13409: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
13410: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
13411: &Apache::lonhtmlcommon::row_closure().
13412: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
13413: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
13414: &Apache::lonhtmlcommon::row_closure(1).
13415: &Apache::lonhtmlcommon::end_pick_box().
13416: '</div>';
13417: }
1.1065 raeburn 13418: $output .=
13419: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 13420: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
13421: "\n";
1.1065 raeburn 13422: if ($duplicates ne '') {
13423: $output .= '<p><span class="LC_warning">'.
13424: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
13425: &start_data_table().
13426: &start_data_table_header_row().
13427: '<th>'.&mt('Overwrite?').'</th>'.
13428: '<th>'.&mt('Name').'</th>'.
13429: '<th>'.&mt('Type').'</th>'.
13430: '<th>'.&mt('Size').'</th>'.
13431: '<th>'.&mt('Last modified').'</th>'.
13432: &end_data_table_header_row().
13433: $duplicates.
13434: &end_data_table().
13435: '</p>';
13436: }
1.1067 raeburn 13437: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 13438: if (ref($hiddenelements) eq 'HASH') {
13439: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
13440: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
13441: }
13442: }
13443: $output .= <<"END";
1.1067 raeburn 13444: <br />
1.1053 raeburn 13445: <input type="submit" name="decompress" value="$lt{'extr'}" />
13446: </form>
13447: $noextract
13448: END
13449: return $output;
13450: }
13451:
1.1065 raeburn 13452: sub decompression_utility {
13453: my ($program) = @_;
13454: my @utilities = ('tar','gunzip','bunzip2','unzip');
13455: my $location;
13456: if (grep(/^\Q$program\E$/,@utilities)) {
13457: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
13458: '/usr/sbin/') {
13459: if (-x $dir.$program) {
13460: $location = $dir.$program;
13461: last;
13462: }
13463: }
13464: }
13465: return $location;
13466: }
13467:
13468: sub list_archive_contents {
13469: my ($file,$pathsref) = @_;
13470: my (@cmd,$output);
13471: my $needsregexp;
13472: if ($file =~ /\.zip$/) {
13473: @cmd = (&decompression_utility('unzip'),"-l");
13474: $needsregexp = 1;
13475: } elsif (($file =~ m/\.tar\.gz$/) ||
13476: ($file =~ /\.tgz$/)) {
13477: @cmd = (&decompression_utility('tar'),"-ztf");
13478: } elsif ($file =~ /\.tar\.bz2$/) {
13479: @cmd = (&decompression_utility('tar'),"-jtf");
13480: } elsif ($file =~ m|\.tar$|) {
13481: @cmd = (&decompression_utility('tar'),"-tf");
13482: }
13483: if (@cmd) {
13484: undef($!);
13485: undef($@);
13486: if (open(my $fh,"-|", @cmd, $file)) {
13487: while (my $line = <$fh>) {
13488: $output .= $line;
13489: chomp($line);
13490: my $item;
13491: if ($needsregexp) {
13492: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
13493: } else {
13494: $item = $line;
13495: }
13496: if ($item ne '') {
13497: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
13498: push(@{$pathsref},$item);
13499: }
13500: }
13501: }
13502: close($fh);
13503: }
13504: }
13505: return $output;
13506: }
13507:
1.1053 raeburn 13508: sub decompress_uploaded_file {
13509: my ($file,$dir) = @_;
13510: &Apache::lonnet::appenv({'cgi.file' => $file});
13511: &Apache::lonnet::appenv({'cgi.dir' => $dir});
13512: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
13513: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
13514: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
13515: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
13516: my $decompressed = $env{'cgi.decompressed'};
13517: &Apache::lonnet::delenv('cgi.file');
13518: &Apache::lonnet::delenv('cgi.dir');
13519: &Apache::lonnet::delenv('cgi.decompressed');
13520: return ($decompressed,$result);
13521: }
13522:
1.1055 raeburn 13523: sub process_decompression {
13524: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 13525: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
13526: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13527: &mt('Unexpected file path.').'</p>'."\n";
13528: }
13529: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
13530: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13531: &mt('Unexpected course context.').'</p>'."\n";
13532: }
1.1293 raeburn 13533: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 13534: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13535: &mt('Filename contained unexpected characters.').'</p>'."\n";
13536: }
1.1055 raeburn 13537: my ($dir,$error,$warning,$output);
1.1180 raeburn 13538: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 13539: $error = &mt('Filename not a supported archive file type.').
13540: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 13541: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
13542: } else {
13543: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13544: if ($docuhome eq 'no_host') {
13545: $error = &mt('Could not determine home server for course.');
13546: } else {
13547: my @ids=&Apache::lonnet::current_machine_ids();
13548: my $currdir = "$dir_root/$destination";
13549: if (grep(/^\Q$docuhome\E$/,@ids)) {
13550: $dir = &LONCAPA::propath($docudom,$docuname).
13551: "$dir_root/$destination";
13552: } else {
13553: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
13554: "$dir_root/$docudom/$docuname/$destination";
13555: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
13556: $error = &mt('Archive file not found.');
13557: }
13558: }
1.1065 raeburn 13559: my (@to_overwrite,@to_skip);
13560: if ($env{'form.archive_overwrite_total'} > 0) {
13561: my $total = $env{'form.archive_overwrite_total'};
13562: for (my $i=0; $i<$total; $i++) {
13563: if ($env{'form.archive_overwrite_'.$i} == 1) {
13564: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
13565: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
13566: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
13567: }
13568: }
13569: }
13570: my $numskip = scalar(@to_skip);
1.1292 raeburn 13571: my $numoverwrite = scalar(@to_overwrite);
13572: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 13573: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
13574: } elsif ($dir eq '') {
1.1055 raeburn 13575: $error = &mt('Directory containing archive file unavailable.');
13576: } elsif (!$error) {
1.1065 raeburn 13577: my ($decompressed,$display);
1.1292 raeburn 13578: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 13579: my $tempdir = time.'_'.$$.int(rand(10000));
13580: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 13581: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
13582: ($decompressed,$display) =
13583: &decompress_uploaded_file($file,"$dir/$tempdir");
13584: foreach my $item (@to_skip) {
13585: if (($item ne '') && ($item !~ /\.\./)) {
13586: if (-f "$dir/$tempdir/$item") {
13587: unlink("$dir/$tempdir/$item");
13588: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 13589: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 13590: }
13591: }
13592: }
13593: foreach my $item (@to_overwrite) {
13594: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
13595: if (($item ne '') && ($item !~ /\.\./)) {
13596: if (-f "$dir/$item") {
13597: unlink("$dir/$item");
13598: } elsif (-d "$dir/$item") {
1.1300 raeburn 13599: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 13600: }
13601: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
13602: }
1.1065 raeburn 13603: }
13604: }
1.1292 raeburn 13605: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 13606: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 13607: }
1.1065 raeburn 13608: }
13609: } else {
13610: ($decompressed,$display) =
13611: &decompress_uploaded_file($file,$dir);
13612: }
1.1055 raeburn 13613: if ($decompressed eq 'ok') {
1.1065 raeburn 13614: $output = '<p class="LC_info">'.
13615: &mt('Files extracted successfully from archive.').
13616: '</p>'."\n";
1.1055 raeburn 13617: my ($warning,$result,@contents);
13618: my ($newdirlistref,$newlisterror) =
13619: &Apache::lonnet::dirlist($currdir,$docudom,
13620: $docuname,1);
13621: my (%is_dir,%changes,@newitems);
13622: my $dirptr = 16384;
1.1065 raeburn 13623: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 13624: foreach my $dir_line (@{$newdirlistref}) {
13625: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 13626: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 13627: push(@newitems,$item);
13628: if ($dirptr&$testdir) {
13629: $is_dir{$item} = 1;
13630: }
13631: $changes{$item} = 1;
13632: }
13633: }
13634: }
13635: if (keys(%changes) > 0) {
13636: foreach my $item (sort(@newitems)) {
13637: if ($changes{$item}) {
13638: push(@contents,$item);
13639: }
13640: }
13641: }
13642: if (@contents > 0) {
1.1067 raeburn 13643: my $wantform;
13644: unless ($env{'form.autoextract_camtasia'}) {
13645: $wantform = 1;
13646: }
1.1056 raeburn 13647: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 13648: my ($count,$datatable) = &get_extracted($docudom,$docuname,
13649: $currdir,\%is_dir,
13650: \%children,\%parent,
1.1056 raeburn 13651: \@contents,\%dirorder,
13652: \%titles,$wantform);
1.1055 raeburn 13653: if ($datatable ne '') {
13654: $output .= &archive_options_form('decompressed',$datatable,
13655: $count,$hiddenelem);
1.1065 raeburn 13656: my $startcount = 6;
1.1055 raeburn 13657: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 13658: \%titles,\%children);
1.1055 raeburn 13659: }
1.1067 raeburn 13660: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 13661: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 13662: my %displayed;
13663: my $total = 1;
13664: $env{'form.archive_directory'} = [];
13665: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
13666: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
13667: $path =~ s{/$}{};
13668: my $item;
13669: if ($path ne '') {
13670: $item = "$path/$titles{$i}";
13671: } else {
13672: $item = $titles{$i};
13673: }
13674: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
13675: if ($item eq $contents[0]) {
13676: push(@{$env{'form.archive_directory'}},$i);
13677: $env{'form.archive_'.$i} = 'display';
13678: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
13679: $displayed{'folder'} = $i;
1.1164 raeburn 13680: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
13681: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 13682: $env{'form.archive_'.$i} = 'display';
13683: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
13684: $displayed{'web'} = $i;
13685: } else {
1.1164 raeburn 13686: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
13687: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
13688: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 13689: push(@{$env{'form.archive_directory'}},$i);
13690: }
13691: $env{'form.archive_'.$i} = 'dependency';
13692: }
13693: $total ++;
13694: }
13695: for (my $i=1; $i<$total; $i++) {
13696: next if ($i == $displayed{'web'});
13697: next if ($i == $displayed{'folder'});
13698: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
13699: }
13700: $env{'form.phase'} = 'decompress_cleanup';
13701: $env{'form.archivedelete'} = 1;
13702: $env{'form.archive_count'} = $total-1;
13703: $output .=
13704: &process_extracted_files('coursedocs',$docudom,
13705: $docuname,$destination,
13706: $dir_root,$hiddenelem);
13707: }
1.1055 raeburn 13708: } else {
13709: $warning = &mt('No new items extracted from archive file.');
13710: }
13711: } else {
13712: $output = $display;
13713: $error = &mt('An error occurred during extraction from the archive file.');
13714: }
13715: }
13716: }
13717: }
13718: if ($error) {
13719: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13720: $error.'</p>'."\n";
13721: }
13722: if ($warning) {
13723: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13724: }
13725: return $output;
13726: }
13727:
13728: sub get_extracted {
1.1056 raeburn 13729: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
13730: $titles,$wantform) = @_;
1.1055 raeburn 13731: my $count = 0;
13732: my $depth = 0;
13733: my $datatable;
1.1056 raeburn 13734: my @hierarchy;
1.1055 raeburn 13735: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 13736: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
13737: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 13738: foreach my $item (@{$contents}) {
13739: $count ++;
1.1056 raeburn 13740: @{$dirorder->{$count}} = @hierarchy;
13741: $titles->{$count} = $item;
1.1055 raeburn 13742: &archive_hierarchy($depth,$count,$parent,$children);
13743: if ($wantform) {
13744: $datatable .= &archive_row($is_dir->{$item},$item,
13745: $currdir,$depth,$count);
13746: }
13747: if ($is_dir->{$item}) {
13748: $depth ++;
1.1056 raeburn 13749: push(@hierarchy,$count);
13750: $parent->{$depth} = $count;
1.1055 raeburn 13751: $datatable .=
13752: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 13753: \$depth,\$count,\@hierarchy,$dirorder,
13754: $children,$parent,$titles,$wantform);
1.1055 raeburn 13755: $depth --;
1.1056 raeburn 13756: pop(@hierarchy);
1.1055 raeburn 13757: }
13758: }
13759: return ($count,$datatable);
13760: }
13761:
13762: sub recurse_extracted_archive {
1.1056 raeburn 13763: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
13764: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 13765: my $result='';
1.1056 raeburn 13766: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
13767: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
13768: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 13769: return $result;
13770: }
13771: my $dirptr = 16384;
13772: my ($newdirlistref,$newlisterror) =
13773: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
13774: if (ref($newdirlistref) eq 'ARRAY') {
13775: foreach my $dir_line (@{$newdirlistref}) {
13776: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
13777: unless ($item =~ /^\.+$/) {
13778: $$count ++;
1.1056 raeburn 13779: @{$dirorder->{$$count}} = @{$hierarchy};
13780: $titles->{$$count} = $item;
1.1055 raeburn 13781: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 13782:
1.1055 raeburn 13783: my $is_dir;
13784: if ($dirptr&$testdir) {
13785: $is_dir = 1;
13786: }
13787: if ($wantform) {
13788: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
13789: }
13790: if ($is_dir) {
13791: $$depth ++;
1.1056 raeburn 13792: push(@{$hierarchy},$$count);
13793: $parent->{$$depth} = $$count;
1.1055 raeburn 13794: $result .=
13795: &recurse_extracted_archive("$currdir/$item",$docudom,
13796: $docuname,$depth,$count,
1.1056 raeburn 13797: $hierarchy,$dirorder,$children,
13798: $parent,$titles,$wantform);
1.1055 raeburn 13799: $$depth --;
1.1056 raeburn 13800: pop(@{$hierarchy});
1.1055 raeburn 13801: }
13802: }
13803: }
13804: }
13805: return $result;
13806: }
13807:
13808: sub archive_hierarchy {
13809: my ($depth,$count,$parent,$children) =@_;
13810: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
13811: if (exists($parent->{$depth})) {
13812: $children->{$parent->{$depth}} .= $count.':';
13813: }
13814: }
13815: return;
13816: }
13817:
13818: sub archive_row {
13819: my ($is_dir,$item,$currdir,$depth,$count) = @_;
13820: my ($name) = ($item =~ m{([^/]+)$});
13821: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 13822: 'display' => 'Add as file',
1.1055 raeburn 13823: 'dependency' => 'Include as dependency',
13824: 'discard' => 'Discard',
13825: );
13826: if ($is_dir) {
1.1059 raeburn 13827: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 13828: }
1.1056 raeburn 13829: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
13830: my $offset = 0;
1.1055 raeburn 13831: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 13832: $offset ++;
1.1065 raeburn 13833: if ($action ne 'display') {
13834: $offset ++;
13835: }
1.1055 raeburn 13836: $output .= '<td><span class="LC_nobreak">'.
13837: '<label><input type="radio" name="archive_'.$count.
13838: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
13839: my $text = $choices{$action};
13840: if ($is_dir) {
13841: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
13842: if ($action eq 'display') {
1.1059 raeburn 13843: $text = &mt('Add as folder');
1.1055 raeburn 13844: }
1.1056 raeburn 13845: } else {
13846: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
13847:
13848: }
13849: $output .= ' /> '.$choices{$action}.'</label></span>';
13850: if ($action eq 'dependency') {
13851: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
13852: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
13853: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
13854: '<option value=""></option>'."\n".
13855: '</select>'."\n".
13856: '</div>';
1.1059 raeburn 13857: } elsif ($action eq 'display') {
13858: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
13859: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
13860: '</div>';
1.1055 raeburn 13861: }
1.1056 raeburn 13862: $output .= '</td>';
1.1055 raeburn 13863: }
13864: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
13865: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
13866: for (my $i=0; $i<$depth; $i++) {
13867: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
13868: }
13869: if ($is_dir) {
13870: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
13871: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
13872: } else {
13873: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
13874: }
13875: $output .= ' '.$name.'</td>'."\n".
13876: &end_data_table_row();
13877: return $output;
13878: }
13879:
13880: sub archive_options_form {
1.1065 raeburn 13881: my ($form,$display,$count,$hiddenelem) = @_;
13882: my %lt = &Apache::lonlocal::texthash(
13883: perm => 'Permanently remove archive file?',
13884: hows => 'How should each extracted item be incorporated in the course?',
13885: cont => 'Content actions for all',
13886: addf => 'Add as folder/file',
13887: incd => 'Include as dependency for a displayed file',
13888: disc => 'Discard',
13889: no => 'No',
13890: yes => 'Yes',
13891: save => 'Save',
13892: );
13893: my $output = <<"END";
13894: <form name="$form" method="post" action="">
13895: <p><span class="LC_nobreak">$lt{'perm'}
13896: <label>
13897: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
13898: </label>
13899:
13900: <label>
13901: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
13902: </span>
13903: </p>
13904: <input type="hidden" name="phase" value="decompress_cleanup" />
13905: <br />$lt{'hows'}
13906: <div class="LC_columnSection">
13907: <fieldset>
13908: <legend>$lt{'cont'}</legend>
13909: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
13910: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
13911: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
13912: </fieldset>
13913: </div>
13914: END
13915: return $output.
1.1055 raeburn 13916: &start_data_table()."\n".
1.1065 raeburn 13917: $display."\n".
1.1055 raeburn 13918: &end_data_table()."\n".
13919: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
13920: $hiddenelem.
1.1065 raeburn 13921: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 13922: '</form>';
13923: }
13924:
13925: sub archive_javascript {
1.1056 raeburn 13926: my ($startcount,$numitems,$titles,$children) = @_;
13927: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 13928: my $maintitle = $env{'form.comment'};
1.1055 raeburn 13929: my $scripttag = <<START;
13930: <script type="text/javascript">
13931: // <![CDATA[
13932:
13933: function checkAll(form,prefix) {
13934: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
13935: for (var i=0; i < form.elements.length; i++) {
13936: var id = form.elements[i].id;
13937: if ((id != '') && (id != undefined)) {
13938: if (idstr.test(id)) {
13939: if (form.elements[i].type == 'radio') {
13940: form.elements[i].checked = true;
1.1056 raeburn 13941: var nostart = i-$startcount;
1.1059 raeburn 13942: var offset = nostart%7;
13943: var count = (nostart-offset)/7;
1.1056 raeburn 13944: dependencyCheck(form,count,offset);
1.1055 raeburn 13945: }
13946: }
13947: }
13948: }
13949: }
13950:
13951: function propagateCheck(form,count) {
13952: if (count > 0) {
1.1059 raeburn 13953: var startelement = $startcount + ((count-1) * 7);
13954: for (var j=1; j<6; j++) {
13955: if ((j != 2) && (j != 4)) {
1.1056 raeburn 13956: var item = startelement + j;
13957: if (form.elements[item].type == 'radio') {
13958: if (form.elements[item].checked) {
13959: containerCheck(form,count,j);
13960: break;
13961: }
1.1055 raeburn 13962: }
13963: }
13964: }
13965: }
13966: }
13967:
13968: numitems = $numitems
1.1056 raeburn 13969: var titles = new Array(numitems);
13970: var parents = new Array(numitems);
1.1055 raeburn 13971: for (var i=0; i<numitems; i++) {
1.1056 raeburn 13972: parents[i] = new Array;
1.1055 raeburn 13973: }
1.1059 raeburn 13974: var maintitle = '$maintitle';
1.1055 raeburn 13975:
13976: START
13977:
1.1056 raeburn 13978: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
13979: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 13980: for (my $i=0; $i<@contents; $i ++) {
13981: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
13982: }
13983: }
13984:
1.1056 raeburn 13985: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
13986: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
13987: }
13988:
1.1055 raeburn 13989: $scripttag .= <<END;
13990:
13991: function containerCheck(form,count,offset) {
13992: if (count > 0) {
1.1056 raeburn 13993: dependencyCheck(form,count,offset);
1.1059 raeburn 13994: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 13995: form.elements[item].checked = true;
13996: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
13997: if (parents[count].length > 0) {
13998: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 13999: containerCheck(form,parents[count][j],offset);
14000: }
14001: }
14002: }
14003: }
14004: }
14005:
14006: function dependencyCheck(form,count,offset) {
14007: if (count > 0) {
1.1059 raeburn 14008: var chosen = (offset+$startcount)+7*(count-1);
14009: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14010: var currtype = form.elements[depitem].type;
14011: if (form.elements[chosen].value == 'dependency') {
14012: document.getElementById('arc_depon_'+count).style.display='block';
14013: form.elements[depitem].options.length = 0;
14014: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14015: for (var i=1; i<=numitems; i++) {
14016: if (i == count) {
14017: continue;
14018: }
1.1059 raeburn 14019: var startelement = $startcount + (i-1) * 7;
14020: for (var j=1; j<6; j++) {
14021: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14022: var item = startelement + j;
14023: if (form.elements[item].type == 'radio') {
14024: if (form.elements[item].checked) {
14025: if (form.elements[item].value == 'display') {
14026: var n = form.elements[depitem].options.length;
14027: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14028: }
14029: }
14030: }
14031: }
14032: }
14033: }
14034: } else {
14035: document.getElementById('arc_depon_'+count).style.display='none';
14036: form.elements[depitem].options.length = 0;
14037: form.elements[depitem].options[0] = new Option('Select','',true,true);
14038: }
1.1059 raeburn 14039: titleCheck(form,count,offset);
1.1056 raeburn 14040: }
14041: }
14042:
14043: function propagateSelect(form,count,offset) {
14044: if (count > 0) {
1.1065 raeburn 14045: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14046: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14047: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14048: if (parents[count].length > 0) {
14049: for (var j=0; j<parents[count].length; j++) {
14050: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14051: }
14052: }
14053: }
14054: }
14055: }
1.1056 raeburn 14056:
14057: function containerSelect(form,count,offset,picked) {
14058: if (count > 0) {
1.1065 raeburn 14059: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14060: if (form.elements[item].type == 'radio') {
14061: if (form.elements[item].value == 'dependency') {
14062: if (form.elements[item+1].type == 'select-one') {
14063: for (var i=0; i<form.elements[item+1].options.length; i++) {
14064: if (form.elements[item+1].options[i].value == picked) {
14065: form.elements[item+1].selectedIndex = i;
14066: break;
14067: }
14068: }
14069: }
14070: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14071: if (parents[count].length > 0) {
14072: for (var j=0; j<parents[count].length; j++) {
14073: containerSelect(form,parents[count][j],offset,picked);
14074: }
14075: }
14076: }
14077: }
14078: }
14079: }
14080: }
14081:
1.1059 raeburn 14082: function titleCheck(form,count,offset) {
14083: if (count > 0) {
14084: var chosen = (offset+$startcount)+7*(count-1);
14085: var depitem = $startcount + ((count-1) * 7) + 2;
14086: var currtype = form.elements[depitem].type;
14087: if (form.elements[chosen].value == 'display') {
14088: document.getElementById('arc_title_'+count).style.display='block';
14089: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14090: document.getElementById('archive_title_'+count).value=maintitle;
14091: }
14092: } else {
14093: document.getElementById('arc_title_'+count).style.display='none';
14094: if (currtype == 'text') {
14095: document.getElementById('archive_title_'+count).value='';
14096: }
14097: }
14098: }
14099: return;
14100: }
14101:
1.1055 raeburn 14102: // ]]>
14103: </script>
14104: END
14105: return $scripttag;
14106: }
14107:
14108: sub process_extracted_files {
1.1067 raeburn 14109: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14110: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14111: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14112: my @ids=&Apache::lonnet::current_machine_ids();
14113: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14114: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14115: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14116: if (grep(/^\Q$docuhome\E$/,@ids)) {
14117: $prefix = &LONCAPA::propath($docudom,$docuname);
14118: $pathtocheck = "$dir_root/$destination";
14119: $dir = $dir_root;
14120: $ishome = 1;
14121: } else {
14122: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14123: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14124: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14125: }
14126: my $currdir = "$dir_root/$destination";
14127: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14128: if ($env{'form.folderpath'}) {
14129: my @items = split('&',$env{'form.folderpath'});
14130: $folders{'0'} = $items[-2];
1.1099 raeburn 14131: if ($env{'form.folderpath'} =~ /\:1$/) {
14132: $containers{'0'}='page';
14133: } else {
14134: $containers{'0'}='sequence';
14135: }
1.1055 raeburn 14136: }
14137: my @archdirs = &get_env_multiple('form.archive_directory');
14138: if ($numitems) {
14139: for (my $i=1; $i<=$numitems; $i++) {
14140: my $path = $env{'form.archive_content_'.$i};
14141: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14142: my $item = $1;
14143: $toplevelitems{$item} = $i;
14144: if (grep(/^\Q$i\E$/,@archdirs)) {
14145: $is_dir{$item} = 1;
14146: }
14147: }
14148: }
14149: }
1.1067 raeburn 14150: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14151: if (keys(%toplevelitems) > 0) {
14152: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14153: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14154: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14155: }
1.1066 raeburn 14156: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14157: if ($numitems) {
14158: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14159: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14160: my $path = $env{'form.archive_content_'.$i};
14161: if ($path =~ /^\Q$pathtocheck\E/) {
14162: if ($env{'form.archive_'.$i} eq 'discard') {
14163: if ($prefix ne '' && $path ne '') {
14164: if (-e $prefix.$path) {
1.1066 raeburn 14165: if ((@archdirs > 0) &&
14166: (grep(/^\Q$i\E$/,@archdirs))) {
14167: $todeletedir{$prefix.$path} = 1;
14168: } else {
14169: $todelete{$prefix.$path} = 1;
14170: }
1.1055 raeburn 14171: }
14172: }
14173: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14174: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14175: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14176: $docstitle = $env{'form.archive_title_'.$i};
14177: if ($docstitle eq '') {
14178: $docstitle = $title;
14179: }
1.1055 raeburn 14180: $outer = 0;
1.1056 raeburn 14181: if (ref($dirorder{$i}) eq 'ARRAY') {
14182: if (@{$dirorder{$i}} > 0) {
14183: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14184: if ($env{'form.archive_'.$item} eq 'display') {
14185: $outer = $item;
14186: last;
14187: }
14188: }
14189: }
14190: }
14191: my ($errtext,$fatal) =
14192: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14193: '/'.$folders{$outer}.'.'.
14194: $containers{$outer});
14195: next if ($fatal);
14196: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14197: if ($context eq 'coursedocs') {
1.1056 raeburn 14198: $mapinner{$i} = time;
1.1055 raeburn 14199: $folders{$i} = 'default_'.$mapinner{$i};
14200: $containers{$i} = 'sequence';
14201: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14202: $folders{$i}.'.'.$containers{$i};
14203: my $newidx = &LONCAPA::map::getresidx();
14204: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14205: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14206: push(@LONCAPA::map::order,$newidx);
14207: my ($outtext,$errtext) =
14208: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14209: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14210: '.'.$containers{$outer},1,1);
1.1056 raeburn 14211: $newseqid{$i} = $newidx;
1.1067 raeburn 14212: unless ($errtext) {
1.1294 raeburn 14213: $result .= '<li>'.&mt('Folder: [_1] added to course',
14214: &HTML::Entities::encode($docstitle,'<>&"')).
14215: '</li>'."\n";
1.1067 raeburn 14216: }
1.1055 raeburn 14217: }
14218: } else {
14219: if ($context eq 'coursedocs') {
14220: my $newidx=&LONCAPA::map::getresidx();
14221: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14222: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14223: $title;
1.1294 raeburn 14224: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
14225: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14226: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14227: }
14228: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14229: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14230: }
14231: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14232: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14233: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14234: unless ($ishome) {
14235: my $fetch = "$newdest{$i}/$title";
14236: $fetch =~ s/^\Q$prefix$dir\E//;
14237: $prompttofetch{$fetch} = 1;
14238: }
1.1292 raeburn 14239: }
1.1067 raeburn 14240: }
1.1294 raeburn 14241: $LONCAPA::map::resources[$newidx]=
14242: $docstitle.':'.$url.':false:normal:res';
14243: push(@LONCAPA::map::order, $newidx);
14244: my ($outtext,$errtext)=
14245: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14246: $docuname.'/'.$folders{$outer}.
14247: '.'.$containers{$outer},1,1);
14248: unless ($errtext) {
14249: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14250: $result .= '<li>'.&mt('File: [_1] added to course',
14251: &HTML::Entities::encode($docstitle,'<>&"')).
14252: '</li>'."\n";
14253: }
1.1067 raeburn 14254: }
1.1294 raeburn 14255: } else {
14256: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14257: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14258: }
1.1055 raeburn 14259: }
14260: }
1.1086 raeburn 14261: }
14262: } else {
1.1294 raeburn 14263: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14264: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14265: }
14266: }
14267: for (my $i=1; $i<=$numitems; $i++) {
14268: next unless ($env{'form.archive_'.$i} eq 'dependency');
14269: my $path = $env{'form.archive_content_'.$i};
14270: if ($path =~ /^\Q$pathtocheck\E/) {
14271: my ($title) = ($path =~ m{/([^/]+)$});
14272: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14273: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14274: if (ref($dirorder{$i}) eq 'ARRAY') {
14275: my ($itemidx,$fullpath,$relpath);
14276: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14277: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14278: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14279: if ($dirorder{$i}->[$j] eq $container) {
14280: $itemidx = $j;
1.1056 raeburn 14281: }
14282: }
1.1086 raeburn 14283: }
14284: if ($itemidx eq '') {
14285: $itemidx = 0;
14286: }
14287: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14288: if ($mapinner{$referrer{$i}}) {
14289: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14290: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14291: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14292: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14293: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14294: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14295: if (!-e $fullpath) {
14296: mkdir($fullpath,0755);
1.1056 raeburn 14297: }
14298: }
1.1086 raeburn 14299: } else {
14300: last;
1.1056 raeburn 14301: }
1.1086 raeburn 14302: }
14303: }
14304: } elsif ($newdest{$referrer{$i}}) {
14305: $fullpath = $newdest{$referrer{$i}};
14306: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14307: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14308: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14309: last;
14310: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14311: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14312: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14313: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14314: if (!-e $fullpath) {
14315: mkdir($fullpath,0755);
1.1056 raeburn 14316: }
14317: }
1.1086 raeburn 14318: } else {
14319: last;
1.1056 raeburn 14320: }
1.1055 raeburn 14321: }
14322: }
1.1086 raeburn 14323: if ($fullpath ne '') {
14324: if (-e "$prefix$path") {
1.1292 raeburn 14325: unless (rename("$prefix$path","$fullpath/$title")) {
14326: $warning .= &mt('Failed to rename dependency').'<br />';
14327: }
1.1086 raeburn 14328: }
14329: if (-e "$fullpath/$title") {
14330: my $showpath;
14331: if ($relpath ne '') {
14332: $showpath = "$relpath/$title";
14333: } else {
14334: $showpath = "/$title";
14335: }
1.1294 raeburn 14336: $result .= '<li>'.&mt('[_1] included as a dependency',
14337: &HTML::Entities::encode($showpath,'<>&"')).
14338: '</li>'."\n";
1.1292 raeburn 14339: unless ($ishome) {
14340: my $fetch = "$fullpath/$title";
14341: $fetch =~ s/^\Q$prefix$dir\E//;
14342: $prompttofetch{$fetch} = 1;
14343: }
1.1086 raeburn 14344: }
14345: }
1.1055 raeburn 14346: }
1.1086 raeburn 14347: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
14348: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 14349: &HTML::Entities::encode($path,'<>&"'),
14350: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
14351: '<br />';
1.1055 raeburn 14352: }
14353: } else {
1.1294 raeburn 14354: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14355: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14356: }
14357: }
14358: if (keys(%todelete)) {
14359: foreach my $key (keys(%todelete)) {
14360: unlink($key);
1.1066 raeburn 14361: }
14362: }
14363: if (keys(%todeletedir)) {
14364: foreach my $key (keys(%todeletedir)) {
14365: rmdir($key);
14366: }
14367: }
14368: foreach my $dir (sort(keys(%is_dir))) {
14369: if (($pathtocheck ne '') && ($dir ne '')) {
14370: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 14371: }
14372: }
1.1067 raeburn 14373: if ($result ne '') {
14374: $output .= '<ul>'."\n".
14375: $result."\n".
14376: '</ul>';
14377: }
14378: unless ($ishome) {
14379: my $replicationfail;
14380: foreach my $item (keys(%prompttofetch)) {
14381: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
14382: unless ($fetchresult eq 'ok') {
14383: $replicationfail .= '<li>'.$item.'</li>'."\n";
14384: }
14385: }
14386: if ($replicationfail) {
14387: $output .= '<p class="LC_error">'.
14388: &mt('Course home server failed to retrieve:').'<ul>'.
14389: $replicationfail.
14390: '</ul></p>';
14391: }
14392: }
1.1055 raeburn 14393: } else {
14394: $warning = &mt('No items found in archive.');
14395: }
14396: if ($error) {
14397: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14398: $error.'</p>'."\n";
14399: }
14400: if ($warning) {
14401: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14402: }
14403: return $output;
14404: }
14405:
1.1066 raeburn 14406: sub cleanup_empty_dirs {
14407: my ($path) = @_;
14408: if (($path ne '') && (-d $path)) {
14409: if (opendir(my $dirh,$path)) {
14410: my @dircontents = grep(!/^\./,readdir($dirh));
14411: my $numitems = 0;
14412: foreach my $item (@dircontents) {
14413: if (-d "$path/$item") {
1.1111 raeburn 14414: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 14415: if (-e "$path/$item") {
14416: $numitems ++;
14417: }
14418: } else {
14419: $numitems ++;
14420: }
14421: }
14422: if ($numitems == 0) {
14423: rmdir($path);
14424: }
14425: closedir($dirh);
14426: }
14427: }
14428: return;
14429: }
14430:
1.41 ng 14431: =pod
1.45 matthew 14432:
1.1162 raeburn 14433: =item * &get_folder_hierarchy()
1.1068 raeburn 14434:
14435: Provides hierarchy of names of folders/sub-folders containing the current
14436: item,
14437:
14438: Inputs: 3
14439: - $navmap - navmaps object
14440:
14441: - $map - url for map (either the trigger itself, or map containing
14442: the resource, which is the trigger).
14443:
14444: - $showitem - 1 => show title for map itself; 0 => do not show.
14445:
14446: Outputs: 1 @pathitems - array of folder/subfolder names.
14447:
14448: =cut
14449:
14450: sub get_folder_hierarchy {
14451: my ($navmap,$map,$showitem) = @_;
14452: my @pathitems;
14453: if (ref($navmap)) {
14454: my $mapres = $navmap->getResourceByUrl($map);
14455: if (ref($mapres)) {
14456: my $pcslist = $mapres->map_hierarchy();
14457: if ($pcslist ne '') {
14458: my @pcs = split(/,/,$pcslist);
14459: foreach my $pc (@pcs) {
14460: if ($pc == 1) {
1.1129 raeburn 14461: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 14462: } else {
14463: my $res = $navmap->getByMapPc($pc);
14464: if (ref($res)) {
14465: my $title = $res->compTitle();
14466: $title =~ s/\W+/_/g;
14467: if ($title ne '') {
14468: push(@pathitems,$title);
14469: }
14470: }
14471: }
14472: }
14473: }
1.1071 raeburn 14474: if ($showitem) {
14475: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 14476: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 14477: } else {
14478: my $maptitle = $mapres->compTitle();
14479: $maptitle =~ s/\W+/_/g;
14480: if ($maptitle ne '') {
14481: push(@pathitems,$maptitle);
14482: }
1.1068 raeburn 14483: }
14484: }
14485: }
14486: }
14487: return @pathitems;
14488: }
14489:
14490: =pod
14491:
1.1015 raeburn 14492: =item * &get_turnedin_filepath()
14493:
14494: Determines path in a user's portfolio file for storage of files uploaded
14495: to a specific essayresponse or dropbox item.
14496:
14497: Inputs: 3 required + 1 optional.
14498: $symb is symb for resource, $uname and $udom are for current user (required).
14499: $caller is optional (can be "submission", if routine is called when storing
14500: an upoaded file when "Submit Answer" button was pressed).
14501:
14502: Returns array containing $path and $multiresp.
14503: $path is path in portfolio. $multiresp is 1 if this resource contains more
14504: than one file upload item. Callers of routine should append partid as a
14505: subdirectory to $path in cases where $multiresp is 1.
14506:
14507: Called by: homework/essayresponse.pm and homework/structuretags.pm
14508:
14509: =cut
14510:
14511: sub get_turnedin_filepath {
14512: my ($symb,$uname,$udom,$caller) = @_;
14513: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
14514: my $turnindir;
14515: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
14516: $turnindir = $userhash{'turnindir'};
14517: my ($path,$multiresp);
14518: if ($turnindir eq '') {
14519: if ($caller eq 'submission') {
14520: $turnindir = &mt('turned in');
14521: $turnindir =~ s/\W+/_/g;
14522: my %newhash = (
14523: 'turnindir' => $turnindir,
14524: );
14525: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
14526: }
14527: }
14528: if ($turnindir ne '') {
14529: $path = '/'.$turnindir.'/';
14530: my ($multipart,$turnin,@pathitems);
14531: my $navmap = Apache::lonnavmaps::navmap->new();
14532: if (defined($navmap)) {
14533: my $mapres = $navmap->getResourceByUrl($map);
14534: if (ref($mapres)) {
14535: my $pcslist = $mapres->map_hierarchy();
14536: if ($pcslist ne '') {
14537: foreach my $pc (split(/,/,$pcslist)) {
14538: my $res = $navmap->getByMapPc($pc);
14539: if (ref($res)) {
14540: my $title = $res->compTitle();
14541: $title =~ s/\W+/_/g;
14542: if ($title ne '') {
1.1149 raeburn 14543: if (($pc > 1) && (length($title) > 12)) {
14544: $title = substr($title,0,12);
14545: }
1.1015 raeburn 14546: push(@pathitems,$title);
14547: }
14548: }
14549: }
14550: }
14551: my $maptitle = $mapres->compTitle();
14552: $maptitle =~ s/\W+/_/g;
14553: if ($maptitle ne '') {
1.1149 raeburn 14554: if (length($maptitle) > 12) {
14555: $maptitle = substr($maptitle,0,12);
14556: }
1.1015 raeburn 14557: push(@pathitems,$maptitle);
14558: }
14559: unless ($env{'request.state'} eq 'construct') {
14560: my $res = $navmap->getBySymb($symb);
14561: if (ref($res)) {
14562: my $partlist = $res->parts();
14563: my $totaluploads = 0;
14564: if (ref($partlist) eq 'ARRAY') {
14565: foreach my $part (@{$partlist}) {
14566: my @types = $res->responseType($part);
14567: my @ids = $res->responseIds($part);
14568: for (my $i=0; $i < scalar(@ids); $i++) {
14569: if ($types[$i] eq 'essay') {
14570: my $partid = $part.'_'.$ids[$i];
14571: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
14572: $totaluploads ++;
14573: }
14574: }
14575: }
14576: }
14577: if ($totaluploads > 1) {
14578: $multiresp = 1;
14579: }
14580: }
14581: }
14582: }
14583: } else {
14584: return;
14585: }
14586: } else {
14587: return;
14588: }
14589: my $restitle=&Apache::lonnet::gettitle($symb);
14590: $restitle =~ s/\W+/_/g;
14591: if ($restitle eq '') {
14592: $restitle = ($resurl =~ m{/[^/]+$});
14593: if ($restitle eq '') {
14594: $restitle = time;
14595: }
14596: }
1.1149 raeburn 14597: if (length($restitle) > 12) {
14598: $restitle = substr($restitle,0,12);
14599: }
1.1015 raeburn 14600: push(@pathitems,$restitle);
14601: $path .= join('/',@pathitems);
14602: }
14603: return ($path,$multiresp);
14604: }
14605:
14606: =pod
14607:
1.464 albertel 14608: =back
1.41 ng 14609:
1.112 bowersj2 14610: =head1 CSV Upload/Handling functions
1.38 albertel 14611:
1.41 ng 14612: =over 4
14613:
1.648 raeburn 14614: =item * &upfile_store($r)
1.41 ng 14615:
14616: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 14617: needs $env{'form.upfile'}
1.41 ng 14618: returns $datatoken to be put into hidden field
14619:
14620: =cut
1.31 albertel 14621:
14622: sub upfile_store {
14623: my $r=shift;
1.258 albertel 14624: $env{'form.upfile'}=~s/\r/\n/gs;
14625: $env{'form.upfile'}=~s/\f/\n/gs;
14626: $env{'form.upfile'}=~s/\n+/\n/gs;
14627: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 14628:
1.1299 raeburn 14629: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
14630: '_enroll_'.$env{'request.course.id'}.'_'.
14631: time.'_'.$$);
14632: return if ($datatoken eq '');
14633:
1.31 albertel 14634: {
1.158 raeburn 14635: my $datafile = $r->dir_config('lonDaemons').
14636: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14637: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 14638: print $fh $env{'form.upfile'};
1.158 raeburn 14639: close($fh);
14640: }
1.31 albertel 14641: }
14642: return $datatoken;
14643: }
14644:
1.56 matthew 14645: =pod
14646:
1.1290 raeburn 14647: =item * &load_tmp_file($r,$datatoken)
1.41 ng 14648:
14649: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 14650: $datatoken is the name to assign to the temporary file.
1.258 albertel 14651: sets $env{'form.upfile'} to the contents of the file
1.41 ng 14652:
14653: =cut
1.31 albertel 14654:
14655: sub load_tmp_file {
1.1290 raeburn 14656: my ($r,$datatoken) = @_;
14657: return if ($datatoken eq '');
1.31 albertel 14658: my @studentdata=();
14659: {
1.158 raeburn 14660: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 14661: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14662: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 14663: @studentdata=<$fh>;
14664: close($fh);
14665: }
1.31 albertel 14666: }
1.258 albertel 14667: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 14668: }
14669:
1.1290 raeburn 14670: sub valid_datatoken {
14671: my ($datatoken) = @_;
1.1325 raeburn 14672: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 14673: return $datatoken;
14674: }
14675: return;
14676: }
14677:
1.56 matthew 14678: =pod
14679:
1.648 raeburn 14680: =item * &upfile_record_sep()
1.41 ng 14681:
14682: Separate uploaded file into records
14683: returns array of records,
1.258 albertel 14684: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 14685:
14686: =cut
1.31 albertel 14687:
14688: sub upfile_record_sep {
1.258 albertel 14689: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 14690: } else {
1.248 albertel 14691: my @records;
1.258 albertel 14692: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 14693: if ($line=~/^\s*$/) { next; }
14694: push(@records,$line);
14695: }
14696: return @records;
1.31 albertel 14697: }
14698: }
14699:
1.56 matthew 14700: =pod
14701:
1.648 raeburn 14702: =item * &record_sep($record)
1.41 ng 14703:
1.258 albertel 14704: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 14705:
14706: =cut
14707:
1.263 www 14708: sub takeleft {
14709: my $index=shift;
14710: return substr('0000'.$index,-4,4);
14711: }
14712:
1.31 albertel 14713: sub record_sep {
14714: my $record=shift;
14715: my %components=();
1.258 albertel 14716: if ($env{'form.upfiletype'} eq 'xml') {
14717: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 14718: my $i=0;
1.356 albertel 14719: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 14720: $field=~s/^(\"|\')//;
14721: $field=~s/(\"|\')$//;
1.263 www 14722: $components{&takeleft($i)}=$field;
1.31 albertel 14723: $i++;
14724: }
1.258 albertel 14725: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 14726: my $i=0;
1.356 albertel 14727: foreach my $field (split(/\t/,$record)) {
1.31 albertel 14728: $field=~s/^(\"|\')//;
14729: $field=~s/(\"|\')$//;
1.263 www 14730: $components{&takeleft($i)}=$field;
1.31 albertel 14731: $i++;
14732: }
14733: } else {
1.561 www 14734: my $separator=',';
1.480 banghart 14735: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 14736: $separator=';';
1.480 banghart 14737: }
1.31 albertel 14738: my $i=0;
1.561 www 14739: # the character we are looking for to indicate the end of a quote or a record
14740: my $looking_for=$separator;
14741: # do not add the characters to the fields
14742: my $ignore=0;
14743: # we just encountered a separator (or the beginning of the record)
14744: my $just_found_separator=1;
14745: # store the field we are working on here
14746: my $field='';
14747: # work our way through all characters in record
14748: foreach my $character ($record=~/(.)/g) {
14749: if ($character eq $looking_for) {
14750: if ($character ne $separator) {
14751: # Found the end of a quote, again looking for separator
14752: $looking_for=$separator;
14753: $ignore=1;
14754: } else {
14755: # Found a separator, store away what we got
14756: $components{&takeleft($i)}=$field;
14757: $i++;
14758: $just_found_separator=1;
14759: $ignore=0;
14760: $field='';
14761: }
14762: next;
14763: }
14764: # single or double quotation marks after a separator indicate beginning of a quote
14765: # we are now looking for the end of the quote and need to ignore separators
14766: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
14767: $looking_for=$character;
14768: next;
14769: }
14770: # ignore would be true after we reached the end of a quote
14771: if ($ignore) { next; }
14772: if (($just_found_separator) && ($character=~/\s/)) { next; }
14773: $field.=$character;
14774: $just_found_separator=0;
1.31 albertel 14775: }
1.561 www 14776: # catch the very last entry, since we never encountered the separator
14777: $components{&takeleft($i)}=$field;
1.31 albertel 14778: }
14779: return %components;
14780: }
14781:
1.144 matthew 14782: ######################################################
14783: ######################################################
14784:
1.56 matthew 14785: =pod
14786:
1.648 raeburn 14787: =item * &upfile_select_html()
1.41 ng 14788:
1.144 matthew 14789: Return HTML code to select a file from the users machine and specify
14790: the file type.
1.41 ng 14791:
14792: =cut
14793:
1.144 matthew 14794: ######################################################
14795: ######################################################
1.31 albertel 14796: sub upfile_select_html {
1.144 matthew 14797: my %Types = (
14798: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 14799: semisv => &mt('Semicolon separated values'),
1.144 matthew 14800: space => &mt('Space separated'),
14801: tab => &mt('Tabulator separated'),
14802: # xml => &mt('HTML/XML'),
14803: );
14804: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 14805: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 14806: foreach my $type (sort(keys(%Types))) {
14807: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
14808: }
14809: $Str .= "</select>\n";
14810: return $Str;
1.31 albertel 14811: }
14812:
1.301 albertel 14813: sub get_samples {
14814: my ($records,$toget) = @_;
14815: my @samples=({});
14816: my $got=0;
14817: foreach my $rec (@$records) {
14818: my %temp = &record_sep($rec);
14819: if (! grep(/\S/, values(%temp))) { next; }
14820: if (%temp) {
14821: $samples[$got]=\%temp;
14822: $got++;
14823: if ($got == $toget) { last; }
14824: }
14825: }
14826: return \@samples;
14827: }
14828:
1.144 matthew 14829: ######################################################
14830: ######################################################
14831:
1.56 matthew 14832: =pod
14833:
1.648 raeburn 14834: =item * &csv_print_samples($r,$records)
1.41 ng 14835:
14836: Prints a table of sample values from each column uploaded $r is an
14837: Apache Request ref, $records is an arrayref from
14838: &Apache::loncommon::upfile_record_sep
14839:
14840: =cut
14841:
1.144 matthew 14842: ######################################################
14843: ######################################################
1.31 albertel 14844: sub csv_print_samples {
14845: my ($r,$records) = @_;
1.662 bisitz 14846: my $samples = &get_samples($records,5);
1.301 albertel 14847:
1.594 raeburn 14848: $r->print(&mt('Samples').'<br />'.&start_data_table().
14849: &start_data_table_header_row());
1.356 albertel 14850: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 14851: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 14852: $r->print(&end_data_table_header_row());
1.301 albertel 14853: foreach my $hash (@$samples) {
1.594 raeburn 14854: $r->print(&start_data_table_row());
1.356 albertel 14855: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 14856: $r->print('<td>');
1.356 albertel 14857: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 14858: $r->print('</td>');
14859: }
1.594 raeburn 14860: $r->print(&end_data_table_row());
1.31 albertel 14861: }
1.594 raeburn 14862: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 14863: }
14864:
1.144 matthew 14865: ######################################################
14866: ######################################################
14867:
1.56 matthew 14868: =pod
14869:
1.648 raeburn 14870: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 14871:
14872: Prints a table to create associations between values and table columns.
1.144 matthew 14873:
1.41 ng 14874: $r is an Apache Request ref,
14875: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 14876: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 14877:
14878: =cut
14879:
1.144 matthew 14880: ######################################################
14881: ######################################################
1.31 albertel 14882: sub csv_print_select_table {
14883: my ($r,$records,$d) = @_;
1.301 albertel 14884: my $i=0;
14885: my $samples = &get_samples($records,1);
1.144 matthew 14886: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 14887: &start_data_table().&start_data_table_header_row().
1.144 matthew 14888: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 14889: '<th>'.&mt('Column').'</th>'.
14890: &end_data_table_header_row()."\n");
1.356 albertel 14891: foreach my $array_ref (@$d) {
14892: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 14893: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 14894:
1.875 bisitz 14895: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 14896: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 14897: $r->print('<option value="none"></option>');
1.356 albertel 14898: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
14899: $r->print('<option value="'.$sample.'"'.
14900: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 14901: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 14902: }
1.594 raeburn 14903: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 14904: $i++;
14905: }
1.594 raeburn 14906: $r->print(&end_data_table());
1.31 albertel 14907: $i--;
14908: return $i;
14909: }
1.56 matthew 14910:
1.144 matthew 14911: ######################################################
14912: ######################################################
14913:
1.56 matthew 14914: =pod
1.31 albertel 14915:
1.648 raeburn 14916: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 14917:
14918: Prints a table of sample values from the upload and can make associate samples to internal names.
14919:
14920: $r is an Apache Request ref,
14921: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
14922: $d is an array of 2 element arrays (internal name, displayed name)
14923:
14924: =cut
14925:
1.144 matthew 14926: ######################################################
14927: ######################################################
1.31 albertel 14928: sub csv_samples_select_table {
14929: my ($r,$records,$d) = @_;
14930: my $i=0;
1.144 matthew 14931: #
1.662 bisitz 14932: my $max_samples = 5;
14933: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 14934: $r->print(&start_data_table().
14935: &start_data_table_header_row().'<th>'.
14936: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
14937: &end_data_table_header_row());
1.301 albertel 14938:
14939: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 14940: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 14941: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 14942: foreach my $option (@$d) {
14943: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 14944: $r->print('<option value="'.$value.'"'.
1.253 albertel 14945: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 14946: $display.'</option>');
1.31 albertel 14947: }
14948: $r->print('</select></td><td>');
1.662 bisitz 14949: foreach my $line (0..($max_samples-1)) {
1.301 albertel 14950: if (defined($samples->[$line]{$key})) {
14951: $r->print($samples->[$line]{$key}."<br />\n");
14952: }
14953: }
1.594 raeburn 14954: $r->print('</td>'.&end_data_table_row());
1.31 albertel 14955: $i++;
14956: }
1.594 raeburn 14957: $r->print(&end_data_table());
1.31 albertel 14958: $i--;
14959: return($i);
1.115 matthew 14960: }
14961:
1.144 matthew 14962: ######################################################
14963: ######################################################
14964:
1.115 matthew 14965: =pod
14966:
1.648 raeburn 14967: =item * &clean_excel_name($name)
1.115 matthew 14968:
14969: Returns a replacement for $name which does not contain any illegal characters.
14970:
14971: =cut
14972:
1.144 matthew 14973: ######################################################
14974: ######################################################
1.115 matthew 14975: sub clean_excel_name {
14976: my ($name) = @_;
14977: $name =~ s/[:\*\?\/\\]//g;
14978: if (length($name) > 31) {
14979: $name = substr($name,0,31);
14980: }
14981: return $name;
1.25 albertel 14982: }
1.84 albertel 14983:
1.85 albertel 14984: =pod
14985:
1.648 raeburn 14986: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 14987:
14988: Returns either 1 or undef
14989:
14990: 1 if the part is to be hidden, undef if it is to be shown
14991:
14992: Arguments are:
14993:
14994: $id the id of the part to be checked
14995: $symb, optional the symb of the resource to check
14996: $udom, optional the domain of the user to check for
14997: $uname, optional the username of the user to check for
14998:
14999: =cut
1.84 albertel 15000:
15001: sub check_if_partid_hidden {
15002: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15003: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15004: $symb,$udom,$uname);
1.141 albertel 15005: my $truth=1;
15006: #if the string starts with !, then the list is the list to show not hide
15007: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15008: my @hiddenlist=split(/,/,$hiddenparts);
15009: foreach my $checkid (@hiddenlist) {
1.141 albertel 15010: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15011: }
1.141 albertel 15012: return !$truth;
1.84 albertel 15013: }
1.127 matthew 15014:
1.138 matthew 15015:
15016: ############################################################
15017: ############################################################
15018:
15019: =pod
15020:
1.157 matthew 15021: =back
15022:
1.138 matthew 15023: =head1 cgi-bin script and graphing routines
15024:
1.157 matthew 15025: =over 4
15026:
1.648 raeburn 15027: =item * &get_cgi_id()
1.138 matthew 15028:
15029: Inputs: none
15030:
15031: Returns an id which can be used to pass environment variables
15032: to various cgi-bin scripts. These environment variables will
15033: be removed from the users environment after a given time by
15034: the routine &Apache::lonnet::transfer_profile_to_env.
15035:
15036: =cut
15037:
15038: ############################################################
15039: ############################################################
1.152 albertel 15040: my $uniq=0;
1.136 matthew 15041: sub get_cgi_id {
1.154 albertel 15042: $uniq=($uniq+1)%100000;
1.280 albertel 15043: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15044: }
15045:
1.127 matthew 15046: ############################################################
15047: ############################################################
15048:
15049: =pod
15050:
1.648 raeburn 15051: =item * &DrawBarGraph()
1.127 matthew 15052:
1.138 matthew 15053: Facilitates the plotting of data in a (stacked) bar graph.
15054: Puts plot definition data into the users environment in order for
15055: graph.png to plot it. Returns an <img> tag for the plot.
15056: The bars on the plot are labeled '1','2',...,'n'.
15057:
15058: Inputs:
15059:
15060: =over 4
15061:
15062: =item $Title: string, the title of the plot
15063:
15064: =item $xlabel: string, text describing the X-axis of the plot
15065:
15066: =item $ylabel: string, text describing the Y-axis of the plot
15067:
15068: =item $Max: scalar, the maximum Y value to use in the plot
15069: If $Max is < any data point, the graph will not be rendered.
15070:
1.140 matthew 15071: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15072: they are plotted. If undefined, default values will be used.
15073:
1.178 matthew 15074: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15075:
1.138 matthew 15076: =item @Values: An array of array references. Each array reference holds data
15077: to be plotted in a stacked bar chart.
15078:
1.239 matthew 15079: =item If the final element of @Values is a hash reference the key/value
15080: pairs will be added to the graph definition.
15081:
1.138 matthew 15082: =back
15083:
15084: Returns:
15085:
15086: An <img> tag which references graph.png and the appropriate identifying
15087: information for the plot.
15088:
1.127 matthew 15089: =cut
15090:
15091: ############################################################
15092: ############################################################
1.134 matthew 15093: sub DrawBarGraph {
1.178 matthew 15094: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15095: #
15096: if (! defined($colors)) {
15097: $colors = ['#33ff00',
15098: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15099: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15100: ];
15101: }
1.228 matthew 15102: my $extra_settings = {};
15103: if (ref($Values[-1]) eq 'HASH') {
15104: $extra_settings = pop(@Values);
15105: }
1.127 matthew 15106: #
1.136 matthew 15107: my $identifier = &get_cgi_id();
15108: my $id = 'cgi.'.$identifier;
1.129 matthew 15109: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15110: return '';
15111: }
1.225 matthew 15112: #
15113: my @Labels;
15114: if (defined($labels)) {
15115: @Labels = @$labels;
15116: } else {
15117: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15118: push(@Labels,$i+1);
1.225 matthew 15119: }
15120: }
15121: #
1.129 matthew 15122: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15123: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15124: my %ValuesHash;
15125: my $NumSets=1;
15126: foreach my $array (@Values) {
15127: next if (! ref($array));
1.136 matthew 15128: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15129: join(',',@$array);
1.129 matthew 15130: }
1.127 matthew 15131: #
1.136 matthew 15132: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15133: if ($NumBars < 3) {
15134: $width = 120+$NumBars*32;
1.220 matthew 15135: $xskip = 1;
1.225 matthew 15136: $bar_width = 30;
15137: } elsif ($NumBars < 5) {
15138: $width = 120+$NumBars*20;
15139: $xskip = 1;
15140: $bar_width = 20;
1.220 matthew 15141: } elsif ($NumBars < 10) {
1.136 matthew 15142: $width = 120+$NumBars*15;
15143: $xskip = 1;
15144: $bar_width = 15;
15145: } elsif ($NumBars <= 25) {
15146: $width = 120+$NumBars*11;
15147: $xskip = 5;
15148: $bar_width = 8;
15149: } elsif ($NumBars <= 50) {
15150: $width = 120+$NumBars*8;
15151: $xskip = 5;
15152: $bar_width = 4;
15153: } else {
15154: $width = 120+$NumBars*8;
15155: $xskip = 5;
15156: $bar_width = 4;
15157: }
15158: #
1.137 matthew 15159: $Max = 1 if ($Max < 1);
15160: if ( int($Max) < $Max ) {
15161: $Max++;
15162: $Max = int($Max);
15163: }
1.127 matthew 15164: $Title = '' if (! defined($Title));
15165: $xlabel = '' if (! defined($xlabel));
15166: $ylabel = '' if (! defined($ylabel));
1.369 www 15167: $ValuesHash{$id.'.title'} = &escape($Title);
15168: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15169: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15170: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15171: $ValuesHash{$id.'.NumBars'} = $NumBars;
15172: $ValuesHash{$id.'.NumSets'} = $NumSets;
15173: $ValuesHash{$id.'.PlotType'} = 'bar';
15174: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15175: $ValuesHash{$id.'.height'} = $height;
15176: $ValuesHash{$id.'.width'} = $width;
15177: $ValuesHash{$id.'.xskip'} = $xskip;
15178: $ValuesHash{$id.'.bar_width'} = $bar_width;
15179: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15180: #
1.228 matthew 15181: # Deal with other parameters
15182: while (my ($key,$value) = each(%$extra_settings)) {
15183: $ValuesHash{$id.'.'.$key} = $value;
15184: }
15185: #
1.646 raeburn 15186: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15187: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15188: }
15189:
15190: ############################################################
15191: ############################################################
15192:
15193: =pod
15194:
1.648 raeburn 15195: =item * &DrawXYGraph()
1.137 matthew 15196:
1.138 matthew 15197: Facilitates the plotting of data in an XY graph.
15198: Puts plot definition data into the users environment in order for
15199: graph.png to plot it. Returns an <img> tag for the plot.
15200:
15201: Inputs:
15202:
15203: =over 4
15204:
15205: =item $Title: string, the title of the plot
15206:
15207: =item $xlabel: string, text describing the X-axis of the plot
15208:
15209: =item $ylabel: string, text describing the Y-axis of the plot
15210:
15211: =item $Max: scalar, the maximum Y value to use in the plot
15212: If $Max is < any data point, the graph will not be rendered.
15213:
15214: =item $colors: Array ref containing the hex color codes for the data to be
15215: plotted in. If undefined, default values will be used.
15216:
15217: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15218:
15219: =item $Ydata: Array ref containing Array refs.
1.185 www 15220: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15221:
15222: =item %Values: hash indicating or overriding any default values which are
15223: passed to graph.png.
15224: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15225:
15226: =back
15227:
15228: Returns:
15229:
15230: An <img> tag which references graph.png and the appropriate identifying
15231: information for the plot.
15232:
1.137 matthew 15233: =cut
15234:
15235: ############################################################
15236: ############################################################
15237: sub DrawXYGraph {
15238: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15239: #
15240: # Create the identifier for the graph
15241: my $identifier = &get_cgi_id();
15242: my $id = 'cgi.'.$identifier;
15243: #
15244: $Title = '' if (! defined($Title));
15245: $xlabel = '' if (! defined($xlabel));
15246: $ylabel = '' if (! defined($ylabel));
15247: my %ValuesHash =
15248: (
1.369 www 15249: $id.'.title' => &escape($Title),
15250: $id.'.xlabel' => &escape($xlabel),
15251: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15252: $id.'.y_max_value'=> $Max,
15253: $id.'.labels' => join(',',@$Xlabels),
15254: $id.'.PlotType' => 'XY',
15255: );
15256: #
15257: if (defined($colors) && ref($colors) eq 'ARRAY') {
15258: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15259: }
15260: #
15261: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15262: return '';
15263: }
15264: my $NumSets=1;
1.138 matthew 15265: foreach my $array (@{$Ydata}){
1.137 matthew 15266: next if (! ref($array));
15267: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15268: }
1.138 matthew 15269: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15270: #
15271: # Deal with other parameters
15272: while (my ($key,$value) = each(%Values)) {
15273: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15274: }
15275: #
1.646 raeburn 15276: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15277: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15278: }
15279:
15280: ############################################################
15281: ############################################################
15282:
15283: =pod
15284:
1.648 raeburn 15285: =item * &DrawXYYGraph()
1.138 matthew 15286:
15287: Facilitates the plotting of data in an XY graph with two Y axes.
15288: Puts plot definition data into the users environment in order for
15289: graph.png to plot it. Returns an <img> tag for the plot.
15290:
15291: Inputs:
15292:
15293: =over 4
15294:
15295: =item $Title: string, the title of the plot
15296:
15297: =item $xlabel: string, text describing the X-axis of the plot
15298:
15299: =item $ylabel: string, text describing the Y-axis of the plot
15300:
15301: =item $colors: Array ref containing the hex color codes for the data to be
15302: plotted in. If undefined, default values will be used.
15303:
15304: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15305:
15306: =item $Ydata1: The first data set
15307:
15308: =item $Min1: The minimum value of the left Y-axis
15309:
15310: =item $Max1: The maximum value of the left Y-axis
15311:
15312: =item $Ydata2: The second data set
15313:
15314: =item $Min2: The minimum value of the right Y-axis
15315:
15316: =item $Max2: The maximum value of the left Y-axis
15317:
15318: =item %Values: hash indicating or overriding any default values which are
15319: passed to graph.png.
15320: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15321:
15322: =back
15323:
15324: Returns:
15325:
15326: An <img> tag which references graph.png and the appropriate identifying
15327: information for the plot.
1.136 matthew 15328:
15329: =cut
15330:
15331: ############################################################
15332: ############################################################
1.137 matthew 15333: sub DrawXYYGraph {
15334: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15335: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15336: #
15337: # Create the identifier for the graph
15338: my $identifier = &get_cgi_id();
15339: my $id = 'cgi.'.$identifier;
15340: #
15341: $Title = '' if (! defined($Title));
15342: $xlabel = '' if (! defined($xlabel));
15343: $ylabel = '' if (! defined($ylabel));
15344: my %ValuesHash =
15345: (
1.369 www 15346: $id.'.title' => &escape($Title),
15347: $id.'.xlabel' => &escape($xlabel),
15348: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 15349: $id.'.labels' => join(',',@$Xlabels),
15350: $id.'.PlotType' => 'XY',
15351: $id.'.NumSets' => 2,
1.137 matthew 15352: $id.'.two_axes' => 1,
15353: $id.'.y1_max_value' => $Max1,
15354: $id.'.y1_min_value' => $Min1,
15355: $id.'.y2_max_value' => $Max2,
15356: $id.'.y2_min_value' => $Min2,
1.136 matthew 15357: );
15358: #
1.137 matthew 15359: if (defined($colors) && ref($colors) eq 'ARRAY') {
15360: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15361: }
15362: #
15363: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
15364: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 15365: return '';
15366: }
15367: my $NumSets=1;
1.137 matthew 15368: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 15369: next if (! ref($array));
15370: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 15371: }
15372: #
15373: # Deal with other parameters
15374: while (my ($key,$value) = each(%Values)) {
15375: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 15376: }
15377: #
1.646 raeburn 15378: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 15379: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 15380: }
15381:
15382: ############################################################
15383: ############################################################
15384:
15385: =pod
15386:
1.157 matthew 15387: =back
15388:
1.139 matthew 15389: =head1 Statistics helper routines?
15390:
15391: Bad place for them but what the hell.
15392:
1.157 matthew 15393: =over 4
15394:
1.648 raeburn 15395: =item * &chartlink()
1.139 matthew 15396:
15397: Returns a link to the chart for a specific student.
15398:
15399: Inputs:
15400:
15401: =over 4
15402:
15403: =item $linktext: The text of the link
15404:
15405: =item $sname: The students username
15406:
15407: =item $sdomain: The students domain
15408:
15409: =back
15410:
1.157 matthew 15411: =back
15412:
1.139 matthew 15413: =cut
15414:
15415: ############################################################
15416: ############################################################
15417: sub chartlink {
15418: my ($linktext, $sname, $sdomain) = @_;
15419: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 15420: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 15421: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 15422: '">'.$linktext.'</a>';
1.153 matthew 15423: }
15424:
15425: #######################################################
15426: #######################################################
15427:
15428: =pod
15429:
15430: =head1 Course Environment Routines
1.157 matthew 15431:
15432: =over 4
1.153 matthew 15433:
1.648 raeburn 15434: =item * &restore_course_settings()
1.153 matthew 15435:
1.648 raeburn 15436: =item * &store_course_settings()
1.153 matthew 15437:
15438: Restores/Store indicated form parameters from the course environment.
15439: Will not overwrite existing values of the form parameters.
15440:
15441: Inputs:
15442: a scalar describing the data (e.g. 'chart', 'problem_analysis')
15443:
15444: a hash ref describing the data to be stored. For example:
15445:
15446: %Save_Parameters = ('Status' => 'scalar',
15447: 'chartoutputmode' => 'scalar',
15448: 'chartoutputdata' => 'scalar',
15449: 'Section' => 'array',
1.373 raeburn 15450: 'Group' => 'array',
1.153 matthew 15451: 'StudentData' => 'array',
15452: 'Maps' => 'array');
15453:
15454: Returns: both routines return nothing
15455:
1.631 raeburn 15456: =back
15457:
1.153 matthew 15458: =cut
15459:
15460: #######################################################
15461: #######################################################
15462: sub store_course_settings {
1.496 albertel 15463: return &store_settings($env{'request.course.id'},@_);
15464: }
15465:
15466: sub store_settings {
1.153 matthew 15467: # save to the environment
15468: # appenv the same items, just to be safe
1.300 albertel 15469: my $udom = $env{'user.domain'};
15470: my $uname = $env{'user.name'};
1.496 albertel 15471: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15472: my %SaveHash;
15473: my %AppHash;
15474: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 15475: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 15476: my $envname = 'environment.'.$basename;
1.258 albertel 15477: if (exists($env{'form.'.$setting})) {
1.153 matthew 15478: # Save this value away
15479: if ($type eq 'scalar' &&
1.258 albertel 15480: (! exists($env{$envname}) ||
15481: $env{$envname} ne $env{'form.'.$setting})) {
15482: $SaveHash{$basename} = $env{'form.'.$setting};
15483: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 15484: } elsif ($type eq 'array') {
15485: my $stored_form;
1.258 albertel 15486: if (ref($env{'form.'.$setting})) {
1.153 matthew 15487: $stored_form = join(',',
15488: map {
1.369 www 15489: &escape($_);
1.258 albertel 15490: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 15491: } else {
15492: $stored_form =
1.369 www 15493: &escape($env{'form.'.$setting});
1.153 matthew 15494: }
15495: # Determine if the array contents are the same.
1.258 albertel 15496: if ($stored_form ne $env{$envname}) {
1.153 matthew 15497: $SaveHash{$basename} = $stored_form;
15498: $AppHash{$envname} = $stored_form;
15499: }
15500: }
15501: }
15502: }
15503: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 15504: $udom,$uname);
1.153 matthew 15505: if ($put_result !~ /^(ok|delayed)/) {
15506: &Apache::lonnet::logthis('unable to save form parameters, '.
15507: 'got error:'.$put_result);
15508: }
15509: # Make sure these settings stick around in this session, too
1.646 raeburn 15510: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 15511: return;
15512: }
15513:
15514: sub restore_course_settings {
1.499 albertel 15515: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 15516: }
15517:
15518: sub restore_settings {
15519: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15520: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 15521: next if (exists($env{'form.'.$setting}));
1.496 albertel 15522: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 15523: '.'.$setting;
1.258 albertel 15524: if (exists($env{$envname})) {
1.153 matthew 15525: if ($type eq 'scalar') {
1.258 albertel 15526: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 15527: } elsif ($type eq 'array') {
1.258 albertel 15528: $env{'form.'.$setting} = [
1.153 matthew 15529: map {
1.369 www 15530: &unescape($_);
1.258 albertel 15531: } split(',',$env{$envname})
1.153 matthew 15532: ];
15533: }
15534: }
15535: }
1.127 matthew 15536: }
15537:
1.618 raeburn 15538: #######################################################
15539: #######################################################
15540:
15541: =pod
15542:
15543: =head1 Domain E-mail Routines
15544:
15545: =over 4
15546:
1.648 raeburn 15547: =item * &build_recipient_list()
1.618 raeburn 15548:
1.1144 raeburn 15549: Build recipient lists for following types of e-mail:
1.766 raeburn 15550: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 15551: (d) Help requests, (e) Course requests needing approval, (f) loncapa
15552: module change checking, student/employee ID conflict checks, as
15553: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
15554: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 15555:
15556: Inputs:
1.619 raeburn 15557: defmail (scalar - email address of default recipient),
1.1144 raeburn 15558: mailing type (scalar: errormail, packagesmail, helpdeskmail,
15559: requestsmail, updatesmail, or idconflictsmail).
15560:
1.619 raeburn 15561: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 15562:
1.619 raeburn 15563: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 15564: i.e., predates configuration by DC via domainprefs.pm
15565:
15566: $requname username of requester (if mailing type is helpdeskmail)
15567:
15568: $requdom domain of requester (if mailing type is helpdeskmail)
15569:
15570: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
15571:
1.618 raeburn 15572:
1.655 raeburn 15573: Returns: comma separated list of addresses to which to send e-mail.
15574:
15575: =back
1.618 raeburn 15576:
15577: =cut
15578:
15579: ############################################################
15580: ############################################################
15581: sub build_recipient_list {
1.1297 raeburn 15582: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 15583: my @recipients;
1.1270 raeburn 15584: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 15585: my %domconfig =
1.1270 raeburn 15586: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 15587: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 15588: if (exists($domconfig{'contacts'}{$mailing})) {
15589: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
15590: my @contacts = ('adminemail','supportemail');
15591: foreach my $item (@contacts) {
15592: if ($domconfig{'contacts'}{$mailing}{$item}) {
15593: my $addr = $domconfig{'contacts'}{$item};
15594: if (!grep(/^\Q$addr\E$/,@recipients)) {
15595: push(@recipients,$addr);
15596: }
1.619 raeburn 15597: }
1.1270 raeburn 15598: }
15599: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
15600: if ($mailing eq 'helpdeskmail') {
15601: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
15602: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
15603: my @ok_bccs;
15604: foreach my $bcc (@bccs) {
15605: $bcc =~ s/^\s+//g;
15606: $bcc =~ s/\s+$//g;
15607: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15608: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15609: push(@ok_bccs,$bcc);
15610: }
15611: }
15612: }
15613: if (@ok_bccs > 0) {
15614: $allbcc = join(', ',@ok_bccs);
15615: }
15616: }
15617: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 15618: }
15619: }
1.766 raeburn 15620: } elsif ($origmail ne '') {
1.1270 raeburn 15621: $lastresort = $origmail;
1.618 raeburn 15622: }
1.1297 raeburn 15623: if ($mailing eq 'helpdeskmail') {
15624: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
15625: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
15626: my ($inststatus,$inststatus_checked);
15627: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
15628: ($env{'user.domain'} ne 'public')) {
15629: $inststatus_checked = 1;
15630: $inststatus = $env{'environment.inststatus'};
15631: }
15632: unless ($inststatus_checked) {
15633: if (($requname ne '') && ($requdom ne '')) {
15634: if (($requname =~ /^$match_username$/) &&
15635: ($requdom =~ /^$match_domain$/) &&
15636: (&Apache::lonnet::domain($requdom))) {
15637: my $requhome = &Apache::lonnet::homeserver($requname,
15638: $requdom);
15639: unless ($requhome eq 'no_host') {
15640: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
15641: $inststatus = $userenv{'inststatus'};
15642: $inststatus_checked = 1;
15643: }
15644: }
15645: }
15646: }
15647: unless ($inststatus_checked) {
15648: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
15649: my %srch = (srchby => 'email',
15650: srchdomain => $defdom,
15651: srchterm => $reqemail,
15652: srchtype => 'exact');
15653: my %srch_results = &Apache::lonnet::usersearch(\%srch);
15654: foreach my $uname (keys(%srch_results)) {
15655: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15656: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15657: $inststatus_checked = 1;
15658: last;
15659: }
15660: }
15661: unless ($inststatus_checked) {
15662: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
15663: if ($dirsrchres eq 'ok') {
15664: foreach my $uname (keys(%srch_results)) {
15665: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15666: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15667: $inststatus_checked = 1;
15668: last;
15669: }
15670: }
15671: }
15672: }
15673: }
15674: }
15675: if ($inststatus ne '') {
15676: foreach my $status (split(/\:/,$inststatus)) {
15677: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
15678: my @contacts = ('adminemail','supportemail');
15679: foreach my $item (@contacts) {
15680: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
15681: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
15682: if (!grep(/^\Q$addr\E$/,@recipients)) {
15683: push(@recipients,$addr);
15684: }
15685: }
15686: }
15687: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
15688: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
15689: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
15690: my @ok_bccs;
15691: foreach my $bcc (@bccs) {
15692: $bcc =~ s/^\s+//g;
15693: $bcc =~ s/\s+$//g;
15694: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15695: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15696: push(@ok_bccs,$bcc);
15697: }
15698: }
15699: }
15700: if (@ok_bccs > 0) {
15701: $allbcc = join(', ',@ok_bccs);
15702: }
15703: }
15704: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
15705: last;
15706: }
15707: }
15708: }
15709: }
15710: }
1.619 raeburn 15711: } elsif ($origmail ne '') {
1.1270 raeburn 15712: $lastresort = $origmail;
15713: }
1.1297 raeburn 15714: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 15715: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
15716: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
15717: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
15718: my %what = (
15719: perlvar => 1,
15720: );
15721: my $primary = &Apache::lonnet::domain($defdom,'primary');
15722: if ($primary) {
15723: my $gotaddr;
15724: my ($result,$returnhash) =
15725: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
15726: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
15727: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
15728: $lastresort = $returnhash->{'lonSupportEMail'};
15729: $gotaddr = 1;
15730: }
15731: }
15732: unless ($gotaddr) {
15733: my $uintdom = &Apache::lonnet::internet_dom($primary);
15734: my $intdom = &Apache::lonnet::internet_dom($lonhost);
15735: unless ($uintdom eq $intdom) {
15736: my %domconfig =
15737: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
15738: if (ref($domconfig{'contacts'}) eq 'HASH') {
15739: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
15740: my @contacts = ('adminemail','supportemail');
15741: foreach my $item (@contacts) {
15742: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
15743: my $addr = $domconfig{'contacts'}{$item};
15744: if (!grep(/^\Q$addr\E$/,@recipients)) {
15745: push(@recipients,$addr);
15746: }
15747: }
15748: }
15749: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
15750: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
15751: }
15752: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
15753: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
15754: my @ok_bccs;
15755: foreach my $bcc (@bccs) {
15756: $bcc =~ s/^\s+//g;
15757: $bcc =~ s/\s+$//g;
15758: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15759: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15760: push(@ok_bccs,$bcc);
15761: }
15762: }
15763: }
15764: if (@ok_bccs > 0) {
15765: $allbcc = join(', ',@ok_bccs);
15766: }
15767: }
15768: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
15769: }
15770: }
15771: }
15772: }
15773: }
15774: }
1.618 raeburn 15775: }
1.688 raeburn 15776: if (defined($defmail)) {
15777: if ($defmail ne '') {
15778: push(@recipients,$defmail);
15779: }
1.618 raeburn 15780: }
15781: if ($otheremails) {
1.619 raeburn 15782: my @others;
15783: if ($otheremails =~ /,/) {
15784: @others = split(/,/,$otheremails);
1.618 raeburn 15785: } else {
1.619 raeburn 15786: push(@others,$otheremails);
15787: }
15788: foreach my $addr (@others) {
15789: if (!grep(/^\Q$addr\E$/,@recipients)) {
15790: push(@recipients,$addr);
15791: }
1.618 raeburn 15792: }
15793: }
1.1298 raeburn 15794: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 15795: if ((!@recipients) && ($lastresort ne '')) {
15796: push(@recipients,$lastresort);
15797: }
15798: } elsif ($lastresort ne '') {
15799: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
15800: push(@recipients,$lastresort);
15801: }
15802: }
1.1271 raeburn 15803: my $recipientlist = join(',',@recipients);
1.1270 raeburn 15804: if (wantarray) {
15805: return ($recipientlist,$allbcc,$addtext);
15806: } else {
15807: return $recipientlist;
15808: }
1.618 raeburn 15809: }
15810:
1.127 matthew 15811: ############################################################
15812: ############################################################
1.154 albertel 15813:
1.655 raeburn 15814: =pod
15815:
1.1224 musolffc 15816: =over 4
15817:
1.1223 musolffc 15818: =item * &mime_email()
15819:
15820: Sends an email with a possible attachment
15821:
15822: Inputs:
15823:
15824: =over 4
15825:
15826: from - Sender's email address
15827:
1.1343 raeburn 15828: replyto - Reply-To email address
15829:
1.1223 musolffc 15830: to - Email address of recipient
15831:
15832: subject - Subject of email
15833:
15834: body - Body of email
15835:
15836: cc_string - Carbon copy email address
15837:
15838: bcc - Blind carbon copy email address
15839:
15840: attachment_path - Path of file to be attached
15841:
15842: file_name - Name of file to be attached
15843:
15844: attachment_text - The body of an attachment of type "TEXT"
15845:
15846: =back
15847:
15848: =back
15849:
15850: =cut
15851:
15852: ############################################################
15853: ############################################################
15854:
15855: sub mime_email {
1.1343 raeburn 15856: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
15857: $file_name,$attachment_text) = @_;
15858:
1.1223 musolffc 15859: my $msg = MIME::Lite->new(
15860: From => $from,
15861: To => $to,
15862: Subject => $subject,
15863: Type =>'TEXT',
15864: Data => $body,
15865: );
1.1343 raeburn 15866: if ($replyto ne '') {
15867: $msg->add("Reply-To" => $replyto);
15868: }
1.1223 musolffc 15869: if ($cc_string ne '') {
15870: $msg->add("Cc" => $cc_string);
15871: }
15872: if ($bcc ne '') {
15873: $msg->add("Bcc" => $bcc);
15874: }
15875: $msg->attr("content-type" => "text/plain");
15876: $msg->attr("content-type.charset" => "UTF-8");
15877: # Attach file if given
15878: if ($attachment_path) {
15879: unless ($file_name) {
15880: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
15881: }
15882: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
15883: $msg->attach(Type => $type,
15884: Path => $attachment_path,
15885: Filename => $file_name
15886: );
15887: # Otherwise attach text if given
15888: } elsif ($attachment_text) {
15889: $msg->attach(Type => 'TEXT',
15890: Data => $attachment_text);
15891: }
15892: # Send it
15893: $msg->send('sendmail');
15894: }
15895:
15896: ############################################################
15897: ############################################################
15898:
15899: =pod
15900:
1.655 raeburn 15901: =head1 Course Catalog Routines
15902:
15903: =over 4
15904:
15905: =item * &gather_categories()
15906:
15907: Converts category definitions - keys of categories hash stored in
15908: coursecategories in configuration.db on the primary library server in a
15909: domain - to an array. Also generates javascript and idx hash used to
15910: generate Domain Coordinator interface for editing Course Categories.
15911:
15912: Inputs:
1.663 raeburn 15913:
1.655 raeburn 15914: categories (reference to hash of category definitions).
1.663 raeburn 15915:
1.655 raeburn 15916: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15917: categories and subcategories).
1.663 raeburn 15918:
1.655 raeburn 15919: idx (reference to hash of counters used in Domain Coordinator interface for
15920: editing Course Categories).
1.663 raeburn 15921:
1.655 raeburn 15922: jsarray (reference to array of categories used to create Javascript arrays for
15923: Domain Coordinator interface for editing Course Categories).
15924:
15925: Returns: nothing
15926:
15927: Side effects: populates cats, idx and jsarray.
15928:
15929: =cut
15930:
15931: sub gather_categories {
15932: my ($categories,$cats,$idx,$jsarray) = @_;
15933: my %counters;
15934: my $num = 0;
15935: foreach my $item (keys(%{$categories})) {
15936: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
15937: if ($container eq '' && $depth == 0) {
15938: $cats->[$depth][$categories->{$item}] = $cat;
15939: } else {
15940: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
15941: }
15942: my ($escitem,$tail) = split(/:/,$item,2);
15943: if ($counters{$tail} eq '') {
15944: $counters{$tail} = $num;
15945: $num ++;
15946: }
15947: if (ref($idx) eq 'HASH') {
15948: $idx->{$item} = $counters{$tail};
15949: }
15950: if (ref($jsarray) eq 'ARRAY') {
15951: push(@{$jsarray->[$counters{$tail}]},$item);
15952: }
15953: }
15954: return;
15955: }
15956:
15957: =pod
15958:
15959: =item * &extract_categories()
15960:
15961: Used to generate breadcrumb trails for course categories.
15962:
15963: Inputs:
1.663 raeburn 15964:
1.655 raeburn 15965: categories (reference to hash of category definitions).
1.663 raeburn 15966:
1.655 raeburn 15967: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15968: categories and subcategories).
1.663 raeburn 15969:
1.655 raeburn 15970: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 15971:
1.655 raeburn 15972: allitems (reference to hash - key is category key
15973: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15974:
1.655 raeburn 15975: idx (reference to hash of counters used in Domain Coordinator interface for
15976: editing Course Categories).
1.663 raeburn 15977:
1.655 raeburn 15978: jsarray (reference to array of categories used to create Javascript arrays for
15979: Domain Coordinator interface for editing Course Categories).
15980:
1.665 raeburn 15981: subcats (reference to hash of arrays containing all subcategories within each
15982: category, -recursive)
15983:
1.1321 raeburn 15984: maxd (reference to hash used to hold max depth for all top-level categories).
15985:
1.655 raeburn 15986: Returns: nothing
15987:
15988: Side effects: populates trails and allitems hash references.
15989:
15990: =cut
15991:
15992: sub extract_categories {
1.1321 raeburn 15993: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 15994: if (ref($categories) eq 'HASH') {
15995: &gather_categories($categories,$cats,$idx,$jsarray);
15996: if (ref($cats->[0]) eq 'ARRAY') {
15997: for (my $i=0; $i<@{$cats->[0]}; $i++) {
15998: my $name = $cats->[0][$i];
15999: my $item = &escape($name).'::0';
16000: my $trailstr;
16001: if ($name eq 'instcode') {
16002: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16003: } elsif ($name eq 'communities') {
16004: $trailstr = &mt('Communities');
1.1239 raeburn 16005: } elsif ($name eq 'placement') {
16006: $trailstr = &mt('Placement Tests');
1.655 raeburn 16007: } else {
16008: $trailstr = $name;
16009: }
16010: if ($allitems->{$item} eq '') {
16011: push(@{$trails},$trailstr);
16012: $allitems->{$item} = scalar(@{$trails})-1;
16013: }
16014: my @parents = ($name);
16015: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16016: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16017: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16018: if (ref($subcats) eq 'HASH') {
16019: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16020: }
1.1321 raeburn 16021: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16022: }
16023: } else {
16024: if (ref($subcats) eq 'HASH') {
16025: $subcats->{$item} = [];
1.655 raeburn 16026: }
1.1321 raeburn 16027: if (ref($maxd) eq 'HASH') {
16028: $maxd->{$name} = 1;
16029: }
1.655 raeburn 16030: }
16031: }
16032: }
16033: }
16034: return;
16035: }
16036:
16037: =pod
16038:
1.1162 raeburn 16039: =item * &recurse_categories()
1.655 raeburn 16040:
16041: Recursively used to generate breadcrumb trails for course categories.
16042:
16043: Inputs:
1.663 raeburn 16044:
1.655 raeburn 16045: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16046: categories and subcategories).
1.663 raeburn 16047:
1.655 raeburn 16048: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16049:
16050: category (current course category, for which breadcrumb trail is being generated).
16051:
16052: trails (reference to array of breadcrumb trails for each category).
16053:
1.655 raeburn 16054: allitems (reference to hash - key is category key
16055: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16056:
1.655 raeburn 16057: parents (array containing containers directories for current category,
16058: back to top level).
16059:
16060: Returns: nothing
16061:
16062: Side effects: populates trails and allitems hash references
16063:
16064: =cut
16065:
16066: sub recurse_categories {
1.1321 raeburn 16067: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16068: my $shallower = $depth - 1;
16069: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16070: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16071: my $name = $cats->[$depth]{$category}[$k];
16072: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16073: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16074: if ($allitems->{$item} eq '') {
16075: push(@{$trails},$trailstr);
16076: $allitems->{$item} = scalar(@{$trails})-1;
16077: }
16078: my $deeper = $depth+1;
16079: push(@{$parents},$category);
1.665 raeburn 16080: if (ref($subcats) eq 'HASH') {
16081: my $subcat = &escape($name).':'.$category.':'.$depth;
16082: for (my $j=@{$parents}; $j>=0; $j--) {
16083: my $higher;
16084: if ($j > 0) {
16085: $higher = &escape($parents->[$j]).':'.
16086: &escape($parents->[$j-1]).':'.$j;
16087: } else {
16088: $higher = &escape($parents->[$j]).'::'.$j;
16089: }
16090: push(@{$subcats->{$higher}},$subcat);
16091: }
16092: }
16093: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16094: $subcats,$maxd);
1.655 raeburn 16095: pop(@{$parents});
16096: }
16097: } else {
16098: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16099: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16100: if ($allitems->{$item} eq '') {
16101: push(@{$trails},$trailstr);
16102: $allitems->{$item} = scalar(@{$trails})-1;
16103: }
1.1321 raeburn 16104: if (ref($maxd) eq 'HASH') {
16105: if ($depth > $maxd->{$parents->[0]}) {
16106: $maxd->{$parents->[0]} = $depth;
16107: }
16108: }
1.655 raeburn 16109: }
16110: return;
16111: }
16112:
1.663 raeburn 16113: =pod
16114:
1.1162 raeburn 16115: =item * &assign_categories_table()
1.663 raeburn 16116:
16117: Create a datatable for display of hierarchical categories in a domain,
16118: with checkboxes to allow a course to be categorized.
16119:
16120: Inputs:
16121:
16122: cathash - reference to hash of categories defined for the domain (from
16123: configuration.db)
16124:
16125: currcat - scalar with an & separated list of categories assigned to a course.
16126:
1.919 raeburn 16127: type - scalar contains course type (Course or Community).
16128:
1.1260 raeburn 16129: disabled - scalar (optional) contains disabled="disabled" if input elements are
16130: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16131:
1.663 raeburn 16132: Returns: $output (markup to be displayed)
16133:
16134: =cut
16135:
16136: sub assign_categories_table {
1.1259 raeburn 16137: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16138: my $output;
16139: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16140: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16141: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16142: $maxdepth = scalar(@cats);
16143: if (@cats > 0) {
16144: my $itemcount = 0;
16145: if (ref($cats[0]) eq 'ARRAY') {
16146: my @currcategories;
16147: if ($currcat ne '') {
16148: @currcategories = split('&',$currcat);
16149: }
1.919 raeburn 16150: my $table;
1.663 raeburn 16151: for (my $i=0; $i<@{$cats[0]}; $i++) {
16152: my $parent = $cats[0][$i];
1.919 raeburn 16153: next if ($parent eq 'instcode');
16154: if ($type eq 'Community') {
16155: next unless ($parent eq 'communities');
1.1239 raeburn 16156: } elsif ($type eq 'Placement') {
16157: next unless ($parent eq 'placement');
1.919 raeburn 16158: } else {
1.1239 raeburn 16159: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16160: }
1.663 raeburn 16161: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16162: my $item = &escape($parent).'::0';
16163: my $checked = '';
16164: if (@currcategories > 0) {
16165: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16166: $checked = ' checked="checked"';
1.663 raeburn 16167: }
16168: }
1.919 raeburn 16169: my $parent_title = $parent;
16170: if ($parent eq 'communities') {
16171: $parent_title = &mt('Communities');
1.1239 raeburn 16172: } elsif ($parent eq 'placement') {
16173: $parent_title = &mt('Placement Tests');
1.919 raeburn 16174: }
16175: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16176: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16177: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16178: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16179: my $depth = 1;
16180: push(@path,$parent);
1.1259 raeburn 16181: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16182: pop(@path);
1.919 raeburn 16183: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16184: $itemcount ++;
16185: }
1.919 raeburn 16186: if ($itemcount) {
16187: $output = &Apache::loncommon::start_data_table().
16188: $table.
16189: &Apache::loncommon::end_data_table();
16190: }
1.663 raeburn 16191: }
16192: }
16193: }
16194: return $output;
16195: }
16196:
16197: =pod
16198:
1.1162 raeburn 16199: =item * &assign_category_rows()
1.663 raeburn 16200:
16201: Create a datatable row for display of nested categories in a domain,
16202: with checkboxes to allow a course to be categorized,called recursively.
16203:
16204: Inputs:
16205:
16206: itemcount - track row number for alternating colors
16207:
16208: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16209: categories and subcategories.
16210:
16211: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16212:
16213: parent - parent of current category item
16214:
16215: path - Array containing all categories back up through the hierarchy from the
16216: current category to the top level.
16217:
16218: currcategories - reference to array of current categories assigned to the course
16219:
1.1260 raeburn 16220: disabled - scalar (optional) contains disabled="disabled" if input elements are
16221: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16222:
1.663 raeburn 16223: Returns: $output (markup to be displayed).
16224:
16225: =cut
16226:
16227: sub assign_category_rows {
1.1259 raeburn 16228: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16229: my ($text,$name,$item,$chgstr);
16230: if (ref($cats) eq 'ARRAY') {
16231: my $maxdepth = scalar(@{$cats});
16232: if (ref($cats->[$depth]) eq 'HASH') {
16233: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16234: my $numchildren = @{$cats->[$depth]{$parent}};
16235: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16236: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16237: for (my $j=0; $j<$numchildren; $j++) {
16238: $name = $cats->[$depth]{$parent}[$j];
16239: $item = &escape($name).':'.&escape($parent).':'.$depth;
16240: my $deeper = $depth+1;
16241: my $checked = '';
16242: if (ref($currcategories) eq 'ARRAY') {
16243: if (@{$currcategories} > 0) {
16244: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16245: $checked = ' checked="checked"';
1.663 raeburn 16246: }
16247: }
16248: }
1.664 raeburn 16249: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16250: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16251: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16252: '<input type="hidden" name="catname" value="'.$name.'" />'.
16253: '</td><td>';
1.663 raeburn 16254: if (ref($path) eq 'ARRAY') {
16255: push(@{$path},$name);
1.1259 raeburn 16256: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16257: pop(@{$path});
16258: }
16259: $text .= '</td></tr>';
16260: }
16261: $text .= '</table></td>';
16262: }
16263: }
16264: }
16265: return $text;
16266: }
16267:
1.1181 raeburn 16268: =pod
16269:
16270: =back
16271:
16272: =cut
16273:
1.655 raeburn 16274: ############################################################
16275: ############################################################
16276:
16277:
1.443 albertel 16278: sub commit_customrole {
1.664 raeburn 16279: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 16280: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16281: ($start?', '.&mt('starting').' '.localtime($start):'').
16282: ($end?', ending '.localtime($end):'').': <b>'.
16283: &Apache::lonnet::assigncustomrole(
1.664 raeburn 16284: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 16285: '</b><br />';
16286: return $output;
16287: }
16288:
16289: sub commit_standardrole {
1.1116 raeburn 16290: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 16291: my ($output,$logmsg,$linefeed);
16292: if ($context eq 'auto') {
16293: $linefeed = "\n";
16294: } else {
16295: $linefeed = "<br />\n";
16296: }
1.443 albertel 16297: if ($three eq 'st') {
1.541 raeburn 16298: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 16299: $one,$two,$sec,$context,$credits);
1.541 raeburn 16300: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16301: ($result eq 'unknown_course') || ($result eq 'refused')) {
16302: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16303: } else {
1.541 raeburn 16304: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16305: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16306: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16307: if ($context eq 'auto') {
16308: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16309: } else {
16310: $output .= '<b>'.$result.'</b>'.$linefeed.
16311: &mt('Add to classlist').': <b>ok</b>';
16312: }
16313: $output .= $linefeed;
1.443 albertel 16314: }
16315: } else {
16316: $output = &mt('Assigning').' '.$three.' in '.$url.
16317: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16318: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 16319: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 16320: if ($context eq 'auto') {
16321: $output .= $result.$linefeed;
16322: } else {
16323: $output .= '<b>'.$result.'</b>'.$linefeed;
16324: }
1.443 albertel 16325: }
16326: return $output;
16327: }
16328:
16329: sub commit_studentrole {
1.1116 raeburn 16330: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
16331: $credits) = @_;
1.626 raeburn 16332: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 16333: if ($context eq 'auto') {
16334: $linefeed = "\n";
16335: } else {
16336: $linefeed = '<br />'."\n";
16337: }
1.443 albertel 16338: if (defined($one) && defined($two)) {
16339: my $cid=$one.'_'.$two;
16340: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
16341: my $secchange = 0;
16342: my $expire_role_result;
16343: my $modify_section_result;
1.628 raeburn 16344: if ($oldsec ne '-1') {
16345: if ($oldsec ne $sec) {
1.443 albertel 16346: $secchange = 1;
1.628 raeburn 16347: my $now = time;
1.443 albertel 16348: my $uurl='/'.$cid;
16349: $uurl=~s/\_/\//g;
16350: if ($oldsec) {
16351: $uurl.='/'.$oldsec;
16352: }
1.626 raeburn 16353: $oldsecurl = $uurl;
1.628 raeburn 16354: $expire_role_result =
1.652 raeburn 16355: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 16356: if ($env{'request.course.sec'} ne '') {
16357: if ($expire_role_result eq 'refused') {
16358: my @roles = ('st');
16359: my @statuses = ('previous');
16360: my @roledoms = ($one);
16361: my $withsec = 1;
16362: my %roleshash =
16363: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
16364: \@statuses,\@roles,\@roledoms,$withsec);
16365: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
16366: my ($oldstart,$oldend) =
16367: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
16368: if ($oldend > 0 && $oldend <= $now) {
16369: $expire_role_result = 'ok';
16370: }
16371: }
16372: }
16373: }
1.443 albertel 16374: $result = $expire_role_result;
16375: }
16376: }
16377: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 16378: $modify_section_result =
16379: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
16380: undef,undef,undef,$sec,
16381: $end,$start,'','',$cid,
16382: '',$context,$credits);
1.443 albertel 16383: if ($modify_section_result =~ /^ok/) {
16384: if ($secchange == 1) {
1.628 raeburn 16385: if ($sec eq '') {
16386: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
16387: } else {
16388: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
16389: }
1.443 albertel 16390: } elsif ($oldsec eq '-1') {
1.628 raeburn 16391: if ($sec eq '') {
16392: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
16393: } else {
16394: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16395: }
1.443 albertel 16396: } else {
1.628 raeburn 16397: if ($sec eq '') {
16398: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
16399: } else {
16400: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16401: }
1.443 albertel 16402: }
16403: } else {
1.1115 raeburn 16404: if ($secchange) {
1.628 raeburn 16405: $$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;
16406: } else {
16407: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
16408: }
1.443 albertel 16409: }
16410: $result = $modify_section_result;
16411: } elsif ($secchange == 1) {
1.628 raeburn 16412: if ($oldsec eq '') {
1.1103 raeburn 16413: $$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 16414: } else {
16415: $$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;
16416: }
1.626 raeburn 16417: if ($expire_role_result eq 'refused') {
16418: my $newsecurl = '/'.$cid;
16419: $newsecurl =~ s/\_/\//g;
16420: if ($sec ne '') {
16421: $newsecurl.='/'.$sec;
16422: }
16423: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
16424: if ($sec eq '') {
16425: $$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;
16426: } else {
16427: $$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;
16428: }
16429: }
16430: }
1.443 albertel 16431: }
16432: } else {
1.626 raeburn 16433: $$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 16434: $result = "error: incomplete course id\n";
16435: }
16436: return $result;
16437: }
16438:
1.1108 raeburn 16439: sub show_role_extent {
16440: my ($scope,$context,$role) = @_;
16441: $scope =~ s{^/}{};
16442: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
16443: push(@courseroles,'co');
16444: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
16445: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
16446: $scope =~ s{/}{_};
16447: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
16448: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
16449: my ($audom,$auname) = split(/\//,$scope);
16450: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
16451: &Apache::loncommon::plainname($auname,$audom).'</span>');
16452: } else {
16453: $scope =~ s{/$}{};
16454: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
16455: &Apache::lonnet::domain($scope,'description').'</span>');
16456: }
16457: }
16458:
1.443 albertel 16459: ############################################################
16460: ############################################################
16461:
1.566 albertel 16462: sub check_clone {
1.578 raeburn 16463: my ($args,$linefeed) = @_;
1.566 albertel 16464: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
16465: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
16466: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 16467: my $clonetitle;
16468: my @clonemsg;
1.566 albertel 16469: my $can_clone = 0;
1.944 raeburn 16470: my $lctype = lc($args->{'crstype'});
1.908 raeburn 16471: if ($lctype ne 'community') {
16472: $lctype = 'course';
16473: }
1.566 albertel 16474: if ($clonehome eq 'no_host') {
1.944 raeburn 16475: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16476: push(@clonemsg,({
16477: mt => 'No new community created.',
16478: args => [],
16479: },
16480: {
16481: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
16482: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
16483: }));
1.908 raeburn 16484: } else {
1.1344 raeburn 16485: push(@clonemsg,({
16486: mt => 'No new course created.',
16487: args => [],
16488: },
16489: {
16490: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
16491: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16492: }));
16493: }
1.566 albertel 16494: } else {
16495: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 16496: $clonetitle = $clonedesc{'description'};
1.944 raeburn 16497: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 16498: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 16499: push(@clonemsg,({
16500: mt => 'No new community created.',
16501: args => [],
16502: },
16503: {
16504: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
16505: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16506: }));
16507: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 16508: }
16509: }
1.1262 raeburn 16510: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 16511: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 16512: $can_clone = 1;
16513: } else {
1.1221 raeburn 16514: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 16515: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 16516: if ($clonehash{'cloners'} eq '') {
16517: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
16518: if ($domdefs{'canclone'}) {
16519: unless ($domdefs{'canclone'} eq 'none') {
16520: if ($domdefs{'canclone'} eq 'domain') {
16521: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
16522: $can_clone = 1;
16523: }
16524: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16525: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
16526: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
16527: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
16528: $can_clone = 1;
16529: }
16530: }
16531: }
16532: }
1.578 raeburn 16533: } else {
1.1221 raeburn 16534: my @cloners = split(/,/,$clonehash{'cloners'});
16535: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 16536: $can_clone = 1;
1.1221 raeburn 16537: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 16538: $can_clone = 1;
1.1225 raeburn 16539: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
16540: $can_clone = 1;
1.1221 raeburn 16541: }
16542: unless ($can_clone) {
1.1225 raeburn 16543: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16544: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 16545: my (%gotdomdefaults,%gotcodedefaults);
16546: foreach my $cloner (@cloners) {
16547: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
16548: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
16549: my (%codedefaults,@code_order);
16550: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
16551: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
16552: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
16553: }
16554: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
16555: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
16556: }
16557: } else {
16558: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
16559: \%codedefaults,
16560: \@code_order);
16561: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
16562: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
16563: }
16564: if (@code_order > 0) {
16565: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
16566: $cloner,$clonehash{'internal.coursecode'},
16567: $args->{'crscode'})) {
16568: $can_clone = 1;
16569: last;
16570: }
16571: }
16572: }
16573: }
16574: }
1.1225 raeburn 16575: }
16576: }
16577: unless ($can_clone) {
16578: my $ccrole = 'cc';
16579: if ($args->{'crstype'} eq 'Community') {
16580: $ccrole = 'co';
16581: }
16582: my %roleshash =
16583: &Apache::lonnet::get_my_roles($args->{'ccuname'},
16584: $args->{'ccdomain'},
16585: 'userroles',['active'],[$ccrole],
16586: [$args->{'clonedomain'}]);
16587: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
16588: $can_clone = 1;
16589: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
16590: $args->{'ccuname'},$args->{'ccdomain'})) {
16591: $can_clone = 1;
1.1221 raeburn 16592: }
16593: }
16594: unless ($can_clone) {
16595: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16596: push(@clonemsg,({
16597: mt => 'No new community created.',
16598: args => [],
16599: },
16600: {
16601: 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]).',
16602: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16603: }));
1.942 raeburn 16604: } else {
1.1344 raeburn 16605: push(@clonemsg,({
16606: mt => 'No new course created.',
16607: args => [],
16608: },
16609: {
16610: 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]).',
16611: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16612: }));
1.1221 raeburn 16613: }
1.566 albertel 16614: }
1.578 raeburn 16615: }
1.566 albertel 16616: }
1.1344 raeburn 16617: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16618: }
16619:
1.444 albertel 16620: sub construct_course {
1.1262 raeburn 16621: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 16622: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
16623: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 16624: my $linefeed = '<br />'."\n";
16625: if ($context eq 'auto') {
16626: $linefeed = "\n";
16627: }
1.566 albertel 16628:
16629: #
16630: # Are we cloning?
16631: #
1.1344 raeburn 16632: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16633: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 16634: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 16635: if (!$can_clone) {
1.1344 raeburn 16636: return (0,$outcome,$clonemsgref);
1.566 albertel 16637: }
16638: }
16639:
1.444 albertel 16640: #
16641: # Open course
16642: #
1.1239 raeburn 16643: my $showncrstype;
16644: if ($args->{'crstype'} eq 'Placement') {
16645: $showncrstype = 'placement test';
16646: } else {
16647: $showncrstype = lc($args->{'crstype'});
16648: }
1.444 albertel 16649: my %cenv=();
16650: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
16651: $args->{'cdescr'},
16652: $args->{'curl'},
16653: $args->{'course_home'},
16654: $args->{'nonstandard'},
16655: $args->{'crscode'},
16656: $args->{'ccuname'}.':'.
16657: $args->{'ccdomain'},
1.882 raeburn 16658: $args->{'crstype'},
1.1344 raeburn 16659: $cnum,$context,$category,
16660: $callercontext);
1.444 albertel 16661:
16662: # Note: The testing routines depend on this being output; see
16663: # Utils::Course. This needs to at least be output as a comment
16664: # if anyone ever decides to not show this, and Utils::Course::new
16665: # will need to be suitably modified.
1.1344 raeburn 16666: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16667: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16668: } else {
16669: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16670: }
1.943 raeburn 16671: if ($$courseid =~ /^error:/) {
1.1344 raeburn 16672: return (0,$outcome,$clonemsgref);
1.943 raeburn 16673: }
16674:
1.444 albertel 16675: #
16676: # Check if created correctly
16677: #
1.479 albertel 16678: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 16679: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 16680: if ($crsuhome eq 'no_host') {
1.1344 raeburn 16681: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16682: $outcome .= &mt_user($user_lh,
16683: 'Course creation failed, unrecognized course home server.');
16684: } else {
16685: $outcome .= &mt('Course creation failed, unrecognized course home server.');
16686: }
16687: $outcome .= $linefeed;
16688: return (0,$outcome,$clonemsgref);
1.943 raeburn 16689: }
1.541 raeburn 16690: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 16691:
1.444 albertel 16692: #
1.566 albertel 16693: # Do the cloning
16694: #
1.1344 raeburn 16695: my @clonemsg;
1.566 albertel 16696: if ($can_clone && $cloneid) {
1.1344 raeburn 16697: push(@clonemsg,
16698: {
16699: mt => 'Created [_1] by cloning from [_2]',
16700: args => [$showncrstype,$clonetitle],
16701: });
1.566 albertel 16702: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 16703: # Copy all files
1.1344 raeburn 16704: my @info =
16705: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
16706: $args->{'dateshift'},$args->{'crscode'},
16707: $args->{'ccuname'}.':'.$args->{'ccdomain'},
16708: $args->{'tinyurls'});
16709: if (@info) {
16710: push(@clonemsg,@info);
16711: }
1.444 albertel 16712: # Restore URL
1.566 albertel 16713: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 16714: # Restore title
1.566 albertel 16715: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 16716: # Restore creation date, creator and creation context.
16717: $cenv{'internal.created'}=$oldcenv{'internal.created'};
16718: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
16719: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 16720: # Mark as cloned
1.566 albertel 16721: $cenv{'clonedfrom'}=$cloneid;
1.638 www 16722: # Need to clone grading mode
16723: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
16724: $cenv{'grading'}=$newenv{'grading'};
16725: # Do not clone these environment entries
16726: &Apache::lonnet::del('environment',
16727: ['default_enrollment_start_date',
16728: 'default_enrollment_end_date',
16729: 'question.email',
16730: 'policy.email',
16731: 'comment.email',
16732: 'pch.users.denied',
1.725 raeburn 16733: 'plc.users.denied',
16734: 'hidefromcat',
1.1121 raeburn 16735: 'checkforpriv',
1.1355 raeburn 16736: 'categories'],
1.638 www 16737: $$crsudom,$$crsunum);
1.1170 raeburn 16738: if ($args->{'textbook'}) {
16739: $cenv{'internal.textbook'} = $args->{'textbook'};
16740: }
1.444 albertel 16741: }
1.566 albertel 16742:
1.444 albertel 16743: #
16744: # Set environment (will override cloned, if existing)
16745: #
16746: my @sections = ();
16747: my @xlists = ();
16748: if ($args->{'crstype'}) {
16749: $cenv{'type'}=$args->{'crstype'};
16750: }
1.1371 raeburn 16751: if ($args->{'lti'}) {
16752: $cenv{'internal.lti'}=$args->{'lti'};
16753: }
1.444 albertel 16754: if ($args->{'crsid'}) {
16755: $cenv{'courseid'}=$args->{'crsid'};
16756: }
16757: if ($args->{'crscode'}) {
16758: $cenv{'internal.coursecode'}=$args->{'crscode'};
16759: }
16760: if ($args->{'crsquota'} ne '') {
16761: $cenv{'internal.coursequota'}=$args->{'crsquota'};
16762: } else {
16763: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
16764: }
16765: if ($args->{'ccuname'}) {
16766: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
16767: ':'.$args->{'ccdomain'};
16768: } else {
16769: $cenv{'internal.courseowner'} = $args->{'curruser'};
16770: }
1.1116 raeburn 16771: if ($args->{'defaultcredits'}) {
16772: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
16773: }
1.444 albertel 16774: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
16775: if ($args->{'crssections'}) {
16776: $cenv{'internal.sectionnums'} = '';
16777: if ($args->{'crssections'} =~ m/,/) {
16778: @sections = split/,/,$args->{'crssections'};
16779: } else {
16780: $sections[0] = $args->{'crssections'};
16781: }
16782: if (@sections > 0) {
16783: foreach my $item (@sections) {
16784: my ($sec,$gp) = split/:/,$item;
16785: my $class = $args->{'crscode'}.$sec;
16786: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
16787: $cenv{'internal.sectionnums'} .= $item.',';
16788: unless ($addcheck eq 'ok') {
1.1263 raeburn 16789: push(@badclasses,$class);
1.444 albertel 16790: }
16791: }
16792: $cenv{'internal.sectionnums'} =~ s/,$//;
16793: }
16794: }
16795: # do not hide course coordinator from staff listing,
16796: # even if privileged
16797: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 16798: # add course coordinator's domain to domains to check for privileged users
16799: # if different to course domain
16800: if ($$crsudom ne $args->{'ccdomain'}) {
16801: $cenv{'checkforpriv'} = $args->{'ccdomain'};
16802: }
1.444 albertel 16803: # add crosslistings
16804: if ($args->{'crsxlist'}) {
16805: $cenv{'internal.crosslistings'}='';
16806: if ($args->{'crsxlist'} =~ m/,/) {
16807: @xlists = split/,/,$args->{'crsxlist'};
16808: } else {
16809: $xlists[0] = $args->{'crsxlist'};
16810: }
16811: if (@xlists > 0) {
16812: foreach my $item (@xlists) {
16813: my ($xl,$gp) = split/:/,$item;
16814: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
16815: $cenv{'internal.crosslistings'} .= $item.',';
16816: unless ($addcheck eq 'ok') {
1.1263 raeburn 16817: push(@badclasses,$xl);
1.444 albertel 16818: }
16819: }
16820: $cenv{'internal.crosslistings'} =~ s/,$//;
16821: }
16822: }
16823: if ($args->{'autoadds'}) {
16824: $cenv{'internal.autoadds'}=$args->{'autoadds'};
16825: }
16826: if ($args->{'autodrops'}) {
16827: $cenv{'internal.autodrops'}=$args->{'autodrops'};
16828: }
16829: # check for notification of enrollment changes
16830: my @notified = ();
16831: if ($args->{'notify_owner'}) {
16832: if ($args->{'ccuname'} ne '') {
16833: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
16834: }
16835: }
16836: if ($args->{'notify_dc'}) {
16837: if ($uname ne '') {
1.630 raeburn 16838: push(@notified,$uname.':'.$udom);
1.444 albertel 16839: }
16840: }
16841: if (@notified > 0) {
16842: my $notifylist;
16843: if (@notified > 1) {
16844: $notifylist = join(',',@notified);
16845: } else {
16846: $notifylist = $notified[0];
16847: }
16848: $cenv{'internal.notifylist'} = $notifylist;
16849: }
16850: if (@badclasses > 0) {
16851: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 16852: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
16853: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
16854: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 16855: );
1.1264 raeburn 16856: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
16857: &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 16858: if ($context eq 'auto') {
16859: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 16860: } else {
1.566 albertel 16861: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 16862: }
16863: foreach my $item (@badclasses) {
1.541 raeburn 16864: if ($context eq 'auto') {
1.1261 raeburn 16865: $outcome .= " - $item\n";
1.541 raeburn 16866: } else {
1.1261 raeburn 16867: $outcome .= "<li>$item</li>\n";
1.541 raeburn 16868: }
1.1261 raeburn 16869: }
16870: if ($context eq 'auto') {
16871: $outcome .= $linefeed;
16872: } else {
16873: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 16874: }
1.444 albertel 16875: }
16876: if ($args->{'no_end_date'}) {
16877: $args->{'endaccess'} = 0;
16878: }
16879: $cenv{'internal.autostart'}=$args->{'enrollstart'};
16880: $cenv{'internal.autoend'}=$args->{'enrollend'};
16881: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
16882: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
16883: if ($args->{'showphotos'}) {
16884: $cenv{'internal.showphotos'}=$args->{'showphotos'};
16885: }
16886: $cenv{'internal.authtype'} = $args->{'authtype'};
16887: $cenv{'internal.autharg'} = $args->{'autharg'};
16888: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
16889: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 16890: 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');
16891: if ($context eq 'auto') {
16892: $outcome .= $krb_msg;
16893: } else {
1.566 albertel 16894: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 16895: }
16896: $outcome .= $linefeed;
1.444 albertel 16897: }
16898: }
16899: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
16900: if ($args->{'setpolicy'}) {
16901: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16902: }
16903: if ($args->{'setcontent'}) {
16904: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16905: }
1.1251 raeburn 16906: if ($args->{'setcomment'}) {
16907: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16908: }
1.444 albertel 16909: }
16910: if ($args->{'reshome'}) {
16911: $cenv{'reshome'}=$args->{'reshome'}.'/';
16912: $cenv{'reshome'}=~s/\/+$/\//;
16913: }
16914: #
16915: # course has keyed access
16916: #
16917: if ($args->{'setkeys'}) {
16918: $cenv{'keyaccess'}='yes';
16919: }
16920: # if specified, key authority is not course, but user
16921: # only active if keyaccess is yes
16922: if ($args->{'keyauth'}) {
1.487 albertel 16923: my ($user,$domain) = split(':',$args->{'keyauth'});
16924: $user = &LONCAPA::clean_username($user);
16925: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 16926: if ($user ne '' && $domain ne '') {
1.487 albertel 16927: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 16928: }
16929: }
16930:
1.1166 raeburn 16931: #
1.1167 raeburn 16932: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 16933: #
16934: if ($args->{'uniquecode'}) {
16935: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
16936: if ($code) {
16937: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 16938: my %crsinfo =
16939: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
16940: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
16941: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
16942: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
16943: }
1.1166 raeburn 16944: if (ref($coderef)) {
16945: $$coderef = $code;
16946: }
16947: }
16948: }
16949:
1.444 albertel 16950: if ($args->{'disresdis'}) {
16951: $cenv{'pch.roles.denied'}='st';
16952: }
16953: if ($args->{'disablechat'}) {
16954: $cenv{'plc.roles.denied'}='st';
16955: }
16956:
16957: # Record we've not yet viewed the Course Initialization Helper for this
16958: # course
16959: $cenv{'course.helper.not.run'} = 1;
16960: #
16961: # Use new Randomseed
16962: #
16963: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
16964: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
16965: #
16966: # The encryption code and receipt prefix for this course
16967: #
16968: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
16969: $cenv{'internal.encpref'}=100+int(9*rand(99));
16970: #
16971: # By default, use standard grading
16972: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
16973:
1.541 raeburn 16974: $outcome .= $linefeed.&mt('Setting environment').': '.
16975: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16976: #
16977: # Open all assignments
16978: #
16979: if ($args->{'openall'}) {
1.1341 raeburn 16980: my $opendate = time;
16981: if ($args->{'openallfrom'} =~ /^\d+$/) {
16982: $opendate = $args->{'openallfrom'};
16983: }
1.444 albertel 16984: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 16985: my %storecontent = ($storeunder => $opendate,
1.444 albertel 16986: $storeunder.'.type' => 'date_start');
1.1341 raeburn 16987: $outcome .= &mt('All assignments open starting [_1]',
16988: &Apache::lonlocal::locallocaltime($opendate)).': '.
16989: &Apache::lonnet::cput
16990: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16991: }
16992: #
16993: # Set first page
16994: #
16995: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
16996: || ($cloneid)) {
1.445 albertel 16997: use LONCAPA::map;
1.444 albertel 16998: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 16999:
17000: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17001: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17002:
1.444 albertel 17003: $outcome .= ($fatal?$errtext:'read ok').' - ';
17004: my $title; my $url;
17005: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17006: $title=&mt('Syllabus');
1.444 albertel 17007: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17008: } else {
1.963 raeburn 17009: $title=&mt('Table of Contents');
1.444 albertel 17010: $url='/adm/navmaps';
17011: }
1.445 albertel 17012:
17013: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17014: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17015:
17016: if ($errtext) { $fatal=2; }
1.541 raeburn 17017: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17018: }
1.566 albertel 17019:
1.1237 raeburn 17020: #
17021: # Set params for Placement Tests
17022: #
1.1239 raeburn 17023: if ($args->{'crstype'} eq 'Placement') {
17024: my %storecontent;
17025: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17026: my %defaults = (
17027: buttonshide => { value => 'yes',
17028: type => 'string_yesno',},
17029: type => { value => 'randomizetry',
17030: type => 'string_questiontype',},
17031: maxtries => { value => 1,
17032: type => 'int_pos',},
17033: problemstatus => { value => 'no',
17034: type => 'string_problemstatus',},
17035: );
17036: foreach my $key (keys(%defaults)) {
17037: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17038: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17039: }
1.1237 raeburn 17040: &Apache::lonnet::cput
17041: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17042: }
17043:
1.1344 raeburn 17044: return (1,$outcome,\@clonemsg);
1.444 albertel 17045: }
17046:
1.1166 raeburn 17047: sub make_unique_code {
17048: my ($cdom,$cnum) = @_;
17049: # get lock on uniquecodes db
17050: my $lockhash = {
17051: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17052: ':'.$env{'user.domain'},
17053: };
17054: my $tries = 0;
17055: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17056: my ($code,$error);
17057:
17058: while (($gotlock ne 'ok') && ($tries<3)) {
17059: $tries ++;
17060: sleep 1;
17061: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17062: }
17063: if ($gotlock eq 'ok') {
17064: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17065: my $gotcode;
17066: my $attempts = 0;
17067: while ((!$gotcode) && ($attempts < 100)) {
17068: $code = &generate_code();
17069: if (!exists($currcodes{$code})) {
17070: $gotcode = 1;
17071: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17072: $error = 'nostore';
17073: }
17074: }
17075: $attempts ++;
17076: }
17077: my @del_lock = ($cnum."\0".'uniquecodes');
17078: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17079: } else {
17080: $error = 'nolock';
17081: }
17082: return ($code,$error);
17083: }
17084:
17085: sub generate_code {
17086: my $code;
17087: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17088: for (my $i=0; $i<6; $i++) {
17089: my $lettnum = int (rand 2);
17090: my $item = '';
17091: if ($lettnum) {
17092: $item = $letts[int( rand(18) )];
17093: } else {
17094: $item = 1+int( rand(8) );
17095: }
17096: $code .= $item;
17097: }
17098: return $code;
17099: }
17100:
1.444 albertel 17101: ############################################################
17102: ############################################################
17103:
1.1237 raeburn 17104: # Community, Course and Placement Test
1.378 raeburn 17105: sub course_type {
17106: my ($cid) = @_;
17107: if (!defined($cid)) {
17108: $cid = $env{'request.course.id'};
17109: }
1.404 albertel 17110: if (defined($env{'course.'.$cid.'.type'})) {
17111: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17112: } else {
17113: return 'Course';
1.377 raeburn 17114: }
17115: }
1.156 albertel 17116:
1.406 raeburn 17117: sub group_term {
17118: my $crstype = &course_type();
17119: my %names = (
17120: 'Course' => 'group',
1.865 raeburn 17121: 'Community' => 'group',
1.1237 raeburn 17122: 'Placement' => 'group',
1.406 raeburn 17123: );
17124: return $names{$crstype};
17125: }
17126:
1.902 raeburn 17127: sub course_types {
1.1310 raeburn 17128: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17129: my %typename = (
17130: official => 'Official course',
17131: unofficial => 'Unofficial course',
17132: community => 'Community',
1.1165 raeburn 17133: textbook => 'Textbook course',
1.1237 raeburn 17134: placement => 'Placement test',
1.1310 raeburn 17135: lti => 'LTI provider',
1.902 raeburn 17136: );
17137: return (\@types,\%typename);
17138: }
17139:
1.156 albertel 17140: sub icon {
17141: my ($file)=@_;
1.505 albertel 17142: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17143: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17144: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17145: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17146: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17147: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17148: $curfext.".gif") {
17149: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17150: $curfext.".gif";
17151: }
17152: }
1.249 albertel 17153: return &lonhttpdurl($iconname);
1.154 albertel 17154: }
1.84 albertel 17155:
1.575 albertel 17156: sub lonhttpdurl {
1.692 www 17157: #
17158: # Had been used for "small fry" static images on separate port 8080.
17159: # Modify here if lightweight http functionality desired again.
17160: # Currently eliminated due to increasing firewall issues.
17161: #
1.575 albertel 17162: my ($url)=@_;
1.692 www 17163: return $url;
1.215 albertel 17164: }
17165:
1.213 albertel 17166: sub connection_aborted {
17167: my ($r)=@_;
17168: $r->print(" ");$r->rflush();
17169: my $c = $r->connection;
17170: return $c->aborted();
17171: }
17172:
1.221 foxr 17173: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17174: # strings as 'strings'.
17175: sub escape_single {
1.221 foxr 17176: my ($input) = @_;
1.223 albertel 17177: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17178: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17179: return $input;
17180: }
1.223 albertel 17181:
1.222 foxr 17182: # Same as escape_single, but escape's "'s This
17183: # can be used for "strings"
17184: sub escape_double {
17185: my ($input) = @_;
17186: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17187: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17188: return $input;
17189: }
1.223 albertel 17190:
1.222 foxr 17191: # Escapes the last element of a full URL.
17192: sub escape_url {
17193: my ($url) = @_;
1.238 raeburn 17194: my @urlslices = split(/\//, $url,-1);
1.369 www 17195: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17196: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17197: }
1.462 albertel 17198:
1.820 raeburn 17199: sub compare_arrays {
17200: my ($arrayref1,$arrayref2) = @_;
17201: my (@difference,%count);
17202: @difference = ();
17203: %count = ();
17204: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17205: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17206: foreach my $element (keys(%count)) {
17207: if ($count{$element} == 1) {
17208: push(@difference,$element);
17209: }
17210: }
17211: }
17212: return @difference;
17213: }
17214:
1.1322 raeburn 17215: sub lon_status_items {
17216: my %defaults = (
17217: E => 100,
17218: W => 4,
17219: N => 1,
1.1324 raeburn 17220: U => 5,
1.1322 raeburn 17221: threshold => 200,
17222: sysmail => 2500,
17223: );
17224: my %names = (
17225: E => 'Errors',
17226: W => 'Warnings',
17227: N => 'Notices',
1.1324 raeburn 17228: U => 'Unsent',
1.1322 raeburn 17229: );
17230: return (\%defaults,\%names);
17231: }
17232:
1.817 bisitz 17233: # -------------------------------------------------------- Initialize user login
1.462 albertel 17234: sub init_user_environment {
1.463 albertel 17235: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17236: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17237:
17238: my $public=($username eq 'public' && $domain eq 'public');
17239:
1.1062 raeburn 17240: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 17241: my $now=time;
17242:
17243: if ($public) {
17244: my $max_public=100;
17245: my $oldest;
17246: my $oldest_time=0;
17247: for(my $next=1;$next<=$max_public;$next++) {
17248: if (-e $lonids."/publicuser_$next.id") {
17249: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17250: if ($mtime<$oldest_time || !$oldest_time) {
17251: $oldest_time=$mtime;
17252: $oldest=$next;
17253: }
17254: } else {
17255: $cookie="publicuser_$next";
17256: last;
17257: }
17258: }
17259: if (!$cookie) { $cookie="publicuser_$oldest"; }
17260: } else {
1.1275 raeburn 17261: # See if old ID present, if so, remove if this isn't a robot,
17262: # killing any existing non-robot sessions
1.463 albertel 17263: if (!$args->{'robot'}) {
17264: opendir(DIR,$lonids);
17265: while ($filename=readdir(DIR)) {
17266: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17267: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17268: &GDBM_READER(),0640)) {
1.1295 raeburn 17269: my $linkedfile;
1.1320 raeburn 17270: if (exists($oldenv{'user.linkedenv'})) {
17271: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17272: }
1.1320 raeburn 17273: untie(%oldenv);
17274: if (unlink("$lonids/$filename")) {
17275: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17276: if (-l "$lonids/$linkedfile.id") {
17277: unlink("$lonids/$linkedfile.id");
17278: }
1.1295 raeburn 17279: }
17280: }
17281: } else {
17282: unlink($lonids.'/'.$filename);
17283: }
1.463 albertel 17284: }
1.462 albertel 17285: }
1.463 albertel 17286: closedir(DIR);
1.1204 raeburn 17287: # If there is a undeleted lockfile for the user's paste buffer remove it.
17288: my $namespace = 'nohist_courseeditor';
17289: my $lockingkey = 'paste'."\0".'locked_num';
17290: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
17291: $domain,$username);
17292: if (exists($lockhash{$lockingkey})) {
17293: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
17294: unless ($delresult eq 'ok') {
17295: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
17296: }
17297: }
1.462 albertel 17298: }
17299: # Give them a new cookie
1.463 albertel 17300: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 17301: : $now.$$.int(rand(10000)));
1.463 albertel 17302: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 17303:
17304: # Initialize roles
17305:
1.1062 raeburn 17306: ($userroles,$firstaccenv,$timerintenv) =
17307: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 17308: }
17309: # ------------------------------------ Check browser type and MathML capability
17310:
1.1194 raeburn 17311: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
17312: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 17313:
17314: # ------------------------------------------------------------- Get environment
17315:
17316: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
17317: my ($tmp) = keys(%userenv);
1.1275 raeburn 17318: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 17319: undef(%userenv);
17320: }
17321: if (($userenv{'interface'}) && (!$form->{'interface'})) {
17322: $form->{'interface'}=$userenv{'interface'};
17323: }
17324: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
17325:
17326: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 17327: foreach my $option ('interface','localpath','localres') {
17328: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 17329: }
17330: # --------------------------------------------------------- Write first profile
17331:
17332: {
1.1350 raeburn 17333: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 17334: my %initial_env =
17335: ("user.name" => $username,
17336: "user.domain" => $domain,
17337: "user.home" => $authhost,
17338: "browser.type" => $clientbrowser,
17339: "browser.version" => $clientversion,
17340: "browser.mathml" => $clientmathml,
17341: "browser.unicode" => $clientunicode,
17342: "browser.os" => $clientos,
1.1137 raeburn 17343: "browser.mobile" => $clientmobile,
1.1141 raeburn 17344: "browser.info" => $clientinfo,
1.1194 raeburn 17345: "browser.osversion" => $clientosversion,
1.462 albertel 17346: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
17347: "request.course.fn" => '',
17348: "request.course.uri" => '',
17349: "request.course.sec" => '',
17350: "request.role" => 'cm',
17351: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 17352: "request.host" => $ip,);
1.462 albertel 17353:
17354: if ($form->{'localpath'}) {
17355: $initial_env{"browser.localpath"} = $form->{'localpath'};
17356: $initial_env{"browser.localres"} = $form->{'localres'};
17357: }
17358:
17359: if ($form->{'interface'}) {
17360: $form->{'interface'}=~s/\W//gs;
17361: $initial_env{"browser.interface"} = $form->{'interface'};
17362: $env{'browser.interface'}=$form->{'interface'};
17363: }
17364:
1.1157 raeburn 17365: if ($form->{'iptoken'}) {
17366: my $lonhost = $r->dir_config('lonHostID');
17367: $initial_env{"user.noloadbalance"} = $lonhost;
17368: $env{'user.noloadbalance'} = $lonhost;
17369: }
17370:
1.1268 raeburn 17371: if ($form->{'noloadbalance'}) {
17372: my @hosts = &Apache::lonnet::current_machine_ids();
17373: my $hosthere = $form->{'noloadbalance'};
17374: if (grep(/^\Q$hosthere\E$/,@hosts)) {
17375: $initial_env{"user.noloadbalance"} = $hosthere;
17376: $env{'user.noloadbalance'} = $hosthere;
17377: }
17378: }
17379:
1.1016 raeburn 17380: unless ($domain eq 'public') {
1.1273 raeburn 17381: my %is_adv = ( is_adv => $env{'user.adv'} );
17382: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
17383:
17384: foreach my $tool ('aboutme','blog','webdav','portfolio') {
17385: $userenv{'availabletools.'.$tool} =
17386: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
17387: undef,\%userenv,\%domdef,\%is_adv);
17388: }
1.980 raeburn 17389:
1.1311 raeburn 17390: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 17391: $userenv{'canrequest.'.$crstype} =
17392: &Apache::lonnet::usertools_access($username,$domain,$crstype,
17393: 'reload','requestcourses',
17394: \%userenv,\%domdef,\%is_adv);
17395: }
1.724 raeburn 17396:
1.1273 raeburn 17397: $userenv{'canrequest.author'} =
17398: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
17399: 'reload','requestauthor',
1.980 raeburn 17400: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 17401: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
17402: $domain,$username);
17403: my $reqstatus = $reqauthor{'author_status'};
17404: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
17405: if (ref($reqauthor{'author'}) eq 'HASH') {
17406: $userenv{'requestauthorqueued'} = $reqstatus.':'.
17407: $reqauthor{'author'}{'timestamp'};
17408: }
1.1092 raeburn 17409: }
1.1287 raeburn 17410: my ($types,$typename) = &course_types();
17411: if (ref($types) eq 'ARRAY') {
17412: my @options = ('approval','validate','autolimit');
17413: my $optregex = join('|',@options);
17414: my (%willtrust,%trustchecked);
17415: foreach my $type (@{$types}) {
17416: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
17417: if ($dom_str ne '') {
17418: my $updatedstr = '';
17419: my @possdomains = split(',',$dom_str);
17420: foreach my $entry (@possdomains) {
17421: my ($extdom,$extopt) = split(':',$entry);
17422: unless ($trustchecked{$extdom}) {
17423: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
17424: $trustchecked{$extdom} = 1;
17425: }
17426: if ($willtrust{$extdom}) {
17427: $updatedstr .= $entry.',';
17428: }
17429: }
17430: $updatedstr =~ s/,$//;
17431: if ($updatedstr) {
17432: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
17433: } else {
17434: delete($userenv{'reqcrsotherdom.'.$type});
17435: }
17436: }
17437: }
17438: }
1.1092 raeburn 17439: }
1.462 albertel 17440: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 17441:
1.462 albertel 17442: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
17443: &GDBM_WRCREAT(),0640)) {
17444: &_add_to_env(\%disk_env,\%initial_env);
17445: &_add_to_env(\%disk_env,\%userenv,'environment.');
17446: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 17447: if (ref($firstaccenv) eq 'HASH') {
17448: &_add_to_env(\%disk_env,$firstaccenv);
17449: }
17450: if (ref($timerintenv) eq 'HASH') {
17451: &_add_to_env(\%disk_env,$timerintenv);
17452: }
1.463 albertel 17453: if (ref($args->{'extra_env'})) {
17454: &_add_to_env(\%disk_env,$args->{'extra_env'});
17455: }
1.462 albertel 17456: untie(%disk_env);
17457: } else {
1.705 tempelho 17458: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
17459: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 17460: return 'error: '.$!;
17461: }
17462: }
17463: $env{'request.role'}='cm';
17464: $env{'request.role.adv'}=$env{'user.adv'};
17465: $env{'browser.type'}=$clientbrowser;
17466:
17467: return $cookie;
17468:
17469: }
17470:
17471: sub _add_to_env {
17472: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 17473: if (ref($env_data) eq 'HASH') {
17474: while (my ($key,$value) = each(%$env_data)) {
17475: $idf->{$prefix.$key} = $value;
17476: $env{$prefix.$key} = $value;
17477: }
1.462 albertel 17478: }
17479: }
17480:
1.685 tempelho 17481: # --- Get the symbolic name of a problem and the url
17482: sub get_symb {
17483: my ($request,$silent) = @_;
1.726 raeburn 17484: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 17485: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
17486: if ($symb eq '') {
17487: if (!$silent) {
1.1071 raeburn 17488: if (ref($request)) {
17489: $request->print("Unable to handle ambiguous references:$url:.");
17490: }
1.685 tempelho 17491: return ();
17492: }
17493: }
17494: &Apache::lonenc::check_decrypt(\$symb);
17495: return ($symb);
17496: }
17497:
17498: # --------------------------------------------------------------Get annotation
17499:
17500: sub get_annotation {
17501: my ($symb,$enc) = @_;
17502:
17503: my $key = $symb;
17504: if (!$enc) {
17505: $key =
17506: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
17507: }
17508: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
17509: return $annotation{$key};
17510: }
17511:
17512: sub clean_symb {
1.731 raeburn 17513: my ($symb,$delete_enc) = @_;
1.685 tempelho 17514:
17515: &Apache::lonenc::check_decrypt(\$symb);
17516: my $enc = $env{'request.enc'};
1.731 raeburn 17517: if ($delete_enc) {
1.730 raeburn 17518: delete($env{'request.enc'});
17519: }
1.685 tempelho 17520:
17521: return ($symb,$enc);
17522: }
1.462 albertel 17523:
1.1181 raeburn 17524: ############################################################
17525: ############################################################
17526:
17527: =pod
17528:
17529: =head1 Routines for building display used to search for courses
17530:
17531:
17532: =over 4
17533:
17534: =item * &build_filters()
17535:
17536: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 17537: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
17538: and quotacheck.pl
17539:
1.1181 raeburn 17540:
17541: Inputs:
17542:
17543: filterlist - anonymous array of fields to include as potential filters
17544:
17545: crstype - course type
17546:
17547: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
17548: to pop-open a course selector (will contain "extra element").
17549:
17550: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
17551:
17552: filter - anonymous hash of criteria and their values
17553:
17554: action - form action
17555:
17556: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
17557:
1.1182 raeburn 17558: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 17559:
17560: cloneruname - username of owner of new course who wants to clone
17561:
17562: clonerudom - domain of owner of new course who wants to clone
17563:
17564: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
17565:
17566: codetitlesref - reference to array of titles of components in institutional codes (official courses)
17567:
17568: codedom - domain
17569:
17570: formname - value of form element named "form".
17571:
17572: fixeddom - domain, if fixed.
17573:
17574: prevphase - value to assign to form element named "phase" when going back to the previous screen
17575:
17576: cnameelement - name of form element in form on opener page which will receive title of selected course
17577:
17578: cnumelement - name of form element in form on opener page which will receive courseID of selected course
17579:
17580: cdomelement - name of form element in form on opener page which will receive domain of selected course
17581:
17582: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
17583:
17584: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
17585:
17586: clonewarning - warning message about missing information for intended course owner when DC creates a course
17587:
1.1182 raeburn 17588:
1.1181 raeburn 17589: Returns: $output - HTML for display of search criteria, and hidden form elements.
17590:
1.1182 raeburn 17591:
1.1181 raeburn 17592: Side Effects: None
17593:
17594: =cut
17595:
17596: # ---------------------------------------------- search for courses based on last activity etc.
17597:
17598: sub build_filters {
17599: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
17600: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
17601: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
17602: $cnameelement,$cnumelement,$cdomelement,$setroles,
17603: $clonetext,$clonewarning) = @_;
1.1182 raeburn 17604: my ($list,$jscript);
1.1181 raeburn 17605: my $onchange = 'javascript:updateFilters(this)';
17606: my ($domainselectform,$sincefilterform,$createdfilterform,
17607: $ownerdomselectform,$persondomselectform,$instcodeform,
17608: $typeselectform,$instcodetitle);
17609: if ($formname eq '') {
17610: $formname = $caller;
17611: }
17612: foreach my $item (@{$filterlist}) {
17613: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
17614: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
17615: if ($item eq 'domainfilter') {
17616: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
17617: } elsif ($item eq 'coursefilter') {
17618: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
17619: } elsif ($item eq 'ownerfilter') {
17620: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17621: } elsif ($item eq 'ownerdomfilter') {
17622: $filter->{'ownerdomfilter'} =
17623: &LONCAPA::clean_domain($filter->{$item});
17624: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
17625: 'ownerdomfilter',1);
17626: } elsif ($item eq 'personfilter') {
17627: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17628: } elsif ($item eq 'persondomfilter') {
17629: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
17630: 'persondomfilter',1);
17631: } else {
17632: $filter->{$item} =~ s/\W//g;
17633: }
17634: if (!$filter->{$item}) {
17635: $filter->{$item} = '';
17636: }
17637: }
17638: if ($item eq 'domainfilter') {
17639: my $allow_blank = 1;
17640: if ($formname eq 'portform') {
17641: $allow_blank=0;
17642: } elsif ($formname eq 'studentform') {
17643: $allow_blank=0;
17644: }
17645: if ($fixeddom) {
17646: $domainselectform = '<input type="hidden" name="domainfilter"'.
17647: ' value="'.$codedom.'" />'.
17648: &Apache::lonnet::domain($codedom,'description');
17649: } else {
17650: $domainselectform = &select_dom_form($filter->{$item},
17651: 'domainfilter',
17652: $allow_blank,'',$onchange);
17653: }
17654: } else {
17655: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
17656: }
17657: }
17658:
17659: # last course activity filter and selection
17660: $sincefilterform = &timebased_select_form('sincefilter',$filter);
17661:
17662: # course created filter and selection
17663: if (exists($filter->{'createdfilter'})) {
17664: $createdfilterform = &timebased_select_form('createdfilter',$filter);
17665: }
17666:
1.1239 raeburn 17667: my $prefix = $crstype;
17668: if ($crstype eq 'Placement') {
17669: $prefix = 'Placement Test'
17670: }
1.1181 raeburn 17671: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 17672: 'cac' => "$prefix Activity",
17673: 'ccr' => "$prefix Created",
17674: 'cde' => "$prefix Title",
17675: 'cdo' => "$prefix Domain",
1.1181 raeburn 17676: 'ins' => 'Institutional Code',
17677: 'inc' => 'Institutional Categorization',
1.1239 raeburn 17678: 'cow' => "$prefix Owner/Co-owner",
17679: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 17680: 'cog' => 'Type',
17681: );
17682:
17683: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17684: my $typeval = 'Course';
17685: if ($crstype eq 'Community') {
17686: $typeval = 'Community';
1.1239 raeburn 17687: } elsif ($crstype eq 'Placement') {
17688: $typeval = 'Placement';
1.1181 raeburn 17689: }
17690: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
17691: } else {
17692: $typeselectform = '<select name="type" size="1"';
17693: if ($onchange) {
17694: $typeselectform .= ' onchange="'.$onchange.'"';
17695: }
17696: $typeselectform .= '>'."\n";
1.1237 raeburn 17697: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 17698: my $shown;
17699: if ($posstype eq 'Placement') {
17700: $shown = &mt('Placement Test');
17701: } else {
17702: $shown = &mt($posstype);
17703: }
1.1181 raeburn 17704: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 17705: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 17706: }
17707: $typeselectform.="</select>";
17708: }
17709:
17710: my ($cloneableonlyform,$cloneabletitle);
17711: if (exists($filter->{'cloneableonly'})) {
17712: my $cloneableon = '';
17713: my $cloneableoff = ' checked="checked"';
17714: if ($filter->{'cloneableonly'}) {
17715: $cloneableon = $cloneableoff;
17716: $cloneableoff = '';
17717: }
17718: $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>';
17719: if ($formname eq 'ccrs') {
1.1187 bisitz 17720: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 17721: } else {
17722: $cloneabletitle = &mt('Cloneable by you');
17723: }
17724: }
17725: my $officialjs;
17726: if ($crstype eq 'Course') {
17727: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 17728: # if (($fixeddom) || ($formname eq 'requestcrs') ||
17729: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
17730: if ($codedom) {
1.1181 raeburn 17731: $officialjs = 1;
17732: ($instcodeform,$jscript,$$numtitlesref) =
17733: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
17734: $officialjs,$codetitlesref);
17735: if ($jscript) {
1.1182 raeburn 17736: $jscript = '<script type="text/javascript">'."\n".
17737: '// <![CDATA['."\n".
17738: $jscript."\n".
17739: '// ]]>'."\n".
17740: '</script>'."\n";
1.1181 raeburn 17741: }
17742: }
17743: if ($instcodeform eq '') {
17744: $instcodeform =
17745: '<input type="text" name="instcodefilter" size="10" value="'.
17746: $list->{'instcodefilter'}.'" />';
17747: $instcodetitle = $lt{'ins'};
17748: } else {
17749: $instcodetitle = $lt{'inc'};
17750: }
17751: if ($fixeddom) {
17752: $instcodetitle .= '<br />('.$codedom.')';
17753: }
17754: }
17755: }
17756: my $output = qq|
17757: <form method="post" name="filterpicker" action="$action">
17758: <input type="hidden" name="form" value="$formname" />
17759: |;
17760: if ($formname eq 'modifycourse') {
17761: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
17762: '<input type="hidden" name="prevphase" value="'.
17763: $prevphase.'" />'."\n";
1.1198 musolffc 17764: } elsif ($formname eq 'quotacheck') {
17765: $output .= qq|
17766: <input type="hidden" name="sortby" value="" />
17767: <input type="hidden" name="sortorder" value="" />
17768: |;
17769: } else {
1.1181 raeburn 17770: my $name_input;
17771: if ($cnameelement ne '') {
17772: $name_input = '<input type="hidden" name="cnameelement" value="'.
17773: $cnameelement.'" />';
17774: }
17775: $output .= qq|
1.1182 raeburn 17776: <input type="hidden" name="cnumelement" value="$cnumelement" />
17777: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 17778: $name_input
17779: $roleelement
17780: $multelement
17781: $typeelement
17782: |;
17783: if ($formname eq 'portform') {
17784: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
17785: }
17786: }
17787: if ($fixeddom) {
17788: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
17789: }
17790: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
17791: if ($sincefilterform) {
17792: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
17793: .$sincefilterform
17794: .&Apache::lonhtmlcommon::row_closure();
17795: }
17796: if ($createdfilterform) {
17797: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
17798: .$createdfilterform
17799: .&Apache::lonhtmlcommon::row_closure();
17800: }
17801: if ($domainselectform) {
17802: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
17803: .$domainselectform
17804: .&Apache::lonhtmlcommon::row_closure();
17805: }
17806: if ($typeselectform) {
17807: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17808: $output .= $typeselectform;
17809: } else {
17810: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
17811: .$typeselectform
17812: .&Apache::lonhtmlcommon::row_closure();
17813: }
17814: }
17815: if ($instcodeform) {
17816: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
17817: .$instcodeform
17818: .&Apache::lonhtmlcommon::row_closure();
17819: }
17820: if (exists($filter->{'ownerfilter'})) {
17821: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
17822: '<table><tr><td>'.&mt('Username').'<br />'.
17823: '<input type="text" name="ownerfilter" size="20" value="'.
17824: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17825: $ownerdomselectform.'</td></tr></table>'.
17826: &Apache::lonhtmlcommon::row_closure();
17827: }
17828: if (exists($filter->{'personfilter'})) {
17829: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
17830: '<table><tr><td>'.&mt('Username').'<br />'.
17831: '<input type="text" name="personfilter" size="20" value="'.
17832: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17833: $persondomselectform.'</td></tr></table>'.
17834: &Apache::lonhtmlcommon::row_closure();
17835: }
17836: if (exists($filter->{'coursefilter'})) {
17837: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
17838: .'<input type="text" name="coursefilter" size="25" value="'
17839: .$list->{'coursefilter'}.'" />'
17840: .&Apache::lonhtmlcommon::row_closure();
17841: }
17842: if ($cloneableonlyform) {
17843: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
17844: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
17845: }
17846: if (exists($filter->{'descriptfilter'})) {
17847: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
17848: .'<input type="text" name="descriptfilter" size="40" value="'
17849: .$list->{'descriptfilter'}.'" />'
17850: .&Apache::lonhtmlcommon::row_closure(1);
17851: }
17852: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
17853: '<input type="hidden" name="updater" value="" />'."\n".
17854: '<input type="submit" name="gosearch" value="'.
17855: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
17856: return $jscript.$clonewarning.$output;
17857: }
17858:
17859: =pod
17860:
17861: =item * &timebased_select_form()
17862:
1.1182 raeburn 17863: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 17864: filter e.g., Course Activity, Course Created, when searching for courses
17865: or communities
17866:
17867: Inputs:
17868:
17869: item - name of form element (sincefilter or createdfilter)
17870:
17871: filter - anonymous hash of criteria and their values
17872:
17873: Returns: HTML for a select box contained a blank, then six time selections,
17874: with value set in incoming form variables currently selected.
17875:
17876: Side Effects: None
17877:
17878: =cut
17879:
17880: sub timebased_select_form {
17881: my ($item,$filter) = @_;
17882: if (ref($filter) eq 'HASH') {
17883: $filter->{$item} =~ s/[^\d-]//g;
17884: if (!$filter->{$item}) { $filter->{$item}=-1; }
17885: return &select_form(
17886: $filter->{$item},
17887: $item,
17888: { '-1' => '',
17889: '86400' => &mt('today'),
17890: '604800' => &mt('last week'),
17891: '2592000' => &mt('last month'),
17892: '7776000' => &mt('last three months'),
17893: '15552000' => &mt('last six months'),
17894: '31104000' => &mt('last year'),
17895: 'select_form_order' =>
17896: ['-1','86400','604800','2592000','7776000',
17897: '15552000','31104000']});
17898: }
17899: }
17900:
17901: =pod
17902:
17903: =item * &js_changer()
17904:
17905: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 17906: when course type or domain is changed, and also to hide 'Searching ...' on
17907: page load completion for page showing search result.
1.1181 raeburn 17908:
17909: Inputs: None
17910:
1.1183 raeburn 17911: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 17912:
17913: Side Effects: None
17914:
17915: =cut
17916:
17917: sub js_changer {
17918: return <<ENDJS;
17919: <script type="text/javascript">
17920: // <![CDATA[
17921: function updateFilters(caller) {
17922: if (typeof(caller) != "undefined") {
17923: document.filterpicker.updater.value = caller.name;
17924: }
17925: document.filterpicker.submit();
17926: }
1.1183 raeburn 17927:
17928: function hideSearching() {
17929: if (document.getElementById('searching')) {
17930: document.getElementById('searching').style.display = 'none';
17931: }
17932: return;
17933: }
17934:
1.1181 raeburn 17935: // ]]>
17936: </script>
17937:
17938: ENDJS
17939: }
17940:
17941: =pod
17942:
1.1182 raeburn 17943: =item * &search_courses()
17944:
17945: Process selected filters form course search form and pass to lonnet::courseiddump
17946: to retrieve a hash for which keys are courseIDs which match the selected filters.
17947:
17948: Inputs:
17949:
17950: dom - domain being searched
17951:
17952: type - course type ('Course' or 'Community' or '.' if any).
17953:
17954: filter - anonymous hash of criteria and their values
17955:
17956: numtitles - for institutional codes - number of categories
17957:
17958: cloneruname - optional username of new course owner
17959:
17960: clonerudom - optional domain of new course owner
17961:
1.1221 raeburn 17962: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 17963: (used when DC is using course creation form)
17964:
17965: codetitles - reference to array of titles of components in institutional codes (official courses).
17966:
1.1221 raeburn 17967: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
17968: (and so can clone automatically)
17969:
17970: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
17971:
17972: reqinstcode - institutional code of new course, where search_courses is used to identify potential
17973: courses to clone
1.1182 raeburn 17974:
17975: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
17976:
17977:
17978: Side Effects: None
17979:
17980: =cut
17981:
17982:
17983: sub search_courses {
1.1221 raeburn 17984: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
17985: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 17986: my (%courses,%showcourses,$cloner);
17987: if (($filter->{'ownerfilter'} ne '') ||
17988: ($filter->{'ownerdomfilter'} ne '')) {
17989: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
17990: $filter->{'ownerdomfilter'};
17991: }
17992: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
17993: if (!$filter->{$item}) {
17994: $filter->{$item}='.';
17995: }
17996: }
17997: my $now = time;
17998: my $timefilter =
17999: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18000: my ($createdbefore,$createdafter);
18001: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18002: $createdbefore = $now;
18003: $createdafter = $now-$filter->{'createdfilter'};
18004: }
18005: my ($instcodefilter,$regexpok);
18006: if ($numtitles) {
18007: if ($env{'form.official'} eq 'on') {
18008: $instcodefilter =
18009: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18010: $regexpok = 1;
18011: } elsif ($env{'form.official'} eq 'off') {
18012: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18013: unless ($instcodefilter eq '') {
18014: $regexpok = -1;
18015: }
18016: }
18017: } else {
18018: $instcodefilter = $filter->{'instcodefilter'};
18019: }
18020: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18021: if ($type eq '') { $type = '.'; }
18022:
18023: if (($clonerudom ne '') && ($cloneruname ne '')) {
18024: $cloner = $cloneruname.':'.$clonerudom;
18025: }
18026: %courses = &Apache::lonnet::courseiddump($dom,
18027: $filter->{'descriptfilter'},
18028: $timefilter,
18029: $instcodefilter,
18030: $filter->{'combownerfilter'},
18031: $filter->{'coursefilter'},
18032: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18033: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18034: $filter->{'cloneableonly'},
18035: $createdbefore,$createdafter,undef,
1.1221 raeburn 18036: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18037: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18038: my $ccrole;
18039: if ($type eq 'Community') {
18040: $ccrole = 'co';
18041: } else {
18042: $ccrole = 'cc';
18043: }
18044: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18045: $filter->{'persondomfilter'},
18046: 'userroles',undef,
18047: [$ccrole,'in','ad','ep','ta','cr'],
18048: $dom);
18049: foreach my $role (keys(%rolehash)) {
18050: my ($cnum,$cdom,$courserole) = split(':',$role);
18051: my $cid = $cdom.'_'.$cnum;
18052: if (exists($courses{$cid})) {
18053: if (ref($courses{$cid}) eq 'HASH') {
18054: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18055: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18056: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18057: }
18058: } else {
18059: $courses{$cid}{roles} = [$courserole];
18060: }
18061: $showcourses{$cid} = $courses{$cid};
18062: }
18063: }
18064: }
18065: %courses = %showcourses;
18066: }
18067: return %courses;
18068: }
18069:
18070: =pod
18071:
1.1181 raeburn 18072: =back
18073:
1.1207 raeburn 18074: =head1 Routines for version requirements for current course.
18075:
18076: =over 4
18077:
18078: =item * &check_release_required()
18079:
18080: Compares required LON-CAPA version with version on server, and
18081: if required version is newer looks for a server with the required version.
18082:
18083: Looks first at servers in user's owen domain; if none suitable, looks at
18084: servers in course's domain are permitted to host sessions for user's domain.
18085:
18086: Inputs:
18087:
18088: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18089:
18090: $courseid - Course ID of current course
18091:
18092: $rolecode - User's current role in course (for switchserver query string).
18093:
18094: $required - LON-CAPA version needed by course (format: Major.Minor).
18095:
18096:
18097: Returns:
18098:
18099: $switchserver - query string tp append to /adm/switchserver call (if
18100: current server's LON-CAPA version is too old.
18101:
18102: $warning - Message is displayed if no suitable server could be found.
18103:
18104: =cut
18105:
18106: sub check_release_required {
18107: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18108: my ($switchserver,$warning);
18109: if ($required ne '') {
18110: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18111: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18112: if ($reqdmajor ne '' && $reqdminor ne '') {
18113: my $otherserver;
18114: if (($major eq '' && $minor eq '') ||
18115: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18116: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18117: my $switchlcrev =
18118: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18119: $userdomserver);
18120: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18121: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18122: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18123: my $cdom = $env{'course.'.$courseid.'.domain'};
18124: if ($cdom ne $env{'user.domain'}) {
18125: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18126: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18127: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18128: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18129: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18130: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18131: my $canhost =
18132: &Apache::lonnet::can_host_session($env{'user.domain'},
18133: $coursedomserver,
18134: $remoterev,
18135: $udomdefaults{'remotesessions'},
18136: $defdomdefaults{'hostedsessions'});
18137:
18138: if ($canhost) {
18139: $otherserver = $coursedomserver;
18140: } else {
18141: $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.");
18142: }
18143: } else {
18144: $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).");
18145: }
18146: } else {
18147: $otherserver = $userdomserver;
18148: }
18149: }
18150: if ($otherserver ne '') {
18151: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18152: }
18153: }
18154: }
18155: return ($switchserver,$warning);
18156: }
18157:
18158: =pod
18159:
18160: =item * &check_release_result()
18161:
18162: Inputs:
18163:
18164: $switchwarning - Warning message if no suitable server found to host session.
18165:
18166: $switchserver - query string to append to /adm/switchserver containing lonHostID
18167: and current role.
18168:
18169: Returns: HTML to display with information about requirement to switch server.
18170: Either displaying warning with link to Roles/Courses screen or
18171: display link to switchserver.
18172:
1.1181 raeburn 18173: =cut
18174:
1.1207 raeburn 18175: sub check_release_result {
18176: my ($switchwarning,$switchserver) = @_;
18177: my $output = &start_page('Selected course unavailable on this server').
18178: '<p class="LC_warning">';
18179: if ($switchwarning) {
18180: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18181: if (&show_course()) {
18182: $output .= &mt('Display courses');
18183: } else {
18184: $output .= &mt('Display roles');
18185: }
18186: $output .= '</a>';
18187: } elsif ($switchserver) {
18188: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18189: '<br />'.
18190: '<a href="/adm/switchserver?'.$switchserver.'">'.
18191: &mt('Switch Server').
18192: '</a>';
18193: }
18194: $output .= '</p>'.&end_page();
18195: return $output;
18196: }
18197:
18198: =pod
18199:
18200: =item * &needs_coursereinit()
18201:
18202: Determine if course contents stored for user's session needs to be
18203: refreshed, because content has changed since "Big Hash" last tied.
18204:
18205: Check for change is made if time last checked is more than 10 minutes ago
18206: (by default).
18207:
18208: Inputs:
18209:
18210: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18211:
18212: $interval (optional) - Time which may elapse (in s) between last check for content
18213: change in current course. (default: 600 s).
18214:
18215: Returns: an array; first element is:
18216:
18217: =over 4
18218:
18219: 'switch' - if content updates mean user's session
18220: needs to be switched to a server running a newer LON-CAPA version
18221:
18222: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18223: on current server hosting user's session
18224:
18225: '' - if no action required.
18226:
18227: =back
18228:
18229: If first item element is 'switch':
18230:
18231: second item is $switchwarning - Warning message if no suitable server found to host session.
18232:
18233: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18234: and current role.
18235:
18236: otherwise: no other elements returned.
18237:
18238: =back
18239:
18240: =cut
18241:
18242: sub needs_coursereinit {
18243: my ($loncaparev,$interval) = @_;
18244: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18245: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18246: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18247: my $now = time;
18248: if ($interval eq '') {
18249: $interval = 600;
18250: }
18251: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18252: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18253: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18254: if ($blocked) {
18255: return ();
18256: }
1.1207 raeburn 18257: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18258: if ($lastchange > $env{'request.course.tied'}) {
18259: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18260: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
18261: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
18262: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
18263: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
18264: $curr_reqd_hash{'internal.releaserequired'}});
18265: my ($switchserver,$switchwarning) =
18266: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
18267: $curr_reqd_hash{'internal.releaserequired'});
18268: if ($switchwarning ne '' || $switchserver ne '') {
18269: return ('switch',$switchwarning,$switchserver);
18270: }
18271: }
18272: }
18273: return ('update');
18274: }
18275: }
18276: return ();
18277: }
1.1181 raeburn 18278:
1.1083 raeburn 18279: sub update_content_constraints {
1.1326 raeburn 18280: my ($cdom,$cnum,$chome,$cid,$keeporder) = @_;
1.1083 raeburn 18281: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18282: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 18283: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 18284: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 18285: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 18286: if ($item eq 'resourcetag') {
18287: if ($name eq 'responsetype') {
18288: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
18289: }
1.1307 raeburn 18290: } elsif ($item eq 'course') {
18291: if ($name eq 'courserestype') {
18292: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
18293: }
1.1083 raeburn 18294: }
18295: }
18296: my $navmap = Apache::lonnavmaps::navmap->new();
18297: if (defined($navmap)) {
1.1307 raeburn 18298: my (%allresponses,%allcrsrestypes);
18299: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
18300: if ($res->is_tool()) {
18301: if ($allcrsrestypes{'exttool'}) {
18302: $allcrsrestypes{'exttool'} ++;
18303: } else {
18304: $allcrsrestypes{'exttool'} = 1;
18305: }
18306: next;
18307: }
1.1083 raeburn 18308: my %responses = $res->responseTypes();
18309: foreach my $key (keys(%responses)) {
18310: next unless(exists($checkresponsetypes{$key}));
18311: $allresponses{$key} += $responses{$key};
18312: }
18313: }
18314: foreach my $key (keys(%allresponses)) {
18315: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
18316: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18317: ($reqdmajor,$reqdminor) = ($major,$minor);
18318: }
18319: }
1.1307 raeburn 18320: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 18321: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 18322: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18323: ($reqdmajor,$reqdminor) = ($major,$minor);
18324: }
18325: }
1.1083 raeburn 18326: undef($navmap);
18327: }
1.1326 raeburn 18328: my (@resources,@order,@resparms,@zombies);
18329: if ($keeporder) {
18330: use LONCAPA::map;
18331: @resources = @LONCAPA::map::resources;
18332: @order = @LONCAPA::map::order;
18333: @resparms = @LONCAPA::map::resparms;
18334: @zombies = @LONCAPA::map::zombies;
18335: }
1.1308 raeburn 18336: my $suppmap = 'supplemental.sequence';
18337: my ($suppcount,$supptools,$errors) = (0,0,0);
18338: ($suppcount,$supptools,$errors) = &recurse_supplemental($cnum,$cdom,$suppmap,
18339: $suppcount,$supptools,$errors);
1.1326 raeburn 18340: if ($keeporder) {
18341: @LONCAPA::map::resources = @resources;
18342: @LONCAPA::map::order = @order;
18343: @LONCAPA::map::resparms = @resparms;
18344: @LONCAPA::map::zombies = @zombies;
18345: }
1.1308 raeburn 18346: if ($supptools) {
18347: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
18348: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
18349: ($reqdmajor,$reqdminor) = ($major,$minor);
18350: }
18351: }
1.1083 raeburn 18352: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
18353: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
18354: }
18355: return;
18356: }
18357:
1.1110 raeburn 18358: sub allmaps_incourse {
18359: my ($cdom,$cnum,$chome,$cid) = @_;
18360: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
18361: $cid = $env{'request.course.id'};
18362: $cdom = $env{'course.'.$cid.'.domain'};
18363: $cnum = $env{'course.'.$cid.'.num'};
18364: $chome = $env{'course.'.$cid.'.home'};
18365: }
18366: my %allmaps = ();
18367: my $lastchange =
18368: &Apache::lonnet::get_coursechange($cdom,$cnum);
18369: if ($lastchange > $env{'request.course.tied'}) {
18370: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
18371: unless ($ferr) {
1.1326 raeburn 18372: &update_content_constraints($cdom,$cnum,$chome,$cid,1);
1.1110 raeburn 18373: }
18374: }
18375: my $navmap = Apache::lonnavmaps::navmap->new();
18376: if (defined($navmap)) {
18377: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
18378: $allmaps{$res->src()} = 1;
18379: }
18380: }
18381: return \%allmaps;
18382: }
18383:
1.1083 raeburn 18384: sub parse_supplemental_title {
18385: my ($title) = @_;
18386:
18387: my ($foldertitle,$renametitle);
18388: if ($title =~ /&&&/) {
18389: $title = &HTML::Entites::decode($title);
18390: }
18391: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
18392: $renametitle=$4;
18393: my ($time,$uname,$udom) = ($1,$2,$3);
18394: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
18395: my $name = &plainname($uname,$udom);
18396: $name = &HTML::Entities::encode($name,'"<>&\'');
18397: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
18398: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
18399: $name.': <br />'.$foldertitle;
18400: }
18401: if (wantarray) {
18402: return ($title,$foldertitle,$renametitle);
18403: }
18404: return $title;
18405: }
18406:
1.1143 raeburn 18407: sub recurse_supplemental {
1.1308 raeburn 18408: my ($cnum,$cdom,$suppmap,$numfiles,$numexttools,$errors) = @_;
1.1143 raeburn 18409: if ($suppmap) {
18410: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
18411: if ($fatal) {
18412: $errors ++;
18413: } else {
18414: if ($#LONCAPA::map::resources > 0) {
18415: foreach my $res (@LONCAPA::map::resources) {
18416: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
18417: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 18418: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1308 raeburn 18419: ($numfiles,$numexttools,$errors) = &recurse_supplemental($cnum,$cdom,$1,
18420: $numfiles,$numexttools,$errors);
1.1143 raeburn 18421: } else {
1.1308 raeburn 18422: if ($src =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
18423: $numexttools ++;
18424: }
1.1143 raeburn 18425: $numfiles ++;
18426: }
18427: }
18428: }
18429: }
18430: }
18431: }
1.1308 raeburn 18432: return ($numfiles,$numexttools,$errors);
1.1143 raeburn 18433: }
18434:
1.1101 raeburn 18435: sub symb_to_docspath {
1.1267 raeburn 18436: my ($symb,$navmapref) = @_;
18437: return unless ($symb && ref($navmapref));
1.1101 raeburn 18438: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
18439: if ($resurl=~/\.(sequence|page)$/) {
18440: $mapurl=$resurl;
18441: } elsif ($resurl eq 'adm/navmaps') {
18442: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
18443: }
18444: my $mapresobj;
1.1267 raeburn 18445: unless (ref($$navmapref)) {
18446: $$navmapref = Apache::lonnavmaps::navmap->new();
18447: }
18448: if (ref($$navmapref)) {
18449: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 18450: }
18451: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
18452: my $type=$2;
18453: my $path;
18454: if (ref($mapresobj)) {
18455: my $pcslist = $mapresobj->map_hierarchy();
18456: if ($pcslist ne '') {
18457: foreach my $pc (split(/,/,$pcslist)) {
18458: next if ($pc <= 1);
1.1267 raeburn 18459: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 18460: if (ref($res)) {
18461: my $thisurl = $res->src();
18462: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
18463: my $thistitle = $res->title();
18464: $path .= '&'.
18465: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 18466: &escape($thistitle).
1.1101 raeburn 18467: ':'.$res->randompick().
18468: ':'.$res->randomout().
18469: ':'.$res->encrypted().
18470: ':'.$res->randomorder().
18471: ':'.$res->is_page();
18472: }
18473: }
18474: }
18475: $path =~ s/^\&//;
18476: my $maptitle = $mapresobj->title();
18477: if ($mapurl eq 'default') {
1.1129 raeburn 18478: $maptitle = 'Main Content';
1.1101 raeburn 18479: }
18480: $path .= (($path ne '')? '&' : '').
18481: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18482: &escape($maptitle).
1.1101 raeburn 18483: ':'.$mapresobj->randompick().
18484: ':'.$mapresobj->randomout().
18485: ':'.$mapresobj->encrypted().
18486: ':'.$mapresobj->randomorder().
18487: ':'.$mapresobj->is_page();
18488: } else {
18489: my $maptitle = &Apache::lonnet::gettitle($mapurl);
18490: my $ispage = (($type eq 'page')? 1 : '');
18491: if ($mapurl eq 'default') {
1.1129 raeburn 18492: $maptitle = 'Main Content';
1.1101 raeburn 18493: }
18494: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18495: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 18496: }
18497: unless ($mapurl eq 'default') {
18498: $path = 'default&'.
1.1146 raeburn 18499: &escape('Main Content').
1.1101 raeburn 18500: ':::::&'.$path;
18501: }
18502: return $path;
18503: }
18504:
1.1094 raeburn 18505: sub captcha_display {
1.1327 raeburn 18506: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18507: my ($output,$error);
1.1234 raeburn 18508: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 18509: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18510: if ($captcha eq 'original') {
1.1094 raeburn 18511: $output = &create_captcha();
18512: unless ($output) {
1.1172 raeburn 18513: $error = 'captcha';
1.1094 raeburn 18514: }
18515: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18516: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 18517: unless ($output) {
1.1172 raeburn 18518: $error = 'recaptcha';
1.1094 raeburn 18519: }
18520: }
1.1234 raeburn 18521: return ($output,$error,$captcha,$version);
1.1094 raeburn 18522: }
18523:
18524: sub captcha_response {
1.1327 raeburn 18525: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18526: my ($captcha_chk,$captcha_error);
1.1327 raeburn 18527: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18528: if ($captcha eq 'original') {
1.1094 raeburn 18529: ($captcha_chk,$captcha_error) = &check_captcha();
18530: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18531: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 18532: } else {
18533: $captcha_chk = 1;
18534: }
18535: return ($captcha_chk,$captcha_error);
18536: }
18537:
18538: sub get_captcha_config {
1.1327 raeburn 18539: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 18540: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 18541: my $hostname = &Apache::lonnet::hostname($lonhost);
18542: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
18543: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 18544: if ($context eq 'usercreation') {
18545: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
18546: if (ref($domconfig{$context}) eq 'HASH') {
18547: $hashtocheck = $domconfig{$context}{'cancreate'};
18548: if (ref($hashtocheck) eq 'HASH') {
18549: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
18550: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
18551: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
18552: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
18553: }
18554: if ($privkey && $pubkey) {
18555: $captcha = 'recaptcha';
1.1234 raeburn 18556: $version = $hashtocheck->{'recaptchaversion'};
18557: if ($version ne '2') {
18558: $version = 1;
18559: }
1.1095 raeburn 18560: } else {
18561: $captcha = 'original';
18562: }
18563: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
18564: $captcha = 'original';
18565: }
1.1094 raeburn 18566: }
1.1095 raeburn 18567: } else {
18568: $captcha = 'captcha';
18569: }
18570: } elsif ($context eq 'login') {
18571: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
18572: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
18573: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
18574: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 18575: if ($privkey && $pubkey) {
18576: $captcha = 'recaptcha';
1.1234 raeburn 18577: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
18578: if ($version ne '2') {
18579: $version = 1;
18580: }
1.1095 raeburn 18581: } else {
18582: $captcha = 'original';
1.1094 raeburn 18583: }
1.1095 raeburn 18584: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
18585: $captcha = 'original';
1.1094 raeburn 18586: }
1.1327 raeburn 18587: } elsif ($context eq 'passwords') {
18588: if ($dom_in_effect) {
18589: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
18590: if ($passwdconf{'captcha'} eq 'recaptcha') {
18591: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
18592: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
18593: $privkey = $passwdconf{'recaptchakeys'}{'private'};
18594: }
18595: if ($privkey && $pubkey) {
18596: $captcha = 'recaptcha';
18597: $version = $passwdconf{'recaptchaversion'};
18598: if ($version ne '2') {
18599: $version = 1;
18600: }
18601: } else {
18602: $captcha = 'original';
18603: }
18604: } elsif ($passwdconf{'captcha'} ne 'notused') {
18605: $captcha = 'original';
18606: }
18607: }
18608: }
1.1234 raeburn 18609: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 18610: }
18611:
18612: sub create_captcha {
18613: my %captcha_params = &captcha_settings();
18614: my ($output,$maxtries,$tries) = ('',10,0);
18615: while ($tries < $maxtries) {
18616: $tries ++;
18617: my $captcha = Authen::Captcha->new (
18618: output_folder => $captcha_params{'output_dir'},
18619: data_folder => $captcha_params{'db_dir'},
18620: );
18621: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
18622:
18623: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
18624: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 18625: '<span class="LC_nobreak">'.
1.1094 raeburn 18626: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 18627: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
1.1367 raeburn 18628: '</span><br />'.
1.1176 raeburn 18629: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 18630: last;
18631: }
18632: }
1.1323 raeburn 18633: if ($output eq '') {
18634: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
18635: }
1.1094 raeburn 18636: return $output;
18637: }
18638:
18639: sub captcha_settings {
18640: my %captcha_params = (
18641: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
18642: www_output_dir => "/captchaspool",
18643: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
18644: numchars => '5',
18645: );
18646: return %captcha_params;
18647: }
18648:
18649: sub check_captcha {
18650: my ($captcha_chk,$captcha_error);
18651: my $code = $env{'form.code'};
18652: my $md5sum = $env{'form.crypt'};
18653: my %captcha_params = &captcha_settings();
18654: my $captcha = Authen::Captcha->new(
18655: output_folder => $captcha_params{'output_dir'},
18656: data_folder => $captcha_params{'db_dir'},
18657: );
1.1109 raeburn 18658: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 18659: my %captcha_hash = (
18660: 0 => 'Code not checked (file error)',
18661: -1 => 'Failed: code expired',
18662: -2 => 'Failed: invalid code (not in database)',
18663: -3 => 'Failed: invalid code (code does not match crypt)',
18664: );
18665: if ($captcha_chk != 1) {
18666: $captcha_error = $captcha_hash{$captcha_chk}
18667: }
18668: return ($captcha_chk,$captcha_error);
18669: }
18670:
18671: sub create_recaptcha {
1.1234 raeburn 18672: my ($pubkey,$version) = @_;
18673: if ($version >= 2) {
1.1367 raeburn 18674: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
18675: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 18676: } else {
18677: my $use_ssl;
18678: if ($ENV{'SERVER_PORT'} == 443) {
18679: $use_ssl = 1;
18680: }
18681: my $captcha = Captcha::reCAPTCHA->new;
18682: return $captcha->get_options_setter({theme => 'white'})."\n".
18683: $captcha->get_html($pubkey,undef,$use_ssl).
18684: &mt('If the text is hard to read, [_1] will replace them.',
18685: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
18686: '<br /><br />';
18687: }
1.1094 raeburn 18688: }
18689:
18690: sub check_recaptcha {
1.1234 raeburn 18691: my ($privkey,$version) = @_;
1.1094 raeburn 18692: my $captcha_chk;
1.1350 raeburn 18693: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 18694: if ($version >= 2) {
18695: my %info = (
18696: secret => $privkey,
18697: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 18698: remoteip => $ip,
1.1234 raeburn 18699: );
1.1280 raeburn 18700: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
18701: $request->content(join('&',map {
18702: my $name = escape($_);
18703: "$name=" . ( ref($info{$_}) eq 'ARRAY'
18704: ? join("&$name=", map {escape($_) } @{$info{$_}})
18705: : &escape($info{$_}) );
18706: } keys(%info)));
18707: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 18708: if ($response->is_success) {
18709: my $data = JSON::DWIW->from_json($response->decoded_content);
18710: if (ref($data) eq 'HASH') {
18711: if ($data->{'success'}) {
18712: $captcha_chk = 1;
18713: }
18714: }
18715: }
18716: } else {
18717: my $captcha = Captcha::reCAPTCHA->new;
18718: my $captcha_result =
18719: $captcha->check_answer(
18720: $privkey,
1.1350 raeburn 18721: $ip,
1.1234 raeburn 18722: $env{'form.recaptcha_challenge_field'},
18723: $env{'form.recaptcha_response_field'},
18724: );
18725: if ($captcha_result->{is_valid}) {
18726: $captcha_chk = 1;
18727: }
1.1094 raeburn 18728: }
18729: return $captcha_chk;
18730: }
18731:
1.1174 raeburn 18732: sub emailusername_info {
1.1244 raeburn 18733: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 18734: my %titles = &Apache::lonlocal::texthash (
18735: lastname => 'Last Name',
18736: firstname => 'First Name',
18737: institution => 'School/college/university',
18738: location => "School's city, state/province, country",
18739: web => "School's web address",
18740: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 18741: id => 'Student/Employee ID',
1.1174 raeburn 18742: );
18743: return (\@fields,\%titles);
18744: }
18745:
1.1161 raeburn 18746: sub cleanup_html {
18747: my ($incoming) = @_;
18748: my $outgoing;
18749: if ($incoming ne '') {
18750: $outgoing = $incoming;
18751: $outgoing =~ s/;/;/g;
18752: $outgoing =~ s/\#/#/g;
18753: $outgoing =~ s/\&/&/g;
18754: $outgoing =~ s/</</g;
18755: $outgoing =~ s/>/>/g;
18756: $outgoing =~ s/\(/(/g;
18757: $outgoing =~ s/\)/)/g;
18758: $outgoing =~ s/"/"/g;
18759: $outgoing =~ s/'/'/g;
18760: $outgoing =~ s/\$/$/g;
18761: $outgoing =~ s{/}{/}g;
18762: $outgoing =~ s/=/=/g;
18763: $outgoing =~ s/\\/\/g
18764: }
18765: return $outgoing;
18766: }
18767:
1.1190 musolffc 18768: # Checks for critical messages and returns a redirect url if one exists.
18769: # $interval indicates how often to check for messages.
1.1282 raeburn 18770: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 18771: sub critical_redirect {
1.1282 raeburn 18772: my ($interval,$context) = @_;
1.1356 raeburn 18773: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
18774: return ();
18775: }
1.1190 musolffc 18776: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 18777: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
18778: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18779: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 18780: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18781: if ($blocked) {
18782: my $checkrole = "cm./$cdom/$cnum";
18783: if ($env{'request.course.sec'} ne '') {
18784: $checkrole .= "/$env{'request.course.sec'}";
18785: }
18786: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
18787: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
18788: return;
18789: }
18790: }
18791: }
1.1190 musolffc 18792: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
18793: $env{'user.name'});
18794: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 18795: my $redirecturl;
1.1190 musolffc 18796: if ($what[0]) {
1.1356 raeburn 18797: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 18798: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 18799: my $url=&Apache::lonnet::absolute_url().$redirecturl;
18800: return (1, $url);
1.1190 musolffc 18801: }
1.1191 raeburn 18802: }
18803: }
18804: return ();
1.1190 musolffc 18805: }
18806:
1.1174 raeburn 18807: # Use:
18808: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
18809: #
18810: ##################################################
18811: # password associated functions #
18812: ##################################################
18813: sub des_keys {
18814: # Make a new key for DES encryption.
18815: # Each key has two parts which are returned separately.
18816: # Please note: Each key must be passed through the &hex function
18817: # before it is output to the web browser. The hex versions cannot
18818: # be used to decrypt.
18819: my @hexstr=('0','1','2','3','4','5','6','7',
18820: '8','9','a','b','c','d','e','f');
18821: my $lkey='';
18822: for (0..7) {
18823: $lkey.=$hexstr[rand(15)];
18824: }
18825: my $ukey='';
18826: for (0..7) {
18827: $ukey.=$hexstr[rand(15)];
18828: }
18829: return ($lkey,$ukey);
18830: }
18831:
18832: sub des_decrypt {
18833: my ($key,$cyphertext) = @_;
18834: my $keybin=pack("H16",$key);
18835: my $cypher;
18836: if ($Crypt::DES::VERSION>=2.03) {
18837: $cypher=new Crypt::DES $keybin;
18838: } else {
18839: $cypher=new DES $keybin;
18840: }
1.1233 raeburn 18841: my $plaintext='';
18842: my $cypherlength = length($cyphertext);
18843: my $numchunks = int($cypherlength/32);
18844: for (my $j=0; $j<$numchunks; $j++) {
18845: my $start = $j*32;
18846: my $cypherblock = substr($cyphertext,$start,32);
18847: my $chunk =
18848: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
18849: $chunk .=
18850: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
18851: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
18852: $plaintext .= $chunk;
18853: }
1.1174 raeburn 18854: return $plaintext;
18855: }
18856:
1.1344 raeburn 18857: sub get_requested_shorturls {
1.1309 raeburn 18858: my ($cdom,$cnum,$navmap) = @_;
18859: return unless (ref($navmap));
1.1344 raeburn 18860: my ($numnew,$errors);
1.1309 raeburn 18861: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
18862: if (@toshorten) {
18863: my (%maps,%resources,%titles);
18864: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
18865: 'shorturls',$cdom,$cnum);
18866: if (keys(%resources)) {
1.1344 raeburn 18867: my %tocreate;
1.1309 raeburn 18868: foreach my $item (sort {$a <=> $b} (@toshorten)) {
18869: my $symb = $resources{$item};
18870: if ($symb) {
18871: $tocreate{$cnum.'&'.$symb} = 1;
18872: }
18873: }
1.1344 raeburn 18874: if (keys(%tocreate)) {
18875: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
18876: \%tocreate);
18877: }
1.1309 raeburn 18878: }
1.1344 raeburn 18879: }
18880: return ($numnew,$errors);
18881: }
18882:
18883: sub make_short_symbs {
18884: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
18885: my ($numnew,@errors);
18886: if (ref($tocreateref) eq 'HASH') {
18887: my %tocreate = %{$tocreateref};
1.1309 raeburn 18888: if (keys(%tocreate)) {
18889: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
18890: my $su = Short::URL->new(no_vowels => 1);
18891: my $init = '';
18892: my (%newunique,%addcourse,%courseonly,%failed);
18893: # get lock on tiny db
18894: my $now = time;
1.1344 raeburn 18895: if ($lockuser eq '') {
18896: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
18897: }
1.1309 raeburn 18898: my $lockhash = {
1.1344 raeburn 18899: "lock\0$now" => $lockuser,
1.1309 raeburn 18900: };
18901: my $tries = 0;
18902: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
18903: my ($code,$error);
18904: while (($gotlock ne 'ok') && ($tries<3)) {
18905: $tries ++;
18906: sleep 1;
1.1319 raeburn 18907: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 18908: }
18909: if ($gotlock eq 'ok') {
18910: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
18911: \%addcourse,\%courseonly,\%failed);
18912: if (keys(%failed)) {
18913: my $numfailed = scalar(keys(%failed));
18914: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
18915: }
18916: if (keys(%newunique)) {
18917: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
18918: if ($putres eq 'ok') {
18919: $numnew = scalar(keys(%newunique));
18920: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
18921: unless ($newputres eq 'ok') {
18922: push(@errors,&mt('error: could not store course look-up of short URLs'));
18923: }
18924: } else {
18925: push(@errors,&mt('error: could not store unique six character URLs'));
18926: }
18927: }
18928: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
18929: unless ($dellockres eq 'ok') {
18930: push(@errors,&mt('error: could not release lockfile'));
18931: }
18932: } else {
18933: push(@errors,&mt('error: could not obtain lockfile'));
18934: }
18935: if (keys(%courseonly)) {
18936: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
18937: if ($result ne 'ok') {
18938: push(@errors,&mt('error: could not update course look-up of short URLs'));
18939: }
18940: }
18941: }
18942: }
18943: return ($numnew,\@errors);
18944: }
18945:
18946: sub shorten_symbs {
18947: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
18948: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
18949: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
18950: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
18951: my (%possibles,%collisions);
18952: foreach my $key (keys(%{$tocreate})) {
18953: my $num = String::CRC32::crc32($key);
18954: my $tiny = $su->encode($num,$init);
18955: if ($tiny) {
18956: $possibles{$tiny} = $key;
18957: }
18958: }
18959: if (!$init) {
18960: $init = 1;
18961: } else {
18962: $init ++;
18963: }
18964: if (keys(%possibles)) {
18965: my @posstiny = keys(%possibles);
18966: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
18967: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
18968: if (keys(%currtiny)) {
18969: foreach my $key (keys(%currtiny)) {
18970: next if ($currtiny{$key} eq '');
18971: if ($currtiny{$key} eq $possibles{$key}) {
18972: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
18973: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18974: $courseonly->{$tsymb} = $key;
18975: }
18976: } else {
18977: $collisions{$possibles{$key}} = 1;
18978: }
18979: delete($possibles{$key});
18980: }
18981: }
18982: foreach my $key (keys(%possibles)) {
18983: $newunique->{$key} = $possibles{$key};
18984: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
18985: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18986: $addcourse->{$tsymb} = $key;
18987: }
18988: }
18989: }
18990: if (keys(%collisions)) {
18991: if ($init <5) {
18992: if (!$init) {
18993: $init = 1;
18994: } else {
18995: $init ++;
18996: }
18997: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
18998: $newunique,$addcourse,$courseonly,$failed);
18999: } else {
19000: foreach my $key (keys(%collisions)) {
19001: $failed->{$key} = 1;
19002: }
19003: }
19004: }
19005: return $init;
19006: }
19007:
1.1328 raeburn 19008: sub is_nonframeable {
1.1329 raeburn 19009: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19010: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19011: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19012:
19013: $remprotocol = lc($remprotocol);
19014: $remhost = lc($remhost);
19015: my $remport = 80;
19016: if ($remprotocol eq 'https') {
19017: $remport = 443;
19018: }
1.1330 raeburn 19019: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19020: if ($cached) {
19021: unless ($nocache) {
19022: if ($result) {
19023: return 1;
19024: } else {
19025: return 0;
19026: }
19027: }
19028: }
1.1328 raeburn 19029: my $uselink;
19030: my $request = new HTTP::Request('HEAD',$url);
19031: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19032: if ($response->is_success()) {
19033: my $secpolicy = lc($response->header('content-security-policy'));
19034: my $xframeop = lc($response->header('x-frame-options'));
19035: $secpolicy =~ s/^\s+|\s+$//g;
19036: $xframeop =~ s/^\s+|\s+$//g;
19037: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19038: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19039: my ($origin,$protocol,$port);
19040: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19041: $port = $ENV{'SERVER_PORT'};
19042: } else {
19043: $port = 80;
19044: }
19045: if ($absolute eq '') {
19046: $protocol = 'http:';
19047: if ($port == 443) {
19048: $protocol = 'https:';
19049: }
19050: $origin = $protocol.'//'.lc($hostname);
19051: } else {
19052: $origin = lc($absolute);
19053: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19054: }
19055: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19056: my $framepolicy = $1;
19057: $framepolicy =~ s/^\s+|\s+$//g;
19058: my @policies = split(/\s+/,$framepolicy);
19059: if (@policies) {
19060: if (grep(/^\Q'none'\E$/,@policies)) {
19061: $uselink = 1;
19062: } else {
19063: $uselink = 1;
19064: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19065: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19066: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19067: undef($uselink);
19068: }
19069: if ($uselink) {
19070: if (grep(/^\Q'self'\E$/,@policies)) {
19071: if (($origin ne '') && ($remotehost eq $origin)) {
19072: undef($uselink);
19073: }
19074: }
19075: }
19076: if ($uselink) {
19077: my @possok;
19078: if ($ip ne '') {
19079: push(@possok,$ip);
19080: }
19081: my $hoststr = '';
19082: foreach my $part (reverse(split(/\./,$hostname))) {
19083: if ($hoststr eq '') {
19084: $hoststr = $part;
19085: } else {
19086: $hoststr = "$part.$hoststr";
19087: }
19088: if ($hoststr eq $hostname) {
19089: push(@possok,$hostname);
19090: } else {
19091: push(@possok,"*.$hoststr");
19092: }
19093: }
19094: if (@possok) {
19095: foreach my $poss (@possok) {
19096: last if (!$uselink);
19097: foreach my $policy (@policies) {
19098: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
19099: undef($uselink);
19100: last;
19101: }
19102: }
19103: }
19104: }
19105: }
19106: }
19107: }
19108: } elsif ($xframeop ne '') {
19109: $uselink = 1;
19110: my @policies = split(/\s*,\s*/,$xframeop);
19111: if (@policies) {
19112: unless (grep(/^deny$/,@policies)) {
19113: if ($origin ne '') {
19114: if (grep(/^sameorigin$/,@policies)) {
19115: if ($remotehost eq $origin) {
19116: undef($uselink);
19117: }
19118: }
19119: if ($uselink) {
19120: foreach my $policy (@policies) {
19121: if ($policy =~ /^allow-from\s*(.+)$/) {
19122: my $allowfrom = $1;
19123: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
19124: undef($uselink);
19125: last;
19126: }
19127: }
19128: }
19129: }
19130: }
19131: }
19132: }
19133: }
19134: }
19135: }
1.1329 raeburn 19136: if ($nocache) {
19137: if ($cached) {
19138: my $devalidate;
19139: if ($uselink && !$result) {
19140: $devalidate = 1;
19141: } elsif (!$uselink && $result) {
19142: $devalidate = 1;
19143: }
19144: if ($devalidate) {
19145: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
19146: }
19147: }
19148: } else {
19149: if ($uselink) {
19150: $result = 1;
19151: } else {
19152: $result = 0;
19153: }
19154: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
19155: }
1.1328 raeburn 19156: return $uselink;
19157: }
19158:
1.1359 raeburn 19159: sub page_menu {
19160: my ($menucolls,$menunum) = @_;
19161: my %menu;
19162: foreach my $item (split(/;/,$menucolls)) {
19163: my ($num,$value) = split(/\%/,$item);
19164: if ($num eq $menunum) {
19165: my @entries = split(/\&/,$value);
19166: foreach my $entry (@entries) {
19167: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 19168: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 19169: $menu{$name} = $fields;
19170: } else {
19171: my @shown;
19172: if ($fields =~ /,/) {
19173: @shown = split(/,/,$fields);
19174: } else {
19175: @shown = ($fields);
19176: }
19177: if (@shown) {
19178: foreach my $field (@shown) {
19179: next if ($field eq '');
19180: $menu{$field} = 1;
19181: }
19182: }
19183: }
19184: }
19185: }
19186: }
19187: return %menu;
19188: }
19189:
1.112 bowersj2 19190: 1;
19191: __END__;
1.41 ng 19192:
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