--- loncom/interface/portfolio.pm 2006/08/11 23:45:18 1.153 +++ loncom/interface/portfolio.pm 2006/11/01 02:03:16 1.167 @@ -1,7 +1,7 @@ # The LearningOnline Network # portfolio browser # -# $Id: portfolio.pm,v 1.153 2006/08/11 23:45:18 banghart Exp $ +# $Id: portfolio.pm,v 1.167 2006/11/01 02:03:16 rezaferry Exp $ # # Copyright Michigan State University Board of Trustees # @@ -95,6 +95,13 @@ sub display_common { 'createdir_label' => 'Create subdirectory in current directory:'); my $escuri = &HTML::Entities::encode($r->uri,'&<>"'); + my $help_fileupload = &Apache::loncommon::help_open_topic('Portfolio AddFiles'); + my $help_createdir = &Apache::loncommon::help_open_topic('Portfolio CreateDirectory'); + + # TO BE DEPRECATED: This line should be deleted once Portfolio uses breadcrumbs + $r->print(&Apache::loncommon::help_open_topic('Portfolio About', 'Help on the portfolio')); + # END LINE TO BE DEPRECATED + $r->print(<<"TABLE"); <table id="LC_portfolio_actions"> <tr id="LC_portfolio_upload"> @@ -109,7 +116,7 @@ sub display_common { <input type="hidden" name="action" value="$env{"form.action"}" /> <input type="hidden" name="fieldname" value="$env{"form.fieldname"}" /> <input type="hidden" name="mode" value="$env{"form.mode"}" /> - <input type="submit" name="storeupl" value="$text{'upload'}" /> + <input type="submit" name="storeupl" value="$text{'upload'}" />$help_fileupload </form> </td> </tr> @@ -124,7 +131,7 @@ sub display_common { <input type="hidden" name="action" value="$env{"form.action"}" /> <input type="hidden" name="fieldname" value="$env{"form.fieldname"}" /> <input type="hidden" name="mode" value="$env{"form.mode"}" /> - <input type="submit" name="createdir" value="$text{'createdir'}" /> + <input type="submit" name="createdir" value="$text{'createdir'}" />$help_createdir </form> </td> </tr> @@ -155,6 +162,7 @@ TABLE } } $r->print('</span>'); + $r->print(&Apache::loncommon::help_open_topic('Portfolio ChangeDirectory')); &Apache::lonhtmlcommon::store_recent($namespace,$current_path,$current_path); $r->print('<br /><form method="post" action="'.$url.'?mode='.$env{"form.mode"}.'&fieldname='.$env{"form.fieldname"}.&group_args()); $r->print('">'. @@ -164,17 +172,41 @@ TABLE } sub display_directory_line { - my ($r,$select_mode,$fullpath, $filename, $mtime, $size, $css_class, + my ($r,$select_mode, $filename, $mtime, $size, $css_class, $line, $access_controls, $curr_access, $now, $version_flag, $href_location, $url, $current_path, $access_admin_text, $versions)=@_; - # my ($filename,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef)=split(/\&/,$line,16); + + my $fullpath = &prepend_group($current_path.$filename); $r->print('<tr class="'.$css_class.'">'); $r->print($line); # contains first two cells of table - if ($$version_flag{$filename}) { # versioned can't be versioned, so TRUE when root file + my $lock_info; + if ($version_flag) { # versioned can't be versioned, so TRUE when root file $r->print('<td><img alt="" src="'.&Apache::loncommon::icon($filename).'" /></td>'); - $r->print('<td>'.$$version_flag{$filename}.'</td>'); + $r->print('<td>'.$version_flag.'</td>'); } else { # this is a graded or handed back file - $r->print('<td colspan="2"> </td>'); + my ($user,$domain) = &get_name_dom(); + my $permissions_hash = &Apache::lonnet::get_portfile_permissions($domain,$user); + if (defined($$permissions_hash{$fullpath})) { + foreach my $array_item (@{$$permissions_hash{$fullpath}}) { + if (ref($array_item) eq 'ARRAY') { + if ($$array_item[-1] eq 'handback') { + $lock_info = 'Handback'; + } elsif ($$array_item[-1] eq 'graded') { + $lock_info = 'Graded'; + } + } + } + } + if ($lock_info) { + my %anchor_fields = ('lockinfo' => $fullpath); + if ($versions) { # hold the folder open + my ($fname,$version,$extension) = &Apache::grades::file_name_version_ext($fullpath); + $fname =~ s|^/||; + $anchor_fields{'showversions'} = $fname.'.'.$extension; + } + $lock_info = &make_anchor(undef,\%anchor_fields,$lock_info); + } + $r->print('<td colspan="2">'.$lock_info.'</td>'); } # $r->print('<td>'.$$version_flag{$filename}.'</td><td>'); $r->print('<td>'.&make_anchor($href_location.$filename,undef,$filename).'</td>'); @@ -235,15 +267,19 @@ sub display_directory { '<tr><th>Select</th><th> </th><th> </th><th>Name</th><th>Size</th><th>Last Modified</th></tr>'); } else { $r->print('<form method="post" action="'.$url.'">'); + $r->print(&Apache::loncommon::help_open_topic('Portfolio FileList', 'Using the portfolio file list')); $r->print('<table id="LC_browser">'. - '<tr><th colspan="2">Actions</th><th> </th><th> </th><th>Name</th><th>Size</th><th>Last Modified</th><th>Current Access Status</th></tr>'); + '<tr><th colspan="2">Actions</th><th> </th><th> </th><th>Name'. + &Apache::loncommon::help_open_topic('Portfolio OpenFile'). + '</th><th>Size</th><th>Last Modified</th><th>Current Access Status'. + &Apache::loncommon::help_open_topic('Portfolio ShareFile'). + '</th></tr>'); } $r->print("\n".&group_form_data()."\n"); my $href_location="/uploaded/$udom/$uname/$port_path".$current_path; my $href_edit_location="/editupload/$udom/$uname/$port_path".$current_path; my @dir_lines; - my @version_lines; my %versioned; foreach my $dir_line (sort { @@ -257,8 +293,9 @@ sub display_directory { $filename =~ s/\s+$//; my ($fname,$version,$extension) = &Apache::grades::file_name_version_ext($filename); if ($version) { - push(@version_lines, [$filename,$dom,$testdir,$size,$mtime,$obs]); - $versioned{$fname.'.'.$extension} .= $version.","; + my $fullpath = &prepend_group($current_path.$fname.'.'.$extension); + push(@{ $versioned{$fullpath} }, + [$filename,$dom,$testdir,$size,$mtime,$obs,]); } else { push(@dir_lines, [$filename,$dom,$testdir,$size,$mtime,$obs]); } @@ -267,27 +304,33 @@ sub display_directory { my ($filename,$dom,$testdir,$size,$mtime,$obs) = @$dir_line; my ($fname,$version,$extension) = &Apache::grades::file_name_version_ext($filename); if (($filename ne '.') && ($filename ne '..') && ($filename !~ /\.meta$/ ) && ($filename !~ /(.*)\.(\d+)\.([^\.]*)$/)) { - my %version_flag; + my $version_flag; my $show_versions; - if ($env{'form.showversions'} eq $filename) { + my $fullpath = &prepend_group($current_path.$filename); + if ($env{'form.showversions'} =~ /$filename/) { $show_versions = 'true'; } - if (exists($versioned{$filename})) { + if (exists($versioned{$fullpath})) { my %anchor_fields = ( - 'selectfile' => $filename, + 'selectfile' => $fullpath, 'continue' => 'false', 'currentpath' => $current_path, ); if ($show_versions) { - $version_flag{$filename} = &make_anchor('portfolio',\%anchor_fields, + # Must preserve other possible showversion files + my $version_remainder = $env{'form.showversions'}; + $version_remainder =~ s/$filename//g; + $anchor_fields{'showversions'} = $version_remainder; + $version_flag = &make_anchor('portfolio',\%anchor_fields, '<img class="LC_icon" alt="'.&mt('opened folder').'" src="'.$iconpath.'folder_pointer_opened.gif" />'); } else { - $anchor_fields{'showversions'} = $filename; - $version_flag{$filename} = &make_anchor('portfolio',\%anchor_fields, + # allow multiple files to show versioned + $anchor_fields{'showversions'} = $env{'form.showversions'}.','.$filename; + $version_flag = &make_anchor('portfolio',\%anchor_fields, '<img class="LC_icon" alt="'.&mt('closed folder').'" src="'.$iconpath.'folder_pointer_closed.gif" />'); } } else { - $version_flag{$filename} = ' '; + $version_flag = ' '; } if ($dirptr&$testdir) { my $colspan='colspan="2"'; @@ -303,13 +346,11 @@ sub display_directory { 'fieldname' => $env{"form.fieldname"}, 'continue' => $env{"form.continue"} ); - $r->print('<td>'.$version_flag{$filename}.'</td><td>'.&make_anchor($url,\%anchor_fields,$filename.'/').'</td>'); + $r->print('<td>'.$version_flag.'</td><td>'.&make_anchor($url,\%anchor_fields,$filename.'/').'</td>'); $r->print('</tr>'); } else { my $css_class = 'LC_browser_file'; my $line; - my $fullpath = $current_path.$filename; - $fullpath = &prepend_group($fullpath); if ($select_mode eq 'true') { $line='<td><input type="checkbox" name="checkfile" value="'.$filename.'"'; if ($$checked_files{$filename} eq 'selected') { @@ -319,7 +360,7 @@ sub display_directory { } else { if (exists $locked_files{$fullpath}) { my %anchor_fields = ( - 'lockinfo' => $current_path.$filename + 'lockinfo' => $fullpath ); $line.='<td colspan="2">'.&make_anchor($url,\%anchor_fields,'Locked').'</td>'; $css_class= 'LC_browser_file_locked'; @@ -340,7 +381,7 @@ sub display_directory { currentpath => $current_path ); $line .= &make_anchor($url,\%anchor_fields,'Rename'); - $line .= '</td><td>'.&make_anchor($href_edit_location.$filename.'.meta',undef,$cat); + $line .= '</td><td>'.&make_anchor($href_edit_location.$filename.'.meta',\%anchor_fields,$cat); # '<a href="'.$href_edit_location.$filename.'.meta">'.$cat.'</a>'; } $line .= '</td>'; @@ -379,19 +420,17 @@ sub display_directory { $curr_access = join('+ ',@allaccesses); } } - &display_directory_line($r,$select_mode,$fullpath, $filename, $mtime, $size, $css_class, $line, - \%access_controls, $curr_access,$now, \%version_flag, $href_location, + &display_directory_line($r,$select_mode, $filename, $mtime, $size, $css_class, $line, + \%access_controls, $curr_access,$now, $version_flag, $href_location, $url, $current_path, $access_admin_text); if ($show_versions) { - foreach my $dir_line (@version_lines) { - my ($v_filename,$dom,$testdir,$size,$mtime,$obs) = @$dir_line; - my ($v_fname,$version,$v_extension) = &Apache::grades::file_name_version_ext($v_filename); + foreach my $dir_line (@{ $versioned{$fullpath} }) { + my ($v_filename,$dom,$testdir,$size,$mtime,$obs) = + @$dir_line; $line = '<td colspan="2"> </td>'; - if (($v_fname eq $fname)&&($v_extension eq $extension)) { - &display_directory_line($r,$select_mode,$fullpath, $v_filename, $mtime, $size, - $css_class, $line, \%access_controls, $curr_access, $now, - \%version_flag, $href_location, $url, $current_path, $access_admin_text, 1); - } + &display_directory_line($r,$select_mode, $v_filename, $mtime, $size, + $css_class, $line, \%access_controls, $curr_access, $now, + undef, $href_location, $url, $current_path, $access_admin_text, 1); } } } @@ -410,7 +449,8 @@ sub display_directory { $r->print('</table>'); if ($can_delete) { $r->print(' - <input type="submit" name="doit" value="Delete Checked Files" /> + <input type="submit" name="doit" value="Delete Checked Files" />'. + &Apache::loncommon::help_open_topic('Portfolio DeleteFile').' <input type="hidden" name="action" value="delete" /> <input type="hidden" name="currentpath" value="'.$current_path.'" /> </form>' @@ -480,6 +520,7 @@ sub done { $message='Done'; } my %anchor_fields = ( + 'showversions' => $env{'form.showversions'}, 'currentpath' => $env{'form.currentpath'}, 'fieldname' => $env{'form.fieldname'}, 'mode' => $env{'form.mode'} @@ -511,18 +552,55 @@ sub delete { } sub delete_confirmed { - my ($r,$url)=@_; + my ($r,$url,$group)=@_; my @files=&Apache::loncommon::get_env_multiple('form.selectfile'); my $result; my ($uname,$udom) = &get_name_dom(); my $port_path = &get_port_path(); + my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom, + $uname); foreach my $delete_file (@files) { $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path. $env{'form.currentpath'}. $delete_file); if ($result ne 'ok') { - $r->print('<span class="LC_error"> An error occured ('.$result. - ') while trying to delete '.&display_file(undef, $delete_file).'</span><br />'); + $r->print('<span class="LC_error">'. + &mt('An error occured ([_1]) while trying to delete + [_2].',$result,&display_file(undef, $delete_file)). + '</span><br /><br />'); + } else { + $r->print(&mt('File: [_1] deleted.', + &display_file(undef,$delete_file))); + my $file_name = $env{'form.currentpath'}.$delete_file; + $file_name = &prepend_group($file_name); + my %access_controls = + &Apache::lonnet::get_access_controls($current_permissions, + $group,$file_name); + if (keys(%access_controls) > 0) { + my %changes; + foreach my $key (keys(%{$access_controls{$file_name}})) { + $changes{'delete'}{$key} = 1; + } + if (keys(%changes) > 0) { + my ($outcome,$deloutcome,$new_values,$translation) = + &Apache::lonnet::modify_access_controls($file_name,\%changes, + $udom,$uname); + if ($outcome ne 'ok') { + $r->print('<br />'.&mt("An error occured ([_1]) while ". + "trying to delete access controls for the file.",$outcome). + '</span><br /><br />'); + } else { + if ($deloutcome eq 'ok') { + $r->print('<br />'.&mt('Access controls also deleted for the file.').'<br /><br />'); + } else { + $r->print('<span class="LC_error">'.'<br />'. + &mt("An error occured ([_1]) while ". + "trying to delete access controls for the file.",$deloutcome). + '</span><br /><br />'); + } + } + } + } } } $r->print(&done(undef,$url)); @@ -581,7 +659,7 @@ sub rename { } sub rename_confirmed { - my ($r,$url)=@_; + my ($r,$url,$group)=@_; my $filenewname=&Apache::lonnet::clean_filename($env{'form.filenewname'}); my ($uname,$udom) = &get_name_dom(); my $port_path = &get_port_path(); @@ -592,24 +670,79 @@ sub rename_confirmed { $r->print(&done(undef,$url)); return; } + my $chg_access; my $result= &Apache::lonnet::renameuserfile($uname,$udom, $port_path.$env{'form.currentpath'}.$env{'form.selectfile'}, $port_path.$env{'form.currentpath'}.$filenewname); - if ($result ne 'ok') { + if ($result eq 'ok') { + $chg_access = &access_for_renamed($filenewname,$group,$udom,$uname); + } else { $r->print('<span class="LC_error">'. - &mt('An errror occured ([_1]) while trying to rename [_2]' + &mt('An error occured ([_1]) while trying to rename [_2]' .' to [_3]',$result,&display_file(), &display_file('',$filenewname)).'</span><br />'); + return; } if ($filenewname ne $env{'form.filenewname'}) { $r->print(&mt("The new file name was changed from:<br />[_1] to [_2]", '<strong>'.&display_file('',$env{'form.filenewname'}).'</strong>', '<strong>'.&display_file('',$filenewname).'</strong>')); } + $r->print($chg_access); $r->print(&done(undef,$url)); } +sub access_for_renamed { + my ($filenewname,$group,$udom,$uname) = @_; + my $oldfile = $env{'form.currentpath'}.$env{'form.selectfile'}; + $oldfile = &prepend_group($oldfile); + my $newfile = $env{'form.currentpath'}.$filenewname; + $newfile = &prepend_group($newfile); + my $current_permissions = + &Apache::lonnet::get_portfile_permissions($udom,$uname); + my %access_controls = + &Apache::lonnet::get_access_controls($current_permissions, + $group,$oldfile); + my $chg_text; + if (keys(%access_controls) > 0) { + my %change_old; + my %change_new; + foreach my $key (keys(%{$access_controls{$oldfile}})) { + $change_old{'delete'}{$key} = 1; + $change_new{'activate'}{$key} = $access_controls{$oldfile}{$key}; + } + my ($outcome,$deloutcome,$new_values,$translation) = + &Apache::lonnet::modify_access_controls($oldfile,\%change_old, + $udom,$uname); + if ($outcome ne 'ok') { + $chg_text ='<br /><br />'.&mt("An error occured ([_1]) while ". + "trying to delete access control records for the old name.",$outcome). + '</span><br />'; + } else { + if ($deloutcome ne 'ok') { + $chg_text = '<br /><br /><span class="LC_error"><br />'. + &mt("An error occured ([_1]) while ". + "trying to delete access control records for the old name.",$deloutcome). + '</span><br />'; + } + } + ($outcome,$deloutcome,$new_values,$translation) = + &Apache::lonnet::modify_access_controls($newfile,\%change_new, + $udom,$uname); + if ($outcome ne 'ok') { + $chg_text .= '<br /><br />'. + &mt("An error occured ([_1]) while ". + "trying to update access control records for the new name.",$outcome). + '</span><br />'; + } + if ($chg_text eq '') { + $chg_text = '<br /><br />'.&mt('Access controls updated to reflect the name change.'); + } + } + return $chg_text; +} + sub display_access { my ($r,$url,$group,$can_setacl,$port_path) = @_; my ($uname,$udom) = &get_name_dom(); @@ -620,23 +753,21 @@ sub display_access { my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group,$file_name); my $aclcount = keys(%access_controls); my $header = '<h3>'.&mt('Allowing others to retrieve file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).'</h3>'; - my $info .= &mt('Access to this file by others can be set to be one or '); - $info .= &mt('more of the following types: public, passphrase-protected or conditional.'); + my $info .= &mt('Access to this file by others can be set to be one or more of the following types: public, passphrase-protected or conditional.'); $info .= '<br /><ul><li>'.&mt('Public files are available to anyone without the need for login.'); - $info .= '</li><li>'.&mt('Passphrase-protected files do not require log-in, but will require '); - $info .= &mt('the viewer to enter the passphrase you set.'); - $info .= '</li><li>'.&mt('Conditional files are accessible to logged-in users with accounts '); - $info .= &mt('in the LON-CAPA network, who satisfy the conditions you set.').'<br />'; - $info .= &mt('The conditions can include affiliation with a particular course or group, '); - $info .= &mt('or a user account in a specific domain.').'<br />'; + $info .= '</li><li>'.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.'); + $info .= '</li><li>'.&mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').'<br />'; + $info .= &mt('The conditions can include affiliation with a particular course or group, or a user account in a specific domain.').'<br />'; $info .= &mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').'</li></ul>'; if ($group eq '') { - $info .= (&mt("Direct others to the 'Display file listing' link (shown when there are viewable files) on your personal information page:<br /><a href='/adm/$udom/$uname/aboutme'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme</a>")); + $info .= (&mt("A listing of files viewable without log-in is available at: <a href='/adm/$udom/$uname/aboutme/portfolio'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme/portfolio</a>.<br />For logged in users a 'Display file listing' link will also appear (when there are viewable files) on your personal information page:<br /><a href='/adm/$udom/$uname/aboutme'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme</a><br />")); } - if ($can_setacl) { &open_form($r,$url); $r->print($header.$info); + $r->print ('<br/>'.&Apache::loncommon::help_open_topic('Portfolio ShareFile SetAccess', 'Help on setting up share access')); + $r->print (&Apache::loncommon::help_open_topic('Portfolio ShareFile ChangeSetting', 'Help on changing settings')); + $r->print (&Apache::loncommon::help_open_topic('Portfolio ShareFile StopAccess', 'Help on removing share access')); &access_setting_table($r,$access_controls{$file_name}); my $button_text = { 'continue' => &mt('Proceed'), @@ -1591,24 +1722,35 @@ sub lock_info { $file_name = &prepend_group($file_name); if (defined($file_name) && defined($$current_permissions{$file_name})) { foreach my $array_item (@{$$current_permissions{$file_name}}) { - if (ref($array_item) eq 'ARRAY') { - my $filetext; - if (defined($group)) { - $filetext = '<strong>'.$env{'form.lockinfo'}. - '</strong> (group: '.$group.')'; - } else { - $filetext = '<strong>'.$file_name.'</strong>'; - } - $r->print(&mt('[_1] was submitted in response to problem: ', - $filetext). - '<strong>'.&Apache::lonnet::gettitle($$array_item[0]). - '</strong><br />'); - my %course_description = &Apache::lonnet::coursedescription($$array_item[1]); - $r->print(&mt('In the course: <strong>[_1]</strong><br />', - $course_description{'description'})); - # $r->print('the third is '.$$array_item[2].'<br>'); - # $r->print("item is $$array_item[0]<br> and $$array_item[0]"); - } + next if (ref($array_item) ne 'ARRAY'); + + my $filetext; + if (defined($group)) { + $filetext = '<strong>'.$env{'form.lockinfo'}. + '</strong> (group: '.$group.')'; + } else { + $filetext = '<strong>'.$file_name.'</strong>'; + } + + my $title ='<strong>'.&Apache::lonnet::gettitle($$array_item[0]). + '</strong><br />'; + if ($$array_item[-1] eq 'graded') { + $r->print(&mt('[_1] was submitted in response to problem: [_2]', + $filetext,$title)); + } elsif ($$array_item[-1] eq 'handback') { + $r->print(&mt('[_1] was handed back in response to problem: [_2]', + $filetext,$title)); + } else { + # submission style lock + $r->print(&mt('[_1] was submitted in response to problem: [_2]', + $filetext,$title)); + } + my %course_description = + &Apache::lonnet::coursedescription($$array_item[1]); + if ( $course_description{'description'} ne '') { + $r->print(&mt('In the course: <strong>[_1]</strong><br />', + $course_description{'description'})); + } } } $r->print(&done('Back',$url)); @@ -1654,13 +1796,19 @@ sub createdir { } sub get_portfolio_root { - my ($uname,$udom) = &get_name_dom(); - my $path; - if (defined($env{'form.group'})) { - $path = '/userfiles/groups/'.$env{'form.group'}.'/portfolio'; - } else { - $path = '/userfiles/portfolio'; + my ($udom,$uname,$group) = @_; + if (!(defined($udom)) || !(defined($uname))) { + ($uname,$udom) = &get_name_dom(); + } + my $path = '/userfiles/portfolio'; + if (!defined($group)) { + if (defined($env{'form.group'})) { + $group = $env{'form.group'}; + } } + if (defined($group)) { + $path = '/userfiles/groups/'.$group.'/portfolio'; + } return (&Apache::loncommon::propath($udom,$uname).$path); } @@ -1901,7 +2049,7 @@ sub handler { } } elsif ($env{'form.action'} eq 'delete' && $env{'form.confirmed'}) { if ($can_delete) { - &delete_confirmed($r,$url); + &delete_confirmed($r,$url,$group); } else { &missing_priv($r,$url,'delete'); } @@ -1925,7 +2073,7 @@ sub handler { } } elsif ($env{'form.action'} eq 'rename' && $env{'form.confirmed'}) { if ($can_modify) { - &rename_confirmed($r,$url); + &rename_confirmed($r,$url,$group); } else { &missing_priv($r,$url,'rename'); }