--- loncom/interface/lonmsg.pm	2008/09/13 02:37:26	1.213
+++ loncom/interface/lonmsg.pm	2008/12/19 02:43:52	1.218
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Routines for messaging
 #
-# $Id: lonmsg.pm,v 1.213 2008/09/13 02:37:26 raeburn Exp $
+# $Id: lonmsg.pm,v 1.218 2008/12/19 02:43:52 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -53,9 +53,150 @@ with <recipient username="$uname:$udom">
 Domain Coordinator e-mail for the storage of information about
 recipients of the message/e-mail.
 
-=head1 FUNCTIONS
+=head1 SUBROUTINES
 
-=over 4
+=over
+
+=pod
+
+=item packagemsg()
+
+Package
+
+=item get_course_context()
+
+=item unpackagemsg()
+
+Unpack message into a hash
+
+=item buildmsgid()
+
+Get info out of msgid
+
+=item unpackmsgid()
+
+=item sendemail()
+
+=item sendnotification()
+
+Send notification emails
+
+=item newmail()
+
+Check for email
+
+=item author_res_msg()
+
+Automated message to the author of a resource
+
+=item * B<author_res_msg($filename, $message)>: Sends message $message to the owner
+    of the resource with the URI $filename.
+
+=item retrieve_author_res_msg()
+
+Retrieve author resource messages
+
+=item del_url_author_res_msg()
+
+Delete all author messages related to one URL
+
+=item clear_author_res_msg()
+
+Clear out all author messages in URL path
+
+=item all_url_author_res_msg()
+
+Return hash with URLs for which there is a resource message
+
+=item store_instructor_comment()
+
+Add a comment to the User Notes screen
+
+=item user_crit_msg_raw()
+
+Critical message to a user
+
+=item user_crit_msg()
+
+New routine that respects "forward" and calls old routine
+
+=item * B<user_crit_msg($user, $domain, $subject, $message, $sendback, $nosentstore,$recipid,$attachmenturl)>: 
+    Sends a critical message $message to the $user at $domain.  If $sendback
+    is true,  a receipt will be sent to the current user when $user receives 
+    the message.
+
+    Additionally it will check if the user has a Forwarding address
+    set, and send the message to that address instead
+
+    returns 
+      - in array context a list of results for each message that was sent
+      - in scalar context a space seperated list of results for each 
+           message sent
+
+
+=item user_crit_received()
+
+Critical message received
+
+=item user_normal_msg_raw()
+
+Normal communication
+
+=item user_normal_msg()
+
+New routine that respects "forward" and calls old routine
+
+=item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
+       $baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle,
+       $error,$nosentstore,$recipid)>:
+ Sends a message to the  $user at $domain, with subject $subject and message $message.
+
+    Additionally it will check if the user has a Forwarding address
+    set, and send the message to that address instead
+
+    returns
+      - in array context a list of results for each message that was sent
+      - in scalar context a space seperated list of results for each
+           message sent
+
+=item store_sent_mail()
+
+=item store_recipients()
+
+=item foldersuffix()
+
+=item get_user_folders()
+
+User-defined folders 
+
+=item secapply()
+
+=item B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
+
+Arguments
+  $feedurl - /res/ url of resource (only need if $author is true)
+  $author,$question,$course,$policy - all true/false parameters
+    if true will attempt to find the addresses of user that should receive
+    this type of feedback (author - feedback to author of resource $feedurl,
+    $question 'Resource Content Questions', $course 'Course Content Question',
+    $policy 'Course Policy')
+    (Additionally it also checks $env for whether the corresponding form.<name>
+    element exists, for ease of use in a html response context)
+   
+  $defaultflag - (internal should be left blank) if true gather addresses 
+                 that aren't for a section even if I have a section
+                 (used for reccursion internally, first we look for
+                 addresses for our specific section then we recurse
+                 and look for non section addresses)
+
+Returns
+  $typestyle - string of html text, describing what addresses were found
+  %to - a hash, which keys are addresses of users to send messages to
+        the keys will look like   name:domain
+
+=item user_lang()
+
+=back
 
 =cut
 
@@ -74,7 +215,7 @@ use LONCAPA qw(:DEFAULT :match);
     }
 }
 
-# ===================================================================== Package
+
 
 sub packagemsg {
     my ($subject,$message,$citation,$baseurl,$attachmenturl,
@@ -83,10 +224,10 @@ sub packagemsg {
     $citation=&HTML::Entities::encode($citation,'<>&"');
     $subject =&HTML::Entities::encode($subject,'<>&"');
     #remove machine specification
-    $baseurl =~ s|^http://[^/]+/|/|;
+    $baseurl =~ s|^https?://[^/]+/|/|;
     $baseurl =&HTML::Entities::encode($baseurl,'<>&"');
     #remove machine specification
-    $attachmenturl =~ s|^http://[^/]+/|/|;
+    $attachmenturl =~ s|^https?://[^/]+/|/|;
     $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
     my $course_context = &get_course_context();
     my $now=time;
@@ -120,6 +261,9 @@ sub packagemsg {
 	   '<role>'.$env{'request.role'}.'</role>'.
 	   '<resource>'.$env{'request.filename'}.'</resource>'.
            '<msgid>'.$msgid.'</msgid>';
+    if (defined($env{'form.group'})) {
+        $result .= '<group>'.$env{'form.group'}.'</group>';
+    }
     if (ref($recuser) eq 'ARRAY') {
         for (my $i=0; $i<@{$recuser}; $i++) {
             if ($type eq 'dcmail') {
@@ -206,7 +350,6 @@ sub get_course_context {
     return $course_context;
 }
 
-# ================================================== Unpack message into a hash
 
 sub unpackagemsg {
     my ($message,$notoken,$noattachmentlink)=@_;
@@ -244,7 +387,6 @@ sub unpackagemsg {
     return %content;
 }
 
-# ======================================================= Get info out of msgid
 
 sub buildmsgid {
     my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
@@ -288,8 +430,8 @@ sub sendemail {
 	}
     }
     $body=
-    "*** ".&mt_user($user_lh,'This is an automatic message generated by the LON-CAPA system.')."\n".
-    "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this message'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
+    "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
+    "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this e-mail'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
 	    &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
     my $msg = new Mail::Send;
     $msg->to($to);
@@ -313,9 +455,11 @@ sub sendnotification {
 
     $text=~s/\&lt\;/\</gs;
     $text=~s/\&gt\;/\>/gs;
-    my $url='http://'.
-	&Apache::lonnet::hostname(&Apache::lonnet::homeserver($touname,$toudom)).
-      '/adm/email?username='.$touname.'&domain='.$toudom;
+    my $homeserver = &Apache::lonnet::homeserver($touname,$toudom);
+    my $protocol = $Apache::lonnet::protocol{$homeserver};
+    $protocol = 'http' if ($protocol ne 'https');
+    my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
+              '/adm/email?username='.$touname.'&domain='.$toudom;
     my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
         $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
     my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
@@ -390,7 +534,7 @@ to access the full message.',$url);
         &sendemail($to,$subject,$body,$touname,$toudom,$user_lh);
     }
 }
-# ============================================================= Check for email
+
 
 sub newmail {
     if ((time-$env{'user.mailcheck.time'})>300) {
@@ -401,14 +545,7 @@ sub newmail {
     return 0;
 }
 
-# =============================== Automated message to the author of a resource
 
-=pod
-
-=item * B<author_res_msg($filename, $message)>: Sends message $message to the owner
-    of the resource with the URI $filename.
-
-=cut
 
 sub author_res_msg {
     my ($filename,$message)=@_;
@@ -430,7 +567,7 @@ sub author_res_msg {
     return 'no_host';
 }
 
-# =========================================== Retrieve author resource messages
+
 
 sub retrieve_author_res_msg {
     my $url=shift;
@@ -450,7 +587,8 @@ sub retrieve_author_res_msg {
 }
 
 
-# =============================== Delete all author messages related to one URL
+
+
 
 sub del_url_author_res_msg {
     my $url=shift;
@@ -464,7 +602,7 @@ sub del_url_author_res_msg {
     }
     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
 }
-# =================================== Clear out all author messages in URL path
+
 
 sub clear_author_res_msg {
     my $url=shift;
@@ -478,7 +616,8 @@ sub clear_author_res_msg {
     }
     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
 }
-# ================= Return hash with URLs for which there is a resource message
+
+
 
 sub all_url_author_res_msg {
     my ($author,$domain)=@_;
@@ -490,7 +629,6 @@ sub all_url_author_res_msg {
     return %returnhash;
 }
 
-# ====================================== Add a comment to the User Notes screen
 
 sub store_instructor_comment {
     my ($msg,$uname,$udom) = @_;
@@ -505,7 +643,6 @@ sub store_instructor_comment {
     return $result;
 }
 
-# ================================================== Critical message to a user
 
 sub user_crit_msg_raw {
     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
@@ -559,24 +696,7 @@ sub user_crit_msg_raw {
     return $status;
 }
 
-# New routine that respects "forward" and calls old routine
-
-=pod
-
-=item * B<user_crit_msg($user, $domain, $subject, $message, $sendback, $nosentstore,$recipid,$attachmenturl)>: 
-    Sends a critical message $message to the $user at $domain.  If $sendback
-    is true,  a receipt will be sent to the current user when $user receives 
-    the message.
 
-    Additionally it will check if the user has a Forwarding address
-    set, and send the message to that address instead
-
-    returns 
-      - in array context a list of results for each message that was sent
-      - in scalar context a space seperated list of results for each 
-           message sent
-
-=cut
 
 sub user_crit_msg {
     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
@@ -605,7 +725,6 @@ sub user_crit_msg {
     return join(' ',@status);
 }
 
-# =================================================== Critical message received
 
 sub user_crit_received {
     my $msgid=shift;
@@ -641,7 +760,8 @@ sub user_crit_received {
     return $status;
 }
 
-# ======================================================== Normal communication
+
+
 
 sub user_normal_msg_raw {
     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
@@ -688,8 +808,10 @@ sub user_normal_msg_raw {
 			     $text,$msgid);
        }
        if ($toperm && $userenv{'permanentemail'}) {
-	   &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
-			     $text,$msgid);
+           if ((!$userenv{'notification'}) || ($userenv{'notification'} ne $userenv{'permanentemail'})) {
+	       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
+	  		         $text,$msgid);
+           }
        }
        &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
 			    $env{'user.home'},
@@ -700,25 +822,6 @@ sub user_normal_msg_raw {
     return $status;
 }
 
-# New routine that respects "forward" and calls old routine
-
-=pod
-
-=item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
-       $baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle,
-       $error,$nosentstore,$recipid)>:
- Sends a message to the  $user at $domain, with subject $subject and message $message.
-
-    Additionally it will check if the user has a Forwarding address
-    set, and send the message to that address instead
-
-    returns
-      - in array context a list of results for each message that was sent
-      - in scalar context a space seperated list of results for each
-           message sent
-
-=cut
-
 sub user_normal_msg {
     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
 	$toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
@@ -748,7 +851,7 @@ sub user_normal_msg {
 }
 
 sub process_sent_mail {
-    my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom) = @_;
+    my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$recipid) = @_;
     my $sentsubj;
     if ($numsent > 1) {
         $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
@@ -763,7 +866,7 @@ sub process_sent_mail {
         &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
     (undef,my $sentmessage) =
         &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
-                    $recudoms,$sentmsgid,undef,undef,$symb,$error);
+                    $recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
     my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
                                   $senderdom);
     return $status;
@@ -802,7 +905,6 @@ sub store_recipients {
     }
 }
 
-# =============================================================== Folder suffix
 
 sub foldersuffix {
     my $folder=shift;
@@ -817,7 +919,6 @@ sub foldersuffix {
     return $suffix;
 }
 
-# ========================================================= User-defined folders 
 
 sub get_user_folders {
     my ($folder) = @_;
@@ -858,33 +959,6 @@ sub secapply {
     return '';
 }
 
-=pod 
-
-=item * B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
-
-Arguments
-  $feedurl - /res/ url of resource (only need if $author is true)
-  $author,$question,$course,$policy - all true/false parameters
-    if true will attempt to find the addresses of user that should receive
-    this type of feedback (author - feedback to author of resource $feedurl,
-    $question 'Resource Content Questions', $course 'Course Content Question',
-    $policy 'Course Policy')
-    (Additionally it also checks $env for whether the corresponding form.<name>
-    element exists, for ease of use in a html response context)
-   
-  $defaultflag - (internal should be left blank) if true gather addresses 
-                 that aren't for a section even if I have a section
-                 (used for reccursion internally, first we look for
-                 addresses for our specific section then we recurse
-                 and look for non section addresses)
-
-Returns
-  $typestyle - string of html text, describing what addresses were found
-  %to - a hash, which keys are addresses of users to send messages to
-        the keys will look like   name:domain
-
-=cut
-
 sub decide_receiver {
     my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
     &Apache::lonenc::check_decrypt(\$feedurl);
@@ -941,17 +1015,11 @@ sub user_lang {
             }
         }
     }
-    my @languages=&Apache::loncommon::get_genlanguages(@userlangs);
+    my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
     my $user_lh = Apache::localize->get_handle(@languages);
     return $user_lh;
 }
 
-=pod
-
-=back
-
-=cut
-
 1;
 __END__