Annotation of loncom/interface/lonblockingstatus.pm, revision 1.15
1.1 droeschl 1: # The LearningOnline Network with CAPA
2: # displays the blocking status table
3: #
1.15 ! raeburn 4: # $Id: lonblockingstatus.pm,v 1.14 2020/01/23 23:48:12 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);
1.15 ! raeburn 47: map { $activities{$_} = 1; } ('boards','chat','com','blogs','groups','port','printout','docs','grades','passwd');
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:
1.11 raeburn 55: if (($activity eq 'docs') || ($activity eq 'printout')) {
1.8 raeburn 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:
1.13 raeburn 81: if (($activity eq 'port') ||
82: (($activity eq 'passwd') && ($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))) {
1.8 raeburn 83: &Apache::loncommon::get_unprocessed_cgi(
1.6 droeschl 84: $ENV{'QUERY_STRING'}, ['udom', 'uname'] );
85:
86: ($uname, $udom) = ($env{'form.uname'}, $env{'form.udom'});
1.8 raeburn 87: if (($uname !~ /^$match_username$/) || ($udom !~ /^$match_domain$/)) {
1.13 raeburn 88: if ($activity eq 'port') {
89: return '<span class="LC_error">'.
90: &mt('Information about the owner of the portfolio files you were trying to view was missing or invalid.').
91: '</span><br />'.
92: &mt('Without valid owner information, the reason why access is blocked can not be determined');
93: } else {
94: return '<span class="LC_error">'.
95: &mt('Information about the username and/or domain for which you were trying to reset a password was missing or invalid.').
96: '</span><br />'.
97: &mt('Without valid information, the reason why access is blocked can not be determined');
98: }
1.8 raeburn 99: }
1.6 droeschl 100: }
101:
102:
103: # retrieve start/end of possible active blocking
1.4 kalberla 104: my %setters;
1.8 raeburn 105: my ($startblock,$endblock,$triggerblock) =
1.9 raeburn 106: &Apache::loncommon::blockcheck(\%setters,$activity,$uname,$udom,$origurl);
1.6 droeschl 107:
108: # nothing to do if there's no active blocking
109: unless ($startblock && $endblock) { return ''; }
110:
111: # lookup $activity -> description
112: #possible activity #corresponding description
1.8 raeburn 113: my %descs = (
114: boards => 'Discussion posts in this course',
115: chat => 'Chat Room',
1.14 raeburn 116: com => 'This message',
1.8 raeburn 117: blogs => 'Blogs',
118: groups => 'Groups in this course',
1.11 raeburn 119: printout => 'Printout generation',
1.8 raeburn 120: docs => 'Course Content',
1.13 raeburn 121: passwd => 'Changing of passwords',
1.15 ! raeburn 122: grades => 'Course Gradebook',
1.8 raeburn 123: );
124:
125: if ($activity eq 'groups' || $activity eq 'boards') {
1.12 raeburn 126: if (&Apache::loncommon::course_type() eq 'Community') {
1.15 ! raeburn 127: $descs{'boards'} = 'Discussion posts in this community';
! 128: $descs{'groups'} = 'Groups in this community';
! 129: $descs{'docs'} = 'Community Content';
! 130: $descs{'grades'} = 'Community Gradebook';
1.8 raeburn 131: }
132: }
133:
134: my $description = $descs{$activity};
135: if ($activity eq 'port') {
136: $description = &get_portfolio_category($uname,$udom,\%setters);
137: }
138: if ($description eq '') {
139: $description = 'Communication';
140: }
1.6 droeschl 141:
142: my $showstart = Apache::lonlocal::locallocaltime($startblock);
143: my $showend = Apache::lonlocal::locallocaltime($endblock);
144:
145: my $output;
146:
1.8 raeburn 147: if ( ref($description) ne 'ARRAY' ) {
1.6 droeschl 148: #default: $description is one of the above descriptions
1.8 raeburn 149: if ($activity eq 'docs') {
1.9 raeburn 150: $output=&mt( 'Access to the content page you are attempting to'
1.8 raeburn 151: . ' view will be unavailable between [_1] and [_2] because'
1.10 raeburn 152: . ' access to selected '.$description.' is being blocked.'
1.8 raeburn 153: ,$showstart, $showend);
1.15 ! raeburn 154: } elsif (($activity eq 'printout') || ($activity eq 'passwd') || ($activity eq 'grades')) {
1.11 raeburn 155: $output = mt( $description
156: . ' will be unavailable between [_1] and [_2] because'
157: . ' this functionality is being blocked.'
158: ,$showstart, $showend);
1.8 raeburn 159: } else {
160: $output = mt( $description
161: . ' will be inaccessible between [_1] and [_2] because'
162: . ' communication is being blocked.'
163: ,$showstart, $showend);
164: }
1.6 droeschl 165: } else {
166: # @$description is is the array returned from get_portfolio_category()
167: # and contains the description (e.g. "Portfolio files belonging to [_1]"
168: # and the value for [_1]
169: $output = mt( $$description[0]
170: . ' will be inaccessible between [_2] and [_3] because'
171: . ' communication is being blocked.'
172: ,$$description[1], $showstart, $showend)
173: }
174:
175: $output = "<p class=\"LC_info\">$output</p>";
176:
177: # show a table containing details, except if user is trying to look
178: # at a different user's portfolio files
179: if ( $activity ne 'port' # no portfolio
180: || ( $uname eq $env{'user.name'} # or own portfolio
181: && $udom eq $env{'user.domain'} )
182: || Apache::lonnet::is_course($udom, $uname) ) # or portfolio of a course
183: {
1.8 raeburn 184: $output .= &build_block_table(\%setters);
1.4 kalberla 185: }
1.6 droeschl 186:
1.5 kalberla 187: return $output;
188: }
189:
190: sub build_block_table {
1.8 raeburn 191: my ($setters) = @_;
1.5 kalberla 192: my %lt = &Apache::lonlocal::texthash(
1.11 raeburn 193: 'cacb' => 'Currently active communication/content blocks',
1.5 kalberla 194: 'cour' => 'Course',
195: 'dura' => 'Duration',
196: 'blse' => 'Block set by'
197: );
198: my $output;
1.6 droeschl 199: $output = Apache::loncommon::start_data_table()
200: . Apache::loncommon::data_table_caption($lt{'cacb'})
201: . Apache::loncommon::start_data_table_header_row()
202: . "<th>$lt{'cour'}</th> <th>$lt{'dura'}</th> <th>$lt{'blse'}</th>"
203: . Apache::loncommon::end_data_table_header_row();
204:
1.5 kalberla 205: foreach my $course (keys(%{$setters})) {
206: my %courseinfo=&Apache::lonnet::coursedescription($course);
207: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
208: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
209: my $fullname = Apache::loncommon::plainname($uname,$udom);
210: if (defined($env{'user.name'}) && defined($env{'user.domain'})
211: && $env{'user.name'} ne 'public'
1.6 droeschl 212: && $env{'user.domain'} ne 'public')
213: {
1.5 kalberla 214: $fullname = Apache::loncommon::aboutmewrapper($fullname,$uname,$udom);
215: }
1.11 raeburn 216: my $triggertype = $$setters{$course}{triggers}[$i];
1.8 raeburn 217: if ($triggertype) {
218: $fullname .= &mt(' (triggered by you when starting timer)');
219: }
1.5 kalberla 220: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
221: $openblock = &Apache::lonlocal::locallocaltime($openblock);
222: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
1.6 droeschl 223: my $duration = mt('[_1] to [_2]', $openblock, $closeblock);
224: $output .= Apache::loncommon::start_data_table_row()
225: . "<td>$courseinfo{'description'}</td>"
226: . "<td>$duration</td>"
227: . "<td>$fullname</td>"
228: . Apache::loncommon::end_data_table_row();
1.5 kalberla 229: }
230: }
231: $output .= Apache::loncommon::end_data_table();
1.4 kalberla 232: }
1.1 droeschl 233:
1.6 droeschl 234: sub get_portfolio_category {
235: my ($uname, $udom, $setters) = @_;
236:
237: if ($uname eq $env{'user.name'} && $udom eq $env{'user.domain'}) {
238: # user's portolfio files
239:
240: return 'Your portfolio files';
241:
242: } elsif (Apache::lonnet::is_course($udom, $uname)) {
243: # group portfolio files
244:
245: my $coursedesc;
246:
247: foreach my $course (keys(%{$setters})) {
248: my %courseinfo = Apache::lonnet::coursedescription($course);
249: $coursedesc = $courseinfo{'description'};
250: }
251:
252: return ["Group portfolio in the course '[_1]'", $coursedesc];
253:
254: } else {
255: # different user's portfolio files
256:
257: my $plainname = Apache::loncommon::plainname($uname, $udom);
258:
259: unless ( $env{'user.name'} eq 'public'
260: && $env{'user.domain'} eq 'public' )
261: {
262: $plainname = Apache::loncommon::aboutmewrapper(
263: $plainname, $uname, $udom);
264: }
265:
266: return ['Portfolio files belonging to [_1]', $plainname];
267: }
268: }
269:
1.1 droeschl 270: 1;
271: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>