Annotation of loncom/interface/groupsort.pm, revision 1.58
1.1 harris41 1: # The LearningOnline Network with CAPA
1.4 harris41 2: # The LON-CAPA group sort handler
3: # Allows for sorting prior to import into RAT.
4: #
1.58 ! albertel 5: # $Id: groupsort.pm,v 1.57 2007/07/12 00:27:13 albertel Exp $
1.4 harris41 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.
1.1 harris41 20: #
1.4 harris41 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
1.1 harris41 26: #
1.4 harris41 27: # http://www.lon-capa.org/
1.1 harris41 28: #
1.4 harris41 29: ###
1.1 harris41 30:
31: package Apache::groupsort;
32:
33: use strict;
34:
35: use Apache::Constants qw(:common);
36: use GDBM_File;
1.15 www 37: use Apache::loncommon;
1.23 www 38: use Apache::lonlocal;
1.27 taceyjo1 39: use Apache::lonnet;
1.50 albertel 40: use LONCAPA();
1.1 harris41 41:
1.33 www 42: my $iconpath; # variable to be accessible to multiple subroutines
1.2 harris41 43: my %hash; # variable to tie to user specific database
1.8 www 44:
1.2 harris41 45:
1.55 albertel 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:
1.33 www 84: sub readfromdb {
1.57 albertel 85: my ($r,$resources)=@_;
1.9 www 86:
1.42 www 87: my $diropendb =
88: "/home/httpd/perl/tmp/$env{'user.domain'}_$env{'user.name'}_sel_res.db";
1.11 www 89:
90: # ----------------------------- diropendb is now the filename of the db to open
1.13 albertel 91: if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
1.55 albertel 92: &update_actions_hash(\%hash);
93:
1.57 albertel 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});
1.5 harris41 106: }
1.57 albertel 107:
1.31 albertel 108: if ($env{'form.oldval'}) {
1.57 albertel 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);
1.1 harris41 117: }
1.57 albertel 118: }
119: # store out new order
120: foreach my $which (0..$#$resources) {
121: my $url = $resources->[$which]{'url'};
122: $hash{'storectr_'.$url} = $which;
1.1 harris41 123: }
124: } else {
1.34 www 125: $r->print('Unable to tie hash to db file');
1.1 harris41 126: }
1.57 albertel 127: untie(%hash);
1.33 www 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: }
1.39 albertel 139: return OK;
1.33 www 140: }
141:
1.34 www 142: # -------------------------------------------------------------- Read from file
143:
144: sub readfromfile {
1.57 albertel 145: my ($r,$resources)=@_;
1.34 www 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: }
1.35 www 162:
1.34 www 163: my $name=$token->[2]->{'title'};
1.50 albertel 164: $name=~s/ \[\((\d+)\,($LONCAPA::username_re)\,($LONCAPA::domain_re)\)\]$//;
1.57 albertel 165: my $note;
1.34 www 166: if ($1) {
1.57 albertel 167: $note = '<br />'.&mt('Removed by ').
1.34 www 168: &Apache::loncommon::plainname($2,$3).', '.
169: &Apache::lonlocal::locallocaltime($1);
170: }
1.37 www 171: $name=~s/\&colon\;/\:/g;
1.58 ! albertel 172: push(@{$resources}, {'url' => $token->[2]->{'src'},
1.57 albertel 173: 'title' => $name,
1.58 ! albertel 174: 'note' => $note,
! 175: 'id' => $token->[2]->{'id'},});
1.34 www 176: }
177: }
178: }
179: }
180: }
181:
1.44 www 182: # --------------------------------------------------------- Read from bookmarks
183:
184: sub readfrombookmarks {
1.57 albertel 185: my ($r,$resources)=@_;
1.44 www 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]) {
1.57 albertel 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});
1.44 www 197: }
198: }
199: }
200:
1.33 www 201: # ---------------------------------------------------------------- Main Handler
202: sub handler {
203: my $r = shift;
204:
205: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.44 www 206: ['acts','mode','readfile','recover','bookmarks']);
1.33 www 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='';
1.37 www 217: my $begincondition='';
218: my $endcondition='';
1.44 www 219: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 220: $begincondition='if (eval("document.forms.groupsort.include"+num+".checked")) {';
221: $endcondition='}';
222: }
1.33 www 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++) {
1.37 www 228: $begincondition
1.33 www 229: opener.document.forms.simpleedit.importdetail.value+='&'+
230: escape(eval("document.forms.groupsort.title"+num+".value"))+'='+
1.58 ! albertel 231: escape(eval("document.forms.groupsort.filelink"+num+".value"))+'='+
! 232: escape(eval("document.forms.groupsort.id"+num+".value"));
1.37 www 233: $endcondition
1.33 www 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++) {
1.37 www 244: $begincondition
1.33 www 245: insertRowInLastRow();
246: placeResourceInLastRow(
247: eval("document.forms.groupsort.title"+num+".value"),
248: eval("document.forms.groupsort.filelink"+num+".value"),
249: linkflag
250: );
251: linkflag=true;
1.37 www 252: $endcondition
1.33 www 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
1.40 albertel 264: my $js = <<END;
265: <script type="text/javascript">
1.33 www 266: function insertRowInLastRow() {
267: opener.insertrow(opener.maxrow);
268: opener.addobj(opener.maxrow,'e&2');
269: }
270: function placeResourceInLastRow (title,url,linkflag) {
271: opener.mostrecent=opener.newresource(opener.maxrow,2,opener.escape(title),
272: opener.escape(url),'false','normal');
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:
1.57 albertel 298: my @resources;
1.33 www 299:
1.34 www 300: if ($env{'form.readfile'}) {
1.57 albertel 301: &readfromfile($r,\@resources);
1.44 www 302: } elsif ($env{'form.bookmarks'}) {
1.57 albertel 303: &readfrombookmarks($r,\@resources);
1.34 www 304: } else {
1.57 albertel 305: &readfromdb($r,\@resources);
1.34 www 306: }
1.33 www 307:
1.2 harris41 308: my $ctr = 0;
1.57 albertel 309: my $clen = scalar(@resources);
1.44 www 310: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.23 www 311: my %lt=&Apache::lonlocal::texthash(
312: 'fin'=> 'Finalize order of resources',
1.42 www 313: 'ci' => 'Continue Import',
314: 'cs' => 'Continue Search',
1.23 www 315: 'fi' => 'Finish Import',
1.51 albertel 316: 're' => 'Recover Checked',
1.23 www 317: 'ca' => 'Cancel',
318: 'co' => 'Change Order',
319: 'ti' => 'Title',
1.37 www 320: 'pa' => 'Path',
321: 'in' => 'Include'
1.23 www 322: );
1.56 albertel 323: my $title = ($env{'form.recover'}) ? 'Recover Removed Resources'
324: : 'Sort Imported Resources';
325: $r->print(&Apache::loncommon::start_page($title, $js));
326:
1.22 albertel 327: $r->print(<<END);
1.14 matthew 328: <form method='post' action='/adm/groupsort' name='groupsort'
329: enctype='application/x-www-form-urlencoded'>
1.1 harris41 330: <input type="hidden" name="fnum" value="$clen" />
331: <input type="hidden" name="oldval" value="" />
332: <input type="hidden" name="newval" value="" />
1.31 albertel 333: <input type="hidden" name="mode" value="$env{'form.mode'}" />
1.36 www 334: <input type="hidden" name="readfile" value="$env{'form.readfile'}" />
1.44 www 335: <input type="hidden" name="bookmarks" value="$env{'form.bookmarks'}" />
1.36 www 336: <input type="hidden" name="recover" value="$env{'form.recover'}" />
1.3 harris41 337: END
1.11 www 338:
1.54 albertel 339: $r->print(&Apache::loncommon::inhibit_menu_check('input'));
1.51 albertel 340: # ---
341:
342: if ($env{'form.recover'}) {
343: $r->print(<<END);
344: <input type="button" name="alter" value="$lt{'re'}"
345: onClick="finish_import()" />
346: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
347: END
348: } else {
1.42 www 349: # --- Continue Buttons
1.51 albertel 350: my $resurl =
351: &Apache::loncommon::escape_single(&Apache::loncommon::lastresurl());
352: $r->print(<<END);
1.56 albertel 353: <b><font color="#888888">$lt{'fin'}</font></b>
1.42 www 354: <input type="button" name="alter" value="$lt{'ci'}"
1.54 albertel 355: onClick="window.location='$resurl?inhibitmenu=yes&catalogmode=import'" />
1.42 www 356: <input type="button" name="altersearch" value="$lt{'cs'}"
1.54 albertel 357: onClick="window.location='/adm/searchcat?inhibitmenu=yes&catalogmode=import'" />
1.23 www 358: <input type="button" name="alter" value="$lt{'fi'}"
1.2 harris41 359: onClick="finish_import()" />
1.23 www 360: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
1.1 harris41 361: END
1.51 albertel 362: }
1.22 albertel 363: $r->print("<table border='0'><tr><td bgcolor='#eeeeee'>");
364: $r->print("<table border=0><tr>\n");
1.44 www 365: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 366: $r->print("<td bgcolor='$titleclr'><b>$lt{'in'}</b></td>\n");
367: } else {
368: $r->print("<td colspan='2' bgcolor='$titleclr'><b>$lt{'co'}</b></td>\n");
369: }
1.23 www 370: $r->print("<td colspan='2' bgcolor='$titleclr'><b>$lt{'ti'}</b></td>\n");
371: $r->print("<td bgcolor='$titleclr'><b>$lt{'pa'}</b></td></tr>\n");
1.22 albertel 372: } else {
1.40 albertel 373: $r->print(&Apache::loncommon::start_page(undef,$js,
1.41 banghart 374: {'only_body' => 1}));
1.22 albertel 375: $r->print(<<END);
376: <form method='post' action='/adm/groupsort' name='groupsort'
377: enctype='application/x-www-form-urlencoded'>
378: <input type="hidden" name="fnum" value="$clen" />
379: <input type="hidden" name="oldval" value="" />
380: <input type="hidden" name="newval" value="" />
1.31 albertel 381: <input type="hidden" name="mode" value="$env{'form.mode'}" />
1.22 albertel 382: END
1.54 albertel 383: $r->print(&Apache::loncommon::inhibit_menu_check('input'));
384:
1.22 albertel 385: }
1.57 albertel 386: foreach my $resource (@resources) {
1.1 harris41 387: $ctr++;
1.57 albertel 388: my $iconname=&Apache::loncommon::icon($resource->{'url'});
1.44 www 389: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.22 albertel 390: $r->print("<tr><td bgcolor='$fileclr'>");
1.44 www 391: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 392: $r->print(&checkbox($ctr-1));
393: } else {
394: $r->print(&movers($clen,$ctr));
395: }
1.22 albertel 396: }
1.58 ! albertel 397: $r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'},
! 398: $resource->{'id'}));
1.44 www 399: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 400: $r->print("</td>");
1.44 www 401: unless (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 402: $r->print("<td bgcolor='$fileclr'>".
403: &select_box($clen,$ctr).
404: "</td>");
405: }
406: $r->print("<td bgcolor='$fileclr'>");
1.26 albertel 407: $r->print("<img src='$iconname' />");
1.22 albertel 408: $r->print("</td><td bgcolor='$fileclr'>");
1.57 albertel 409: $r->print($resource->{'title'}.$resource->{'notes'}."</td><td bgcolor='$fileclr'>\n");
410: $r->print($resource->{'url'}."</td></tr>\n");
1.22 albertel 411: }
412: }
1.44 www 413: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.22 albertel 414: $r->print("</table></td></tr></table></form>");
415: } else {
416: $r->print(<<END);
417: <script type="text/javascript">
418: finish_import();
419: </script>
420: END
421: }
1.40 albertel 422:
423: $r->print(&Apache::loncommon::end_page());
1.22 albertel 424:
1.1 harris41 425: return OK;
426: }
427:
1.2 harris41 428: # --------------------------------------- Hidden values (returns scalar string)
1.1 harris41 429: sub hidden {
1.58 ! albertel 430: my ($sel,$title,$filelink,$id) = @_;
1.2 harris41 431: my $string = '<input type="hidden" name="title'.$sel.'" value="'.$title.
432: '" />';
1.48 albertel 433: $filelink=~s|^/ext/|http://|;
1.2 harris41 434: $string .= '<input type="hidden" name="filelink'.$sel.'" value="'.
435: $filelink.'" />';
1.58 ! albertel 436: $string .= '<input type="hidden" name="id'.$sel.'" value="'.$id.'" />';
1.1 harris41 437: return $string;
438: }
439:
1.2 harris41 440: # --------------------------------------- Moving arrows (returns scalar string)
1.1 harris41 441: sub movers {
1.2 harris41 442: my ($total,$sel) = @_;
443: my $dsel = $sel-1;
444: my $usel = $sel+1;
445: $usel = 1 if $usel > $total;
446: $dsel = $total if $dsel < 1;
1.1 harris41 447: my $string;
1.2 harris41 448: $string = (<<END);
1.1 harris41 449: <table border='0' cellspacing='0' cellpadding='0'>
1.2 harris41 450: <tr><td><a href='javascript:move($sel,$dsel)'>
451: <img src="${iconpath}move_up.gif" alt='UP' border='0' /></a></td></tr>
452: <tr><td><a href='javascript:move($sel,$usel)'>
453: <img src="${iconpath}move_down.gif" alt='DOWN' border='0' /></a></td></tr>
1.1 harris41 454: </table>
455: END
456: return $string;
457: }
1.2 harris41 458:
459: # ------------------------------------------ Select box (returns scalar string)
1.1 harris41 460: sub select_box {
1.2 harris41 461: my ($total,$sel) = @_;
1.1 harris41 462: my $string;
1.2 harris41 463: $string = '<select name="alt'.$sel.'"';
464: $string .= " onChange='selectchange($sel)'>";
1.36 www 465: $string .= "<option name='o0' value='0'>".&mt('discard')."</option>";
1.1 harris41 466: for my $cur (1..$total) {
1.2 harris41 467: $string .= "<option name='o$cur' value='$cur'";
468: if ($cur == $sel) {
469: $string .= "selected";
1.1 harris41 470: }
1.2 harris41 471: $string .= ">$cur</option>";
1.1 harris41 472: }
1.2 harris41 473: $string .= "</select>\n";
1.1 harris41 474: return $string;
475: }
476:
1.37 www 477: # ------------------------------------------------------------------- Checkbox
478:
479: sub checkbox {
480: my $sel=shift;
481: return "<label><input type='checkbox' name='include$sel'".
482: ($env{"form.include$sel"}?' checked="checked"':'').
483: ' />'.&mt('Include').'</label>';
484: }
485:
1.1 harris41 486: 1;
487:
488: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>