1 package FS::svc_domain;
4 use vars qw( @ISA $whois_hack $conf $smtpmachine
5 @defaultrecords $soadefaultttl $soaemail $soaexpire $soamachine
9 use Mail::Internet 1.44;
13 use FS::Record qw(fields qsearch qsearchs dbh);
20 use FS::domain_record;
23 @ISA = qw( FS::svc_Common );
25 #ask FS::UID to run this stuff for us later
26 $FS::UID::callback{'FS::domain'} = sub {
29 $smtpmachine = $conf->config('smtpmachine');
31 @defaultrecords = $conf->config('defaultrecords');
32 $soadefaultttl = $conf->config('soadefaultttl');
33 $soaemail = $conf->config('soaemail');
34 $soaexpire = $conf->config('soaexpire');
35 $soamachine = $conf->config('soamachine');
36 $soarefresh = $conf->config('soarefresh');
37 $soaretry = $conf->config('soaretry');
43 FS::svc_domain - Object methods for svc_domain records
49 $record = new FS::svc_domain \%hash;
50 $record = new FS::svc_domain { 'column' => 'value' };
52 $error = $record->insert;
54 $error = $new_record->replace($old_record);
56 $error = $record->delete;
58 $error = $record->check;
60 $error = $record->suspend;
62 $error = $record->unsuspend;
64 $error = $record->cancel;
68 An FS::svc_domain object represents a domain. FS::svc_domain inherits from
69 FS::svc_Common. The following fields are currently supported:
73 =item svcnum - primary key (assigned automatically for new accounts)
77 =item catchall - optional svcnum of an svc_acct record, designating an email catchall account.
87 Creates a new domain. To add the domain to the database, see L<"insert">.
91 sub table { 'svc_domain'; }
95 Adds this domain to the database. If there is an error, returns the error,
96 otherwise returns false.
98 The additional fields I<pkgnum> and I<svcpart> (see L<FS::cust_svc>) should be
99 defined. An FS::cust_svc record will be created and inserted.
101 The additional field I<action> should be set to I<N> for new domains or I<M>
104 A registration or transfer email will be submitted unless
105 $FS::svc_domain::whois_hack is true.
107 The additional field I<email> can be used to manually set the admin contact
108 email address on this email. Otherwise, the svc_acct records for this package
109 (see L<FS::cust_pkg>) are searched. If there is exactly one svc_acct record
110 in the same package, it is automatically used. Otherwise an error is returned.
112 If any I<soamachine> configuration file exists, an SOA record is added to
113 the domain_record table (see <FS::domain_record>).
115 If any records are defined in the I<defaultrecords> configuration file,
116 appropriate records are added to the domain_record table (see
117 L<FS::domain_record>).
125 local $SIG{HUP} = 'IGNORE';
126 local $SIG{INT} = 'IGNORE';
127 local $SIG{QUIT} = 'IGNORE';
128 local $SIG{TERM} = 'IGNORE';
129 local $SIG{TSTP} = 'IGNORE';
130 local $SIG{PIPE} = 'IGNORE';
132 my $oldAutoCommit = $FS::UID::AutoCommit;
133 local $FS::UID::AutoCommit = 0;
136 $error = $self->check;
137 return $error if $error;
139 return "Domain in use (here)"
140 if qsearchs( 'svc_domain', { 'domain' => $self->domain } );
142 my $whois = $self->whois;
143 if ( $self->action eq "N" && ! $whois_hack && $whois ) {
144 $dbh->rollback if $oldAutoCommit;
145 return "Domain in use (see whois)";
147 if ( $self->action eq "M" && ! $whois ) {
148 $dbh->rollback if $oldAutoCommit;
149 return "Domain not found (see whois)";
152 $error = $self->SUPER::insert;
154 $dbh->rollback if $oldAutoCommit;
158 $self->submit_internic unless $whois_hack;
161 my $soa = new FS::domain_record {
162 'svcnum' => $self->svcnum,
166 'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ".
167 "$soarefresh $soaretry $soaexpire $soadefaultttl )"
169 $error = $soa->insert;
171 $dbh->rollback if $oldAutoCommit;
172 return "couldn't insert SOA record for new domain: $error";
175 foreach my $record ( @defaultrecords ) {
176 my($zone,$af,$type,$data) = split(/\s+/,$record,4);
177 my $domain_record = new FS::domain_record {
178 'svcnum' => $self->svcnum,
184 my $error = $domain_record->insert;
186 $dbh->rollback if $oldAutoCommit;
187 return "couldn't insert record for new domain: $error";
193 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
200 Deletes this domain from the database. If there is an error, returns the
201 error, otherwise returns false.
203 The corresponding FS::cust_svc record will be deleted as well.
210 return "Can't delete a domain which has accounts!"
211 if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } );
213 #return "Can't delete a domain with (domain_record) zone entries!"
214 # if qsearch('domain_record', { 'svcnum' => $self->svcnum } );
216 local $SIG{HUP} = 'IGNORE';
217 local $SIG{INT} = 'IGNORE';
218 local $SIG{QUIT} = 'IGNORE';
219 local $SIG{TERM} = 'IGNORE';
220 local $SIG{TSTP} = 'IGNORE';
221 local $SIG{PIPE} = 'IGNORE';
223 my $oldAutoCommit = $FS::UID::AutoCommit;
224 local $FS::UID::AutoCommit = 0;
227 foreach my $domain_record ( reverse $self->domain_record ) {
228 my $error = $domain_record->delete;
230 $dbh->rollback if $oldAutoCommit;
235 my $error = $self->SUPER::delete;
237 $dbh->rollback if $oldAutoCommit;
241 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
244 =item replace OLD_RECORD
246 Replaces OLD_RECORD with this one in the database. If there is an error,
247 returns the error, otherwise returns false.
252 my ( $new, $old ) = ( shift, shift );
254 return "Can't change domain - reorder."
255 if $old->getfield('domain') ne $new->getfield('domain');
257 my $error = $new->SUPER::replace($old);
258 return $error if $error;
263 Just returns false (no error) for now.
265 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
269 Just returns false (no error) for now.
271 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
275 Just returns false (no error) for now.
277 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
281 Checks all fields to make sure this is a valid domain. If there is an error,
282 returns the error, otherwise returns false. Called by the insert and replace
285 Sets any fixed values; see L<FS::part_svc>.
292 my $x = $self->setfixed;
293 return $x unless ref($x);
296 my $error = $self->ut_numbern('svcnum')
297 || $self->ut_numbern('catchall')
299 return $error if $error;
303 if ( $self->svcnum ) {
304 my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
305 $pkgnum = $cust_svc->pkgnum;
307 $pkgnum = $self->pkgnum;
310 my($recref) = $self->hashref;
312 unless ( $whois_hack ) {
313 unless ( $self->email ) { #find out an email address
315 foreach ( qsearch( 'cust_svc', { 'pkgnum' => $pkgnum } ) ) {
316 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $_->svcnum } );
317 push @svc_acct, $svc_acct if $svc_acct;
320 if ( scalar(@svc_acct) == 0 ) {
321 return "Must order an account in package ". $pkgnum. " first";
322 } elsif ( scalar(@svc_acct) > 1 ) {
323 return "More than one account in package ". $pkgnum. ": specify admin contact email";
325 $self->email($svc_acct[0]->email );
330 #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) {
331 if ( $recref->{domain} =~ /^([\w\-]{1,22})\.(com|net|org|edu)$/ ) {
332 $recref->{domain} = "$1.$2";
334 } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.]+)$/ ) {
335 $recref->{domain} = $1;
337 return "Illegal domain ". $recref->{domain}.
338 " (or unknown registry - try \$whois_hack)";
341 $recref->{action} =~ /^(M|N)$/ or return "Illegal action";
342 $recref->{action} = $1;
344 if ( $recref->{catchall} ne '' ) {
345 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } );
346 return "Unknown catchall" unless $svc_acct;
349 $self->ut_textn('purpose');
368 sort { $order{$a->rectype} <=> $order{$b->rectype} }
369 qsearch('domain_record', { svcnum => $self->svcnum } );
373 sub catchall_svc_acct {
375 if ( $self->catchall ) {
376 qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } );
384 Returns the Net::Whois::Domain object (see L<Net::Whois>) for this domain, or
385 undef if the domain is not found in whois.
387 (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)
392 $whois_hack or new Net::Whois::Domain $_[0]->domain;
402 die "_whois depriciated";
405 =item submit_internic
407 Submits a registration email for this domain.
411 sub submit_internic {
413 carp "submit_internic depreciated";
420 Delete doesn't send a registration template.
422 All registries should be supported.
424 Should change action to a real field.
426 The $recref stuff in sub check should be cleaned up.
430 L<FS::svc_Common>, L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>,
431 L<FS::part_svc>, L<FS::cust_pkg>, L<Net::Whois>, schema.html from the base
432 documentation, config.html from the base documentation.