File:
[LON-CAPA] /
loncom /
interface /
lonblockingstatus.pm
Revision
1.8:
download - view:
text,
annotated -
select for diffs
Sat Mar 31 14:19:24 2012 UTC (12 years, 3 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Bug 6518
- Exam blocks can also block access to specified folders and/or resources
for the duration of an exam.
- The start time for blocking can be based on activation of the timer for
a specific timed quiz item (map or resource specific).
1: # The LearningOnline Network with CAPA
2: # displays the blocking status table
3: #
4: # $Id: lonblockingstatus.pm,v 1.8 2012/03/31 14:19:24 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);
47: map { $activities{$_} = 1; } ('boards','chat','msgdisplay','blogs','groups','port','docs');
48:
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: }
67:
68: $r->print(&Apache::loncommon::end_page());
69:
70: return OK;
71: }
72:
73:
74: sub blockpage {
75: my ($activity,$origurl) = @_;
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') {
82: &Apache::loncommon::get_unprocessed_cgi(
83: $ENV{'QUERY_STRING'}, ['udom', 'uname'] );
84:
85: ($uname, $udom) = ($env{'form.uname'}, $env{'form.udom'});
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: }
92: }
93:
94:
95: # retrieve start/end of possible active blocking
96: my %setters;
97: my ($startblock,$endblock,$triggerblock) =
98: &Apache::loncommon::blockcheck(\%setters,$activity,$uname,$udom,$url);
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
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: }
129:
130: my $showstart = Apache::lonlocal::locallocaltime($startblock);
131: my $showend = Apache::lonlocal::locallocaltime($endblock);
132:
133: my $output;
134:
135: if ( ref($description) ne 'ARRAY' ) {
136: #default: $description is one of the above descriptions
137: if ($activity eq 'docs') {
138: $output=&mt( 'Access to the content page you are attempting to
139: . ' view will be unavailable between [_1] and [_2] because'
140: . ' access to selected $description is being blocked.'
141: ,$showstart, $showend);
142: }
143: } else {
144: $output = mt( $description
145: . ' will be inaccessible between [_1] and [_2] because'
146: . ' communication is being blocked.'
147: ,$showstart, $showend);
148: }
149: } else {
150: # @$description is is the array returned from get_portfolio_category()
151: # and contains the description (e.g. "Portfolio files belonging to [_1]"
152: # and the value for [_1]
153: $output = mt( $$description[0]
154: . ' will be inaccessible between [_2] and [_3] because'
155: . ' communication is being blocked.'
156: ,$$description[1], $showstart, $showend)
157: }
158:
159: $output = "<p class=\"LC_info\">$output</p>";
160:
161: # show a table containing details, except if user is trying to look
162: # at a different user's portfolio files
163: if ( $activity ne 'port' # no portfolio
164: || ( $uname eq $env{'user.name'} # or own portfolio
165: && $udom eq $env{'user.domain'} )
166: || Apache::lonnet::is_course($udom, $uname) ) # or portfolio of a course
167: {
168: $output .= &build_block_table(\%setters);
169: }
170:
171: return $output;
172: }
173:
174: sub build_block_table {
175: my ($setters) = @_;
176: my %lt = &Apache::lonlocal::texthash(
177: 'cacb' => 'Currently active communication blocks',
178: 'cour' => 'Course',
179: 'dura' => 'Duration',
180: 'blse' => 'Block set by'
181: );
182: my $output;
183: $output = Apache::loncommon::start_data_table()
184: . Apache::loncommon::data_table_caption($lt{'cacb'})
185: . Apache::loncommon::start_data_table_header_row()
186: . "<th>$lt{'cour'}</th> <th>$lt{'dura'}</th> <th>$lt{'blse'}</th>"
187: . Apache::loncommon::end_data_table_header_row();
188:
189: foreach my $course (keys(%{$setters})) {
190: my %courseinfo=&Apache::lonnet::coursedescription($course);
191: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
192: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
193: my $fullname = Apache::loncommon::plainname($uname,$udom);
194: if (defined($env{'user.name'}) && defined($env{'user.domain'})
195: && $env{'user.name'} ne 'public'
196: && $env{'user.domain'} ne 'public')
197: {
198: $fullname = Apache::loncommon::aboutmewrapper($fullname,$uname,$udom);
199: }
200: my $triggertype = $$setters{$course}{times}[$i];
201: if ($triggertype) {
202: $fullname .= &mt(' (triggered by you when starting timer)');
203: }
204: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
205: $openblock = &Apache::lonlocal::locallocaltime($openblock);
206: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
207: my $duration = mt('[_1] to [_2]', $openblock, $closeblock);
208: $output .= Apache::loncommon::start_data_table_row()
209: . "<td>$courseinfo{'description'}</td>"
210: . "<td>$duration</td>"
211: . "<td>$fullname</td>"
212: . Apache::loncommon::end_data_table_row();
213: }
214: }
215: $output .= Apache::loncommon::end_data_table();
216: }
217:
218: sub get_portfolio_category {
219: my ($uname, $udom, $setters) = @_;
220:
221: if ($uname eq $env{'user.name'} && $udom eq $env{'user.domain'}) {
222: # user's portolfio files
223:
224: return 'Your portfolio files';
225:
226: } elsif (Apache::lonnet::is_course($udom, $uname)) {
227: # group portfolio files
228:
229: my $coursedesc;
230:
231: foreach my $course (keys(%{$setters})) {
232: my %courseinfo = Apache::lonnet::coursedescription($course);
233: $coursedesc = $courseinfo{'description'};
234: }
235:
236: return ["Group portfolio in the course '[_1]'", $coursedesc];
237:
238: } else {
239: # different user's portfolio files
240:
241: my $plainname = Apache::loncommon::plainname($uname, $udom);
242:
243: unless ( $env{'user.name'} eq 'public'
244: && $env{'user.domain'} eq 'public' )
245: {
246: $plainname = Apache::loncommon::aboutmewrapper(
247: $plainname, $uname, $udom);
248: }
249:
250: return ['Portfolio files belonging to [_1]', $plainname];
251: }
252: }
253:
254: 1;
255: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>