--- loncom/interface/portfolio.pm 2004/06/25 20:50:05 1.7
+++ loncom/interface/portfolio.pm 2006/08/04 20:41:32 1.144
@@ -1,3 +1,8 @@
+# The LearningOnline Network
+# portfolio browser
+#
+# $Id: portfolio.pm,v 1.144 2006/08/04 20:41:32 albertel Exp $
+#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
@@ -18,12 +23,9 @@
#
# /home/httpd/html/adm/gpl.txt
#
-
-
# http://www.lon-capa.org/
#
-
package Apache::portfolio;
use strict;
use Apache::Constants qw(:common :http);
@@ -32,221 +34,1914 @@ use Apache::lonnet;
use Apache::lontexconvert;
use Apache::lonfeedback;
use Apache::lonlocal;
-sub makeAnchor{
- # receives a file name assumed to reside in username/userfiles/portfolio/
- # returns a form consisting of a single submit button labeled with the file name
- my ($fileName, $currentPath) = @_;
- my $anchor = ''.$fileName.'';
-# my $button = '
-#
-# ';
- return $anchor;
-}
-sub displayDirectory {
- # returns html with separated contents of the directory
- # returns a currentFile (bolds the selected file/dir)
-
- my ($currentPath, $currentFile, $isDir, @dirList,) = @_;
- my $displayOut='';
- my $fileName;
- my $upPath;
- if ($currentPath ne '/'){
- $displayOut = 'Listing of '.$currentPath.' '.
- # provides the "up one directory level" function
- # it means shortening the currentpath to the parent directory
- $currentPath =~ m:(^/.*)(/.*/$):;
- if ($1 ne '/'){
- $upPath = $1.'/';
- }else{
- $upPath = $1;
+use Apache::lonnet;
+use Apache::longroup;
+use Apache::lonhtmlcommon;
+use HTML::Entities;
+use LONCAPA;
+
+sub group_args {
+ my $output;
+ if (defined($env{'form.group'})) {
+ $output .= '&group='.$env{'form.group'};
+ if (defined($env{'form.ref'})) {
+ $output .= '&ref='.$env{'form.ref'};
+ }
+ }
+ return $output;
+}
+
+sub group_form_data {
+ my $output;
+ if (defined($env{'form.group'})) {
+ $output = '';
+ if (exists($env{'form.ref'})) {
+ $output .= '';
+ }
+ }
+ return $output;
+}
+
+# receives a file name and path stub from username/userfiles/portfolio/
+# returns an anchor tag consisting encoding filename and currentpath
+sub make_anchor {
+ my ($url, $filename, $current_path, $current_mode, $field_name,
+ $continue_select) = @_;
+ if ($continue_select ne 'true') {$continue_select = 'false'};
+ my $anchor = ''.$filename.'';
+ return $anchor;
+}
+
+my $dirptr=16384;
+sub display_common {
+ my ($r,$url,$current_path,$is_empty,$dir_list,$can_upload)=@_;
+ my $namespace = &get_namespace();
+ my $port_path = &get_port_path();
+ if ($can_upload) {
+ my $groupitem = &group_form_data();
+
+ my $iconpath= $r->dir_config('lonIconsURL') . "/";
+ my %text=&Apache::lonlocal::texthash(
+ 'upload' => 'Upload',
+ 'upload_label' =>
+ 'Upload file to current directory:',
+ 'createdir' => 'Create Subdirectory',
+ 'createdir_label' =>
+ 'Create subdirectory in current directory:');
+ my $escuri = &HTML::Entities::encode($r->uri,'&<>"');
+ $r->print(<<"TABLE");
+
');
+ &close_form($r,$url);
+ } else {
+ $r->print("No file was checked to delete. ");
+ $r->print(&done(undef,$url));
+ }
+ }
+}
+
+sub delete_confirmed {
+ my ($r,$url)=@_;
+ my @files=&Apache::loncommon::get_env_multiple('form.selectfile');
+ my $result;
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
+ foreach my $delete_file (@files) {
+ $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
+ $env{'form.currentpath'}.
+ $delete_file);
+ if ($result ne 'ok') {
+ $r->print(' An error occured ('.$result.
+ ') while trying to delete '.&display_file(undef, $delete_file).' ');
+ }
+ }
+ $r->print(&done(undef,$url));
+}
+
+sub delete_dir {
+ my ($r,$url)=@_;
+ &open_form($r,$url);
+ $r->print('
'.&mt('Delete').' '.&display_file().'?
');
+ &close_form($r,$url);
+}
+
+sub delete_dir_confirmed {
+ my ($r,$url)=@_;
+ my $directory_name = $env{'form.currentpath'};
+ $directory_name =~ s|/$||; # remove any trailing slash
+ my ($uname,$udom) = &get_name_dom();
+ my $namespace = &get_namespace();
+ my $port_path = &get_port_path();
+ my $result=&Apache::lonnet::removeuserfile($uname,$udom,$port_path.
+ $directory_name);
+
+ if ($result ne 'ok') {
+ $r->print(' An error occured (dir) ('.$result.
+ ') while trying to delete '.$directory_name.' ');
+ } else {
+ # now remove from recent
+# $r->print(' removing '.$directory_name.' print(&done(undef,$url));
+}
+
+sub rename {
+ my ($r,$url)=@_;
+ my $file_name = $env{'form.currentpath'}.$env{'form.rename'};
+ my ($uname,$udom) = &get_name_dom();
+ $file_name = &prepend_group($file_name);
+ if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
+ $r->print ("The file is locked and cannot be renamed. ");
+ $r->print(&done(undef,$url));
+ } else {
+ &open_form($r,$url);
+ $r->print('
'.&mt('Rename').' '.&display_file().' to
+ ?
');
+ &close_form($r,$url);
+ }
+}
+
+sub rename_confirmed {
+ my ($r,$url)=@_;
+ my $filenewname=&Apache::lonnet::clean_filename($env{'form.filenewname'});
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
+ if ($filenewname eq '') {
+ $r->print(''.
+ &mt("Error: no valid filename was provided to rename to.").
+ ' ');
+ $r->print(&done(undef,$url));
+ return;
+ }
+ 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') {
+ $r->print(''.
+ &mt('An errror occured ([_1]) while trying to rename [_2]'
+ .' to [_3]',$result,&display_file(),
+ &display_file('',$filenewname)).' ');
+ }
+ if ($filenewname ne $env{'form.filenewname'}) {
+ $r->print(&mt("The new file name was changed from: [_1] to [_2]",
+ ''.&display_file('',$env{'form.filenewname'}).'',
+ ''.&display_file('',$filenewname).''));
+ }
+ $r->print(&done(undef,$url));
+}
+
+sub display_access {
+ my ($r,$url,$group,$can_setacl,$port_path) = @_;
+ my ($uname,$udom) = &get_name_dom();
+ my $file_name = $env{'form.currentpath'}.$env{'form.access'};
+ $file_name = &prepend_group($file_name);
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group,$file_name);
+ my $aclcount = keys(%access_controls);
+ my $header = '
'.&mt('Allowing others to retrieve file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).'
';
+ 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.').'
'.&mt('Public files are available to anyone without the need for login.').'
'.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.').'
'.&mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').' '.&mt('The conditions can include affiliation with a particular course or group, or a user account in a specific domain.').' '.&mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').'
';
+
+ if ($group eq '') {
+ $info .= (&mt("Direct others to the 'Display file listing' link (shown when there are viewable files) on your personal information page: http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme"));
+ }
+
+ if ($can_setacl) {
+ &open_form($r,$url);
+ $r->print($header.$info);
+ &access_setting_table($r,$access_controls{$file_name});
+ my $button_text = {
+ 'continue' => &mt('Proceed'),
+ 'cancel' => &mt('Back to directory listing'),
+ };
+ &close_form($r,$url,$button_text);
+ } else {
+ $r->print($header);
+ if ($aclcount) {
+ $r->print($info);
+ }
+ &view_access_settings($r,$url,$access_controls{$file_name},$aclcount);
+ }
+}
+
+sub view_access_settings {
+ my ($r,$url,$access_controls,$aclcount) = @_;
+ my ($showstart,$showend);
+ my %todisplay;
+ foreach my $key (sort(keys(%{$access_controls}))) {
+ my ($num,$scope,$end,$start) = &unpack_acc_key($key);
+ $todisplay{$scope}{$key} = $$access_controls{$key};
+ }
+ if ($aclcount) {
+ $r->print(&mt('
';
+ return $output;
+}
+
+sub role_options_window {
+ my ($r) = @_;
+ my $cdom = $env{'form.cdom'};
+ my $cnum = $env{'form.cnum'};
+ my $type = $env{'form.type'};
+ my $addindex = $env{'form.setroles'};
+ my $grouptitle = 'Groups';
+ if ($type eq 'Group') {
+ $grouptitle = 'Teams';
+ }
+ my $role_selects = &role_selectors(1,1,'new',$type,undef,'rolepicker');
+ $r->print(<<"END_SCRIPT");
+
+END_SCRIPT
+ $r->print(&mt('Select roles, course status, section(s) and group(s) for users who will be able to access the portfolio file.'));
+ $r->print('
'.&mt('Roles').'
'.&mt('[_1] status',$type).'
'.&mt('Sections').'
'.&mt($grouptitle).'
'.$role_selects.'
');
+ return;
+}
+
+sub select_files {
+ my ($r) = @_;
+ if ($env{'form.continue'} eq 'true') {
+ # here we update the selections for the currentpath
+ # eventually, have to handle removing those not checked, but . . .
+ my @items=&Apache::loncommon::get_env_multiple('form.checkfile');
+ if (scalar(@items)){
+ &Apache::lonnet::save_selected_files($env{'user.name'}, $env{'form.currentpath'}, @items);
+ }
+ } else {
+ #empty the file for a fresh start
+ &Apache::lonnet::clear_selected_files($env{'user.name'});
+ }
+ my @files = &Apache::lonnet::files_not_in_path($env{'user.name'}, $env{'form.currentpath'});
+ my $java_files = join ",", @files;
+ if ($java_files) {
+ $java_files.=',';
+ }
+ my $javascript =(<
+ function finishSelect() {
+ENDSMP
+ $javascript .= 'fileList = "'.$java_files.'";';
+ $javascript .= (<
+ENDSMP
+ $r->print($javascript);
+ $r->print("
Select portfolio files
+ Check as many as you wish in response to the problem. ");
+ my @otherfiles=&Apache::lonnet::files_not_in_path($env{'user.name'}, $env{'form.currentpath'});
+ if (@otherfiles) {
+ $r->print("Files selected from other directories: ");
+ foreach my $file (@otherfiles) {
+ $r->print($file." ");
}
- $displayOut = $displayOut.
- return $displayOut;
+ }
+}
+
+sub upload {
+ my ($r,$url,$group)=@_;
+ my $fname=$env{'form.uploaddoc.filename'};
+ my $filesize = (length($env{'form.uploaddoc'})) / 1000; #express in k (1024?)
+ my $disk_quota = 20000; # expressed in k
+ if (defined($group)) {
+ my $grp_quota = &get_group_quota($group); # quota expressed in k
+ if ($grp_quota ne '') {
+ $disk_quota = $grp_quota;
+ } else {
+ $disk_quota = 0;
+ }
+ }
+ $fname=&Apache::lonnet::clean_filename($fname);
+ my $portfolio_root=&get_portfolio_root();
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
+ # Fixme --- Move the checking for existing file to LOND error return
+ my @dir_list=&get_dir_list($portfolio_root);
+ my $found_file = 0;
+ my $locked_file = 0;
+ foreach my $line (@dir_list) {
+ my ($file_name)=split(/\&/,$line,2);
+ if ($file_name eq $fname){
+ $file_name = $env{'form.currentpath'}.$file_name;
+ $file_name = &prepend_group($file_name);
+ $found_file = 1;
+ if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
+ $locked_file = 1;
+ }
+ }
+ }
+ my $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$portfolio_root);
+ if (($current_disk_usage + $filesize) > $disk_quota){
+ $r->print('Unable to upload '.$fname.' (size = '.$filesize.' kilobytes). Disk quota will be exceeded.'.
+ ' Disk quota is '.$disk_quota.' kilobytes. Your current disk usage is '.$current_disk_usage.' kilobytes.');
+ $r->print(&done('Back',$url));
+ }
+ elsif ($found_file){
+ if ($locked_file){
+ $r->print(''.'Unable to upload '.$fname.', a locked file by that name was found in '.$port_path.$env{'form.currentpath'}.''.
+ ' You will be able to rename or delete existing '.$fname.' after a grade has been assigned.');
+ $r->print(&done('Back',$url));
+ } else {
+ $r->print(''.'Unable to upload '.$fname.', a file by that name was found in '.$port_path.$env{'form.currentpath'}.''.
+ ' To upload, rename or delete existing '.$fname.' in '.$port_path.$env{'form.currentpath'});
+ $r->print(&done('Back',$url));
+ }
+ } else {
+ my $result=&Apache::lonnet::userfileupload('uploaddoc','',
+ $port_path.$env{'form.currentpath'});
+ if ($result !~ m|^/uploaded/|) {
+ $r->print(''.'An errror occured ('.$result.
+ ') while trying to upload '.&display_file().' ');
+ $r->print(&done('Back',$url));
+ } else {
+ $r->print(&done(undef,$url));
+ }
+ }
+}
+
+sub lock_info {
+ my ($r,$url,$group) = @_;
+ my ($uname,$udom) = &get_name_dom();
+ my $current_permissions = &Apache::lonnet::get_portfile_permissions($udom,
+ $uname);
+ my $file_name = $env{'form.lockinfo'};
+ $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 = ''.$env{'form.lockinfo'}.
+ ' (group: '.$group.')';
+ } else {
+ $filetext = ''.$file_name.'';
+ }
+ $r->print(&mt('[_1] was submitted in response to problem: ',
+ $filetext).
+ ''.&Apache::lonnet::gettitle($$array_item[0]).
+ ' ');
+ my %course_description = &Apache::lonnet::coursedescription($$array_item[1]);
+ $r->print(&mt('In the course: [_1] ',
+ $course_description{'description'}));
+ # $r->print('the third is '.$$array_item[2].' ');
+ # $r->print("item is $$array_item[0] and $$array_item[0]");
+ }
+ }
+ }
+ $r->print(&done('Back',$url));
+ return 'ok';
+}
+
+sub createdir {
+ my ($r,$url)=@_;
+ my $newdir=&Apache::lonnet::clean_filename($env{'form.newdir'});
+ if ($newdir eq '') {
+ $r->print(''.
+ &mt("Error: no directory name was provided.").
+ ' ');
+ $r->print(&done(undef,$url));
+ return;
+ }
+ my $portfolio_root = &get_portfolio_root();
+ my @dir_list=&get_dir_list($portfolio_root);
+ my $found_file = 0;
+ foreach my $line (@dir_list) {
+ my ($filename)=split(/\&/,$line,2);
+ if ($filename eq $newdir){
+ $found_file = 1;
+ }
+ }
+ if ($found_file){
+ $r->print(''.'Unable to create a directory named '.$newdir.
+ ' a file or directory by that name already exists. ');
+ } else {
+ my ($uname,$udom) = &get_name_dom();
+ my $port_path = &get_port_path();
+ my $result=&Apache::lonnet::mkdiruserfile($uname,$udom,
+ $port_path.$env{'form.currentpath'}.$newdir);
+ if ($result ne 'ok') {
+ $r->print(''.'An errror occured ('.$result.
+ ') while trying to create a new directory '.&display_file().' ');
+ }
+ }
+ if ($newdir ne $env{'form.newdir'}) {
+ $r->print("The new directory name was changed from: ".$env{'form.newdir'}." to $newdir ");
+ }
+ $r->print(&done(undef,$url));
}
-sub displayActions {
- # returns html to offer user appropriate actions depending on selected file/directory
- my $displayOut;
- my ($currentPath, $currentFile, $isDir, $isFile) = @_;
-# $displayOut = 'here are actions for '.$currentFile;
- if ($isDir){
- $displayOut = 'Directory';
- }
- if ($isFile){
- $displayOut = 'File';
- }
-
- $displayOut = $displayOut.'
-
-
-
-
-
-
-
-
-
-
-
-
-
- ';
- $displayOut = $displayOut.'Add a file to your portfolio';
- # file upload form
- $displayOut = $displayOut.'
');
- return OK;
+ if ($caller eq 'coursegrp_portfolio') {
+ &Apache::lonhtmlcommon::clear_breadcrumbs();
+ $r->print(&coursegrp_portfolio_header($udom,$uname,$grp_desc));
+ }
+ my @dir_list=&get_dir_list($portfolio_root);
+ if ($dir_list[0] eq 'no_such_dir'){
+ # two main reasons for this:
+ # 1) never been here, so directory structure not created
+ # 2) back-button navigation after deleting a directory
+ if ($current_path eq '/'){
+ &Apache::lonnet::mkdiruserfile($uname,$udom,
+ &get_port_path());
+ } else {
+ # some directory that snuck in get rid of the directory
+ # from the recent pulldown, just in case
+ &Apache::lonhtmlcommon::remove_recent('portfolio',
+ [$current_path]);
+ $current_path = '/'; # force it back to the root
+ }
+ # now grab the directory list again, for the first time
+ @dir_list=&Apache::lonnet::dirlist($current_path,
+ $udom,$uname,$portfolio_root);
+ }
+ # need to know if directory is empty so it can be removed if desired
+ my $is_empty=(@dir_list == 2);
+ &display_common($r,$url,$current_path,$is_empty,\@dir_list,
+ $can_upload);
+ &display_directory($r,$url,$current_path,$is_empty,\@dir_list,$group,
+ $can_upload,$can_modify,$can_delete,$can_setacl);
+ $r->print(&Apache::loncommon::end_page());
+ }
+ return OK;
}
1;