version 1.14, 2006/12/04 14:59:56
|
version 1.32, 2023/06/20 14:03:52
|
Line 1
|
Line 1
|
# The LearningOnline Network with CAPA |
# The LearningOnline Network with CAPA |
# accessor routines used to provide information about course groups |
# accessor routines used to provide information about course groups |
# |
# |
|
# $Id$ |
|
# |
# Copyright Michigan State University Board of Trustees |
# Copyright Michigan State University Board of Trustees |
# |
# |
# This file is part of the LearningOnline Network with CAPA (LON-CAPA). |
# This file is part of the LearningOnline Network with CAPA (LON-CAPA). |
Line 28 package Apache::longroup;
|
Line 30 package Apache::longroup;
|
|
|
use strict; |
use strict; |
use Apache::lonnet; |
use Apache::lonnet; |
|
use Apache::lonlocal; |
|
use LONCAPA; |
|
|
############################################### |
############################################### |
=pod |
=pod |
Line 58 can be sent to &get_group_settings() to
|
Line 62 can be sent to &get_group_settings() to
|
|
|
Side effects: |
Side effects: |
None. |
None. |
|
|
=cut |
=cut |
|
|
############################################### |
############################################### |
Line 89 sub coursegroups {
|
Line 94 sub coursegroups {
|
|
|
############################################### |
############################################### |
|
|
|
=pod |
|
|
=item get_group_settings |
=item get_group_settings |
|
|
Uses TokeParser to extract group information from the |
Uses TokeParser to extract group information from the |
Line 196 Input:
|
Line 203 Input:
|
4. Role |
4. Role |
5. End date of role |
5. End date of role |
6. Start date of role |
6. Start date of role |
|
7. Selfenroll |
|
8. Context |
|
|
Checks to see if role for which assignment is being made is in a course. |
Checks to see if role for which assignment is being made is in a course. |
If so, gathers information about auto-group population settings for |
If so, gathers information about auto-group population settings for |
Line 209 for the course is included amongst the u
|
Line 218 for the course is included amongst the u
|
and would trigger membership in teh same group(s) |
and would trigger membership in teh same group(s) |
|
|
If role is being added, will add any group memberships specified |
If role is being added, will add any group memberships specified |
for auto-group population, unless use is already a group member. |
for auto-group population, unless user is already a group member. |
Uses default group privileges and default start and end group access |
Uses default group privileges and default start and end group access |
times. |
times. |
|
|
|
Flag for selfenroll (value of 1), and context (auto, updatenow, |
|
automated, course, domain etc.) can be used to log the reason for |
|
the role change. |
|
|
Output |
Output |
None |
None |
Line 224 or expire group membership(s) for a user
|
Line 237 or expire group membership(s) for a user
|
=cut |
=cut |
|
|
sub group_changes { |
sub group_changes { |
my ($udom,$uname,$url,$role,$origend,$origstart) = @_; |
my ($udom,$uname,$url,$role,$origend,$origstart,$selfenroll,$context, |
|
$othdomby,$requester) = @_; |
my $now = time; |
my $now = time; |
my $chgtype; |
my $chgtype; |
if ($origend > 0 && $origend <= $now) { |
if ($origend > 0 && $origend <= $now) { |
Line 239 sub group_changes {
|
Line 253 sub group_changes {
|
} else { |
} else { |
$cid = $url; |
$cid = $url; |
} |
} |
my $courseid = $cid; |
|
$courseid =~ s|^/||; |
|
$courseid =~ s|/|_|; |
|
my %crshash=&Apache::lonnet::coursedescription($cid); |
my %crshash=&Apache::lonnet::coursedescription($cid); |
$cdom = $crshash{'domain'}; |
$cdom = $crshash{'domain'}; |
$cnum = $crshash{'num'}; |
$cnum = $crshash{'num'}; |
Line 279 sub group_changes {
|
Line 290 sub group_changes {
|
if (@changegroups > 0) { |
if (@changegroups > 0) { |
my %currpriv; |
my %currpriv; |
my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,$cid); |
my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,$cid); |
if (my $tmp = &Apache::lonnet::error(%roleshash)) { |
if (keys(%roleshash) > 0) { |
&Apache::lonnet::logthis('Error retrieving roles: '.$tmp. |
|
' for '.$uname.':'.$udom); |
|
} else { |
|
my $group_privs = ''; |
my $group_privs = ''; |
foreach my $group (@changegroups) { |
foreach my $group (@changegroups) { |
if ($chgtype eq 'add') { |
if ($chgtype eq 'add') { |
Line 336 sub group_changes {
|
Line 344 sub group_changes {
|
$add,$uname.':'.$udom, |
$add,$uname.':'.$udom, |
$settings{$add}{'enddate'}, |
$settings{$add}{'enddate'}, |
$settings{$add}{'startdate'}, |
$settings{$add}{'startdate'}, |
$group_privs) eq 'ok') { |
$group_privs,$selfenroll,$context, |
|
$othdomby,$requester) eq 'ok') { |
my %usersettings; |
my %usersettings; |
$usersettings{$add.':'.$uname.':'.$udom} = |
$usersettings{$add.':'.$uname.':'.$udom} = |
$addgroup{$add}; |
$addgroup{$add}; |
Line 405 sub group_changes {
|
Line 414 sub group_changes {
|
$cnum,$drop, |
$cnum,$drop, |
$uname.':'.$udom,$now, |
$uname.':'.$udom,$now, |
$dropstart{$drop}, |
$dropstart{$drop}, |
$currpriv{$drop}) |
$currpriv{$drop}, |
|
$selfenroll,$context, |
|
$othdomby,$requester) |
eq 'ok') { |
eq 'ok') { |
my %usersettings; |
my %usersettings; |
$usersettings{$drop.':'.$uname.':'.$udom} = |
$usersettings{$drop.':'.$uname.':'.$udom} = |
Line 427 sub group_changes {
|
Line 438 sub group_changes {
|
|
|
sub get_fixed_privs { |
sub get_fixed_privs { |
my $fixedprivs = { |
my $fixedprivs = { |
email => {sgm => 1}, |
email => {sgm => 1}, |
discussion => {vgb => 1}, |
discussion => {vgb => 1}, |
chat => {pgc => 1}, |
chat => {pgc => 1}, |
files => {rgf => 1}, |
files => {rgf => 1}, |
roster => {vgm => 1}, |
roster => {vgm => 1}, |
homepage => {vgh => 1}, |
homepage => {vgh => 1}, |
}; |
}; |
return $fixedprivs; |
return $fixedprivs; |
} |
} |
Line 442 sub get_fixed_privs {
|
Line 453 sub get_fixed_privs {
|
sub get_tool_privs { |
sub get_tool_privs { |
my ($gpterm) = @_; |
my ($gpterm) = @_; |
my $toolprivs = { |
my $toolprivs = { |
email => { |
email => { |
sgm => 'Send '.$gpterm.' mail', |
sgm => 'Send '.$gpterm.' message', |
sgb => 'Broadcast mail', |
sgb => 'Broadcast message', |
}, |
}, |
discussion => { |
discussion => { |
cgb => 'Create boards', |
cgb => 'Create boards', |
Line 454 sub get_tool_privs {
|
Line 465 sub get_tool_privs {
|
vgb => 'View boards', |
vgb => 'View boards', |
}, |
}, |
chat => { |
chat => { |
pgc => 'Chat', |
pgc => 'Chat Room', |
}, |
}, |
files => { |
files => { |
rgf => 'Retrieve', |
rgf => 'Retrieve', |
Line 633 sub get_bbfolder_url {
|
Line 644 sub get_bbfolder_url {
|
|
|
sub get_group_bbinfo { |
sub get_group_bbinfo { |
my ($cdom,$cnum,$group,$boardurl) = @_; |
my ($cdom,$cnum,$group,$boardurl) = @_; |
|
my @groupboards = (); |
|
my %boardshash = (); |
my $navmap = Apache::lonnavmaps::navmap->new(); |
my $navmap = Apache::lonnavmaps::navmap->new(); |
my @groupboards; |
if (defined($navmap)) { |
my %boardshash; |
my $grpbbmap = &get_bbfolder_url($cdom,$cnum,$group); |
my $grpbbmap = &get_bbfolder_url($cdom,$cnum,$group); |
if ($grpbbmap) { |
if ($grpbbmap) { |
my $bbfolderres = $navmap->getResourceByUrl($grpbbmap); |
my $bbfolderres = $navmap->getResourceByUrl($grpbbmap); |
if ($bbfolderres) { |
if ($bbfolderres) { |
my @boards = $navmap->retrieveResources($bbfolderres,undef,0,0); |
my @boards = $navmap->retrieveResources($bbfolderres,undef,0,0); |
foreach my $res (@boards) { |
foreach my $res (@boards) { |
my $url = $res->src(); |
my $url = $res->src(); |
if ($url =~ m|^(/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard)|) { |
if ($url =~ m|^(/adm/\Q$cdom\E/\Q$cnum\E/\d+/bulletinboard)|) { |
if ($boardurl) { |
if ($boardurl) { |
if ($boardurl =~ /^\Q$1\E/) { |
if ($boardurl =~ /^\Q$1\E/) { |
push(@groupboards,$res->symb()); |
push(@groupboards,$res->symb()); |
$boardshash{$res->symb()} = { |
$boardshash{$res->symb()} = { |
|
title => $res->title(), |
title => $res->title(), |
url => $res->src(), |
url => $res->src(), |
}; |
}; |
last; |
last; |
} |
} |
} else { |
} else { |
push(@groupboards,$res->symb()); |
push(@groupboards,$res->symb()); |
$boardshash{$res->symb()} = { |
$boardshash{$res->symb()} = { |
title => $res->title(), |
title => $res->title(), |
url => $res->src(), |
url => $res->src(), |
}; |
}; |
|
} |
} |
} |
} |
} |
} |
} |
} |
} |
|
undef($navmap); |
|
} else { |
|
&Apache::lonnet::logthis('Retrieval of group boards failed - could not create navmap object for group: '.$group.' in course: '.$cdom.':'.$cnum); |
} |
} |
undef($navmap); |
|
return (\@groupboards,\%boardshash); |
return (\@groupboards,\%boardshash); |
} |
} |
|
|
############################################### |
############################################### |
|
|
|
sub get_group_link { |
|
my ($cdom,$cnum,$group,$navmap,$view_permission,$refarg) = @_; |
|
if (ref($navmap)) { |
|
my $map = "uploaded/$cdom/$cnum/group_folder_"."$group.sequence"; |
|
my $mapres = $navmap->getResourceByUrl("/$map"); |
|
my $hidden; |
|
if (ref($mapres)) { |
|
if ((!$view_permission) && ($mapres->randomout())) { |
|
$hidden = 1; |
|
} |
|
} |
|
my $url = "adm/$cdom/$cnum/$group/smppg"; |
|
my $idx = '1'; |
|
my $symb = $map.'___'.$idx.'___'.$url; |
|
my $res = $navmap->getBySymb($symb); |
|
$url = "/$url"; |
|
$map = "/$map"; |
|
my $link; |
|
if (ref($res)) { |
|
if ((!$view_permission) && ($res->randomout())) { |
|
$hidden = 1; |
|
} else { |
|
$hidden = 0; |
|
if ($refarg) { |
|
$link = $url.'?'.$refarg; |
|
} else { |
|
$link = $res->link(); |
|
$link .= (($link=~/\?/)?'&':'?').'symb='.$res->shown_symb(); |
|
} |
|
} |
|
} elsif (&Apache::lonnet::is_on_map($url)) { |
|
unless ($hidden) { |
|
$link = $url; |
|
if ($refarg) { |
|
$link = $url.'?'.$refarg; |
|
} |
|
} |
|
} |
|
if (wantarray) { |
|
return ($link,$hidden); |
|
} else { |
|
return $link; |
|
} |
|
} |
|
return; |
|
} |
|
|
|
############################################### |
|
|
|
sub display_group_links { |
|
my ($r,$target,$group,$context,$refarg,$numtoolsref,$hidehdr,%groupinfo) = @_; |
|
my @available = (); |
|
my %menu = (); |
|
%{$menu{'email'}} = ( |
|
text => 'Group Message', |
|
href => '/adm/email?compose=group&group='.$group. |
|
$refarg, |
|
); |
|
%{$menu{'discussion'}} = ( |
|
text => 'Discussion Boards', |
|
href => '/adm/groupboards?group='.$group.$refarg, |
|
); |
|
%{$menu{'chat'}} = ( |
|
text => 'Group Chat Room', |
|
href => "javascript:group_chat('$group')", |
|
); |
|
%{$menu{'files'}} = ( |
|
text => 'Group Portfolio', |
|
href => '/adm/coursegrp_portfolio?group='.$group. |
|
$refarg, |
|
); |
|
%{$menu{'roster'}} = ( |
|
text => 'Membership Roster', |
|
href => '/adm/grouproster?group='.$group.$refarg, |
|
); |
|
foreach my $tool (sort(keys(%menu))) { |
|
if ($groupinfo{functions}{$tool} eq 'on') { |
|
push(@available,$tool); |
|
} |
|
} |
|
my $output = ''; |
|
if (ref($numtoolsref) eq 'SCALAR') { |
|
$$numtoolsref = scalar(@available); |
|
} |
|
if (@available > 0) { |
|
if ($target eq 'tex') { |
|
$output = '<table cellspacing="4" cellpadding="4">'; |
|
} else { |
|
$output = &Apache::loncommon::start_data_table(); |
|
} |
|
foreach my $tool (@available) { |
|
if ($target eq 'tex') { |
|
$output .= '<tr><td>'.&mt($menu{$tool}{text}).'</td></tr>'; |
|
} else { |
|
$output .= &Apache::loncommon::start_data_table_row() |
|
.'<td><a href="'.$menu{$tool}{href}.'">' |
|
.&mt($menu{$tool}{text}).'</a></td>' |
|
.&Apache::loncommon::end_data_table_row(); |
|
} |
|
} |
|
if ($target eq 'tex') { |
|
$output .= '</table>'; |
|
} else { |
|
$output .= &Apache::loncommon::end_data_table(); |
|
} |
|
if ($target eq 'tex') { |
|
$output = &Apache::lonxml::xmlparse($r,'tex',&mt('Available functions').'<br /><br />'.$output); |
|
} else { |
|
unless ($hidehdr) { |
|
$output = '<h3>'.&mt('Available Group Tools').'</h3>'.$output; |
|
} |
|
} |
|
} else { |
|
if ($context eq 'edit') { |
|
$output = &mt('No group functionality.'); |
|
} else { |
|
$output = &mt('No group functionality (e.g., e-mail, discussion, chat room or file upload) is currently available to you in this group: [_1].', |
|
'<b>'.&unescape($groupinfo{'description'}).'</b>'); |
|
} |
|
if ($target eq 'tex') { |
|
$output = &Apache::lonxml::xmlparse($r,'tex',$output); |
|
} |
|
} |
|
return $output; |
|
} |
|
|
1; |
1; |
|
|