File:  [LON-CAPA] / loncom / interface / lonblockingstatus.pm
Revision 1.18: download - view: text, annotated - select for diffs
Tue Sep 29 19:29:51 2020 UTC (3 years, 8 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD
- Remove trailing white space
- Remove blank line
- Add missing semicolon

    1: # The LearningOnline Network with CAPA
    2: # displays the blocking status table
    3: #
    4: # $Id: lonblockingstatus.pm,v 1.18 2020/09/29 19:29:51 raeburn Exp $
    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();
   34: use Apache::lonnet;
   35: use Apache::lonlocal;
   36: use LONCAPA qw(:DEFAULT :match);
   37: 
   38: sub handler {
   39:     my $r = shift;
   40:     &Apache::loncommon::no_cache($r);
   41:     &Apache::loncommon::content_type($r,'text/html');
   42: 
   43:     $r->send_http_header;
   44:     return OK if $r->header_only;
   45: 
   46:     my (%activities,$activity,$origurl,$origsymb);
   47:     map { $activities{$_} = 1; } ('boards','chat','com','blogs','groups','port','printout','docs','grades','passwd','search');
   48: 
   49:     # determine what kind of blocking we want details for
   50:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['activity','url','symb']);
   51:     $activity = $env{'form.activity'};
   52: 
   53:     my $title = 'Communication Blocking Status Information';
   54: 
   55:     if (($activity eq 'docs') || ($activity eq 'printout') ||
   56:         ($activity eq 'grades') || ($activity eq 'passwd') ||
   57:         ($activity eq 'search')) {
   58:         $title = 'Blocking Status Information';
   59:         if ($activity eq 'docs') {
   60:             $origurl = $env{'form.url'};
   61:             $origsymb = $env{'form.symb'};
   62:         }
   63:     }
   64:     $r->print(&Apache::loncommon::start_page($title,undef,
   65:                                             {'only_body' => 1}));
   66: 
   67:     if (($activity eq '') || (!$activities{$activity})) {
   68:         $r->print('<p class="LC_error">'.&mt('Error: unknown activity type blocked').'</p>');
   69:     } elsif (($activity eq 'docs') && ($origurl eq '') && ($origsymb eq '')) {
   70:         $r->print('<p class="LC_error">'.&mt('Error: could not determine what content was blocked from access').'</p>');
   71:     } else {
   72:         $r->print(&blockpage($activity,$origurl,$origsymb));
   73:     }
   74: 
   75:     $r->print(&Apache::loncommon::end_page());
   76: 
   77:     return OK;
   78: }
   79: 
   80: sub blockpage {
   81:     my ($activity,$origurl,$origsymb) = @_;
   82: 
   83:     # in case of a portfolio block we need to determine the owner of the files
   84:     # we're trying to look at. This information is passed via query string.
   85:     my ($uname, $udom);
   86: 
   87:     if (($activity eq 'port') ||
   88:         (($activity eq 'passwd') && ($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))) {
   89:         &Apache::loncommon::get_unprocessed_cgi(
   90:             $ENV{'QUERY_STRING'}, ['udom', 'uname'] );
   91: 
   92:         ($uname, $udom) = ($env{'form.uname'}, $env{'form.udom'});
   93:         if (($uname !~ /^$match_username$/) || ($udom !~ /^$match_domain$/)) {
   94:             if ($activity eq 'port') {
   95:                 return '<span class="LC_error">'.
   96:                        &mt('Information about the owner of the portfolio files you were trying to view was missing or invalid.').
   97:                        '</span><br />'.
   98:                        &mt('Without valid owner information, the reason why access is blocked can not be determined');
   99:             } else {
  100:                 return '<span class="LC_error">'.
  101:                        &mt('Information about the username and/or domain for which you were trying to reset a password was missing or invalid.').
  102:                        '</span><br />'.
  103:                        &mt('Without valid information, the reason why access is blocked can not be determined');
  104:             }
  105:         }
  106:     }
  107: 
  108:     # retrieve start/end of possible active blocking
  109:     my (%setters,$startblock,$endblock,$triggerblock);
  110: 
  111:     if ($activity eq 'docs') {
  112:         my ($cdom,$cnum);
  113:         if ($env{'request.course.id'}) {
  114:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  115:             $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  116:         }
  117:         my $cancheck;
  118:         if (($cdom ne '') && ($cnum ne '')) {
  119:             if ($origsymb =~ m{^uploaded/($match_domain)/($match_courseid)/}) {
  120:                 my ($crsdom,$crsnum) = ($1,$2);
  121:                 if (($cdom eq $crsdom) && ($cnum eq $crsnum)) {
  122:                     $cancheck = 1;
  123:                 }
  124:             } else {
  125:                 $cancheck = 1;
  126:             }
  127:         }
  128:         if ($cancheck) {
  129:             ($startblock,$endblock,$triggerblock) =
  130:                 &Apache::loncommon::blockcheck(\%setters,$activity,$cnum,$cdom,$origurl,1,$origsymb,'blockingstatus');
  131:         } else {
  132:             return '<p class="LC_info">'.&mt('Could not determine why access is blocked.').'</p>';
  133:         }
  134:     } else {
  135:         ($startblock,$endblock,$triggerblock) =
  136:             &Apache::loncommon::blockcheck(\%setters,$activity,$uname,$udom,$origurl,undef,$origsymb,'blockingstatus');
  137:     }
  138: 
  139:     # nothing to do if there's no active blocking
  140:     unless ($startblock && $endblock) {
  141:         if ($activity eq 'docs') {
  142:             return '<p class="LC_info">'.&mt('Content no longer blocked from access').'</p>';
  143:         }
  144:         return '<p class="LC_info">'.&mt('Access no longer blocked for this activity').'</p>';
  145:     }
  146: 
  147:     # lookup $activity -> description
  148:                    #possible activity          #corresponding description
  149:     my %descs = (
  150:                    boards     => 'Discussion posts in this course',
  151:                    chat       => 'Chat Room',
  152:                    com        => 'This message',
  153:                    blogs      => 'Blogs',
  154:                    groups     => 'Groups in this course',
  155:                    printout   => 'Printout generation',
  156:                    docs       => 'Course Content',
  157:                    passwd     => 'Changing of passwords',
  158:                    grades     => 'Course Gradebook',
  159:                    search     => 'Content Search',
  160:                 );
  161: 
  162:     if ($activity eq 'groups' || $activity eq 'boards') {
  163:         if (&Apache::loncommon::course_type() eq 'Community') {
  164:             $descs{'boards'} = 'Discussion posts in this community';
  165:             $descs{'groups'} = 'Groups in this community';
  166:             $descs{'docs'} = 'Community Content';
  167:             $descs{'grades'} = 'Community Gradebook';
  168:         }
  169:     }
  170: 
  171:     my $description = $descs{$activity};
  172:     if ($activity eq 'port') {
  173:         $description = &get_portfolio_category($uname,$udom,\%setters);
  174:     }
  175:     if ($description eq '') {
  176:         $description = 'Communication';
  177:     }
  178: 
  179:     my $showstart = Apache::lonlocal::locallocaltime($startblock);
  180:     my $showend   = Apache::lonlocal::locallocaltime($endblock);
  181: 
  182:     my $output;
  183: 
  184:     if ( ref($description) ne 'ARRAY' ) {
  185:         #default: $description is one of the above descriptions
  186:         if ($activity eq 'docs') {
  187:             $output=&mt( 'Access to the content page you are attempting to'
  188:                          . ' view will be unavailable between [_1] and [_2] because'
  189:                          . ' access to selected '.$description.' is being blocked.'
  190:                          ,$showstart, $showend);
  191:         } elsif (($activity eq 'printout') || ($activity eq 'passwd') ||
  192:                  ($activity eq 'grades') || ($activity eq 'search')) {
  193:             $output = mt( $description
  194:                           . ' will be unavailable between [_1] and [_2] because'
  195:                           . ' this functionality is being blocked.'
  196:                           ,$showstart, $showend);
  197:         } else {
  198:             $output = mt( $description
  199:                           . ' will be inaccessible between [_1] and [_2] because'
  200:                           . ' communication is being blocked.'
  201:                           ,$showstart, $showend);
  202:         }
  203:     } else {
  204:         # @$description is is the array returned from get_portfolio_category()
  205:         # and contains the description (e.g. "Portfolio files belonging to [_1]"
  206:         # and the value for [_1]
  207:         $output = mt( $$description[0]
  208:                       . ' will be inaccessible between [_2] and [_3] because'
  209:                       . ' communication is being blocked.'
  210:                      ,$$description[1], $showstart, $showend);
  211:     }
  212: 
  213:     $output = "<p class=\"LC_info\">$output</p>";
  214: 
  215:     # show a table containing details, except if user is trying to look
  216:     # at a different user's portfolio files
  217:     if (   $activity ne 'port'                        # no portfolio
  218:         || (   $uname eq $env{'user.name'}            # or own portfolio
  219:             && $udom  eq $env{'user.domain'} ) 
  220:         || Apache::lonnet::is_course($udom, $uname) ) # or portfolio of a course
  221:     {
  222:         $output .= &build_block_table(\%setters);
  223:     }
  224: 
  225:     return $output;
  226: }
  227: 
  228: sub build_block_table {
  229:     my ($setters) = @_;
  230:     my %lt = &Apache::lonlocal::texthash(
  231:         'cacb' => 'Currently active communication/content blocks',
  232:         'cour' => 'Course',
  233:         'dura' => 'Duration',
  234:         'blse' => 'Block set by'
  235:     );
  236:     my $output;
  237:     $output  = Apache::loncommon::start_data_table()
  238:              . Apache::loncommon::data_table_caption($lt{'cacb'})
  239:              . Apache::loncommon::start_data_table_header_row()
  240:              . "<th>$lt{'cour'}</th> <th>$lt{'dura'}</th> <th>$lt{'blse'}</th>"
  241:              . Apache::loncommon::end_data_table_header_row();
  242: 
  243:     foreach my $course (keys(%{$setters})) {
  244:         my %courseinfo=&Apache::lonnet::coursedescription($course);
  245:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
  246:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
  247:             my $fullname = Apache::loncommon::plainname($uname,$udom);
  248:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
  249:                 && $env{'user.name'} ne 'public'
  250:                 && $env{'user.domain'} ne 'public') 
  251:             {
  252:                 $fullname = Apache::loncommon::aboutmewrapper($fullname,$uname,$udom);
  253:             }
  254:             my $triggertype = $$setters{$course}{triggers}[$i];
  255:             if ($triggertype) {
  256:                 $fullname .= &mt(' (triggered by you when starting timer)');
  257:             }
  258:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
  259:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
  260:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
  261:             my $duration = mt('[_1] to [_2]', $openblock, $closeblock);
  262:             $output .= Apache::loncommon::start_data_table_row()
  263:                      . "<td>$courseinfo{'description'}</td>"
  264:                      . "<td>$duration</td>"
  265:                      . "<td>$fullname</td>"
  266:                      . Apache::loncommon::end_data_table_row();
  267:         }
  268:     }
  269:     $output .= Apache::loncommon::end_data_table();
  270: }
  271: 
  272: sub get_portfolio_category {
  273:     my ($uname, $udom, $setters) = @_;
  274: 
  275:     if ($uname eq $env{'user.name'} && $udom eq $env{'user.domain'}) {
  276:         # user's portolfio files
  277: 
  278:         return 'Your portfolio files';
  279: 
  280:     } elsif (Apache::lonnet::is_course($udom, $uname)) {
  281:         # group portfolio files
  282: 
  283:         my $coursedesc;
  284: 
  285:         foreach my $course (keys(%{$setters})) {
  286:             my %courseinfo = Apache::lonnet::coursedescription($course);
  287:             $coursedesc    = $courseinfo{'description'};
  288:         }
  289: 
  290:         return ["Group portfolio in the course '[_1]'", $coursedesc];
  291:         
  292:     } else {
  293:         # different user's portfolio files
  294:         
  295:         my $plainname = Apache::loncommon::plainname($uname, $udom);
  296: 
  297:         unless (   $env{'user.name'}   eq 'public' 
  298:                 && $env{'user.domain'} eq 'public' ) 
  299:         {
  300:             $plainname = Apache::loncommon::aboutmewrapper(
  301:                             $plainname, $uname, $udom);
  302:         }
  303: 
  304:         return ['Portfolio files belonging to [_1]', $plainname];
  305:     }
  306: }
  307: 
  308: 1;
  309: __END__

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