Annotation of loncom/interface/lonblockingstatus.pm, revision 1.9

1.1       droeschl    1: # The LearningOnline Network with CAPA
                      2: # displays the blocking status table
                      3: #
1.9     ! raeburn     4: # $Id: lonblockingstatus.pm,v 1.8 2012/03/31 14:19:24 raeburn Exp $
1.1       droeschl    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: #
                     29: package Apache::lonblockingstatus;
                     30: 
                     31: use strict;
                     32: use Apache::Constants qw(:common);
                     33: use Apache::loncommon();
1.3       kalberla   34: use Apache::lonnet;
                     35: use Apache::lonlocal;
1.8       raeburn    36: use LONCAPA qw(:DEFAULT :match);
1.1       droeschl   37: 
                     38: sub handler {
                     39:     my $r = shift;
1.8       raeburn    40:     &Apache::loncommon::no_cache($r);
                     41:     &Apache::loncommon::content_type($r,'text/html');
1.6       droeschl   42: 
1.1       droeschl   43:     $r->send_http_header;
                     44:     return OK if $r->header_only;
                     45: 
1.8       raeburn    46:     my (%activities,$activity,$origurl);
                     47:     map { $activities{$_} = 1; } ('boards','chat','msgdisplay','blogs','groups','port','docs');
1.1       droeschl   48: 
1.8       raeburn    49:     # determine what kind of blocking we want details for
                     50:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['activity','url']);
                     51:     $activity = $env{'form.activity'};
                     52: 
                     53:     my $title = 'Communication Blocking Status Information';
                     54: 
                     55:     if ($activity eq 'docs') {
                     56:         $title = 'Blocking Status Information';
                     57:         $origurl = $env{'form.url'};
                     58:     }
                     59:     $r->print(&Apache::loncommon::start_page($title,undef,
                     60:                                             {'only_body' => 1}));
                     61: 
                     62:     if (($activity eq '') || (!$activities{$activity})) {
                     63:         $r->print('<span class="LC_error">'.&mt('Error: unknown activity type blocked').'</span>');
                     64:     } else {
                     65:         $r->print(&blockpage($activity,$origurl));
                     66:     }
1.6       droeschl   67:     
1.8       raeburn    68:     $r->print(&Apache::loncommon::end_page());
1.6       droeschl   69: 
1.1       droeschl   70:     return OK;
                     71: }
1.6       droeschl   72: 
                     73: 
                     74: sub blockpage {
1.8       raeburn    75:     my ($activity,$origurl) = @_;
1.6       droeschl   76: 
                     77:     # in case of a portfolio block we need to determine the owner of the files
                     78:     # we're trying to look at. This information is passed via query string.
                     79:     my ($uname, $udom);
                     80: 
                     81:     if ($activity eq 'port') {
1.8       raeburn    82:         &Apache::loncommon::get_unprocessed_cgi(
1.6       droeschl   83:             $ENV{'QUERY_STRING'}, ['udom', 'uname'] );
                     84: 
                     85:         ($uname, $udom) = ($env{'form.uname'}, $env{'form.udom'});
1.8       raeburn    86:         if (($uname !~ /^$match_username$/) || ($udom !~ /^$match_domain$/)) {
                     87:             return '<span class="LC_error">'.
                     88:                    &mt('Information about the owner of the portfolio files you were trying to view was missing or invalid.').
                     89:                    '</span><br />'.
                     90:                    &mt('Without valid owner information, the reason why access is blocked can not be determined'); 
                     91:         }
1.6       droeschl   92:     }
                     93: 
                     94: 
                     95:     # retrieve start/end of possible active blocking
1.4       kalberla   96:     my %setters;
1.8       raeburn    97:     my ($startblock,$endblock,$triggerblock) = 
1.9     ! raeburn    98:         &Apache::loncommon::blockcheck(\%setters,$activity,$uname,$udom,$origurl);
1.6       droeschl   99: 
                    100:     # nothing to do if there's no active blocking
                    101:     unless ($startblock && $endblock) { return ''; }
                    102: 
                    103:     # lookup $activity -> description
                    104:                    #possible activity          #corresponding description
1.8       raeburn   105:     my %descs = (
                    106:                    boards     => 'Discussion posts in this course',
                    107:                    chat       => 'Chat Room',
                    108:                    msgdisplay => 'This message',
                    109:                    blogs      => 'Blogs',
                    110:                    groups     => 'Groups in this course',
                    111:                    docs       => 'Course Content',
                    112:                 );
                    113: 
                    114:     if ($activity eq 'groups' || $activity eq 'boards') {
                    115:         if (&course_type() eq 'Community') {
                    116:             $descs{'boards'} = 'Discussion posts in this community',
                    117:             $descs{'groups'} = 'Groups in this community',
                    118:             $descs{'docs'} = 'Community Content',  
                    119:         }
                    120:     }
                    121: 
                    122:     my $description = $descs{$activity};
                    123:     if ($activity eq 'port') {
                    124:         $description = &get_portfolio_category($uname,$udom,\%setters);
                    125:     }
                    126:     if ($description eq '') {
                    127:         $description = 'Communication';
                    128:     }
1.6       droeschl  129: 
                    130:     my $showstart = Apache::lonlocal::locallocaltime($startblock);
                    131:     my $showend   = Apache::lonlocal::locallocaltime($endblock);
                    132: 
                    133:     my $output;
                    134:     
1.8       raeburn   135:     if ( ref($description) ne 'ARRAY' ) {
1.6       droeschl  136:         #default: $description is one of the above descriptions
1.8       raeburn   137:         if ($activity eq 'docs') {
1.9     ! raeburn   138:             $output=&mt( 'Access to the content page you are attempting to' 
1.8       raeburn   139:                          . ' view will be unavailable between [_1] and [_2] because'
                    140:                          . ' access to selected $description is being blocked.'
                    141:                          ,$showstart, $showend);
                    142:         } else {
                    143:             $output = mt( $description
                    144:                           . ' will be inaccessible between [_1] and [_2] because'
                    145:                           . ' communication is being blocked.'
                    146:                           ,$showstart, $showend);  
                    147:         }
1.6       droeschl  148:     } else {
                    149:         # @$description is is the array returned from get_portfolio_category()
                    150:         # and contains the description (e.g. "Portfolio files belonging to [_1]"
                    151:         # and the value for [_1]
                    152:         $output = mt( $$description[0]
                    153:                       . ' will be inaccessible between [_2] and [_3] because'
                    154:                       . ' communication is being blocked.'
                    155:                      ,$$description[1], $showstart, $showend)  
                    156:     }
                    157: 
                    158:     $output = "<p class=\"LC_info\">$output</p>";
                    159: 
                    160:     # show a table containing details, except if user is trying to look 
                    161:     # at a different user's portfolio files
                    162:     if (   $activity ne 'port'                        # no portfolio
                    163:         || (   $uname eq $env{'user.name'}            # or own portfolio
                    164:             && $udom  eq $env{'user.domain'} ) 
                    165:         || Apache::lonnet::is_course($udom, $uname) ) # or portfolio of a course
                    166:     {
1.8       raeburn   167:         $output .= &build_block_table(\%setters);
1.4       kalberla  168:     }
1.6       droeschl  169: 
1.5       kalberla  170:     return $output;
                    171: }
                    172: 
                    173: sub build_block_table {
1.8       raeburn   174:     my ($setters) = @_;
1.5       kalberla  175:     my %lt = &Apache::lonlocal::texthash(
                    176:         'cacb' => 'Currently active communication blocks',
                    177:         'cour' => 'Course',
                    178:         'dura' => 'Duration',
                    179:         'blse' => 'Block set by'
                    180:     );
                    181:     my $output;
1.6       droeschl  182:     $output  = Apache::loncommon::start_data_table()
                    183:              . Apache::loncommon::data_table_caption($lt{'cacb'})
                    184:              . Apache::loncommon::start_data_table_header_row()
                    185:              . "<th>$lt{'cour'}</th> <th>$lt{'dura'}</th> <th>$lt{'blse'}</th>"
                    186:              . Apache::loncommon::end_data_table_header_row();
                    187: 
1.5       kalberla  188:     foreach my $course (keys(%{$setters})) {
                    189:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                    190:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                    191:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
                    192:             my $fullname = Apache::loncommon::plainname($uname,$udom);
                    193:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                    194:                 && $env{'user.name'} ne 'public'
1.6       droeschl  195:                 && $env{'user.domain'} ne 'public') 
                    196:             {
1.5       kalberla  197:                 $fullname = Apache::loncommon::aboutmewrapper($fullname,$uname,$udom);
                    198:             }
1.8       raeburn   199:             my $triggertype = $$setters{$course}{times}[$i];
                    200:             if ($triggertype) {
                    201:                 $fullname .= &mt(' (triggered by you when starting timer)'); 
                    202:             }
1.5       kalberla  203:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                    204:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                    205:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
1.6       droeschl  206:             my $duration = mt('[_1] to [_2]', $openblock, $closeblock);
                    207:             $output .= Apache::loncommon::start_data_table_row()
                    208:                      . "<td>$courseinfo{'description'}</td>"
                    209:                      . "<td>$duration</td>"
                    210:                      . "<td>$fullname</td>"
                    211:                      . Apache::loncommon::end_data_table_row();
1.5       kalberla  212:         }
                    213:     }
                    214:     $output .= Apache::loncommon::end_data_table();
1.4       kalberla  215: }
1.1       droeschl  216: 
1.6       droeschl  217: sub get_portfolio_category {
                    218:     my ($uname, $udom, $setters) = @_;
                    219: 
                    220:     if ($uname eq $env{'user.name'} && $udom eq $env{'user.domain'}) {
                    221:         # user's portolfio files
                    222: 
                    223:         return 'Your portfolio files';
                    224: 
                    225:     } elsif (Apache::lonnet::is_course($udom, $uname)) {
                    226:         # group portfolio files
                    227: 
                    228:         my $coursedesc;
                    229: 
                    230:         foreach my $course (keys(%{$setters})) {
                    231:             my %courseinfo = Apache::lonnet::coursedescription($course);
                    232:             $coursedesc    = $courseinfo{'description'};
                    233:         }
                    234: 
                    235:         return ["Group portfolio in the course '[_1]'", $coursedesc];
                    236:         
                    237:     } else {
                    238:         # different user's portfolio files
                    239:         
                    240:         my $plainname = Apache::loncommon::plainname($uname, $udom);
                    241: 
                    242:         unless (   $env{'user.name'}   eq 'public' 
                    243:                 && $env{'user.domain'} eq 'public' ) 
                    244:         {
                    245:             $plainname = Apache::loncommon::aboutmewrapper(
                    246:                             $plainname, $uname, $udom);
                    247:         }
                    248: 
                    249:         return ['Portfolio files belonging to [_1]', $plainname];
                    250:     }
                    251: }
                    252: 
1.1       droeschl  253: 1;
                    254: __END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>