File:  [LON-CAPA] / loncom / interface / lonfeedback.pm
Revision 1.19: download - view: text, annotated - select for diffs
Wed Dec 19 17:17:46 2001 UTC (22 years, 5 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- Finished GPLing the code

    1: # The LearningOnline Network
    2: # Feedback
    3: #
    4: # $Id: lonfeedback.pm,v 1.19 2001/12/19 17:17:46 albertel 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: # (Internal Server Error Handler
   29: #
   30: # (Login Screen
   31: # 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14,
   32: # 1/14/00,5/29,5/30,6/1,6/29,7/1,11/9 Gerd Kortemeyer)
   33: #
   34: # 3/1/1 Gerd Kortemeyer)
   35: #
   36: # 3/1,2/3,2/5,2/6,2/8 Gerd Kortemeyer
   37: # 2/9 Guy Albertelli
   38: # 2/10 Gerd Kortemeyer
   39: # 2/13 Guy Albertelli
   40: # 7/25 Gerd Kortemeyer
   41: # 7/26 Guy Albertelli
   42: # 7/26,8/10,10/1,11/5,11/6 Gerd Kortemeyer
   43: 
   44: 
   45: package Apache::lonfeedback;
   46: 
   47: use strict;
   48: use Apache::Constants qw(:common);
   49: use Apache::lonmsg();
   50: use Apache::loncommon();
   51: 
   52: sub mail_screen {
   53:   my ($r,$feedurl,$options) = @_;
   54:   $r->print(<<ENDDOCUMENT);
   55: <html>
   56: <head>
   57: <title>The LearningOnline Network with CAPA</title>
   58: <meta http-equiv="pragma" content="no-cache"></meta>
   59: <script>
   60:     function gosubmit() {
   61:         var rec=0;
   62:         if (typeof(document.mailform.elements.author)!="undefined") {
   63:           if (document.mailform.elements.author.checked) {
   64:              rec=1;
   65:           } 
   66:         }
   67:         if (typeof(document.mailform.elements.question)!="undefined") {
   68:           if (document.mailform.elements.question.checked) {
   69:              rec=1;
   70:           } 
   71:         }
   72:         if (typeof(document.mailform.elements.course)!="undefined") {
   73:           if (document.mailform.elements.course.checked) {
   74:              rec=1;
   75:           } 
   76:         }
   77:         if (typeof(document.mailform.elements.policy)!="undefined") {
   78:           if (document.mailform.elements.policy.checked) {
   79:              rec=1;
   80:           } 
   81:         }
   82:         if (typeof(document.mailform.elements.discuss)!="undefined") {
   83:           if (document.mailform.elements.discuss.checked) {
   84:              rec=1;
   85:           } 
   86:         }
   87:         if (typeof(document.mailform.elements.anondiscuss)!="undefined") {
   88:           if (document.mailform.elements.anondiscuss.checked) {
   89:              rec=1;
   90:           } 
   91:         }
   92: 
   93:         if (rec) {
   94: 	    document.mailform.submit();
   95:         } else {
   96:             alert('Please check a feedback type.');
   97: 	}
   98:     }
   99: </script>
  100: </head>
  101: <body bgcolor="#FFFFFF" onLoad="window.focus();">
  102: <img align=right src=/adm/lonIcons/lonlogos.gif>
  103: <h1>Feedback</h1>
  104: <h2><tt>$feedurl</tt></h2>
  105: <form action="/adm/feedback" method=post name=mailform>
  106: <input type=hidden name=postdata value="$feedurl">
  107: Please check at least one of the following feedback types:
  108: $options<hr>
  109: My question/comment/feedback:<p>
  110: <textarea name=comment cols=60 rows=10 wrap=hard>
  111: </textarea><p>
  112: <input type=hidden name=sendit value=1>
  113: <input type=button value="Send Feedback" onClick='gosubmit();'></input>
  114: </form>
  115: </body>
  116: </html>
  117: ENDDOCUMENT
  118: }
  119: 
  120: sub fail_redirect {
  121:   my ($r,$feedurl) = @_;
  122:   $r->print (<<ENDFAILREDIR);
  123: <head><title>Feedback not sent</title>
  124: <meta http-equiv="pragma" content="no-cache"></meta>
  125: <meta HTTP-EQUIV="Refresh" CONTENT="2; url=$feedurl">
  126: </head>
  127: <html>
  128: <body bgcolor="#FFFFFF">
  129: <img align=right src=/adm/lonIcons/lonlogos.gif>
  130: <b>Sorry, no recipients  ...</b>
  131: </body>
  132: </html>
  133: ENDFAILREDIR
  134: }
  135: 
  136: sub redirect_back {
  137:   my ($r,$feedurl,$typestyle,$sendsomething,$status) = @_;
  138:   $r->print (<<ENDREDIR);
  139: <head>
  140: <title>Feedback sent</title>
  141: <meta http-equiv="pragma" content="no-cache"></meta>
  142: <meta HTTP-EQUIV="Refresh" CONTENT="2; url=$feedurl">
  143: </head>
  144: <html>
  145: <body bgcolor="#FFFFFF">
  146: <img align=right src=/adm/lonIcons/lonlogos.gif>
  147: $typestyle
  148: <b>Sent $sendsomething message(s).</b>
  149: <font color=red>$status</font>
  150: </body>
  151: </html>
  152: ENDREDIR
  153: }
  154: 
  155: sub no_redirect_back {
  156:   my ($r,$feedurl) = @_;
  157:   $r->print (<<ENDNOREDIR);
  158: <head><title>Feedback not sent</title>
  159: <meta http-equiv="pragma" content="no-cache"></meta>
  160: ENDNOREDIR
  161: 
  162:   if ($feedurl!~/^\/adm\/feedback/) { 
  163:     $r->print('<meta HTTP-EQUIV="Refresh" CONTENT="2; url='.$feedurl.'">');
  164:   }
  165:   
  166:   $r->print (<<ENDNOREDIRTWO);
  167: </head>
  168: <html>
  169: <body bgcolor="#FFFFFF">
  170: <img align=right src=/adm/lonIcons/lonlogos.gif>
  171: <b>Sorry, no feedback possible on this resource  ...</b>
  172: </body>
  173: </html>
  174: ENDNOREDIRTWO
  175: }
  176: 
  177: sub screen_header {
  178:   my ($feedurl) = @_;
  179:   my $options='';
  180:   if (($feedurl=~/^\/res/) && ($feedurl!~/^\/res\/adm/)) {
  181:     $options= 
  182:       '<p><input type=checkbox name=author> Feedback to resource author';
  183:   }
  184:   if ($ENV{'course.'.$ENV{'request.course.id'}.'.question.email'}) {
  185:     $options.=
  186:     '<br><input type=checkbox name=question> Question about resource content';
  187:   }
  188:   if ($ENV{'course.'.$ENV{'request.course.id'}.'.comment.email'}) {
  189:     $options.=
  190:       '<br><input type=checkbox name=course> '.
  191: 	'Question/Comment/Feedback about course content';
  192:   }
  193:   if ($ENV{'course.'.$ENV{'request.course.id'}.'.policy.email'}) {
  194:     $options.=
  195:       '<br><input type=checkbox name=policy> '.
  196: 	'Question/Comment/Feedback about course policy';
  197:   }
  198:   if ($ENV{'request.course.id'}) {
  199:     $options.='<br><input type=checkbox name=discuss> '.
  200: 	'<b>Contribution to course discussion of resource</b>';
  201:   }
  202:   if ($ENV{'request.course.id'}) {
  203:     $options.='<br><input type=checkbox name=anondiscuss> '.
  204: 	'<b>Anonymous contribution to course discussion of resource</b>'.
  205:         ' (name only visible to course faculty)';
  206:   }
  207:   return $options;
  208: }
  209: 
  210: sub resource_output {
  211:   my ($feedurl) = @_;
  212:   my $usersaw=&Apache::lonnet::ssi($feedurl);
  213:   $usersaw=~s/\<body[^\>]*\>//gi;
  214:   $usersaw=~s/\<\/body\>//gi;
  215:   $usersaw=~s/\<html\>//gi;
  216:   $usersaw=~s/\<\/html\>//gi;
  217:   $usersaw=~s/\<head\>//gi;
  218:   $usersaw=~s/\<\/head\>//gi;
  219:   $usersaw=~s/action\s*\=/would_be_action\=/gi;
  220:   return $usersaw;
  221: }
  222: 
  223: sub clear_out_html {
  224:   my $message=$ENV{'form.comment'};
  225:   $message=~s/\</\&lt\;/g;
  226:   $message=~s/\>/\&gt\;/g;
  227:   return $message;
  228: }
  229: 
  230: sub assemble_email {
  231:   my ($feedurl,$message,$prevattempts,$usersaw)=@_;
  232:   my $email=<<"ENDEMAIL";
  233: Refers to <a href="$feedurl">$feedurl</a>
  234: 
  235: $message
  236: ENDEMAIL
  237:     my $citations=<<"ENDCITE";
  238: <h2>Previous attempts of student (if applicable)</h2>
  239: $prevattempts
  240: <p><hr>
  241: <h2>Original screen output (if applicable)</h2>
  242: $usersaw
  243: ENDCITE
  244:   return ($email,$citations);
  245: }
  246: 
  247: sub decide_receiver {
  248:   my ($feedurl) = @_;
  249:   my $typestyle='';
  250:   my %to=();
  251:   if ($ENV{'form.author'}) {
  252:     $typestyle.='Submitting as Author Feedback<br>';
  253:     $feedurl=~/^\/res\/(\w+)\/(\w+)\//;
  254:     $to{$2.':'.$1}=1;
  255:   }
  256:   if ($ENV{'form.question'}) {
  257:     $typestyle.='Submitting as Question<br>';
  258:     map {
  259:       $to{$_}=1;
  260:     } split(/\,/,
  261: 	    $ENV{'course.'.$ENV{'request.course.id'}.'.question.email'});
  262:   }
  263:   if ($ENV{'form.course'}) {
  264:     $typestyle.='Submitting as Comment<br>';
  265:     map {
  266:       $to{$_}=1;
  267:     } split(/\,/,
  268: 	    $ENV{'course.'.$ENV{'request.course.id'}.'.comment.email'});
  269:   }
  270:   if ($ENV{'form.policy'}) {
  271:     $typestyle.='Submitting as Policy Feedback<br>';
  272:     map {
  273:       $to{$_}=1;
  274:     } split(/\,/,
  275: 	    $ENV{'course.'.$ENV{'request.course.id'}.'.policy.email'});
  276:   }
  277:   return ($typestyle,%to);
  278: }
  279: 
  280: sub send_msg {
  281:   my ($feedurl,$email,$citations,%to)=@_;
  282:   my $status='';
  283:   my $sendsomething=0;
  284:   map {
  285:     if ($_) {
  286:       unless (&Apache::lonmsg::user_normal_msg(split(/\:/,$_),
  287:                'Feedback '.$feedurl,$email,$citations) eq 'ok') {
  288: 	$status.='<br>Error sending message to '.$_.'<br>';
  289:       } else {
  290: 	$sendsomething++;
  291:       }
  292:     }
  293:   } keys %to;
  294: 
  295:     my %record=&Apache::lonnet::restore('_feedback');
  296:     my ($temp)=keys %record;
  297:     unless ($temp=~/^error\:/) {
  298:        my %newrecord=();
  299:        $newrecord{'resource'}=$feedurl;
  300:        $newrecord{'subnumber'}=$record{'subnumber'}+1;
  301:        unless (&Apache::lonnet::cstore(\%newrecord,'_feedback') eq 'ok') {
  302: 	   $status.='<br>Not registered<br>';
  303:        }
  304:     }
  305:        
  306:   return ($status,$sendsomething);
  307: }
  308: 
  309: sub adddiscuss {
  310:     my ($symb,$email,$anon)=@_;
  311:     my $status='';
  312:     my %contrib=('message'      => $email,
  313:                  'sendername'   => $ENV{'user.name'},
  314:                  'senderdomain' => $ENV{'user.domain'});
  315:     if ($anon) {
  316: 	$contrib{'anonymous'}='true';
  317:     }
  318:     if (($symb) && ($email)) {
  319:        $status='Adding to class discussion'.($anon?' (anonymous)':'').': '.
  320:         &Apache::lonnet::store(\%contrib,$symb,$ENV{'request.course.id'},
  321:                      $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
  322: 		     $ENV{'course.'.$ENV{'request.course.id'}.'.num'});
  323:     }
  324:     my %record=&Apache::lonnet::restore('_discussion');
  325:     my ($temp)=keys %record;
  326:     unless ($temp=~/^error\:/) {
  327:        my %newrecord=();
  328:        $newrecord{'resource'}=$symb;
  329:        $newrecord{'subnumber'}=$record{'subnumber'}+1;
  330:        $status.=' '.&Apache::lonnet::cstore(\%newrecord,'_discussion');
  331:     }
  332:     return $status.'<br>';   
  333: }
  334: 
  335: sub handler {
  336:   my $r = shift;
  337:   if ($r->header_only) {
  338:      $r->content_type('text/html');
  339:      $r->send_http_header;
  340:      return OK;
  341:   }
  342: 
  343: # --------------------------- Get query string for limited number of parameters
  344: 
  345:     map {
  346:        my ($name, $value) = split(/=/,$_);
  347:        $value =~ tr/+/ /;
  348:        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
  349:        if (($name eq 'hide') || ($name eq 'unhide')) {
  350:            unless ($ENV{'form.'.$name}) {
  351:               $ENV{'form.'.$name}=$value;
  352: 	   }
  353:        }
  354:     } (split(/&/,$ENV{'QUERY_STRING'}));
  355: 
  356:   if (($ENV{'form.hide'}) || ($ENV{'form.unhide'})) {
  357: # ----------------------------------------------------------------- Hide/unhide
  358:     $r->content_type('text/html');
  359:     $r->send_http_header;
  360: 
  361:     my $entry=$ENV{'form.hide'}?$ENV{'form.hide'}:$ENV{'form.unhide'};
  362: 
  363:     my ($symb,$idx)=split(/\:\:\:/,$entry);
  364:     my ($map,$ind,$url)=split(/\_\_\_/,$symb);
  365: 
  366:     my %contrib=&Apache::lonnet::restore($symb,$ENV{'request.course.id'},
  367:                      $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
  368: 		     $ENV{'course.'.$ENV{'request.course.id'}.'.num'});
  369: 
  370:         
  371:     my $currenthidden=$contrib{'hidden'};
  372:     
  373:     if ($ENV{'form.hide'}) {
  374: 	$currenthidden.='.'.$idx.'.';
  375:     } else {
  376:         $currenthidden=~s/\.$idx\.//g;
  377:     }
  378:     my %newhash=('hidden' => $currenthidden);
  379: 
  380:     &Apache::lonnet::store(\%newhash,$symb,$ENV{'request.course.id'},
  381:                      $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
  382: 		     $ENV{'course.'.$ENV{'request.course.id'}.'.num'});
  383: 
  384:     &redirect_back($r,'/res/'.$url,'Changed discussion status<p>','0');
  385: 
  386:       
  387:   } else {
  388: # ------------------------------------------------------------- Normal feedback
  389:   my $feedurl=$ENV{'form.postdata'};
  390:   $feedurl=~s/^http\:\/\///;
  391:   $feedurl=~s/^$ENV{'SERVER_NAME'}//;
  392:   $feedurl=~s/^$ENV{'HTTP_HOST'}//;
  393: 
  394:   my $symb=&Apache::lonnet::symbread($feedurl);
  395:   my $goahead=1;
  396:   if ($feedurl=~/\.(problem|exam|quiz|assess|survey|form)$/) {
  397:       unless ($symb) { $goahead=0; }
  398:   }
  399: 
  400:   if ($goahead) {
  401: # Go ahead with feedback, no ambiguous reference
  402:     $r->content_type('text/html');
  403:     $r->send_http_header;
  404:   
  405:     if (
  406:       (
  407:        ($feedurl=~m:^/res:) && ($feedurl!~m:^/res/adm:)
  408:       ) 
  409:       || 
  410:       ($ENV{'request.course.id'} && ($feedurl!~m:^/adm:))
  411:      ) {
  412: # --------------------------------------------------- Print login screen header
  413:     unless ($ENV{'form.sendit'}) {
  414:       my $options=&screen_header($feedurl);
  415:       if ($options) {
  416: 	&mail_screen($r,$feedurl,$options);
  417:       } else {
  418: 	&fail_redirect($r,$feedurl);
  419:       }
  420:     } else {
  421:       
  422: # Get previous user input
  423:       my $prevattempts=&Apache::loncommon::get_previous_attempt(
  424:             $symb,$ENV{'user.name'},$ENV{'user.domain'},
  425:             $ENV{'request.course.id'});
  426: 
  427: # Get output from resource
  428:       my $usersaw=&resource_output($feedurl);
  429: 
  430: # Filter HTML out of message (could be nasty)
  431:       my $message=&clear_out_html;
  432: 
  433: # Assemble email
  434:       my ($email,$citations)=&assemble_email($feedurl,$message,$prevattempts,
  435:           $usersaw);
  436: 
  437: # Who gets this?
  438:       my ($typestyle,%to) = &decide_receiver($feedurl);
  439: 
  440: # Actually send mail
  441:       my ($status,$numsent)=&send_msg($feedurl,$email,$citations,%to);
  442: 
  443: # Discussion? Store that.
  444: 
  445:       if ($ENV{'form.discuss'}) {
  446: 	  $typestyle.=&adddiscuss($symb,$message);
  447:       }
  448: 
  449:       if ($ENV{'form.anondiscuss'}) {
  450: 	  $typestyle.=&adddiscuss($symb,$message,1);
  451:       }
  452: 
  453: 
  454: # Receipt screen and redirect back to where came from
  455:       &redirect_back($r,$feedurl,$typestyle,$numsent,$status);
  456: 
  457:     }
  458:    } else {
  459: # Unable to give feedback
  460:     &no_redirect_back($r,$feedurl);
  461:    }
  462:   } else {
  463: # Ambiguous Problem Resource
  464:     $r->internal_redirect('/adm/ambiguous');
  465:   }
  466: }
  467:   return OK;
  468: } 
  469: 
  470: 1;
  471: __END__
  472: 
  473: 
  474: 
  475: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>