Return to groupboards.pm CVS log

Up to [LON-CAPA] / loncom / interface

- Modifications to facilitate translation.

    1: # The LearningOnline Network
    2: # Group Bulletin Boards Manager
    3: #
    4: # $Id: groupboards.pm,v 1.21 2013/11/23 20:40:57 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::groupboards;
   30: 
   31: use strict;
   32: use Apache::Constants qw(:common :http);
   33: use Apache::loncommon();
   34: use Apache::lonnet;
   35: use Apache::lonuserstate();
   36: use LONCAPA::map();
   37: use Apache::lonlocal;
   38: use LONCAPA;
   39: 
   40: sub handler {
   41:     my ($r) = @_;
   42:     &Apache::loncommon::content_type($r,'text/html');
   43:     $r->send_http_header;
   44:     return OK if $r->header_only;
   45: 
   46:     #  Needs to be in a course
   47:     if (! ($env{'request.course.fn'})) {
   48:         # Not in a course
   49:         $env{'user.error.msg'}=
   50:      "/adm/groupboards:mdg:0:0:Cannot edit or view course groups";
   51:         return HTTP_NOT_ACCEPTABLE;
   52:     }
   53: 
   54:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
   55:                         ['group','ref']);
   56: 
   57:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
   58:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
   59:     my $now = time;
   60:     my $crstype = &Apache::loncommon::course_type();
   61:     my $gpterm =  &Apache::loncommon::group_term();
   62:     my $ucgpterm = $gpterm;
   63:     $ucgpterm =~ s/^(\w)/uc($1)/e;
   64:     my $bodytitle = $ucgpterm.' Discussion Boards';
   65:     my $group = $env{'form.group'};
   66:     $group =~ s/\W//g;
   67:     my ($description,$earlyout,$refarg);
   68: 
   69:     if (exists($env{'form.ref'})) {
   70:         $refarg = 'ref='.$env{'form.ref'};
   71:     }
   72: 
   73:     &Apache::lonhtmlcommon::clear_breadcrumbs();
   74:     if (!defined($group)) {
   75:         $earlyout = &mt("No $gpterm defined, so there are no $gpterm discussion boards to display");
   76:         $r->print(&display_error($cdom,$cnum,$group,$description,$gpterm,
   77:                                  $ucgpterm,$bodytitle,$earlyout,$refarg));
   78:         return OK;
   79:     }
   80:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum,$group);
   81:     if (!defined($curr_groups{$group})) {
   82:         $earlyout = &mt('Invalid group');
   83:         $r->print(&display_error($cdom,$cnum,$group,$description,$gpterm,
   84:                                  $ucgpterm,$bodytitle,$earlyout,$refarg));
   85:         return OK;
   86:     }
   87:     my %content = &Apache::longroup::get_group_settings($curr_groups{$group});
   88:     $description = &unescape($content{'description'});
   89: 
   90:     my $can_create=&Apache::lonnet::allowed('cgb',$env{'request.course.id'}.
   91:                                             '/'.$group);
   92:     my $can_view = &Apache::lonnet::allowed('vcg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
   93: 
   94:     if (!$can_view) {
   95:         $can_view = &Apache::lonnet::allowed('vgb',$env{'request.course.id'}.
   96:                                           '/'.$group);
   97:     }
   98:     if (!$can_view) {
   99:         $earlyout=&mt("You do not have privileges to view discussion boards in this $gpterm");
  100:         $r->print(&display_error($cdom,$cnum,$group,$description,$gpterm,
  101:                                  $ucgpterm,$bodytitle,$earlyout,$refarg));
  102:         return OK;
  103:     }
  104:     if (defined($env{'form.newbul'})) {
  105:         if (($can_create) || (&Apache::lonnet::allowed('mdg',$env{'request.course.id'}))) {
  106:             $r->print(&boards_header($cdom,$cnum,$group,$description,$gpterm,
  107:                                      $ucgpterm,$bodytitle,$refarg));
  108:             my ($outcome,$newurl,$bbtitle,$lockfreed) = 
  109: 		&create_board($cdom,$cnum,$group,$env{'form.newbul'});
  110:             if ($outcome eq 'ok') {
  111:                 my ($furl,$ferr)= &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
  112:                 $r->print(&mt('The new discussion board was added successfully.').'<br />');
  113:                 $r->print('<table border="0"><tr><td>'.
  114:                           '<a href="'.$newurl.'?group='.$group.'&amp;'.$refarg.
  115:                           '">'.&mt('Edit [_1] board',$bbtitle).'</a></td>'.
  116:                            '<td>&nbsp;&nbsp;</td><td>'.
  117:                           '<a href="/adm/groupboards?group='.$group.'&amp;'.
  118:                           $refarg.'">'.&mt('View all group discussion boards').
  119:                           '</a></td></tr></table>');
  120:                 if ($lockfreed ne 'ok') {
  121:                     $r->print(&mt('There was a problem removing a lockfile for the group ([_1]).',$description).'<br />'.
  122:                               &mt('This may prevent creation of additional discussion boards in this group.').'<br />'.
  123:                               &mt('Please contact the [_1]helpdesk[_2] for assistance.',
  124:                                   '<a href="/adm/helpdesk">','</a>')
  125:                              );
  126:                 }
  127:             } else {
  128:                 $r->print(&mt('There was a problem creating the new discussion board - [_1]','<span class="LC_error">'.$outcome.'</span>').'<br /><a href="/adm/groupboards?group='.$group.'">'.
  129:                          &mt('Return to discussion boards').'</a>');
  130:             }
  131:             $r->print(&Apache::loncommon::end_page());
  132:             return OK;
  133:         }
  134:     }
  135:     my $jscript;
  136:     if (($can_create) || (&Apache::lonnet::allowed('mdg',$env{'request.course.id'}))) {
  137:         $jscript = qq|
  138: <script type="text/javascript">
  139: function makebulboard() {
  140:    var title=prompt('Discussion Board Title');
  141:    if (title) {
  142:     this.document.forms.newbb.newbul.value=title;
  143:     this.document.forms.newbb.submit();
  144:    }
  145: }
  146: </script>
  147: |;
  148:     }
  149:     $r->print(&boards_header($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,
  150:                              $bodytitle,$refarg,$jscript));
  151:     my ($groupboards,$boards) = &Apache::longroup::get_group_bbinfo($cdom,$cnum,
  152:                                                                     $group);
  153:     if (($can_create) || (&Apache::lonnet::allowed('mdg',$env{'request.course.id'}))) {
  154:         $r->print('<br /><form method="post" name="newbb" action="/adm/groupboards">'.
  155:                   "\n".'<input type="button" name="bbbutton" value="'.
  156:                   &mt('New Discussion Board').
  157:                   '" onclick="javascript:makebulboard();" />'."\n".
  158:                   '<input type="hidden" name="newbul" />'."\n".
  159:                   '<input type="hidden" name="group" value="'.$group.'" />'.
  160:                   '<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />'.
  161:                   "\n".'</form><br />');
  162:     }
  163:     if (@{$groupboards} > 0) {
  164:         $r->print('<br />'
  165:                  .&Apache::loncommon::start_data_table()
  166:                  .&Apache::loncommon::start_data_table_header_row()
  167:                  .'<th>'.&mt('Discussion Boards').'</th>'
  168:                  .&Apache::loncommon::end_data_table_header_row()
  169:         );
  170:         foreach my $board (@{$groupboards}) {
  171:             my $board_url = $$boards{$board}{'url'};
  172:             if ($board_url =~ /\?/) {
  173:                 $board_url .= '&amp;group='.$group;
  174:             } else {
  175:                 $board_url .= '?group='.$group;
  176:             }
  177:             $r->print(&Apache::loncommon::start_data_table_row()
  178:                      .'<td>'
  179:                      .'<a href="'.$board_url.'&amp;'.$refarg.'">'
  180:                      .$$boards{$board}{'title'}.'</a>'
  181:                      .'</td>'
  182:                      .&Apache::loncommon::end_data_table_row()
  183:             );
  184:         }
  185:         $r->print(&Apache::loncommon::end_data_table());
  186:     } else {
  187:         $r->print('<p class="LC_info">'
  188:                  .&mt('There are currently no discussion boards in this '.$gpterm.'.',)
  189:                  .'</p>'
  190:         );
  191:     }
  192:     $r->print(&Apache::loncommon::end_page());
  193:     return OK;
  194: }
  195: 
  196: sub create_board {
  197:     my ($cdom,$cnum,$group,$bbtitle) = @_;
  198:     my ($outcome,$newurl,$idtype);
  199:     $bbtitle=&unescape($bbtitle);
  200:     $idtype = 'inc';
  201:     my ($boardid,$dellock,$error) = 
  202:         &Apache::lonnet::get_timebased_id($group,'boardids','groupboards',
  203:                                           $cdom,$cnum);
  204:     if ($boardid) {
  205:          $newurl = '/adm/'.$cdom.'/'.$cnum.'/'.$boardid.'/bulletinboard';
  206:     } else {
  207:          return ($error,$newurl,$bbtitle,$dellock);
  208:     }
  209: 
  210:     # need to check here if group_boards_$group.sequence is in the course
  211:     # if not - add it as an item in group_folder_$group.sequence 
  212:     my $allbbsmap = &Apache::longroup::get_bbfolder_url($cdom,$cnum,$group);
  213:     if ($allbbsmap =~ m|^/uploaded|) {
  214:         my ($errtext,$fatal)=&LONCAPA::map::mapread($allbbsmap);
  215:         if (!$fatal) {
  216:             my $newidx=&LONCAPA::map::getresidx($newurl);
  217:             $LONCAPA::map::resources[$newidx]=$bbtitle.':'.$newurl.
  218:                                                    ':false:normal:res';
  219:             push(@LONCAPA::map::order,$newidx);
  220:             my ($errtext,$fatal)=&LONCAPA::map::storemap($allbbsmap,1,1);
  221:             if ($fatal) {
  222:                 $outcome = "error: failed to save discussion boards map - $errtext\n";
  223:             } else {
  224:                 my %boardinfo = (
  225:                   'group' => $group,
  226:                 );
  227:                 $outcome = &Apache::lonnet::put('bulletinpage_'.$boardid,
  228:                                                 \%boardinfo,$cdom,$cnum);
  229:             }
  230:         } else {
  231:             $outcome = "error: failed to read all discussion boards map - $errtext\n";
  232:         }
  233:     } else {
  234:         $outcome = 'error: discussion boards folder absent, '.
  235:                    'or in unexpected location - '.$allbbsmap."\n";
  236:     }
  237:     return ($outcome,$newurl,$bbtitle,$dellock);
  238: }
  239: 
  240: sub display_error {
  241:     my ($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,$bodytitle,$earlyout,
  242:         $refarg)=@_;
  243:     my $output = &boards_header($cdom,$cnum,$group,$description,$gpterm,
  244:                                 $ucgpterm,$bodytitle,$refarg);
  245:     $output .= $earlyout;
  246:     $output .= &Apache::loncommon::end_page();
  247:     return $output;
  248: }
  249: 
  250: sub boards_header {
  251:     my ($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,$bodytitle,$refarg,
  252:         $jscript)=@_;
  253:     my $output = &Apache::loncommon::start_page($bodytitle,$jscript);
  254:     if ($refarg) {
  255:         &Apache::lonhtmlcommon::add_breadcrumb
  256:         ({href=>"/adm/coursegroups",
  257:           text=>"Groups",
  258:           title=>"View course groups"},);
  259:     }
  260:     &Apache::lonhtmlcommon::add_breadcrumb
  261:         ({href=>"/adm/$cdom/$cnum/$group/smppg?$refarg",
  262:           text=>"$ucgpterm: $description",
  263:           title=>"Go to group's home page"},
  264:          {href=>"/adm/groupboards?group=$group&amp;$refarg",
  265:           text=>"Discussion Boards",
  266:           title=>"Display group discussion boards"},);
  267:     $output .= &Apache::lonhtmlcommon::breadcrumbs(&mt('[_1] discussion boards - [_2]',$gpterm,$description));
  268:     return $output;
  269: }
  270: 
  271: 1;