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'; }
93 =item insert [ , OPTION => VALUE ... ]
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>).
119 Currently available options are: I<depend_jobnum>
121 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
122 jobnums), all provisioning jobs will have a dependancy on the supplied
123 jobnum(s) (they will not run until the specific job(s) complete(s)).
131 local $SIG{HUP} = 'IGNORE';
132 local $SIG{INT} = 'IGNORE';
133 local $SIG{QUIT} = 'IGNORE';
134 local $SIG{TERM} = 'IGNORE';
135 local $SIG{TSTP} = 'IGNORE';
136 local $SIG{PIPE} = 'IGNORE';
138 my $oldAutoCommit = $FS::UID::AutoCommit;
139 local $FS::UID::AutoCommit = 0;
142 $error = $self->check;
143 return $error if $error;
145 return "Domain in use (here)"
146 if qsearchs( 'svc_domain', { 'domain' => $self->domain } );
148 my $whois = $self->whois;
149 if ( $self->action eq "N" && ! $whois_hack && $whois ) {
150 $dbh->rollback if $oldAutoCommit;
151 return "Domain in use (see whois)";
153 if ( $self->action eq "M" && ! $whois ) {
154 $dbh->rollback if $oldAutoCommit;
155 return "Domain not found (see whois)";
158 $error = $self->SUPER::insert(@_);
160 $dbh->rollback if $oldAutoCommit;
164 $self->submit_internic unless $whois_hack;
167 my $soa = new FS::domain_record {
168 'svcnum' => $self->svcnum,
172 'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ".
173 "$soarefresh $soaretry $soaexpire $soadefaultttl )"
175 $error = $soa->insert;
177 $dbh->rollback if $oldAutoCommit;
178 return "couldn't insert SOA record for new domain: $error";
181 foreach my $record ( @defaultrecords ) {
182 my($zone,$af,$type,$data) = split(/\s+/,$record,4);
183 my $domain_record = new FS::domain_record {
184 'svcnum' => $self->svcnum,
190 my $error = $domain_record->insert;
192 $dbh->rollback if $oldAutoCommit;
193 return "couldn't insert record for new domain: $error";
199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
206 Deletes this domain from the database. If there is an error, returns the
207 error, otherwise returns false.
209 The corresponding FS::cust_svc record will be deleted as well.
216 return "Can't delete a domain which has accounts!"
217 if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } );
219 return "Can't delete a domain with (svc_acct_sm) mail aliases!"
220 if defined( $FS::Record::dbdef->table('svc_acct_sm') )
221 && qsearch('svc_acct_sm', { 'domsvc' => $self->svcnum } );
223 #return "Can't delete a domain with (domain_record) zone entries!"
224 # if qsearch('domain_record', { 'svcnum' => $self->svcnum } );
226 local $SIG{HUP} = 'IGNORE';
227 local $SIG{INT} = 'IGNORE';
228 local $SIG{QUIT} = 'IGNORE';
229 local $SIG{TERM} = 'IGNORE';
230 local $SIG{TSTP} = 'IGNORE';
231 local $SIG{PIPE} = 'IGNORE';
233 my $oldAutoCommit = $FS::UID::AutoCommit;
234 local $FS::UID::AutoCommit = 0;
237 foreach my $domain_record ( reverse $self->domain_record ) {
238 my $error = $domain_record->delete;
240 $dbh->rollback if $oldAutoCommit;
245 my $error = $self->SUPER::delete;
247 $dbh->rollback if $oldAutoCommit;
251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
254 =item replace OLD_RECORD
256 Replaces OLD_RECORD with this one in the database. If there is an error,
257 returns the error, otherwise returns false.
262 my ( $new, $old ) = ( shift, shift );
264 return "Can't change domain - reorder."
265 if $old->getfield('domain') ne $new->getfield('domain');
267 my $error = $new->SUPER::replace($old);
268 return $error if $error;
273 Just returns false (no error) for now.
275 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
279 Just returns false (no error) for now.
281 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
285 Just returns false (no error) for now.
287 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
291 Checks all fields to make sure this is a valid domain. If there is an error,
292 returns the error, otherwise returns false. Called by the insert and replace
295 Sets any fixed values; see L<FS::part_svc>.
302 my $x = $self->setfixed;
303 return $x unless ref($x);
306 my $error = $self->ut_numbern('svcnum')
307 || $self->ut_numbern('catchall')
309 return $error if $error;
313 if ( $self->svcnum ) {
314 my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
315 $pkgnum = $cust_svc->pkgnum;
317 $pkgnum = $self->pkgnum;
320 my($recref) = $self->hashref;
322 unless ( $whois_hack ) {
323 unless ( $self->email ) { #find out an email address
325 foreach ( qsearch( 'cust_svc', { 'pkgnum' => $pkgnum } ) ) {
326 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $_->svcnum } );
327 push @svc_acct, $svc_acct if $svc_acct;
330 if ( scalar(@svc_acct) == 0 ) {
331 return "Must order an account in package ". $pkgnum. " first";
332 } elsif ( scalar(@svc_acct) > 1 ) {
333 return "More than one account in package ". $pkgnum. ": specify admin contact email";
335 $self->email($svc_acct[0]->email );
340 #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) {
341 if ( $recref->{domain} =~ /^([\w\-]{1,63})\.(com|net|org|edu)$/ ) {
342 $recref->{domain} = "$1.$2";
344 } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.]+)$/ ) {
345 $recref->{domain} = $1;
347 return "Illegal domain ". $recref->{domain}.
348 " (or unknown registry - try \$whois_hack)";
351 $recref->{action} =~ /^(M|N)$/ or return "Illegal action";
352 $recref->{action} = $1;
354 if ( $recref->{catchall} ne '' ) {
355 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } );
356 return "Unknown catchall" unless $svc_acct;
359 $self->ut_textn('purpose');
378 sort { $order{$a->rectype} <=> $order{$b->rectype} }
379 qsearch('domain_record', { svcnum => $self->svcnum } );
383 sub catchall_svc_acct {
385 if ( $self->catchall ) {
386 qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } );
394 Returns the Net::Whois::Domain object (see L<Net::Whois>) for this domain, or
395 undef if the domain is not found in whois.
397 (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)
402 $whois_hack or new Net::Whois::Domain $_[0]->domain;
412 die "_whois depriciated";
415 =item submit_internic
417 Submits a registration email for this domain.
421 sub submit_internic {
423 carp "submit_internic depreciated";
430 Delete doesn't send a registration template.
432 All registries should be supported.
434 Should change action to a real field.
436 The $recref stuff in sub check should be cleaned up.
440 L<FS::svc_Common>, L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>,
441 L<FS::part_svc>, L<FS::cust_pkg>, L<Net::Whois>, schema.html from the base
442 documentation, config.html from the base documentation.