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.63 2008/12/01 19:12:37 jms 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: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
311: my %lt=&Apache::lonlocal::texthash(
312: 'fin'=> 'Finalize order of resources',
313: 'ci' => 'Continue Import',
314: 'cs' => 'Continue Search',
315: 'fi' => 'Finish Import',
316: 're' => 'Recover Checked',
317: 'ca' => 'Cancel',
318: 'co' => 'Change Order',
319: 'ti' => 'Title',
320: 'pa' => 'Path',
321: 'in' => 'Include'
322: );
323: my $title = ($env{'form.recover'}) ? 'Recover Removed Resources'
324: : 'Sort Imported Resources';
325: $r->print(&Apache::loncommon::start_page($title, $js));
326:
327: $r->print(<<END);
328: <form method='post' action='/adm/groupsort' name='groupsort'
329: enctype='application/x-www-form-urlencoded'>
330: <input type="hidden" name="fnum" value="$clen" />
331: <input type="hidden" name="oldval" value="" />
332: <input type="hidden" name="newval" value="" />
333: <input type="hidden" name="mode" value="$env{'form.mode'}" />
334: <input type="hidden" name="readfile" value="$env{'form.readfile'}" />
335: <input type="hidden" name="bookmarks" value="$env{'form.bookmarks'}" />
336: <input type="hidden" name="recover" value="$env{'form.recover'}" />
337: END
338:
339: $r->print(&Apache::loncommon::inhibit_menu_check('input'));
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 {
349: # --- Continue Buttons
350: my $resurl =
351: &Apache::loncommon::escape_single(&Apache::loncommon::lastresurl());
352: $r->print(<<END);
353: <h2>$lt{'fin'}</h2>
354: <div>
355: <input type="button" name="alter" value="$lt{'ci'}"
356: onClick="window.location='$resurl?inhibitmenu=yes&catalogmode=import'" />
357: <input type="button" name="altersearch" value="$lt{'cs'}"
358: onClick="window.location='/adm/searchcat?inhibitmenu=yes&catalogmode=import'" />
359: <input type="button" name="alter" value="$lt{'fi'}"
360: onClick="finish_import()" />
361: <input type="button" name="alter" value="$lt{'ca'}" onClick="self.close()" />
362: </div>
363: <br />
364: END
365: }
366: $r->print(&Apache::loncommon::start_data_table()
367: .&Apache::loncommon::start_data_table_header_row());
368: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
369: $r->print("<th>$lt{'in'}</th>\n");
370: } else {
371: $r->print("<th colspan='2'>$lt{'co'}</th>\n");
372: }
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");
377: } else {
378: $r->print(&Apache::loncommon::start_page(undef,$js,
379: {'only_body' => 1}));
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="" />
386: <input type="hidden" name="mode" value="$env{'form.mode'}" />
387: END
388: $r->print(&Apache::loncommon::inhibit_menu_check('input'));
389:
390: }
391: foreach my $resource (@resources) {
392: $ctr++;
393: my $iconname=&Apache::loncommon::icon($resource->{'url'});
394: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
395: $r->print(&Apache::loncommon::start_data_table_row()
396: ."<td>");
397: if (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
398: $r->print(&checkbox($ctr-1));
399: } else {
400: $r->print(&movers($clen,$ctr));
401: }
402: }
403: $r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'},
404: $resource->{'id'}));
405: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
406: $r->print("</td>");
407: unless (($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
408: $r->print("<td>".
409: &select_box($clen,$ctr).
410: "</td>");
411: }
412: $r->print("<td>");
413: $r->print("<img src='$iconname' />");
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");
419: }
420: }
421: if (($clen > 1) || ($env{'form.readfile'}) || ($env{'form.bookmarks'})) {
422: $r->print(&Apache::loncommon::end_data_table()
423: ."</form>");
424: } else {
425: $r->print(<<END);
426: <script type="text/javascript">
427: finish_import();
428: </script>
429: END
430: }
431:
432: $r->print(&Apache::loncommon::end_page());
433:
434: return OK;
435: }
436:
437: # --------------------------------------- Hidden values (returns scalar string)
438: sub hidden {
439: my ($sel,$title,$filelink,$id) = @_;
440: my $string = '<input type="hidden" name="title'.$sel.'" value="'.
441: &escape($title).'" />';
442: $filelink=~s|^/ext/|http://|;
443: $string .= '<input type="hidden" name="filelink'.$sel.'" value="'.
444: &escape($filelink).'" />';
445: $string .= '<input type="hidden" name="id'.$sel.'" value="'.&escape($id).'" />';
446: return $string;
447: }
448:
449: # --------------------------------------- Moving arrows (returns scalar string)
450: sub movers {
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;
456: my $string;
457: $string = (<<END);
458: <table border='0' cellspacing='0' cellpadding='0'>
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>
463: </table>
464: END
465: return $string;
466: }
467:
468: # ------------------------------------------ Select box (returns scalar string)
469: sub select_box {
470: my ($total,$sel) = @_;
471: my $string;
472: $string = '<select name="alt'.$sel.'"';
473: $string .= " onChange='selectchange($sel)'>";
474: $string .= "<option name='o0' value='0'>".&mt('discard')."</option>";
475: for my $cur (1..$total) {
476: $string .= "<option name='o$cur' value='$cur'";
477: if ($cur == $sel) {
478: $string .= "selected";
479: }
480: $string .= ">$cur</option>";
481: }
482: $string .= "</select>\n";
483: return $string;
484: }
485:
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:
495: 1;
496:
497: __END__
498:
499: =pod
500:
501: =head1 NAME
502:
503: Apache::groupsort.pm
504:
505: =head1 SYNOPSIS
506:
507: Implements a second phase of importing
508: multiple resources into the RAT. Allows for
509: reordering the sequence of resources
510:
511: This is part of the LearningOnline Network with CAPA project
512: described at http://www.lon-capa.org.
513:
514:
515: =head1 NOTABLE SUBROUTINES
516:
517: =over
518:
519: =item
520:
521: =back
522:
523: =cut
524:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>