Changeset 328:73e179721396

Timestamp:

08/22/11 16:55:25 (9 months ago)

Author:

Anselm Lingnau <anselm@…>

Branch:

default

Message:

Various changes to pl-init.
pl-init will now add the list owner to the list as a subscriber with admin
privileges. This is mainly to make life easier for deployments of many lists
with Project Guinevere.

Also, the --config=... command line option was changed to read configuration
parameter assignments from a file whose name is given as the argument.
Individual paramter assignments may now be passed as additional command-line
arguments after the list owner address.

Files:

• bin/pl-init (modified) (7 diffs)
• lib/Lancelot/ConfigItems.pm (modified) (1 diff)

bin/pl-init

@@ -7 +7 @@
 =head1 SYNOPSIS
 
- pl-init [-v?] [--clone=otherlist] [-config=CONFIG] ...
+ pl-init [-v?] [--clone=otherlist] [--config=FILE] ...
         [--[no]mailfilter] [--our-isp] [--verbose]
-          list@domain owner-address
+          list@domain owner-address key=value ...
 
 =head1 OVERVIEW
 
-The B<pl-init> command creates a new Lancelot mailing list with no
-subscribers and a basic (if sensible) configuration.
+The B<pl-init> command creates a new Lancelot mailing list with
+a sensible (if basic) configuration.
 
 =head1 DESCRIPTION
@@ -26 +26 @@
 the content of a system-wide defaults file (if available), (3) the
 content of the user-specific defaults file F<$HOME/.pl/defaults.conf>
-(if available), and (4) any configuration parameter assignments given
-on the command line, in that order. Later settings override earlier
-ones.  Between (3) and (4), the B<list.address> parameter is set to
-I<list@domain>, the B<list.owneraddress> parameter is set to
-I<owner-address>, and the B<list.name> parameter is set to the
-local part of I<list@domain>, capitalised.
+(if available), (4) any files whose names are passed on the command line
+by means of the B<--config> option, and (5) any configuration parameter
+assignments given on the command line, in that order. Later settings
+override earlier ones.  Between (3) and (4), the B<list.address> parameter
+is set to I<list@domain>, the B<list.owneraddress> parameter is set to
+I<owner-address>, the B<list.ownername> parameter is set to the list
+owner's name if one is passed as part of I<owner-address>, and the
+B<list.name> parameter is set to the local part of I<list@domain>,
+capitalised.
+
+Any command-line parameters passed after I<owner-address> will be
+considered configuration parameter assignments in the sense of (5) above.
+Note that these are pre-parsed by the shell, and USE QUOTES IF YOUR
+CONFIGURATION PARAMETER ASSIGNMENTS CONTAIN WHITESPACE.
 
 If a list configuration is "cloned" from that of another list, that
 list's configuration is copied to the new list after the defaults
-files have been processed but before the command-line parameter
-assignments take effect. This makes it possible to copy a list's
-configuration "except for" some specific settings. The list and owner
-addresses are set immediately before the command-line parameter
-assignments are processed, so they will be correct for a "cloned"
-list; you overwrite them from the command line at your own peril.
+files have been processed but before the configuration files and
+parameter assignments given on the command line take effect.
+This makes it possible to copy a list's configuration "except for"
+some specific settings. The list and owner addresses are set immediately
+before the command-line parameter assignments are processed, so they will
+be correct for a "cloned" list; you overwrite them from the command line
+at your own peril.
+
+The I<owner-address> will also be subscribed to the list as an
+administrator. If you'd rather not have this, add the configuration
+parameter
+
+  list.subscribeowner = 0
+
+to one of the default files or invoke B<pl-init> like
+
+  pl-init list@domain owner@domain list.subscribeowner=0
+
 
 =head1 OPTIONS
@@ -52 +72 @@
 as the new list.
 
-=item B<--config>=I<key>=I<value>
-
-Changes the list configuration parameter I<key> to I<value> (use
-quotes if I<value> contains whitespace).  If B<--config> is used
-together with B<--clone>, the changes take place after the
-configuration has been cloned. There may be multiple B<--config>
-options on the same command line. Configuration parameters may be
-changed later using the B<pl-conf> command.
-
-USE QUOTES IF YOUR VALUES CONTAIN WHITESPACE.
+=item B<--config>=I<file>
+
+Reads configuration parameter assignments from I<file>. Empty lines
+and comment lines (starting with "#") in I<file> will be ignored.
+
+If B<--config> is used together with B<--clone>, the changes take
+place after the configuration has been cloned. There may be multiple
+B<--config> options on the same command line. Configuration parameters
+may be changed later using the B<pl-conf> command.
 
 =item B<--mailfilter>
@@ -93 +112 @@
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2004 by Anselm Lingnau. This program is free software; you
+Copyright 2004-11 by Anselm Lingnau. This program is free software; you
 may redistribute it and/or modify it under the terms of the GNU
 General Public License as published by the Free Software Foundation;
@@ -130 +149 @@
 use Lancelot::Log qw/log/;
 
-my (%opts);
+my %opts;
 
 GetOptions(\%opts, -defaults,
            -argvmin => 2, "need list and owner address",
-           -argvmax => 2, "too many arguments",
            "our-isp?", "clone=", "config@", "mailfilter!");
 
-my ($listaddr, $owneraddr) = @ARGV;
-my (%options) = ( create => 1, ourisp => $opts{"our-isp"} );
+my $listaddr = shift;
+my $owneraddr = (Email::Address->parse(shift))[0];
+my $ownername = $owneraddr->phrase || $owneraddr->comment;
+
+my %options = ( create => 1, ourisp => $opts{"our-isp"} );
 
 my $db = new Lancelot::DB $listaddr, \%options
@@ -146 +167 @@
 
 $db->set_config("list.address", $listaddr);
-$db->set_config("list.owneraddress", $owneraddr);
-my ($listname) = $listaddr;
+$db->set_config("list.owneraddress", $owneraddr->address);
+$db->set_config("list.ownername", $ownername) if $ownername;
+my $listname = $listaddr;
 $listname =~ s/\@.*$//;
 $db->set_config("list.name", ucfirst($listname));
 
-$db->set_configs(@{$opts{config}}) if @{$opts{config}};
+$db->set_configs_from_file($_, 0) foreach @{$opts{config}};
+$db->set_configs(@ARGV) if @ARGV;
 
 if ($opts{"our-isp"} && !($opts{mailfilter} == 0)) {
@@ -165 +188 @@
         die "$0: couldn't create $mfname: $!\n";
     }
+} else {
+    my $xlistaddr = $listaddr;
+    my $delim = $db->get_config("mail.delimiter");
+    $xlistaddr =~ s/\@/${delim}ANYTHING\@/;
+    my $user = getpwuid($<);
+
+    print "Make sure that within your MTA setup, messages to\n\n";
+    print "    $listaddr   as well as\n";
+    print "    $xlistaddr\n\n";
+    print "are piped into\n\n";
+    print "    $Bin/pl-incoming --user $user $listaddr\n\n";
+    print "Consult Project Lancelot's Deployment-HOWTO for details.\n";
+}
+
+my $subscribe_owner = $db->get_config("list.subscribeowner");
+if ($subscribe_owner) {
+    log "info", "subscribing owner address as list administrator";
+    unless ($db->add_address($owneraddr, { admin => 1 })) {
+        log "err", "error subscribing $owneraddr\n";
+    }
 }
 

lib/Lancelot/ConfigItems.pm

@@ -98 +98 @@
 list.owneraddress|STR||Address of the list owner, for LIST+owner@DOMAIN
 list.ownername|STR||Name of the list owner
+list.subscribeowner|BOOL|1|Subscribe list owner as administrator when list is created
 mail.addheaders|STR||List of names of headers to be added to outgoing messages (put header values in »mail.header.NAME« variables)
 mail.delimiter|STR|+|Character between list name and extensions (must match MTA setup)