--- loncom/interface/groupsort.pm 2001/08/08 03:00:54 1.1 +++ loncom/interface/groupsort.pm 2017/05/30 15:16:38 1.77 @@ -1,70 +1,354 @@ # The LearningOnline Network with CAPA -# # The LON-CAPA group sort handler -# # Allows for sorting prior to import into RAT. # -# YEAR=2001 -# 8/7 Scott Harrison +# $Id: groupsort.pm,v 1.77 2017/05/30 15:16:38 raeburn Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +### package Apache::groupsort; use strict; -use Apache::Constants qw(:common); +use Apache::Constants qw(:common :http); use GDBM_File; +use Apache::loncommon; +use Apache::lonlocal; +use Apache::lonnet; +use LONCAPA qw(:DEFAULT :match); + +my $iconpath; # variable to be accessible to multiple subroutines +my %hash; # variable to tie to user specific database + + +sub update_actions_hash { + my ($hash) = @_; + # be careful in here, there is also a global %hash + my $acts=$env{'form.acts'}; + my @Acts=split(/b/,$acts); + my %ahash; + my %achash; + # some initial hashes for working with data + my $ac=0; + foreach (@Acts) { + my ($state,$ref)=split(/a/); + $ahash{$ref}=$state; + $achash{$ref}=$ac; + $ac++; + } + # sorting through the actions and changing the global database hash + foreach my $key (sort {$achash{$a}<=>$achash{$b}} (keys(%ahash))) { + if ($ahash{$key} eq '1') { + $hash->{'store_'.$hash->{'pre_'.$key.'_link'}}= + $hash->{'pre_'.$key.'_title'}; + $hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}}= + $hash->{'storectr'}+0; + $hash->{'storectr'}++; + } + if ($ahash{$key} eq '0') { + if ($hash->{'store_'.$hash->{'pre_'.$key.'_link'}}) { + delete($hash->{'store_'.$hash->{'pre_'.$key.'_link'}}); + delete($hash->{'storectr_'.$hash->{'pre_'.$key.'_link'}}); + } + } + } + # deleting the previously cached listing + foreach my $key (keys(%{ $hash })) { + next if ($key !~ /^pre_(\d+)_link/); + my $which = $1; + delete($hash->{'pre_'.$which.'_title'}); + delete($hash->{'pre_'.$which.'_link'}); + } +} + +sub readfromdb { + my ($r,$resources)=@_; + + my $diropendb = LONCAPA::tempdir() . + "$env{'user.domain'}_$env{'user.name'}_sel_res.db"; + +# ----------------------------- diropendb is now the filename of the db to open + if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { + &update_actions_hash(\%hash); + + my %temp_resources; + foreach my $key (keys(%hash)) { + next if ($key !~ /^store_/); + my ($url) = ($key =~ /^store_(.*)/); + $temp_resources{$hash{'storectr_'.$url}}{'url'}=$url; + $temp_resources{$hash{'storectr_'.$url}}{'title'}= + &Apache::lonnet::gettitle($url); + } + + # use the temp, since there might be gaps in the counting + foreach my $item (sort {$a <=> $b} (keys(%temp_resources))) { + push(@{ $resources },$temp_resources{$item}); + } + + if ($env{'form.oldval'}) { + my $res = splice(@{$resources},$env{'form.oldval'}-1,1); + if ($env{'form.newval'} == 0) { + # picked 'discard' + my $url = $res->{'url'}; + delete($hash{'storectr_'.$url}); + delete($hash{'store_'.$url}); + } else { + splice(@{$resources},$env{'form.newval'}-1,0,$res); + } + } + # store out new order + foreach my $which (0..$#$resources) { + my $url = $resources->[$which]{'url'}; + $hash{'storectr_'.$url} = $which; + } + } else { + $r->print('Unable to tie hash to db file'); + } + untie(%hash); +} + -my %hash; -my $iconpath; + +sub cleanup { + if (tied(%hash)){ + &Apache::lonnet::logthis('Cleanup groupsort: hash'); + unless (untie(%hash)) { + &Apache::lonnet::logthis('Failed cleanup groupsort: hash'); + } + } + return OK; +} + +# -------------------------------------------------------------- Read from file + +sub readfromfile { + my ($r,$resources)=@_; + my $cont=&Apache::lonnet::getfile + (&Apache::lonnet::filelocation('',$env{'form.readfile'})); + if ($cont==-1) { + $r->print('Unable to read file: '. + &Apache::lonnet::filelocation('',$env{'form.readfile'})); + } else { + my $parser = HTML::TokeParser->new(\$cont); + my ($token,$donechk,$allmaps); + $allmaps = {}; + while ($token = $parser->get_token) { + if ($token->[0] eq 'S') { + if ($token->[1] eq 'resource') { + if ($env{'form.recover'}) { + if ($token->[2]->{'type'} ne 'zombie') { next; } + if ($token->[2]->{'src'} =~ /\.(page|sequence)$/) { + if (($env{'request.course.id'}) && + ($env{'form.readfile'} =~ m{/default(|_\d+)\.(page|sequence)$})) { + unless ($donechk) { + $allmaps = &Apache::loncommon::allmaps_incourse(); + $donechk = 1; + } + } + if ($allmaps->{$token->[2]->{'src'}}) { next; } + } + } else { + if ($token->[2]->{'type'} eq 'zombie') { next; } + } + + my $name=$token->[2]->{'title'}; + $name=~s/ \[\((\d+)\,($LONCAPA::username_re)\,($LONCAPA::domain_re)\)\]$//; + my $note; + if ($1) { + $note = '
'.&mt('Removed by '). + &Apache::loncommon::plainname($2,$3).', '. + &Apache::lonlocal::locallocaltime($1); + } + $name=~s/\&colon\;/\:/g; + push(@{$resources}, {'url' => $token->[2]->{'src'}, + 'title' => $name, + 'note' => $note, + 'id' => $token->[2]->{'id'},}); + } + } + } + } +} + +# ---------------------------------------------------------------- Main Handler sub handler { my $r = shift; - my $fileclr='#ffffe6'; - my $titleclr='#ddffff'; - $r->content_type('text/html'); + + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['acts','mode','readfile','recover']); + + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; - $r->print(< - -The LearningOnline Network With CAPA Group Sorter - - - END + # read pertinent machine configuration my $domain = $r->dir_config('lonDefDomain'); - $iconpath= $r->dir_config('lonIconsURL') . "/"; - my $diropendb = "/home/httpd/perl/tmp/$domain\_$ENV{'user.name'}_indexer.db"; - my %shash; - my %thash; - map { - my ($name, $value) = split(/=/,$_); - $value =~ tr/+/ /; - $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; - if ($name eq 'acts') { - $ENV{'form.'.$name}=$value; - } - } (split(/&/,$ENV{'QUERY_STRING'})); - if (tie(%hash,'GDBM_File',$diropendb,&GDBM_WRCREAT,0640)) { - my $acts=$ENV{'form.acts'}; - my @Acts=split(/b/,$acts); - my %ahash; - my %achash; - my $ac=0; - map { - my ($state,$ref)=split(/a/); - $ahash{$ref}=$state; - $achash{$ref}=$ac; - $ac++; - } (@Acts); - map { - my $key=$_; - if ($ahash{$key} eq '1') { -# $r->print("NEW: "); -# $r->print($hash{'pre_'.$key.'_title'}); -# $r->print(" : "); -# $r->print($hash{'pre_'.$key.'_link'}); -# $r->print("
"); - $hash{'store_'.$hash{'pre_'.$key.'_link'}}= - $hash{'pre_'.$key.'_title'}; - $hash{'storectr_'.$hash{'pre_'.$key.'_link'}}= - $hash{'storectr'}+0; - $hash{'storectr'}++; - } - if ($ahash{$key} eq '0') { - if ($hash{'store_'.$hash{'pre_'.$key.'_link'}}) { - delete $hash{'store_'.$hash{'pre_'.$key.'_link'}}; - } - } - } sort {$achash{$a}<=>$achash{$b}} (keys %ahash); - map { - if ($_ =~ /^store_/) { - my $key=$_; - $key=~s/^store_//; -# $r->print("STORE: "); -# $r->print($hash{'storectr_'.$key}); -# $r->print(':'); -# $r->print($hash{'store_'.$key}); -# $r->print(':'); -# $r->print($key); - $shash{$key}=$hash{'storectr_'.$key}; - $thash{$key}=$hash{'store_'.$key}; -# $r->print("
"); - } - } keys %hash; - if ($ENV{'form.oldval'}) { -# $r->print('TEST TEST'); - my $newctr=0; - my %chash; - map { - my $key=$_; - $newctr++; - $shash{$key}=$newctr; - $hash{'storectr_'.$key}=$newctr; - $chash{$newctr}=$key; - } sort {$shash{$a}<=>$shash{$b}} (keys %shash); - my $oldval=$ENV{'form.oldval'}; - my $newval=$ENV{'form.newval'}; - if ($oldval!=$newval) { - $shash{$chash{$oldval}}=$newval; - $hash{'storectr_'.$chash{$oldval}}=$newval; - if ($oldval<$newval) { # push down - for my $idx ($oldval..($newval-1)) { - $shash{$chash{$idx+1}}=$idx; - $hash{'storectr_'.$chash{$idx+1}}=$idx; - } - } - elsif ($oldval>$newval) { # push up - for my $idx (reverse($newval..($oldval-1))) { - $shash{$chash{$idx}}=$idx+1; - $hash{'storectr_'.$chash{$idx}}=$idx+1; - } - } - } - } + $iconpath = $r->dir_config('lonIconsURL') . "/"; + + my @resources; + + if ($env{'form.readfile'}) { + &readfromfile($r,\@resources); } else { - $r->print('Unable to tie hash to db file'); - return OK; + &readfromdb($r,\@resources); } - untie %hash; -# $r->print($ENV{'form.acts'}); - my $ctr=0; - my $clen=scalar(keys %shash); - $r->print('

The LearningOnline With CAPA Group Sorter

'."\n"); - $r->print('Finalize order of resources'."\n"); - $r->print("
"); - $r->print(< 1) || ($env{'form.readfile'})) { + my %lt=&Apache::lonlocal::texthash( + 'fin'=> 'Finalize order of resources', + 'ci' => 'Continue Import', + 'cs' => 'Continue Search', + 'fi' => 'Finish Import', + 're' => 'Recover Checked', + 'ip' => 'Import Checked', + 'ca' => 'Cancel', + 'co' => 'Change Order', + 'ti' => 'Title', + 'pa' => 'Path', + 'in' => 'Include' + ); + + $r->print(&Apache::loncommon::start_page($title, $js)); + $r->print('

'.&mt($title).'

'); + + $r->print(< -  -  - + + + +END + + $r->print(&Apache::loncommon::inhibit_menu_check('input')); + # --- + + my $buttontext = $lt{'re'}; + if ($env{'form.recover'}) { + $r->print(<  + END - $r->print("
"); - $r->print("\n"); - $r->print("\n"); - $r->print("\n"); - $r->print("\n"); - map { - my $key=$_; + } else { + # --- Continue Buttons + my $resurl = + &Apache::loncommon::escape_single(&Apache::loncommon::lastresurl()); + $r->print(<$lt{'fin'} +
+  +  +  + +
+
+END + } + + # Only display header if content exists + if ($clen > 0) { + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row()); + if (($env{'form.readfile'})) { + $r->print("\n"); + } else { + $r->print(''."\n"); + } + $r->print(''."\n"); + $r->print(""); + $r->print(&Apache::loncommon::end_data_table_header_row()."\n"); + } else { + my $errtxt = ''; + if ($env{'form.recover'}) { + $errtxt = 'There are no resources to recover.'; + } else { + $errtxt = 'There are no resources to import.'; + } + $r->print('

'.&mt($errtxt).'

'); + } + } else { + $r->print(&Apache::loncommon::start_page(undef,$js, + {'only_body' => 1})); +# $r->print('

'.&mt($title).'

'); + $r->print(< + + + + +END + $r->print(&Apache::loncommon::inhibit_menu_check('input')); + + } + foreach my $resource (@resources) { $ctr++; - my @file_ext = split(/\./,$key); - my $curfext = $file_ext[scalar(@file_ext)-1]; - $r->print("\n"); - } sort {$shash{$a}<=>$shash{$b}} (keys %shash); - $r->print("
Change orderTitlePath
$lt{'in'}'.$lt{'co'}.''.$lt{'ti'}.'$lt{'pa'}
"); - $r->print(&movers($clen,$ctr)); - $r->print(&hidden($ctr-1,$thash{$key},$key)); - $r->print(""); - $r->print(&select_box($clen,$ctr)); - $r->print(""); - $r->print(""); - $r->print(""); - $r->print("$thash{$key}\n"); - $r->print("$key
"); - $r->print(< - + my $iconname=&Apache::loncommon::icon($resource->{'url'}); + if (($clen > 1) || ($env{'form.readfile'})) { + $r->print(&Apache::loncommon::start_data_table_row() + .""); + if (($env{'form.readfile'})) { + $r->print(&checkbox($ctr-1,$disabled)); + } else { + $r->print(&movers($clen,$ctr)); + } + } + $r->print(&hidden($ctr-1,$resource->{'title'},$resource->{'url'}, + $resource->{'id'})); + if (($clen > 1) || ($env{'form.readfile'})) { + $r->print(""); + unless (($env{'form.readfile'})) { + $r->print("". + &select_box($clen,$ctr,$disabled). + ""); + } + $r->print(""); + $r->print(""); + $r->print(""); + if (($env{'form.recover'}) && + ($resource->{'url'} =~ m{/uploaded/$match_domain/$match_courseid/supplemental/})) { + my $title = &Apache::loncommon::parse_supplemental_title($resource->{'title'}); + $r->print($title); + } else { + $r->print($resource->{'title'}); + } + $r->print($resource->{'notes'}."\n"); + $r->print($resource->{'url'}."" + .&Apache::loncommon::end_data_table_row() + ."\n"); + } + } + if (($clen > 1) || ($env{'form.readfile'})) { + if ($clen > 0) { + $r->print(&Apache::loncommon::end_data_table()); + } + $r->print(''); + } else { + $r->print(< + finish_import(); + END + } + + $r->print(&Apache::loncommon::end_page()); + return OK; } +# --------------------------------------- Hidden values (returns scalar string) sub hidden { - my ($sel,$title,$filelink)=@_; - my $string=''; - $string.=''; + my ($sel,$title,$filelink,$id) = @_; + my $string = ''; + $filelink=~s|^/ext/|http://|; + $string .= ''; + $string .= ''; return $string; } +# --------------------------------------- Moving arrows (returns scalar string) sub movers { - my ($total,$sel)=@_; - my $dsel=$sel-1; - my $usel=$sel+1; - $usel=1 if $usel>$total; - $dsel=$total if $dsel<1; + my ($total,$sel) = @_; + my $dsel = $sel-1; + my $usel = $sel+1; + $usel = 1 if $usel > $total; + $dsel = $total if $dsel < 1; my $string; - $string=< -UP -DOWN + +UP + +DOWN END return $string; } -1; + +# ------------------------------------------ Select box (returns scalar string) sub select_box { - my ($total,$sel)=@_; + my ($total,$sel,$disabled) = @_; my $string; - $string=''.&mt('Include').''; +} + 1; __END__ +=pod + +=head1 NAME + +Apache::groupsort.pm + +=head1 SYNOPSIS + +Implements a second phase of importing +multiple resources into the RAT. Allows for +reordering the sequence of resources + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 NOTABLE SUBROUTINES + +=over + +=item + +=back + +=cut +