Annotation of loncom/interface/loncommon.pm, revision 1.1075.2.161.2.6
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1075.2.161. .6(raebu 4:22): # $Id: loncommon.pm,v 1.1075.2.161.2.5 2022/02/18 00:41:09 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1075.2.25 raeburn 70: use Apache::lonuserutils();
1.1075.2.27 raeburn 71: use Apache::lonuserstate();
1.1075.2.69 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1075.2.135 raeburn 74: use HTTP::Request;
1.657 raeburn 75: use DateTime::TimeZone;
1.1075.2.102 raeburn 76: use DateTime::Locale;
1.1075.2.94 raeburn 77: use Encode();
1.1075.2.14 raeburn 78: use Authen::Captcha;
79: use Captcha::reCAPTCHA;
1.1075.2.107 raeburn 80: use JSON::DWIW;
81: use LWP::UserAgent;
1.1075.2.64 raeburn 82: use Crypt::DES;
83: use DynaLoader; # for Crypt::DES version
1.1075.2.128 raeburn 84: use File::Copy();
85: use File::Path();
1.1075.2.161. .1(raebu 86:21): use String::CRC32();
87:21): use Short::URL();
1.117 www 88:
1.517 raeburn 89: # ---------------------------------------------- Designs
90: use vars qw(%defaultdesign);
91:
1.22 www 92: my $readit;
93:
1.517 raeburn 94:
1.157 matthew 95: ##
96: ## Global Variables
97: ##
1.46 matthew 98:
1.643 foxr 99:
100: # ----------------------------------------------- SSI with retries:
101: #
102:
103: =pod
104:
1.648 raeburn 105: =head1 Server Side include with retries:
1.643 foxr 106:
107: =over 4
108:
1.648 raeburn 109: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 110:
111: Performs an ssi with some number of retries. Retries continue either
112: until the result is ok or until the retry count supplied by the
113: caller is exhausted.
114:
115: Inputs:
1.648 raeburn 116:
117: =over 4
118:
1.643 foxr 119: resource - Identifies the resource to insert.
1.648 raeburn 120:
1.643 foxr 121: retries - Count of the number of retries allowed.
1.648 raeburn 122:
1.643 foxr 123: form - Hash that identifies the rendering options.
124:
1.648 raeburn 125: =back
126:
127: Returns:
128:
129: =over 4
130:
1.643 foxr 131: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 132:
1.643 foxr 133: response - The response from the last attempt (which may or may not have been successful.
134:
1.648 raeburn 135: =back
136:
137: =back
138:
1.643 foxr 139: =cut
140:
141: sub ssi_with_retries {
142: my ($resource, $retries, %form) = @_;
143:
144:
145: my $ok = 0; # True if we got a good response.
146: my $content;
147: my $response;
148:
149: # Try to get the ssi done. within the retries count:
150:
151: do {
152: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
153: $ok = $response->is_success;
1.650 www 154: if (!$ok) {
155: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
156: }
1.643 foxr 157: $retries--;
158: } while (!$ok && ($retries > 0));
159:
160: if (!$ok) {
161: $content = ''; # On error return an empty content.
162: }
163: return ($content, $response);
164:
165: }
166:
167:
168:
1.20 www 169: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 170: my %language;
1.124 www 171: my %supported_language;
1.1048 foxr 172: my %latex_language; # For choosing hyphenation in <transl..>
173: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 174: my %cprtag;
1.192 taceyjo1 175: my %scprtag;
1.351 www 176: my %fe; my %fd; my %fm;
1.41 ng 177: my %category_extensions;
1.12 harris41 178:
1.46 matthew 179: # ---------------------------------------------- Thesaurus variables
1.144 matthew 180: #
181: # %Keywords:
182: # A hash used by &keyword to determine if a word is considered a keyword.
183: # $thesaurus_db_file
184: # Scalar containing the full path to the thesaurus database.
1.46 matthew 185:
186: my %Keywords;
187: my $thesaurus_db_file;
188:
1.144 matthew 189: #
190: # Initialize values from language.tab, copyright.tab, filetypes.tab,
191: # thesaurus.tab, and filecategories.tab.
192: #
1.18 www 193: BEGIN {
1.46 matthew 194: # Variable initialization
195: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
196: #
1.22 www 197: unless ($readit) {
1.12 harris41 198: # ------------------------------------------------------------------- languages
199: {
1.158 raeburn 200: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
201: '/language.tab';
1.1075.2.128 raeburn 202: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
1.1048 foxr 206: my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 207: $language{$key}=$val.' - '.$enc;
208: if ($sup) {
209: $supported_language{$key}=$sup;
210: }
1.1048 foxr 211: if ($latex) {
212: $latex_language_bykey{$key} = $latex;
213: $latex_language{$two} = $latex;
214: }
1.158 raeburn 215: }
216: close($fh);
217: }
1.12 harris41 218: }
219: # ------------------------------------------------------------------ copyrights
220: {
1.158 raeburn 221: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
222: '/copyright.tab';
1.1075.2.128 raeburn 223: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 224: while (my $line = <$fh>) {
225: next if ($line=~/^\#/);
226: chomp($line);
227: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 228: $cprtag{$key}=$val;
229: }
230: close($fh);
231: }
1.12 harris41 232: }
1.351 www 233: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 234: {
235: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
236: '/source_copyright.tab';
1.1075.2.128 raeburn 237: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 238: while (my $line = <$fh>) {
239: next if ($line =~ /^\#/);
240: chomp($line);
241: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 242: $scprtag{$key}=$val;
243: }
244: close($fh);
245: }
246: }
1.63 www 247:
1.517 raeburn 248: # -------------------------------------------------------------- default domain designs
1.63 www 249: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 250: my $designfile = $designdir.'/default.tab';
1.1075.2.128 raeburn 251: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 252: while (my $line = <$fh>) {
253: next if ($line =~ /^\#/);
254: chomp($line);
255: my ($key,$val)=(split(/\=/,$line));
256: if ($val) { $defaultdesign{$key}=$val; }
257: }
258: close($fh);
1.63 www 259: }
260:
1.15 harris41 261: # ------------------------------------------------------------- file categories
262: {
1.158 raeburn 263: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
264: '/filecategories.tab';
1.1075.2.128 raeburn 265: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 266: while (my $line = <$fh>) {
267: next if ($line =~ /^\#/);
268: chomp($line);
269: my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119 raeburn 270: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 271: }
272: close($fh);
273: }
274:
1.15 harris41 275: }
1.12 harris41 276: # ------------------------------------------------------------------ file types
277: {
1.158 raeburn 278: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
279: '/filetypes.tab';
1.1075.2.128 raeburn 280: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 281: while (my $line = <$fh>) {
282: next if ($line =~ /^\#/);
283: chomp($line);
284: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 285: if ($descr ne '') {
286: $fe{$ending}=lc($emb);
287: $fd{$ending}=$descr;
1.351 www 288: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 289: }
290: }
291: close($fh);
292: }
1.12 harris41 293: }
1.22 www 294: &Apache::lonnet::logthis(
1.705 tempelho 295: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 296: $readit=1;
1.46 matthew 297: } # end of unless($readit)
1.32 matthew 298:
299: }
1.112 bowersj2 300:
1.42 matthew 301: ###############################################################
302: ## HTML and Javascript Helper Functions ##
303: ###############################################################
304:
305: =pod
306:
1.112 bowersj2 307: =head1 HTML and Javascript Functions
1.42 matthew 308:
1.112 bowersj2 309: =over 4
310:
1.648 raeburn 311: =item * &browser_and_searcher_javascript()
1.112 bowersj2 312:
313: X<browsing, javascript>X<searching, javascript>Returns a string
314: containing javascript with two functions, C<openbrowser> and
315: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
316: tags.
1.42 matthew 317:
1.648 raeburn 318: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 319:
320: inputs: formname, elementname, only, omit
321:
322: formname and elementname indicate the name of the html form and name of
323: the element that the results of the browsing selection are to be placed in.
324:
325: Specifying 'only' will restrict the browser to displaying only files
1.185 www 326: with the given extension. Can be a comma separated list.
1.42 matthew 327:
328: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 329: with the given extension. Can be a comma separated list.
1.42 matthew 330:
1.648 raeburn 331: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 332:
333: Inputs: formname, elementname
334:
335: formname and elementname specify the name of the html form and the name
336: of the element the selection from the search results will be placed in.
1.542 raeburn 337:
1.42 matthew 338: =cut
339:
340: sub browser_and_searcher_javascript {
1.199 albertel 341: my ($mode)=@_;
342: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 343: my $resurl=&escape_single(&lastresurl());
1.42 matthew 344: return <<END;
1.219 albertel 345: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 346: var editbrowser = null;
1.135 albertel 347: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 348: var url = '$resurl/?';
1.42 matthew 349: if (editbrowser == null) {
350: url += 'launch=1&';
351: }
352: url += 'catalogmode=interactive&';
1.199 albertel 353: url += 'mode=$mode&';
1.611 albertel 354: url += 'inhibitmenu=yes&';
1.42 matthew 355: url += 'form=' + formname + '&';
356: if (only != null) {
357: url += 'only=' + only + '&';
1.217 albertel 358: } else {
359: url += 'only=&';
360: }
1.42 matthew 361: if (omit != null) {
362: url += 'omit=' + omit + '&';
1.217 albertel 363: } else {
364: url += 'omit=&';
365: }
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Browser';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editbrowser = open(url,title,options,'1');
376: editbrowser.focus();
377: }
378: var editsearcher;
1.135 albertel 379: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 380: var url = '/adm/searchcat?';
381: if (editsearcher == null) {
382: url += 'launch=1&';
383: }
384: url += 'catalogmode=interactive&';
1.199 albertel 385: url += 'mode=$mode&';
1.42 matthew 386: url += 'form=' + formname + '&';
1.135 albertel 387: if (titleelement != null) {
388: url += 'titleelement=' + titleelement + '&';
1.217 albertel 389: } else {
390: url += 'titleelement=&';
391: }
1.42 matthew 392: url += 'element=' + elementname + '';
393: var title = 'Search';
1.435 albertel 394: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 395: options += ',width=700,height=600';
396: editsearcher = open(url,title,options,'1');
397: editsearcher.focus();
398: }
1.219 albertel 399: // END LON-CAPA Internal -->
1.42 matthew 400: END
1.170 www 401: }
402:
403: sub lastresurl {
1.258 albertel 404: if ($env{'environment.lastresurl'}) {
405: return $env{'environment.lastresurl'}
1.170 www 406: } else {
407: return '/res';
408: }
409: }
410:
411: sub storeresurl {
412: my $resurl=&Apache::lonnet::clutter(shift);
413: unless ($resurl=~/^\/res/) { return 0; }
414: $resurl=~s/\/$//;
415: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 416: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 417: return 1;
1.42 matthew 418: }
419:
1.74 www 420: sub studentbrowser_javascript {
1.111 www 421: unless (
1.258 albertel 422: (($env{'request.course.id'}) &&
1.302 albertel 423: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
424: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
425: '/'.$env{'request.course.sec'})
426: ))
1.258 albertel 427: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 428: ) { return ''; }
1.74 www 429: return (<<'ENDSTDBRW');
1.776 bisitz 430: <script type="text/javascript" language="Javascript">
1.824 bisitz 431: // <![CDATA[
1.74 www 432: var stdeditbrowser;
1.1075.2.143 raeburn 433: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74 www 434: var url = '/adm/pickstudent?';
435: var filter;
1.558 albertel 436: if (!ignorefilter) {
437: eval('filter=document.'+formname+'.'+uname+'.value;');
438: }
1.74 www 439: if (filter != null) {
440: if (filter != '') {
441: url += 'filter='+filter+'&';
442: }
443: }
444: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 445: '&udomelement='+udom+
446: '&clicker='+clicker;
1.111 www 447: if (roleflag) { url+="&roles=1"; }
1.1075.2.143 raeburn 448: if (courseadv == 'condition') {
449: if (document.getElementById('courseadv')) {
450: courseadv = document.getElementById('courseadv').value;
451: }
452: }
453: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102 www 454: var title = 'Student_Browser';
1.74 www 455: var options = 'scrollbars=1,resizable=1,menubar=0';
456: options += ',width=700,height=600';
457: stdeditbrowser = open(url,title,options,'1');
458: stdeditbrowser.focus();
459: }
1.824 bisitz 460: // ]]>
1.74 www 461: </script>
462: ENDSTDBRW
463: }
1.42 matthew 464:
1.1003 www 465: sub resourcebrowser_javascript {
466: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 467: return (<<'ENDRESBRW');
1.1003 www 468: <script type="text/javascript" language="Javascript">
469: // <![CDATA[
470: var reseditbrowser;
1.1004 www 471: function openresbrowser(formname,reslink) {
1.1005 www 472: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 473: var title = 'Resource_Browser';
474: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 475: options += ',width=700,height=500';
1.1004 www 476: reseditbrowser = open(url,title,options,'1');
477: reseditbrowser.focus();
1.1003 www 478: }
479: // ]]>
480: </script>
1.1004 www 481: ENDRESBRW
1.1003 www 482: }
483:
1.74 www 484: sub selectstudent_link {
1.1075.2.143 raeburn 485: my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999 www 486: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
487: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
488: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 489: if ($env{'request.course.id'}) {
1.302 albertel 490: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
491: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
492: '/'.$env{'request.course.sec'})) {
1.111 www 493: return '';
494: }
1.999 www 495: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.143 raeburn 496: if ($courseadv eq 'only') {
497: $callargs .= ",'',1,'$courseadv'";
498: } elsif ($courseadv eq 'none') {
499: $callargs .= ",'','','$courseadv'";
500: } elsif ($courseadv eq 'condition') {
501: $callargs .= ",'','','$courseadv'";
1.793 raeburn 502: }
503: return '<span class="LC_nobreak">'.
504: '<a href="javascript:openstdbrowser('.$callargs.');">'.
505: &mt('Select User').'</a></span>';
1.74 www 506: }
1.258 albertel 507: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 508: $callargs .= ",'',1";
1.793 raeburn 509: return '<span class="LC_nobreak">'.
510: '<a href="javascript:openstdbrowser('.$callargs.');">'.
511: &mt('Select User').'</a></span>';
1.111 www 512: }
513: return '';
1.91 www 514: }
515:
1.1004 www 516: sub selectresource_link {
517: my ($form,$reslink,$arg)=@_;
518:
519: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
520: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
521: unless ($env{'request.course.id'}) { return $arg; }
522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openresbrowser('.$callargs.');">'.
524: $arg.'</a></span>';
525: }
526:
527:
528:
1.653 raeburn 529: sub authorbrowser_javascript {
530: return <<"ENDAUTHORBRW";
1.776 bisitz 531: <script type="text/javascript" language="JavaScript">
1.824 bisitz 532: // <![CDATA[
1.653 raeburn 533: var stdeditbrowser;
534:
535: function openauthorbrowser(formname,udom) {
536: var url = '/adm/pickauthor?';
537: url += 'form='+formname+'&roledom='+udom;
538: var title = 'Author_Browser';
539: var options = 'scrollbars=1,resizable=1,menubar=0';
540: options += ',width=700,height=600';
541: stdeditbrowser = open(url,title,options,'1');
542: stdeditbrowser.focus();
543: }
544:
1.824 bisitz 545: // ]]>
1.653 raeburn 546: </script>
547: ENDAUTHORBRW
548: }
549:
1.91 www 550: sub coursebrowser_javascript {
1.1075.2.31 raeburn 551: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95 raeburn 552: $credits_element,$instcode) = @_;
1.932 raeburn 553: my $wintitle = 'Course_Browser';
1.931 raeburn 554: if ($crstype eq 'Community') {
1.932 raeburn 555: $wintitle = 'Community_Browser';
1.909 raeburn 556: }
1.876 raeburn 557: my $id_functions = &javascript_index_functions();
558: my $output = '
1.776 bisitz 559: <script type="text/javascript" language="JavaScript">
1.824 bisitz 560: // <![CDATA[
1.468 raeburn 561: var stdeditbrowser;'."\n";
1.876 raeburn 562:
563: $output .= <<"ENDSTDBRW";
1.909 raeburn 564: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 565: var url = '/adm/pickcourse?';
1.895 raeburn 566: var formid = getFormIdByName(formname);
1.876 raeburn 567: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 568: if (domainfilter != null) {
569: if (domainfilter != '') {
570: url += 'domainfilter='+domainfilter+'&';
571: }
572: }
1.91 www 573: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 574: '&cdomelement='+udom+
575: '&cnameelement='+desc;
1.468 raeburn 576: if (extra_element !=null && extra_element != '') {
1.594 raeburn 577: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 578: url += '&roleelement='+extra_element;
579: if (domainfilter == null || domainfilter == '') {
580: url += '&domainfilter='+extra_element;
581: }
1.234 raeburn 582: }
1.468 raeburn 583: else {
584: if (formname == 'portform') {
585: url += '&setroles='+extra_element;
1.800 raeburn 586: } else {
587: if (formname == 'rules') {
588: url += '&fixeddom='+extra_element;
589: }
1.468 raeburn 590: }
591: }
1.230 raeburn 592: }
1.909 raeburn 593: if (type != null && type != '') {
594: url += '&type='+type;
595: }
596: if (type_elem != null && type_elem != '') {
597: url += '&typeelement='+type_elem;
598: }
1.872 raeburn 599: if (formname == 'ccrs') {
600: var ownername = document.forms[formid].ccuname.value;
601: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101 raeburn 602: url += '&cloner='+ownername+':'+ownerdom;
603: if (type == 'Course') {
604: url += '&crscode='+document.forms[formid].crscode.value;
605: }
1.1075.2.95 raeburn 606: }
607: if (formname == 'requestcrs') {
608: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 609: }
1.293 raeburn 610: if (multflag !=null && multflag != '') {
611: url += '&multiple='+multflag;
612: }
1.909 raeburn 613: var title = '$wintitle';
1.91 www 614: var options = 'scrollbars=1,resizable=1,menubar=0';
615: options += ',width=700,height=600';
616: stdeditbrowser = open(url,title,options,'1');
617: stdeditbrowser.focus();
618: }
1.876 raeburn 619: $id_functions
620: ENDSTDBRW
1.1075.2.31 raeburn 621: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
622: $output .= &setsec_javascript($sec_element,$formname,$role_element,
623: $credits_element);
1.876 raeburn 624: }
625: $output .= '
626: // ]]>
627: </script>';
628: return $output;
629: }
630:
631: sub javascript_index_functions {
632: return <<"ENDJS";
633:
634: function getFormIdByName(formname) {
635: for (var i=0;i<document.forms.length;i++) {
636: if (document.forms[i].name == formname) {
637: return i;
638: }
639: }
640: return -1;
641: }
642:
643: function getIndexByName(formid,item) {
644: for (var i=0;i<document.forms[formid].elements.length;i++) {
645: if (document.forms[formid].elements[i].name == item) {
646: return i;
647: }
648: }
649: return -1;
650: }
1.468 raeburn 651:
1.876 raeburn 652: function getDomainFromSelectbox(formname,udom) {
653: var userdom;
654: var formid = getFormIdByName(formname);
655: if (formid > -1) {
656: var domid = getIndexByName(formid,udom);
657: if (domid > -1) {
658: if (document.forms[formid].elements[domid].type == 'select-one') {
659: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
660: }
661: if (document.forms[formid].elements[domid].type == 'hidden') {
662: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 663: }
664: }
665: }
1.876 raeburn 666: return userdom;
667: }
668:
669: ENDJS
1.468 raeburn 670:
1.876 raeburn 671: }
672:
1.1017 raeburn 673: sub javascript_array_indexof {
1.1018 raeburn 674: return <<ENDJS;
1.1017 raeburn 675: <script type="text/javascript" language="JavaScript">
676: // <![CDATA[
677:
678: if (!Array.prototype.indexOf) {
679: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
680: "use strict";
681: if (this === void 0 || this === null) {
682: throw new TypeError();
683: }
684: var t = Object(this);
685: var len = t.length >>> 0;
686: if (len === 0) {
687: return -1;
688: }
689: var n = 0;
690: if (arguments.length > 0) {
691: n = Number(arguments[1]);
692: if (n !== n) { // shortcut for verifying if it's NaN
693: n = 0;
694: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
695: n = (n > 0 || -1) * Math.floor(Math.abs(n));
696: }
697: }
698: if (n >= len) {
699: return -1;
700: }
701: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
702: for (; k < len; k++) {
703: if (k in t && t[k] === searchElement) {
704: return k;
705: }
706: }
707: return -1;
708: }
709: }
710:
711: // ]]>
712: </script>
713:
714: ENDJS
715:
716: }
717:
1.876 raeburn 718: sub userbrowser_javascript {
719: my $id_functions = &javascript_index_functions();
720: return <<"ENDUSERBRW";
721:
1.888 raeburn 722: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 723: var url = '/adm/pickuser?';
724: var userdom = getDomainFromSelectbox(formname,udom);
725: if (userdom != null) {
726: if (userdom != '') {
727: url += 'srchdom='+userdom+'&';
728: }
729: }
730: url += 'form=' + formname + '&unameelement='+uname+
731: '&udomelement='+udom+
732: '&ulastelement='+ulast+
733: '&ufirstelement='+ufirst+
734: '&uemailelement='+uemail+
1.881 raeburn 735: '&hideudomelement='+hideudom+
736: '&coursedom='+crsdom;
1.888 raeburn 737: if ((caller != null) && (caller != undefined)) {
738: url += '&caller='+caller;
739: }
1.876 raeburn 740: var title = 'User_Browser';
741: var options = 'scrollbars=1,resizable=1,menubar=0';
742: options += ',width=700,height=600';
743: var stdeditbrowser = open(url,title,options,'1');
744: stdeditbrowser.focus();
745: }
746:
1.888 raeburn 747: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 748: var formid = getFormIdByName(formname);
749: if (formid > -1) {
1.888 raeburn 750: var unameid = getIndexByName(formid,uname);
1.876 raeburn 751: var domid = getIndexByName(formid,udom);
752: var hidedomid = getIndexByName(formid,origdom);
753: if (hidedomid > -1) {
754: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 755: var unameval = document.forms[formid].elements[unameid].value;
756: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
757: if (domid > -1) {
758: var slct = document.forms[formid].elements[domid];
759: if (slct.type == 'select-one') {
760: var i;
761: for (i=0;i<slct.length;i++) {
762: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
763: }
764: }
765: if (slct.type == 'hidden') {
766: slct.value = fixeddom;
1.876 raeburn 767: }
768: }
1.468 raeburn 769: }
770: }
771: }
1.876 raeburn 772: return;
773: }
774:
775: $id_functions
776: ENDUSERBRW
1.468 raeburn 777: }
778:
779: sub setsec_javascript {
1.1075.2.31 raeburn 780: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 781: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
782: $communityrolestr);
783: if ($role_element ne '') {
784: my @allroles = ('st','ta','ep','in','ad');
785: foreach my $crstype ('Course','Community') {
786: if ($crstype eq 'Community') {
787: foreach my $role (@allroles) {
788: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
789: }
790: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
791: } else {
792: foreach my $role (@allroles) {
793: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
794: }
795: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
796: }
797: }
798: $rolestr = '"'.join('","',@allroles).'"';
799: $courserolestr = '"'.join('","',@courserolenames).'"';
800: $communityrolestr = '"'.join('","',@communityrolenames).'"';
801: }
1.468 raeburn 802: my $setsections = qq|
803: function setSect(sectionlist) {
1.629 raeburn 804: var sectionsArray = new Array();
805: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
806: sectionsArray = sectionlist.split(",");
807: }
1.468 raeburn 808: var numSections = sectionsArray.length;
809: document.$formname.$sec_element.length = 0;
810: if (numSections == 0) {
811: document.$formname.$sec_element.multiple=false;
812: document.$formname.$sec_element.size=1;
813: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
814: } else {
815: if (numSections == 1) {
816: document.$formname.$sec_element.multiple=false;
817: document.$formname.$sec_element.size=1;
818: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
819: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
820: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
821: } else {
822: for (var i=0; i<numSections; i++) {
823: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
824: }
825: document.$formname.$sec_element.multiple=true
826: if (numSections < 3) {
827: document.$formname.$sec_element.size=numSections;
828: } else {
829: document.$formname.$sec_element.size=3;
830: }
831: document.$formname.$sec_element.options[0].selected = false
832: }
833: }
1.91 www 834: }
1.905 raeburn 835:
836: function setRole(crstype) {
1.468 raeburn 837: |;
1.905 raeburn 838: if ($role_element eq '') {
839: $setsections .= ' return;
840: }
841: ';
842: } else {
843: $setsections .= qq|
844: var elementLength = document.$formname.$role_element.length;
845: var allroles = Array($rolestr);
846: var courserolenames = Array($courserolestr);
847: var communityrolenames = Array($communityrolestr);
848: if (elementLength != undefined) {
849: if (document.$formname.$role_element.options[5].value == 'cc') {
850: if (crstype == 'Course') {
851: return;
852: } else {
853: allroles[5] = 'co';
854: for (var i=0; i<6; i++) {
855: document.$formname.$role_element.options[i].value = allroles[i];
856: document.$formname.$role_element.options[i].text = communityrolenames[i];
857: }
858: }
859: } else {
860: if (crstype == 'Community') {
861: return;
862: } else {
863: allroles[5] = 'cc';
864: for (var i=0; i<6; i++) {
865: document.$formname.$role_element.options[i].value = allroles[i];
866: document.$formname.$role_element.options[i].text = courserolenames[i];
867: }
868: }
869: }
870: }
871: return;
872: }
873: |;
874: }
1.1075.2.31 raeburn 875: if ($credits_element) {
876: $setsections .= qq|
877: function setCredits(defaultcredits) {
878: document.$formname.$credits_element.value = defaultcredits;
879: return;
880: }
881: |;
882: }
1.468 raeburn 883: return $setsections;
884: }
885:
1.91 www 886: sub selectcourse_link {
1.909 raeburn 887: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
888: $typeelement) = @_;
889: my $type = $selecttype;
1.871 raeburn 890: my $linktext = &mt('Select Course');
891: if ($selecttype eq 'Community') {
1.909 raeburn 892: $linktext = &mt('Select Community');
1.906 raeburn 893: } elsif ($selecttype eq 'Course/Community') {
894: $linktext = &mt('Select Course/Community');
1.909 raeburn 895: $type = '';
1.1019 raeburn 896: } elsif ($selecttype eq 'Select') {
897: $linktext = &mt('Select');
898: $type = '';
1.871 raeburn 899: }
1.787 bisitz 900: return '<span class="LC_nobreak">'
901: ."<a href='"
902: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
903: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 904: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 905: ."'>".$linktext.'</a>'
1.787 bisitz 906: .'</span>';
1.74 www 907: }
1.42 matthew 908:
1.653 raeburn 909: sub selectauthor_link {
910: my ($form,$udom)=@_;
911: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
912: &mt('Select Author').'</a>';
913: }
914:
1.876 raeburn 915: sub selectuser_link {
1.881 raeburn 916: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 917: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 918: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 919: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 920: ');">'.$linktext.'</a>';
1.876 raeburn 921: }
922:
1.273 raeburn 923: sub check_uncheck_jscript {
924: my $jscript = <<"ENDSCRT";
925: function checkAll(field) {
926: if (field.length > 0) {
927: for (i = 0; i < field.length; i++) {
1.1075.2.14 raeburn 928: if (!field[i].disabled) {
929: field[i].checked = true;
930: }
1.273 raeburn 931: }
932: } else {
1.1075.2.14 raeburn 933: if (!field.disabled) {
934: field.checked = true;
935: }
1.273 raeburn 936: }
937: }
938:
939: function uncheckAll(field) {
940: if (field.length > 0) {
941: for (i = 0; i < field.length; i++) {
942: field[i].checked = false ;
1.543 albertel 943: }
944: } else {
1.273 raeburn 945: field.checked = false ;
946: }
947: }
948: ENDSCRT
949: return $jscript;
950: }
951:
1.656 www 952: sub select_timezone {
1.1075.2.115 raeburn 953: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
954: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659 raeburn 955: if ($includeempty) {
956: $output .= '<option value=""';
957: if (($selected eq '') || ($selected eq 'local')) {
958: $output .= ' selected="selected" ';
959: }
960: $output .= '> </option>';
961: }
1.657 raeburn 962: my @timezones = DateTime::TimeZone->all_names;
963: foreach my $tzone (@timezones) {
964: $output.= '<option value="'.$tzone.'"';
965: if ($tzone eq $selected) {
966: $output.=' selected="selected"';
967: }
968: $output.=">$tzone</option>\n";
1.656 www 969: }
970: $output.="</select>";
971: return $output;
972: }
1.273 raeburn 973:
1.687 raeburn 974: sub select_datelocale {
1.1075.2.115 raeburn 975: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
976: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 977: if ($includeempty) {
978: $output .= '<option value=""';
979: if ($selected eq '') {
980: $output .= ' selected="selected" ';
981: }
982: $output .= '> </option>';
983: }
1.1075.2.102 raeburn 984: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 985: my (@possibles,%locale_names);
1.1075.2.102 raeburn 986: my @locales = DateTime::Locale->ids();
987: foreach my $id (@locales) {
988: if ($id ne '') {
989: my ($en_terr,$native_terr);
990: my $loc = DateTime::Locale->load($id);
991: if (ref($loc)) {
992: $en_terr = $loc->name();
993: $native_terr = $loc->native_name();
1.687 raeburn 994: if (grep(/^en$/,@languages) || !@languages) {
995: if ($en_terr ne '') {
996: $locale_names{$id} = '('.$en_terr.')';
997: } elsif ($native_terr ne '') {
998: $locale_names{$id} = $native_terr;
999: }
1000: } else {
1001: if ($native_terr ne '') {
1002: $locale_names{$id} = $native_terr.' ';
1003: } elsif ($en_terr ne '') {
1004: $locale_names{$id} = '('.$en_terr.')';
1005: }
1006: }
1.1075.2.94 raeburn 1007: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102 raeburn 1008: push(@possibles,$id);
1.687 raeburn 1009: }
1010: }
1011: }
1012: foreach my $item (sort(@possibles)) {
1013: $output.= '<option value="'.$item.'"';
1014: if ($item eq $selected) {
1015: $output.=' selected="selected"';
1016: }
1017: $output.=">$item";
1018: if ($locale_names{$item} ne '') {
1.1075.2.94 raeburn 1019: $output.=' '.$locale_names{$item};
1.687 raeburn 1020: }
1021: $output.="</option>\n";
1022: }
1023: $output.="</select>";
1024: return $output;
1025: }
1026:
1.792 raeburn 1027: sub select_language {
1.1075.2.115 raeburn 1028: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1029: my %langchoices;
1030: if ($includeempty) {
1.1075.2.32 raeburn 1031: %langchoices = ('' => 'No language preference');
1.792 raeburn 1032: }
1033: foreach my $id (&languageids()) {
1034: my $code = &supportedlanguagecode($id);
1035: if ($code) {
1036: $langchoices{$code} = &plainlanguagedescription($id);
1037: }
1038: }
1.1075.2.32 raeburn 1039: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115 raeburn 1040: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1041: }
1042:
1.42 matthew 1043: =pod
1.36 matthew 1044:
1.648 raeburn 1045: =item * &linked_select_forms(...)
1.36 matthew 1046:
1047: linked_select_forms returns a string containing a <script></script> block
1048: and html for two <select> menus. The select menus will be linked in that
1049: changing the value of the first menu will result in new values being placed
1050: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1051: order unless a defined order is provided.
1.36 matthew 1052:
1053: linked_select_forms takes the following ordered inputs:
1054:
1055: =over 4
1056:
1.112 bowersj2 1057: =item * $formname, the name of the <form> tag
1.36 matthew 1058:
1.112 bowersj2 1059: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1060:
1.112 bowersj2 1061: =item * $firstdefault, the default value for the first menu
1.36 matthew 1062:
1.112 bowersj2 1063: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1064:
1.112 bowersj2 1065: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1066:
1.112 bowersj2 1067: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1068:
1.609 raeburn 1069: =item * $menuorder, the order of values in the first menu
1070:
1.1075.2.31 raeburn 1071: =item * $onchangefirst, additional javascript call to execute for an onchange
1072: event for the first <select> tag
1073:
1074: =item * $onchangesecond, additional javascript call to execute for an onchange
1075: event for the second <select> tag
1076:
1.41 ng 1077: =back
1078:
1.36 matthew 1079: Below is an example of such a hash. Only the 'text', 'default', and
1080: 'select2' keys must appear as stated. keys(%menu) are the possible
1081: values for the first select menu. The text that coincides with the
1.41 ng 1082: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1083: and text for the second menu are given in the hash pointed to by
1084: $menu{$choice1}->{'select2'}.
1085:
1.112 bowersj2 1086: my %menu = ( A1 => { text =>"Choice A1" ,
1087: default => "B3",
1088: select2 => {
1089: B1 => "Choice B1",
1090: B2 => "Choice B2",
1091: B3 => "Choice B3",
1092: B4 => "Choice B4"
1.609 raeburn 1093: },
1094: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1095: },
1096: A2 => { text =>"Choice A2" ,
1097: default => "C2",
1098: select2 => {
1099: C1 => "Choice C1",
1100: C2 => "Choice C2",
1101: C3 => "Choice C3"
1.609 raeburn 1102: },
1103: order => ['C2','C1','C3'],
1.112 bowersj2 1104: },
1105: A3 => { text =>"Choice A3" ,
1106: default => "D6",
1107: select2 => {
1108: D1 => "Choice D1",
1109: D2 => "Choice D2",
1110: D3 => "Choice D3",
1111: D4 => "Choice D4",
1112: D5 => "Choice D5",
1113: D6 => "Choice D6",
1114: D7 => "Choice D7"
1.609 raeburn 1115: },
1116: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1117: }
1118: );
1.36 matthew 1119:
1120: =cut
1121:
1122: sub linked_select_forms {
1123: my ($formname,
1124: $middletext,
1125: $firstdefault,
1126: $firstselectname,
1127: $secondselectname,
1.609 raeburn 1128: $hashref,
1129: $menuorder,
1.1075.2.31 raeburn 1130: $onchangefirst,
1131: $onchangesecond
1.36 matthew 1132: ) = @_;
1133: my $second = "document.$formname.$secondselectname";
1134: my $first = "document.$formname.$firstselectname";
1135: # output the javascript to do the changing
1136: my $result = '';
1.776 bisitz 1137: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1138: $result.="// <![CDATA[\n";
1.36 matthew 1139: $result.="var select2data = new Object();\n";
1140: $" = '","';
1141: my $debug = '';
1142: foreach my $s1 (sort(keys(%$hashref))) {
1143: $result.="select2data.d_$s1 = new Object();\n";
1144: $result.="select2data.d_$s1.def = new String('".
1145: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 1146: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 1147: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1148: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1149: @s2values = @{$hashref->{$s1}->{'order'}};
1150: }
1.36 matthew 1151: $result.="\"@s2values\");\n";
1152: $result.="select2data.d_$s1.texts = new Array(";
1153: my @s2texts;
1154: foreach my $value (@s2values) {
1.1075.2.119 raeburn 1155: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1156: }
1157: $result.="\"@s2texts\");\n";
1158: }
1159: $"=' ';
1160: $result.= <<"END";
1161:
1162: function select1_changed() {
1163: // Determine new choice
1164: var newvalue = "d_" + $first.value;
1165: // update select2
1166: var values = select2data[newvalue].values;
1167: var texts = select2data[newvalue].texts;
1168: var select2def = select2data[newvalue].def;
1169: var i;
1170: // out with the old
1171: for (i = 0; i < $second.options.length; i++) {
1172: $second.options[i] = null;
1173: }
1174: // in with the nuclear
1175: for (i=0;i<values.length; i++) {
1176: $second.options[i] = new Option(values[i]);
1.143 matthew 1177: $second.options[i].value = values[i];
1.36 matthew 1178: $second.options[i].text = texts[i];
1179: if (values[i] == select2def) {
1180: $second.options[i].selected = true;
1181: }
1182: }
1183: }
1.824 bisitz 1184: // ]]>
1.36 matthew 1185: </script>
1186: END
1187: # output the initial values for the selection lists
1.1075.2.31 raeburn 1188: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609 raeburn 1189: my @order = sort(keys(%{$hashref}));
1190: if (ref($menuorder) eq 'ARRAY') {
1191: @order = @{$menuorder};
1192: }
1193: foreach my $value (@order) {
1.36 matthew 1194: $result.=" <option value=\"$value\" ";
1.253 albertel 1195: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1196: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1197: }
1198: $result .= "</select>\n";
1199: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1200: $result .= $middletext;
1.1075.2.31 raeburn 1201: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1202: if ($onchangesecond) {
1203: $result .= ' onchange="'.$onchangesecond.'"';
1204: }
1205: $result .= ">\n";
1.36 matthew 1206: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1207:
1208: my @secondorder = sort(keys(%select2));
1209: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1210: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1211: }
1212: foreach my $value (@secondorder) {
1.36 matthew 1213: $result.=" <option value=\"$value\" ";
1.253 albertel 1214: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1215: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1216: }
1217: $result .= "</select>\n";
1218: # return $debug;
1219: return $result;
1220: } # end of sub linked_select_forms {
1221:
1.45 matthew 1222: =pod
1.44 bowersj2 1223:
1.1075.2.161. .6(raebu 1224:22): =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1225:
1.112 bowersj2 1226: Returns a string corresponding to an HTML link to the given help
1227: $topic, where $topic corresponds to the name of a .tex file in
1228: /home/httpd/html/adm/help/tex, with underscores replaced by
1229: spaces.
1230:
1231: $text will optionally be linked to the same topic, allowing you to
1232: link text in addition to the graphic. If you do not want to link
1233: text, but wish to specify one of the later parameters, pass an
1234: empty string.
1235:
1236: $stayOnPage is a value that will be interpreted as a boolean. If true,
1237: the link will not open a new window. If false, the link will open
1238: a new window using Javascript. (Default is false.)
1239:
1240: $width and $height are optional numerical parameters that will
1241: override the width and height of the popped up window, which may
1.973 raeburn 1242: be useful for certain help topics with big pictures included.
1243:
1244: $imgid is the id of the img tag used for the help icon. This may be
1245: used in a javascript call to switch the image src. See
1246: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1247:
1.1075.2.161. .6(raebu 1248:22): $links_target will optionally be set to a target (_top, _parent or _self).
1249:22):
1.44 bowersj2 1250: =cut
1251:
1252: sub help_open_topic {
1.1075.2.161. .6(raebu 1253:22): my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1254: $text = "" if (not defined $text);
1.44 bowersj2 1255: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1256: $width = 500 if (not defined $width);
1.44 bowersj2 1257: $height = 400 if (not defined $height);
1258: my $filename = $topic;
1259: $filename =~ s/ /_/g;
1260:
1.48 bowersj2 1261: my $template = "";
1262: my $link;
1.572 banghart 1263:
1.159 www 1264: $topic=~s/\W/\_/g;
1.44 bowersj2 1265:
1.572 banghart 1266: if (!$stayOnPage) {
1.1075.2.50 raeburn 1267: if ($env{'browser.mobile'}) {
1268: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1269: } else {
1270: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1271: }
1.1037 www 1272: } elsif ($stayOnPage eq 'popup') {
1273: $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 1274: } else {
1.48 bowersj2 1275: $link = "/adm/help/${filename}.hlp";
1276: }
1277:
1278: # Add the text
1.1075.2.161. .6(raebu 1279:22): my $target = ' target="_top"';
1280:22): if ($links_target) {
1281:22): $target = ' target="'.$links_target.'"';
1282:22): } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self')) {
1283:22): $target = '';
1284:22): }
1.755 neumanie 1285: if ($text ne "") {
1.763 bisitz 1286: $template.='<span class="LC_help_open_topic">'
1.1075.2.161. .6(raebu 1287:22): .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1288: .$text.'</a>';
1.48 bowersj2 1289: }
1290:
1.763 bisitz 1291: # (Always) Add the graphic
1.179 matthew 1292: my $title = &mt('Online Help');
1.667 raeburn 1293: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1294: if ($imgid ne '') {
1295: $imgid = ' id="'.$imgid.'"';
1296: }
1.1075.2.161. .6(raebu 1297:22): $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1298: .'<img src="'.$helpicon.'" border="0"'
1299: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1300: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1301: .' /></a>';
1302: if ($text ne "") {
1303: $template.='</span>';
1304: }
1.44 bowersj2 1305: return $template;
1306:
1.106 bowersj2 1307: }
1308:
1309: # This is a quicky function for Latex cheatsheet editing, since it
1310: # appears in at least four places
1311: sub helpLatexCheatsheet {
1.1037 www 1312: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1313: my $out;
1.106 bowersj2 1314: my $addOther = '';
1.732 raeburn 1315: if ($topic) {
1.1037 www 1316: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1317: }
1318: $out = '<span>' # Start cheatsheet
1319: .$addOther
1320: .'<span>'
1.1037 www 1321: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1322: .'</span> <span>'
1.1037 www 1323: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1324: .'</span>';
1.732 raeburn 1325: unless ($not_author) {
1.763 bisitz 1326: $out .= ' <span>'
1.1037 www 1327: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1328: .'</span> <span>'
1.1075.2.78 raeburn 1329: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71 raeburn 1330: .'</span>';
1.732 raeburn 1331: }
1.763 bisitz 1332: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1333: return $out;
1.172 www 1334: }
1335:
1.430 albertel 1336: sub general_help {
1337: my $helptopic='Student_Intro';
1338: if ($env{'request.role'}=~/^(ca|au)/) {
1339: $helptopic='Authoring_Intro';
1.907 raeburn 1340: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1341: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1342: } elsif ($env{'request.role'}=~/^dc/) {
1343: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1344: }
1345: return $helptopic;
1346: }
1347:
1348: sub update_help_link {
1349: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1350: my $origurl = $ENV{'REQUEST_URI'};
1351: $origurl=~s|^/~|/priv/|;
1352: my $timestamp = time;
1353: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1354: $$datum = &escape($$datum);
1355: }
1356:
1357: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1358: my $output .= <<"ENDOUTPUT";
1359: <script type="text/javascript">
1.824 bisitz 1360: // <![CDATA[
1.430 albertel 1361: banner_link = '$banner_link';
1.824 bisitz 1362: // ]]>
1.430 albertel 1363: </script>
1364: ENDOUTPUT
1365: return $output;
1366: }
1367:
1368: # now just updates the help link and generates a blue icon
1.193 raeburn 1369: sub help_open_menu {
1.1075.2.161. .6(raebu 1370:22): my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1371: = @_;
1.949 droeschl 1372: $stayOnPage = 1;
1.430 albertel 1373: my $output;
1374: if ($component_help) {
1375: if (!$text) {
1376: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1075.2.161. .6(raebu 1377:22): $width,$height,'',$links_target);
1.430 albertel 1378: } else {
1379: my $help_text;
1380: $help_text=&unescape($topic);
1381: $output='<table><tr><td>'.
1382: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1075.2.161. .6(raebu 1383:22): $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1384: }
1385: }
1386: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1387: return $output.$banner_link;
1388: }
1389:
1390: sub top_nav_help {
1.1075.2.158 raeburn 1391: my ($text,$linkattr) = @_;
1.436 albertel 1392: $text = &mt($text);
1.1075.2.60 raeburn 1393: my $stay_on_page;
1394: unless ($env{'environment.remote'} eq 'on') {
1395: $stay_on_page = 1;
1396: }
1.1075.2.61 raeburn 1397: my ($link,$banner_link);
1398: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1399: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1400: : "javascript:helpMenu('open')";
1401: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1402: }
1.201 raeburn 1403: my $title = &mt('Get help');
1.1075.2.61 raeburn 1404: if ($link) {
1405: return <<"END";
1.436 albertel 1406: $banner_link
1.1075.2.158 raeburn 1407: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1408: END
1.1075.2.61 raeburn 1409: } else {
1410: return ' '.$text.' ';
1411: }
1.436 albertel 1412: }
1413:
1414: sub help_menu_js {
1.1075.2.52 raeburn 1415: my ($httphost) = @_;
1.949 droeschl 1416: my $stayOnPage = 1;
1.436 albertel 1417: my $width = 620;
1418: my $height = 600;
1.430 albertel 1419: my $helptopic=&general_help();
1.1075.2.52 raeburn 1420: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1421: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1422: my $start_page =
1423: &Apache::loncommon::start_page('Help Menu', undef,
1424: {'frameset' => 1,
1425: 'js_ready' => 1,
1.1075.2.136 raeburn 1426: 'use_absolute' => $httphost,
1.331 albertel 1427: 'add_entries' => {
1428: 'border' => '0',
1.579 raeburn 1429: 'rows' => "110,*",},});
1.331 albertel 1430: my $end_page =
1431: &Apache::loncommon::end_page({'frameset' => 1,
1432: 'js_ready' => 1,});
1433:
1.436 albertel 1434: my $template .= <<"ENDTEMPLATE";
1435: <script type="text/javascript">
1.877 bisitz 1436: // <![CDATA[
1.253 albertel 1437: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1438: var banner_link = '';
1.243 raeburn 1439: function helpMenu(target) {
1440: var caller = this;
1441: if (target == 'open') {
1442: var newWindow = null;
1443: try {
1.262 albertel 1444: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1445: }
1446: catch(error) {
1447: writeHelp(caller);
1448: return;
1449: }
1450: if (newWindow) {
1451: caller = newWindow;
1452: }
1.193 raeburn 1453: }
1.243 raeburn 1454: writeHelp(caller);
1455: return;
1456: }
1457: function writeHelp(caller) {
1.1075.2.61 raeburn 1458: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1459: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1460: caller.document.close();
1461: caller.focus();
1.193 raeburn 1462: }
1.877 bisitz 1463: // END LON-CAPA Internal -->
1.253 albertel 1464: // ]]>
1.436 albertel 1465: </script>
1.193 raeburn 1466: ENDTEMPLATE
1467: return $template;
1468: }
1469:
1.172 www 1470: sub help_open_bug {
1471: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1472: unless ($env{'user.adv'}) { return ''; }
1.172 www 1473: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1474: $text = "" if (not defined $text);
1475: $stayOnPage=1;
1.184 albertel 1476: $width = 600 if (not defined $width);
1477: $height = 600 if (not defined $height);
1.172 www 1478:
1479: $topic=~s/\W+/\+/g;
1480: my $link='';
1481: my $template='';
1.379 albertel 1482: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1483: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1484: if (!$stayOnPage)
1485: {
1486: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1487: }
1488: else
1489: {
1490: $link = $url;
1491: }
1.1075.2.161. .6(raebu 1492:22):
1493:22): my $target = '_top';
1494:22): if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1495:22): (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1496:22): $target = '_blank';
1497:22): }
1498:22):
1.172 www 1499: # Add the text
1500: if ($text ne "")
1501: {
1502: $template .=
1503: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1075.2.161. .6(raebu 1504:22): "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1505: }
1506:
1507: # Add the graphic
1.179 matthew 1508: my $title = &mt('Report a Bug');
1.215 albertel 1509: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1510: $template .= <<"ENDTEMPLATE";
1.1075.2.161. .6(raebu 1511:22): <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1512: ENDTEMPLATE
1513: if ($text ne '') { $template.='</td></tr></table>' };
1514: return $template;
1515:
1516: }
1517:
1518: sub help_open_faq {
1519: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1520: unless ($env{'user.adv'}) { return ''; }
1.172 www 1521: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1522: $text = "" if (not defined $text);
1523: $stayOnPage=1;
1524: $width = 350 if (not defined $width);
1525: $height = 400 if (not defined $height);
1526:
1527: $topic=~s/\W+/\+/g;
1528: my $link='';
1529: my $template='';
1530: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1531: if (!$stayOnPage)
1532: {
1533: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1534: }
1535: else
1536: {
1537: $link = $url;
1538: }
1539:
1540: # Add the text
1541: if ($text ne "")
1542: {
1543: $template .=
1.173 www 1544: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1545: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1546: }
1547:
1548: # Add the graphic
1.179 matthew 1549: my $title = &mt('View the FAQ');
1.215 albertel 1550: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1551: $template .= <<"ENDTEMPLATE";
1.436 albertel 1552: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1553: ENDTEMPLATE
1554: if ($text ne '') { $template.='</td></tr></table>' };
1555: return $template;
1556:
1.44 bowersj2 1557: }
1.37 matthew 1558:
1.180 matthew 1559: ###############################################################
1560: ###############################################################
1561:
1.45 matthew 1562: =pod
1563:
1.648 raeburn 1564: =item * &change_content_javascript():
1.256 matthew 1565:
1566: This and the next function allow you to create small sections of an
1567: otherwise static HTML page that you can update on the fly with
1568: Javascript, even in Netscape 4.
1569:
1570: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1571: must be written to the HTML page once. It will prove the Javascript
1572: function "change(name, content)". Calling the change function with the
1573: name of the section
1574: you want to update, matching the name passed to C<changable_area>, and
1575: the new content you want to put in there, will put the content into
1576: that area.
1577:
1578: B<Note>: Netscape 4 only reserves enough space for the changable area
1579: to contain room for the original contents. You need to "make space"
1580: for whatever changes you wish to make, and be B<sure> to check your
1581: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1582: it's adequate for updating a one-line status display, but little more.
1583: This script will set the space to 100% width, so you only need to
1584: worry about height in Netscape 4.
1585:
1586: Modern browsers are much less limiting, and if you can commit to the
1587: user not using Netscape 4, this feature may be used freely with
1588: pretty much any HTML.
1589:
1590: =cut
1591:
1592: sub change_content_javascript {
1593: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1594: if ($env{'browser.type'} eq 'netscape' &&
1595: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1596: return (<<NETSCAPE4);
1597: function change(name, content) {
1598: doc = document.layers[name+"___escape"].layers[0].document;
1599: doc.open();
1600: doc.write(content);
1601: doc.close();
1602: }
1603: NETSCAPE4
1604: } else {
1605: # Otherwise, we need to use semi-standards-compliant code
1606: # (technically, "innerHTML" isn't standard but the equivalent
1607: # is really scary, and every useful browser supports it
1608: return (<<DOMBASED);
1609: function change(name, content) {
1610: element = document.getElementById(name);
1611: element.innerHTML = content;
1612: }
1613: DOMBASED
1614: }
1615: }
1616:
1617: =pod
1618:
1.648 raeburn 1619: =item * &changable_area($name,$origContent):
1.256 matthew 1620:
1621: This provides a "changable area" that can be modified on the fly via
1622: the Javascript code provided in C<change_content_javascript>. $name is
1623: the name you will use to reference the area later; do not repeat the
1624: same name on a given HTML page more then once. $origContent is what
1625: the area will originally contain, which can be left blank.
1626:
1627: =cut
1628:
1629: sub changable_area {
1630: my ($name, $origContent) = @_;
1631:
1.258 albertel 1632: if ($env{'browser.type'} eq 'netscape' &&
1633: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1634: # If this is netscape 4, we need to use the Layer tag
1635: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1636: } else {
1637: return "<span id='$name'>$origContent</span>";
1638: }
1639: }
1640:
1641: =pod
1642:
1.648 raeburn 1643: =item * &viewport_geometry_js
1.590 raeburn 1644:
1645: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1646:
1647: =cut
1648:
1649:
1650: sub viewport_geometry_js {
1651: return <<"GEOMETRY";
1652: var Geometry = {};
1653: function init_geometry() {
1654: if (Geometry.init) { return };
1655: Geometry.init=1;
1656: if (window.innerHeight) {
1657: Geometry.getViewportHeight = function() { return window.innerHeight; };
1658: Geometry.getViewportWidth = function() { return window.innerWidth; };
1659: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1660: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1661: }
1662: else if (document.documentElement && document.documentElement.clientHeight) {
1663: Geometry.getViewportHeight =
1664: function() { return document.documentElement.clientHeight; };
1665: Geometry.getViewportWidth =
1666: function() { return document.documentElement.clientWidth; };
1667:
1668: Geometry.getHorizontalScroll =
1669: function() { return document.documentElement.scrollLeft; };
1670: Geometry.getVerticalScroll =
1671: function() { return document.documentElement.scrollTop; };
1672: }
1673: else if (document.body.clientHeight) {
1674: Geometry.getViewportHeight =
1675: function() { return document.body.clientHeight; };
1676: Geometry.getViewportWidth =
1677: function() { return document.body.clientWidth; };
1678: Geometry.getHorizontalScroll =
1679: function() { return document.body.scrollLeft; };
1680: Geometry.getVerticalScroll =
1681: function() { return document.body.scrollTop; };
1682: }
1683: }
1684:
1685: GEOMETRY
1686: }
1687:
1688: =pod
1689:
1.648 raeburn 1690: =item * &viewport_size_js()
1.590 raeburn 1691:
1692: 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.
1693:
1694: =cut
1695:
1696: sub viewport_size_js {
1697: my $geometry = &viewport_geometry_js();
1698: return <<"DIMS";
1699:
1700: $geometry
1701:
1702: function getViewportDims(width,height) {
1703: init_geometry();
1704: width.value = Geometry.getViewportWidth();
1705: height.value = Geometry.getViewportHeight();
1706: return;
1707: }
1708:
1709: DIMS
1710: }
1711:
1712: =pod
1713:
1.648 raeburn 1714: =item * &resize_textarea_js()
1.565 albertel 1715:
1716: emits the needed javascript to resize a textarea to be as big as possible
1717:
1718: creates a function resize_textrea that takes two IDs first should be
1719: the id of the element to resize, second should be the id of a div that
1720: surrounds everything that comes after the textarea, this routine needs
1721: to be attached to the <body> for the onload and onresize events.
1722:
1.648 raeburn 1723: =back
1.565 albertel 1724:
1725: =cut
1726:
1727: sub resize_textarea_js {
1.590 raeburn 1728: my $geometry = &viewport_geometry_js();
1.565 albertel 1729: return <<"RESIZE";
1730: <script type="text/javascript">
1.824 bisitz 1731: // <![CDATA[
1.590 raeburn 1732: $geometry
1.565 albertel 1733:
1.588 albertel 1734: function getX(element) {
1735: var x = 0;
1736: while (element) {
1737: x += element.offsetLeft;
1738: element = element.offsetParent;
1739: }
1740: return x;
1741: }
1742: function getY(element) {
1743: var y = 0;
1744: while (element) {
1745: y += element.offsetTop;
1746: element = element.offsetParent;
1747: }
1748: return y;
1749: }
1750:
1751:
1.565 albertel 1752: function resize_textarea(textarea_id,bottom_id) {
1753: init_geometry();
1754: var textarea = document.getElementById(textarea_id);
1755: //alert(textarea);
1756:
1.588 albertel 1757: var textarea_top = getY(textarea);
1.565 albertel 1758: var textarea_height = textarea.offsetHeight;
1759: var bottom = document.getElementById(bottom_id);
1.588 albertel 1760: var bottom_top = getY(bottom);
1.565 albertel 1761: var bottom_height = bottom.offsetHeight;
1762: var window_height = Geometry.getViewportHeight();
1.588 albertel 1763: var fudge = 23;
1.565 albertel 1764: var new_height = window_height-fudge-textarea_top-bottom_height;
1765: if (new_height < 300) {
1766: new_height = 300;
1767: }
1768: textarea.style.height=new_height+'px';
1769: }
1.824 bisitz 1770: // ]]>
1.565 albertel 1771: </script>
1772: RESIZE
1773:
1774: }
1775:
1.1075.2.112 raeburn 1776: sub colorfuleditor_js {
1777: return <<"COLORFULEDIT"
1778: <script type="text/javascript">
1779: // <![CDATA[>
1780: function fold_box(curDepth, lastresource){
1781:
1782: // we need a list because there can be several blocks you need to fold in one tag
1783: var block = document.getElementsByName('foldblock_'+curDepth);
1784: // but there is only one folding button per tag
1785: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1786:
1787: if(block.item(0).style.display == 'none'){
1788:
1789: foldbutton.value = '@{[&mt("Hide")]}';
1790: for (i = 0; i < block.length; i++){
1791: block.item(i).style.display = '';
1792: }
1793: }else{
1794:
1795: foldbutton.value = '@{[&mt("Show")]}';
1796: for (i = 0; i < block.length; i++){
1797: // block.item(i).style.visibility = 'collapse';
1798: block.item(i).style.display = 'none';
1799: }
1800: };
1801: saveState(lastresource);
1802: }
1803:
1804: function saveState (lastresource) {
1805:
1806: var tag_list = getTagList();
1807: if(tag_list != null){
1808: var timestamp = new Date().getTime();
1809: var key = lastresource;
1810:
1811: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1812: // starting with timestamp
1813: var value = timestamp+';';
1814:
1815: // building the list of key-value pairs
1816: for(var i = 0; i < tag_list.length; i++){
1817: value += tag_list[i]+',';
1818: value += document.getElementsByName(tag_list[i])[0].style.display+';';
1819: }
1820:
1821: // only iterate whole storage if nothing to override
1822: if(localStorage.getItem(key) == null){
1823:
1824: // prevent storage from growing large
1825: if(localStorage.length > 50){
1826: var regex_getTimestamp = /^(?:\d)+;/;
1827: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
1828: var oldest_key;
1829:
1830: for(var i = 1; i < localStorage.length; i++){
1831: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
1832: oldest_key = localStorage.key(i);
1833: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
1834: }
1835: }
1836: localStorage.removeItem(oldest_key);
1837: }
1838: }
1839: localStorage.setItem(key,value);
1840: }
1841: }
1842:
1843: // restore folding status of blocks (on page load)
1844: function restoreState (lastresource) {
1845: if(localStorage.getItem(lastresource) != null){
1846: var key = lastresource;
1847: var value = localStorage.getItem(key);
1848: var regex_delTimestamp = /^\d+;/;
1849:
1850: value.replace(regex_delTimestamp, '');
1851:
1852: var valueArr = value.split(';');
1853: var pairs;
1854: var elements;
1855: for (var i = 0; i < valueArr.length; i++){
1856: pairs = valueArr[i].split(',');
1857: elements = document.getElementsByName(pairs[0]);
1858:
1859: for (var j = 0; j < elements.length; j++){
1860: elements[j].style.display = pairs[1];
1861: if (pairs[1] == "none"){
1862: var regex_id = /([_\\d]+)\$/;
1863: regex_id.exec(pairs[0]);
1864: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
1865: }
1866: }
1867: }
1868: }
1869: }
1870:
1871: function getTagList () {
1872:
1873: var stringToSearch = document.lonhomework.innerHTML;
1874:
1875: var ret = new Array();
1876: var regex_findBlock = /(foldblock_.*?)"/g;
1877: var tag_list = stringToSearch.match(regex_findBlock);
1878:
1879: if(tag_list != null){
1880: for(var i = 0; i < tag_list.length; i++){
1881: ret.push(tag_list[i].replace(/"/, ''));
1882: }
1883: }
1884: return ret;
1885: }
1886:
1887: function saveScrollPosition (resource) {
1888: var tag_list = getTagList();
1889:
1890: // we dont always want to jump to the first block
1891: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
1892: if(\$(window).scrollTop() > 170){
1893: if(tag_list != null){
1894: var result;
1895: for(var i = 0; i < tag_list.length; i++){
1896: if(isElementInViewport(tag_list[i])){
1897: result += tag_list[i]+';';
1898: }
1899: }
1900: sessionStorage.setItem('anchor_'+resource, result);
1901: }
1902: } else {
1903: // we dont need to save zero, just delete the item to leave everything tidy
1904: sessionStorage.removeItem('anchor_'+resource);
1905: }
1906: }
1907:
1908: function restoreScrollPosition(resource){
1909:
1910: var elem = sessionStorage.getItem('anchor_'+resource);
1911: if(elem != null){
1912: var tag_list = elem.split(';');
1913: var elem_list;
1914:
1915: for(var i = 0; i < tag_list.length; i++){
1916: elem_list = document.getElementsByName(tag_list[i]);
1917:
1918: if(elem_list.length > 0){
1919: elem = elem_list[0];
1920: break;
1921: }
1922: }
1923: elem.scrollIntoView();
1924: }
1925: }
1926:
1927: function isElementInViewport(el) {
1928:
1929: // change to last element instead of first
1930: var elem = document.getElementsByName(el);
1931: var rect = elem[0].getBoundingClientRect();
1932:
1933: return (
1934: rect.top >= 0 &&
1935: rect.left >= 0 &&
1936: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
1937: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
1938: );
1939: }
1940:
1941: function autosize(depth){
1942: var cmInst = window['cm'+depth];
1943: var fitsizeButton = document.getElementById('fitsize'+depth);
1944:
1945: // is fixed size, switching to dynamic
1946: if (sessionStorage.getItem("autosized_"+depth) == null) {
1947: cmInst.setSize("","auto");
1948: fitsizeButton.value = "@{[&mt('Fixed size')]}";
1949: sessionStorage.setItem("autosized_"+depth, "yes");
1950:
1951: // is dynamic size, switching to fixed
1952: } else {
1953: cmInst.setSize("","300px");
1954: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
1955: sessionStorage.removeItem("autosized_"+depth);
1956: }
1957: }
1958:
1959:
1960:
1961: // ]]>
1962: </script>
1963: COLORFULEDIT
1964: }
1965:
1966: sub xmleditor_js {
1967: return <<XMLEDIT
1968: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
1969: <script type="text/javascript">
1970: // <![CDATA[>
1971:
1972: function saveScrollPosition (resource) {
1973:
1974: var scrollPos = \$(window).scrollTop();
1975: sessionStorage.setItem(resource,scrollPos);
1976: }
1977:
1978: function restoreScrollPosition(resource){
1979:
1980: var scrollPos = sessionStorage.getItem(resource);
1981: \$(window).scrollTop(scrollPos);
1982: }
1983:
1984: // unless internet explorer
1985: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
1986:
1987: \$(document).ready(function() {
1988: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
1989: });
1990: }
1991:
1992: // inserts text at cursor position into codemirror (xml editor only)
1993: function insertText(text){
1994: cm.focus();
1995: var curPos = cm.getCursor();
1996: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
1997: }
1998: // ]]>
1999: </script>
2000: XMLEDIT
2001: }
2002:
2003: sub insert_folding_button {
2004: my $curDepth = $Apache::lonxml::curdepth;
2005: my $lastresource = $env{'request.ambiguous'};
2006:
2007: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2008: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2009: }
2010:
2011:
1.565 albertel 2012: =pod
2013:
1.256 matthew 2014: =head1 Excel and CSV file utility routines
2015:
2016: =cut
2017:
2018: ###############################################################
2019: ###############################################################
2020:
2021: =pod
2022:
1.1075.2.56 raeburn 2023: =over 4
2024:
1.648 raeburn 2025: =item * &csv_translate($text)
1.37 matthew 2026:
1.185 www 2027: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2028: format.
2029:
2030: =cut
2031:
1.180 matthew 2032: ###############################################################
2033: ###############################################################
1.37 matthew 2034: sub csv_translate {
2035: my $text = shift;
2036: $text =~ s/\"/\"\"/g;
1.209 albertel 2037: $text =~ s/\n/ /g;
1.37 matthew 2038: return $text;
2039: }
1.180 matthew 2040:
2041: ###############################################################
2042: ###############################################################
2043:
2044: =pod
2045:
1.648 raeburn 2046: =item * &define_excel_formats()
1.180 matthew 2047:
2048: Define some commonly used Excel cell formats.
2049:
2050: Currently supported formats:
2051:
2052: =over 4
2053:
2054: =item header
2055:
2056: =item bold
2057:
2058: =item h1
2059:
2060: =item h2
2061:
2062: =item h3
2063:
1.256 matthew 2064: =item h4
2065:
2066: =item i
2067:
1.180 matthew 2068: =item date
2069:
2070: =back
2071:
2072: Inputs: $workbook
2073:
2074: Returns: $format, a hash reference.
2075:
1.1057 foxr 2076:
1.180 matthew 2077: =cut
2078:
2079: ###############################################################
2080: ###############################################################
2081: sub define_excel_formats {
2082: my ($workbook) = @_;
2083: my $format;
2084: $format->{'header'} = $workbook->add_format(bold => 1,
2085: bottom => 1,
2086: align => 'center');
2087: $format->{'bold'} = $workbook->add_format(bold=>1);
2088: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2089: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2090: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2091: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2092: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2093: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2094: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2095: return $format;
2096: }
2097:
2098: ###############################################################
2099: ###############################################################
1.113 bowersj2 2100:
2101: =pod
2102:
1.648 raeburn 2103: =item * &create_workbook()
1.255 matthew 2104:
2105: Create an Excel worksheet. If it fails, output message on the
2106: request object and return undefs.
2107:
2108: Inputs: Apache request object
2109:
2110: Returns (undef) on failure,
2111: Excel worksheet object, scalar with filename, and formats
2112: from &Apache::loncommon::define_excel_formats on success
2113:
2114: =cut
2115:
2116: ###############################################################
2117: ###############################################################
2118: sub create_workbook {
2119: my ($r) = @_;
2120: #
2121: # Create the excel spreadsheet
2122: my $filename = '/prtspool/'.
1.258 albertel 2123: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2124: time.'_'.rand(1000000000).'.xls';
2125: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2126: if (! defined($workbook)) {
2127: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2128: $r->print(
2129: '<p class="LC_error">'
2130: .&mt('Problems occurred in creating the new Excel file.')
2131: .' '.&mt('This error has been logged.')
2132: .' '.&mt('Please alert your LON-CAPA administrator.')
2133: .'</p>'
2134: );
1.255 matthew 2135: return (undef);
2136: }
2137: #
1.1014 foxr 2138: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2139: #
2140: my $format = &Apache::loncommon::define_excel_formats($workbook);
2141: return ($workbook,$filename,$format);
2142: }
2143:
2144: ###############################################################
2145: ###############################################################
2146:
2147: =pod
2148:
1.648 raeburn 2149: =item * &create_text_file()
1.113 bowersj2 2150:
1.542 raeburn 2151: Create a file to write to and eventually make available to the user.
1.256 matthew 2152: If file creation fails, outputs an error message on the request object and
2153: return undefs.
1.113 bowersj2 2154:
1.256 matthew 2155: Inputs: Apache request object, and file suffix
1.113 bowersj2 2156:
1.256 matthew 2157: Returns (undef) on failure,
2158: Filehandle and filename on success.
1.113 bowersj2 2159:
2160: =cut
2161:
1.256 matthew 2162: ###############################################################
2163: ###############################################################
2164: sub create_text_file {
2165: my ($r,$suffix) = @_;
2166: if (! defined($suffix)) { $suffix = 'txt'; };
2167: my $fh;
2168: my $filename = '/prtspool/'.
1.258 albertel 2169: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2170: time.'_'.rand(1000000000).'.'.$suffix;
2171: $fh = Apache::File->new('>/home/httpd'.$filename);
2172: if (! defined($fh)) {
2173: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2174: $r->print(
2175: '<p class="LC_error">'
2176: .&mt('Problems occurred in creating the output file.')
2177: .' '.&mt('This error has been logged.')
2178: .' '.&mt('Please alert your LON-CAPA administrator.')
2179: .'</p>'
2180: );
1.113 bowersj2 2181: }
1.256 matthew 2182: return ($fh,$filename)
1.113 bowersj2 2183: }
2184:
2185:
1.256 matthew 2186: =pod
1.113 bowersj2 2187:
2188: =back
2189:
2190: =cut
1.37 matthew 2191:
2192: ###############################################################
1.33 matthew 2193: ## Home server <option> list generating code ##
2194: ###############################################################
1.35 matthew 2195:
1.169 www 2196: # ------------------------------------------
2197:
2198: sub domain_select {
2199: my ($name,$value,$multiple)=@_;
2200: my %domains=map {
1.514 albertel 2201: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 2202: } &Apache::lonnet::all_domains();
1.169 www 2203: if ($multiple) {
2204: $domains{''}=&mt('Any domain');
1.550 albertel 2205: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2206: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2207: } else {
1.550 albertel 2208: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2209: return &select_form($name,$value,\%domains);
1.169 www 2210: }
2211: }
2212:
1.282 albertel 2213: #-------------------------------------------
2214:
2215: =pod
2216:
1.519 raeburn 2217: =head1 Routines for form select boxes
2218:
2219: =over 4
2220:
1.648 raeburn 2221: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2222:
2223: Returns a string containing a <select> element int multiple mode
2224:
2225:
2226: Args:
2227: $name - name of the <select> element
1.506 raeburn 2228: $value - scalar or array ref of values that should already be selected
1.282 albertel 2229: $size - number of rows long the select element is
1.283 albertel 2230: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2231: (shown text should already have been &mt())
1.506 raeburn 2232: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2233:
1.282 albertel 2234: =cut
2235:
2236: #-------------------------------------------
1.169 www 2237: sub multiple_select_form {
1.284 albertel 2238: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2239: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2240: my $output='';
1.191 matthew 2241: if (! defined($size)) {
2242: $size = 4;
1.283 albertel 2243: if (scalar(keys(%$hash))<4) {
2244: $size = scalar(keys(%$hash));
1.191 matthew 2245: }
2246: }
1.734 bisitz 2247: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2248: my @order;
1.506 raeburn 2249: if (ref($order) eq 'ARRAY') {
2250: @order = @{$order};
2251: } else {
2252: @order = sort(keys(%$hash));
1.501 banghart 2253: }
2254: if (exists($$hash{'select_form_order'})) {
2255: @order = @{$$hash{'select_form_order'}};
2256: }
2257:
1.284 albertel 2258: foreach my $key (@order) {
1.356 albertel 2259: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2260: $output.='selected="selected" ' if ($selected{$key});
2261: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2262: }
2263: $output.="</select>\n";
2264: return $output;
2265: }
2266:
1.88 www 2267: #-------------------------------------------
2268:
2269: =pod
2270:
1.1075.2.115 raeburn 2271: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2272:
2273: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2274: allow a user to select options from a ref to a hash containing:
2275: option_name => displayed text. An optional $onchange can include
1.1075.2.115 raeburn 2276: a javascript onchange item, e.g., onchange="this.form.submit();".
2277: An optional arg -- $readonly -- if true will cause the select form
2278: to be disabled, e.g., for the case where an instructor has a section-
2279: specific role, and is viewing/modifying parameters.
1.970 raeburn 2280:
1.88 www 2281: See lonrights.pm for an example invocation and use.
2282:
2283: =cut
2284:
2285: #-------------------------------------------
2286: sub select_form {
1.1075.2.115 raeburn 2287: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2288: return unless (ref($hashref) eq 'HASH');
2289: if ($onchange) {
2290: $onchange = ' onchange="'.$onchange.'"';
2291: }
1.1075.2.129 raeburn 2292: my $disabled;
2293: if ($readonly) {
2294: $disabled = ' disabled="disabled"';
2295: }
2296: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2297: my @keys;
1.970 raeburn 2298: if (exists($hashref->{'select_form_order'})) {
2299: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2300: } else {
1.970 raeburn 2301: @keys=sort(keys(%{$hashref}));
1.128 albertel 2302: }
1.356 albertel 2303: foreach my $key (@keys) {
2304: $selectform.=
2305: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2306: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2307: ">".$hashref->{$key}."</option>\n";
1.88 www 2308: }
2309: $selectform.="</select>";
2310: return $selectform;
2311: }
2312:
1.475 www 2313: # For display filters
2314:
2315: sub display_filter {
1.1074 raeburn 2316: my ($context) = @_;
1.475 www 2317: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2318: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2319: my $phraseinput = 'hidden';
2320: my $includeinput = 'hidden';
2321: my ($checked,$includetypestext);
2322: if ($env{'form.displayfilter'} eq 'containing') {
2323: $phraseinput = 'text';
2324: if ($context eq 'parmslog') {
2325: $includeinput = 'checkbox';
2326: if ($env{'form.includetypes'}) {
2327: $checked = ' checked="checked"';
2328: }
2329: $includetypestext = &mt('Include parameter types');
2330: }
2331: } else {
2332: $includetypestext = ' ';
2333: }
2334: my ($additional,$secondid,$thirdid);
2335: if ($context eq 'parmslog') {
2336: $additional =
2337: '<label><input type="'.$includeinput.'" name="includetypes"'.
2338: $checked.' name="includetypes" value="1" id="includetypes" />'.
2339: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2340: '</label>';
2341: $secondid = 'includetypes';
2342: $thirdid = 'includetypestext';
2343: }
2344: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2345: '$secondid','$thirdid')";
2346: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2347: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2348: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2349: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2350: &mt('Filter: [_1]',
1.477 www 2351: &select_form($env{'form.displayfilter'},
2352: 'displayfilter',
1.970 raeburn 2353: {'currentfolder' => 'Current folder/page',
1.477 www 2354: 'containing' => 'Containing phrase',
1.1074 raeburn 2355: 'none' => 'None'},$onchange)).' '.
2356: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2357: &HTML::Entities::encode($env{'form.containingphrase'}).
2358: '" />'.$additional;
2359: }
2360:
2361: sub display_filter_js {
2362: my $includetext = &mt('Include parameter types');
2363: return <<"ENDJS";
2364:
2365: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2366: var firstType = 'hidden';
2367: if (setter.options[setter.selectedIndex].value == 'containing') {
2368: firstType = 'text';
2369: }
2370: firstObject = document.getElementById(firstid);
2371: if (typeof(firstObject) == 'object') {
2372: if (firstObject.type != firstType) {
2373: changeInputType(firstObject,firstType);
2374: }
2375: }
2376: if (context == 'parmslog') {
2377: var secondType = 'hidden';
2378: if (firstType == 'text') {
2379: secondType = 'checkbox';
2380: }
2381: secondObject = document.getElementById(secondid);
2382: if (typeof(secondObject) == 'object') {
2383: if (secondObject.type != secondType) {
2384: changeInputType(secondObject,secondType);
2385: }
2386: }
2387: var textItem = document.getElementById(thirdid);
2388: var currtext = textItem.innerHTML;
2389: var newtext;
2390: if (firstType == 'text') {
2391: newtext = '$includetext';
2392: } else {
2393: newtext = ' ';
2394: }
2395: if (currtext != newtext) {
2396: textItem.innerHTML = newtext;
2397: }
2398: }
2399: return;
2400: }
2401:
2402: function changeInputType(oldObject,newType) {
2403: var newObject = document.createElement('input');
2404: newObject.type = newType;
2405: if (oldObject.size) {
2406: newObject.size = oldObject.size;
2407: }
2408: if (oldObject.value) {
2409: newObject.value = oldObject.value;
2410: }
2411: if (oldObject.name) {
2412: newObject.name = oldObject.name;
2413: }
2414: if (oldObject.id) {
2415: newObject.id = oldObject.id;
2416: }
2417: oldObject.parentNode.replaceChild(newObject,oldObject);
2418: return;
2419: }
2420:
2421: ENDJS
1.475 www 2422: }
2423:
1.167 www 2424: sub gradeleveldescription {
2425: my $gradelevel=shift;
2426: my %gradelevels=(0 => 'Not specified',
2427: 1 => 'Grade 1',
2428: 2 => 'Grade 2',
2429: 3 => 'Grade 3',
2430: 4 => 'Grade 4',
2431: 5 => 'Grade 5',
2432: 6 => 'Grade 6',
2433: 7 => 'Grade 7',
2434: 8 => 'Grade 8',
2435: 9 => 'Grade 9',
2436: 10 => 'Grade 10',
2437: 11 => 'Grade 11',
2438: 12 => 'Grade 12',
2439: 13 => 'Grade 13',
2440: 14 => '100 Level',
2441: 15 => '200 Level',
2442: 16 => '300 Level',
2443: 17 => '400 Level',
2444: 18 => 'Graduate Level');
2445: return &mt($gradelevels{$gradelevel});
2446: }
2447:
1.163 www 2448: sub select_level_form {
2449: my ($deflevel,$name)=@_;
2450: unless ($deflevel) { $deflevel=0; }
1.167 www 2451: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2452: for (my $i=0; $i<=18; $i++) {
2453: $selectform.="<option value=\"$i\" ".
1.253 albertel 2454: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2455: ">".&gradeleveldescription($i)."</option>\n";
2456: }
2457: $selectform.="</select>";
2458: return $selectform;
1.163 www 2459: }
1.167 www 2460:
1.35 matthew 2461: #-------------------------------------------
2462:
1.45 matthew 2463: =pod
2464:
1.1075.2.115 raeburn 2465: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2466:
2467: Returns a string containing a <select name='$name' size='1'> form to
2468: allow a user to select the domain to preform an operation in.
2469: See loncreateuser.pm for an example invocation and use.
2470:
1.90 www 2471: If the $includeempty flag is set, it also includes an empty choice ("no domain
2472: selected");
2473:
1.743 raeburn 2474: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2475:
1.910 raeburn 2476: 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.
2477:
1.1075.2.36 raeburn 2478: The optional $incdoms is a reference to an array of domains which will be the only available options.
2479:
1.1075.2.115 raeburn 2480: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
2481:
2482: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
1.563 raeburn 2483:
1.35 matthew 2484: =cut
2485:
2486: #-------------------------------------------
1.34 matthew 2487: sub select_dom_form {
1.1075.2.115 raeburn 2488: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2489: if ($onchange) {
1.874 raeburn 2490: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2491: }
1.1075.2.115 raeburn 2492: if ($disabled) {
2493: $disabled = ' disabled="disabled"';
2494: }
1.1075.2.36 raeburn 2495: my (@domains,%exclude);
1.910 raeburn 2496: if (ref($incdoms) eq 'ARRAY') {
2497: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2498: } else {
2499: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2500: }
1.90 www 2501: if ($includeempty) { @domains=('',@domains); }
1.1075.2.36 raeburn 2502: if (ref($excdoms) eq 'ARRAY') {
2503: map { $exclude{$_} = 1; } @{$excdoms};
2504: }
1.1075.2.115 raeburn 2505: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2506: foreach my $dom (@domains) {
1.1075.2.36 raeburn 2507: next if ($exclude{$dom});
1.356 albertel 2508: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2509: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2510: if ($showdomdesc) {
2511: if ($dom ne '') {
2512: my $domdesc = &Apache::lonnet::domain($dom,'description');
2513: if ($domdesc ne '') {
2514: $selectdomain .= ' ('.$domdesc.')';
2515: }
2516: }
2517: }
2518: $selectdomain .= "</option>\n";
1.34 matthew 2519: }
2520: $selectdomain.="</select>";
2521: return $selectdomain;
2522: }
2523:
1.35 matthew 2524: #-------------------------------------------
2525:
1.45 matthew 2526: =pod
2527:
1.648 raeburn 2528: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2529:
1.586 raeburn 2530: input: 4 arguments (two required, two optional) -
2531: $domain - domain of new user
2532: $name - name of form element
2533: $default - Value of 'default' causes a default item to be first
2534: option, and selected by default.
2535: $hide - Value of 'hide' causes hiding of the name of the server,
2536: if 1 server found, or default, if 0 found.
1.594 raeburn 2537: output: returns 2 items:
1.586 raeburn 2538: (a) form element which contains either:
2539: (i) <select name="$name">
2540: <option value="$hostid1">$hostid $servers{$hostid}</option>
2541: <option value="$hostid2">$hostid $servers{$hostid}</option>
2542: </select>
2543: form item if there are multiple library servers in $domain, or
2544: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2545: if there is only one library server in $domain.
2546:
2547: (b) number of library servers found.
2548:
2549: See loncreateuser.pm for example of use.
1.35 matthew 2550:
2551: =cut
2552:
2553: #-------------------------------------------
1.586 raeburn 2554: sub home_server_form_item {
2555: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2556: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2557: my $result;
2558: my $numlib = keys(%servers);
2559: if ($numlib > 1) {
2560: $result .= '<select name="'.$name.'" />'."\n";
2561: if ($default) {
1.804 bisitz 2562: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2563: '</option>'."\n";
2564: }
2565: foreach my $hostid (sort(keys(%servers))) {
2566: $result.= '<option value="'.$hostid.'">'.
2567: $hostid.' '.$servers{$hostid}."</option>\n";
2568: }
2569: $result .= '</select>'."\n";
2570: } elsif ($numlib == 1) {
2571: my $hostid;
2572: foreach my $item (keys(%servers)) {
2573: $hostid = $item;
2574: }
2575: $result .= '<input type="hidden" name="'.$name.'" value="'.
2576: $hostid.'" />';
2577: if (!$hide) {
2578: $result .= $hostid.' '.$servers{$hostid};
2579: }
2580: $result .= "\n";
2581: } elsif ($default) {
2582: $result .= '<input type="hidden" name="'.$name.
2583: '" value="default" />';
2584: if (!$hide) {
2585: $result .= &mt('default');
2586: }
2587: $result .= "\n";
1.33 matthew 2588: }
1.586 raeburn 2589: return ($result,$numlib);
1.33 matthew 2590: }
1.112 bowersj2 2591:
2592: =pod
2593:
1.534 albertel 2594: =back
2595:
1.112 bowersj2 2596: =cut
1.87 matthew 2597:
2598: ###############################################################
1.112 bowersj2 2599: ## Decoding User Agent ##
1.87 matthew 2600: ###############################################################
2601:
2602: =pod
2603:
1.112 bowersj2 2604: =head1 Decoding the User Agent
2605:
2606: =over 4
2607:
2608: =item * &decode_user_agent()
1.87 matthew 2609:
2610: Inputs: $r
2611:
2612: Outputs:
2613:
2614: =over 4
2615:
1.112 bowersj2 2616: =item * $httpbrowser
1.87 matthew 2617:
1.112 bowersj2 2618: =item * $clientbrowser
1.87 matthew 2619:
1.112 bowersj2 2620: =item * $clientversion
1.87 matthew 2621:
1.112 bowersj2 2622: =item * $clientmathml
1.87 matthew 2623:
1.112 bowersj2 2624: =item * $clientunicode
1.87 matthew 2625:
1.112 bowersj2 2626: =item * $clientos
1.87 matthew 2627:
1.1075.2.42 raeburn 2628: =item * $clientmobile
2629:
2630: =item * $clientinfo
2631:
1.1075.2.77 raeburn 2632: =item * $clientosversion
2633:
1.87 matthew 2634: =back
2635:
1.157 matthew 2636: =back
2637:
1.87 matthew 2638: =cut
2639:
2640: ###############################################################
2641: ###############################################################
2642: sub decode_user_agent {
1.247 albertel 2643: my ($r)=@_;
1.87 matthew 2644: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2645: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2646: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2647: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2648: my $clientbrowser='unknown';
2649: my $clientversion='0';
2650: my $clientmathml='';
2651: my $clientunicode='0';
1.1075.2.42 raeburn 2652: my $clientmobile=0;
1.1075.2.77 raeburn 2653: my $clientosversion='';
1.87 matthew 2654: for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76 raeburn 2655: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2656: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2657: $clientbrowser=$bname;
2658: $httpbrowser=~/$vreg/i;
2659: $clientversion=$1;
2660: $clientmathml=($clientversion>=$minv);
2661: $clientunicode=($clientversion>=$univ);
2662: }
2663: }
2664: my $clientos='unknown';
1.1075.2.42 raeburn 2665: my $clientinfo;
1.87 matthew 2666: if (($httpbrowser=~/linux/i) ||
2667: ($httpbrowser=~/unix/i) ||
2668: ($httpbrowser=~/ux/i) ||
2669: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2670: if (($httpbrowser=~/vax/i) ||
2671: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2672: if ($httpbrowser=~/next/i) { $clientos='next'; }
2673: if (($httpbrowser=~/mac/i) ||
2674: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77 raeburn 2675: if ($httpbrowser=~/win/i) {
2676: $clientos='win';
2677: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2678: $clientosversion = $1;
2679: }
2680: }
1.87 matthew 2681: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42 raeburn 2682: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2683: $clientmobile=lc($1);
2684: }
2685: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2686: $clientinfo = 'firefox-'.$1;
2687: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2688: $clientinfo = 'chromeframe-'.$1;
2689: }
1.87 matthew 2690: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77 raeburn 2691: $clientunicode,$clientos,$clientmobile,$clientinfo,
2692: $clientosversion);
1.87 matthew 2693: }
2694:
1.32 matthew 2695: ###############################################################
2696: ## Authentication changing form generation subroutines ##
2697: ###############################################################
2698: ##
2699: ## All of the authform_xxxxxxx subroutines take their inputs in a
2700: ## hash, and have reasonable default values.
2701: ##
2702: ## formname = the name given in the <form> tag.
1.35 matthew 2703: #-------------------------------------------
2704:
1.45 matthew 2705: =pod
2706:
1.112 bowersj2 2707: =head1 Authentication Routines
2708:
2709: =over 4
2710:
1.648 raeburn 2711: =item * &authform_xxxxxx()
1.35 matthew 2712:
2713: The authform_xxxxxx subroutines provide javascript and html forms which
2714: handle some of the conveniences required for authentication forms.
2715: This is not an optimal method, but it works.
2716:
2717: =over 4
2718:
1.112 bowersj2 2719: =item * authform_header
1.35 matthew 2720:
1.112 bowersj2 2721: =item * authform_authorwarning
1.35 matthew 2722:
1.112 bowersj2 2723: =item * authform_nochange
1.35 matthew 2724:
1.112 bowersj2 2725: =item * authform_kerberos
1.35 matthew 2726:
1.112 bowersj2 2727: =item * authform_internal
1.35 matthew 2728:
1.112 bowersj2 2729: =item * authform_filesystem
1.35 matthew 2730:
2731: =back
2732:
1.648 raeburn 2733: See loncreateuser.pm for invocation and use examples.
1.157 matthew 2734:
1.35 matthew 2735: =cut
2736:
2737: #-------------------------------------------
1.32 matthew 2738: sub authform_header{
2739: my %in = (
2740: formname => 'cu',
1.80 albertel 2741: kerb_def_dom => '',
1.32 matthew 2742: @_,
2743: );
2744: $in{'formname'} = 'document.' . $in{'formname'};
2745: my $result='';
1.80 albertel 2746:
2747: #---------------------------------------------- Code for upper case translation
2748: my $Javascript_toUpperCase;
2749: unless ($in{kerb_def_dom}) {
2750: $Javascript_toUpperCase =<<"END";
2751: switch (choice) {
2752: case 'krb': currentform.elements[choicearg].value =
2753: currentform.elements[choicearg].value.toUpperCase();
2754: break;
2755: default:
2756: }
2757: END
2758: } else {
2759: $Javascript_toUpperCase = "";
2760: }
2761:
1.165 raeburn 2762: my $radioval = "'nochange'";
1.591 raeburn 2763: if (defined($in{'curr_authtype'})) {
2764: if ($in{'curr_authtype'} ne '') {
2765: $radioval = "'".$in{'curr_authtype'}."arg'";
2766: }
1.174 matthew 2767: }
1.165 raeburn 2768: my $argfield = 'null';
1.591 raeburn 2769: if (defined($in{'mode'})) {
1.165 raeburn 2770: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2771: if (defined($in{'curr_autharg'})) {
2772: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2773: $argfield = "'$in{'curr_autharg'}'";
2774: }
2775: }
2776: }
2777: }
2778:
1.32 matthew 2779: $result.=<<"END";
2780: var current = new Object();
1.165 raeburn 2781: current.radiovalue = $radioval;
2782: current.argfield = $argfield;
1.32 matthew 2783:
2784: function changed_radio(choice,currentform) {
2785: var choicearg = choice + 'arg';
2786: // If a radio button in changed, we need to change the argfield
2787: if (current.radiovalue != choice) {
2788: current.radiovalue = choice;
2789: if (current.argfield != null) {
2790: currentform.elements[current.argfield].value = '';
2791: }
2792: if (choice == 'nochange') {
2793: current.argfield = null;
2794: } else {
2795: current.argfield = choicearg;
2796: switch(choice) {
2797: case 'krb':
2798: currentform.elements[current.argfield].value =
2799: "$in{'kerb_def_dom'}";
2800: break;
2801: default:
2802: break;
2803: }
2804: }
2805: }
2806: return;
2807: }
1.22 www 2808:
1.32 matthew 2809: function changed_text(choice,currentform) {
2810: var choicearg = choice + 'arg';
2811: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2812: $Javascript_toUpperCase
1.32 matthew 2813: // clear old field
2814: if ((current.argfield != choicearg) && (current.argfield != null)) {
2815: currentform.elements[current.argfield].value = '';
2816: }
2817: current.argfield = choicearg;
2818: }
2819: set_auth_radio_buttons(choice,currentform);
2820: return;
1.20 www 2821: }
1.32 matthew 2822:
2823: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 2824: var numauthchoices = currentform.login.length;
2825: if (typeof numauthchoices == "undefined") {
2826: return;
2827: }
1.32 matthew 2828: var i=0;
1.986 raeburn 2829: while (i < numauthchoices) {
1.32 matthew 2830: if (currentform.login[i].value == newvalue) { break; }
2831: i++;
2832: }
1.986 raeburn 2833: if (i == numauthchoices) {
1.32 matthew 2834: return;
2835: }
2836: current.radiovalue = newvalue;
2837: currentform.login[i].checked = true;
2838: return;
2839: }
2840: END
2841: return $result;
2842: }
2843:
1.1075.2.20 raeburn 2844: sub authform_authorwarning {
1.32 matthew 2845: my $result='';
1.144 matthew 2846: $result='<i>'.
2847: &mt('As a general rule, only authors or co-authors should be '.
2848: 'filesystem authenticated '.
2849: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2850: return $result;
2851: }
2852:
1.1075.2.20 raeburn 2853: sub authform_nochange {
1.32 matthew 2854: my %in = (
2855: formname => 'document.cu',
2856: kerb_def_dom => 'MSU.EDU',
2857: @_,
2858: );
1.1075.2.20 raeburn 2859: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 2860: my $result;
1.1075.2.20 raeburn 2861: if (!$authnum) {
2862: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 2863: } else {
2864: $result = '<label>'.&mt('[_1] Do not change login data',
2865: '<input type="radio" name="login" value="nochange" '.
2866: 'checked="checked" onclick="'.
1.281 albertel 2867: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2868: '</label>';
1.586 raeburn 2869: }
1.32 matthew 2870: return $result;
2871: }
2872:
1.591 raeburn 2873: sub authform_kerberos {
1.32 matthew 2874: my %in = (
2875: formname => 'document.cu',
2876: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2877: kerb_def_auth => 'krb4',
1.32 matthew 2878: @_,
2879: );
1.586 raeburn 2880: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117 raeburn 2881: $autharg,$jscall,$disabled);
1.1075.2.20 raeburn 2882: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2883: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2884: $check5 = ' checked="checked"';
1.80 albertel 2885: } else {
1.772 bisitz 2886: $check4 = ' checked="checked"';
1.80 albertel 2887: }
1.1075.2.117 raeburn 2888: if ($in{'readonly'}) {
2889: $disabled = ' disabled="disabled"';
2890: }
1.165 raeburn 2891: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2892: if (defined($in{'curr_authtype'})) {
2893: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2894: $krbcheck = ' checked="checked"';
1.623 raeburn 2895: if (defined($in{'mode'})) {
2896: if ($in{'mode'} eq 'modifyuser') {
2897: $krbcheck = '';
2898: }
2899: }
1.591 raeburn 2900: if (defined($in{'curr_kerb_ver'})) {
2901: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2902: $check5 = ' checked="checked"';
1.591 raeburn 2903: $check4 = '';
2904: } else {
1.772 bisitz 2905: $check4 = ' checked="checked"';
1.591 raeburn 2906: $check5 = '';
2907: }
1.586 raeburn 2908: }
1.591 raeburn 2909: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2910: $krbarg = $in{'curr_autharg'};
2911: }
1.586 raeburn 2912: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2913: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2914: $result =
2915: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2916: $in{'curr_autharg'},$krbver);
2917: } else {
2918: $result =
2919: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2920: }
2921: return $result;
2922: }
2923: }
2924: } else {
2925: if ($authnum == 1) {
1.784 bisitz 2926: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 2927: }
2928: }
1.586 raeburn 2929: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2930: return;
1.587 raeburn 2931: } elsif ($authtype eq '') {
1.591 raeburn 2932: if (defined($in{'mode'})) {
1.587 raeburn 2933: if ($in{'mode'} eq 'modifycourse') {
2934: if ($authnum == 1) {
1.1075.2.117 raeburn 2935: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 2936: }
2937: }
2938: }
1.586 raeburn 2939: }
2940: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2941: if ($authtype eq '') {
2942: $authtype = '<input type="radio" name="login" value="krb" '.
2943: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117 raeburn 2944: $krbcheck.$disabled.' />';
1.586 raeburn 2945: }
2946: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20 raeburn 2947: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 2948: $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20 raeburn 2949: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 2950: $in{'curr_authtype'} eq 'krb4')) {
2951: $result .= &mt
1.144 matthew 2952: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2953: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2954: '<label>'.$authtype,
1.281 albertel 2955: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2956: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2957: 'onchange="'.$jscall.'"'.$disabled.' />',
2958: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
2959: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 2960: '</label>');
1.586 raeburn 2961: } elsif ($can_assign{'krb4'}) {
2962: $result .= &mt
2963: ('[_1] Kerberos authenticated with domain [_2] '.
2964: '[_3] Version 4 [_4]',
2965: '<label>'.$authtype,
2966: '</label><input type="text" size="10" name="krbarg" '.
2967: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2968: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 2969: '<label><input type="hidden" name="krbver" value="4" />',
2970: '</label>');
2971: } elsif ($can_assign{'krb5'}) {
2972: $result .= &mt
2973: ('[_1] Kerberos authenticated with domain [_2] '.
2974: '[_3] Version 5 [_4]',
2975: '<label>'.$authtype,
2976: '</label><input type="text" size="10" name="krbarg" '.
2977: 'value="'.$krbarg.'" '.
1.1075.2.117 raeburn 2978: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 2979: '<label><input type="hidden" name="krbver" value="5" />',
2980: '</label>');
2981: }
1.32 matthew 2982: return $result;
2983: }
2984:
1.1075.2.20 raeburn 2985: sub authform_internal {
1.586 raeburn 2986: my %in = (
1.32 matthew 2987: formname => 'document.cu',
2988: kerb_def_dom => 'MSU.EDU',
2989: @_,
2990: );
1.1075.2.117 raeburn 2991: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 2992: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 2993: if ($in{'readonly'}) {
2994: $disabled = ' disabled="disabled"';
2995: }
1.591 raeburn 2996: if (defined($in{'curr_authtype'})) {
2997: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2998: if ($can_assign{'int'}) {
1.772 bisitz 2999: $intcheck = 'checked="checked" ';
1.623 raeburn 3000: if (defined($in{'mode'})) {
3001: if ($in{'mode'} eq 'modifyuser') {
3002: $intcheck = '';
3003: }
3004: }
1.591 raeburn 3005: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3006: $intarg = $in{'curr_autharg'};
3007: }
3008: } else {
3009: $result = &mt('Currently internally authenticated.');
3010: return $result;
1.165 raeburn 3011: }
3012: }
1.586 raeburn 3013: } else {
3014: if ($authnum == 1) {
1.784 bisitz 3015: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3016: }
3017: }
3018: if (!$can_assign{'int'}) {
3019: return;
1.587 raeburn 3020: } elsif ($authtype eq '') {
1.591 raeburn 3021: if (defined($in{'mode'})) {
1.587 raeburn 3022: if ($in{'mode'} eq 'modifycourse') {
3023: if ($authnum == 1) {
1.1075.2.117 raeburn 3024: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3025: }
3026: }
3027: }
1.165 raeburn 3028: }
1.586 raeburn 3029: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3030: if ($authtype eq '') {
3031: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117 raeburn 3032: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3033: }
1.605 bisitz 3034: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117 raeburn 3035: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3036: $result = &mt
1.144 matthew 3037: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3038: '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118 raeburn 3039: $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 3040: return $result;
3041: }
3042:
1.1075.2.20 raeburn 3043: sub authform_local {
1.32 matthew 3044: my %in = (
3045: formname => 'document.cu',
3046: kerb_def_dom => 'MSU.EDU',
3047: @_,
3048: );
1.1075.2.117 raeburn 3049: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 3050: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 3051: if ($in{'readonly'}) {
3052: $disabled = ' disabled="disabled"';
3053: }
1.591 raeburn 3054: if (defined($in{'curr_authtype'})) {
3055: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3056: if ($can_assign{'loc'}) {
1.772 bisitz 3057: $loccheck = 'checked="checked" ';
1.623 raeburn 3058: if (defined($in{'mode'})) {
3059: if ($in{'mode'} eq 'modifyuser') {
3060: $loccheck = '';
3061: }
3062: }
1.591 raeburn 3063: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3064: $locarg = $in{'curr_autharg'};
3065: }
3066: } else {
3067: $result = &mt('Currently using local (institutional) authentication.');
3068: return $result;
1.165 raeburn 3069: }
3070: }
1.586 raeburn 3071: } else {
3072: if ($authnum == 1) {
1.784 bisitz 3073: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3074: }
3075: }
3076: if (!$can_assign{'loc'}) {
3077: return;
1.587 raeburn 3078: } elsif ($authtype eq '') {
1.591 raeburn 3079: if (defined($in{'mode'})) {
1.587 raeburn 3080: if ($in{'mode'} eq 'modifycourse') {
3081: if ($authnum == 1) {
1.1075.2.117 raeburn 3082: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3083: }
3084: }
3085: }
1.165 raeburn 3086: }
1.586 raeburn 3087: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3088: if ($authtype eq '') {
3089: $authtype = '<input type="radio" name="login" value="loc" '.
3090: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117 raeburn 3091: $jscall.'"'.$disabled.' />';
1.586 raeburn 3092: }
3093: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117 raeburn 3094: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3095: $result = &mt('[_1] Local Authentication with argument [_2]',
3096: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3097: return $result;
3098: }
3099:
1.1075.2.20 raeburn 3100: sub authform_filesystem {
1.32 matthew 3101: my %in = (
3102: formname => 'document.cu',
3103: kerb_def_dom => 'MSU.EDU',
3104: @_,
3105: );
1.1075.2.117 raeburn 3106: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20 raeburn 3107: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117 raeburn 3108: if ($in{'readonly'}) {
3109: $disabled = ' disabled="disabled"';
3110: }
1.591 raeburn 3111: if (defined($in{'curr_authtype'})) {
3112: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3113: if ($can_assign{'fsys'}) {
1.772 bisitz 3114: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3115: if (defined($in{'mode'})) {
3116: if ($in{'mode'} eq 'modifyuser') {
3117: $fsyscheck = '';
3118: }
3119: }
1.586 raeburn 3120: } else {
3121: $result = &mt('Currently Filesystem Authenticated.');
3122: return $result;
3123: }
3124: }
3125: } else {
3126: if ($authnum == 1) {
1.784 bisitz 3127: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3128: }
3129: }
3130: if (!$can_assign{'fsys'}) {
3131: return;
1.587 raeburn 3132: } elsif ($authtype eq '') {
1.591 raeburn 3133: if (defined($in{'mode'})) {
1.587 raeburn 3134: if ($in{'mode'} eq 'modifycourse') {
3135: if ($authnum == 1) {
1.1075.2.117 raeburn 3136: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3137: }
3138: }
3139: }
1.586 raeburn 3140: }
3141: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3142: if ($authtype eq '') {
3143: $authtype = '<input type="radio" name="login" value="fsys" '.
3144: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117 raeburn 3145: $jscall.'"'.$disabled.' />';
1.586 raeburn 3146: }
1.1075.2.158 raeburn 3147: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1075.2.117 raeburn 3148: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3149: $result = &mt
1.144 matthew 3150: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1075.2.158 raeburn 3151: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3152: return $result;
3153: }
3154:
1.586 raeburn 3155: sub get_assignable_auth {
3156: my ($dom) = @_;
3157: if ($dom eq '') {
3158: $dom = $env{'request.role.domain'};
3159: }
3160: my %can_assign = (
3161: krb4 => 1,
3162: krb5 => 1,
3163: int => 1,
3164: loc => 1,
3165: );
3166: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3167: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3168: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3169: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3170: my $context;
3171: if ($env{'request.role'} =~ /^au/) {
3172: $context = 'author';
1.1075.2.117 raeburn 3173: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3174: $context = 'domain';
3175: } elsif ($env{'request.course.id'}) {
3176: $context = 'course';
3177: }
3178: if ($context) {
3179: if (ref($authhash->{$context}) eq 'HASH') {
3180: %can_assign = %{$authhash->{$context}};
3181: }
3182: }
3183: }
3184: }
3185: my $authnum = 0;
3186: foreach my $key (keys(%can_assign)) {
3187: if ($can_assign{$key}) {
3188: $authnum ++;
3189: }
3190: }
3191: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3192: $authnum --;
3193: }
3194: return ($authnum,%can_assign);
3195: }
3196:
1.1075.2.137 raeburn 3197: sub check_passwd_rules {
3198: my ($domain,$plainpass) = @_;
3199: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3200: my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138 raeburn 3201: $min = $Apache::lonnet::passwdmin;
1.1075.2.137 raeburn 3202: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3203: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138 raeburn 3204: if ($passwdconf{'min'} > $min) {
3205: $min = $passwdconf{'min'};
3206: }
1.1075.2.137 raeburn 3207: }
3208: if ($passwdconf{'max'} =~ /^\d+$/) {
3209: $max = $passwdconf{'max'};
3210: }
3211: @chars = @{$passwdconf{'chars'}};
3212: }
3213: if (($min) && (length($plainpass) < $min)) {
3214: push(@brokerule,'min');
3215: }
3216: if (($max) && (length($plainpass) > $max)) {
3217: push(@brokerule,'max');
3218: }
3219: if (@chars) {
3220: my %rules;
3221: map { $rules{$_} = 1; } @chars;
3222: if ($rules{'uc'}) {
3223: unless ($plainpass =~ /[A-Z]/) {
3224: push(@brokerule,'uc');
3225: }
3226: }
3227: if ($rules{'lc'}) {
3228: unless ($plainpass =~ /[a-z]/) {
3229: push(@brokerule,'lc');
3230: }
3231: }
3232: if ($rules{'num'}) {
3233: unless ($plainpass =~ /\d/) {
3234: push(@brokerule,'num');
3235: }
3236: }
3237: if ($rules{'spec'}) {
3238: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3239: push(@brokerule,'spec');
3240: }
3241: }
3242: }
3243: if (@brokerule) {
3244: my %rulenames = &Apache::lonlocal::texthash(
3245: uc => 'At least one upper case letter',
3246: lc => 'At least one lower case letter',
3247: num => 'At least one number',
3248: spec => 'At least one non-alphanumeric',
3249: );
3250: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3251: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3252: $rulenames{'num'} .= ': 0123456789';
3253: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3254: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3255: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3256: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143 raeburn 3257: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137 raeburn 3258: if (grep(/^$rule$/,@brokerule)) {
3259: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3260: }
3261: }
3262: $warning .= '</ul>';
3263: }
3264: if (wantarray) {
3265: return @brokerule;
3266: }
3267: return $warning;
3268: }
3269:
1.1075.2.161. .5(raebu 3270:22): sub passwd_validation_js {
3271:22): my ($currpasswdval,$domain,$context,$id) = @_;
3272:22): my (%passwdconf,$alertmsg);
3273:22): if ($context eq 'linkprot') {
3274:22): my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3275:22): if (ref($domconfig{'ltisec'}) eq 'HASH') {
3276:22): if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3277:22): %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3278:22): }
3279:22): }
3280:22): if ($id eq 'add') {
3281:22): $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3282:22): } elsif ($id =~ /^\d+$/) {
3283:22): my $pos = $id+1;
3284:22): $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3285:22): } else {
3286:22): $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3287:22): }
3288:22): } else {
3289:22): %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3290:22): $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3291:22): }
3292:22): my ($min,$max,@chars,$numrules,$intargjs,%alert);
3293:22): $numrules = 0;
3294:22): $min = $Apache::lonnet::passwdmin;
3295:22): if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3296:22): if ($passwdconf{'min'} =~ /^\d+$/) {
3297:22): if ($passwdconf{'min'} > $min) {
3298:22): $min = $passwdconf{'min'};
3299:22): }
3300:22): }
3301:22): if ($passwdconf{'max'} =~ /^\d+$/) {
3302:22): $max = $passwdconf{'max'};
3303:22): $numrules ++;
3304:22): }
3305:22): @chars = @{$passwdconf{'chars'}};
3306:22): if (@chars) {
3307:22): $numrules ++;
3308:22): }
3309:22): }
3310:22): if ($min > 0) {
3311:22): $numrules ++;
3312:22): }
3313:22): if (($min > 0) || ($max ne '') || (@chars > 0)) {
3314:22): if ($min) {
3315:22): $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3316:22): }
3317:22): if ($max) {
3318:22): $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3319:22): }
3320:22): my (@charalerts,@charrules);
3321:22): if (@chars) {
3322:22): if (grep(/^uc$/,@chars)) {
3323:22): push(@charalerts,&mt('contain at least one upper case letter'));
3324:22): push(@charrules,'uc');
3325:22): }
3326:22): if (grep(/^lc$/,@chars)) {
3327:22): push(@charalerts,&mt('contain at least one lower case letter'));
3328:22): push(@charrules,'lc');
3329:22): }
3330:22): if (grep(/^num$/,@chars)) {
3331:22): push(@charalerts,&mt('contain at least one number'));
3332:22): push(@charrules,'num');
3333:22): }
3334:22): if (grep(/^spec$/,@chars)) {
3335:22): push(@charalerts,&mt('contain at least one non-alphanumeric'));
3336:22): push(@charrules,'spec');
3337:22): }
3338:22): }
3339:22): $intargjs = qq| var rulesmsg = '';\n|.
3340:22): qq| var currpwval = $currpasswdval;\n|;
3341:22): if ($min) {
3342:22): $intargjs .= qq|
3343:22): if (currpwval.length < $min) {
3344:22): rulesmsg += ' - $alert{min}';
3345:22): }
3346:22): |;
3347:22): }
3348:22): if ($max) {
3349:22): $intargjs .= qq|
3350:22): if (currpwval.length > $max) {
3351:22): rulesmsg += ' - $alert{max}';
3352:22): }
3353:22): |;
3354:22): }
3355:22): if (@chars > 0) {
3356:22): my $charrulestr = '"'.join('","',@charrules).'"';
3357:22): my $charalertstr = '"'.join('","',@charalerts).'"';
3358:22): $intargjs .= qq| var brokerules = new Array();\n|.
3359:22): qq| var charrules = new Array($charrulestr);\n|.
3360:22): qq| var charalerts = new Array($charalertstr);\n|;
3361:22): my %rules;
3362:22): map { $rules{$_} = 1; } @chars;
3363:22): if ($rules{'uc'}) {
3364:22): $intargjs .= qq|
3365:22): var ucRegExp = /[A-Z]/;
3366:22): if (!ucRegExp.test(currpwval)) {
3367:22): brokerules.push('uc');
3368:22): }
3369:22): |;
3370:22): }
3371:22): if ($rules{'lc'}) {
3372:22): $intargjs .= qq|
3373:22): var lcRegExp = /[a-z]/;
3374:22): if (!lcRegExp.test(currpwval)) {
3375:22): brokerules.push('lc');
3376:22): }
3377:22): |;
3378:22): }
3379:22): if ($rules{'num'}) {
3380:22): $intargjs .= qq|
3381:22): var numRegExp = /[0-9]/;
3382:22): if (!numRegExp.test(currpwval)) {
3383:22): brokerules.push('num');
3384:22): }
3385:22): |;
3386:22): }
3387:22): if ($rules{'spec'}) {
3388:22): $intargjs .= q|
3389:22): var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
3390:22): if (!specRegExp.test(currpwval)) {
3391:22): brokerules.push('spec');
3392:22): }
3393:22): |;
3394:22): }
3395:22): $intargjs .= qq|
3396:22): if (brokerules.length > 0) {
3397:22): for (var i=0; i<brokerules.length; i++) {
3398:22): for (var j=0; j<charrules.length; j++) {
3399:22): if (brokerules[i] == charrules[j]) {
3400:22): rulesmsg += ' - '+charalerts[j]+'\\n';
3401:22): break;
3402:22): }
3403:22): }
3404:22): }
3405:22): }
3406:22): |;
3407:22): }
3408:22): $intargjs .= qq|
3409:22): if (rulesmsg != '') {
3410:22): rulesmsg = '$alertmsg'+rulesmsg;
3411:22): alert(rulesmsg);
3412:22): return false;
3413:22): }
3414:22): |;
3415:22): }
3416:22): return ($numrules,$intargjs);
3417:22): }
3418:22):
1.80 albertel 3419: ###############################################################
3420: ## Get Kerberos Defaults for Domain ##
3421: ###############################################################
3422: ##
3423: ## Returns default kerberos version and an associated argument
3424: ## as listed in file domain.tab. If not listed, provides
3425: ## appropriate default domain and kerberos version.
3426: ##
3427: #-------------------------------------------
3428:
3429: =pod
3430:
1.648 raeburn 3431: =item * &get_kerberos_defaults()
1.80 albertel 3432:
3433: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3434: version and domain. If not found, it defaults to version 4 and the
3435: domain of the server.
1.80 albertel 3436:
1.648 raeburn 3437: =over 4
3438:
1.80 albertel 3439: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3440:
1.648 raeburn 3441: =back
3442:
3443: =back
3444:
1.80 albertel 3445: =cut
3446:
3447: #-------------------------------------------
3448: sub get_kerberos_defaults {
3449: my $domain=shift;
1.641 raeburn 3450: my ($krbdef,$krbdefdom);
3451: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3452: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3453: $krbdef = $domdefaults{'auth_def'};
3454: $krbdefdom = $domdefaults{'auth_arg_def'};
3455: } else {
1.80 albertel 3456: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3457: my $krbdefdom=$1;
3458: $krbdefdom=~tr/a-z/A-Z/;
3459: $krbdef = "krb4";
3460: }
3461: return ($krbdef,$krbdefdom);
3462: }
1.112 bowersj2 3463:
1.32 matthew 3464:
1.46 matthew 3465: ###############################################################
3466: ## Thesaurus Functions ##
3467: ###############################################################
1.20 www 3468:
1.46 matthew 3469: =pod
1.20 www 3470:
1.112 bowersj2 3471: =head1 Thesaurus Functions
3472:
3473: =over 4
3474:
1.648 raeburn 3475: =item * &initialize_keywords()
1.46 matthew 3476:
3477: Initializes the package variable %Keywords if it is empty. Uses the
3478: package variable $thesaurus_db_file.
3479:
3480: =cut
3481:
3482: ###################################################
3483:
3484: sub initialize_keywords {
3485: return 1 if (scalar keys(%Keywords));
3486: # If we are here, %Keywords is empty, so fill it up
3487: # Make sure the file we need exists...
3488: if (! -e $thesaurus_db_file) {
3489: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3490: " failed because it does not exist");
3491: return 0;
3492: }
3493: # Set up the hash as a database
3494: my %thesaurus_db;
3495: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3496: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3497: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3498: $thesaurus_db_file);
3499: return 0;
3500: }
3501: # Get the average number of appearances of a word.
3502: my $avecount = $thesaurus_db{'average.count'};
3503: # Put keywords (those that appear > average) into %Keywords
3504: while (my ($word,$data)=each (%thesaurus_db)) {
3505: my ($count,undef) = split /:/,$data;
3506: $Keywords{$word}++ if ($count > $avecount);
3507: }
3508: untie %thesaurus_db;
3509: # Remove special values from %Keywords.
1.356 albertel 3510: foreach my $value ('total.count','average.count') {
3511: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3512: }
1.46 matthew 3513: return 1;
3514: }
3515:
3516: ###################################################
3517:
3518: =pod
3519:
1.648 raeburn 3520: =item * &keyword($word)
1.46 matthew 3521:
3522: Returns true if $word is a keyword. A keyword is a word that appears more
3523: than the average number of times in the thesaurus database. Calls
3524: &initialize_keywords
3525:
3526: =cut
3527:
3528: ###################################################
1.20 www 3529:
3530: sub keyword {
1.46 matthew 3531: return if (!&initialize_keywords());
3532: my $word=lc(shift());
3533: $word=~s/\W//g;
3534: return exists($Keywords{$word});
1.20 www 3535: }
1.46 matthew 3536:
3537: ###############################################################
3538:
3539: =pod
1.20 www 3540:
1.648 raeburn 3541: =item * &get_related_words()
1.46 matthew 3542:
1.160 matthew 3543: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3544: an array of words. If the keyword is not in the thesaurus, an empty array
3545: will be returned. The order of the words returned is determined by the
3546: database which holds them.
3547:
3548: Uses global $thesaurus_db_file.
3549:
1.1057 foxr 3550:
1.46 matthew 3551: =cut
3552:
3553: ###############################################################
3554: sub get_related_words {
3555: my $keyword = shift;
3556: my %thesaurus_db;
3557: if (! -e $thesaurus_db_file) {
3558: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3559: "failed because the file does not exist");
3560: return ();
3561: }
3562: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3563: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3564: return ();
3565: }
3566: my @Words=();
1.429 www 3567: my $count=0;
1.46 matthew 3568: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3569: # The first element is the number of times
3570: # the word appears. We do not need it now.
1.429 www 3571: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3572: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3573: my $threshold=$mostfrequentcount/10;
3574: foreach my $possibleword (@RelatedWords) {
3575: my ($word,$wordcount)=split(/\,/,$possibleword);
3576: if ($wordcount>$threshold) {
3577: push(@Words,$word);
3578: $count++;
3579: if ($count>10) { last; }
3580: }
1.20 www 3581: }
3582: }
1.46 matthew 3583: untie %thesaurus_db;
3584: return @Words;
1.14 harris41 3585: }
1.46 matthew 3586:
1.112 bowersj2 3587: =pod
3588:
3589: =back
3590:
3591: =cut
1.61 www 3592:
3593: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3594: =pod
3595:
1.112 bowersj2 3596: =head1 User Name Functions
3597:
3598: =over 4
3599:
1.648 raeburn 3600: =item * &plainname($uname,$udom,$first)
1.81 albertel 3601:
1.112 bowersj2 3602: Takes a users logon name and returns it as a string in
1.226 albertel 3603: "first middle last generation" form
3604: if $first is set to 'lastname' then it returns it as
3605: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3606:
3607: =cut
1.61 www 3608:
1.295 www 3609:
1.81 albertel 3610: ###############################################################
1.61 www 3611: sub plainname {
1.226 albertel 3612: my ($uname,$udom,$first)=@_;
1.537 albertel 3613: return if (!defined($uname) || !defined($udom));
1.295 www 3614: my %names=&getnames($uname,$udom);
1.226 albertel 3615: my $name=&Apache::lonnet::format_name($names{'firstname'},
3616: $names{'middlename'},
3617: $names{'lastname'},
3618: $names{'generation'},$first);
3619: $name=~s/^\s+//;
1.62 www 3620: $name=~s/\s+$//;
3621: $name=~s/\s+/ /g;
1.353 albertel 3622: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3623: return $name;
1.61 www 3624: }
1.66 www 3625:
3626: # -------------------------------------------------------------------- Nickname
1.81 albertel 3627: =pod
3628:
1.648 raeburn 3629: =item * &nickname($uname,$udom)
1.81 albertel 3630:
3631: Gets a users name and returns it as a string as
3632:
3633: ""nickname""
1.66 www 3634:
1.81 albertel 3635: if the user has a nickname or
3636:
3637: "first middle last generation"
3638:
3639: if the user does not
3640:
3641: =cut
1.66 www 3642:
3643: sub nickname {
3644: my ($uname,$udom)=@_;
1.537 albertel 3645: return if (!defined($uname) || !defined($udom));
1.295 www 3646: my %names=&getnames($uname,$udom);
1.68 albertel 3647: my $name=$names{'nickname'};
1.66 www 3648: if ($name) {
3649: $name='"'.$name.'"';
3650: } else {
3651: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3652: $names{'lastname'}.' '.$names{'generation'};
3653: $name=~s/\s+$//;
3654: $name=~s/\s+/ /g;
3655: }
3656: return $name;
3657: }
3658:
1.295 www 3659: sub getnames {
3660: my ($uname,$udom)=@_;
1.537 albertel 3661: return if (!defined($uname) || !defined($udom));
1.433 albertel 3662: if ($udom eq 'public' && $uname eq 'public') {
3663: return ('lastname' => &mt('Public'));
3664: }
1.295 www 3665: my $id=$uname.':'.$udom;
3666: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3667: if ($cached) {
3668: return %{$names};
3669: } else {
3670: my %loadnames=&Apache::lonnet::get('environment',
3671: ['firstname','middlename','lastname','generation','nickname'],
3672: $udom,$uname);
3673: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3674: return %loadnames;
3675: }
3676: }
1.61 www 3677:
1.542 raeburn 3678: # -------------------------------------------------------------------- getemails
1.648 raeburn 3679:
1.542 raeburn 3680: =pod
3681:
1.648 raeburn 3682: =item * &getemails($uname,$udom)
1.542 raeburn 3683:
3684: Gets a user's email information and returns it as a hash with keys:
3685: notification, critnotification, permanentemail
3686:
3687: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3688: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3689:
1.648 raeburn 3690:
1.542 raeburn 3691: =cut
3692:
1.648 raeburn 3693:
1.466 albertel 3694: sub getemails {
3695: my ($uname,$udom)=@_;
3696: if ($udom eq 'public' && $uname eq 'public') {
3697: return;
3698: }
1.467 www 3699: if (!$udom) { $udom=$env{'user.domain'}; }
3700: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3701: my $id=$uname.':'.$udom;
3702: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3703: if ($cached) {
3704: return %{$names};
3705: } else {
3706: my %loadnames=&Apache::lonnet::get('environment',
3707: ['notification','critnotification',
3708: 'permanentemail'],
3709: $udom,$uname);
3710: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3711: return %loadnames;
3712: }
3713: }
3714:
1.551 albertel 3715: sub flush_email_cache {
3716: my ($uname,$udom)=@_;
3717: if (!$udom) { $udom =$env{'user.domain'}; }
3718: if (!$uname) { $uname=$env{'user.name'}; }
3719: return if ($udom eq 'public' && $uname eq 'public');
3720: my $id=$uname.':'.$udom;
3721: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3722: }
3723:
1.728 raeburn 3724: # -------------------------------------------------------------------- getlangs
3725:
3726: =pod
3727:
3728: =item * &getlangs($uname,$udom)
3729:
3730: Gets a user's language preference and returns it as a hash with key:
3731: language.
3732:
3733: =cut
3734:
3735:
3736: sub getlangs {
3737: my ($uname,$udom) = @_;
3738: if (!$udom) { $udom =$env{'user.domain'}; }
3739: if (!$uname) { $uname=$env{'user.name'}; }
3740: my $id=$uname.':'.$udom;
3741: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3742: if ($cached) {
3743: return %{$langs};
3744: } else {
3745: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3746: $udom,$uname);
3747: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3748: return %loadlangs;
3749: }
3750: }
3751:
3752: sub flush_langs_cache {
3753: my ($uname,$udom)=@_;
3754: if (!$udom) { $udom =$env{'user.domain'}; }
3755: if (!$uname) { $uname=$env{'user.name'}; }
3756: return if ($udom eq 'public' && $uname eq 'public');
3757: my $id=$uname.':'.$udom;
3758: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3759: }
3760:
1.61 www 3761: # ------------------------------------------------------------------ Screenname
1.81 albertel 3762:
3763: =pod
3764:
1.648 raeburn 3765: =item * &screenname($uname,$udom)
1.81 albertel 3766:
3767: Gets a users screenname and returns it as a string
3768:
3769: =cut
1.61 www 3770:
3771: sub screenname {
3772: my ($uname,$udom)=@_;
1.258 albertel 3773: if ($uname eq $env{'user.name'} &&
3774: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3775: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3776: return $names{'screenname'};
1.62 www 3777: }
3778:
1.212 albertel 3779:
1.802 bisitz 3780: # ------------------------------------------------------------- Confirm Wrapper
3781: =pod
3782:
1.1075.2.42 raeburn 3783: =item * &confirmwrapper($message)
1.802 bisitz 3784:
3785: Wrap messages about completion of operation in box
3786:
3787: =cut
3788:
3789: sub confirmwrapper {
3790: my ($message)=@_;
3791: if ($message) {
3792: return "\n".'<div class="LC_confirm_box">'."\n"
3793: .$message."\n"
3794: .'</div>'."\n";
3795: } else {
3796: return $message;
3797: }
3798: }
3799:
1.62 www 3800: # ------------------------------------------------------------- Message Wrapper
3801:
3802: sub messagewrapper {
1.369 www 3803: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3804: return
1.441 albertel 3805: '<a href="/adm/email?compose=individual&'.
3806: 'recname='.$username.'&recdom='.$domain.
3807: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3808: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3809: }
1.802 bisitz 3810:
1.74 www 3811: # --------------------------------------------------------------- Notes Wrapper
3812:
3813: sub noteswrapper {
3814: my ($link,$un,$do)=@_;
3815: return
1.896 amueller 3816: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3817: }
1.802 bisitz 3818:
1.62 www 3819: # ------------------------------------------------------------- Aboutme Wrapper
3820:
3821: sub aboutmewrapper {
1.1070 raeburn 3822: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3823: if (!defined($username) && !defined($domain)) {
3824: return;
3825: }
1.1075.2.15 raeburn 3826: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3827: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3828: }
3829:
3830: # ------------------------------------------------------------ Syllabus Wrapper
3831:
3832: sub syllabuswrapper {
1.707 bisitz 3833: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3834: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3835: }
1.14 harris41 3836:
1.802 bisitz 3837: # -----------------------------------------------------------------------------
3838:
1.208 matthew 3839: sub track_student_link {
1.887 raeburn 3840: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3841: my $link ="/adm/trackstudent?";
1.208 matthew 3842: my $title = 'View recent activity';
3843: if (defined($sname) && $sname !~ /^\s*$/ &&
3844: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3845: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3846: $title .= ' of this student';
1.268 albertel 3847: }
1.208 matthew 3848: if (defined($target) && $target !~ /^\s*$/) {
3849: $target = qq{target="$target"};
3850: } else {
3851: $target = '';
3852: }
1.268 albertel 3853: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3854: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3855: $title = &mt($title);
3856: $linktext = &mt($linktext);
1.448 albertel 3857: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3858: &help_open_topic('View_recent_activity');
1.208 matthew 3859: }
3860:
1.781 raeburn 3861: sub slot_reservations_link {
3862: my ($linktext,$sname,$sdom,$target) = @_;
3863: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
3864: my $title = 'View slot reservation history';
3865: if (defined($sname) && $sname !~ /^\s*$/ &&
3866: defined($sdom) && $sdom !~ /^\s*$/) {
3867: $link .= "&uname=$sname&udom=$sdom";
3868: $title .= ' of this student';
3869: }
3870: if (defined($target) && $target !~ /^\s*$/) {
3871: $target = qq{target="$target"};
3872: } else {
3873: $target = '';
3874: }
3875: $title = &mt($title);
3876: $linktext = &mt($linktext);
3877: return qq{<a href="$link" title="$title" $target>$linktext</a>};
3878: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
3879:
3880: }
3881:
1.508 www 3882: # ===================================================== Display a student photo
3883:
3884:
1.509 albertel 3885: sub student_image_tag {
1.508 www 3886: my ($domain,$user)=@_;
3887: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
3888: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
3889: return '<img src="'.$imgsrc.'" align="right" />';
3890: } else {
3891: return '';
3892: }
3893: }
3894:
1.112 bowersj2 3895: =pod
3896:
3897: =back
3898:
3899: =head1 Access .tab File Data
3900:
3901: =over 4
3902:
1.648 raeburn 3903: =item * &languageids()
1.112 bowersj2 3904:
3905: returns list of all language ids
3906:
3907: =cut
3908:
1.14 harris41 3909: sub languageids {
1.16 harris41 3910: return sort(keys(%language));
1.14 harris41 3911: }
3912:
1.112 bowersj2 3913: =pod
3914:
1.648 raeburn 3915: =item * &languagedescription()
1.112 bowersj2 3916:
3917: returns description of a specified language id
3918:
3919: =cut
3920:
1.14 harris41 3921: sub languagedescription {
1.125 www 3922: my $code=shift;
3923: return ($supported_language{$code}?'* ':'').
3924: $language{$code}.
1.126 www 3925: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 3926: }
3927:
1.1048 foxr 3928: =pod
3929:
3930: =item * &plainlanguagedescription
3931:
3932: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
3933: and the language character encoding (e.g. ISO) separated by a ' - ' string.
3934:
3935: =cut
3936:
1.145 www 3937: sub plainlanguagedescription {
3938: my $code=shift;
3939: return $language{$code};
3940: }
3941:
1.1048 foxr 3942: =pod
3943:
3944: =item * &supportedlanguagecode
3945:
3946: Returns the supported language code (e.g. sptutf maps to pt) given a language
3947: code.
3948:
3949: =cut
3950:
1.145 www 3951: sub supportedlanguagecode {
3952: my $code=shift;
3953: return $supported_language{$code};
1.97 www 3954: }
3955:
1.112 bowersj2 3956: =pod
3957:
1.1048 foxr 3958: =item * &latexlanguage()
3959:
3960: Given a language key code returns the correspondnig language to use
3961: to select the correct hyphenation on LaTeX printouts. This is undef if there
3962: is no supported hyphenation for the language code.
3963:
3964: =cut
3965:
3966: sub latexlanguage {
3967: my $code = shift;
3968: return $latex_language{$code};
3969: }
3970:
3971: =pod
3972:
3973: =item * &latexhyphenation()
3974:
3975: Same as above but what's supplied is the language as it might be stored
3976: in the metadata.
3977:
3978: =cut
3979:
3980: sub latexhyphenation {
3981: my $key = shift;
3982: return $latex_language_bykey{$key};
3983: }
3984:
3985: =pod
3986:
1.648 raeburn 3987: =item * ©rightids()
1.112 bowersj2 3988:
3989: returns list of all copyrights
3990:
3991: =cut
3992:
3993: sub copyrightids {
3994: return sort(keys(%cprtag));
3995: }
3996:
3997: =pod
3998:
1.648 raeburn 3999: =item * ©rightdescription()
1.112 bowersj2 4000:
4001: returns description of a specified copyright id
4002:
4003: =cut
4004:
4005: sub copyrightdescription {
1.166 www 4006: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4007: }
1.197 matthew 4008:
4009: =pod
4010:
1.648 raeburn 4011: =item * &source_copyrightids()
1.192 taceyjo1 4012:
4013: returns list of all source copyrights
4014:
4015: =cut
4016:
4017: sub source_copyrightids {
4018: return sort(keys(%scprtag));
4019: }
4020:
4021: =pod
4022:
1.648 raeburn 4023: =item * &source_copyrightdescription()
1.192 taceyjo1 4024:
4025: returns description of a specified source copyright id
4026:
4027: =cut
4028:
4029: sub source_copyrightdescription {
4030: return &mt($scprtag{shift(@_)});
4031: }
1.112 bowersj2 4032:
4033: =pod
4034:
1.648 raeburn 4035: =item * &filecategories()
1.112 bowersj2 4036:
4037: returns list of all file categories
4038:
4039: =cut
4040:
4041: sub filecategories {
4042: return sort(keys(%category_extensions));
4043: }
4044:
4045: =pod
4046:
1.648 raeburn 4047: =item * &filecategorytypes()
1.112 bowersj2 4048:
4049: returns list of file types belonging to a given file
4050: category
4051:
4052: =cut
4053:
4054: sub filecategorytypes {
1.356 albertel 4055: my ($cat) = @_;
4056: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 4057: }
4058:
4059: =pod
4060:
1.648 raeburn 4061: =item * &fileembstyle()
1.112 bowersj2 4062:
4063: returns embedding style for a specified file type
4064:
4065: =cut
4066:
4067: sub fileembstyle {
4068: return $fe{lc(shift(@_))};
1.169 www 4069: }
4070:
1.351 www 4071: sub filemimetype {
4072: return $fm{lc(shift(@_))};
4073: }
4074:
1.169 www 4075:
4076: sub filecategoryselect {
4077: my ($name,$value)=@_;
1.189 matthew 4078: return &select_form($value,$name,
1.970 raeburn 4079: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4080: }
4081:
4082: =pod
4083:
1.648 raeburn 4084: =item * &filedescription()
1.112 bowersj2 4085:
4086: returns description for a specified file type
4087:
4088: =cut
4089:
4090: sub filedescription {
1.188 matthew 4091: my $file_description = $fd{lc(shift())};
4092: $file_description =~ s:([\[\]]):~$1:g;
4093: return &mt($file_description);
1.112 bowersj2 4094: }
4095:
4096: =pod
4097:
1.648 raeburn 4098: =item * &filedescriptionex()
1.112 bowersj2 4099:
4100: returns description for a specified file type with
4101: extra formatting
4102:
4103: =cut
4104:
4105: sub filedescriptionex {
4106: my $ex=shift;
1.188 matthew 4107: my $file_description = $fd{lc($ex)};
4108: $file_description =~ s:([\[\]]):~$1:g;
4109: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4110: }
4111:
4112: # End of .tab access
4113: =pod
4114:
4115: =back
4116:
4117: =cut
4118:
4119: # ------------------------------------------------------------------ File Types
4120: sub fileextensions {
4121: return sort(keys(%fe));
4122: }
4123:
1.97 www 4124: # ----------------------------------------------------------- Display Languages
4125: # returns a hash with all desired display languages
4126: #
4127:
4128: sub display_languages {
4129: my %languages=();
1.695 raeburn 4130: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4131: $languages{$lang}=1;
1.97 www 4132: }
4133: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4134: if ($env{'form.displaylanguage'}) {
1.356 albertel 4135: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4136: $languages{$lang}=1;
1.97 www 4137: }
4138: }
4139: return %languages;
1.14 harris41 4140: }
4141:
1.582 albertel 4142: sub languages {
4143: my ($possible_langs) = @_;
1.695 raeburn 4144: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4145: if (!ref($possible_langs)) {
4146: if( wantarray ) {
4147: return @preferred_langs;
4148: } else {
4149: return $preferred_langs[0];
4150: }
4151: }
4152: my %possibilities = map { $_ => 1 } (@$possible_langs);
4153: my @preferred_possibilities;
4154: foreach my $preferred_lang (@preferred_langs) {
4155: if (exists($possibilities{$preferred_lang})) {
4156: push(@preferred_possibilities, $preferred_lang);
4157: }
4158: }
4159: if( wantarray ) {
4160: return @preferred_possibilities;
4161: }
4162: return $preferred_possibilities[0];
4163: }
4164:
1.742 raeburn 4165: sub user_lang {
4166: my ($touname,$toudom,$fromcid) = @_;
4167: my @userlangs;
4168: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4169: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4170: $env{'course.'.$fromcid.'.languages'}));
4171: } else {
4172: my %langhash = &getlangs($touname,$toudom);
4173: if ($langhash{'languages'} ne '') {
4174: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4175: } else {
4176: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4177: if ($domdefs{'lang_def'} ne '') {
4178: @userlangs = ($domdefs{'lang_def'});
4179: }
4180: }
4181: }
4182: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4183: my $user_lh = Apache::localize->get_handle(@languages);
4184: return $user_lh;
4185: }
4186:
4187:
1.112 bowersj2 4188: ###############################################################
4189: ## Student Answer Attempts ##
4190: ###############################################################
4191:
4192: =pod
4193:
4194: =head1 Alternate Problem Views
4195:
4196: =over 4
4197:
1.648 raeburn 4198: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86 raeburn 4199: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4200:
4201: Return string with previous attempt on problem. Arguments:
4202:
4203: =over 4
4204:
4205: =item * $symb: Problem, including path
4206:
4207: =item * $username: username of the desired student
4208:
4209: =item * $domain: domain of the desired student
1.14 harris41 4210:
1.112 bowersj2 4211: =item * $course: Course ID
1.14 harris41 4212:
1.112 bowersj2 4213: =item * $getattempt: Leave blank for all attempts, otherwise put
4214: something
1.14 harris41 4215:
1.112 bowersj2 4216: =item * $regexp: if string matches this regexp, the string will be
4217: sent to $gradesub
1.14 harris41 4218:
1.112 bowersj2 4219: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4220:
1.1075.2.86 raeburn 4221: =item * $usec: section of the desired student
4222:
4223: =item * $identifier: counter for student (multiple students one problem) or
4224: problem (one student; whole sequence).
4225:
1.112 bowersj2 4226: =back
1.14 harris41 4227:
1.112 bowersj2 4228: The output string is a table containing all desired attempts, if any.
1.16 harris41 4229:
1.112 bowersj2 4230: =cut
1.1 albertel 4231:
4232: sub get_previous_attempt {
1.1075.2.86 raeburn 4233: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4234: my $prevattempts='';
1.43 ng 4235: no strict 'refs';
1.1 albertel 4236: if ($symb) {
1.3 albertel 4237: my (%returnhash)=
4238: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4239: if ($returnhash{'version'}) {
4240: my %lasthash=();
4241: my $version;
4242: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91 raeburn 4243: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4244: if ($key =~ /\.rawrndseed$/) {
4245: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4246: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4247: } else {
4248: $lasthash{$key}=$returnhash{$version.':'.$key};
4249: }
1.19 harris41 4250: }
1.1 albertel 4251: }
1.596 albertel 4252: $prevattempts=&start_data_table().&start_data_table_header_row();
4253: $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86 raeburn 4254: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4255: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4256: foreach my $key (sort(keys(%lasthash))) {
4257: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4258: if ($#parts > 0) {
1.31 albertel 4259: my $data=$parts[-1];
1.989 raeburn 4260: next if ($data eq 'foilorder');
1.31 albertel 4261: pop(@parts);
1.1010 www 4262: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4263: if ($data eq 'type') {
4264: unless ($showsurv) {
4265: my $id = join(',',@parts);
4266: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4267: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4268: $lasthidden{$ign.'.'.$id} = 1;
4269: }
1.945 raeburn 4270: }
1.1075.2.86 raeburn 4271: if ($identifier ne '') {
4272: my $id = join(',',@parts);
4273: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4274: $domain,$username,$usec,undef,$course) =~ /^no/) {
4275: $hidestatus{$ign.'.'.$id} = 1;
4276: }
4277: }
4278: } elsif ($data eq 'regrader') {
4279: if (($identifier ne '') && (@parts)) {
4280: my $id = join(',',@parts);
4281: $regraded{$ign.'.'.$id} = 1;
4282: }
1.1010 www 4283: }
1.31 albertel 4284: } else {
1.41 ng 4285: if ($#parts == 0) {
4286: $prevattempts.='<th>'.$parts[0].'</th>';
4287: } else {
4288: $prevattempts.='<th>'.$ign.'</th>';
4289: }
1.31 albertel 4290: }
1.16 harris41 4291: }
1.596 albertel 4292: $prevattempts.=&end_data_table_header_row();
1.40 ng 4293: if ($getattempt eq '') {
1.1075.2.86 raeburn 4294: my (%solved,%resets,%probstatus);
4295: if (($identifier ne '') && (keys(%regraded) > 0)) {
4296: for ($version=1;$version<=$returnhash{'version'};$version++) {
4297: foreach my $id (keys(%regraded)) {
4298: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4299: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4300: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4301: push(@{$resets{$id}},$version);
4302: }
4303: }
4304: }
4305: }
1.40 ng 4306: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86 raeburn 4307: my (@hidden,@unsolved);
1.945 raeburn 4308: if (%typeparts) {
4309: foreach my $id (keys(%typeparts)) {
1.1075.2.86 raeburn 4310: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4311: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4312: push(@hidden,$id);
1.1075.2.86 raeburn 4313: } elsif ($identifier ne '') {
4314: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4315: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4316: ($hidestatus{$id})) {
4317: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
4318: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4319: push(@{$solved{$id}},$version);
4320: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4321: (ref($solved{$id}) eq 'ARRAY')) {
4322: my $skip;
4323: if (ref($resets{$id}) eq 'ARRAY') {
4324: foreach my $reset (@{$resets{$id}}) {
4325: if ($reset > $solved{$id}[-1]) {
4326: $skip=1;
4327: last;
4328: }
4329: }
4330: }
4331: unless ($skip) {
4332: my ($ign,$partslist) = split(/\./,$id,2);
4333: push(@unsolved,$partslist);
4334: }
4335: }
4336: }
1.945 raeburn 4337: }
4338: }
4339: }
4340: $prevattempts.=&start_data_table_row().
1.1075.2.86 raeburn 4341: '<td>'.&mt('Transaction [_1]',$version);
4342: if (@unsolved) {
4343: $prevattempts .= '<span class="LC_nobreak"><label>'.
4344: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4345: &mt('Hide').'</label></span>';
4346: }
4347: $prevattempts .= '</td>';
1.945 raeburn 4348: if (@hidden) {
4349: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4350: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4351: my $hide;
4352: foreach my $id (@hidden) {
4353: if ($key =~ /^\Q$id\E/) {
4354: $hide = 1;
4355: last;
4356: }
4357: }
4358: if ($hide) {
4359: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4360: if (($data eq 'award') || ($data eq 'awarddetail')) {
4361: my $value = &format_previous_attempt_value($key,
4362: $returnhash{$version.':'.$key});
4363: $prevattempts.='<td>'.$value.' </td>';
4364: } else {
4365: $prevattempts.='<td> </td>';
4366: }
4367: } else {
4368: if ($key =~ /\./) {
1.1075.2.91 raeburn 4369: my $value = $returnhash{$version.':'.$key};
4370: if ($key =~ /\.rndseed$/) {
4371: my ($id) = ($key =~ /^(.+)\.rndseed$/);
4372: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4373: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4374: }
4375: }
4376: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4377: ' </td>';
1.945 raeburn 4378: } else {
4379: $prevattempts.='<td> </td>';
4380: }
4381: }
4382: }
4383: } else {
4384: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4385: next if ($key =~ /\.foilorder$/);
1.1075.2.91 raeburn 4386: my $value = $returnhash{$version.':'.$key};
4387: if ($key =~ /\.rndseed$/) {
4388: my ($id) = ($key =~ /^(.+)\.rndseed$/);
4389: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4390: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4391: }
4392: }
4393: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4394: ' </td>';
1.945 raeburn 4395: }
4396: }
4397: $prevattempts.=&end_data_table_row();
1.40 ng 4398: }
1.1 albertel 4399: }
1.945 raeburn 4400: my @currhidden = keys(%lasthidden);
1.596 albertel 4401: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4402: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4403: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4404: if (%typeparts) {
4405: my $hidden;
4406: foreach my $id (@currhidden) {
4407: if ($key =~ /^\Q$id\E/) {
4408: $hidden = 1;
4409: last;
4410: }
4411: }
4412: if ($hidden) {
4413: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4414: if (($data eq 'award') || ($data eq 'awarddetail')) {
4415: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4416: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4417: $value = &$gradesub($value);
4418: }
4419: $prevattempts.='<td>'.$value.' </td>';
4420: } else {
4421: $prevattempts.='<td> </td>';
4422: }
4423: } else {
4424: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4425: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4426: $value = &$gradesub($value);
4427: }
4428: $prevattempts.='<td>'.$value.' </td>';
4429: }
4430: } else {
4431: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4432: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4433: $value = &$gradesub($value);
4434: }
4435: $prevattempts.='<td>'.$value.' </td>';
4436: }
1.16 harris41 4437: }
1.596 albertel 4438: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4439: } else {
1.596 albertel 4440: $prevattempts=
4441: &start_data_table().&start_data_table_row().
4442: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
4443: &end_data_table_row().&end_data_table();
1.1 albertel 4444: }
4445: } else {
1.596 albertel 4446: $prevattempts=
4447: &start_data_table().&start_data_table_row().
4448: '<td>'.&mt('No data.').'</td>'.
4449: &end_data_table_row().&end_data_table();
1.1 albertel 4450: }
1.10 albertel 4451: }
4452:
1.581 albertel 4453: sub format_previous_attempt_value {
4454: my ($key,$value) = @_;
1.1011 www 4455: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581 albertel 4456: $value = &Apache::lonlocal::locallocaltime($value);
4457: } elsif (ref($value) eq 'ARRAY') {
4458: $value = '('.join(', ', @{ $value }).')';
1.988 raeburn 4459: } elsif ($key =~ /answerstring$/) {
4460: my %answers = &Apache::lonnet::str2hash($value);
4461: my @anskeys = sort(keys(%answers));
4462: if (@anskeys == 1) {
4463: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4464: if ($answer =~ m{\0}) {
4465: $answer =~ s{\0}{,}g;
1.988 raeburn 4466: }
4467: my $tag_internal_answer_name = 'INTERNAL';
4468: if ($anskeys[0] eq $tag_internal_answer_name) {
4469: $value = $answer;
4470: } else {
4471: $value = $anskeys[0].'='.$answer;
4472: }
4473: } else {
4474: foreach my $ans (@anskeys) {
4475: my $answer = $answers{$ans};
1.1001 raeburn 4476: if ($answer =~ m{\0}) {
4477: $answer =~ s{\0}{,}g;
1.988 raeburn 4478: }
4479: $value .= $ans.'='.$answer.'<br />';;
4480: }
4481: }
1.581 albertel 4482: } else {
4483: $value = &unescape($value);
4484: }
4485: return $value;
4486: }
4487:
4488:
1.107 albertel 4489: sub relative_to_absolute {
4490: my ($url,$output)=@_;
4491: my $parser=HTML::TokeParser->new(\$output);
4492: my $token;
4493: my $thisdir=$url;
4494: my @rlinks=();
4495: while ($token=$parser->get_token) {
4496: if ($token->[0] eq 'S') {
4497: if ($token->[1] eq 'a') {
4498: if ($token->[2]->{'href'}) {
4499: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4500: }
4501: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4502: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4503: } elsif ($token->[1] eq 'base') {
4504: $thisdir=$token->[2]->{'href'};
4505: }
4506: }
4507: }
4508: $thisdir=~s-/[^/]*$--;
1.356 albertel 4509: foreach my $link (@rlinks) {
1.726 raeburn 4510: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4511: ($link=~/^\//) ||
4512: ($link=~/^javascript:/i) ||
4513: ($link=~/^mailto:/i) ||
4514: ($link=~/^\#/)) {
4515: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4516: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4517: }
4518: }
4519: # -------------------------------------------------- Deal with Applet codebases
4520: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4521: return $output;
4522: }
4523:
1.112 bowersj2 4524: =pod
4525:
1.648 raeburn 4526: =item * &get_student_view()
1.112 bowersj2 4527:
4528: show a snapshot of what student was looking at
4529:
4530: =cut
4531:
1.10 albertel 4532: sub get_student_view {
1.186 albertel 4533: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4534: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4535: my (%form);
1.10 albertel 4536: my @elements=('symb','courseid','domain','username');
4537: foreach my $element (@elements) {
1.186 albertel 4538: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4539: }
1.186 albertel 4540: if (defined($moreenv)) {
4541: %form=(%form,%{$moreenv});
4542: }
1.236 albertel 4543: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4544: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4545: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4546: $userview=~s/\<body[^\>]*\>//gi;
4547: $userview=~s/\<\/body\>//gi;
4548: $userview=~s/\<html\>//gi;
4549: $userview=~s/\<\/html\>//gi;
4550: $userview=~s/\<head\>//gi;
4551: $userview=~s/\<\/head\>//gi;
4552: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4553: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4554: if (wantarray) {
4555: return ($userview,$response);
4556: } else {
4557: return $userview;
4558: }
4559: }
4560:
4561: sub get_student_view_with_retries {
4562: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4563:
4564: my $ok = 0; # True if we got a good response.
4565: my $content;
4566: my $response;
4567:
4568: # Try to get the student_view done. within the retries count:
4569:
4570: do {
4571: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4572: $ok = $response->is_success;
4573: if (!$ok) {
4574: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4575: }
4576: $retries--;
4577: } while (!$ok && ($retries > 0));
4578:
4579: if (!$ok) {
4580: $content = ''; # On error return an empty content.
4581: }
1.651 www 4582: if (wantarray) {
4583: return ($content, $response);
4584: } else {
4585: return $content;
4586: }
1.11 albertel 4587: }
4588:
1.1075.2.149 raeburn 4589: sub css_links {
4590: my ($currsymb,$level) = @_;
4591: my ($links,@symbs,%cssrefs,%httpref);
4592: if ($level eq 'map') {
4593: my $navmap = Apache::lonnavmaps::navmap->new();
4594: if (ref($navmap)) {
4595: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
4596: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
4597: foreach my $res (@resources) {
4598: if (ref($res) && $res->symb()) {
4599: push(@symbs,$res->symb());
4600: }
4601: }
4602: }
4603: } else {
4604: @symbs = ($currsymb);
4605: }
4606: foreach my $symb (@symbs) {
4607: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
4608: if ($css_href =~ /\S/) {
4609: unless ($css_href =~ m{https?://}) {
4610: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
4611: my $proburl = &Apache::lonnet::clutter($url);
4612: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
4613: unless ($css_href =~ m{^/}) {
4614: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
4615: }
4616: if ($css_href =~ m{^/(res|uploaded)/}) {
4617: unless (($httpref{'httpref.'.$css_href}) ||
4618: (&Apache::lonnet::is_on_map($css_href))) {
4619: my $thisurl = $proburl;
4620: if ($env{'httpref.'.$proburl}) {
4621: $thisurl = $env{'httpref.'.$proburl};
4622: }
4623: $httpref{'httpref.'.$css_href} = $thisurl;
4624: }
4625: }
4626: }
4627: $cssrefs{$css_href} = 1;
4628: }
4629: }
4630: if (keys(%httpref)) {
4631: &Apache::lonnet::appenv(\%httpref);
4632: }
4633: if (keys(%cssrefs)) {
4634: foreach my $css_href (keys(%cssrefs)) {
4635: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
4636: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
4637: }
4638: }
4639: return $links;
4640: }
4641:
1.112 bowersj2 4642: =pod
4643:
1.648 raeburn 4644: =item * &get_student_answers()
1.112 bowersj2 4645:
4646: show a snapshot of how student was answering problem
4647:
4648: =cut
4649:
1.11 albertel 4650: sub get_student_answers {
1.100 sakharuk 4651: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4652: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4653: my (%moreenv);
1.11 albertel 4654: my @elements=('symb','courseid','domain','username');
4655: foreach my $element (@elements) {
1.186 albertel 4656: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4657: }
1.186 albertel 4658: $moreenv{'grade_target'}='answer';
4659: %moreenv=(%form,%moreenv);
1.497 raeburn 4660: $feedurl = &Apache::lonnet::clutter($feedurl);
4661: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4662: return $userview;
1.1 albertel 4663: }
1.116 albertel 4664:
4665: =pod
4666:
4667: =item * &submlink()
4668:
1.242 albertel 4669: Inputs: $text $uname $udom $symb $target
1.116 albertel 4670:
4671: Returns: A link to grades.pm such as to see the SUBM view of a student
4672:
4673: =cut
4674:
4675: ###############################################
4676: sub submlink {
1.242 albertel 4677: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4678: if (!($uname && $udom)) {
4679: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4680: &Apache::lonnet::whichuser($symb);
1.116 albertel 4681: if (!$symb) { $symb=$cursymb; }
4682: }
1.254 matthew 4683: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4684: $symb=&escape($symb);
1.960 bisitz 4685: if ($target) { $target=" target=\"$target\""; }
4686: return
4687: '<a href="/adm/grades?command=submission'.
4688: '&symb='.$symb.
4689: '&student='.$uname.
4690: '&userdom='.$udom.'"'.
4691: $target.'>'.$text.'</a>';
1.242 albertel 4692: }
4693: ##############################################
4694:
4695: =pod
4696:
4697: =item * &pgrdlink()
4698:
4699: Inputs: $text $uname $udom $symb $target
4700:
4701: Returns: A link to grades.pm such as to see the PGRD view of a student
4702:
4703: =cut
4704:
4705: ###############################################
4706: sub pgrdlink {
4707: my $link=&submlink(@_);
4708: $link=~s/(&command=submission)/$1&showgrading=yes/;
4709: return $link;
4710: }
4711: ##############################################
4712:
4713: =pod
4714:
4715: =item * &pprmlink()
4716:
4717: Inputs: $text $uname $udom $symb $target
4718:
4719: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4720: student and a specific resource
1.242 albertel 4721:
4722: =cut
4723:
4724: ###############################################
4725: sub pprmlink {
4726: my ($text,$uname,$udom,$symb,$target)=@_;
4727: if (!($uname && $udom)) {
4728: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4729: &Apache::lonnet::whichuser($symb);
1.242 albertel 4730: if (!$symb) { $symb=$cursymb; }
4731: }
1.254 matthew 4732: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4733: $symb=&escape($symb);
1.242 albertel 4734: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4735: return '<a href="/adm/parmset?command=set&'.
4736: 'symb='.$symb.'&uname='.$uname.
4737: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4738: }
4739: ##############################################
1.37 matthew 4740:
1.112 bowersj2 4741: =pod
4742:
4743: =back
4744:
4745: =cut
4746:
1.37 matthew 4747: ###############################################
1.51 www 4748:
4749:
4750: sub timehash {
1.687 raeburn 4751: my ($thistime) = @_;
4752: my $timezone = &Apache::lonlocal::gettimezone();
4753: my $dt = DateTime->from_epoch(epoch => $thistime)
4754: ->set_time_zone($timezone);
4755: my $wday = $dt->day_of_week();
4756: if ($wday == 7) { $wday = 0; }
4757: return ( 'second' => $dt->second(),
4758: 'minute' => $dt->minute(),
4759: 'hour' => $dt->hour(),
4760: 'day' => $dt->day_of_month(),
4761: 'month' => $dt->month(),
4762: 'year' => $dt->year(),
4763: 'weekday' => $wday,
4764: 'dayyear' => $dt->day_of_year(),
4765: 'dlsav' => $dt->is_dst() );
1.51 www 4766: }
4767:
1.370 www 4768: sub utc_string {
4769: my ($date)=@_;
1.371 www 4770: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4771: }
4772:
1.51 www 4773: sub maketime {
4774: my %th=@_;
1.687 raeburn 4775: my ($epoch_time,$timezone,$dt);
4776: $timezone = &Apache::lonlocal::gettimezone();
4777: eval {
4778: $dt = DateTime->new( year => $th{'year'},
4779: month => $th{'month'},
4780: day => $th{'day'},
4781: hour => $th{'hour'},
4782: minute => $th{'minute'},
4783: second => $th{'second'},
4784: time_zone => $timezone,
4785: );
4786: };
4787: if (!$@) {
4788: $epoch_time = $dt->epoch;
4789: if ($epoch_time) {
4790: return $epoch_time;
4791: }
4792: }
1.51 www 4793: return POSIX::mktime(
4794: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4795: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4796: }
4797:
4798: #########################################
1.51 www 4799:
4800: sub findallcourses {
1.482 raeburn 4801: my ($roles,$uname,$udom) = @_;
1.355 albertel 4802: my %roles;
4803: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4804: my %courses;
1.51 www 4805: my $now=time;
1.482 raeburn 4806: if (!defined($uname)) {
4807: $uname = $env{'user.name'};
4808: }
4809: if (!defined($udom)) {
4810: $udom = $env{'user.domain'};
4811: }
4812: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4813: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4814: if (!%roles) {
4815: %roles = (
4816: cc => 1,
1.907 raeburn 4817: co => 1,
1.482 raeburn 4818: in => 1,
4819: ep => 1,
4820: ta => 1,
4821: cr => 1,
4822: st => 1,
4823: );
4824: }
4825: foreach my $entry (keys(%roleshash)) {
4826: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4827: if ($trole =~ /^cr/) {
4828: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4829: } else {
4830: next if (!exists($roles{$trole}));
4831: }
4832: if ($tend) {
4833: next if ($tend < $now);
4834: }
4835: if ($tstart) {
4836: next if ($tstart > $now);
4837: }
1.1058 raeburn 4838: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4839: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4840: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4841: if ($secpart eq '') {
4842: ($cnum,$role) = split(/_/,$cnumpart);
4843: $sec = 'none';
1.1058 raeburn 4844: $value .= $cnum.'/';
1.482 raeburn 4845: } else {
4846: $cnum = $cnumpart;
4847: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4848: $value .= $cnum.'/'.$sec;
4849: }
4850: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4851: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4852: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4853: }
4854: } else {
4855: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4856: }
1.482 raeburn 4857: }
4858: } else {
4859: foreach my $key (keys(%env)) {
1.483 albertel 4860: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4861: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4862: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4863: next if ($role eq 'ca' || $role eq 'aa');
4864: next if (%roles && !exists($roles{$role}));
4865: my ($starttime,$endtime)=split(/\./,$env{$key});
4866: my $active=1;
4867: if ($starttime) {
4868: if ($now<$starttime) { $active=0; }
4869: }
4870: if ($endtime) {
4871: if ($now>$endtime) { $active=0; }
4872: }
4873: if ($active) {
1.1058 raeburn 4874: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4875: if ($sec eq '') {
4876: $sec = 'none';
1.1058 raeburn 4877: } else {
4878: $value .= $sec;
4879: }
4880: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4881: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4882: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4883: }
4884: } else {
4885: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4886: }
1.474 raeburn 4887: }
4888: }
1.51 www 4889: }
4890: }
1.474 raeburn 4891: return %courses;
1.51 www 4892: }
1.37 matthew 4893:
1.54 www 4894: ###############################################
1.474 raeburn 4895:
4896: sub blockcheck {
1.1075.2.158 raeburn 4897: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490 raeburn 4898:
1.1075.2.161. .4(raebu 4899:22): unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
1.1075.2.158 raeburn 4900: my ($has_evb,$check_ipaccess);
4901: my $dom = $env{'user.domain'};
4902: if ($env{'request.course.id'}) {
4903: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4904: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4905: my $checkrole = "cm./$cdom/$cnum";
4906: my $sec = $env{'request.course.sec'};
4907: if ($sec ne '') {
4908: $checkrole .= "/$sec";
4909: }
4910: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
4911: ($env{'request.role'} !~ /^st/)) {
4912: $has_evb = 1;
4913: }
4914: unless ($has_evb) {
4915: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
4916: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
4917: if ($udom eq $cdom) {
4918: $check_ipaccess = 1;
4919: }
4920: }
4921: }
1.1075.2.161. .3(raebu 4922:22): } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
4923:22): ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
4924:22): my $checkrole;
4925:22): if ($env{'request.role.domain'} eq '') {
4926:22): $checkrole = "cm./$env{'user.domain'}/";
4927:22): } else {
4928:22): $checkrole = "cm./$env{'request.role.domain'}/";
4929:22): }
4930:22): if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
4931:22): $has_evb = 1;
4932:22): }
1.1075.2.158 raeburn 4933: }
4934: unless ($has_evb || $check_ipaccess) {
4935: my @machinedoms = &Apache::lonnet::current_machine_domains();
4936: if (($dom eq 'public') && ($activity eq 'port')) {
4937: $dom = $udom;
4938: }
4939: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
4940: $check_ipaccess = 1;
4941: } else {
4942: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
4943: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
4944: my $prim = &Apache::lonnet::domain($dom,'primary');
4945: my $intdom = &Apache::lonnet::internet_dom($prim);
4946: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
4947: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
4948: $check_ipaccess = 1;
4949: }
4950: }
4951: }
4952: }
4953: if ($check_ipaccess) {
4954: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
4955: unless (defined($cached)) {
4956: my %domconfig =
4957: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
4958: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
4959: }
4960: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
4961: foreach my $id (keys(%{$ipaccessref})) {
4962: if (ref($ipaccessref->{$id}) eq 'HASH') {
4963: my $range = $ipaccessref->{$id}->{'ip'};
4964: if ($range) {
4965: if (&Apache::lonnet::ip_match($clientip,$range)) {
4966: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
4967: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
4968: return ('','','',$id,$dom);
4969: last;
4970: }
4971: }
4972: }
4973: }
4974: }
4975: }
4976: }
4977: }
1.1075.2.161. .4(raebu 4978:22): if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
4979:22): return ();
4980:22): }
1.1075.2.158 raeburn 4981: }
1.1075.2.73 raeburn 4982: if (defined($udom) && defined($uname)) {
4983: # If uname and udom are for a course, check for blocks in the course.
4984: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
4985: my ($startblock,$endblock,$triggerblock) =
1.1075.2.147 raeburn 4986: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73 raeburn 4987: return ($startblock,$endblock,$triggerblock);
4988: }
4989: } else {
1.490 raeburn 4990: $udom = $env{'user.domain'};
4991: $uname = $env{'user.name'};
4992: }
4993:
1.502 raeburn 4994: my $startblock = 0;
4995: my $endblock = 0;
1.1062 raeburn 4996: my $triggerblock = '';
1.1075.2.160 raeburn 4997: my %live_courses;
4998: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
4999: %live_courses = &findallcourses(undef,$uname,$udom);
5000: }
1.474 raeburn 5001:
1.490 raeburn 5002: # If uname is for a user, and activity is course-specific, i.e.,
5003: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5004:
1.490 raeburn 5005: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.161. .1(raebu 5006:21): $activity eq 'groups' || $activity eq 'printout' ||
5007:21): $activity eq 'search' || $activity eq 'reinit' ||
5008:21): $activity eq 'alert') && ($env{'request.course.id'})) {
1.490 raeburn 5009: foreach my $key (keys(%live_courses)) {
5010: if ($key ne $env{'request.course.id'}) {
5011: delete($live_courses{$key});
5012: }
5013: }
5014: }
5015:
5016: my $otheruser = 0;
5017: my %own_courses;
5018: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5019: # Resource belongs to user other than current user.
5020: $otheruser = 1;
5021: # Gather courses for current user
5022: %own_courses =
5023: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5024: }
5025:
5026: # Gather active course roles - course coordinator, instructor,
5027: # exam proctor, ta, student, or custom role.
1.474 raeburn 5028:
5029: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5030: my ($cdom,$cnum);
5031: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5032: $cdom = $env{'course.'.$course.'.domain'};
5033: $cnum = $env{'course.'.$course.'.num'};
5034: } else {
1.490 raeburn 5035: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5036: }
5037: my $no_ownblock = 0;
5038: my $no_userblock = 0;
1.533 raeburn 5039: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5040: # Check if current user has 'evb' priv for this
5041: if (defined($own_courses{$course})) {
5042: foreach my $sec (keys(%{$own_courses{$course}})) {
5043: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5044: if ($sec ne 'none') {
5045: $checkrole .= '/'.$sec;
5046: }
5047: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5048: $no_ownblock = 1;
5049: last;
5050: }
5051: }
5052: }
5053: # if they have 'evb' priv and are currently not playing student
5054: next if (($no_ownblock) &&
5055: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5056: }
1.474 raeburn 5057: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5058: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5059: if ($sec ne 'none') {
1.482 raeburn 5060: $checkrole .= '/'.$sec;
1.474 raeburn 5061: }
1.490 raeburn 5062: if ($otheruser) {
5063: # Resource belongs to user other than current user.
5064: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5065: my (%allroles,%userroles);
5066: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5067: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5068: my ($trole,$tdom,$tnum,$tsec);
5069: if ($entry =~ /^cr/) {
5070: ($trole,$tdom,$tnum,$tsec) =
5071: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5072: } else {
5073: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5074: }
5075: my ($spec,$area,$trest);
5076: $area = '/'.$tdom.'/'.$tnum;
5077: $trest = $tnum;
5078: if ($tsec ne '') {
5079: $area .= '/'.$tsec;
5080: $trest .= '/'.$tsec;
5081: }
5082: $spec = $trole.'.'.$area;
5083: if ($trole =~ /^cr/) {
5084: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5085: $tdom,$spec,$trest,$area);
5086: } else {
5087: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5088: $tdom,$spec,$trest,$area);
5089: }
5090: }
1.1075.2.124 raeburn 5091: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5092: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5093: if ($1) {
5094: $no_userblock = 1;
5095: last;
5096: }
1.486 raeburn 5097: }
5098: }
1.490 raeburn 5099: } else {
5100: # Resource belongs to current user
5101: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5102: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5103: $no_ownblock = 1;
5104: last;
5105: }
1.474 raeburn 5106: }
5107: }
5108: # if they have the evb priv and are currently not playing student
1.482 raeburn 5109: next if (($no_ownblock) &&
1.491 albertel 5110: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5111: next if ($no_userblock);
1.474 raeburn 5112:
1.1075.2.128 raeburn 5113: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5114: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 5115:
1.1062 raeburn 5116: my ($start,$end,$trigger) =
1.1075.2.147 raeburn 5117: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5118: if (($start != 0) &&
5119: (($startblock == 0) || ($startblock > $start))) {
5120: $startblock = $start;
1.1062 raeburn 5121: if ($trigger ne '') {
5122: $triggerblock = $trigger;
5123: }
1.502 raeburn 5124: }
5125: if (($end != 0) &&
5126: (($endblock == 0) || ($endblock < $end))) {
5127: $endblock = $end;
1.1062 raeburn 5128: if ($trigger ne '') {
5129: $triggerblock = $trigger;
5130: }
1.502 raeburn 5131: }
1.490 raeburn 5132: }
1.1062 raeburn 5133: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5134: }
5135:
5136: sub get_blocks {
1.1075.2.147 raeburn 5137: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5138: my $startblock = 0;
5139: my $endblock = 0;
1.1062 raeburn 5140: my $triggerblock = '';
1.490 raeburn 5141: my $course = $cdom.'_'.$cnum;
5142: $setters->{$course} = {};
5143: $setters->{$course}{'staff'} = [];
5144: $setters->{$course}{'times'} = [];
1.1062 raeburn 5145: $setters->{$course}{'triggers'} = [];
5146: my (@blockers,%triggered);
5147: my $now = time;
5148: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5149: if ($activity eq 'docs') {
1.1075.2.148 raeburn 5150: my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147 raeburn 5151: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5152: $blocked = 1;
5153: $nosymbcache = 1;
1.1075.2.148 raeburn 5154: $noenccheck = 1;
1.1075.2.147 raeburn 5155: }
1.1075.2.148 raeburn 5156: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5157: foreach my $block (@blockers) {
5158: if ($block =~ /^firstaccess____(.+)$/) {
5159: my $item = $1;
5160: my $type = 'map';
5161: my $timersymb = $item;
5162: if ($item eq 'course') {
5163: $type = 'course';
5164: } elsif ($item =~ /___\d+___/) {
5165: $type = 'resource';
5166: } else {
5167: $timersymb = &Apache::lonnet::symbread($item);
5168: }
5169: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5170: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5171: $triggered{$block} = {
5172: start => $start,
5173: end => $end,
5174: type => $type,
5175: };
5176: }
5177: }
5178: } else {
5179: foreach my $block (keys(%commblocks)) {
5180: if ($block =~ m/^(\d+)____(\d+)$/) {
5181: my ($start,$end) = ($1,$2);
5182: if ($start <= time && $end >= time) {
5183: if (ref($commblocks{$block}) eq 'HASH') {
5184: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5185: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5186: unless(grep(/^\Q$block\E$/,@blockers)) {
5187: push(@blockers,$block);
5188: }
5189: }
5190: }
5191: }
5192: }
5193: } elsif ($block =~ /^firstaccess____(.+)$/) {
5194: my $item = $1;
5195: my $timersymb = $item;
5196: my $type = 'map';
5197: if ($item eq 'course') {
5198: $type = 'course';
5199: } elsif ($item =~ /___\d+___/) {
5200: $type = 'resource';
5201: } else {
5202: $timersymb = &Apache::lonnet::symbread($item);
5203: }
5204: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5205: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5206: if ($start && $end) {
5207: if (($start <= time) && ($end >= time)) {
1.1075.2.158 raeburn 5208: if (ref($commblocks{$block}) eq 'HASH') {
5209: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5210: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5211: unless(grep(/^\Q$block\E$/,@blockers)) {
5212: push(@blockers,$block);
5213: $triggered{$block} = {
5214: start => $start,
5215: end => $end,
5216: type => $type,
5217: };
5218: }
5219: }
5220: }
1.1062 raeburn 5221: }
5222: }
1.490 raeburn 5223: }
1.1062 raeburn 5224: }
5225: }
5226: }
5227: foreach my $blocker (@blockers) {
5228: my ($staff_name,$staff_dom,$title,$blocks) =
5229: &parse_block_record($commblocks{$blocker});
5230: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5231: my ($start,$end,$triggertype);
5232: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5233: ($start,$end) = ($1,$2);
5234: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5235: $start = $triggered{$blocker}{'start'};
5236: $end = $triggered{$blocker}{'end'};
5237: $triggertype = $triggered{$blocker}{'type'};
5238: }
5239: if ($start) {
5240: push(@{$$setters{$course}{'times'}}, [$start,$end]);
5241: if ($triggertype) {
5242: push(@{$$setters{$course}{'triggers'}},$triggertype);
5243: } else {
5244: push(@{$$setters{$course}{'triggers'}},0);
5245: }
5246: if ( ($startblock == 0) || ($startblock > $start) ) {
5247: $startblock = $start;
5248: if ($triggertype) {
5249: $triggerblock = $blocker;
1.474 raeburn 5250: }
5251: }
1.1062 raeburn 5252: if ( ($endblock == 0) || ($endblock < $end) ) {
5253: $endblock = $end;
5254: if ($triggertype) {
5255: $triggerblock = $blocker;
5256: }
5257: }
1.474 raeburn 5258: }
5259: }
1.1062 raeburn 5260: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5261: }
5262:
5263: sub parse_block_record {
5264: my ($record) = @_;
5265: my ($setuname,$setudom,$title,$blocks);
5266: if (ref($record) eq 'HASH') {
5267: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5268: $title = &unescape($record->{'event'});
5269: $blocks = $record->{'blocks'};
5270: } else {
5271: my @data = split(/:/,$record,3);
5272: if (scalar(@data) eq 2) {
5273: $title = $data[1];
5274: ($setuname,$setudom) = split(/@/,$data[0]);
5275: } else {
5276: ($setuname,$setudom,$title) = @data;
5277: }
5278: $blocks = { 'com' => 'on' };
5279: }
5280: return ($setuname,$setudom,$title,$blocks);
5281: }
5282:
1.854 kalberla 5283: sub blocking_status {
1.1075.2.158 raeburn 5284: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 5285: my %setters;
1.890 droeschl 5286:
1.1061 raeburn 5287: # check for active blocking
1.1075.2.158 raeburn 5288: if ($clientip eq '') {
5289: $clientip = &Apache::lonnet::get_requestor_ip();
5290: }
5291: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
5292: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 5293: my $blocked = 0;
1.1075.2.158 raeburn 5294: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 5295: $blocked = 1;
5296: }
1.890 droeschl 5297:
1.1061 raeburn 5298: # caller just wants to know whether a block is active
5299: if (!wantarray) { return $blocked; }
5300:
5301: # build a link to a popup window containing the details
5302: my $querystring = "?activity=$activity";
1.1075.2.158 raeburn 5303: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
5304: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1075.2.97 raeburn 5305: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5306: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5307: } elsif ($activity eq 'docs') {
1.1075.2.147 raeburn 5308: my $showurl = &Apache::lonenc::check_encrypt($url);
5309: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
5310: if ($symb) {
5311: my $showsymb = &Apache::lonenc::check_encrypt($symb);
5312: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
5313: }
1.1062 raeburn 5314: }
1.1061 raeburn 5315:
5316: my $output .= <<'END_MYBLOCK';
5317: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5318: var options = "width=" + w + ",height=" + h + ",";
5319: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5320: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5321: var newWin = window.open(url, wdwName, options);
5322: newWin.focus();
5323: }
1.890 droeschl 5324: END_MYBLOCK
1.854 kalberla 5325:
1.1061 raeburn 5326: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5327:
1.1061 raeburn 5328: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5329: my $text = &mt('Communication Blocked');
1.1075.2.93 raeburn 5330: my $class = 'LC_comblock';
1.1062 raeburn 5331: if ($activity eq 'docs') {
5332: $text = &mt('Content Access Blocked');
1.1075.2.93 raeburn 5333: $class = '';
1.1063 raeburn 5334: } elsif ($activity eq 'printout') {
5335: $text = &mt('Printing Blocked');
1.1075.2.97 raeburn 5336: } elsif ($activity eq 'passwd') {
5337: $text = &mt('Password Changing Blocked');
1.1075.2.158 raeburn 5338: } elsif ($activity eq 'grades') {
5339: $text = &mt('Gradebook Blocked');
5340: } elsif ($activity eq 'search') {
5341: $text = &mt('Search Blocked');
1.1075.2.161. .1(raebu 5342:21): } elsif ($activity eq 'alert') {
5343:21): $text = &mt('Checking Critical Messages Blocked');
5344:21): } elsif ($activity eq 'reinit') {
5345:21): $text = &mt('Checking Course Update Blocked');
1.1075.2.158 raeburn 5346: } elsif ($activity eq 'about') {
5347: $text = &mt('Access to User Information Pages Blocked');
1.1075.2.160 raeburn 5348: } elsif ($activity eq 'wishlist') {
5349: $text = &mt('Access to Stored Links Blocked');
5350: } elsif ($activity eq 'annotate') {
5351: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 5352: }
1.1061 raeburn 5353: $output .= <<"END_BLOCK";
1.1075.2.93 raeburn 5354: <div class='$class'>
1.869 kalberla 5355: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5356: title='$text'>
5357: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5358: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5359: title='$text'>$text</a>
1.867 kalberla 5360: </div>
5361:
5362: END_BLOCK
1.474 raeburn 5363:
1.1061 raeburn 5364: return ($blocked, $output);
1.854 kalberla 5365: }
1.490 raeburn 5366:
1.60 matthew 5367: ###############################################
5368:
1.682 raeburn 5369: sub check_ip_acc {
1.1075.2.105 raeburn 5370: my ($acc,$clientip)=@_;
1.682 raeburn 5371: &Apache::lonxml::debug("acc is $acc");
5372: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5373: return 1;
5374: }
5375: my $allowed=0;
1.1075.2.144 raeburn 5376: my $ip;
5377: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5378: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5379: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5380: } else {
1.1075.2.150 raeburn 5381: my $remote_ip = &Apache::lonnet::get_requestor_ip();
5382: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144 raeburn 5383: }
1.682 raeburn 5384:
5385: my $name;
1.1075.2.161. .1(raebu 5386:21): my %access = (
5387:21): allowfrom => 1,
5388:21): denyfrom => 0,
5389:21): );
5390:21): my @allows;
5391:21): my @denies;
5392:21): foreach my $item (split(',',$acc)) {
5393:21): $item =~ s/^\s*//;
5394:21): $item =~ s/\s*$//;
5395:21): if ($item =~ /^\!(.+)$/) {
5396:21): push(@denies,$1);
5397:21): } else {
5398:21): push(@allows,$item);
5399:21): }
5400:21): }
5401:21): my $numdenies = scalar(@denies);
5402:21): my $numallows = scalar(@allows);
5403:21): my $count = 0;
5404:21): foreach my $pattern (@denies,@allows) {
5405:21): $count ++;
5406:21): my $acctype = 'allowfrom';
5407:21): if ($count <= $numdenies) {
5408:21): $acctype = 'denyfrom';
5409:21): }
1.682 raeburn 5410: if ($pattern =~ /\*$/) {
5411: #35.8.*
5412: $pattern=~s/\*//;
1.1075.2.161. .1(raebu 5413:21): if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5414: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5415: #35.8.3.[34-56]
5416: my $low=$2;
5417: my $high=$3;
5418: $pattern=$1;
5419: if ($ip =~ /^\Q$pattern\E/) {
5420: my $last=(split(/\./,$ip))[3];
1.1075.2.161. .1(raebu 5421:21): if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 5422: }
5423: } elsif ($pattern =~ /^\*/) {
5424: #*.msu.edu
5425: $pattern=~s/\*//;
5426: if (!defined($name)) {
5427: use Socket;
5428: my $netaddr=inet_aton($ip);
5429: ($name)=gethostbyaddr($netaddr,AF_INET);
5430: }
1.1075.2.161. .1(raebu 5431:21): if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 5432: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5433: #127.0.0.1
1.1075.2.161. .1(raebu 5434:21): if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5435: } else {
5436: #some.name.com
5437: if (!defined($name)) {
5438: use Socket;
5439: my $netaddr=inet_aton($ip);
5440: ($name)=gethostbyaddr($netaddr,AF_INET);
5441: }
1.1075.2.161. .1(raebu 5442:21): if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
5443:21): }
5444:21): if ($allowed =~ /^(0|1)$/) { last; }
5445:21): }
5446:21): if ($allowed eq '') {
5447:21): if ($numdenies && !$numallows) {
5448:21): $allowed = 1;
5449:21): } else {
5450:21): $allowed = 0;
1.682 raeburn 5451: }
5452: }
5453: return $allowed;
5454: }
5455:
5456: ###############################################
5457:
1.60 matthew 5458: =pod
5459:
1.112 bowersj2 5460: =head1 Domain Template Functions
5461:
5462: =over 4
5463:
5464: =item * &determinedomain()
1.60 matthew 5465:
5466: Inputs: $domain (usually will be undef)
5467:
1.63 www 5468: Returns: Determines which domain should be used for designs
1.60 matthew 5469:
5470: =cut
1.54 www 5471:
1.60 matthew 5472: ###############################################
1.63 www 5473: sub determinedomain {
5474: my $domain=shift;
1.531 albertel 5475: if (! $domain) {
1.60 matthew 5476: # Determine domain if we have not been given one
1.893 raeburn 5477: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5478: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5479: if ($env{'request.role.domain'}) {
5480: $domain=$env{'request.role.domain'};
1.60 matthew 5481: }
5482: }
1.63 www 5483: return $domain;
5484: }
5485: ###############################################
1.517 raeburn 5486:
1.518 albertel 5487: sub devalidate_domconfig_cache {
5488: my ($udom)=@_;
5489: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5490: }
5491:
5492: # ---------------------- Get domain configuration for a domain
5493: sub get_domainconf {
5494: my ($udom) = @_;
5495: my $cachetime=1800;
5496: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5497: if (defined($cached)) { return %{$result}; }
5498:
5499: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5500: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5501: my (%designhash,%legacy);
1.518 albertel 5502: if (keys(%domconfig) > 0) {
5503: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5504: if (keys(%{$domconfig{'login'}})) {
5505: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5506: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87 raeburn 5507: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5508: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5509: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5510: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5511: if ($key eq 'loginvia') {
5512: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5513: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5514: $designhash{$udom.'.login.loginvia'} = $server;
5515: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5516: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5517: } else {
5518: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5519: }
1.948 raeburn 5520: }
1.1075.2.87 raeburn 5521: } elsif ($key eq 'headtag') {
5522: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5523: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5524: }
1.946 raeburn 5525: }
1.1075.2.87 raeburn 5526: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5527: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5528: }
1.946 raeburn 5529: }
5530: }
5531: }
1.1075.2.158 raeburn 5532: } elsif ($key eq 'saml') {
5533: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5534: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
5535: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
5536: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
5537: foreach my $item ('text','img','alt','url','title','notsso') {
5538: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
5539: }
5540: }
5541: }
5542: }
1.946 raeburn 5543: } else {
5544: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5545: $designhash{$udom.'.login.'.$key.'_'.$img} =
5546: $domconfig{'login'}{$key}{$img};
5547: }
1.699 raeburn 5548: }
5549: } else {
5550: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5551: }
1.632 raeburn 5552: }
5553: } else {
5554: $legacy{'login'} = 1;
1.518 albertel 5555: }
1.632 raeburn 5556: } else {
5557: $legacy{'login'} = 1;
1.518 albertel 5558: }
5559: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5560: if (keys(%{$domconfig{'rolecolors'}})) {
5561: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5562: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5563: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5564: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5565: }
1.518 albertel 5566: }
5567: }
1.632 raeburn 5568: } else {
5569: $legacy{'rolecolors'} = 1;
1.518 albertel 5570: }
1.632 raeburn 5571: } else {
5572: $legacy{'rolecolors'} = 1;
1.518 albertel 5573: }
1.948 raeburn 5574: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5575: if ($domconfig{'autoenroll'}{'co-owners'}) {
5576: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5577: }
5578: }
1.632 raeburn 5579: if (keys(%legacy) > 0) {
5580: my %legacyhash = &get_legacy_domconf($udom);
5581: foreach my $item (keys(%legacyhash)) {
5582: if ($item =~ /^\Q$udom\E\.login/) {
5583: if ($legacy{'login'}) {
5584: $designhash{$item} = $legacyhash{$item};
5585: }
5586: } else {
5587: if ($legacy{'rolecolors'}) {
5588: $designhash{$item} = $legacyhash{$item};
5589: }
1.518 albertel 5590: }
5591: }
5592: }
1.632 raeburn 5593: } else {
5594: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5595: }
5596: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5597: $cachetime);
5598: return %designhash;
5599: }
5600:
1.632 raeburn 5601: sub get_legacy_domconf {
5602: my ($udom) = @_;
5603: my %legacyhash;
5604: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5605: my $designfile = $designdir.'/'.$udom.'.tab';
5606: if (-e $designfile) {
1.1075.2.128 raeburn 5607: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 5608: while (my $line = <$fh>) {
5609: next if ($line =~ /^\#/);
5610: chomp($line);
5611: my ($key,$val)=(split(/\=/,$line));
5612: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5613: }
5614: close($fh);
5615: }
5616: }
1.1026 raeburn 5617: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5618: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5619: }
5620: return %legacyhash;
5621: }
5622:
1.63 www 5623: =pod
5624:
1.112 bowersj2 5625: =item * &domainlogo()
1.63 www 5626:
5627: Inputs: $domain (usually will be undef)
5628:
5629: Returns: A link to a domain logo, if the domain logo exists.
5630: If the domain logo does not exist, a description of the domain.
5631:
5632: =cut
1.112 bowersj2 5633:
1.63 www 5634: ###############################################
5635: sub domainlogo {
1.517 raeburn 5636: my $domain = &determinedomain(shift);
1.518 albertel 5637: my %designhash = &get_domainconf($domain);
1.517 raeburn 5638: # See if there is a logo
5639: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5640: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5641: if ($imgsrc =~ m{^/(adm|res)/}) {
5642: if ($imgsrc =~ m{^/res/}) {
5643: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5644: &Apache::lonnet::repcopy($local_name);
5645: }
5646: $imgsrc = &lonhttpdurl($imgsrc);
1.1075.2.161. .2(raebu 5647:22): }
5648:22): my $alttext = $domain;
5649:22): if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
5650:22): $alttext = $designhash{$domain.'.login.alttext_domlogo'};
5651:22): }
5652:22): return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 5653: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5654: return &Apache::lonnet::domain($domain,'description');
1.59 www 5655: } else {
1.60 matthew 5656: return '';
1.59 www 5657: }
5658: }
1.63 www 5659: ##############################################
5660:
5661: =pod
5662:
1.112 bowersj2 5663: =item * &designparm()
1.63 www 5664:
5665: Inputs: $which parameter; $domain (usually will be undef)
5666:
5667: Returns: value of designparamter $which
5668:
5669: =cut
1.112 bowersj2 5670:
1.397 albertel 5671:
1.400 albertel 5672: ##############################################
1.397 albertel 5673: sub designparm {
5674: my ($which,$domain)=@_;
5675: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5676: return $env{'environment.color.'.$which};
1.96 www 5677: }
1.63 www 5678: $domain=&determinedomain($domain);
1.1016 raeburn 5679: my %domdesign;
5680: unless ($domain eq 'public') {
5681: %domdesign = &get_domainconf($domain);
5682: }
1.520 raeburn 5683: my $output;
1.517 raeburn 5684: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5685: $output = $domdesign{$domain.'.'.$which};
1.63 www 5686: } else {
1.520 raeburn 5687: $output = $defaultdesign{$which};
5688: }
5689: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5690: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5691: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5692: if ($output =~ m{^/res/}) {
5693: my $local_name = &Apache::lonnet::filelocation('',$output);
5694: &Apache::lonnet::repcopy($local_name);
5695: }
1.520 raeburn 5696: $output = &lonhttpdurl($output);
5697: }
1.63 www 5698: }
1.520 raeburn 5699: return $output;
1.63 www 5700: }
1.59 www 5701:
1.822 bisitz 5702: ##############################################
5703: =pod
5704:
1.832 bisitz 5705: =item * &authorspace()
5706:
1.1028 raeburn 5707: Inputs: $url (usually will be undef).
1.832 bisitz 5708:
1.1075.2.40 raeburn 5709: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5710: directory being viewed (or for which action is being taken).
5711: If $url is provided, and begins /priv/<domain>/<uname>
5712: the path will be that portion of the $context argument.
5713: Otherwise the path will be for the author space of the current
5714: user when the current role is author, or for that of the
5715: co-author/assistant co-author space when the current role
5716: is co-author or assistant co-author.
1.832 bisitz 5717:
5718: =cut
5719:
5720: sub authorspace {
1.1028 raeburn 5721: my ($url) = @_;
5722: if ($url ne '') {
5723: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5724: return $1;
5725: }
5726: }
1.832 bisitz 5727: my $caname = '';
1.1024 www 5728: my $cadom = '';
1.1028 raeburn 5729: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5730: ($cadom,$caname) =
1.832 bisitz 5731: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5732: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5733: $caname = $env{'user.name'};
1.1024 www 5734: $cadom = $env{'user.domain'};
1.832 bisitz 5735: }
1.1028 raeburn 5736: if (($caname ne '') && ($cadom ne '')) {
5737: return "/priv/$cadom/$caname/";
5738: }
5739: return;
1.832 bisitz 5740: }
5741:
5742: ##############################################
5743: =pod
5744:
1.822 bisitz 5745: =item * &head_subbox()
5746:
5747: Inputs: $content (contains HTML code with page functions, etc.)
5748:
5749: Returns: HTML div with $content
5750: To be included in page header
5751:
5752: =cut
5753:
5754: sub head_subbox {
5755: my ($content)=@_;
5756: my $output =
1.993 raeburn 5757: '<div class="LC_head_subbox">'
1.822 bisitz 5758: .$content
5759: .'</div>'
5760: }
5761:
5762: ##############################################
5763: =pod
5764:
5765: =item * &CSTR_pageheader()
5766:
1.1026 raeburn 5767: Input: (optional) filename from which breadcrumb trail is built.
5768: In most cases no input as needed, as $env{'request.filename'}
5769: is appropriate for use in building the breadcrumb trail.
1.1075.2.161. .6(raebu 5770:22): frameset flag
5771:22): If page header is being requested for use in a frameset, then
5772:22): the second (option) argument -- frameset will be true, and
5773:22): the target attribute set for links should be target="_parent".
1.822 bisitz 5774:
5775: Returns: HTML div with CSTR path and recent box
1.1075.2.40 raeburn 5776: To be included on Authoring Space pages
1.822 bisitz 5777:
5778: =cut
5779:
5780: sub CSTR_pageheader {
1.1075.2.161. .6(raebu 5781:22): my ($trailfile,$frameset) = @_;
1.1026 raeburn 5782: if ($trailfile eq '') {
5783: $trailfile = $env{'request.filename'};
5784: }
5785:
5786: # this is for resources; directories have customtitle, and crumbs
5787: # and select recent are created in lonpubdir.pm
5788:
5789: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5790: my ($udom,$uname,$thisdisfn)=
1.1075.2.29 raeburn 5791: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5792: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5793: $formaction =~ s{/+}{/}g;
1.822 bisitz 5794:
5795: my $parentpath = '';
5796: my $lastitem = '';
5797: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5798: $parentpath = $1;
5799: $lastitem = $2;
5800: } else {
5801: $lastitem = $thisdisfn;
5802: }
1.921 bisitz 5803:
1.1075.2.161. .6(raebu 5804:22): my ($target,$crumbtarget) = (' target="_top"','_top');
5805:22): if ($frameset) {
5806:22): $target = ' target="_parent"';
5807:22): $crumbtarget = '_parent';
5808:22): } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
5809:22): $target = ' target="'.$env{'request.deeplink.target'}.'"';
5810:22): $crumbtarget = $env{'request.deeplink.target'};
5811:22): }
5812:22):
1.921 bisitz 5813: my $output =
1.822 bisitz 5814: '<div>'
5815: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40 raeburn 5816: .'<b>'.&mt('Authoring Space:').'</b> '
1.1075.2.161. .6(raebu 5817:22): .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
5818:22): .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 5819:
5820: if ($lastitem) {
5821: $output .=
5822: '<span class="LC_filename">'
5823: .$lastitem
5824: .'</span>';
5825: }
5826: $output .=
5827: '<br />'
1.1075.2.161. .6(raebu 5828:22): #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.822 bisitz 5829: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5830: .'</form>'
1.1075.2.161. .6(raebu 5831:22): .&Apache::lonmenu::constspaceform($frameset)
1.822 bisitz 5832: .'</div>';
1.921 bisitz 5833:
5834: return $output;
1.822 bisitz 5835: }
5836:
1.60 matthew 5837: ###############################################
5838: ###############################################
5839:
5840: =pod
5841:
1.112 bowersj2 5842: =back
5843:
1.549 albertel 5844: =head1 HTML Helpers
1.112 bowersj2 5845:
5846: =over 4
5847:
5848: =item * &bodytag()
1.60 matthew 5849:
5850: Returns a uniform header for LON-CAPA web pages.
5851:
5852: Inputs:
5853:
1.112 bowersj2 5854: =over 4
5855:
5856: =item * $title, A title to be displayed on the page.
5857:
5858: =item * $function, the current role (can be undef).
5859:
5860: =item * $addentries, extra parameters for the <body> tag.
5861:
5862: =item * $bodyonly, if defined, only return the <body> tag.
5863:
5864: =item * $domain, if defined, force a given domain.
5865:
5866: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5867: text interface only)
1.60 matthew 5868:
1.814 bisitz 5869: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5870: navigational links
1.317 albertel 5871:
1.338 albertel 5872: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5873:
1.1075.2.12 raeburn 5874: =item * $no_inline_link, if true and in remote mode, don't show the
5875: 'Switch To Inline Menu' link
5876:
1.460 albertel 5877: =item * $args, optional argument valid values are
5878: no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133 raeburn 5879: use_absolute -> for external resource or syllabus, this will
5880: contain https://<hostname> if server uses
5881: https (as per hosts.tab), but request is for http
5882: hostname -> hostname, from $r->hostname().
1.460 albertel 5883:
1.1075.2.15 raeburn 5884: =item * $advtoolsref, optional argument, ref to an array containing
5885: inlineremote items to be added in "Functions" menu below
5886: breadcrumbs.
5887:
1.1075.2.161. .1(raebu 5888:21): =item * $ltiscope, optional argument, will be one of: resource, map or
5889:21): course, if LON-CAPA is in LTI Provider context. Value is
5890:21): the scope of use, i.e., launch was for access to a single, a map
5891:21): or the entire course.
5892:21):
5893:21): =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
5894:21): context, this will contain the URL for the landing item in
5895:21): the course, after launch from an LTI Consumer
5896:21):
5897:21): =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
5898:21): context, this will contain a reference to hash of items
5899:21): to be included in the page header and/or inline menu.
5900:21):
1.112 bowersj2 5901: =back
5902:
1.60 matthew 5903: Returns: A uniform header for LON-CAPA web pages.
5904: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5905: If $bodyonly is undef or zero, an html string containing a <body> tag and
5906: other decorations will be returned.
5907:
5908: =cut
5909:
1.54 www 5910: sub bodytag {
1.831 bisitz 5911: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.161. .1(raebu 5912:21): $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref,
5913:21): $ltiscope,$ltiuri,$ltimenu,$menucoll,$menuref)=@_;
1.339 albertel 5914:
1.954 raeburn 5915: my $public;
5916: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5917: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5918: $public = 1;
5919: }
1.460 albertel 5920: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52 raeburn 5921: my $httphost = $args->{'use_absolute'};
1.1075.2.133 raeburn 5922: my $hostname = $args->{'hostname'};
1.339 albertel 5923:
1.183 matthew 5924: $function = &get_users_function() if (!$function);
1.339 albertel 5925: my $img = &designparm($function.'.img',$domain);
5926: my $font = &designparm($function.'.font',$domain);
5927: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5928:
1.803 bisitz 5929: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5930: 'bgcolor' => $pgbg,
1.339 albertel 5931: 'text' => $font,
5932: 'alink' => &designparm($function.'.alink',$domain),
5933: 'vlink' => &designparm($function.'.vlink',$domain),
5934: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5935: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5936:
1.63 www 5937: # role and realm
1.1075.2.68 raeburn 5938: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5939: if ($realm) {
5940: $realm = '/'.$realm;
5941: }
1.1075.2.159 raeburn 5942: if ($role eq 'ca') {
1.479 albertel 5943: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5944: $realm = &plainname($rname,$rdom);
1.378 raeburn 5945: }
1.55 www 5946: # realm
1.1075.2.158 raeburn 5947: my ($cid,$sec);
1.258 albertel 5948: if ($env{'request.course.id'}) {
1.1075.2.158 raeburn 5949: $cid = $env{'request.course.id'};
5950: if ($env{'request.course.sec'}) {
5951: $sec = $env{'request.course.sec'};
5952: }
5953: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
5954: if (&Apache::lonnet::is_course($1,$2)) {
5955: $cid = $1.'_'.$2;
5956: $sec = $3;
5957: }
5958: }
5959: if ($cid) {
1.378 raeburn 5960: if ($env{'request.role'} !~ /^cr/) {
5961: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115 raeburn 5962: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121 raeburn 5963: if ($env{'request.role.desc'}) {
5964: $role = $env{'request.role.desc'};
5965: } else {
5966: $role = &mt('Helpdesk[_1]',' '.$2);
5967: }
1.1075.2.115 raeburn 5968: } else {
5969: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 5970: }
1.1075.2.158 raeburn 5971: if ($sec) {
5972: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 5973: }
1.1075.2.158 raeburn 5974: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 5975: } else {
5976: $role = &Apache::lonnet::plaintext($role);
1.54 www 5977: }
1.433 albertel 5978:
1.359 albertel 5979: if (!$realm) { $realm=' '; }
1.330 albertel 5980:
1.438 albertel 5981: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5982:
1.101 www 5983: # construct main body tag
1.359 albertel 5984: my $bodytag = "<body $extra_body_attr>".
1.1075.2.100 raeburn 5985: &Apache::lontexconvert::init_math_support();
1.252 albertel 5986:
1.1075.2.38 raeburn 5987: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5988:
5989: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5990: return $bodytag;
1.1075.2.38 raeburn 5991: }
1.359 albertel 5992:
1.954 raeburn 5993: if ($public) {
1.433 albertel 5994: undef($role);
5995: }
1.1075.2.158 raeburn 5996:
1.1075.2.161. .1(raebu 5997:21): my $showcrstitle = 1;
5998:21): if (($cid) && ($env{'request.lti.login'})) {
5999:21): if (ref($ltimenu) eq 'HASH') {
6000:21): unless ($ltimenu->{'role'}) {
6001:21): undef($role);
6002:21): }
6003:21): unless ($ltimenu->{'coursetitle'}) {
6004:21): $realm=' ';
6005:21): $showcrstitle = 0;
6006:21): }
6007:21): }
6008:21): } elsif (($cid) && ($menucoll)) {
6009:21): if (ref($menuref) eq 'HASH') {
6010:21): unless ($menuref->{'role'}) {
6011:21): undef($role);
6012:21): }
6013:21): unless ($menuref->{'crs'}) {
6014:21): $realm=' ';
6015:21): $showcrstitle = 0;
6016:21): }
6017:21): }
6018:21): }
6019:21):
1.762 bisitz 6020: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6021: #
6022: # Extra info if you are the DC
6023: my $dc_info = '';
1.1075.2.161. .1(raebu 6024:21): if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1075.2.158 raeburn 6025: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6026: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6027: $dc_info =~ s/\s+$//;
1.359 albertel 6028: }
6029:
1.1075.2.161. .1(raebu 6030:21): my $crstype;
6031:21): if ($cid) {
6032:21): $crstype = $env{'course.'.$cid.'.type'};
6033:21): } elsif ($args->{'crstype'}) {
6034:21): $crstype = $args->{'crstype'};
6035:21): }
6036:21):
1.1075.2.108 raeburn 6037: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903 droeschl 6038:
1.1075.2.13 raeburn 6039: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6040:
1.1075.2.38 raeburn 6041:
6042:
1.1075.2.21 raeburn 6043: my $funclist;
6044: if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52 raeburn 6045: $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21 raeburn 6046: Apache::lonmenu::serverform();
6047: my $forbodytag;
6048: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6049: $forcereg,$args->{'group'},
6050: $args->{'bread_crumbs'},
1.1075.2.133 raeburn 6051: $advtoolsref,'','',\$forbodytag);
1.1075.2.21 raeburn 6052: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6053: $funclist = $forbodytag;
6054: }
6055: } else {
1.903 droeschl 6056:
6057: # if ($env{'request.state'} eq 'construct') {
6058: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6059: # }
6060:
1.1075.2.38 raeburn 6061: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 6062: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6063:
1.1075.2.161. .1(raebu 6064:21): unless ($args->{'no_primary_menu'}) {
.4(raebu 6065:22): my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
.6(raebu 6066:22): $args->{'links_disabled'},
6067:22): $args->{'links_target'});
.1(raebu 6068:21): if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
6069:21): if ($dc_info) {
6070:21): $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
6071:21): }
6072:21): $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
6073:21): <em>$realm</em> $dc_info</div>|;
6074:21): return $bodytag;
1.1075.2.1 raeburn 6075: }
1.894 droeschl 6076:
1.1075.2.161. .1(raebu 6077:21): unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
6078:21): $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
6079:21): }
1.916 droeschl 6080:
1.1075.2.161. .1(raebu 6081:21): $bodytag .= $right;
1.852 droeschl 6082:
1.1075.2.161. .1(raebu 6083:21): if ($dc_info) {
6084:21): $dc_info = &dc_courseid_toggle($dc_info);
6085:21): }
6086:21): $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 6087: }
1.916 droeschl 6088:
1.1075.2.61 raeburn 6089: #if directed to not display the secondary menu, don't.
6090: if ($args->{'no_secondary_menu'}) {
6091: return $bodytag;
6092: }
1.903 droeschl 6093: #don't show menus for public users
1.954 raeburn 6094: if (!$public){
1.1075.2.161. .1(raebu 6095:21): unless ($args->{'no_inline_menu'}) {
6096:21): $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
6097:21): $args->{'no_primary_menu'},
6098:21): $menucoll,$menuref,
.6(raebu 6099:22): $args->{'links_disabled'},
6100:22): $args->{'links_target'});
.1(raebu 6101:21): }
1.903 droeschl 6102: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6103: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6104: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6105: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.161. .1(raebu 6106:21): $args->{'bread_crumbs'},'','',$hostname,$ltiscope,$ltiuri);
1.1075.2.116 raeburn 6107: } elsif ($forcereg) {
1.1075.2.22 raeburn 6108: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116 raeburn 6109: $args->{'group'},
1.1075.2.161 raeburn 6110: $args->{'hide_buttons'},
1.1075.2.161. .1(raebu 6111:21): $hostname,$ltiscope,$ltiuri);
1.1075.2.15 raeburn 6112: } else {
1.1075.2.21 raeburn 6113: my $forbodytag;
6114: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6115: $forcereg,$args->{'group'},
6116: $args->{'bread_crumbs'},
1.1075.2.133 raeburn 6117: $advtoolsref,'',$hostname,
6118: \$forbodytag);
1.1075.2.21 raeburn 6119: unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6120: $bodytag .= $forbodytag;
6121: }
1.920 raeburn 6122: }
1.903 droeschl 6123: }else{
6124: # this is to seperate menu from content when there's no secondary
6125: # menu. Especially needed for public accessible ressources.
6126: $bodytag .= '<hr style="clear:both" />';
6127: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6128: }
1.903 droeschl 6129:
1.235 raeburn 6130: return $bodytag;
1.1075.2.12 raeburn 6131: }
6132:
6133: #
6134: # Top frame rendering, Remote is up
6135: #
6136:
6137: my $imgsrc = $img;
6138: if ($img =~ /^\/adm/) {
6139: $imgsrc = &lonhttpdurl($img);
6140: }
6141: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
6142:
1.1075.2.60 raeburn 6143: my $help=($no_inline_link?''
6144: :&Apache::loncommon::top_nav_help('Help'));
6145:
1.1075.2.12 raeburn 6146: # Explicit link to get inline menu
6147: my $menu= ($no_inline_link?''
6148: :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
6149:
6150: if ($dc_info) {
6151: $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
6152: }
6153:
1.1075.2.38 raeburn 6154: my $name = &plainname($env{'user.name'},$env{'user.domain'});
6155: unless ($public) {
6156: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
6157: undef,'LC_menubuttons_link');
6158: }
6159:
1.1075.2.12 raeburn 6160: unless ($env{'form.inhibitmenu'}) {
6161: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38 raeburn 6162: <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60 raeburn 6163: <li>$help</li>
1.1075.2.12 raeburn 6164: <li>$menu</li>
6165: </ol><div id="LC_realm"> $realm $dc_info</div>|;
6166: }
1.1075.2.13 raeburn 6167: if ($env{'request.state'} eq 'construct') {
6168: if (!$public){
6169: if ($env{'request.state'} eq 'construct') {
6170: $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52 raeburn 6171: &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13 raeburn 6172: &Apache::lonhtmlcommon::scripttag('','end').
6173: &Apache::lonmenu::innerregister($forcereg,
6174: $args->{'bread_crumbs'});
6175: }
6176: }
6177: }
1.1075.2.21 raeburn 6178: return $bodytag."\n".$funclist;
1.182 matthew 6179: }
6180:
1.917 raeburn 6181: sub dc_courseid_toggle {
6182: my ($dc_info) = @_;
1.980 raeburn 6183: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6184: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6185: &mt('(More ...)').'</a></span>'.
6186: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6187: }
6188:
1.330 albertel 6189: sub make_attr_string {
6190: my ($register,$attr_ref) = @_;
6191:
6192: if ($attr_ref && !ref($attr_ref)) {
6193: die("addentries Must be a hash ref ".
6194: join(':',caller(1))." ".
6195: join(':',caller(0))." ");
6196: }
6197:
6198: if ($register) {
1.339 albertel 6199: my ($on_load,$on_unload);
6200: foreach my $key (keys(%{$attr_ref})) {
6201: if (lc($key) eq 'onload') {
6202: $on_load.=$attr_ref->{$key}.';';
6203: delete($attr_ref->{$key});
6204:
6205: } elsif (lc($key) eq 'onunload') {
6206: $on_unload.=$attr_ref->{$key}.';';
6207: delete($attr_ref->{$key});
6208: }
6209: }
1.1075.2.12 raeburn 6210: if ($env{'environment.remote'} eq 'on') {
6211: $attr_ref->{'onload'} =
6212: &Apache::lonmenu::loadevents(). $on_load;
6213: $attr_ref->{'onunload'}=
6214: &Apache::lonmenu::unloadevents().$on_unload;
6215: } else {
6216: $attr_ref->{'onload'} = $on_load;
6217: $attr_ref->{'onunload'}= $on_unload;
6218: }
1.330 albertel 6219: }
1.339 albertel 6220:
1.330 albertel 6221: my $attr_string;
1.1075.2.56 raeburn 6222: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6223: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6224: }
6225: return $attr_string;
6226: }
6227:
6228:
1.182 matthew 6229: ###############################################
1.251 albertel 6230: ###############################################
6231:
6232: =pod
6233:
6234: =item * &endbodytag()
6235:
6236: Returns a uniform footer for LON-CAPA web pages.
6237:
1.635 raeburn 6238: Inputs: 1 - optional reference to an args hash
6239: If in the hash, key for noredirectlink has a value which evaluates to true,
6240: a 'Continue' link is not displayed if the page contains an
6241: internal redirect in the <head></head> section,
6242: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6243:
6244: =cut
6245:
6246: sub endbodytag {
1.635 raeburn 6247: my ($args) = @_;
1.1075.2.6 raeburn 6248: my $endbodytag;
6249: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6250: $endbodytag='</body>';
6251: }
1.315 albertel 6252: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6253: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
6254: $endbodytag=
6255: "<br /><a href=\"$env{'internal.head.redirect'}\">".
6256: &mt('Continue').'</a>'.
6257: $endbodytag;
6258: }
1.315 albertel 6259: }
1.251 albertel 6260: return $endbodytag;
6261: }
6262:
1.352 albertel 6263: =pod
6264:
6265: =item * &standard_css()
6266:
6267: Returns a style sheet
6268:
6269: Inputs: (all optional)
6270: domain -> force to color decorate a page for a specific
6271: domain
6272: function -> force usage of a specific rolish color scheme
6273: bgcolor -> override the default page bgcolor
6274:
6275: =cut
6276:
1.343 albertel 6277: sub standard_css {
1.345 albertel 6278: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6279: $function = &get_users_function() if (!$function);
6280: my $img = &designparm($function.'.img', $domain);
6281: my $tabbg = &designparm($function.'.tabbg', $domain);
6282: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6283: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6284: #second colour for later usage
1.345 albertel 6285: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6286: my $pgbg_or_bgcolor =
6287: $bgcolor ||
1.352 albertel 6288: &designparm($function.'.pgbg', $domain);
1.382 albertel 6289: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6290: my $alink = &designparm($function.'.alink', $domain);
6291: my $vlink = &designparm($function.'.vlink', $domain);
6292: my $link = &designparm($function.'.link', $domain);
6293:
1.602 albertel 6294: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6295: my $mono = 'monospace';
1.850 bisitz 6296: my $data_table_head = $sidebg;
6297: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6298: my $data_table_dark = '#E0E0E0';
1.470 banghart 6299: my $data_table_darker = '#CCCCCC';
1.349 albertel 6300: my $data_table_highlight = '#FFFF00';
1.352 albertel 6301: my $mail_new = '#FFBB77';
6302: my $mail_new_hover = '#DD9955';
6303: my $mail_read = '#BBBB77';
6304: my $mail_read_hover = '#999944';
6305: my $mail_replied = '#AAAA88';
6306: my $mail_replied_hover = '#888855';
6307: my $mail_other = '#99BBBB';
6308: my $mail_other_hover = '#669999';
1.391 albertel 6309: my $table_header = '#DDDDDD';
1.489 raeburn 6310: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6311: my $lg_border_color = '#C8C8C8';
1.952 onken 6312: my $button_hover = '#BF2317';
1.392 albertel 6313:
1.608 albertel 6314: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6315: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6316: : '0 3px 0 4px';
1.448 albertel 6317:
1.523 albertel 6318:
1.343 albertel 6319: return <<END;
1.947 droeschl 6320:
6321: /* needed for iframe to allow 100% height in FF */
6322: body, html {
6323: margin: 0;
6324: padding: 0 0.5%;
6325: height: 99%; /* to avoid scrollbars */
6326: }
6327:
1.795 www 6328: body {
1.911 bisitz 6329: font-family: $sans;
6330: line-height:130%;
6331: font-size:0.83em;
6332: color:$font;
1.795 www 6333: }
6334:
1.959 onken 6335: a:focus,
6336: a:focus img {
1.795 www 6337: color: red;
6338: }
1.698 harmsja 6339:
1.911 bisitz 6340: form, .inline {
6341: display: inline;
1.795 www 6342: }
1.721 harmsja 6343:
1.795 www 6344: .LC_right {
1.911 bisitz 6345: text-align:right;
1.795 www 6346: }
6347:
6348: .LC_middle {
1.911 bisitz 6349: vertical-align:middle;
1.795 www 6350: }
1.721 harmsja 6351:
1.1075.2.38 raeburn 6352: .LC_floatleft {
6353: float: left;
6354: }
6355:
6356: .LC_floatright {
6357: float: right;
6358: }
6359:
1.911 bisitz 6360: .LC_400Box {
6361: width:400px;
6362: }
1.721 harmsja 6363:
1.947 droeschl 6364: .LC_iframecontainer {
6365: width: 98%;
6366: margin: 0;
6367: position: fixed;
6368: top: 8.5em;
6369: bottom: 0;
6370: }
6371:
6372: .LC_iframecontainer iframe{
6373: border: none;
6374: width: 100%;
6375: height: 100%;
6376: }
6377:
1.778 bisitz 6378: .LC_filename {
6379: font-family: $mono;
6380: white-space:pre;
1.921 bisitz 6381: font-size: 120%;
1.778 bisitz 6382: }
6383:
6384: .LC_fileicon {
6385: border: none;
6386: height: 1.3em;
6387: vertical-align: text-bottom;
6388: margin-right: 0.3em;
6389: text-decoration:none;
6390: }
6391:
1.1008 www 6392: .LC_setting {
6393: text-decoration:underline;
6394: }
6395:
1.350 albertel 6396: .LC_error {
6397: color: red;
6398: }
1.795 www 6399:
1.1075.2.15 raeburn 6400: .LC_warning {
6401: color: darkorange;
6402: }
6403:
1.457 albertel 6404: .LC_diff_removed {
1.733 bisitz 6405: color: red;
1.394 albertel 6406: }
1.532 albertel 6407:
6408: .LC_info,
1.457 albertel 6409: .LC_success,
6410: .LC_diff_added {
1.350 albertel 6411: color: green;
6412: }
1.795 www 6413:
1.802 bisitz 6414: div.LC_confirm_box {
6415: background-color: #FAFAFA;
6416: border: 1px solid $lg_border_color;
6417: margin-right: 0;
6418: padding: 5px;
6419: }
6420:
6421: div.LC_confirm_box .LC_error img,
6422: div.LC_confirm_box .LC_success img {
6423: vertical-align: middle;
6424: }
6425:
1.1075.2.108 raeburn 6426: .LC_maxwidth {
6427: max-width: 100%;
6428: height: auto;
6429: }
6430:
6431: .LC_textsize_mobile {
6432: \@media only screen and (max-device-width: 480px) {
6433: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6434: }
6435: }
6436:
1.440 albertel 6437: .LC_icon {
1.771 droeschl 6438: border: none;
1.790 droeschl 6439: vertical-align: middle;
1.771 droeschl 6440: }
6441:
1.543 albertel 6442: .LC_docs_spacer {
6443: width: 25px;
6444: height: 1px;
1.771 droeschl 6445: border: none;
1.543 albertel 6446: }
1.346 albertel 6447:
1.532 albertel 6448: .LC_internal_info {
1.735 bisitz 6449: color: #999999;
1.532 albertel 6450: }
6451:
1.794 www 6452: .LC_discussion {
1.1050 www 6453: background: $data_table_dark;
1.911 bisitz 6454: border: 1px solid black;
6455: margin: 2px;
1.794 www 6456: }
6457:
6458: .LC_disc_action_left {
1.1050 www 6459: background: $sidebg;
1.911 bisitz 6460: text-align: left;
1.1050 www 6461: padding: 4px;
6462: margin: 2px;
1.794 www 6463: }
6464:
6465: .LC_disc_action_right {
1.1050 www 6466: background: $sidebg;
1.911 bisitz 6467: text-align: right;
1.1050 www 6468: padding: 4px;
6469: margin: 2px;
1.794 www 6470: }
6471:
6472: .LC_disc_new_item {
1.911 bisitz 6473: background: white;
6474: border: 2px solid red;
1.1050 www 6475: margin: 4px;
6476: padding: 4px;
1.794 www 6477: }
6478:
6479: .LC_disc_old_item {
1.911 bisitz 6480: background: white;
1.1050 www 6481: margin: 4px;
6482: padding: 4px;
1.794 www 6483: }
6484:
1.458 albertel 6485: table.LC_pastsubmission {
6486: border: 1px solid black;
6487: margin: 2px;
6488: }
6489:
1.924 bisitz 6490: table#LC_menubuttons {
1.345 albertel 6491: width: 100%;
6492: background: $pgbg;
1.392 albertel 6493: border: 2px;
1.402 albertel 6494: border-collapse: separate;
1.803 bisitz 6495: padding: 0;
1.345 albertel 6496: }
1.392 albertel 6497:
1.801 tempelho 6498: table#LC_title_bar a {
6499: color: $fontmenu;
6500: }
1.836 bisitz 6501:
1.807 droeschl 6502: table#LC_title_bar {
1.819 tempelho 6503: clear: both;
1.836 bisitz 6504: display: none;
1.807 droeschl 6505: }
6506:
1.795 www 6507: table#LC_title_bar,
1.933 droeschl 6508: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6509: table#LC_title_bar.LC_with_remote {
1.359 albertel 6510: width: 100%;
1.392 albertel 6511: border-color: $pgbg;
6512: border-style: solid;
6513: border-width: $border;
1.379 albertel 6514: background: $pgbg;
1.801 tempelho 6515: color: $fontmenu;
1.392 albertel 6516: border-collapse: collapse;
1.803 bisitz 6517: padding: 0;
1.819 tempelho 6518: margin: 0;
1.359 albertel 6519: }
1.795 www 6520:
1.933 droeschl 6521: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6522: margin: 0;
6523: padding: 0;
1.933 droeschl 6524: position: relative;
6525: list-style: none;
1.913 droeschl 6526: }
1.933 droeschl 6527: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6528: display: inline;
6529: }
1.933 droeschl 6530:
6531: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6532: padding: 0;
1.933 droeschl 6533: margin: 0;
6534: float: left;
1.913 droeschl 6535: }
1.933 droeschl 6536: .LC_breadcrumb_tools_tools {
6537: padding: 0;
6538: margin: 0;
1.913 droeschl 6539: float: right;
6540: }
6541:
1.359 albertel 6542: table#LC_title_bar td {
6543: background: $tabbg;
6544: }
1.795 www 6545:
1.911 bisitz 6546: table#LC_menubuttons img {
1.803 bisitz 6547: border: none;
1.346 albertel 6548: }
1.795 www 6549:
1.842 droeschl 6550: .LC_breadcrumbs_component {
1.911 bisitz 6551: float: right;
6552: margin: 0 1em;
1.357 albertel 6553: }
1.842 droeschl 6554: .LC_breadcrumbs_component img {
1.911 bisitz 6555: vertical-align: middle;
1.777 tempelho 6556: }
1.795 www 6557:
1.1075.2.108 raeburn 6558: .LC_breadcrumbs_hoverable {
6559: background: $sidebg;
6560: }
6561:
1.383 albertel 6562: td.LC_table_cell_checkbox {
6563: text-align: center;
6564: }
1.795 www 6565:
6566: .LC_fontsize_small {
1.911 bisitz 6567: font-size: 70%;
1.705 tempelho 6568: }
6569:
1.844 bisitz 6570: #LC_breadcrumbs {
1.911 bisitz 6571: clear:both;
6572: background: $sidebg;
6573: border-bottom: 1px solid $lg_border_color;
6574: line-height: 2.5em;
1.933 droeschl 6575: overflow: hidden;
1.911 bisitz 6576: margin: 0;
6577: padding: 0;
1.995 raeburn 6578: text-align: left;
1.819 tempelho 6579: }
1.862 bisitz 6580:
1.1075.2.16 raeburn 6581: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 6582: clear:both;
6583: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 6584: border: 1px solid $sidebg;
1.1075.2.16 raeburn 6585: margin: 0 0 10px 0;
1.966 bisitz 6586: padding: 3px;
1.995 raeburn 6587: text-align: left;
1.822 bisitz 6588: }
6589:
1.795 www 6590: .LC_fontsize_medium {
1.911 bisitz 6591: font-size: 85%;
1.705 tempelho 6592: }
6593:
1.795 www 6594: .LC_fontsize_large {
1.911 bisitz 6595: font-size: 120%;
1.705 tempelho 6596: }
6597:
1.346 albertel 6598: .LC_menubuttons_inline_text {
6599: color: $font;
1.698 harmsja 6600: font-size: 90%;
1.701 harmsja 6601: padding-left:3px;
1.346 albertel 6602: }
6603:
1.934 droeschl 6604: .LC_menubuttons_inline_text img{
6605: vertical-align: middle;
6606: }
6607:
1.1051 www 6608: li.LC_menubuttons_inline_text img {
1.951 onken 6609: cursor:pointer;
1.1002 droeschl 6610: text-decoration: none;
1.951 onken 6611: }
6612:
1.526 www 6613: .LC_menubuttons_link {
6614: text-decoration: none;
6615: }
1.795 www 6616:
1.522 albertel 6617: .LC_menubuttons_category {
1.521 www 6618: color: $font;
1.526 www 6619: background: $pgbg;
1.521 www 6620: font-size: larger;
6621: font-weight: bold;
6622: }
6623:
1.346 albertel 6624: td.LC_menubuttons_text {
1.911 bisitz 6625: color: $font;
1.346 albertel 6626: }
1.706 harmsja 6627:
1.346 albertel 6628: .LC_current_location {
6629: background: $tabbg;
6630: }
1.795 www 6631:
1.1075.2.134 raeburn 6632: td.LC_zero_height {
6633: line-height: 0;
6634: cellpadding: 0;
6635: }
6636:
1.938 bisitz 6637: table.LC_data_table {
1.347 albertel 6638: border: 1px solid #000000;
1.402 albertel 6639: border-collapse: separate;
1.426 albertel 6640: border-spacing: 1px;
1.610 albertel 6641: background: $pgbg;
1.347 albertel 6642: }
1.795 www 6643:
1.422 albertel 6644: .LC_data_table_dense {
6645: font-size: small;
6646: }
1.795 www 6647:
1.507 raeburn 6648: table.LC_nested_outer {
6649: border: 1px solid #000000;
1.589 raeburn 6650: border-collapse: collapse;
1.803 bisitz 6651: border-spacing: 0;
1.507 raeburn 6652: width: 100%;
6653: }
1.795 www 6654:
1.879 raeburn 6655: table.LC_innerpickbox,
1.507 raeburn 6656: table.LC_nested {
1.803 bisitz 6657: border: none;
1.589 raeburn 6658: border-collapse: collapse;
1.803 bisitz 6659: border-spacing: 0;
1.507 raeburn 6660: width: 100%;
6661: }
1.795 www 6662:
1.911 bisitz 6663: table.LC_data_table tr th,
6664: table.LC_calendar tr th,
1.879 raeburn 6665: table.LC_prior_tries tr th,
6666: table.LC_innerpickbox tr th {
1.349 albertel 6667: font-weight: bold;
6668: background-color: $data_table_head;
1.801 tempelho 6669: color:$fontmenu;
1.701 harmsja 6670: font-size:90%;
1.347 albertel 6671: }
1.795 www 6672:
1.879 raeburn 6673: table.LC_innerpickbox tr th,
6674: table.LC_innerpickbox tr td {
6675: vertical-align: top;
6676: }
6677:
1.711 raeburn 6678: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6679: background-color: #CCCCCC;
1.711 raeburn 6680: font-weight: bold;
6681: text-align: left;
6682: }
1.795 www 6683:
1.912 bisitz 6684: table.LC_data_table tr.LC_odd_row > td {
6685: background-color: $data_table_light;
6686: padding: 2px;
6687: vertical-align: top;
6688: }
6689:
1.809 bisitz 6690: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6691: background-color: $data_table_light;
1.912 bisitz 6692: vertical-align: top;
6693: }
6694:
6695: table.LC_data_table tr.LC_even_row > td {
6696: background-color: $data_table_dark;
1.425 albertel 6697: padding: 2px;
1.900 bisitz 6698: vertical-align: top;
1.347 albertel 6699: }
1.795 www 6700:
1.809 bisitz 6701: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6702: background-color: $data_table_dark;
1.900 bisitz 6703: vertical-align: top;
1.347 albertel 6704: }
1.795 www 6705:
1.425 albertel 6706: table.LC_data_table tr.LC_data_table_highlight td {
6707: background-color: $data_table_darker;
6708: }
1.795 www 6709:
1.639 raeburn 6710: table.LC_data_table tr td.LC_leftcol_header {
6711: background-color: $data_table_head;
6712: font-weight: bold;
6713: }
1.795 www 6714:
1.451 albertel 6715: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6716: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6717: font-weight: bold;
6718: font-style: italic;
6719: text-align: center;
6720: padding: 8px;
1.347 albertel 6721: }
1.795 www 6722:
1.1075.2.30 raeburn 6723: table.LC_data_table tr.LC_empty_row td,
6724: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6725: background-color: $sidebg;
6726: }
6727:
6728: table.LC_nested tr.LC_empty_row td {
6729: background-color: #FFFFFF;
6730: }
6731:
1.890 droeschl 6732: table.LC_caption {
6733: }
6734:
1.507 raeburn 6735: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6736: padding: 4ex
6737: }
1.795 www 6738:
1.507 raeburn 6739: table.LC_nested_outer tr th {
6740: font-weight: bold;
1.801 tempelho 6741: color:$fontmenu;
1.507 raeburn 6742: background-color: $data_table_head;
1.701 harmsja 6743: font-size: small;
1.507 raeburn 6744: border-bottom: 1px solid #000000;
6745: }
1.795 www 6746:
1.507 raeburn 6747: table.LC_nested_outer tr td.LC_subheader {
6748: background-color: $data_table_head;
6749: font-weight: bold;
6750: font-size: small;
6751: border-bottom: 1px solid #000000;
6752: text-align: right;
1.451 albertel 6753: }
1.795 www 6754:
1.507 raeburn 6755: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6756: background-color: #CCCCCC;
1.451 albertel 6757: font-weight: bold;
6758: font-size: small;
1.507 raeburn 6759: text-align: center;
6760: }
1.795 www 6761:
1.589 raeburn 6762: table.LC_nested tr.LC_info_row td.LC_left_item,
6763: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6764: text-align: left;
1.451 albertel 6765: }
1.795 www 6766:
1.507 raeburn 6767: table.LC_nested td {
1.735 bisitz 6768: background-color: #FFFFFF;
1.451 albertel 6769: font-size: small;
1.507 raeburn 6770: }
1.795 www 6771:
1.507 raeburn 6772: table.LC_nested_outer tr th.LC_right_item,
6773: table.LC_nested tr.LC_info_row td.LC_right_item,
6774: table.LC_nested tr.LC_odd_row td.LC_right_item,
6775: table.LC_nested tr td.LC_right_item {
1.451 albertel 6776: text-align: right;
6777: }
6778:
1.507 raeburn 6779: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6780: background-color: #EEEEEE;
1.451 albertel 6781: }
6782:
1.473 raeburn 6783: table.LC_createuser {
6784: }
6785:
6786: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6787: font-size: small;
1.473 raeburn 6788: }
6789:
6790: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6791: background-color: #CCCCCC;
1.473 raeburn 6792: font-weight: bold;
6793: text-align: center;
6794: }
6795:
1.349 albertel 6796: table.LC_calendar {
6797: border: 1px solid #000000;
6798: border-collapse: collapse;
1.917 raeburn 6799: width: 98%;
1.349 albertel 6800: }
1.795 www 6801:
1.349 albertel 6802: table.LC_calendar_pickdate {
6803: font-size: xx-small;
6804: }
1.795 www 6805:
1.349 albertel 6806: table.LC_calendar tr td {
6807: border: 1px solid #000000;
6808: vertical-align: top;
1.917 raeburn 6809: width: 14%;
1.349 albertel 6810: }
1.795 www 6811:
1.349 albertel 6812: table.LC_calendar tr td.LC_calendar_day_empty {
6813: background-color: $data_table_dark;
6814: }
1.795 www 6815:
1.779 bisitz 6816: table.LC_calendar tr td.LC_calendar_day_current {
6817: background-color: $data_table_highlight;
1.777 tempelho 6818: }
1.795 www 6819:
1.938 bisitz 6820: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6821: background-color: $mail_new;
6822: }
1.795 www 6823:
1.938 bisitz 6824: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6825: background-color: $mail_new_hover;
6826: }
1.795 www 6827:
1.938 bisitz 6828: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6829: background-color: $mail_read;
6830: }
1.795 www 6831:
1.938 bisitz 6832: /*
6833: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6834: background-color: $mail_read_hover;
6835: }
1.938 bisitz 6836: */
1.795 www 6837:
1.938 bisitz 6838: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6839: background-color: $mail_replied;
6840: }
1.795 www 6841:
1.938 bisitz 6842: /*
6843: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6844: background-color: $mail_replied_hover;
6845: }
1.938 bisitz 6846: */
1.795 www 6847:
1.938 bisitz 6848: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6849: background-color: $mail_other;
6850: }
1.795 www 6851:
1.938 bisitz 6852: /*
6853: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6854: background-color: $mail_other_hover;
6855: }
1.938 bisitz 6856: */
1.494 raeburn 6857:
1.777 tempelho 6858: table.LC_data_table tr > td.LC_browser_file,
6859: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6860: background: #AAEE77;
1.389 albertel 6861: }
1.795 www 6862:
1.777 tempelho 6863: table.LC_data_table tr > td.LC_browser_file_locked,
6864: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6865: background: #FFAA99;
1.387 albertel 6866: }
1.795 www 6867:
1.777 tempelho 6868: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6869: background: #888888;
1.779 bisitz 6870: }
1.795 www 6871:
1.777 tempelho 6872: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6873: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6874: background: #F8F866;
1.777 tempelho 6875: }
1.795 www 6876:
1.696 bisitz 6877: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6878: background: #E0E8FF;
1.387 albertel 6879: }
1.696 bisitz 6880:
1.707 bisitz 6881: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6882: /* background: #77FF77; */
1.707 bisitz 6883: }
1.795 www 6884:
1.707 bisitz 6885: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6886: border-right: 8px solid #FFFF77;
1.707 bisitz 6887: }
1.795 www 6888:
1.707 bisitz 6889: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6890: border-right: 8px solid #FFAA77;
1.707 bisitz 6891: }
1.795 www 6892:
1.707 bisitz 6893: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6894: border-right: 8px solid #FF7777;
1.707 bisitz 6895: }
1.795 www 6896:
1.707 bisitz 6897: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6898: border-right: 8px solid #AAFF77;
1.707 bisitz 6899: }
1.795 www 6900:
1.707 bisitz 6901: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6902: border-right: 8px solid #11CC55;
1.707 bisitz 6903: }
6904:
1.388 albertel 6905: span.LC_current_location {
1.701 harmsja 6906: font-size:larger;
1.388 albertel 6907: background: $pgbg;
6908: }
1.387 albertel 6909:
1.1029 www 6910: span.LC_current_nav_location {
6911: font-weight:bold;
6912: background: $sidebg;
6913: }
6914:
1.395 albertel 6915: span.LC_parm_menu_item {
6916: font-size: larger;
6917: }
1.795 www 6918:
1.395 albertel 6919: span.LC_parm_scope_all {
6920: color: red;
6921: }
1.795 www 6922:
1.395 albertel 6923: span.LC_parm_scope_folder {
6924: color: green;
6925: }
1.795 www 6926:
1.395 albertel 6927: span.LC_parm_scope_resource {
6928: color: orange;
6929: }
1.795 www 6930:
1.395 albertel 6931: span.LC_parm_part {
6932: color: blue;
6933: }
1.795 www 6934:
1.911 bisitz 6935: span.LC_parm_folder,
6936: span.LC_parm_symb {
1.395 albertel 6937: font-size: x-small;
6938: font-family: $mono;
6939: color: #AAAAAA;
6940: }
6941:
1.977 bisitz 6942: ul.LC_parm_parmlist li {
6943: display: inline-block;
6944: padding: 0.3em 0.8em;
6945: vertical-align: top;
6946: width: 150px;
6947: border-top:1px solid $lg_border_color;
6948: }
6949:
1.795 www 6950: td.LC_parm_overview_level_menu,
6951: td.LC_parm_overview_map_menu,
6952: td.LC_parm_overview_parm_selectors,
6953: td.LC_parm_overview_restrictions {
1.396 albertel 6954: border: 1px solid black;
6955: border-collapse: collapse;
6956: }
1.795 www 6957:
1.396 albertel 6958: table.LC_parm_overview_restrictions td {
6959: border-width: 1px 4px 1px 4px;
6960: border-style: solid;
6961: border-color: $pgbg;
6962: text-align: center;
6963: }
1.795 www 6964:
1.396 albertel 6965: table.LC_parm_overview_restrictions th {
6966: background: $tabbg;
6967: border-width: 1px 4px 1px 4px;
6968: border-style: solid;
6969: border-color: $pgbg;
6970: }
1.795 www 6971:
1.398 albertel 6972: table#LC_helpmenu {
1.803 bisitz 6973: border: none;
1.398 albertel 6974: height: 55px;
1.803 bisitz 6975: border-spacing: 0;
1.398 albertel 6976: }
6977:
6978: table#LC_helpmenu fieldset legend {
6979: font-size: larger;
6980: }
1.795 www 6981:
1.397 albertel 6982: table#LC_helpmenu_links {
6983: width: 100%;
6984: border: 1px solid black;
6985: background: $pgbg;
1.803 bisitz 6986: padding: 0;
1.397 albertel 6987: border-spacing: 1px;
6988: }
1.795 www 6989:
1.397 albertel 6990: table#LC_helpmenu_links tr td {
6991: padding: 1px;
6992: background: $tabbg;
1.399 albertel 6993: text-align: center;
6994: font-weight: bold;
1.397 albertel 6995: }
1.396 albertel 6996:
1.795 www 6997: table#LC_helpmenu_links a:link,
6998: table#LC_helpmenu_links a:visited,
1.397 albertel 6999: table#LC_helpmenu_links a:active {
7000: text-decoration: none;
7001: color: $font;
7002: }
1.795 www 7003:
1.397 albertel 7004: table#LC_helpmenu_links a:hover {
7005: text-decoration: underline;
7006: color: $vlink;
7007: }
1.396 albertel 7008:
1.417 albertel 7009: .LC_chrt_popup_exists {
7010: border: 1px solid #339933;
7011: margin: -1px;
7012: }
1.795 www 7013:
1.417 albertel 7014: .LC_chrt_popup_up {
7015: border: 1px solid yellow;
7016: margin: -1px;
7017: }
1.795 www 7018:
1.417 albertel 7019: .LC_chrt_popup {
7020: border: 1px solid #8888FF;
7021: background: #CCCCFF;
7022: }
1.795 www 7023:
1.421 albertel 7024: table.LC_pick_box {
7025: border-collapse: separate;
7026: background: white;
7027: border: 1px solid black;
7028: border-spacing: 1px;
7029: }
1.795 www 7030:
1.421 albertel 7031: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7032: background: $sidebg;
1.421 albertel 7033: font-weight: bold;
1.900 bisitz 7034: text-align: left;
1.740 bisitz 7035: vertical-align: top;
1.421 albertel 7036: width: 184px;
7037: padding: 8px;
7038: }
1.795 www 7039:
1.579 raeburn 7040: table.LC_pick_box td.LC_pick_box_value {
7041: text-align: left;
7042: padding: 8px;
7043: }
1.795 www 7044:
1.579 raeburn 7045: table.LC_pick_box td.LC_pick_box_select {
7046: text-align: left;
7047: padding: 8px;
7048: }
1.795 www 7049:
1.424 albertel 7050: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 7051: padding: 0;
1.421 albertel 7052: height: 1px;
7053: background: black;
7054: }
1.795 www 7055:
1.421 albertel 7056: table.LC_pick_box td.LC_pick_box_submit {
7057: text-align: right;
7058: }
1.795 www 7059:
1.579 raeburn 7060: table.LC_pick_box td.LC_evenrow_value {
7061: text-align: left;
7062: padding: 8px;
7063: background-color: $data_table_light;
7064: }
1.795 www 7065:
1.579 raeburn 7066: table.LC_pick_box td.LC_oddrow_value {
7067: text-align: left;
7068: padding: 8px;
7069: background-color: $data_table_light;
7070: }
1.795 www 7071:
1.579 raeburn 7072: span.LC_helpform_receipt_cat {
7073: font-weight: bold;
7074: }
1.795 www 7075:
1.424 albertel 7076: table.LC_group_priv_box {
7077: background: white;
7078: border: 1px solid black;
7079: border-spacing: 1px;
7080: }
1.795 www 7081:
1.424 albertel 7082: table.LC_group_priv_box td.LC_pick_box_title {
7083: background: $tabbg;
7084: font-weight: bold;
7085: text-align: right;
7086: width: 184px;
7087: }
1.795 www 7088:
1.424 albertel 7089: table.LC_group_priv_box td.LC_groups_fixed {
7090: background: $data_table_light;
7091: text-align: center;
7092: }
1.795 www 7093:
1.424 albertel 7094: table.LC_group_priv_box td.LC_groups_optional {
7095: background: $data_table_dark;
7096: text-align: center;
7097: }
1.795 www 7098:
1.424 albertel 7099: table.LC_group_priv_box td.LC_groups_functionality {
7100: background: $data_table_darker;
7101: text-align: center;
7102: font-weight: bold;
7103: }
1.795 www 7104:
1.424 albertel 7105: table.LC_group_priv td {
7106: text-align: left;
1.803 bisitz 7107: padding: 0;
1.424 albertel 7108: }
7109:
7110: .LC_navbuttons {
7111: margin: 2ex 0ex 2ex 0ex;
7112: }
1.795 www 7113:
1.423 albertel 7114: .LC_topic_bar {
7115: font-weight: bold;
7116: background: $tabbg;
1.918 wenzelju 7117: margin: 1em 0em 1em 2em;
1.805 bisitz 7118: padding: 3px;
1.918 wenzelju 7119: font-size: 1.2em;
1.423 albertel 7120: }
1.795 www 7121:
1.423 albertel 7122: .LC_topic_bar span {
1.918 wenzelju 7123: left: 0.5em;
7124: position: absolute;
1.423 albertel 7125: vertical-align: middle;
1.918 wenzelju 7126: font-size: 1.2em;
1.423 albertel 7127: }
1.795 www 7128:
1.423 albertel 7129: table.LC_course_group_status {
7130: margin: 20px;
7131: }
1.795 www 7132:
1.423 albertel 7133: table.LC_status_selector td {
7134: vertical-align: top;
7135: text-align: center;
1.424 albertel 7136: padding: 4px;
7137: }
1.795 www 7138:
1.599 albertel 7139: div.LC_feedback_link {
1.616 albertel 7140: clear: both;
1.829 kalberla 7141: background: $sidebg;
1.779 bisitz 7142: width: 100%;
1.829 kalberla 7143: padding-bottom: 10px;
7144: border: 1px $tabbg solid;
1.833 kalberla 7145: height: 22px;
7146: line-height: 22px;
7147: padding-top: 5px;
7148: }
7149:
7150: div.LC_feedback_link img {
7151: height: 22px;
1.867 kalberla 7152: vertical-align:middle;
1.829 kalberla 7153: }
7154:
1.911 bisitz 7155: div.LC_feedback_link a {
1.829 kalberla 7156: text-decoration: none;
1.489 raeburn 7157: }
1.795 www 7158:
1.867 kalberla 7159: div.LC_comblock {
1.911 bisitz 7160: display:inline;
1.867 kalberla 7161: color:$font;
7162: font-size:90%;
7163: }
7164:
7165: div.LC_feedback_link div.LC_comblock {
7166: padding-left:5px;
7167: }
7168:
7169: div.LC_feedback_link div.LC_comblock a {
7170: color:$font;
7171: }
7172:
1.489 raeburn 7173: span.LC_feedback_link {
1.858 bisitz 7174: /* background: $feedback_link_bg; */
1.599 albertel 7175: font-size: larger;
7176: }
1.795 www 7177:
1.599 albertel 7178: span.LC_message_link {
1.858 bisitz 7179: /* background: $feedback_link_bg; */
1.599 albertel 7180: font-size: larger;
7181: position: absolute;
7182: right: 1em;
1.489 raeburn 7183: }
1.421 albertel 7184:
1.515 albertel 7185: table.LC_prior_tries {
1.524 albertel 7186: border: 1px solid #000000;
7187: border-collapse: separate;
7188: border-spacing: 1px;
1.515 albertel 7189: }
1.523 albertel 7190:
1.515 albertel 7191: table.LC_prior_tries td {
1.524 albertel 7192: padding: 2px;
1.515 albertel 7193: }
1.523 albertel 7194:
7195: .LC_answer_correct {
1.795 www 7196: background: lightgreen;
7197: color: darkgreen;
7198: padding: 6px;
1.523 albertel 7199: }
1.795 www 7200:
1.523 albertel 7201: .LC_answer_charged_try {
1.797 www 7202: background: #FFAAAA;
1.795 www 7203: color: darkred;
7204: padding: 6px;
1.523 albertel 7205: }
1.795 www 7206:
1.779 bisitz 7207: .LC_answer_not_charged_try,
1.523 albertel 7208: .LC_answer_no_grade,
7209: .LC_answer_late {
1.795 www 7210: background: lightyellow;
1.523 albertel 7211: color: black;
1.795 www 7212: padding: 6px;
1.523 albertel 7213: }
1.795 www 7214:
1.523 albertel 7215: .LC_answer_previous {
1.795 www 7216: background: lightblue;
7217: color: darkblue;
7218: padding: 6px;
1.523 albertel 7219: }
1.795 www 7220:
1.779 bisitz 7221: .LC_answer_no_message {
1.777 tempelho 7222: background: #FFFFFF;
7223: color: black;
1.795 www 7224: padding: 6px;
1.779 bisitz 7225: }
1.795 www 7226:
1.1075.2.140 raeburn 7227: .LC_answer_unknown,
7228: .LC_answer_warning {
1.779 bisitz 7229: background: orange;
7230: color: black;
1.795 www 7231: padding: 6px;
1.777 tempelho 7232: }
1.795 www 7233:
1.529 albertel 7234: span.LC_prior_numerical,
7235: span.LC_prior_string,
7236: span.LC_prior_custom,
7237: span.LC_prior_reaction,
7238: span.LC_prior_math {
1.925 bisitz 7239: font-family: $mono;
1.523 albertel 7240: white-space: pre;
7241: }
7242:
1.525 albertel 7243: span.LC_prior_string {
1.925 bisitz 7244: font-family: $mono;
1.525 albertel 7245: white-space: pre;
7246: }
7247:
1.523 albertel 7248: table.LC_prior_option {
7249: width: 100%;
7250: border-collapse: collapse;
7251: }
1.795 www 7252:
1.911 bisitz 7253: table.LC_prior_rank,
1.795 www 7254: table.LC_prior_match {
1.528 albertel 7255: border-collapse: collapse;
7256: }
1.795 www 7257:
1.528 albertel 7258: table.LC_prior_option tr td,
7259: table.LC_prior_rank tr td,
7260: table.LC_prior_match tr td {
1.524 albertel 7261: border: 1px solid #000000;
1.515 albertel 7262: }
7263:
1.855 bisitz 7264: .LC_nobreak {
1.544 albertel 7265: white-space: nowrap;
1.519 raeburn 7266: }
7267:
1.576 raeburn 7268: span.LC_cusr_emph {
7269: font-style: italic;
7270: }
7271:
1.633 raeburn 7272: span.LC_cusr_subheading {
7273: font-weight: normal;
7274: font-size: 85%;
7275: }
7276:
1.861 bisitz 7277: div.LC_docs_entry_move {
1.859 bisitz 7278: border: 1px solid #BBBBBB;
1.545 albertel 7279: background: #DDDDDD;
1.861 bisitz 7280: width: 22px;
1.859 bisitz 7281: padding: 1px;
7282: margin: 0;
1.545 albertel 7283: }
7284:
1.861 bisitz 7285: table.LC_data_table tr > td.LC_docs_entry_commands,
7286: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7287: font-size: x-small;
7288: }
1.795 www 7289:
1.861 bisitz 7290: .LC_docs_entry_parameter {
7291: white-space: nowrap;
7292: }
7293:
1.544 albertel 7294: .LC_docs_copy {
1.545 albertel 7295: color: #000099;
1.544 albertel 7296: }
1.795 www 7297:
1.544 albertel 7298: .LC_docs_cut {
1.545 albertel 7299: color: #550044;
1.544 albertel 7300: }
1.795 www 7301:
1.544 albertel 7302: .LC_docs_rename {
1.545 albertel 7303: color: #009900;
1.544 albertel 7304: }
1.795 www 7305:
1.544 albertel 7306: .LC_docs_remove {
1.545 albertel 7307: color: #990000;
7308: }
7309:
1.1075.2.134 raeburn 7310: .LC_domprefs_email,
1.547 albertel 7311: .LC_docs_reinit_warn,
7312: .LC_docs_ext_edit {
7313: font-size: x-small;
7314: }
7315:
1.545 albertel 7316: table.LC_docs_adddocs td,
7317: table.LC_docs_adddocs th {
7318: border: 1px solid #BBBBBB;
7319: padding: 4px;
7320: background: #DDDDDD;
1.543 albertel 7321: }
7322:
1.584 albertel 7323: table.LC_sty_begin {
7324: background: #BBFFBB;
7325: }
1.795 www 7326:
1.584 albertel 7327: table.LC_sty_end {
7328: background: #FFBBBB;
7329: }
7330:
1.589 raeburn 7331: table.LC_double_column {
1.803 bisitz 7332: border-width: 0;
1.589 raeburn 7333: border-collapse: collapse;
7334: width: 100%;
7335: padding: 2px;
7336: }
7337:
7338: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7339: top: 2px;
1.589 raeburn 7340: left: 2px;
7341: width: 47%;
7342: vertical-align: top;
7343: }
7344:
7345: table.LC_double_column tr td.LC_right_col {
7346: top: 2px;
1.779 bisitz 7347: right: 2px;
1.589 raeburn 7348: width: 47%;
7349: vertical-align: top;
7350: }
7351:
1.591 raeburn 7352: div.LC_left_float {
7353: float: left;
7354: padding-right: 5%;
1.597 albertel 7355: padding-bottom: 4px;
1.591 raeburn 7356: }
7357:
7358: div.LC_clear_float_header {
1.597 albertel 7359: padding-bottom: 2px;
1.591 raeburn 7360: }
7361:
7362: div.LC_clear_float_footer {
1.597 albertel 7363: padding-top: 10px;
1.591 raeburn 7364: clear: both;
7365: }
7366:
1.597 albertel 7367: div.LC_grade_show_user {
1.941 bisitz 7368: /* border-left: 5px solid $sidebg; */
7369: border-top: 5px solid #000000;
7370: margin: 50px 0 0 0;
1.936 bisitz 7371: padding: 15px 0 5px 10px;
1.597 albertel 7372: }
1.795 www 7373:
1.936 bisitz 7374: div.LC_grade_show_user_odd_row {
1.941 bisitz 7375: /* border-left: 5px solid #000000; */
7376: }
7377:
7378: div.LC_grade_show_user div.LC_Box {
7379: margin-right: 50px;
1.597 albertel 7380: }
7381:
7382: div.LC_grade_submissions,
7383: div.LC_grade_message_center,
1.936 bisitz 7384: div.LC_grade_info_links {
1.597 albertel 7385: margin: 5px;
7386: width: 99%;
7387: background: #FFFFFF;
7388: }
1.795 www 7389:
1.597 albertel 7390: div.LC_grade_submissions_header,
1.936 bisitz 7391: div.LC_grade_message_center_header {
1.705 tempelho 7392: font-weight: bold;
7393: font-size: large;
1.597 albertel 7394: }
1.795 www 7395:
1.597 albertel 7396: div.LC_grade_submissions_body,
1.936 bisitz 7397: div.LC_grade_message_center_body {
1.597 albertel 7398: border: 1px solid black;
7399: width: 99%;
7400: background: #FFFFFF;
7401: }
1.795 www 7402:
1.613 albertel 7403: table.LC_scantron_action {
7404: width: 100%;
7405: }
1.795 www 7406:
1.613 albertel 7407: table.LC_scantron_action tr th {
1.698 harmsja 7408: font-weight:bold;
7409: font-style:normal;
1.613 albertel 7410: }
1.795 www 7411:
1.779 bisitz 7412: .LC_edit_problem_header,
1.614 albertel 7413: div.LC_edit_problem_footer {
1.705 tempelho 7414: font-weight: normal;
7415: font-size: medium;
1.602 albertel 7416: margin: 2px;
1.1060 bisitz 7417: background-color: $sidebg;
1.600 albertel 7418: }
1.795 www 7419:
1.600 albertel 7420: div.LC_edit_problem_header,
1.602 albertel 7421: div.LC_edit_problem_header div,
1.614 albertel 7422: div.LC_edit_problem_footer,
7423: div.LC_edit_problem_footer div,
1.602 albertel 7424: div.LC_edit_problem_editxml_header,
7425: div.LC_edit_problem_editxml_header div {
1.1075.2.112 raeburn 7426: z-index: 100;
1.600 albertel 7427: }
1.795 www 7428:
1.600 albertel 7429: div.LC_edit_problem_header_title {
1.705 tempelho 7430: font-weight: bold;
7431: font-size: larger;
1.602 albertel 7432: background: $tabbg;
7433: padding: 3px;
1.1060 bisitz 7434: margin: 0 0 5px 0;
1.602 albertel 7435: }
1.795 www 7436:
1.602 albertel 7437: table.LC_edit_problem_header_title {
7438: width: 100%;
1.600 albertel 7439: background: $tabbg;
1.602 albertel 7440: }
7441:
1.1075.2.112 raeburn 7442: div.LC_edit_actionbar {
7443: background-color: $sidebg;
7444: margin: 0;
7445: padding: 0;
7446: line-height: 200%;
1.602 albertel 7447: }
1.795 www 7448:
1.1075.2.112 raeburn 7449: div.LC_edit_actionbar div{
7450: padding: 0;
7451: margin: 0;
7452: display: inline-block;
1.600 albertel 7453: }
1.795 www 7454:
1.1075.2.34 raeburn 7455: .LC_edit_opt {
7456: padding-left: 1em;
7457: white-space: nowrap;
7458: }
7459:
1.1075.2.57 raeburn 7460: .LC_edit_problem_latexhelper{
7461: text-align: right;
7462: }
7463:
7464: #LC_edit_problem_colorful div{
7465: margin-left: 40px;
7466: }
7467:
1.1075.2.112 raeburn 7468: #LC_edit_problem_codemirror div{
7469: margin-left: 0px;
7470: }
7471:
1.911 bisitz 7472: img.stift {
1.803 bisitz 7473: border-width: 0;
7474: vertical-align: middle;
1.677 riegler 7475: }
1.680 riegler 7476:
1.923 bisitz 7477: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7478: vertical-align: top;
1.777 tempelho 7479: }
1.795 www 7480:
1.716 raeburn 7481: div.LC_createcourse {
1.911 bisitz 7482: margin: 10px 10px 10px 10px;
1.716 raeburn 7483: }
7484:
1.917 raeburn 7485: .LC_dccid {
1.1075.2.38 raeburn 7486: float: right;
1.917 raeburn 7487: margin: 0.2em 0 0 0;
7488: padding: 0;
7489: font-size: 90%;
7490: display:none;
7491: }
7492:
1.897 wenzelju 7493: ol.LC_primary_menu a:hover,
1.721 harmsja 7494: ol#LC_MenuBreadcrumbs a:hover,
7495: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7496: ul#LC_secondary_menu a:hover,
1.721 harmsja 7497: .LC_FormSectionClearButton input:hover
1.795 www 7498: ul.LC_TabContent li:hover a {
1.952 onken 7499: color:$button_hover;
1.911 bisitz 7500: text-decoration:none;
1.693 droeschl 7501: }
7502:
1.779 bisitz 7503: h1 {
1.911 bisitz 7504: padding: 0;
7505: line-height:130%;
1.693 droeschl 7506: }
1.698 harmsja 7507:
1.911 bisitz 7508: h2,
7509: h3,
7510: h4,
7511: h5,
7512: h6 {
7513: margin: 5px 0 5px 0;
7514: padding: 0;
7515: line-height:130%;
1.693 droeschl 7516: }
1.795 www 7517:
7518: .LC_hcell {
1.911 bisitz 7519: padding:3px 15px 3px 15px;
7520: margin: 0;
7521: background-color:$tabbg;
7522: color:$fontmenu;
7523: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7524: }
1.795 www 7525:
1.840 bisitz 7526: .LC_Box > .LC_hcell {
1.911 bisitz 7527: margin: 0 -10px 10px -10px;
1.835 bisitz 7528: }
7529:
1.721 harmsja 7530: .LC_noBorder {
1.911 bisitz 7531: border: 0;
1.698 harmsja 7532: }
1.693 droeschl 7533:
1.721 harmsja 7534: .LC_FormSectionClearButton input {
1.911 bisitz 7535: background-color:transparent;
7536: border: none;
7537: cursor:pointer;
7538: text-decoration:underline;
1.693 droeschl 7539: }
1.763 bisitz 7540:
7541: .LC_help_open_topic {
1.911 bisitz 7542: color: #FFFFFF;
7543: background-color: #EEEEFF;
7544: margin: 1px;
7545: padding: 4px;
7546: border: 1px solid #000033;
7547: white-space: nowrap;
7548: /* vertical-align: middle; */
1.759 neumanie 7549: }
1.693 droeschl 7550:
1.911 bisitz 7551: dl,
7552: ul,
7553: div,
7554: fieldset {
7555: margin: 10px 10px 10px 0;
7556: /* overflow: hidden; */
1.693 droeschl 7557: }
1.795 www 7558:
1.1075.2.90 raeburn 7559: article.geogebraweb div {
7560: margin: 0;
7561: }
7562:
1.838 bisitz 7563: fieldset > legend {
1.911 bisitz 7564: font-weight: bold;
7565: padding: 0 5px 0 5px;
1.838 bisitz 7566: }
7567:
1.813 bisitz 7568: #LC_nav_bar {
1.911 bisitz 7569: float: left;
1.995 raeburn 7570: background-color: $pgbg_or_bgcolor;
1.966 bisitz 7571: margin: 0 0 2px 0;
1.807 droeschl 7572: }
7573:
1.916 droeschl 7574: #LC_realm {
7575: margin: 0.2em 0 0 0;
7576: padding: 0;
7577: font-weight: bold;
7578: text-align: center;
1.995 raeburn 7579: background-color: $pgbg_or_bgcolor;
1.916 droeschl 7580: }
7581:
1.911 bisitz 7582: #LC_nav_bar em {
7583: font-weight: bold;
7584: font-style: normal;
1.807 droeschl 7585: }
7586:
1.897 wenzelju 7587: ol.LC_primary_menu {
1.934 droeschl 7588: margin: 0;
1.1075.2.2 raeburn 7589: padding: 0;
1.807 droeschl 7590: }
7591:
1.852 droeschl 7592: ol#LC_PathBreadcrumbs {
1.911 bisitz 7593: margin: 0;
1.693 droeschl 7594: }
7595:
1.897 wenzelju 7596: ol.LC_primary_menu li {
1.1075.2.2 raeburn 7597: color: RGB(80, 80, 80);
7598: vertical-align: middle;
7599: text-align: left;
7600: list-style: none;
1.1075.2.112 raeburn 7601: position: relative;
1.1075.2.2 raeburn 7602: float: left;
1.1075.2.112 raeburn 7603: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
7604: line-height: 1.5em;
1.1075.2.2 raeburn 7605: }
7606:
1.1075.2.113 raeburn 7607: ol.LC_primary_menu li a,
1.1075.2.112 raeburn 7608: ol.LC_primary_menu li p {
1.1075.2.2 raeburn 7609: display: block;
7610: margin: 0;
7611: padding: 0 5px 0 10px;
7612: text-decoration: none;
7613: }
7614:
1.1075.2.112 raeburn 7615: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
7616: display: inline-block;
7617: width: 95%;
7618: text-align: left;
7619: }
7620:
7621: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
7622: display: inline-block;
7623: width: 5%;
7624: float: right;
7625: text-align: right;
7626: font-size: 70%;
7627: }
7628:
7629: ol.LC_primary_menu ul {
1.1075.2.2 raeburn 7630: display: none;
1.1075.2.112 raeburn 7631: width: 15em;
1.1075.2.2 raeburn 7632: background-color: $data_table_light;
1.1075.2.112 raeburn 7633: position: absolute;
7634: top: 100%;
7635: }
7636:
7637: ol.LC_primary_menu ul ul {
7638: left: 100%;
7639: top: 0;
1.1075.2.2 raeburn 7640: }
7641:
1.1075.2.112 raeburn 7642: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2 raeburn 7643: display: block;
7644: position: absolute;
7645: margin: 0;
7646: padding: 0;
1.1075.2.5 raeburn 7647: z-index: 2;
1.1075.2.2 raeburn 7648: }
7649:
7650: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112 raeburn 7651: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2 raeburn 7652: font-size: 90%;
1.911 bisitz 7653: vertical-align: top;
1.1075.2.2 raeburn 7654: float: none;
1.1075.2.5 raeburn 7655: border-left: 1px solid black;
7656: border-right: 1px solid black;
1.1075.2.112 raeburn 7657: /* A dark bottom border to visualize different menu options;
7658: overwritten in the create_submenu routine for the last border-bottom of the menu */
7659: border-bottom: 1px solid $data_table_dark;
1.1075.2.2 raeburn 7660: }
7661:
1.1075.2.112 raeburn 7662: ol.LC_primary_menu li li p:hover {
7663: color:$button_hover;
7664: text-decoration:none;
7665: background-color:$data_table_dark;
1.1075.2.2 raeburn 7666: }
7667:
7668: ol.LC_primary_menu li li a:hover {
7669: color:$button_hover;
7670: background-color:$data_table_dark;
1.693 droeschl 7671: }
7672:
1.1075.2.112 raeburn 7673: /* Font-size equal to the size of the predecessors*/
7674: ol.LC_primary_menu li:hover li li {
7675: font-size: 100%;
7676: }
7677:
1.897 wenzelju 7678: ol.LC_primary_menu li img {
1.911 bisitz 7679: vertical-align: bottom;
1.934 droeschl 7680: height: 1.1em;
1.1075.2.3 raeburn 7681: margin: 0.2em 0 0 0;
1.693 droeschl 7682: }
7683:
1.897 wenzelju 7684: ol.LC_primary_menu a {
1.911 bisitz 7685: color: RGB(80, 80, 80);
7686: text-decoration: none;
1.693 droeschl 7687: }
1.795 www 7688:
1.949 droeschl 7689: ol.LC_primary_menu a.LC_new_message {
7690: font-weight:bold;
7691: color: darkred;
7692: }
7693:
1.975 raeburn 7694: ol.LC_docs_parameters {
7695: margin-left: 0;
7696: padding: 0;
7697: list-style: none;
7698: }
7699:
7700: ol.LC_docs_parameters li {
7701: margin: 0;
7702: padding-right: 20px;
7703: display: inline;
7704: }
7705:
1.976 raeburn 7706: ol.LC_docs_parameters li:before {
7707: content: "\\002022 \\0020";
7708: }
7709:
7710: li.LC_docs_parameters_title {
7711: font-weight: bold;
7712: }
7713:
7714: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7715: content: "";
7716: }
7717:
1.897 wenzelju 7718: ul#LC_secondary_menu {
1.1075.2.23 raeburn 7719: clear: right;
1.911 bisitz 7720: color: $fontmenu;
7721: background: $tabbg;
7722: list-style: none;
7723: padding: 0;
7724: margin: 0;
7725: width: 100%;
1.995 raeburn 7726: text-align: left;
1.1075.2.4 raeburn 7727: float: left;
1.808 droeschl 7728: }
7729:
1.897 wenzelju 7730: ul#LC_secondary_menu li {
1.911 bisitz 7731: font-weight: bold;
7732: line-height: 1.8em;
7733: border-right: 1px solid black;
1.1075.2.4 raeburn 7734: float: left;
7735: }
7736:
7737: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7738: background-color: $data_table_light;
7739: }
7740:
7741: ul#LC_secondary_menu li a {
7742: padding: 0 0.8em;
7743: }
7744:
7745: ul#LC_secondary_menu li ul {
7746: display: none;
7747: }
7748:
7749: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7750: display: block;
7751: position: absolute;
7752: margin: 0;
7753: padding: 0;
7754: list-style:none;
7755: float: none;
7756: background-color: $data_table_light;
1.1075.2.5 raeburn 7757: z-index: 2;
1.1075.2.10 raeburn 7758: margin-left: -1px;
1.1075.2.4 raeburn 7759: }
7760:
7761: ul#LC_secondary_menu li ul li {
7762: font-size: 90%;
7763: vertical-align: top;
7764: border-left: 1px solid black;
7765: border-right: 1px solid black;
1.1075.2.33 raeburn 7766: background-color: $data_table_light;
1.1075.2.4 raeburn 7767: list-style:none;
7768: float: none;
7769: }
7770:
7771: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7772: background-color: $data_table_dark;
1.807 droeschl 7773: }
7774:
1.847 tempelho 7775: ul.LC_TabContent {
1.911 bisitz 7776: display:block;
7777: background: $sidebg;
7778: border-bottom: solid 1px $lg_border_color;
7779: list-style:none;
1.1020 raeburn 7780: margin: -1px -10px 0 -10px;
1.911 bisitz 7781: padding: 0;
1.693 droeschl 7782: }
7783:
1.795 www 7784: ul.LC_TabContent li,
7785: ul.LC_TabContentBigger li {
1.911 bisitz 7786: float:left;
1.741 harmsja 7787: }
1.795 www 7788:
1.897 wenzelju 7789: ul#LC_secondary_menu li a {
1.911 bisitz 7790: color: $fontmenu;
7791: text-decoration: none;
1.693 droeschl 7792: }
1.795 www 7793:
1.721 harmsja 7794: ul.LC_TabContent {
1.952 onken 7795: min-height:20px;
1.721 harmsja 7796: }
1.795 www 7797:
7798: ul.LC_TabContent li {
1.911 bisitz 7799: vertical-align:middle;
1.959 onken 7800: padding: 0 16px 0 10px;
1.911 bisitz 7801: background-color:$tabbg;
7802: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7803: border-left: solid 1px $font;
1.721 harmsja 7804: }
1.795 www 7805:
1.847 tempelho 7806: ul.LC_TabContent .right {
1.911 bisitz 7807: float:right;
1.847 tempelho 7808: }
7809:
1.911 bisitz 7810: ul.LC_TabContent li a,
7811: ul.LC_TabContent li {
7812: color:rgb(47,47,47);
7813: text-decoration:none;
7814: font-size:95%;
7815: font-weight:bold;
1.952 onken 7816: min-height:20px;
7817: }
7818:
1.959 onken 7819: ul.LC_TabContent li a:hover,
7820: ul.LC_TabContent li a:focus {
1.952 onken 7821: color: $button_hover;
1.959 onken 7822: background:none;
7823: outline:none;
1.952 onken 7824: }
7825:
7826: ul.LC_TabContent li:hover {
7827: color: $button_hover;
7828: cursor:pointer;
1.721 harmsja 7829: }
1.795 www 7830:
1.911 bisitz 7831: ul.LC_TabContent li.active {
1.952 onken 7832: color: $font;
1.911 bisitz 7833: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7834: border-bottom:solid 1px #FFFFFF;
7835: cursor: default;
1.744 ehlerst 7836: }
1.795 www 7837:
1.959 onken 7838: ul.LC_TabContent li.active a {
7839: color:$font;
7840: background:#FFFFFF;
7841: outline: none;
7842: }
1.1047 raeburn 7843:
7844: ul.LC_TabContent li.goback {
7845: float: left;
7846: border-left: none;
7847: }
7848:
1.870 tempelho 7849: #maincoursedoc {
1.911 bisitz 7850: clear:both;
1.870 tempelho 7851: }
7852:
7853: ul.LC_TabContentBigger {
1.911 bisitz 7854: display:block;
7855: list-style:none;
7856: padding: 0;
1.870 tempelho 7857: }
7858:
1.795 www 7859: ul.LC_TabContentBigger li {
1.911 bisitz 7860: vertical-align:bottom;
7861: height: 30px;
7862: font-size:110%;
7863: font-weight:bold;
7864: color: #737373;
1.841 tempelho 7865: }
7866:
1.957 onken 7867: ul.LC_TabContentBigger li.active {
7868: position: relative;
7869: top: 1px;
7870: }
7871:
1.870 tempelho 7872: ul.LC_TabContentBigger li a {
1.911 bisitz 7873: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7874: height: 30px;
7875: line-height: 30px;
7876: text-align: center;
7877: display: block;
7878: text-decoration: none;
1.958 onken 7879: outline: none;
1.741 harmsja 7880: }
1.795 www 7881:
1.870 tempelho 7882: ul.LC_TabContentBigger li.active a {
1.911 bisitz 7883: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
7884: color:$font;
1.744 ehlerst 7885: }
1.795 www 7886:
1.870 tempelho 7887: ul.LC_TabContentBigger li b {
1.911 bisitz 7888: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7889: display: block;
7890: float: left;
7891: padding: 0 30px;
1.957 onken 7892: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7893: }
7894:
1.956 onken 7895: ul.LC_TabContentBigger li:hover b {
7896: color:$button_hover;
7897: }
7898:
1.870 tempelho 7899: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7900: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7901: color:$font;
1.957 onken 7902: border: 0;
1.741 harmsja 7903: }
1.693 droeschl 7904:
1.870 tempelho 7905:
1.862 bisitz 7906: ul.LC_CourseBreadcrumbs {
7907: background: $sidebg;
1.1020 raeburn 7908: height: 2em;
1.862 bisitz 7909: padding-left: 10px;
1.1020 raeburn 7910: margin: 0;
1.862 bisitz 7911: list-style-position: inside;
7912: }
7913:
1.911 bisitz 7914: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7915: ol#LC_PathBreadcrumbs {
1.911 bisitz 7916: padding-left: 10px;
7917: margin: 0;
1.933 droeschl 7918: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7919: }
7920:
1.911 bisitz 7921: ol#LC_MenuBreadcrumbs li,
7922: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7923: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7924: display: inline;
1.933 droeschl 7925: white-space: normal;
1.693 droeschl 7926: }
7927:
1.823 bisitz 7928: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7929: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7930: text-decoration: none;
7931: font-size:90%;
1.693 droeschl 7932: }
1.795 www 7933:
1.969 droeschl 7934: ol#LC_MenuBreadcrumbs h1 {
7935: display: inline;
7936: font-size: 90%;
7937: line-height: 2.5em;
7938: margin: 0;
7939: padding: 0;
7940: }
7941:
1.795 www 7942: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7943: text-decoration:none;
7944: font-size:100%;
7945: font-weight:bold;
1.693 droeschl 7946: }
1.795 www 7947:
1.840 bisitz 7948: .LC_Box {
1.911 bisitz 7949: border: solid 1px $lg_border_color;
7950: padding: 0 10px 10px 10px;
1.746 neumanie 7951: }
1.795 www 7952:
1.1020 raeburn 7953: .LC_DocsBox {
7954: border: solid 1px $lg_border_color;
7955: padding: 0 0 10px 10px;
7956: }
7957:
1.795 www 7958: .LC_AboutMe_Image {
1.911 bisitz 7959: float:left;
7960: margin-right:10px;
1.747 neumanie 7961: }
1.795 www 7962:
7963: .LC_Clear_AboutMe_Image {
1.911 bisitz 7964: clear:left;
1.747 neumanie 7965: }
1.795 www 7966:
1.721 harmsja 7967: dl.LC_ListStyleClean dt {
1.911 bisitz 7968: padding-right: 5px;
7969: display: table-header-group;
1.693 droeschl 7970: }
7971:
1.721 harmsja 7972: dl.LC_ListStyleClean dd {
1.911 bisitz 7973: display: table-row;
1.693 droeschl 7974: }
7975:
1.721 harmsja 7976: .LC_ListStyleClean,
7977: .LC_ListStyleSimple,
7978: .LC_ListStyleNormal,
1.795 www 7979: .LC_ListStyleSpecial {
1.911 bisitz 7980: /* display:block; */
7981: list-style-position: inside;
7982: list-style-type: none;
7983: overflow: hidden;
7984: padding: 0;
1.693 droeschl 7985: }
7986:
1.721 harmsja 7987: .LC_ListStyleSimple li,
7988: .LC_ListStyleSimple dd,
7989: .LC_ListStyleNormal li,
7990: .LC_ListStyleNormal dd,
7991: .LC_ListStyleSpecial li,
1.795 www 7992: .LC_ListStyleSpecial dd {
1.911 bisitz 7993: margin: 0;
7994: padding: 5px 5px 5px 10px;
7995: clear: both;
1.693 droeschl 7996: }
7997:
1.721 harmsja 7998: .LC_ListStyleClean li,
7999: .LC_ListStyleClean dd {
1.911 bisitz 8000: padding-top: 0;
8001: padding-bottom: 0;
1.693 droeschl 8002: }
8003:
1.721 harmsja 8004: .LC_ListStyleSimple dd,
1.795 www 8005: .LC_ListStyleSimple li {
1.911 bisitz 8006: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8007: }
8008:
1.721 harmsja 8009: .LC_ListStyleSpecial li,
8010: .LC_ListStyleSpecial dd {
1.911 bisitz 8011: list-style-type: none;
8012: background-color: RGB(220, 220, 220);
8013: margin-bottom: 4px;
1.693 droeschl 8014: }
8015:
1.721 harmsja 8016: table.LC_SimpleTable {
1.911 bisitz 8017: margin:5px;
8018: border:solid 1px $lg_border_color;
1.795 www 8019: }
1.693 droeschl 8020:
1.721 harmsja 8021: table.LC_SimpleTable tr {
1.911 bisitz 8022: padding: 0;
8023: border:solid 1px $lg_border_color;
1.693 droeschl 8024: }
1.795 www 8025:
8026: table.LC_SimpleTable thead {
1.911 bisitz 8027: background:rgb(220,220,220);
1.693 droeschl 8028: }
8029:
1.721 harmsja 8030: div.LC_columnSection {
1.911 bisitz 8031: display: block;
8032: clear: both;
8033: overflow: hidden;
8034: margin: 0;
1.693 droeschl 8035: }
8036:
1.721 harmsja 8037: div.LC_columnSection>* {
1.911 bisitz 8038: float: left;
8039: margin: 10px 20px 10px 0;
8040: overflow:hidden;
1.693 droeschl 8041: }
1.721 harmsja 8042:
1.795 www 8043: table em {
1.911 bisitz 8044: font-weight: bold;
8045: font-style: normal;
1.748 schulted 8046: }
1.795 www 8047:
1.779 bisitz 8048: table.LC_tableBrowseRes,
1.795 www 8049: table.LC_tableOfContent {
1.911 bisitz 8050: border:none;
8051: border-spacing: 1px;
8052: padding: 3px;
8053: background-color: #FFFFFF;
8054: font-size: 90%;
1.753 droeschl 8055: }
1.789 droeschl 8056:
1.911 bisitz 8057: table.LC_tableOfContent {
8058: border-collapse: collapse;
1.789 droeschl 8059: }
8060:
1.771 droeschl 8061: table.LC_tableBrowseRes a,
1.768 schulted 8062: table.LC_tableOfContent a {
1.911 bisitz 8063: background-color: transparent;
8064: text-decoration: none;
1.753 droeschl 8065: }
8066:
1.795 www 8067: table.LC_tableOfContent img {
1.911 bisitz 8068: border: none;
8069: height: 1.3em;
8070: vertical-align: text-bottom;
8071: margin-right: 0.3em;
1.753 droeschl 8072: }
1.757 schulted 8073:
1.795 www 8074: a#LC_content_toolbar_firsthomework {
1.911 bisitz 8075: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 8076: }
8077:
1.795 www 8078: a#LC_content_toolbar_everything {
1.911 bisitz 8079: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 8080: }
8081:
1.795 www 8082: a#LC_content_toolbar_uncompleted {
1.911 bisitz 8083: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 8084: }
8085:
1.795 www 8086: #LC_content_toolbar_clearbubbles {
1.911 bisitz 8087: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 8088: }
8089:
1.795 www 8090: a#LC_content_toolbar_changefolder {
1.911 bisitz 8091: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 8092: }
8093:
1.795 www 8094: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 8095: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 8096: }
8097:
1.1043 raeburn 8098: a#LC_content_toolbar_edittoplevel {
8099: background-image:url(/res/adm/pages/edittoplevel.gif);
8100: }
8101:
1.795 www 8102: ul#LC_toolbar li a:hover {
1.911 bisitz 8103: background-position: bottom center;
1.757 schulted 8104: }
8105:
1.795 www 8106: ul#LC_toolbar {
1.911 bisitz 8107: padding: 0;
8108: margin: 2px;
8109: list-style:none;
8110: position:relative;
8111: background-color:white;
1.1075.2.9 raeburn 8112: overflow: auto;
1.757 schulted 8113: }
8114:
1.795 www 8115: ul#LC_toolbar li {
1.911 bisitz 8116: border:1px solid white;
8117: padding: 0;
8118: margin: 0;
8119: float: left;
8120: display:inline;
8121: vertical-align:middle;
1.1075.2.9 raeburn 8122: white-space: nowrap;
1.911 bisitz 8123: }
1.757 schulted 8124:
1.783 amueller 8125:
1.795 www 8126: a.LC_toolbarItem {
1.911 bisitz 8127: display:block;
8128: padding: 0;
8129: margin: 0;
8130: height: 32px;
8131: width: 32px;
8132: color:white;
8133: border: none;
8134: background-repeat:no-repeat;
8135: background-color:transparent;
1.757 schulted 8136: }
8137:
1.915 droeschl 8138: ul.LC_funclist {
8139: margin: 0;
8140: padding: 0.5em 1em 0.5em 0;
8141: }
8142:
1.933 droeschl 8143: ul.LC_funclist > li:first-child {
8144: font-weight:bold;
8145: margin-left:0.8em;
8146: }
8147:
1.915 droeschl 8148: ul.LC_funclist + ul.LC_funclist {
8149: /*
8150: left border as a seperator if we have more than
8151: one list
8152: */
8153: border-left: 1px solid $sidebg;
8154: /*
8155: this hides the left border behind the border of the
8156: outer box if element is wrapped to the next 'line'
8157: */
8158: margin-left: -1px;
8159: }
8160:
1.843 bisitz 8161: ul.LC_funclist li {
1.915 droeschl 8162: display: inline;
1.782 bisitz 8163: white-space: nowrap;
1.915 droeschl 8164: margin: 0 0 0 25px;
8165: line-height: 150%;
1.782 bisitz 8166: }
8167:
1.974 wenzelju 8168: .LC_hidden {
8169: display: none;
8170: }
8171:
1.1030 www 8172: .LCmodal-overlay {
8173: position:fixed;
8174: top:0;
8175: right:0;
8176: bottom:0;
8177: left:0;
8178: height:100%;
8179: width:100%;
8180: margin:0;
8181: padding:0;
8182: background:#999;
8183: opacity:.75;
8184: filter: alpha(opacity=75);
8185: -moz-opacity: 0.75;
8186: z-index:101;
8187: }
8188:
8189: * html .LCmodal-overlay {
8190: position: absolute;
8191: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8192: }
8193:
8194: .LCmodal-window {
8195: position:fixed;
8196: top:50%;
8197: left:50%;
8198: margin:0;
8199: padding:0;
8200: z-index:102;
8201: }
8202:
8203: * html .LCmodal-window {
8204: position:absolute;
8205: }
8206:
8207: .LCclose-window {
8208: position:absolute;
8209: width:32px;
8210: height:32px;
8211: right:8px;
8212: top:8px;
8213: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8214: text-indent:-99999px;
8215: overflow:hidden;
8216: cursor:pointer;
8217: }
8218:
1.1075.2.158 raeburn 8219: .LCisDisabled {
8220: cursor: not-allowed;
8221: opacity: 0.5;
8222: }
8223:
8224: a[aria-disabled="true"] {
8225: color: currentColor;
8226: display: inline-block; /* For IE11/ MS Edge bug */
8227: pointer-events: none;
8228: text-decoration: none;
8229: }
8230:
1.1075.2.141 raeburn 8231: pre.LC_wordwrap {
8232: white-space: pre-wrap;
8233: white-space: -moz-pre-wrap;
8234: white-space: -pre-wrap;
8235: white-space: -o-pre-wrap;
8236: word-wrap: break-word;
8237: }
8238:
1.1075.2.17 raeburn 8239: /*
8240: styles used by TTH when "Default set of options to pass to tth/m
8241: when converting TeX" in course settings has been set
8242:
8243: option passed: -t
8244:
8245: */
8246:
8247: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8248: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8249: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8250: td div.norm {line-height:normal;}
8251:
8252: /*
8253: option passed -y3
8254: */
8255:
8256: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8257: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8258: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8259:
1.1075.2.121 raeburn 8260: #LC_minitab_header {
8261: float:left;
8262: width:100%;
8263: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8264: font-size:93%;
8265: line-height:normal;
8266: margin: 0.5em 0 0.5em 0;
8267: }
8268: #LC_minitab_header ul {
8269: margin:0;
8270: padding:10px 10px 0;
8271: list-style:none;
8272: }
8273: #LC_minitab_header li {
8274: float:left;
8275: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8276: margin:0;
8277: padding:0 0 0 9px;
8278: }
8279: #LC_minitab_header a {
8280: display:block;
8281: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8282: padding:5px 15px 4px 6px;
8283: }
8284: #LC_minitab_header #LC_current_minitab {
8285: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8286: }
8287: #LC_minitab_header #LC_current_minitab a {
8288: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8289: padding-bottom:5px;
8290: }
8291:
8292:
1.343 albertel 8293: END
8294: }
8295:
1.306 albertel 8296: =pod
8297:
8298: =item * &headtag()
8299:
8300: Returns a uniform footer for LON-CAPA web pages.
8301:
1.307 albertel 8302: Inputs: $title - optional title for the head
8303: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 8304: $args - optional arguments
1.319 albertel 8305: force_register - if is true call registerurl so the remote is
8306: informed
1.415 albertel 8307: redirect -> array ref of
8308: 1- seconds before redirect occurs
8309: 2- url to redirect to
8310: 3- whether the side effect should occur
1.315 albertel 8311: (side effect of setting
8312: $env{'internal.head.redirect'} to the url
8313: redirected too)
1.352 albertel 8314: domain -> force to color decorate a page for a specific
8315: domain
8316: function -> force usage of a specific rolish color scheme
8317: bgcolor -> override the default page bgcolor
1.460 albertel 8318: no_auto_mt_title
8319: -> prevent &mt()ing the title arg
1.464 albertel 8320:
1.306 albertel 8321: =cut
8322:
8323: sub headtag {
1.313 albertel 8324: my ($title,$head_extra,$args) = @_;
1.306 albertel 8325:
1.363 albertel 8326: my $function = $args->{'function'} || &get_users_function();
8327: my $domain = $args->{'domain'} || &determinedomain();
8328: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1075.2.52 raeburn 8329: my $httphost = $args->{'use_absolute'};
1.418 albertel 8330: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 8331: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 8332: #time(),
1.418 albertel 8333: $env{'environment.color.timestamp'},
1.363 albertel 8334: $function,$domain,$bgcolor);
8335:
1.369 www 8336: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 8337:
1.308 albertel 8338: my $result =
8339: '<head>'.
1.1075.2.56 raeburn 8340: &font_settings($args);
1.319 albertel 8341:
1.1075.2.72 raeburn 8342: my $inhibitprint;
8343: if ($args->{'print_suppress'}) {
8344: $inhibitprint = &print_suppression();
8345: }
1.1064 raeburn 8346:
1.461 albertel 8347: if (!$args->{'frameset'}) {
8348: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
8349: }
1.1075.2.12 raeburn 8350: if ($args->{'force_register'}) {
8351: $result .= &Apache::lonmenu::registerurl(1);
1.319 albertel 8352: }
1.436 albertel 8353: if (!$args->{'no_nav_bar'}
8354: && !$args->{'only_body'}
8355: && !$args->{'frameset'}) {
1.1075.2.52 raeburn 8356: $result .= &help_menu_js($httphost);
1.1032 www 8357: $result.=&modal_window();
1.1038 www 8358: $result.=&togglebox_script();
1.1034 www 8359: $result.=&wishlist_window();
1.1041 www 8360: $result.=&LCprogressbarUpdate_script();
1.1034 www 8361: } else {
8362: if ($args->{'add_modal'}) {
8363: $result.=&modal_window();
8364: }
8365: if ($args->{'add_wishlist'}) {
8366: $result.=&wishlist_window();
8367: }
1.1038 www 8368: if ($args->{'add_togglebox'}) {
8369: $result.=&togglebox_script();
8370: }
1.1041 www 8371: if ($args->{'add_progressbar'}) {
8372: $result.=&LCprogressbarUpdate_script();
8373: }
1.436 albertel 8374: }
1.314 albertel 8375: if (ref($args->{'redirect'})) {
1.414 albertel 8376: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 8377: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 8378: if (!$inhibit_continue) {
8379: $env{'internal.head.redirect'} = $url;
8380: }
1.313 albertel 8381: $result.=<<ADDMETA
8382: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 8383: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 8384: ADDMETA
1.1075.2.89 raeburn 8385: } else {
8386: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
8387: my $requrl = $env{'request.uri'};
8388: if ($requrl eq '') {
8389: $requrl = $ENV{'REQUEST_URI'};
8390: $requrl =~ s/\?.+$//;
8391: }
8392: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
8393: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
8394: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
8395: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
8396: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
8397: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145 raeburn 8398: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151 raeburn 8399: my ($offload,$offloadoth);
1.1075.2.89 raeburn 8400: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
8401: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145 raeburn 8402: $offload = 1;
1.1075.2.151 raeburn 8403: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8404: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8405: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8406: $offloadoth = 1;
8407: $dom_in_use = $env{'user.domain'};
8408: }
8409: }
1.1075.2.145 raeburn 8410: }
8411: }
8412: unless ($offload) {
8413: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
8414: if ($domdefs{'offloadoth'}{$lonhost}) {
8415: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8416: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8417: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8418: $offload = 1;
1.1075.2.151 raeburn 8419: $offloadoth = 1;
1.1075.2.145 raeburn 8420: $dom_in_use = $env{'user.domain'};
8421: }
1.1075.2.89 raeburn 8422: }
1.1075.2.145 raeburn 8423: }
8424: }
8425: }
8426: if ($offload) {
1.1075.2.158 raeburn 8427: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151 raeburn 8428: if (($newserver eq '') && ($offloadoth)) {
8429: my @domains = &Apache::lonnet::current_machine_domains();
1.1075.2.161. .1(raebu 8430:21): if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
1.1075.2.151 raeburn 8431: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
8432: }
8433: }
1.1075.2.145 raeburn 8434: if (($newserver) && ($newserver ne $lonhost)) {
8435: my $numsec = 5;
8436: my $timeout = $numsec * 1000;
8437: my ($newurl,$locknum,%locks,$msg);
8438: if ($env{'request.role.adv'}) {
8439: ($locknum,%locks) = &Apache::lonnet::get_locks();
8440: }
8441: my $disable_submit = 0;
8442: if ($requrl =~ /$LONCAPA::assess_re/) {
8443: $disable_submit = 1;
8444: }
8445: if ($locknum) {
8446: my @lockinfo = sort(values(%locks));
1.1075.2.153 raeburn 8447: $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145 raeburn 8448: join(", ",sort(values(%locks)))."\n";
8449: if (&show_course()) {
8450: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89 raeburn 8451: } else {
1.1075.2.145 raeburn 8452: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
8453: }
8454: } else {
8455: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8456: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
8457: }
8458: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8459: $newurl = '/adm/switchserver?otherserver='.$newserver;
8460: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8461: $newurl .= '&role='.$env{'request.role'};
8462: }
8463: if ($env{'request.symb'}) {
8464: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
8465: if ($shownsymb =~ m{^/enc/}) {
8466: my $reqdmajor = 2;
8467: my $reqdminor = 11;
8468: my $reqdsubminor = 3;
8469: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
8470: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
8471: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
8472: if (($major eq '' && $minor eq '') ||
8473: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
8474: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
8475: ($reqdsubminor > $subminor))))) {
8476: undef($shownsymb);
8477: }
1.1075.2.89 raeburn 8478: }
1.1075.2.145 raeburn 8479: if ($shownsymb) {
8480: &js_escape(\$shownsymb);
8481: $newurl .= '&symb='.$shownsymb;
1.1075.2.89 raeburn 8482: }
1.1075.2.145 raeburn 8483: } else {
8484: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
8485: &js_escape(\$shownurl);
8486: $newurl .= '&origurl='.$shownurl;
1.1075.2.89 raeburn 8487: }
1.1075.2.145 raeburn 8488: }
8489: &js_escape(\$msg);
8490: $result.=<<OFFLOAD
1.1075.2.89 raeburn 8491: <meta http-equiv="pragma" content="no-cache" />
8492: <script type="text/javascript">
1.1075.2.92 raeburn 8493: // <![CDATA[
1.1075.2.89 raeburn 8494: function LC_Offload_Now() {
8495: var dest = "$newurl";
8496: if (dest != '') {
8497: window.location.href="$newurl";
8498: }
8499: }
1.1075.2.92 raeburn 8500: \$(document).ready(function () {
8501: window.alert('$msg');
8502: if ($disable_submit) {
1.1075.2.89 raeburn 8503: \$(".LC_hwk_submit").prop("disabled", true);
8504: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92 raeburn 8505: }
8506: setTimeout('LC_Offload_Now()', $timeout);
8507: });
8508: // ]]>
1.1075.2.89 raeburn 8509: </script>
8510: OFFLOAD
8511: }
8512: }
8513: }
8514: }
8515: }
1.313 albertel 8516: }
1.306 albertel 8517: if (!defined($title)) {
8518: $title = 'The LearningOnline Network with CAPA';
8519: }
1.460 albertel 8520: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
8521: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61 raeburn 8522: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
8523: if (!$args->{'frameset'}) {
8524: $result .= ' /';
8525: }
8526: $result .= '>'
1.1064 raeburn 8527: .$inhibitprint
1.414 albertel 8528: .$head_extra;
1.1075.2.108 raeburn 8529: my $clientmobile;
8530: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
8531: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
8532: } else {
8533: $clientmobile = $env{'browser.mobile'};
8534: }
8535: if ($clientmobile) {
1.1075.2.42 raeburn 8536: $result .= '
8537: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
8538: <meta name="apple-mobile-web-app-capable" content="yes" />';
8539: }
1.1075.2.126 raeburn 8540: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 8541: return $result.'</head>';
1.306 albertel 8542: }
8543:
8544: =pod
8545:
1.340 albertel 8546: =item * &font_settings()
8547:
8548: Returns neccessary <meta> to set the proper encoding
8549:
1.1075.2.56 raeburn 8550: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 8551:
8552: =cut
8553:
8554: sub font_settings {
1.1075.2.56 raeburn 8555: my ($args) = @_;
1.340 albertel 8556: my $headerstring='';
1.1075.2.56 raeburn 8557: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
8558: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340 albertel 8559: $headerstring.=
1.1075.2.61 raeburn 8560: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
8561: if (!$args->{'frameset'}) {
8562: $headerstring.= ' /';
8563: }
8564: $headerstring .= '>'."\n";
1.340 albertel 8565: }
8566: return $headerstring;
8567: }
8568:
1.341 albertel 8569: =pod
8570:
1.1064 raeburn 8571: =item * &print_suppression()
8572:
8573: In course context returns css which causes the body to be blank when media="print",
8574: if printout generation is unavailable for the current resource.
8575:
8576: This could be because:
8577:
8578: (a) printstartdate is in the future
8579:
8580: (b) printenddate is in the past
8581:
8582: (c) there is an active exam block with "printout"
8583: functionality blocked
8584:
8585: Users with pav, pfo or evb privileges are exempt.
8586:
8587: Inputs: none
8588:
8589: =cut
8590:
8591:
8592: sub print_suppression {
8593: my $noprint;
8594: if ($env{'request.course.id'}) {
8595: my $scope = $env{'request.course.id'};
8596: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8597: (&Apache::lonnet::allowed('pfo',$scope))) {
8598: return;
8599: }
8600: if ($env{'request.course.sec'} ne '') {
8601: $scope .= "/$env{'request.course.sec'}";
8602: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8603: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 8604: return;
1.1064 raeburn 8605: }
8606: }
8607: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8608: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158 raeburn 8609: my $clientip = &Apache::lonnet::get_requestor_ip();
8610: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 8611: if ($blocked) {
8612: my $checkrole = "cm./$cdom/$cnum";
8613: if ($env{'request.course.sec'} ne '') {
8614: $checkrole .= "/$env{'request.course.sec'}";
8615: }
8616: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
8617: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
8618: $noprint = 1;
8619: }
8620: }
8621: unless ($noprint) {
8622: my $symb = &Apache::lonnet::symbread();
8623: if ($symb ne '') {
8624: my $navmap = Apache::lonnavmaps::navmap->new();
8625: if (ref($navmap)) {
8626: my $res = $navmap->getBySymb($symb);
8627: if (ref($res)) {
8628: if (!$res->resprintable()) {
8629: $noprint = 1;
8630: }
8631: }
8632: }
8633: }
8634: }
8635: if ($noprint) {
8636: return <<"ENDSTYLE";
8637: <style type="text/css" media="print">
8638: body { display:none }
8639: </style>
8640: ENDSTYLE
8641: }
8642: }
8643: return;
8644: }
8645:
8646: =pod
8647:
1.341 albertel 8648: =item * &xml_begin()
8649:
8650: Returns the needed doctype and <html>
8651:
8652: Inputs: none
8653:
8654: =cut
8655:
8656: sub xml_begin {
1.1075.2.61 raeburn 8657: my ($is_frameset) = @_;
1.341 albertel 8658: my $output='';
8659:
8660: if ($env{'browser.mathml'}) {
8661: $output='<?xml version="1.0"?>'
8662: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
8663: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
8664:
8665: # .'<!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">] >'
8666: .'<!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">'
8667: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
8668: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61 raeburn 8669: } elsif ($is_frameset) {
8670: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
8671: '<html>'."\n";
1.341 albertel 8672: } else {
1.1075.2.61 raeburn 8673: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
8674: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 8675: }
8676: return $output;
8677: }
1.340 albertel 8678:
8679: =pod
8680:
1.306 albertel 8681: =item * &start_page()
8682:
8683: Returns a complete <html> .. <body> section for LON-CAPA web pages.
8684:
1.648 raeburn 8685: Inputs:
8686:
8687: =over 4
8688:
8689: $title - optional title for the page
8690:
8691: $head_extra - optional extra HTML to incude inside the <head>
8692:
8693: $args - additional optional args supported are:
8694:
8695: =over 8
8696:
8697: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 8698: arg on
1.814 bisitz 8699: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 8700: add_entries -> additional attributes to add to the <body>
8701: domain -> force to color decorate a page for a
1.317 albertel 8702: specific domain
1.648 raeburn 8703: function -> force usage of a specific rolish color
1.317 albertel 8704: scheme
1.648 raeburn 8705: redirect -> see &headtag()
8706: bgcolor -> override the default page bg color
8707: js_ready -> return a string ready for being used in
1.317 albertel 8708: a javascript writeln
1.648 raeburn 8709: html_encode -> return a string ready for being used in
1.320 albertel 8710: a html attribute
1.648 raeburn 8711: force_register -> if is true will turn on the &bodytag()
1.317 albertel 8712: $forcereg arg
1.648 raeburn 8713: frameset -> if true will start with a <frameset>
1.330 albertel 8714: rather than <body>
1.648 raeburn 8715: skip_phases -> hash ref of
1.338 albertel 8716: head -> skip the <html><head> generation
8717: body -> skip all <body> generation
1.1075.2.12 raeburn 8718: no_inline_link -> if true and in remote mode, don't show the
8719: 'Switch To Inline Menu' link
1.648 raeburn 8720: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 8721: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 8722: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1075.2.123 raeburn 8723: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
8724: to lonhtmlcommon::breadcrumbs
1.1075.2.15 raeburn 8725: group -> includes the current group, if page is for a
8726: specific group
1.1075.2.133 raeburn 8727: use_absolute -> for request for external resource or syllabus, this
8728: will contain https://<hostname> if server uses
8729: https (as per hosts.tab), but request is for http
8730: hostname -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158 raeburn 8731: links_disabled -> Links in primary and secondary menus are disabled
8732: (Can enable them once page has loaded - see lonroles.pm
8733: for an example).
1.1075.2.161. .6(raebu 8734:22): links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 8735:
1.648 raeburn 8736: =back
1.460 albertel 8737:
1.648 raeburn 8738: =back
1.562 albertel 8739:
1.306 albertel 8740: =cut
8741:
8742: sub start_page {
1.309 albertel 8743: my ($title,$head_extra,$args) = @_;
1.318 albertel 8744: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 8745:
1.315 albertel 8746: $env{'internal.start_page'}++;
1.1075.2.161. .1(raebu 8747:21): my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 8748:
1.338 albertel 8749: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62 raeburn 8750: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 8751: }
1.1075.2.161. .1(raebu 8752:21):
8753:21): if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
8754:21): if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
8755:21): unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
8756:21): $args->{'no_primary_menu'} = 1;
8757:21): }
8758:21): unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
8759:21): $args->{'no_inline_menu'} = 1;
8760:21): }
8761:21): if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
8762:21): map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
8763:21): }
8764:21): } else {
8765:21): my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8766:21): my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
8767:21): if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
8768:21): unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
8769:21): $args->{'no_primary_menu'} = 1;
8770:21): }
8771:21): unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
8772:21): $args->{'no_inline_menu'} = 1;
8773:21): }
8774:21): if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
8775:21): map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
8776:21): }
8777:21): }
8778:21): }
8779:21): ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
8780:21): $env{'course.'.$env{'request.course.id'}.'.domain'},
8781:21): $env{'course.'.$env{'request.course.id'}.'.num'});
8782:21): } elsif ($env{'request.course.id'}) {
8783:21): my $expiretime=600;
8784:21): if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
8785:21): &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
8786:21): }
8787:21): my ($deeplinkmenu,$menuref);
8788:21): ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
8789:21): if ($menucoll) {
8790:21): if (ref($menuref) eq 'HASH') {
8791:21): %menu = %{$menuref};
8792:21): }
8793:21): if ($menu{'top'} eq 'n') {
8794:21): $args->{'no_primary_menu'} = 1;
8795:21): }
8796:21): if ($menu{'inline'} eq 'n') {
8797:21): unless (&Apache::lonnet::allowed('opa')) {
8798:21): my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8799:21): my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8800:21): my $crstype = &course_type();
8801:21): my $now = time;
8802:21): my $ccrole;
8803:21): if ($crstype eq 'Community') {
8804:21): $ccrole = 'co';
8805:21): } else {
8806:21): $ccrole = 'cc';
8807:21): }
8808:21): if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
8809:21): my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
8810:21): if ((($start) && ($start<0)) ||
8811:21): (($end) && ($end<$now)) ||
8812:21): (($start) && ($now<$start))) {
8813:21): $args->{'no_inline_menu'} = 1;
8814:21): }
8815:21): } else {
8816:21): $args->{'no_inline_menu'} = 1;
8817:21): }
8818:21): }
8819:21): }
8820:21): }
8821:21): }
.4(raebu 8822:22):
1.338 albertel 8823: if (! exists($args->{'skip_phases'}{'body'}) ) {
8824: if ($args->{'frameset'}) {
8825: my $attr_string = &make_attr_string($args->{'force_register'},
8826: $args->{'add_entries'});
8827: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 8828: } else {
8829: $result .=
8830: &bodytag($title,
8831: $args->{'function'}, $args->{'add_entries'},
8832: $args->{'only_body'}, $args->{'domain'},
8833: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12 raeburn 8834: $args->{'bgcolor'}, $args->{'no_inline_link'},
1.1075.2.161. .1(raebu 8835:21): $args, \@advtools,
8836:21): $ltiscope,$ltiuri,\%ltimenu,$menucoll,\%menu);
1.831 bisitz 8837: }
1.330 albertel 8838: }
1.338 albertel 8839:
1.315 albertel 8840: if ($args->{'js_ready'}) {
1.713 kaisler 8841: $result = &js_ready($result);
1.315 albertel 8842: }
1.320 albertel 8843: if ($args->{'html_encode'}) {
1.713 kaisler 8844: $result = &html_encode($result);
8845: }
8846:
1.813 bisitz 8847: # Preparation for new and consistent functionlist at top of screen
8848: # if ($args->{'functionlist'}) {
8849: # $result .= &build_functionlist();
8850: #}
8851:
1.964 droeschl 8852: # Don't add anything more if only_body wanted or in const space
8853: return $result if $args->{'only_body'}
8854: || $env{'request.state'} eq 'construct';
1.813 bisitz 8855:
8856: #Breadcrumbs
1.758 kaisler 8857: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
8858: &Apache::lonhtmlcommon::clear_breadcrumbs();
8859: #if any br links exists, add them to the breadcrumbs
8860: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
8861: foreach my $crumb (@{$args->{'bread_crumbs'}}){
8862: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
8863: }
8864: }
1.1075.2.19 raeburn 8865: # if @advtools array contains items add then to the breadcrumbs
8866: if (@advtools > 0) {
8867: &Apache::lonmenu::advtools_crumbs(@advtools);
8868: }
1.1075.2.123 raeburn 8869: my $menulink;
8870: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
1.1075.2.161. .1(raebu 8871:21): if ((exists($args->{'bread_crumbs_nomenu'})) ||
8872:21): ($ltiscope eq 'map') || ($ltiscope eq 'resource')) {
1.1075.2.123 raeburn 8873: $menulink = 0;
8874: } else {
8875: undef($menulink);
8876: }
1.758 kaisler 8877: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
8878: if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123 raeburn 8879: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1075.2.161. .1(raebu 8880:21): } else {
1.1075.2.123 raeburn 8881: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 8882: }
1.1075.2.24 raeburn 8883: } elsif (($env{'environment.remote'} eq 'on') &&
8884: ($env{'form.inhibitmenu'} ne 'yes') &&
8885: ($env{'request.noversionuri'} =~ m{^/res/}) &&
8886: ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21 raeburn 8887: $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320 albertel 8888: }
1.315 albertel 8889: return $result;
1.306 albertel 8890: }
8891:
8892: sub end_page {
1.315 albertel 8893: my ($args) = @_;
8894: $env{'internal.end_page'}++;
1.330 albertel 8895: my $result;
1.335 albertel 8896: if ($args->{'discussion'}) {
8897: my ($target,$parser);
8898: if (ref($args->{'discussion'})) {
8899: ($target,$parser) =($args->{'discussion'}{'target'},
8900: $args->{'discussion'}{'parser'});
8901: }
8902: $result .= &Apache::lonxml::xmlend($target,$parser);
8903: }
1.330 albertel 8904: if ($args->{'frameset'}) {
8905: $result .= '</frameset>';
8906: } else {
1.635 raeburn 8907: $result .= &endbodytag($args);
1.330 albertel 8908: }
1.1075.2.6 raeburn 8909: unless ($args->{'notbody'}) {
8910: $result .= "\n</html>";
8911: }
1.330 albertel 8912:
1.315 albertel 8913: if ($args->{'js_ready'}) {
1.317 albertel 8914: $result = &js_ready($result);
1.315 albertel 8915: }
1.335 albertel 8916:
1.320 albertel 8917: if ($args->{'html_encode'}) {
8918: $result = &html_encode($result);
8919: }
1.335 albertel 8920:
1.315 albertel 8921: return $result;
8922: }
8923:
1.1075.2.161. .1(raebu 8924:21): sub menucoll_in_effect {
8925:21): my ($menucoll,$deeplinkmenu,%menu);
8926:21): if ($env{'request.course.id'}) {
8927:21): $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
8928:21): if ($env{'request.deeplink.login'}) {
8929:21): my ($deeplink_symb,$deeplink,$check_login_symb);
8930:21): my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8931:21): my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8932:21): if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
8933:21): if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
8934:21): my $navmap = Apache::lonnavmaps::navmap->new();
8935:21): if (ref($navmap)) {
8936:21): $deeplink = $navmap->get_mapparam(undef,
8937:21): &Apache::lonnet::declutter($env{'request.noversionuri'}),
8938:21): '0.deeplink');
8939:21): } else {
8940:21): $check_login_symb = 1;
8941:21): }
8942:21): } else {
8943:21): my $symb=&Apache::lonnet::symbread();
8944:21): if ($symb) {
8945:21): $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
8946:21): } else {
8947:21): $check_login_symb = 1;
8948:21): }
8949:21): }
8950:21): } else {
8951:21): $check_login_symb = 1;
8952:21): }
8953:21): if ($check_login_symb) {
8954:21): $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
8955:21): if ($deeplink_symb =~ /\.(page|sequence)$/) {
8956:21): my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
8957:21): my $navmap = Apache::lonnavmaps::navmap->new();
8958:21): if (ref($navmap)) {
8959:21): $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
8960:21): }
8961:21): } else {
8962:21): $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
8963:21): }
8964:21): }
8965:21): if ($deeplink ne '') {
.6(raebu 8966:22): my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
.1(raebu 8967:21): if ($display =~ /^\d+$/) {
8968:21): $deeplinkmenu = 1;
8969:21): $menucoll = $display;
8970:21): }
8971:21): }
8972:21): }
8973:21): if ($menucoll) {
8974:21): %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
8975:21): }
8976:21): }
8977:21): return ($menucoll,$deeplinkmenu,\%menu);
8978:21): }
8979:21):
8980:21): sub deeplink_login_symb {
8981:21): my ($cnum,$cdom) = @_;
8982:21): my $login_symb;
8983:21): if ($env{'request.deeplink.login'}) {
8984:21): $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
8985:21): }
8986:21): return $login_symb;
8987:21): }
8988:21):
8989:21): sub symb_from_tinyurl {
8990:21): my ($url,$cnum,$cdom) = @_;
8991:21): if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
8992:21): my $key = $1;
8993:21): my ($tinyurl,$login);
8994:21): my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
8995:21): if (defined($cached)) {
8996:21): $tinyurl = $result;
8997:21): } else {
8998:21): my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
8999:21): my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
9000:21): if ($currtiny{$key} ne '') {
9001:21): $tinyurl = $currtiny{$key};
9002:21): &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
9003:21): }
9004:21): }
9005:21): if ($tinyurl ne '') {
9006:21): my ($cnumreq,$symb) = split(/\&/,$tinyurl);
9007:21): if (wantarray) {
9008:21): return ($cnumreq,$symb);
9009:21): } elsif ($cnumreq eq $cnum) {
9010:21): return $symb;
9011:21): }
9012:21): }
9013:21): }
9014:21): if (wantarray) {
9015:21): return ();
9016:21): } else {
9017:21): return;
9018:21): }
9019:21): }
9020:21):
1.1034 www 9021: sub wishlist_window {
9022: return(<<'ENDWISHLIST');
1.1046 raeburn 9023: <script type="text/javascript">
1.1034 www 9024: // <![CDATA[
9025: // <!-- BEGIN LON-CAPA Internal
9026: function set_wishlistlink(title, path) {
9027: if (!title) {
9028: title = document.title;
9029: title = title.replace(/^LON-CAPA /,'');
9030: }
1.1075.2.65 raeburn 9031: title = encodeURIComponent(title);
1.1075.2.83 raeburn 9032: title = title.replace("'","\\\'");
1.1034 www 9033: if (!path) {
9034: path = location.pathname;
9035: }
1.1075.2.65 raeburn 9036: path = encodeURIComponent(path);
1.1075.2.83 raeburn 9037: path = path.replace("'","\\\'");
1.1034 www 9038: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
9039: 'wishlistNewLink','width=560,height=350,scrollbars=0');
9040: }
9041: // END LON-CAPA Internal -->
9042: // ]]>
9043: </script>
9044: ENDWISHLIST
9045: }
9046:
1.1030 www 9047: sub modal_window {
9048: return(<<'ENDMODAL');
1.1046 raeburn 9049: <script type="text/javascript">
1.1030 www 9050: // <![CDATA[
9051: // <!-- BEGIN LON-CAPA Internal
9052: var modalWindow = {
9053: parent:"body",
9054: windowId:null,
9055: content:null,
9056: width:null,
9057: height:null,
9058: close:function()
9059: {
9060: $(".LCmodal-window").remove();
9061: $(".LCmodal-overlay").remove();
9062: },
9063: open:function()
9064: {
9065: var modal = "";
9066: modal += "<div class=\"LCmodal-overlay\"></div>";
9067: 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;\">";
9068: modal += this.content;
9069: modal += "</div>";
9070:
9071: $(this.parent).append(modal);
9072:
9073: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
9074: $(".LCclose-window").click(function(){modalWindow.close();});
9075: $(".LCmodal-overlay").click(function(){modalWindow.close();});
9076: }
9077: };
1.1075.2.42 raeburn 9078: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 9079: {
1.1075.2.119 raeburn 9080: source = source.replace(/'/g,"'");
1.1030 www 9081: modalWindow.windowId = "myModal";
9082: modalWindow.width = width;
9083: modalWindow.height = height;
1.1075.2.80 raeburn 9084: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 9085: modalWindow.open();
1.1075.2.87 raeburn 9086: };
1.1030 www 9087: // END LON-CAPA Internal -->
9088: // ]]>
9089: </script>
9090: ENDMODAL
9091: }
9092:
9093: sub modal_link {
1.1075.2.42 raeburn 9094: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 9095: unless ($width) { $width=480; }
9096: unless ($height) { $height=400; }
1.1031 www 9097: unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42 raeburn 9098: unless ($transparency) { $transparency='true'; }
9099:
1.1074 raeburn 9100: my $target_attr;
9101: if (defined($target)) {
9102: $target_attr = 'target="'.$target.'"';
9103: }
9104: return <<"ENDLINK";
1.1075.2.143 raeburn 9105: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 9106: ENDLINK
1.1030 www 9107: }
9108:
1.1032 www 9109: sub modal_adhoc_script {
1.1075.2.155 raeburn 9110: my ($funcname,$width,$height,$content,$possmathjax)=@_;
9111: my $mathjax;
9112: if ($possmathjax) {
9113: $mathjax = <<'ENDJAX';
9114: if (typeof MathJax == 'object') {
9115: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
9116: }
9117: ENDJAX
9118: }
1.1032 www 9119: return (<<ENDADHOC);
1.1046 raeburn 9120: <script type="text/javascript">
1.1032 www 9121: // <![CDATA[
9122: var $funcname = function()
9123: {
9124: modalWindow.windowId = "myModal";
9125: modalWindow.width = $width;
9126: modalWindow.height = $height;
9127: modalWindow.content = '$content';
9128: modalWindow.open();
1.1075.2.155 raeburn 9129: $mathjax
1.1032 www 9130: };
9131: // ]]>
9132: </script>
9133: ENDADHOC
9134: }
9135:
1.1041 www 9136: sub modal_adhoc_inner {
1.1075.2.155 raeburn 9137: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 9138: my $innerwidth=$width-20;
9139: $content=&js_ready(
1.1042 www 9140: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42 raeburn 9141: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
9142: $content.
1.1041 www 9143: &end_scrollbox().
1.1075.2.42 raeburn 9144: &end_page()
1.1041 www 9145: );
1.1075.2.155 raeburn 9146: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 9147: }
9148:
9149: sub modal_adhoc_window {
1.1075.2.155 raeburn 9150: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
9151: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 9152: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
9153: }
9154:
9155: sub modal_adhoc_launch {
9156: my ($funcname,$width,$height,$content)=@_;
9157: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
9158: <script type="text/javascript">
9159: // <![CDATA[
9160: $funcname();
9161: // ]]>
9162: </script>
9163: ENDLAUNCH
9164: }
9165:
9166: sub modal_adhoc_close {
9167: return (<<ENDCLOSE);
9168: <script type="text/javascript">
9169: // <![CDATA[
9170: modalWindow.close();
9171: // ]]>
9172: </script>
9173: ENDCLOSE
9174: }
9175:
1.1038 www 9176: sub togglebox_script {
9177: return(<<ENDTOGGLE);
9178: <script type="text/javascript">
9179: // <![CDATA[
9180: function LCtoggleDisplay(id,hidetext,showtext) {
9181: link = document.getElementById(id + "link").childNodes[0];
9182: with (document.getElementById(id).style) {
9183: if (display == "none" ) {
9184: display = "inline";
9185: link.nodeValue = hidetext;
9186: } else {
9187: display = "none";
9188: link.nodeValue = showtext;
9189: }
9190: }
9191: }
9192: // ]]>
9193: </script>
9194: ENDTOGGLE
9195: }
9196:
1.1039 www 9197: sub start_togglebox {
9198: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
9199: unless ($heading) { $heading=''; } else { $heading.=' '; }
9200: unless ($showtext) { $showtext=&mt('show'); }
9201: unless ($hidetext) { $hidetext=&mt('hide'); }
9202: unless ($headerbg) { $headerbg='#FFFFFF'; }
9203: return &start_data_table().
9204: &start_data_table_header_row().
9205: '<td bgcolor="'.$headerbg.'">'.$heading.
9206: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
9207: $showtext.'\')">'.$showtext.'</a>]</td>'.
9208: &end_data_table_header_row().
9209: '<tr id="'.$id.'" style="display:none""><td>';
9210: }
9211:
9212: sub end_togglebox {
9213: return '</td></tr>'.&end_data_table();
9214: }
9215:
1.1041 www 9216: sub LCprogressbar_script {
1.1075.2.130 raeburn 9217: my ($id,$number_to_do)=@_;
9218: if ($number_to_do) {
9219: return(<<ENDPROGRESS);
1.1041 www 9220: <script type="text/javascript">
9221: // <![CDATA[
1.1045 www 9222: \$('#progressbar$id').progressbar({
1.1041 www 9223: value: 0,
9224: change: function(event, ui) {
9225: var newVal = \$(this).progressbar('option', 'value');
9226: \$('.pblabel', this).text(LCprogressTxt);
9227: }
9228: });
9229: // ]]>
9230: </script>
9231: ENDPROGRESS
1.1075.2.130 raeburn 9232: } else {
9233: return(<<ENDPROGRESS);
9234: <script type="text/javascript">
9235: // <![CDATA[
9236: \$('#progressbar$id').progressbar({
9237: value: false,
9238: create: function(event, ui) {
9239: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
9240: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
9241: }
9242: });
9243: // ]]>
9244: </script>
9245: ENDPROGRESS
9246: }
1.1041 www 9247: }
9248:
9249: sub LCprogressbarUpdate_script {
9250: return(<<ENDPROGRESSUPDATE);
9251: <style type="text/css">
9252: .ui-progressbar { position:relative; }
1.1075.2.130 raeburn 9253: .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 9254: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
9255: </style>
9256: <script type="text/javascript">
9257: // <![CDATA[
1.1045 www 9258: var LCprogressTxt='---';
9259:
1.1075.2.130 raeburn 9260: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 9261: LCprogressTxt=progresstext;
1.1075.2.130 raeburn 9262: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
9263: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
9264: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
9265: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
9266: } else {
9267: \$('#progressbar'+id).progressbar('value',percent);
9268: }
1.1041 www 9269: }
9270: // ]]>
9271: </script>
9272: ENDPROGRESSUPDATE
9273: }
9274:
1.1042 www 9275: my $LClastpercent;
1.1045 www 9276: my $LCidcnt;
9277: my $LCcurrentid;
1.1042 www 9278:
1.1041 www 9279: sub LCprogressbar {
1.1075.2.130 raeburn 9280: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 9281: $LClastpercent=0;
1.1045 www 9282: $LCidcnt++;
9283: $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130 raeburn 9284: my ($starting,$content);
9285: if ($number_to_do) {
9286: $starting=&mt('Starting');
9287: $content=(<<ENDPROGBAR);
9288: $preamble
1.1045 www 9289: <div id="progressbar$LCcurrentid">
1.1041 www 9290: <span class="pblabel">$starting</span>
9291: </div>
9292: ENDPROGBAR
1.1075.2.130 raeburn 9293: } else {
9294: $starting=&mt('Loading...');
9295: $LClastpercent='false';
9296: $content=(<<ENDPROGBAR);
9297: $preamble
9298: <div id="progressbar$LCcurrentid">
9299: <div class="progress-label">$starting</div>
9300: </div>
9301: ENDPROGBAR
9302: }
9303: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 9304: }
9305:
9306: sub LCprogressbarUpdate {
1.1075.2.130 raeburn 9307: my ($r,$val,$text,$number_to_do)=@_;
9308: if ($number_to_do) {
9309: unless ($val) {
9310: if ($LClastpercent) {
9311: $val=$LClastpercent;
9312: } else {
9313: $val=0;
9314: }
9315: }
9316: if ($val<0) { $val=0; }
9317: if ($val>100) { $val=0; }
9318: $LClastpercent=$val;
9319: unless ($text) { $text=$val.'%'; }
9320: } else {
9321: $val = 'false';
1.1042 www 9322: }
1.1041 www 9323: $text=&js_ready($text);
1.1044 www 9324: &r_print($r,<<ENDUPDATE);
1.1041 www 9325: <script type="text/javascript">
9326: // <![CDATA[
1.1075.2.130 raeburn 9327: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 9328: // ]]>
9329: </script>
9330: ENDUPDATE
1.1035 www 9331: }
9332:
1.1042 www 9333: sub LCprogressbarClose {
9334: my ($r)=@_;
9335: $LClastpercent=0;
1.1044 www 9336: &r_print($r,<<ENDCLOSE);
1.1042 www 9337: <script type="text/javascript">
9338: // <![CDATA[
1.1045 www 9339: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 9340: // ]]>
9341: </script>
9342: ENDCLOSE
1.1044 www 9343: }
9344:
9345: sub r_print {
9346: my ($r,$to_print)=@_;
9347: if ($r) {
9348: $r->print($to_print);
9349: $r->rflush();
9350: } else {
9351: print($to_print);
9352: }
1.1042 www 9353: }
9354:
1.320 albertel 9355: sub html_encode {
9356: my ($result) = @_;
9357:
1.322 albertel 9358: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 9359:
9360: return $result;
9361: }
1.1044 www 9362:
1.317 albertel 9363: sub js_ready {
9364: my ($result) = @_;
9365:
1.323 albertel 9366: $result =~ s/[\n\r]/ /xmsg;
9367: $result =~ s/\\/\\\\/xmsg;
9368: $result =~ s/'/\\'/xmsg;
1.372 albertel 9369: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 9370:
9371: return $result;
9372: }
9373:
1.315 albertel 9374: sub validate_page {
9375: if ( exists($env{'internal.start_page'})
1.316 albertel 9376: && $env{'internal.start_page'} > 1) {
9377: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 9378: $env{'internal.start_page'}.' '.
1.316 albertel 9379: $ENV{'request.filename'});
1.315 albertel 9380: }
9381: if ( exists($env{'internal.end_page'})
1.316 albertel 9382: && $env{'internal.end_page'} > 1) {
9383: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 9384: $env{'internal.end_page'}.' '.
1.316 albertel 9385: $env{'request.filename'});
1.315 albertel 9386: }
9387: if ( exists($env{'internal.start_page'})
9388: && ! exists($env{'internal.end_page'})) {
1.316 albertel 9389: &Apache::lonnet::logthis('start_page called without end_page '.
9390: $env{'request.filename'});
1.315 albertel 9391: }
9392: if ( ! exists($env{'internal.start_page'})
9393: && exists($env{'internal.end_page'})) {
1.316 albertel 9394: &Apache::lonnet::logthis('end_page called without start_page'.
9395: $env{'request.filename'});
1.315 albertel 9396: }
1.306 albertel 9397: }
1.315 albertel 9398:
1.996 www 9399:
9400: sub start_scrollbox {
1.1075.2.56 raeburn 9401: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 9402: unless ($outerwidth) { $outerwidth='520px'; }
9403: unless ($width) { $width='500px'; }
9404: unless ($height) { $height='200px'; }
1.1075 raeburn 9405: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 9406: if ($id ne '') {
1.1075.2.42 raeburn 9407: $table_id = ' id="table_'.$id.'"';
9408: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 9409: }
1.1075 raeburn 9410: if ($bgcolor ne '') {
9411: $tdcol = "background-color: $bgcolor;";
9412: }
1.1075.2.42 raeburn 9413: my $nicescroll_js;
9414: if ($env{'browser.mobile'}) {
9415: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
9416: }
1.1075 raeburn 9417: return <<"END";
1.1075.2.42 raeburn 9418: $nicescroll_js
9419:
9420: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56 raeburn 9421: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075 raeburn 9422: END
1.996 www 9423: }
9424:
9425: sub end_scrollbox {
1.1036 www 9426: return '</div></td></tr></table>';
1.996 www 9427: }
9428:
1.1075.2.42 raeburn 9429: sub nicescroll_javascript {
9430: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
9431: my %options;
9432: if (ref($cursor) eq 'HASH') {
9433: %options = %{$cursor};
9434: }
9435: unless ($options{'railalign'} =~ /^left|right$/) {
9436: $options{'railalign'} = 'left';
9437: }
9438: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9439: my $function = &get_users_function();
9440: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
9441: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9442: $options{'cursorcolor'} = '#00F';
9443: }
9444: }
9445: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
9446: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
9447: $options{'cursoropacity'}='1.0';
9448: }
9449: } else {
9450: $options{'cursoropacity'}='1.0';
9451: }
9452: if ($options{'cursorfixedheight'} eq 'none') {
9453: delete($options{'cursorfixedheight'});
9454: } else {
9455: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
9456: }
9457: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
9458: delete($options{'railoffset'});
9459: }
9460: my @niceoptions;
9461: while (my($key,$value) = each(%options)) {
9462: if ($value =~ /^\{.+\}$/) {
9463: push(@niceoptions,$key.':'.$value);
9464: } else {
9465: push(@niceoptions,$key.':"'.$value.'"');
9466: }
9467: }
9468: my $nicescroll_js = '
9469: $(document).ready(
9470: function() {
9471: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
9472: }
9473: );
9474: ';
9475: if ($framecheck) {
9476: $nicescroll_js .= '
9477: function expand_div(caller) {
9478: if (top === self) {
9479: document.getElementById("'.$id.'").style.width = "auto";
9480: document.getElementById("'.$id.'").style.height = "auto";
9481: } else {
9482: try {
9483: if (parent.frames) {
9484: if (parent.frames.length > 1) {
9485: var framesrc = parent.frames[1].location.href;
9486: var currsrc = framesrc.replace(/\#.*$/,"");
9487: if ((caller == "search") || (currsrc == "'.$location.'")) {
9488: document.getElementById("'.$id.'").style.width = "auto";
9489: document.getElementById("'.$id.'").style.height = "auto";
9490: }
9491: }
9492: }
9493: } catch (e) {
9494: return;
9495: }
9496: }
9497: return;
9498: }
9499: ';
9500: }
9501: if ($needjsready) {
9502: $nicescroll_js = '
9503: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
9504: } else {
9505: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
9506: }
9507: return $nicescroll_js;
9508: }
9509:
1.318 albertel 9510: sub simple_error_page {
1.1075.2.49 raeburn 9511: my ($r,$title,$msg,$args) = @_;
1.1075.2.161. .4(raebu 9512:22): my %displayargs;
1.1075.2.49 raeburn 9513: if (ref($args) eq 'HASH') {
9514: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1075.2.161. .4(raebu 9515:22): if ($args->{'only_body'}) {
9516:22): $displayargs{'only_body'} = 1;
9517:22): }
9518:22): if ($args->{'no_nav_bar'}) {
9519:22): $displayargs{'no_nav_bar'} = 1;
9520:22): }
1.1075.2.49 raeburn 9521: } else {
9522: $msg = &mt($msg);
9523: }
9524:
1.318 albertel 9525: my $page =
1.1075.2.161. .4(raebu 9526:22): &Apache::loncommon::start_page($title,'',\%displayargs).
1.1075.2.49 raeburn 9527: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 9528: &Apache::loncommon::end_page();
9529: if (ref($r)) {
9530: $r->print($page);
1.327 albertel 9531: return;
1.318 albertel 9532: }
9533: return $page;
9534: }
1.347 albertel 9535:
9536: {
1.610 albertel 9537: my @row_count;
1.961 onken 9538:
9539: sub start_data_table_count {
9540: unshift(@row_count, 0);
9541: return;
9542: }
9543:
9544: sub end_data_table_count {
9545: shift(@row_count);
9546: return;
9547: }
9548:
1.347 albertel 9549: sub start_data_table {
1.1018 raeburn 9550: my ($add_class,$id) = @_;
1.422 albertel 9551: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 9552: my $table_id;
9553: if (defined($id)) {
9554: $table_id = ' id="'.$id.'"';
9555: }
1.961 onken 9556: &start_data_table_count();
1.1018 raeburn 9557: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 9558: }
9559:
9560: sub end_data_table {
1.961 onken 9561: &end_data_table_count();
1.389 albertel 9562: return '</table>'."\n";;
1.347 albertel 9563: }
9564:
9565: sub start_data_table_row {
1.974 wenzelju 9566: my ($add_class, $id) = @_;
1.610 albertel 9567: $row_count[0]++;
9568: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 9569: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 9570: $id = (' id="'.$id.'"') unless ($id eq '');
9571: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 9572: }
1.471 banghart 9573:
9574: sub continue_data_table_row {
1.974 wenzelju 9575: my ($add_class, $id) = @_;
1.610 albertel 9576: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 9577: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
9578: $id = (' id="'.$id.'"') unless ($id eq '');
9579: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 9580: }
1.347 albertel 9581:
9582: sub end_data_table_row {
1.389 albertel 9583: return '</tr>'."\n";;
1.347 albertel 9584: }
1.367 www 9585:
1.421 albertel 9586: sub start_data_table_empty_row {
1.707 bisitz 9587: # $row_count[0]++;
1.421 albertel 9588: return '<tr class="LC_empty_row" >'."\n";;
9589: }
9590:
9591: sub end_data_table_empty_row {
9592: return '</tr>'."\n";;
9593: }
9594:
1.367 www 9595: sub start_data_table_header_row {
1.389 albertel 9596: return '<tr class="LC_header_row">'."\n";;
1.367 www 9597: }
9598:
9599: sub end_data_table_header_row {
1.389 albertel 9600: return '</tr>'."\n";;
1.367 www 9601: }
1.890 droeschl 9602:
9603: sub data_table_caption {
9604: my $caption = shift;
9605: return "<caption class=\"LC_caption\">$caption</caption>";
9606: }
1.347 albertel 9607: }
9608:
1.548 albertel 9609: =pod
9610:
9611: =item * &inhibit_menu_check($arg)
9612:
9613: Checks for a inhibitmenu state and generates output to preserve it
9614:
9615: Inputs: $arg - can be any of
9616: - undef - in which case the return value is a string
9617: to add into arguments list of a uri
9618: - 'input' - in which case the return value is a HTML
9619: <form> <input> field of type hidden to
9620: preserve the value
9621: - a url - in which case the return value is the url with
9622: the neccesary cgi args added to preserve the
9623: inhibitmenu state
9624: - a ref to a url - no return value, but the string is
9625: updated to include the neccessary cgi
9626: args to preserve the inhibitmenu state
9627:
9628: =cut
9629:
9630: sub inhibit_menu_check {
9631: my ($arg) = @_;
9632: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
9633: if ($arg eq 'input') {
9634: if ($env{'form.inhibitmenu'}) {
9635: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
9636: } else {
9637: return
9638: }
9639: }
9640: if ($env{'form.inhibitmenu'}) {
9641: if (ref($arg)) {
9642: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9643: } elsif ($arg eq '') {
9644: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
9645: } else {
9646: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9647: }
9648: }
9649: if (!ref($arg)) {
9650: return $arg;
9651: }
9652: }
9653:
1.251 albertel 9654: ###############################################
1.182 matthew 9655:
9656: =pod
9657:
1.549 albertel 9658: =back
9659:
9660: =head1 User Information Routines
9661:
9662: =over 4
9663:
1.405 albertel 9664: =item * &get_users_function()
1.182 matthew 9665:
9666: Used by &bodytag to determine the current users primary role.
9667: Returns either 'student','coordinator','admin', or 'author'.
9668:
9669: =cut
9670:
9671: ###############################################
9672: sub get_users_function {
1.815 tempelho 9673: my $function = 'norole';
1.818 tempelho 9674: if ($env{'request.role'}=~/^(st)/) {
9675: $function='student';
9676: }
1.907 raeburn 9677: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 9678: $function='coordinator';
9679: }
1.258 albertel 9680: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 9681: $function='admin';
9682: }
1.826 bisitz 9683: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 9684: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 9685: $function='author';
9686: }
9687: return $function;
1.54 www 9688: }
1.99 www 9689:
9690: ###############################################
9691:
1.233 raeburn 9692: =pod
9693:
1.821 raeburn 9694: =item * &show_course()
9695:
9696: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
9697: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
9698:
9699: Inputs:
9700: None
9701:
9702: Outputs:
9703: Scalar: 1 if 'Course' to be used, 0 otherwise.
9704:
9705: =cut
9706:
9707: ###############################################
9708: sub show_course {
9709: my $course = !$env{'user.adv'};
9710: if (!$env{'user.adv'}) {
9711: foreach my $env (keys(%env)) {
9712: next if ($env !~ m/^user\.priv\./);
9713: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
9714: $course = 0;
9715: last;
9716: }
9717: }
9718: }
9719: return $course;
9720: }
9721:
9722: ###############################################
9723:
9724: =pod
9725:
1.542 raeburn 9726: =item * &check_user_status()
1.274 raeburn 9727:
9728: Determines current status of supplied role for a
9729: specific user. Roles can be active, previous or future.
9730:
9731: Inputs:
9732: user's domain, user's username, course's domain,
1.375 raeburn 9733: course's number, optional section ID.
1.274 raeburn 9734:
9735: Outputs:
9736: role status: active, previous or future.
9737:
9738: =cut
9739:
9740: sub check_user_status {
1.412 raeburn 9741: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 9742: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85 raeburn 9743: my @uroles = keys(%userinfo);
1.274 raeburn 9744: my $srchstr;
9745: my $active_chk = 'none';
1.412 raeburn 9746: my $now = time;
1.274 raeburn 9747: if (@uroles > 0) {
1.908 raeburn 9748: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 9749: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
9750: } else {
1.412 raeburn 9751: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
9752: }
9753: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 9754: my $role_end = 0;
9755: my $role_start = 0;
9756: $active_chk = 'active';
1.412 raeburn 9757: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
9758: $role_end = $1;
9759: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
9760: $role_start = $1;
1.274 raeburn 9761: }
9762: }
9763: if ($role_start > 0) {
1.412 raeburn 9764: if ($now < $role_start) {
1.274 raeburn 9765: $active_chk = 'future';
9766: }
9767: }
9768: if ($role_end > 0) {
1.412 raeburn 9769: if ($now > $role_end) {
1.274 raeburn 9770: $active_chk = 'previous';
9771: }
9772: }
9773: }
9774: }
9775: return $active_chk;
9776: }
9777:
9778: ###############################################
9779:
9780: =pod
9781:
1.405 albertel 9782: =item * &get_sections()
1.233 raeburn 9783:
9784: Determines all the sections for a course including
9785: sections with students and sections containing other roles.
1.419 raeburn 9786: Incoming parameters:
9787:
9788: 1. domain
9789: 2. course number
9790: 3. reference to array containing roles for which sections should
9791: be gathered (optional).
9792: 4. reference to array containing status types for which sections
9793: should be gathered (optional).
9794:
9795: If the third argument is undefined, sections are gathered for any role.
9796: If the fourth argument is undefined, sections are gathered for any status.
9797: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 9798:
1.374 raeburn 9799: Returns section hash (keys are section IDs, values are
9800: number of users in each section), subject to the
1.419 raeburn 9801: optional roles filter, optional status filter
1.233 raeburn 9802:
9803: =cut
9804:
9805: ###############################################
9806: sub get_sections {
1.419 raeburn 9807: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 9808: if (!defined($cdom) || !defined($cnum)) {
9809: my $cid = $env{'request.course.id'};
9810:
9811: return if (!defined($cid));
9812:
9813: $cdom = $env{'course.'.$cid.'.domain'};
9814: $cnum = $env{'course.'.$cid.'.num'};
9815: }
9816:
9817: my %sectioncount;
1.419 raeburn 9818: my $now = time;
1.240 albertel 9819:
1.1075.2.33 raeburn 9820: my $check_students = 1;
9821: my $only_students = 0;
9822: if (ref($possible_roles) eq 'ARRAY') {
9823: if (grep(/^st$/,@{$possible_roles})) {
9824: if (@{$possible_roles} == 1) {
9825: $only_students = 1;
9826: }
9827: } else {
9828: $check_students = 0;
9829: }
9830: }
9831:
9832: if ($check_students) {
1.276 albertel 9833: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 9834: my $sec_index = &Apache::loncoursedata::CL_SECTION();
9835: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 9836: my $start_index = &Apache::loncoursedata::CL_START();
9837: my $end_index = &Apache::loncoursedata::CL_END();
9838: my $status;
1.366 albertel 9839: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 9840: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
9841: $data->[$status_index],
9842: $data->[$start_index],
9843: $data->[$end_index]);
9844: if ($stu_status eq 'Active') {
9845: $status = 'active';
9846: } elsif ($end < $now) {
9847: $status = 'previous';
9848: } elsif ($start > $now) {
9849: $status = 'future';
9850: }
9851: if ($section ne '-1' && $section !~ /^\s*$/) {
9852: if ((!defined($possible_status)) || (($status ne '') &&
9853: (grep/^\Q$status\E$/,@{$possible_status}))) {
9854: $sectioncount{$section}++;
9855: }
1.240 albertel 9856: }
9857: }
9858: }
1.1075.2.33 raeburn 9859: if ($only_students) {
9860: return %sectioncount;
9861: }
1.240 albertel 9862: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9863: foreach my $user (sort(keys(%courseroles))) {
9864: if ($user !~ /^(\w{2})/) { next; }
9865: my ($role) = ($user =~ /^(\w{2})/);
9866: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 9867: my ($section,$status);
1.240 albertel 9868: if ($role eq 'cr' &&
9869: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
9870: $section=$1;
9871: }
9872: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
9873: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 9874: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
9875: if ($end == -1 && $start == -1) {
9876: next; #deleted role
9877: }
9878: if (!defined($possible_status)) {
9879: $sectioncount{$section}++;
9880: } else {
9881: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
9882: $status = 'active';
9883: } elsif ($end < $now) {
9884: $status = 'future';
9885: } elsif ($start > $now) {
9886: $status = 'previous';
9887: }
9888: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
9889: $sectioncount{$section}++;
9890: }
9891: }
1.233 raeburn 9892: }
1.366 albertel 9893: return %sectioncount;
1.233 raeburn 9894: }
9895:
1.274 raeburn 9896: ###############################################
1.294 raeburn 9897:
9898: =pod
1.405 albertel 9899:
9900: =item * &get_course_users()
9901:
1.275 raeburn 9902: Retrieves usernames:domains for users in the specified course
9903: with specific role(s), and access status.
9904:
9905: Incoming parameters:
1.277 albertel 9906: 1. course domain
9907: 2. course number
9908: 3. access status: users must have - either active,
1.275 raeburn 9909: previous, future, or all.
1.277 albertel 9910: 4. reference to array of permissible roles
1.288 raeburn 9911: 5. reference to array of section restrictions (optional)
9912: 6. reference to results object (hash of hashes).
9913: 7. reference to optional userdata hash
1.609 raeburn 9914: 8. reference to optional statushash
1.630 raeburn 9915: 9. flag if privileged users (except those set to unhide in
9916: course settings) should be excluded
1.609 raeburn 9917: Keys of top level results hash are roles.
1.275 raeburn 9918: Keys of inner hashes are username:domain, with
9919: values set to access type.
1.288 raeburn 9920: Optional userdata hash returns an array with arguments in the
9921: same order as loncoursedata::get_classlist() for student data.
9922:
1.609 raeburn 9923: Optional statushash returns
9924:
1.288 raeburn 9925: Entries for end, start, section and status are blank because
9926: of the possibility of multiple values for non-student roles.
9927:
1.275 raeburn 9928: =cut
1.405 albertel 9929:
1.275 raeburn 9930: ###############################################
1.405 albertel 9931:
1.275 raeburn 9932: sub get_course_users {
1.630 raeburn 9933: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 9934: my %idx = ();
1.419 raeburn 9935: my %seclists;
1.288 raeburn 9936:
9937: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
9938: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
9939: $idx{end} = &Apache::loncoursedata::CL_END();
9940: $idx{start} = &Apache::loncoursedata::CL_START();
9941: $idx{id} = &Apache::loncoursedata::CL_ID();
9942: $idx{section} = &Apache::loncoursedata::CL_SECTION();
9943: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
9944: $idx{status} = &Apache::loncoursedata::CL_STATUS();
9945:
1.290 albertel 9946: if (grep(/^st$/,@{$roles})) {
1.276 albertel 9947: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 9948: my $now = time;
1.277 albertel 9949: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 9950: my $match = 0;
1.412 raeburn 9951: my $secmatch = 0;
1.419 raeburn 9952: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 9953: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 9954: if ($section eq '') {
9955: $section = 'none';
9956: }
1.291 albertel 9957: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9958: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9959: $secmatch = 1;
9960: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 9961: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9962: $secmatch = 1;
9963: }
9964: } else {
1.419 raeburn 9965: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 9966: $secmatch = 1;
9967: }
1.290 albertel 9968: }
1.412 raeburn 9969: if (!$secmatch) {
9970: next;
9971: }
1.419 raeburn 9972: }
1.275 raeburn 9973: if (defined($$types{'active'})) {
1.288 raeburn 9974: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 9975: push(@{$$users{st}{$student}},'active');
1.288 raeburn 9976: $match = 1;
1.275 raeburn 9977: }
9978: }
9979: if (defined($$types{'previous'})) {
1.609 raeburn 9980: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 9981: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 9982: $match = 1;
1.275 raeburn 9983: }
9984: }
9985: if (defined($$types{'future'})) {
1.609 raeburn 9986: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 9987: push(@{$$users{st}{$student}},'future');
1.288 raeburn 9988: $match = 1;
1.275 raeburn 9989: }
9990: }
1.609 raeburn 9991: if ($match) {
9992: push(@{$seclists{$student}},$section);
9993: if (ref($userdata) eq 'HASH') {
9994: $$userdata{$student} = $$classlist{$student};
9995: }
9996: if (ref($statushash) eq 'HASH') {
9997: $statushash->{$student}{'st'}{$section} = $status;
9998: }
1.288 raeburn 9999: }
1.275 raeburn 10000: }
10001: }
1.412 raeburn 10002: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 10003: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10004: my $now = time;
1.609 raeburn 10005: my %displaystatus = ( previous => 'Expired',
10006: active => 'Active',
10007: future => 'Future',
10008: );
1.1075.2.36 raeburn 10009: my (%nothide,@possdoms);
1.630 raeburn 10010: if ($hidepriv) {
10011: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
10012: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
10013: if ($user !~ /:/) {
10014: $nothide{join(':',split(/[\@]/,$user))}=1;
10015: } else {
10016: $nothide{$user} = 1;
10017: }
10018: }
1.1075.2.36 raeburn 10019: my @possdoms = ($cdom);
10020: if ($coursehash{'checkforpriv'}) {
10021: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
10022: }
1.630 raeburn 10023: }
1.439 raeburn 10024: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 10025: my $match = 0;
1.412 raeburn 10026: my $secmatch = 0;
1.439 raeburn 10027: my $status;
1.412 raeburn 10028: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 10029: $user =~ s/:$//;
1.439 raeburn 10030: my ($end,$start) = split(/:/,$coursepersonnel{$person});
10031: if ($end == -1 || $start == -1) {
10032: next;
10033: }
10034: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
10035: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 10036: my ($uname,$udom) = split(/:/,$user);
10037: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10038: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10039: $secmatch = 1;
10040: } elsif ($usec eq '') {
1.420 albertel 10041: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10042: $secmatch = 1;
10043: }
10044: } else {
10045: if (grep(/^\Q$usec\E$/,@{$sections})) {
10046: $secmatch = 1;
10047: }
10048: }
10049: if (!$secmatch) {
10050: next;
10051: }
1.288 raeburn 10052: }
1.419 raeburn 10053: if ($usec eq '') {
10054: $usec = 'none';
10055: }
1.275 raeburn 10056: if ($uname ne '' && $udom ne '') {
1.630 raeburn 10057: if ($hidepriv) {
1.1075.2.36 raeburn 10058: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 10059: (!$nothide{$uname.':'.$udom})) {
10060: next;
10061: }
10062: }
1.503 raeburn 10063: if ($end > 0 && $end < $now) {
1.439 raeburn 10064: $status = 'previous';
10065: } elsif ($start > $now) {
10066: $status = 'future';
10067: } else {
10068: $status = 'active';
10069: }
1.277 albertel 10070: foreach my $type (keys(%{$types})) {
1.275 raeburn 10071: if ($status eq $type) {
1.420 albertel 10072: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 10073: push(@{$$users{$role}{$user}},$type);
10074: }
1.288 raeburn 10075: $match = 1;
10076: }
10077: }
1.419 raeburn 10078: if (($match) && (ref($userdata) eq 'HASH')) {
10079: if (!exists($$userdata{$uname.':'.$udom})) {
10080: &get_user_info($udom,$uname,\%idx,$userdata);
10081: }
1.420 albertel 10082: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 10083: push(@{$seclists{$uname.':'.$udom}},$usec);
10084: }
1.609 raeburn 10085: if (ref($statushash) eq 'HASH') {
10086: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
10087: }
1.275 raeburn 10088: }
10089: }
10090: }
10091: }
1.290 albertel 10092: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 10093: if ((defined($cdom)) && (defined($cnum))) {
10094: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
10095: if ( defined($csettings{'internal.courseowner'}) ) {
10096: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 10097: next if ($owner eq '');
10098: my ($ownername,$ownerdom);
10099: if ($owner =~ /^([^:]+):([^:]+)$/) {
10100: $ownername = $1;
10101: $ownerdom = $2;
10102: } else {
10103: $ownername = $owner;
10104: $ownerdom = $cdom;
10105: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 10106: }
10107: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 10108: if (defined($userdata) &&
1.609 raeburn 10109: !exists($$userdata{$owner})) {
10110: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
10111: if (!grep(/^none$/,@{$seclists{$owner}})) {
10112: push(@{$seclists{$owner}},'none');
10113: }
10114: if (ref($statushash) eq 'HASH') {
10115: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 10116: }
1.290 albertel 10117: }
1.279 raeburn 10118: }
10119: }
10120: }
1.419 raeburn 10121: foreach my $user (keys(%seclists)) {
10122: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
10123: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
10124: }
1.275 raeburn 10125: }
10126: return;
10127: }
10128:
1.288 raeburn 10129: sub get_user_info {
10130: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 10131: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
10132: &plainname($uname,$udom,'lastname');
1.291 albertel 10133: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 10134: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 10135: my %idhash = &Apache::lonnet::idrget($udom,($uname));
10136: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 10137: return;
10138: }
1.275 raeburn 10139:
1.472 raeburn 10140: ###############################################
10141:
10142: =pod
10143:
10144: =item * &get_user_quota()
10145:
1.1075.2.41 raeburn 10146: Retrieves quota assigned for storage of user files.
10147: Default is to report quota for portfolio files.
1.472 raeburn 10148:
10149: Incoming parameters:
10150: 1. user's username
10151: 2. user's domain
1.1075.2.41 raeburn 10152: 3. quota name - portfolio, author, or course
10153: (if no quota name provided, defaults to portfolio).
1.1075.2.59 raeburn 10154: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42 raeburn 10155: course
1.472 raeburn 10156:
10157: Returns:
1.1075.2.58 raeburn 10158: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 10159: 2. (Optional) Type of setting: custom or default
10160: (individually assigned or default for user's
10161: institutional status).
10162: 3. (Optional) - User's institutional status (e.g., faculty, staff
10163: or student - types as defined in localenroll::inst_usertypes
10164: for user's domain, which determines default quota for user.
10165: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 10166:
10167: If a value has been stored in the user's environment,
1.536 raeburn 10168: it will return that, otherwise it returns the maximal default
1.1075.2.41 raeburn 10169: defined for the user's institutional status(es) in the domain.
1.472 raeburn 10170:
10171: =cut
10172:
10173: ###############################################
10174:
10175:
10176: sub get_user_quota {
1.1075.2.42 raeburn 10177: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 10178: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 10179: if (!defined($udom)) {
10180: $udom = $env{'user.domain'};
10181: }
10182: if (!defined($uname)) {
10183: $uname = $env{'user.name'};
10184: }
10185: if (($udom eq '' || $uname eq '') ||
10186: ($udom eq 'public') && ($uname eq 'public')) {
10187: $quota = 0;
1.536 raeburn 10188: $quotatype = 'default';
10189: $defquota = 0;
1.472 raeburn 10190: } else {
1.536 raeburn 10191: my $inststatus;
1.1075.2.41 raeburn 10192: if ($quotaname eq 'course') {
10193: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
10194: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
10195: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
10196: } else {
10197: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
10198: $quota = $cenv{'internal.uploadquota'};
10199: }
1.536 raeburn 10200: } else {
1.1075.2.41 raeburn 10201: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
10202: if ($quotaname eq 'author') {
10203: $quota = $env{'environment.authorquota'};
10204: } else {
10205: $quota = $env{'environment.portfolioquota'};
10206: }
10207: $inststatus = $env{'environment.inststatus'};
10208: } else {
10209: my %userenv =
10210: &Apache::lonnet::get('environment',['portfolioquota',
10211: 'authorquota','inststatus'],$udom,$uname);
10212: my ($tmp) = keys(%userenv);
10213: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10214: if ($quotaname eq 'author') {
10215: $quota = $userenv{'authorquota'};
10216: } else {
10217: $quota = $userenv{'portfolioquota'};
10218: }
10219: $inststatus = $userenv{'inststatus'};
10220: } else {
10221: undef(%userenv);
10222: }
10223: }
10224: }
10225: if ($quota eq '' || wantarray) {
10226: if ($quotaname eq 'course') {
10227: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59 raeburn 10228: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
10229: ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42 raeburn 10230: $defquota = $domdefs{$crstype.'quota'};
10231: }
10232: if ($defquota eq '') {
10233: $defquota = 500;
10234: }
1.1075.2.41 raeburn 10235: } else {
10236: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
10237: }
10238: if ($quota eq '') {
10239: $quota = $defquota;
10240: $quotatype = 'default';
10241: } else {
10242: $quotatype = 'custom';
10243: }
1.472 raeburn 10244: }
10245: }
1.536 raeburn 10246: if (wantarray) {
10247: return ($quota,$quotatype,$settingstatus,$defquota);
10248: } else {
10249: return $quota;
10250: }
1.472 raeburn 10251: }
10252:
10253: ###############################################
10254:
10255: =pod
10256:
10257: =item * &default_quota()
10258:
1.536 raeburn 10259: Retrieves default quota assigned for storage of user portfolio files,
10260: given an (optional) user's institutional status.
1.472 raeburn 10261:
10262: Incoming parameters:
1.1075.2.42 raeburn 10263:
1.472 raeburn 10264: 1. domain
1.536 raeburn 10265: 2. (Optional) institutional status(es). This is a : separated list of
10266: status types (e.g., faculty, staff, student etc.)
10267: which apply to the user for whom the default is being retrieved.
10268: If the institutional status string in undefined, the domain
1.1075.2.41 raeburn 10269: default quota will be returned.
10270: 3. quota name - portfolio, author, or course
10271: (if no quota name provided, defaults to portfolio).
1.472 raeburn 10272:
10273: Returns:
1.1075.2.42 raeburn 10274:
1.1075.2.58 raeburn 10275: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 10276: 2. (Optional) institutional type which determined the value of the
10277: default quota.
1.472 raeburn 10278:
10279: If a value has been stored in the domain's configuration db,
10280: it will return that, otherwise it returns 20 (for backwards
10281: compatibility with domains which have not set up a configuration
1.1075.2.58 raeburn 10282: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 10283:
1.536 raeburn 10284: If the user's status includes multiple types (e.g., staff and student),
10285: the largest default quota which applies to the user determines the
10286: default quota returned.
10287:
1.472 raeburn 10288: =cut
10289:
10290: ###############################################
10291:
10292:
10293: sub default_quota {
1.1075.2.41 raeburn 10294: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 10295: my ($defquota,$settingstatus);
10296: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 10297: ['quotas'],$udom);
1.1075.2.41 raeburn 10298: my $key = 'defaultquota';
10299: if ($quotaname eq 'author') {
10300: $key = 'authorquota';
10301: }
1.622 raeburn 10302: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 10303: if ($inststatus ne '') {
1.765 raeburn 10304: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 10305: foreach my $item (@statuses) {
1.1075.2.41 raeburn 10306: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10307: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 10308: if ($defquota eq '') {
1.1075.2.41 raeburn 10309: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10310: $settingstatus = $item;
1.1075.2.41 raeburn 10311: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
10312: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10313: $settingstatus = $item;
10314: }
10315: }
1.1075.2.41 raeburn 10316: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10317: if ($quotahash{'quotas'}{$item} ne '') {
10318: if ($defquota eq '') {
10319: $defquota = $quotahash{'quotas'}{$item};
10320: $settingstatus = $item;
10321: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
10322: $defquota = $quotahash{'quotas'}{$item};
10323: $settingstatus = $item;
10324: }
1.536 raeburn 10325: }
10326: }
10327: }
10328: }
10329: if ($defquota eq '') {
1.1075.2.41 raeburn 10330: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10331: $defquota = $quotahash{'quotas'}{$key}{'default'};
10332: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10333: $defquota = $quotahash{'quotas'}{'default'};
10334: }
1.536 raeburn 10335: $settingstatus = 'default';
1.1075.2.42 raeburn 10336: if ($defquota eq '') {
10337: if ($quotaname eq 'author') {
10338: $defquota = 500;
10339: }
10340: }
1.536 raeburn 10341: }
10342: } else {
10343: $settingstatus = 'default';
1.1075.2.41 raeburn 10344: if ($quotaname eq 'author') {
10345: $defquota = 500;
10346: } else {
10347: $defquota = 20;
10348: }
1.536 raeburn 10349: }
10350: if (wantarray) {
10351: return ($defquota,$settingstatus);
1.472 raeburn 10352: } else {
1.536 raeburn 10353: return $defquota;
1.472 raeburn 10354: }
10355: }
10356:
1.1075.2.41 raeburn 10357: ###############################################
10358:
10359: =pod
10360:
1.1075.2.42 raeburn 10361: =item * &excess_filesize_warning()
1.1075.2.41 raeburn 10362:
10363: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42 raeburn 10364: of existing file within authoring space will cause quota for the authoring
10365: space to be exceeded.
10366:
10367: Same, if upload of a file directly to a course/community via Course Editor
10368: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41 raeburn 10369:
1.1075.2.61 raeburn 10370: Inputs: 7
1.1075.2.42 raeburn 10371: 1. username or coursenum
1.1075.2.41 raeburn 10372: 2. domain
1.1075.2.42 raeburn 10373: 3. context ('author' or 'course')
1.1075.2.41 raeburn 10374: 4. filename of file for which action is being requested
10375: 5. filesize (kB) of file
10376: 6. action being taken: copy or upload.
1.1075.2.59 raeburn 10377: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41 raeburn 10378:
10379: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
10380: otherwise return null.
10381:
1.1075.2.42 raeburn 10382: =back
10383:
1.1075.2.41 raeburn 10384: =cut
10385:
1.1075.2.42 raeburn 10386: sub excess_filesize_warning {
1.1075.2.59 raeburn 10387: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42 raeburn 10388: my $current_disk_usage = 0;
1.1075.2.59 raeburn 10389: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42 raeburn 10390: if ($context eq 'author') {
10391: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
10392: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
10393: } else {
10394: foreach my $subdir ('docs','supplemental') {
10395: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
10396: }
10397: }
1.1075.2.41 raeburn 10398: $disk_quota = int($disk_quota * 1000);
10399: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69 raeburn 10400: return '<p class="LC_warning">'.
1.1075.2.41 raeburn 10401: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69 raeburn 10402: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
10403: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41 raeburn 10404: $disk_quota,$current_disk_usage).
10405: '</p>';
10406: }
10407: return;
10408: }
10409:
10410: ###############################################
10411:
10412:
1.384 raeburn 10413: sub get_secgrprole_info {
10414: my ($cdom,$cnum,$needroles,$type) = @_;
10415: my %sections_count = &get_sections($cdom,$cnum);
10416: my @sections = (sort {$a <=> $b} keys(%sections_count));
10417: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
10418: my @groups = sort(keys(%curr_groups));
10419: my $allroles = [];
10420: my $rolehash;
10421: my $accesshash = {
10422: active => 'Currently has access',
10423: future => 'Will have future access',
10424: previous => 'Previously had access',
10425: };
10426: if ($needroles) {
10427: $rolehash = {'all' => 'all'};
1.385 albertel 10428: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10429: if (&Apache::lonnet::error(%user_roles)) {
10430: undef(%user_roles);
10431: }
10432: foreach my $item (keys(%user_roles)) {
1.384 raeburn 10433: my ($role)=split(/\:/,$item,2);
10434: if ($role eq 'cr') { next; }
10435: if ($role =~ /^cr/) {
10436: $$rolehash{$role} = (split('/',$role))[3];
10437: } else {
10438: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
10439: }
10440: }
10441: foreach my $key (sort(keys(%{$rolehash}))) {
10442: push(@{$allroles},$key);
10443: }
10444: push (@{$allroles},'st');
10445: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
10446: }
10447: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
10448: }
10449:
1.555 raeburn 10450: sub user_picker {
1.1075.2.127 raeburn 10451: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 10452: my $currdom = $dom;
1.1075.2.114 raeburn 10453: my @alldoms = &Apache::lonnet::all_domains();
10454: if (@alldoms == 1) {
10455: my %domsrch = &Apache::lonnet::get_dom('configuration',
10456: ['directorysrch'],$alldoms[0]);
10457: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
10458: my $showdom = $domdesc;
10459: if ($showdom eq '') {
10460: $showdom = $dom;
10461: }
10462: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
10463: if ((!$domsrch{'directorysrch'}{'available'}) &&
10464: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
10465: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
10466: }
10467: }
10468: }
1.555 raeburn 10469: my %curr_selected = (
10470: srchin => 'dom',
1.580 raeburn 10471: srchby => 'lastname',
1.555 raeburn 10472: );
10473: my $srchterm;
1.625 raeburn 10474: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 10475: if ($srch->{'srchby'} ne '') {
10476: $curr_selected{'srchby'} = $srch->{'srchby'};
10477: }
10478: if ($srch->{'srchin'} ne '') {
10479: $curr_selected{'srchin'} = $srch->{'srchin'};
10480: }
10481: if ($srch->{'srchtype'} ne '') {
10482: $curr_selected{'srchtype'} = $srch->{'srchtype'};
10483: }
10484: if ($srch->{'srchdomain'} ne '') {
10485: $currdom = $srch->{'srchdomain'};
10486: }
10487: $srchterm = $srch->{'srchterm'};
10488: }
1.1075.2.98 raeburn 10489: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 10490: 'usr' => 'Search criteria',
1.563 raeburn 10491: 'doma' => 'Domain/institution to search',
1.558 albertel 10492: 'uname' => 'username',
10493: 'lastname' => 'last name',
1.555 raeburn 10494: 'lastfirst' => 'last name, first name',
1.558 albertel 10495: 'crs' => 'in this course',
1.576 raeburn 10496: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 10497: 'alc' => 'all LON-CAPA',
1.573 raeburn 10498: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 10499: 'exact' => 'is',
10500: 'contains' => 'contains',
1.569 raeburn 10501: 'begins' => 'begins with',
1.1075.2.98 raeburn 10502: );
10503: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 10504: 'youm' => "You must include some text to search for.",
10505: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
10506: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
10507: 'yomc' => "You must choose a domain when using an institutional directory search.",
10508: 'ymcd' => "You must choose a domain when using a domain search.",
10509: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
10510: 'whse' => "When searching by last,first you must include at least one character in the first name.",
10511: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 10512: );
1.1075.2.98 raeburn 10513: &html_escape(\%html_lt);
10514: &js_escape(\%js_lt);
1.1075.2.115 raeburn 10515: my $domform;
1.1075.2.126 raeburn 10516: my $allow_blank = 1;
1.1075.2.115 raeburn 10517: if ($fixeddom) {
1.1075.2.126 raeburn 10518: $allow_blank = 0;
10519: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115 raeburn 10520: } else {
1.1075.2.126 raeburn 10521: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115 raeburn 10522: }
1.563 raeburn 10523: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 10524:
10525: my @srchins = ('crs','dom','alc','instd');
10526:
10527: foreach my $option (@srchins) {
10528: # FIXME 'alc' option unavailable until
10529: # loncreateuser::print_user_query_page()
10530: # has been completed.
10531: next if ($option eq 'alc');
1.880 raeburn 10532: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 10533: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127 raeburn 10534: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 10535: if ($curr_selected{'srchin'} eq $option) {
10536: $srchinsel .= '
1.1075.2.98 raeburn 10537: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 10538: } else {
10539: $srchinsel .= '
1.1075.2.98 raeburn 10540: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 10541: }
1.555 raeburn 10542: }
1.563 raeburn 10543: $srchinsel .= "\n </select>\n";
1.555 raeburn 10544:
10545: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 10546: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 10547: if ($curr_selected{'srchby'} eq $option) {
10548: $srchbysel .= '
1.1075.2.98 raeburn 10549: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10550: } else {
10551: $srchbysel .= '
1.1075.2.98 raeburn 10552: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10553: }
10554: }
10555: $srchbysel .= "\n </select>\n";
10556:
10557: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 10558: foreach my $option ('begins','contains','exact') {
1.555 raeburn 10559: if ($curr_selected{'srchtype'} eq $option) {
10560: $srchtypesel .= '
1.1075.2.98 raeburn 10561: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10562: } else {
10563: $srchtypesel .= '
1.1075.2.98 raeburn 10564: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10565: }
10566: }
10567: $srchtypesel .= "\n </select>\n";
10568:
1.558 albertel 10569: my ($newuserscript,$new_user_create);
1.994 raeburn 10570: my $context_dom = $env{'request.role.domain'};
10571: if ($context eq 'requestcrs') {
10572: if ($env{'form.coursedom'} ne '') {
10573: $context_dom = $env{'form.coursedom'};
10574: }
10575: }
1.556 raeburn 10576: if ($forcenewuser) {
1.576 raeburn 10577: if (ref($srch) eq 'HASH') {
1.994 raeburn 10578: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 10579: if ($cancreate) {
10580: $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>';
10581: } else {
1.799 bisitz 10582: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 10583: my %usertypetext = (
10584: official => 'institutional',
10585: unofficial => 'non-institutional',
10586: );
1.799 bisitz 10587: $new_user_create = '<p class="LC_warning">'
10588: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
10589: .' '
10590: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
10591: ,'<a href="'.$helplink.'">','</a>')
10592: .'</p><br />';
1.627 raeburn 10593: }
1.576 raeburn 10594: }
10595: }
10596:
1.556 raeburn 10597: $newuserscript = <<"ENDSCRIPT";
10598:
1.570 raeburn 10599: function setSearch(createnew,callingForm) {
1.556 raeburn 10600: if (createnew == 1) {
1.570 raeburn 10601: for (var i=0; i<callingForm.srchby.length; i++) {
10602: if (callingForm.srchby.options[i].value == 'uname') {
10603: callingForm.srchby.selectedIndex = i;
1.556 raeburn 10604: }
10605: }
1.570 raeburn 10606: for (var i=0; i<callingForm.srchin.length; i++) {
10607: if ( callingForm.srchin.options[i].value == 'dom') {
10608: callingForm.srchin.selectedIndex = i;
1.556 raeburn 10609: }
10610: }
1.570 raeburn 10611: for (var i=0; i<callingForm.srchtype.length; i++) {
10612: if (callingForm.srchtype.options[i].value == 'exact') {
10613: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 10614: }
10615: }
1.570 raeburn 10616: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 10617: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 10618: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 10619: }
10620: }
10621: }
10622: }
10623: ENDSCRIPT
1.558 albertel 10624:
1.556 raeburn 10625: }
10626:
1.555 raeburn 10627: my $output = <<"END_BLOCK";
1.556 raeburn 10628: <script type="text/javascript">
1.824 bisitz 10629: // <![CDATA[
1.570 raeburn 10630: function validateEntry(callingForm) {
1.558 albertel 10631:
1.556 raeburn 10632: var checkok = 1;
1.558 albertel 10633: var srchin;
1.570 raeburn 10634: for (var i=0; i<callingForm.srchin.length; i++) {
10635: if ( callingForm.srchin[i].checked ) {
10636: srchin = callingForm.srchin[i].value;
1.558 albertel 10637: }
10638: }
10639:
1.570 raeburn 10640: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
10641: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
10642: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
10643: var srchterm = callingForm.srchterm.value;
10644: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 10645: var msg = "";
10646:
10647: if (srchterm == "") {
10648: checkok = 0;
1.1075.2.98 raeburn 10649: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 10650: }
10651:
1.569 raeburn 10652: if (srchtype== 'begins') {
10653: if (srchterm.length < 2) {
10654: checkok = 0;
1.1075.2.98 raeburn 10655: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 10656: }
10657: }
10658:
1.556 raeburn 10659: if (srchtype== 'contains') {
10660: if (srchterm.length < 3) {
10661: checkok = 0;
1.1075.2.98 raeburn 10662: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 10663: }
10664: }
10665: if (srchin == 'instd') {
10666: if (srchdomain == '') {
10667: checkok = 0;
1.1075.2.98 raeburn 10668: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 10669: }
10670: }
10671: if (srchin == 'dom') {
10672: if (srchdomain == '') {
10673: checkok = 0;
1.1075.2.98 raeburn 10674: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 10675: }
10676: }
10677: if (srchby == 'lastfirst') {
10678: if (srchterm.indexOf(",") == -1) {
10679: checkok = 0;
1.1075.2.98 raeburn 10680: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 10681: }
10682: if (srchterm.indexOf(",") == srchterm.length -1) {
10683: checkok = 0;
1.1075.2.98 raeburn 10684: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 10685: }
10686: }
10687: if (checkok == 0) {
1.1075.2.98 raeburn 10688: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 10689: return;
10690: }
10691: if (checkok == 1) {
1.570 raeburn 10692: callingForm.submit();
1.556 raeburn 10693: }
10694: }
10695:
10696: $newuserscript
10697:
1.824 bisitz 10698: // ]]>
1.556 raeburn 10699: </script>
1.558 albertel 10700:
10701: $new_user_create
10702:
1.555 raeburn 10703: END_BLOCK
1.558 albertel 10704:
1.876 raeburn 10705: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98 raeburn 10706: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 10707: $domform.
10708: &Apache::lonhtmlcommon::row_closure().
1.1075.2.98 raeburn 10709: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 10710: $srchbysel.
10711: $srchtypesel.
10712: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
10713: $srchinsel.
10714: &Apache::lonhtmlcommon::row_closure(1).
10715: &Apache::lonhtmlcommon::end_pick_box().
10716: '<br />';
1.1075.2.114 raeburn 10717: return ($output,1);
1.555 raeburn 10718: }
10719:
1.612 raeburn 10720: sub user_rule_check {
1.615 raeburn 10721: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99 raeburn 10722: my ($response,%inst_response);
1.612 raeburn 10723: if (ref($usershash) eq 'HASH') {
1.1075.2.99 raeburn 10724: if (keys(%{$usershash}) > 1) {
10725: my (%by_username,%by_id,%userdoms);
10726: my $checkid;
1.612 raeburn 10727: if (ref($checks) eq 'HASH') {
1.1075.2.99 raeburn 10728: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
10729: $checkid = 1;
10730: }
10731: }
10732: foreach my $user (keys(%{$usershash})) {
10733: my ($uname,$udom) = split(/:/,$user);
10734: if ($checkid) {
10735: if (ref($usershash->{$user}) eq 'HASH') {
10736: if ($usershash->{$user}->{'id'} ne '') {
10737: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
10738: $userdoms{$udom} = 1;
10739: if (ref($inst_results) eq 'HASH') {
10740: $inst_results->{$uname.':'.$udom} = {};
10741: }
10742: }
10743: }
10744: } else {
10745: $by_username{$udom}{$uname} = 1;
10746: $userdoms{$udom} = 1;
10747: if (ref($inst_results) eq 'HASH') {
10748: $inst_results->{$uname.':'.$udom} = {};
10749: }
10750: }
10751: }
10752: foreach my $udom (keys(%userdoms)) {
10753: if (!$got_rules->{$udom}) {
10754: my %domconfig = &Apache::lonnet::get_dom('configuration',
10755: ['usercreation'],$udom);
10756: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10757: foreach my $item ('username','id') {
10758: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10759: $$curr_rules{$udom}{$item} =
10760: $domconfig{'usercreation'}{$item.'_rule'};
10761: }
10762: }
10763: }
10764: $got_rules->{$udom} = 1;
10765: }
10766: }
10767: if ($checkid) {
10768: foreach my $udom (keys(%by_id)) {
10769: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
10770: if ($outcome eq 'ok') {
10771: foreach my $id (keys(%{$by_id{$udom}})) {
10772: my $uname = $by_id{$udom}{$id};
10773: $inst_response{$uname.':'.$udom} = $outcome;
10774: }
10775: if (ref($results) eq 'HASH') {
10776: foreach my $uname (keys(%{$results})) {
10777: if (exists($inst_response{$uname.':'.$udom})) {
10778: $inst_response{$uname.':'.$udom} = $outcome;
10779: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10780: }
10781: }
10782: }
10783: }
1.612 raeburn 10784: }
1.615 raeburn 10785: } else {
1.1075.2.99 raeburn 10786: foreach my $udom (keys(%by_username)) {
10787: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
10788: if ($outcome eq 'ok') {
10789: foreach my $uname (keys(%{$by_username{$udom}})) {
10790: $inst_response{$uname.':'.$udom} = $outcome;
10791: }
10792: if (ref($results) eq 'HASH') {
10793: foreach my $uname (keys(%{$results})) {
10794: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10795: }
10796: }
10797: }
10798: }
1.612 raeburn 10799: }
1.1075.2.99 raeburn 10800: } elsif (keys(%{$usershash}) == 1) {
10801: my $user = (keys(%{$usershash}))[0];
10802: my ($uname,$udom) = split(/:/,$user);
10803: if (($udom ne '') && ($uname ne '')) {
10804: if (ref($usershash->{$user}) eq 'HASH') {
10805: if (ref($checks) eq 'HASH') {
10806: if (defined($checks->{'username'})) {
10807: ($inst_response{$user},%{$inst_results->{$user}}) =
10808: &Apache::lonnet::get_instuser($udom,$uname);
10809: } elsif (defined($checks->{'id'})) {
10810: if ($usershash->{$user}->{'id'} ne '') {
10811: ($inst_response{$user},%{$inst_results->{$user}}) =
10812: &Apache::lonnet::get_instuser($udom,undef,
10813: $usershash->{$user}->{'id'});
10814: } else {
10815: ($inst_response{$user},%{$inst_results->{$user}}) =
10816: &Apache::lonnet::get_instuser($udom,$uname);
10817: }
10818: }
10819: } else {
10820: ($inst_response{$user},%{$inst_results->{$user}}) =
10821: &Apache::lonnet::get_instuser($udom,$uname);
10822: return;
10823: }
10824: if (!$got_rules->{$udom}) {
10825: my %domconfig = &Apache::lonnet::get_dom('configuration',
10826: ['usercreation'],$udom);
10827: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10828: foreach my $item ('username','id') {
10829: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10830: $$curr_rules{$udom}{$item} =
10831: $domconfig{'usercreation'}{$item.'_rule'};
10832: }
10833: }
1.585 raeburn 10834: }
1.1075.2.99 raeburn 10835: $got_rules->{$udom} = 1;
1.585 raeburn 10836: }
10837: }
1.1075.2.99 raeburn 10838: } else {
10839: return;
10840: }
10841: } else {
10842: return;
10843: }
10844: foreach my $user (keys(%{$usershash})) {
10845: my ($uname,$udom) = split(/:/,$user);
10846: next if (($udom eq '') || ($uname eq ''));
10847: my $id;
10848: if (ref($inst_results) eq 'HASH') {
10849: if (ref($inst_results->{$user}) eq 'HASH') {
10850: $id = $inst_results->{$user}->{'id'};
10851: }
10852: }
10853: if ($id eq '') {
10854: if (ref($usershash->{$user})) {
10855: $id = $usershash->{$user}->{'id'};
10856: }
1.585 raeburn 10857: }
1.612 raeburn 10858: foreach my $item (keys(%{$checks})) {
10859: if (ref($$curr_rules{$udom}) eq 'HASH') {
10860: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
10861: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99 raeburn 10862: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
10863: $$curr_rules{$udom}{$item});
1.612 raeburn 10864: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
10865: if ($rule_check{$rule}) {
10866: $$rulematch{$user}{$item} = $rule;
1.1075.2.99 raeburn 10867: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 10868: if (ref($inst_results) eq 'HASH') {
10869: if (ref($inst_results->{$user}) eq 'HASH') {
10870: if (keys(%{$inst_results->{$user}}) == 0) {
10871: $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99 raeburn 10872: } elsif ($item eq 'id') {
10873: if ($inst_results->{$user}->{'id'} eq '') {
10874: $$alerts{$item}{$udom}{$uname} = 1;
10875: }
1.615 raeburn 10876: }
1.612 raeburn 10877: }
10878: }
1.615 raeburn 10879: }
10880: last;
1.585 raeburn 10881: }
10882: }
10883: }
10884: }
10885: }
10886: }
10887: }
10888: }
1.612 raeburn 10889: return;
10890: }
10891:
10892: sub user_rule_formats {
10893: my ($domain,$domdesc,$curr_rules,$check) = @_;
10894: my %text = (
10895: 'username' => 'Usernames',
10896: 'id' => 'IDs',
10897: );
10898: my $output;
10899: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
10900: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
10901: if (@{$ruleorder} > 0) {
1.1075.2.20 raeburn 10902: $output = '<br />'.
10903: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
10904: '<span class="LC_cusr_emph">','</span>',$domdesc).
10905: ' <ul>';
1.612 raeburn 10906: foreach my $rule (@{$ruleorder}) {
10907: if (ref($curr_rules) eq 'ARRAY') {
10908: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
10909: if (ref($rules->{$rule}) eq 'HASH') {
10910: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
10911: $rules->{$rule}{'desc'}.'</li>';
10912: }
10913: }
10914: }
10915: }
10916: $output .= '</ul>';
10917: }
10918: }
10919: return $output;
10920: }
10921:
10922: sub instrule_disallow_msg {
1.615 raeburn 10923: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 10924: my $response;
10925: my %text = (
10926: item => 'username',
10927: items => 'usernames',
10928: match => 'matches',
10929: do => 'does',
10930: action => 'a username',
10931: one => 'one',
10932: );
10933: if ($count > 1) {
10934: $text{'item'} = 'usernames';
10935: $text{'match'} ='match';
10936: $text{'do'} = 'do';
10937: $text{'action'} = 'usernames',
10938: $text{'one'} = 'ones';
10939: }
10940: if ($checkitem eq 'id') {
10941: $text{'items'} = 'IDs';
10942: $text{'item'} = 'ID';
10943: $text{'action'} = 'an ID';
1.615 raeburn 10944: if ($count > 1) {
10945: $text{'item'} = 'IDs';
10946: $text{'action'} = 'IDs';
10947: }
1.612 raeburn 10948: }
1.674 bisitz 10949: $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 10950: if ($mode eq 'upload') {
10951: if ($checkitem eq 'username') {
10952: $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'}.");
10953: } elsif ($checkitem eq 'id') {
1.674 bisitz 10954: $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 10955: }
1.669 raeburn 10956: } elsif ($mode eq 'selfcreate') {
10957: if ($checkitem eq 'id') {
10958: $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.");
10959: }
1.615 raeburn 10960: } else {
10961: if ($checkitem eq 'username') {
10962: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
10963: } elsif ($checkitem eq 'id') {
10964: $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.");
10965: }
1.612 raeburn 10966: }
10967: return $response;
1.585 raeburn 10968: }
10969:
1.624 raeburn 10970: sub personal_data_fieldtitles {
10971: my %fieldtitles = &Apache::lonlocal::texthash (
10972: id => 'Student/Employee ID',
10973: permanentemail => 'E-mail address',
10974: lastname => 'Last Name',
10975: firstname => 'First Name',
10976: middlename => 'Middle Name',
10977: generation => 'Generation',
10978: gen => 'Generation',
1.765 raeburn 10979: inststatus => 'Affiliation',
1.624 raeburn 10980: );
10981: return %fieldtitles;
10982: }
10983:
1.642 raeburn 10984: sub sorted_inst_types {
10985: my ($dom) = @_;
1.1075.2.70 raeburn 10986: my ($usertypes,$order);
10987: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
10988: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
10989: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
10990: $order = $domdefaults{'inststatus'}{'inststatusorder'};
10991: } else {
10992: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
10993: }
1.642 raeburn 10994: my $othertitle = &mt('All users');
10995: if ($env{'request.course.id'}) {
1.668 raeburn 10996: $othertitle = &mt('Any users');
1.642 raeburn 10997: }
10998: my @types;
10999: if (ref($order) eq 'ARRAY') {
11000: @types = @{$order};
11001: }
11002: if (@types == 0) {
11003: if (ref($usertypes) eq 'HASH') {
11004: @types = sort(keys(%{$usertypes}));
11005: }
11006: }
11007: if (keys(%{$usertypes}) > 0) {
11008: $othertitle = &mt('Other users');
11009: }
11010: return ($othertitle,$usertypes,\@types);
11011: }
11012:
1.645 raeburn 11013: sub get_institutional_codes {
1.1075.2.157 raeburn 11014: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 11015: # Get complete list of course sections to update
11016: my @currsections = ();
11017: my @currxlists = ();
1.1075.2.157 raeburn 11018: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 11019: my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157 raeburn 11020: my $crskey = $crs.':'.$coursecode;
11021: @{$unclutteredsec{$crskey}} = ();
11022: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 11023:
11024: if ($$settings{'internal.sectionnums'} ne '') {
11025: @currsections = split(/,/,$$settings{'internal.sectionnums'});
11026: }
11027:
11028: if ($$settings{'internal.crosslistings'} ne '') {
11029: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
11030: }
11031:
11032: if (@currxlists > 0) {
1.1075.2.157 raeburn 11033: foreach my $xl (@currxlists) {
11034: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 11035: unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119 raeburn 11036: push(@{$allcourses},$1);
1.645 raeburn 11037: $$LC_code{$1} = $2;
11038: }
11039: }
11040: }
11041: }
1.1075.2.157 raeburn 11042:
1.645 raeburn 11043: if (@currsections > 0) {
1.1075.2.157 raeburn 11044: foreach my $sec (@currsections) {
11045: if ($sec =~ m/^(\w+):(\w*)$/ ) {
11046: my $instsec = $1;
1.645 raeburn 11047: my $lc_sec = $2;
1.1075.2.157 raeburn 11048: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
11049: push(@{$unclutteredsec{$crskey}},$instsec);
11050: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
11051: }
11052: }
11053: }
11054: }
11055:
11056: if (@{$unclutteredsec{$crskey}} > 0) {
11057: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
11058: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
11059: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
11060: my $sec = $coursecode.$formattedsec{$crskey}[$i];
11061: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119 raeburn 11062: push(@{$allcourses},$sec);
1.1075.2.157 raeburn 11063: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 11064: }
11065: }
11066: }
11067: }
11068: return;
11069: }
11070:
1.971 raeburn 11071: sub get_standard_codeitems {
11072: return ('Year','Semester','Department','Number','Section');
11073: }
11074:
1.112 bowersj2 11075: =pod
11076:
1.780 raeburn 11077: =head1 Slot Helpers
11078:
11079: =over 4
11080:
11081: =item * sorted_slots()
11082:
1.1040 raeburn 11083: Sorts an array of slot names in order of an optional sort key,
11084: default sort is by slot start time (earliest first).
1.780 raeburn 11085:
11086: Inputs:
11087:
11088: =over 4
11089:
11090: slotsarr - Reference to array of unsorted slot names.
11091:
11092: slots - Reference to hash of hash, where outer hash keys are slot names.
11093:
1.1040 raeburn 11094: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
11095:
1.549 albertel 11096: =back
11097:
1.780 raeburn 11098: Returns:
11099:
11100: =over 4
11101:
1.1040 raeburn 11102: sorted - An array of slot names sorted by a specified sort key
11103: (default sort key is start time of the slot).
1.780 raeburn 11104:
11105: =back
11106:
11107: =cut
11108:
11109:
11110: sub sorted_slots {
1.1040 raeburn 11111: my ($slotsarr,$slots,$sortkey) = @_;
11112: if ($sortkey eq '') {
11113: $sortkey = 'starttime';
11114: }
1.780 raeburn 11115: my @sorted;
11116: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
11117: @sorted =
11118: sort {
11119: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 11120: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 11121: }
11122: if (ref($slots->{$a})) { return -1;}
11123: if (ref($slots->{$b})) { return 1;}
11124: return 0;
11125: } @{$slotsarr};
11126: }
11127: return @sorted;
11128: }
11129:
1.1040 raeburn 11130: =pod
11131:
11132: =item * get_future_slots()
11133:
11134: Inputs:
11135:
11136: =over 4
11137:
11138: cnum - course number
11139:
11140: cdom - course domain
11141:
11142: now - current UNIX time
11143:
11144: symb - optional symb
11145:
11146: =back
11147:
11148: Returns:
11149:
11150: =over 4
11151:
11152: sorted_reservable - ref to array of student_schedulable slots currently
11153: reservable, ordered by end date of reservation period.
11154:
11155: reservable_now - ref to hash of student_schedulable slots currently
11156: reservable.
11157:
11158: Keys in inner hash are:
11159: (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104 raeburn 11160: (b) endreserve: end date of reservation period.
11161: (c) uniqueperiod: start,end dates when slot is to be uniquely
11162: selected.
1.1040 raeburn 11163:
11164: sorted_future - ref to array of student_schedulable slots reservable in
11165: the future, ordered by start date of reservation period.
11166:
11167: future_reservable - ref to hash of student_schedulable slots reservable
11168: in the future.
11169:
11170: Keys in inner hash are:
11171: (a) symb: either blank or symb to which slot use is restricted.
11172: (b) startreserve: start date of reservation period.
1.1075.2.104 raeburn 11173: (c) uniqueperiod: start,end dates when slot is to be uniquely
11174: selected.
1.1040 raeburn 11175:
11176: =back
11177:
11178: =cut
11179:
11180: sub get_future_slots {
11181: my ($cnum,$cdom,$now,$symb) = @_;
11182: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
11183: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
11184: foreach my $slot (keys(%slots)) {
11185: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
11186: if ($symb) {
11187: next if (($slots{$slot}->{'symb'} ne '') &&
11188: ($slots{$slot}->{'symb'} ne $symb));
11189: }
11190: if (($slots{$slot}->{'starttime'} > $now) &&
11191: ($slots{$slot}->{'endtime'} > $now)) {
11192: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
11193: my $userallowed = 0;
11194: if ($slots{$slot}->{'allowedsections'}) {
11195: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
11196: if (!defined($env{'request.role.sec'})
11197: && grep(/^No section assigned$/,@allowed_sec)) {
11198: $userallowed=1;
11199: } else {
11200: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
11201: $userallowed=1;
11202: }
11203: }
11204: unless ($userallowed) {
11205: if (defined($env{'request.course.groups'})) {
11206: my @groups = split(/:/,$env{'request.course.groups'});
11207: foreach my $group (@groups) {
11208: if (grep(/^\Q$group\E$/,@allowed_sec)) {
11209: $userallowed=1;
11210: last;
11211: }
11212: }
11213: }
11214: }
11215: }
11216: if ($slots{$slot}->{'allowedusers'}) {
11217: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
11218: my $user = $env{'user.name'}.':'.$env{'user.domain'};
11219: if (grep(/^\Q$user\E$/,@allowed_users)) {
11220: $userallowed = 1;
11221: }
11222: }
11223: next unless($userallowed);
11224: }
11225: my $startreserve = $slots{$slot}->{'startreserve'};
11226: my $endreserve = $slots{$slot}->{'endreserve'};
11227: my $symb = $slots{$slot}->{'symb'};
1.1075.2.104 raeburn 11228: my $uniqueperiod;
11229: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
11230: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
11231: }
1.1040 raeburn 11232: if (($startreserve < $now) &&
11233: (!$endreserve || $endreserve > $now)) {
11234: my $lastres = $endreserve;
11235: if (!$lastres) {
11236: $lastres = $slots{$slot}->{'starttime'};
11237: }
11238: $reservable_now{$slot} = {
11239: symb => $symb,
1.1075.2.104 raeburn 11240: endreserve => $lastres,
11241: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11242: };
11243: } elsif (($startreserve > $now) &&
11244: (!$endreserve || $endreserve > $startreserve)) {
11245: $future_reservable{$slot} = {
11246: symb => $symb,
1.1075.2.104 raeburn 11247: startreserve => $startreserve,
11248: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11249: };
11250: }
11251: }
11252: }
11253: my @unsorted_reservable = keys(%reservable_now);
11254: if (@unsorted_reservable > 0) {
11255: @sorted_reservable =
11256: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
11257: }
11258: my @unsorted_future = keys(%future_reservable);
11259: if (@unsorted_future > 0) {
11260: @sorted_future =
11261: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
11262: }
11263: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
11264: }
1.780 raeburn 11265:
11266: =pod
11267:
1.1057 foxr 11268: =back
11269:
1.549 albertel 11270: =head1 HTTP Helpers
11271:
11272: =over 4
11273:
1.648 raeburn 11274: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 11275:
1.258 albertel 11276: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 11277: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 11278: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 11279:
11280: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
11281: $possible_names is an ref to an array of form element names. As an example:
11282: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 11283: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 11284:
11285: =cut
1.1 albertel 11286:
1.6 albertel 11287: sub get_unprocessed_cgi {
1.25 albertel 11288: my ($query,$possible_names)= @_;
1.26 matthew 11289: # $Apache::lonxml::debug=1;
1.356 albertel 11290: foreach my $pair (split(/&/,$query)) {
11291: my ($name, $value) = split(/=/,$pair);
1.369 www 11292: $name = &unescape($name);
1.25 albertel 11293: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
11294: $value =~ tr/+/ /;
11295: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 11296: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 11297: }
1.16 harris41 11298: }
1.6 albertel 11299: }
11300:
1.112 bowersj2 11301: =pod
11302:
1.648 raeburn 11303: =item * &cacheheader()
1.112 bowersj2 11304:
11305: returns cache-controlling header code
11306:
11307: =cut
11308:
1.7 albertel 11309: sub cacheheader {
1.258 albertel 11310: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 11311: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
11312: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 11313: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
11314: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 11315: return $output;
1.7 albertel 11316: }
11317:
1.112 bowersj2 11318: =pod
11319:
1.648 raeburn 11320: =item * &no_cache($r)
1.112 bowersj2 11321:
11322: specifies header code to not have cache
11323:
11324: =cut
11325:
1.9 albertel 11326: sub no_cache {
1.216 albertel 11327: my ($r) = @_;
11328: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 11329: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 11330: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
11331: $r->no_cache(1);
11332: $r->header_out("Expires" => $date);
11333: $r->header_out("Pragma" => "no-cache");
1.123 www 11334: }
11335:
11336: sub content_type {
1.181 albertel 11337: my ($r,$type,$charset) = @_;
1.299 foxr 11338: if ($r) {
11339: # Note that printout.pl calls this with undef for $r.
11340: &no_cache($r);
11341: }
1.258 albertel 11342: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 11343: unless ($charset) {
11344: $charset=&Apache::lonlocal::current_encoding;
11345: }
11346: if ($charset) { $type.='; charset='.$charset; }
11347: if ($r) {
11348: $r->content_type($type);
11349: } else {
11350: print("Content-type: $type\n\n");
11351: }
1.9 albertel 11352: }
1.25 albertel 11353:
1.112 bowersj2 11354: =pod
11355:
1.648 raeburn 11356: =item * &add_to_env($name,$value)
1.112 bowersj2 11357:
1.258 albertel 11358: adds $name to the %env hash with value
1.112 bowersj2 11359: $value, if $name already exists, the entry is converted to an array
11360: reference and $value is added to the array.
11361:
11362: =cut
11363:
1.25 albertel 11364: sub add_to_env {
11365: my ($name,$value)=@_;
1.258 albertel 11366: if (defined($env{$name})) {
11367: if (ref($env{$name})) {
1.25 albertel 11368: #already have multiple values
1.258 albertel 11369: push(@{ $env{$name} },$value);
1.25 albertel 11370: } else {
11371: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 11372: my $first=$env{$name};
11373: undef($env{$name});
11374: push(@{ $env{$name} },$first,$value);
1.25 albertel 11375: }
11376: } else {
1.258 albertel 11377: $env{$name}=$value;
1.25 albertel 11378: }
1.31 albertel 11379: }
1.149 albertel 11380:
11381: =pod
11382:
1.648 raeburn 11383: =item * &get_env_multiple($name)
1.149 albertel 11384:
1.258 albertel 11385: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 11386: values may be defined and end up as an array ref.
11387:
11388: returns an array of values
11389:
11390: =cut
11391:
11392: sub get_env_multiple {
11393: my ($name) = @_;
11394: my @values;
1.258 albertel 11395: if (defined($env{$name})) {
1.149 albertel 11396: # exists is it an array
1.258 albertel 11397: if (ref($env{$name})) {
11398: @values=@{ $env{$name} };
1.149 albertel 11399: } else {
1.258 albertel 11400: $values[0]=$env{$name};
1.149 albertel 11401: }
11402: }
11403: return(@values);
11404: }
11405:
1.660 raeburn 11406: sub ask_for_embedded_content {
11407: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 11408: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11 raeburn 11409: %currsubfile,%unused,$rem);
1.1071 raeburn 11410: my $counter = 0;
11411: my $numnew = 0;
1.987 raeburn 11412: my $numremref = 0;
11413: my $numinvalid = 0;
11414: my $numpathchg = 0;
11415: my $numexisting = 0;
1.1071 raeburn 11416: my $numunused = 0;
11417: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53 raeburn 11418: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 11419: my $heading = &mt('Upload embedded files');
11420: my $buttontext = &mt('Upload');
11421:
1.1075.2.11 raeburn 11422: if ($env{'request.course.id'}) {
1.1075.2.35 raeburn 11423: if ($actionurl eq '/adm/dependencies') {
11424: $navmap = Apache::lonnavmaps::navmap->new();
11425: }
11426: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11427: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11 raeburn 11428: }
1.1075.2.35 raeburn 11429: if (($actionurl eq '/adm/portfolio') ||
11430: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 11431: my $current_path='/';
11432: if ($env{'form.currentpath'}) {
11433: $current_path = $env{'form.currentpath'};
11434: }
11435: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35 raeburn 11436: $udom = $cdom;
11437: $uname = $cnum;
1.984 raeburn 11438: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
11439: } else {
11440: $udom = $env{'user.domain'};
11441: $uname = $env{'user.name'};
11442: $url = '/userfiles/portfolio';
11443: }
1.987 raeburn 11444: $toplevel = $url.'/';
1.984 raeburn 11445: $url .= $current_path;
11446: $getpropath = 1;
1.987 raeburn 11447: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11448: ($actionurl eq '/adm/imsimport')) {
1.1022 www 11449: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 11450: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 11451: $toplevel = $url;
1.984 raeburn 11452: if ($rest ne '') {
1.987 raeburn 11453: $url .= $rest;
11454: }
11455: } elsif ($actionurl eq '/adm/coursedocs') {
11456: if (ref($args) eq 'HASH') {
1.1071 raeburn 11457: $url = $args->{'docs_url'};
11458: $toplevel = $url;
1.1075.2.11 raeburn 11459: if ($args->{'context'} eq 'paste') {
11460: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
11461: ($path) =
11462: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11463: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11464: $fileloc =~ s{^/}{};
11465: }
1.1071 raeburn 11466: }
11467: } elsif ($actionurl eq '/adm/dependencies') {
11468: if ($env{'request.course.id'} ne '') {
11469: if (ref($args) eq 'HASH') {
11470: $url = $args->{'docs_url'};
11471: $title = $args->{'docs_title'};
1.1075.2.35 raeburn 11472: $toplevel = $url;
11473: unless ($toplevel =~ m{^/}) {
11474: $toplevel = "/$url";
11475: }
1.1075.2.11 raeburn 11476: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35 raeburn 11477: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
11478: $path = $1;
11479: } else {
11480: ($path) =
11481: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11482: }
1.1075.2.79 raeburn 11483: if ($toplevel=~/^\/*(uploaded|editupload)/) {
11484: $fileloc = $toplevel;
11485: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
11486: my ($udom,$uname,$fname) =
11487: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
11488: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
11489: } else {
11490: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11491: }
1.1071 raeburn 11492: $fileloc =~ s{^/}{};
11493: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
11494: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
11495: }
1.987 raeburn 11496: }
1.1075.2.35 raeburn 11497: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11498: $udom = $cdom;
11499: $uname = $cnum;
11500: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
11501: $toplevel = $url;
11502: $path = $url;
11503: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
11504: $fileloc =~ s{^/}{};
11505: }
11506: foreach my $file (keys(%{$allfiles})) {
11507: my $embed_file;
11508: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
11509: $embed_file = $1;
11510: } else {
11511: $embed_file = $file;
11512: }
1.1075.2.55 raeburn 11513: my ($absolutepath,$cleaned_file);
11514: if ($embed_file =~ m{^\w+://}) {
11515: $cleaned_file = $embed_file;
1.1075.2.47 raeburn 11516: $newfiles{$cleaned_file} = 1;
11517: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11518: } else {
1.1075.2.55 raeburn 11519: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 11520: if ($embed_file =~ m{^/}) {
11521: $absolutepath = $embed_file;
11522: }
1.1075.2.47 raeburn 11523: if ($cleaned_file =~ m{/}) {
11524: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 11525: $path = &check_for_traversal($path,$url,$toplevel);
11526: my $item = $fname;
11527: if ($path ne '') {
11528: $item = $path.'/'.$fname;
11529: $subdependencies{$path}{$fname} = 1;
11530: } else {
11531: $dependencies{$item} = 1;
11532: }
11533: if ($absolutepath) {
11534: $mapping{$item} = $absolutepath;
11535: } else {
11536: $mapping{$item} = $embed_file;
11537: }
11538: } else {
11539: $dependencies{$embed_file} = 1;
11540: if ($absolutepath) {
1.1075.2.47 raeburn 11541: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 11542: } else {
1.1075.2.47 raeburn 11543: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11544: }
11545: }
1.984 raeburn 11546: }
11547: }
1.1071 raeburn 11548: my $dirptr = 16384;
1.984 raeburn 11549: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 11550: $currsubfile{$path} = {};
1.1075.2.35 raeburn 11551: if (($actionurl eq '/adm/portfolio') ||
11552: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11553: my ($sublistref,$listerror) =
11554: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
11555: if (ref($sublistref) eq 'ARRAY') {
11556: foreach my $line (@{$sublistref}) {
11557: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 11558: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 11559: }
1.984 raeburn 11560: }
1.987 raeburn 11561: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11562: if (opendir(my $dir,$url.'/'.$path)) {
11563: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 11564: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
11565: }
1.1075.2.11 raeburn 11566: } elsif (($actionurl eq '/adm/dependencies') ||
11567: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 11568: ($args->{'context'} eq 'paste')) ||
11569: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11570: if ($env{'request.course.id'} ne '') {
1.1075.2.35 raeburn 11571: my $dir;
11572: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11573: $dir = $fileloc;
11574: } else {
11575: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11576: }
1.1071 raeburn 11577: if ($dir ne '') {
11578: my ($sublistref,$listerror) =
11579: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
11580: if (ref($sublistref) eq 'ARRAY') {
11581: foreach my $line (@{$sublistref}) {
11582: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
11583: undef,$mtime)=split(/\&/,$line,12);
11584: unless (($testdir&$dirptr) ||
11585: ($file_name =~ /^\.\.?$/)) {
11586: $currsubfile{$path}{$file_name} = [$size,$mtime];
11587: }
11588: }
11589: }
11590: }
1.984 raeburn 11591: }
11592: }
11593: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 11594: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 11595: my $item = $path.'/'.$file;
11596: unless ($mapping{$item} eq $item) {
11597: $pathchanges{$item} = 1;
11598: }
11599: $existing{$item} = 1;
11600: $numexisting ++;
11601: } else {
11602: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 11603: }
11604: }
1.1071 raeburn 11605: if ($actionurl eq '/adm/dependencies') {
11606: foreach my $path (keys(%currsubfile)) {
11607: if (ref($currsubfile{$path}) eq 'HASH') {
11608: foreach my $file (keys(%{$currsubfile{$path}})) {
11609: unless ($subdependencies{$path}{$file}) {
1.1075.2.11 raeburn 11610: next if (($rem ne '') &&
11611: (($env{"httpref.$rem"."$path/$file"} ne '') ||
11612: (ref($navmap) &&
11613: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
11614: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11615: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 11616: $unused{$path.'/'.$file} = 1;
11617: }
11618: }
11619: }
11620: }
11621: }
1.984 raeburn 11622: }
1.987 raeburn 11623: my %currfile;
1.1075.2.35 raeburn 11624: if (($actionurl eq '/adm/portfolio') ||
11625: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11626: my ($dirlistref,$listerror) =
11627: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
11628: if (ref($dirlistref) eq 'ARRAY') {
11629: foreach my $line (@{$dirlistref}) {
11630: my ($file_name,$rest) = split(/\&/,$line,2);
11631: $currfile{$file_name} = 1;
11632: }
1.984 raeburn 11633: }
1.987 raeburn 11634: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11635: if (opendir(my $dir,$url)) {
1.987 raeburn 11636: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 11637: map {$currfile{$_} = 1;} @dir_list;
11638: }
1.1075.2.11 raeburn 11639: } elsif (($actionurl eq '/adm/dependencies') ||
11640: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35 raeburn 11641: ($args->{'context'} eq 'paste')) ||
11642: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11643: if ($env{'request.course.id'} ne '') {
11644: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11645: if ($dir ne '') {
11646: my ($dirlistref,$listerror) =
11647: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
11648: if (ref($dirlistref) eq 'ARRAY') {
11649: foreach my $line (@{$dirlistref}) {
11650: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
11651: $size,undef,$mtime)=split(/\&/,$line,12);
11652: unless (($testdir&$dirptr) ||
11653: ($file_name =~ /^\.\.?$/)) {
11654: $currfile{$file_name} = [$size,$mtime];
11655: }
11656: }
11657: }
11658: }
11659: }
1.984 raeburn 11660: }
11661: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 11662: if (exists($currfile{$file})) {
1.987 raeburn 11663: unless ($mapping{$file} eq $file) {
11664: $pathchanges{$file} = 1;
11665: }
11666: $existing{$file} = 1;
11667: $numexisting ++;
11668: } else {
1.984 raeburn 11669: $newfiles{$file} = 1;
11670: }
11671: }
1.1071 raeburn 11672: foreach my $file (keys(%currfile)) {
11673: unless (($file eq $filename) ||
11674: ($file eq $filename.'.bak') ||
11675: ($dependencies{$file})) {
1.1075.2.11 raeburn 11676: if ($actionurl eq '/adm/dependencies') {
1.1075.2.35 raeburn 11677: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
11678: next if (($rem ne '') &&
11679: (($env{"httpref.$rem".$file} ne '') ||
11680: (ref($navmap) &&
11681: (($navmap->getResourceByUrl($rem.$file) ne '') ||
11682: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11683: ($navmap->getResourceByUrl($rem.$1)))))));
11684: }
1.1075.2.11 raeburn 11685: }
1.1071 raeburn 11686: $unused{$file} = 1;
11687: }
11688: }
1.1075.2.11 raeburn 11689: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
11690: ($args->{'context'} eq 'paste')) {
11691: $counter = scalar(keys(%existing));
11692: $numpathchg = scalar(keys(%pathchanges));
11693: return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35 raeburn 11694: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
11695: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
11696: $counter = scalar(keys(%existing));
11697: $numpathchg = scalar(keys(%pathchanges));
11698: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11 raeburn 11699: }
1.984 raeburn 11700: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 11701: if ($actionurl eq '/adm/dependencies') {
11702: next if ($embed_file =~ m{^\w+://});
11703: }
1.660 raeburn 11704: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 11705: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 11706: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 11707: unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35 raeburn 11708: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
11709: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 11710: }
1.1075.2.35 raeburn 11711: $upload_output .= '</td>';
1.1071 raeburn 11712: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1075.2.35 raeburn 11713: $upload_output.='<td align="right">'.
11714: '<span class="LC_info LC_fontsize_medium">'.
11715: &mt("URL points to web address").'</span>';
1.987 raeburn 11716: $numremref++;
1.660 raeburn 11717: } elsif ($args->{'error_on_invalid_names'}
11718: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35 raeburn 11719: $upload_output.='<td align="right"><span class="LC_warning">'.
11720: &mt('Invalid characters').'</span>';
1.987 raeburn 11721: $numinvalid++;
1.660 raeburn 11722: } else {
1.1075.2.35 raeburn 11723: $upload_output .= '<td>'.
11724: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 11725: $embed_file,\%mapping,
1.1071 raeburn 11726: $allfiles,$codebase,'upload');
11727: $counter ++;
11728: $numnew ++;
1.987 raeburn 11729: }
11730: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
11731: }
11732: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 11733: if ($actionurl eq '/adm/dependencies') {
11734: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
11735: $modify_output .= &start_data_table_row().
11736: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
11737: '<img src="'.&icon($embed_file).'" border="0" />'.
11738: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
11739: '<td>'.$size.'</td>'.
11740: '<td>'.$mtime.'</td>'.
11741: '<td><label><input type="checkbox" name="mod_upload_dep" '.
11742: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
11743: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
11744: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
11745: &embedded_file_element('upload_embedded',$counter,
11746: $embed_file,\%mapping,
11747: $allfiles,$codebase,'modify').
11748: '</div></td>'.
11749: &end_data_table_row()."\n";
11750: $counter ++;
11751: } else {
11752: $upload_output .= &start_data_table_row().
1.1075.2.35 raeburn 11753: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
11754: '<span class="LC_filename">'.$embed_file.'</span></td>'.
11755: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 11756: &Apache::loncommon::end_data_table_row()."\n";
11757: }
11758: }
11759: my $delidx = $counter;
11760: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
11761: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
11762: $delete_output .= &start_data_table_row().
11763: '<td><img src="'.&icon($oldfile).'" />'.
11764: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
11765: '<td>'.$size.'</td>'.
11766: '<td>'.$mtime.'</td>'.
11767: '<td><label><input type="checkbox" name="del_upload_dep" '.
11768: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
11769: &embedded_file_element('upload_embedded',$delidx,
11770: $oldfile,\%mapping,$allfiles,
11771: $codebase,'delete').'</td>'.
11772: &end_data_table_row()."\n";
11773: $numunused ++;
11774: $delidx ++;
1.987 raeburn 11775: }
11776: if ($upload_output) {
11777: $upload_output = &start_data_table().
11778: $upload_output.
11779: &end_data_table()."\n";
11780: }
1.1071 raeburn 11781: if ($modify_output) {
11782: $modify_output = &start_data_table().
11783: &start_data_table_header_row().
11784: '<th>'.&mt('File').'</th>'.
11785: '<th>'.&mt('Size (KB)').'</th>'.
11786: '<th>'.&mt('Modified').'</th>'.
11787: '<th>'.&mt('Upload replacement?').'</th>'.
11788: &end_data_table_header_row().
11789: $modify_output.
11790: &end_data_table()."\n";
11791: }
11792: if ($delete_output) {
11793: $delete_output = &start_data_table().
11794: &start_data_table_header_row().
11795: '<th>'.&mt('File').'</th>'.
11796: '<th>'.&mt('Size (KB)').'</th>'.
11797: '<th>'.&mt('Modified').'</th>'.
11798: '<th>'.&mt('Delete?').'</th>'.
11799: &end_data_table_header_row().
11800: $delete_output.
11801: &end_data_table()."\n";
11802: }
1.987 raeburn 11803: my $applies = 0;
11804: if ($numremref) {
11805: $applies ++;
11806: }
11807: if ($numinvalid) {
11808: $applies ++;
11809: }
11810: if ($numexisting) {
11811: $applies ++;
11812: }
1.1071 raeburn 11813: if ($counter || $numunused) {
1.987 raeburn 11814: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
11815: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 11816: $state.'<h3>'.$heading.'</h3>';
11817: if ($actionurl eq '/adm/dependencies') {
11818: if ($numnew) {
11819: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
11820: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
11821: $upload_output.'<br />'."\n";
11822: }
11823: if ($numexisting) {
11824: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
11825: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
11826: $modify_output.'<br />'."\n";
11827: $buttontext = &mt('Save changes');
11828: }
11829: if ($numunused) {
11830: $output .= '<h4>'.&mt('Unused files').'</h4>'.
11831: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
11832: $delete_output.'<br />'."\n";
11833: $buttontext = &mt('Save changes');
11834: }
11835: } else {
11836: $output .= $upload_output.'<br />'."\n";
11837: }
11838: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
11839: $counter.'" />'."\n";
11840: if ($actionurl eq '/adm/dependencies') {
11841: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
11842: $numnew.'" />'."\n";
11843: } elsif ($actionurl eq '') {
1.987 raeburn 11844: $output .= '<input type="hidden" name="phase" value="three" />';
11845: }
11846: } elsif ($applies) {
11847: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
11848: if ($applies > 1) {
11849: $output .=
1.1075.2.35 raeburn 11850: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 11851: if ($numremref) {
11852: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
11853: }
11854: if ($numinvalid) {
11855: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
11856: }
11857: if ($numexisting) {
11858: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
11859: }
11860: $output .= '</ul><br />';
11861: } elsif ($numremref) {
11862: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
11863: } elsif ($numinvalid) {
11864: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
11865: } elsif ($numexisting) {
11866: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
11867: }
11868: $output .= $upload_output.'<br />';
11869: }
11870: my ($pathchange_output,$chgcount);
1.1071 raeburn 11871: $chgcount = $counter;
1.987 raeburn 11872: if (keys(%pathchanges) > 0) {
11873: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 11874: if ($counter) {
1.987 raeburn 11875: $output .= &embedded_file_element('pathchange',$chgcount,
11876: $embed_file,\%mapping,
1.1071 raeburn 11877: $allfiles,$codebase,'change');
1.987 raeburn 11878: } else {
11879: $pathchange_output .=
11880: &start_data_table_row().
11881: '<td><input type ="checkbox" name="namechange" value="'.
11882: $chgcount.'" checked="checked" /></td>'.
11883: '<td>'.$mapping{$embed_file}.'</td>'.
11884: '<td>'.$embed_file.
11885: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 11886: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 11887: '</td>'.&end_data_table_row();
1.660 raeburn 11888: }
1.987 raeburn 11889: $numpathchg ++;
11890: $chgcount ++;
1.660 raeburn 11891: }
11892: }
1.1075.2.35 raeburn 11893: if (($counter) || ($numunused)) {
1.987 raeburn 11894: if ($numpathchg) {
11895: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
11896: $numpathchg.'" />'."\n";
11897: }
11898: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11899: ($actionurl eq '/adm/imsimport')) {
11900: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
11901: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
11902: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 11903: } elsif ($actionurl eq '/adm/dependencies') {
11904: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 11905: }
1.1075.2.35 raeburn 11906: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 11907: } elsif ($numpathchg) {
11908: my %pathchange = ();
11909: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
11910: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11911: $output .= '<p>'.&mt('or').'</p>';
1.1075.2.35 raeburn 11912: }
1.987 raeburn 11913: }
1.1071 raeburn 11914: return ($output,$counter,$numpathchg);
1.987 raeburn 11915: }
11916:
1.1075.2.47 raeburn 11917: =pod
11918:
11919: =item * clean_path($name)
11920:
11921: Performs clean-up of directories, subdirectories and filename in an
11922: embedded object, referenced in an HTML file which is being uploaded
11923: to a course or portfolio, where
11924: "Upload embedded images/multimedia files if HTML file" checkbox was
11925: checked.
11926:
11927: Clean-up is similar to replacements in lonnet::clean_filename()
11928: except each / between sub-directory and next level is preserved.
11929:
11930: =cut
11931:
11932: sub clean_path {
11933: my ($embed_file) = @_;
11934: $embed_file =~s{^/+}{};
11935: my @contents;
11936: if ($embed_file =~ m{/}) {
11937: @contents = split(/\//,$embed_file);
11938: } else {
11939: @contents = ($embed_file);
11940: }
11941: my $lastidx = scalar(@contents)-1;
11942: for (my $i=0; $i<=$lastidx; $i++) {
11943: $contents[$i]=~s{\\}{/}g;
11944: $contents[$i]=~s/\s+/\_/g;
11945: $contents[$i]=~s{[^/\w\.\-]}{}g;
11946: if ($i == $lastidx) {
11947: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
11948: }
11949: }
11950: if ($lastidx > 0) {
11951: return join('/',@contents);
11952: } else {
11953: return $contents[0];
11954: }
11955: }
11956:
1.987 raeburn 11957: sub embedded_file_element {
1.1071 raeburn 11958: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 11959: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
11960: (ref($codebase) eq 'HASH'));
11961: my $output;
1.1071 raeburn 11962: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 11963: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
11964: }
11965: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
11966: &escape($embed_file).'" />';
11967: unless (($context eq 'upload_embedded') &&
11968: ($mapping->{$embed_file} eq $embed_file)) {
11969: $output .='
11970: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
11971: }
11972: my $attrib;
11973: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
11974: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
11975: }
11976: $output .=
11977: "\n\t\t".
11978: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
11979: $attrib.'" />';
11980: if (exists($codebase->{$mapping->{$embed_file}})) {
11981: $output .=
11982: "\n\t\t".
11983: '<input name="codebase_'.$num.'" type="hidden" value="'.
11984: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 11985: }
1.987 raeburn 11986: return $output;
1.660 raeburn 11987: }
11988:
1.1071 raeburn 11989: sub get_dependency_details {
11990: my ($currfile,$currsubfile,$embed_file) = @_;
11991: my ($size,$mtime,$showsize,$showmtime);
11992: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
11993: if ($embed_file =~ m{/}) {
11994: my ($path,$fname) = split(/\//,$embed_file);
11995: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
11996: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
11997: }
11998: } else {
11999: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
12000: ($size,$mtime) = @{$currfile->{$embed_file}};
12001: }
12002: }
12003: $showsize = $size/1024.0;
12004: $showsize = sprintf("%.1f",$showsize);
12005: if ($mtime > 0) {
12006: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
12007: }
12008: }
12009: return ($showsize,$showmtime);
12010: }
12011:
12012: sub ask_embedded_js {
12013: return <<"END";
12014: <script type="text/javascript"">
12015: // <![CDATA[
12016: function toggleBrowse(counter) {
12017: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
12018: var fileid = document.getElementById('embedded_item_'+counter);
12019: var uploaddivid = document.getElementById('moduploaddep_'+counter);
12020: if (chkboxid.checked == true) {
12021: uploaddivid.style.display='block';
12022: } else {
12023: uploaddivid.style.display='none';
12024: fileid.value = '';
12025: }
12026: }
12027: // ]]>
12028: </script>
12029:
12030: END
12031: }
12032:
1.661 raeburn 12033: sub upload_embedded {
12034: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 12035: $current_disk_usage,$hiddenstate,$actionurl) = @_;
12036: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 12037: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
12038: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
12039: my $orig_uploaded_filename =
12040: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 12041: foreach my $type ('orig','ref','attrib','codebase') {
12042: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
12043: $env{'form.embedded_'.$type.'_'.$i} =
12044: &unescape($env{'form.embedded_'.$type.'_'.$i});
12045: }
12046: }
1.661 raeburn 12047: my ($path,$fname) =
12048: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
12049: # no path, whole string is fname
12050: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
12051: $fname = &Apache::lonnet::clean_filename($fname);
12052: # See if there is anything left
12053: next if ($fname eq '');
12054:
12055: # Check if file already exists as a file or directory.
12056: my ($state,$msg);
12057: if ($context eq 'portfolio') {
12058: my $port_path = $dirpath;
12059: if ($group ne '') {
12060: $port_path = "groups/$group/$port_path";
12061: }
1.987 raeburn 12062: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
12063: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 12064: $dir_root,$port_path,$disk_quota,
12065: $current_disk_usage,$uname,$udom);
12066: if ($state eq 'will_exceed_quota'
1.984 raeburn 12067: || $state eq 'file_locked') {
1.661 raeburn 12068: $output .= $msg;
12069: next;
12070: }
12071: } elsif (($context eq 'author') || ($context eq 'testbank')) {
12072: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
12073: if ($state eq 'exists') {
12074: $output .= $msg;
12075: next;
12076: }
12077: }
12078: # Check if extension is valid
12079: if (($fname =~ /\.(\w+)$/) &&
12080: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53 raeburn 12081: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
12082: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 12083: next;
12084: } elsif (($fname =~ /\.(\w+)$/) &&
12085: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 12086: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 12087: next;
12088: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34 raeburn 12089: $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 12090: next;
12091: }
12092: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35 raeburn 12093: my $subdir = $path;
12094: $subdir =~ s{/+$}{};
1.661 raeburn 12095: if ($context eq 'portfolio') {
1.984 raeburn 12096: my $result;
12097: if ($state eq 'existingfile') {
12098: $result=
12099: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35 raeburn 12100: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 12101: } else {
1.984 raeburn 12102: $result=
12103: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 12104: $dirpath.
1.1075.2.35 raeburn 12105: $env{'form.currentpath'}.$subdir);
1.984 raeburn 12106: if ($result !~ m|^/uploaded/|) {
12107: $output .= '<span class="LC_error">'
12108: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12109: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12110: .'</span><br />';
12111: next;
12112: } else {
1.987 raeburn 12113: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12114: $path.$fname.'</span>').'<br />';
1.984 raeburn 12115: }
1.661 raeburn 12116: }
1.1075.2.35 raeburn 12117: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
12118: my $extendedsubdir = $dirpath.'/'.$subdir;
12119: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 12120: my $result =
1.1075.2.35 raeburn 12121: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 12122: if ($result !~ m|^/uploaded/|) {
12123: $output .= '<span class="LC_error">'
12124: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12125: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12126: .'</span><br />';
12127: next;
12128: } else {
12129: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12130: $path.$fname.'</span>').'<br />';
1.1075.2.35 raeburn 12131: if ($context eq 'syllabus') {
12132: &Apache::lonnet::make_public_indefinitely($result);
12133: }
1.987 raeburn 12134: }
1.661 raeburn 12135: } else {
12136: # Save the file
12137: my $target = $env{'form.embedded_item_'.$i};
12138: my $fullpath = $dir_root.$dirpath.'/'.$path;
12139: my $dest = $fullpath.$fname;
12140: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 12141: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 12142: my $count;
12143: my $filepath = $dir_root;
1.1027 raeburn 12144: foreach my $subdir (@parts) {
12145: $filepath .= "/$subdir";
12146: if (!-e $filepath) {
1.661 raeburn 12147: mkdir($filepath,0770);
12148: }
12149: }
12150: my $fh;
12151: if (!open($fh,'>'.$dest)) {
12152: &Apache::lonnet::logthis('Failed to create '.$dest);
12153: $output .= '<span class="LC_error">'.
1.1071 raeburn 12154: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
12155: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12156: '</span><br />';
12157: } else {
12158: if (!print $fh $env{'form.embedded_item_'.$i}) {
12159: &Apache::lonnet::logthis('Failed to write to '.$dest);
12160: $output .= '<span class="LC_error">'.
1.1071 raeburn 12161: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
12162: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12163: '</span><br />';
12164: } else {
1.987 raeburn 12165: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12166: $url.'</span>').'<br />';
12167: unless ($context eq 'testbank') {
12168: $footer .= &mt('View embedded file: [_1]',
12169: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
12170: }
12171: }
12172: close($fh);
12173: }
12174: }
12175: if ($env{'form.embedded_ref_'.$i}) {
12176: $pathchange{$i} = 1;
12177: }
12178: }
12179: if ($output) {
12180: $output = '<p>'.$output.'</p>';
12181: }
12182: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
12183: $returnflag = 'ok';
1.1071 raeburn 12184: my $numpathchgs = scalar(keys(%pathchange));
12185: if ($numpathchgs > 0) {
1.987 raeburn 12186: if ($context eq 'portfolio') {
12187: $output .= '<p>'.&mt('or').'</p>';
12188: } elsif ($context eq 'testbank') {
1.1071 raeburn 12189: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
12190: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 12191: $returnflag = 'modify_orightml';
12192: }
12193: }
1.1071 raeburn 12194: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 12195: }
12196:
12197: sub modify_html_form {
12198: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
12199: my $end = 0;
12200: my $modifyform;
12201: if ($context eq 'upload_embedded') {
12202: return unless (ref($pathchange) eq 'HASH');
12203: if ($env{'form.number_embedded_items'}) {
12204: $end += $env{'form.number_embedded_items'};
12205: }
12206: if ($env{'form.number_pathchange_items'}) {
12207: $end += $env{'form.number_pathchange_items'};
12208: }
12209: if ($end) {
12210: for (my $i=0; $i<$end; $i++) {
12211: if ($i < $env{'form.number_embedded_items'}) {
12212: next unless($pathchange->{$i});
12213: }
12214: $modifyform .=
12215: &start_data_table_row().
12216: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
12217: 'checked="checked" /></td>'.
12218: '<td>'.$env{'form.embedded_ref_'.$i}.
12219: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
12220: &escape($env{'form.embedded_ref_'.$i}).'" />'.
12221: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
12222: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
12223: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
12224: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
12225: '<td>'.$env{'form.embedded_orig_'.$i}.
12226: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
12227: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
12228: &end_data_table_row();
1.1071 raeburn 12229: }
1.987 raeburn 12230: }
12231: } else {
12232: $modifyform = $pathchgtable;
12233: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
12234: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
12235: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12236: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
12237: }
12238: }
12239: if ($modifyform) {
1.1071 raeburn 12240: if ($actionurl eq '/adm/dependencies') {
12241: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
12242: }
1.987 raeburn 12243: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
12244: '<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".
12245: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
12246: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
12247: '</ol></p>'."\n".'<p>'.
12248: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
12249: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
12250: &start_data_table()."\n".
12251: &start_data_table_header_row().
12252: '<th>'.&mt('Change?').'</th>'.
12253: '<th>'.&mt('Current reference').'</th>'.
12254: '<th>'.&mt('Required reference').'</th>'.
12255: &end_data_table_header_row()."\n".
12256: $modifyform.
12257: &end_data_table().'<br />'."\n".$hiddenstate.
12258: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
12259: '</form>'."\n";
12260: }
12261: return;
12262: }
12263:
12264: sub modify_html_refs {
1.1075.2.35 raeburn 12265: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 12266: my $container;
12267: if ($context eq 'portfolio') {
12268: $container = $env{'form.container'};
12269: } elsif ($context eq 'coursedoc') {
12270: $container = $env{'form.primaryurl'};
1.1071 raeburn 12271: } elsif ($context eq 'manage_dependencies') {
12272: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
12273: $container = "/$container";
1.1075.2.35 raeburn 12274: } elsif ($context eq 'syllabus') {
12275: $container = $url;
1.987 raeburn 12276: } else {
1.1027 raeburn 12277: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 12278: }
12279: my (%allfiles,%codebase,$output,$content);
12280: my @changes = &get_env_multiple('form.namechange');
1.1075.2.35 raeburn 12281: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 12282: if (wantarray) {
12283: return ('',0,0);
12284: } else {
12285: return;
12286: }
12287: }
12288: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 12289: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 12290: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
12291: if (wantarray) {
12292: return ('',0,0);
12293: } else {
12294: return;
12295: }
12296: }
1.987 raeburn 12297: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 12298: if ($content eq '-1') {
12299: if (wantarray) {
12300: return ('',0,0);
12301: } else {
12302: return;
12303: }
12304: }
1.987 raeburn 12305: } else {
1.1071 raeburn 12306: unless ($container =~ /^\Q$dir_root\E/) {
12307: if (wantarray) {
12308: return ('',0,0);
12309: } else {
12310: return;
12311: }
12312: }
1.1075.2.128 raeburn 12313: if (open(my $fh,'<',$container)) {
1.987 raeburn 12314: $content = join('', <$fh>);
12315: close($fh);
12316: } else {
1.1071 raeburn 12317: if (wantarray) {
12318: return ('',0,0);
12319: } else {
12320: return;
12321: }
1.987 raeburn 12322: }
12323: }
12324: my ($count,$codebasecount) = (0,0);
12325: my $mm = new File::MMagic;
12326: my $mime_type = $mm->checktype_contents($content);
12327: if ($mime_type eq 'text/html') {
12328: my $parse_result =
12329: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
12330: \%codebase,\$content);
12331: if ($parse_result eq 'ok') {
12332: foreach my $i (@changes) {
12333: my $orig = &unescape($env{'form.embedded_orig_'.$i});
12334: my $ref = &unescape($env{'form.embedded_ref_'.$i});
12335: if ($allfiles{$ref}) {
12336: my $newname = $orig;
12337: my ($attrib_regexp,$codebase);
1.1006 raeburn 12338: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 12339: if ($attrib_regexp =~ /:/) {
12340: $attrib_regexp =~ s/\:/|/g;
12341: }
12342: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12343: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12344: $count += $numchg;
1.1075.2.35 raeburn 12345: $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48 raeburn 12346: delete($allfiles{$ref});
1.987 raeburn 12347: }
12348: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 12349: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 12350: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
12351: $codebasecount ++;
12352: }
12353: }
12354: }
1.1075.2.35 raeburn 12355: my $skiprewrites;
1.987 raeburn 12356: if ($count || $codebasecount) {
12357: my $saveresult;
1.1071 raeburn 12358: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1075.2.35 raeburn 12359: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 12360: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12361: if ($url eq $container) {
12362: my ($fname) = ($container =~ m{/([^/]+)$});
12363: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12364: $count,'<span class="LC_filename">'.
1.1071 raeburn 12365: $fname.'</span>').'</p>';
1.987 raeburn 12366: } else {
12367: $output = '<p class="LC_error">'.
12368: &mt('Error: update failed for: [_1].',
12369: '<span class="LC_filename">'.
12370: $container.'</span>').'</p>';
12371: }
1.1075.2.35 raeburn 12372: if ($context eq 'syllabus') {
12373: unless ($saveresult eq 'ok') {
12374: $skiprewrites = 1;
12375: }
12376: }
1.987 raeburn 12377: } else {
1.1075.2.128 raeburn 12378: if (open(my $fh,'>',$container)) {
1.987 raeburn 12379: print $fh $content;
12380: close($fh);
12381: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12382: $count,'<span class="LC_filename">'.
12383: $container.'</span>').'</p>';
1.661 raeburn 12384: } else {
1.987 raeburn 12385: $output = '<p class="LC_error">'.
12386: &mt('Error: could not update [_1].',
12387: '<span class="LC_filename">'.
12388: $container.'</span>').'</p>';
1.661 raeburn 12389: }
12390: }
12391: }
1.1075.2.35 raeburn 12392: if (($context eq 'syllabus') && (!$skiprewrites)) {
12393: my ($actionurl,$state);
12394: $actionurl = "/public/$udom/$uname/syllabus";
12395: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
12396: &ask_for_embedded_content($actionurl,$state,\%allfiles,
12397: \%codebase,
12398: {'context' => 'rewrites',
12399: 'ignore_remote_references' => 1,});
12400: if (ref($mapping) eq 'HASH') {
12401: my $rewrites = 0;
12402: foreach my $key (keys(%{$mapping})) {
12403: next if ($key =~ m{^https?://});
12404: my $ref = $mapping->{$key};
12405: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
12406: my $attrib;
12407: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
12408: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
12409: }
12410: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12411: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12412: $rewrites += $numchg;
12413: }
12414: }
12415: if ($rewrites) {
12416: my $saveresult;
12417: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12418: if ($url eq $container) {
12419: my ($fname) = ($container =~ m{/([^/]+)$});
12420: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
12421: $count,'<span class="LC_filename">'.
12422: $fname.'</span>').'</p>';
12423: } else {
12424: $output .= '<p class="LC_error">'.
12425: &mt('Error: could not update links in [_1].',
12426: '<span class="LC_filename">'.
12427: $container.'</span>').'</p>';
12428:
12429: }
12430: }
12431: }
12432: }
1.987 raeburn 12433: } else {
12434: &logthis('Failed to parse '.$container.
12435: ' to modify references: '.$parse_result);
1.661 raeburn 12436: }
12437: }
1.1071 raeburn 12438: if (wantarray) {
12439: return ($output,$count,$codebasecount);
12440: } else {
12441: return $output;
12442: }
1.661 raeburn 12443: }
12444:
12445: sub check_for_existing {
12446: my ($path,$fname,$element) = @_;
12447: my ($state,$msg);
12448: if (-d $path.'/'.$fname) {
12449: $state = 'exists';
12450: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12451: } elsif (-e $path.'/'.$fname) {
12452: $state = 'exists';
12453: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12454: }
12455: if ($state eq 'exists') {
12456: $msg = '<span class="LC_error">'.$msg.'</span><br />';
12457: }
12458: return ($state,$msg);
12459: }
12460:
12461: sub check_for_upload {
12462: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
12463: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 12464: my $filesize = length($env{'form.'.$element});
12465: if (!$filesize) {
12466: my $msg = '<span class="LC_error">'.
12467: &mt('Unable to upload [_1]. (size = [_2] bytes)',
12468: '<span class="LC_filename">'.$fname.'</span>',
12469: $filesize).'<br />'.
1.1007 raeburn 12470: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 12471: '</span>';
12472: return ('zero_bytes',$msg);
12473: }
12474: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 12475: my $getpropath = 1;
1.1021 raeburn 12476: my ($dirlistref,$listerror) =
12477: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 12478: my $found_file = 0;
12479: my $locked_file = 0;
1.991 raeburn 12480: my @lockers;
12481: my $navmap;
12482: if ($env{'request.course.id'}) {
12483: $navmap = Apache::lonnavmaps::navmap->new();
12484: }
1.1021 raeburn 12485: if (ref($dirlistref) eq 'ARRAY') {
12486: foreach my $line (@{$dirlistref}) {
12487: my ($file_name,$rest)=split(/\&/,$line,2);
12488: if ($file_name eq $fname){
12489: $file_name = $path.$file_name;
12490: if ($group ne '') {
12491: $file_name = $group.$file_name;
12492: }
12493: $found_file = 1;
12494: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
12495: foreach my $lock (@lockers) {
12496: if (ref($lock) eq 'ARRAY') {
12497: my ($symb,$crsid) = @{$lock};
12498: if ($crsid eq $env{'request.course.id'}) {
12499: if (ref($navmap)) {
12500: my $res = $navmap->getBySymb($symb);
12501: foreach my $part (@{$res->parts()}) {
12502: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
12503: unless (($slot_status == $res->RESERVED) ||
12504: ($slot_status == $res->RESERVED_LOCATION)) {
12505: $locked_file = 1;
12506: }
1.991 raeburn 12507: }
1.1021 raeburn 12508: } else {
12509: $locked_file = 1;
1.991 raeburn 12510: }
12511: } else {
12512: $locked_file = 1;
12513: }
12514: }
1.1021 raeburn 12515: }
12516: } else {
12517: my @info = split(/\&/,$rest);
12518: my $currsize = $info[6]/1000;
12519: if ($currsize < $filesize) {
12520: my $extra = $filesize - $currsize;
12521: if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69 raeburn 12522: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 12523: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
1.1075.2.69 raeburn 12524: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
12525: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
12526: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 12527: return ('will_exceed_quota',$msg);
12528: }
1.984 raeburn 12529: }
12530: }
1.661 raeburn 12531: }
12532: }
12533: }
12534: if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69 raeburn 12535: my $msg = '<p class="LC_warning">'.
12536: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
12537: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 12538: return ('will_exceed_quota',$msg);
12539: } elsif ($found_file) {
12540: if ($locked_file) {
1.1075.2.69 raeburn 12541: my $msg = '<p class="LC_warning">';
1.661 raeburn 12542: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
1.1075.2.69 raeburn 12543: $msg .= '</p>';
1.661 raeburn 12544: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
12545: return ('file_locked',$msg);
12546: } else {
1.1075.2.69 raeburn 12547: my $msg = '<p class="LC_error">';
1.984 raeburn 12548: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1075.2.69 raeburn 12549: $msg .= '</p>';
1.984 raeburn 12550: return ('existingfile',$msg);
1.661 raeburn 12551: }
12552: }
12553: }
12554:
1.987 raeburn 12555: sub check_for_traversal {
12556: my ($path,$url,$toplevel) = @_;
12557: my @parts=split(/\//,$path);
12558: my $cleanpath;
12559: my $fullpath = $url;
12560: for (my $i=0;$i<@parts;$i++) {
12561: next if ($parts[$i] eq '.');
12562: if ($parts[$i] eq '..') {
12563: $fullpath =~ s{([^/]+/)$}{};
12564: } else {
12565: $fullpath .= $parts[$i].'/';
12566: }
12567: }
12568: if ($fullpath =~ /^\Q$url\E(.*)$/) {
12569: $cleanpath = $1;
12570: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
12571: my $curr_toprel = $1;
12572: my @parts = split(/\//,$curr_toprel);
12573: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
12574: my @urlparts = split(/\//,$url_toprel);
12575: my $doubledots;
12576: my $startdiff = -1;
12577: for (my $i=0; $i<@urlparts; $i++) {
12578: if ($startdiff == -1) {
12579: unless ($urlparts[$i] eq $parts[$i]) {
12580: $startdiff = $i;
12581: $doubledots .= '../';
12582: }
12583: } else {
12584: $doubledots .= '../';
12585: }
12586: }
12587: if ($startdiff > -1) {
12588: $cleanpath = $doubledots;
12589: for (my $i=$startdiff; $i<@parts; $i++) {
12590: $cleanpath .= $parts[$i].'/';
12591: }
12592: }
12593: }
12594: $cleanpath =~ s{(/)$}{};
12595: return $cleanpath;
12596: }
1.31 albertel 12597:
1.1053 raeburn 12598: sub is_archive_file {
12599: my ($mimetype) = @_;
12600: if (($mimetype eq 'application/octet-stream') ||
12601: ($mimetype eq 'application/x-stuffit') ||
12602: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
12603: return 1;
12604: }
12605: return;
12606: }
12607:
12608: sub decompress_form {
1.1065 raeburn 12609: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 12610: my %lt = &Apache::lonlocal::texthash (
12611: this => 'This file is an archive file.',
1.1067 raeburn 12612: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 12613: itsc => 'Its contents are as follows:',
1.1053 raeburn 12614: youm => 'You may wish to extract its contents.',
12615: extr => 'Extract contents',
1.1067 raeburn 12616: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
12617: proa => 'Process automatically?',
1.1053 raeburn 12618: yes => 'Yes',
12619: no => 'No',
1.1067 raeburn 12620: fold => 'Title for folder containing movie',
12621: movi => 'Title for page containing embedded movie',
1.1053 raeburn 12622: );
1.1065 raeburn 12623: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 12624: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 12625: my $info = &list_archive_contents($fileloc,\@paths);
12626: if (@paths) {
12627: foreach my $path (@paths) {
12628: $path =~ s{^/}{};
1.1067 raeburn 12629: if ($path =~ m{^([^/]+)/$}) {
12630: $topdir = $1;
12631: }
1.1065 raeburn 12632: if ($path =~ m{^([^/]+)/}) {
12633: $toplevel{$1} = $path;
12634: } else {
12635: $toplevel{$path} = $path;
12636: }
12637: }
12638: }
1.1067 raeburn 12639: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59 raeburn 12640: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 12641: "$topdir/media/",
12642: "$topdir/media/$topdir.mp4",
12643: "$topdir/media/FirstFrame.png",
12644: "$topdir/media/player.swf",
12645: "$topdir/media/swfobject.js",
12646: "$topdir/media/expressInstall.swf");
1.1075.2.81 raeburn 12647: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59 raeburn 12648: "$topdir/$topdir.mp4",
12649: "$topdir/$topdir\_config.xml",
12650: "$topdir/$topdir\_controller.swf",
12651: "$topdir/$topdir\_embed.css",
12652: "$topdir/$topdir\_First_Frame.png",
12653: "$topdir/$topdir\_player.html",
12654: "$topdir/$topdir\_Thumbnails.png",
12655: "$topdir/playerProductInstall.swf",
12656: "$topdir/scripts/",
12657: "$topdir/scripts/config_xml.js",
12658: "$topdir/scripts/handlebars.js",
12659: "$topdir/scripts/jquery-1.7.1.min.js",
12660: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
12661: "$topdir/scripts/modernizr.js",
12662: "$topdir/scripts/player-min.js",
12663: "$topdir/scripts/swfobject.js",
12664: "$topdir/skins/",
12665: "$topdir/skins/configuration_express.xml",
12666: "$topdir/skins/express_show/",
12667: "$topdir/skins/express_show/player-min.css",
12668: "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81 raeburn 12669: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
12670: "$topdir/$topdir.mp4",
12671: "$topdir/$topdir\_config.xml",
12672: "$topdir/$topdir\_controller.swf",
12673: "$topdir/$topdir\_embed.css",
12674: "$topdir/$topdir\_First_Frame.png",
12675: "$topdir/$topdir\_player.html",
12676: "$topdir/$topdir\_Thumbnails.png",
12677: "$topdir/playerProductInstall.swf",
12678: "$topdir/scripts/",
12679: "$topdir/scripts/config_xml.js",
12680: "$topdir/scripts/techsmith-smart-player.min.js",
12681: "$topdir/skins/",
12682: "$topdir/skins/configuration_express.xml",
12683: "$topdir/skins/express_show/",
12684: "$topdir/skins/express_show/spritesheet.min.css",
12685: "$topdir/skins/express_show/spritesheet.png",
12686: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59 raeburn 12687: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 12688: if (@diffs == 0) {
1.1075.2.59 raeburn 12689: $is_camtasia = 6;
12690: } else {
1.1075.2.81 raeburn 12691: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59 raeburn 12692: if (@diffs == 0) {
12693: $is_camtasia = 8;
1.1075.2.81 raeburn 12694: } else {
12695: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
12696: if (@diffs == 0) {
12697: $is_camtasia = 8;
12698: }
1.1075.2.59 raeburn 12699: }
1.1067 raeburn 12700: }
12701: }
12702: my $output;
12703: if ($is_camtasia) {
12704: $output = <<"ENDCAM";
12705: <script type="text/javascript" language="Javascript">
12706: // <![CDATA[
12707:
12708: function camtasiaToggle() {
12709: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
12710: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59 raeburn 12711: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 12712: document.getElementById('camtasia_titles').style.display='block';
12713: } else {
12714: document.getElementById('camtasia_titles').style.display='none';
12715: }
12716: }
12717: }
12718: return;
12719: }
12720:
12721: // ]]>
12722: </script>
12723: <p>$lt{'camt'}</p>
12724: ENDCAM
1.1065 raeburn 12725: } else {
1.1067 raeburn 12726: $output = '<p>'.$lt{'this'};
12727: if ($info eq '') {
12728: $output .= ' '.$lt{'youm'}.'</p>'."\n";
12729: } else {
12730: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
12731: '<div><pre>'.$info.'</pre></div>';
12732: }
1.1065 raeburn 12733: }
1.1067 raeburn 12734: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 12735: my $duplicates;
12736: my $num = 0;
12737: if (ref($dirlist) eq 'ARRAY') {
12738: foreach my $item (@{$dirlist}) {
12739: if (ref($item) eq 'ARRAY') {
12740: if (exists($toplevel{$item->[0]})) {
12741: $duplicates .=
12742: &start_data_table_row().
12743: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
12744: 'value="0" checked="checked" />'.&mt('No').'</label>'.
12745: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
12746: 'value="1" />'.&mt('Yes').'</label>'.
12747: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
12748: '<td>'.$item->[0].'</td>';
12749: if ($item->[2]) {
12750: $duplicates .= '<td>'.&mt('Directory').'</td>';
12751: } else {
12752: $duplicates .= '<td>'.&mt('File').'</td>';
12753: }
12754: $duplicates .= '<td>'.$item->[3].'</td>'.
12755: '<td>'.
12756: &Apache::lonlocal::locallocaltime($item->[4]).
12757: '</td>'.
12758: &end_data_table_row();
12759: $num ++;
12760: }
12761: }
12762: }
12763: }
12764: my $itemcount;
12765: if (@paths > 0) {
12766: $itemcount = scalar(@paths);
12767: } else {
12768: $itemcount = 1;
12769: }
1.1067 raeburn 12770: if ($is_camtasia) {
12771: $output .= $lt{'auto'}.'<br />'.
12772: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59 raeburn 12773: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 12774: $lt{'yes'}.'</label> <label>'.
12775: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
12776: $lt{'no'}.'</label></span><br />'.
12777: '<div id="camtasia_titles" style="display:block">'.
12778: &Apache::lonhtmlcommon::start_pick_box().
12779: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
12780: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
12781: &Apache::lonhtmlcommon::row_closure().
12782: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
12783: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
12784: &Apache::lonhtmlcommon::row_closure(1).
12785: &Apache::lonhtmlcommon::end_pick_box().
12786: '</div>';
12787: }
1.1065 raeburn 12788: $output .=
12789: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 12790: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
12791: "\n";
1.1065 raeburn 12792: if ($duplicates ne '') {
12793: $output .= '<p><span class="LC_warning">'.
12794: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
12795: &start_data_table().
12796: &start_data_table_header_row().
12797: '<th>'.&mt('Overwrite?').'</th>'.
12798: '<th>'.&mt('Name').'</th>'.
12799: '<th>'.&mt('Type').'</th>'.
12800: '<th>'.&mt('Size').'</th>'.
12801: '<th>'.&mt('Last modified').'</th>'.
12802: &end_data_table_header_row().
12803: $duplicates.
12804: &end_data_table().
12805: '</p>';
12806: }
1.1067 raeburn 12807: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 12808: if (ref($hiddenelements) eq 'HASH') {
12809: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
12810: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
12811: }
12812: }
12813: $output .= <<"END";
1.1067 raeburn 12814: <br />
1.1053 raeburn 12815: <input type="submit" name="decompress" value="$lt{'extr'}" />
12816: </form>
12817: $noextract
12818: END
12819: return $output;
12820: }
12821:
1.1065 raeburn 12822: sub decompression_utility {
12823: my ($program) = @_;
12824: my @utilities = ('tar','gunzip','bunzip2','unzip');
12825: my $location;
12826: if (grep(/^\Q$program\E$/,@utilities)) {
12827: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
12828: '/usr/sbin/') {
12829: if (-x $dir.$program) {
12830: $location = $dir.$program;
12831: last;
12832: }
12833: }
12834: }
12835: return $location;
12836: }
12837:
12838: sub list_archive_contents {
12839: my ($file,$pathsref) = @_;
12840: my (@cmd,$output);
12841: my $needsregexp;
12842: if ($file =~ /\.zip$/) {
12843: @cmd = (&decompression_utility('unzip'),"-l");
12844: $needsregexp = 1;
12845: } elsif (($file =~ m/\.tar\.gz$/) ||
12846: ($file =~ /\.tgz$/)) {
12847: @cmd = (&decompression_utility('tar'),"-ztf");
12848: } elsif ($file =~ /\.tar\.bz2$/) {
12849: @cmd = (&decompression_utility('tar'),"-jtf");
12850: } elsif ($file =~ m|\.tar$|) {
12851: @cmd = (&decompression_utility('tar'),"-tf");
12852: }
12853: if (@cmd) {
12854: undef($!);
12855: undef($@);
12856: if (open(my $fh,"-|", @cmd, $file)) {
12857: while (my $line = <$fh>) {
12858: $output .= $line;
12859: chomp($line);
12860: my $item;
12861: if ($needsregexp) {
12862: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
12863: } else {
12864: $item = $line;
12865: }
12866: if ($item ne '') {
12867: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
12868: push(@{$pathsref},$item);
12869: }
12870: }
12871: }
12872: close($fh);
12873: }
12874: }
12875: return $output;
12876: }
12877:
1.1053 raeburn 12878: sub decompress_uploaded_file {
12879: my ($file,$dir) = @_;
12880: &Apache::lonnet::appenv({'cgi.file' => $file});
12881: &Apache::lonnet::appenv({'cgi.dir' => $dir});
12882: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
12883: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
12884: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
12885: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
12886: my $decompressed = $env{'cgi.decompressed'};
12887: &Apache::lonnet::delenv('cgi.file');
12888: &Apache::lonnet::delenv('cgi.dir');
12889: &Apache::lonnet::delenv('cgi.decompressed');
12890: return ($decompressed,$result);
12891: }
12892:
1.1055 raeburn 12893: sub process_decompression {
12894: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128 raeburn 12895: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
12896: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12897: &mt('Unexpected file path.').'</p>'."\n";
12898: }
12899: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
12900: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12901: &mt('Unexpected course context.').'</p>'."\n";
12902: }
12903: unless ($file eq &Apache::lonnet::clean_filename($file)) {
12904: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12905: &mt('Filename contained unexpected characters.').'</p>'."\n";
12906: }
1.1055 raeburn 12907: my ($dir,$error,$warning,$output);
1.1075.2.69 raeburn 12908: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34 raeburn 12909: $error = &mt('Filename not a supported archive file type.').
12910: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 12911: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
12912: } else {
12913: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12914: if ($docuhome eq 'no_host') {
12915: $error = &mt('Could not determine home server for course.');
12916: } else {
12917: my @ids=&Apache::lonnet::current_machine_ids();
12918: my $currdir = "$dir_root/$destination";
12919: if (grep(/^\Q$docuhome\E$/,@ids)) {
12920: $dir = &LONCAPA::propath($docudom,$docuname).
12921: "$dir_root/$destination";
12922: } else {
12923: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
12924: "$dir_root/$docudom/$docuname/$destination";
12925: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
12926: $error = &mt('Archive file not found.');
12927: }
12928: }
1.1065 raeburn 12929: my (@to_overwrite,@to_skip);
12930: if ($env{'form.archive_overwrite_total'} > 0) {
12931: my $total = $env{'form.archive_overwrite_total'};
12932: for (my $i=0; $i<$total; $i++) {
12933: if ($env{'form.archive_overwrite_'.$i} == 1) {
12934: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
12935: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
12936: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
12937: }
12938: }
12939: }
12940: my $numskip = scalar(@to_skip);
1.1075.2.128 raeburn 12941: my $numoverwrite = scalar(@to_overwrite);
12942: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 12943: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
12944: } elsif ($dir eq '') {
1.1055 raeburn 12945: $error = &mt('Directory containing archive file unavailable.');
12946: } elsif (!$error) {
1.1065 raeburn 12947: my ($decompressed,$display);
1.1075.2.128 raeburn 12948: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 12949: my $tempdir = time.'_'.$$.int(rand(10000));
12950: mkdir("$dir/$tempdir",0755);
1.1075.2.128 raeburn 12951: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
12952: ($decompressed,$display) =
12953: &decompress_uploaded_file($file,"$dir/$tempdir");
12954: foreach my $item (@to_skip) {
12955: if (($item ne '') && ($item !~ /\.\./)) {
12956: if (-f "$dir/$tempdir/$item") {
12957: unlink("$dir/$tempdir/$item");
12958: } elsif (-d "$dir/$tempdir/$item") {
12959: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
12960: }
12961: }
12962: }
12963: foreach my $item (@to_overwrite) {
12964: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
12965: if (($item ne '') && ($item !~ /\.\./)) {
12966: if (-f "$dir/$item") {
12967: unlink("$dir/$item");
12968: } elsif (-d "$dir/$item") {
12969: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
12970: }
12971: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
12972: }
1.1065 raeburn 12973: }
12974: }
1.1075.2.128 raeburn 12975: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
12976: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
12977: }
1.1065 raeburn 12978: }
12979: } else {
12980: ($decompressed,$display) =
12981: &decompress_uploaded_file($file,$dir);
12982: }
1.1055 raeburn 12983: if ($decompressed eq 'ok') {
1.1065 raeburn 12984: $output = '<p class="LC_info">'.
12985: &mt('Files extracted successfully from archive.').
12986: '</p>'."\n";
1.1055 raeburn 12987: my ($warning,$result,@contents);
12988: my ($newdirlistref,$newlisterror) =
12989: &Apache::lonnet::dirlist($currdir,$docudom,
12990: $docuname,1);
12991: my (%is_dir,%changes,@newitems);
12992: my $dirptr = 16384;
1.1065 raeburn 12993: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 12994: foreach my $dir_line (@{$newdirlistref}) {
12995: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128 raeburn 12996: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 12997: push(@newitems,$item);
12998: if ($dirptr&$testdir) {
12999: $is_dir{$item} = 1;
13000: }
13001: $changes{$item} = 1;
13002: }
13003: }
13004: }
13005: if (keys(%changes) > 0) {
13006: foreach my $item (sort(@newitems)) {
13007: if ($changes{$item}) {
13008: push(@contents,$item);
13009: }
13010: }
13011: }
13012: if (@contents > 0) {
1.1067 raeburn 13013: my $wantform;
13014: unless ($env{'form.autoextract_camtasia'}) {
13015: $wantform = 1;
13016: }
1.1056 raeburn 13017: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 13018: my ($count,$datatable) = &get_extracted($docudom,$docuname,
13019: $currdir,\%is_dir,
13020: \%children,\%parent,
1.1056 raeburn 13021: \@contents,\%dirorder,
13022: \%titles,$wantform);
1.1055 raeburn 13023: if ($datatable ne '') {
13024: $output .= &archive_options_form('decompressed',$datatable,
13025: $count,$hiddenelem);
1.1065 raeburn 13026: my $startcount = 6;
1.1055 raeburn 13027: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 13028: \%titles,\%children);
1.1055 raeburn 13029: }
1.1067 raeburn 13030: if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59 raeburn 13031: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 13032: my %displayed;
13033: my $total = 1;
13034: $env{'form.archive_directory'} = [];
13035: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
13036: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
13037: $path =~ s{/$}{};
13038: my $item;
13039: if ($path ne '') {
13040: $item = "$path/$titles{$i}";
13041: } else {
13042: $item = $titles{$i};
13043: }
13044: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
13045: if ($item eq $contents[0]) {
13046: push(@{$env{'form.archive_directory'}},$i);
13047: $env{'form.archive_'.$i} = 'display';
13048: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
13049: $displayed{'folder'} = $i;
1.1075.2.59 raeburn 13050: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
13051: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 13052: $env{'form.archive_'.$i} = 'display';
13053: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
13054: $displayed{'web'} = $i;
13055: } else {
1.1075.2.59 raeburn 13056: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
13057: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
13058: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 13059: push(@{$env{'form.archive_directory'}},$i);
13060: }
13061: $env{'form.archive_'.$i} = 'dependency';
13062: }
13063: $total ++;
13064: }
13065: for (my $i=1; $i<$total; $i++) {
13066: next if ($i == $displayed{'web'});
13067: next if ($i == $displayed{'folder'});
13068: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
13069: }
13070: $env{'form.phase'} = 'decompress_cleanup';
13071: $env{'form.archivedelete'} = 1;
13072: $env{'form.archive_count'} = $total-1;
13073: $output .=
13074: &process_extracted_files('coursedocs',$docudom,
13075: $docuname,$destination,
13076: $dir_root,$hiddenelem);
13077: }
1.1055 raeburn 13078: } else {
13079: $warning = &mt('No new items extracted from archive file.');
13080: }
13081: } else {
13082: $output = $display;
13083: $error = &mt('An error occurred during extraction from the archive file.');
13084: }
13085: }
13086: }
13087: }
13088: if ($error) {
13089: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13090: $error.'</p>'."\n";
13091: }
13092: if ($warning) {
13093: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13094: }
13095: return $output;
13096: }
13097:
13098: sub get_extracted {
1.1056 raeburn 13099: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
13100: $titles,$wantform) = @_;
1.1055 raeburn 13101: my $count = 0;
13102: my $depth = 0;
13103: my $datatable;
1.1056 raeburn 13104: my @hierarchy;
1.1055 raeburn 13105: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 13106: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
13107: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 13108: foreach my $item (@{$contents}) {
13109: $count ++;
1.1056 raeburn 13110: @{$dirorder->{$count}} = @hierarchy;
13111: $titles->{$count} = $item;
1.1055 raeburn 13112: &archive_hierarchy($depth,$count,$parent,$children);
13113: if ($wantform) {
13114: $datatable .= &archive_row($is_dir->{$item},$item,
13115: $currdir,$depth,$count);
13116: }
13117: if ($is_dir->{$item}) {
13118: $depth ++;
1.1056 raeburn 13119: push(@hierarchy,$count);
13120: $parent->{$depth} = $count;
1.1055 raeburn 13121: $datatable .=
13122: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 13123: \$depth,\$count,\@hierarchy,$dirorder,
13124: $children,$parent,$titles,$wantform);
1.1055 raeburn 13125: $depth --;
1.1056 raeburn 13126: pop(@hierarchy);
1.1055 raeburn 13127: }
13128: }
13129: return ($count,$datatable);
13130: }
13131:
13132: sub recurse_extracted_archive {
1.1056 raeburn 13133: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
13134: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 13135: my $result='';
1.1056 raeburn 13136: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
13137: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
13138: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 13139: return $result;
13140: }
13141: my $dirptr = 16384;
13142: my ($newdirlistref,$newlisterror) =
13143: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
13144: if (ref($newdirlistref) eq 'ARRAY') {
13145: foreach my $dir_line (@{$newdirlistref}) {
13146: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
13147: unless ($item =~ /^\.+$/) {
13148: $$count ++;
1.1056 raeburn 13149: @{$dirorder->{$$count}} = @{$hierarchy};
13150: $titles->{$$count} = $item;
1.1055 raeburn 13151: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 13152:
1.1055 raeburn 13153: my $is_dir;
13154: if ($dirptr&$testdir) {
13155: $is_dir = 1;
13156: }
13157: if ($wantform) {
13158: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
13159: }
13160: if ($is_dir) {
13161: $$depth ++;
1.1056 raeburn 13162: push(@{$hierarchy},$$count);
13163: $parent->{$$depth} = $$count;
1.1055 raeburn 13164: $result .=
13165: &recurse_extracted_archive("$currdir/$item",$docudom,
13166: $docuname,$depth,$count,
1.1056 raeburn 13167: $hierarchy,$dirorder,$children,
13168: $parent,$titles,$wantform);
1.1055 raeburn 13169: $$depth --;
1.1056 raeburn 13170: pop(@{$hierarchy});
1.1055 raeburn 13171: }
13172: }
13173: }
13174: }
13175: return $result;
13176: }
13177:
13178: sub archive_hierarchy {
13179: my ($depth,$count,$parent,$children) =@_;
13180: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
13181: if (exists($parent->{$depth})) {
13182: $children->{$parent->{$depth}} .= $count.':';
13183: }
13184: }
13185: return;
13186: }
13187:
13188: sub archive_row {
13189: my ($is_dir,$item,$currdir,$depth,$count) = @_;
13190: my ($name) = ($item =~ m{([^/]+)$});
13191: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 13192: 'display' => 'Add as file',
1.1055 raeburn 13193: 'dependency' => 'Include as dependency',
13194: 'discard' => 'Discard',
13195: );
13196: if ($is_dir) {
1.1059 raeburn 13197: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 13198: }
1.1056 raeburn 13199: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
13200: my $offset = 0;
1.1055 raeburn 13201: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 13202: $offset ++;
1.1065 raeburn 13203: if ($action ne 'display') {
13204: $offset ++;
13205: }
1.1055 raeburn 13206: $output .= '<td><span class="LC_nobreak">'.
13207: '<label><input type="radio" name="archive_'.$count.
13208: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
13209: my $text = $choices{$action};
13210: if ($is_dir) {
13211: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
13212: if ($action eq 'display') {
1.1059 raeburn 13213: $text = &mt('Add as folder');
1.1055 raeburn 13214: }
1.1056 raeburn 13215: } else {
13216: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
13217:
13218: }
13219: $output .= ' /> '.$choices{$action}.'</label></span>';
13220: if ($action eq 'dependency') {
13221: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
13222: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
13223: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
13224: '<option value=""></option>'."\n".
13225: '</select>'."\n".
13226: '</div>';
1.1059 raeburn 13227: } elsif ($action eq 'display') {
13228: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
13229: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
13230: '</div>';
1.1055 raeburn 13231: }
1.1056 raeburn 13232: $output .= '</td>';
1.1055 raeburn 13233: }
13234: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
13235: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
13236: for (my $i=0; $i<$depth; $i++) {
13237: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
13238: }
13239: if ($is_dir) {
13240: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
13241: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
13242: } else {
13243: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
13244: }
13245: $output .= ' '.$name.'</td>'."\n".
13246: &end_data_table_row();
13247: return $output;
13248: }
13249:
13250: sub archive_options_form {
1.1065 raeburn 13251: my ($form,$display,$count,$hiddenelem) = @_;
13252: my %lt = &Apache::lonlocal::texthash(
13253: perm => 'Permanently remove archive file?',
13254: hows => 'How should each extracted item be incorporated in the course?',
13255: cont => 'Content actions for all',
13256: addf => 'Add as folder/file',
13257: incd => 'Include as dependency for a displayed file',
13258: disc => 'Discard',
13259: no => 'No',
13260: yes => 'Yes',
13261: save => 'Save',
13262: );
13263: my $output = <<"END";
13264: <form name="$form" method="post" action="">
13265: <p><span class="LC_nobreak">$lt{'perm'}
13266: <label>
13267: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
13268: </label>
13269:
13270: <label>
13271: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
13272: </span>
13273: </p>
13274: <input type="hidden" name="phase" value="decompress_cleanup" />
13275: <br />$lt{'hows'}
13276: <div class="LC_columnSection">
13277: <fieldset>
13278: <legend>$lt{'cont'}</legend>
13279: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
13280: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
13281: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
13282: </fieldset>
13283: </div>
13284: END
13285: return $output.
1.1055 raeburn 13286: &start_data_table()."\n".
1.1065 raeburn 13287: $display."\n".
1.1055 raeburn 13288: &end_data_table()."\n".
13289: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
13290: $hiddenelem.
1.1065 raeburn 13291: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 13292: '</form>';
13293: }
13294:
13295: sub archive_javascript {
1.1056 raeburn 13296: my ($startcount,$numitems,$titles,$children) = @_;
13297: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 13298: my $maintitle = $env{'form.comment'};
1.1055 raeburn 13299: my $scripttag = <<START;
13300: <script type="text/javascript">
13301: // <![CDATA[
13302:
13303: function checkAll(form,prefix) {
13304: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
13305: for (var i=0; i < form.elements.length; i++) {
13306: var id = form.elements[i].id;
13307: if ((id != '') && (id != undefined)) {
13308: if (idstr.test(id)) {
13309: if (form.elements[i].type == 'radio') {
13310: form.elements[i].checked = true;
1.1056 raeburn 13311: var nostart = i-$startcount;
1.1059 raeburn 13312: var offset = nostart%7;
13313: var count = (nostart-offset)/7;
1.1056 raeburn 13314: dependencyCheck(form,count,offset);
1.1055 raeburn 13315: }
13316: }
13317: }
13318: }
13319: }
13320:
13321: function propagateCheck(form,count) {
13322: if (count > 0) {
1.1059 raeburn 13323: var startelement = $startcount + ((count-1) * 7);
13324: for (var j=1; j<6; j++) {
13325: if ((j != 2) && (j != 4)) {
1.1056 raeburn 13326: var item = startelement + j;
13327: if (form.elements[item].type == 'radio') {
13328: if (form.elements[item].checked) {
13329: containerCheck(form,count,j);
13330: break;
13331: }
1.1055 raeburn 13332: }
13333: }
13334: }
13335: }
13336: }
13337:
13338: numitems = $numitems
1.1056 raeburn 13339: var titles = new Array(numitems);
13340: var parents = new Array(numitems);
1.1055 raeburn 13341: for (var i=0; i<numitems; i++) {
1.1056 raeburn 13342: parents[i] = new Array;
1.1055 raeburn 13343: }
1.1059 raeburn 13344: var maintitle = '$maintitle';
1.1055 raeburn 13345:
13346: START
13347:
1.1056 raeburn 13348: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
13349: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 13350: for (my $i=0; $i<@contents; $i ++) {
13351: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
13352: }
13353: }
13354:
1.1056 raeburn 13355: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
13356: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
13357: }
13358:
1.1055 raeburn 13359: $scripttag .= <<END;
13360:
13361: function containerCheck(form,count,offset) {
13362: if (count > 0) {
1.1056 raeburn 13363: dependencyCheck(form,count,offset);
1.1059 raeburn 13364: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 13365: form.elements[item].checked = true;
13366: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
13367: if (parents[count].length > 0) {
13368: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 13369: containerCheck(form,parents[count][j],offset);
13370: }
13371: }
13372: }
13373: }
13374: }
13375:
13376: function dependencyCheck(form,count,offset) {
13377: if (count > 0) {
1.1059 raeburn 13378: var chosen = (offset+$startcount)+7*(count-1);
13379: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 13380: var currtype = form.elements[depitem].type;
13381: if (form.elements[chosen].value == 'dependency') {
13382: document.getElementById('arc_depon_'+count).style.display='block';
13383: form.elements[depitem].options.length = 0;
13384: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11 raeburn 13385: for (var i=1; i<=numitems; i++) {
13386: if (i == count) {
13387: continue;
13388: }
1.1059 raeburn 13389: var startelement = $startcount + (i-1) * 7;
13390: for (var j=1; j<6; j++) {
13391: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 13392: var item = startelement + j;
13393: if (form.elements[item].type == 'radio') {
13394: if (form.elements[item].checked) {
13395: if (form.elements[item].value == 'display') {
13396: var n = form.elements[depitem].options.length;
13397: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
13398: }
13399: }
13400: }
13401: }
13402: }
13403: }
13404: } else {
13405: document.getElementById('arc_depon_'+count).style.display='none';
13406: form.elements[depitem].options.length = 0;
13407: form.elements[depitem].options[0] = new Option('Select','',true,true);
13408: }
1.1059 raeburn 13409: titleCheck(form,count,offset);
1.1056 raeburn 13410: }
13411: }
13412:
13413: function propagateSelect(form,count,offset) {
13414: if (count > 0) {
1.1065 raeburn 13415: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 13416: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
13417: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13418: if (parents[count].length > 0) {
13419: for (var j=0; j<parents[count].length; j++) {
13420: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 13421: }
13422: }
13423: }
13424: }
13425: }
1.1056 raeburn 13426:
13427: function containerSelect(form,count,offset,picked) {
13428: if (count > 0) {
1.1065 raeburn 13429: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 13430: if (form.elements[item].type == 'radio') {
13431: if (form.elements[item].value == 'dependency') {
13432: if (form.elements[item+1].type == 'select-one') {
13433: for (var i=0; i<form.elements[item+1].options.length; i++) {
13434: if (form.elements[item+1].options[i].value == picked) {
13435: form.elements[item+1].selectedIndex = i;
13436: break;
13437: }
13438: }
13439: }
13440: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13441: if (parents[count].length > 0) {
13442: for (var j=0; j<parents[count].length; j++) {
13443: containerSelect(form,parents[count][j],offset,picked);
13444: }
13445: }
13446: }
13447: }
13448: }
13449: }
13450: }
13451:
1.1059 raeburn 13452: function titleCheck(form,count,offset) {
13453: if (count > 0) {
13454: var chosen = (offset+$startcount)+7*(count-1);
13455: var depitem = $startcount + ((count-1) * 7) + 2;
13456: var currtype = form.elements[depitem].type;
13457: if (form.elements[chosen].value == 'display') {
13458: document.getElementById('arc_title_'+count).style.display='block';
13459: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
13460: document.getElementById('archive_title_'+count).value=maintitle;
13461: }
13462: } else {
13463: document.getElementById('arc_title_'+count).style.display='none';
13464: if (currtype == 'text') {
13465: document.getElementById('archive_title_'+count).value='';
13466: }
13467: }
13468: }
13469: return;
13470: }
13471:
1.1055 raeburn 13472: // ]]>
13473: </script>
13474: END
13475: return $scripttag;
13476: }
13477:
13478: sub process_extracted_files {
1.1067 raeburn 13479: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 13480: my $numitems = $env{'form.archive_count'};
1.1075.2.128 raeburn 13481: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 13482: my @ids=&Apache::lonnet::current_machine_ids();
13483: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 13484: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 13485: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13486: if (grep(/^\Q$docuhome\E$/,@ids)) {
13487: $prefix = &LONCAPA::propath($docudom,$docuname);
13488: $pathtocheck = "$dir_root/$destination";
13489: $dir = $dir_root;
13490: $ishome = 1;
13491: } else {
13492: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
13493: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128 raeburn 13494: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 13495: }
13496: my $currdir = "$dir_root/$destination";
13497: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
13498: if ($env{'form.folderpath'}) {
13499: my @items = split('&',$env{'form.folderpath'});
13500: $folders{'0'} = $items[-2];
1.1075.2.17 raeburn 13501: if ($env{'form.folderpath'} =~ /\:1$/) {
13502: $containers{'0'}='page';
13503: } else {
13504: $containers{'0'}='sequence';
13505: }
1.1055 raeburn 13506: }
13507: my @archdirs = &get_env_multiple('form.archive_directory');
13508: if ($numitems) {
13509: for (my $i=1; $i<=$numitems; $i++) {
13510: my $path = $env{'form.archive_content_'.$i};
13511: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
13512: my $item = $1;
13513: $toplevelitems{$item} = $i;
13514: if (grep(/^\Q$i\E$/,@archdirs)) {
13515: $is_dir{$item} = 1;
13516: }
13517: }
13518: }
13519: }
1.1067 raeburn 13520: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 13521: if (keys(%toplevelitems) > 0) {
13522: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 13523: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
13524: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 13525: }
1.1066 raeburn 13526: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 13527: if ($numitems) {
13528: for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11 raeburn 13529: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 13530: my $path = $env{'form.archive_content_'.$i};
13531: if ($path =~ /^\Q$pathtocheck\E/) {
13532: if ($env{'form.archive_'.$i} eq 'discard') {
13533: if ($prefix ne '' && $path ne '') {
13534: if (-e $prefix.$path) {
1.1066 raeburn 13535: if ((@archdirs > 0) &&
13536: (grep(/^\Q$i\E$/,@archdirs))) {
13537: $todeletedir{$prefix.$path} = 1;
13538: } else {
13539: $todelete{$prefix.$path} = 1;
13540: }
1.1055 raeburn 13541: }
13542: }
13543: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 13544: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 13545: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 13546: $docstitle = $env{'form.archive_title_'.$i};
13547: if ($docstitle eq '') {
13548: $docstitle = $title;
13549: }
1.1055 raeburn 13550: $outer = 0;
1.1056 raeburn 13551: if (ref($dirorder{$i}) eq 'ARRAY') {
13552: if (@{$dirorder{$i}} > 0) {
13553: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 13554: if ($env{'form.archive_'.$item} eq 'display') {
13555: $outer = $item;
13556: last;
13557: }
13558: }
13559: }
13560: }
13561: my ($errtext,$fatal) =
13562: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
13563: '/'.$folders{$outer}.'.'.
13564: $containers{$outer});
13565: next if ($fatal);
13566: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
13567: if ($context eq 'coursedocs') {
1.1056 raeburn 13568: $mapinner{$i} = time;
1.1055 raeburn 13569: $folders{$i} = 'default_'.$mapinner{$i};
13570: $containers{$i} = 'sequence';
13571: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13572: $folders{$i}.'.'.$containers{$i};
13573: my $newidx = &LONCAPA::map::getresidx();
13574: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 13575: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 13576: push(@LONCAPA::map::order,$newidx);
13577: my ($outtext,$errtext) =
13578: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13579: $docuname.'/'.$folders{$outer}.
1.1075.2.11 raeburn 13580: '.'.$containers{$outer},1,1);
1.1056 raeburn 13581: $newseqid{$i} = $newidx;
1.1067 raeburn 13582: unless ($errtext) {
1.1075.2.128 raeburn 13583: $result .= '<li>'.&mt('Folder: [_1] added to course',
13584: &HTML::Entities::encode($docstitle,'<>&"'))..
13585: '</li>'."\n";
1.1067 raeburn 13586: }
1.1055 raeburn 13587: }
13588: } else {
13589: if ($context eq 'coursedocs') {
13590: my $newidx=&LONCAPA::map::getresidx();
13591: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13592: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
13593: $title;
1.1075.2.128 raeburn 13594: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
13595: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
13596: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067 raeburn 13597: }
1.1075.2.128 raeburn 13598: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13599: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
13600: }
13601: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13602: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
13603: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
13604: unless ($ishome) {
13605: my $fetch = "$newdest{$i}/$title";
13606: $fetch =~ s/^\Q$prefix$dir\E//;
13607: $prompttofetch{$fetch} = 1;
13608: }
13609: }
13610: }
13611: $LONCAPA::map::resources[$newidx]=
13612: $docstitle.':'.$url.':false:normal:res';
13613: push(@LONCAPA::map::order, $newidx);
13614: my ($outtext,$errtext)=
13615: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13616: $docuname.'/'.$folders{$outer}.
13617: '.'.$containers{$outer},1,1);
13618: unless ($errtext) {
13619: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
13620: $result .= '<li>'.&mt('File: [_1] added to course',
13621: &HTML::Entities::encode($docstitle,'<>&"')).
13622: '</li>'."\n";
13623: }
1.1067 raeburn 13624: }
1.1075.2.128 raeburn 13625: } else {
13626: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13627: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067 raeburn 13628: }
1.1055 raeburn 13629: }
13630: }
1.1075.2.11 raeburn 13631: }
13632: } else {
1.1075.2.128 raeburn 13633: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13634: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11 raeburn 13635: }
13636: }
13637: for (my $i=1; $i<=$numitems; $i++) {
13638: next unless ($env{'form.archive_'.$i} eq 'dependency');
13639: my $path = $env{'form.archive_content_'.$i};
13640: if ($path =~ /^\Q$pathtocheck\E/) {
13641: my ($title) = ($path =~ m{/([^/]+)$});
13642: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
13643: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
13644: if (ref($dirorder{$i}) eq 'ARRAY') {
13645: my ($itemidx,$fullpath,$relpath);
13646: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
13647: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 13648: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11 raeburn 13649: if ($dirorder{$i}->[$j] eq $container) {
13650: $itemidx = $j;
1.1056 raeburn 13651: }
13652: }
1.1075.2.11 raeburn 13653: }
13654: if ($itemidx eq '') {
13655: $itemidx = 0;
13656: }
13657: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
13658: if ($mapinner{$referrer{$i}}) {
13659: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
13660: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13661: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13662: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13663: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13664: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13665: if (!-e $fullpath) {
13666: mkdir($fullpath,0755);
1.1056 raeburn 13667: }
13668: }
1.1075.2.11 raeburn 13669: } else {
13670: last;
1.1056 raeburn 13671: }
1.1075.2.11 raeburn 13672: }
13673: }
13674: } elsif ($newdest{$referrer{$i}}) {
13675: $fullpath = $newdest{$referrer{$i}};
13676: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13677: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
13678: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
13679: last;
13680: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13681: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13682: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13683: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13684: if (!-e $fullpath) {
13685: mkdir($fullpath,0755);
1.1056 raeburn 13686: }
13687: }
1.1075.2.11 raeburn 13688: } else {
13689: last;
1.1056 raeburn 13690: }
1.1075.2.11 raeburn 13691: }
13692: }
13693: if ($fullpath ne '') {
13694: if (-e "$prefix$path") {
1.1075.2.128 raeburn 13695: unless (rename("$prefix$path","$fullpath/$title")) {
13696: $warning .= &mt('Failed to rename dependency').'<br />';
13697: }
1.1075.2.11 raeburn 13698: }
13699: if (-e "$fullpath/$title") {
13700: my $showpath;
13701: if ($relpath ne '') {
13702: $showpath = "$relpath/$title";
13703: } else {
13704: $showpath = "/$title";
1.1056 raeburn 13705: }
1.1075.2.128 raeburn 13706: $result .= '<li>'.&mt('[_1] included as a dependency',
13707: &HTML::Entities::encode($showpath,'<>&"')).
13708: '</li>'."\n";
13709: unless ($ishome) {
13710: my $fetch = "$fullpath/$title";
13711: $fetch =~ s/^\Q$prefix$dir\E//;
13712: $prompttofetch{$fetch} = 1;
13713: }
1.1055 raeburn 13714: }
13715: }
13716: }
1.1075.2.11 raeburn 13717: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
13718: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128 raeburn 13719: &HTML::Entities::encode($path,'<>&"'),
13720: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
13721: '<br />';
1.1055 raeburn 13722: }
13723: } else {
1.1075.2.128 raeburn 13724: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13725: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 13726: }
13727: }
13728: if (keys(%todelete)) {
13729: foreach my $key (keys(%todelete)) {
13730: unlink($key);
1.1066 raeburn 13731: }
13732: }
13733: if (keys(%todeletedir)) {
13734: foreach my $key (keys(%todeletedir)) {
13735: rmdir($key);
13736: }
13737: }
13738: foreach my $dir (sort(keys(%is_dir))) {
13739: if (($pathtocheck ne '') && ($dir ne '')) {
13740: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 13741: }
13742: }
1.1067 raeburn 13743: if ($result ne '') {
13744: $output .= '<ul>'."\n".
13745: $result."\n".
13746: '</ul>';
13747: }
13748: unless ($ishome) {
13749: my $replicationfail;
13750: foreach my $item (keys(%prompttofetch)) {
13751: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
13752: unless ($fetchresult eq 'ok') {
13753: $replicationfail .= '<li>'.$item.'</li>'."\n";
13754: }
13755: }
13756: if ($replicationfail) {
13757: $output .= '<p class="LC_error">'.
13758: &mt('Course home server failed to retrieve:').'<ul>'.
13759: $replicationfail.
13760: '</ul></p>';
13761: }
13762: }
1.1055 raeburn 13763: } else {
13764: $warning = &mt('No items found in archive.');
13765: }
13766: if ($error) {
13767: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13768: $error.'</p>'."\n";
13769: }
13770: if ($warning) {
13771: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13772: }
13773: return $output;
13774: }
13775:
1.1066 raeburn 13776: sub cleanup_empty_dirs {
13777: my ($path) = @_;
13778: if (($path ne '') && (-d $path)) {
13779: if (opendir(my $dirh,$path)) {
13780: my @dircontents = grep(!/^\./,readdir($dirh));
13781: my $numitems = 0;
13782: foreach my $item (@dircontents) {
13783: if (-d "$path/$item") {
1.1075.2.28 raeburn 13784: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 13785: if (-e "$path/$item") {
13786: $numitems ++;
13787: }
13788: } else {
13789: $numitems ++;
13790: }
13791: }
13792: if ($numitems == 0) {
13793: rmdir($path);
13794: }
13795: closedir($dirh);
13796: }
13797: }
13798: return;
13799: }
13800:
1.41 ng 13801: =pod
1.45 matthew 13802:
1.1075.2.56 raeburn 13803: =item * &get_folder_hierarchy()
1.1068 raeburn 13804:
13805: Provides hierarchy of names of folders/sub-folders containing the current
13806: item,
13807:
13808: Inputs: 3
13809: - $navmap - navmaps object
13810:
13811: - $map - url for map (either the trigger itself, or map containing
13812: the resource, which is the trigger).
13813:
13814: - $showitem - 1 => show title for map itself; 0 => do not show.
13815:
13816: Outputs: 1 @pathitems - array of folder/subfolder names.
13817:
13818: =cut
13819:
13820: sub get_folder_hierarchy {
13821: my ($navmap,$map,$showitem) = @_;
13822: my @pathitems;
13823: if (ref($navmap)) {
13824: my $mapres = $navmap->getResourceByUrl($map);
13825: if (ref($mapres)) {
13826: my $pcslist = $mapres->map_hierarchy();
13827: if ($pcslist ne '') {
13828: my @pcs = split(/,/,$pcslist);
13829: foreach my $pc (@pcs) {
13830: if ($pc == 1) {
1.1075.2.38 raeburn 13831: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 13832: } else {
13833: my $res = $navmap->getByMapPc($pc);
13834: if (ref($res)) {
13835: my $title = $res->compTitle();
13836: $title =~ s/\W+/_/g;
13837: if ($title ne '') {
13838: push(@pathitems,$title);
13839: }
13840: }
13841: }
13842: }
13843: }
1.1071 raeburn 13844: if ($showitem) {
13845: if ($mapres->{ID} eq '0.0') {
1.1075.2.38 raeburn 13846: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 13847: } else {
13848: my $maptitle = $mapres->compTitle();
13849: $maptitle =~ s/\W+/_/g;
13850: if ($maptitle ne '') {
13851: push(@pathitems,$maptitle);
13852: }
1.1068 raeburn 13853: }
13854: }
13855: }
13856: }
13857: return @pathitems;
13858: }
13859:
13860: =pod
13861:
1.1015 raeburn 13862: =item * &get_turnedin_filepath()
13863:
13864: Determines path in a user's portfolio file for storage of files uploaded
13865: to a specific essayresponse or dropbox item.
13866:
13867: Inputs: 3 required + 1 optional.
13868: $symb is symb for resource, $uname and $udom are for current user (required).
13869: $caller is optional (can be "submission", if routine is called when storing
13870: an upoaded file when "Submit Answer" button was pressed).
13871:
13872: Returns array containing $path and $multiresp.
13873: $path is path in portfolio. $multiresp is 1 if this resource contains more
13874: than one file upload item. Callers of routine should append partid as a
13875: subdirectory to $path in cases where $multiresp is 1.
13876:
13877: Called by: homework/essayresponse.pm and homework/structuretags.pm
13878:
13879: =cut
13880:
13881: sub get_turnedin_filepath {
13882: my ($symb,$uname,$udom,$caller) = @_;
13883: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
13884: my $turnindir;
13885: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
13886: $turnindir = $userhash{'turnindir'};
13887: my ($path,$multiresp);
13888: if ($turnindir eq '') {
13889: if ($caller eq 'submission') {
13890: $turnindir = &mt('turned in');
13891: $turnindir =~ s/\W+/_/g;
13892: my %newhash = (
13893: 'turnindir' => $turnindir,
13894: );
13895: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
13896: }
13897: }
13898: if ($turnindir ne '') {
13899: $path = '/'.$turnindir.'/';
13900: my ($multipart,$turnin,@pathitems);
13901: my $navmap = Apache::lonnavmaps::navmap->new();
13902: if (defined($navmap)) {
13903: my $mapres = $navmap->getResourceByUrl($map);
13904: if (ref($mapres)) {
13905: my $pcslist = $mapres->map_hierarchy();
13906: if ($pcslist ne '') {
13907: foreach my $pc (split(/,/,$pcslist)) {
13908: my $res = $navmap->getByMapPc($pc);
13909: if (ref($res)) {
13910: my $title = $res->compTitle();
13911: $title =~ s/\W+/_/g;
13912: if ($title ne '') {
1.1075.2.48 raeburn 13913: if (($pc > 1) && (length($title) > 12)) {
13914: $title = substr($title,0,12);
13915: }
1.1015 raeburn 13916: push(@pathitems,$title);
13917: }
13918: }
13919: }
13920: }
13921: my $maptitle = $mapres->compTitle();
13922: $maptitle =~ s/\W+/_/g;
13923: if ($maptitle ne '') {
1.1075.2.48 raeburn 13924: if (length($maptitle) > 12) {
13925: $maptitle = substr($maptitle,0,12);
13926: }
1.1015 raeburn 13927: push(@pathitems,$maptitle);
13928: }
13929: unless ($env{'request.state'} eq 'construct') {
13930: my $res = $navmap->getBySymb($symb);
13931: if (ref($res)) {
13932: my $partlist = $res->parts();
13933: my $totaluploads = 0;
13934: if (ref($partlist) eq 'ARRAY') {
13935: foreach my $part (@{$partlist}) {
13936: my @types = $res->responseType($part);
13937: my @ids = $res->responseIds($part);
13938: for (my $i=0; $i < scalar(@ids); $i++) {
13939: if ($types[$i] eq 'essay') {
13940: my $partid = $part.'_'.$ids[$i];
13941: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
13942: $totaluploads ++;
13943: }
13944: }
13945: }
13946: }
13947: if ($totaluploads > 1) {
13948: $multiresp = 1;
13949: }
13950: }
13951: }
13952: }
13953: } else {
13954: return;
13955: }
13956: } else {
13957: return;
13958: }
13959: my $restitle=&Apache::lonnet::gettitle($symb);
13960: $restitle =~ s/\W+/_/g;
13961: if ($restitle eq '') {
13962: $restitle = ($resurl =~ m{/[^/]+$});
13963: if ($restitle eq '') {
13964: $restitle = time;
13965: }
13966: }
1.1075.2.48 raeburn 13967: if (length($restitle) > 12) {
13968: $restitle = substr($restitle,0,12);
13969: }
1.1015 raeburn 13970: push(@pathitems,$restitle);
13971: $path .= join('/',@pathitems);
13972: }
13973: return ($path,$multiresp);
13974: }
13975:
13976: =pod
13977:
1.464 albertel 13978: =back
1.41 ng 13979:
1.112 bowersj2 13980: =head1 CSV Upload/Handling functions
1.38 albertel 13981:
1.41 ng 13982: =over 4
13983:
1.648 raeburn 13984: =item * &upfile_store($r)
1.41 ng 13985:
13986: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 13987: needs $env{'form.upfile'}
1.41 ng 13988: returns $datatoken to be put into hidden field
13989:
13990: =cut
1.31 albertel 13991:
13992: sub upfile_store {
13993: my $r=shift;
1.258 albertel 13994: $env{'form.upfile'}=~s/\r/\n/gs;
13995: $env{'form.upfile'}=~s/\f/\n/gs;
13996: $env{'form.upfile'}=~s/\n+/\n/gs;
13997: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 13998:
1.1075.2.128 raeburn 13999: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
14000: '_enroll_'.$env{'request.course.id'}.'_'.
14001: time.'_'.$$);
14002: return if ($datatoken eq '');
14003:
1.31 albertel 14004: {
1.158 raeburn 14005: my $datafile = $r->dir_config('lonDaemons').
14006: '/tmp/'.$datatoken.'.tmp';
1.1075.2.128 raeburn 14007: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 14008: print $fh $env{'form.upfile'};
1.158 raeburn 14009: close($fh);
14010: }
1.31 albertel 14011: }
14012: return $datatoken;
14013: }
14014:
1.56 matthew 14015: =pod
14016:
1.1075.2.128 raeburn 14017: =item * &load_tmp_file($r,$datatoken)
1.41 ng 14018:
14019: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128 raeburn 14020: $datatoken is the name to assign to the temporary file.
1.258 albertel 14021: sets $env{'form.upfile'} to the contents of the file
1.41 ng 14022:
14023: =cut
1.31 albertel 14024:
14025: sub load_tmp_file {
1.1075.2.128 raeburn 14026: my ($r,$datatoken) = @_;
14027: return if ($datatoken eq '');
1.31 albertel 14028: my @studentdata=();
14029: {
1.158 raeburn 14030: my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128 raeburn 14031: '/tmp/'.$datatoken.'.tmp';
14032: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 14033: @studentdata=<$fh>;
14034: close($fh);
14035: }
1.31 albertel 14036: }
1.258 albertel 14037: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 14038: }
14039:
1.1075.2.128 raeburn 14040: sub valid_datatoken {
14041: my ($datatoken) = @_;
1.1075.2.131 raeburn 14042: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128 raeburn 14043: return $datatoken;
14044: }
14045: return;
14046: }
14047:
1.56 matthew 14048: =pod
14049:
1.648 raeburn 14050: =item * &upfile_record_sep()
1.41 ng 14051:
14052: Separate uploaded file into records
14053: returns array of records,
1.258 albertel 14054: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 14055:
14056: =cut
1.31 albertel 14057:
14058: sub upfile_record_sep {
1.258 albertel 14059: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 14060: } else {
1.248 albertel 14061: my @records;
1.258 albertel 14062: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 14063: if ($line=~/^\s*$/) { next; }
14064: push(@records,$line);
14065: }
14066: return @records;
1.31 albertel 14067: }
14068: }
14069:
1.56 matthew 14070: =pod
14071:
1.648 raeburn 14072: =item * &record_sep($record)
1.41 ng 14073:
1.258 albertel 14074: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 14075:
14076: =cut
14077:
1.263 www 14078: sub takeleft {
14079: my $index=shift;
14080: return substr('0000'.$index,-4,4);
14081: }
14082:
1.31 albertel 14083: sub record_sep {
14084: my $record=shift;
14085: my %components=();
1.258 albertel 14086: if ($env{'form.upfiletype'} eq 'xml') {
14087: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 14088: my $i=0;
1.356 albertel 14089: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 14090: $field=~s/^(\"|\')//;
14091: $field=~s/(\"|\')$//;
1.263 www 14092: $components{&takeleft($i)}=$field;
1.31 albertel 14093: $i++;
14094: }
1.258 albertel 14095: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 14096: my $i=0;
1.356 albertel 14097: foreach my $field (split(/\t/,$record)) {
1.31 albertel 14098: $field=~s/^(\"|\')//;
14099: $field=~s/(\"|\')$//;
1.263 www 14100: $components{&takeleft($i)}=$field;
1.31 albertel 14101: $i++;
14102: }
14103: } else {
1.561 www 14104: my $separator=',';
1.480 banghart 14105: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 14106: $separator=';';
1.480 banghart 14107: }
1.31 albertel 14108: my $i=0;
1.561 www 14109: # the character we are looking for to indicate the end of a quote or a record
14110: my $looking_for=$separator;
14111: # do not add the characters to the fields
14112: my $ignore=0;
14113: # we just encountered a separator (or the beginning of the record)
14114: my $just_found_separator=1;
14115: # store the field we are working on here
14116: my $field='';
14117: # work our way through all characters in record
14118: foreach my $character ($record=~/(.)/g) {
14119: if ($character eq $looking_for) {
14120: if ($character ne $separator) {
14121: # Found the end of a quote, again looking for separator
14122: $looking_for=$separator;
14123: $ignore=1;
14124: } else {
14125: # Found a separator, store away what we got
14126: $components{&takeleft($i)}=$field;
14127: $i++;
14128: $just_found_separator=1;
14129: $ignore=0;
14130: $field='';
14131: }
14132: next;
14133: }
14134: # single or double quotation marks after a separator indicate beginning of a quote
14135: # we are now looking for the end of the quote and need to ignore separators
14136: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
14137: $looking_for=$character;
14138: next;
14139: }
14140: # ignore would be true after we reached the end of a quote
14141: if ($ignore) { next; }
14142: if (($just_found_separator) && ($character=~/\s/)) { next; }
14143: $field.=$character;
14144: $just_found_separator=0;
1.31 albertel 14145: }
1.561 www 14146: # catch the very last entry, since we never encountered the separator
14147: $components{&takeleft($i)}=$field;
1.31 albertel 14148: }
14149: return %components;
14150: }
14151:
1.144 matthew 14152: ######################################################
14153: ######################################################
14154:
1.56 matthew 14155: =pod
14156:
1.648 raeburn 14157: =item * &upfile_select_html()
1.41 ng 14158:
1.144 matthew 14159: Return HTML code to select a file from the users machine and specify
14160: the file type.
1.41 ng 14161:
14162: =cut
14163:
1.144 matthew 14164: ######################################################
14165: ######################################################
1.31 albertel 14166: sub upfile_select_html {
1.144 matthew 14167: my %Types = (
14168: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 14169: semisv => &mt('Semicolon separated values'),
1.144 matthew 14170: space => &mt('Space separated'),
14171: tab => &mt('Tabulator separated'),
14172: # xml => &mt('HTML/XML'),
14173: );
14174: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 14175: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 14176: foreach my $type (sort(keys(%Types))) {
14177: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
14178: }
14179: $Str .= "</select>\n";
14180: return $Str;
1.31 albertel 14181: }
14182:
1.301 albertel 14183: sub get_samples {
14184: my ($records,$toget) = @_;
14185: my @samples=({});
14186: my $got=0;
14187: foreach my $rec (@$records) {
14188: my %temp = &record_sep($rec);
14189: if (! grep(/\S/, values(%temp))) { next; }
14190: if (%temp) {
14191: $samples[$got]=\%temp;
14192: $got++;
14193: if ($got == $toget) { last; }
14194: }
14195: }
14196: return \@samples;
14197: }
14198:
1.144 matthew 14199: ######################################################
14200: ######################################################
14201:
1.56 matthew 14202: =pod
14203:
1.648 raeburn 14204: =item * &csv_print_samples($r,$records)
1.41 ng 14205:
14206: Prints a table of sample values from each column uploaded $r is an
14207: Apache Request ref, $records is an arrayref from
14208: &Apache::loncommon::upfile_record_sep
14209:
14210: =cut
14211:
1.144 matthew 14212: ######################################################
14213: ######################################################
1.31 albertel 14214: sub csv_print_samples {
14215: my ($r,$records) = @_;
1.662 bisitz 14216: my $samples = &get_samples($records,5);
1.301 albertel 14217:
1.594 raeburn 14218: $r->print(&mt('Samples').'<br />'.&start_data_table().
14219: &start_data_table_header_row());
1.356 albertel 14220: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 14221: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 14222: $r->print(&end_data_table_header_row());
1.301 albertel 14223: foreach my $hash (@$samples) {
1.594 raeburn 14224: $r->print(&start_data_table_row());
1.356 albertel 14225: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 14226: $r->print('<td>');
1.356 albertel 14227: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 14228: $r->print('</td>');
14229: }
1.594 raeburn 14230: $r->print(&end_data_table_row());
1.31 albertel 14231: }
1.594 raeburn 14232: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 14233: }
14234:
1.144 matthew 14235: ######################################################
14236: ######################################################
14237:
1.56 matthew 14238: =pod
14239:
1.648 raeburn 14240: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 14241:
14242: Prints a table to create associations between values and table columns.
1.144 matthew 14243:
1.41 ng 14244: $r is an Apache Request ref,
14245: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 14246: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 14247:
14248: =cut
14249:
1.144 matthew 14250: ######################################################
14251: ######################################################
1.31 albertel 14252: sub csv_print_select_table {
14253: my ($r,$records,$d) = @_;
1.301 albertel 14254: my $i=0;
14255: my $samples = &get_samples($records,1);
1.144 matthew 14256: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 14257: &start_data_table().&start_data_table_header_row().
1.144 matthew 14258: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 14259: '<th>'.&mt('Column').'</th>'.
14260: &end_data_table_header_row()."\n");
1.356 albertel 14261: foreach my $array_ref (@$d) {
14262: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 14263: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 14264:
1.875 bisitz 14265: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 14266: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 14267: $r->print('<option value="none"></option>');
1.356 albertel 14268: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
14269: $r->print('<option value="'.$sample.'"'.
14270: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 14271: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 14272: }
1.594 raeburn 14273: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 14274: $i++;
14275: }
1.594 raeburn 14276: $r->print(&end_data_table());
1.31 albertel 14277: $i--;
14278: return $i;
14279: }
1.56 matthew 14280:
1.144 matthew 14281: ######################################################
14282: ######################################################
14283:
1.56 matthew 14284: =pod
1.31 albertel 14285:
1.648 raeburn 14286: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 14287:
14288: Prints a table of sample values from the upload and can make associate samples to internal names.
14289:
14290: $r is an Apache Request ref,
14291: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
14292: $d is an array of 2 element arrays (internal name, displayed name)
14293:
14294: =cut
14295:
1.144 matthew 14296: ######################################################
14297: ######################################################
1.31 albertel 14298: sub csv_samples_select_table {
14299: my ($r,$records,$d) = @_;
14300: my $i=0;
1.144 matthew 14301: #
1.662 bisitz 14302: my $max_samples = 5;
14303: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 14304: $r->print(&start_data_table().
14305: &start_data_table_header_row().'<th>'.
14306: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
14307: &end_data_table_header_row());
1.301 albertel 14308:
14309: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 14310: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 14311: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 14312: foreach my $option (@$d) {
14313: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 14314: $r->print('<option value="'.$value.'"'.
1.253 albertel 14315: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 14316: $display.'</option>');
1.31 albertel 14317: }
14318: $r->print('</select></td><td>');
1.662 bisitz 14319: foreach my $line (0..($max_samples-1)) {
1.301 albertel 14320: if (defined($samples->[$line]{$key})) {
14321: $r->print($samples->[$line]{$key}."<br />\n");
14322: }
14323: }
1.594 raeburn 14324: $r->print('</td>'.&end_data_table_row());
1.31 albertel 14325: $i++;
14326: }
1.594 raeburn 14327: $r->print(&end_data_table());
1.31 albertel 14328: $i--;
14329: return($i);
1.115 matthew 14330: }
14331:
1.144 matthew 14332: ######################################################
14333: ######################################################
14334:
1.115 matthew 14335: =pod
14336:
1.648 raeburn 14337: =item * &clean_excel_name($name)
1.115 matthew 14338:
14339: Returns a replacement for $name which does not contain any illegal characters.
14340:
14341: =cut
14342:
1.144 matthew 14343: ######################################################
14344: ######################################################
1.115 matthew 14345: sub clean_excel_name {
14346: my ($name) = @_;
14347: $name =~ s/[:\*\?\/\\]//g;
14348: if (length($name) > 31) {
14349: $name = substr($name,0,31);
14350: }
14351: return $name;
1.25 albertel 14352: }
1.84 albertel 14353:
1.85 albertel 14354: =pod
14355:
1.648 raeburn 14356: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 14357:
14358: Returns either 1 or undef
14359:
14360: 1 if the part is to be hidden, undef if it is to be shown
14361:
14362: Arguments are:
14363:
14364: $id the id of the part to be checked
14365: $symb, optional the symb of the resource to check
14366: $udom, optional the domain of the user to check for
14367: $uname, optional the username of the user to check for
14368:
14369: =cut
1.84 albertel 14370:
14371: sub check_if_partid_hidden {
14372: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 14373: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 14374: $symb,$udom,$uname);
1.141 albertel 14375: my $truth=1;
14376: #if the string starts with !, then the list is the list to show not hide
14377: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 14378: my @hiddenlist=split(/,/,$hiddenparts);
14379: foreach my $checkid (@hiddenlist) {
1.141 albertel 14380: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 14381: }
1.141 albertel 14382: return !$truth;
1.84 albertel 14383: }
1.127 matthew 14384:
1.138 matthew 14385:
14386: ############################################################
14387: ############################################################
14388:
14389: =pod
14390:
1.157 matthew 14391: =back
14392:
1.138 matthew 14393: =head1 cgi-bin script and graphing routines
14394:
1.157 matthew 14395: =over 4
14396:
1.648 raeburn 14397: =item * &get_cgi_id()
1.138 matthew 14398:
14399: Inputs: none
14400:
14401: Returns an id which can be used to pass environment variables
14402: to various cgi-bin scripts. These environment variables will
14403: be removed from the users environment after a given time by
14404: the routine &Apache::lonnet::transfer_profile_to_env.
14405:
14406: =cut
14407:
14408: ############################################################
14409: ############################################################
1.152 albertel 14410: my $uniq=0;
1.136 matthew 14411: sub get_cgi_id {
1.154 albertel 14412: $uniq=($uniq+1)%100000;
1.280 albertel 14413: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 14414: }
14415:
1.127 matthew 14416: ############################################################
14417: ############################################################
14418:
14419: =pod
14420:
1.648 raeburn 14421: =item * &DrawBarGraph()
1.127 matthew 14422:
1.138 matthew 14423: Facilitates the plotting of data in a (stacked) bar graph.
14424: Puts plot definition data into the users environment in order for
14425: graph.png to plot it. Returns an <img> tag for the plot.
14426: The bars on the plot are labeled '1','2',...,'n'.
14427:
14428: Inputs:
14429:
14430: =over 4
14431:
14432: =item $Title: string, the title of the plot
14433:
14434: =item $xlabel: string, text describing the X-axis of the plot
14435:
14436: =item $ylabel: string, text describing the Y-axis of the plot
14437:
14438: =item $Max: scalar, the maximum Y value to use in the plot
14439: If $Max is < any data point, the graph will not be rendered.
14440:
1.140 matthew 14441: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 14442: they are plotted. If undefined, default values will be used.
14443:
1.178 matthew 14444: =item $labels: array ref holding the labels to use on the x-axis for the bars.
14445:
1.138 matthew 14446: =item @Values: An array of array references. Each array reference holds data
14447: to be plotted in a stacked bar chart.
14448:
1.239 matthew 14449: =item If the final element of @Values is a hash reference the key/value
14450: pairs will be added to the graph definition.
14451:
1.138 matthew 14452: =back
14453:
14454: Returns:
14455:
14456: An <img> tag which references graph.png and the appropriate identifying
14457: information for the plot.
14458:
1.127 matthew 14459: =cut
14460:
14461: ############################################################
14462: ############################################################
1.134 matthew 14463: sub DrawBarGraph {
1.178 matthew 14464: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 14465: #
14466: if (! defined($colors)) {
14467: $colors = ['#33ff00',
14468: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
14469: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
14470: ];
14471: }
1.228 matthew 14472: my $extra_settings = {};
14473: if (ref($Values[-1]) eq 'HASH') {
14474: $extra_settings = pop(@Values);
14475: }
1.127 matthew 14476: #
1.136 matthew 14477: my $identifier = &get_cgi_id();
14478: my $id = 'cgi.'.$identifier;
1.129 matthew 14479: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 14480: return '';
14481: }
1.225 matthew 14482: #
14483: my @Labels;
14484: if (defined($labels)) {
14485: @Labels = @$labels;
14486: } else {
14487: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119 raeburn 14488: push(@Labels,$i+1);
1.225 matthew 14489: }
14490: }
14491: #
1.129 matthew 14492: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 14493: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 14494: my %ValuesHash;
14495: my $NumSets=1;
14496: foreach my $array (@Values) {
14497: next if (! ref($array));
1.136 matthew 14498: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 14499: join(',',@$array);
1.129 matthew 14500: }
1.127 matthew 14501: #
1.136 matthew 14502: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 14503: if ($NumBars < 3) {
14504: $width = 120+$NumBars*32;
1.220 matthew 14505: $xskip = 1;
1.225 matthew 14506: $bar_width = 30;
14507: } elsif ($NumBars < 5) {
14508: $width = 120+$NumBars*20;
14509: $xskip = 1;
14510: $bar_width = 20;
1.220 matthew 14511: } elsif ($NumBars < 10) {
1.136 matthew 14512: $width = 120+$NumBars*15;
14513: $xskip = 1;
14514: $bar_width = 15;
14515: } elsif ($NumBars <= 25) {
14516: $width = 120+$NumBars*11;
14517: $xskip = 5;
14518: $bar_width = 8;
14519: } elsif ($NumBars <= 50) {
14520: $width = 120+$NumBars*8;
14521: $xskip = 5;
14522: $bar_width = 4;
14523: } else {
14524: $width = 120+$NumBars*8;
14525: $xskip = 5;
14526: $bar_width = 4;
14527: }
14528: #
1.137 matthew 14529: $Max = 1 if ($Max < 1);
14530: if ( int($Max) < $Max ) {
14531: $Max++;
14532: $Max = int($Max);
14533: }
1.127 matthew 14534: $Title = '' if (! defined($Title));
14535: $xlabel = '' if (! defined($xlabel));
14536: $ylabel = '' if (! defined($ylabel));
1.369 www 14537: $ValuesHash{$id.'.title'} = &escape($Title);
14538: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
14539: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 14540: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 14541: $ValuesHash{$id.'.NumBars'} = $NumBars;
14542: $ValuesHash{$id.'.NumSets'} = $NumSets;
14543: $ValuesHash{$id.'.PlotType'} = 'bar';
14544: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14545: $ValuesHash{$id.'.height'} = $height;
14546: $ValuesHash{$id.'.width'} = $width;
14547: $ValuesHash{$id.'.xskip'} = $xskip;
14548: $ValuesHash{$id.'.bar_width'} = $bar_width;
14549: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 14550: #
1.228 matthew 14551: # Deal with other parameters
14552: while (my ($key,$value) = each(%$extra_settings)) {
14553: $ValuesHash{$id.'.'.$key} = $value;
14554: }
14555: #
1.646 raeburn 14556: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 14557: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14558: }
14559:
14560: ############################################################
14561: ############################################################
14562:
14563: =pod
14564:
1.648 raeburn 14565: =item * &DrawXYGraph()
1.137 matthew 14566:
1.138 matthew 14567: Facilitates the plotting of data in an XY graph.
14568: Puts plot definition data into the users environment in order for
14569: graph.png to plot it. Returns an <img> tag for the plot.
14570:
14571: Inputs:
14572:
14573: =over 4
14574:
14575: =item $Title: string, the title of the plot
14576:
14577: =item $xlabel: string, text describing the X-axis of the plot
14578:
14579: =item $ylabel: string, text describing the Y-axis of the plot
14580:
14581: =item $Max: scalar, the maximum Y value to use in the plot
14582: If $Max is < any data point, the graph will not be rendered.
14583:
14584: =item $colors: Array ref containing the hex color codes for the data to be
14585: plotted in. If undefined, default values will be used.
14586:
14587: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14588:
14589: =item $Ydata: Array ref containing Array refs.
1.185 www 14590: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 14591:
14592: =item %Values: hash indicating or overriding any default values which are
14593: passed to graph.png.
14594: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14595:
14596: =back
14597:
14598: Returns:
14599:
14600: An <img> tag which references graph.png and the appropriate identifying
14601: information for the plot.
14602:
1.137 matthew 14603: =cut
14604:
14605: ############################################################
14606: ############################################################
14607: sub DrawXYGraph {
14608: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
14609: #
14610: # Create the identifier for the graph
14611: my $identifier = &get_cgi_id();
14612: my $id = 'cgi.'.$identifier;
14613: #
14614: $Title = '' if (! defined($Title));
14615: $xlabel = '' if (! defined($xlabel));
14616: $ylabel = '' if (! defined($ylabel));
14617: my %ValuesHash =
14618: (
1.369 www 14619: $id.'.title' => &escape($Title),
14620: $id.'.xlabel' => &escape($xlabel),
14621: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 14622: $id.'.y_max_value'=> $Max,
14623: $id.'.labels' => join(',',@$Xlabels),
14624: $id.'.PlotType' => 'XY',
14625: );
14626: #
14627: if (defined($colors) && ref($colors) eq 'ARRAY') {
14628: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14629: }
14630: #
14631: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
14632: return '';
14633: }
14634: my $NumSets=1;
1.138 matthew 14635: foreach my $array (@{$Ydata}){
1.137 matthew 14636: next if (! ref($array));
14637: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
14638: }
1.138 matthew 14639: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 14640: #
14641: # Deal with other parameters
14642: while (my ($key,$value) = each(%Values)) {
14643: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 14644: }
14645: #
1.646 raeburn 14646: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 14647: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14648: }
14649:
14650: ############################################################
14651: ############################################################
14652:
14653: =pod
14654:
1.648 raeburn 14655: =item * &DrawXYYGraph()
1.138 matthew 14656:
14657: Facilitates the plotting of data in an XY graph with two Y axes.
14658: Puts plot definition data into the users environment in order for
14659: graph.png to plot it. Returns an <img> tag for the plot.
14660:
14661: Inputs:
14662:
14663: =over 4
14664:
14665: =item $Title: string, the title of the plot
14666:
14667: =item $xlabel: string, text describing the X-axis of the plot
14668:
14669: =item $ylabel: string, text describing the Y-axis of the plot
14670:
14671: =item $colors: Array ref containing the hex color codes for the data to be
14672: plotted in. If undefined, default values will be used.
14673:
14674: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14675:
14676: =item $Ydata1: The first data set
14677:
14678: =item $Min1: The minimum value of the left Y-axis
14679:
14680: =item $Max1: The maximum value of the left Y-axis
14681:
14682: =item $Ydata2: The second data set
14683:
14684: =item $Min2: The minimum value of the right Y-axis
14685:
14686: =item $Max2: The maximum value of the left Y-axis
14687:
14688: =item %Values: hash indicating or overriding any default values which are
14689: passed to graph.png.
14690: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14691:
14692: =back
14693:
14694: Returns:
14695:
14696: An <img> tag which references graph.png and the appropriate identifying
14697: information for the plot.
1.136 matthew 14698:
14699: =cut
14700:
14701: ############################################################
14702: ############################################################
1.137 matthew 14703: sub DrawXYYGraph {
14704: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
14705: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 14706: #
14707: # Create the identifier for the graph
14708: my $identifier = &get_cgi_id();
14709: my $id = 'cgi.'.$identifier;
14710: #
14711: $Title = '' if (! defined($Title));
14712: $xlabel = '' if (! defined($xlabel));
14713: $ylabel = '' if (! defined($ylabel));
14714: my %ValuesHash =
14715: (
1.369 www 14716: $id.'.title' => &escape($Title),
14717: $id.'.xlabel' => &escape($xlabel),
14718: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 14719: $id.'.labels' => join(',',@$Xlabels),
14720: $id.'.PlotType' => 'XY',
14721: $id.'.NumSets' => 2,
1.137 matthew 14722: $id.'.two_axes' => 1,
14723: $id.'.y1_max_value' => $Max1,
14724: $id.'.y1_min_value' => $Min1,
14725: $id.'.y2_max_value' => $Max2,
14726: $id.'.y2_min_value' => $Min2,
1.136 matthew 14727: );
14728: #
1.137 matthew 14729: if (defined($colors) && ref($colors) eq 'ARRAY') {
14730: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14731: }
14732: #
14733: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
14734: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 14735: return '';
14736: }
14737: my $NumSets=1;
1.137 matthew 14738: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 14739: next if (! ref($array));
14740: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 14741: }
14742: #
14743: # Deal with other parameters
14744: while (my ($key,$value) = each(%Values)) {
14745: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 14746: }
14747: #
1.646 raeburn 14748: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 14749: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 14750: }
14751:
14752: ############################################################
14753: ############################################################
14754:
14755: =pod
14756:
1.157 matthew 14757: =back
14758:
1.139 matthew 14759: =head1 Statistics helper routines?
14760:
14761: Bad place for them but what the hell.
14762:
1.157 matthew 14763: =over 4
14764:
1.648 raeburn 14765: =item * &chartlink()
1.139 matthew 14766:
14767: Returns a link to the chart for a specific student.
14768:
14769: Inputs:
14770:
14771: =over 4
14772:
14773: =item $linktext: The text of the link
14774:
14775: =item $sname: The students username
14776:
14777: =item $sdomain: The students domain
14778:
14779: =back
14780:
1.157 matthew 14781: =back
14782:
1.139 matthew 14783: =cut
14784:
14785: ############################################################
14786: ############################################################
14787: sub chartlink {
14788: my ($linktext, $sname, $sdomain) = @_;
14789: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 14790: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 14791: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 14792: '">'.$linktext.'</a>';
1.153 matthew 14793: }
14794:
14795: #######################################################
14796: #######################################################
14797:
14798: =pod
14799:
14800: =head1 Course Environment Routines
1.157 matthew 14801:
14802: =over 4
1.153 matthew 14803:
1.648 raeburn 14804: =item * &restore_course_settings()
1.153 matthew 14805:
1.648 raeburn 14806: =item * &store_course_settings()
1.153 matthew 14807:
14808: Restores/Store indicated form parameters from the course environment.
14809: Will not overwrite existing values of the form parameters.
14810:
14811: Inputs:
14812: a scalar describing the data (e.g. 'chart', 'problem_analysis')
14813:
14814: a hash ref describing the data to be stored. For example:
14815:
14816: %Save_Parameters = ('Status' => 'scalar',
14817: 'chartoutputmode' => 'scalar',
14818: 'chartoutputdata' => 'scalar',
14819: 'Section' => 'array',
1.373 raeburn 14820: 'Group' => 'array',
1.153 matthew 14821: 'StudentData' => 'array',
14822: 'Maps' => 'array');
14823:
14824: Returns: both routines return nothing
14825:
1.631 raeburn 14826: =back
14827:
1.153 matthew 14828: =cut
14829:
14830: #######################################################
14831: #######################################################
14832: sub store_course_settings {
1.496 albertel 14833: return &store_settings($env{'request.course.id'},@_);
14834: }
14835:
14836: sub store_settings {
1.153 matthew 14837: # save to the environment
14838: # appenv the same items, just to be safe
1.300 albertel 14839: my $udom = $env{'user.domain'};
14840: my $uname = $env{'user.name'};
1.496 albertel 14841: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14842: my %SaveHash;
14843: my %AppHash;
14844: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 14845: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 14846: my $envname = 'environment.'.$basename;
1.258 albertel 14847: if (exists($env{'form.'.$setting})) {
1.153 matthew 14848: # Save this value away
14849: if ($type eq 'scalar' &&
1.258 albertel 14850: (! exists($env{$envname}) ||
14851: $env{$envname} ne $env{'form.'.$setting})) {
14852: $SaveHash{$basename} = $env{'form.'.$setting};
14853: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 14854: } elsif ($type eq 'array') {
14855: my $stored_form;
1.258 albertel 14856: if (ref($env{'form.'.$setting})) {
1.153 matthew 14857: $stored_form = join(',',
14858: map {
1.369 www 14859: &escape($_);
1.258 albertel 14860: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 14861: } else {
14862: $stored_form =
1.369 www 14863: &escape($env{'form.'.$setting});
1.153 matthew 14864: }
14865: # Determine if the array contents are the same.
1.258 albertel 14866: if ($stored_form ne $env{$envname}) {
1.153 matthew 14867: $SaveHash{$basename} = $stored_form;
14868: $AppHash{$envname} = $stored_form;
14869: }
14870: }
14871: }
14872: }
14873: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 14874: $udom,$uname);
1.153 matthew 14875: if ($put_result !~ /^(ok|delayed)/) {
14876: &Apache::lonnet::logthis('unable to save form parameters, '.
14877: 'got error:'.$put_result);
14878: }
14879: # Make sure these settings stick around in this session, too
1.646 raeburn 14880: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 14881: return;
14882: }
14883:
14884: sub restore_course_settings {
1.499 albertel 14885: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 14886: }
14887:
14888: sub restore_settings {
14889: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14890: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 14891: next if (exists($env{'form.'.$setting}));
1.496 albertel 14892: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 14893: '.'.$setting;
1.258 albertel 14894: if (exists($env{$envname})) {
1.153 matthew 14895: if ($type eq 'scalar') {
1.258 albertel 14896: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 14897: } elsif ($type eq 'array') {
1.258 albertel 14898: $env{'form.'.$setting} = [
1.153 matthew 14899: map {
1.369 www 14900: &unescape($_);
1.258 albertel 14901: } split(',',$env{$envname})
1.153 matthew 14902: ];
14903: }
14904: }
14905: }
1.127 matthew 14906: }
14907:
1.618 raeburn 14908: #######################################################
14909: #######################################################
14910:
14911: =pod
14912:
14913: =head1 Domain E-mail Routines
14914:
14915: =over 4
14916:
1.648 raeburn 14917: =item * &build_recipient_list()
1.618 raeburn 14918:
1.1075.2.44 raeburn 14919: Build recipient lists for following types of e-mail:
1.766 raeburn 14920: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44 raeburn 14921: (d) Help requests, (e) Course requests needing approval, (f) loncapa
14922: module change checking, student/employee ID conflict checks, as
14923: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
14924: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 14925:
14926: Inputs:
1.1075.2.44 raeburn 14927: defmail (scalar - email address of default recipient),
14928: mailing type (scalar: errormail, packagesmail, helpdeskmail,
14929: requestsmail, updatesmail, or idconflictsmail).
14930:
1.619 raeburn 14931: defdom (domain for which to retrieve configuration settings),
1.1075.2.44 raeburn 14932:
14933: origmail (scalar - email address of recipient from loncapa.conf,
14934: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 14935:
1.1075.2.139 raeburn 14936: $requname username of requester (if mailing type is helpdeskmail)
14937:
14938: $requdom domain of requester (if mailing type is helpdeskmail)
14939:
14940: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
14941:
1.655 raeburn 14942: Returns: comma separated list of addresses to which to send e-mail.
14943:
14944: =back
1.618 raeburn 14945:
14946: =cut
14947:
14948: ############################################################
14949: ############################################################
14950: sub build_recipient_list {
1.1075.2.139 raeburn 14951: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 14952: my @recipients;
1.1075.2.122 raeburn 14953: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 14954: my %domconfig =
1.1075.2.122 raeburn 14955: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 14956: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 14957: if (exists($domconfig{'contacts'}{$mailing})) {
14958: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
14959: my @contacts = ('adminemail','supportemail');
14960: foreach my $item (@contacts) {
14961: if ($domconfig{'contacts'}{$mailing}{$item}) {
14962: my $addr = $domconfig{'contacts'}{$item};
14963: if (!grep(/^\Q$addr\E$/,@recipients)) {
14964: push(@recipients,$addr);
14965: }
1.619 raeburn 14966: }
1.1075.2.122 raeburn 14967: }
14968: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
14969: if ($mailing eq 'helpdeskmail') {
14970: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
14971: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
14972: my @ok_bccs;
14973: foreach my $bcc (@bccs) {
14974: $bcc =~ s/^\s+//g;
14975: $bcc =~ s/\s+$//g;
14976: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14977: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14978: push(@ok_bccs,$bcc);
14979: }
14980: }
14981: }
14982: if (@ok_bccs > 0) {
14983: $allbcc = join(', ',@ok_bccs);
14984: }
14985: }
14986: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 14987: }
14988: }
1.766 raeburn 14989: } elsif ($origmail ne '') {
1.1075.2.122 raeburn 14990: $lastresort = $origmail;
1.618 raeburn 14991: }
1.1075.2.139 raeburn 14992: if ($mailing eq 'helpdeskmail') {
14993: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
14994: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
14995: my ($inststatus,$inststatus_checked);
14996: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
14997: ($env{'user.domain'} ne 'public')) {
14998: $inststatus_checked = 1;
14999: $inststatus = $env{'environment.inststatus'};
15000: }
15001: unless ($inststatus_checked) {
15002: if (($requname ne '') && ($requdom ne '')) {
15003: if (($requname =~ /^$match_username$/) &&
15004: ($requdom =~ /^$match_domain$/) &&
15005: (&Apache::lonnet::domain($requdom))) {
15006: my $requhome = &Apache::lonnet::homeserver($requname,
15007: $requdom);
15008: unless ($requhome eq 'no_host') {
15009: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
15010: $inststatus = $userenv{'inststatus'};
15011: $inststatus_checked = 1;
15012: }
15013: }
15014: }
15015: }
15016: unless ($inststatus_checked) {
15017: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
15018: my %srch = (srchby => 'email',
15019: srchdomain => $defdom,
15020: srchterm => $reqemail,
15021: srchtype => 'exact');
15022: my %srch_results = &Apache::lonnet::usersearch(\%srch);
15023: foreach my $uname (keys(%srch_results)) {
15024: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15025: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15026: $inststatus_checked = 1;
15027: last;
15028: }
15029: }
15030: unless ($inststatus_checked) {
15031: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
15032: if ($dirsrchres eq 'ok') {
15033: foreach my $uname (keys(%srch_results)) {
15034: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15035: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15036: $inststatus_checked = 1;
15037: last;
15038: }
15039: }
15040: }
15041: }
15042: }
15043: }
15044: if ($inststatus ne '') {
15045: foreach my $status (split(/\:/,$inststatus)) {
15046: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
15047: my @contacts = ('adminemail','supportemail');
15048: foreach my $item (@contacts) {
15049: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
15050: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
15051: if (!grep(/^\Q$addr\E$/,@recipients)) {
15052: push(@recipients,$addr);
15053: }
15054: }
15055: }
15056: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
15057: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
15058: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
15059: my @ok_bccs;
15060: foreach my $bcc (@bccs) {
15061: $bcc =~ s/^\s+//g;
15062: $bcc =~ s/\s+$//g;
15063: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15064: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15065: push(@ok_bccs,$bcc);
15066: }
15067: }
15068: }
15069: if (@ok_bccs > 0) {
15070: $allbcc = join(', ',@ok_bccs);
15071: }
15072: }
15073: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
15074: last;
15075: }
15076: }
15077: }
15078: }
15079: }
1.619 raeburn 15080: } elsif ($origmail ne '') {
1.1075.2.122 raeburn 15081: $lastresort = $origmail;
15082: }
1.1075.2.128 raeburn 15083: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122 raeburn 15084: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
15085: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
15086: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
15087: my %what = (
15088: perlvar => 1,
15089: );
15090: my $primary = &Apache::lonnet::domain($defdom,'primary');
15091: if ($primary) {
15092: my $gotaddr;
15093: my ($result,$returnhash) =
15094: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
15095: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
15096: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
15097: $lastresort = $returnhash->{'lonSupportEMail'};
15098: $gotaddr = 1;
15099: }
15100: }
15101: unless ($gotaddr) {
15102: my $uintdom = &Apache::lonnet::internet_dom($primary);
15103: my $intdom = &Apache::lonnet::internet_dom($lonhost);
15104: unless ($uintdom eq $intdom) {
15105: my %domconfig =
15106: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
15107: if (ref($domconfig{'contacts'}) eq 'HASH') {
15108: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
15109: my @contacts = ('adminemail','supportemail');
15110: foreach my $item (@contacts) {
15111: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
15112: my $addr = $domconfig{'contacts'}{$item};
15113: if (!grep(/^\Q$addr\E$/,@recipients)) {
15114: push(@recipients,$addr);
15115: }
15116: }
15117: }
15118: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
15119: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
15120: }
15121: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
15122: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
15123: my @ok_bccs;
15124: foreach my $bcc (@bccs) {
15125: $bcc =~ s/^\s+//g;
15126: $bcc =~ s/\s+$//g;
15127: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15128: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15129: push(@ok_bccs,$bcc);
15130: }
15131: }
15132: }
15133: if (@ok_bccs > 0) {
15134: $allbcc = join(', ',@ok_bccs);
15135: }
15136: }
15137: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
15138: }
15139: }
15140: }
15141: }
15142: }
15143: }
1.618 raeburn 15144: }
1.688 raeburn 15145: if (defined($defmail)) {
15146: if ($defmail ne '') {
15147: push(@recipients,$defmail);
15148: }
1.618 raeburn 15149: }
15150: if ($otheremails) {
1.619 raeburn 15151: my @others;
15152: if ($otheremails =~ /,/) {
15153: @others = split(/,/,$otheremails);
1.618 raeburn 15154: } else {
1.619 raeburn 15155: push(@others,$otheremails);
15156: }
15157: foreach my $addr (@others) {
15158: if (!grep(/^\Q$addr\E$/,@recipients)) {
15159: push(@recipients,$addr);
15160: }
1.618 raeburn 15161: }
15162: }
1.1075.2.128 raeburn 15163: if ($mailing eq 'helpdeskmail') {
1.1075.2.122 raeburn 15164: if ((!@recipients) && ($lastresort ne '')) {
15165: push(@recipients,$lastresort);
15166: }
15167: } elsif ($lastresort ne '') {
15168: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
15169: push(@recipients,$lastresort);
15170: }
15171: }
15172: my $recipientlist = join(',',@recipients);
15173: if (wantarray) {
15174: return ($recipientlist,$allbcc,$addtext);
15175: } else {
15176: return $recipientlist;
15177: }
1.618 raeburn 15178: }
15179:
1.127 matthew 15180: ############################################################
15181: ############################################################
1.154 albertel 15182:
1.655 raeburn 15183: =pod
15184:
15185: =head1 Course Catalog Routines
15186:
15187: =over 4
15188:
15189: =item * &gather_categories()
15190:
15191: Converts category definitions - keys of categories hash stored in
15192: coursecategories in configuration.db on the primary library server in a
15193: domain - to an array. Also generates javascript and idx hash used to
15194: generate Domain Coordinator interface for editing Course Categories.
15195:
15196: Inputs:
1.663 raeburn 15197:
1.655 raeburn 15198: categories (reference to hash of category definitions).
1.663 raeburn 15199:
1.655 raeburn 15200: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15201: categories and subcategories).
1.663 raeburn 15202:
1.655 raeburn 15203: idx (reference to hash of counters used in Domain Coordinator interface for
15204: editing Course Categories).
1.663 raeburn 15205:
1.655 raeburn 15206: jsarray (reference to array of categories used to create Javascript arrays for
15207: Domain Coordinator interface for editing Course Categories).
15208:
15209: Returns: nothing
15210:
15211: Side effects: populates cats, idx and jsarray.
15212:
15213: =cut
15214:
15215: sub gather_categories {
15216: my ($categories,$cats,$idx,$jsarray) = @_;
15217: my %counters;
15218: my $num = 0;
15219: foreach my $item (keys(%{$categories})) {
15220: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
15221: if ($container eq '' && $depth == 0) {
15222: $cats->[$depth][$categories->{$item}] = $cat;
15223: } else {
15224: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
15225: }
15226: my ($escitem,$tail) = split(/:/,$item,2);
15227: if ($counters{$tail} eq '') {
15228: $counters{$tail} = $num;
15229: $num ++;
15230: }
15231: if (ref($idx) eq 'HASH') {
15232: $idx->{$item} = $counters{$tail};
15233: }
15234: if (ref($jsarray) eq 'ARRAY') {
15235: push(@{$jsarray->[$counters{$tail}]},$item);
15236: }
15237: }
15238: return;
15239: }
15240:
15241: =pod
15242:
15243: =item * &extract_categories()
15244:
15245: Used to generate breadcrumb trails for course categories.
15246:
15247: Inputs:
1.663 raeburn 15248:
1.655 raeburn 15249: categories (reference to hash of category definitions).
1.663 raeburn 15250:
1.655 raeburn 15251: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15252: categories and subcategories).
1.663 raeburn 15253:
1.655 raeburn 15254: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 15255:
1.655 raeburn 15256: allitems (reference to hash - key is category key
15257: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15258:
1.655 raeburn 15259: idx (reference to hash of counters used in Domain Coordinator interface for
15260: editing Course Categories).
1.663 raeburn 15261:
1.655 raeburn 15262: jsarray (reference to array of categories used to create Javascript arrays for
15263: Domain Coordinator interface for editing Course Categories).
15264:
1.665 raeburn 15265: subcats (reference to hash of arrays containing all subcategories within each
15266: category, -recursive)
15267:
1.1075.2.132 raeburn 15268: maxd (reference to hash used to hold max depth for all top-level categories).
15269:
1.655 raeburn 15270: Returns: nothing
15271:
15272: Side effects: populates trails and allitems hash references.
15273:
15274: =cut
15275:
15276: sub extract_categories {
1.1075.2.132 raeburn 15277: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 15278: if (ref($categories) eq 'HASH') {
15279: &gather_categories($categories,$cats,$idx,$jsarray);
15280: if (ref($cats->[0]) eq 'ARRAY') {
15281: for (my $i=0; $i<@{$cats->[0]}; $i++) {
15282: my $name = $cats->[0][$i];
15283: my $item = &escape($name).'::0';
15284: my $trailstr;
15285: if ($name eq 'instcode') {
15286: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 15287: } elsif ($name eq 'communities') {
15288: $trailstr = &mt('Communities');
1.655 raeburn 15289: } else {
15290: $trailstr = $name;
15291: }
15292: if ($allitems->{$item} eq '') {
15293: push(@{$trails},$trailstr);
15294: $allitems->{$item} = scalar(@{$trails})-1;
15295: }
15296: my @parents = ($name);
15297: if (ref($cats->[1]{$name}) eq 'ARRAY') {
15298: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
15299: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 15300: if (ref($subcats) eq 'HASH') {
15301: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
15302: }
1.1075.2.132 raeburn 15303: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 15304: }
15305: } else {
15306: if (ref($subcats) eq 'HASH') {
15307: $subcats->{$item} = [];
1.655 raeburn 15308: }
1.1075.2.132 raeburn 15309: if (ref($maxd) eq 'HASH') {
15310: $maxd->{$name} = 1;
15311: }
1.655 raeburn 15312: }
15313: }
15314: }
15315: }
15316: return;
15317: }
15318:
15319: =pod
15320:
1.1075.2.56 raeburn 15321: =item * &recurse_categories()
1.655 raeburn 15322:
15323: Recursively used to generate breadcrumb trails for course categories.
15324:
15325: Inputs:
1.663 raeburn 15326:
1.655 raeburn 15327: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15328: categories and subcategories).
1.663 raeburn 15329:
1.655 raeburn 15330: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 15331:
15332: category (current course category, for which breadcrumb trail is being generated).
15333:
15334: trails (reference to array of breadcrumb trails for each category).
15335:
1.655 raeburn 15336: allitems (reference to hash - key is category key
15337: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15338:
1.655 raeburn 15339: parents (array containing containers directories for current category,
15340: back to top level).
15341:
15342: Returns: nothing
15343:
15344: Side effects: populates trails and allitems hash references
15345:
15346: =cut
15347:
15348: sub recurse_categories {
1.1075.2.132 raeburn 15349: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 15350: my $shallower = $depth - 1;
15351: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
15352: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
15353: my $name = $cats->[$depth]{$category}[$k];
15354: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.161. .4(raebu 15355:22): my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15356: if ($allitems->{$item} eq '') {
15357: push(@{$trails},$trailstr);
15358: $allitems->{$item} = scalar(@{$trails})-1;
15359: }
15360: my $deeper = $depth+1;
15361: push(@{$parents},$category);
1.665 raeburn 15362: if (ref($subcats) eq 'HASH') {
15363: my $subcat = &escape($name).':'.$category.':'.$depth;
15364: for (my $j=@{$parents}; $j>=0; $j--) {
15365: my $higher;
15366: if ($j > 0) {
15367: $higher = &escape($parents->[$j]).':'.
15368: &escape($parents->[$j-1]).':'.$j;
15369: } else {
15370: $higher = &escape($parents->[$j]).'::'.$j;
15371: }
15372: push(@{$subcats->{$higher}},$subcat);
15373: }
15374: }
15375: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132 raeburn 15376: $subcats,$maxd);
1.655 raeburn 15377: pop(@{$parents});
15378: }
15379: } else {
15380: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132 raeburn 15381: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15382: if ($allitems->{$item} eq '') {
15383: push(@{$trails},$trailstr);
15384: $allitems->{$item} = scalar(@{$trails})-1;
15385: }
1.1075.2.132 raeburn 15386: if (ref($maxd) eq 'HASH') {
15387: if ($depth > $maxd->{$parents->[0]}) {
15388: $maxd->{$parents->[0]} = $depth;
15389: }
15390: }
1.655 raeburn 15391: }
15392: return;
15393: }
15394:
1.663 raeburn 15395: =pod
15396:
1.1075.2.56 raeburn 15397: =item * &assign_categories_table()
1.663 raeburn 15398:
15399: Create a datatable for display of hierarchical categories in a domain,
15400: with checkboxes to allow a course to be categorized.
15401:
15402: Inputs:
15403:
15404: cathash - reference to hash of categories defined for the domain (from
15405: configuration.db)
15406:
15407: currcat - scalar with an & separated list of categories assigned to a course.
15408:
1.919 raeburn 15409: type - scalar contains course type (Course or Community).
15410:
1.1075.2.117 raeburn 15411: disabled - scalar (optional) contains disabled="disabled" if input elements are
15412: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15413:
1.663 raeburn 15414: Returns: $output (markup to be displayed)
15415:
15416: =cut
15417:
15418: sub assign_categories_table {
1.1075.2.117 raeburn 15419: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 15420: my $output;
15421: if (ref($cathash) eq 'HASH') {
1.1075.2.132 raeburn 15422: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
15423: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 15424: $maxdepth = scalar(@cats);
15425: if (@cats > 0) {
15426: my $itemcount = 0;
15427: if (ref($cats[0]) eq 'ARRAY') {
15428: my @currcategories;
15429: if ($currcat ne '') {
15430: @currcategories = split('&',$currcat);
15431: }
1.919 raeburn 15432: my $table;
1.663 raeburn 15433: for (my $i=0; $i<@{$cats[0]}; $i++) {
15434: my $parent = $cats[0][$i];
1.919 raeburn 15435: next if ($parent eq 'instcode');
15436: if ($type eq 'Community') {
15437: next unless ($parent eq 'communities');
15438: } else {
15439: next if ($parent eq 'communities');
15440: }
1.663 raeburn 15441: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
15442: my $item = &escape($parent).'::0';
15443: my $checked = '';
15444: if (@currcategories > 0) {
15445: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 15446: $checked = ' checked="checked"';
1.663 raeburn 15447: }
15448: }
1.919 raeburn 15449: my $parent_title = $parent;
15450: if ($parent eq 'communities') {
15451: $parent_title = &mt('Communities');
15452: }
15453: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
15454: '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117 raeburn 15455: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 15456: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 15457: my $depth = 1;
15458: push(@path,$parent);
1.1075.2.117 raeburn 15459: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 15460: pop(@path);
1.919 raeburn 15461: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 15462: $itemcount ++;
15463: }
1.919 raeburn 15464: if ($itemcount) {
15465: $output = &Apache::loncommon::start_data_table().
15466: $table.
15467: &Apache::loncommon::end_data_table();
15468: }
1.663 raeburn 15469: }
15470: }
15471: }
15472: return $output;
15473: }
15474:
15475: =pod
15476:
1.1075.2.56 raeburn 15477: =item * &assign_category_rows()
1.663 raeburn 15478:
15479: Create a datatable row for display of nested categories in a domain,
15480: with checkboxes to allow a course to be categorized,called recursively.
15481:
15482: Inputs:
15483:
15484: itemcount - track row number for alternating colors
15485:
15486: cats - reference to array of arrays/hashes which encapsulates hierarchy of
15487: categories and subcategories.
15488:
15489: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
15490:
15491: parent - parent of current category item
15492:
15493: path - Array containing all categories back up through the hierarchy from the
15494: current category to the top level.
15495:
15496: currcategories - reference to array of current categories assigned to the course
15497:
1.1075.2.117 raeburn 15498: disabled - scalar (optional) contains disabled="disabled" if input elements are
15499: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15500:
1.663 raeburn 15501: Returns: $output (markup to be displayed).
15502:
15503: =cut
15504:
15505: sub assign_category_rows {
1.1075.2.117 raeburn 15506: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 15507: my ($text,$name,$item,$chgstr);
15508: if (ref($cats) eq 'ARRAY') {
15509: my $maxdepth = scalar(@{$cats});
15510: if (ref($cats->[$depth]) eq 'HASH') {
15511: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
15512: my $numchildren = @{$cats->[$depth]{$parent}};
15513: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45 raeburn 15514: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 15515: for (my $j=0; $j<$numchildren; $j++) {
15516: $name = $cats->[$depth]{$parent}[$j];
15517: $item = &escape($name).':'.&escape($parent).':'.$depth;
15518: my $deeper = $depth+1;
15519: my $checked = '';
15520: if (ref($currcategories) eq 'ARRAY') {
15521: if (@{$currcategories} > 0) {
15522: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 15523: $checked = ' checked="checked"';
1.663 raeburn 15524: }
15525: }
15526: }
1.664 raeburn 15527: $text .= '<tr><td><span class="LC_nobreak"><label>'.
15528: '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117 raeburn 15529: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 15530: '<input type="hidden" name="catname" value="'.$name.'" />'.
15531: '</td><td>';
1.663 raeburn 15532: if (ref($path) eq 'ARRAY') {
15533: push(@{$path},$name);
1.1075.2.117 raeburn 15534: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 15535: pop(@{$path});
15536: }
15537: $text .= '</td></tr>';
15538: }
15539: $text .= '</table></td>';
15540: }
15541: }
15542: }
15543: return $text;
15544: }
15545:
1.1075.2.69 raeburn 15546: =pod
15547:
15548: =back
15549:
15550: =cut
15551:
1.655 raeburn 15552: ############################################################
15553: ############################################################
15554:
15555:
1.443 albertel 15556: sub commit_customrole {
1.664 raeburn 15557: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 15558: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 15559: ($start?', '.&mt('starting').' '.localtime($start):'').
15560: ($end?', ending '.localtime($end):'').': <b>'.
15561: &Apache::lonnet::assigncustomrole(
1.664 raeburn 15562: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 15563: '</b><br />';
15564: return $output;
15565: }
15566:
15567: sub commit_standardrole {
1.1075.2.31 raeburn 15568: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 15569: my ($output,$logmsg,$linefeed);
15570: if ($context eq 'auto') {
15571: $linefeed = "\n";
15572: } else {
15573: $linefeed = "<br />\n";
15574: }
1.443 albertel 15575: if ($three eq 'st') {
1.541 raeburn 15576: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31 raeburn 15577: $one,$two,$sec,$context,$credits);
1.541 raeburn 15578: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 15579: ($result eq 'unknown_course') || ($result eq 'refused')) {
15580: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 15581: } else {
1.541 raeburn 15582: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 15583: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15584: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
15585: if ($context eq 'auto') {
15586: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
15587: } else {
15588: $output .= '<b>'.$result.'</b>'.$linefeed.
15589: &mt('Add to classlist').': <b>ok</b>';
15590: }
15591: $output .= $linefeed;
1.443 albertel 15592: }
15593: } else {
15594: $output = &mt('Assigning').' '.$three.' in '.$url.
15595: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15596: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 15597: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 15598: if ($context eq 'auto') {
15599: $output .= $result.$linefeed;
15600: } else {
15601: $output .= '<b>'.$result.'</b>'.$linefeed;
15602: }
1.443 albertel 15603: }
15604: return $output;
15605: }
15606:
15607: sub commit_studentrole {
1.1075.2.31 raeburn 15608: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
15609: $credits) = @_;
1.626 raeburn 15610: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 15611: if ($context eq 'auto') {
15612: $linefeed = "\n";
15613: } else {
15614: $linefeed = '<br />'."\n";
15615: }
1.443 albertel 15616: if (defined($one) && defined($two)) {
15617: my $cid=$one.'_'.$two;
15618: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
15619: my $secchange = 0;
15620: my $expire_role_result;
15621: my $modify_section_result;
1.628 raeburn 15622: if ($oldsec ne '-1') {
15623: if ($oldsec ne $sec) {
1.443 albertel 15624: $secchange = 1;
1.628 raeburn 15625: my $now = time;
1.443 albertel 15626: my $uurl='/'.$cid;
15627: $uurl=~s/\_/\//g;
15628: if ($oldsec) {
15629: $uurl.='/'.$oldsec;
15630: }
1.626 raeburn 15631: $oldsecurl = $uurl;
1.628 raeburn 15632: $expire_role_result =
1.652 raeburn 15633: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 15634: if ($env{'request.course.sec'} ne '') {
15635: if ($expire_role_result eq 'refused') {
15636: my @roles = ('st');
15637: my @statuses = ('previous');
15638: my @roledoms = ($one);
15639: my $withsec = 1;
15640: my %roleshash =
15641: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
15642: \@statuses,\@roles,\@roledoms,$withsec);
15643: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
15644: my ($oldstart,$oldend) =
15645: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
15646: if ($oldend > 0 && $oldend <= $now) {
15647: $expire_role_result = 'ok';
15648: }
15649: }
15650: }
15651: }
1.443 albertel 15652: $result = $expire_role_result;
15653: }
15654: }
15655: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31 raeburn 15656: $modify_section_result =
15657: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
15658: undef,undef,undef,$sec,
15659: $end,$start,'','',$cid,
15660: '',$context,$credits);
1.443 albertel 15661: if ($modify_section_result =~ /^ok/) {
15662: if ($secchange == 1) {
1.628 raeburn 15663: if ($sec eq '') {
15664: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
15665: } else {
15666: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
15667: }
1.443 albertel 15668: } elsif ($oldsec eq '-1') {
1.628 raeburn 15669: if ($sec eq '') {
15670: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
15671: } else {
15672: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15673: }
1.443 albertel 15674: } else {
1.628 raeburn 15675: if ($sec eq '') {
15676: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
15677: } else {
15678: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15679: }
1.443 albertel 15680: }
15681: } else {
1.628 raeburn 15682: if ($secchange) {
15683: $$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;
15684: } else {
15685: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
15686: }
1.443 albertel 15687: }
15688: $result = $modify_section_result;
15689: } elsif ($secchange == 1) {
1.628 raeburn 15690: if ($oldsec eq '') {
1.1075.2.20 raeburn 15691: $$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 15692: } else {
15693: $$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;
15694: }
1.626 raeburn 15695: if ($expire_role_result eq 'refused') {
15696: my $newsecurl = '/'.$cid;
15697: $newsecurl =~ s/\_/\//g;
15698: if ($sec ne '') {
15699: $newsecurl.='/'.$sec;
15700: }
15701: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
15702: if ($sec eq '') {
15703: $$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;
15704: } else {
15705: $$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;
15706: }
15707: }
15708: }
1.443 albertel 15709: }
15710: } else {
1.626 raeburn 15711: $$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 15712: $result = "error: incomplete course id\n";
15713: }
15714: return $result;
15715: }
15716:
1.1075.2.25 raeburn 15717: sub show_role_extent {
15718: my ($scope,$context,$role) = @_;
15719: $scope =~ s{^/}{};
15720: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
15721: push(@courseroles,'co');
15722: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
15723: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
15724: $scope =~ s{/}{_};
15725: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
15726: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
15727: my ($audom,$auname) = split(/\//,$scope);
15728: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
15729: &Apache::loncommon::plainname($auname,$audom).'</span>');
15730: } else {
15731: $scope =~ s{/$}{};
15732: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
15733: &Apache::lonnet::domain($scope,'description').'</span>');
15734: }
15735: }
15736:
1.443 albertel 15737: ############################################################
15738: ############################################################
15739:
1.566 albertel 15740: sub check_clone {
1.578 raeburn 15741: my ($args,$linefeed) = @_;
1.566 albertel 15742: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
15743: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
15744: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.161. .1(raebu 15745:21): my $clonetitle;
15746:21): my @clonemsg;
1.566 albertel 15747: my $can_clone = 0;
1.944 raeburn 15748: my $lctype = lc($args->{'crstype'});
1.908 raeburn 15749: if ($lctype ne 'community') {
15750: $lctype = 'course';
15751: }
1.566 albertel 15752: if ($clonehome eq 'no_host') {
1.944 raeburn 15753: if ($args->{'crstype'} eq 'Community') {
1.1075.2.161. .1(raebu 15754:21): push(@clonemsg,({
15755:21): mt => 'No new community created.',
15756:21): args => [],
15757:21): },
15758:21): {
15759:21): mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
15760:21): args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
15761:21): }));
1.908 raeburn 15762: } else {
1.1075.2.161. .1(raebu 15763:21): push(@clonemsg,({
15764:21): mt => 'No new course created.',
15765:21): args => [],
15766:21): },
15767:21): {
15768:21): mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
15769:21): args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
15770:21): }));
15771:21): }
1.566 albertel 15772: } else {
15773: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.161. .1(raebu 15774:21): $clonetitle = $clonedesc{'description'};
1.944 raeburn 15775: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15776: if ($clonedesc{'type'} ne 'Community') {
1.1075.2.161. .1(raebu 15777:21): push(@clonemsg,({
15778:21): mt => 'No new community created.',
15779:21): args => [],
15780:21): },
15781:21): {
15782:21): mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
15783:21): args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
15784:21): }));
15785:21): return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 15786: }
15787: }
1.1075.2.119 raeburn 15788: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 15789: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 15790: $can_clone = 1;
15791: } else {
1.1075.2.95 raeburn 15792: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 15793: $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95 raeburn 15794: if ($clonehash{'cloners'} eq '') {
15795: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
15796: if ($domdefs{'canclone'}) {
15797: unless ($domdefs{'canclone'} eq 'none') {
15798: if ($domdefs{'canclone'} eq 'domain') {
15799: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
15800: $can_clone = 1;
15801: }
15802: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15803: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
15804: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
15805: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
15806: $can_clone = 1;
15807: }
15808: }
15809: }
1.908 raeburn 15810: }
1.1075.2.95 raeburn 15811: } else {
15812: my @cloners = split(/,/,$clonehash{'cloners'});
15813: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 15814: $can_clone = 1;
1.1075.2.95 raeburn 15815: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 15816: $can_clone = 1;
1.1075.2.96 raeburn 15817: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
15818: $can_clone = 1;
1.1075.2.95 raeburn 15819: }
15820: unless ($can_clone) {
1.1075.2.96 raeburn 15821: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15822: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1075.2.95 raeburn 15823: my (%gotdomdefaults,%gotcodedefaults);
15824: foreach my $cloner (@cloners) {
15825: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
15826: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
15827: my (%codedefaults,@code_order);
15828: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
15829: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
15830: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
15831: }
15832: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
15833: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
15834: }
15835: } else {
15836: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
15837: \%codedefaults,
15838: \@code_order);
15839: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
15840: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
15841: }
15842: if (@code_order > 0) {
15843: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
15844: $cloner,$clonehash{'internal.coursecode'},
15845: $args->{'crscode'})) {
15846: $can_clone = 1;
15847: last;
15848: }
15849: }
15850: }
15851: }
15852: }
1.1075.2.96 raeburn 15853: }
15854: }
15855: unless ($can_clone) {
15856: my $ccrole = 'cc';
15857: if ($args->{'crstype'} eq 'Community') {
15858: $ccrole = 'co';
15859: }
15860: my %roleshash =
15861: &Apache::lonnet::get_my_roles($args->{'ccuname'},
15862: $args->{'ccdomain'},
15863: 'userroles',['active'],[$ccrole],
15864: [$args->{'clonedomain'}]);
15865: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
15866: $can_clone = 1;
15867: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
15868: $args->{'ccuname'},$args->{'ccdomain'})) {
15869: $can_clone = 1;
1.1075.2.95 raeburn 15870: }
15871: }
15872: unless ($can_clone) {
15873: if ($args->{'crstype'} eq 'Community') {
1.1075.2.161. .1(raebu 15874:21): push(@clonemsg,({
15875:21): mt => 'No new community created.',
15876:21): args => [],
15877:21): },
15878:21): {
15879:21): 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]).',
15880:21): args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
15881:21): }));
1.1075.2.95 raeburn 15882: } else {
1.1075.2.161. .1(raebu 15883:21): push(@clonemsg,({
15884:21): mt => 'No new course created.',
15885:21): args => [],
15886:21): },
15887:21): {
15888:21): 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]).',
15889:21): args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
15890:21): }));
1.578 raeburn 15891: }
1.566 albertel 15892: }
1.578 raeburn 15893: }
1.566 albertel 15894: }
1.1075.2.161. .1(raebu 15895:21): return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 15896: }
15897:
1.444 albertel 15898: sub construct_course {
1.1075.2.119 raeburn 15899: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.161. .1(raebu 15900:21): $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
15901:21): my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 15902: my $linefeed = '<br />'."\n";
15903: if ($context eq 'auto') {
15904: $linefeed = "\n";
15905: }
1.566 albertel 15906:
15907: #
15908: # Are we cloning?
15909: #
1.1075.2.161. .1(raebu 15910:21): my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 15911: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.161. .1(raebu 15912:21): ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 15913: if (!$can_clone) {
1.1075.2.161. .1(raebu 15914:21): return (0,$outcome,$clonemsgref);
1.566 albertel 15915: }
15916: }
15917:
1.444 albertel 15918: #
15919: # Open course
15920: #
15921: my $crstype = lc($args->{'crstype'});
15922: my %cenv=();
15923: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
15924: $args->{'cdescr'},
15925: $args->{'curl'},
15926: $args->{'course_home'},
15927: $args->{'nonstandard'},
15928: $args->{'crscode'},
15929: $args->{'ccuname'}.':'.
15930: $args->{'ccdomain'},
1.882 raeburn 15931: $args->{'crstype'},
1.1075.2.161. .1(raebu 15932:21): $cnum,$context,$category,
15933:21): $callercontext);
1.444 albertel 15934:
15935: # Note: The testing routines depend on this being output; see
15936: # Utils::Course. This needs to at least be output as a comment
15937: # if anyone ever decides to not show this, and Utils::Course::new
15938: # will need to be suitably modified.
1.1075.2.161. .1(raebu 15939:21): if (($callercontext eq 'auto') && ($user_lh ne '')) {
15940:21): $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
15941:21): } else {
15942:21): $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
15943:21): }
1.943 raeburn 15944: if ($$courseid =~ /^error:/) {
1.1075.2.161. .1(raebu 15945:21): return (0,$outcome,$clonemsgref);
1.943 raeburn 15946: }
15947:
1.444 albertel 15948: #
15949: # Check if created correctly
15950: #
1.479 albertel 15951: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 15952: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 15953: if ($crsuhome eq 'no_host') {
1.1075.2.161. .1(raebu 15954:21): if (($callercontext eq 'auto') && ($user_lh ne '')) {
15955:21): $outcome .= &mt_user($user_lh,
15956:21): 'Course creation failed, unrecognized course home server.');
15957:21): } else {
15958:21): $outcome .= &mt('Course creation failed, unrecognized course home server.');
15959:21): }
15960:21): $outcome .= $linefeed;
15961:21): return (0,$outcome,$clonemsgref);
1.943 raeburn 15962: }
1.541 raeburn 15963: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 15964:
1.444 albertel 15965: #
1.566 albertel 15966: # Do the cloning
1.1075.2.161. .1(raebu 15967:21): #
15968:21): my @clonemsg;
1.566 albertel 15969: if ($can_clone && $cloneid) {
1.1075.2.161. .1(raebu 15970:21): push(@clonemsg,
15971:21): {
15972:21): mt => 'Created [_1] by cloning from [_2]',
15973:21): args => [$crstype,$clonetitle],
15974:21): });
1.566 albertel 15975: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 15976: # Copy all files
1.1075.2.161. .1(raebu 15977:21): my @info =
15978:21): &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
15979:21): $args->{'dateshift'},$args->{'crscode'},
15980:21): $args->{'ccuname'}.':'.$args->{'ccdomain'},
15981:21): $args->{'tinyurls'});
15982:21): if (@info) {
15983:21): push(@clonemsg,@info);
15984:21): }
1.444 albertel 15985: # Restore URL
1.566 albertel 15986: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 15987: # Restore title
1.566 albertel 15988: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 15989: # Restore creation date, creator and creation context.
15990: $cenv{'internal.created'}=$oldcenv{'internal.created'};
15991: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
15992: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 15993: # Mark as cloned
1.566 albertel 15994: $cenv{'clonedfrom'}=$cloneid;
1.638 www 15995: # Need to clone grading mode
15996: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
15997: $cenv{'grading'}=$newenv{'grading'};
15998: # Do not clone these environment entries
15999: &Apache::lonnet::del('environment',
16000: ['default_enrollment_start_date',
16001: 'default_enrollment_end_date',
16002: 'question.email',
16003: 'policy.email',
16004: 'comment.email',
16005: 'pch.users.denied',
1.725 raeburn 16006: 'plc.users.denied',
16007: 'hidefromcat',
1.1075.2.36 raeburn 16008: 'checkforpriv',
1.1075.2.158 raeburn 16009: 'categories'],
1.638 www 16010: $$crsudom,$$crsunum);
1.1075.2.63 raeburn 16011: if ($args->{'textbook'}) {
16012: $cenv{'internal.textbook'} = $args->{'textbook'};
16013: }
1.444 albertel 16014: }
1.566 albertel 16015:
1.444 albertel 16016: #
16017: # Set environment (will override cloned, if existing)
16018: #
16019: my @sections = ();
16020: my @xlists = ();
16021: if ($args->{'crstype'}) {
16022: $cenv{'type'}=$args->{'crstype'};
16023: }
16024: if ($args->{'crsid'}) {
16025: $cenv{'courseid'}=$args->{'crsid'};
16026: }
16027: if ($args->{'crscode'}) {
16028: $cenv{'internal.coursecode'}=$args->{'crscode'};
16029: }
16030: if ($args->{'crsquota'} ne '') {
16031: $cenv{'internal.coursequota'}=$args->{'crsquota'};
16032: } else {
16033: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
16034: }
16035: if ($args->{'ccuname'}) {
16036: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
16037: ':'.$args->{'ccdomain'};
16038: } else {
16039: $cenv{'internal.courseowner'} = $args->{'curruser'};
16040: }
1.1075.2.31 raeburn 16041: if ($args->{'defaultcredits'}) {
16042: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
16043: }
1.444 albertel 16044: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
16045: if ($args->{'crssections'}) {
16046: $cenv{'internal.sectionnums'} = '';
16047: if ($args->{'crssections'} =~ m/,/) {
16048: @sections = split/,/,$args->{'crssections'};
16049: } else {
16050: $sections[0] = $args->{'crssections'};
16051: }
16052: if (@sections > 0) {
16053: foreach my $item (@sections) {
16054: my ($sec,$gp) = split/:/,$item;
16055: my $class = $args->{'crscode'}.$sec;
16056: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
16057: $cenv{'internal.sectionnums'} .= $item.',';
16058: unless ($addcheck eq 'ok') {
1.1075.2.119 raeburn 16059: push(@badclasses,$class);
1.444 albertel 16060: }
16061: }
16062: $cenv{'internal.sectionnums'} =~ s/,$//;
16063: }
16064: }
16065: # do not hide course coordinator from staff listing,
16066: # even if privileged
16067: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36 raeburn 16068: # add course coordinator's domain to domains to check for privileged users
16069: # if different to course domain
16070: if ($$crsudom ne $args->{'ccdomain'}) {
16071: $cenv{'checkforpriv'} = $args->{'ccdomain'};
16072: }
1.444 albertel 16073: # add crosslistings
16074: if ($args->{'crsxlist'}) {
16075: $cenv{'internal.crosslistings'}='';
16076: if ($args->{'crsxlist'} =~ m/,/) {
16077: @xlists = split/,/,$args->{'crsxlist'};
16078: } else {
16079: $xlists[0] = $args->{'crsxlist'};
16080: }
16081: if (@xlists > 0) {
16082: foreach my $item (@xlists) {
16083: my ($xl,$gp) = split/:/,$item;
16084: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
16085: $cenv{'internal.crosslistings'} .= $item.',';
16086: unless ($addcheck eq 'ok') {
1.1075.2.119 raeburn 16087: push(@badclasses,$xl);
1.444 albertel 16088: }
16089: }
16090: $cenv{'internal.crosslistings'} =~ s/,$//;
16091: }
16092: }
16093: if ($args->{'autoadds'}) {
16094: $cenv{'internal.autoadds'}=$args->{'autoadds'};
16095: }
16096: if ($args->{'autodrops'}) {
16097: $cenv{'internal.autodrops'}=$args->{'autodrops'};
16098: }
16099: # check for notification of enrollment changes
16100: my @notified = ();
16101: if ($args->{'notify_owner'}) {
16102: if ($args->{'ccuname'} ne '') {
16103: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
16104: }
16105: }
16106: if ($args->{'notify_dc'}) {
16107: if ($uname ne '') {
1.630 raeburn 16108: push(@notified,$uname.':'.$udom);
1.444 albertel 16109: }
16110: }
16111: if (@notified > 0) {
16112: my $notifylist;
16113: if (@notified > 1) {
16114: $notifylist = join(',',@notified);
16115: } else {
16116: $notifylist = $notified[0];
16117: }
16118: $cenv{'internal.notifylist'} = $notifylist;
16119: }
16120: if (@badclasses > 0) {
16121: my %lt=&Apache::lonlocal::texthash(
1.1075.2.119 raeburn 16122: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
16123: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
16124: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 16125: );
1.1075.2.119 raeburn 16126: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
16127: &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 16128: if ($context eq 'auto') {
16129: $outcome .= $badclass_msg.$linefeed;
1.1075.2.119 raeburn 16130: } else {
1.566 albertel 16131: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119 raeburn 16132: }
16133: foreach my $item (@badclasses) {
1.541 raeburn 16134: if ($context eq 'auto') {
1.1075.2.119 raeburn 16135: $outcome .= " - $item\n";
1.541 raeburn 16136: } else {
1.1075.2.119 raeburn 16137: $outcome .= "<li>$item</li>\n";
1.541 raeburn 16138: }
1.1075.2.119 raeburn 16139: }
16140: if ($context eq 'auto') {
16141: $outcome .= $linefeed;
16142: } else {
16143: $outcome .= "</ul><br /><br /></div>\n";
16144: }
1.444 albertel 16145: }
16146: if ($args->{'no_end_date'}) {
16147: $args->{'endaccess'} = 0;
16148: }
16149: $cenv{'internal.autostart'}=$args->{'enrollstart'};
16150: $cenv{'internal.autoend'}=$args->{'enrollend'};
16151: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
16152: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
16153: if ($args->{'showphotos'}) {
16154: $cenv{'internal.showphotos'}=$args->{'showphotos'};
16155: }
16156: $cenv{'internal.authtype'} = $args->{'authtype'};
16157: $cenv{'internal.autharg'} = $args->{'autharg'};
16158: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
16159: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 16160: 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');
16161: if ($context eq 'auto') {
16162: $outcome .= $krb_msg;
16163: } else {
1.566 albertel 16164: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 16165: }
16166: $outcome .= $linefeed;
1.444 albertel 16167: }
16168: }
16169: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
16170: if ($args->{'setpolicy'}) {
16171: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16172: }
16173: if ($args->{'setcontent'}) {
16174: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16175: }
1.1075.2.110 raeburn 16176: if ($args->{'setcomment'}) {
16177: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16178: }
1.444 albertel 16179: }
16180: if ($args->{'reshome'}) {
16181: $cenv{'reshome'}=$args->{'reshome'}.'/';
16182: $cenv{'reshome'}=~s/\/+$/\//;
16183: }
16184: #
16185: # course has keyed access
16186: #
16187: if ($args->{'setkeys'}) {
16188: $cenv{'keyaccess'}='yes';
16189: }
16190: # if specified, key authority is not course, but user
16191: # only active if keyaccess is yes
16192: if ($args->{'keyauth'}) {
1.487 albertel 16193: my ($user,$domain) = split(':',$args->{'keyauth'});
16194: $user = &LONCAPA::clean_username($user);
16195: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 16196: if ($user ne '' && $domain ne '') {
1.487 albertel 16197: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 16198: }
16199: }
16200:
1.1075.2.59 raeburn 16201: #
16202: # generate and store uniquecode (available to course requester), if course should have one.
16203: #
16204: if ($args->{'uniquecode'}) {
16205: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
16206: if ($code) {
16207: $cenv{'internal.uniquecode'} = $code;
16208: my %crsinfo =
16209: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
16210: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
16211: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
16212: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
16213: }
16214: if (ref($coderef)) {
16215: $$coderef = $code;
16216: }
16217: }
16218: }
16219:
1.444 albertel 16220: if ($args->{'disresdis'}) {
16221: $cenv{'pch.roles.denied'}='st';
16222: }
16223: if ($args->{'disablechat'}) {
16224: $cenv{'plc.roles.denied'}='st';
16225: }
16226:
16227: # Record we've not yet viewed the Course Initialization Helper for this
16228: # course
16229: $cenv{'course.helper.not.run'} = 1;
16230: #
16231: # Use new Randomseed
16232: #
16233: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
16234: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
16235: #
16236: # The encryption code and receipt prefix for this course
16237: #
16238: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
16239: $cenv{'internal.encpref'}=100+int(9*rand(99));
16240: #
16241: # By default, use standard grading
16242: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
16243:
1.541 raeburn 16244: $outcome .= $linefeed.&mt('Setting environment').': '.
16245: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16246: #
16247: # Open all assignments
16248: #
16249: if ($args->{'openall'}) {
1.1075.2.146 raeburn 16250: my $opendate = time;
16251: if ($args->{'openallfrom'} =~ /^\d+$/) {
16252: $opendate = $args->{'openallfrom'};
16253: }
1.444 albertel 16254: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146 raeburn 16255: my %storecontent = ($storeunder => $opendate,
1.444 albertel 16256: $storeunder.'.type' => 'date_start');
1.1075.2.146 raeburn 16257: $outcome .= &mt('All assignments open starting [_1]',
16258: &Apache::lonlocal::locallocaltime($opendate)).': '.
16259: &Apache::lonnet::cput
16260: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16261: }
16262: #
16263: # Set first page
16264: #
16265: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
16266: || ($cloneid)) {
1.445 albertel 16267: use LONCAPA::map;
1.444 albertel 16268: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 16269:
16270: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
16271: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
16272:
1.444 albertel 16273: $outcome .= ($fatal?$errtext:'read ok').' - ';
16274: my $title; my $url;
16275: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 16276: $title=&mt('Syllabus');
1.444 albertel 16277: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
16278: } else {
1.963 raeburn 16279: $title=&mt('Table of Contents');
1.444 albertel 16280: $url='/adm/navmaps';
16281: }
1.445 albertel 16282:
16283: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
16284: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
16285:
16286: if ($errtext) { $fatal=2; }
1.541 raeburn 16287: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 16288: }
1.566 albertel 16289:
1.1075.2.161. .1(raebu 16290:21): return (1,$outcome,\@clonemsg);
1.444 albertel 16291: }
16292:
1.1075.2.59 raeburn 16293: sub make_unique_code {
16294: my ($cdom,$cnum) = @_;
16295: # get lock on uniquecodes db
16296: my $lockhash = {
16297: $cnum."\0".'uniquecodes' => $env{'user.name'}.
16298: ':'.$env{'user.domain'},
16299: };
16300: my $tries = 0;
16301: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16302: my ($code,$error);
16303:
16304: while (($gotlock ne 'ok') && ($tries<3)) {
16305: $tries ++;
16306: sleep 1;
16307: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16308: }
16309: if ($gotlock eq 'ok') {
16310: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
16311: my $gotcode;
16312: my $attempts = 0;
16313: while ((!$gotcode) && ($attempts < 100)) {
16314: $code = &generate_code();
16315: if (!exists($currcodes{$code})) {
16316: $gotcode = 1;
16317: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
16318: $error = 'nostore';
16319: }
16320: }
16321: $attempts ++;
16322: }
16323: my @del_lock = ($cnum."\0".'uniquecodes');
16324: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
16325: } else {
16326: $error = 'nolock';
16327: }
16328: return ($code,$error);
16329: }
16330:
16331: sub generate_code {
16332: my $code;
16333: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
16334: for (my $i=0; $i<6; $i++) {
16335: my $lettnum = int (rand 2);
16336: my $item = '';
16337: if ($lettnum) {
16338: $item = $letts[int( rand(18) )];
16339: } else {
16340: $item = 1+int( rand(8) );
16341: }
16342: $code .= $item;
16343: }
16344: return $code;
16345: }
16346:
1.444 albertel 16347: ############################################################
16348: ############################################################
16349:
1.953 droeschl 16350: #SD
16351: # only Community and Course, or anything else?
1.378 raeburn 16352: sub course_type {
16353: my ($cid) = @_;
16354: if (!defined($cid)) {
16355: $cid = $env{'request.course.id'};
16356: }
1.404 albertel 16357: if (defined($env{'course.'.$cid.'.type'})) {
16358: return $env{'course.'.$cid.'.type'};
1.378 raeburn 16359: } else {
16360: return 'Course';
1.377 raeburn 16361: }
16362: }
1.156 albertel 16363:
1.406 raeburn 16364: sub group_term {
16365: my $crstype = &course_type();
16366: my %names = (
16367: 'Course' => 'group',
1.865 raeburn 16368: 'Community' => 'group',
1.406 raeburn 16369: );
16370: return $names{$crstype};
16371: }
16372:
1.902 raeburn 16373: sub course_types {
1.1075.2.59 raeburn 16374: my @types = ('official','unofficial','community','textbook');
1.902 raeburn 16375: my %typename = (
16376: official => 'Official course',
16377: unofficial => 'Unofficial course',
16378: community => 'Community',
1.1075.2.59 raeburn 16379: textbook => 'Textbook course',
1.902 raeburn 16380: );
16381: return (\@types,\%typename);
16382: }
16383:
1.156 albertel 16384: sub icon {
16385: my ($file)=@_;
1.505 albertel 16386: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 16387: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 16388: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 16389: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
16390: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
16391: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16392: $curfext.".gif") {
16393: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16394: $curfext.".gif";
16395: }
16396: }
1.249 albertel 16397: return &lonhttpdurl($iconname);
1.154 albertel 16398: }
1.84 albertel 16399:
1.575 albertel 16400: sub lonhttpdurl {
1.692 www 16401: #
16402: # Had been used for "small fry" static images on separate port 8080.
16403: # Modify here if lightweight http functionality desired again.
16404: # Currently eliminated due to increasing firewall issues.
16405: #
1.575 albertel 16406: my ($url)=@_;
1.692 www 16407: return $url;
1.215 albertel 16408: }
16409:
1.213 albertel 16410: sub connection_aborted {
16411: my ($r)=@_;
16412: $r->print(" ");$r->rflush();
16413: my $c = $r->connection;
16414: return $c->aborted();
16415: }
16416:
1.221 foxr 16417: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 16418: # strings as 'strings'.
16419: sub escape_single {
1.221 foxr 16420: my ($input) = @_;
1.223 albertel 16421: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 16422: $input =~ s/\'/\\\'/g; # Esacpe the 's....
16423: return $input;
16424: }
1.223 albertel 16425:
1.222 foxr 16426: # Same as escape_single, but escape's "'s This
16427: # can be used for "strings"
16428: sub escape_double {
16429: my ($input) = @_;
16430: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
16431: $input =~ s/\"/\\\"/g; # Esacpe the "s....
16432: return $input;
16433: }
1.223 albertel 16434:
1.222 foxr 16435: # Escapes the last element of a full URL.
16436: sub escape_url {
16437: my ($url) = @_;
1.238 raeburn 16438: my @urlslices = split(/\//, $url,-1);
1.369 www 16439: my $lastitem = &escape(pop(@urlslices));
1.1075.2.83 raeburn 16440: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 16441: }
1.462 albertel 16442:
1.820 raeburn 16443: sub compare_arrays {
16444: my ($arrayref1,$arrayref2) = @_;
16445: my (@difference,%count);
16446: @difference = ();
16447: %count = ();
16448: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
16449: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
16450: foreach my $element (keys(%count)) {
16451: if ($count{$element} == 1) {
16452: push(@difference,$element);
16453: }
16454: }
16455: }
16456: return @difference;
16457: }
16458:
1.1075.2.152 raeburn 16459: sub lon_status_items {
16460: my %defaults = (
16461: E => 100,
16462: W => 4,
16463: N => 1,
16464: U => 5,
16465: threshold => 200,
16466: sysmail => 2500,
16467: );
16468: my %names = (
16469: E => 'Errors',
16470: W => 'Warnings',
16471: N => 'Notices',
16472: U => 'Unsent',
16473: );
16474: return (\%defaults,\%names);
16475: }
16476:
1.817 bisitz 16477: # -------------------------------------------------------- Initialize user login
1.462 albertel 16478: sub init_user_environment {
1.463 albertel 16479: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 16480: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
16481:
16482: my $public=($username eq 'public' && $domain eq 'public');
16483:
16484: # See if old ID present, if so, remove
16485:
1.1062 raeburn 16486: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 16487: my $now=time;
16488:
16489: if ($public) {
16490: my $max_public=100;
16491: my $oldest;
16492: my $oldest_time=0;
16493: for(my $next=1;$next<=$max_public;$next++) {
16494: if (-e $lonids."/publicuser_$next.id") {
16495: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
16496: if ($mtime<$oldest_time || !$oldest_time) {
16497: $oldest_time=$mtime;
16498: $oldest=$next;
16499: }
16500: } else {
16501: $cookie="publicuser_$next";
16502: last;
16503: }
16504: }
16505: if (!$cookie) { $cookie="publicuser_$oldest"; }
16506: } else {
1.463 albertel 16507: # if this isn't a robot, kill any existing non-robot sessions
16508: if (!$args->{'robot'}) {
16509: opendir(DIR,$lonids);
16510: while ($filename=readdir(DIR)) {
16511: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136 raeburn 16512: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
16513: &GDBM_READER(),0640)) {
16514: my $linkedfile;
16515: if (exists($oldenv{'user.linkedenv'})) {
16516: $linkedfile = $oldenv{'user.linkedenv'};
16517: }
16518: untie(%oldenv);
16519: if (unlink("$lonids/$filename")) {
16520: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
16521: if (-l "$lonids/$linkedfile.id") {
16522: unlink("$lonids/$linkedfile.id");
16523: }
16524: }
16525: }
16526: } else {
16527: unlink($lonids.'/'.$filename);
16528: }
1.463 albertel 16529: }
1.462 albertel 16530: }
1.463 albertel 16531: closedir(DIR);
1.1075.2.84 raeburn 16532: # If there is a undeleted lockfile for the user's paste buffer remove it.
16533: my $namespace = 'nohist_courseeditor';
16534: my $lockingkey = 'paste'."\0".'locked_num';
16535: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
16536: $domain,$username);
16537: if (exists($lockhash{$lockingkey})) {
16538: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
16539: unless ($delresult eq 'ok') {
16540: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
16541: }
16542: }
1.462 albertel 16543: }
16544: # Give them a new cookie
1.463 albertel 16545: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 16546: : $now.$$.int(rand(10000)));
1.463 albertel 16547: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 16548:
16549: # Initialize roles
16550:
1.1062 raeburn 16551: ($userroles,$firstaccenv,$timerintenv) =
16552: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 16553: }
16554: # ------------------------------------ Check browser type and MathML capability
16555:
1.1075.2.77 raeburn 16556: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
16557: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 16558:
16559: # ------------------------------------------------------------- Get environment
16560:
16561: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
16562: my ($tmp) = keys(%userenv);
16563: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
16564: } else {
16565: undef(%userenv);
16566: }
16567: if (($userenv{'interface'}) && (!$form->{'interface'})) {
16568: $form->{'interface'}=$userenv{'interface'};
16569: }
16570: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
16571:
16572: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 16573: foreach my $option ('interface','localpath','localres') {
16574: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 16575: }
16576: # --------------------------------------------------------- Write first profile
16577:
16578: {
1.1075.2.150 raeburn 16579: my $ip = &Apache::lonnet::get_requestor_ip();
1.462 albertel 16580: my %initial_env =
16581: ("user.name" => $username,
16582: "user.domain" => $domain,
16583: "user.home" => $authhost,
16584: "browser.type" => $clientbrowser,
16585: "browser.version" => $clientversion,
16586: "browser.mathml" => $clientmathml,
16587: "browser.unicode" => $clientunicode,
16588: "browser.os" => $clientos,
1.1075.2.42 raeburn 16589: "browser.mobile" => $clientmobile,
16590: "browser.info" => $clientinfo,
1.1075.2.77 raeburn 16591: "browser.osversion" => $clientosversion,
1.462 albertel 16592: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
16593: "request.course.fn" => '',
16594: "request.course.uri" => '',
16595: "request.course.sec" => '',
16596: "request.role" => 'cm',
16597: "request.role.adv" => $env{'user.adv'},
1.1075.2.150 raeburn 16598: "request.host" => $ip,);
1.462 albertel 16599:
16600: if ($form->{'localpath'}) {
16601: $initial_env{"browser.localpath"} = $form->{'localpath'};
16602: $initial_env{"browser.localres"} = $form->{'localres'};
16603: }
16604:
16605: if ($form->{'interface'}) {
16606: $form->{'interface'}=~s/\W//gs;
16607: $initial_env{"browser.interface"} = $form->{'interface'};
16608: $env{'browser.interface'}=$form->{'interface'};
16609: }
16610:
1.1075.2.54 raeburn 16611: if ($form->{'iptoken'}) {
16612: my $lonhost = $r->dir_config('lonHostID');
16613: $initial_env{"user.noloadbalance"} = $lonhost;
16614: $env{'user.noloadbalance'} = $lonhost;
16615: }
16616:
1.1075.2.120 raeburn 16617: if ($form->{'noloadbalance'}) {
16618: my @hosts = &Apache::lonnet::current_machine_ids();
16619: my $hosthere = $form->{'noloadbalance'};
16620: if (grep(/^\Q$hosthere\E$/,@hosts)) {
16621: $initial_env{"user.noloadbalance"} = $hosthere;
16622: $env{'user.noloadbalance'} = $hosthere;
16623: }
16624: }
16625:
1.1016 raeburn 16626: unless ($domain eq 'public') {
1.1075.2.125 raeburn 16627: my %is_adv = ( is_adv => $env{'user.adv'} );
16628: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980 raeburn 16629:
1.1075.2.125 raeburn 16630: foreach my $tool ('aboutme','blog','webdav','portfolio') {
16631: $userenv{'availabletools.'.$tool} =
16632: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
16633: undef,\%userenv,\%domdef,\%is_adv);
16634: }
1.724 raeburn 16635:
1.1075.2.125 raeburn 16636: foreach my $crstype ('official','unofficial','community','textbook') {
16637: $userenv{'canrequest.'.$crstype} =
16638: &Apache::lonnet::usertools_access($username,$domain,$crstype,
16639: 'reload','requestcourses',
16640: \%userenv,\%domdef,\%is_adv);
16641: }
1.765 raeburn 16642:
1.1075.2.125 raeburn 16643: $userenv{'canrequest.author'} =
16644: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
16645: 'reload','requestauthor',
16646: \%userenv,\%domdef,\%is_adv);
16647: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
16648: $domain,$username);
16649: my $reqstatus = $reqauthor{'author_status'};
16650: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
16651: if (ref($reqauthor{'author'}) eq 'HASH') {
16652: $userenv{'requestauthorqueued'} = $reqstatus.':'.
16653: $reqauthor{'author'}{'timestamp'};
16654: }
1.1075.2.14 raeburn 16655: }
16656: }
16657:
1.462 albertel 16658: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 16659:
1.462 albertel 16660: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
16661: &GDBM_WRCREAT(),0640)) {
16662: &_add_to_env(\%disk_env,\%initial_env);
16663: &_add_to_env(\%disk_env,\%userenv,'environment.');
16664: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 16665: if (ref($firstaccenv) eq 'HASH') {
16666: &_add_to_env(\%disk_env,$firstaccenv);
16667: }
16668: if (ref($timerintenv) eq 'HASH') {
16669: &_add_to_env(\%disk_env,$timerintenv);
16670: }
1.463 albertel 16671: if (ref($args->{'extra_env'})) {
16672: &_add_to_env(\%disk_env,$args->{'extra_env'});
16673: }
1.462 albertel 16674: untie(%disk_env);
16675: } else {
1.705 tempelho 16676: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
16677: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 16678: return 'error: '.$!;
16679: }
16680: }
16681: $env{'request.role'}='cm';
16682: $env{'request.role.adv'}=$env{'user.adv'};
16683: $env{'browser.type'}=$clientbrowser;
16684:
16685: return $cookie;
16686:
16687: }
16688:
16689: sub _add_to_env {
16690: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 16691: if (ref($env_data) eq 'HASH') {
16692: while (my ($key,$value) = each(%$env_data)) {
16693: $idf->{$prefix.$key} = $value;
16694: $env{$prefix.$key} = $value;
16695: }
1.462 albertel 16696: }
16697: }
16698:
1.685 tempelho 16699: # --- Get the symbolic name of a problem and the url
16700: sub get_symb {
16701: my ($request,$silent) = @_;
1.726 raeburn 16702: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 16703: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
16704: if ($symb eq '') {
16705: if (!$silent) {
1.1071 raeburn 16706: if (ref($request)) {
16707: $request->print("Unable to handle ambiguous references:$url:.");
16708: }
1.685 tempelho 16709: return ();
16710: }
16711: }
16712: &Apache::lonenc::check_decrypt(\$symb);
16713: return ($symb);
16714: }
16715:
16716: # --------------------------------------------------------------Get annotation
16717:
16718: sub get_annotation {
16719: my ($symb,$enc) = @_;
16720:
16721: my $key = $symb;
16722: if (!$enc) {
16723: $key =
16724: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
16725: }
16726: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
16727: return $annotation{$key};
16728: }
16729:
16730: sub clean_symb {
1.731 raeburn 16731: my ($symb,$delete_enc) = @_;
1.685 tempelho 16732:
16733: &Apache::lonenc::check_decrypt(\$symb);
16734: my $enc = $env{'request.enc'};
1.731 raeburn 16735: if ($delete_enc) {
1.730 raeburn 16736: delete($env{'request.enc'});
16737: }
1.685 tempelho 16738:
16739: return ($symb,$enc);
16740: }
1.462 albertel 16741:
1.1075.2.69 raeburn 16742: ############################################################
16743: ############################################################
16744:
16745: =pod
16746:
16747: =head1 Routines for building display used to search for courses
16748:
16749:
16750: =over 4
16751:
16752: =item * &build_filters()
16753:
16754: Create markup for a table used to set filters to use when selecting
16755: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
16756: and quotacheck.pl
16757:
16758:
16759: Inputs:
16760:
16761: filterlist - anonymous array of fields to include as potential filters
16762:
16763: crstype - course type
16764:
16765: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
16766: to pop-open a course selector (will contain "extra element").
16767:
16768: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
16769:
16770: filter - anonymous hash of criteria and their values
16771:
16772: action - form action
16773:
16774: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
16775:
16776: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
16777:
16778: cloneruname - username of owner of new course who wants to clone
16779:
16780: clonerudom - domain of owner of new course who wants to clone
16781:
16782: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
16783:
16784: codetitlesref - reference to array of titles of components in institutional codes (official courses)
16785:
16786: codedom - domain
16787:
16788: formname - value of form element named "form".
16789:
16790: fixeddom - domain, if fixed.
16791:
16792: prevphase - value to assign to form element named "phase" when going back to the previous screen
16793:
16794: cnameelement - name of form element in form on opener page which will receive title of selected course
16795:
16796: cnumelement - name of form element in form on opener page which will receive courseID of selected course
16797:
16798: cdomelement - name of form element in form on opener page which will receive domain of selected course
16799:
16800: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
16801:
16802: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
16803:
16804: clonewarning - warning message about missing information for intended course owner when DC creates a course
16805:
16806:
16807: Returns: $output - HTML for display of search criteria, and hidden form elements.
16808:
16809:
16810: Side Effects: None
16811:
16812: =cut
16813:
16814: # ---------------------------------------------- search for courses based on last activity etc.
16815:
16816: sub build_filters {
16817: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
16818: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
16819: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
16820: $cnameelement,$cnumelement,$cdomelement,$setroles,
16821: $clonetext,$clonewarning) = @_;
16822: my ($list,$jscript);
16823: my $onchange = 'javascript:updateFilters(this)';
16824: my ($domainselectform,$sincefilterform,$createdfilterform,
16825: $ownerdomselectform,$persondomselectform,$instcodeform,
16826: $typeselectform,$instcodetitle);
16827: if ($formname eq '') {
16828: $formname = $caller;
16829: }
16830: foreach my $item (@{$filterlist}) {
16831: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
16832: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
16833: if ($item eq 'domainfilter') {
16834: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
16835: } elsif ($item eq 'coursefilter') {
16836: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
16837: } elsif ($item eq 'ownerfilter') {
16838: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16839: } elsif ($item eq 'ownerdomfilter') {
16840: $filter->{'ownerdomfilter'} =
16841: &LONCAPA::clean_domain($filter->{$item});
16842: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
16843: 'ownerdomfilter',1);
16844: } elsif ($item eq 'personfilter') {
16845: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16846: } elsif ($item eq 'persondomfilter') {
16847: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
16848: 'persondomfilter',1);
16849: } else {
16850: $filter->{$item} =~ s/\W//g;
16851: }
16852: if (!$filter->{$item}) {
16853: $filter->{$item} = '';
16854: }
16855: }
16856: if ($item eq 'domainfilter') {
16857: my $allow_blank = 1;
16858: if ($formname eq 'portform') {
16859: $allow_blank=0;
16860: } elsif ($formname eq 'studentform') {
16861: $allow_blank=0;
16862: }
16863: if ($fixeddom) {
16864: $domainselectform = '<input type="hidden" name="domainfilter"'.
16865: ' value="'.$codedom.'" />'.
16866: &Apache::lonnet::domain($codedom,'description');
16867: } else {
16868: $domainselectform = &select_dom_form($filter->{$item},
16869: 'domainfilter',
16870: $allow_blank,'',$onchange);
16871: }
16872: } else {
16873: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
16874: }
16875: }
16876:
16877: # last course activity filter and selection
16878: $sincefilterform = &timebased_select_form('sincefilter',$filter);
16879:
16880: # course created filter and selection
16881: if (exists($filter->{'createdfilter'})) {
16882: $createdfilterform = &timebased_select_form('createdfilter',$filter);
16883: }
16884:
16885: my %lt = &Apache::lonlocal::texthash(
16886: 'cac' => "$crstype Activity",
16887: 'ccr' => "$crstype Created",
16888: 'cde' => "$crstype Title",
16889: 'cdo' => "$crstype Domain",
16890: 'ins' => 'Institutional Code',
16891: 'inc' => 'Institutional Categorization',
16892: 'cow' => "$crstype Owner/Co-owner",
16893: 'cop' => "$crstype Personnel Includes",
16894: 'cog' => 'Type',
16895: );
16896:
16897: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
16898: my $typeval = 'Course';
16899: if ($crstype eq 'Community') {
16900: $typeval = 'Community';
16901: }
16902: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
16903: } else {
16904: $typeselectform = '<select name="type" size="1"';
16905: if ($onchange) {
16906: $typeselectform .= ' onchange="'.$onchange.'"';
16907: }
16908: $typeselectform .= '>'."\n";
16909: foreach my $posstype ('Course','Community') {
16910: $typeselectform.='<option value="'.$posstype.'"'.
16911: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
16912: }
16913: $typeselectform.="</select>";
16914: }
16915:
16916: my ($cloneableonlyform,$cloneabletitle);
16917: if (exists($filter->{'cloneableonly'})) {
16918: my $cloneableon = '';
16919: my $cloneableoff = ' checked="checked"';
16920: if ($filter->{'cloneableonly'}) {
16921: $cloneableon = $cloneableoff;
16922: $cloneableoff = '';
16923: }
16924: $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>';
16925: if ($formname eq 'ccrs') {
1.1075.2.71 raeburn 16926: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69 raeburn 16927: } else {
16928: $cloneabletitle = &mt('Cloneable by you');
16929: }
16930: }
16931: my $officialjs;
16932: if ($crstype eq 'Course') {
16933: if (exists($filter->{'instcodefilter'})) {
16934: # if (($fixeddom) || ($formname eq 'requestcrs') ||
16935: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
16936: if ($codedom) {
16937: $officialjs = 1;
16938: ($instcodeform,$jscript,$$numtitlesref) =
16939: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
16940: $officialjs,$codetitlesref);
16941: if ($jscript) {
16942: $jscript = '<script type="text/javascript">'."\n".
16943: '// <![CDATA['."\n".
16944: $jscript."\n".
16945: '// ]]>'."\n".
16946: '</script>'."\n";
16947: }
16948: }
16949: if ($instcodeform eq '') {
16950: $instcodeform =
16951: '<input type="text" name="instcodefilter" size="10" value="'.
16952: $list->{'instcodefilter'}.'" />';
16953: $instcodetitle = $lt{'ins'};
16954: } else {
16955: $instcodetitle = $lt{'inc'};
16956: }
16957: if ($fixeddom) {
16958: $instcodetitle .= '<br />('.$codedom.')';
16959: }
16960: }
16961: }
16962: my $output = qq|
16963: <form method="post" name="filterpicker" action="$action">
16964: <input type="hidden" name="form" value="$formname" />
16965: |;
16966: if ($formname eq 'modifycourse') {
16967: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
16968: '<input type="hidden" name="prevphase" value="'.
16969: $prevphase.'" />'."\n";
1.1075.2.82 raeburn 16970: } elsif ($formname eq 'quotacheck') {
16971: $output .= qq|
16972: <input type="hidden" name="sortby" value="" />
16973: <input type="hidden" name="sortorder" value="" />
16974: |;
16975: } else {
1.1075.2.69 raeburn 16976: my $name_input;
16977: if ($cnameelement ne '') {
16978: $name_input = '<input type="hidden" name="cnameelement" value="'.
16979: $cnameelement.'" />';
16980: }
16981: $output .= qq|
16982: <input type="hidden" name="cnumelement" value="$cnumelement" />
16983: <input type="hidden" name="cdomelement" value="$cdomelement" />
16984: $name_input
16985: $roleelement
16986: $multelement
16987: $typeelement
16988: |;
16989: if ($formname eq 'portform') {
16990: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
16991: }
16992: }
16993: if ($fixeddom) {
16994: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
16995: }
16996: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
16997: if ($sincefilterform) {
16998: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
16999: .$sincefilterform
17000: .&Apache::lonhtmlcommon::row_closure();
17001: }
17002: if ($createdfilterform) {
17003: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
17004: .$createdfilterform
17005: .&Apache::lonhtmlcommon::row_closure();
17006: }
17007: if ($domainselectform) {
17008: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
17009: .$domainselectform
17010: .&Apache::lonhtmlcommon::row_closure();
17011: }
17012: if ($typeselectform) {
17013: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17014: $output .= $typeselectform;
17015: } else {
17016: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
17017: .$typeselectform
17018: .&Apache::lonhtmlcommon::row_closure();
17019: }
17020: }
17021: if ($instcodeform) {
17022: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
17023: .$instcodeform
17024: .&Apache::lonhtmlcommon::row_closure();
17025: }
17026: if (exists($filter->{'ownerfilter'})) {
17027: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
17028: '<table><tr><td>'.&mt('Username').'<br />'.
17029: '<input type="text" name="ownerfilter" size="20" value="'.
17030: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17031: $ownerdomselectform.'</td></tr></table>'.
17032: &Apache::lonhtmlcommon::row_closure();
17033: }
17034: if (exists($filter->{'personfilter'})) {
17035: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
17036: '<table><tr><td>'.&mt('Username').'<br />'.
17037: '<input type="text" name="personfilter" size="20" value="'.
17038: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17039: $persondomselectform.'</td></tr></table>'.
17040: &Apache::lonhtmlcommon::row_closure();
17041: }
17042: if (exists($filter->{'coursefilter'})) {
17043: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
17044: .'<input type="text" name="coursefilter" size="25" value="'
17045: .$list->{'coursefilter'}.'" />'
17046: .&Apache::lonhtmlcommon::row_closure();
17047: }
17048: if ($cloneableonlyform) {
17049: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
17050: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
17051: }
17052: if (exists($filter->{'descriptfilter'})) {
17053: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
17054: .'<input type="text" name="descriptfilter" size="40" value="'
17055: .$list->{'descriptfilter'}.'" />'
17056: .&Apache::lonhtmlcommon::row_closure(1);
17057: }
17058: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
17059: '<input type="hidden" name="updater" value="" />'."\n".
17060: '<input type="submit" name="gosearch" value="'.
17061: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
17062: return $jscript.$clonewarning.$output;
17063: }
17064:
17065: =pod
17066:
17067: =item * &timebased_select_form()
17068:
17069: Create markup for a dropdown list used to select a time-based
17070: filter e.g., Course Activity, Course Created, when searching for courses
17071: or communities
17072:
17073: Inputs:
17074:
17075: item - name of form element (sincefilter or createdfilter)
17076:
17077: filter - anonymous hash of criteria and their values
17078:
17079: Returns: HTML for a select box contained a blank, then six time selections,
17080: with value set in incoming form variables currently selected.
17081:
17082: Side Effects: None
17083:
17084: =cut
17085:
17086: sub timebased_select_form {
17087: my ($item,$filter) = @_;
17088: if (ref($filter) eq 'HASH') {
17089: $filter->{$item} =~ s/[^\d-]//g;
17090: if (!$filter->{$item}) { $filter->{$item}=-1; }
17091: return &select_form(
17092: $filter->{$item},
17093: $item,
17094: { '-1' => '',
17095: '86400' => &mt('today'),
17096: '604800' => &mt('last week'),
17097: '2592000' => &mt('last month'),
17098: '7776000' => &mt('last three months'),
17099: '15552000' => &mt('last six months'),
17100: '31104000' => &mt('last year'),
17101: 'select_form_order' =>
17102: ['-1','86400','604800','2592000','7776000',
17103: '15552000','31104000']});
17104: }
17105: }
17106:
17107: =pod
17108:
17109: =item * &js_changer()
17110:
17111: Create script tag containing Javascript used to submit course search form
17112: when course type or domain is changed, and also to hide 'Searching ...' on
17113: page load completion for page showing search result.
17114:
17115: Inputs: None
17116:
17117: Returns: markup containing updateFilters() and hideSearching() javascript functions.
17118:
17119: Side Effects: None
17120:
17121: =cut
17122:
17123: sub js_changer {
17124: return <<ENDJS;
17125: <script type="text/javascript">
17126: // <![CDATA[
17127: function updateFilters(caller) {
17128: if (typeof(caller) != "undefined") {
17129: document.filterpicker.updater.value = caller.name;
17130: }
17131: document.filterpicker.submit();
17132: }
17133:
17134: function hideSearching() {
17135: if (document.getElementById('searching')) {
17136: document.getElementById('searching').style.display = 'none';
17137: }
17138: return;
17139: }
17140:
17141: // ]]>
17142: </script>
17143:
17144: ENDJS
17145: }
17146:
17147: =pod
17148:
17149: =item * &search_courses()
17150:
17151: Process selected filters form course search form and pass to lonnet::courseiddump
17152: to retrieve a hash for which keys are courseIDs which match the selected filters.
17153:
17154: Inputs:
17155:
17156: dom - domain being searched
17157:
17158: type - course type ('Course' or 'Community' or '.' if any).
17159:
17160: filter - anonymous hash of criteria and their values
17161:
17162: numtitles - for institutional codes - number of categories
17163:
17164: cloneruname - optional username of new course owner
17165:
17166: clonerudom - optional domain of new course owner
17167:
1.1075.2.95 raeburn 17168: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69 raeburn 17169: (used when DC is using course creation form)
17170:
17171: codetitles - reference to array of titles of components in institutional codes (official courses).
17172:
1.1075.2.95 raeburn 17173: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
17174: (and so can clone automatically)
17175:
17176: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
17177:
17178: reqinstcode - institutional code of new course, where search_courses is used to identify potential
17179: courses to clone
1.1075.2.69 raeburn 17180:
17181: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
17182:
17183:
17184: Side Effects: None
17185:
17186: =cut
17187:
17188:
17189: sub search_courses {
1.1075.2.95 raeburn 17190: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
17191: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69 raeburn 17192: my (%courses,%showcourses,$cloner);
17193: if (($filter->{'ownerfilter'} ne '') ||
17194: ($filter->{'ownerdomfilter'} ne '')) {
17195: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
17196: $filter->{'ownerdomfilter'};
17197: }
17198: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
17199: if (!$filter->{$item}) {
17200: $filter->{$item}='.';
17201: }
17202: }
17203: my $now = time;
17204: my $timefilter =
17205: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
17206: my ($createdbefore,$createdafter);
17207: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
17208: $createdbefore = $now;
17209: $createdafter = $now-$filter->{'createdfilter'};
17210: }
17211: my ($instcodefilter,$regexpok);
17212: if ($numtitles) {
17213: if ($env{'form.official'} eq 'on') {
17214: $instcodefilter =
17215: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17216: $regexpok = 1;
17217: } elsif ($env{'form.official'} eq 'off') {
17218: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17219: unless ($instcodefilter eq '') {
17220: $regexpok = -1;
17221: }
17222: }
17223: } else {
17224: $instcodefilter = $filter->{'instcodefilter'};
17225: }
17226: if ($instcodefilter eq '') { $instcodefilter = '.'; }
17227: if ($type eq '') { $type = '.'; }
17228:
17229: if (($clonerudom ne '') && ($cloneruname ne '')) {
17230: $cloner = $cloneruname.':'.$clonerudom;
17231: }
17232: %courses = &Apache::lonnet::courseiddump($dom,
17233: $filter->{'descriptfilter'},
17234: $timefilter,
17235: $instcodefilter,
17236: $filter->{'combownerfilter'},
17237: $filter->{'coursefilter'},
17238: undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95 raeburn 17239: undef,undef,$cloner,$cc_clone,
1.1075.2.69 raeburn 17240: $filter->{'cloneableonly'},
17241: $createdbefore,$createdafter,undef,
1.1075.2.95 raeburn 17242: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69 raeburn 17243: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
17244: my $ccrole;
17245: if ($type eq 'Community') {
17246: $ccrole = 'co';
17247: } else {
17248: $ccrole = 'cc';
17249: }
17250: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
17251: $filter->{'persondomfilter'},
17252: 'userroles',undef,
17253: [$ccrole,'in','ad','ep','ta','cr'],
17254: $dom);
17255: foreach my $role (keys(%rolehash)) {
17256: my ($cnum,$cdom,$courserole) = split(':',$role);
17257: my $cid = $cdom.'_'.$cnum;
17258: if (exists($courses{$cid})) {
17259: if (ref($courses{$cid}) eq 'HASH') {
17260: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
17261: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119 raeburn 17262: push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69 raeburn 17263: }
17264: } else {
17265: $courses{$cid}{roles} = [$courserole];
17266: }
17267: $showcourses{$cid} = $courses{$cid};
17268: }
17269: }
17270: }
17271: %courses = %showcourses;
17272: }
17273: return %courses;
17274: }
17275:
17276: =pod
17277:
17278: =back
17279:
1.1075.2.88 raeburn 17280: =head1 Routines for version requirements for current course.
17281:
17282: =over 4
17283:
17284: =item * &check_release_required()
17285:
17286: Compares required LON-CAPA version with version on server, and
17287: if required version is newer looks for a server with the required version.
17288:
17289: Looks first at servers in user's owen domain; if none suitable, looks at
17290: servers in course's domain are permitted to host sessions for user's domain.
17291:
17292: Inputs:
17293:
17294: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17295:
17296: $courseid - Course ID of current course
17297:
17298: $rolecode - User's current role in course (for switchserver query string).
17299:
17300: $required - LON-CAPA version needed by course (format: Major.Minor).
17301:
17302:
17303: Returns:
17304:
17305: $switchserver - query string tp append to /adm/switchserver call (if
17306: current server's LON-CAPA version is too old.
17307:
17308: $warning - Message is displayed if no suitable server could be found.
17309:
17310: =cut
17311:
17312: sub check_release_required {
17313: my ($loncaparev,$courseid,$rolecode,$required) = @_;
17314: my ($switchserver,$warning);
17315: if ($required ne '') {
17316: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
17317: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17318: if ($reqdmajor ne '' && $reqdminor ne '') {
17319: my $otherserver;
17320: if (($major eq '' && $minor eq '') ||
17321: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
17322: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
17323: my $switchlcrev =
17324: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
17325: $userdomserver);
17326: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17327: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
17328: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
17329: my $cdom = $env{'course.'.$courseid.'.domain'};
17330: if ($cdom ne $env{'user.domain'}) {
17331: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
17332: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
17333: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17334: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
17335: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
17336: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
17337: my $canhost =
17338: &Apache::lonnet::can_host_session($env{'user.domain'},
17339: $coursedomserver,
17340: $remoterev,
17341: $udomdefaults{'remotesessions'},
17342: $defdomdefaults{'hostedsessions'});
17343:
17344: if ($canhost) {
17345: $otherserver = $coursedomserver;
17346: } else {
17347: $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.");
17348: }
17349: } else {
17350: $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).");
17351: }
17352: } else {
17353: $otherserver = $userdomserver;
17354: }
17355: }
17356: if ($otherserver ne '') {
17357: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
17358: }
17359: }
17360: }
17361: return ($switchserver,$warning);
17362: }
17363:
17364: =pod
17365:
17366: =item * &check_release_result()
17367:
17368: Inputs:
17369:
17370: $switchwarning - Warning message if no suitable server found to host session.
17371:
17372: $switchserver - query string to append to /adm/switchserver containing lonHostID
17373: and current role.
17374:
17375: Returns: HTML to display with information about requirement to switch server.
17376: Either displaying warning with link to Roles/Courses screen or
17377: display link to switchserver.
17378:
1.1075.2.69 raeburn 17379: =cut
17380:
1.1075.2.88 raeburn 17381: sub check_release_result {
17382: my ($switchwarning,$switchserver) = @_;
17383: my $output = &start_page('Selected course unavailable on this server').
17384: '<p class="LC_warning">';
17385: if ($switchwarning) {
17386: $output .= $switchwarning.'<br /><a href="/adm/roles">';
17387: if (&show_course()) {
17388: $output .= &mt('Display courses');
17389: } else {
17390: $output .= &mt('Display roles');
17391: }
17392: $output .= '</a>';
17393: } elsif ($switchserver) {
17394: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
17395: '<br />'.
17396: '<a href="/adm/switchserver?'.$switchserver.'">'.
17397: &mt('Switch Server').
17398: '</a>';
17399: }
17400: $output .= '</p>'.&end_page();
17401: return $output;
17402: }
17403:
17404: =pod
17405:
17406: =item * &needs_coursereinit()
17407:
17408: Determine if course contents stored for user's session needs to be
17409: refreshed, because content has changed since "Big Hash" last tied.
17410:
17411: Check for change is made if time last checked is more than 10 minutes ago
17412: (by default).
17413:
17414: Inputs:
17415:
17416: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17417:
17418: $interval (optional) - Time which may elapse (in s) between last check for content
17419: change in current course. (default: 600 s).
17420:
17421: Returns: an array; first element is:
17422:
17423: =over 4
17424:
17425: 'switch' - if content updates mean user's session
17426: needs to be switched to a server running a newer LON-CAPA version
17427:
17428: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
17429: on current server hosting user's session
17430:
17431: '' - if no action required.
17432:
17433: =back
17434:
17435: If first item element is 'switch':
17436:
17437: second item is $switchwarning - Warning message if no suitable server found to host session.
17438:
17439: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
17440: and current role.
17441:
17442: otherwise: no other elements returned.
17443:
17444: =back
17445:
17446: =cut
17447:
17448: sub needs_coursereinit {
17449: my ($loncaparev,$interval) = @_;
17450: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
17451: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17452: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
17453: my $now = time;
17454: if ($interval eq '') {
17455: $interval = 600;
17456: }
17457: if (($now-$env{'request.course.timechecked'})>$interval) {
17458: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.161. .4(raebu 17459:22): my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
.1(raebu 17460:21): if ($blocked) {
17461:21): return ();
17462:21): }
17463:21): my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88 raeburn 17464: if ($lastchange > $env{'request.course.tied'}) {
17465: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17466: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
17467: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
17468: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
17469: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
17470: $curr_reqd_hash{'internal.releaserequired'}});
17471: my ($switchserver,$switchwarning) =
17472: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
17473: $curr_reqd_hash{'internal.releaserequired'});
17474: if ($switchwarning ne '' || $switchserver ne '') {
17475: return ('switch',$switchwarning,$switchserver);
17476: }
17477: }
17478: }
17479: return ('update');
17480: }
17481: }
17482: return ();
17483: }
1.1075.2.69 raeburn 17484:
1.1075.2.11 raeburn 17485: sub update_content_constraints {
17486: my ($cdom,$cnum,$chome,$cid) = @_;
17487: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17488: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
17489: my %checkresponsetypes;
17490: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
17491: my ($item,$name,$value) = split(/:/,$key);
17492: if ($item eq 'resourcetag') {
17493: if ($name eq 'responsetype') {
17494: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
17495: }
17496: }
17497: }
17498: my $navmap = Apache::lonnavmaps::navmap->new();
17499: if (defined($navmap)) {
17500: my %allresponses;
17501: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
17502: my %responses = $res->responseTypes();
17503: foreach my $key (keys(%responses)) {
17504: next unless(exists($checkresponsetypes{$key}));
17505: $allresponses{$key} += $responses{$key};
17506: }
17507: }
17508: foreach my $key (keys(%allresponses)) {
17509: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
17510: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17511: ($reqdmajor,$reqdminor) = ($major,$minor);
17512: }
17513: }
17514: undef($navmap);
17515: }
17516: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
17517: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
17518: }
17519: return;
17520: }
17521:
1.1075.2.27 raeburn 17522: sub allmaps_incourse {
17523: my ($cdom,$cnum,$chome,$cid) = @_;
17524: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
17525: $cid = $env{'request.course.id'};
17526: $cdom = $env{'course.'.$cid.'.domain'};
17527: $cnum = $env{'course.'.$cid.'.num'};
17528: $chome = $env{'course.'.$cid.'.home'};
17529: }
17530: my %allmaps = ();
17531: my $lastchange =
17532: &Apache::lonnet::get_coursechange($cdom,$cnum);
17533: if ($lastchange > $env{'request.course.tied'}) {
17534: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
17535: unless ($ferr) {
17536: &update_content_constraints($cdom,$cnum,$chome,$cid);
17537: }
17538: }
17539: my $navmap = Apache::lonnavmaps::navmap->new();
17540: if (defined($navmap)) {
17541: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
17542: $allmaps{$res->src()} = 1;
17543: }
17544: }
17545: return \%allmaps;
17546: }
17547:
1.1075.2.11 raeburn 17548: sub parse_supplemental_title {
17549: my ($title) = @_;
17550:
17551: my ($foldertitle,$renametitle);
17552: if ($title =~ /&&&/) {
17553: $title = &HTML::Entites::decode($title);
17554: }
17555: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
17556: $renametitle=$4;
17557: my ($time,$uname,$udom) = ($1,$2,$3);
17558: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
17559: my $name = &plainname($uname,$udom);
17560: $name = &HTML::Entities::encode($name,'"<>&\'');
17561: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
17562: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
17563: $name.': <br />'.$foldertitle;
17564: }
17565: if (wantarray) {
17566: return ($title,$foldertitle,$renametitle);
17567: }
17568: return $title;
17569: }
17570:
1.1075.2.43 raeburn 17571: sub recurse_supplemental {
17572: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
17573: if ($suppmap) {
17574: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
17575: if ($fatal) {
17576: $errors ++;
17577: } else {
17578: if ($#LONCAPA::map::resources > 0) {
17579: foreach my $res (@LONCAPA::map::resources) {
17580: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
17581: if (($src ne '') && ($status eq 'res')) {
1.1075.2.46 raeburn 17582: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
17583: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43 raeburn 17584: } else {
17585: $numfiles ++;
17586: }
17587: }
17588: }
17589: }
17590: }
17591: }
17592: return ($numfiles,$errors);
17593: }
17594:
1.1075.2.18 raeburn 17595: sub symb_to_docspath {
1.1075.2.119 raeburn 17596: my ($symb,$navmapref) = @_;
17597: return unless ($symb && ref($navmapref));
1.1075.2.18 raeburn 17598: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
17599: if ($resurl=~/\.(sequence|page)$/) {
17600: $mapurl=$resurl;
17601: } elsif ($resurl eq 'adm/navmaps') {
17602: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
17603: }
17604: my $mapresobj;
1.1075.2.119 raeburn 17605: unless (ref($$navmapref)) {
17606: $$navmapref = Apache::lonnavmaps::navmap->new();
17607: }
17608: if (ref($$navmapref)) {
17609: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18 raeburn 17610: }
17611: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
17612: my $type=$2;
17613: my $path;
17614: if (ref($mapresobj)) {
17615: my $pcslist = $mapresobj->map_hierarchy();
17616: if ($pcslist ne '') {
17617: foreach my $pc (split(/,/,$pcslist)) {
17618: next if ($pc <= 1);
1.1075.2.119 raeburn 17619: my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18 raeburn 17620: if (ref($res)) {
17621: my $thisurl = $res->src();
17622: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
17623: my $thistitle = $res->title();
17624: $path .= '&'.
17625: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46 raeburn 17626: &escape($thistitle).
1.1075.2.18 raeburn 17627: ':'.$res->randompick().
17628: ':'.$res->randomout().
17629: ':'.$res->encrypted().
17630: ':'.$res->randomorder().
17631: ':'.$res->is_page();
17632: }
17633: }
17634: }
17635: $path =~ s/^\&//;
17636: my $maptitle = $mapresobj->title();
17637: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 17638: $maptitle = 'Main Content';
1.1075.2.18 raeburn 17639: }
17640: $path .= (($path ne '')? '&' : '').
17641: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 17642: &escape($maptitle).
1.1075.2.18 raeburn 17643: ':'.$mapresobj->randompick().
17644: ':'.$mapresobj->randomout().
17645: ':'.$mapresobj->encrypted().
17646: ':'.$mapresobj->randomorder().
17647: ':'.$mapresobj->is_page();
17648: } else {
17649: my $maptitle = &Apache::lonnet::gettitle($mapurl);
17650: my $ispage = (($type eq 'page')? 1 : '');
17651: if ($mapurl eq 'default') {
1.1075.2.38 raeburn 17652: $maptitle = 'Main Content';
1.1075.2.18 raeburn 17653: }
17654: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46 raeburn 17655: &escape($maptitle).':::::'.$ispage;
1.1075.2.18 raeburn 17656: }
17657: unless ($mapurl eq 'default') {
17658: $path = 'default&'.
1.1075.2.46 raeburn 17659: &escape('Main Content').
1.1075.2.18 raeburn 17660: ':::::&'.$path;
17661: }
17662: return $path;
17663: }
17664:
1.1075.2.14 raeburn 17665: sub captcha_display {
1.1075.2.137 raeburn 17666: my ($context,$lonhost,$defdom) = @_;
1.1075.2.14 raeburn 17667: my ($output,$error);
1.1075.2.107 raeburn 17668: my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137 raeburn 17669: &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14 raeburn 17670: if ($captcha eq 'original') {
17671: $output = &create_captcha();
17672: unless ($output) {
17673: $error = 'captcha';
17674: }
17675: } elsif ($captcha eq 'recaptcha') {
1.1075.2.107 raeburn 17676: $output = &create_recaptcha($pubkey,$version);
1.1075.2.14 raeburn 17677: unless ($output) {
17678: $error = 'recaptcha';
17679: }
17680: }
1.1075.2.107 raeburn 17681: return ($output,$error,$captcha,$version);
1.1075.2.14 raeburn 17682: }
17683:
17684: sub captcha_response {
1.1075.2.137 raeburn 17685: my ($context,$lonhost,$defdom) = @_;
1.1075.2.14 raeburn 17686: my ($captcha_chk,$captcha_error);
1.1075.2.137 raeburn 17687: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14 raeburn 17688: if ($captcha eq 'original') {
17689: ($captcha_chk,$captcha_error) = &check_captcha();
17690: } elsif ($captcha eq 'recaptcha') {
1.1075.2.107 raeburn 17691: $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14 raeburn 17692: } else {
17693: $captcha_chk = 1;
17694: }
17695: return ($captcha_chk,$captcha_error);
17696: }
17697:
17698: sub get_captcha_config {
1.1075.2.137 raeburn 17699: my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107 raeburn 17700: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14 raeburn 17701: my $hostname = &Apache::lonnet::hostname($lonhost);
17702: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
17703: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17704: if ($context eq 'usercreation') {
17705: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
17706: if (ref($domconfig{$context}) eq 'HASH') {
17707: $hashtocheck = $domconfig{$context}{'cancreate'};
17708: if (ref($hashtocheck) eq 'HASH') {
17709: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
17710: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
17711: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
17712: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
17713: }
17714: if ($privkey && $pubkey) {
17715: $captcha = 'recaptcha';
1.1075.2.107 raeburn 17716: $version = $hashtocheck->{'recaptchaversion'};
17717: if ($version ne '2') {
17718: $version = 1;
17719: }
1.1075.2.14 raeburn 17720: } else {
17721: $captcha = 'original';
17722: }
17723: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
17724: $captcha = 'original';
17725: }
17726: }
17727: } else {
17728: $captcha = 'captcha';
17729: }
17730: } elsif ($context eq 'login') {
17731: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
17732: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
17733: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
17734: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
17735: if ($privkey && $pubkey) {
17736: $captcha = 'recaptcha';
1.1075.2.107 raeburn 17737: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
17738: if ($version ne '2') {
17739: $version = 1;
17740: }
1.1075.2.14 raeburn 17741: } else {
17742: $captcha = 'original';
17743: }
17744: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
17745: $captcha = 'original';
17746: }
1.1075.2.137 raeburn 17747: } elsif ($context eq 'passwords') {
17748: if ($dom_in_effect) {
17749: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
17750: if ($passwdconf{'captcha'} eq 'recaptcha') {
17751: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
17752: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
17753: $privkey = $passwdconf{'recaptchakeys'}{'private'};
17754: }
17755: if ($privkey && $pubkey) {
17756: $captcha = 'recaptcha';
17757: $version = $passwdconf{'recaptchaversion'};
17758: if ($version ne '2') {
17759: $version = 1;
17760: }
17761: } else {
17762: $captcha = 'original';
17763: }
17764: } elsif ($passwdconf{'captcha'} ne 'notused') {
17765: $captcha = 'original';
17766: }
17767: }
1.1075.2.14 raeburn 17768: }
1.1075.2.107 raeburn 17769: return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14 raeburn 17770: }
17771:
17772: sub create_captcha {
17773: my %captcha_params = &captcha_settings();
17774: my ($output,$maxtries,$tries) = ('',10,0);
17775: while ($tries < $maxtries) {
17776: $tries ++;
17777: my $captcha = Authen::Captcha->new (
17778: output_folder => $captcha_params{'output_dir'},
17779: data_folder => $captcha_params{'db_dir'},
17780: );
17781: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
17782:
17783: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
17784: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158 raeburn 17785: '<span class="LC_nobreak">'.
1.1075.2.14 raeburn 17786: &mt('Type in the letters/numbers shown below').' '.
1.1075.2.66 raeburn 17787: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
1.1075.2.158 raeburn 17788: '</span><br />'.
1.1075.2.66 raeburn 17789: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14 raeburn 17790: last;
17791: }
17792: }
1.1075.2.158 raeburn 17793: if ($output eq '') {
17794: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
17795: }
1.1075.2.14 raeburn 17796: return $output;
17797: }
17798:
17799: sub captcha_settings {
17800: my %captcha_params = (
17801: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
17802: www_output_dir => "/captchaspool",
17803: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
17804: numchars => '5',
17805: );
17806: return %captcha_params;
17807: }
17808:
17809: sub check_captcha {
17810: my ($captcha_chk,$captcha_error);
17811: my $code = $env{'form.code'};
17812: my $md5sum = $env{'form.crypt'};
17813: my %captcha_params = &captcha_settings();
17814: my $captcha = Authen::Captcha->new(
17815: output_folder => $captcha_params{'output_dir'},
17816: data_folder => $captcha_params{'db_dir'},
17817: );
1.1075.2.26 raeburn 17818: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14 raeburn 17819: my %captcha_hash = (
17820: 0 => 'Code not checked (file error)',
17821: -1 => 'Failed: code expired',
17822: -2 => 'Failed: invalid code (not in database)',
17823: -3 => 'Failed: invalid code (code does not match crypt)',
17824: );
17825: if ($captcha_chk != 1) {
17826: $captcha_error = $captcha_hash{$captcha_chk}
17827: }
17828: return ($captcha_chk,$captcha_error);
17829: }
17830:
17831: sub create_recaptcha {
1.1075.2.107 raeburn 17832: my ($pubkey,$version) = @_;
17833: if ($version >= 2) {
1.1075.2.158 raeburn 17834: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
17835: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107 raeburn 17836: } else {
17837: my $use_ssl;
17838: if ($ENV{'SERVER_PORT'} == 443) {
17839: $use_ssl = 1;
17840: }
17841: my $captcha = Captcha::reCAPTCHA->new;
17842: return $captcha->get_options_setter({theme => 'white'})."\n".
17843: $captcha->get_html($pubkey,undef,$use_ssl).
17844: &mt('If the text is hard to read, [_1] will replace them.',
17845: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
17846: '<br /><br />';
17847: }
1.1075.2.14 raeburn 17848: }
17849:
17850: sub check_recaptcha {
1.1075.2.107 raeburn 17851: my ($privkey,$version) = @_;
1.1075.2.14 raeburn 17852: my $captcha_chk;
1.1075.2.150 raeburn 17853: my $ip = &Apache::lonnet::get_requestor_ip();
1.1075.2.107 raeburn 17854: if ($version >= 2) {
17855: my $ua = LWP::UserAgent->new;
17856: $ua->timeout(10);
17857: my %info = (
17858: secret => $privkey,
17859: response => $env{'form.g-recaptcha-response'},
1.1075.2.150 raeburn 17860: remoteip => $ip,
1.1075.2.107 raeburn 17861: );
17862: my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
17863: if ($response->is_success) {
17864: my $data = JSON::DWIW->from_json($response->decoded_content);
17865: if (ref($data) eq 'HASH') {
17866: if ($data->{'success'}) {
17867: $captcha_chk = 1;
17868: }
17869: }
17870: }
17871: } else {
17872: my $captcha = Captcha::reCAPTCHA->new;
17873: my $captcha_result =
17874: $captcha->check_answer(
17875: $privkey,
1.1075.2.150 raeburn 17876: $ip,
1.1075.2.107 raeburn 17877: $env{'form.recaptcha_challenge_field'},
17878: $env{'form.recaptcha_response_field'},
17879: );
17880: if ($captcha_result->{is_valid}) {
17881: $captcha_chk = 1;
17882: }
1.1075.2.14 raeburn 17883: }
17884: return $captcha_chk;
17885: }
17886:
1.1075.2.64 raeburn 17887: sub emailusername_info {
1.1075.2.103 raeburn 17888: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64 raeburn 17889: my %titles = &Apache::lonlocal::texthash (
17890: lastname => 'Last Name',
17891: firstname => 'First Name',
17892: institution => 'School/college/university',
17893: location => "School's city, state/province, country",
17894: web => "School's web address",
17895: officialemail => 'E-mail address at institution (if different)',
1.1075.2.103 raeburn 17896: id => 'Student/Employee ID',
1.1075.2.64 raeburn 17897: );
17898: return (\@fields,\%titles);
17899: }
17900:
1.1075.2.56 raeburn 17901: sub cleanup_html {
17902: my ($incoming) = @_;
17903: my $outgoing;
17904: if ($incoming ne '') {
17905: $outgoing = $incoming;
17906: $outgoing =~ s/;/;/g;
17907: $outgoing =~ s/\#/#/g;
17908: $outgoing =~ s/\&/&/g;
17909: $outgoing =~ s/</</g;
17910: $outgoing =~ s/>/>/g;
17911: $outgoing =~ s/\(/(/g;
17912: $outgoing =~ s/\)/)/g;
17913: $outgoing =~ s/"/"/g;
17914: $outgoing =~ s/'/'/g;
17915: $outgoing =~ s/\$/$/g;
17916: $outgoing =~ s{/}{/}g;
17917: $outgoing =~ s/=/=/g;
17918: $outgoing =~ s/\\/\/g
17919: }
17920: return $outgoing;
17921: }
17922:
1.1075.2.74 raeburn 17923: # Checks for critical messages and returns a redirect url if one exists.
17924: # $interval indicates how often to check for messages.
1.1075.2.161. .1(raebu 17925:21): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74 raeburn 17926: sub critical_redirect {
1.1075.2.161. .1(raebu 17927:21): my ($interval,$context) = @_;
1.1075.2.158 raeburn 17928: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
17929: return ();
17930: }
1.1075.2.74 raeburn 17931: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.161. .1(raebu 17932:21): if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
17933:21): my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17934:21): my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
.4(raebu 17935:22): my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
.1(raebu 17936:21): if ($blocked) {
17937:21): my $checkrole = "cm./$cdom/$cnum";
17938:21): if ($env{'request.course.sec'} ne '') {
17939:21): $checkrole .= "/$env{'request.course.sec'}";
17940:21): }
17941:21): unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
17942:21): ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
17943:21): return;
17944:21): }
17945:21): }
17946:21): }
1.1075.2.74 raeburn 17947: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
17948: $env{'user.name'});
17949: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
17950: my $redirecturl;
17951: if ($what[0]) {
1.1075.2.158 raeburn 17952: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74 raeburn 17953: $redirecturl='/adm/email?critical=display';
17954: my $url=&Apache::lonnet::absolute_url().$redirecturl;
17955: return (1, $url);
17956: }
17957: }
17958: }
17959: return ();
17960: }
17961:
1.1075.2.64 raeburn 17962: # Use:
17963: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
17964: #
17965: ##################################################
17966: # password associated functions #
17967: ##################################################
17968: sub des_keys {
17969: # Make a new key for DES encryption.
17970: # Each key has two parts which are returned separately.
17971: # Please note: Each key must be passed through the &hex function
17972: # before it is output to the web browser. The hex versions cannot
17973: # be used to decrypt.
17974: my @hexstr=('0','1','2','3','4','5','6','7',
17975: '8','9','a','b','c','d','e','f');
17976: my $lkey='';
17977: for (0..7) {
17978: $lkey.=$hexstr[rand(15)];
17979: }
17980: my $ukey='';
17981: for (0..7) {
17982: $ukey.=$hexstr[rand(15)];
17983: }
17984: return ($lkey,$ukey);
17985: }
17986:
17987: sub des_decrypt {
17988: my ($key,$cyphertext) = @_;
17989: my $keybin=pack("H16",$key);
17990: my $cypher;
17991: if ($Crypt::DES::VERSION>=2.03) {
17992: $cypher=new Crypt::DES $keybin;
17993: } else {
17994: $cypher=new DES $keybin;
17995: }
1.1075.2.106 raeburn 17996: my $plaintext='';
17997: my $cypherlength = length($cyphertext);
17998: my $numchunks = int($cypherlength/32);
17999: for (my $j=0; $j<$numchunks; $j++) {
18000: my $start = $j*32;
18001: my $cypherblock = substr($cyphertext,$start,32);
18002: my $chunk =
18003: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
18004: $chunk .=
18005: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
18006: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
18007: $plaintext .= $chunk;
18008: }
1.1075.2.64 raeburn 18009: return $plaintext;
18010: }
18011:
1.1075.2.161. .1(raebu 18012:21): sub get_requested_shorturls {
18013:21): my ($cdom,$cnum,$navmap) = @_;
18014:21): return unless (ref($navmap));
18015:21): my ($numnew,$errors);
18016:21): my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
18017:21): if (@toshorten) {
18018:21): my (%maps,%resources,%titles);
18019:21): &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
18020:21): 'shorturls',$cdom,$cnum);
18021:21): if (keys(%resources)) {
18022:21): my %tocreate;
18023:21): foreach my $item (sort {$a <=> $b} (@toshorten)) {
18024:21): my $symb = $resources{$item};
18025:21): if ($symb) {
18026:21): $tocreate{$cnum.'&'.$symb} = 1;
18027:21): }
18028:21): }
18029:21): if (keys(%tocreate)) {
18030:21): ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
18031:21): \%tocreate);
18032:21): }
18033:21): }
18034:21): }
18035:21): return ($numnew,$errors);
18036:21): }
18037:21):
18038:21): sub make_short_symbs {
18039:21): my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
18040:21): my ($numnew,@errors);
18041:21): if (ref($tocreateref) eq 'HASH') {
18042:21): my %tocreate = %{$tocreateref};
18043:21): if (keys(%tocreate)) {
18044:21): my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
18045:21): my $su = Short::URL->new(no_vowels => 1);
18046:21): my $init = '';
18047:21): my (%newunique,%addcourse,%courseonly,%failed);
18048:21): # get lock on tiny db
18049:21): my $now = time;
18050:21): if ($lockuser eq '') {
18051:21): $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
18052:21): }
18053:21): my $lockhash = {
18054:21): "lock\0$now" => $lockuser,
18055:21): };
18056:21): my $tries = 0;
18057:21): my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
18058:21): my ($code,$error);
18059:21): while (($gotlock ne 'ok') && ($tries<3)) {
18060:21): $tries ++;
18061:21): sleep 1;
18062:21): $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
18063:21): }
18064:21): if ($gotlock eq 'ok') {
18065:21): $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
18066:21): \%addcourse,\%courseonly,\%failed);
18067:21): if (keys(%failed)) {
18068:21): my $numfailed = scalar(keys(%failed));
18069:21): push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
18070:21): }
18071:21): if (keys(%newunique)) {
18072:21): my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
18073:21): if ($putres eq 'ok') {
18074:21): $numnew = scalar(keys(%newunique));
18075:21): my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
18076:21): unless ($newputres eq 'ok') {
18077:21): push(@errors,&mt('error: could not store course look-up of short URLs'));
18078:21): }
18079:21): } else {
18080:21): push(@errors,&mt('error: could not store unique six character URLs'));
18081:21): }
18082:21): }
18083:21): my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
18084:21): unless ($dellockres eq 'ok') {
18085:21): push(@errors,&mt('error: could not release lockfile'));
18086:21): }
18087:21): } else {
18088:21): push(@errors,&mt('error: could not obtain lockfile'));
18089:21): }
18090:21): if (keys(%courseonly)) {
18091:21): my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
18092:21): if ($result ne 'ok') {
18093:21): push(@errors,&mt('error: could not update course look-up of short URLs'));
18094:21): }
18095:21): }
18096:21): }
18097:21): }
18098:21): return ($numnew,\@errors);
18099:21): }
18100:21):
18101:21): sub shorten_symbs {
18102:21): my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
18103:21): return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
18104:21): (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
18105:21): (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
18106:21): my (%possibles,%collisions);
18107:21): foreach my $key (keys(%{$tocreate})) {
18108:21): my $num = String::CRC32::crc32($key);
18109:21): my $tiny = $su->encode($num,$init);
18110:21): if ($tiny) {
18111:21): $possibles{$tiny} = $key;
18112:21): }
18113:21): }
18114:21): if (!$init) {
18115:21): $init = 1;
18116:21): } else {
18117:21): $init ++;
18118:21): }
18119:21): if (keys(%possibles)) {
18120:21): my @posstiny = keys(%possibles);
18121:21): my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
18122:21): my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
18123:21): if (keys(%currtiny)) {
18124:21): foreach my $key (keys(%currtiny)) {
18125:21): next if ($currtiny{$key} eq '');
18126:21): if ($currtiny{$key} eq $possibles{$key}) {
18127:21): my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
18128:21): unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18129:21): $courseonly->{$tsymb} = $key;
18130:21): }
18131:21): } else {
18132:21): $collisions{$possibles{$key}} = 1;
18133:21): }
18134:21): delete($possibles{$key});
18135:21): }
18136:21): }
18137:21): foreach my $key (keys(%possibles)) {
18138:21): $newunique->{$key} = $possibles{$key};
18139:21): my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
18140:21): unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18141:21): $addcourse->{$tsymb} = $key;
18142:21): }
18143:21): }
18144:21): }
18145:21): if (keys(%collisions)) {
18146:21): if ($init <5) {
18147:21): if (!$init) {
18148:21): $init = 1;
18149:21): } else {
18150:21): $init ++;
18151:21): }
18152:21): $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
18153:21): $newunique,$addcourse,$courseonly,$failed);
18154:21): } else {
18155:21): foreach my $key (keys(%collisions)) {
18156:21): $failed->{$key} = 1;
18157:21): $failed->{$key} = 1;
18158:21): }
18159:21): }
18160:21): }
18161:21): return $init;
18162:21): }
18163:21):
1.1075.2.135 raeburn 18164: sub is_nonframeable {
18165: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
18166: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
18167: return if (($remprotocol eq '') || ($remhost eq ''));
18168:
18169: $remprotocol = lc($remprotocol);
18170: $remhost = lc($remhost);
18171: my $remport = 80;
18172: if ($remprotocol eq 'https') {
18173: $remport = 443;
18174: }
18175: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
18176: if ($cached) {
18177: unless ($nocache) {
18178: if ($result) {
18179: return 1;
18180: } else {
18181: return 0;
18182: }
18183: }
18184: }
18185: my $uselink;
18186: my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142 raeburn 18187: my $ua = LWP::UserAgent->new;
18188: $ua->timeout(5);
18189: my $response=$ua->request($request);
1.1075.2.135 raeburn 18190: if ($response->is_success()) {
18191: my $secpolicy = lc($response->header('content-security-policy'));
18192: my $xframeop = lc($response->header('x-frame-options'));
18193: $secpolicy =~ s/^\s+|\s+$//g;
18194: $xframeop =~ s/^\s+|\s+$//g;
18195: if (($secpolicy ne '') || ($xframeop ne '')) {
18196: my $remotehost = $remprotocol.'://'.$remhost;
18197: my ($origin,$protocol,$port);
18198: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
18199: $port = $ENV{'SERVER_PORT'};
18200: } else {
18201: $port = 80;
18202: }
18203: if ($absolute eq '') {
18204: $protocol = 'http:';
18205: if ($port == 443) {
18206: $protocol = 'https:';
18207: }
18208: $origin = $protocol.'//'.lc($hostname);
18209: } else {
18210: $origin = lc($absolute);
18211: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
18212: }
18213: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
18214: my $framepolicy = $1;
18215: $framepolicy =~ s/^\s+|\s+$//g;
18216: my @policies = split(/\s+/,$framepolicy);
18217: if (@policies) {
18218: if (grep(/^\Q'none'\E$/,@policies)) {
18219: $uselink = 1;
18220: } else {
18221: $uselink = 1;
18222: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
18223: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
18224: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
18225: undef($uselink);
18226: }
18227: if ($uselink) {
18228: if (grep(/^\Q'self'\E$/,@policies)) {
18229: if (($origin ne '') && ($remotehost eq $origin)) {
18230: undef($uselink);
18231: }
18232: }
18233: }
18234: if ($uselink) {
18235: my @possok;
18236: if ($ip ne '') {
18237: push(@possok,$ip);
18238: }
18239: my $hoststr = '';
18240: foreach my $part (reverse(split(/\./,$hostname))) {
18241: if ($hoststr eq '') {
18242: $hoststr = $part;
18243: } else {
18244: $hoststr = "$part.$hoststr";
18245: }
18246: if ($hoststr eq $hostname) {
18247: push(@possok,$hostname);
18248: } else {
18249: push(@possok,"*.$hoststr");
18250: }
18251: }
18252: if (@possok) {
18253: foreach my $poss (@possok) {
18254: last if (!$uselink);
18255: foreach my $policy (@policies) {
18256: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
18257: undef($uselink);
18258: last;
18259: }
18260: }
18261: }
18262: }
18263: }
18264: }
18265: }
18266: } elsif ($xframeop ne '') {
18267: $uselink = 1;
18268: my @policies = split(/\s*,\s*/,$xframeop);
18269: if (@policies) {
18270: unless (grep(/^deny$/,@policies)) {
18271: if ($origin ne '') {
18272: if (grep(/^sameorigin$/,@policies)) {
18273: if ($remotehost eq $origin) {
18274: undef($uselink);
18275: }
18276: }
18277: if ($uselink) {
18278: foreach my $policy (@policies) {
18279: if ($policy =~ /^allow-from\s*(.+)$/) {
18280: my $allowfrom = $1;
18281: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
18282: undef($uselink);
18283: last;
18284: }
18285: }
18286: }
18287: }
18288: }
18289: }
18290: }
18291: }
18292: }
18293: }
18294: if ($nocache) {
18295: if ($cached) {
18296: my $devalidate;
18297: if ($uselink && !$result) {
18298: $devalidate = 1;
18299: } elsif (!$uselink && $result) {
18300: $devalidate = 1;
18301: }
18302: if ($devalidate) {
18303: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
18304: }
18305: }
18306: } else {
18307: if ($uselink) {
18308: $result = 1;
18309: } else {
18310: $result = 0;
18311: }
18312: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
18313: }
18314: return $uselink;
18315: }
18316:
1.1075.2.161. .1(raebu 18317:21): sub page_menu {
18318:21): my ($menucolls,$menunum) = @_;
18319:21): my %menu;
18320:21): foreach my $item (split(/;/,$menucolls)) {
18321:21): my ($num,$value) = split(/\%/,$item);
18322:21): if ($num eq $menunum) {
18323:21): my @entries = split(/\&/,$value);
18324:21): foreach my $entry (@entries) {
18325:21): my ($name,$fields) = split(/=/,$entry);
18326:21): if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
18327:21): $menu{$name} = $fields;
18328:21): } else {
18329:21): my @shown;
18330:21): if ($fields =~ /,/) {
18331:21): @shown = split(/,/,$fields);
18332:21): } else {
18333:21): @shown = ($fields);
18334:21): }
18335:21): if (@shown) {
18336:21): foreach my $field (@shown) {
18337:21): next if ($field eq '');
18338:21): $menu{$field} = 1;
18339:21): }
18340:21): }
18341:21): }
18342:21): }
18343:21): }
18344:21): }
18345:21): return %menu;
18346:21): }
18347:21):
1.112 bowersj2 18348: 1;
18349: __END__;
1.41 ng 18350:
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