[LON-CAPA-cvs] cvs: loncom /auth loncacc.pm /interface lonmsg.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Wed, 19 Nov 2008 17:38:26 -0000


This is a MIME encoded message

--jms1227116306
Content-Type: text/plain

jms		Wed Nov 19 17:38:26 2008 EDT

  Modified files:              
    /loncom/auth	loncacc.pm 
    /loncom/interface	lonmsg.pm 
  Log:
  Added/Converted POD comments
  
--jms1227116306
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081119173826.txt"

Index: loncom/auth/loncacc.pm
diff -u loncom/auth/loncacc.pm:1.47 loncom/auth/loncacc.pm:1.48
--- loncom/auth/loncacc.pm:1.47	Wed Nov 12 20:01:09 2008
+++ loncom/auth/loncacc.pm	Wed Nov 19 17:38:21 2008
@@ -2,7 +2,7 @@
 # Cookie Based Access Handler for Construction Area
 # (lonacc: 5/21/99,5/22,5/29,5/31 Gerd Kortemeyer)
 #
-# $Id: loncacc.pm,v 1.47 2008/11/12 20:01:09 jms Exp $
+# $Id: loncacc.pm,v 1.48 2008/11/19 17:38:21 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -73,11 +73,11 @@
 
 =head1 OTHERSUBROUTINES
 
-=over 4
+=over
 
-=item *
+=item constructaccess($url,$ownerdomain)
 
-constructaccess($url,$ownerdomain) : See if the owner domain and name
+See if the owner domain and name
 in the URL match those in the expected environment.  If so, return 
 two element list ($ownername,$ownerdomain).  Else, return null string.
 
Index: loncom/interface/lonmsg.pm
diff -u loncom/interface/lonmsg.pm:1.214 loncom/interface/lonmsg.pm:1.215
--- loncom/interface/lonmsg.pm:1.214	Tue Nov  4 04:18:22 2008
+++ loncom/interface/lonmsg.pm	Wed Nov 19 17:38:26 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Routines for messaging
 #
-# $Id: lonmsg.pm,v 1.214 2008/11/04 04:18:22 raeburn Exp $
+# $Id: lonmsg.pm,v 1.215 2008/11/19 17:38:26 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -53,9 +53,150 @@
 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 @@
     }
 }
 
-# ===================================================================== Package
+
 
 sub packagemsg {
     my ($subject,$message,$citation,$baseurl,$attachmenturl,
@@ -209,7 +350,6 @@
     return $course_context;
 }
 
-# ================================================== Unpack message into a hash
 
 sub unpackagemsg {
     my ($message,$notoken,$noattachmentlink)=@_;
@@ -247,7 +387,6 @@
     return %content;
 }
 
-# ======================================================= Get info out of msgid
 
 sub buildmsgid {
     my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
@@ -393,7 +532,7 @@
         &sendemail($to,$subject,$body,$touname,$toudom,$user_lh);
     }
 }
-# ============================================================= Check for email
+
 
 sub newmail {
     if ((time-$env{'user.mailcheck.time'})>300) {
@@ -404,14 +543,7 @@
     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)=@_;
@@ -433,7 +565,7 @@
     return 'no_host';
 }
 
-# =========================================== Retrieve author resource messages
+
 
 sub retrieve_author_res_msg {
     my $url=shift;
@@ -453,7 +585,8 @@
 }
 
 
-# =============================== Delete all author messages related to one URL
+
+
 
 sub del_url_author_res_msg {
     my $url=shift;
@@ -467,7 +600,7 @@
     }
     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;
@@ -481,7 +614,8 @@
     }
     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)=@_;
@@ -493,7 +627,6 @@
     return %returnhash;
 }
 
-# ====================================== Add a comment to the User Notes screen
 
 sub store_instructor_comment {
     my ($msg,$uname,$udom) = @_;
@@ -508,7 +641,6 @@
     return $result;
 }
 
-# ================================================== Critical message to a user
 
 sub user_crit_msg_raw {
     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
@@ -562,24 +694,7 @@
     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,
@@ -608,7 +723,6 @@
     return join(' ',@status);
 }
 
-# =================================================== Critical message received
 
 sub user_crit_received {
     my $msgid=shift;
@@ -644,7 +758,8 @@
     return $status;
 }
 
-# ======================================================== Normal communication
+
+
 
 sub user_normal_msg_raw {
     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
@@ -705,25 +820,6 @@
     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)=@_;
@@ -807,7 +903,6 @@
     }
 }
 
-# =============================================================== Folder suffix
 
 sub foldersuffix {
     my $folder=shift;
@@ -822,7 +917,6 @@
     return $suffix;
 }
 
-# ========================================================= User-defined folders 
 
 sub get_user_folders {
     my ($folder) = @_;
@@ -863,33 +957,6 @@
     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);
@@ -951,12 +1018,6 @@
     return $user_lh;
 }
 
-=pod
-
-=back
-
-=cut
-
 1;
 __END__
 

--jms1227116306--