Return to lonevaluate.pm CVS log

Up to [LON-CAPA] / loncom / interface

Help students to easily find out which fields are required and which not.
- Add marker to all required fields and display info text to explain.
- Improve/consistent layout of feedback if not correctly filled in.

    1: # The LearningOnline Network
    2: # Evaluate
    3: #
    4: # $Id: lonevaluate.pm,v 1.30 2014/01/17 17:10:12 bisitz 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: 
   30: 
   31: package Apache::lonevaluate;
   32: 
   33: use strict;
   34: use Apache::lonnet;
   35: use Apache::Constants qw(:common);
   36: use Apache::loncommon();
   37: use Apache::lonenc();
   38: use Apache::lonlocal;
   39: use LONCAPA();
   40: 
   41: sub handler {
   42:     my $r = shift;
   43:     &Apache::loncommon::content_type($r,'text/html');
   44:     &Apache::loncommon::no_cache($r);
   45:     
   46:     $r->send_http_header;
   47:     return OK if $r->header_only;
   48: 
   49:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['postdata']);
   50:     my $feedurl=$env{'form.postdata'};
   51:     $feedurl=~s/^https?\:\/\///;
   52:     $feedurl=~s/^$ENV{'SERVER_NAME'}//;
   53:     $feedurl=~s/^$ENV{'HTTP_HOST'}//;
   54: 
   55:     $feedurl=&Apache::lonnet::declutter($feedurl);
   56: 
   57:     my $title=&Apache::lonnet::gettitle($feedurl);
   58:     my $showurl=&Apache::lonenc::check_encrypt($feedurl);
   59: 
   60:     my ($rdomain,$rauth)=($feedurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\//);
   61: 
   62:     my $prefix=$env{'user.name'}.'@'.$env{'user.domain'}.'___'.
   63: 	$feedurl.'___';
   64: 
   65:     my @items=('correct','helpful','depth','clear','technical','comments',
   66:                'timestamp');
   67: 
   68:     my @retrieve=map{ $prefix.$_ } @items;
   69: 
   70:     my %currenteval=
   71:        &Apache::lonnet::get('nohist_resevaldata',\@retrieve,$rdomain,$rauth);
   72: 
   73:     my $already=($currenteval{$prefix.'timestamp'} ne '');
   74: 
   75:     $env{'form.timestamp'}=time;
   76: 
   77:     my $warning='';
   78: 
   79:     if ($env{'form.submiteval'} eq 'true') {
   80: # ------------------------------------------------ User is submitting something
   81:         my $complete=1;
   82: 	foreach my $item (@items) {
   83: 	    if ($env{'form.'.$item}) {
   84: 		$currenteval{$prefix.$item}=$env{'form.'.$item};
   85:             } elsif ($item ne 'comments') {
   86:                 $complete=0;
   87:             }
   88:         }
   89:         if ($complete) {
   90: 	    my $showurl=&Apache::lonenc::check_encrypt(&Apache::lonnet::clutter($feedurl));
   91:             my $js = &Apache::lonhtmlcommon::scripttag(<<ENDJS);
   92:     function goback() {
   93:         if ((window.name=='loncapaclient')) {
   94:             window.location='$showurl';
   95:         } else {
   96:             self.close();
   97:         }
   98:     }
   99: ENDJS
  100: 
  101:             # Breadcrumbs
  102:             my $brcrum = [{'href' => '/adm/evaluate',
  103:                            'text' => 'Evaluate Resource'},
  104:                           {'href' => '',
  105:                            'text' => 'Done'}];
  106: 
  107:             my $start_page = &Apache::loncommon::start_page('Evaluate Resource',
  108:                                                             $js,
  109:                                                             {'bread_crumbs' => $brcrum,});
  110: 
  111:             $r->print($start_page
  112:                      .'<p class="LC_success">'
  113:                      .&mt('Saving feedback: [_1]'
  114:                           ,&Apache::lonnet::put(
  115:                                'nohist_resevaldata',\%currenteval,$rdomain,$rauth))
  116:                      .'</p>'
  117:             );
  118:            unless ($already) {
  119:                $r->print('<p>'.&mt('Logging first evaluation').'</p>');
  120:            }
  121:            $r->print('<p><b>'.&mt('Thank you for your input!').'</b></p>'
  122:                     .&Apache::lonhtmlcommon::scripttag(
  123:                         'setTimeout("goback()",2000);')
  124:                     .&Apache::loncommon::end_page()
  125:            );
  126:            return OK;
  127:         } else {
  128:             $warning=&mt('Please fill out all required fields below!');
  129:         }
  130:    
  131:     }
  132: 
  133: # ---------------------------------------------------------- Dial in old values
  134:     my $dialold='';
  135:     my $oldcomments='';
  136: 
  137:     foreach my $item (@items) {
  138:        unless ($item eq 'comments') {
  139:            unless (($item eq 'timestamp') || 
  140:                    (!defined($currenteval{$prefix.$item}))) {
  141:               $dialold.=
  142:                    'document.evaluation.'.$item.'.selectedIndex='.
  143:                    $currenteval{$prefix.$item}.";\n";
  144: 	   }
  145:        } else {
  146:            $oldcomments=$currenteval{$prefix.$item};
  147:        }       
  148:     }
  149: # ------------------------------------------------------- Print out eval screen
  150:     my %lt=&Apache::lonlocal::texthash('a' => 'Strongly Disagree',
  151: 				       'b' => 'Disagree',
  152: 				       'c' => 'Neutral',
  153: 				       'd' => 'Agree',
  154: 				       'e' => 'Strongly Agree',);
  155:     my $standardoptions='';
  156:     $standardoptions = (<<ENDOPTIONS);
  157: <option value="0">-</option>
  158: <option value="1">$lt{'a'}</option>
  159: <option value="2">$lt{'b'}</option>
  160: <option value="3">$lt{'c'}</option>
  161: <option value="4">$lt{'d'}</option>
  162: <option value="5">$lt{'e'}</option>
  163: ENDOPTIONS
  164: 
  165:     # Breadcrumbs
  166:     my $brcrum = [{'href' => '/adm/evaluate',
  167:                    'text' => 'Evaluate Resource'}];
  168: 
  169:     my $start_page = &Apache::loncommon::start_page('Evaluate Resource',
  170:                                                     undef,
  171:                                                     {'bread_crumbs' => $brcrum,});
  172:     my $end_page   = &Apache::loncommon::end_page();
  173: 
  174:     %lt=&Apache::lonlocal::texthash(
  175:        'pleaserank' => 'Please rank the following criteria:',
  176:        'required'   => '(All fields marked with * are required.)',
  177:        'correct'    => 'The material appears to be correct',
  178:        'helpful'    => 'The material is helpful',
  179:        'depth'      => 'The material is covered with sufficient depth',
  180:        'clear'      => 'The material is presented in a clear way',
  181:        'technical'  => 'The resource is technically correct (loads fast enough, does not produce errors, links work, etc)',
  182:        'comments'   => 'Comments',
  183:        'submit'     => 'Submit Evaluation',
  184:     );
  185:     $r->print(
  186:         $start_page
  187:        .'<h2>'.$title.'</h2>');
  188: 
  189:     if ($warning) {
  190:         $r->print(
  191:             &Apache::loncommon::confirmwrapper(
  192:                 &Apache::lonhtmlcommon::confirm_success(
  193:             $warning,1)));
  194:     }
  195:     $r->print(
  196:         '<form method="post" name="evaluation" action="/adm/evaluate">'
  197:        .'<input type="hidden" name="submiteval" value="true" />'
  198:        .'<input type="hidden" name="postdata" value="'.$showurl.'" />'
  199:     );
  200:     $r->print(
  201:         &Apache::lonhtmlcommon::start_pick_box()
  202:        .&Apache::lonhtmlcommon::row_headline()
  203:        .$lt{'pleaserank'}.'<br />'
  204:        .'<span class="LC_info">'.$lt{'required'}.'</span>'
  205:        .&Apache::lonhtmlcommon::row_closure()
  206:     );
  207: 
  208:     foreach my $key ('correct', 'helpful', 'depth', 'clear', 'technical') {
  209:         $r->print(
  210:             &Apache::lonhtmlcommon::row_title(
  211:                 '<span title="'.&mt('required').'">'.$lt{$key}
  212:                .' <span class="LC_info">*</span></span>')
  213:            .'<select name="'.$key.'">'
  214:            .$standardoptions
  215:            .'</select>'
  216:            .&Apache::lonhtmlcommon::row_closure()
  217:         );
  218:     }
  219: 
  220:     $r->print(
  221:         &Apache::lonhtmlcommon::row_title($lt{'comments'})
  222:        .'<textarea name="comments" cols="40" rows="5">'
  223:        .$oldcomments
  224:        .'</textarea>'
  225:        .&Apache::lonhtmlcommon::row_closure(1)
  226:        .&Apache::lonhtmlcommon::end_pick_box()
  227:        .'<p>'
  228:        .'<input type="submit" value="'.$lt{'submit'}.'" />'
  229:        .'</p>'
  230:     );
  231: 
  232:     $r->print(
  233:         &Apache::lonhtmlcommon::scripttag($dialold)
  234:        .'</form>'
  235:        .$end_page
  236:     );
  237: 
  238:     return OK;
  239: } 
  240: 
  241: 1;
  242: __END__
  243: 
  244: =pod
  245: 
  246: =head1 NAME
  247: 
  248: Apache::lonevaluate.pm
  249: 
  250: =head1 SYNOPSIS
  251: 
  252: Handles evaluation.
  253: 
  254: This is part of the LearningOnline Network with CAPA project
  255: described at http://www.lon-capa.org.
  256: 
  257: =head1 OVERVIEW
  258: 
  259: None
  260: 
  261: =cut