File:  [LON-CAPA] / loncom / interface / groupsort.pm
Revision 1.59: download - view: text, annotated - select for diffs
Thu Jul 12 19:54:43 2007 UTC (16 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- when recovering deleted resource in Advanced RAT, support recovering
  the correct id number if possible

    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.59 2007/07/12 19:54:43 albertel 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:     my $acts=$env{'form.acts'};
   49:     my @Acts=split(/b/,$acts);
   50:     my %ahash;
   51:     my %achash;
   52:     my $ac=0;
   53:     # some initial hashes for working with data
   54:     foreach (@Acts) {
   55: 	my ($state,$ref)=split(/a/);
   56: 	$ahash{$ref}=$state;
   57: 	$achash{$ref}=$ac;
   58: 	$ac++;
   59:     }
   60:     # sorting through the actions and changing the global database hash
   61:     foreach my $key (sort {$achash{$a}<=>$achash{$b}} (keys %ahash)) {
   62: 	if ($ahash{$key} eq '1') {
   63: 	    $hash->{'store_'.$hash{'pre_'.$key.'_link'}}=
   64: 		$hash->{'pre_'.$key.'_title'};
   65: 	    $hash->{'storectr_'.$hash{'pre_'.$key.'_link'}}=
   66: 		$hash->{'storectr'}+0;
   67: 	    $hash->{'storectr'}++;
   68: 	}
   69: 	if ($ahash{$key} eq '0') {
   70: 	    if ($hash->{'store_'.$hash{'pre_'.$key.'_link'}}) {
   71: 		delete($hash->{'store_'.$hash{'pre_'.$key.'_link'}});
   72: 	    }
   73: 	}
   74:     }
   75:     # deleting the previously cached listing
   76:     foreach my $key (keys(%{ $hash })) {
   77: 	next if ($key !~ /^pre_(\d+)_link/);
   78: 	my $which = $1;
   79: 	delete($hash->{'pre_'.$which.'_title'});
   80: 	delete($hash->{'pre_'.$which.'_link'});
   81:     }
   82: }
   83: 
   84: sub readfromdb {
   85:     my ($r,$resources)=@_;
   86: 
   87:     my $diropendb = 
   88:        "/home/httpd/perl/tmp/$env{'user.domain'}_$env{'user.name'}_sel_res.db";
   89: 
   90: # ----------------------------- diropendb is now the filename of the db to open
   91:     if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
   92: 	&update_actions_hash(\%hash);
   93: 
   94: 	my %temp_resources;
   95: 	foreach my $key (keys(%hash)) {
   96: 	    next if ($key !~ /^store_/);
   97: 	    my ($url) = ($key =~ /^store_(.*)/);
   98: 	    $temp_resources{$hash{'storectr_'.$url}}{'url'}=$url;
   99: 	    $temp_resources{$hash{'storectr_'.$url}}{'title'}=
  100: 		&Apache::lonnet::gettitle($url);
  101: 	}
  102: 
  103: 	# use the temp, since there might be gaps in the counting
  104: 	foreach my $item (sort {$a <=> $b} (keys(%temp_resources))) {
  105: 	    push(@{ $resources },$temp_resources{$item});
  106: 	}
  107: 
  108: 	if ($env{'form.oldval'}) {
  109: 	    my $res = splice(@{$resources},$env{'form.oldval'}-1,1);
  110: 	    if ($env{'form.newval'} == 0) {
  111: 		# picked 'discard'
  112: 		my $url =  $res->{'url'};
  113: 		delete($hash{'storectr_'.$url});
  114: 		delete($hash{'store_'.$url});
  115: 	    } else {
  116: 		splice(@{$resources},$env{'form.newval'}-1,0,$res);
  117: 	    }
  118: 	}
  119: 	# store out new order
  120: 	foreach my $which (0..$#$resources) {
  121: 	    my $url =  $resources->[$which]{'url'};
  122: 	    $hash{'storectr_'.$url} = $which;
  123: 	}
  124:     } else {
  125: 	$r->print('Unable to tie hash to db file');
  126:     }
  127:     untie(%hash);
  128: }
  129: 
  130: 
  131: 
  132: sub cleanup {
  133:     if (tied(%hash)){
  134: 	&Apache::lonnet::logthis('Cleanup groupsort: hash');
  135:         unless (untie(%hash)) {
  136: 	    &Apache::lonnet::logthis('Failed cleanup groupsort: hash');
  137:         }
  138:     }
  139:     return OK;
  140: }
  141: 
  142: # -------------------------------------------------------------- Read from file
  143: 
  144: sub readfromfile {
  145:     my ($r,$resources)=@_;
  146:     my $cont=&Apache::lonnet::getfile
  147: 	(&Apache::lonnet::filelocation('',$env{'form.readfile'}));
  148:     if ($cont==-1) {
  149: 	$r->print('Unable to read file: '.
  150: 		  &Apache::lonnet::filelocation('',$env{'form.readfile'}));
  151:     } else {
  152:         my $parser = HTML::TokeParser->new(\$cont);
  153:         my $token;
  154:         while ($token = $parser->get_token) {
  155: 	    if ($token->[0] eq 'S') {
  156:                 if ($token->[1] eq 'resource') {
  157: 		    if ($env{'form.recover'}) {
  158: 			if ($token->[2]->{'type'} ne 'zombie') { next; }
  159: 		    } else {
  160: 			if ($token->[2]->{'type'} eq 'zombie') { next; }
  161: 		    }
  162: 
  163:                     my $name=$token->[2]->{'title'};
  164: 		    $name=~s/ \[\((\d+)\,($LONCAPA::username_re)\,($LONCAPA::domain_re)\)\]$//;
  165: 		    my $note;
  166: 		    if ($1) {
  167: 			$note = '<br />'.&mt('Removed by ').
  168: 			    &Apache::loncommon::plainname($2,$3).', '.
  169: 			    &Apache::lonlocal::locallocaltime($1);
  170: 		    }
  171: 		    $name=~s/\&colon\;/\:/g;
  172: 		    push(@{$resources}, {'url'   => $token->[2]->{'src'},
  173: 					 'title' => $name,
  174: 					 'note'  => $note,
  175: 				         'id'    => $token->[2]->{'id'},});
  176: 		}
  177: 	    }
  178: 	}
  179:     }
  180: }
  181: 
  182: # --------------------------------------------------------- Read from bookmarks
  183: 
  184: sub readfrombookmarks {
  185:     my ($r,$resources)=@_;
  186:     my %bookmarks=&Apache::lonnet::dump('bookmarks');
  187: # the bookmark "hash" is just one entry
  188: # it's a javascript program code with arguments like ('title','url');
  189:     my @bookmarks=($bookmarks{'bookmarks'}=~/\((?:\'([^\']+)\'\,\'([^\']+)\'|\"([^\"]+)\"\,\"([^\"]+)\")\)\;/g);
  190:     for (my $index=0;$index<($#bookmarks+1)/2;$index++) {
  191:         if ($bookmarks[$index*2+1]) {
  192: 	    my $url  = $bookmarks[$index*2+1];
  193: 	    my $name = $bookmarks[$index*2];
  194: 	    $name =~ s/^LON\-CAPA\s+//;
  195: 
  196: 	    push(@{$resources},{'url' => $url, 'title' => $name});
  197: 	}
  198:     }
  199: }
  200: 
  201: # ---------------------------------------------------------------- Main Handler
  202: sub handler {
  203:     my $r = shift;
  204:  
  205:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  206: 			     ['acts','mode','readfile','recover','bookmarks']);
  207:     # color scheme
  208:     my $fileclr = '#ffffe6';
  209:     my $titleclr = '#ddffff';
  210: 
  211:     &Apache::loncommon::content_type($r,'text/html');
  212:     $r->send_http_header;
  213:     return OK if $r->header_only;
  214: 
  215: # finish_import looks different for graphical or "simple" RAT
  216:     my $finishimport='';
  217:     my $begincondition='';
  218:     my $endcondition='';
  219:     if (($env{'form.readfile'}) || ($env{'form.bookmarks'}))  {
  220:         $begincondition='if (eval("document.forms.groupsort.include"+num+".checked")) {';
  221: 	$endcondition='}';
  222:     }
  223:     if ($env{'form.mode'} eq 'simple' || $env{'form.mode'} eq '') {
  224:         $finishimport=(<<ENDSMP);
  225: function finish_import() {
  226:     opener.document.forms.simpleedit.importdetail.value='';
  227:     for (var num=0; num<document.forms.groupsort.fnum.value; num++) {
  228: 	$begincondition
  229: 	opener.document.forms.simpleedit.importdetail.value+='&'+
  230:               escape(eval("document.forms.groupsort.title"+num+".value"))+'='+
  231: 	      escape(eval("document.forms.groupsort.filelink"+num+".value"))+'='+
  232: 	      escape(eval("document.forms.groupsort.id"+num+".value"));
  233: 	$endcondition
  234:     }
  235:     opener.document.forms.simpleedit.submit();
  236:     self.close();
  237: }
  238: ENDSMP
  239:     } else {
  240:         $finishimport=(<<ENDADV);
  241: function finish_import() {
  242:     var linkflag=false;
  243:     for (var num=0; num<document.forms.groupsort.fnum.value; num++) {
  244: 	$begincondition
  245: 	insertRowInLastRow();
  246: 	placeResourceInLastRow(
  247: 	       eval("document.forms.groupsort.title"+num+".value"),
  248:  	       eval("document.forms.groupsort.filelink"+num+".value"),
  249:  	       eval("document.forms.groupsort.id"+num+".value"),
  250: 	       linkflag
  251: 	);
  252:         linkflag=true;
  253: 	$endcondition
  254:     }
  255:     opener.editmode=0;
  256:     opener.notclear=0;
  257:     opener.linkmode=0;
  258:     opener.draw();
  259:     self.close();
  260: }
  261: ENDADV
  262:     }
  263: 
  264: # output start of web page
  265:     my $js = <<END;
  266: <script type="text/javascript">
  267: function insertRowInLastRow() {
  268:     opener.insertrow(opener.maxrow);
  269:     opener.addobj(opener.maxrow,'e&2');
  270: }
  271: function placeResourceInLastRow (title,url,id,linkflag) {
  272:     opener.mostrecent=opener.newresource(opener.maxrow,2,opener.escape(title),
  273: 		       opener.escape(url),'false','normal',id);
  274:     opener.save();
  275:     if (linkflag) {
  276: 	opener.joinres(opener.linkmode,opener.mostrecent,0);
  277:     }
  278:     opener.linkmode=opener.mostrecent;
  279: }
  280: $finishimport
  281: function selectchange(val) {
  282:     var newval=0+eval("document.forms.groupsort.alt"+val+".selectedIndex");
  283:     orderchange(val,newval);
  284: }
  285: function move(val,newval) {
  286:     orderchange(val,newval);
  287: }
  288: function orderchange(val,newval) {
  289:     document.forms.groupsort.oldval.value=val;
  290:     document.forms.groupsort.newval.value=newval;
  291:     document.forms.groupsort.submit();
  292: }
  293: </script>
  294: END
  295:     # read pertinent machine configuration
  296:     my $domain  = $r->dir_config('lonDefDomain');
  297:     $iconpath = $r->dir_config('lonIconsURL') . "/";
  298: 
  299:     my @resources;
  300: 
  301:     if ($env{'form.readfile'}) {
  302: 	&readfromfile($r,\@resources);
  303:     } elsif ($env{'form.bookmarks'}) {
  304: 	&readfrombookmarks($r,\@resources);
  305:     } else {
  306: 	&readfromdb($r,\@resources);
  307:     }
  308: 
  309:     my $ctr = 0;
  310:     my $clen = scalar(@resources);
  311:     if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  312: 	my %lt=&Apache::lonlocal::texthash(
  313: 		'fin'=> 'Finalize order of resources',
  314: 		'ci' => 'Continue Import',
  315: 		'cs' => 'Continue Search',
  316: 		'fi' => 'Finish Import',
  317: 		're' => 'Recover Checked',
  318: 		'ca' => 'Cancel',
  319: 		'co' => 'Change Order',
  320: 		'ti' => 'Title',
  321: 		'pa' => 'Path',
  322:                 'in' => 'Include'
  323: 		);
  324: 	my $title = ($env{'form.recover'}) ? 'Recover Removed Resources'
  325:                                            : 'Sort Imported Resources';
  326: 	$r->print(&Apache::loncommon::start_page($title, $js));
  327: 
  328: 	$r->print(<<END);
  329: <form method='post' action='/adm/groupsort' name='groupsort'
  330:       enctype='application/x-www-form-urlencoded'>
  331: <input type="hidden" name="fnum" value="$clen" />
  332: <input type="hidden" name="oldval" value="" />
  333: <input type="hidden" name="newval" value="" />
  334: <input type="hidden" name="mode" value="$env{'form.mode'}" />
  335: <input type="hidden" name="readfile" value="$env{'form.readfile'}" />
  336: <input type="hidden" name="bookmarks" value="$env{'form.bookmarks'}" />
  337: <input type="hidden" name="recover" value="$env{'form.recover'}" />
  338: END
  339: 
  340:         $r->print(&Apache::loncommon::inhibit_menu_check('input'));
  341:         # ---
  342:     
  343:         if ($env{'form.recover'}) {
  344: 	    $r->print(<<END);
  345: <input type="button" name="alter" value="$lt{'re'}"
  346:  onClick="finish_import()" />&nbsp;
  347: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
  348: END
  349: 	} else {
  350:         # --- Continue Buttons
  351: 	    my $resurl = 
  352: 		&Apache::loncommon::escape_single(&Apache::loncommon::lastresurl());
  353: 	    $r->print(<<END);
  354: <b><font color="#888888">$lt{'fin'}</font></b>
  355: <input type="button" name="alter" value="$lt{'ci'}"
  356:  onClick="window.location='$resurl?inhibitmenu=yes&amp;catalogmode=import'" />&nbsp;
  357: <input type="button" name="altersearch" value="$lt{'cs'}"
  358:  onClick="window.location='/adm/searchcat?inhibitmenu=yes&amp;catalogmode=import'" />&nbsp;
  359: <input type="button" name="alter" value="$lt{'fi'}"
  360:  onClick="finish_import()" />&nbsp;
  361: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
  362: END
  363:         }
  364:         $r->print("<table border='0'><tr><td bgcolor='#eeeeee'>");
  365: 	$r->print("<table border=0><tr>\n");
  366: 	if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) { 
  367: 	    $r->print("<td bgcolor='$titleclr'><b>$lt{'in'}</b></td>\n");
  368: 	} else { 
  369: 	    $r->print("<td colspan='2' bgcolor='$titleclr'><b>$lt{'co'}</b></td>\n"); 
  370: 	}
  371: 	$r->print("<td colspan='2' bgcolor='$titleclr'><b>$lt{'ti'}</b></td>\n");
  372: 	$r->print("<td bgcolor='$titleclr'><b>$lt{'pa'}</b></td></tr>\n");
  373:     } else {
  374: 	$r->print(&Apache::loncommon::start_page(undef,$js,
  375: 						 {'only_body' => 1}));
  376: 	$r->print(<<END);
  377: <form method='post' action='/adm/groupsort' name='groupsort'
  378:       enctype='application/x-www-form-urlencoded'>
  379: <input type="hidden" name="fnum" value="$clen" />
  380: <input type="hidden" name="oldval" value="" />
  381: <input type="hidden" name="newval" value="" />
  382: <input type="hidden" name="mode" value="$env{'form.mode'}" />
  383: END
  384:         $r->print(&Apache::loncommon::inhibit_menu_check('input'));
  385: 
  386:     }
  387:     foreach my $resource (@resources) {
  388: 	$ctr++;
  389: 	my $iconname=&Apache::loncommon::icon($resource->{'url'});
  390: 	if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  391: 	    $r->print("<tr><td bgcolor='$fileclr'>");
  392:             if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  393: 		$r->print(&checkbox($ctr-1));
  394: 	    } else {
  395: 		$r->print(&movers($clen,$ctr));
  396: 	    }
  397: 	}
  398: 	$r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'},
  399: 			  $resource->{'id'}));
  400: 	if (($clen > 1)  || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  401: 	    $r->print("</td>");
  402:             unless (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  403: 		$r->print("<td bgcolor='$fileclr'>".
  404: 			  &select_box($clen,$ctr).
  405: 			  "</td>");
  406: 	    }
  407: 	    $r->print("<td bgcolor='$fileclr'>");
  408: 	    $r->print("<img src='$iconname' />");
  409: 	    $r->print("</td><td bgcolor='$fileclr'>");
  410: 	    $r->print($resource->{'title'}.$resource->{'notes'}."</td><td bgcolor='$fileclr'>\n");
  411: 	    $r->print($resource->{'url'}."</td></tr>\n");
  412: 	} 
  413:     }
  414:     if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
  415: 	$r->print("</table></td></tr></table></form>");
  416:     } else {
  417: 	$r->print(<<END);
  418: <script type="text/javascript">
  419:     finish_import();
  420: </script>
  421: END
  422:     }
  423: 
  424:     $r->print(&Apache::loncommon::end_page());
  425: 
  426:     return OK;
  427: }
  428: 
  429: # --------------------------------------- Hidden values (returns scalar string)
  430: sub hidden {
  431:     my ($sel,$title,$filelink,$id) = @_;
  432:     my $string = '<input type="hidden" name="title'.$sel.'" value="'.$title.
  433: 	'" />';
  434:     $filelink=~s|^/ext/|http://|;
  435:     $string .= '<input type="hidden" name="filelink'.$sel.'" value="'.
  436: 	$filelink.'" />';
  437:     $string .= '<input type="hidden" name="id'.$sel.'" value="'.$id.'" />';
  438:     return $string;
  439: }
  440: 
  441: # --------------------------------------- Moving arrows (returns scalar string)
  442: sub movers {
  443:     my ($total,$sel) = @_;
  444:     my $dsel = $sel-1;
  445:     my $usel = $sel+1;
  446:     $usel = 1 if $usel > $total;
  447:     $dsel = $total if $dsel < 1;
  448:     my $string;
  449:     $string = (<<END);
  450: <table border='0' cellspacing='0' cellpadding='0'>
  451: <tr><td><a href='javascript:move($sel,$dsel)'>
  452: <img src="${iconpath}move_up.gif" alt='UP' border='0' /></a></td></tr>
  453: <tr><td><a href='javascript:move($sel,$usel)'>
  454: <img src="${iconpath}move_down.gif" alt='DOWN' border='0' /></a></td></tr>
  455: </table>
  456: END
  457:     return $string;
  458: }
  459: 
  460: # ------------------------------------------ Select box (returns scalar string)
  461: sub select_box {
  462:     my ($total,$sel) = @_;
  463:     my $string;
  464:     $string = '<select name="alt'.$sel.'"';
  465:     $string .= " onChange='selectchange($sel)'>";
  466:     $string .= "<option name='o0' value='0'>".&mt('discard')."</option>";
  467:     for my $cur (1..$total) {
  468: 	$string .= "<option name='o$cur' value='$cur'";
  469: 	if ($cur == $sel) {
  470: 	    $string .= "selected";
  471: 	}
  472: 	$string .= ">$cur</option>";
  473:     }
  474:     $string .= "</select>\n";
  475:     return $string;
  476: }
  477: 
  478: # ------------------------------------------------------------------- Checkbox
  479: 
  480: sub checkbox {
  481:     my $sel=shift;
  482:     return "<label><input type='checkbox' name='include$sel'".
  483:        ($env{"form.include$sel"}?' checked="checked"':'').
  484:        ' />'.&mt('Include').'</label>';
  485: }
  486: 
  487: 1;
  488: 
  489: __END__

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