summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Command/Admin/newdomain.pm
blob: bbc5ce2f656f1a630f95e239b98d19e02e4b92b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
#-*- perl -*-
#
#  Copyright (C) 2003,2004,2005,2006 Ken'ichi Fukamachi
#   All rights reserved. This program is free software; you can
#   redistribute it and/or modify it under the same terms as Perl itself.
#
# $FML: newdomain.pm,v 1.10 2006/03/05 08:08:36 fukachan Exp $
#

package FML::Command::Admin::newdomain;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;


=head1 NAME

FML::Command::Admin::newdomain - declare a new domain we use.

=head1 SYNOPSIS

See C<FML::Command> for more detail of newdomain operation.

=head1 DESCRIPTION

declare a new domain we use.

=head2 new()

constructor.

=head2 need_lock()

not need lock in the first time.

=cut


# Descriptions: constructor.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
sub new
{
    my ($self) = @_;
    my ($type) = ref($self) || $self;
    my $me     = {};
    return bless $me, $type;
}


# Descriptions: not need lock in the first time.
#    Arguments: none
# Side Effects: none
# Return Value: NUM( 1 or 0)
sub need_lock { 0;}


=head2 process($curproc, $command_context)

declare a new domain we use.
It adds domain to ml_home_prefix configuration file.

=cut


# Descriptions: declare a new domain we use.
#    Arguments: OBJ($self) OBJ($curproc) OBJ($command_context)
# Side Effects: forward request to dir module
# Return Value: none
sub process
{
    my ($self, $curproc, $command_context) = @_;
    my $canon_argv = $command_context->get_canon_argv();
    my $domain     = $canon_argv->{ ml_name }        || '';
    my $prefix     = $canon_argv->{ options }->[ 0 ] || '';
    my $error      = '';

    if ($domain && $prefix) {
	use FML::ML::HomePrefix;
	my $ml_home_prefix = new FML::ML::HomePrefix $curproc;
	$ml_home_prefix->add($domain, $prefix);
    }
    elsif ($domain && (! $prefix)) {
	$error = "ml_home_prefix unspecified";
    }
    elsif ((! $domain) && $prefix) {
	$error = "domain unspecified";
    }
    else {
	$error = "no argument";
    }

    if ($error) {
	$curproc->logerror($error);
	croak($error);
    }
}


=head1 CODING STYLE

See C<http://www.fml.org/software/FNF/> on fml coding style guide.

=head1 AUTHOR

Ken'ichi Fukamachi

=head1 COPYRIGHT

Copyright (C) 2003,2004,2005,2006 Ken'ichi Fukamachi

All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.

=head1 HISTORY

FML::Command::Admin::newdomain first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more detainewdomain.

=cut


1;