# The LearningOnline Network # Personal Information Page # # $Id: lonaboutme.pm,v 1.155 2013/09/17 15:04:30 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/ # =pod =head1 NAME pache::lonaboutme =head1 SYNOPSIS (empty) This is part of the LearningOnline Network with CAPA project described at http://www.lon-capa.org. =head1 OVERVIEW (empty) =head1 SUBROUTINES =over =item handler() =item aboutme_info() =item print_portfiles_link() =item build_query_string() =item display_portfolio_header() =item display_portfolio_files() =item portfolio_files() =item build_hierarchy() =item parse_directory() =back =cut package Apache::lonaboutme; use strict; use Apache::Constants qw(:common); use Apache::loncommon; use Apache::lonnet; use Apache::lontexconvert; use Apache::lonhtmlgateway; use Apache::lonrss(); use Apache::lonlocal; use Apache::lonmsgdisplay(); use Apache::lontemplate; use HTML::Entities(); use Image::Magick; sub handler { my $r = shift; &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; my $target=$env{'form.grade_target'}; # ------------------------------------------------------------ Print the screen if ($target eq 'tex') { $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); } my (undef,undef,$cdom,$cnum,undef,$action)=split(/\//,$r->uri); my $is_course; # Is this even a user? if (&Apache::lonnet::homeserver($cnum,$cdom) eq 'no_host') { &Apache::loncommon::simple_error_page($r,'No info', 'No user information available'); return OK; } else { $is_course = &Apache::lonnet::is_course($cdom,$cnum); } my $candisplay = 1; if (!$is_course) { if ($action ne 'portfolio') { $candisplay = &Apache::lonnet::usertools_access($cnum,$cdom,'aboutme'); if ((!$candisplay) && ($env{'request.course.id'})) { $candisplay = &aboutme_access($cnum,$cdom); } if (!$candisplay) { if ($target eq 'tex') { $r->print('\noindent{\large\textbf{'.&mt('No user personal information page available').'}}\\\\\\\\'); } else { $r->print(&Apache::loncommon::start_page("Personal Information Page")); $r->print('

'.&mt('No user personal information page available') .'

'. &mt('This is a result of one of the following:').''); $r->print(&Apache::loncommon::end_page()); } return OK; } } } # --------------------------------------------------------- The syllabus fields my %syllabusfields=&Apache::lonlocal::texthash( 'aaa_contactinfo' => 'Contact Information', 'bbb_aboutme' => 'Personal Information', 'ccc_webreferences' => 'Web References'); # ------------------------------------------------------------ Get Query String &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['forceedit','forcestudent','todocs', 'register','popup','folderpath','title']); # ----------------------------------------------- Available Portfolio file display if (($target ne 'tex') && ($action eq 'portfolio')) { &display_portfolio_header($r,$is_course); if ((!$is_course) && (!&Apache::lonnet::usertools_access($cnum,$cdom,'portfolio'))) { $r->print('

'.&mt('No user portfolio available') .'

'. &mt('This is a result of one of the following:').''); } else { my ($blocked,$blocktext) = &Apache::loncommon::blocking_status('port',$cnum,$cdom); if (!$blocked) { &display_portfolio_files($r,$is_course); } else { $r->print($blocktext); } } $r->print(&Apache::loncommon::end_page()); return OK; } if ($is_course) { if ($target ne 'tex') { my $args = {'function' => undef, 'domain' => $cdom}; if ($env{'form.register'}) { $args->{'force_register'} = $env{'form.register'}; } else { my %coursedescription = &Apache::lonnet::coursedescription($cdom.'_'.$cnum); my $cdescr = $coursedescription{'description'}; my $brcrum = [{href=>"/adm/$cdom/$cnum/aboutme", text=>&mt('Course Information - [_1]',$cdescr), no_mt=>1} ]; $args->{'bread_crumbs'} = $brcrum; } my $start_page = &Apache::loncommon::start_page( "Course Information",undef,$args); $r->print($start_page); $r->print('

'.&mt('Group Portfolio').'

'); &print_portfiles_link($r,$is_course); $r->print(&Apache::loncommon::end_page()); } return OK; } #------------Get rights my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum); my %syllabus=&Apache::lonnet::dump('aboutme',$cdom,$cnum); my ($allowed,$coursedomain,$coursenum); if ($env{'request.course.id'}) { $coursedomain = $env{'course.'.$env{'request.course.id'}.'.domain'}; $coursenum = $env{'course.'.$env{'request.course.id'}.'.num'}; } my ($cfile) = &Apache::lonnet::can_edit_resource($env{'request.noversionuri'}, $coursenum,$coursedomain, $env{'request.noversionuri'}, $env{'request.symb'}); if ($cfile ne '') { $allowed = 1; } if (!$env{'form.forceedit'} or $target eq 'tex') { $allowed=0; } # --------------------------------------- There is such a user, get environment if ($target ne 'tex') { my $rss_link = &Apache::lonrss::rss_link($cnum,$cdom); my $args = {'function' => undef, 'domain' => $cdom, 'force_register' => $env{'form.register'}, }; if ($env{'form.popup'}) { # Don't show breadcrumbs in popup window $args->{'no_nav_bar'} = 1; } elsif (!$env{'form.register'}) { #Don't show breadcrumbs twice, when this page is part of course content and you call it if (($env{'request.course.id'}) && ($env{'form.folderpath'} =~ /^supplemental/)) { my $crstype = &Apache::loncommon::course_type(); my $title = $env{'form.title'}; if ($title eq '') { $title = &mt('Personal Information Page'); } my $brcrum = &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1); if (ref($brcrum) eq 'ARRAY') { $args->{'bread_crumbs'} = $brcrum; } } else { $args->{'bread_crumbs'} = [{href=>"/adm/$cdom/$cnum/aboutme", text=>"Personal Information Page"}]; } } my $start_page = &Apache::loncommon::start_page('Personal Information Page',$rss_link,$args); $r->print($start_page); } #----------------Print Privacy note (edit mode) or last modified date. if ($target ne 'tex') { #Print Privacy Note if ($allowed) { $r->print('
' .''.&mt('Privacy Note:').' ' .&mt('The information you submit can be viewed by anybody who is logged into LON-CAPA. Do not provide information that you are not ready to share publicly.') .'
' ); } elsif ($syllabus{'uploaded.lastmodified'}) { #Print last modified my $lastmod=$syllabus{'uploaded.lastmodified'}; $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never')); $r->print('
'); $r->print(&mt('Last updated').': '.$lastmod . ''); $r->print('
'); } } #------Print Headtitle if ($target ne 'tex') { $r->print('
'. '

'.&Apache::loncommon::plainname($cnum,$cdom).'

'); if ($allowed) { $r->print('
'); if ($courseenv{'nickname'}) { $r->print('

"'.$courseenv{'nickname'}.'"

'); } $r->print('

'.&Apache::lonnet::domain($cdom,'description').'

'); #Print Help Text $r->print('
'. &Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes',&mt('Help with filling in text boxes')). '

'); } else { if ($courseenv{'nickname'}) { $r->print('

"'.$courseenv{'nickname'}.'"

'); } $r->print('

'.&Apache::lonnet::domain($cdom,'description').'

'); } } else { $r->print('\noindent{\large\textbf{'.&Apache::loncommon::plainname($cnum,$cdom).'}}\\\\\\\\'); $r->print('\textbf{'.&Apache::lonnet::domain($cdom,'description').'}\\\\'); } # does this user have privileges to post, etc? my $query_string; if (($env{'form.uploaddoc.filename'}) && ($env{'form.storeupl'}) && ($allowed)) { if ($env{'form.uploaddoc.filename'}=~/\.(gif|jpg|png|jpeg)$/i) { if ($syllabus{'uploaded.photourl'}) { &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'}); } $syllabus{'uploaded.photourl'}= &Apache::lonnet::userfileupload('uploaddoc',undef,'aboutme', undef,undef,undef,undef,undef,undef,undef,'400','500'); } $syllabus{'uploaded.lastmodified'}=time; &Apache::lonnet::put('aboutme',\%syllabus,$cdom,$cnum); } if ($allowed && $env{'form.delupl'}) { if ($syllabus{'uploaded.photourl'}) { &Apache::lonnet::removeuploadedurl($syllabus{'uploaded.photourl'}); delete($syllabus{'uploaded.photourl'}); &Apache::lonnet::del('aboutme',['uploaded.photourl'],$cdom,$cnum); } } if (($allowed) && ($env{'form.storesyl'})) { foreach my $syl_field (keys(%syllabusfields)) { my $field=$env{'form.'.$syl_field}; chomp($field); my $gateway = Apache::lonhtmlgateway->new(); $field = $gateway->process_incoming_html($field,1); $syllabus{$syl_field}=$field; } $syllabus{'uploaded.lastmodified'}=time; &Apache::lonnet::put('aboutme',\%syllabus,$cdom,$cnum); } my $image; # ---------------------------------------------------------------- Get syllabus if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) { if ($syllabus{'uploaded.photourl'}) { &Apache::lonnet::allowuploaded('/adm/aboutme',$syllabus{'uploaded.photourl'}); $image=qq|Photo of the user|; if ($target eq 'tex') { $image=&Apache::lonxml::xmlparse($r,'tex',$image); } } if ($allowed) { $r->print( '
'. '

'.&mt('Upload a Photo').'

'. '

'. &mt('LON-CAPA will automatically scale your uploaded file so the image will not exceed a width of 400px and a height of 500px.').'

'. ''. ''. ''. '
'); if ($syllabus{'uploaded.photourl'}) { $r->print('
') } $r->print('

'); } if($allowed) { $r->print('
'); } if ($target ne 'tex') { #print Image $r->print($image.''); } #End Print Image #Print Content eg. Contactinfo aboutme,... &Apache::lontemplate::print_aboutme_content_template($r,$allowed,$target,\%syllabusfields,\%syllabus); #End Print Content if ($target ne 'tex') { #Begin Print RSS and portfiles &print_portfiles_link($r,$is_course); if (&Apache::lonrss::advertisefeeds($cnum,$cdom) ne '') { &Apache::lontemplate::print_start_template($r,'RSS Feeds and Blogs','LC_Box'); $r->print(&Apache::lonrss::advertisefeeds($cnum,$cdom)); &Apache::lontemplate::print_end_template($r); } } #End Print RSS and portfiles if ($allowed) { if ($env{'form.popup'}) { $r->print(''); } $r->print('
'); } if ($target ne 'tex') {$r->print('
');} else {$r->print('\\\\');} } else { $r->print('

'.&mt('No personal information provided').'.

'); } if ($env{'request.course.id'} && &Apache::lonnet::allowed('srm',$env{'request.course.id'}) && &Apache::lonnet::in_course($cdom,$cnum,$coursedomain,$coursenum,undef,1)) { if ($target ne 'tex') { $r->print(''); &Apache::lontemplate::print_start_template($r,&mt('User Notes, Records of Face-To-Face Discussions, and Critical Messages in Course'),'LC_Box'); $r->print(''); $r->print(&mt('Shared by course faculty and staff').&Apache::loncommon::help_open_topic("Course_Face_To_Face_Records,Course_Critical_Message")); $r->print(''); &Apache::lonmsgdisplay::disfacetoface($r,$cnum,$cdom); &Apache::lontemplate::print_end_template($r); } else { $r->print('\\\\\textbf{'.&mt('User Notes, Records of Face-To-Face Discussions, and Critical Messages in Course').'}\\\\'.&mt('Shared by course faculty and staff').'\\\\\\\\'); &Apache::lonmsgdisplay::disfacetoface($r,$cnum,$cdom, 'tex'); } } if ($target ne 'tex') { $r->print('
'); if ($env{'form.popup'}) { $r->print('

'.&mt('Close window').'

'); } $r->print(&Apache::loncommon::end_page()); } else { $r->print('\end{document}'); } return OK; } sub aboutme_info { my ($r,$is_course) = @_; my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri); my $name; if (!$is_course) { $name = &Apache::loncommon::plainname($cnum,$cdom); } return ($cdom,$cnum,$name); } sub print_portfiles_link { my ($r,$is_course) = @_; my ($cdom,$cnum,$name) = &aboutme_info($r,$is_course); my $filecounts = &portfolio_files($r,'showlink',undef,$is_course, $cdom,$cnum,$name); my $query_string = &build_query_string(); my $output; my %lt = &Apache::lonlocal::texthash( 'vpfi' => 'Viewable portfolio files', 'vgpf' => 'Viewable group portfolio files', 'difl' => 'Display file listing', ); if ($filecounts->{'both'} > 0) { $output = '

'; $output .= ($is_course?$lt{'vgpf'}:$lt{'vpfi'}).'

'; #$output = '

'.($is_course?$lt{'vgpf'}:$lt{'vpfi'}).'

'; $output .= ''.$lt{'difl'}. '

'; if ($filecounts->{'both'} == 1) { if ($is_course) { $output .= &mt('One group portfolio file is available.').'
'; } elsif ($is_course) { $output .= '
'.&mt('There are currently no publicly accessible or password protected group portfolio files.').'
'; } $r->print($output); return; } sub build_query_string { my ($new_items) = @_; my $query_string; my @formelements = ('register'); my $new = 0; if (ref($new_items) eq 'HASH') { $new = 1; if (!defined($new_items->{'forceedit'}) && !defined($new_items->{'forcestudent'})) { push(@formelements,('forceedit','forcestudent')); } } else { push(@formelements,('forceedit','forcestudent')); } foreach my $element (@formelements) { if (exists($env{'form.'.$element})) { if ((!$new) || (!defined($new_items->{$element}))) { $query_string .= '&'.$element.'='.$env{'form.'.$element}; } } } if ($new) { foreach my $key (keys(%{$new_items})) { $query_string .= '&'.$key.'='.$new_items->{$key}; } } $query_string =~ s/^\&/\?/; return $query_string; } sub display_portfolio_header { my ($r,$is_course) = @_; my ($cdom,$cnum,$name) = &aboutme_info($r,$is_course); my $query_string = &build_query_string(); my $args = {'domain' => $cdom}; if ($env{'form.forcestudent'}) { $args->{'function'} = 'student'; } my $output; if ($is_course) { if (($env{'request.course.id'} eq $cdom.'_'.$cnum) && ($env{'form.register'})) { $args->{force_register} = $env{'form.register'}; } else { my %coursedescription = &Apache::lonnet::coursedescription($cdom.'_'.$cnum); my $cdescr = $coursedescription{'description'}; my $brcrum = [{href=>"/adm/$cdom/$cnum/aboutme".$query_string, text=>&mt('Course Information - [_1]',$cdescr), no_mt=>1}, {href=>"/adm/$cdom/$cnum/aboutme/portfolio".$query_string, text=>'Viewable group portfolio files'} ]; $args->{bread_crumbs} = $brcrum; } $output = &Apache::loncommon::start_page('Viewable group portfolio files',undef,$args). '

'.&mt('Group Portfolio files').'

'; } else { if ($env{'request.course.id'} && $env{'form.register'}) { $args->{force_register} = $env{'form.register'}; } else { my $brcrum = [{href => "/adm/$cdom/$cnum/aboutme".$query_string, text => &mt('Personal Information Page - [_1]',$name), title => &mt('Go to personal information page for [_1]',$name), no_mt => 1}, {href => "/adm/$cdom/$cnum/aboutme/portfolio".$query_string, text => 'Viewable files', title => &mt('Viewable portfolio files for [_1]',$name), no_mt => 1} ]; $args->{bread_crumbs} = $brcrum; } $output = &Apache::loncommon::start_page('Viewable portfolio files', undef,$args). '

'.&mt('Portfolio files for [_1]',$name).'

'; } $r->print($output); return; } sub display_portfolio_files { my ($r,$is_course) = @_; my ($cdom,$cnum,$name) = &aboutme_info($r,$is_course); my %lt = &Apache::lonlocal::texthash( 'withoutpass' => 'passphrase not required', 'withpass' => 'passphrase protected', 'both' => 'all access types ', ); my $portaccess = 'withoutpass'; if (exists($env{'form.portaccess'})) { $portaccess = $env{'form.portaccess'}; } my $output = '
'. &mt('File access type: ').''."\n"; if ($env{'form.register'}) { $output .= ''."\n"; } $output .= ''. '


'; $r->print($output); my $filecounts = &portfolio_files($r,'listfiles',\%lt,$is_course, $cdom,$cnum,$name); if (!($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public')) { if ($env{'request.course.id'} && $env{'form.register'}) { my $query_string = &build_query_string(); $r->print('
'); if ($is_course) { $r->print(&mt('Course Information page')); } else { $r->print(&mt('Information about [_1]',$name)); } $r->print(''); } } return; } sub portfolio_files { my ($r,$mode,$lt,$is_course,$cdom,$cnum,$name) = @_; my $filecounts = { withpass => 0, withoutpass => 0, both => 0, }; my $current_permissions = &Apache::lonnet::get_portfile_permissions($cdom,$cnum); my %access_controls = &Apache::lonnet::get_access_controls($current_permissions); my $portaccess; if ($mode eq 'showlink') { $portaccess = 'both'; } else { $portaccess = 'withoutpass'; if (exists($env{'form.portaccess'})) { $portaccess = $env{'form.portaccess'}; } } my $diroutput; if ($is_course) { my %files_by_group; foreach my $filename (sort(keys(%access_controls))) { my ($group,$path) = split('/',$filename,2); $files_by_group{$group}{$path} = $access_controls{$filename}; } foreach my $group (sort(keys(%files_by_group))) { my %fileshash; my $grpout .= &build_hierarchy($r,$cdom,$cnum,$portaccess, $is_course,$filecounts,$mode, $files_by_group{$group}, \%fileshash,$group); if ($grpout) { $diroutput .= '

'.$group.'

'.$grpout.'
'; } } } else { my %allfileshash; $diroutput = &build_hierarchy($r,$cdom,$cnum,$portaccess,$is_course, $filecounts,$mode,\%access_controls, \%allfileshash); } if ($mode eq 'listfiles') { if ($filecounts->{'both'}) { $r->print($diroutput); } else { my $access_text; if (ref($lt) eq 'HASH') { $access_text = $lt->{$portaccess}; } $r->print(&mt('There are no available files of the specified access type: [_1]',$access_text)); } } return $filecounts; } sub build_hierarchy { my ($r,$cdom,$cnum,$portaccess,$is_course,$filecounts,$mode,$access_info, $allfileshash,$group) = @_; foreach my $filename (sort(keys(%{$access_info}))) { my $access_status = &Apache::lonnet::get_portfolio_access($cdom,$cnum,$filename,$group,$$access_info{$filename}); if ($portaccess eq 'both') { if (($access_status ne 'ok') && ($access_status !~ /^[^:]+:guest_/)) { next; } } elsif ($portaccess eq 'withoutpass') { if ($access_status ne 'ok') { next; } } elsif ($portaccess eq 'withpass') { if ($access_status !~ /^[^:]+:guest_/) { next; } } if ($mode eq 'listfiles') { $filename =~ s/^\///; my @pathitems = split('/',$filename); my $lasthash = $allfileshash; while (@pathitems > 1) { my $newlevel = shift(@pathitems); if (!exists($lasthash->{$newlevel})) { $lasthash->{$newlevel} = {}; } $lasthash = $lasthash->{$newlevel}; } $lasthash->{$pathitems[0]} = $filename; } if ($access_status eq 'ok') { $filecounts->{'withoutpass'} ++; } elsif ($access_status =~ /^[^:]+:guest_/) { $filecounts->{'withpass'} ++; } } $filecounts->{'both'} = $filecounts->{'withoutpass'} + $filecounts->{'withpass'}; my $output; if ($mode eq 'listfiles') { if ($filecounts->{'both'} > 0) { $output = &Apache::loncommon::start_data_table(); $output .= &parse_directory($r,0,$allfileshash,'',$is_course, $group); $output .= &Apache::loncommon::end_data_table(); } } return $output; } sub parse_directory { my ($r,$depth,$currhash,$path,$is_course,$group) = @_; my ($cdom,$cnum,$name) = &aboutme_info($r,$is_course); $depth++; my $output; my $portfolio_root = &Apache::portfolio::get_portfolio_root($cdom,$cnum, $group); my $getpropath = 1; my ($listref,$listerror) = &Apache::lonnet::dirlist($portfolio_root.$path,$cdom,$cnum,$getpropath); my %dirlist; if (ref($listref) eq 'ARRAY') { %dirlist = map { ((split('&',$_,2))[0],1) } @{$listref}; } foreach my $item (sort(keys(%{$currhash}))) { $output .= &Apache::loncommon::start_data_table_row(); $output .= ''; if (ref($currhash->{$item}) eq 'HASH') { my $title=&HTML::Entities::encode($item,'<>&"'); $output .= ''.&mt('Folder').' '.$title.' '.$title; $output .= ' ' .&Apache::loncommon::end_data_table_row(); $output .= &parse_directory($r,$depth,$currhash->{$item}, $path.'/'.$item,$is_course,$group); } else { my $file_name; if ($currhash->{$item} =~ m|/([^/]+)$|) { $file_name = $1; } else { $file_name = $currhash->{$item}; } my $have_meta = exists($dirlist{$file_name.'.meta'}); my $url; if ($is_course) { $url = '/uploaded/'.$cdom.'/'.$cnum.'/groups/'.$group. '/portfolio/'.$currhash->{$item}; } else { $url = '/uploaded/'.$cdom.'/'.$cnum.'/portfolio/'.$currhash->{$item}; } my $showname; if ($have_meta) { $showname = &Apache::lonnet::metadata($url,'title'); } if ($showname eq '') { $showname = $file_name; } else { $showname = $file_name.' ('.$showname.')'; } $showname=&HTML::Entities::encode($showname,'<>&"'); $output .= ''. ''. ' '.$showname.''; $output.=''; if ($have_meta) { $output.= ''.&mt('Metadata').''; } $output .= '' .&Apache::loncommon::end_data_table_row(); } } return $output; } sub aboutme_access { my ($uname,$udom) = @_; my $privcheck = $env{'request.course.id'}; my $sec; if ($env{'request.course.sec'} ne '') { $sec = $env{'request.course.sec'}; $privcheck .= '/'.$sec; } my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; if (($cdom eq '') || ($cnum eq '')) { my %coursehash = &Apache::lonnet::coursedescription($env{'request.course.id'}); $cdom = $coursehash{'domain'}; $cnum = $coursehash{'cnum'}; } if ((&Apache::lonnet::allowed('srm',$privcheck)) || (&Apache::lonnet::allowed('dff',$privcheck))) { if (&Apache::lonnet::in_course($uname,$udom,$cnum,$cdom,undef,1)) { return 1; } } return; } 1; __END__