# # $Id: lonsupportreq.pm,v 1.45 2007/12/04 04:43:21 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ # package Apache::lonsupportreq; use strict; use MIME::Types; use MIME::Lite; use CGI::Cookie(); use Apache::Constants qw(:common); use Apache::loncommon(); use Apache::lonhtmlcommon; use Apache::lonnet; use Apache::lonlocal; use Apache::lonacc(); use Apache::courseclassifier; use LONCAPA; sub handler { my ($r) = @_; &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; if ($r->header_only) { return OK; } if ($r->uri eq '/adm/helpdesk') { &Apache::lonlocal::get_language_handle($r); } &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['origurl','function']); if ($r->uri eq '/adm/helpdesk') { &Apache::lonacc::get_posted_cgi($r); } my $function = $env{'form.function'}; my $origurl = &unescape($env{'form.origurl'}); my $command = $env{'form.command'}; if ($command eq 'process') { &print_request_receipt($r,$origurl,$function); } else { &print_request_form($r,$origurl,$function); } return OK; } sub print_request_form { my ($r,$origurl,$function) = @_; my ($os,$browser,$bversion,$uhost,$uname,$udom,$uhome,$urole,$usec,$email,$cid,$cdom,$cnum,$ctitle,$ccode,$sectionlist,$lastname,$firstname,$server,$formname); $function = &Apache::loncommon::get_users_function() if (!$function); $ccode = ''; $os = $env{'browser.os'}; $browser = $env{'browser.type'}; $bversion = $env{'browser.version'}; $uhost = $env{'request.host'}; $uname = $env{'user.name'}; $udom = $env{'user.domain'}; $uhome = $env{'user.home'}; $urole = $env{'request.role'}; $usec = $env{'request.course.sec'}; $cid = $env{'request.course.id'}; $formname = 'logproblem'; my $machine = &Apache::lonnet::absolute_url(); if ($origurl =~ m-^https?://-) { $server = $origurl; } else { $server = $machine.$origurl; } my $showserver = $server; $showserver =~ s/\?.*$//; my %lt = &Apache::lonlocal::texthash ( email => 'The e-mail address you entered', notv => 'is not a valid e-mail address', rsub => 'You must include a subject', rdes => 'You must include a description', name => 'Name', subm => 'Submit Request', emad => 'E-mail address', unme => 'username', doma => 'domain', entu => 'Enter the username you use to log-in to LON-CAPA', chdo => 'Choose your LON-CAPA domain', entr => 'Enter the username you use to log-in to LON-CAPA, and your domain.', urlp => 'URL of page', phon => 'Phone', crsd => 'Course Details', enin => 'Enter institutional course code', pick => 'Pick', enct => 'Enter course title', secn => 'Section Number', sele => 'Select', titl => 'Title', lsec => 'LON-CAPA sec', subj => 'Subject', detd => 'Detailed Description', opfi => 'Optional file upload', uplf => 'Upload a file (e.g., a screenshot) relevant to your help request (128 KB max.)', fini => 'Finish', clfm => 'Clear Form', ); my $scripttag = (<<"END"); function validate() { if (validmail(document.logproblem.email) == false) { alert("$lt{'email'}: "+document.logproblem.email.value+" $lt{'notv'}."); return; } if (document.logproblem.subject.value == '') { alert("$lt{'rsub'}."); return; } if (document.logproblem.description.value == '') { alert("$lt{'rdes'}."); return; } document.logproblem.submit(); } END $scripttag .= &Apache::lonhtmlcommon::javascript_valid_email(); if ($cid) { $cdom = $env{'course.'.$cid.'.domain'}; $cnum = $env{'course.'.$cid.'.num'}; } if ($cdom && $cnum) { my %csettings = &Apache::lonnet::get('environment',['description','internal.coursecode','internal.sectionnums'],$cdom,$cnum); $ctitle = $csettings{'description'}; $ccode = $csettings{'internal.coursecode'}; $sectionlist = $csettings{'internal.sectionnums'}; } if ($env{'environment.permanentemail'}) { $email = $env{'environment.permanentemail'}; } elsif ($env{'environment.critnotification'}) { $email = $env{'environment.critnotification'}; } elsif ($env{'environment.notification'}) { $email = $env{'environment.notification'}; } if ($env{'environment.lastname'}) { $lastname = $env{'environment.lastname'}; } if ($env{'environment.firstname'}) { $firstname = $env{'environment.firstname'}; } my @sections = split(/,/,$sectionlist); my %groupid; foreach my $section (@sections) { my ($sec,$grp) = split(/:/,$section); $groupid{$sec} = $grp; } &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['codedom']); my $codedom = &get_domain(); my $details_title; if ($codedom) { $details_title = '
('.$codedom.')'; } my %coursecodes; my %codes; my @codetitles; my %cat_titles; my %cat_order; my %idlist; my %idnums; my %idlist_titles; my $caller = 'global'; my $totcodes = 0; my $format_reply; my $jscript = ''; my $loaditems = qq| function initialize_codes() { return; } |; if ($cnum) { $coursecodes{$cnum} = $ccode; if ($ccode eq '') { $totcodes = &Apache::courseclassifier::retrieve_instcodes(\%coursecodes,$codedom,$totcodes); } else { $coursecodes{$cnum} = $ccode; $caller = $cnum; $totcodes ++; } } else { $totcodes = &Apache::courseclassifier::retrieve_instcodes(\%coursecodes,$codedom,$totcodes); } if ($totcodes > 0) { if ($ccode eq '') { $format_reply = &Apache::lonnet::auto_instcode_format($caller,$codedom,\%coursecodes,\%codes,\@codetitles,\%cat_titles,\%cat_order); if ($format_reply eq 'ok') { my $numtypes = @codetitles; &Apache::courseclassifier::build_code_selections(\%codes,\@codetitles,\%cat_titles,\%cat_order,\%idlist,\%idnums,\%idlist_titles); my ($scripttext,$longtitles) = &Apache::courseclassifier::javascript_definitions(\@codetitles,\%idlist,\%idlist_titles,\%idnums,\%cat_titles); my $longtitles_str = join('","',@{$longtitles}); my $allidlist = $idlist{$codetitles[0]}; $jscript .= &Apache::courseclassifier::courseset_js_start($formname,$longtitles_str,$allidlist); $jscript .= $scripttext; $jscript .= &Apache::courseclassifier::javascript_code_selections($formname,@codetitles); $loaditems = ''; } } } my $js = ''; my %add_entries = (topmargin => "0", marginheight => "0", onLoad =>"initialize_codes()",); $r->print(&Apache::loncommon::start_page('Support Request',$js, { 'function' => $function, 'add_entries' => \%add_entries, 'only_body' => 1,})); if ($r->uri eq '/adm/helpdesk') { &print_header($r,$origurl); } $r->print('
'."\n"); my $output = &Apache::lonhtmlcommon::start_pick_box(). &Apache::lonhtmlcommon::row_title($lt{'name'},undef,'LC_oddrow_value')."\n"; my $fullname = ''; if ((defined($lastname) && $lastname ne '') && (defined($firstname) && $firstname ne '')) { $fullname = "$firstname $lastname"; $output .= $fullname.'&').'" />'; } else { if (defined($firstname) && $firstname ne '') { $fullname = $firstname; } elsif (defined($lastname) && $lastname ne '') { $fullname = " $lastname"; } $output .= '&').'" />'; } $output .= '      '. &Apache::lonhtmlcommon::row_closure()."\n". &Apache::lonhtmlcommon::row_title($lt{'emad'},undef,'LC_evenrow_value'). '&').'" />
'."\n". &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title("$lt{'unme'}/$lt{'doma'}",undef,'LC_oddrow_value'); my $udom_input = '&').'" />'; my $uname_input = '&').'" />'; if (defined($uname) && defined($udom)) { $output .= ''.$lt{'unme'}.': '.$uname.'  '.$lt{'doma'}.': '.$udom.$udom_input.$uname_input; } else { my $udomform = ''; my $unameform = ''; if (defined($udom)) { $output .= $lt{'entu'}; } elsif (defined($uname)) { $output .= $lt{'chdo'}; } else { $output .= $lt{'entr'}; } $output .= '
'; if (defined($udom)) { $udomform = ''.$lt{'doma'}.': '.$udom.$udom_input; } elsif (defined($uname)) { $unameform = ''.$lt{'unme'}.': '.$uname.'  '.$uname_input; } if ($udomform eq '') { $udomform = ''.$lt{'doma'}.': '; $udomform .= &Apache::loncommon::select_dom_form($codedom,'udom'); } if ($unameform eq '') { $unameform= ''.$lt{'unme'}.'  '; } $output .= $unameform.$udomform; } $output .= &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title("$lt{'urlp'}",undef,'LC_evenrow_value'). $showserver.'&').'" />'. &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title("$lt{'phon'}",undef,'LC_oddrow_value'). '
'. &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title("$lt{'crsd'}$details_title",undef,'LC_evenrow_value'); if ($cnum) { if ($coursecodes{$cnum}) { foreach my $item (@codetitles) { $output .= ''.$item.': '.$codes{$cnum}{$item}.'; '; } $output .= ' &').'" />'; } else { $output .= $lt{'enin'}.':  '; } } else { if ($totcodes > 0) { my $numtitles = @codetitles; if ($numtitles == 0) { $output .= $lt{'enin'}.':  '; } else { my $lasttitle = $numtitles; if ($numtitles > 4) { $lasttitle = 4; } $output .= ''; for (my $i=1; $i<$numtitles; $i++) { $output .= ''."\n"; } $output .= '
'.$codetitles[0].'
'."\n". '
'.$codetitles[$i].'
'."\n". ''."\n". '
'; if ($numtitles > 4) { $output .= '

'.$codetitles[$numtitles].'
'."\n". ''."\n"; } } } else { $output .= $lt{'enin'}.':  '; } } if ($ctitle) { $output .= '
'.$lt{'titl'}.': '.$ctitle. '&').'" />'."\n"; } else { $output .= '
'.$lt{'enct'}.':  '."\n"; } $output .= &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title($lt{'secn'},undef,'LC_oddrow_value'); if ($sectionlist) { $output .= ""; } else { $output .= ''; } $output .= &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title($lt{'subj'},undef,'LC_evenrow_value'). ' '."\n". &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title($lt{'detd'},undef,'LC_oddrow_value'). ' '. &Apache::lonhtmlcommon::row_closure(); my $lastrow = 'LC_evenrow_value'; if (defined($env{'user.name'})) { $output .= &Apache::lonhtmlcommon::row_title($lt{'opfi'},undef,'LC_evenrow_value'). '
'.$lt{'uplf'}."\n". &Apache::lonhtmlcommon::row_closure(); $lastrow = 'LC_oddrow_value'; } $output .= &Apache::lonhtmlcommon::row_title($lt{'fini'},undef,$lastrow); $output .= <     END $output .= &Apache::lonhtmlcommon::row_closure(1); $output .= &Apache::lonhtmlcommon::end_pick_box(); $r->print(<
END $r->print(&Apache::loncommon::end_page()); return; } sub print_request_receipt { my ($r,$url,$function) = @_; my @ENVvars = ('HTTP_HOST','HTTP_USER_AGENT','REMOTE_ADDR','SERVER_ADDR','SERVER_NAME'); my @envvars = ('browser.os','browser.type','browser.version','user.home','request.role'); my @loncvars = ('user.name','user.domain','request.course.sec','request.course.id'); my @cookievars = ('lonID'); my $admin = $Apache::lonnet::perlvar{'lonAdminMail'}; my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; my $defdom = &get_domain(); my $to = &Apache::loncommon::build_recipient_list(undef,'helpdeskmail', $defdom,$origmail); my $from = $admin; my $reporttime = &Apache::lonlocal::locallocaltime(time); my @formvars = ('username','email','uname','udom','sourceurl','phone','section','coursecode','title','subject','description','screenshot'); &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},\@formvars); my $coursecode = $env{'form.coursecode'}; if ($coursecode eq '') { if (defined($env{'form.Year'})) { $coursecode .= $env{'form.Year'}; } if (defined($env{'form.Semester'})) { $coursecode .= $env{'form.Semester'}; } if (defined($env{'form.Department'})) { $coursecode .= $env{'form.Department'}; } if (defined($env{'form.Number'})) { $coursecode .= $env{'form.Number'}; } } my %lt = &Apache::lonlocal::texthash ( username => 'Name', email => 'Email', user => 'Username/domain', phone => 'Phone', crsi => 'Course Information', subject => 'Subject', description => 'Description', sourceurl => 'URL', date => 'Date/Time', secn => 'Section', asup => 'A support request has been sent to', warn => 'Warning: Problem with support e-mail address', your => 'Your support request contained the following information', sect => 'section', info => 'Information supplied', adin => 'Additional information recorded', ); $env{'form.user'} = "'".$env{'form.uname'}.':'.$env{'form.udom'}."'"; $env{'form.csri'} = $env{'form.title'}.' - '.$coursecode.' - '.$lt{'sect'}.': '.$env{'form.section'}; my $supportmsg = <|g; $displaymsg .= ''. "$lt{$item}: $descrip
\n"; } elsif ($item eq 'sourceurl') { my $showurl = $env{'form.sourceurl'}; $showurl =~ s/\?.*$//; $displaymsg .= ''. "$lt{$item}: $showurl
\n"; } else { $displaymsg .= ''. "$lt{$item}: $env{'form.'.$item}
\n"; } } } $displaymsg .= ''. $lt{'date'}.': '.$reporttime.'
'."\n"; my $start_page = &Apache::loncommon::start_page('Support request recorded',undef, {'function' => $function, 'add_entries' => { topmargin => "0", marginheight => "0", }, 'only_body' => 1,}); $r->print(<<"END"); $start_page END if ($r->uri eq '/adm/helpdesk') { &print_header($r,$url,'process'); } my $bad_email = 0; if ($to =~ /,/) { my @ok_email; foreach my $email (split(/,/,$to)) { if ($email =~ m/^[^\@]+\@[^\@]+$/) { push(@ok_email,$email); } } if (@ok_email > 0) { $to = join(',',@ok_email); } elsif ($admin =~ m/^[^\@]+\@[^\@]+$/) { $to = $admin; } else { $bad_email = 1; } } elsif ($to !~ m/^[^\@]+\@[^\@]+$/) { if ($admin =~ m/^[^\@]+\@[^\@]+$/) { $to = $admin; } else { $bad_email = 1; } } if ($bad_email) { $r->print('

'.$lt{'warn'}.'

'. &mt('As the e-mail address provided for this LON-CAPA server ([_1]) does not appear to be a valid e-mail address, your support request has not been sent to the LON-CAPA support staff or administrator at your institution.',$to).' '.&mt('Instead a copy has been sent to the LON-CAPA support team at Michigan State University.')); $to = 'helpdesk@lon-capa.org'; } else { $r->print('

'.$lt{'asup'}.' '.$to.'

'); } if (defined($env{'form.email'})) { if ($env{'form.email'} =~ m/^[^\@]+\@[^\@]+$/) { $from = $env{'form.email'}; } } my $subject = $env{'form.subject'}; $subject =~ s/(`)/'/g; $subject =~ s/\$/\(\$\)/g; $supportmsg =~ s/(`)/'/g; $supportmsg =~ s/\$/\(\$\)/g; $displaymsg =~ s/(`)/'/g; $displaymsg =~ s/\$/\(\$\)/g; my $fname; my $attachmentpath = ''; my $attachmentsize = ''; if (defined($env{'user.name'})) { if ($env{'form.screenshot.filename'}) { $attachmentsize = length($env{'form.screenshot'}); if ($attachmentsize > 131072) { $displaymsg .= '
'.&mt('The uploaded screenshot file ([_1] bytes) included with your request exceeded the maximum allowed size - 128 KB, and has therefore been discarded.',$attachmentsize); } else { $attachmentpath=&Apache::lonnet::userfileupload('screenshot',undef,'helprequests'); } } } my %cookies; my $cookie=CGI::Cookie->parse($r->header_in('Cookie')); if ($$cookie{'lonID'} =~ /lonID=($LONCAPA::handle_re);/) { $cookies{'lonID'} = $1; } if ($attachmentpath =~ m-/([^/]+)$-) { $fname = $1; $displaymsg .= '
'.&mt('An uploaded screenshot file \'[_1]\' ([_2] bytes) was included in the request sent by [_3].',$fname,$attachmentsize,$env{'user.name'}.': '.$env{'user.domain'}); $supportmsg .= "\n"; foreach my $var (@cookievars) { $supportmsg .= "$var: $cookies{$var}\n"; } foreach my $var(@ENVvars) { $supportmsg .= "$var: $ENV{$var}\n"; } foreach my $var (@envvars) { $supportmsg .= "$var: $env{$var}\n"; } } my $msg = MIME::Lite->new( From => $from, To => $to, Subject => $subject, Type =>'TEXT', Data => $supportmsg, ); if ($attachmentpath) { my ($type, $encoding) = MIME::Types::by_suffix($attachmentpath); $msg->attach(Type => $type, Path => $attachmentpath, Filename => $fname ); } else { my $envdata = ''; foreach my $var (@cookievars) { $envdata .= "$var: $cookies{$var}\n"; } foreach my $var (@ENVvars) { $envdata .= "$var: $ENV{$var}\n"; } foreach my $var (@envvars) { $envdata .= "$var: $env{$var}\n"; } foreach my $var (@loncvars) { $envdata .= "$var: $env{$var}\n"; } $msg->attach(Type => 'TEXT', Data => $envdata); } ### Send it: $msg->send('sendmail'); if ($attachmentpath =~ m|$Apache::lonnet::perlvar{'lonDaemons'}/tmp/helprequests/(\d+)/[^/]+|) { unlink($attachmentpath); } $r->print(''.$lt{'your'}.':

'."\n"); $r->print(&Apache::lonhtmlcommon::start_pick_box('LC_helpform_receipt'). &Apache::lonhtmlcommon::row_title($lt{'info'},undef,'LC_oddrow_value')."\n".$displaymsg."\n". &Apache::lonhtmlcommon::row_closure(). &Apache::lonhtmlcommon::row_title($lt{'adin'},undef,'LC_evenrow_value')); my $envmsg; foreach my $var (@cookievars) { if ($cookies{$var} ne '') { $envmsg.= ''. $var.': '.$cookies{$var}.', '; } } foreach my $var (@ENVvars) { if ($ENV{$var} ne '') { $envmsg .= ''. $var.': '.$ENV{$var}.', '; } } foreach my $var (@envvars) { if ($env{$var} ne '') { $envmsg .= ''. $var.': '.$env{$var}.', '; } } $envmsg =~ s/, $//; $r->print($envmsg."\n". &Apache::lonhtmlcommon::row_closure(1)."\n". &Apache::lonhtmlcommon::end_pick_box()."\n". &Apache::loncommon::end_page()); } sub print_header { my ($r,$origurl,$command) = @_; my $location=&Apache::loncommon::lonhttpdurl("/adm"); my ($component_url); my $helpdesk_link = ''; if ($command eq 'process') { $helpdesk_link = ''; } my %lt = &Apache::lonlocal::texthash ( login => 'Log-in help', ask => 'Ask helpdesk', getst => 'Getting started guide', back => 'Back to last location' ); my ($getstartlink,$getstarttext); if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/gettingstarted.html') { $getstartlink = qq| $lt{'getst'}|; $getstarttext = ' '.&mt('and the "Getting started" guide').' '; } $r->print(<  
  LON-CAPA help/support $getstartlink
    END if ($command ne 'process') { $r->print(' '.&mt(' Please review the information in "Log-in help"').$getstarttext.' '.&mt('if you are unable to log-in').'. '.&mt('If your problem is still unresolved, the form below can be used to send a question to the LON-CAPA helpdesk').'.
'.&mt('Students').': '.&mt('Do not use this form to ask questions about course content.').' '.&mt('Contact your instructor instead.').'

'); } $r->print(' '); return; } sub get_domain { my $codedom; if (exists($env{'form.codedom'})) { $codedom = $env{'form.codedom'}; } elsif ($env{'request.course.id'}) { $codedom = $env{'course.'.$env{'request.course.id'}.'.domain'}; } elsif ($env{'request.role.domain'}) { $codedom = $env{'request.role.domain'}; } else { $codedom = $Apache::lonnet::perlvar{'lonDefDomain'}; } return $codedom; } 1;