Return to groupboards.pm CVS log

Up to [LON-CAPA] / loncom / interface

Added missing CVS Ids for automatic version numbering to script header
(Irrespective if the script is still in use or not)

    1: # The LearningOnline Network
    2: # Group Bulletin Boards Manager
    3: #
    4: # $Id: groupboards.pm,v 1.14 2009/02/13 17:20:29 bisitz 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 [_1] defined, so there are no [_1] discussion boards to display',$gpterm);
   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 [_1]',$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,$dellockoutcome) = 
  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 ($dellockoutcome ne 'ok') {
  121:                     $r->print(&mt('There was a problem removing a lockfile for the group ([_1]). This may prevent creation of additional bulletin boards in this group.  Please contact the system administrator for your LON-CAPA domain.'));
  122:                 }
  123:             } else {
  124:                 $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.'">'.
  125:                          &mt('Return to discussion boards').'</a>');
  126:             }
  127:             $r->print(&Apache::loncommon::end_page());
  128:             return OK;
  129:         }
  130:     }
  131:     my $jscript;
  132:     if (($can_create) || (&Apache::lonnet::allowed('mdg',$env{'request.course.id'}))) {
  133:         $jscript = qq|
  134: <script type="text/javascript">
  135: function makebulboard() {
  136:    var title=prompt('Discussion Board Title');
  137:    if (title) {
  138:     this.document.forms.newbb.newbul.value=title;
  139:     this.document.forms.newbb.submit();
  140:    }
  141: }
  142: </script>
  143: |;
  144:     }
  145:     $r->print(&boards_header($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,
  146:                              $bodytitle,$refarg,$jscript));
  147:     my ($groupboards,$boards) = &Apache::longroup::get_group_bbinfo($cdom,$cnum,
  148:                                                                     $group);
  149:     if (($can_create) || (&Apache::lonnet::allowed('mdg',$env{'request.course.id'}))) {
  150:         $r->print('<br /><form method="post" name="newbb" action="/adm/groupboards">'.
  151:                   "\n".'<input type="button" name="bbbutton" value="'.
  152:                   &mt('New Discussion Board').
  153:                   '" onClick="javascript:makebulboard();" />'."\n".
  154:                   '<input type="hidden" name="newbul" />'."\n".
  155:                   '<input type="hidden" name="group" value="'.$group.'" />'.
  156:                   '<input type="hidden" name="ref" value="'.$env{'form.ref'}.'" />'.
  157:                   "\n".'</form><br />');
  158:     }
  159:     if (@{$groupboards} > 0) {
  160:         $r->print('<br />'
  161:                  .&Apache::loncommon::start_data_table()
  162:                  .&Apache::loncommon::start_data_table_header_row()
  163:                  .'<th>'.&mt('Discussion Boards').'</th>'
  164:                  .&Apache::loncommon::end_data_table_header_row()
  165:         );
  166:         foreach my $board (@{$groupboards}) {
  167:             my $board_url = $$boards{$board}{'url'};
  168:             if ($board_url =~ /\?/) {
  169:                 $board_url .= '&amp;group='.$group;
  170:             } else {
  171:                 $board_url .= '?group='.$group;
  172:             }
  173:             $r->print(&Apache::loncommon::start_data_table_row()
  174:                      .'<td>'
  175:                      .'<a href="'.$board_url.'&amp;'.$refarg.'">'
  176:                      .$$boards{$board}{'title'}.'</a>'
  177:                      .'</td>'
  178:                      .&Apache::loncommon::end_data_table_row()
  179:             );
  180:         }
  181:         $r->print(&Apache::loncommon::end_data_table());
  182:     } else {
  183:         $r->print('<p class="LC_info">'
  184:                  .&mt('There are currently no discussion boards in this '.$gpterm.'.',)
  185:                  .'</p>'
  186:         );
  187:     }
  188:     $r->print(&Apache::loncommon::end_page());
  189:     return OK;
  190: }
  191: 
  192: sub create_board {
  193:     my ($cdom,$cnum,$group,$bbtitle) = @_;
  194:     my ($outcome,$boardid,$newurl);
  195:     $bbtitle=&unescape($bbtitle);
  196:     # get lock on nohist_groupboards file
  197:     my $lockhash = {
  198:                   $group."\0".'locked_boardids' => $env{'user.name'}.
  199:                                                        ':'.$env{'user.domain'},
  200:                    };
  201:     my $tries = 0;
  202:     my $gotlock = &Apache::lonnet::newput('nohist_groupboards',$lockhash,$cdom,$cnum);
  203:     my $dellockoutcome;
  204:     while (($gotlock ne 'ok') && $tries <3) {
  205:         $tries ++;
  206:         sleep 1;
  207:         $gotlock = &Apache::lonnet::newput('nohist_groupboards',$lockhash,$cdom,$cnum);
  208:     }
  209:     if ($gotlock eq 'ok') {
  210:        my %curr_boards = &Apache::lonnet::dump('nohist_groupboards',$cdom,$cnum,$group);
  211:        $boardid = time;
  212:        my $idtries = 0;
  213:        while(exists($curr_boards{$group."\0".$boardid}) && $idtries < 20) {
  214:            $boardid ++;
  215:            $idtries ++;
  216:        }
  217:        if (!exists($curr_boards{$group."\0".$boardid})) {
  218:            my %new_board = (
  219:                           $group."\0".$boardid => $env{'user.name'}.':'.
  220:                                                   $env{'user.domain'},
  221:            );
  222:            my $putresult = &Apache::lonnet::put('nohist_groupboards',\%new_board,
  223:                                                 $cdom,$cnum);
  224:            if ($putresult ne 'ok') {
  225:                $outcome = 'error saving new board: '.$putresult;
  226:            } else {
  227:                $newurl = '/adm/'.$cdom.'/'.$cnum.'/'.$boardid.
  228:                          '/bulletinboard';
  229:            }
  230:        } else {
  231:             $outcome = ('error: no unique ID for the new board available.');
  232:        }
  233:        #  remove lock
  234:        my @del_lock = ($group."\0".'locked_boardids');
  235:        $dellockoutcome = &Apache::lonnet::del('nohist_groupboards',\@del_lock,$cdom,$cnum);
  236:     } else {
  237:         $outcome = "error: could not obtain lockfile\n";
  238:         $dellockoutcome = 'ok';
  239:     }
  240:     if (!$newurl) {
  241:         return ($outcome,$newurl,$bbtitle,$dellockoutcome);
  242:     }
  243:     $newurl=&unescape($newurl);
  244:     # need to check here if group_boards_$group.sequence is in the course
  245:     # if not - add it as an item in group_folder_$group.sequence 
  246:     my $allbbsmap = &Apache::longroup::get_bbfolder_url($cdom,$cnum,$group);
  247:     if ($allbbsmap =~ m|^/uploaded|) {
  248:         my ($errtext,$fatal)=&LONCAPA::map::mapread($allbbsmap);
  249:         if (!$fatal) {
  250:             my $newidx=&LONCAPA::map::getresidx($newurl);
  251:             $LONCAPA::map::resources[$newidx]=$bbtitle.':'.$newurl.
  252:                                                    ':false:normal:res';
  253:             push(@LONCAPA::map::order,$newidx);
  254:             my ($errtext,$fatal)=&LONCAPA::map::storemap($allbbsmap,1);
  255:             if ($fatal) {
  256:                 $outcome = "error: failed to save discussion boards map - $errtext\n";
  257:             } else {
  258:                 my %boardinfo = (
  259:                   'group' => $group,
  260:                 );
  261:                 $outcome = &Apache::lonnet::put('bulletinpage_'.$boardid,
  262:                                                 \%boardinfo,$cdom,$cnum);
  263:             }
  264:         } else {
  265:             $outcome = "error: failed to read all discussion boards map - $errtext\n";
  266:         }
  267:     } else {
  268:         $outcome = 'error: discussion boards folder absent, '.
  269:                    'or in unexpected location - '.$allbbsmap."\n";
  270:     }
  271:     return ($outcome,$newurl,$bbtitle,$dellockoutcome);
  272: }
  273: 
  274: sub display_error {
  275:     my ($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,$bodytitle,$earlyout,
  276:         $refarg)=@_;
  277:     my $output = &boards_header($cdom,$cnum,$group,$description,$gpterm,
  278:                                 $ucgpterm,$bodytitle,$refarg);
  279:     $output .= $earlyout;
  280:     $output .= &Apache::loncommon::end_page();
  281:     return $output;
  282: }
  283: 
  284: sub boards_header {
  285:     my ($cdom,$cnum,$group,$description,$gpterm,$ucgpterm,$bodytitle,$refarg,
  286:         $jscript)=@_;
  287:     my $output = &Apache::loncommon::start_page($bodytitle,$jscript);
  288:     if ($refarg) {
  289:         &Apache::lonhtmlcommon::add_breadcrumb
  290:         ({href=>"/adm/coursegroups",
  291:           text=>"Groups",
  292:           title=>"View course groups"},);
  293:     }
  294:     &Apache::lonhtmlcommon::add_breadcrumb
  295:         ({href=>"/adm/$cdom/$cnum/$group/smppg?$refarg",
  296:           text=>"$ucgpterm: $description",
  297:           title=>"Go to group's home page"},
  298:          {href=>"/adm/groupboards?group=$group&amp;$refarg",
  299:           text=>"Discussion Boards",
  300:           title=>"Display group discussion boards"},);
  301:     $output .= &Apache::lonhtmlcommon::breadcrumbs(&mt('[_1] discussion boards - [_2]',$gpterm,$description));
  302:     return $output;
  303: }
  304: 
  305: 1;