Changes for firma rev 1.34. Also, corrected misspelled words and fixed typos.

2 files changed, 52 insertions, 21 deletions

diff --git a/CHANGELOG b/CHANGELOG
index 91dcf04..6e44242 100755
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,11 +1,35 @@
 Firma CHANGELOG
 ---------------
 
-30/08/2005 - 0.3-cvs (rev 1.33) - rhatto
+02/09/2005 - 0.3-cvs (rev 1.34) - luis
+
+  - Added two optional (and experimental) parameters to firma.conf:
+    USE_GPG_HIDDEN_RECIPIENT_OPTION and SEND_MESSAGES_USING_BCC. If
+    both are enabled, firma will use GnuPG's --hidden-recipient
+    option (available from version 1.4.0 onwards) and send list
+    messages to all subscribers at once, using BCC. This should
+    speed up message processing, specially on lists with several
+    subscribers.
+
+  - Major changes on functions SendListMessage and SendWarningMessage
+    to implement the two options above, and some minor changes on
+    functions SendBounceMessage and ProcessMessage.
+
+  - Added a new check on function CheckFirmaConfigFile, to make sure
+    GnuPG's version is 1.4.0 or later in case
+    USE_GPG_HIDDEN_RECIPIENT_OPTION is enabled.
+
+  - Added/removed some local variables:
+    email   -> ( removed )
+    ( new ) -> subscriber, email_address, recipients
+
+  - Corrected misspelled words and fixed typos on comments.
+
+30/08/2005 - v0.2.5 (rev 1.33) - rhatto
 
   - Added GPL copyright notice and firma contact email
 
-23/08/2005 - 0.3-cvs (rev 1.32) - luis - released as firma 0.2.5
+23/08/2005 - 0.3-cvs (rev 1.32) - luis
 
   - Fixed a possible infinite loop (added on rev 1.30) on function
     GetMessageHeaders. It could be triggered, for example, by a
@@ -25,7 +49,8 @@ Firma CHANGELOG
   - Changed project description to: "firma: GnuPG-based encrypted
     mailing list manager"
 
-  - Declared/renamed/removed variables and arrays:
+  - Added/renamed/removed variables and arrays:
+
     o Configuration file variables:
     MAIL      -> MAIL_AGENT
     MAIL_ARGS -> MAIL_AGENT_ARGS
@@ -51,6 +76,7 @@ Firma CHANGELOG
     CONFIG          -> LIST_CONFIG_FILE
     LINES, n, i     -> ( removed )
     ( new )         -> FIRMA_CONFIG_FILE
+
     o Global arrays:
     MESSAGE       -> ORIG_MESSAGE
     GPG_MESSAGE   -> ORIG_GPG_MESSAGE
@@ -71,7 +97,7 @@ Firma CHANGELOG
     LISTS_DIR, and a list specific file, containing the variables
     LIST_ADDRESS, LIST_ADMIN, LIST_HOMEDIR and PASSPHRASE.
 
-  - Edited the comments at the beggining of the script to reflect the
+  - Edited the comments at the beginning of the script to reflect the
     change above.
 
   - As suggested by the Advanced Bash-Scripting Guide (ABSG)[1], added
@@ -118,6 +144,7 @@ Firma CHANGELOG
         same character in the PASSPHRASE;
       Other minor changes in the PASSPHRASE, LIST_ADDRESS and
         LIST_ADMIN checks.
+
     o GetMessage:
       Added a check to see if the message was successfully stored in
         the ORIG_MESSAGE array.
@@ -142,8 +169,8 @@ Firma CHANGELOG
     o ChooseUid:
       Declared keyid, uid_count and chosen_uid_number as local
         variables, moving them to the beginning of the function;
-      Minor syntax changes in the checkings;
-      Added lots of comments, explaining what the checkings and the
+      Minor syntax changes in the checks;
+      Added lots of comments, explaining what the checks and the
         expect script are doing.
 
   - Major changes on functions: GetGpgMessage, GetMessageHeaders,
@@ -177,7 +204,7 @@ Firma CHANGELOG
       Changed "umask" from 0777 to 0077. Otherwise, function NewList
         cannot create configuration files for new lists;
       Improved parsing of option -a (--admin-task), removing
-        unecessary commands and routines from this part of the code;
+        unnecessary commands and routines from this part of the code;
       Again, new command-line options can be easily added to this new
         nested "case" structure.
 
@@ -201,7 +228,7 @@ Firma CHANGELOG
 07/05/2005 - 0.3-cvs (rev 1.13) - rhatto
 
   - Firma now uses sendmail or any smtp wrapper directly:
-    - Specify your smtp wrapper through MAIL var, eg:
+    - Specify your smtp wrapper through MAIL var, e.g.:
       MAIL=/usr/sbin/sendmail
       MAIL=/usr/bin/ssmtp
     - Command-line arguments passed to the wrapper must
@@ -221,10 +248,10 @@ Firma CHANGELOG
       SUBSCRIBERS -> get_subscribers_list
       get_headers -> get_message_headers
   - New args:
-    -h: chama a usage()
-    -v: chama a version()
+    -h: calls function usage
+    -v: calls function version
   - Option -a passes STDIN line by line to list_admin
-  - Added some checkings in the main procedure
+  - Added some checks in the main procedure
   - Some minor syntax changes
 
 02/08/2005 - 0.3-cvs - rhatto
@@ -232,7 +259,7 @@ Firma CHANGELOG
   - Completed function newlist (still needs tests)
   - New function: gpg_args
 
-25/05/2005 - v0.2.x - rhatto
+25/05/2005 - v0.2.4 - rhatto
 
   - Message is now stored in two arrays, MESSAGE and GPG_MESSAGE.
     Temporary files are no longer needed. Deleted TMP var.
@@ -289,7 +316,7 @@ Firma CHANGELOG
     configuration file. If any of these checks fail, firma exits and
     shows what should be corrected in the file.
 
-  - GPGLIST now lists public keys using the gpg option
+  - GPGLIST now lists public keys using GnuPG's option
     "--with-colons". Definitely much easier to parse.
 
   - added --no-permission-warning on $GPGCOMMAND.
@@ -339,7 +366,7 @@ Firma CHANGELOG
         --no-use-agent"
 
   - Added two new functions: GPGSTDERR and SUBSCRIBERS. The first gets
-    gpg STDERR and discards its STDOUT and the later returns the
+    GnuPG's STDERR and discards its STDOUT and the later returns the
     subscribers list.
 
     function GPGSTDERR {
@@ -367,13 +394,13 @@ Firma CHANGELOG
 
 Feb 2005 - v0.1 - rhatto
 
-  - First public release and proof of concept
+  - First public release and proof of concept.
   - Based on pgplist (http://www.rediris.es/app/pgplist/index.en.html),
-    but completely written from scratch
-  - Strips all mail headers
-  - Use keyring as database
+    but completely written from scratch.
+  - Strips all mail headers.
+  - Use keyring as database.
   - List variables are sourced from a configuration file.
-  - List subscription is managed through gpg public keyrings, one
+  - List subscription is managed through GnuPG's public keyrings, one
     keyring for each mailing list.
   - Message is read from STDIN, passed to it by postfix or some
     other MTA.
diff --git a/GUIDELINES b/GUIDELINES
index 7c8d100..e7d33e6 100755
--- a/GUIDELINES
+++ b/GUIDELINES
@@ -6,7 +6,7 @@ Abstract: this policy helps control all development
 
 In the future this procedure will be automatic.
 
-1 - After any adition to firma, check the following:
+1 - After any addition to firma, check the following:
 ----------------------------------------------------
 
   - Put all new variables in the variables list bellow
@@ -56,6 +56,8 @@ In the future this procedure will be automatic.
     MAIL_AGENT
     MAIL_AGENT_ARGS
     LISTS_DIR 
+    USE_GPG_HIDDEN_RECIPIENT_OPTION
+    SEND_MESSAGES_USING_BCC
 
     LIST_ADDRESS
     LIST_ADMIN
@@ -93,7 +95,9 @@ In the future this procedure will be automatic.
     first_blank_line
     i
     j
-    email
+    subscriber
+    recipients
+    email_address
     keyid
     uid_count
     chosen_uid_number