Return to groupsort.pm CVS log

Up to [LON-CAPA] / loncom / interface

Changes related to modification of LON-CAPA screen header.
- Explicitly re-added h1 headline which used to be in the removed title_bar.
- "There are no resources..." message for all three kinds of routine calls.
- Moved title text generation to another place to allow access for both start_page calls.
- Added translation phrases.

    1: # The LearningOnline Network with CAPA
    2: # The LON-CAPA group sort handler
    3: # Allows for sorting prior to import into RAT.
    4: #
    5: # $Id: groupsort.pm,v 1.66 2010/05/03 13:53:47 bisitz Exp $
    6: # 
    7: # Copyright Michigan State University Board of Trustees
    8: #
    9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   10: #
   11: # LON-CAPA is free software; you can redistribute it and/or modify
   12: # it under the terms of the GNU General Public License as published by
   13: # the Free Software Foundation; either version 2 of the License, or
   14: # (at your option) any later version.
   15: #
   16: # LON-CAPA is distributed in the hope that it will be useful,
   17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   19: # GNU General Public License for more details.
   20: #
   21: # You should have received a copy of the GNU General Public License
   22: # along with LON-CAPA; if not, write to the Free Software
   23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   24: #
   25: # /home/httpd/html/adm/gpl.txt
   26: #
   27: # http://www.lon-capa.org/
   28: #
   29: ###
   30: 
   31: package Apache::groupsort;
   32: 
   33: use strict;
   34: 
   35: use Apache::Constants qw(:common);
   36: use GDBM_File;
   37: use Apache::loncommon;
   38: use Apache::lonlocal;
   39: use Apache::lonnet;
   40: use LONCAPA;
   41: 
   42: my $iconpath; # variable to be accessible to multiple subroutines
   43: my %hash; # variable to tie to user specific database
   44: 
   45: 
   46: sub update_actions_hash {
   47:     my ($hash) = @_;
   48:     # be careful in here, there is also a global %hash
   49:     my $acts=$env{'form.acts'};
   50:     my @Acts=split(/b/,$acts);
   51:     my %ahash;
   52:     my %achash;
   53:     # some initial hashes for working with data
   54:     my $ac=0;
   55:     foreach (@Acts) {
   56:  	my ($state,$ref)=split(/a/);
   57: 	$ahash{$ref}=$state;
   58: 	$achash{$ref}=$ac;
   59: 	$ac++;
   60:     }
   61:     # sorting through the actions and changing the global database hash
   62:     foreach my $key (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) {
   63: 	if ($ahash{$key} eq '1') {
   64: 	    $hash->{'store_'.$hash->{'pre_'.$key.'_link'}}=
   65: 		$hash->{'pre_'.$key.'_title'};
   66: 	    $hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}}=
   67: 		$hash->{'storectr'}+0;
   68: 	    $hash->{'storectr'}++;
   69: 	}
   70: 	if ($ahash{$key} eq '0') {
   71: 	    if ($hash->{'store_'.$hash->{'pre_'.$key.'_link'}}) {
   72: 		delete($hash->{'store_'.$hash->{'pre_'.$key.'_link'}});
   73: 		delete($hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}});
   74: 	    }
   75: 	}
   76:     }
   77:     # deleting the previously cached listing
   78:     foreach my $key (keys(%{ $hash })) {
   79: 	next if ($key !~ /^pre_(\d+)_link/);
   80: 	my $which = $1;
   81: 	delete($hash->{'pre_'.$which.'_title'});
   82: 	delete($hash->{'pre_'.$which.'_link'});
   83:     }
   84: }
   85: 
   86: sub readfromdb {
   87:     my ($r,$resources)=@_;
   88: 
   89:     my $diropendb = 
   90:        "/home/httpd/perl/tmp/$env{'user.domain'}_$env{'user.name'}_sel_res.db";
   91: 
   92: # ----------------------------- diropendb is now the filename of the db to open
   93:     if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
   94: 	&update_actions_hash(\%hash);
   95: 
   96: 	my %temp_resources;
   97: 	foreach my $key (keys(%hash)) {
   98: 	    next if ($key !~ /^store_/);
   99: 	    my ($url) = ($key =~ /^store_(.*)/);
  100: 	    $temp_resources{$hash{'storectr_'.$url}}{'url'}=$url;
  101: 	    $temp_resources{$hash{'storectr_'.$url}}{'title'}=
  102: 		&Apache::lonnet::gettitle($url);
  103: 	}
  104: 
  105: 	# use the temp, since there might be gaps in the counting
  106: 	foreach my $item (sort {$a <=> $b} (keys(%temp_resources))) {
  107: 	    push(@{ $resources },$temp_resources{$item});
  108: 	}
  109: 
  110: 	if ($env{'form.oldval'}) {
  111: 	    my $res = splice(@{$resources},$env{'form.oldval'}-1,1);
  112: 	    if ($env{'form.newval'} == 0) {
  113: 		# picked 'discard'
  114: 		my $url =  $res->{'url'};
  115: 		delete($hash{'storectr_'.$url});
  116: 		delete($hash{'store_'.$url});
  117: 	    } else {
  118: 		splice(@{$resources},$env{'form.newval'}-1,0,$res);
  119: 	    }
  120: 	}
  121: 	# store out new order
  122: 	foreach my $which (0..$#$resources) {
  123: 	    my $url =  $resources->[$which]{'url'};
  124: 	    $hash{'storectr_'.$url} = $which;
  125: 	}
  126:     } else {
  127: 	$r->print('Unable to tie hash to db file');
  128:     }
  129:     untie(%hash);
  130: }
  131: 
  132: 
  133: 
  134: sub cleanup {
  135:     if (tied(%hash)){
  136: 	&Apache::lonnet::logthis('Cleanup groupsort: hash');
  137:         unless (untie(%hash)) {
  138: 	    &Apache::lonnet::logthis('Failed cleanup groupsort: hash');
  139:         }
  140:     }
  141:     return OK;
  142: }
  143: 
  144: # -------------------------------------------------------------- Read from file
  145: 
  146: sub readfromfile {
  147:     my ($r,$resources)=@_;
  148:     my $cont=&Apache::lonnet::getfile
  149: 	(&Apache::lonnet::filelocation('',$env{'form.readfile'}));
  150:     if ($cont==-1) {
  151: 	$r->print('Unable to read file: '.
  152: 		  &Apache::lonnet::filelocation('',$env{'form.readfile'}));
  153:     } else {
  154:         my $parser = HTML::TokeParser->new(\$cont);
  155:         my $token;
  156:         while ($token = $parser->get_token) {
  157: 	    if ($token->[0] eq 'S') {
  158:                 if ($token->[1] eq 'resource') {
  159: 		    if ($env{'form.recover'}) {
  160: 			if ($token->[2]->{'type'} ne 'zombie') { next; }
  161: 		    } else {
  162: 			if ($token->[2]->{'type'} eq 'zombie') { next; }
  163: 		    }
  164: 
  165:                     my $name=$token->[2]->{'title'};
  166: 		    $name=~s/ \[\((\d+)\,($LONCAPA::username_re)\,($LONCAPA::domain_re)\)\]$//;
  167: 		    my $note;
  168: 		    if ($1) {
  169: 			$note = '<br />'.&mt('Removed by ').
  170: 			    &Apache::loncommon::plainname($2,$3).', '.
  171: 			    &Apache::lonlocal::locallocaltime($1);
  172: 		    }
  173: 		    $name=~s/\&colon\;/\:/g;
  174: 		    push(@{$resources}, {'url'   => $token->[2]->{'src'},
  175: 					 'title' => $name,
  176: 					 'note'  => $note,
  177: 				         'id'    => $token->[2]->{'id'},});
  178: 		}
  179: 	    }
  180: 	}
  181:     }
  182: }
  183: 
  184: # --------------------------------------------------------- Read from bookmarks
  185: 
  186: sub readfrombookmarks {
  187:     my ($r,$resources)=@_;
  188:     my %bookmarks=&Apache::lonnet::dump('bookmarks');
  189: # the bookmark "hash" is just one entry
  190: # it's a javascript program code with arguments like ('title','url');
  191:     my @bookmarks=($bookmarks{'bookmarks'}=~/\((?:\'([^\']+)\'\,\'([^\']+)\'|\"([^\"]+)\"\,\"([^\"]+)\")\)\;/g);
  192:     for (my $index=0;$index<($#bookmarks+1)/2;$index++) {
  193:         if ($bookmarks[$index*2+1]) {
  194: 	    my $url  = $bookmarks[$index*2+1];
  195: 	    my $name = $bookmarks[$index*2];
  196: 	    $name =~ s/^LON\-CAPA\s+//;
  197: 
  198: 	    push(@{$resources},{'url' => $url, 'title' => $name});
  199: 	}
  200:     }
  201: }
  202: 
  203: # ---------------------------------------------------------------- Main Handler
  204: sub handler {
  205:     my $r = shift;
  206:  
  207:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  208: 			     ['acts','mode','readfile','recover','bookmarks']);
  209: 
  210:     &Apache::loncommon::content_type($r,'text/html');
  211:     $r->send_http_header;
  212:     return OK if $r->header_only;
  213: 
  214: # finish_import looks different for graphical or "simple" RAT
  215:     my $finishimport='';
  216:     my $begincondition='';
  217:     my $endcondition='';
  218:     if (($env{'form.readfile'}) || ($env{'form.bookmarks'}))  {
  219:         $begincondition='if (eval("document.forms.groupsort.include"+num+".checked")) {';
  220: 	$endcondition='}';
  221:     }
  222:     if ($env{'form.mode'} eq 'simple' || $env{'form.mode'} eq '') {
  223:         $finishimport=(<<ENDSMP);
  224: function finish_import() {
  225:     opener.document.forms.simpleedit.importdetail.value='';
  226:     for (var num=0; num<document.forms.groupsort.fnum.value; num++) {
  227: 	$begincondition
  228: 	opener.document.forms.simpleedit.importdetail.value+='&'+
  229:               eval("document.forms.groupsort.title"+num+".value")+'='+
  230: 	      eval("document.forms.groupsort.filelink"+num+".value")+'='+
  231: 	      eval("document.forms.groupsort.id"+num+".value");
  232: 	$endcondition
  233:     }
  234:     opener.document.forms.simpleedit.submit();
  235:     self.close();
  236: }
  237: ENDSMP
  238:     } else {
  239:         $finishimport=(<<ENDADV);
  240: function finish_import() {
  241:     var linkflag=false;
  242:     for (var num=0; num<document.forms.groupsort.fnum.value; num++) {
  243: 	$begincondition
  244: 	insertRowInLastRow();
  245: 	placeResourceInLastRow(
  246: 	       eval("document.forms.groupsort.title"+num+".value"),
  247:  	       eval("document.forms.groupsort.filelink"+num+".value"),
  248:  	       eval("document.forms.groupsort.id"+num+".value"),
  249: 	       linkflag
  250: 	);
  251:         linkflag=true;
  252: 	$endcondition
  253:     }
  254:     opener.editmode=0;
  255:     opener.notclear=0;
  256:     opener.linkmode=0;
  257:     opener.draw();
  258:     self.close();
  259: }
  260: ENDADV
  261:     }
  262: 
  263: # output start of web page
  264:     my $js = <<END;
  265: <script type="text/javascript">
  266: function insertRowInLastRow() {
  267:     opener.insertrow(opener.maxrow);
  268:     opener.addobj(opener.maxrow,'e&2');
  269: }
  270: function placeResourceInLastRow (title,url,id,linkflag) {
  271:     opener.mostrecent=opener.newresource(opener.maxrow,2,opener.escape(title),
  272: 		       opener.escape(url),'false','normal',id);
  273:     opener.save();
  274:     if (linkflag) {
  275: 	opener.joinres(opener.linkmode,opener.mostrecent,0);
  276:     }
  277:     opener.linkmode=opener.mostrecent;
  278: }
  279: $finishimport
  280: function selectchange(val) {
  281:     var newval=0+eval("document.forms.groupsort.alt"+val+".selectedIndex");
  282:     orderchange(val,newval);
  283: }
  284: function move(val,newval) {
  285:     orderchange(val,newval);
  286: }
  287: function orderchange(val,newval) {
  288:     document.forms.groupsort.oldval.value=val;
  289:     document.forms.groupsort.newval.value=newval;
  290:     document.forms.groupsort.submit();
  291: }
  292: </script>
  293: END
  294:     # read pertinent machine configuration
  295:     my $domain  = $r->dir_config('lonDefDomain');
  296:     $iconpath = $r->dir_config('lonIconsURL') . "/";
  297: 
  298:     my @resources;
  299: 
  300:     if ($env{'form.readfile'}) {
  301: 	&readfromfile($r,\@resources);
  302:     } elsif ($env{'form.bookmarks'}) {
  303: 	&readfrombookmarks($r,\@resources);
  304:     } else {
  305: 	&readfromdb($r,\@resources);
  306:     }
  307: 
  308:     my $ctr = 0;
  309:     my $clen = scalar(@resources);
  310:     my $title = '';
  311:     if ($env{'form.recover'}) {
  312:         $title = 'Recover Removed Resources';
  313:     } else {
  314:         $title = 'Sort Imported Resources';
  315:     }
  316:     if ($env{'form.bookmarks'}) {
  317:         $title = 'Import Resources from Bookmarks';
  318:     }
  319:     if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  320: 	my %lt=&Apache::lonlocal::texthash(
  321: 		'fin'=> 'Finalize order of resources',
  322: 		'ci' => 'Continue Import',
  323: 		'cs' => 'Continue Search',
  324: 		'fi' => 'Finish Import',
  325: 		're' => 'Recover Checked',
  326: 		'ip' => 'Import Checked',
  327: 		'ca' => 'Cancel',
  328: 		'co' => 'Change Order',
  329: 		'ti' => 'Title',
  330: 		'pa' => 'Path',
  331:                 'in' => 'Include'
  332: 		);
  333: 
  334: 	$r->print(&Apache::loncommon::start_page($title, $js));
  335: 	$r->print('<h1>'.&mt($title).'</h1>');
  336: 
  337: 	$r->print(<<END);
  338: <form method='post' action='/adm/groupsort' name='groupsort'
  339:       enctype='application/x-www-form-urlencoded'>
  340: <input type="hidden" name="fnum" value="$clen" />
  341: <input type="hidden" name="oldval" value="" />
  342: <input type="hidden" name="newval" value="" />
  343: <input type="hidden" name="mode" value="$env{'form.mode'}" />
  344: <input type="hidden" name="readfile" value="$env{'form.readfile'}" />
  345: <input type="hidden" name="bookmarks" value="$env{'form.bookmarks'}" />
  346: <input type="hidden" name="recover" value="$env{'form.recover'}" />
  347: END
  348: 
  349:         $r->print(&Apache::loncommon::inhibit_menu_check('input'));
  350:         # ---
  351: 
  352:         my $buttontext = $lt{'re'};
  353:         if ($env{'form.bookmarks'}) {
  354:             $buttontext = $lt{'ip'}
  355:         }
  356:         if ($env{'form.recover'} || $env{'form.bookmarks'}) {
  357: 	    $r->print(<<END);
  358: <input type="button" name="alter" value="$buttontext"
  359:  onClick="finish_import()" />&nbsp;
  360: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
  361: END
  362: 	} else {
  363:         # --- Continue Buttons
  364: 	    my $resurl = 
  365: 		&Apache::loncommon::escape_single(&Apache::loncommon::lastresurl());
  366: 	    $r->print(<<END);
  367: <h2>$lt{'fin'}</h2>
  368: <div>
  369: <input type="button" name="alter" value="$lt{'ci'}"
  370:  onClick="window.location='$resurl?inhibitmenu=yes&amp;catalogmode=import'" />&nbsp;
  371: <input type="button" name="altersearch" value="$lt{'cs'}"
  372:  onClick="window.location='/adm/searchcat?inhibitmenu=yes&amp;catalogmode=import'" />&nbsp;
  373: <input type="button" name="alter" value="$lt{'fi'}"
  374:  onClick="finish_import()" />&nbsp;
  375: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
  376: </div>
  377: <br />
  378: END
  379:         }
  380: 
  381:         # Only display header if content exists
  382:         if ($clen > 0) {
  383:             $r->print(&Apache::loncommon::start_data_table()
  384:                      .&Apache::loncommon::start_data_table_header_row());
  385:             if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) { 
  386:                 $r->print("<th>$lt{'in'}</th>\n");
  387:             } else { 
  388:                 $r->print('<th colspan="2">'.$lt{'co'}.'</th>'."\n"); 
  389:             }
  390:             $r->print('<th colspan="2">'.$lt{'ti'}.'</th>'."\n");
  391:             $r->print("<th>$lt{'pa'}</th>");
  392:             $r->print(&Apache::loncommon::end_data_table_header_row()."\n");
  393:         } else {
  394:             my $errtxt = '';
  395:             if ($env{'form.recover'}) {
  396:                 $errtxt = 'There are no resources to recover.';
  397:             } else {
  398:                 $errtxt = 'There are no resources to import.';
  399:             }
  400:             if ($env{'form.bookmarks'}) {
  401:                 $errtxt = 'There are no resources in your bookmarks to import.';
  402:             }
  403:             $r->print('<p class="LC_info">'.&mt($errtxt).'</p>');
  404:         }
  405:     } else {
  406: 	$r->print(&Apache::loncommon::start_page(undef,$js,
  407: 						 {'only_body' => 1}));
  408: #       $r->print('<h1>'.&mt($title).'</h1>');
  409: 	$r->print(<<END);
  410: <form method='post' action='/adm/groupsort' name='groupsort'
  411:       enctype='application/x-www-form-urlencoded'>
  412: <input type="hidden" name="fnum" value="$clen" />
  413: <input type="hidden" name="oldval" value="" />
  414: <input type="hidden" name="newval" value="" />
  415: <input type="hidden" name="mode" value="$env{'form.mode'}" />
  416: END
  417:         $r->print(&Apache::loncommon::inhibit_menu_check('input'));
  418: 
  419:     }
  420:     foreach my $resource (@resources) {
  421: 	$ctr++;
  422: 	my $iconname=&Apache::loncommon::icon($resource->{'url'});
  423: 	if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  424: 	    $r->print(&Apache::loncommon::start_data_table_row()
  425:                      ."<td>");
  426:             if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  427: 		$r->print(&checkbox($ctr-1));
  428: 	    } else {
  429: 		$r->print(&movers($clen,$ctr));
  430: 	    }
  431: 	}
  432: 	$r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'},
  433: 			  $resource->{'id'}));
  434: 	if (($clen > 1)  || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  435: 	    $r->print("</td>");
  436:             unless (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  437: 		$r->print("<td>".
  438: 			  &select_box($clen,$ctr).
  439: 			  "</td>");
  440: 	    }
  441: 	    $r->print("<td>");
  442: 	    $r->print("<img src='$iconname' />");
  443: 	    $r->print("</td><td>");
  444: 	    $r->print($resource->{'title'}.$resource->{'notes'}."</td><td>\n");
  445: 	    $r->print($resource->{'url'}."</td>"
  446:                      .&Apache::loncommon::end_data_table_row()
  447:                      ."\n");
  448: 	} 
  449:     }
  450:     if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  451:         if ($clen > 0) {
  452:             $r->print(&Apache::loncommon::end_data_table());
  453:         }
  454:         $r->print('</form>');
  455:     } else {
  456: 	$r->print(<<END);
  457: <script type="text/javascript">
  458:     finish_import();
  459: </script>
  460: END
  461:     }
  462: 
  463:     $r->print(&Apache::loncommon::end_page());
  464: 
  465:     return OK;
  466: }
  467: 
  468: # --------------------------------------- Hidden values (returns scalar string)
  469: sub hidden {
  470:     my ($sel,$title,$filelink,$id) = @_;
  471:     my $string = '<input type="hidden" name="title'.$sel.'" value="'.
  472: 	&escape($title).'" />';
  473:     $filelink=~s|^/ext/|http://|;
  474:     $string .= '<input type="hidden" name="filelink'.$sel.'" value="'.
  475: 	&escape($filelink).'" />';
  476:     $string .= '<input type="hidden" name="id'.$sel.'" value="'.&escape($id).'" />';
  477:     return $string;
  478: }
  479: 
  480: # --------------------------------------- Moving arrows (returns scalar string)
  481: sub movers {
  482:     my ($total,$sel) = @_;
  483:     my $dsel = $sel-1;
  484:     my $usel = $sel+1;
  485:     $usel = 1 if $usel > $total;
  486:     $dsel = $total if $dsel < 1;
  487:     my $string;
  488:     $string = (<<END);
  489: <table border='0' cellspacing='0' cellpadding='0'>
  490: <tr><td><a href='javascript:move($sel,$dsel)'>
  491: <img src="${iconpath}move_up.gif" alt='UP' border='0' /></a></td></tr>
  492: <tr><td><a href='javascript:move($sel,$usel)'>
  493: <img src="${iconpath}move_down.gif" alt='DOWN' border='0' /></a></td></tr>
  494: </table>
  495: END
  496:     return $string;
  497: }
  498: 
  499: # ------------------------------------------ Select box (returns scalar string)
  500: sub select_box {
  501:     my ($total,$sel) = @_;
  502:     my $string;
  503:     $string = '<select name="alt'.$sel.'"';
  504:     $string .= " onChange='selectchange($sel)'>";
  505:     $string .= "<option name='o0' value='0'>".&mt('discard')."</option>";
  506:     for my $cur (1..$total) {
  507: 	$string .= "<option name='o$cur' value='$cur'";
  508: 	if ($cur == $sel) {
  509: 	    $string .= "selected";
  510: 	}
  511: 	$string .= ">$cur</option>";
  512:     }
  513:     $string .= "</select>\n";
  514:     return $string;
  515: }
  516: 
  517: # ------------------------------------------------------------------- Checkbox
  518: 
  519: sub checkbox {
  520:     my $sel=shift;
  521:     return "<label><input type='checkbox' name='include$sel'".
  522:        ($env{"form.include$sel"}?' checked="checked"':'').
  523:        ' />'.&mt('Include').'</label>';
  524: }
  525: 
  526: 1;
  527: 
  528: __END__
  529: 
  530: =pod
  531: 
  532: =head1 NAME
  533: 
  534: Apache::groupsort.pm
  535: 
  536: =head1 SYNOPSIS
  537: 
  538: Implements a second phase of importing
  539: multiple resources into the RAT. Allows for
  540: reordering the sequence of resources
  541: 
  542: This is part of the LearningOnline Network with CAPA project
  543: described at http://www.lon-capa.org.
  544: 
  545: 
  546: =head1 NOTABLE SUBROUTINES
  547: 
  548: =over
  549: 
  550: =item 
  551: 
  552: =back
  553: 
  554: =cut
  555: