Annotation of loncom/interface/lonpickcourse.pm, revision 1.117
1.1 www 1: # The LearningOnline Network
2: # Pick a course
3: #
1.117 ! raeburn 4: # $Id: lonpickcourse.pm,v 1.116 2015/05/21 23:40:09 raeburn Exp $
1.1 www 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: package Apache::lonpickcourse;
30:
31: use strict;
32: use Apache::Constants qw(:common);
33: use Apache::loncommon;
1.106 raeburn 34: use Apache::lonhtmlcommon;
1.1 www 35: use Apache::loncoursedata;
36: use Apache::lonnet;
1.8 www 37: use Apache::lonlocal;
1.46 raeburn 38: use Apache::longroup;
1.85 raeburn 39: use LONCAPA qw(:DEFAULT :match);
1.1 www 40:
41: sub handler {
42: my $r = shift;
1.8 www 43: &Apache::loncommon::content_type($r,'text/html');
1.1 www 44: $r->send_http_header;
45: return OK if $r->header_only;
46:
47: # ------------------------------------------------------------ Print the screen
1.40 albertel 48:
1.55 raeburn 49: # Get parameters from query string
1.1 www 50: &Apache::loncommon::get_unprocessed_cgi
1.55 raeburn 51: ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
1.19 raeburn 52: 'cdomelement','cnameelement','roleelement',
1.116 raeburn 53: 'multiple','type','setroles','fixeddom','cloner',
54: 'crscode','crsdom']);
1.90 raeburn 55: my ($type,$title,$jscript,$multelement,$multiple,$roleelement,$typeelement,
1.116 raeburn 56: $lastaction,$autosubmit,$submitopener,$cloneruname,$clonerudom,$crscode,$crsdom);
1.55 raeburn 57:
1.117 ! raeburn 58: # Get course type - Course, Community or Placement.
1.54 raeburn 59: $type = $env{'form.type'};
60: if (!defined($env{'form.type'})) {
61: $type = 'Course';
62: }
1.82 bisitz 63: $title = 'Selecting a '.$type;
1.54 raeburn 64:
65: # Setup for multiple course selections, if flag for multiples set.
1.55 raeburn 66: $multiple = $env{'form.multiple'};
67: if ($multiple) {
68: ($jscript,$multelement) = &multiples_tag();
1.82 bisitz 69: $title = 'Selecting '.$type.'(s)';
1.54 raeburn 70: }
71:
1.55 raeburn 72: # if called when a DC is selecting a course
1.54 raeburn 73: my $roledom = $env{'form.roleelement'};
74: if ($roledom) {
75: $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
1.66 raeburn 76: $submitopener = &processpick();
1.54 raeburn 77: $autosubmit = 'process_pick("'.$roledom.'")';
78: }
1.90 raeburn 79: if ($env{'form.typeelement'} ne '') {
80: $typeelement = '<input type="hidden" name="typeelement" value="'.$env{'form.typeelement'}.'" />';
81: }
1.54 raeburn 82:
1.92 raeburn 83: # if called when a DC is creating a course for another user.
1.85 raeburn 84: if ($env{'form.form'} eq 'ccrs') {
85: ($cloneruname,$clonerudom) = ($env{'form.cloner'} =~ /^($match_username):($match_domain)$/);
1.116 raeburn 86: $crscode = $env{'form.crscode'};
87: $crsdom = $env{'request.role.domain'};
1.85 raeburn 88: }
89:
90: # if called when requesting a course
91: if ($env{'form.form'} eq 'requestcrs') {
92: $cloneruname = $env{'user.name'};
93: $clonerudom = $env{'user.domain'};
1.116 raeburn 94: $crscode = $env{'form.crscode'};
95: $crsdom = $env{'form.crsdom'};
1.85 raeburn 96: }
97:
1.54 raeburn 98: my $onlyown = 0;
1.55 raeburn 99: # if called to assign course-based portfolio access control
1.59 raeburn 100: if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
1.54 raeburn 101: $onlyown = 1;
1.49 raeburn 102: }
1.55 raeburn 103:
104: my %loaditem;
1.84 raeburn 105: if (($env{'form.type'} eq 'Course') && ($env{'form.numtitles'})) {
106: if (($env{'form.official'} eq 'on') && ($env{'form.state'} eq 'listing')) {
107: $loaditem{'onload'} = 'setElements(document.filterpicker); ';
108: }
1.78 raeburn 109: }
110:
1.66 raeburn 111: if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) &&
112: ($env{'form.pickedcourse'})) {
1.115 raeburn 113: if ($type ne 'Community') {
114: my %coursedescription =
115: &Apache::lonnet::coursedescription($env{'form.pickedcourse'},
116: {'one_time' => '1'});
117: my $cdom = $coursedescription{'domain'};
118: my %domdefs = &Apache::lonnet::get_domain_defaults($cdom);
119: if (($domdefs{'officialcredits'} || $domdefs{'unofficialcredits'} || $domdefs{'textbookcredits'})) {
120: $loaditem{'onload'} .= 'setDefaultCredits();';
121: }
122: }
123: $loaditem{'onload'} .= 'setRoles();setSections();';
1.30 raeburn 124: }
1.113 raeburn 125: if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) && (!$onlyown)) {
126: $loaditem{'onload'} .= 'hideSearching(); ';
127: }
1.112 raeburn 128: my $js = &Apache::loncommon::js_changer();
1.107 raeburn 129: $r->print(&Apache::loncommon::start_page($title,$js,
1.42 albertel 130: {'add_entries' => \%loaditem,
1.41 albertel 131: 'no_nav_bar' => 1, }));
1.55 raeburn 132:
133: if ($env{'form.form'} eq 'portform') {
134: $lastaction = 'document.courselist.submit()';
1.67 raeburn 135: } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
136: !$multiple)) {
1.55 raeburn 137: $lastaction =
138: 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
139: 'document.courselist.submit();';
1.34 albertel 140: } else {
1.55 raeburn 141: $lastaction = 'self.close()';
1.1 www 142: }
1.19 raeburn 143:
1.55 raeburn 144: # if called to assign a role in a course to a user via CUSR
1.66 raeburn 145: if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
1.68 raeburn 146: $r->print(&create_user_javascript($type));
1.55 raeburn 147: }
1.54 raeburn 148:
1.55 raeburn 149: # print javascript functions for choosing a course
1.85 raeburn 150: if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) ||
151: $onlyown) {
1.58 raeburn 152: $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
1.55 raeburn 153: }
1.105 bisitz 154: $r->print(&Apache::lonhtmlcommon::scripttag($jscript));
1.55 raeburn 155: $r->print($submitopener);
1.54 raeburn 156:
1.55 raeburn 157: # ------------------------------------------ Display of filters to limit search
1.57 raeburn 158: my $filter = {};
159: my $action = '/adm/pickcourse';
1.99 raeburn 160: my ($numtitles,$showroles,$nohost,@codetitles);
1.112 raeburn 161: unless ($onlyown) {
1.111 raeburn 162: my $filterlist = ['domainfilter','sincefilter'];
1.94 raeburn 163: # created filter for DCs only
164: if ($env{'user.adv'} && $env{'form.domainfilter'} &&
1.95 raeburn 165: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})
166: && $env{'form.form'} ne 'portform') {
1.94 raeburn 167: my $loncaparev = &Apache::lonnet::get_server_loncaparev($env{'form.domainfilter'});
168: if ($loncaparev ne 'unknown_cmd') {
169: push(@{$filterlist},'createdfilter');
170: }
171: }
172: push(@{$filterlist},('descriptfilter','instcodefilter'));
1.79 raeburn 173: if ($env{'form.form'} eq 'rules') {
1.111 raeburn 174: push(@{$filterlist},('personfilter','persondomfilter'));
175: if ($env{'form.persondomfilter'} eq '') {
176: unless ($env{'form.gosearch'}) {
177: $filter->{'persondomfilter'} = $env{'request.role.domain'};
178: }
179: } else {
180: $filter->{'persondomfilter'} =
181: &LONCAPA::clean_domain($env{'form.persondomfilter'});
182: }
1.79 raeburn 183: if (($env{'form.personfilter'} ne '') && ($env{'form.persondomfilter'} ne '')) {
184: if (&Apache::lonnet::homeserver($env{'form.personfilter'},
185: $env{'form.persondomfilter'}) eq 'no_host') {
186: $nohost = 1;
187: } else {
188: $showroles = 1;
189: }
190: }
191: } else {
1.111 raeburn 192: push(@{$filterlist},('ownerfilter','ownerdomfilter'));
1.79 raeburn 193: }
1.55 raeburn 194: # course ID filter for DCs only
195: if ($env{'user.adv'} && $env{'form.domainfilter'} &&
196: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
197: push(@{$filterlist},'coursefilter');
198: }
1.85 raeburn 199: if ($cloneruname ne '' && $clonerudom ne '') {
200: push(@{$filterlist},'cloneableonly');
201: }
1.111 raeburn 202: if ((ref($filterlist) eq 'ARRAY') && (ref($filter) eq 'HASH')) {
203: foreach my $item (@{$filterlist}) {
204: $filter->{$item} = $env{'form.'.$item};
205: }
206: }
207: if ($env{'form.form'} eq 'portform') {
208: $filter->{'domainfilter'} ||= $env{'user.domain'};
209: } elsif ($env{'form.form'} eq 'studentform') {
210: $filter->{'domainfilter'} ||= $env{'request.role.domain'};
211: }
212: my $codedom;
213: if ($env{'form.fixeddom'}) {
214: $codedom = $env{'request.role.domain'};
215: } else {
216: $codedom = $filter->{'domainfilter'};
217: }
218: my ($clonetext,$clonewarning);
219: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
220: (my $coord_cloneable,$clonewarning) =
221: &get_coordinator_cloneable($cloneruname,$clonerudom,$type);
222: if ($env{'form.form'} eq 'ccrs') {
223: $clonetext = '<input type="hidden" name="cloner" value="'.$env{'form.cloner'}.'" />'."\n";
224: }
225: if ($coord_cloneable) {
226: $clonetext .= '<input type="hidden" name="cc_clone" value="'.$coord_cloneable.'" />';
227: }
1.116 raeburn 228: if ($crscode ne '') {
229: $clonetext .= '<input type="hidden" name="crscode" value="'.$crscode.'" />';
230: }
231: if ($crsdom ne '') {
232: $clonetext .= '<input type="hidden" name="crsdom" value="'.$crsdom.'" />';
233: }
1.111 raeburn 234: }
235: $r->print(&Apache::loncommon::build_filters($filterlist,$type,$roleelement,$multelement,
236: $filter,$action,\$numtitles,undef,$cloneruname,
237: $clonerudom,$typeelement,\@codetitles,$codedom,
238: $env{'form.form'},$env{'form.fixeddom'},
239: $env{'form.prevphase'},$env{'form.cnameelement'},
240: $env{'form.cnumelement'},$env{'form.cdomelement'},
241: $env{'form.setroles'},$clonetext,$clonewarning));
1.55 raeburn 242: }
1.54 raeburn 243:
244: # ---------------------------------------------------------------- Get the data
1.85 raeburn 245: if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) ||
246: $onlyown) {
1.98 raeburn 247: my $domcloner;
248: if ($env{'form.form'} eq 'ccrs') {
249: if (($env{'request.role.domain'} eq $env{'form.domainfilter'}) &&
250: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
251: $domcloner = 1;
252: }
253: }
1.112 raeburn 254: my %courses;
255: if (!$onlyown) {
256: $r->print('<div id="searching">'.&mt('Searching ...').'</div>');
257: $r->rflush();
258: my $srchdom = $filter->{'domainfilter'};
259: %courses = &Apache::loncommon::search_courses($srchdom,$type,$filter,$numtitles,
260: $cloneruname,$clonerudom,$domcloner,
1.116 raeburn 261: \@codetitles,$env{'form.cc_clone'},
262: $crsdom,$crscode);
1.112 raeburn 263: } else {
264: $r->print('<br />');
265: my %coursehash = &Apache::loncommon::findallcourses();
266: foreach my $cid (sort(keys(%coursehash))) {
267: $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
268: }
269: }
1.79 raeburn 270: if ($nohost) {
271: $r->print ('<span class="LC_warning">'.
272: &mt('User does not exist - username: [_1], domain: [_2].',
273: '<b>'.$filter->{'personfilter'}.'</b>',
274: '<b>'.$filter->{'persondomfilter'}.'</b>').'</span>');
275: } else {
1.85 raeburn 276: &display_matched_courses($r,$type,$multiple,$action,$showroles,$cloneruname,
1.116 raeburn 277: $clonerudom,$crsdom,$crscode,%courses);
1.79 raeburn 278: }
1.54 raeburn 279: }
280: $r->print(&Apache::loncommon::end_page());
281: return OK;
282: }
283:
1.66 raeburn 284: sub processpick {
285: my $openerform = 'rolechoice';
286: if ($env{'form.form'} eq 'studentform') {
287: $openerform = $env{'form.form'};
288: }
289: my $process_pick = <<"ENDONE";
290: <script type="text/javascript">
291: function process_pick(dom) {
292: var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value;
293: var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value;
294: var okDomain = 0;
295: ENDONE
296: if ($openerform eq 'rolechoice') {
297: $process_pick .= <<"ENDTWO";
298: if (pickedDomain == dom) {
299: if (pickedCourse != '') {
1.88 raeburn 300: var ccrole = "cc";
301: var pickedType = "$env{'form.type'}";
302: if (pickedType == "Community") {
303: ccrole = "co";
304: }
305: var courseTarget = ccrole+"./"+pickedDomain+"/"+pickedCourse
1.66 raeburn 306: opener.document.title='Role selected. Please stand by.';
307: opener.status='Role selected. Please stand by.';
308: opener.document.rolechoice.newrole.value=courseTarget
309: opener.document.rolechoice.submit();
310: }
311: }
312: else {
313: alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
314: }
315: ENDTWO
316: } else {
317: $process_pick .= <<"ENDTHREE";
318: if (pickedDomain != dom) {
319: alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
320: return;
321: }
322: ENDTHREE
323: }
324: $process_pick .= "
325: }
326:
327: </script>
328: ";
329: return $process_pick;
330: }
331:
1.55 raeburn 332: sub create_user_javascript {
333: my ($type) = @_;
334: my $output;
335: #javascript for reporting sections and groups then closing
336: if ($env{'form.pickedcourse'}) {
1.87 raeburn 337: my %coursedescription =
338: &Apache::lonnet::coursedescription($env{'form.pickedcourse'},
339: {'one_time' => '1'});
340: my $cdom = $coursedescription{'domain'};
341: my $cnum = $coursedescription{'num'};
342: my $crstype = $coursedescription{'type'};
1.106 raeburn 343: my %domdefs = &Apache::lonnet::get_domain_defaults($cdom);
344: my ($showcredits,$credits);
345: if (($crstype ne 'Community') &&
1.109 raeburn 346: (($domdefs{'officialcredits'} || $domdefs{'unofficialcredits'} || $domdefs{'textbookcredits'}))) {
1.106 raeburn 347: $showcredits = 1;
348: $credits = $coursedescription{'internal.defaultcredits'};
349: }
1.55 raeburn 350: my $sec_element = 'currsec';
351: my $grplist_element = 'groups';
352: my ($sections,$groups) =
353: &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
354: my $num_sections = scalar(@{$sections});
355: my $seclist = join(',',@{$sections});
356: my $num_groups = scalar(@{$groups});
357: my $groupslist = join(',',@{$groups});
358: $output = qq|
359: <script type="text/javascript">
1.106 raeburn 360: // <![CDATA[
1.55 raeburn 361: function setSections() {
362: opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
363: window.opener.setSect('$seclist');
1.87 raeburn 364: self.close();
365: }
366: function setRoles() {
367: window.opener.setRole('$crstype');
1.55 raeburn 368: }
1.106 raeburn 369: |;
370: if ($showcredits) {
371: $output .= qq|
372: function setDefaultCredits() {
373: window.opener.setCredits('$credits');
374: }
375: |;
376: }
377: $output .= qq|
378: // ]]>
1.55 raeburn 379: </script>
380: |;
381: }
382: return $output;
383: }
384:
1.54 raeburn 385: sub display_matched_courses {
1.116 raeburn 386: my ($r,$type,$multiple,$action,$showroles,$cloneruname,$clonerudom,$crsdom,$crscode,%courses) = @_;
1.55 raeburn 387: if ($env{'form.form'} eq 'portform') {
388: $action = '/adm/portfolio';
389: }
1.68 raeburn 390: my $numcourses = keys(%courses);
1.55 raeburn 391: $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.68 raeburn 392: if ($env{'form.form'} eq 'modifycourse') {
393: if ($numcourses > 0) {
1.89 raeburn 394: my $ccrole = 'cc';
395: if ($type eq 'Community') {
396: $ccrole = 'co';
397: }
398: my $cctitle = &Apache::lonnet::plaintext($ccrole,$type);
1.68 raeburn 399: my $dctitle = &Apache::lonnet::plaintext('dc');
1.93 raeburn 400: my $ccrolechk = ' ';
401: my $menuchk = ' checked="checked" ';
1.68 raeburn 402: $r->print(
1.106 raeburn 403: '<div class="LC_left_float">'
404: .'<fieldset>'
405: .'<legend>'.&mt('Pick action').'</legend>'
406: .'<span class="LC_nobreak"><label>'
1.75 bisitz 407: .'<input type="radio" name="phase" value="ccrole"'.$ccrolechk.'/>'
1.89 raeburn 408: .' ');
409: if ($type eq 'Community') {
410: $r->print(&mt('Enter the community with the role of [_1].',$cctitle));
411: } else {
412: $r->print(&mt('Enter the course with the role of [_1].',$cctitle));
413: }
1.106 raeburn 414: $r->print('</label></span><br />'
415: .'<span class="LC_nobreak"><label>'
1.89 raeburn 416: .'<input type="radio" name="phase" value="menu"'.$menuchk.'/> ');
417: if ($type eq 'Community') {
418: $r->print(&mt('View or modify community settings which only a [_1] may modify.',$dctitle));
419: } else {
420: $r->print(&mt('View or modify course settings which only a [_1] may modify.',$dctitle));
421: }
1.106 raeburn 422: $r->print('</label></span>'
423: .'</fieldset></div>'
424: .'<br clear="all" />'
1.75 bisitz 425: );
1.68 raeburn 426: }
427: }
1.54 raeburn 428: my %by_descrip;
429: foreach my $course (keys(%courses)) {
430: my $descr;
1.64 raeburn 431: if (ref($courses{$course}) eq 'HASH') {
1.65 raeburn 432: $descr = $courses{$course}{'description'};
1.64 raeburn 433: } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54 raeburn 434: $descr = &unescape($1);
1.34 albertel 435: } else {
1.54 raeburn 436: $descr = &unescape($courses{$course});
437: }
438: my $description = $descr;
439: push (@{$by_descrip{$description}}, $course);
440: }
1.71 bisitz 441:
1.54 raeburn 442: if ($numcourses > 1 && $multiple) {
1.104 bisitz 443: $r->print('<input type="button" value="'.&mt('check all').'"
1.54 raeburn 444: onclick="javascript:checkAll(document.courselist.course_id)" />
1.104 bisitz 445: <input type="button" value="'.&mt('uncheck all').'"
1.54 raeburn 446: onclick="javascript:uncheckAll(document.courselist.course_id)" />
447: <br /><br />');
448: }
1.71 bisitz 449:
450: if (%courses) {
451: $r->print(&Apache::loncommon::start_data_table());
452: $r->print(&Apache::loncommon::start_data_table_header_row());
1.89 raeburn 453: my $titlehdr = &mt('Course Title');
454: if ($type eq 'Community') {
455: $titlehdr = &mt('Community Title');
456: }
1.71 bisitz 457: $r->print('<th>'.&mt('Select').'</th>'
1.89 raeburn 458: .'<th>'.$titlehdr.'</th>'
459: .'<th>'.&mt('Domain').'</th>');
1.117 ! raeburn 460: unless (($type eq 'Community') || ($type eq 'Placement')) {
1.89 raeburn 461: $r->print('<th>'.&mt('Course Code').'</th>');
462: }
463: $r->print('<th>'.&mt('Owner/Co-owner(s)').'</th>');
1.79 raeburn 464: if ($showroles) {
465: $r->print('<th>'.&mt("Role(s) for [_1]",
466: &Apache::loncommon::plainname($env{'form.personfilter'},
467: $env{'form.persondomfilter'},'firstname')).'</th>');
468: }
1.71 bisitz 469: $r->print(&Apache::loncommon::end_data_table_header_row());
470: }
1.92 raeburn 471: my %cc_cloneable;
472: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
473: my ($coord_cloneable,$warning) =
474: &get_coordinator_cloneable($cloneruname,$clonerudom,$type);
475: if ($coord_cloneable) {
476: map {$cc_cloneable{$_} = 1;} split('&',$coord_cloneable);
477: }
478: }
1.116 raeburn 479: my (%gotdomdefaults,%gotcodedefaults);
1.54 raeburn 480: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
481: foreach my $course (@{$by_descrip{$description}}) {
1.72 raeburn 482: $r->print(&Apache::loncommon::start_data_table_row());
1.54 raeburn 483: my $cleandesc=&HTML::Entities::encode($description,'<>&"');
484: $cleandesc=~s/'/\\'/g;
485: my ($cdom,$cnum)=split(/\_/,$course);
1.85 raeburn 486: my ($descr,$instcode,$ttype,$canclone,@owners);
1.64 raeburn 487: if (ref($courses{$course}) eq 'HASH') {
488: $descr = $courses{$course}{'description'};
1.85 raeburn 489: $instcode = $courses{$course}{'inst_code'};
490: $ttype = $courses{$course}{'type'};
491: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
1.98 raeburn 492: if ($env{'form.form'} eq 'ccrs') {
493: if (($env{'request.role.domain'} eq $cdom) &&
494: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
495: $canclone = 1;
496: }
497: }
498: unless ($canclone) {
499: if ($cc_cloneable{$cnum.':'.$cdom}) {
500: $canclone = 1;
501: }
1.92 raeburn 502: }
503: unless ($canclone) {
504: my $cloners = $courses{$course}{'cloners'};
1.116 raeburn 505: if ($cloners ne '') {
1.92 raeburn 506: my @cloneable = split(',',$cloners);
507: if (grep(/^\*$/,@cloneable)) {
508: $canclone = 1;
509: }
1.97 raeburn 510: if (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
1.92 raeburn 511: $canclone = 1;
512: }
513: if (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
514: $canclone = 1;
515: }
1.116 raeburn 516: unless ($canclone) {
517: if (($instcode) && ($crscode) && ($cdom eq $crsdom)) {
518: foreach my $cloner (@cloneable) {
519: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
520: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
521: if ($cloner =~ /\=/) {
522: my (%codedefaults,@code_order);
523: if (ref($gotcodedefaults{$cdom}) eq 'HASH') {
524: if (ref($gotcodedefaults{$cdom}{'defaults'}) eq 'HASH') {
525: %codedefaults = %{$gotcodedefaults{$cdom}{'defaults'}};
526: }
527: if (ref($gotcodedefaults{$cdom}{'order'}) eq 'ARRAY') {
528: @code_order = @{$gotcodedefaults{$cdom}{'order'}};
529: }
530: } else {
531: &Apache::lonnet::auto_instcode_defaults($cdom,
532: \%codedefaults,
533: \@code_order);
534: $gotcodedefaults{$cdom}{'defaults'} = \%codedefaults;
535: $gotcodedefaults{$cdom}{'order'} = \@code_order;
536: }
537: if (@code_order > 0) {
538: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
539: $cloner,$instcode,$crscode)) {
540: $canclone = 1;
541: last;
542: }
543: }
544: }
545: }
546: }
547: }
548: }
549: } else {
550: my %domdefs;
551: if (ref($gotdomdefaults{$cdom}) eq 'HASH') {
552: %domdefs = %{$gotdomdefaults{$cdom}};
553: } else {
554: %domdefs = &Apache::lonnet::get_domain_defaults($cdom);
555: $gotdomdefaults{$cdom} = \%domdefs;
556: }
557: if ($domdefs{'canclone'}) {
558: unless ($domdefs{'canclone'} eq 'none') {
559: if ($domdefs{'canclone'} eq 'domain') {
560: if ($clonerudom eq $cdom) {
561: $canclone = 1;
562: }
563: } elsif (($instcode) && ($crscode) &&
564: ($cdom eq $crsdom)) {
565: my (%codedefaults,@code_order);
566: if (ref($gotcodedefaults{$cdom}) eq 'HASH') {
567: if (ref($gotcodedefaults{$cdom}{'defaults'}) eq 'HASH') {
568: %codedefaults = %{$gotcodedefaults{$cdom}{'defaults'}};
569: }
570: if (ref($gotcodedefaults{$cdom}{'order'}) eq 'ARRAY') {
571: @code_order = @{$gotcodedefaults{$cdom}{'order'}};
572: }
573: } else {
574: &Apache::lonnet::auto_instcode_defaults($cdom,
575: \%codedefaults,
576: \@code_order);
577: $gotcodedefaults{$cdom}{'defaults'} = \%codedefaults;
578: $gotcodedefaults{$cdom}{'order'} = \@code_order;
579: }
580: if (@code_order > 0) {
581: if (&Apache::lonnet::default_instcode_cloning($cdom,$domdefs{'canclone'},
582: $instcode,$crscode,\%codedefaults,
583: \@code_order)) {
584: $canclone = 1;
585: }
586: }
587: }
588: }
589: }
1.85 raeburn 590: }
591: }
592: }
1.101 raeburn 593: push(@owners,$courses{$course}{'owner'});
594: if ($courses{$course}{'co-owners'} ne '') {
595: foreach my $item (split(/,/,$courses{$course}{'co-owners'})) {
596: push(@owners,$item);
1.64 raeburn 597: }
598: }
599: } else {
600: my $singleowner;
601: ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
602: push(@owners,&unescape($singleowner));
603: }
1.93 raeburn 604: my $ownerstr = join(', ',map { &Apache::loncommon::plainname(split(':',$_)); } @owners);
1.85 raeburn 605: $r->print('<td>'.&course_chooser($multiple,$cdom,$cnum,$cleandesc,$canclone).'</td>');
1.71 bisitz 606: $r->print('<td>'.$description.'</td>');
607: $r->print('<td>');
608: $r->print(&Apache::lonnet::domain($cdom,'description')?
609: $cdom.' ('.&Apache::lonnet::domain($cdom,'description').')':$cdom);
610: $r->print('</td>');
1.117 ! raeburn 611: unless (($type eq 'Community') || ($type eq 'Placement')) {
1.89 raeburn 612: $r->print('<td>');
613: if ($instcode ne '') {
614: $r->print(&unescape($instcode));
615: } else {
616: $r->print(' ');
617: }
618: $r->print('</td>');
1.54 raeburn 619: }
1.72 raeburn 620: $r->print('<td>'.$ownerstr.'</td>');
1.79 raeburn 621: if ($showroles) {
622: $r->print('<td>');
623: my $rolestr;
624: if (ref($courses{$course}{'roles'}) eq 'ARRAY') {
625: my @roles = sort(@{$courses{$course}{'roles'}});
626: foreach my $role (@roles) {
627: if ($role =~ /^cr/) {
628: my (undef,$crdom,$crname,$crtitle) = split('/',$role);
629: $rolestr .= $crtitle.', ';
630: } else {
1.89 raeburn 631: $rolestr .= &Apache::lonnet::plaintext($role,$type).', ';
1.79 raeburn 632: }
633: }
634: $rolestr =~ s/\, $//;
635: }
636: $r->print($rolestr.'</td>');
637: }
1.54 raeburn 638: if ($multiple) { $r->print("</label>\n"); }
1.72 raeburn 639: $r->print(&Apache::loncommon::end_data_table_row());
1.71 bisitz 640: # $r->print("<br />\n");
1.19 raeburn 641: }
642: }
1.72 raeburn 643: if (%courses) {
644: $r->print(&Apache::loncommon::end_data_table());
645: }
1.71 bisitz 646:
1.54 raeburn 647: if (!%courses) {
1.104 bisitz 648: $r->print('<p class="LC_info">'.&mt('None found').'</p>');
1.54 raeburn 649: } elsif ($multiple) {
1.108 bisitz 650: $r->print('<input type="button" value="'.&mt('Submit').'" onclick="gochoose('."'','','')".'" />');
1.54 raeburn 651: }
652: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
653: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
654: '<input type="hidden" name="type" value="'.$type.'" />'."\n");
655: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
656: $r->print('<input type="hidden" name="roleelement" value="'.
657: $env{'form.roleelement'}.'" />'."\n");
658: }
1.55 raeburn 659: if ($env{'form.form'} eq 'portform') {
660: $r->print('<input type="hidden" name="cnum" value="" />');
661: $r->print('<input type="hidden" name="cdom" value="" />');
662: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
663: $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57 raeburn 664: } elsif ($env{'form.form'} eq 'modifycourse') {
1.85 raeburn 665: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form','numtitles','state']));
1.57 raeburn 666: } else {
667: $r->print('<input type="hidden" name="cnumelement" value="'.
668: $env{'form.cnumelement'}.'" />'."\n".
669: '<input type="hidden" name="cdomelement" value="'.
670: $env{'form.cdomelement'}.'" />'."\n");
1.90 raeburn 671: if ($env{'form.typeelement'} ne '') {
672: $r->print('<input type="hidden" name="typeelement" value="'.
673: $env{'form.typeelement'}.'" />'."\n");
674:
675: }
1.55 raeburn 676: }
1.78 raeburn 677: if ((exists($env{'form.fixeddom'})) && ($env{'form.form'} eq 'rules')) {
678: $r->print('<input type="hidden" name="fixeddom" value="'.
679: $env{'form.fixeddom'}.'" />');
680: }
681: if ($env{'form.numtitles'}) {
682: $r->print('<input type="hidden" name="numtitles" value="'.
683: $env{'form.numtitles'}.'" />');
684: }
1.54 raeburn 685: $r->print("</form>\n");
686: return;
687: }
688:
689: sub multiples_tag {
1.55 raeburn 690: my $jscript = &Apache::loncommon::check_uncheck_jscript();
691: my $multelement = '<input type="hidden" name="multiple" value="1" />';
692: return ($jscript,$multelement);
1.1 www 693: }
1.30 raeburn 694:
1.92 raeburn 695: sub get_coordinator_cloneable {
696: my ($cloneruname,$clonerudom,$type) = @_;
1.100 www 697: if (($cloneruname!~/\w/) || ($clonerudom!~/\w/)) {
698: my $warning = '<div class="LC_warning">'.&mt('Intended course owner not specified').
699: '</div>';
700: return ('',$warning);
701: } elsif (&Apache::lonnet::homeserver($cloneruname,$clonerudom) eq 'no_host') {
1.92 raeburn 702: my $warning = '<div class="LC_error">'.&mt('Intended course owner does not exist').
703: '</div>';
704: return ('',$warning);
705: } else {
706: my ($cc_clone,$ccrole);
707: if ($type eq 'Community') {
708: $ccrole = 'co';
1.117 ! raeburn 709: } else {
1.92 raeburn 710: $ccrole = 'cc';
711: }
712: my %ccroles = &Apache::lonnet::get_my_roles($cloneruname,$clonerudom,
713: 'userroles',['active'], [$ccrole]);
714: foreach my $key (sort(keys(%ccroles))) {
715: my ($cnum,$cdom,$role) = split(':',$key);
716: $cc_clone .= $cdom.':'.$cnum.'&';
717: }
718: $cc_clone =~ s/\&$//;
719: return ($cc_clone);
720: }
721: }
722:
1.30 raeburn 723: sub course_chooser {
1.85 raeburn 724: my ($multiple,$cdom,$cnum,$cleandesc,$canclone) = @_;
1.30 raeburn 725: my $output;
1.35 raeburn 726: if ($multiple) {
1.32 albertel 727: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.85 raeburn 728: } elsif ((($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) && (!$canclone)) {
729: if ($env{'form.form'} eq 'ccrs') {
1.114 bisitz 730: $output = &mt('No cloning for [_1]',$env{'form.cloner'})."\n";
1.85 raeburn 731: } else {
732: $output = &mt('No rights to clone')."\n";
733: }
1.30 raeburn 734: } else {
1.108 bisitz 735: $output = '<input type="button" value="'.&mt('Select').'" onclick="gochoose('.
1.30 raeburn 736: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
737: }
738: return $output;
1.49 raeburn 739: }
740:
1.55 raeburn 741: sub gochoose_javascript {
1.57 raeburn 742: my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55 raeburn 743: my %elements = (
744: 'Course' => {
745: name => 'coursepick',
746: total => 'coursetotal',
747: list => 'courselist',
748: },
1.83 raeburn 749: 'Community' => {
1.88 raeburn 750: name => 'coursepick',
751: total => 'coursetotal',
752: list => 'courselist',
1.55 raeburn 753: },
1.117 ! raeburn 754: 'Placement' => {
! 755: name => 'coursepick',
! 756: total => 'coursetotal',
! 757: list => 'courselist',
! 758: },
1.55 raeburn 759: );
1.107 raeburn 760: my $output = qq|
1.57 raeburn 761: function gochoose(cname,cdom,cdesc) {
1.55 raeburn 762: var openerForm = "$env{'form.form'}";
763: courseCount = 0;
764: var courses = '';
1.57 raeburn 765: |;
766: if ($multiple) {
767: $output .= <<"ENDSCRIPT";
768: courseCount = 0;
769: var courses = '';
770: if (typeof(document.courselist.course_id.length) == 'undefined') {
771: // only 1 course checkbox was created
772: if (document.courselist.course_id.checked) {
773: courses = courses + document.courselist.course_id.value + "&&";
774: courseCount ++;
775: }
776: } else {
777: for (var j=0; j<document.courselist.course_id.length; j++) {
778: if (document.courselist.course_id[j].checked) {
779: courses = courses + document.courselist.course_id[j].value + "&&";
1.55 raeburn 780: courseCount ++;
781: }
1.57 raeburn 782: }
783: }
784: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
785: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
786: 'undefined') {
787: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
788: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55 raeburn 789: } else {
1.57 raeburn 790: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55 raeburn 791: }
1.57 raeburn 792: } else {
793: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
794: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
795: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55 raeburn 796: } else {
1.57 raeburn 797: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54 raeburn 798: }
1.55 raeburn 799: }
1.57 raeburn 800: }
801: if (courseCount > 0) {
802: courses = courses.substr(0,courses.length-2);
803: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
804: }
805: ENDSCRIPT
806: } else {
1.90 raeburn 807: my ($name_code,$type_code);
1.57 raeburn 808: if ($env{'form.cnameelement'} ne '') {
1.103 raeburn 809: $name_code = <<ENDNAMECODE;
810: var showcdesc = cdesc;
811: if (cdesc.length > 25) {
812: showcdesc = cdesc.substr(0,25)+' ...';
813: }
814: opener.document.$env{'form.form'}.$env{'form.cnameelement'}.value=showcdesc;
815: ENDNAMECODE
1.55 raeburn 816: }
1.90 raeburn 817: if ($env{'form.typeelement'} ne '') {
818: $type_code = 'opener.document.'.$env{'form.form'}.'.'.
819: $env{'form.typeelement'}.'.value=document.courselist.type;';
820: }
821:
1.57 raeburn 822: $output .= qq|
1.55 raeburn 823: $name_code
1.90 raeburn 824: $type_code
1.55 raeburn 825: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
826: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
827: if (slct.options == undefined) {
828: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
829: }
830: else {
831: var i;
832: for (i=0;i<slct.length;i++) {
833: if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54 raeburn 834: }
835: }
1.57 raeburn 836: |;
1.54 raeburn 837: }
1.57 raeburn 838: $output .= qq|
1.55 raeburn 839: if (openerForm == 'portform') {
840: document.courselist.cnum.value = cname;
841: document.courselist.cdom.value = cdom;
842: }
843: $autosubmit
844: $lastaction
1.54 raeburn 845: }
1.57 raeburn 846: |;
1.105 bisitz 847: return &Apache::lonhtmlcommon::scripttag($output);
1.54 raeburn 848: }
849:
1.55 raeburn 850: 1;
851: __END__
852:
853: =pod
854:
855: =head1 NAME
856:
857: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.
858:
859: =head1 SYNOPSIS
860:
861: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user.
862:
863: =head1 OVERVIEW
864:
865: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses.
866:
867: =head2 Search Criteria (Screen One)
868:
869: =head3 Criteria:
870:
871: =over 4
872:
873: =item *
874: Course Activity - how recently was course last visited by anyone.
875:
876: =item *
877: Course Domain - the domain of the course
878:
879: =item *
1.117 ! raeburn 880: Type - Course, Community or Placement
1.55 raeburn 881:
882: =item *
883: Course Institutional Code - the institutional identifier assigned to the course
884:
885: =item *
886: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
887:
888: =item *
889: Course Owner's Domain - the domain of the owner of the course
890:
891: =item *
1.76 bisitz 892: Course Title - text which appears in the Course Title, as set in the Course Parameters.
1.55 raeburn 893:
894: =item *
895: Course ID - the internal course number (course ID part after initial 'domain_') used by LON-CAPA (this criterion is only displayed to Domain Coordinators selecting a course in the same domain as their DC role).
896:
897: =back
898:
899: The criteria setting screen is not displayed if course picking is done by a user who does not have advanced privileges (as defined by $env{'user.adv'}).
900:
901: =head2 Course Display (Screen Two)
902:
903: A list of courses matching the search criteria is displayed. If the user is not an advanced user, screen one will have been skipped and the courses displayed will be all courses in which the user has currently active roles. The information displayed for each course is:
904:
905: =over 4
906:
907: =item *
908: Course description
909:
910: =item *
911: Domain description of course domain
912:
913: =item *
914: Course institutional code
915:
916: =item *
917: Course owner (username:domain)
918:
919: =back
920:
921: Depending on context, the display may include a single select box for each course, allowing selection of only a single course, or may include checkboxes allowing selection of more than one course.
922:
923: Following selection, and/or submission, the course description, number and domain are transferred to the browser window from which the course picker window was opened. In most cases, the child window containing the course picker screens will be closed. However, in some cases closure will be delayed until a third screen has been displayed (e.g., setting of course-based conditional access controls for portfolio files). In this case the page is generated via /adm/portfolio and the page features select boxes to allow the user to select roles, access types, sections and groups.
924:
925: =head1 SUBROUTINES
926:
927: =over 4
928:
929: =item *
930: X<create_user_javascript()>
931: B<create_user_javascript($type)>:
932:
1.117 ! raeburn 933: Input: 1 - $type - the course type - Course, Community, or Placement
1.55 raeburn 934:
935: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
936:
937: Side Effects: None
938:
939: javascript code for reporting selected sections (as a string of comma separated sections) and groups in the selected course (as a comma separated list) then calling setSect() javscript function in the opener window (to populate section select box) then closing current window.
940:
941:
942: =item *
943: X<display_matched_courses()>
1.116 raeburn 944: B<display_matched_courses($r,$type,$multiple,$action,$showroles,$cloneruname,$clonerudom,$crsdom,$crscode,%courses)>:
1.55 raeburn 945:
1.116 raeburn 946: Input: 8 - request object, course type, multiple (0 or 1), form action, whether to show roles (for course personnel filter), username of new course owner, domain of new course owner, domain of new course, institutional code of new course, hash of courses.
1.55 raeburn 947:
948: Output: 0
949:
950: Side Effects: prints select buttons (multiple = 0) or checkboxes (multiple = 1) and hidden form elements for selection of one or more courses which met search criteria.
951:
952: =item *
953: X<multiples_tag()>
954: B<multiples_tag()>:
955:
956:
957: Input: 0
958:
959: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
960:
961: Side Effects: None
962:
963:
964: =item *
965: X<course_chooser()>
1.85 raeburn 966: B<course_chooser($multiple,$cdom,$cnum,$cleandesc,$canclone)>:
1.55 raeburn 967:
1.85 raeburn 968: Input: 5 - single (0) or multiple (1) courses; course domain, course number; course description; can clone course (1 if new course owner has cloning rights).
1.55 raeburn 969:
1.85 raeburn 970: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user to indicate course selection.
1.55 raeburn 971:
972: Side Effects: None
973:
974:
975: =item *
976: X<gochoose_javascript()>
1.57 raeburn 977: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55 raeburn 978:
1.66 raeburn 979: Input: 4 - course type; single (0) or multiple courses (1); in context of DC selecting a CC role in a course: javascript code from &processpick(); final action to take after user chooses course(s): either close window, or submit form for display of next page etc.
1.55 raeburn 980:
981: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
982:
983: Side Effects: None
984:
985: javascript functions used when user selects a course(s). Different behavior depending on context:
986:
987: =back
988:
989: =over 8
990:
991: =item
992:
993: (a) Domain Coordinator using MAIL to select recipients of broadcast e-mail - && separated list of selected courses written to hidden form element in opener window. Child window closes.
994:
995: =item
996:
997: (b) Domain Coordinator choosing a course for adoption of a CC role from roles screen - write course identifying information to hidden form elements in opener window and automatically submit role selection form in opener window. Child window closes.
998:
999: =item
1000:
1001: (c) Domain Coordinator creating a course, and selecting a course to clone - course number and domain written to visible form elements in opener window. Child window closes.
1002:
1003: =item
1.54 raeburn 1004:
1.55 raeburn 1005: (d) User selecting a course for course-based conditional access control for a portfolio file - form is submitted, and new page is displayed for selection of roles, access types, sections and groups to be used in conditional ACL. New page is generated by /adm/portfolio.
1.54 raeburn 1006:
1.55 raeburn 1007: =item
1.54 raeburn 1008:
1.55 raeburn 1009: (e) Domain Coordinator assigning a role to a user - form is submitted, and new page does an onload call to a javascript function to (a) write lists of sections and groups to hidden elements in opener window, (b) call function in opener window to dynamically populate select box showing current sections.
1.54 raeburn 1010:
1.55 raeburn 1011: =item
1.54 raeburn 1012:
1.55 raeburn 1013: (f) Author modifying a rights entry in a .rights file - selected course number and domain are witten to visible form elements in opener window. Child window closes.
1.54 raeburn 1014:
1.55 raeburn 1015: =item
1.49 raeburn 1016:
1.102 bisitz 1017: (g) Bubblesheet Scanning Operator uploading a bubblesheet file to a course - course number is written to visible form element in opener window. Child window closes.
1.30 raeburn 1018:
1.84 raeburn 1019: =item
1020:
1021: (h) User requesting creation of a course, and selecting a course to clone - course number and domain written to visible form elements in opener window. Child window closes.
1022:
1.55 raeburn 1023: =back
1024:
1025: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>