Return to lonaboutme.pm CVS log

Up to [LON-CAPA] / loncom / interface

Advertising a user's viewable portfolio files on the user's aboutme page. Currently not implemented for group portfolio files.  The aboutme page returns 'Forbidden' if the url is viewed without login - modification or alternative mechanism required for advertisement of viewable files for users without accounts.

# The LearningOnline Network
# "About Me" Personal Information
#
# $Id: lonaboutme.pm,v 1.43 2006/08/02 03:05:10 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::lonaboutme;

use strict;
use Apache::Constants qw(:common);
use Apache::loncommon;
use Apache::lonnet;
use Apache::lontexconvert;
use Apache::lonfeedback;
use Apache::lonrss();
use Apache::lonlocal;
use Apache::lonmsgdisplay();

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)=split(/\//,$r->uri);
# 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;
    }
# --------------------------------------------------------- The syllabus fields
    my %syllabusfields=&Apache::lonlocal::texthash(
       'aaa_contactinfo'   => 'Contact Information',
       'bbb_aboutme'       => 'About Me',
       'ccc_webreferences' => 'Web References');

# ------------------------------------------------------------ Get Query String
    &Apache::loncommon::get_unprocessed_cgi
        ($ENV{'QUERY_STRING'},['forceedit','forcestudent','register','action']);

# ----------------------------------------------- Available Portfolio file display 
    if (($target ne 'tex') && ($env{'form.action'} eq 'portfolio')) {
        my %lt = &Apache::lonlocal::texthash (
                  withoutpass => 'passphrase not required',
                  withpass    => 'passphrase protected',
                  both        => 'all access types ',
        );
        &display_portfolio_header($r);
        &display_portfolio_files($r,\%lt);
        $r->print(&Apache::loncommon::end_page());
        return OK;
    }

# --------------------------------------------------------------- Force Student
    my $forcestudent='';
    if ($env{'form.forcestudent'}) { $forcestudent='student'; };

    my $forceregister = '';
    if ($forcestudent eq '') {
        $forceregister = $env{'form.register'};
    }
       
# --------------------------------------- There is such a user, get environment
    my %courseenv=&Apache::lonnet::dump('environment',$cdom,$cnum);
    if ($target ne 'tex') {
	my $start_page = 
	    &Apache::loncommon::start_page("Personal Information",undef,
					   {'function'       => $forcestudent,
					    'domain'         => $cdom,
					    'force_register' =>
						            $forceregister,});
	$r->print($start_page);
	$r->print('<h1>'.&Apache::loncommon::plainname($cnum,$cdom).'</h1>');
    } else {
	$r->print('\noindent{\large\textbf{'.&Apache::loncommon::plainname($cnum,$cdom).'}}\\\\\\\\');
    }
    if ($courseenv{'nickname'}) {
       $r->print(
         '<h2>&quot;'.$courseenv{'nickname'}.
         '&quot;</h2>');
    }
    if ($target ne 'tex') {
	$r->print('<h3>'.$Apache::lonnet::domaindescription{$cdom}.'</h3>'.
		  '<p>'.&Apache::loncommon::messagewrapper('Send me a message',$cnum,$cdom).'</p>'.&Apache::lonrss::advertisefeeds($cnum,$cdom));
    } else {
	$r->print('\textbf{'.$Apache::lonnet::domaindescription{$cdom}.'}\\\\');
    }
    my %syllabus=&Apache::lonnet::dump('aboutme',$cdom,$cnum);
    my $allowed=0;

# does this user have privileges to post, etc?

       my $privleged=$allowed=(($env{'user.name'} eq $cnum) && 
			       ($env{'user.domain'} eq $cdom));
       if ($forcestudent or $target eq 'tex') { $allowed=0; }
 
       if ($allowed) {
           my $query_string = &build_query_string({'forcestudent' => '1',});
	   $r->print('<p><b>'.&mt('Privacy Note').':</b> '.
		     &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.').
		     '</p>'.
		     &Apache::loncommon::help_open_topic('Uploaded_Templates_TextBoxes','Help with filling in text boxes').'</p><p><a href="'.$r->uri.$query_string.'">Show Public View</a>'.
		     &Apache::loncommon::help_open_topic('Uploaded_Templates_PublicView').'</p>');
       } elsif ($privleged && $target ne 'tex') {
           my $query_string = &build_query_string({'forceedit' => '1',});
	   $r->print('<p><a href="'.$r->uri.$query_string.'"><font size="+1">'.
		     &mt('Edit').'</font></a></p>');
       }
      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');
 	  }
          $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 (keys %syllabusfields) {
               my $field=$env{'form.'.$_};
               $field=~s/\s+$//s;
               $field=&Apache::lonfeedback::clear_out_html($field,
                                                           $env{'user.adv'});
	       $syllabus{$_}=$field;
           }
           $syllabus{'uploaded.lastmodified'}=time;
           &Apache::lonnet::put('aboutme',\%syllabus,$cdom,$cnum);
       }

# ---------------------------------------------------------------- Get syllabus
    if (($syllabus{'uploaded.lastmodified'}) || ($allowed)) {
       my $lastmod=$syllabus{'uploaded.lastmodified'};
       $lastmod=($lastmod?&Apache::lonlocal::locallocaltime($lastmod):&mt('never'));
       $r->print(&mt('Last updated').': '.$lastmod);
       if ($syllabus{'uploaded.photourl'}) {
	   &Apache::lonnet::allowuploaded('/adm/aboutme',
					  $syllabus{'uploaded.photourl'});
	   my $image=
               qq{<img src="$syllabus{'uploaded.photourl'}" align="right" />};
	   if ($target eq 'tex') {
	       $image=&Apache::lonxml::xmlparse($r,'tex',$image);
	   }
	   $r->print($image);
       }
       if ($allowed) {
           $r->print(
	 '<form method="post">
               <input type="submit" name="delupl" value="Delete Photo" />
          </form>'.
	 '<form method="post" enctype="multipart/form-data">'.
         '<h3>'.&mt('Upload a Photo').'</h3>'.
         '<input type="file" name="uploaddoc" size="50">'.
         '<input type="submit" name="storeupl" value="Upload">'.
	 '</form><form method="post">');

       }
       foreach (sort keys %syllabusfields) {
          if (($syllabus{$_}) || ($allowed)) {
              my $message=$syllabus{$_};
	      &Apache::lonfeedback::newline_to_br(\$message);
              $message
             =~s/(http\:\/\/[^\s]+)/\<a href=\"$1\"\>\<tt\>$1\<\/tt\>\<\/a\>/g;
	      if ($allowed) {
		  $message=&Apache::lonspeller::markeduptext($message);
	      }
	      $message=&Apache::lontexconvert::msgtexconverted($message);
	      if ($target ne 'tex') {
		  $r->print('<h3>'.$syllabusfields{$_}.'</h3><blockquote>'.
                            $message.'</blockquote>');
	      } else {
		     $r->print('\\\\\textbf{'.$syllabusfields{$_}.'}\\\\'.
			       &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
	      }
              if ($allowed) {
                 $r->print('<br /><textarea cols="80" rows="6" name="'.$_.'">'.
			   $syllabus{$_}.
           '</textarea><input type="submit" name="storesyl" value="'.
			   &mt('Store').'" />');
	      }
	  }
       }
       if ($allowed) {
	   $r->print('</form>');
       }
       if ($target ne 'tex') {$r->print('</p>');} else {$r->print('\\\\');}
    } else {
       $r->print('<p>'.&mt('No personal information provided').'.</p>');
    }

    if ($target ne 'tex') {
        &print_portfiles_link($r);
    }

    if ($env{'request.course.id'}) {
	if (&Apache::lonnet::allowed('srm',$env{'request.course.id'})) {
	    if ($target ne 'tex') {
		$r->print('<a name="coursecomment" />');
		$r->print('<hr /><h3>'.
                          &mt('User Notes, Records of Face-To-Face Discussions, and Critical Messages in Course').'</h3>'.
                          &mt('Shared by course faculty and staff').
                          &Apache::loncommon::help_open_topic("Course_Face_To_Face_Records,Course_Critical_Message").
'<br />');
                &Apache::lonmsgdisplay::disfacetoface($r,$cnum,$cdom);
                $r->print('<hr />');
                if (&Apache::lonnet::allowed('vsa',
                                             $env{'request.course.id'}) ||
                    &Apache::lonnet::allowed('vsa',
                                             $env{'request.course.id'}.'/'.
                                             $env{'request.course.sec'})) {
                    $r->print(&Apache::loncommon::track_student_link
                              ('View recent activity by this student',
                               $cnum,$cdom).('&nbsp;'x2));
                }
                $r->print(&Apache::loncommon::noteswrapper('Add Records',$cnum,$cdom));
	    } 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);
	    }
        }
    }
    if ($target ne 'tex') {
	$r->print(&Apache::loncommon::end_page());
    } else {
	$r->print('\end{document}');
    }
    return OK;
}

sub aboutme_info {
    my ($r) = @_;
    my (undef,undef,$cdom,$cnum)=split(/\//,$r->uri);
    my $name = &Apache::loncommon::plainname($cnum,$cdom);
    return ($cdom,$cnum,$name);
}

sub print_portfiles_link {
    my ($r) = @_;
    my ($cdom,$cnum,$name) = &aboutme_info($r);
    my $filecounts = &portfolio_files($r,'showlink');
    my $query_string = &build_query_string({'action' => 'portfolio',});
    my $output;
    if ($filecounts->{'both'} > 0) {
        $output = &mt('<h3>Viewable portfolio files</h3>');
        $output .= '<a href="/adm/'.$cdom.'/'.$cnum.'/aboutme'.
                   $query_string.'">'.&mt('Display file listing').
                   '</a><br /><br />';
        $output .= &mt('A total of [_1] portfolio files owned by [_2] are available for viewing.',$filecounts->{'both'},$name).'<ul>';
        if ($filecounts->{'withoutpass'}) {
            $output .= '<li>'.&mt('[_1] files are either publicly accessible, or directly available to you because of your current role, domain and/or username.',$filecounts->{'withoutpass'}).'</li>';   
        }
        if ($filecounts->{'withpass'}) {
            $output .= '<li>'.&mt('[_1] files will be available after you have entered a passphrase set for each specific file.',$filecounts->{'withpass'}).'</li>';
        }
        $output .= '</ul>';
    }
    $r->print($output);
    return;
}

sub build_query_string {
    my ($new_items) = @_;
    my $query_string;
    my @formelements = ('register'); 
    my $nonew = 1;
    if (ref($new_items) eq 'HASH') {
        $nonew = 0;
        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 (($nonew) || (!defined($new_items->{$element}))) {
                $query_string .= '&amp;'.$element.'='.$env{'form.'.$element};
            }
        }
    }
    if (!$nonew) {
        foreach my $key (keys(%{$new_items})) {
            $query_string .= '&amp;'.$key.'='.$new_items->{$key};
        }
    }
    $query_string =~ s/^\&amp;/\?/;
    return $query_string;
}

sub display_portfolio_header {
    my ($r) = @_;
    my ($cdom,$cnum,$name) = &aboutme_info($r);
    my $query_string = &build_query_string();
    &Apache::lonhtmlcommon::clear_breadcrumbs();
    my $forcestudent='';
    if ($env{'form.forcestudent'}) { $forcestudent='student'; };
    my $output =
        &Apache::loncommon::start_page('Viewable portfolio files',undef,
                                            {'function' => $forcestudent, 
                                             'domain'   => $cdom,});
    &Apache::lonhtmlcommon::add_breadcrumb
        ({href=>"/adm/$cdom/$cnum/aboutme".$query_string,
          text=>"Personal information - $name",
          title=>"Go to personal information page for $name"},
         {href=>"/adm/$cdom/$cnum/aboutme?action=portfolio",
          text=>"Viewable files - $name",
          title=>"Viewable portfolio files for $name"}
);
    $output .= &Apache::lonhtmlcommon::breadcrumbs(&mt('Viewable portfolio files.'));
    $output .= '<h3>'.&mt('Portfolio files for [_1]',$name).'</h3>';
    $r->print($output);
    return;
}

sub display_portfolio_files {
    my ($r,$lt) = @_;
    my ($cdom,$cnum,$name) = aboutme_info($r);
    my $portaccess = 'withoutpass';
    if (exists($env{'form.portaccess'})) {
        $portaccess = $env{'form.portaccess'};
    }
    my $output = '<form name="displaystatus" method="post">'.
                 &mt('File access type: ').'<select name="portaccess">';
    foreach my $type ('withoutpass','withpass','both') {
        $output .= '<option value="'.$type.'" ';
        if ($portaccess eq $type) {
            $output .= 'selected="selected"';
        }
        $output .= '>'.$lt->{$type}.'</option>';
    }
    $output .= '</select>'."\n".
               '<input type="submit" name="portaccessbutton" value="'.
               &mt('Update display').'">'.
               '<input type="hidden" name="action" value="'.
               $env{'form.action'}.'"/>';
    $output .= '</form><br /><br />';
    $r->print($output);
    my $filecounts = &portfolio_files($r,'listfiles',$lt);
    my $query_string = &build_query_string();
    $r->print('<br /><br /><a href="/adm/'.$cdom.'/'.$cnum.
               '/aboutme'.$query_string.'">'.
               &mt('Information about [_1]',$name).'</a>');
    return;
}

sub portfolio_files {
    my ($r,$mode,$lt) = @_;
    my ($cdom,$cnum,$name) = &aboutme_info($r);
    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 %allfileshash;
    my $portaccess;
    if ($mode eq 'showlink') {
        $portaccess = 'both';
    } else {
        $portaccess = 'withoutpass';
        if (exists($env{'form.portaccess'})) {
            $portaccess = $env{'form.portaccess'};
        }
    }

    foreach my $filename (keys(%access_controls)) {
        my $access_status = 
            &Apache::lonnet::get_portfolio_access($access_controls{$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'};
    if ($mode eq 'listfiles') {
        my $output;
        if (keys(%allfileshash) > 0) {
            my $depth = 0;
            my $count = 0;
            $output = '<table border="0" cellpadding="2" cellspacing="0">';
            ($count,$output) = &parse_directory($r,$output,$depth,
                                               \%allfileshash,$count);
            $output .= '</table>';
        } else {
            my $access_text;
            if (ref($lt) eq 'HASH') {
                $access_text = $lt->{$portaccess};   
            }
            $output .= &mt('There are no available files of the specified access type: [_1]',$access_text);
        }
        $r->print($output);
    }
    return $filecounts;
}

sub parse_directory {
    my ($r,$output,$depth,$currhash,$count) = @_;
    my ($cdom,$cnum,$name) = &aboutme_info($r);
    $depth ++;
    my @backgroundColors = ("#FFFFFF", "#F6F6F6");
    my $indent = '<img src="'.&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif").'" width="25" height="1" alt="&nbsp;&nbsp;" border="0" />';
    $output .= $indent;
    foreach my $item (sort(keys(%{$currhash}))) {
        $count ++;
        my $backgroundcolor = $backgroundColors[$count%2]; 
        $output .= '<tr bgcolor="'.$backgroundcolor.'">';
        $output .= '<td>';
        for (my $i=0; $i<$depth; $i++) {
            $output .= $indent;
        }
        if (ref($currhash->{$item}) eq 'HASH') {
            my $title = $item;
            $title=~s/\"/\&quot;/g;
            $output .= '<img src="'.&Apache::loncommon::lonhttpdurl("/adm/lonIcons/navmap.folder.open.gif").'" alt="'.&mt('Folder').' '.$title.' border="0" />&nbsp;'.$title;
            ($count,$output) = &parse_directory($r,$output,$depth,
                                                $currhash->{$item},$count);
        } else {
            my $showname;
            if ($currhash->{$item} =~ m|/([^/]+)$|) {
                $showname = $1;
            } else {
                $showname = $currhash->{$item};
            }
            $output .= '<img alt="" src="'.&Apache::loncommon::icon($currhash->{$item}).'" />&nbsp;<a href="/uploaded/'.$cdom.'/'.$cnum.'/portfolio/'.$currhash->{$item}.'">'.$showname.'</a>';
        }
        $output .= '</td></tr>';
    }
    return ($count,$output);
}

1;
__END__