File:  [LON-CAPA] / loncom / interface / lonnotify.pm
Revision 1.38: download - view: text, annotated - select for diffs
Wed Nov 10 14:44:50 2010 UTC (13 years, 5 months ago) by bisitz
Branches: MAIN
CVS tags: version_2_10_X, version_2_10_1, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, HEAD, BZ4492-merge, BZ4492-feature_horizontal_radioresponse
Bug #5528:
Explicitly send character encoding UTF-8 in outgoing e-mail to ensure correct character display in user's e-mail client:
- Notification e-mails
- Broadcast e-mails (DC)
- Helpdesk requests

Character encoding of special chars in e-mail subject still dysfunctional (as before)

    1: # The LearningOnline Network with CAPA
    2: # Sending messages
    3: #
    4: # $Id: lonnotify.pm,v 1.38 2010/11/10 14:44:50 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::lonnotify;
   30:                                                                                 
   31: use strict;
   32: use Apache::lonnet;
   33: use Apache::loncommon;
   34: use Apache::courseclassifier;
   35: use LONCAPA::Enrollment;
   36: use Apache::Constants qw(:common :http);
   37: use Apache::lonlocal;
   38: use Mail::Send;
   39: use HTML::TokeParser;
   40: use HTML::Entities;
   41: use lib '/home/httpd/lib/perl/';
   42: use LONCAPA;
   43: 
   44: sub handler {
   45:     my ($r) = @_;
   46:     &Apache::loncommon::content_type($r,'text/html');
   47:     $r->send_http_header;
   48: 
   49:     if ($r->header_only) {
   50:         return OK;
   51:     }
   52:     my $cdom = $env{'request.role.domain'};
   53:     unless (&Apache::lonnet::allowed('psa',$cdom)) {
   54:         # Not allowed to broadcast e-mail system-wide 
   55:         $env{'user.error.msg'}="/adm/notify:psa:0:0:Cannot broadcast e-mail systemwide";
   56:         return HTTP_NOT_ACCEPTABLE;
   57:     }
   58: 
   59:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
   60:                                             ['command']);
   61:     my $command = $env{'form.command'};
   62:     my $origin = $env{'form.origin'};
   63: 
   64:     &Apache::lonhtmlcommon::clear_breadcrumbs();
   65: 
   66:     &Apache::lonhtmlcommon::add_breadcrumb
   67:         ({href=>'/adm/notify',
   68:           text=>"Broadcast E-mail"});
   69:     if ($command eq 'process') {
   70:         &print_request_receipt($r,$command,$cdom);
   71:     } elsif ($command eq 'compose') {
   72:         &print_composition_form($r,$command,$cdom);
   73:     } elsif ($command eq 'pick_target') {
   74:         &print_selection_form($r,$command,$cdom);
   75:     } elsif ($command eq 'pick_display') {
   76:         &print_display_option_form($r,$command,$cdom);
   77:     } elsif ($command eq 'display') {
   78:         &print_display($r,$command,$cdom);
   79:     } else {
   80:         &print_front_page($r,'front',$cdom);
   81:     }
   82:     return OK;
   83: }
   84: 
   85: sub add_script {
   86:     my ($js) = @_;
   87:     return '<script type="text/javascript">'."\n".$js."\n".'</script>';
   88: }
   89: 
   90: sub start_page {
   91:     my ($jscript,$bread_title,$formname) = @_;
   92: 
   93:     my $loadcode;
   94:     if ((defined($env{'form.origin'})) 
   95: 	&& ($env{'form.command'} eq 'compose' 
   96: 	    || $env{'form.command'} eq 'pick_target' 
   97: 	    || $env{'form.command'} eq 'pick_display')) {
   98:         if ($env{'form.origin'} ne '') {
   99:             $loadcode = 'javascript:setFormElements(document.'.$env{'form.command'}.')';
  100:             if (($env{'form.command'} eq 'pick_target') 
  101: 		&& (($env{'form.origin'} eq 'compose')
  102: 		    || ($env{'form.origin'} eq 'process'))) {
  103:                 if ($env{'form.coursepick'} eq 'category') {
  104:                     $loadcode .= ';javascript:setCourseCat(document.'.$env{'form.command'}.')';
  105:                 }
  106:             }
  107:         }
  108:     }
  109:     
  110:     my $start_page = 
  111: 	&Apache::loncommon::start_page('Broadcast e-mail to users', $jscript,
  112: 				       {'add_entries' => 
  113: 					    {'onload' => $loadcode,},});
  114:     my $breadcrumbs =
  115: 	&Apache::lonhtmlcommon::breadcrumbs($bread_title,
  116: 					    'Broadcast_system_email');
  117:     my $output = <<"ENDONE";
  118: $start_page
  119: $breadcrumbs
  120: <br />
  121: <form name="$formname" method="post" action="">
  122: ENDONE
  123: 
  124:     return $output;
  125: }
  126: 
  127: sub end_page {
  128:     return '</form>'.&Apache::loncommon::end_page();
  129: }
  130: 
  131: sub print_front_page {
  132:     my ($r,$formname,$cdom) = @_;
  133: 
  134:     my $jscript = qq|
  135: function next_page(caller) {
  136:     if (caller == 'view') {
  137:         document.front.command.value="pick_display"
  138:     }
  139:     else {
  140:         document.front.command.value="pick_target"
  141:     }
  142:     document.front.submit()
  143: }
  144:     |; 
  145: 
  146: 
  147:     my @menu=
  148:         ({  categorytitle=>'Broadcast e-mail to Domain',
  149:         items =>[
  150:             {   linktext => 'Send e-mail to selected users',
  151:                 url => 'javascript:next_page('."'new'".')',
  152:                 permission => 1,
  153:                 #help => '',
  154:                 icon => 'mail-reply-all.png',
  155:                 linktitle => 'Send a new e-mail to selected users from this domain'
  156:             },
  157:             {   linktext => 'Display sent e-mails',
  158:                 url => 'javascript:next_page('."'view'".')',
  159:                 permission => 1,
  160:                 #help => '',
  161:                 icon => 'messalog.png',
  162:                 linktitle => 'Display e-mail sent by Domain Coordinators in this domain'
  163:             },
  164:         ]
  165:         },
  166:         );
  167: 
  168:     $r->print(
  169:         &start_page(&add_script($jscript),
  170:             'Broadcast e-mail to Domain', $formname)
  171:        .'<input type="hidden" name="command" />'
  172:        .&Apache::lonhtmlcommon::generate_menu(@menu)
  173:        .&end_page()
  174:     );
  175:     return;
  176: }
  177: 
  178: sub print_display_option_form {
  179:     my ($r,$formname,$cdom) = @_;
  180:     &Apache::lonhtmlcommon::add_breadcrumb({text=>"Display options"});
  181: 
  182:     my $cmd = 'display';
  183:     my $submit_text = &mt('Display e-mail');
  184:     my @roles = ('dc');
  185:     my $now = time;
  186: 
  187:     my $startdateform = &Apache::lonhtmlcommon::date_setter($formname,
  188:                                                             'startdate',
  189:                                                             $now);
  190:     my $enddateform = &Apache::lonhtmlcommon::date_setter($formname,
  191:                                                           'enddate',
  192:                                                           $now);
  193:     my %elements = (
  194:         startdate_month => 'selectbox',
  195:         startdate_hour => 'selectbox',
  196:         enddate_month => 'selectbox',
  197:         enddate_hour => 'selectbox',
  198:         startdate_day => 'text',
  199:         startdate_year => 'text',
  200:         startdate_minute => 'text',
  201:         startdate_second => 'text',
  202:         enddate_day => 'text',
  203:         enddate_year => 'text',
  204:         enddate_minute => 'text',
  205:         enddate_second => 'text',
  206:         sender => 'checkbox',
  207:     );
  208:     my $jscript = &Apache::lonhtmlcommon::set_form_elements(\%elements);
  209: 
  210:     my $output = &start_page(&add_script($jscript),
  211: 			     'Broadcast e-mail display options', $formname);
  212: 
  213:     $output .= &Apache::lonhtmlcommon::start_pick_box();
  214:     $output .= &Apache::lonhtmlcommon::row_title(&mt('Date range'));
  215:     $output .= '<table><tr><td>'.&mt('Earliest to display:').' </td><td>'.
  216:                 $startdateform.'</td></tr>';
  217:     $output .= '<tr><td>'.&mt('Latest to display:').' </td><td>'.$enddateform.
  218:                '</td></tr></table>';
  219:     $output .= &Apache::lonhtmlcommon::row_closure();
  220:     $output .= &Apache::lonhtmlcommon::row_title(&mt('Choose sender(s)'));
  221:     my %personnel = &Apache::lonnet::get_domain_roles($cdom,\@roles);
  222:     my @domcc = ();
  223:     foreach my $server (keys %personnel) {
  224:         foreach my $user (sort(keys %{$personnel{$server}})) {
  225:             my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
  226:             unless (grep/^$uname:$udom$/,@domcc) {
  227:                 my %userinfo = &Apache::lonnet::get('environment',['lastname','firstname'],$udom,$uname);
  228:                 $output .= '<input type="checkbox" name="sender" value="'.$uname.':'.$udom.'" />&nbsp;'.$userinfo{'firstname'}.' '.$userinfo{'lastname'}.'&nbsp;&nbsp;('.$uname.':'.$udom.')';
  229:                 push (@domcc,$uname.':'.$udom);
  230:             }
  231:         }
  232:     }
  233:     $output .= &Apache::lonhtmlcommon::row_closure();
  234:     $output .= &Apache::lonhtmlcommon::submit_row(&mt('Submit'),$cmd,$submit_text);
  235:     $output .= &Apache::lonhtmlcommon::end_pick_box();
  236:     $output .= qq(<input type="hidden" name="sortby" value="date" />\n).
  237: 	&end_page();
  238:     $r->print($output);
  239:     return;
  240: }
  241: 
  242: sub print_display {
  243:     my ($r,$formname,$cdom) = @_;
  244:     &Apache::lonhtmlcommon::add_breadcrumb
  245:          ({href=>"javascript:goBack('pick_display')",
  246:           text=>"Display options"},
  247:          {text=>"E-mail display"});
  248: 
  249:     my $msgcount = 0;
  250:     my $start = &Apache::lonhtmlcommon::get_date_from_form('startdate');
  251:     my $end = &Apache::lonhtmlcommon::get_date_from_form('enddate');
  252:     my @senders = &Apache::loncommon::get_env_multiple('form.sender');
  253:     my %sentmail = &Apache::lonnet::dcmaildump($cdom,$start,$end,\@senders);
  254:     my %dcmail = ();
  255:     my %Sortby = ();
  256:     my $jscript = <<"ENDSCRIPT";
  257: function changeSort(caller) {
  258:     document.$formname.command.value = '$formname';
  259:     document.$formname.sortby.value = caller;
  260:     document.$formname.submit();
  261: }
  262: function goBack(target) {
  263:     document.$formname.command.value = target;
  264:     document.$formname.submit();
  265: }
  266: 
  267: ENDSCRIPT
  268: 
  269:     my $output = &start_page(&add_script($jscript),
  270: 			     'Display Broadcast e-mail', $formname);
  271: 
  272:     foreach my $msgid (keys(%sentmail)) {
  273:         my %content = &Apache::lonmsg::unpackagemsg($sentmail{$msgid});
  274:         $msgcount ++;
  275:         %{$dcmail{$msgid}} = ();
  276:         foreach my $item (keys(%content)) {
  277:             if ($item eq 'recipient') {
  278:                 foreach my $user (keys(%{$content{recipient}})) {
  279:                     $dcmail{$msgid}{recipient}{$user} = $content{recipient}{$user};
  280:                 }
  281:             } else {
  282:                 $dcmail{$msgid}{$item} = $content{$item};
  283:             }
  284:         }
  285:     }
  286:     $output .= &Apache::loncommon::start_data_table();
  287:     if ($msgcount > 0) {
  288:         $output .= &Apache::loncommon::start_data_table_header_row().
  289: 	    '<th><a href="javascript:changeSort(\'date\')">Date</a></th>'.
  290: 	    '<th><a href="javascript:changeSort(\'subject\')">Subject</a></th>'.
  291: 	    '<th><a href="javascript:changeSort(\'sender\')">Sender</a></th>'.
  292: 	    '<th><a href="javascript:changeSort(\'message\')">Message</a></th>'.
  293: 	    '<th><a href="javascript:changeSort(\'recipients\')">Recipients</a></th>'.
  294: 	    &Apache::loncommon::end_data_table_header_row();
  295: 
  296:         if (($env{'form.sortby'} eq 'date') || ($env{'form.sortby'} eq '') || (!defined($env{'form.sortby'})) || (($env{'form.sortby'} eq 'sender') && (@senders <= 1))) {
  297:             foreach my $msgid (sort(keys(%dcmail))) {
  298:                 my $recipients = '';
  299:                 my ($date,undef,$sname,$sdom) =
  300:                                   &Apache::lonmsg::unpackmsgid($msgid,undef,1);
  301:                 $date = &Apache::lonlocal::locallocaltime($date);
  302:                 foreach my $user (sort(keys(%{$dcmail{$msgid}{recipient}}))) {
  303:                     $recipients .= $dcmail{$msgid}{recipient}{$user}.', ';
  304:                 }
  305:                 $recipients =~ s/,\s$//;
  306:                 $output .= &Apache::loncommon::start_data_table_row().
  307: 		    '<td><small>'.$date.'</small></td>'.
  308: 		    '<td><small>'.&cr_to_br($dcmail{$msgid}{subject}).'</small></td>'.
  309: 		    '<td><small>'.$sname.':'.$sdom.'</small></td><td><small>'.&cr_to_br($dcmail{$msgid}{message}).'</small></td>'.
  310: 		    '<td><small>'.$recipients.'</small></td>'."\n".
  311: 		    &Apache::loncommon::end_data_table_row();
  312:             }
  313:         } else {
  314:             foreach my $msgid (sort(keys(%dcmail))) {
  315:                 my ($date,undef,$sname,$sdom) =
  316:                                    &Apache::lonmsg::unpackmsgid($msgid,undef,1);
  317:                 if ($env{'form.sortby'} eq 'subject') {
  318:                     push @{$Sortby{$dcmail{$msgid}{subject}}},$msgid;
  319:                 } elsif ($env{'form.sortby'} eq 'message') {
  320:                     push @{$Sortby{$dcmail{$msgid}{message}}},$msgid;
  321:                 } elsif ($env{'form.sortby'} eq 'recipients') {
  322:                     my $recipients ='';
  323:                     foreach my $user (sort(keys(%{$dcmail{$msgid}{recipient}}))) {
  324:                         $recipients .= $dcmail{$msgid}{recipient}{$user}.', ';
  325:                     }
  326:                     $recipients =~ s/,\s$//;
  327:                     push @{$Sortby{$recipients}},$msgid;
  328:                 } elsif ($env{'form.sortby'} eq 'sender') {
  329:                     if (@senders > 1) {
  330:                        push @{$Sortby{$sname.':'.$sdom}},$msgid;
  331:                     }
  332:                 }
  333:             }
  334:             foreach my $key (sort(keys(%Sortby))) {
  335:                 foreach my $msgid (@{$Sortby{$key}}) {
  336:                     my $recipients = '';
  337:                     if ($env{'form.sortby'} eq 'recipients') {
  338:                         $recipients = $key;
  339:                     } else {
  340:                         foreach my $user (sort(keys(%{$dcmail{$msgid}{recipient}}))) {
  341:                             $recipients .= $dcmail{$msgid}{recipient}{$user}.', ';
  342:                         }
  343:                         $recipients =~ s/,\s$//;
  344:                     }
  345:                     my ($date,undef,$sname,$sdom) =
  346:                                    &Apache::lonmsg::unpackmsgid($msgid,undef,1);
  347:                     $date = &Apache::lonlocal::locallocaltime($date);
  348:                     $output .=  &Apache::loncommon::start_data_table_row().
  349: 			'<td><small>'.$date.'</small></td>'.
  350: 			'<td><small>'.&cr_to_br($dcmail{$msgid}{subject}).'</small></td>'.
  351: 			'<td><small>'.$sname.':'.$sdom.'</small></td>'.
  352: 			'<td><small>'.&cr_to_br($dcmail{$msgid}{message}).'</small></td>'.
  353: 			'<td><small>'.$recipients.'</small></td>'."\n".
  354: 			&Apache::loncommon::end_data_table_row();
  355:                 }
  356:             }
  357:         }
  358:     } else {
  359:         $output .= &Apache::loncommon::start_data_table_empty_row().
  360: 	    '<td>No mail sent matching supplied criteria</td>'.
  361: 	    &Apache::loncommon::end_data_table_empty_row();
  362:     }
  363:     $output .= &Apache::loncommon::end_data_table();
  364:     $output .= &Apache::lonhtmlcommon::echo_form_input(['sortby','command','origin']);
  365:     my $curr_sortby;
  366:     if (defined($env{'form.sortby'})) {
  367:         $curr_sortby = $env{'form.sortby'};
  368:     } else {
  369:         $curr_sortby = 'date';
  370:     }
  371:     $output .= qq(<input type="hidden" name="origin" value="$formname" />\n);
  372:     $output .= qq(<input type="hidden" name="command" />\n);
  373:     $output .= qq(<input type="hidden" name="sortby" value="$curr_sortby" />\n);
  374:     $output .= &end_page();
  375:     $r->print($output);
  376:     return;
  377: }
  378: 
  379: sub print_selection_form {
  380:     my ($r,$formname,$cdom) = @_;
  381:     my %coursecodes = ();
  382:     my %codes = ();
  383:     my @codetitles = ();
  384:     my %cat_titles = ();
  385:     my %cat_order = ();
  386:     my %idlist = ();
  387:     my %idnums = ();
  388:     my %idlist_titles = ();
  389:     my $caller = 'global';
  390:     my $totcodes = 0;
  391:     my $format_reply;
  392:     my $jscript = '';
  393:     my %lt=&Apache::lonlocal::texthash(
  394:                'buil' => 'Building valid e-mail address from username, if missing from preferences:',
  395:                'kerb' => 'Kerberos: enter default for each realm used in the domain, with comma separation of entries',
  396:                'infs' => 'Internal, Filesystem and Local authentication: enter single default.',
  397:                'comp' => 'Compose E-mail'
  398:            );
  399:     &Apache::lonhtmlcommon::add_breadcrumb
  400:           ({text=>"Select Audience"});
  401: 
  402:     $totcodes = &Apache::courseclassifier::retrieve_instcodes(\%coursecodes,$cdom,$totcodes);
  403:     if ($totcodes > 0) {
  404:         $format_reply = &Apache::lonnet::auto_instcode_format($caller,$cdom,\%coursecodes,\%codes,\@codetitles,\%cat_titles,\%cat_order);
  405:         if ($format_reply eq 'ok') {
  406:             my $numtypes = @codetitles;
  407:             &Apache::courseclassifier::build_code_selections(\%codes,\@codetitles,\%cat_titles,\%cat_order,\%idlist,\%idnums,\%idlist_titles);
  408:             my ($scripttext,$longtitles) = &Apache::courseclassifier::javascript_definitions(\@codetitles,\%idlist,\%idlist_titles,\%idnums,\%cat_titles);
  409:             my $longtitles_str = join('","',@{$longtitles});
  410:             my $allidlist = $idlist{$codetitles[0]};
  411:             $jscript .= &Apache::courseclassifier::courseset_js_start($formname,$longtitles_str,$allidlist);
  412:             $jscript .= $scripttext;
  413:             $jscript .= &Apache::courseclassifier::javascript_code_selections($formname,@codetitles);
  414:         }
  415:     }
  416:     my @standardnames = &Apache::loncommon::get_standard_codeitems();
  417: 
  418:     my $cb_jscript = &Apache::loncommon::coursebrowser_javascript($cdom);
  419: 
  420:     my %elements = (
  421:                      roles => 'selectbox',
  422:                      types => 'selectbox',
  423:                      Year => 'selectbox',
  424:                      coursepick => 'radio',
  425:                      coursetotal => 'text',
  426:                      courselist => 'text',
  427:                      internal => 'text',
  428:                      krb4 => 'text',
  429:                      krb5 => 'text',
  430:                      localauth => 'text',
  431:                      unix => 'text',
  432:                    );
  433:     $jscript .= &Apache::lonhtmlcommon::set_form_elements(\%elements);
  434:     if ($env{'form.coursepick'} eq 'category') {
  435:         $jscript .= qq|
  436: function setCourseCat(formname) {
  437:     if (formname.Year.options[formname.Year.selectedIndex].value == -1) {
  438:         return;
  439:     }
  440:     courseSet('$codetitles[0]');
  441:     for (var j=0; j<formname.Semester.length; j++) {
  442:         if (formname.Semester.options[j].value == "$env{'form.Semester'}") {
  443:             formname.Semester.options[j].selected = true;
  444:         }
  445:     }
  446:     if (formname.Semester.options[formname.Semester.selectedIndex].value == -1) {
  447:         return;
  448:     }
  449:     courseSet('$codetitles[1]');
  450:     for (var j=0; j<formname.Department.length; j++) {
  451:         if (formname.Department.options[j].value == "$env{'form.Department'}") {
  452:             formname.Department.options[j].selected = true;
  453:         }
  454:     }
  455:     if (formname.Department.options[formname.Department.selectedIndex].value == -1) {
  456:         return;
  457:     }
  458:     courseSet('$codetitles[2]');
  459:     for (var j=0; j<formname.Number.length; j++) {
  460:         if (formname.Number.options[j].value == "$env{'form.Number'}") {
  461:             formname.Number.options[j].selected = true;
  462:         }
  463:     }
  464: }
  465: |; 
  466:     }
  467: 
  468: 
  469:     my $output = &start_page(&add_script($jscript).$cb_jscript,
  470: 			     'Choose e-mail audience', $formname);
  471: 
  472:     $output .= &Apache::lonhtmlcommon::start_pick_box();
  473:     my @roles = ('ow','cc','in','ta','ep','st','cr');
  474:     my %longtypes = ();
  475:     my %authtypes = ();
  476:     &form_elements(\%longtypes,\%authtypes);
  477:     my $descrip = $lt{'buil'}.' 
  478: <ul>
  479: <li>'.$lt{'kerb'}.'<br />(e.g., MSU.EDU=msu.edu, MSUE.EDU=msue.msu.edu).</li>
  480: <li>'.$lt{'infs'}.'</li>
  481: </ul>'."\n";
  482:     my $submit_text = $lt{'comp'};
  483:     my $cmd = 'compose';
  484:     $output .= &Apache::lonhtmlcommon::role_select_row(\@roles,&mt('Roles'));
  485:     $output .= &Apache::lonhtmlcommon::course_select_row(&mt('Courses'),$formname,$totcodes,\@codetitles,\%idlist,\%idlist_titles,undef,undef,\@standardnames);
  486:     $output .= &Apache::lonhtmlcommon::status_select_row(\%longtypes,&mt('Access status'));
  487:     $output .= &Apache::lonhtmlcommon::email_default_row(\%authtypes,&mt('Username -> E-mail conversion'),$descrip);
  488:     $output .= &Apache::lonhtmlcommon::submit_row(&mt('Submit'),$cmd,$submit_text);
  489:     $output .= &Apache::lonhtmlcommon::end_pick_box();
  490:     $output .= &end_page();
  491:     $r->print($output);
  492:     return;
  493: }
  494: 
  495: sub print_composition_form {
  496:     my ($r,$formname,$cdom) = @_;
  497:     &Apache::lonhtmlcommon::add_breadcrumb
  498:         ({href=>"javascript:goBack('pick_target')",
  499:           text=>"Select Audience"},
  500:          {text=>"Compose E-mail"});
  501:     my $jscript = &Apache::loncommon::check_uncheck_jscript();
  502:     $jscript .= qq|
  503: function goBack(target) {
  504:     document.$formname.command.value = target;
  505:     document.$formname.submit();
  506: }
  507: |;
  508: 
  509:     my %lt=&Apache::lonlocal::texthash(
  510:                       'nore' => 'No recipients identified',
  511:                       'emad' => 'e-mail address',
  512:                    );
  513:     my %elements = (
  514:                      subject => 'text',
  515:                      message => 'text',
  516:                      sender => 'text',
  517:                      recipient => 'checkbox',
  518:                    );
  519:     $jscript .= &Apache::lonhtmlcommon::set_form_elements(\%elements);
  520: 
  521:     $r->print(&start_page(&add_script($jscript),
  522: 			  'Broadcast e-mail to users', $formname));
  523: 
  524:     my $coursefilter = $env{'form.coursepick'};
  525:     my %courses;
  526:     if ($coursefilter eq 'all') {
  527:         %courses = &Apache::lonnet::courseiddump($cdom,'.','.','.','.','.',
  528:                                                  undef,undef,'Course');
  529:     } elsif ($coursefilter eq 'category') {
  530:         my $instcode = &Apache::courseclassifier::instcode_from_selectors($cdom);
  531:         my $regexp = '';
  532:         if ($instcode eq '') {
  533:             $instcode = '.';
  534:         } else {
  535:             $regexp = 1;
  536:         }
  537:         %courses = &Apache::lonnet::courseiddump($cdom,'.','.',$instcode,'.','.',
  538:                                                  undef,undef,'Course',$regexp);
  539:     } elsif ($coursefilter eq 'specific') {
  540:         if ($env{'form.coursetotal'} > 1) {
  541:             my @course_ids = split(/&&/,$env{'form.courselist'});
  542:             foreach my $cid (@course_ids) {
  543:                 $courses{$cid} = '';
  544:             }
  545:         } else {
  546:             $courses{$env{'form.courselist'}} = '';
  547:         }
  548:     }
  549: 
  550:     my @types = &Apache::loncommon::get_env_multiple('form.types');
  551:     my @roles = &Apache::loncommon::get_env_multiple('form.roles');
  552: 
  553:     my %longtypes = ();
  554:     my %authtypes = ();
  555:     my %email_defaults = ();
  556: 
  557:     &form_elements(\%longtypes,\%authtypes);
  558:     foreach my $auth (keys(%authtypes)) {
  559:         if (exists($env{'form.'.$auth})) {
  560:              my $default = $env{'form.'.$auth};
  561:              $default =~ s/^,+//;
  562:              $default =~ s/,+$//;
  563:              if ($auth =~ /^krb/) {
  564:                  %{$email_defaults{$auth}} = ();
  565:                  if ($default =~ /,/) {
  566:                      my @items = split(/,/,$default);
  567:                      foreach my $item (@items) {
  568:                          my ($realm,$value) = split(/=/,$item);
  569:                          $email_defaults{$auth}{$realm} = $value;
  570:                      }
  571:                  } else {
  572:                      my ($realm,$value) = split(/=/,$default);
  573:                      $email_defaults{$auth}{$realm} = $value;
  574:                  }
  575:              } else {
  576:                  $email_defaults{$auth} = $default;
  577:              }
  578:          }
  579:     }
  580: 
  581:     my $sender = &get_user_info($env{'user.name'},%email_defaults);
  582: 
  583:     my %recipients = ();
  584:     my %users = ();
  585:     my %access = ();
  586:     my @sections = ();
  587:     my $totalrecip = 0;
  588:     my @unmatched = ();
  589:     foreach my $role (@roles) {
  590:         %{$users{$role}} = ();
  591:     }
  592:     foreach my $type (@types) {
  593:         $access{$type} = $type;
  594:     }
  595:     foreach my $course_id (keys(%courses)) {
  596:         my %coursehash = 
  597:             &Apache::lonnet::coursedescription($course_id,{'one_time' => 1});
  598:         my $cdom = $coursehash{'domain'};
  599:         my $cnum = $coursehash{'num'};
  600:         &Apache::loncommon::get_course_users($cdom,$cnum,\%access,\@roles,\@sections,\%users);
  601:     }
  602:     foreach my $role (keys(%users)) {
  603:         foreach my $user (keys(%{$users{$role}})) {
  604:             unless (defined($recipients{$user})) {
  605:                 $recipients{$user} = &get_user_info($user,%email_defaults);
  606:                 if ($recipients{$user} eq '') {
  607:                     push @unmatched, $user;
  608:                 } else {
  609:                     $totalrecip ++;
  610:                 } 
  611:             }
  612:         }
  613:     }
  614:     my $output;
  615:   
  616:     if ($totalrecip > 0) {
  617:         $output .= &Apache::lonhtmlcommon::start_pick_box();
  618:         $output .= &Apache::lonhtmlcommon::row_title(&mt('Subject'));
  619:         $output .= '<input type="text" name="subject" size="30" />';
  620:         $output .= &Apache::lonhtmlcommon::row_closure();
  621:         $output .= &Apache::lonhtmlcommon::row_title(&mt('Message'));
  622:         $output .= '  <textarea name="message" id="message"
  623:                       cols="60" rows="10" wrap="hard"></textarea>';
  624:         $output .= &Apache::lonhtmlcommon::row_closure();
  625:         $output .= &Apache::lonhtmlcommon::row_title(&mt('Recipients'));
  626:         $output .= '<input type="button" value="check all" 
  627:                     onclick="javascript:checkAll(document.compose.recipient)" />
  628:                     &nbsp;&nbsp;<input type="button" value="uncheck all"
  629:                     onclick="javascript:uncheckAll(document.compose.recipient)" />
  630:                     <br />';
  631: 	$output .= &Apache::loncommon::start_data_table();
  632:         if (keys(%recipients) > 0) {
  633: 	    $output .= &Apache::loncommon::start_data_table_header_row();
  634:             $output .= '<th>&nbsp;<th>username:domain</th><th>'.$lt{'emad'}.'</th>';
  635: 	    $output .= &Apache::loncommon::end_data_table_header_row();
  636:         }
  637:         foreach my $username (sort(keys(%recipients))) {
  638: 	    $output .= &Apache::loncommon::start_data_table_row();
  639:             if ($recipients{$username} =~ /\@/) {
  640:                 my $value=&escape($username).':'.&escape($recipients{$username});
  641:                 $output .= '<td><input type="checkbox" name="recipient" value="'.$value.'" /></td><td>'.$username.'</td><td>'.$recipients{$username}.'</td>';
  642:             }
  643: 	    $output .= &Apache::loncommon::end_data_table_row();
  644:         }
  645:         $output .= &Apache::loncommon::end_data_table();
  646:         if (@unmatched) {
  647:             $output .= '<br /><br />'.&mt('Could not determine e-mail addresses for the following users:').'<ul>';
  648:             foreach my $username (sort @unmatched) {
  649:                 $output .= '<li>'.$username.'</li>';
  650:             }
  651:             $output .= '</ul>';
  652:         }
  653:         $output .= &Apache::lonhtmlcommon::row_closure();
  654:         $output .= &Apache::lonhtmlcommon::row_title(&mt('Sender e-mail address'));
  655:         $output .= '<input type="text" name="sender" value="'.$sender.'" />';
  656:         $output .= &Apache::lonhtmlcommon::row_closure();
  657:         $output .= &Apache::lonhtmlcommon::submit_row(&mt('Submit'),'process',&mt('Send'));
  658:         $output .= &Apache::lonhtmlcommon::end_pick_box();
  659:     } else {
  660:         $output .= $lt{'nore'}."\n".
  661:                    '<input type="hidden" name="command" value="" />'."\n";
  662:     }
  663:     $output .= '<input type="hidden" name="origin" value="'.$formname.'" />'."\n";
  664:     $output .= &Apache::lonhtmlcommon::echo_form_input(['command','origin','subject','message','recipient','sender'],);
  665:     $output .= &end_page();
  666:     $r->print($output);
  667:     return;
  668: }
  669: 
  670: 
  671: sub print_request_receipt {
  672:     my ($r,$formname,$dom) =@_;
  673:     my @recipients = &Apache::loncommon::get_env_multiple('form.recipient');
  674:     my $subject = $env{'form.subject'};
  675:     my $message = $env{'form.message'};
  676:     my $from = $env{'form.sender'};
  677:     my $jscript = <<ENDSCRIPT;
  678: function goBack(target) {
  679:     document.$formname.command.value = target;
  680:     document.$formname.submit();
  681: }
  682: ENDSCRIPT
  683: 
  684:     &Apache::lonhtmlcommon::add_breadcrumb
  685:         ({href=>"javascript:goBack('pick_target')",
  686:           text=>"Select audience"});
  687:     &Apache::lonhtmlcommon::add_breadcrumb
  688:         ({href=>"javascript:goBack('compose')",
  689:           text=>"Compose E-mail"});
  690:     &Apache::lonhtmlcommon::add_breadcrumb
  691:         ({href=>"/adm/notify?command=process",
  692:           text=>"Outcome"});
  693: 
  694: 
  695:     my $output = &start_page(&add_script($jscript), 'E-mail Delivery',
  696: 			     $formname);
  697: 
  698: 
  699:     my @deliveries = ();
  700:     &broadcast_email(\@recipients,$subject,$from,$message,\@deliveries);
  701:     if (@deliveries > 0) {
  702: 	$output .= &Apache::loncommon::start_data_table();
  703:         &store_mail($subject,$message,$dom,\@deliveries);
  704:         $output .= &Apache::loncommon::start_data_table_header_row().
  705: 	    '<th>'.&mt('Status').'</th>'.
  706: 	    '<th>'.&mt('Subject').'</th>'.
  707: 	    '<th>'.&mt('Message').'</th>'.
  708: 	    '<th>'.&mt('Recipents').'</th>'.
  709: 	    &Apache::loncommon::end_data_table_header_row();
  710: 	$output .= &Apache::loncommon::start_data_table_row().
  711: 	    '<td valign="middle">'.&mt('Sent').'</td>'.
  712: 	    '<td valign="middle">'.&cr_to_br($subject).'</td>'.
  713: 	    '<td valign="middle">'.&cr_to_br($message).'</td>'.
  714: 	    '<td>';
  715:         foreach my $person (@deliveries) {
  716:             my ($username,$email) = split(/:/,$person);
  717:             $output .= &unescape($email).'&nbsp;('.&unescape($username).')<br />'."\n";
  718:         }
  719:         $output .= '</td>'.
  720: 	    &Apache::loncommon::end_data_table_row().
  721: 	    &Apache::loncommon::end_data_table();
  722:     } else {
  723:         $output .= 'No mail sent - no recipients identified'; 
  724:     }
  725:     $output .= '<br /><a href="/adm/notify">'.&mt('Send another e-mail').'</a>'."\n";
  726:     $output .= '<input type="hidden" name="command" />'."\n".
  727:                '<input type="hidden" name="origin" value="'.$formname.'" />'."\n";
  728:     $output .= &Apache::lonhtmlcommon::echo_form_input(['command','origin']);
  729:     $output .= &end_page();
  730:     $r->print($output);
  731:     return;
  732: }
  733: 
  734: sub broadcast_email {
  735:     my ($recipients,$subject,$from,$message,$deliveries)=@_;
  736: # Should implement staggered delivery for large numbers of recipients?.
  737:     foreach my $user (@{$recipients}) {
  738:         my $msg = new Mail::Send;
  739:         my ($username,$to) = split(/:/,$user);
  740:         $username = &unescape($username);
  741:         $to = &unescape($to);
  742:         $msg->to($to);
  743:         $msg->subject($subject);
  744:         $msg->add('From',"$from");
  745:         $msg->add('Content-type','text/plain; charset=UTF-8');
  746:         if (my $fh = $msg->open()) {
  747:             print $fh $message;
  748:             $fh->close;
  749:             push(@{$deliveries},$user); 
  750:         }
  751:     }
  752: }
  753: 
  754: sub get_user_info {
  755:     my ($user,%email_defaults) = @_;
  756:     my ($uname,$udom) = split(/:/,$user);
  757:     my @emailtypes = ('permanentemail','critnotification','notification');
  758:     my %userinfo = &Apache::loncommon::getemails($uname,$udom);
  759:     my $email = '';
  760:     foreach my $type (@emailtypes) {
  761:         $email = $userinfo{$type};
  762:         if ($email =~ /\@/) {
  763:             last;
  764:         }
  765:     }
  766:     if ($email eq '') {
  767:         my $authinfo  = &Apache::lonnet::queryauthenticate($uname,$udom);
  768:         my ($authtype,$autharg) = split(/:/,$authinfo);
  769:         if ($authtype =~ /^krb/) {
  770:             if (defined($email_defaults{$authtype}{$autharg})) {
  771:                 $email = $uname.'@'.$email_defaults{$authtype}{$autharg};
  772:             }
  773:         } else {
  774:             if ((defined($email_defaults{$authtype})) && ($email_defaults{$authtype} ne '')) {
  775:                 $email = $uname.'@'.$email_defaults{$authtype};
  776:             }
  777:         }
  778:     }
  779:     return $email;
  780: }
  781: 
  782: sub form_elements {
  783:    my ($longtypes,$authtypes) = @_;
  784:    %{$longtypes} = (
  785:                    active => &mt('Currently has access'),
  786:                    previous => &mt('Previously had access'),
  787:                    future => &mt('Will have future access'),
  788:                    );
  789:    %{$authtypes} = (
  790:                    krb4 => 'Kerberos 4',
  791:                    krb5 => 'Kerberos 5',
  792:                    internal => 'Internal (LON-CAPA)',
  793:                    unix => 'Filesystem (UNIX)',
  794:                    localauth => 'Local/Customized',
  795:                    );
  796:    return;
  797: }
  798: 
  799: sub store_mail {
  800:     my ($subject,$message,$domain,$recipients,$attachmenturl) = @_;
  801:     my $msgid;
  802:     ($msgid,$message) = &Apache::lonmsg::packagemsg($subject,$message,undef,undef,
  803:                         $attachmenturl,$recipients,undef,undef,'dcmail');
  804: 
  805: # Store in dc email db files on primary library server for domain.
  806:     my $server = &Apache::lonnet::domain($domain,'primary');
  807:     if (defined($server)) {
  808:         unless (&Apache::lonnet::dcmailput($domain,$msgid,$message,$server) 
  809:                                                             eq 'ok') {
  810:             &Apache::lonnet::logthis('Storage of dc mail failed for domain'.
  811:                  $domain.' for server: '. $server.'.  Message ID was '.$msgid);
  812:         }
  813:     } else {
  814:         &Apache::lonnet::logthis('Storage of dc mail failed for domain'.
  815:            $domain.' as no primary server identified. Message ID was '.$msgid);
  816:     }
  817: }
  818: 
  819: sub cr_to_br {
  820:     my $incoming = shift;
  821:     $incoming =~ s/\n/\<br \/\>/g;
  822:     return $incoming;
  823: }
  824: 
  825: 1;

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>