Annotation of loncom/interface/lonpickcourse.pm, revision 1.91
1.1 www 1: # The LearningOnline Network
2: # Pick a course
3: #
1.91 ! bisitz 4: # $Id: lonpickcourse.pm,v 1.90 2009/11/04 14:12:19 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;
34: use Apache::loncoursedata;
35: use Apache::lonnet;
1.8 www 36: use Apache::lonlocal;
1.46 raeburn 37: use Apache::longroup;
1.78 raeburn 38: use Apache::courseclassifier;
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.85 raeburn 53: 'multiple','type','setroles','fixeddom','cloner']);
1.90 raeburn 54: my ($type,$title,$jscript,$multelement,$multiple,$roleelement,$typeelement,
1.85 raeburn 55: $lastaction,$autosubmit,$submitopener,$cloneruname,$clonerudom);
1.55 raeburn 56:
1.83 raeburn 57: # Get course type - Course or Community.
1.54 raeburn 58: $type = $env{'form.type'};
59: if (!defined($env{'form.type'})) {
60: $type = 'Course';
61: }
1.82 bisitz 62: $title = 'Selecting a '.$type;
1.54 raeburn 63:
64: # Setup for multiple course selections, if flag for multiples set.
1.55 raeburn 65: $multiple = $env{'form.multiple'};
66: if ($multiple) {
67: ($jscript,$multelement) = &multiples_tag();
1.82 bisitz 68: $title = 'Selecting '.$type.'(s)';
1.54 raeburn 69: }
70:
1.55 raeburn 71: # if called when a DC is selecting a course
1.54 raeburn 72: my $roledom = $env{'form.roleelement'};
73: if ($roledom) {
74: $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
1.66 raeburn 75: $submitopener = &processpick();
1.54 raeburn 76: $autosubmit = 'process_pick("'.$roledom.'")';
77: }
1.90 raeburn 78: if ($env{'form.typeelement'} ne '') {
79: $typeelement = '<input type="hidden" name="typeelement" value="'.$env{'form.typeelement'}.'" />';
80: }
1.54 raeburn 81:
1.85 raeburn 82: # if called when a DC is creating a course
83: if ($env{'form.form'} eq 'ccrs') {
84: ($cloneruname,$clonerudom) = ($env{'form.cloner'} =~ /^($match_username):($match_domain)$/);
85: }
86:
87: # if called when requesting a course
88: if ($env{'form.form'} eq 'requestcrs') {
89: $cloneruname = $env{'user.name'};
90: $clonerudom = $env{'user.domain'};
91: }
92:
1.54 raeburn 93: my $onlyown = 0;
1.55 raeburn 94: # if called to assign course-based portfolio access control
1.59 raeburn 95: if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
1.54 raeburn 96: $onlyown = 1;
1.49 raeburn 97: }
1.55 raeburn 98:
99: my %loaditem;
1.84 raeburn 100: if (($env{'form.type'} eq 'Course') && ($env{'form.numtitles'})) {
101: if (($env{'form.official'} eq 'on') && ($env{'form.state'} eq 'listing')) {
102: $loaditem{'onload'} = 'setElements(document.filterpicker); ';
103: }
1.78 raeburn 104: }
105:
1.66 raeburn 106: if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) &&
107: ($env{'form.pickedcourse'})) {
1.89 raeburn 108: $loaditem{'onload'} .= 'setRoles();setSections();';
1.30 raeburn 109: }
1.85 raeburn 110: my $js = &js_changer();
111: $r->print(&Apache::loncommon::start_page($title,$js,
1.42 albertel 112: {'add_entries' => \%loaditem,
1.41 albertel 113: 'no_nav_bar' => 1, }));
1.55 raeburn 114:
115: if ($env{'form.form'} eq 'portform') {
116: $lastaction = 'document.courselist.submit()';
1.67 raeburn 117: } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
118: !$multiple)) {
1.55 raeburn 119: $lastaction =
120: 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
121: 'document.courselist.submit();';
1.34 albertel 122: } else {
1.55 raeburn 123: $lastaction = 'self.close()';
1.1 www 124: }
1.19 raeburn 125:
1.55 raeburn 126: # if called to assign a role in a course to a user via CUSR
1.66 raeburn 127: if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
1.68 raeburn 128: $r->print(&create_user_javascript($type));
1.55 raeburn 129: }
1.54 raeburn 130:
1.55 raeburn 131: # print javascript functions for choosing a course
1.85 raeburn 132: if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) ||
133: $onlyown) {
1.58 raeburn 134: $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
1.55 raeburn 135: }
1.79 raeburn 136: $r->print('<script type="text/javascript" language="Javascript">'.$jscript.
137: '</script>');
1.55 raeburn 138: $r->print($submitopener);
1.54 raeburn 139:
1.55 raeburn 140: # ------------------------------------------ Display of filters to limit search
1.57 raeburn 141: my $filter = {};
142: my $action = '/adm/pickcourse';
1.79 raeburn 143: my ($numtitles,$showroles,$nohost);
1.55 raeburn 144: if (!$onlyown) {
145: my $filterlist = ['domainfilter','descriptfilter',
1.79 raeburn 146: 'instcodefilter'];
147: if ($env{'form.form'} eq 'rules') {
148: push(@{$filterlist},'personfilter');
149: if (($env{'form.personfilter'} ne '') && ($env{'form.persondomfilter'} ne '')) {
150: if (&Apache::lonnet::homeserver($env{'form.personfilter'},
151: $env{'form.persondomfilter'}) eq 'no_host') {
152: $nohost = 1;
153: } else {
154: $showroles = 1;
155: }
156: }
157: } else {
158: push(@{$filterlist},'ownerfilter');
159: }
1.55 raeburn 160: # course ID filter for DCs only
161: if ($env{'user.adv'} && $env{'form.domainfilter'} &&
162: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
163: push(@{$filterlist},'coursefilter');
164: }
1.85 raeburn 165: if ($cloneruname ne '' && $clonerudom ne '') {
166: push(@{$filterlist},'cloneableonly');
167: }
168:
1.55 raeburn 169: $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
1.85 raeburn 170: $filter,$action,\$numtitles,undef,$cloneruname,
1.90 raeburn 171: $clonerudom,$typeelement));
1.55 raeburn 172: }
1.54 raeburn 173:
174: # ---------------------------------------------------------------- Get the data
1.85 raeburn 175: if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) ||
176: $onlyown) {
177: my %courses = &search_courses($r,$type,$onlyown,$filter,$numtitles,
178: $cloneruname,$clonerudom);
1.79 raeburn 179: if ($nohost) {
180: $r->print ('<span class="LC_warning">'.
181: &mt('User does not exist - username: [_1], domain: [_2].',
182: '<b>'.$filter->{'personfilter'}.'</b>',
183: '<b>'.$filter->{'persondomfilter'}.'</b>').'</span>');
184: } else {
1.85 raeburn 185: &display_matched_courses($r,$type,$multiple,$action,$showroles,$cloneruname,
186: $clonerudom,%courses);
1.79 raeburn 187: }
1.54 raeburn 188: }
189: $r->print(&Apache::loncommon::end_page());
190: return OK;
191: }
192:
1.85 raeburn 193: sub js_changer {
194: return <<"ENDJS";
195: <script type="text/javascript">
196:
197: function updateFilters(caller) {
198: if (typeof(caller) != "undefined") {
199: document.filterpicker.updater.value = caller.name;
200: }
201: document.filterpicker.submit();
202: }
203:
204: </script>
205:
206: ENDJS
207:
208: }
209:
1.66 raeburn 210: sub processpick {
211: my $openerform = 'rolechoice';
212: if ($env{'form.form'} eq 'studentform') {
213: $openerform = $env{'form.form'};
214: }
215: my $process_pick = <<"ENDONE";
216: <script type="text/javascript">
217: function process_pick(dom) {
218: var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value;
219: var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value;
220: var okDomain = 0;
221: ENDONE
222: if ($openerform eq 'rolechoice') {
223: $process_pick .= <<"ENDTWO";
224: if (pickedDomain == dom) {
225: if (pickedCourse != '') {
1.88 raeburn 226: var ccrole = "cc";
227: var pickedType = "$env{'form.type'}";
228: if (pickedType == "Community") {
229: ccrole = "co";
230: }
231: var courseTarget = ccrole+"./"+pickedDomain+"/"+pickedCourse
1.66 raeburn 232: opener.document.title='Role selected. Please stand by.';
233: opener.status='Role selected. Please stand by.';
234: opener.document.rolechoice.newrole.value=courseTarget
235: opener.document.rolechoice.submit();
236: }
237: }
238: else {
239: 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");
240: }
241: ENDTWO
242: } else {
243: $process_pick .= <<"ENDTHREE";
244: if (pickedDomain != dom) {
245: 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");
246: return;
247: }
248: ENDTHREE
249: }
250: $process_pick .= "
251: }
252:
253: </script>
254: ";
255: return $process_pick;
256: }
257:
1.55 raeburn 258: sub create_user_javascript {
259: my ($type) = @_;
260: my $output;
261: #javascript for reporting sections and groups then closing
262: if ($env{'form.pickedcourse'}) {
1.87 raeburn 263: my %coursedescription =
264: &Apache::lonnet::coursedescription($env{'form.pickedcourse'},
265: {'one_time' => '1'});
266: my $cdom = $coursedescription{'domain'};
267: my $cnum = $coursedescription{'num'};
268: my $crstype = $coursedescription{'type'};
1.55 raeburn 269: my $sec_element = 'currsec';
270: my $grplist_element = 'groups';
271: my ($sections,$groups) =
272: &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
273: my $num_sections = scalar(@{$sections});
274: my $seclist = join(',',@{$sections});
275: my $num_groups = scalar(@{$groups});
276: my $groupslist = join(',',@{$groups});
277: $output = qq|
278: <script type="text/javascript">
279: function setSections() {
280: opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
281: window.opener.setSect('$seclist');
1.87 raeburn 282: self.close();
283: }
284: function setRoles() {
285: window.opener.setRole('$crstype');
1.55 raeburn 286: }
287: </script>
288: |;
289: ;
290: }
291: return $output;
292: }
293:
1.54 raeburn 294: sub display_matched_courses {
1.85 raeburn 295: my ($r,$type,$multiple,$action,$showroles,$cloneruname,$clonerudom,%courses) = @_;
1.55 raeburn 296: if ($env{'form.form'} eq 'portform') {
297: $action = '/adm/portfolio';
298: }
1.68 raeburn 299: my $numcourses = keys(%courses);
1.55 raeburn 300: $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.68 raeburn 301: if ($env{'form.form'} eq 'modifycourse') {
302: if ($numcourses > 0) {
1.89 raeburn 303: my $ccrole = 'cc';
304: if ($type eq 'Community') {
305: $ccrole = 'co';
306: }
307: my $cctitle = &Apache::lonnet::plaintext($ccrole,$type);
1.68 raeburn 308: my $dctitle = &Apache::lonnet::plaintext('dc');
309: my $ccrolechk = ' checked="checked" ';
310: my $menuchk = ' ';
311: if ($env{'form.prevphase'} ne '') {
312: $ccrolechk = ' ';
313: $menuchk = ' checked="checked" ';
314: }
315: $r->print(
1.75 bisitz 316: '<fieldset>'
317: .'<legend>'.&mt('Action').'</legend>'
318: .'<div class="LC_nobreak"><label>'
319: .'<input type="radio" name="phase" value="ccrole"'.$ccrolechk.'/>'
1.89 raeburn 320: .' ');
321: if ($type eq 'Community') {
322: $r->print(&mt('Enter the community with the role of [_1].',$cctitle));
323: } else {
324: $r->print(&mt('Enter the course with the role of [_1].',$cctitle));
325: }
326: $r->print('</label></div>'
1.75 bisitz 327: .'<div class="LC_nobreak"><label>'
1.89 raeburn 328: .'<input type="radio" name="phase" value="menu"'.$menuchk.'/> ');
329: if ($type eq 'Community') {
330: $r->print(&mt('View or modify community settings which only a [_1] may modify.',$dctitle));
331: } else {
332: $r->print(&mt('View or modify course settings which only a [_1] may modify.',$dctitle));
333: }
334: $r->print('</label></div>'
1.75 bisitz 335: .'</fieldset>'
336: .'<br />'
337: );
1.68 raeburn 338: }
339: }
1.54 raeburn 340: my %by_descrip;
341: foreach my $course (keys(%courses)) {
342: my $descr;
1.64 raeburn 343: if (ref($courses{$course}) eq 'HASH') {
1.65 raeburn 344: $descr = $courses{$course}{'description'};
1.64 raeburn 345: } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54 raeburn 346: $descr = &unescape($1);
1.34 albertel 347: } else {
1.54 raeburn 348: $descr = &unescape($courses{$course});
349: }
350: my $description = $descr;
351: push (@{$by_descrip{$description}}, $course);
352: }
1.71 bisitz 353:
1.54 raeburn 354: if ($numcourses > 1 && $multiple) {
355: $r->print('<input type="button" value="check all"
356: onclick="javascript:checkAll(document.courselist.course_id)" />
357: <input type="button" value="uncheck all"
358: onclick="javascript:uncheckAll(document.courselist.course_id)" />
359: <br /><br />');
360: }
1.71 bisitz 361:
362: if (%courses) {
363: $r->print(&Apache::loncommon::start_data_table());
364: $r->print(&Apache::loncommon::start_data_table_header_row());
1.89 raeburn 365: my $titlehdr = &mt('Course Title');
366: if ($type eq 'Community') {
367: $titlehdr = &mt('Community Title');
368: }
1.71 bisitz 369: $r->print('<th>'.&mt('Select').'</th>'
1.89 raeburn 370: .'<th>'.$titlehdr.'</th>'
371: .'<th>'.&mt('Domain').'</th>');
372: unless ($type eq 'Community') {
373: $r->print('<th>'.&mt('Course Code').'</th>');
374: }
375: $r->print('<th>'.&mt('Owner/Co-owner(s)').'</th>');
1.79 raeburn 376: if ($showroles) {
377: $r->print('<th>'.&mt("Role(s) for [_1]",
378: &Apache::loncommon::plainname($env{'form.personfilter'},
379: $env{'form.persondomfilter'},'firstname')).'</th>');
380: }
1.71 bisitz 381: $r->print(&Apache::loncommon::end_data_table_header_row());
382: }
1.54 raeburn 383: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
384: foreach my $course (@{$by_descrip{$description}}) {
1.72 raeburn 385: $r->print(&Apache::loncommon::start_data_table_row());
1.54 raeburn 386: my $cleandesc=&HTML::Entities::encode($description,'<>&"');
387: $cleandesc=~s/'/\\'/g;
388: my ($cdom,$cnum)=split(/\_/,$course);
1.85 raeburn 389: my ($descr,$instcode,$ttype,$canclone,@owners);
1.64 raeburn 390: if (ref($courses{$course}) eq 'HASH') {
391: $descr = $courses{$course}{'description'};
1.85 raeburn 392: $instcode = $courses{$course}{'inst_code'};
393: $ttype = $courses{$course}{'type'};
394: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
395: my $cloners = $courses{$course}{'cloners'};
396: if ($cloners ne '') {
397: my @cloneable = split(',',$cloners);
398: if (grep(/^\*$/,@cloneable)) {
399: $canclone = 1;
400: }
401: if (grep(/^\*:\Q$env{'form.clonerudom'}\E$/,@cloneable)) {
402: $canclone = 1;
403: }
404: if (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
405: $canclone = 1;
406: }
407: }
408: }
1.64 raeburn 409: push(@owners,&unescape($courses{$course}{'owner'}));
410: if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
411: foreach my $item (@{$courses{$course}{'co-owners'}}) {
412: push(@owners,&unescape($item));
413: }
414: }
415: } else {
416: my $singleowner;
417: ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
418: push(@owners,&unescape($singleowner));
419: }
1.72 raeburn 420: my $ownerstr = join(', ',@owners);
1.85 raeburn 421: $r->print('<td>'.&course_chooser($multiple,$cdom,$cnum,$cleandesc,$canclone).'</td>');
1.71 bisitz 422: $r->print('<td>'.$description.'</td>');
423: $r->print('<td>');
424: $r->print(&Apache::lonnet::domain($cdom,'description')?
425: $cdom.' ('.&Apache::lonnet::domain($cdom,'description').')':$cdom);
426: $r->print('</td>');
1.89 raeburn 427: unless ($type eq 'Community') {
428: $r->print('<td>');
429: if ($instcode ne '') {
430: $r->print(&unescape($instcode));
431: } else {
432: $r->print(' ');
433: }
434: $r->print('</td>');
1.54 raeburn 435: }
1.72 raeburn 436: $r->print('<td>'.$ownerstr.'</td>');
1.79 raeburn 437: if ($showroles) {
438: $r->print('<td>');
439: my $rolestr;
440: if (ref($courses{$course}{'roles'}) eq 'ARRAY') {
441: my @roles = sort(@{$courses{$course}{'roles'}});
442: foreach my $role (@roles) {
443: if ($role =~ /^cr/) {
444: my (undef,$crdom,$crname,$crtitle) = split('/',$role);
445: $rolestr .= $crtitle.', ';
446: } else {
1.89 raeburn 447: $rolestr .= &Apache::lonnet::plaintext($role,$type).', ';
1.79 raeburn 448: }
449: }
450: $rolestr =~ s/\, $//;
451: }
452: $r->print($rolestr.'</td>');
453: }
1.54 raeburn 454: if ($multiple) { $r->print("</label>\n"); }
1.72 raeburn 455: $r->print(&Apache::loncommon::end_data_table_row());
1.71 bisitz 456: # $r->print("<br />\n");
1.19 raeburn 457: }
458: }
1.72 raeburn 459: if (%courses) {
460: $r->print(&Apache::loncommon::end_data_table());
461: }
1.71 bisitz 462:
1.54 raeburn 463: if (!%courses) {
464: $r->print(&mt('None found'));
465: } elsif ($multiple) {
1.57 raeburn 466: $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54 raeburn 467: }
468: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
469: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
470: '<input type="hidden" name="type" value="'.$type.'" />'."\n");
471: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
472: $r->print('<input type="hidden" name="roleelement" value="'.
473: $env{'form.roleelement'}.'" />'."\n");
474: }
1.55 raeburn 475: if ($env{'form.form'} eq 'portform') {
476: $r->print('<input type="hidden" name="cnum" value="" />');
477: $r->print('<input type="hidden" name="cdom" value="" />');
478: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
479: $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57 raeburn 480: } elsif ($env{'form.form'} eq 'modifycourse') {
1.85 raeburn 481: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form','numtitles','state']));
1.57 raeburn 482: } else {
483: $r->print('<input type="hidden" name="cnumelement" value="'.
484: $env{'form.cnumelement'}.'" />'."\n".
485: '<input type="hidden" name="cdomelement" value="'.
486: $env{'form.cdomelement'}.'" />'."\n");
1.90 raeburn 487: if ($env{'form.typeelement'} ne '') {
488: $r->print('<input type="hidden" name="typeelement" value="'.
489: $env{'form.typeelement'}.'" />'."\n");
490:
491: }
1.55 raeburn 492: }
1.78 raeburn 493: if ((exists($env{'form.fixeddom'})) && ($env{'form.form'} eq 'rules')) {
494: $r->print('<input type="hidden" name="fixeddom" value="'.
495: $env{'form.fixeddom'}.'" />');
496: }
497: if ($env{'form.numtitles'}) {
498: $r->print('<input type="hidden" name="numtitles" value="'.
499: $env{'form.numtitles'}.'" />');
500: }
1.54 raeburn 501: $r->print("</form>\n");
502: return;
503: }
504:
505: sub multiples_tag {
1.55 raeburn 506: my $jscript = &Apache::loncommon::check_uncheck_jscript();
507: my $multelement = '<input type="hidden" name="multiple" value="1" />';
508: return ($jscript,$multelement);
1.1 www 509: }
1.30 raeburn 510:
1.54 raeburn 511: sub build_filters {
1.57 raeburn 512: my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
1.90 raeburn 513: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement) = @_;
1.85 raeburn 514: my ($list,$formname,$fixeddom,$codedom,$jscript);
515: $codedom = $env{'request.role.domain'};
1.57 raeburn 516: if (defined($env{'form.form'})) {
1.81 raeburn 517: $formname = $env{'form.form'};
518: } else {
519: $formname = $caller;
1.57 raeburn 520: }
1.84 raeburn 521: my $onchange;
522: unless ($env{'form.interface'} eq 'textual') {
1.85 raeburn 523: $onchange = 'javascript:updateFilters(this)';
1.84 raeburn 524: }
1.79 raeburn 525: my ($domainselectform,$sincefilterform,$ownerdomselectform,$persondomselectform,
1.78 raeburn 526: $instcodeform,$typeselectform,$instcodetitle);
1.55 raeburn 527: foreach my $item (@{$filterlist}) {
1.54 raeburn 528: $filter->{$item} = $env{'form.'.$item};
529: if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.79 raeburn 530: if ($item eq 'domainfilter') {
1.61 albertel 531: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
532: } elsif ($item eq 'coursefilter') {
533: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
534: } elsif ($item eq 'ownerfilter') {
535: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
1.79 raeburn 536: $filter->{'ownerdomfilter'} =
537: &LONCAPA::clean_domain($env{'form.ownerdomfilter'});
538: $ownerdomselectform =
539: &Apache::loncommon::select_dom_form($filter->{'ownerdomfilter'},
540: 'ownerdomfilter',1);
541: } elsif ($item eq 'personfilter') {
542: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
543: if ($env{'form.persondomfilter'} eq '') {
1.85 raeburn 544: unless ($env{'form.gosearch'}) {
1.79 raeburn 545: $filter->{'persondomfilter'} = $env{'request.role.domain'};
546: }
547: } else {
548: $filter->{'persondomfilter'} =
549: &LONCAPA::clean_domain($env{'form.persondomfilter'});
550: }
551: $persondomselectform =
552: &Apache::loncommon::select_dom_form($filter->{'persondomfilter'},
553: 'persondomfilter',1);
1.61 albertel 554: } else {
555: $filter->{$item} =~ s/\W//g;
556: }
1.54 raeburn 557: if (!$filter->{$item}) {
558: $filter->{$item} = '';
559: }
560: }
561: if ($item eq 'domainfilter') {
1.63 albertel 562: my $allow_blank = 1;
563: if ($formname eq 'portform') {
564: $filter->{$item} ||= $env{'user.domain'};
565: $allow_blank=0;
1.67 raeburn 566: } elsif ($formname eq 'studentform') {
567: $filter->{$item} ||= $env{'request.role.domain'};
568: $allow_blank=0;
569: }
1.78 raeburn 570: if ($env{'form.fixeddom'}) {
571: $domainselectform = '<input type="hidden" name="domainfilter"'.
572: 'value="'.$env{'request.role.domain'}.'" />'.
573: &Apache::lonnet::domain($env{'request.role.domain'},
574: 'description');
575: $codedom = $env{'request.role.domain'};
1.79 raeburn 576: } else {
1.78 raeburn 577: $domainselectform =
578: &Apache::loncommon::select_dom_form($filter->{$item},
579: 'domainfilter',
1.84 raeburn 580: $allow_blank,'',$onchange);
1.78 raeburn 581: $codedom = $filter->{'domainfilter'};
582: }
1.54 raeburn 583: } else {
584: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
585: }
586: }
587:
588: # last course activity filter and selection
589: $filter->{'sincefilter'} = $env{'form.sincefilter'};
590: $filter->{'sincefilter'} =~ s/[^\d-]//g;
591: if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
1.91 ! bisitz 592: $sincefilterform=&Apache::loncommon::select_form(
! 593: $filter->{'sincefilter'},
! 594: 'sincefilter',
! 595: ( '-1' => '',
! 596: '86400' => &mt('today'),
! 597: '604800' => &mt('last week'),
! 598: '2592000' => &mt('last month'),
! 599: '7776000' => &mt('last three months'),
! 600: '15552000' => &mt('last six months'),
! 601: '31104000' => &mt('last year'),
! 602: 'select_form_order' =>
! 603: ['-1','86400','604800','2592000','7776000',
! 604: '15552000','31104000']));
! 605:
! 606: my %lt = &Apache::lonlocal::texthash(
! 607: 'cac' => "$type Activity",
! 608: 'cde' => "$type Title",
! 609: 'cdo' => "$type Domain",
! 610: 'ins' => 'Institutional Code',
! 611: 'inc' => 'Institutional Categorization',
! 612: 'cow' => "$type Owner/Co-owner",
! 613: 'cop' => "$type Personnel Includes",
! 614: 'cog' => 'Type',
1.54 raeburn 615: );
1.49 raeburn 616:
1.89 raeburn 617: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
618: my $typeval = 'Course';
619: if ($type eq 'Community') {
620: $typeval = 'Community';
621: }
622: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
623: } else {
624: $typeselectform = '<select name="type" size="1"';
625: if ($onchange) {
626: $typeselectform .= 'onchange="'.$onchange.'"';
627: }
628: $typeselectform .= '>'."\n";
629: foreach my $posstype ('Course','Community') {
630: $typeselectform.='<option value="'.$posstype.'"'.
631: ($posstype eq $type ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
632: }
633: $typeselectform.="</select>";
1.84 raeburn 634: }
1.85 raeburn 635:
636: my ($cloneableonlyform,$cloneabletitle);
637: if (exists($filter->{'cloneableonly'})) {
638: my $cloneableon = '';
639: my $cloneableoff = ' checked="checked"';
640: if ($filter->{'cloneableonly'}) {
641: $cloneableon = $cloneableoff;
642: $cloneableoff = '';
643: }
1.86 raeburn 644: $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/> '.&mt('Required').'</label>'.(' 'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' /> '.&mt('No restriction').'</label></span>';
1.85 raeburn 645: if ($env{'form.form'} eq 'ccrs') {
646: $cloneabletitle = &mt('Cloneable for').' '.$cloneruname.':'.$clonerudom;
647: } else {
648: $cloneabletitle = &mt('Cloneable by you');
649: }
650: }
1.80 raeburn 651: my $officialjs;
1.54 raeburn 652: if ($type eq 'Course') {
1.85 raeburn 653: if (exists($filter->{'instcodefilter'})) {
654: if (($env{'form.fixeddom'}) || ($formname eq 'requestcrs')
655: || ($formname eq 'modifycourse')) {
656: $officialjs = 1;
657: ($instcodeform,$jscript,$$numtitlesref) =
658: &instcode_selectors($codedom,'filterpicker',$officialjs);
659: if ($jscript) {
660: $jscript = '<script type="text/javascript" language="Javascript">'.
661: $jscript.'</script>'."\n";
662: }
663: }
664: if ($instcodeform eq '') {
665: $instcodeform =
666: '<input type="text" name="instcodefilter" size="10" value="'.
667: $list->{'instcodefilter'}.'" />';
668: $instcodetitle = $lt{'ins'};
669: } else {
670: $instcodetitle = $lt{'inc'};
671: }
672: if ($env{'form.fixeddom'}) {
673: $instcodetitle .= '<br />('.$codedom.')';
674: }
1.78 raeburn 675: }
1.54 raeburn 676: }
1.84 raeburn 677:
1.57 raeburn 678: my $output = qq|
1.85 raeburn 679: <form method="post" name="filterpicker" action="$action">
1.57 raeburn 680: <input type="hidden" name="form" value="$formname" />
681: |;
682: if ($formname eq 'modifycourse') {
1.68 raeburn 683: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
684: '<input type="hidden" name="prevphase" value="'.
685: $env{'form.prevphase'}.'" />'."\n";
686: } else {
1.57 raeburn 687: my $name_input;
688: if ($env{'form.cnameelement'} ne '') {
689: $name_input = '<input type="hidden" name="cnameelement" value="'.
690: $env{'form.cnameelement'}.'" />';
691: }
692: $output .= qq|
1.27 albertel 693: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
694: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13 albertel 695: $name_input
1.18 raeburn 696: $roleelement
1.35 raeburn 697: $multelement
1.90 raeburn 698: $typeelement
1.57 raeburn 699: |;
1.59 raeburn 700: if ($formname eq 'portform') {
1.78 raeburn 701: $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />'."\n";
1.59 raeburn 702: }
1.57 raeburn 703: }
1.78 raeburn 704: if ($env{'form.fixeddom'}) {
705: $output .= '<input type="hidden" name="fixeddom" value="'.$env{'form.fixeddom'}.'" />'."\n";
706: }
1.74 bisitz 707: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
1.57 raeburn 708: if ($sincefilterform) {
1.74 bisitz 709: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
710: .$sincefilterform
711: .&Apache::lonhtmlcommon::row_closure();
1.57 raeburn 712: }
713: if ($domainselectform) {
1.74 bisitz 714: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
715: .$domainselectform
716: .&Apache::lonhtmlcommon::row_closure();
1.78 raeburn 717: }
1.57 raeburn 718: if ($typeselectform) {
1.89 raeburn 719: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
720: $output .= $typeselectform;
721: } else {
722: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
723: .$typeselectform
724: .&Apache::lonhtmlcommon::row_closure();
725: }
1.57 raeburn 726: }
727: if ($instcodeform) {
1.78 raeburn 728: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
1.74 bisitz 729: .$instcodeform
730: .&Apache::lonhtmlcommon::row_closure();
1.57 raeburn 731: }
732: if (exists($filter->{'ownerfilter'})) {
1.79 raeburn 733: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
734: '<table><tr><td>'.&mt('Username').'<br />'.
735: '<input type="text" name="ownerfilter" size="20" value="'.
736: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
737: $ownerdomselectform.'</td></tr></table>'.
738: &Apache::lonhtmlcommon::row_closure();
739: }
740: if (exists($filter->{'personfilter'})) {
741: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
742: '<table><tr><td>'.&mt('Username').'<br />'.
743: '<input type="text" name="personfilter" size="20" value="'.
744: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
745: $persondomselectform.'</td></tr></table>'.
746: &Apache::lonhtmlcommon::row_closure();
1.57 raeburn 747: }
748: if (exists($filter->{'coursefilter'})) {
1.74 bisitz 749: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
750: .'<input type="text" name="coursefilter" size="25" value="'
751: .$list->{'coursefilter'}.'" />'
752: .&Apache::lonhtmlcommon::row_closure();
1.57 raeburn 753: }
1.85 raeburn 754: if ($cloneableonlyform) {
755: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
756: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
757: }
1.57 raeburn 758: if (exists($filter->{'descriptfilter'})) {
1.74 bisitz 759: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
760: .'<input type="text" name="descriptfilter" size="40" value="'
761: .$list->{'descriptfilter'}.'" />'
762: .&Apache::lonhtmlcommon::row_closure(1);
1.57 raeburn 763: }
1.85 raeburn 764: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>';
765: my $warning;
766: if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
767: my $cloneruhome=&Apache::lonnet::homeserver($cloneruname,$clonerudom);
768: my $cc_clone;
769: if ($cloneruhome eq 'no_host') {
770: $warning = '<div class="LC_error">'.&mt('Intended course owner does not exist').
771: '</div>';
772: } else {
1.89 raeburn 773: my $ccrole;
774: if ($type eq 'Community') {
775: $ccrole = 'co';
776: } elsif ($type eq 'Course') {
777: $ccrole = 'cc';
778: }
1.85 raeburn 779: if ($env{'form.form'} eq 'ccrs') {
780: $output .= '<input type="hidden" name="cloner" value="'.$env{'form.cloner'}.'" />'."\n";
781: }
782: my %ccroles = &Apache::lonnet::get_my_roles($cloneruname,$clonerudom,
1.89 raeburn 783: 'userroles',['active'], [$ccrole]);
1.85 raeburn 784: foreach my $key (sort(keys(%ccroles))) {
785: my ($cnum,$cdom,$role) = split(':',$key);
786: $cc_clone .= $cdom.':'.$cnum.'&';
787: }
788: $cc_clone =~ s/\&$//;
789: }
790: if ($cc_clone ne '') {
791: $output .= '<input type="hidden" name="cc_clone" value="'.$cc_clone.'" />';
792: }
793: }
794: $output .= '<input type="hidden" name="updater" value="">'."\n".
1.84 raeburn 795: '<input type="submit" name="gosearch" value="'.
1.70 raeburn 796: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
1.85 raeburn 797: return $jscript.$warning.$output;
1.78 raeburn 798: }
799:
800: sub instcode_selectors {
1.80 raeburn 801: my ($codedom,$formname,$officialjs) = @_;
1.78 raeburn 802: my ($output,@codetitles,%cat_titles,%cat_order,%cat_items);
803: my ($jscript,$totcodes,$numtitles,$lasttitle) =
804: &Apache::courseclassifier::instcode_selectors_data($codedom,$formname,
1.80 raeburn 805: \%cat_items,\@codetitles,\%cat_titles,\%cat_order,$officialjs);
1.78 raeburn 806: if ($numtitles > 0) {
1.84 raeburn 807: my $official = ' checked="checked" ';
808: my $unofficial = '';
809: if ($env{'form.official'} eq 'off') {
810: $unofficial = $official;
811: $official = '';
1.80 raeburn 812: }
813: $output .= '<span class="LC_nobreak">'.&mt('Official course:').' <label>'.
1.84 raeburn 814: '<input type="radio" name="official" value="on"'.$official.' />'.
1.80 raeburn 815: &mt('Yes').'</label>'.(' 'x3).'<label>'.
1.84 raeburn 816: '<input type="radio" name="official" value="off"'.$unofficial.
1.80 raeburn 817: ' onclick="toggleOfficial();" />'.&mt('No').'</label></span><br />'.
818: &Apache::courseclassifier::build_instcode_selectors($numtitles,
819: $lasttitle,\%cat_items,\@codetitles,\%cat_titles,\%cat_order)."\n".
820: '<input type="hidden" name="numtitles" value="'.$numtitles.'" />'."\n".
821: '<input type="hidden" name="state" value="listing" />'."\n";
1.78 raeburn 822:
823: }
824: return ($output,$jscript,$numtitles);
1.54 raeburn 825: }
826:
827: sub search_courses {
1.85 raeburn 828: my ($r,$type,$onlyown,$filter,$numtitles,$cloneruname,$clonerudom) = @_;
1.89 raeburn 829: my (%courses,%showcourses,$cloner,$ccrole);
830: if ($type eq 'Community') {
831: $ccrole = 'co';
832: } else {
833: $ccrole = 'cc';
834: }
1.54 raeburn 835: if (!$onlyown) {
1.71 bisitz 836: $r->print(&mt('Searching ...').'<br /> <br />');
1.6 www 837: $r->rflush();
1.54 raeburn 838: if (($filter->{'ownerfilter'} ne '') ||
839: ($filter->{'ownerdomfilter'} ne '')) {
840: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
841: $filter->{'ownerdomfilter'};
842: }
1.80 raeburn 843: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
1.54 raeburn 844: if (!$filter->{$item}) {
845: $filter->{$item}='.';
846: }
1.52 raeburn 847: }
1.54 raeburn 848: my $timefilter =
849: ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
1.78 raeburn 850: my ($instcodefilter,$regexpok);
851: if ($numtitles) {
1.84 raeburn 852: if ($env{'form.official'} eq 'on') {
1.80 raeburn 853: $instcodefilter =
1.84 raeburn 854: &Apache::courseclassifier::instcode_search_str($filter->{'domainfilter'},$numtitles);
1.80 raeburn 855: $regexpok = 1;
1.84 raeburn 856: } elsif ($env{'form.official'} eq 'off') {
857: $instcodefilter = &Apache::courseclassifier::instcode_search_str($filter->{'domainfilter'},$numtitles);
858: unless ($instcodefilter eq '') {
859: $regexpok = -1;
860: }
1.80 raeburn 861: }
1.78 raeburn 862: } else {
863: $instcodefilter = $filter->{'instcodefilter'};
864: }
1.80 raeburn 865: if ($instcodefilter eq '') { $instcodefilter = '.'; }
866: if ($type eq '') { $type = '.'; }
1.85 raeburn 867:
868: if (($clonerudom ne '') && ($cloneruname ne '')) {
869: $cloner = $cloneruname.':'.$clonerudom;
870: }
1.54 raeburn 871: %courses =
872: &Apache::lonnet::courseiddump($filter->{'domainfilter'},
873: $filter->{'descriptfilter'},
874: $timefilter,
1.78 raeburn 875: $instcodefilter,
1.54 raeburn 876: $filter->{'combownerfilter'},
877: $filter->{'coursefilter'},
1.85 raeburn 878: undef,undef,$type,$regexpok,undef,undef,
879: undef,undef,$cloner,$env{'form.cc_clone'},
880: $filter->{'cloneableonly'});
1.79 raeburn 881: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
882: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
883: $filter->{'persondomfilter'},
884: 'userroles',undef,
1.89 raeburn 885: [$ccrole,'in','ad','ep','ta','cr'],
1.79 raeburn 886: $filter->{'domainfilter'});
887: foreach my $role (keys(%rolehash)) {
888: my ($cnum,$cdom,$courserole) = split(':',$role);
889: my $cid = $cdom.'_'.$cnum;
890: if (exists($courses{$cid})) {
891: if (ref($courses{$cid}) eq 'HASH') {
892: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
893: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
894: push (@{$courses{$cid}{roles}},$courserole);
895: }
896: } else {
897: $courses{$cid}{roles} = [$courserole];
898: }
899: $showcourses{$cid} = $courses{$cid};
900: }
901: }
902: }
903: %courses = %showcourses;
904: }
1.54 raeburn 905: } else {
906: $r->print('<br />');
1.60 raeburn 907: my %coursehash = &Apache::loncommon::findallcourses();
908: foreach my $cid (sort(keys(%coursehash))) {
1.65 raeburn 909: $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
1.36 raeburn 910: }
1.2 www 911: }
1.54 raeburn 912: return %courses;
1.18 raeburn 913: }
1.1 www 914:
1.30 raeburn 915: sub course_chooser {
1.85 raeburn 916: my ($multiple,$cdom,$cnum,$cleandesc,$canclone) = @_;
1.30 raeburn 917: my $output;
1.35 raeburn 918: if ($multiple) {
1.32 albertel 919: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.85 raeburn 920: } elsif ((($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) && (!$canclone)) {
921: if ($env{'form.form'} eq 'ccrs') {
922: $output = &mt('No cloning for ').$env{'form.cloner'}."\n";
923: } else {
924: $output = &mt('No rights to clone')."\n";
925: }
1.30 raeburn 926: } else {
1.71 bisitz 927: $output = '<input type="button" value="'.&mt('Select').'" onClick="gochoose('.
1.30 raeburn 928: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
929: }
930: return $output;
1.49 raeburn 931: }
932:
1.55 raeburn 933: sub gochoose_javascript {
1.57 raeburn 934: my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55 raeburn 935: my %elements = (
936: 'Course' => {
937: name => 'coursepick',
938: total => 'coursetotal',
939: list => 'courselist',
940: },
1.83 raeburn 941: 'Community' => {
1.88 raeburn 942: name => 'coursepick',
943: total => 'coursetotal',
944: list => 'courselist',
1.55 raeburn 945: },
946: );
1.57 raeburn 947: my $output .= qq|
1.55 raeburn 948: <script type="text/javascript">
1.57 raeburn 949: function gochoose(cname,cdom,cdesc) {
1.55 raeburn 950: var openerForm = "$env{'form.form'}";
951: courseCount = 0;
952: var courses = '';
1.57 raeburn 953: |;
954: if ($multiple) {
955: $output .= <<"ENDSCRIPT";
956: courseCount = 0;
957: var courses = '';
958: if (typeof(document.courselist.course_id.length) == 'undefined') {
959: // only 1 course checkbox was created
960: if (document.courselist.course_id.checked) {
961: courses = courses + document.courselist.course_id.value + "&&";
962: courseCount ++;
963: }
964: } else {
965: for (var j=0; j<document.courselist.course_id.length; j++) {
966: if (document.courselist.course_id[j].checked) {
967: courses = courses + document.courselist.course_id[j].value + "&&";
1.55 raeburn 968: courseCount ++;
969: }
1.57 raeburn 970: }
971: }
972: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
973: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
974: 'undefined') {
975: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
976: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55 raeburn 977: } else {
1.57 raeburn 978: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55 raeburn 979: }
1.57 raeburn 980: } else {
981: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
982: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
983: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55 raeburn 984: } else {
1.57 raeburn 985: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54 raeburn 986: }
1.55 raeburn 987: }
1.57 raeburn 988: }
989: if (courseCount > 0) {
990: courses = courses.substr(0,courses.length-2);
991: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
992: }
993: ENDSCRIPT
994: } else {
1.90 raeburn 995: my ($name_code,$type_code);
1.57 raeburn 996: if ($env{'form.cnameelement'} ne '') {
997: $name_code = 'opener.document.'.$env{'form.form'}.'.'.
998: $env{'form.cnameelement'}.'.value=cdesc;';
1.55 raeburn 999: }
1.90 raeburn 1000: if ($env{'form.typeelement'} ne '') {
1001: $type_code = 'opener.document.'.$env{'form.form'}.'.'.
1002: $env{'form.typeelement'}.'.value=document.courselist.type;';
1003: }
1004:
1.57 raeburn 1005: $output .= qq|
1.55 raeburn 1006: $name_code
1.90 raeburn 1007: $type_code
1.55 raeburn 1008: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
1009: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
1010: if (slct.options == undefined) {
1011: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
1012: }
1013: else {
1014: var i;
1015: for (i=0;i<slct.length;i++) {
1016: if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54 raeburn 1017: }
1018: }
1.57 raeburn 1019: |;
1.54 raeburn 1020: }
1.57 raeburn 1021: $output .= qq|
1.55 raeburn 1022: if (openerForm == 'portform') {
1023: document.courselist.cnum.value = cname;
1024: document.courselist.cdom.value = cdom;
1025: }
1026: $autosubmit
1027: $lastaction
1.54 raeburn 1028: }
1.55 raeburn 1029: </script>
1.57 raeburn 1030: |;
1.55 raeburn 1031: return $output;
1.54 raeburn 1032: }
1033:
1.55 raeburn 1034: 1;
1035: __END__
1036:
1037: =pod
1038:
1039: =head1 NAME
1040:
1041: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.
1042:
1043: =head1 SYNOPSIS
1044:
1045: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user.
1046:
1047: =head1 OVERVIEW
1048:
1049: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses.
1050:
1051: =head2 Search Criteria (Screen One)
1052:
1053: =head3 Criteria:
1054:
1055: =over 4
1056:
1057: =item *
1058: Course Activity - how recently was course last visited by anyone.
1059:
1060: =item *
1061: Course Domain - the domain of the course
1062:
1063: =item *
1.84 raeburn 1064: Type - Course or Community
1.55 raeburn 1065:
1066: =item *
1067: Course Institutional Code - the institutional identifier assigned to the course
1068:
1069: =item *
1070: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
1071:
1072: =item *
1073: Course Owner's Domain - the domain of the owner of the course
1074:
1075: =item *
1.76 bisitz 1076: Course Title - text which appears in the Course Title, as set in the Course Parameters.
1.55 raeburn 1077:
1078: =item *
1079: 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).
1080:
1081: =back
1082:
1083: 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'}).
1084:
1085: =head2 Course Display (Screen Two)
1086:
1087: 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:
1088:
1089: =over 4
1090:
1091: =item *
1092: Course description
1093:
1094: =item *
1095: Domain description of course domain
1096:
1097: =item *
1098: Course institutional code
1099:
1100: =item *
1101: Course owner (username:domain)
1102:
1103: =back
1104:
1105: 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.
1106:
1107: 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.
1108:
1109: =head1 SUBROUTINES
1110:
1111: =over 4
1112:
1113: =item *
1114: X<create_user_javascript()>
1115: B<create_user_javascript($type)>:
1116:
1.83 raeburn 1117: Input: 1 - $type - the course type - Course or Community
1.55 raeburn 1118:
1119: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
1120:
1121: Side Effects: None
1122:
1123: 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.
1124:
1125:
1126: =item *
1127: X<display_matched_courses()>
1.85 raeburn 1128: B<display_matched_courses($r,$type,$multiple,$action,$showroles,$cloneruname,$clonerudom,%courses)>:
1.55 raeburn 1129:
1.85 raeburn 1130: Input: 7 - 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, hash of courses.
1.55 raeburn 1131:
1132: Output: 0
1133:
1134: 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.
1135:
1136: =item *
1137: X<multiples_tag()>
1138: B<multiples_tag()>:
1139:
1140:
1141: Input: 0
1142:
1143: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
1144:
1145: Side Effects: None
1146:
1147: =item *
1148: X<build_filters()>
1.90 raeburn 1149: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action,$numfiltersref,$caller,$cloneruname,$clonerudom,$typeelem)>:
1.55 raeburn 1150:
1151:
1.90 raeburn 1152: Input: 11 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action; ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number); caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm), username and domain of new course owner who wants to clone, $tyepelem
1.55 raeburn 1153:
1154: Output: 1 - $output - HTML for display of search criteria, and hidden form elements.
1155:
1156: Side Effects: None
1157:
1158: =item *
1159: X<search_courses()>
1.85 raeburn 1160: B<search_courses($r,$type,$onlyown,$filter,$numtitles,$cloneruname,$clonerudom)>:
1.55 raeburn 1161:
1162:
1.85 raeburn 1163: Input: 7 - request object, course type, search scope: only courses in which user has active role (1), or any course (0); anonymous hash of criteria and their values; for institutional codes - number of categories; optional username of new course owner, optional domain of new course owner). Last two needed when search is for courses to clone from course request form, or course creation form (DC).
1.55 raeburn 1164:
1165: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
1166:
1167: Side Effects: None
1168:
1169:
1170: =item *
1171: X<course_chooser()>
1.85 raeburn 1172: B<course_chooser($multiple,$cdom,$cnum,$cleandesc,$canclone)>:
1.55 raeburn 1173:
1.85 raeburn 1174: 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 1175:
1.85 raeburn 1176: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user to indicate course selection.
1.55 raeburn 1177:
1178: Side Effects: None
1179:
1180:
1181: =item *
1182: X<gochoose_javascript()>
1.57 raeburn 1183: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55 raeburn 1184:
1.66 raeburn 1185: 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 1186:
1187: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
1188:
1189: Side Effects: None
1190:
1191: javascript functions used when user selects a course(s). Different behavior depending on context:
1192:
1193: =back
1194:
1195: =over 8
1196:
1197: =item
1198:
1199: (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.
1200:
1201: =item
1202:
1203: (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.
1204:
1205: =item
1206:
1207: (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.
1208:
1209: =item
1.54 raeburn 1210:
1.55 raeburn 1211: (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 1212:
1.55 raeburn 1213: =item
1.54 raeburn 1214:
1.55 raeburn 1215: (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 1216:
1.55 raeburn 1217: =item
1.54 raeburn 1218:
1.55 raeburn 1219: (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 1220:
1.55 raeburn 1221: =item
1.49 raeburn 1222:
1.55 raeburn 1223: (g) Scantron Operator uploading a scantron file to a course - course number is written to visible form element in opener window. Child window closes.
1.30 raeburn 1224:
1.84 raeburn 1225: =item
1226:
1227: (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.
1228:
1.55 raeburn 1229: =back
1230:
1231: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>