loncom/interface/lonhtmlcommon.pm - view

File: [LON-CAPA] / loncom / interface / lonhtmlcommon.pm
Revision 1.418: download - view: text, annotated - select for diffs
Tue Feb 18 03:42:04 2025 UTC (3 days, 14 hours ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, HEAD

- WCAG 2 compliance.

1: # The LearningOnline Network with CAPA 2: # a pile of common html routines 3: # 4: # $Id: lonhtmlcommon.pm,v 1.418 2025/02/18 03:42:04 raeburn Exp $ 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: # 28: ###################################################################### 29: ###################################################################### 30: 31: =pod 32: 33: =head1 NAME 34: 35: Apache::lonhtmlcommon - routines to do common html things 36: 37: =head1 SYNOPSIS 38: 39: Referenced by other mod_perl Apache modules. 40: 41: =head1 INTRODUCTION 42: 43: lonhtmlcommon is a collection of subroutines used to present information 44: in a consistent html format, or provide other functionality related to 45: html. 46: 47: =head2 General Subroutines 48: 49: =over 4 50: 51: =cut 52: 53: ###################################################################### 54: ###################################################################### 55: 56: package Apache::lonhtmlcommon; 57: 58: use strict; 59: use Time::Local; 60: use Time::HiRes; 61: use Apache::lonlocal; 62: use Apache::lonnet; 63: use HTML::Entities(); 64: use LONCAPA qw(:DEFAULT :match); 65: 66: sub java_not_enabled { 67: if (($env{'browser.mobile'}) && ($env{'browser.mobile'} =~ /^ipad|ipod|iphone$/i)) { 68: return "\n".'<span class="LC_error">'. 69: &mt('The required Java applet could not be started, because Java is not supported by your mobile device.'). 70: "</span>\n"; 71: } else { 72: return "\n".'<span class="LC_error">'. 73: &mt('The required Java applet could not be started. Please make sure to have Java installed and active in your browser.'). 74: "</span>\n"; 75: } 76: } 77: 78: sub coursepreflink { 79: my ($text,$category)=@_; 80: if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) { 81: my $target =' target="_top"'; 82: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) || 83: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) { 84: $target =''; 85: } 86: return '<a'.$target.' href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'"><span class="LC_setting">'.$text.'</span></a>'; 87: } else { 88: return ''; 89: } 90: } 91: 92: sub raw_href_to_link { 93: my ($message)=@_; 94: $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi; 95: return $message; 96: } 97: 98: sub entity_encode { 99: my ($text)=@_; 100: return &HTML::Entities::encode($text, '\'<>&"'); 101: } 102: 103: sub direct_parm_link { 104: my ($linktext,$symb,$filter,$part,$target)=@_; 105: $symb=&entity_encode($symb); 106: $filter=&entity_encode($filter); 107: $part=&entity_encode($part); 108: if (($symb) && (&Apache::lonnet::allowed('opa')) && ($target ne 'tex')) { 109: my $target=' target="_top"'; 110: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) || 111: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) { 112: $target=''; 113: } 114: return "<a".$target." href=\"/adm/parmset?symb=$symb&filter=$filter&part=$part\"><span class=\"LC_setting\">$linktext</span></a>"; 115: } else { 116: return $linktext; 117: } 118: } 119: ############################################## 120: ############################################## 121: 122: =item &confirm_success() 123: 124: Successful completion of an operation message 125: 126: =cut 127: 128: sub confirm_success { 129: my ($message,$failure)=@_; 130: if ($failure) { 131: return '<span class="LC_error" style="font-size: inherit;">'."\n" 132: .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n" 133: .$message."\n" 134: .'</span>'."\n"; 135: } else { 136: return '<span class="LC_success">'."\n" 137: .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n" 138: .$message."\n" 139: .'</span>'."\n"; 140: } 141: } 142: 143: ############################################## 144: ############################################## 145: 146: =pod 147: 148: =item &dragmath_button() 149: 150: Creates a button that launches a dragmath popup-window, in which an 151: expression can be edited and pasted as LaTeX into a specified textarea. 152: 153: textarea - Name of the textarea to edit. 154: helpicon - If true, show a help icon to the right of the button. 155: 156: =cut 157: 158: sub dragmath_button { 159: my ($textarea,$helpicon) = @_; 160: my $help_text; 161: if ($helpicon) { 162: $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor',undef,undef,undef,undef,'mathhelpicon_'.$textarea); 163: } 164: my $buttontext=&mt('Edit Math'); 165: return <<ENDDRAGMATH; 166: <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text 167: ENDDRAGMATH 168: } 169: 170: ############################################## 171: 172: =pod 173: 174: =item &dragmath_js() 175: 176: Javascript used to open pop-up window containing dragmath applet which 177: can be used to paste LaTeX into a textarea. 178: 179: =cut 180: 181: sub dragmath_js { 182: my ($popup) = @_; 183: return <<ENDDRAGMATHJS; 184: <script type="text/javascript"> 185: // <![CDATA[ 186: function mathedit(textarea, doc) { 187: targetEntry = textarea; 188: targetDoc = doc; 189: newwin = window.open("/adm/dragmath/$popup.html","","width=565,height=500,resizable"); 190: } 191: // ]]> 192: </script> 193: 194: ENDDRAGMATHJS 195: } 196: 197: ############################################## 198: ############################################## 199: 200: =pod 201: 202: =item &dependencies_button() 203: 204: Creates a button that launches a popup-window, in which dependencies 205: for the web page in the main window can be added to, replaced or deleted. 206: 207: =cut 208: 209: sub dependencies_button { 210: my $buttontext=&mt('Manage Dependencies'); 211: return <<"END"; 212: <input type="button" value="$buttontext" onclick="javascript:dependencycheck();" /> 213: END 214: } 215: 216: ############################################## 217: 218: =pod 219: 220: =item &dependencycheck_js() 221: 222: Javascript used to open pop-up window containing interface to manage 223: dependencies for a web page uploaded diretcly to a course. 224: 225: =cut 226: 227: sub dependencycheck_js { 228: my ($symb,$title,$url,$folderpath,$uri) = @_; 229: my $link; 230: if ($symb) { 231: $link = '/adm/dependencies?symb='.&HTML::Entities::encode($symb,'<>&"'); 232: } elsif ($folderpath) { 233: $link = '/adm/dependencies?folderpath='.&HTML::Entities::encode($folderpath,'<>&"'); 234: $url = $uri; 235: } elsif ($uri =~ m{^/public/$match_domain/$match_courseid/syllabus$}) { 236: $link = '/adm/dependencies'; 237: } 238: $link .= (($link=~/\?/)?'&':'?').'title='. 239: &HTML::Entities::encode($title,'<>&"'); 240: if ($url) { 241: $link .= '&url='.&HTML::Entities::encode($url,'<>&"'); 242: } 243: &js_escape(\$link); 244: return <<ENDJS; 245: <script type="text/javascript"> 246: // <![CDATA[ 247: function dependencycheck() { 248: depwin = window.open("$link","","width=750,height=500,resizable,scrollbars=yes"); 249: } 250: // ]]> 251: </script> 252: ENDJS 253: } 254: 255: ############################################## 256: ############################################## 257: 258: =pod 259: 260: =item &authorbombs() 261: 262: =cut 263: 264: ############################################## 265: ############################################## 266: 267: sub authorbombs { 268: my $url=shift; 269: $url=&Apache::lonnet::declutter($url); 270: my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/}); 271: my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); 272: foreach my $bomb (keys(%bombs)) { 273: if ($bomb =~ /^$udom\/$uname\//) { 274: return '<a href="/adm/bombs/'.$url. 275: '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'. 276: &Apache::loncommon::help_open_topic('About_Bombs'); 277: } 278: } 279: return ''; 280: } 281: 282: ############################################## 283: ############################################## 284: 285: sub recent_filename { 286: my $area=shift; 287: return 'nohist_recent_'.&escape($area); 288: } 289: 290: sub store_recent { 291: my ($area,$name,$value,$freeze)=@_; 292: my $file=&recent_filename($area); 293: my %recent=&Apache::lonnet::dump($file); 294: if (scalar(keys(%recent))>20) { 295: # remove oldest value 296: my $oldest=time(); 297: my $delkey=''; 298: foreach my $item (keys(%recent)) { 299: my $thistime=(split(/\&/,$recent{$item}))[0]; 300: if (($thistime ne "always_include") && ($thistime<$oldest)) { 301: $oldest=$thistime; 302: $delkey=$item; 303: } 304: } 305: &Apache::lonnet::del($file,[$delkey]); 306: } 307: # store new value 308: my $timestamp; 309: if ($freeze) { 310: $timestamp = "always_include"; 311: } else { 312: $timestamp = time(); 313: } 314: &Apache::lonnet::put($file,{ $name => 315: $timestamp.'&'.&escape($value) }); 316: } 317: 318: sub remove_recent { 319: my ($area,$names)=@_; 320: my $file=&recent_filename($area); 321: return &Apache::lonnet::del($file,$names); 322: } 323: 324: sub select_recent { 325: my ($area,$fieldname,$event)=@_; 326: my %recent=&Apache::lonnet::dump(&recent_filename($area)); 327: my $return="\n<select name='$fieldname'". 328: ($event?" onchange='$event'":''). 329: ">\n<option value=''>--- ".&mt('Recent')." ---</option>"; 330: foreach my $value (sort(keys(%recent))) { 331: unless ($value =~/^error\:/) { 332: my $escaped = &Apache::loncommon::escape_url($value); 333: &Apache::loncommon::inhibit_menu_check(\$escaped); 334: if ($area eq 'residx') { 335: next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value))); 336: } 337: $return.="\n<option value='$escaped'>". 338: &unescape((split(/\&/,$recent{$value}))[1]). 339: '</option>'; 340: } 341: } 342: $return.="\n</select>\n"; 343: return $return; 344: } 345: 346: sub get_recent { 347: my ($area, $n) = @_; 348: my %recent=&Apache::lonnet::dump(&recent_filename($area)); 349: 350: # Create hash with key as time and recent as value 351: # Begin filling return_hash with any 'always_include' option 352: my %time_hash = (); 353: my %return_hash = (); 354: foreach my $item (keys(%recent)) { 355: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item})); 356: if ($thistime eq 'always_include') { 357: $return_hash{$item} = &unescape($thisvalue); 358: $n--; 359: } else { 360: $time_hash{$thistime} = $item; 361: } 362: } 363: 364: # Sort by decreasing time and return key value pairs 365: my $idx = 1; 366: foreach my $item (reverse(sort(keys(%time_hash)))) { 367: $return_hash{$time_hash{$item}} = 368: &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]); 369: if ($n && ($idx++ >= $n)) {last;} 370: } 371: 372: return %return_hash; 373: } 374: 375: sub get_recent_frozen { 376: my ($area) = @_; 377: my %recent=&Apache::lonnet::dump(&recent_filename($area)); 378: 379: # Create hash with all 'frozen' items 380: my %return_hash = (); 381: foreach my $item (keys(%recent)) { 382: my ($thistime,$thisvalue)=(split(/\&/,$recent{$item})); 383: if ($thistime eq 'always_include') { 384: $return_hash{$item} = &unescape($thisvalue); 385: } 386: } 387: return %return_hash; 388: } 389: 390: 391: 392: =pod 393: 394: =item &textbox() 395: 396: =cut 397: 398: ############################################## 399: ############################################## 400: sub textbox { 401: my ($name,$value,$size,$special) = @_; 402: $size = 40 if (! defined($size)); 403: $value = &HTML::Entities::encode($value,'<>&"'); 404: my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '. 405: 'value="'.$value.'" '.$special.' />'; 406: return $Str; 407: } 408: 409: ############################################## 410: ############################################## 411: 412: =pod 413: 414: =item &checkbox() 415: 416: =cut 417: 418: ############################################## 419: ############################################## 420: sub checkbox { 421: my ($name,$checked,$value,$special) = @_; 422: my $Str = '<input type="checkbox" name="'.$name.'" '; 423: if (defined($value)) { 424: $Str .= 'value="'.$value.'"'; 425: } 426: if ($checked) { 427: $Str .= ' checked="checked"'; 428: } 429: $Str .= $special.' />'; 430: return $Str; 431: } 432: 433: 434: =pod 435: 436: =item &radiobutton() 437: 438: =cut 439: 440: ############################################## 441: ############################################## 442: sub radio { 443: my ($name,$checked,$value) = @_; 444: my $Str = '<input type="radio" name="'.$name.'" '; 445: if (defined($value)) { 446: $Str .= 'value="'.$value.'"'; 447: } 448: if ($checked eq $value) { 449: $Str .= ' checked="checked"'; 450: } 451: $Str .= ' />'; 452: return $Str; 453: } 454: 455: ############################################## 456: ############################################## 457: 458: =pod 459: 460: =item &date_setter() 461: 462: &date_setter returns html and javascript for a compact date-setting form. 463: To retrieve values from it, use &get_date_from_form. 464: 465: =over 4 466: 467: =item Inputs 468: 469: =over 470: 471: =item $dname 472: 473: The name to prepend to the form elements. 474: The form elements defined will be dname_year, dname_month, dname_day, 475: dname_hour, dname_min, and dname_sec. 476: 477: =item $currentvalue 478: 479: The current setting for this time parameter. A unix format time 480: (time in seconds since the beginning of Jan 1st, 1970, GMT. 481: An undefined value is taken to indicate the value is the current time 482: unless it is requested to leave it empty. See $includeempty. 483: Also, to be explicit, a value of 'now' also indicates the current time. 484: 485: =item $special 486: 487: Additional html/javascript to be associated with each element in 488: the date_setter. See lonparmset for example usage. 489: 490: =item $includeempty 491: 492: If it is set (true) and no date/time value is provided, 493: the date/time fields are left empty. 494: 495: =item $state 496: 497: Specifies the initial state of the form elements. Either 'disabled' or empty. 498: Defaults to empty, which indicates the form elements are not disabled. 499: 500: =item $no_hh_mm_ss 501: 502: If true, text boxes for hours, minutes and seconds are omitted. 503: 504: =item $defhour 505: 506: Default value for hours (a default of 0 is used otherwise). 507: 508: =item $defmin 509: 510: Default value for minutes (a default of 0 is used otherwise). 511: 512: =item defsec 513: 514: Default value for seconds (a default of 0 is used otherwise). 515: 516: =item $nolink 517: 518: If true, a "Select calendar" link (to pop-up a calendar) is not displayed 519: to the right of the items. 520: 521: =item $no_mm_ss 522: 523: If true, text boxes for minutes and seconds are omitted. 524: 525: =item $no_ss 526: 527: If true, text boxes for seconds are omitted. 528: 529: =back 530: 531: =item Bugs 532: 533: The method used to restrict user input will fail in the year 2400. 534: 535: =back 536: 537: =cut 538: 539: ############################################## 540: ############################################## 541: sub date_setter { 542: my ($formname,$dname,$currentvalue,$special,$includeempty,$state, 543: $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink,$no_mm_ss,$no_ss) = @_; 544: my $now = time; 545: my %labels = &Apache::lonlocal::texthash( 546: day => 'day', 547: month => 'month', 548: year => 'year', 549: sec => 'seconds', 550: min => 'minutes', 551: hour => 'hours', 552: ); 553: my $tzname; 554: my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.''); 555: #other potentially useful values: wkday,yrday,is_daylight_savings 556: 557: if (! defined($state) || $state ne 'disabled') { 558: $state = ''; 559: } else { 560: $state = 'disabled="disabled"'; 561: } 562: if (! defined($no_hh_mm_ss)) { 563: $no_hh_mm_ss = 0; 564: } 565: if ($currentvalue eq 'now') { 566: $currentvalue = $now; 567: } 568: 569: # Default value: Set empty date field to current time 570: # unless empty inclusion is requested 571: if ((!$includeempty) && (!$currentvalue)) { 572: $currentvalue = $now; 573: } 574: # Do we have a date? Split it! 575: if ($currentvalue) { 576: ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue); 577: 578: #No values provided for hour, min, sec? Use default 0 579: if (($defhour) || ($defmin) || ($defsec)) { 580: $sec = ($defsec ? $defsec : 0); 581: $min = ($defmin ? $defmin : 0); 582: $hour = ($defhour ? $defhour : 0); 583: } 584: } 585: my $result = "\n\n"; 586: $result .= <<ENDJS; 587: <script type="text/javascript"> 588: // <![CDATA[ 589: function $dname\_checkday() { 590: var day = document.$formname.$dname\_day.value; 591: var month = document.$formname.$dname\_month.value; 592: var year = document.$formname.$dname\_year.value; 593: var valid = true; 594: if (day < 1) { 595: document.$formname.$dname\_day.value = 1; 596: } 597: if (day > 31) { 598: document.$formname.$dname\_day.value = 31; 599: } 600: if ((month == 1) || (month == 3) || (month == 5) || 601: (month == 7) || (month == 8) || (month == 10) || 602: (month == 12)) { 603: if (day > 31) { 604: document.$formname.$dname\_day.value = 31; 605: day = 31; 606: } 607: } else if (month == 2 ) { 608: if ((year % 4 == 0) && (year % 100 != 0)) { 609: if (day > 29) { 610: document.$formname.$dname\_day.value = 29; 611: } 612: } else if (day > 29) { 613: document.$formname.$dname\_day.value = 28; 614: } 615: } else if (day > 30) { 616: document.$formname.$dname\_day.value = 30; 617: } 618: } 619: 620: function $dname\_disable() { 621: document.$formname.$dname\_month.disabled=true; 622: document.$formname.$dname\_day.disabled=true; 623: document.$formname.$dname\_year.disabled=true; 624: document.$formname.$dname\_hour.disabled=true; 625: document.$formname.$dname\_minute.disabled=true; 626: document.$formname.$dname\_second.disabled=true; 627: } 628: 629: function $dname\_enable() { 630: document.$formname.$dname\_month.disabled=false; 631: document.$formname.$dname\_day.disabled=false; 632: document.$formname.$dname\_year.disabled=false; 633: document.$formname.$dname\_hour.disabled=false; 634: document.$formname.$dname\_minute.disabled=false; 635: document.$formname.$dname\_second.disabled=false; 636: } 637: 638: function $dname\_opencalendar() { 639: if (! document.$formname.$dname\_month.disabled) { 640: var calwin=window.open( 641: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+ 642: document.$formname.$dname\_month.value+"&year="+ 643: document.$formname.$dname\_year.value, 644: "LONCAPAcal", 645: "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no"); 646: } 647: 648: } 649: // ]]> 650: </script> 651: ENDJS 652: $result .= ' <span class="LC_nobreak">'; 653: my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" aria-label="$labels{'month'}">}; 654: # Month 655: my @Months = qw/January February March April May June 656: July August September October November December/; 657: # Pad @Months with a bogus value to make indexing easier 658: unshift(@Months,'If you can read this an error occurred'); 659: if ($includeempty) { $monthselector.="<option value=''></option>"; } 660: for(my $m = 1;$m <=$#Months;$m++) { 661: $monthselector .= qq{ <option value="$m"}; 662: $monthselector .= ' selected="selected"' if ($m-1 eq $month); 663: $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n"; 664: } 665: $monthselector.= ' </select>'; 666: # Day 667: my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" aria-label="$labels{'day'}" />}; 668: # Year 669: my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" aria-label="$labels{'year'}" />}; 670: # 671: my $hourselector = qq{<select name="$dname\_hour" $special $state aria-label="$labels{'hour'}">}; 672: if ($includeempty) { 673: $hourselector.=qq{<option value=''></option>}; 674: } 675: for (my $h = 0;$h<24;$h++) { 676: $hourselector .= qq{<option value="$h"}; 677: $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h); 678: $hourselector .= ">"; 679: my $timest=''; 680: if ($h == 0) { 681: $timest .= "12 am"; 682: } elsif($h == 12) { 683: $timest .= "12 noon"; 684: } elsif($h < 12) { 685: $timest .= "$h am"; 686: } else { 687: $timest .= $h-12 ." pm"; 688: } 689: $timest=&mt($timest); 690: $hourselector .= $timest." </option>\n"; 691: } 692: $hourselector .= " </select>\n"; 693: my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" aria-label="$labels{'min'}" />}; 694: my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" aria-label="$labels{'sec'}" />}; 695: my $cal_link; 696: unless (($nolink) || ($state eq 'disabled')) { 697: $cal_link = qq{<a href="javascript:$dname\_opencalendar()">}; 698: } 699: # 700: my $tzone = ' '.$tzname.' '; 701: if ($no_hh_mm_ss) { 702: $result .= &mt('[_1] [_2] [_3] ', 703: $monthselector,$dayselector,$yearselector). 704: $tzone; 705: } elsif ($no_mm_ss) { 706: $result .= &mt('[_1] [_2] [_3] [_4]', 707: $monthselector,$dayselector,$yearselector, 708: $hourselector). 709: $tzone; 710: 711: } elsif ($no_ss) { 712: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m', 713: $monthselector,$dayselector,$yearselector, 714: $hourselector,$minuteselector). 715: $tzone; 716: 717: } else { 718: $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ', 719: $monthselector,$dayselector,$yearselector, 720: $hourselector,$minuteselector,$secondselector). 721: $tzone; 722: } 723: unless (($nolink) || ($state eq 'disabled')) { 724: $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>'); 725: } 726: $result .= "</span>\n\n"; 727: return $result; 728: } 729: 730: sub get_timedates { 731: my ($epoch) = @_; 732: my $dt = DateTime->from_epoch(epoch => $epoch) 733: ->set_time_zone(&Apache::lonlocal::gettimezone()); 734: my $tzname = $dt->time_zone_short_name(); 735: my $sec = $dt->second; 736: my $min = $dt->minute; 737: my $hour = $dt->hour; 738: my $mday = $dt->day; 739: my $month = $dt->month; 740: if ($month) { 741: $month --; 742: } 743: my $year = $dt->year; 744: return ($tzname,$sec,$min,$hour,$mday,$month,$year); 745: } 746: 747: sub build_url { 748: my ($base, $fields)=@_; 749: my $url; 750: $url = $base.'?'; 751: foreach my $key (keys(%$fields)) { 752: $url.=&escape($key).'='.&escape($$fields{$key}).'&'; 753: } 754: $url =~ s/&$//; 755: return $url; 756: } 757: 758: 759: ############################################## 760: ############################################## 761: 762: =pod 763: 764: =item &get_date_from_form() 765: 766: get_date_from_form retrieves the date specified in an &date_setter form. 767: 768: =over 769: 770: =item Inputs: 771: 772: =over 4 773: 774: =item $dname 775: 776: The name passed to &date_setter, which prefixes the form elements. 777: 778: =item $defaulttime 779: 780: The unix time to use as the default in case of poor inputs. 781: 782: =back 783: 784: =back 785: 786: Returns: Unix time represented in the form. 787: 788: =cut 789: 790: ############################################## 791: ############################################## 792: sub get_date_from_form { 793: my ($dname) = @_; 794: my ($sec,$min,$hour,$day,$month,$year); 795: # 796: if (defined($env{'form.'.$dname.'_second'})) { 797: my $tmpsec = $env{'form.'.$dname.'_second'}; 798: if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) { 799: $sec = $tmpsec; 800: } 801: if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; } 802: } else { 803: $sec = 0; 804: } 805: if (defined($env{'form.'.$dname.'_minute'})) { 806: my $tmpmin = $env{'form.'.$dname.'_minute'}; 807: if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) { 808: $min = $tmpmin; 809: } 810: if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; } 811: } else { 812: $min = 0; 813: } 814: if (defined($env{'form.'.$dname.'_hour'})) { 815: my $tmphour = $env{'form.'.$dname.'_hour'}; 816: if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) { 817: $hour = $tmphour; 818: } 819: } else { 820: $hour = 0; 821: } 822: if (defined($env{'form.'.$dname.'_day'})) { 823: my $tmpday = $env{'form.'.$dname.'_day'}; 824: if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) { 825: $day = $tmpday; 826: } 827: } 828: if (defined($env{'form.'.$dname.'_month'})) { 829: my $tmpmonth = $env{'form.'.$dname.'_month'}; 830: if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) { 831: $month = $tmpmonth; 832: } 833: } 834: if (defined($env{'form.'.$dname.'_year'})) { 835: my $tmpyear = $env{'form.'.$dname.'_year'}; 836: if (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) { 837: $year = $tmpyear; 838: } 839: } 840: if (($year<1970) || ($year>2037)) { return undef; } 841: if (defined($sec) && defined($min) && defined($hour) && 842: defined($day) && defined($month) && defined($year)) { 843: my $timezone = &Apache::lonlocal::gettimezone(); 844: my $dt = DateTime->new( year => $year, 845: month => $month, 846: day => $day, 847: hour => $hour, 848: minute => $min, 849: second => $sec, 850: time_zone => $timezone, 851: ); 852: my $epoch_time = $dt->epoch; 853: if ($epoch_time ne '') { 854: return $epoch_time; 855: } else { 856: return undef; 857: } 858: } else { 859: return undef; 860: } 861: } 862: 863: ############################################## 864: ############################################## 865: 866: =pod 867: 868: =item &pjump_javascript_definition() 869: 870: Returns javascript defining the 'pjump' function, which opens up a 871: parameter setting wizard. 872: 873: =cut 874: 875: ############################################## 876: ############################################## 877: sub pjump_javascript_definition { 878: my $Str = <<END; 879: function pjump(type,dis,value,marker,ret,call,hour,min,sec,extra) { 880: openMyModal("/adm/rat/parameter.html?type="+escape(type) 881: +"&value="+escape(value)+"&marker="+escape(marker) 882: +"&return="+escape(ret) 883: +"&call="+escape(call)+"&name="+escape(dis) 884: +"&defhour="+escape(hour)+"&defmin="+escape(min) 885: +"&defsec="+escape(sec)+"&extra="+escape(extra) 886: +"&modal=1",350,350,'no'); 887: } 888: END 889: return $Str; 890: } 891: 892: ############################################## 893: ############################################## 894: 895: =pod 896: 897: =item &javascript_nothing() 898: 899: Return an appropriate null for the users browser. This is used 900: as the first arguement for window.open calls when you want a blank 901: window that you can then write to. 902: 903: =cut 904: 905: ############################################## 906: ############################################## 907: sub javascript_nothing { 908: # mozilla and other browsers work with "''", but IE on mac does not. 909: my $nothing = "''"; 910: my $user_browser; 911: my $user_os; 912: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'})); 913: $user_os = $env{'browser.os'} if (exists($env{'browser.os'})); 914: if (! defined($user_browser) || ! defined($user_os)) { 915: (undef,$user_browser,undef,undef,undef,$user_os) = 916: &Apache::loncommon::decode_user_agent(); 917: } 918: if ($user_browser eq 'explorer' && $user_os =~ 'mac') { 919: $nothing = "'javascript:void(0);'"; 920: } 921: return $nothing; 922: } 923: 924: ############################################## 925: ############################################## 926: sub javascript_docopen { 927: my ($mimetype) = @_; 928: $mimetype ||= 'text/html'; 929: # safari does not understand document.open() and loads "text/html" 930: my $nothing = "''"; 931: my $user_browser; 932: my $user_os; 933: $user_browser = $env{'browser.type'} if (exists($env{'browser.type'})); 934: $user_os = $env{'browser.os'} if (exists($env{'browser.os'})); 935: if (! defined($user_browser) || ! defined($user_os)) { 936: (undef,$user_browser,undef,undef,undef,$user_os) = 937: &Apache::loncommon::decode_user_agent(); 938: } 939: if ($user_browser eq 'safari' && $user_os =~ 'mac') { 940: $nothing = "document.clear()"; 941: } else { 942: $nothing = "document.open('$mimetype','replace')"; 943: } 944: return $nothing; 945: } 946: 947: 948: ############################################## 949: ############################################## 950: 951: =pod 952: 953: =item &StatusOptions() 954: 955: Returns html for a selection box which allows the user to choose the 956: enrollment status of students. The selection box name is 'Status'. 957: 958: =over 959: 960: =item Inputs: 961: 962: $status: the currently selected status. If undefined the value of 963: $env{'form.Status'} is taken. If that is undefined, a value of 'Active' 964: is used. 965: 966: $formname: The name of the form. If defined the onchange attribute of 967: the selection box is set to document.$formname.submit(). 968: 969: $size: the size (number of lines) of the selection box. 970: 971: $onchange: javascript to use when the value is changed. Enclosed in 972: double quotes, ""s, not single quotes. 973: 974: =back 975: 976: Returns: a perl string as described. 977: 978: =cut 979: 980: ############################################## 981: ############################################## 982: sub StatusOptions { 983: my ($status, $formName,$size,$onchange,$mult)=@_; 984: $size = 1 if (!defined($size)); 985: if (! defined($status)) { 986: $status = 'Active'; 987: $status = $env{'form.Status'} if (exists($env{'form.Status'})); 988: } 989: 990: my $Str = ''; 991: $Str .= '<select name="Status"'; 992: if (defined($mult)){ 993: $Str .= ' multiple="multiple" '; 994: } 995: if(defined($formName) && $formName ne '' && ! defined($onchange)) { 996: $Str .= ' onchange="document.'.$formName.'.submit()"'; 997: } 998: if (defined($onchange)) { 999: $Str .= ' onchange="'.$onchange.'"'; 1000: } 1001: $Str .= ' size="'.$size.'" '; 1002: $Str .= '>'."\n"; 1003: foreach my $type (['Active', &mt('Currently Has Access')], 1004: ['Future', &mt('Will Have Future Access')], 1005: ['Expired', &mt('Previously Had Access')], 1006: ['Any', &mt('Any Access Status')]) { 1007: my ($name,$label) = @$type; 1008: $Str .= '<option value="'.$name.'" '; 1009: if ($status eq $name) { 1010: $Str .= 'selected="selected" '; 1011: } 1012: $Str .= '>'.$label.'</option>'."\n"; 1013: } 1014: 1015: $Str .= '</select>'."\n"; 1016: } 1017: 1018: ######################################################## 1019: ######################################################## 1020: 1021: =pod 1022: 1023: =item Progress Window Handling Routines 1024: 1025: These routines handle the creation, update, increment, and closure of 1026: progress windows. The progress window reports to the user the number 1027: of items completed and an estimate of the time required to complete the rest. 1028: 1029: =over 4 1030: 1031: 1032: =item &Create_PrgWin() 1033: 1034: Writes javascript to the client to open a progress window and returns a 1035: data structure used for bookkeeping. 1036: 1037: =over 1038: 1039: =item Inputs 1040: 1041: =over 1042: 1043: =item $r Apache request 1044: 1045: =item $number_to_do The total number of items being processed. 1046: 1047: =item $preamble Optional HTML to display before the progress bar. 1048: 1049: =back 1050: 1051: =back 1052: 1053: Returns a hash containing the progress state data structure. 1054: If $number_to_do is zero or null, an indeterminate progress bar will 1055: be used. 1056: 1057: =item &Update_PrgWin() 1058: 1059: Updates the text in the progress indicator. Does not increment the count. 1060: See &Increment_PrgWin. 1061: 1062: =over 1063: 1064: =item Inputs: 1065: 1066: =over 4 1067: 1068: =item $r Apache request 1069: 1070: =item $prog_state Pointer to the data structure returned by &Create_PrgWin 1071: 1072: =item $displaystring The string to write to the status indicator 1073: 1074: =back 1075: 1076: =back 1077: 1078: Returns: none 1079: 1080: 1081: =item &Increment_PrgWin() 1082: 1083: Increment the count of items completed for the progress window by $step or 1 if no step is provided. 1084: 1085: =over 1086: 1087: =item Inputs: 1088: 1089: =over 4 1090: 1091: =item $r 1092: 1093: Apache request 1094: 1095: =item $prog_state 1096: 1097: Pointer to the data structure returned by Create_PrgWin 1098: 1099: =item $extraInfo 1100: 1101: A description of the items being iterated over. Typically 'student'. 1102: 1103: =item $step 1104: 1105: (optional) counter step. Will be set to default 1 if ommited. step must be greater than 0 or empty. 1106: 1107: =back 1108: 1109: =back 1110: 1111: Returns: none 1112: 1113: 1114: =item &Close_PrgWin() 1115: 1116: Closes the progress window. 1117: 1118: =over 1119: 1120: =item Inputs: 1121: 1122: =over 4 1123: 1124: =item $r Apache request 1125: 1126: =item $prog_state Pointer to the data structure returned by Create_PrgWin 1127: 1128: =back 1129: 1130: =back 1131: 1132: Returns: none 1133: 1134: =back 1135: 1136: =cut 1137: 1138: ######################################################## 1139: ######################################################## 1140: 1141: 1142: # Create progress 1143: sub Create_PrgWin { 1144: my ($r,$number_to_do,$preamble)=@_; 1145: my %prog_state; 1146: $prog_state{'done'}=0; 1147: $prog_state{'firststart'}=&Time::HiRes::time(); 1148: $prog_state{'laststart'}=&Time::HiRes::time(); 1149: $prog_state{'max'}=$number_to_do; 1150: &Apache::loncommon::LCprogressbar($r,$prog_state{'max'},$preamble); 1151: return %prog_state; 1152: } 1153: 1154: # update progress 1155: sub Update_PrgWin { 1156: my ($r,$prog_state,$displayString)=@_; 1157: &Apache::loncommon::LCprogressbarUpdate($r,undef,$displayString,$$prog_state{'max'}); 1158: $$prog_state{'laststart'}=&Time::HiRes::time(); 1159: } 1160: 1161: # increment progress state 1162: sub Increment_PrgWin { 1163: my ($r,$prog_state,$extraInfo,$step)=@_; 1164: $step = $step > 0 ? $step : 1; 1165: $$prog_state{'done'} += $step; 1166: 1167: # Catch (max modulo step) <> 0 1168: my $current = $$prog_state{'done'}; 1169: my $last = ($$prog_state{'max'} - $current); 1170: if ($last <= 0) { 1171: $last = 1; 1172: $current = $$prog_state{'max'}; 1173: } 1174: 1175: my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/ 1176: $current * $last; 1177: $time_est = int($time_est); 1178: # 1179: my $min = int($time_est/60); 1180: my $sec = $time_est % 60; 1181: 1182: my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'}; 1183: if ($lasttime > 9) { 1184: $lasttime = int($lasttime); 1185: } elsif ($lasttime < 0.01) { 1186: $lasttime = 0; 1187: } else { 1188: $lasttime = sprintf("%3.2f",$lasttime); 1189: } 1190: 1191: $sec = 0 if ($min >= 10); # Don't show seconds if remaining time >= 10 min. 1192: $sec = 1 if ( ($min == 0) && ($sec == 0) ); # Little cheating: pretend to have 1 second remaining instead of 0 to have something to display 1193: 1194: my $timeinfo = 1195: &mt('[_1]/[_2]:' 1196: .' [quant,_3,minute,minutes,] [quant,_4,second ,seconds ,]remaining' 1197: .' ([quant,_5,second] for '.$extraInfo.')', 1198: $current, 1199: $$prog_state{'max'}, 1200: $min, 1201: $sec, 1202: $lasttime); 1203: my $percent=0; 1204: if ($$prog_state{'max'}) { 1205: $percent=int(100.*$current/$$prog_state{'max'}); 1206: } 1207: &Apache::loncommon::LCprogressbarUpdate($r,$percent,$timeinfo,$$prog_state{'max'}); 1208: $$prog_state{'laststart'}=&Time::HiRes::time(); 1209: } 1210: 1211: # close Progress Line 1212: sub Close_PrgWin { 1213: my ($r,$prog_state)=@_; 1214: &Apache::loncommon::LCprogressbarClose($r); 1215: undef(%$prog_state); 1216: } 1217: 1218: 1219: # ------------------------------------------------------- Puts directory header 1220: 1221: sub crumbs { 1222: my ($uri,$target,$prefix,$form,$skiplast,$onclick)=@_; 1223: # You cannot crumbnify uploaded or adm resources 1224: if ($uri=~/^\/*(uploaded|adm)\//) { return &mt('(Internal Course/Community Content)'); } 1225: if ($target) { 1226: $target = ' target="'. 1227: &Apache::loncommon::escape_single($target).'"'; 1228: } 1229: my $output='<span class="LC_filename">'; 1230: $output.=$prefix.'/'; 1231: if (($env{'user.adv'}) || ($env{'user.author'})) { 1232: my $path=$prefix.'/'; 1233: foreach my $dir (split('/',$uri)) { 1234: if (! $dir) { next; } 1235: $path .= $dir; 1236: if ($path eq $uri) { 1237: if ($skiplast) { 1238: $output.=$dir; 1239: last; 1240: } 1241: } else { 1242: $path.='/'; 1243: } 1244: if ($path eq '/res/') { 1245: unless (&Apache::lonnet::allowed('bre',$path)) { 1246: $output.="$dir/"; 1247: next; 1248: } 1249: } 1250: my $href_path = &HTML::Entities::encode($path,'<>&"'); 1251: &Apache::loncommon::inhibit_menu_check(\$href_path); 1252: if ($form) { 1253: my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();'; 1254: $output.=qq{<a href="$href"$onclick$target>$dir</a>/}; 1255: } else { 1256: $output.=qq{<a href="$href_path"$onclick$target>$dir</a>/}; 1257: } 1258: } 1259: } else { 1260: foreach my $dir (split('/',$uri)) { 1261: if (! $dir) { next; } 1262: $output.=$dir.'/'; 1263: } 1264: } 1265: if ($uri !~ m|/$|) { $output=~s|/$||; } 1266: $output.='</span>'; 1267: 1268: 1269: return $output; 1270: } 1271: 1272: # --------------------- A function that generates a window for the spellchecker 1273: 1274: sub spellheader { 1275: my $start_page= 1276: &Apache::loncommon::start_page('Speller Suggestions',undef, 1277: {'only_body' => 1, 1278: 'js_ready' => 1, 1279: 'bgcolor' => '#DDDDDD', 1280: 'add_entries' => { 1281: 'onload' => 1282: 'document.forms.spellcheckform.submit()', 1283: } 1284: }); 1285: my $end_page= 1286: &Apache::loncommon::end_page({'js_ready' => 1}); 1287: 1288: my $nothing=&javascript_nothing(); 1289: return (<<ENDCHECK); 1290: <script type="text/javascript"> 1291: // <![CDATA[ 1292: // 1302: // ]]> 1303: </script> 1304: ENDCHECK 1305: } 1306: 1307: # ---------------------------------- Generate link to spell checker for a field 1308: 1309: sub spelllink { 1310: my ($form,$field)=@_; 1311: my $linktext=&mt('Check Spelling'); 1312: return (<<ENDLINK); 1313: <a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow(this.document.forms.$form.$field.value);">$linktext</a> 1314: ENDLINK 1315: } 1316: 1317: # ------------------------------------------------- Output headers for CKEditor 1318: 1319: sub htmlareaheaders { 1320: my $s=""; 1321: if (&htmlareabrowser()) { 1322: $s.=(<<ENDEDITOR); 1323: <script type="text/javascript" src="/ckeditor/ckeditor.js"></script> 1324: ENDEDITOR 1325: } 1326: $s.=(<<ENDJQUERY); 1327: <script type="text/javascript" src="/adm/jQuery/js/jquery-3.7.1.min.js"></script> 1328: <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.13.3.custom.min.js"></script> 1329: <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.13.3.custom.min.css" /> 1330: <script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" > 1331: </script> 1332: <link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" /> 1333: <script type="text/javascript" src="/adm/countdown/js/jquery.countdown.min.js"></script> 1334: <link rel="stylesheet" type="text/css" href="/adm/countdown/css/jquery.countdown.css" /> 1335: 1336: <script type="text/javascript" src="/adm/spellchecker/js/jquery.spellchecker.min.js"></script> 1337: <link rel="stylesheet" type="text/css" href="/adm/spellchecker/css/spellchecker.css" /> 1338: <script type="text/javascript" src="/adm/nicescroll/jquery.nicescroll.min.js"></script> 1339: 1340: ENDJQUERY 1341: return $s; 1342: } 1343: 1344: # ----------------------------------------------------------------- Preferences 1345: 1346: # ------------------------------------------------- lang to use in html editor 1347: sub htmlarea_lang { 1348: my $lang='en'; 1349: if (&mt('htmlarea_lang') ne 'htmlarea_lang') { 1350: $lang=&mt('htmlarea_lang'); 1351: } 1352: return $lang; 1353: } 1354: 1355: # return javacsript to activate elements of .colorchooser with jpicker: 1356: # Caller is responsible for enclosing this in <script> tags: 1357: # 1358: sub color_picker { 1359: return ' 1360: $(document).ready(function(){ 1361: $.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/"; 1362: $(".colorchooser").jPicker({window: { position: {x: "screenCenter", y: "bottom"}}}); 1363: });'; 1364: } 1365: 1366: sub countdown { 1367: 1368: # Code to put a due date countdown in 'duedatecountdown' span. 1369: # This is currently located in the breadcrumb headers. 1370: # note that the dueDateLayout is internatinoalized below. 1371: # Here document is used to support the substitution into the javascript below. 1372: # ..which unforunately necessitates escaping the $'s in the javascript. 1373: # There are several times of importance 1374: # 1375: # serverDueDate - The absolute time at which the problem expires. 1376: # serverTime - The server's time when the problem finished computing. 1377: # clientTime - The client's time...as close to serverTime as possible. 1378: # The clientTime will be slightly later due to 1379: # 1. The latency between problem computation and 1380: # the first network action. 1381: # 2. The time required between the page load-start and the actual 1382: # initial javascript execution that got clientTime. 1383: # These are used as follows: 1384: # The difference between clientTime and serverTime are used to 1385: # correct for differences in clock settings between the browser's system and the 1386: # server's. 1387: # 1388: # The difference between clientTime and the time at which the ready() method 1389: # starts executing is used to estimate latencies for page load and submission. 1390: # Since this is an estimate, it is doubled. The latency estimate + one minute 1391: # is used to determine when the countdown timer turns red to warn the user 1392: # to think about submitting. 1393: 1394: 1395: my $dueDateLayout = &mt('Due in: {dn} {dl} {hnn}{sep}{mnn}{sep}{snn} [_1]', 1396: "<span id='submitearly'></span>"); 1397: my $early = '- <b>'.&mt('Submit Early').'</b>'; 1398: my $pastdue = '- <b>'.&mt('Past Due').'</b>'; 1399: return <<"JAVASCRIPT"; 1400: 1401: var documentReadyTime; 1402: 1403: \$(document).ready(function() { 1404: if (typeof(dueDate) != "undefined") { 1405: documentReadyTime = (new Date()).getTime(); 1406: \$("#duedatecountdown").countdown({until: dueDate, compact: true, 1407: layout: "$dueDateLayout", 1408: onTick: function (periods) { 1409: var latencyEstimate = (documentReadyTime - clientTime) * 2; 1410: if(\$.countdown.periodsToSeconds(periods) < (300 + latencyEstimate)) { 1411: \$("#submitearly").html("$early"); 1412: if (\$.countdown.periodsToSeconds(periods) < 1) { 1413: \$("#submitearly").html("$pastdue"); 1414: } 1415: } 1416: if(\$.countdown.periodsToSeconds(periods) < (60 + latencyEstimate)) { 1417: \$(this).css("color", "red"); //Highlight last minute. 1418: } 1419: } 1420: }); 1421: } 1422: }); 1423: 1424: JAVASCRIPT 1425: 1426: } 1427: 1428: # ----------------------------------------- Script to activate only some fields 1429: 1430: sub htmlareaselectactive { 1431: my ($args) = @_; 1432: unless (&htmlareabrowser()) { return ''; } 1433: my $output='<script type="text/javascript" defer="defer">'."\n" 1434: .'// <![CDATA['."\n" 1435: .'//'."\n" 1721: .'// ]]>'."\n" 1722: .'</script>'; 1723: return $output; 1724: } 1725: 1726: # --------------------------------------------------------------------- Blocked 1727: 1728: sub htmlareablocked { 1729: unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; } 1730: return 0; 1731: } 1732: 1733: # ---------------------------------------- Browser capable of running HTMLArea? 1734: 1735: sub htmlareabrowser { 1736: return 1; 1737: } 1738: 1739: # 1740: # Should the "return to content" link be shown? 1741: # 1742: 1743: sub show_return_link { 1744: 1745: unless ($env{'request.course.id'}) { return 0; } 1746: if ($env{'request.noversionuri'}=~m{^/priv/} || 1747: $env{'request.uri'}=~m{^/priv/}) { return 1; } 1748: return if (($env{'request.noversionuri'} eq '/adm/supplemental') && 1749: ($env{'form.folder'} ne 'supplemental')); 1750: return if (($env{'form.folderpath'} ne '') && 1751: (($env{'request.noversionuri'} =~ m{^/adm/$match_domain/$match_username/aboutme$}) || 1752: ($env{'request.noversionuri'} =~ m{^/public/$match_domain/$match_courseid/syllabus$}))); 1753: return if (($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement') && 1754: (!$env{'request.role.adv'})); 1755: if (($env{'request.noversionuri'} =~ m{^/adm/viewclasslist($|\?)}) 1756: || ($env{'request.noversionuri'} =~ m{^/adm/.*/aboutme($|\?)})) { 1757: 1758: return if ($env{'form.register'}); 1759: } 1760: if ((($env{'request.symb'} ne '') || ($env{'form.folderpath'} ne '')) && 1761: ($env{'request.noversionuri'} =~m{^/adm/coursedocs/showdoc/uploaded/($match_domain)/($match_courseid)/(docs|supplemental)/})) { 1762: my ($cdom,$cnum,$area) = ($1,$2,$3); 1763: if (($env{'course.'.$env{'request.course.id'}.'.domain'} eq $cdom) && 1764: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $cnum)) { 1765: if (($env{'request.symb'}) && ($area eq 'docs')) { 1766: my ($map,$resid,$url) = &Apache::lonnet::decode_symb($env{'request.symb'}); 1767: return if ($env{'request.noversionuri'} eq '/adm/coursedocs/showdoc/'.$url); 1768: } elsif (($env{'form.folderpath'}) && ($area eq 'supplemental')) { 1769: return; 1770: } 1771: } 1772: } 1773: return (($env{'request.noversionuri'}=~m{^/(res|public)/} && 1774: $env{'request.symb'} eq '') 1775: || 1776: ($env{'request.noversionuri'}=~ m{^/cgi-bin/printout.pl}) 1777: || 1778: (($env{'request.noversionuri'}=~/^\/adm\//) && 1779: ($env{'request.noversionuri'}!~/^\/adm\/wrapper\//) && 1780: ($env{'request.noversionuri'}!~ 1781: m{^/adm/.*/(smppg|bulletinboard|ext\.tool)($|\?)}) 1782: )); 1783: } 1784: 1785: 1786: ## 1787: # Set the dueDate variable...note this is done in the timezone 1788: # of the browser. 1789: # 1790: # @param epoch relative time at which the problem is due. 1791: # 1792: # @return the javascript fragment to set the date: 1793: # 1794: sub set_due_date { 1795: my $dueStamp = shift; 1796: my $duems = $dueStamp * 1000; # Javascript Date object needs ms not seconds. 1797: 1798: my $now = time()*1000; 1799: 1800: # This slightly obscure bit of javascript sets the dueDate variable 1801: # to the time in the browser at which the problem was due. 1802: # The code should correct for gross differences between the server 1803: # and client's time setting 1804: 1805: return <<"END"; 1806: 1807: <script type="text/javascript"> 1808: //<![CDATA[ 1809: var serverDueDate = $duems; 1810: var serverTime = $now; 1811: var clientTime = (new Date()).getTime(); 1812: var dueDate = new Date(serverDueDate + (clientTime - serverTime)); 1813: 1814: //]]> 1815: </script> 1816: 1817: END 1818: } 1819: ## 1820: # Sets the time at which the problem finished computing. 1821: # This just updates the serverTime and clientTime variables above. 1822: # Calling this in e.g. end_problem provides a better estimate of the 1823: # difference beetween the server and client time setting as 1824: # the difference contains less of the latency/problem compute time. 1825: # 1826: sub set_compute_end_time { 1827: 1828: my $now = time()*1000; # Javascript times are in ms. 1829: return <<"END"; 1830: 1831: <script type="text/javascript"> 1832: //<![CDATA[ 1833: serverTime = $now; 1834: clientTime = (new Date()).getTime(); 1835: //]]> 1836: </script> 1837: 1838: END 1839: } 1840: 1841: ## 1842: # Client-side javascript to convert any dashes in text pasted 1843: # into textbox(es) for numericalresponse item(s) to a standard 1844: # minus, i.e., - . Calls to dash_to_minus_js() in end_problem() 1845: # and in loncommon::endbodytag() for a .page (arg: dashjs => 1) 1846: # 1847: # Will apply to any input tag with class: LC_numresponse_text. 1848: # Currently set in start_textline for numericalresponse items. 1849: # 1850: 1851: sub dash_to_minus_js { 1852: return <<'ENDJS'; 1853: 1854: <script type="text/javascript"> 1855: //<![CDATA[ 1856: // 1883: //]]> 1884: </script> 1885: 1886: ENDJS 1887: } 1888: 1889: ############################################################ 1890: ############################################################ 1891: 1892: =pod 1893: 1894: =item &breadcrumbs() 1895: 1896: Compiles the previously registered breadcrumbs into an series of links. 1897: Additionally supports a 'component', which will be displayed on the 1898: right side of the breadcrumbs enclosing div (without a link). 1899: A link to help for the component will be included if one is specified. 1900: 1901: All inputs can be undef without problems. 1902: 1903: =over 1904: 1905: =item Inputs: 1906: 1907: =over 1908: 1909: =item $component 1910: 1911: the text on the right side of the breadcrumbs trail 1912: 1913: =item $component_help 1914: 1915: the help item filename (without .tex extension). 1916: 1917: =item $menulink 1918: 1919: boolean, controls whether to include a link to /adm/menu 1920: 1921: =item $helplink 1922: 1923: if 'nohelp' don't include the orange help link 1924: 1925: =item $crumbs_style 1926: 1927: optional style attribute for div containing breadcrumbs 1928: unless called from docs_breadcrumbs 1929: 1930: =item $no_mt 1931: 1932: optional flag, 1 if &mt() is _not_ to be applied to $component when including the text on the right 1933: 1934: =item $CourseBreadcrumbs 1935: 1936: optional flag, 1 if &breadcrumbs called from &docs_breadcrumbs, because breadcrumbs are being 1937: used to display hierarchy for current folder shown in the Course Editor. 1938: 1939: =item $topic_help 1940: 1941: optional help item to be displayed on right side of the breadcrumbs row, using 1942: loncommon::help_open_topic() to generate the link. 1943: 1944: =item $topic_help_text 1945: 1946: text to include in the link in the optional help item ($topic_help) on the right 1947: side of the breadcrumbs row. 1948: 1949: =item $links_target 1950: 1951: optionally includes the target (_top, _parent or _self) for (i) initial 1952: $menulink item in the breadcrumbs (if present), (ii) return to last location 1953: (if present), and (iii) help item at the right side of breadcrumbs menu, 1954: created by loncommon::help_open_topic() or loncommon::help_open_menu(). 1955: 1956: =back 1957: 1958: =back 1959: 1960: Returns a string containing breadcrumbs for the current page. 1961: 1962: =item &clear_breadcrumbs() 1963: 1964: Clears the previously stored breadcrumbs. 1965: 1966: =item &add_breadcrumb() 1967: 1968: Pushes a breadcrumb on the stack of crumbs. 1969: 1970: input: $breadcrumb, a hash reference. The keys 'href','title', and 'text' 1971: are required. If present the keys 'faq' and 'bug' will be used to provide 1972: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title' 1973: and 'text' values won't be sent through &mt() 1974: 1975: returns: nothing 1976: 1977: =cut 1978: 1979: ############################################################ 1980: ############################################################ 1981: { 1982: my @Crumbs; 1983: my %tools = (); 1984: 1985: sub breadcrumbs { 1986: my ($component,$component_help,$menulink,$helplink,$crumbs_style,$no_mt, 1987: $CourseBreadcrumbs,$topic_help,$topic_help_text,$links_target) = @_; 1988: # 1989: # Make the faq and bug data cascade 1990: my $faq = ''; 1991: my $bug = ''; 1992: my $help = ''; 1993: # Crumb Symbol 1994: my $crumbsymbol = '»'; 1995: # The last breadcrumb does not have a link, so handle it separately. 1996: my $last = pop(@Crumbs); 1997: # 1998: # The first one should be the course or a menu link 1999: if (!defined($menulink)) { $menulink=1; } 2000: if ($menulink) { 2001: if ($env{'request.course.id'}) { 2002: my ($menucoll,$deeplinkmenu,$menuref) = &Apache::loncommon::menucoll_in_effect(); 2003: if (($menucoll) && (ref($menuref) eq 'HASH')) { 2004: if ($menuref->{'main'} eq 'n') { 2005: undef($menulink); 2006: } 2007: } 2008: } 2009: } 2010: if ($menulink) { 2011: my $description = 'Menu'; 2012: my $no_mt_descr = 0; 2013: if ((exists($env{'request.course.id'})) && 2014: ($env{'request.course.id'} ne '') && 2015: ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) { 2016: $description = 2017: $env{'course.'.$env{'request.course.id'}.'.description'}; 2018: $no_mt_descr = 1; 2019: if ($env{'request.noversionuri'} =~ 2020: m{^/?public/($match_domain)/($match_courseid)/syllabus$}) { 2021: unless (($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1) && 2022: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $2)) { 2023: $description = 'Menu'; 2024: $no_mt_descr = 0; 2025: } 2026: } 2027: } 2028: my $target = '_top'; 2029: if ($links_target) { 2030: $target = $links_target; 2031: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) || 2032: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) { 2033: $target=''; 2034: } 2035: $menulink = { href =>'/adm/menu', 2036: title =>'Go to main menu', 2037: target =>$target, 2038: text =>$description, 2039: no_mt =>$no_mt_descr, }; 2040: if($last) { 2041: #$last set, so we have some crumbs 2042: unshift(@Crumbs,$menulink); 2043: } else { 2044: #only menulink crumb present 2045: $last = $menulink; 2046: } 2047: } 2048: my $links; 2049: if ((&show_return_link) && (!$CourseBreadcrumbs) && (ref($last) eq 'HASH')) { 2050: my $alttext = &mt('Go Back'); 2051: my $hashref = { href => '/adm/flip?postdata=return:', 2052: title => &mt('Back to most recent content resource'), 2053: class => 'LC_menubuttons_link', 2054: }; 2055: if ($links_target) { 2056: $hashref->{'target'} = $links_target; 2057: } 2058: $links=&htmltag( 'a','<img src="/res/adm/pages/tolastloc.png" alt="'.$alttext.'" class="LC_icon" />', 2059: $hashref); 2060: $links=&htmltag('li',$links); 2061: } 2062: $links.= join "", 2063: map { 2064: $faq = $_->{'faq'} if (exists($_->{'faq'})); 2065: $bug = $_->{'bug'} if (exists($_->{'bug'})); 2066: $help = $_->{'help'} if (exists($_->{'help'})); 2067: 2068: my $result = $_->{no_mt} ? $_->{text} : &mt($_->{text}); 2069: 2070: if ($_->{href}){ 2071: $result = &htmltag( 'a', $result, 2072: { href => $_->{href}, 2073: title => $_->{no_mt} ? $_->{title} : &mt($_->{title}), 2074: target => $_->{target}, }); 2075: } 2076: 2077: $result = &htmltag( 'li', "$result $crumbsymbol"); 2078: } @Crumbs; 2079: 2080: #should the last Element be translated? 2081: 2082: my $lasttext = $last->{'no_mt'} ? $last->{'text'} 2083: : mt( $last->{'text'} ); 2084: 2085: # last breadcrumb is the first order heading of a page 2086: # for course breadcrumbs it's just bold 2087: 2088: if ($lasttext ne '') { 2089: $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1', 2090: $lasttext)); 2091: } 2092: 2093: my $icons = ''; 2094: $faq = $last->{'faq'} if (exists($last->{'faq'})); 2095: $bug = $last->{'bug'} if (exists($last->{'bug'})); 2096: $help = $last->{'help'} if (exists($last->{'help'})); 2097: $component_help=($component_help?$component_help:$help); 2098: # if ($faq ne '') { 2099: # $icons .= &Apache::loncommon::help_open_faq($faq); 2100: # } 2101: # if ($bug ne '') { 2102: # $icons .= &Apache::loncommon::help_open_bug($bug); 2103: # } 2104: if ($faq ne '' || $component_help ne '' || $bug ne '') { 2105: $icons .= &Apache::loncommon::help_open_menu($component, 2106: $component_help, 2107: $faq,$bug,'','','','', 2108: $links_target); 2109: } 2110: if ($topic_help && $topic_help_text) { 2111: $icons .= ' '.&Apache::loncommon::help_open_topic($topic_help,&mt($topic_help_text),'', 2112: undef,600,'',$links_target); 2113: } 2114: # 2115: 2116: 2117: if ($links ne '') { 2118: unless ($CourseBreadcrumbs) { 2119: $links = &htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" }); 2120: } else { 2121: $links = &htmltag('ul', $links, { class => "LC_CourseBreadcrumbs" }); 2122: } 2123: } 2124: 2125: 2126: if (($component) || ($topic_help && $topic_help_text)) { 2127: $links = &htmltag('span', 2128: ( $no_mt ? $component : mt($component) ). 2129: ( $icons ? $icons : '' ), 2130: { class => 'LC_breadcrumbs_component' } ) 2131: .$links 2132: ; 2133: } 2134: my $nav_and_tools = 0; 2135: foreach my $item ('navigation','tools') { 2136: if (ref($tools{$item}) eq 'ARRAY') { 2137: $nav_and_tools += scalar(@{$tools{$item}}) 2138: } 2139: } 2140: if (($links ne '') || ($nav_and_tools)) { 2141: &render_tools(\$links); 2142: unless ($CourseBreadcrumbs) { 2143: my $args = { id => 'LC_breadcrumbs' }; 2144: if ($crumbs_style ne '') { 2145: $args->{'style'} = $crumbs_style; 2146: } 2147: $links = &htmltag('div', $links, $args); 2148: } 2149: } 2150: my $adv_tools = 0; 2151: if (ref($tools{'advtools'}) eq 'ARRAY') { 2152: $adv_tools = scalar(@{$tools{'advtools'}}); 2153: } 2154: if (($links ne '') || ($adv_tools)) { 2155: &render_advtools(\$links); 2156: } 2157: 2158: # Return the @Crumbs stack to what we started with 2159: push(@Crumbs,$last); 2160: shift(@Crumbs); 2161: 2162: 2163: # Return the breadcrumb's line 2164: 2165: my $labeltext = &HTML::Entities::encode(&mt('Links for navigation and information')); 2166: return '<div class="LC_landmark" role="navigation" aria-label="'.$labeltext.'">'.$links.'</div>'; 2167: } 2168: 2169: sub clear_breadcrumbs { 2170: undef(@Crumbs); 2171: undef(%tools); 2172: } 2173: 2174: sub add_breadcrumb { 2175: push(@Crumbs,@_); 2176: } 2177: 2178: =item &add_breadcrumb_tool($category, $html) 2179: 2180: Adds $html to $category of the breadcrumb toolbar container. 2181: 2182: $html is usually a link to a page that invokes a function on the currently 2183: displayed data (e.g. print when viewing a problem) 2184: 2185: =over 2186: 2187: =item Currently there are 3 possible values for $category: 2188: 2189: =over 2190: 2191: =item navigation 2192: left of breadcrumbs line 2193: 2194: =item tools 2195: remaining items in right of breadcrumbs line 2196: 2197: =item advtools 2198: advanced tools shown in a separate box below breadcrumbs line 2199: 2200: =back 2201: 2202: =back 2203: 2204: returns: nothing 2205: 2206: =cut 2207: 2208: sub add_breadcrumb_tool { 2209: my ($category, @html) = @_; 2210: return unless @html; 2211: if (!keys(%tools)) { 2212: %tools = ( navigation => [], tools => [], advtools => []); 2213: } 2214: 2215: #this cleans data received from lonmenu::innerregister 2216: @html = grep {defined $_ && $_ ne ''} @html; 2217: for (@html) { 2218: s/align="(right|left)"//; 2219: # s/<span.*?\/span>// if $category ne 'advtools'; 2220: } 2221: 2222: push @{$tools{$category}}, @html; 2223: } 2224: 2225: =item &clear_breadcrumb_tools() 2226: 2227: Clears the breadcrumb toolbar container. 2228: 2229: returns: nothing 2230: 2231: =cut 2232: 2233: sub clear_breadcrumb_tools { 2234: undef(%tools); 2235: } 2236: 2237: =item &current_breadcrumb_tools() 2238: 2239: returns: a hash containing the current breadcrumb tools. 2240: 2241: =cut 2242: 2243: sub current_breadcrumb_tools { 2244: return %tools; 2245: } 2246: 2247: =item &render_tools(\$breadcrumbs) 2248: 2249: Creates html for breadcrumb tools (categories navigation and tools) and inserts 2250: \$breadcrumbs at the correct position. 2251: 2252: =over 2253: 2254: =item input: 2255: 2256: =over 2257: 2258: =item \$breadcrumbs - a reference to the string containing prepared breadcrumbs. 2259: 2260: =back 2261: 2262: =back 2263: 2264: returns: nothing 2265: 2266: =cut 2267: 2268: #TODO might split this in separate functions for each category 2269: sub render_tools { 2270: my ($breadcrumbs) = @_; 2271: return unless (keys(%tools)); 2272: 2273: my $navigation = list_from_array($tools{navigation}, 2274: { listattr => { class=>"LC_breadcrumb_tools_navigation" } }); 2275: my $tools = list_from_array($tools{tools}, 2276: { listattr => { class=>"LC_breadcrumb_tools_tools" } }); 2277: $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs], 2278: { listattr => { class=>'LC_breadcrumb_tools_outerlist' } }); 2279: } 2280: 2281: =pod 2282: 2283: =item &render_advtools(\$breadcrumbs) 2284: 2285: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs 2286: at the correct position. 2287: 2288: =over 2289: 2290: =item input: 2291: 2292: =over 2293: 2294: =item \$breadcrumbs - a reference to the string containing prepared breadcrumbs (after render_tools call). 2295: 2296: =back 2297: 2298: =back 2299: 2300: returns: nothing 2301: 2302: =cut 2303: 2304: sub render_advtools { 2305: my ($breadcrumbs) = @_; 2306: return unless (defined $tools{'advtools'}) 2307: and (scalar(@{$tools{'advtools'}}) > 0); 2308: 2309: $$breadcrumbs .= Apache::loncommon::head_subbox( 2310: funclist_from_array($tools{'advtools'}) ); 2311: } 2312: 2313: } # End of scope for @Crumbs 2314: 2315: sub docs_breadcrumbs { 2316: my ($allowed,$crstype,$contenteditor,$title,$precleared,$checklinkprot)=@_; 2317: my ($folderpath,@folders,$supplementalflag); 2318: @folders = split('&',$env{'form.folderpath'}); 2319: if ($env{'form.folderpath'} =~ /^supplemental/) { 2320: $supplementalflag = 1; 2321: } 2322: my $plain=''; 2323: my $container = 'sequence'; 2324: my ($randompick,$isencrypted,$ishidden,$is_random_order) = (-1,0,0,0); 2325: my @docs_crumbs; 2326: while (@folders) { 2327: my $folder=shift(@folders); 2328: my $foldername=shift(@folders); 2329: if ($folderpath) {$folderpath.='&';} 2330: $folderpath.=$folder.'&'.$foldername; 2331: my $url = $env{'request.use_absolute'}; 2332: if ($allowed) { 2333: $url .= '/adm/coursedocs?folderpath='; 2334: } else { 2335: $url .= '/adm/supplemental?folderpath='; 2336: } 2337: $url .= &escape($folderpath); 2338: my $name=&unescape($foldername); 2339: # each of randompick number, hidden, encrypted, random order, is_page 2340: # are appended with ":"s to the foldername 2341: $name=~s/\:(\d*)\:(\w*)\:(\w*):(\d*)\:?(\d*)$//; 2342: if ($contenteditor) { 2343: if ($supplementalflag) { 2344: if ($2) { $ishidden=1; } 2345: } else { 2346: if ($1 ne '') { 2347: $randompick=$1; 2348: } else { 2349: $randompick=-1; 2350: } 2351: if ($2) { $ishidden=1; } 2352: if ($3) { $isencrypted=1; } 2353: if ($4 ne '') { $is_random_order = 1; } 2354: if ($5 == 1) {$container = 'page'; } 2355: } 2356: } 2357: if ($folder eq 'supplemental') { 2358: $name = &mt('Supplemental Content'); 2359: } 2360: if ($contenteditor) { 2361: $plain.=$name.' > '; 2362: } 2363: push(@docs_crumbs, 2364: {'href' => $url, 2365: 'title' => $name, 2366: 'text' => $name, 2367: 'no_mt' => 1, 2368: }); 2369: } 2370: if ($title) { 2371: push(@docs_crumbs, 2372: {'title' => $title, 2373: 'text' => $title, 2374: 'no_mt' => 1,} 2375: ); 2376: } 2377: if (wantarray) { 2378: unless ($precleared) { 2379: &clear_breadcrumbs(); 2380: } 2381: &add_breadcrumb(@docs_crumbs); 2382: if ($contenteditor) { 2383: $plain=~s/\&gt\;\s*$//; 2384: } 2385: my $menulink = 0; 2386: if (!$allowed && !$contenteditor && !$supplementalflag) { 2387: $menulink = 1; 2388: } 2389: if ($checklinkprot) { 2390: if ($env{'request.deeplink.login'}) { 2391: my $linkprotout = &Apache::lonmenu::linkprot_exit(); 2392: if ($linkprotout) { 2393: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout); 2394: } 2395: } 2396: } 2397: return (&breadcrumbs(undef,undef,$menulink,'nohelp',undef,undef, 2398: $contenteditor), 2399: $randompick,$ishidden,$isencrypted,$plain, 2400: $is_random_order,$container); 2401: } else { 2402: return \@docs_crumbs; 2403: } 2404: } 2405: 2406: ############################################################ 2407: ############################################################ 2408: 2409: # Nested table routines. 2410: # 2411: # Routines to display form items in a multi-row table with 2 columns. 2412: # Uses nested tables to divide form elements into segments. 2413: # For examples of use see loncom/interface/lonnotify.pm 2414: # 2415: # Can be used in following order: ... 2416: # &start_pick_box() 2417: # row1 2418: # row2 2419: # row3 ... etc. 2420: # &submit_row() 2421: # &end_pick_box() 2422: # 2423: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row, 2424: # &status_select_row and &email_default_row 2425: # 2426: # Can also be used in following order: 2427: # 2428: # &start_pick_box() 2429: # &row_title() 2430: # &row_closure() 2431: # &row_title() 2432: # &row_closure() ... etc. 2433: # &submit_row() 2434: # &end_pick_box() 2435: # 2436: # In general a &submit_row() call should proceed the call to &end_pick_box(), 2437: # as this routine adds a button for form submission. 2438: # &submit_row() does not require a &row_closure after it. 2439: # 2440: # &start_pick_box() creates a bounding table with 1-pixel wide black border. 2441: # rows should be placed between calls to &start_pick_box() and &end_pick_box. 2442: # 2443: # &row_title() adds a title in the left column for each segment. 2444: # &row_closure() closes a row with a 1-pixel wide black line. 2445: # 2446: # &role_select_row() provides a select box from which to choose 1 or more roles 2447: # &course_select_row provides ways of picking groups of courses 2448: # radio buttons: all, by category or by picking from a course picker pop-up 2449: # note: by category option is only displayed if a domain has implemented 2450: # selection by year, semester, department, number etc. 2451: # 2452: # &status_select_row() provides a select box from which to choose 1 or more 2453: # access types (current access, prior access, and future access) 2454: # 2455: # &email_default_row() provides text boxes for default e-mail suffixes for 2456: # different authentication types in a domain. 2457: # 2458: # &row_title() and &row_closure() are called internally by the &*_select_row 2459: # routines, but can also be called directly to start and end rows which have 2460: # needs that are not accommodated by the *_select_row() routines. 2461: 2462: { # Start: row_count block for pick_box 2463: my @row_count; 2464: 2465: sub start_pick_box { 2466: my ($css_class,$id) = @_; 2467: if (defined($css_class)) { 2468: $css_class = 'class="'.$css_class.'"'; 2469: } else { 2470: $css_class= 'class="LC_pick_box"'; 2471: } 2472: my $table_id; 2473: if (defined($id)) { 2474: $table_id = ' id="'.$id.'"'; 2475: } 2476: unshift(@row_count,0); 2477: my $output = <<"END"; 2478: <table $css_class $table_id> 2479: END 2480: return $output; 2481: } 2482: 2483: sub end_pick_box { 2484: shift(@row_count); 2485: my $output = <<"END"; 2486: </table> 2487: END 2488: return $output; 2489: } 2490: 2491: sub row_headline { 2492: my $output = <<"END"; 2493: <tr><td colspan="2"> 2494: END 2495: return $output; 2496: } 2497: 2498: sub row_title { 2499: my ($title,$css_title_class,$css_value_class,$css_value_furtherAttributes,$nocolon) = @_; 2500: $row_count[0]++; 2501: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row'; 2502: $css_title_class ||= 'LC_pick_box_title'; 2503: $css_title_class = 'class="'.$css_title_class.'"'; 2504: 2505: $css_value_class ||= 'LC_pick_box_value'; 2506: 2507: if (($title ne '') && (!$nocolon)) { 2508: $title .= ':'; 2509: } 2510: my $output = <<"ENDONE"; 2511: <tr class="LC_pick_box_row" $css_value_furtherAttributes> 2512: <th $css_title_class> 2513: $title 2514: </th> 2515: <td class="$css_value_class $css_class"> 2516: ENDONE 2517: return $output; 2518: } 2519: 2520: sub row_closure { 2521: my ($no_separator) =@_; 2522: my $output = <<"ENDTWO"; 2523: </td> 2524: </tr> 2525: ENDTWO 2526: if (!$no_separator) { 2527: $output .= <<"ENDTWO"; 2528: <tr> 2529: <td colspan="2" class="LC_pick_box_separator"> 2530: </td> 2531: </tr> 2532: ENDTWO 2533: } 2534: return $output; 2535: } 2536: 2537: } # End: row_count block for pick_box 2538: 2539: sub role_select_row { 2540: my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_; 2541: my $crstype = 'Course'; 2542: if ($cdom ne '' && $cnum ne '') { 2543: $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum); 2544: } 2545: my $output; 2546: if (defined($title)) { 2547: $output = &row_title($title,$css_class); 2548: } 2549: $output .= qq| 2550: <select name="roles" multiple="multiple">\n|; 2551: foreach my $role (@$roles) { 2552: my $plrole; 2553: if ($role eq 'ow') { 2554: $plrole = &mt('Course Owner'); 2555: } elsif ($role eq 'cr') { 2556: if ($show_separate_custom) { 2557: if ($cdom ne '' && $cnum ne '') { 2558: my %course_customroles = &course_custom_roles($cdom,$cnum); 2559: foreach my $crrole (sort(keys(%course_customroles))) { 2560: my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|); 2561: $output .= ' <option value="'.$crrole.'">'.$plcrrole. 2562: '</option>'; 2563: } 2564: } 2565: } else { 2566: $plrole = &mt('Custom Role'); 2567: } 2568: } else { 2569: $plrole=&Apache::lonnet::plaintext($role,$crstype); 2570: } 2571: if (($role ne 'cr') || (!$show_separate_custom)) { 2572: $output .= ' <option value="'.$role.'">'.$plrole.'</option>'; 2573: } 2574: } 2575: $output .= qq| </select>\n|; 2576: if (defined($title)) { 2577: $output .= &row_closure(); 2578: } 2579: return $output; 2580: } 2581: 2582: sub course_select_row { 2583: my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles, 2584: $css_class,$crstype,$standardnames) = @_; 2585: my $output = &row_title($title,$css_class); 2586: $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames); 2587: $output .= &row_closure(); 2588: return $output; 2589: } 2590: 2591: sub course_selection { 2592: my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype,$standardnames) = @_; 2593: my $output = qq| 2594: <script type="text/javascript"> 2595: // <![CDATA[ 2596: function coursePick (formname) { 2597: for (var i=0; i<formname.coursepick.length; i++) { 2598: if (formname.coursepick[i].value == 'category') { 2599: courseSet(''); 2600: } 2601: if (!formname.coursepick[i].checked) { 2602: if (formname.coursepick[i].value == 'specific') { 2603: formname.coursetotal.value = 0; 2604: formname.courselist = ''; 2605: } 2606: } 2607: } 2608: } 2609: function setPick (formname) { 2610: for (var i=0; i<formname.coursepick.length; i++) { 2611: if (formname.coursepick[i].value == 'category') { 2612: formname.coursepick[i].checked = true; 2613: } 2614: formname.coursetotal.value = 0; 2615: formname.courselist = ''; 2616: } 2617: } 2618: // ]]> 2619: </script> 2620: |; 2621: 2622: my ($allcrs,$pickspec); 2623: if ($crstype eq 'Community') { 2624: $allcrs = &mt('All communities'); 2625: $pickspec = &mt('Pick specific communities:'); 2626: } else { 2627: $allcrs = &mt('All courses'); 2628: $pickspec = &mt('Pick specific course(s):'); 2629: } 2630: 2631: my $courseform='<b>'.&Apache::loncommon::selectcourse_link 2632: ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>'; 2633: $output .= '<label><input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'</label><br />'; 2634: if ($totcodes > 0) { 2635: my $numtitles = @$codetitles; 2636: if ($numtitles > 0) { 2637: $output .= '<label><input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&html_escape(&mt('Choose categories, from left to right'))."'".')" />'.&mt('Pick courses by category:').'</label><br />'; 2638: $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n". 2639: '<select name="'.$standardnames->[0]. 2640: '" onchange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n". 2641: ' <option value="-1" />Select'."\n"; 2642: my @items = (); 2643: my @longitems = (); 2644: if ($$idlist{$$codetitles[0]} =~ /","/) { 2645: @items = split(/","/,$$idlist{$$codetitles[0]}); 2646: } else { 2647: $items[0] = $$idlist{$$codetitles[0]}; 2648: } 2649: if (defined($$idlist_titles{$$codetitles[0]})) { 2650: if ($$idlist_titles{$$codetitles[0]} =~ /","/) { 2651: @longitems = split(/","/,$$idlist_titles{$$codetitles[0]}); 2652: } else { 2653: $longitems[0] = $$idlist_titles{$$codetitles[0]}; 2654: } 2655: for (my $i=0; $i<@longitems; $i++) { 2656: if ($longitems[$i] eq '') { 2657: $longitems[$i] = $items[$i]; 2658: } 2659: } 2660: } else { 2661: @longitems = @items; 2662: } 2663: for (my $i=0; $i<@items; $i++) { 2664: $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>'; 2665: } 2666: $output .= '</select></td>'; 2667: for (my $i=1; $i<$numtitles; $i++) { 2668: $output .= '<td>'.$$codetitles[$i].'<br />'."\n". 2669: '<select name="'.$standardnames->[$i]. 2670: '" onchange="courseSet('."'$$codetitles[$i]'".')">'."\n". 2671: '<option value="-1"><-Pick '.$$codetitles[$i-1].'</option>'."\n". 2672: '</select>'."\n". 2673: '</td>'; 2674: } 2675: $output .= '</tr></table><br />'; 2676: } 2677: } 2678: $output .= 2679: '<label><input type="radio" name="coursepick" value="specific"' 2680: .' onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />' 2681: .$pickspec.'</label>' 2682: .' '.$courseform.'  ' 2683: .&mt('[_1] selected.', 2684: '<input type="text" value="0" size="4" name="coursetotal" readonly="readonly" />' 2685: .'<input type="hidden" name="courselist" value="" />') 2686: .'<br />'."\n"; 2687: return $output; 2688: } 2689: 2690: sub status_select_row { 2691: my ($types,$title,$css_class) = @_; 2692: my $output; 2693: if (defined($title)) { 2694: $output = &row_title($title,$css_class,'LC_pick_box_select'); 2695: } 2696: $output .= qq| 2697: <select name="types" multiple="multiple">\n|; 2698: foreach my $status_type (sort(keys(%{$types}))) { 2699: $output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>'; 2700: } 2701: $output .= qq| </select>\n|; 2702: if (defined($title)) { 2703: $output .= &row_closure(); 2704: } 2705: return $output; 2706: } 2707: 2708: sub email_default_row { 2709: my ($authtypes,$title,$descrip,$css_class) = @_; 2710: my $output = &row_title($title,$css_class); 2711: $output .= $descrip. 2712: &Apache::loncommon::start_data_table(). 2713: &Apache::loncommon::start_data_table_header_row(). 2714: '<th>'.&mt('Authentication Method').'</th>'. 2715: '<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n". 2716: &Apache::loncommon::end_data_table_header_row(); 2717: my $rownum = 0; 2718: foreach my $auth (sort(keys(%{$authtypes}))) { 2719: my ($userentry,$size); 2720: if ($auth =~ /^krb/) { 2721: $userentry = ''; 2722: $size = 25; 2723: } else { 2724: $userentry = 'username@'; 2725: $size = 15; 2726: } 2727: $output .= &Apache::loncommon::start_data_table_row(). 2728: '<td> '.$$authtypes{$auth}.'</td>'. 2729: '<td align="right">'.$userentry. 2730: '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'. 2731: &Apache::loncommon::end_data_table_row(); 2732: } 2733: $output .= &Apache::loncommon::end_data_table(); 2734: $output .= &row_closure(); 2735: return $output; 2736: } 2737: 2738: 2739: sub submit_row { 2740: my ($title,$cmd,$submit_text,$css_class) = @_; 2741: my $output = &row_title($title,$css_class,'LC_pick_box_submit'); 2742: $output .= qq| 2743: <br /> 2744: <input type="hidden" name="command" value="$cmd" /> 2745: <input type="submit" value="$submit_text"/>   2746: <br /><br /> 2747: \n|; 2748: return $output; 2749: } 2750: 2751: sub course_custom_roles { 2752: my ($cdom,$cnum) = @_; 2753: my %returnhash=(); 2754: my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum); 2755: foreach my $person (sort(keys(%coursepersonnel))) { 2756: my ($role) = ($person =~ /^([^:]+):/); 2757: my ($end,$start) = split(/:/,$coursepersonnel{$person}); 2758: if ($end == -1 && $start == -1) { 2759: next; 2760: } 2761: if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) { 2762: $returnhash{$role} ++; 2763: } 2764: } 2765: return %returnhash; 2766: } 2767: 2768: 2769: sub resource_info_box { 2770: my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp,$divforres)=@_; 2771: my $return=''; 2772: if (($stuvcurrent ne '') || ($divforres)) { 2773: $return = '<div class="LC_left_float">'; 2774: } 2775: if ($symb) { 2776: $return.=&Apache::loncommon::start_data_table(); 2777: my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb); 2778: my $folder=&Apache::lonnet::gettitle($map); 2779: $return.=&Apache::loncommon::start_data_table_row(). 2780: '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'. 2781: &Apache::loncommon::end_data_table_row(); 2782: unless ($onlyfolderflag) { 2783: $return.=&Apache::loncommon::start_data_table_row(). 2784: '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'. 2785: &Apache::loncommon::end_data_table_row(); 2786: } 2787: if ($stuvcurrent ne '') { 2788: $return .= &Apache::loncommon::start_data_table_row(). 2789: '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'. 2790: &Apache::loncommon::end_data_table_row(); 2791: } 2792: if ($stuvdisp ne '') { 2793: $return .= &Apache::loncommon::start_data_table_row(). 2794: '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'. 2795: &Apache::loncommon::end_data_table_row(); 2796: } 2797: $return.=&Apache::loncommon::end_data_table(); 2798: } else { 2799: $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>'; 2800: } 2801: if (($stuvcurrent ne '') || ($divforres)) { 2802: $return .= '</div>'; 2803: } 2804: return $return; 2805: } 2806: 2807: # display_usage 2808: # 2809: # Generates a div containing a block, filled to show percentage of current quota used 2810: # 2811: # Quotas available for user portfolios, group portfolios, authoring spaces, and course 2812: # content stored directly within a course (i.e., excluding published content). 2813: # 2814: 2815: sub display_usage { 2816: my ($current_disk_usage,$disk_quota,$context) = @_; 2817: my $usage = $current_disk_usage/1024; 2818: my $quota = $disk_quota/1024; 2819: my $percent; 2820: if ($disk_quota == 0) { 2821: $percent = 100.0; 2822: } else { 2823: $percent = 100*($current_disk_usage/$disk_quota); 2824: } 2825: $usage = sprintf("%.2f",$usage); 2826: $quota = sprintf("%.2f",$quota); 2827: $percent = sprintf("%.0f",$percent); 2828: my ($color,$cssclass); 2829: if ($percent <= 60) { 2830: $color = '#00A000'; 2831: } elsif ($percent > 60 && $percent < 90) { 2832: $color = '#FFD300'; 2833: $cssclass = 'class="LC_warning"'; 2834: } elsif( $percent >= 90) { 2835: $color = '#FF0000'; 2836: $cssclass = 'class="LC_error"'; 2837: } 2838: my $prog_width = $percent; 2839: if ($prog_width > 100) { 2840: $prog_width = 100; 2841: } 2842: my $display = 'block'; 2843: if ($context eq 'authoring') { 2844: $display = 'inline'; 2845: } 2846: return ' 2847: <div id="meter1" align="left" style="display:'.$display.'" '.$cssclass.'>'.&mt('Currently using [_1] of the [_2] available.',$usage.' MB <span style="font-weight:bold;">('.$percent.'%)</span>',$quota.' MB')."\n". 2848: ' <div id="meter2" style="display:block; margin-top:3px; margin-bottom:3px; margin-left:0px; margin-right:0px; width:400px; border:1px solid #000000; height:10px;">'."\n". 2849: ' <div id="meter3" style="display:block; background-color:'.$color.'; width:'.$prog_width.'%; height:10px; color:#000000; margin:0px;"></div>'."\n". 2850: ' </div>'."\n". 2851: ' </div>'; 2852: } 2853: 2854: ############################################## 2855: ############################################## 2856: 2857: # topic_bar 2858: # 2859: # Generates a div containing an (optional) number with a white background followed by a 2860: # title with a background color defined in the corresponding CSS: LC_topic_bar 2861: # Inputs: 2862: # 1. number to display. 2863: # If input for number is empty only the title will be displayed. 2864: # 2. title text to display. 2865: # 3. optional id for the <div> 2866: # Outputs - a scalar containing html mark-up for the div. 2867: 2868: sub topic_bar { 2869: my ($num,$title,$id) = @_; 2870: my $number = ''; 2871: if ($num ne '') { 2872: $number = '<span>'.$num.'</span>'; 2873: } 2874: if ($id ne '') { 2875: $id = 'id="'.$id.'"'; 2876: } 2877: return '<div class="LC_topic_bar" '.$id.'>'.$number.$title.'</div>'; 2878: } 2879: 2880: ############################################## 2881: ############################################## 2882: # echo_form_input 2883: # 2884: # Generates html markup to add form elements from the referrer page 2885: # as hidden form elements (values encoded) in the new page. 2886: # 2887: # Intended to support two types of use 2888: # (a) to allow backing up to earlier pages in a multi-page 2889: # form submission process using a breadcrumb trail. 2890: # 2891: # (b) to allow the current page to be reloaded with form elements 2892: # set on previous page to remain unchanged. An example would 2893: # be where the a page containing a dynamically-built table of data is 2894: # is to be redisplayed, with only the sort order of the data changed. 2895: # 2896: # Inputs: 2897: # 1. Reference to array of form elements in the submitted form on 2898: # the referrer page which are to be excluded from the echoed elements. 2899: # 2900: # 2. Reference to array of regular expressions, which if matched in the 2901: # name of the form element n the referrer page will be omitted from echo. 2902: # 2903: # Outputs: A scalar containing the html markup for the echoed form 2904: # elements (all as hidden elements, with values encoded). 2905: 2906: 2907: sub echo_form_input { 2908: my ($excluded,$regexps) = @_; 2909: my $output = ''; 2910: foreach my $key (keys(%env)) { 2911: if ($key =~ /^form\.(.+)$/) { 2912: my $name = $1; 2913: my $match = 0; 2914: if (ref($excluded) eq 'ARRAY') { 2915: next if (grep(/^\Q$name\E$/,@{$excluded})); 2916: } 2917: if (ref($regexps) eq 'ARRAY') { 2918: if (@{$regexps} > 0) { 2919: foreach my $regexp (@{$regexps}) { 2920: if ($name =~ /$regexp/) { 2921: $match = 1; 2922: last; 2923: } 2924: } 2925: } 2926: } 2927: next if ($match); 2928: if (ref($env{$key}) eq 'ARRAY') { 2929: foreach my $value (@{$env{$key}}) { 2930: $value = &HTML::Entities::encode($value,'<>&"'); 2931: $output .= '<input type="hidden" name="'.$name. 2932: '" value="'.$value.'" />'."\n"; 2933: } 2934: } else { 2935: my $value = &HTML::Entities::encode($env{$key},'<>&"'); 2936: $output .= '<input type="hidden" name="'.$name. 2937: '" value="'.$value.'" />'."\n"; 2938: } 2939: } 2940: } 2941: return $output; 2942: } 2943: 2944: ############################################## 2945: ############################################## 2946: # set_form_elements 2947: # 2948: # Generates javascript to set form elements to values based on 2949: # corresponding values for the same form elements when the page was 2950: # previously submitted. 2951: # 2952: # Last submission values are read from hidden form elements in referring 2953: # page which have the same name, i.e., generated by &echo_form_input(). 2954: # 2955: # Intended to be called by onload event. 2956: # 2957: # Inputs: 2958: # (a) Reference to hash of echoed form elements to be set. 2959: # 2960: # In the hash, keys are the form element names, and the values are the 2961: # element type (selectbox, radio, checkbox or text -for textbox, textarea or 2962: # hidden). 2963: # 2964: # (b) Optional reference to hash of stored elements to be set. 2965: # 2966: # If the page being displayed is a page which permits modification of 2967: # previously stored data, e.g., the first page in a multi-page submission, 2968: # then if stored is supplied, form elements will be set to the last stored 2969: # values. If user supplied values are also available for the same elements 2970: # these will replace the stored values. 2971: # 2972: # Output: 2973: # 2974: # javascript function - set_form_elements() which sets form elements, 2975: # expects an argument: formname - the name of the form according to 2976: # the DOM, e.g., document.compose 2977: 2978: sub set_form_elements { 2979: my ($elements,$stored) = @_; 2980: my %values; 2981: my $output .= 'function setFormElements(courseForm) { 2982: '; 2983: if (defined($stored)) { 2984: foreach my $name (keys(%{$stored})) { 2985: if (exists($$elements{$name})) { 2986: if (ref($$stored{$name}) eq 'ARRAY') { 2987: $values{$name} = $$stored{$name}; 2988: } else { 2989: @{$values{$name}} = ($$stored{$name}); 2990: } 2991: } 2992: } 2993: } 2994: 2995: foreach my $key (keys(%env)) { 2996: if ($key =~ /^form\.(.+)$/) { 2997: my $name = $1; 2998: if (exists($$elements{$name})) { 2999: @{$values{$name}} = &Apache::loncommon::get_env_multiple($key); 3000: } 3001: } 3002: } 3003: 3004: foreach my $name (keys(%values)) { 3005: for (my $i=0; $i<@{$values{$name}}; $i++) { 3006: $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"'); 3007: $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g; 3008: $values{$name}[$i] =~ s/"/\\"/g; 3009: } 3010: if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) { 3011: my $numvalues = @{$values{$name}}; 3012: if ($numvalues > 1) { 3013: my $valuestring = join('","',@{$values{$name}}); 3014: $output .= qq| 3015: var textvalues = new Array ("$valuestring"); 3016: var total = courseForm.elements['$name'].length; 3017: if (total > $numvalues) { 3018: total = $numvalues; 3019: } 3020: for (var i=0; i<total; i++) { 3021: courseForm.elements['$name']\[i].value = textvalues[i]; 3022: } 3023: |; 3024: } else { 3025: $output .= qq| 3026: courseForm.elements['$name'].value = "$values{$name}[0]"; 3027: |; 3028: } 3029: } else { 3030: $output .= qq| 3031: var elementLength = courseForm.elements['$name'].length; 3032: if (elementLength==undefined) { 3033: |; 3034: foreach my $value (@{$values{$name}}) { 3035: if ($$elements{$name} eq 'selectbox') { 3036: $output .= qq| 3037: if (courseForm.elements['$name'].options[0].value == "$value") { 3038: courseForm.elements['$name'].options[0].selected = true; 3039: }|; 3040: } elsif (($$elements{$name} eq 'radio') || 3041: ($$elements{$name} eq 'checkbox')) { 3042: $output .= qq| 3043: if (courseForm.elements['$name'].value == "$value") { 3044: courseForm.elements['$name'].checked = true; 3045: } else { 3046: courseForm.elements['$name'].checked = false; 3047: }|; 3048: } 3049: } 3050: $output .= qq| 3051: } 3052: else { 3053: for (var i=0; i<courseForm.elements['$name'].length; i++) { 3054: |; 3055: if ($$elements{$name} eq 'selectbox') { 3056: $output .= qq| 3057: courseForm.elements['$name'].options[i].selected = false;|; 3058: } elsif (($$elements{$name} eq 'radio') || 3059: ($$elements{$name} eq 'checkbox')) { 3060: $output .= qq| 3061: courseForm.elements['$name']\[i].checked = false;|; 3062: } 3063: $output .= qq| 3064: } 3065: for (var j=0; j<courseForm.elements['$name'].length; j++) { 3066: |; 3067: foreach my $value (@{$values{$name}}) { 3068: if ($$elements{$name} eq 'selectbox') { 3069: $output .= qq| 3070: if (courseForm.elements['$name'].options[j].value == "$value") { 3071: courseForm.elements['$name'].options[j].selected = true; 3072: }|; 3073: } elsif (($$elements{$name} eq 'radio') || 3074: ($$elements{$name} eq 'checkbox')) { 3075: $output .= qq| 3076: if (courseForm.elements['$name']\[j].value == "$value") { 3077: courseForm.elements['$name']\[j].checked = true; 3078: }|; 3079: } 3080: } 3081: $output .= qq| 3082: } 3083: } 3084: |; 3085: } 3086: } 3087: $output .= " 3088: return; 3089: }\n"; 3090: return $output; 3091: } 3092: 3093: ############################################## 3094: ############################################## 3095: 3096: sub file_submissionchk_js { 3097: my ($turninpaths,$multiples) = @_; 3098: my $overwritewarn = &mt('File(s) you uploaded for your submission will overwrite existing file(s) submitted for this item')."\n". 3099: &mt('Continue submission and overwrite the file(s)?'); 3100: &js_escape(\$overwritewarn); 3101: my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.')."\n". 3102: &mt('Continue submission with these files removed?'); 3103: &js_escape(\$delfilewarn); 3104: my ($turninpathtext,$multtext,$arrayindexofjs); 3105: if (ref($turninpaths) eq 'HASH') { 3106: foreach my $key (sort(keys(%{$turninpaths}))) { 3107: $turninpathtext .= " if (prefix == '$key') {\n". 3108: " return '$turninpaths->{$key}';\n". 3109: " }\n"; 3110: } 3111: } 3112: $turninpathtext .= " return '';\n"; 3113: if (ref($multiples) eq 'HASH') { 3114: foreach my $key (sort(keys(%{$multiples}))) { 3115: $multtext .= " if (prefix == '$key') {\n". 3116: " return '$multiples->{$key}';\n". 3117: " }\n"; 3118: } 3119: } 3120: $multtext .= " return '';\n"; 3121: 3122: $arrayindexofjs = &Apache::loncommon::javascript_array_indexof(); 3123: return <<"ENDSCRIPT"; 3124: <script type="text/javascript"> 3125: // <![CDATA[ 3126: 3127: function file_submission_check(formname,path,multiresp) { 3128: var elemnum = formname.elements.length; 3129: if (elemnum == 0) { 3130: return true; 3131: } 3132: var alloverwrites = []; 3133: var alldelconfirm = []; 3134: var result = []; 3135: var submitter; 3136: var subprefix; 3137: var allsub = getIndexByName(formname,'all_submit'); 3138: if (allsub == -1) { 3139: var idx = getIndexByName(formname,'submitted'); 3140: if (idx != -1) { 3141: var subval = String(formname.elements[idx].value); 3142: submitter = subval.replace(/^part_/,''); 3143: result = overwritten_check(formname,path,multiresp,submitter); 3144: alloverwrites.push.apply(alloverwrites,result['overwrite']); 3145: alldelconfirm.push.apply(alldelconfirm,result['delete']); 3146: } 3147: } else { 3148: if (formname.elements[allsub].type == 'submit') { 3149: var partsub = /^\\d+\\.\\d+_submit_.+\$/; 3150: var allprefixes = []; 3151: var allparts = []; 3152: for (var i=0; i<formname.elements.length; i++) { 3153: if (formname.elements[i].type == 'submit') { 3154: var elemname = formname.elements[i].name; 3155: var subname = String(elemname); 3156: var savesub = String(elemname); 3157: if (partsub.test(subname)) { 3158: var prefix = subname.replace(/_submit_.+\$/,''); 3159: if (allprefixes.indexOf(prefix) == -1) { 3160: allprefixes.push(prefix); 3161: allparts[prefix] = []; 3162: } 3163: var part = savesub.replace(/^\\d+\\.\\d+_submit_/,''); 3164: allparts[prefix].push(part); 3165: } 3166: } 3167: } 3168: for (var k=0; k<allprefixes.length; k++) { 3169: var idx = getIndexByName(formname,allprefixes[k]+'_submitted'); 3170: if (idx > -1) { 3171: if (formname.elements[idx].value != 'yes') { 3172: submitterval = formname.elements[idx].value; 3173: submitter = submitterval.replace(/^part_/,''); 3174: subprefix = allprefixes[k]; 3175: result = overwritten_check(formname,path,multiresp,submitter,subprefix); 3176: alloverwrites.push.apply(alloverwrites,result['overwrite']); 3177: alldelconfirm.push.apply(alldelconfirm,result['delete']); 3178: break; 3179: } 3180: } 3181: } 3182: if (submitter == '' || submitter == undefined) { 3183: for (var m=0; m<allprefixes.length; m++) { 3184: for (var n=0; n<allparts[allprefixes[m]].length; n++) { 3185: var result = overwritten_check(formname,path,multiresp,allparts[allprefixes[m]][n],allprefixes[m]); 3186: alloverwrites.push.apply(alloverwrites,result['overwrite']); 3187: alldelconfirm.push.apply(alldelconfirm,result['delete']); 3188: } 3189: } 3190: } 3191: } 3192: } 3193: if (alloverwrites.length > 0) { 3194: if (!confirm("$overwritewarn")) { 3195: for (var n=0; n<alloverwrites.length; n++) { 3196: formname.elements[alloverwrites[n]].value = ""; 3197: } 3198: return false; 3199: } 3200: } 3201: if (alldelconfirm.length > 0) { 3202: if (!confirm("$delfilewarn")) { 3203: for (var p=0; p<alldelconfirm.length; p++) { 3204: formname.elements[alldelconfirm[p]].checked = false; 3205: } 3206: return false; 3207: } 3208: } 3209: return true; 3210: } 3211: 3212: function getIndexByName(formname,item) { 3213: for (var i=0;i<formname.elements.length;i++) { 3214: if (formname.elements[i].name == item) { 3215: return i; 3216: } 3217: } 3218: return -1; 3219: } 3220: 3221: function overwritten_check(formname,path,multiresp,part,prefix) { 3222: var result = []; 3223: result['overwrite'] = []; 3224: result['delete'] = []; 3225: var elemnum = formname.elements.length; 3226: if (elemnum == 0) { 3227: return result; 3228: } 3229: var uploadstr; 3230: var deletestr; 3231: if ((prefix != undefined) && (prefix != '')) { 3232: var prepend = prefix+'_'; 3233: uploadstr = new RegExp("^"+prepend+"HWFILE"+part+".+\$"); 3234: deletestr = new RegExp("^"+prepend+"HWFILE"+part+".+_\\\\d+_delete\$"); 3235: multiresp = check_for_multiples(prepend); 3236: path = check_for_turninpath(prepend); 3237: } else { 3238: uploadstr = new RegExp("^HWFILE"+part+".+\$"); 3239: deletestr = new RegExp("^HWFILE"+part+".+_\\\\d+_delete\$"); 3240: } 3241: var alluploads = []; 3242: var allchecked = []; 3243: var allskipdel = []; 3244: var fnametrim = /[^\\/\\\\]+\$/; 3245: for (var i=0; i<formname.elements.length; i++) { 3246: var id = formname.elements[i].id; 3247: if (id != '') { 3248: if (uploadstr.test(id)) { 3249: if (formname.elements[i].type == 'file') { 3250: alluploads.push(id); 3251: } else { 3252: if (deletestr.test(id)) { 3253: if (formname.elements[i].type == 'checkbox') { 3254: if (formname.elements[i].checked) { 3255: allchecked.push(id); 3256: } 3257: } 3258: } 3259: } 3260: } 3261: } 3262: } 3263: for (var j=0; j<alluploads.length; j++) { 3264: var delstr = new RegExp("^"+alluploads[j]+"_\\\\d+_delete\$"); 3265: var delboxes = []; 3266: for (var k=0; k<formname.elements.length; k++) { 3267: var id = formname.elements[k].id; 3268: if ((id != '') && (id != undefined)) { 3269: if (delstr.test(id)) { 3270: if (formname.elements[k].type == 'checkbox') { 3271: delboxes.push(id); 3272: } 3273: } 3274: } 3275: } 3276: if (delboxes.length > 0) { 3277: if ((formname.elements[alluploads[j]].value != undefined) && 3278: (formname.elements[alluploads[j]].value != '')) { 3279: var filepath = formname.elements[alluploads[j]].value; 3280: var newfilename = fnametrim.exec(filepath); 3281: if (newfilename != null) { 3282: var filename = String(newfilename); 3283: var nospaces = filename.replace(/\\s+/g,'_'); 3284: var nospecials = nospaces.replace(/[^\\/\\w\\.\\-]/g,''); 3285: var cleanfilename = nospecials.replace(/\\.(\\d+\\.)/g,"_\$1"); 3286: if (cleanfilename != '') { 3287: var fullpath = path+"/"+cleanfilename; 3288: if (multiresp == 1) { 3289: var partid = String(alluploads[i]); 3290: var subdir = partid.replace(/^\\d*.?\\d*_?HWFILE/,''); 3291: if (subdir != "" && subdir != undefined) { 3292: fullpath = path+"/"+subdir+"/"+cleanfilename; 3293: } 3294: } 3295: for (var m=0; m<delboxes.length; m++) { 3296: if (fullpath == formname.elements[delboxes[m]].value) { 3297: if (formname.elements[delboxes[m]].checked) { 3298: allskipdel.push(delboxes[m]); 3299: } else { 3300: result['overwrite'].push(alluploads[j]); 3301: } 3302: break; 3303: } 3304: } 3305: } 3306: } 3307: } 3308: } 3309: } 3310: if (allchecked.length > 0) { 3311: if (allskipdel.length > 0) { 3312: for (var n=0; n<allchecked.length; n++) { 3313: if (allskipdel.indexOf(allchecked[n]) == -1) { 3314: result['delete'].push(allchecked[n]); 3315: } 3316: } 3317: } else { 3318: result['delete'].push.apply(result['delete'],allchecked); 3319: } 3320: } 3321: return result; 3322: } 3323: 3324: function check_for_multiples(prefix) { 3325: $multtext 3326: } 3327: 3328: function check_for_turninpath(prefix) { 3329: $turninpathtext 3330: } 3331: 3332: // ]]> 3333: </script> 3334: 3335: $arrayindexofjs 3336: 3337: ENDSCRIPT 3338: } 3339: 3340: ############################################## 3341: ############################################## 3342: 3343: sub resize_scrollbox_js { 3344: my ($context,$tabidstr,$tid) = @_; 3345: my (%names,$paddingwfrac,$offsetwfrac,$offsetv,$minw,$minv); 3346: if ($context eq 'docs') { 3347: %names = ( 3348: boxw => 'contenteditor', 3349: item => 'contentlist', 3350: header => 'uploadfileresult', 3351: scroll => 'contentscroll', 3352: boxh => 'contenteditor', 3353: ); 3354: $paddingwfrac = 0.09; 3355: $offsetwfrac = 0.015; 3356: $offsetv = 20; 3357: $minw = 250; 3358: $minv = 200; 3359: } elsif ($context eq 'params') { 3360: %names = ( 3361: boxw => 'parameditor', 3362: item => 'mapmenuinner', 3363: header => 'parmstep1', 3364: scroll => 'mapmenuscroll', 3365: boxh => 'parmlevel', 3366: ); 3367: $paddingwfrac = 0.2; 3368: $offsetwfrac = 0.015; 3369: $offsetv = 80; 3370: $minw = 100; 3371: $minv = 100; 3372: } 3373: my $viewport_js = &Apache::loncommon::viewport_geometry_js(); 3374: my $output = ' 3375: 3376: window.onresize=callResize; 3377: 3378: '; 3379: if ($context eq 'docs') { 3380: if ($env{'form.active'}) { 3381: $output .= "\nvar activeTab = '$env{'form.active'}$tid';\n"; 3382: } else { 3383: $output .= "\nvar activeTab = '';\n"; 3384: } 3385: } 3386: $output .= <<"FIRST"; 3387: 3388: $viewport_js 3389: 3390: function resize_scrollbox(scrollboxname,chkw,chkh) { 3391: var scrollboxid = 'div_'+scrollboxname; 3392: var scrolltableid = 'table_'+scrollboxname; 3393: var scrollbox; 3394: var scrolltable; 3395: var ismobile = '$env{'browser.mobile'}'; 3396: 3397: if (document.getElementById("$names{'boxw'}") == null) { 3398: return; 3399: } 3400: 3401: if (document.getElementById(scrollboxid) == null) { 3402: return; 3403: } else { 3404: scrollbox = document.getElementById(scrollboxid); 3405: } 3406: 3407: 3408: if (document.getElementById(scrolltableid) == null) { 3409: return; 3410: } else { 3411: scrolltable = document.getElementById(scrolltableid); 3412: } 3413: 3414: init_geometry(); 3415: var vph = Geometry.getViewportHeight(); 3416: var vpw = Geometry.getViewportWidth(); 3417: 3418: FIRST 3419: if ($context eq 'docs') { 3420: $output .= " 3421: var alltabs = ['$tabidstr']; 3422: "; 3423: } elsif ($context eq 'params') { 3424: $output .= " 3425: if (document.getElementById('$names{'boxh'}') == null) { 3426: return; 3427: } 3428: "; 3429: } 3430: $output .= <<"SECOND"; 3431: var listwchange; 3432: var scrollchange; 3433: if (chkw == 1) { 3434: var boxw = document.getElementById("$names{'boxw'}").offsetWidth; 3435: var itemw; 3436: var itemid = document.getElementById("$names{'item'}"); 3437: if (itemid != null) { 3438: itemw = itemid.offsetWidth; 3439: } 3440: var itemwstart = itemw; 3441: 3442: var scrollboxw = scrollbox.offsetWidth; 3443: var scrollboxscrollw = scrollbox.scrollWidth; 3444: var scrollstart = scrollboxw; 3445: 3446: var offsetw = parseInt(vpw * $offsetwfrac); 3447: var paddingw = parseInt(vpw * $paddingwfrac); 3448: 3449: var minscrollboxw = $minw; 3450: var maxcolw = 0; 3451: SECOND 3452: if ($context eq 'docs') { 3453: $output .= <<"DOCSONE"; 3454: var actabw = 0; 3455: for (var i=0; i<alltabs.length; i++) { 3456: if (activeTab == alltabs[i]) { 3457: actabw = document.getElementById(alltabs[i]).offsetWidth; 3458: if (actabw > maxcolw) { 3459: maxcolw = actabw; 3460: } 3461: } else { 3462: if (document.getElementById(alltabs[i]) != null) { 3463: var thistab = document.getElementById(alltabs[i]); 3464: thistab.style.visibility = 'hidden'; 3465: thistab.style.display = 'block'; 3466: var tabw = document.getElementById(alltabs[i]).offsetWidth; 3467: thistab.style.display = 'none'; 3468: thistab.style.visibility = ''; 3469: if (tabw > maxcolw) { 3470: maxcolw = tabw; 3471: } 3472: } 3473: } 3474: } 3475: DOCSONE 3476: } elsif ($context eq 'params') { 3477: $output .= <<"PARAMSONE"; 3478: var parmlevelrows = new Array(); 3479: var mapmenucells = new Array(); 3480: parmlevelrows = document.getElementById("$names{'boxh'}").rows; 3481: var numrows = parmlevelrows.length; 3482: if (numrows > 1) { 3483: mapmenucells = parmlevelrows[2].getElementsByTagName('td'); 3484: } 3485: maxcolw = mapmenucells[0].offsetWidth; 3486: PARAMSONE 3487: } 3488: $output .= <<"THIRD"; 3489: if (maxcolw > 0) { 3490: var newscrollboxw; 3491: if (maxcolw+paddingw+scrollboxscrollw<boxw) { 3492: newscrollboxw = boxw-paddingw-maxcolw; 3493: if (newscrollboxw < minscrollboxw) { 3494: newscrollboxw = minscrollboxw; 3495: } 3496: scrollbox.style.width = newscrollboxw+"px"; 3497: if (newscrollboxw != scrollboxw) { 3498: var newitemw = newscrollboxw-offsetw; 3499: itemid.style.width = newitemw+"px"; 3500: } 3501: } else { 3502: newscrollboxw = boxw-paddingw-maxcolw; 3503: if (newscrollboxw < minscrollboxw) { 3504: newscrollboxw = minscrollboxw; 3505: } 3506: scrollbox.style.width = newscrollboxw+"px"; 3507: if (newscrollboxw != scrollboxw) { 3508: var newitemw = newscrollboxw-offsetw; 3509: itemid.style.width = newitemw+"px"; 3510: } 3511: } 3512: 3513: if (newscrollboxw != scrollboxw) { 3514: var newscrolltablew = newscrollboxw+offsetw; 3515: scrolltable.style.width = newscrolltablew+"px"; 3516: } 3517: } 3518: 3519: if (newscrollboxw != scrollboxw) { 3520: scrollchange = 1; 3521: } 3522: 3523: if (itemid.offsetWidth != itemwstart) { 3524: listwchange = 1; 3525: } 3526: } 3527: if ((chkh == 1) || (listwchange)) { 3528: var itemid = document.getElementById("$names{'item'}"); 3529: if (itemid != null) { 3530: itemh = itemid.offsetHeight; 3531: } 3532: var primaryheight = 0; 3533: if (document.getElementById('LC_nav_bar') != null) { 3534: primaryheight = document.getElementById('LC_nav_bar').offsetHeight; 3535: } 3536: var secondaryheight = 0; 3537: if (document.getElementById('LC_secondary_menu') != null) { 3538: secondaryheight = document.getElementById('LC_secondary_menu').offsetHeight; 3539: } 3540: var crumbsheight = 0; 3541: if (document.getElementById('LC_breadcrumbs') != null) { 3542: crumbsheight = document.getElementById('LC_breadcrumbs').offsetHeight; 3543: } 3544: var dccidheight = 0; 3545: if (document.getElementById('dccid') != null) { 3546: dccidheight = document.getElementById('dccid').offsetHeight; 3547: } 3548: var headerheight = 0; 3549: if (document.getElementById("$names{'header'}") != null) { 3550: headerheight = document.getElementById("$names{'header'}").offsetHeight; 3551: } 3552: var tabbedheight = document.getElementById("tabbededitor").offsetHeight; 3553: var boxheight = document.getElementById("$names{'boxh'}").offsetHeight; 3554: var freevspace = vph-(primaryheight+secondaryheight+crumbsheight+dccidheight+headerheight+tabbedheight+boxheight); 3555: 3556: var scrollboxheight = scrollbox.offsetHeight; 3557: var scrollboxscrollheight = scrollbox.scrollHeight; 3558: var scrollboxh = scrollboxheight; 3559: 3560: var minvscrollbox = $minv; 3561: var offsetv = $offsetv; 3562: var newscrollboxheight; 3563: if (freevspace < 0) { 3564: newscrollboxheight = scrollboxheight+freevspace-offsetv; 3565: if (newscrollboxheight < minvscrollbox) { 3566: newscrollboxheight = minvscrollbox; 3567: } 3568: scrollbox.style.height = newscrollboxheight + "px"; 3569: } else { 3570: if (scrollboxscrollheight > scrollboxheight) { 3571: if (freevspace > offsetv) { 3572: newscrollboxheight = scrollboxheight+freevspace-offsetv; 3573: if (newscrollboxheight < minvscrollbox) { 3574: newscrollboxheight = minvscrollbox; 3575: } 3576: scrollbox.style.height = newscrollboxheight+"px"; 3577: } 3578: } 3579: } 3580: scrollboxheight = scrollbox.offsetHeight; 3581: var itemh = document.getElementById("$names{'item'}").offsetHeight; 3582: 3583: if (scrollboxscrollheight <= scrollboxheight) { 3584: if ((itemh+offsetv)<scrollboxheight) { 3585: newscrollheight = itemh+offsetv; 3586: scrollbox.style.height = newscrollheight+"px"; 3587: } 3588: } 3589: var newscrollboxh = scrollbox.offsetHeight; 3590: if (scrollboxh != newscrollboxh) { 3591: scrollchange = 1; 3592: } 3593: } 3594: if (ismobile && scrollchange) { 3595: \$("#div_$names{'scroll'}").getNiceScroll().onResize(); 3596: } 3597: return; 3598: } 3599: 3600: function callResize() { 3601: var timer; 3602: clearTimeout(timer); 3603: timer=setTimeout('resize_scrollbox("$names{'scroll'}","1","1")',500); 3604: } 3605: 3606: THIRD 3607: return $output; 3608: } 3609: 3610: ############################################## 3611: ############################################## 3612: 3613: sub javascript_jumpto_resource { 3614: my $confirm_switch = &mt("Editing requires switching to the resource's home server.")."\n". 3615: &mt('Switch server?'); 3616: my $confirm_new_tab = &mt("Editing requires using the resource's home server.")."\n". 3617: &mt('Open a new browser tab?'); 3618: &js_escape(\$confirm_switch); 3619: &js_escape(\$confirm_new_tab); 3620: return (<<ENDUTILITY) 3621: 3622: function go(url) { 3623: if (url!='' && url!= null) { 3624: currentURL = null; 3625: currentSymb= null; 3626: var lcHostname = setLCHost(); 3627: if (lcHostname!='' && lcHostname!= null) { 3628: var RegExp = /^https?\:/; 3629: if (RegExp.test(url)) { 3630: window.location.href=url; 3631: } else { 3632: window.location.href=lcHostname+url; 3633: } 3634: } else { 3635: window.location.href=url; 3636: } 3637: } 3638: } 3639: 3640: function need_switchserver(url,target) { 3641: if (url!='' && url!= null) { 3642: if (target == '_blank') { 3643: if (confirm("$confirm_new_tab")) { 3644: window.open(url,target); 3645: } 3646: } else if (confirm("$confirm_switch")) { 3647: go(url); 3648: } 3649: } 3650: return; 3651: } 3652: 3653: ENDUTILITY 3654: 3655: } 3656: 3657: sub jump_to_editres { 3658: my ($cfile,$home,$switchserver,$forceedit,$forcereg,$symb,$shownsymb, 3659: $folderpath,$title,$hostname,$idx,$suppurl,$todocs,$suppanchor) = @_; 3660: my ($jscall,$anchor,$usehttp,$usehttps,$is_ext,$target); 3661: if ($switchserver) { 3662: if ($home) { 3663: my $resedit; 3664: if ($cfile =~ m{^/priv/($match_domain)/($match_username)/}) { 3665: my ($audom,$auname) = ($1,$2); 3666: unless (&Apache::lonnet::is_course($audom,$auname)) { 3667: unless ((&Apache::lonnet::will_trust('othcoau',$env{'user.domain'},$audom)) && 3668: (&Apache::lonnet::will_trust('coaurem',$audom,$env{'user.domain'}))) { 3669: return; 3670: } 3671: if (($symb ne '') && ($env{'request.course.id'}) && 3672: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'}))) { 3673: unless (&Apache::lonnet::can_switchserver($env{'user.domain'},$home)) { 3674: $target = '_blank'; 3675: $resedit = 1; 3676: } 3677: } 3678: } 3679: } 3680: $cfile = '/adm/switchserver?otherserver='.$home.'&role='. 3681: &HTML::Entities::encode($env{'request.role'},'"<>&'); 3682: if ($shownsymb) { 3683: $cfile .= '&symb='.&HTML::Entities::encode($shownsymb,'"<>&'); 3684: if ($resedit) { 3685: $cfile .= '&edit=1'; 3686: } 3687: } elsif ($folderpath) { 3688: $cfile .= '&folderpath='.&HTML::Entities::encode($folderpath,'"<>&'); 3689: } 3690: if ($forceedit) { 3691: $cfile .= '&forceedit=1'; 3692: } 3693: if ($forcereg) { 3694: $cfile .= '&register=1'; 3695: } 3696: $jscall = "need_switchserver('".&Apache::loncommon::escape_single($cfile)."','$target')"; 3697: } 3698: } else { 3699: unless ($cfile =~ m{^/priv/}) { 3700: if ($cfile =~ m{^(/adm/wrapper/ext/([^#]+))(?:|#([^#]+))$}) { 3701: $cfile = $1; 3702: my $extlink = $2; 3703: $anchor = $3; 3704: $is_ext = 1; 3705: if (($extlink !~ /^https:/) && ($ENV{'SERVER_PORT'} == 443)) { 3706: unless ((&Apache::lonnet::uses_sts()) || (&Apache::lonnet::waf_allssl($hostname))) { 3707: $usehttp = 1; 3708: } 3709: } elsif ($env{'request.use_absolute'}) { 3710: if ($env{'request.use_absolute'} =~ m{^https://}) { 3711: $usehttps = 1; 3712: } 3713: } 3714: } elsif ($cfile =~ m{^/?public/($match_domain)/($match_courseid)/syllabus}) { 3715: if ($ENV{'SERVER_PORT'} == 443) { 3716: my ($cdom,$cnum) = ($1,$2); 3717: if (($env{'request.course.id'}) && 3718: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $cnum) && 3719: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $cdom)) { 3720: if ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://}) { 3721: unless ((&Apache::lonnet::uses_sts()) || (&Apache::lonnet::waf_allssl($hostname))) { 3722: $usehttp = 1; 3723: } 3724: } 3725: } 3726: } elsif ($env{'request.use_absolute'}) { 3727: if ($env{'request.use_absolute'} =~ m{^https://}) { 3728: $usehttps = 1; 3729: } 3730: } 3731: } 3732: if ($symb) { 3733: if ($anchor ne '') { 3734: if ($symb =~ m{^([^#]+)\Q#$anchor\E$}) { 3735: $symb = $1.&escape(&escape('#')).$anchor; 3736: } 3737: } 3738: $cfile .= (($cfile=~/\?/)?'&':'?')."symb=$symb"; 3739: } elsif ($folderpath) { 3740: $cfile .= (($cfile=~/\?/)?'&':'?'). 3741: 'folderpath='.&HTML::Entities::encode(&escape($folderpath),'"<>&'); 3742: if ($title) { 3743: $cfile .= (($cfile=~/\?/)?'&':'?'). 3744: 'title='.&HTML::Entities::encode(&escape($title),'"<>&'); 3745: } 3746: if ($idx) { 3747: $cfile .= (($cfile=~/\?/)?'&':'?').'idx='.$idx; 3748: } 3749: if ($suppurl) { 3750: $cfile .= (($cfile=~/\?/)?'&':'?'). 3751: 'suppurl='.&HTML::Entities::encode(&escape($suppurl)); 3752: } 3753: } 3754: if ($forceedit) { 3755: $cfile .= (($cfile=~/\?/)?'&':'?').'forceedit=1'; 3756: if ($usehttps) { 3757: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile; 3758: } 3759: } elsif ($usehttp) { 3760: if ($hostname ne '') { 3761: $cfile = 'http://'.$hostname.(($cfile =~ /^\//)? '':'/').$cfile; 3762: } 3763: $cfile .= (($cfile=~/\?/)?'&':'?').'usehttp=1'; 3764: } elsif ($usehttps) { 3765: $cfile = $env{'request.use_absolute'}.(($cfile =~ /^\//)? '':'/').$cfile; 3766: } 3767: if ($forcereg) { 3768: $cfile .= (($cfile=~/\?/)?'&':'?').'register=1'; 3769: } 3770: if ($todocs) { 3771: $cfile .= (($cfile=~/\?/)?'&':'?').'todocs=1'; 3772: } 3773: if ($suppanchor ne '') { 3774: $cfile .= (($cfile=~/\?/)?'&':'?').'anchor='. 3775: &HTML::Entities::encode($suppanchor,'"<>&'); 3776: } 3777: } 3778: if ($anchor ne '') { 3779: $cfile .= '#'.$anchor; 3780: } 3781: $jscall = "go('".&Apache::loncommon::escape_single($cfile)."')"; 3782: } 3783: return $jscall; 3784: } 3785: 3786: ############################################## 3787: ############################################## 3788: 3789: # javascript_valid_email 3790: # 3791: # Generates javascript to validate an e-mail address. 3792: # Returns a javascript function which accepts a form field as argument, and 3793: # returns false if field.value does not satisfy two regular expression matches 3794: # for a valid e-mail address. Backwards compatible with old browsers without 3795: # support for javascript RegExp (just checks for @ in field.value in this case). 3796: 3797: sub javascript_valid_email { 3798: my $scripttag .= <<'END'; 3799: function validmail(field,suffix) { 3800: var str = field.value; 3801: if (suffix != '' && suffix != undefined) { 3802: str += suffix; 3803: } 3804: if (window.RegExp) { 3805: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)"; 3806: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //" 3807: var reg1 = new RegExp(reg1str); 3808: var reg2 = new RegExp(reg2str); 3809: if (!reg1.test(str) && reg2.test(str)) { 3810: return true; 3811: } 3812: return false; 3813: } 3814: else 3815: { 3816: if(str.indexOf("@") >= 0) { 3817: return true; 3818: } 3819: return false; 3820: } 3821: } 3822: END 3823: return $scripttag; 3824: } 3825: 3826: 3827: # USAGE: htmltag(element, content, {attribute => value,...}); 3828: # 3829: # EXAMPLES: 3830: # - htmltag('a', 'this is an anchor', {href => 'www.example.com', 3831: # title => 'this is a title'}) 3832: # 3833: # - You might want to set up needed tags like: 3834: # 3835: # my $h3 = sub { return htmltag( "h3", @_ ) }; 3836: # 3837: # ... and use them: $h3->("This is a headline") 3838: # 3839: # - To set up a couple of tags, see sub inittags 3840: # 3841: # NOTES: 3842: # - Empty elements, such as <br/> are correctly terminated, 3843: # i.e. htmltag('br') returns <br/> 3844: # - Empty attributes (title="") are filtered out. 3845: # - The function will not check for deprecated attributes. 3846: # 3847: # OUTPUT: content enclosed in xhtml conform tags 3848: sub htmltag{ 3849: return 3850: qq|<$_[0]| 3851: . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys(%{ $_[2] }) ) 3852: . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n"; 3853: }; 3854: 3855: 3856: # USAGE: inittags(@tags); 3857: # 3858: # EXAMPLES: 3859: # - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) ) 3860: # $h1->("This is a headline") #Returns: <h1>This is a headline</h1> 3861: # 3862: # NOTES: See sub htmltag for further information. 3863: # 3864: # OUTPUT: List of subroutines. 3865: sub inittags { 3866: my @tags = @_; 3867: return map { my $tag = $_; 3868: sub { return htmltag( $tag, @_ ) } 3869: } @tags; 3870: } 3871: 3872: 3873: # USAGE: scripttag(scriptcode, [start|end|both]); 3874: # 3875: # EXAMPLES: 3876: # - scripttag("alert('Hello World!')", 'both') 3877: # returns: 3878: # <script type="text/javascript"> 3879: # // BEGIN LON-CAPA Internal 3880: # alert(Hello World!') 3881: # // END LON-CAPA Internal 3882: # </script> 3883: # 3884: # NOTES: 3885: # - works currently only for javascripts 3886: # 3887: # OUTPUT: 3888: # Scriptcode properly enclosed in <script> and CDATA tags (and LC 3889: # Internal markers if 2nd argument is given) 3890: sub scripttag { 3891: my ( $content, $marker ) = @_; 3892: return unless defined $content; 3893: 3894: my $begin = "\n// BEGIN LON-CAPA Internal\n"; 3895: my $end = "\n// END LON-CAPA Internal\n"; 3896: 3897: if ($marker) { 3898: $content = $begin . $content if $marker eq 'start' or $marker eq 'both'; 3899: $content .= $end if $marker eq 'end' or $marker eq 'both'; 3900: } 3901: 3902: $content = "\n// <![CDATA[\n$content\n// ]]>\n"; 3903: 3904: return htmltag('script', $content, {type => 'text/javascript'}); 3905: }; 3906: 3907: =pod 3908: 3909: =item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } ) 3910: 3911: Constructs a XHTML list from \@array. 3912: 3913: =over 3914: 3915: =item input: 3916: 3917: =over 3918: 3919: =item \@array 3920: 3921: A reference to the array containing text that will be wrapped in <li></li> tags. 3922: 3923: =item { listattr => {}, itemattr =>{} } 3924: 3925: Attributes for <ul> and <li> passed in as hash references. 3926: See htmltag() for more details. 3927: 3928: =back 3929: 3930: =back 3931: 3932: returns: XHTML list as String. 3933: 3934: =cut 3935: 3936: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}} 3937: sub list_from_array { 3938: my ($items, $args) = @_; 3939: return unless (ref($items) eq 'ARRAY'); 3940: return unless scalar @$items; 3941: my ($ul, $li) = inittags( qw(ul li) ); 3942: my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items; 3943: return $ul->( $listitems, $args->{listattr} ); 3944: } 3945: 3946: 3947: ############################################## 3948: ############################################## 3949: 3950: # generate_menu 3951: # 3952: # Generates html markup for a menu. 3953: # 3954: # Inputs: 3955: # An array of following structure: 3956: # ({ categorytitle => 'Categorytitle', 3957: # items => [ 3958: # { 3959: # linktext => 'Text to be displayed', 3960: # url => 'URL the link is pointing to, i.e. /adm/site?action=dosomething', 3961: # permission => 'Contains permissions as returned from lonnet::allowed(), 3962: # must evaluate to true in order to activate the link', 3963: # icon => 'icon filename', 3964: # alttext => 'alt text for the icon', 3965: # help => 'Name of the corresponding helpfile', 3966: # linktitle => 'Description of the link (used for title tag)' 3967: # }, 3968: # ... 3969: # ] 3970: # }, 3971: # ... 3972: # ) 3973: # 3974: # Outputs: A scalar containing the html markup for the menu. 3975: 3976: sub generate_menu { 3977: my @menu = @_; 3978: # subs for specific html elements 3979: my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) ); 3980: 3981: my @categories; # each element represents the entire markup for a category 3982: 3983: foreach my $category (@menu) { 3984: my @links; # contains the links for the current $category 3985: foreach my $link (@{$$category{items}}) { 3986: next unless $$link{permission}; 3987: 3988: # create the markup for the current $link and push it into @links. 3989: # each entry consists of an image and a text optionally followed 3990: # by a help link. 3991: my $src; 3992: if ($$link{icon} ne '') { 3993: $src = '/res/adm/pages/'.$$link{icon}; 3994: } 3995: push(@links,$li->( 3996: $a->( 3997: $img->("", { 3998: class => "LC_noBorder LC_middle", 3999: src => $src, 4000: alt => mt(defined($$link{alttext}) ? 4001: $$link{alttext} : $$link{linktext}) 4002: }), { 4003: href => $$link{url}, 4004: title => mt($$link{linktitle}), 4005: class => 'LC_menubuttons_link' 4006: }). 4007: $a->(mt($$link{linktext}), { 4008: href => $$link{url}, 4009: title => mt($$link{linktitle}), 4010: class => "LC_menubuttons_link" 4011: }). 4012: (defined($$link{help}) ? 4013: Apache::loncommon::help_open_topic($$link{help}) : ''), 4014: {class => "LC_menubuttons_inline_text"})); 4015: } 4016: 4017: # wrap categorytitle in <h3>, concatenate with 4018: # joined and in <ul> tags wrapped @links 4019: # and wrap everything in an enclosing <div> and push it into 4020: # @categories 4021: # such that each element looks like: 4022: # <div><h3>title</h3><ul><li>...</li>...</ul></div> 4023: # the category won't be added if there aren't any links 4024: push(@categories, 4025: $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}). 4026: $ul->(join('' ,@links), {class =>"LC_ListStyleNormal" }), 4027: {class=>"LC_Box LC_400Box"})) if scalar(@links); 4028: } 4029: 4030: # wrap the joined @categories in another <div> (column layout) 4031: return $div->(join('', @categories), {class => "LC_columnSection"}); 4032: } 4033: 4034: ############################################## 4035: ############################################## 4036: 4037: =pod 4038: 4039: =item &start_funclist() 4040: 4041: Start list of available functions 4042: 4043: Typically used to offer a simple list of available functions 4044: at top or bottom of page. 4045: All available functions/actions for the current page 4046: should be included in this list. 4047: 4048: If the optional headline text is not provided, a default text will be used. 4049: 4050: =over 4051: 4052: =item Related routines: 4053: 4054: =over 4 4055: 4056: =item add_item_funclist 4057: 4058: =item end_funclist 4059: 4060: =back 4061: 4062: =back 4063: 4064: Inputs: (optional) headline text 4065: 4066: Returns: HTML code with function list start 4067: 4068: =cut 4069: 4070: ############################################## 4071: ############################################## 4072: 4073: sub start_funclist { 4074: my($legendtext)=@_; 4075: $legendtext=&mt('Functions') if !$legendtext; 4076: return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n"; 4077: } 4078: 4079: 4080: ############################################## 4081: ############################################## 4082: 4083: =pod 4084: 4085: =item &add_item_funclist() 4086: 4087: Adds an item to the list of available functions 4088: 4089: =over 4090: 4091: =item Related routines: 4092: 4093: =over 4 4094: 4095: =item start_funclist 4096: 4097: =item end_funclist 4098: 4099: =back 4100: 4101: =back 4102: 4103: Inputs: content item with text and link to function 4104: 4105: Returns: HTML code with list item for funclist 4106: 4107: =cut 4108: 4109: ############################################## 4110: ############################################## 4111: 4112: sub add_item_funclist { 4113: my($content) = @_; 4114: return '<li>'.$content.'</li>'."\n"; 4115: } 4116: 4117: =pod 4118: 4119: =item &end_funclist() 4120: 4121: End list of available functions 4122: 4123: =over 4124: 4125: =item Related routines: 4126: 4127: start_funclist 4128: add_item_funclist 4129: 4130: =back 4131: 4132: Inputs: ./. 4133: 4134: Returns: HTML code with function list end 4135: 4136: =cut 4137: 4138: sub end_funclist { 4139: return "</ul>\n"; 4140: } 4141: 4142: =pod 4143: 4144: =item &funclist_from_array( \@array, {legend => 'text for legend'} ) 4145: 4146: Constructs a XHTML list from \@array with the first item being visually 4147: highlighted and set to the value of legend or 'Functions' if legend is 4148: empty. 4149: 4150: =over 4151: 4152: =item \@array 4153: 4154: A reference to the array containing text that will be wrapped in <li></li> tags. 4155: 4156: =item { legend => 'text' } 4157: 4158: A string that's used as visually highlighted first item. 'Functions' is used if 4159: it's value evaluates to false. 4160: 4161: =back 4162: 4163: returns: XHTML list as string. 4164: 4165: =back 4166: 4167: =cut 4168: 4169: sub funclist_from_array { 4170: my ($items, $args) = @_; 4171: return unless(ref($items) eq 'ARRAY'); 4172: $args->{legend} ||= mt('Functions'); 4173: return list_from_array( [$args->{legend}, @$items], 4174: { listattr => {class => 'LC_funclist'} }); 4175: } 4176: 4177: =pod 4178: 4179: =over 4180: 4181: =item &actionbox( \@array ) 4182: 4183: Constructs a XHTML list from \@array with the first item being visually 4184: highlighted and set to the value 'Actions'. The list is wrapped in a division. 4185: 4186: The actionlist is used to offer contextual actions, mostly at the bottom 4187: of a page, on which the outcome of an processed action is shown, 4188: e.g. a file operation in Authoring Space. 4189: 4190: =over 4191: 4192: =item \@array 4193: 4194: A reference to the array containing text. Details: sub funclist_from_array 4195: 4196: =back 4197: 4198: Returns: XHTML div as string. 4199: 4200: =back 4201: 4202: =cut 4203: 4204: sub actionbox { 4205: my ($items) = @_; 4206: return unless(ref($items) eq 'ARRAY'); 4207: return 4208: '<div class="LC_actionbox">' 4209: .&funclist_from_array($items, {legend => &mt('Actions')}) 4210: .'</div>'; 4211: } 4212: 4213: 1; 4214: 4215: __END__