Annotation of loncom/interface/groupsort.pm, revision 1.62
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.62 ! bisitz 5: # $Id: groupsort.pm,v 1.61 2007/11/02 21:08:45 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.61 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) = @_;
1.60 banghart 48: # be careful in here, there is also a global %hash
1.55 albertel 49: my $acts=$env{'form.acts'};
50: my @Acts=split(/b/,$acts);
51: my %ahash;
52: my %achash;
1.60 banghart 53: # some initial hashes for working with data
1.55 albertel 54: my $ac=0;
55: foreach (@Acts) {
1.60 banghart 56: my ($state,$ref)=split(/a/);
1.55 albertel 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') {
1.60 banghart 64: $hash->{'store_'.$hash->{'pre_'.$key.'_link'}}=
1.55 albertel 65: $hash->{'pre_'.$key.'_title'};
1.60 banghart 66: $hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}}=
1.55 albertel 67: $hash->{'storectr'}+0;
68: $hash->{'storectr'}++;
69: }
70: if ($ahash{$key} eq '0') {
1.60 banghart 71: if ($hash->{'store_'.$hash->{'pre_'.$key.'_link'}}) {
72: delete($hash->{'store_'.$hash->{'pre_'.$key.'_link'}});
73: delete($hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}});
1.55 albertel 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:
1.33 www 86: sub readfromdb {
1.57 albertel 87: my ($r,$resources)=@_;
1.9 www 88:
1.42 www 89: my $diropendb =
90: "/home/httpd/perl/tmp/$env{'user.domain'}_$env{'user.name'}_sel_res.db";
1.11 www 91:
92: # ----------------------------- diropendb is now the filename of the db to open
1.13 albertel 93: if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
1.55 albertel 94: &update_actions_hash(\%hash);
95:
1.57 albertel 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});
1.5 harris41 108: }
1.57 albertel 109:
1.31 albertel 110: if ($env{'form.oldval'}) {
1.57 albertel 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);
1.1 harris41 119: }
1.57 albertel 120: }
121: # store out new order
122: foreach my $which (0..$#$resources) {
123: my $url = $resources->[$which]{'url'};
124: $hash{'storectr_'.$url} = $which;
1.1 harris41 125: }
126: } else {
1.34 www 127: $r->print('Unable to tie hash to db file');
1.1 harris41 128: }
1.57 albertel 129: untie(%hash);
1.33 www 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: }
1.39 albertel 141: return OK;
1.33 www 142: }
143:
1.34 www 144: # -------------------------------------------------------------- Read from file
145:
146: sub readfromfile {
1.57 albertel 147: my ($r,$resources)=@_;
1.34 www 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: }
1.35 www 164:
1.34 www 165: my $name=$token->[2]->{'title'};
1.50 albertel 166: $name=~s/ \[\((\d+)\,($LONCAPA::username_re)\,($LONCAPA::domain_re)\)\]$//;
1.57 albertel 167: my $note;
1.34 www 168: if ($1) {
1.57 albertel 169: $note = '<br />'.&mt('Removed by ').
1.34 www 170: &Apache::loncommon::plainname($2,$3).', '.
171: &Apache::lonlocal::locallocaltime($1);
172: }
1.37 www 173: $name=~s/\&colon\;/\:/g;
1.58 albertel 174: push(@{$resources}, {'url' => $token->[2]->{'src'},
1.57 albertel 175: 'title' => $name,
1.58 albertel 176: 'note' => $note,
177: 'id' => $token->[2]->{'id'},});
1.34 www 178: }
179: }
180: }
181: }
182: }
183:
1.44 www 184: # --------------------------------------------------------- Read from bookmarks
185:
186: sub readfrombookmarks {
1.57 albertel 187: my ($r,$resources)=@_;
1.44 www 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]) {
1.57 albertel 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});
1.44 www 199: }
200: }
201: }
202:
1.33 www 203: # ---------------------------------------------------------------- Main Handler
204: sub handler {
205: my $r = shift;
206:
207: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.44 www 208: ['acts','mode','readfile','recover','bookmarks']);
1.33 www 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='';
1.37 www 216: my $begincondition='';
217: my $endcondition='';
1.44 www 218: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 219: $begincondition='if (eval("document.forms.groupsort.include"+num+".checked")) {';
220: $endcondition='}';
221: }
1.33 www 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++) {
1.37 www 227: $begincondition
1.33 www 228: opener.document.forms.simpleedit.importdetail.value+='&'+
1.61 albertel 229: eval("document.forms.groupsort.title"+num+".value")+'='+
230: eval("document.forms.groupsort.filelink"+num+".value")+'='+
231: eval("document.forms.groupsort.id"+num+".value");
1.37 www 232: $endcondition
1.33 www 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++) {
1.37 www 243: $begincondition
1.33 www 244: insertRowInLastRow();
245: placeResourceInLastRow(
246: eval("document.forms.groupsort.title"+num+".value"),
247: eval("document.forms.groupsort.filelink"+num+".value"),
1.59 albertel 248: eval("document.forms.groupsort.id"+num+".value"),
1.33 www 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: }
1.59 albertel 270: function placeResourceInLastRow (title,url,id,linkflag) {
1.33 www 271: opener.mostrecent=opener.newresource(opener.maxrow,2,opener.escape(title),
1.59 albertel 272: opener.escape(url),'false','normal',id);
1.33 www 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.62 ! bisitz 353: <h2>$lt{'fin'}</h2>
! 354: <div>
1.42 www 355: <input type="button" name="alter" value="$lt{'ci'}"
1.54 albertel 356: onClick="window.location='$resurl?inhibitmenu=yes&catalogmode=import'" />
1.42 www 357: <input type="button" name="altersearch" value="$lt{'cs'}"
1.54 albertel 358: onClick="window.location='/adm/searchcat?inhibitmenu=yes&catalogmode=import'" />
1.23 www 359: <input type="button" name="alter" value="$lt{'fi'}"
1.2 harris41 360: onClick="finish_import()" />
1.23 www 361: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
1.62 ! bisitz 362: </div>
! 363: <br />
1.1 harris41 364: END
1.51 albertel 365: }
1.62 ! bisitz 366: $r->print(&Apache::loncommon::start_data_table()
! 367: .&Apache::loncommon::start_data_table_header_row());
1.44 www 368: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.62 ! bisitz 369: $r->print("<th>$lt{'in'}</th>\n");
1.37 www 370: } else {
1.62 ! bisitz 371: $r->print("<th colspan='2'>$lt{'co'}</th>\n");
1.37 www 372: }
1.62 ! bisitz 373: $r->print("<th colspan='2'>$lt{'ti'}</th>\n");
! 374: $r->print("<th>$lt{'pa'}</th>");
! 375: $r->print(&Apache::loncommon::end_data_table_header_row()
! 376: ."\n");
1.22 albertel 377: } else {
1.40 albertel 378: $r->print(&Apache::loncommon::start_page(undef,$js,
1.41 banghart 379: {'only_body' => 1}));
1.22 albertel 380: $r->print(<<END);
381: <form method='post' action='/adm/groupsort' name='groupsort'
382: enctype='application/x-www-form-urlencoded'>
383: <input type="hidden" name="fnum" value="$clen" />
384: <input type="hidden" name="oldval" value="" />
385: <input type="hidden" name="newval" value="" />
1.31 albertel 386: <input type="hidden" name="mode" value="$env{'form.mode'}" />
1.22 albertel 387: END
1.54 albertel 388: $r->print(&Apache::loncommon::inhibit_menu_check('input'));
389:
1.22 albertel 390: }
1.57 albertel 391: foreach my $resource (@resources) {
1.1 harris41 392: $ctr++;
1.57 albertel 393: my $iconname=&Apache::loncommon::icon($resource->{'url'});
1.44 www 394: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.62 ! bisitz 395: $r->print(&Apache::loncommon::start_data_table_row()
! 396: ."<td>");
1.44 www 397: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 398: $r->print(&checkbox($ctr-1));
399: } else {
400: $r->print(&movers($clen,$ctr));
401: }
1.22 albertel 402: }
1.58 albertel 403: $r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'},
404: $resource->{'id'}));
1.44 www 405: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.37 www 406: $r->print("</td>");
1.44 www 407: unless (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.62 ! bisitz 408: $r->print("<td>".
1.37 www 409: &select_box($clen,$ctr).
410: "</td>");
411: }
1.62 ! bisitz 412: $r->print("<td>");
1.26 albertel 413: $r->print("<img src='$iconname' />");
1.62 ! bisitz 414: $r->print("</td><td>");
! 415: $r->print($resource->{'title'}.$resource->{'notes'}."</td><td>\n");
! 416: $r->print($resource->{'url'}."</td>"
! 417: .&Apache::loncommon::end_data_table_row()
! 418: ."\n");
1.22 albertel 419: }
420: }
1.44 www 421: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
1.62 ! bisitz 422: $r->print(&Apache::loncommon::end_data_table()
! 423: ."</form>");
1.22 albertel 424: } else {
425: $r->print(<<END);
426: <script type="text/javascript">
427: finish_import();
428: </script>
429: END
430: }
1.40 albertel 431:
432: $r->print(&Apache::loncommon::end_page());
1.22 albertel 433:
1.1 harris41 434: return OK;
435: }
436:
1.2 harris41 437: # --------------------------------------- Hidden values (returns scalar string)
1.1 harris41 438: sub hidden {
1.58 albertel 439: my ($sel,$title,$filelink,$id) = @_;
1.61 albertel 440: my $string = '<input type="hidden" name="title'.$sel.'" value="'.
441: &escape($title).'" />';
1.48 albertel 442: $filelink=~s|^/ext/|http://|;
1.2 harris41 443: $string .= '<input type="hidden" name="filelink'.$sel.'" value="'.
1.61 albertel 444: &escape($filelink).'" />';
445: $string .= '<input type="hidden" name="id'.$sel.'" value="'.&escape($id).'" />';
1.1 harris41 446: return $string;
447: }
448:
1.2 harris41 449: # --------------------------------------- Moving arrows (returns scalar string)
1.1 harris41 450: sub movers {
1.2 harris41 451: my ($total,$sel) = @_;
452: my $dsel = $sel-1;
453: my $usel = $sel+1;
454: $usel = 1 if $usel > $total;
455: $dsel = $total if $dsel < 1;
1.1 harris41 456: my $string;
1.2 harris41 457: $string = (<<END);
1.1 harris41 458: <table border='0' cellspacing='0' cellpadding='0'>
1.2 harris41 459: <tr><td><a href='javascript:move($sel,$dsel)'>
460: <img src="${iconpath}move_up.gif" alt='UP' border='0' /></a></td></tr>
461: <tr><td><a href='javascript:move($sel,$usel)'>
462: <img src="${iconpath}move_down.gif" alt='DOWN' border='0' /></a></td></tr>
1.1 harris41 463: </table>
464: END
465: return $string;
466: }
1.2 harris41 467:
468: # ------------------------------------------ Select box (returns scalar string)
1.1 harris41 469: sub select_box {
1.2 harris41 470: my ($total,$sel) = @_;
1.1 harris41 471: my $string;
1.2 harris41 472: $string = '<select name="alt'.$sel.'"';
473: $string .= " onChange='selectchange($sel)'>";
1.36 www 474: $string .= "<option name='o0' value='0'>".&mt('discard')."</option>";
1.1 harris41 475: for my $cur (1..$total) {
1.2 harris41 476: $string .= "<option name='o$cur' value='$cur'";
477: if ($cur == $sel) {
478: $string .= "selected";
1.1 harris41 479: }
1.2 harris41 480: $string .= ">$cur</option>";
1.1 harris41 481: }
1.2 harris41 482: $string .= "</select>\n";
1.1 harris41 483: return $string;
484: }
485:
1.37 www 486: # ------------------------------------------------------------------- Checkbox
487:
488: sub checkbox {
489: my $sel=shift;
490: return "<label><input type='checkbox' name='include$sel'".
491: ($env{"form.include$sel"}?' checked="checked"':'').
492: ' />'.&mt('Include').'</label>';
493: }
494:
1.1 harris41 495: 1;
496:
497: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>