1: # The LearningOnline Network
2: # Allow users to self-enroll in a course
3: #
4: # $Id: selfenroll.pm,v 1.27.2.5 2016/08/07 01:40:55 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: #
29: package Apache::selfenroll;
30:
31: use strict;
32: use Apache::Constants qw(:common);
33: use Apache::lonnet;
34: use Apache::loncommon;
35: use Apache::lonlocal;
36: use Apache::createaccount;
37: use Apache::loncoursequeueadmin;
38: use Apache::lonuserutils;
39: use LONCAPA qw(:DEFAULT :match);
40:
41: sub handler {
42: my $r = shift;
43: &Apache::loncommon::content_type($r,'text/html');
44: $r->send_http_header;
45: if ($r->header_only) {
46: return OK;
47: }
48: my $handle = &Apache::lonnet::check_for_valid_session($r);
49: my $lonidsdir=$r->dir_config('lonIDsDir');
50: my $lonhost = $r->dir_config('lonHostID');
51: if ($handle ne '') {
52: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
53: }
54: &Apache::lonacc::get_posted_cgi($r);
55: &Apache::lonlocal::get_language_handle($r);
56: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['courseid']);
57: my $js = &Apache::createaccount::catreturn_js();
58:
59: my $courseid = Apache::lonnet::is_course($env{'form.courseid'});
60:
61: unless ($courseid) {
62: &page_header($r,$env{'form.courseid'},$js);
63: $r->print('<h3>'.&mt('Self-enrollment error').'</h3>'.
64: '<span class="LC_error">'.
65: &mt('Invalid domain or course number').'</span>');
66: &page_footer($r);
67: return OK;
68: }
69: my $now = time;
70: if ($env{'form.phase'} eq 'login') {
71: $js .= "\n".&Apache::createaccount::javascript_setforms($now);
72: }
73: my %coursehash = &Apache::lonnet::coursedescription($courseid);
74: my $cdom = $coursehash{'domain'};
75: my $cnum = $coursehash{'num'};
76: my $desc = $coursehash{'description'};
77: &page_header($r,$courseid,$js,$desc);
78: my $include = $r->dir_config('lonIncludes');
79: if ($env{'form.phase'} eq 'login') {
80: my $jsh=Apache::File->new($include."/londes.js");
81: $r->print(<$jsh>);
82: }
83: my ($canenroll,$selfenroll_types,$selfenroll_registered,@cancreate,
84: $knownuser,$selfenroll_access_start,$selfenroll_access_end,
85: $selfenroll_section,$selfenroll_future,%curr_role,$cdomdesc,
86: $selfenroll_approval,$selfenroll_limit,$selfenroll_cap,
87: $selfenroll_notifylist,$owner,$crstype);
88: $selfenroll_types = $coursehash{'internal.selfenroll_types'};
89: $selfenroll_registered = $coursehash{'internal.selfenroll_registered'};
90: $selfenroll_section = $coursehash{'internal.selfenroll_section'};
91: $selfenroll_access_start = $coursehash{'internal.selfenroll_start_access'};
92: $selfenroll_access_end = $coursehash{'internal.selfenroll_end_access'};
93: $selfenroll_limit = $coursehash{'internal.selfenroll_limit'};
94: $selfenroll_cap = $coursehash{'internal.selfenroll_cap'};
95: $selfenroll_approval = $coursehash{'internal.selfenroll_approval'};
96: $selfenroll_notifylist = $coursehash{'internal.selfenroll_notifylist'};
97: $owner = $coursehash{'internal.courseowner'};
98: $crstype = $coursehash{'internal.type'};
99: if ($crstype eq '') {
100: $crstype = 'Course';
101: }
102: my $nospace;
103: if ($selfenroll_types ne '') {
104: my $start = $coursehash{'internal.selfenroll_start_date'};
105: my $end = $coursehash{'internal.selfenroll_end_date'};
106: if (($start > 0 && $start < $now) && (($end == 0) || ($end > 0 && $end > $now))) {
107: if (($selfenroll_limit eq 'allstudents') ||
108: ($selfenroll_limit eq 'selfenroll')) {
109: $nospace =
110: &enrollment_limit_check($selfenroll_limit,$selfenroll_cap,
111: $cdom,$cnum);
112: if (!$nospace) {
113: $canenroll = 1;
114: }
115: } else {
116: $canenroll = 1;
117: }
118: } elsif (($end == 0) || ($end > 0 && $end > $now)) {
119: if ($start > $now) {
120: if (($selfenroll_limit eq 'allstudents') ||
121: ($selfenroll_limit eq 'selfenroll')) {
122: $nospace =
123: &enrollment_limit_check($selfenroll_limit,$cdom,$cnum);
124: }
125: if (!$nospace) {
126: $selfenroll_future = &Apache::lonlocal::locallocaltime($start);
127: }
128: }
129: }
130: }
131: $knownuser = &user_is_known();
132: if (!$canenroll) {
133: $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3><span class="LC_warning">'.
134: &mt('Self-enrollment is not currently available for this course.').
135: '</span><br /><br />');
136: if ($nospace) {
137: if ($selfenroll_limit eq 'allstudents') {
138: $r->print(&mt('The enrollment limit of [quant,_1,student] has been reached.',$selfenroll_cap));
139: } else {
140: $r->print(&mt('The enrollment limit of [quant,_1,self-enrolled student] has been reached.',$selfenroll_cap));
141:
142: }
143: }
144: if ($selfenroll_types ne '') {
145: if ($selfenroll_future ne '') {
146: if ($selfenroll_types eq '*') {
147: $r->print(&mt('Self-enrollment will become available starting [_1], and will be available to all LON-CAPA users.',$selfenroll_future).'<br />');
148: } else {
149: my ($enrolltypes,$longtypes,$alldoms);
150: if ($knownuser) {
151: &get_selfenroll_filters($selfenroll_types,$env{'user.domain'});
152: my $domdesc = &Apache::lonnet::domain($env{'user.domain'},'description');
153: if (ref($enrolltypes) eq 'HASH') {
154: if (ref($enrolltypes->{$env{'user.domain'}}) eq 'ARRAY') {
155: if (grep(/^any$/,@{$enrolltypes->{$env{'user.domain'}}})) {
156: $r->print(&mt('Self-enrollment will become available starting [_1], and will be available to all LON-CAPA users at your institution ([_2]).',
157: $selfenroll_future,$domdesc).'<br />');
158:
159: } else {
160: if (&user_can_selfenroll($env{'user.domain'},
161: $env{'user.name'},
162: $enrolltypes->{$env{'user.domain'}})) {
163: $r->print(&mt('Self-enrollment will become available starting [_1]; please enroll at that time.',$selfenroll_future));
164: } else {
165: $r->print(&mt('Although self-enrollment will become available starting [_1], you are ineligible for enrollment.',$selfenroll_future).'<br />');
166: $r->print(&print_selfenroll_types($longtypes,$env{'user.domain'}));
167: }
168: }
169: }
170: }
171: } else {
172: $r->print(&mt('Self-enrollment will become available starting [_1].',
173: $selfenroll_future).'<br />');
174: $r->print(&print_selfenroll_types($longtypes));
175: }
176: }
177: }
178: }
179: }
180: if ($knownuser) {
181: foreach my $key (keys(%env)) {
182: if ($key =~ m-^user\.role\.st\./$cdom/$cnum/?(\w*)$-) {
183: my $sec = $1;
184: my ($start,$end) = split(/\./,$env{$key});
185: my $status = 'active';
186: if (($end) && ($end<=$now)) {
187: $status = 'previous';
188: }
189: if (($start) && ($now<$start)) {
190: $status = 'future';
191: }
192: if ($status eq 'active' || $status eq 'future') {
193: $curr_role{'status'} = $status;
194: $curr_role{'section'} = $sec;
195: if ($curr_role{'section'} eq '') {
196: $curr_role{'section'} = &mt('none');
197: }
198: $curr_role{'start'} = &Apache::lonlocal::locallocaltime($start);
199: $curr_role{'role'} = 'st./'.$cdom.'/'.$cnum;
200: if ($sec ne '') {
201: $curr_role{'role'} .= '/'.$sec;
202: }
203: }
204: }
205: }
206: }
207: if (!$canenroll) {
208: if (keys(%curr_role)) {
209: $r->print(&has_role(%curr_role));
210: }
211: &page_footer($r);
212: return OK;
213: }
214: @cancreate = &can_create($cdom);
215: my ($form,$login_path,$firsturl,$create_path,$sso_url,$missing_formitem);
216: $form = 'logmein';
217: $login_path = '/adm/login';
218: $firsturl= '/adm/selfenroll?courseid='.$courseid;
219: $create_path = '/adm/createaccount';
220: $sso_url = $r->dir_config('lonSSOReloginServer');
221: if ($sso_url eq '') {
222: $sso_url = $login_path;
223: }
224: $missing_formitem = &mt('The link to the requested page could not be followed.')."\n".&mt('The placeholder for the courseID is absent.');
225: &js_escape(\$missing_formitem);
226: if ($knownuser) {
227: if (keys(%curr_role)) {
228: $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.
229: '<span class="LC_warning">'.&has_role(%curr_role).'</span>');
230: &page_footer($r);
231: return OK;
232: }
233: &process_self_enroll($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,
234: $selfenroll_access_start,$selfenroll_access_end,
235: $selfenroll_section,$now,$selfenroll_approval,
236: $selfenroll_notifylist,$owner,$crstype,$lonhost,$handle);
237: } elsif ($env{'form.phase'} eq 'login') {
238: my $submit_text = &mt('Log in');
239: $r->print('<h3>'.&mt('Log-in to LON-CAPA').'</h3>');
240: my $udom = &Apache::lonnet::default_login_domain();
241: $r->print(&Apache::createaccount::login_box($now,$lonhost,$courseid,
242: $submit_text,$udom,'selfenroll'));
243: $r->print(&mt('You will be able to self-enroll in the course you selected ([_1]) after you have successfully logged in.','<b>'.$desc.'</b>'));
244: &page_footer($r);
245: return OK;
246: } elsif (@cancreate > 0) {
247: $r->print(<<END);
248: <script type="text/javascript">
249: function setPath(formname,formaction,item,arg) {
250: var formidx = getFormByName(formname);
251: if (formidx > -1) {
252: if (formaction != '') {
253: document.forms[formidx].action = formaction;
254: }
255: var itemid = getIndexByName(formidx,'setting');
256: if (itemid > -1) {
257: document.forms[formidx].elements[itemid].name = item;
258: document.forms[formidx].elements[itemid].value = arg;
259: document.forms[formidx].submit();
260: } else {
261: alert("$missing_formitem");
262: }
263: }
264: return;
265: }
266:
267: </script>
268: END
269: $r->print('<h3>'.&mt('LON-CAPA account required').'</h3>'.
270: &mt('You need to be logged into LON-CAPA to self-enroll in a course.').'<ul><li>'.&mt('If you have an account in LON-CAPA, [_1]log-in[_2].','<a href="javascript:setPath('."'$form','','phase','login'".')">','</a>').'</li>');
271: if (@cancreate > 1) {
272: $r->print('<li>'.&mt('Otherwise:').'<br />');
273: my $count = 0;
274: foreach my $type ('sso','login','email') {
275: if (($count > 0) && ($count <@cancreate)) {
276: $r->print(' , '.&mt('or').'<br />');
277: }
278: if (grep(/^$type$/,@cancreate)) {
279: if ($type eq 'sso') {
280: $r->print(' '.&mt("if you have an institutional log-in, use your institution's [_1]single sign on page[_2] to log-in, then create an account",'<a href="javascript:setPath('."'$form','$sso_url','firsturl','$firsturl'".')">','</a>'));
281: } elsif ($type eq 'login') {
282: $r->print(' '.&mt('if you have an institutional login, [_1]create an account[_2]','<a href="javascript:setPath('."'$form','$create_path','context','selfenroll_create'".')">','</a>'));
283: } elsif ($type eq 'email') {
284: $r->print(' '.&mt('you can use an e-mail address to [_1]create an account[_2]','<a href="javascript:setPath('."'$form','$create_path','context','selfenroll_create'".')">','</a>'));
285: }
286: $count ++;
287: }
288: }
289: $r->print('.<br />');
290: } else {
291: if ($cancreate[0] eq 'login') {
292: $r->print('<li>'.&mt('Otherwise, if you have an institutional login, [_1]create an account[_2].','<a href="javascript:setPath('."'$form','$create_path','context','selfenroll_create'".')">','</a>'));
293: } elsif ($cancreate[0] eq 'email') {
294: $r->print('<li>'.&mt('Otherwise, you will use an e-mail address to [_1]create an account[_2].','<a href="javascript:setPath('."'$form','$create_path','context','selfenroll_create'".')">','</a>'));
295: } elsif ($cancreate[0] eq 'sso') {
296: $r->print('<li>'.&mt("Otherwise, use your institution's [_1]single sign on page[_2] to log-in, then create an account.",'<a href="javascript:setPath('."'$form','$sso_url','firsturl','$firsturl'".')">','</a>'));
297: }
298: }
299: if ($selfenroll_types eq '*') {
300: $r->print('<br />'.&mt('You will be able to self enroll in this course once the account has been created.').'</li></ul>');
301: } else {
302: $r->print('</li></ul>');
303: my ($enrolltypes,$longtypes,$alldoms) =
304: &get_selfenroll_filters($selfenroll_types);
305: $r->print(&print_selfenroll_types($longtypes));
306: }
307: } else {
308: my $cdomdesc = &Apache::lonnet::domain($cdom,'description');
309: $r->print('<h3>'.&mt('LON-CAPA account required').'</h3>');
310: $r->print(&mt('You must [_1]log-in[_2] to LON-CAPA with an existing account to be able to enroll in this course, as account creation at this institution ([_3]) is not permitted when self-enrolling.','<a href="'.$login_path.'">','</a>',$cdomdesc));
311: if ($selfenroll_types ne '*') {
312: my ($enrolltypes,$longtypes,$alldoms) =
313: &get_selfenroll_filters($selfenroll_types);
314: $r->print('<br />'.&print_selfenroll_types($longtypes));
315: }
316: my $displayurl = &escape($firsturl);
317: $r->print(&mt('Submit a request to the LON-CAPA [_1]helpdesk[_2] for [_3] if you require assistance.','<a href="/adm/helpdesk?origurl='.$displayurl.'">','</a>',$cdomdesc));
318: }
319: $r->print("\n".'<form name="'.$form.'" method="post" action="">'."\n".
320: '<input type="hidden" name="courseid" value="'.$courseid.'" />'."\n".
321: '<input type="hidden" name="setting" value=""/>'."\n".
322: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid','context','phase'])."\n".
323: '</form>'."\n");
324: &page_footer($r);
325: return OK;
326: }
327:
328: sub enrollment_limit_check {
329: my ($selfenroll_limit,$selfenroll_cap,$cdom,$cnum) = @_;
330: my $nospace = 0;
331: my (%idx,%stucount);
332: my $classlist = &Apache::loncoursedata::get_classlist($cdom,$cnum);
333: $idx{'type'} = &Apache::loncoursedata::CL_TYPE();
334: $idx{'status'} = &Apache::loncoursedata::CL_STATUS();
335: while (my ($student,$data) = each(%$classlist)) {
336: if (($data->[$idx{'status'}] eq 'Active') ||
337: ($data->[$idx{'status'}] eq 'Future')) {
338: if ($data->[$idx{'type'}] eq 'selfenroll') {
339: $stucount{'selfenroll'} ++;
340: }
341: $stucount{'allstudents'} ++;
342: }
343: }
344: if ($stucount{$selfenroll_limit} >= $selfenroll_cap) {
345: $nospace = 1;
346: }
347: return $nospace;
348: }
349:
350: sub page_header {
351: my ($r,$courseid,$js,$desc) = @_;
352: my $start_page =
353: &Apache::loncommon::start_page('Self-enroll in a LON-CAPA course',$js,
354: {'no_inline_link' => 1,});
355: $r->print($start_page);
356: &Apache::lonhtmlcommon::clear_breadcrumbs();
357: &Apache::createaccount::selfenroll_crumbs($r,$courseid,$desc);
358: $r->print(&Apache::lonhtmlcommon::breadcrumbs('Self-enroll in course'));
359: return;
360: }
361:
362: sub page_footer {
363: my ($r) = @_;
364: $r->print('<form name="backupcrumbs" method="post" action="/adm/coursecatalog">'."\n".
365: &Apache::lonhtmlcommon::echo_form_input(['backto','courseid','phase','context']).
366: '</form>'.&Apache::loncommon::end_page());
367: return;
368: }
369:
370: sub user_is_known {
371: my $known = 0;
372: if ($env{'user.name'} ne '' && $env{'user.name'} ne 'public'
373: && $env{'user.domain'} ne '' && $env{'user.domain'} ne 'public') {
374: $known = 1;
375: }
376: return $known;
377: }
378:
379: sub can_create {
380: my ($cdom) = @_;
381: my @cancreate;
382: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$cdom);
383: if (ref($domconfig{'usercreation'}) eq 'HASH') {
384: if (ref($domconfig{'usercreation'}{'cancreate'}) eq 'HASH') {
385: if ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne 'none') {
386: if (ref($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}) eq 'ARRAY') {
387: @cancreate = @{$domconfig{'usercreation'}{'cancreate'}{'selfcreate'}};
388: } else {
389: if (($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne 'none') &&
390: ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne '')) {
391: @cancreate = ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'});
392: }
393: }
394: }
395: }
396: }
397: return @cancreate;
398: }
399:
400: sub has_role {
401: my (%curr_role) = @_;
402: my $output;
403: if ($curr_role{'status'} eq 'active') {
404: my $rolelink = &jump_to_role($curr_role{'role'});
405: $output = &mt('You already have an active student role (section: "[_1]") in this course.',$curr_role{'section'}).'<br />'.$rolelink;
406: } elsif ($curr_role{'status'} eq 'future') {
407: $output = &mt('You have a student role (section: "[_1]") in this course which will become active [_2].',$curr_role{'section'},$curr_role{'start'});
408: }
409: return $output;
410: }
411:
412: sub process_self_enroll {
413: my ($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,
414: $selfenroll_access_start,$selfenroll_access_end,$selfenroll_section,
415: $now,$selfenroll_approval,$selfenroll_notifylist,$owner,$crstype,$lonhost,$handle) = @_;
416: my $udom = $env{'user.domain'};
417: my $uname = $env{'user.name'};
418: my $selfenroll = 0;
419: my ($enrolltypes,$longtypes,$alldoms);
420: if ($selfenroll_types eq '*') {
421: $selfenroll = 1;
422: } else {
423: ($enrolltypes,$longtypes,$alldoms) =
424: &get_selfenroll_filters($selfenroll_types,$udom);
425: if ($alldoms) {
426: $selfenroll = 1;
427: } elsif (ref($enrolltypes) eq 'HASH') {
428: if (ref($enrolltypes->{$udom}) eq 'ARRAY') {
429: if (grep(/^any$/,@{$enrolltypes->{$udom}})) {
430: $selfenroll = 1;
431: } else {
432: $selfenroll = &user_can_selfenroll($udom,$uname,$enrolltypes->{$udom});
433: }
434: }
435: }
436: }
437: if ($selfenroll) {
438: my $usec = $selfenroll_section;
439: if ($selfenroll_section eq 'none') {
440: $usec = '';
441: }
442: my $instcid;
443: if ($selfenroll_registered) {
444: my ($registered,$instsec,$instcid,$message) = &check_registered($cdom,$cnum);
445: $usec = $instsec;
446: if (!$registered) {
447: $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.
448: &mt('Self-enrollment is restricted to students officially registered for this course.').'<br />');
449: if ($message) {
450: $r->print($message);
451: } else {
452: $r->print(&mt('As you are not currently registered for this course, self-enrollment is unavailable.'));
453: }
454: return;
455: }
456: }
457: if ($selfenroll_approval) {
458: my $outcome =
459: &store_selfenroll_request($udom,$uname,$usec,$cdom,$cnum,
460: $selfenroll_notifylist,$owner,
461: $selfenroll_approval,$crstype,$lonhost,$handle);
462: $r->print($outcome);
463: } else {
464: my $enrollresult =
465: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,
466: undef,undef,$usec,$selfenroll_access_end,$selfenroll_access_start,
467: 'selfenroll',undef,$cdom.'_'.$cnum,$selfenroll,'selfenroll','',$instcid);
468: if ($enrollresult eq 'ok') {
469: my (%userroles,%newrole,%newgroups);
470: my $role = 'st';
471: my $area = '/'.$cdom.'/'.$cnum;
472: my $spec = $role.'.'.$area;
473: if ($usec ne '') {
474: $spec .= '/'.$usec;
475: $area .= '/'.$usec;
476: }
477: &Apache::lonnet::standard_roleprivs(\%newrole,$role,$cdom,$spec,$cnum,
478: $area);
479: &Apache::lonnet::set_userprivs(\%userroles,\%newrole,\%newgroups);
480: $userroles{'user.role.'.$spec} = $selfenroll_access_start.'.'.$selfenroll_access_end;
481: &Apache::lonnet::appenv(\%userroles,[$role,'cm']);
482: $r->print('<h3>'.&mt('Enrollment process complete').'</h3>');
483: if ($selfenroll_access_end && $selfenroll_access_end <= $now) {
484: $r->print(&mt('The end date for access to this course for users who self-enroll has passed.').'<br />'.&mt('Consequently, although a new role was created for you in the course, it is an inactive role which does not provide access to the course.'));
485: } else {
486: $r->print(&mt('Self-enrollment in this course was successful.').'<br />');
487: my $showstart = &Apache::lonlocal::locallocaltime($selfenroll_access_start);
488: my $showend = &Apache::lonlocal::locallocaltime($selfenroll_access_end);
489: if ($selfenroll_access_start && $selfenroll_access_start >$now) {
490: $r->print(&mt('The start date for access to this course for users who self-enroll has yet to be reached.').'<br />'.&mt('Consequently, although a new role was created for you in the course, you will not be able to select this role until [_1].',$showstart));
491: } else {
492: my $newrole = 'st./'.$cdom.'/'.$cnum;
493: if ($usec ne '') {
494: $newrole .= '/'.$usec;
495: }
496: my $rolelink = &jump_to_role($newrole);
497: $r->print(&mt('Your new role is available immediately, and will provide access to the course until [_1].',$showend).'<br /><br />'."\n".
498: $rolelink);
499: }
500: }
501: } else {
502: $r->print('<h3>'.&mt('Enrollment incomplete').'</h3>'.
503: &mt('Self-enrollment in this course failed.'));
504: if ($enrollresult ne '') {
505: $r->print('<span class="LC_error">'.$enrollresult.'</span>');
506: }
507: }
508: }
509: } else {
510: $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.
511: &mt('You are not permitted to enroll yourself in this course.').'<br />');
512: $r->print(&print_selfenroll_types($longtypes));
513: }
514: return;
515: }
516:
517: sub user_can_selfenroll {
518: my ($udom,$uname,$domenrolltypes) = @_;
519: my $selfenroll = 0;
520: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'inststatus');
521: my @inststatuses;
522: if ($userhash{'inststatus'} eq '') {
523: push(@inststatuses,'other');
524: } else {
525: @inststatuses = split(':',$userhash{'inststatus'});
526: }
527: foreach my $type (@inststatuses) {
528: if (ref($domenrolltypes) eq 'ARRAY') {
529: if (grep(/^\Q$type\E$/,@{$domenrolltypes})) {
530: $selfenroll = 1;
531: last;
532: }
533: }
534: }
535: return $selfenroll;
536: }
537:
538: sub store_selfenroll_request {
539: my ($udom,$uname,$usec,$cdom,$cnum,$selfenroll_notifylist,$owner,
540: $selfenroll_approval,$crstype,$lonhost,$handle) = @_;
541: my $namespace = 'selfenrollrequests';
542: my $output;
543: my $now = time;
544: my %existing =
545: &Apache::lonnet::get($namespace,[$uname.':'.$udom],$cdom,$cnum);
546: if ($existing{$uname.':'.$udom}) {
547: my $status;
548: $output = &mt('A self-enrollment request already exists for you for this course.').'<br />';
549: my %info = &Apache::lonnet::get($namespace,[$cdom.'_'.$cnum],$udom,$uname);
550: if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
551: $status = $info{$cdom.'_'.$cnum}{'status'};
552: }
553: if ($status eq 'pending') {
554: my $token = $info{$cdom.'_'.$cnum}{'token'};
555: my ($statusupdate,$pendingform) = &pending_selfenrollment_form($cdom,$cnum,$crstype,$token,$lonhost);
556: if ($statusupdate eq 'pending') {
557: $output .= $pendingform;
558: }
559: } else {
560: $output .= &mt('Your earlier request is in a queue awaiting action by a Course Coordinator.').
561: '<br /><br />'.&Apache::loncoursequeueadmin::queued_selfenrollment();
562: }
563: } else {
564: my %selfenroll = (
565: $uname.':'.$udom => $now.':'.$usec,
566: );
567: my $putresult = &Apache::lonnet::put($namespace,\%selfenroll,$cdom,$cnum);
568: my $status = 'request';
569: if ($selfenroll_approval eq '2') {
570: $status = 'pending';
571: }
572: if ($putresult eq 'ok') {
573: my %userenroll = (
574: $cdom.'_'.$cnum => {
575: timestamp => $now,
576: section => $usec,
577: status => $status,
578: });
579: my $token;
580: if ($status eq 'pending') {
581: $token = &Apache::lonnet::tmpput(\%selfenroll,$lonhost);
582: $userenroll{$cdom.'_'.$cnum}{'token'} = $token;
583: $userenroll{$cdom.'_'.$cnum}{'lonhost'} = $lonhost;
584: $userenroll{$cdom.'_'.$cnum}{'handle'} = $handle;
585: }
586: my $warning;
587: my $userresult = &Apache::lonnet::put($namespace,\%userenroll,$udom,$uname);
588: if ($userresult ne 'ok') {
589: $warning = &mt('An error occurred saving a personal record of your request.');
590: }
591: $output = &mt('Your request for self-enrollment has been recorded.').'<br />';
592: if ($status eq 'pending') {
593: my ($statusupdate,$pendingform) = &pending_selfenrollment_form($cdom,$cnum,$crstype,$token,$lonhost);
594: if ($statusupdate eq 'request') {
595: $status = $statusupdate;
596: } else {
597: $output .= $pendingform;
598: }
599: }
600: if ($status eq 'request') {
601: $output .= &mt('A message will be sent to your LON-CAPA account when the course coordinator takes action on your request.').'<br />'.
602: &mt('To access your LON-CAPA message, go to the Main Menu and click on "Send and Receive Messages".').'<br />';
603: my %emails = &Apache::loncommon::getemails($uname,$udom);
604: if (($emails{'permanentemail'} ne '') || ($emails{'notification'} ne '')) {
605: my $address = $emails{'permanentemail'};
606: if ($address eq '') {
607: $address = $emails{'notification'};
608: }
609: $output.= &mt('An e-mail will also be sent to: [_1] when this occurs.',$address).'<br />';
610: }
611: if ($warning) {
612: $output .= '<span class="LC_warning">'.$warning.'</span><br />';
613: }
614: $output .= &Apache::loncoursequeueadmin::queued_selfenrollment();
615:
616: if ($selfenroll_notifylist) {
617: my $fullname = &Apache::loncommon::plainname($uname,$udom);
618: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
619: my $coursedesc = $courseinfo{'description'};
620: &Apache::loncoursequeueadmin::send_selfserve_notification(
621: $selfenroll_notifylist,$fullname,$cdom.'_'.$cnum,
622: $coursedesc,$now,'selfenrollreq',$owner);
623: }
624: }
625: } else {
626: $output = '<span class="LC_error">'.&mt('An error occurred when recording your request.').'</span>';
627:
628: }
629: }
630: return $output;
631: }
632:
633: sub pending_selfenrollment_form {
634: my ($cdom,$cnum,$crstype,$token,$lonhost) = @_;
635: my ($status,$output);
636: my $coursetype = &Apache::lonuserutils::get_extended_type($cdom,$cnum,$crstype);
637: my %postvalues = (
638: 'username' => $env{'user.name'},
639: 'domain' => $env{'user.domain'},
640: 'course' => $cdom.'_'.$cnum,
641: 'coursetype' => $coursetype,
642: );
643: my %domconfig = &Apache::lonnet::get_dom('configuration',['selfenrollment'],$cdom);
644:
645: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
646: my ($url,$buttontext,$code,@fields);
647: if (ref($domconfig{'selfenrollment'}{'validation'}) eq 'HASH') {
648: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'_'.$cnum,{ 'one_time' => 1});
649: $postvalues{'uniquecode'} = $courseinfo{'internal.uniquecode'};
650: $postvalues{'description'} = $courseinfo{'description'};
651: $url = $domconfig{'selfenrollment'}{'validation'}{'url'};
652: if (ref($domconfig{'selfenrollment'}{'validation'}{'fields'}) eq 'ARRAY') {
653: @fields = @{$domconfig{'selfenrollment'}{'validation'}{'fields'}};
654: }
655: $buttontext = $domconfig{'selfenrollment'}{'validation'}{'button'};
656:
657: $output .= $domconfig{'selfenrollment'}{'validation'}{'markup'};
658: if (($url =~ m{^(https?\://|/)}) && (@fields > 0)) {
659: $output .= '<form name="selfenrollvalidation" action="'.$url.'" method="post">'."\n";
660: foreach my $field (@fields) {
661: if ($postvalues{$field}) {
662: $output .= '<input type="hidden" name="'.$field.'" value="'.$postvalues{$field}.'" />'."\n";
663: }
664: }
665: if ($buttontext eq '') {
666: $buttontext = &mt('Complete my enrollment');
667: }
668: my $protocol = $Apache::lonnet::protocol{$lonhost};
669: $protocol = 'http' if ($protocol ne 'https');
670: my $enroller = $protocol.'://'.&Apache::lonnet::hostname($lonhost).'/cgi-bin/enrollqueued.pl';
671: $output .= '<input type="hidden" name="enroller" value="'.$enroller.'" />'."\n".
672: '<input type="hidden" name="token" value="'.$token.'" />'."\n".
673: '<input type="submit" name="validate" value="'.$buttontext.'" />'."\n".
674: '</form>'."\n";
675: $status = 'pending';
676: } else {
677: $status = 'request';
678: }
679: }
680: } else {
681: $status = 'request';
682: }
683: return ($status,$output);
684: }
685:
686: sub jump_to_role {
687: my ($role) = @_;
688: my $output = <<"END";
689: <script type="text/javascript">
690: function SelectRole() {
691: document.rolechoice.selectrole.value = '1';
692: document.rolechoice.submit();
693: }
694: </script>
695: END
696: $output .= '<a href="javascript:SelectRole()">'."\n".
697: &mt('Enter course now').'</a>'."\n".
698: '<form name="rolechoice" action="/adm/roles" method="post">'."\n".
699: '<input type="hidden" name="selectrole" value="" />'."\n".
700: '<input type="hidden" name="'.$role.'" value="1" />'."\n".
701: '</form>';
702: return $output;
703: }
704:
705: sub get_selfenroll_filters {
706: my ($selfenroll_types,$domain) = @_;
707: my (%enrolltypes,%longtypes,$alldoms);
708: my @selfenrolldoms = split(/;/,$selfenroll_types);
709: foreach my $item (@selfenrolldoms) {
710: my ($selfdom,$type_str) = split(/:/,$item);
711: if ($selfdom eq '*') {
712: $alldoms = 1;
713: last;
714: }
715: if ($domain ne '') {
716: next if ($selfdom ne $domain);
717: }
718: if ($selfdom =~ /^$match_domain$/) {
719: if (&Apache::lonnet::domain($selfdom) ne '') {
720: my @types = split(/,/,$type_str);
721: my @unesc_types = map { &unescape($_); } @types;
722: my ($othertitle,$usertypes,$types) =
723: &Apache::loncommon::sorted_inst_types($selfdom);
724: if (ref($usertypes) eq 'HASH') {
725: my $anytype = 1;
726: foreach my $key (keys(%{$usertypes})) {
727: if (!grep(/^\Q$key\E$/,@unesc_types)) {
728: $anytype = 0;
729: last;
730: }
731: }
732: if ($anytype) {
733: if (!(grep(/^other$/,@types))) {
734: $anytype = 0;
735: }
736: }
737: $usertypes->{'any'} = &mt('Any users');
738: $usertypes->{'other'} = &mt('Others');
739: my @showtypes;
740: if ($anytype) {
741: @{$enrolltypes{$selfdom}} = ('any');
742: @showtypes = ('any');
743: } else {
744: @{$enrolltypes{$selfdom}} = @types;
745: @showtypes = @unesc_types;
746: }
747: @{$longtypes{$selfdom}} =
748: map {$usertypes->{$_}} @showtypes;
749: }
750: }
751: }
752: }
753: return (\%enrolltypes,\%longtypes,$alldoms);
754: }
755:
756: sub print_selfenroll_types {
757: my ($longtypes,$domain) = @_;
758: my $output;
759: if (ref($longtypes) eq 'HASH') {
760: if ($domain ne '') {
761: my $domdesc = &Apache::lonnet::domain($domain,'description');
762: if (ref($longtypes->{$domain}) eq 'ARRAY') {
763: if (grep(/^any$/,@{$longtypes->{$domain}})) {
764: $output = &mt('Self-enrollment in this course is available to any user affiliated with [_1].',$domdesc);
765: } else {
766: my $status_str = join(', ',@{$longtypes->{$domain}});
767: $output = &mt('Self-enrollment in this course is only available to users affiliated with [_1] who have the following status: "[_2]".',$domdesc,$status_str);
768: }
769: } else {
770: $output = &mt('Self-enrollment is not currently available for this course for users affiliated with [_1].',$domdesc);
771: }
772: } elsif (keys(%{$longtypes}) > 0) {
773: $output = &mt('Self-enrollment in this course is only available to users affiliated with the following institutions, and who have the required status:').' <ul>'."\n";
774: foreach my $selfdom (sort(keys(%{$longtypes}))) {
775: my $selfdomdesc = &Apache::lonnet::domain($selfdom,'description');
776: if (ref($longtypes->{$selfdom}) eq 'ARRAY') {
777: $output .= '<li>'.$selfdomdesc.': '.join(', ',@{$longtypes->{$selfdom}}).'</li>'."\n";
778: }
779: }
780: $output .= '</ul>'."\n";
781: } else {
782: $output = &mt('Self-enrollment is not currently available for this course.');
783: }
784: }
785: return $output;
786: }
787:
788: sub check_registered {
789: my ($cdom,$cnum) = @_;
790: my ($registered,$instsec,$instcid,$message);
791: my %settings = &Apache::lonnet::get('environment',['internal.coursecode',
792: 'internal.sectionnums',
793: 'internal.crosslistings'],$cdom,$cnum);
794: my (@allcourses,%LC_code,%affiliates,%reply);
795: &Apache::loncommon::get_institutional_codes(\%settings,\@allcourses,\%LC_code);
796: if (@allcourses > 0) {
797: @{$affiliates{$cnum}} = @allcourses;
798: my $outcome = &Apache::lonnet::fetch_enrollment_query('updatenow',\%affiliates,\%reply,$cdom,$cnum);
799: if ($outcome eq 'ok') {
800: if ($reply{$cnum} > 0) {
801: foreach my $class (@allcourses) {
802: my %enrolled;
803: my $dir = $Apache::lonnet::perlvar{'lonDaemons'};
804: my %place = &LONCAPA::Enrollment::place_hash();
805: &LONCAPA::Enrollment::parse_classlist($dir,$cdom,$cnum,$class,
806: \%place,$LC_code{$class},\%enrolled);
807: if (defined($enrolled{$env{'user.name'}})) {
808: $registered = 1;
809: $instsec = $LC_code{$class};
810: $instcid = $class;
811: last;
812: }
813: }
814: } else {
815: $message = &mt('Your registration status could not be verified.');
816: }
817: } else {
818: $message = &mt('Your registration status could not determined, because a problem occurred retrieving data.');
819: }
820: } else {
821: $message = &mt('As no institutional course sections are currently associated with this course, your registration status is undetermined.');
822: }
823: return ($registered,$instsec,$instcid,$message);
824: }
825:
826: 1;
827:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to selfenroll.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface