1 package FS::svc_domain;
4 use vars qw( @ISA $whois_hack $conf
5 @defaultrecords $soadefaultttl $soaemail $soaexpire $soamachine
11 use FS::Record qw(fields qsearch qsearchs dbh);
18 use FS::domain_record;
21 @ISA = qw( FS::svc_Common );
23 #ask FS::UID to run this stuff for us later
24 $FS::UID::callback{'FS::domain'} = sub {
27 @defaultrecords = $conf->config('defaultrecords');
28 $soadefaultttl = $conf->config('soadefaultttl');
29 $soaemail = $conf->config('soaemail');
30 $soaexpire = $conf->config('soaexpire');
31 $soamachine = $conf->config('soamachine');
32 $soarefresh = $conf->config('soarefresh');
33 $soaretry = $conf->config('soaretry');
39 FS::svc_domain - Object methods for svc_domain records
45 $record = new FS::svc_domain \%hash;
46 $record = new FS::svc_domain { 'column' => 'value' };
48 $error = $record->insert;
50 $error = $new_record->replace($old_record);
52 $error = $record->delete;
54 $error = $record->check;
56 $error = $record->suspend;
58 $error = $record->unsuspend;
60 $error = $record->cancel;
64 An FS::svc_domain object represents a domain. FS::svc_domain inherits from
65 FS::svc_Common. The following fields are currently supported:
69 =item svcnum - primary key (assigned automatically for new accounts)
73 =item catchall - optional svcnum of an svc_acct record, designating an email catchall account.
83 Creates a new domain. To add the domain to the database, see L<"insert">.
87 sub table { 'svc_domain'; }
89 =item insert [ , OPTION => VALUE ... ]
91 Adds this domain to the database. If there is an error, returns the error,
92 otherwise returns false.
94 The additional fields I<pkgnum> and I<svcpart> (see L<FS::cust_svc>) should be
95 defined. An FS::cust_svc record will be created and inserted.
97 The additional field I<action> should be set to I<N> for new domains or I<M>
100 A registration or transfer email will be submitted unless
101 $FS::svc_domain::whois_hack is true.
103 The additional field I<email> can be used to manually set the admin contact
104 email address on this email. Otherwise, the svc_acct records for this package
105 (see L<FS::cust_pkg>) are searched. If there is exactly one svc_acct record
106 in the same package, it is automatically used. Otherwise an error is returned.
108 If any I<soamachine> configuration file exists, an SOA record is added to
109 the domain_record table (see <FS::domain_record>).
111 If any records are defined in the I<defaultrecords> configuration file,
112 appropriate records are added to the domain_record table (see
113 L<FS::domain_record>).
115 Currently available options are: I<depend_jobnum>
117 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
118 jobnums), all provisioning jobs will have a dependancy on the supplied
119 jobnum(s) (they will not run until the specific job(s) complete(s)).
127 local $SIG{HUP} = 'IGNORE';
128 local $SIG{INT} = 'IGNORE';
129 local $SIG{QUIT} = 'IGNORE';
130 local $SIG{TERM} = 'IGNORE';
131 local $SIG{TSTP} = 'IGNORE';
132 local $SIG{PIPE} = 'IGNORE';
134 my $oldAutoCommit = $FS::UID::AutoCommit;
135 local $FS::UID::AutoCommit = 0;
138 $error = $self->check;
139 return $error if $error;
141 return "Domain in use (here)"
142 if qsearchs( 'svc_domain', { 'domain' => $self->domain } );
144 my $whois = $self->whois;
145 if ( $self->action eq "N" && ! $whois_hack && $whois ) {
146 $dbh->rollback if $oldAutoCommit;
147 return "Domain in use (see whois)";
149 if ( $self->action eq "M" && ! $whois ) {
150 $dbh->rollback if $oldAutoCommit;
151 return "Domain not found (see whois)";
154 $error = $self->SUPER::insert(@_);
156 $dbh->rollback if $oldAutoCommit;
160 $self->submit_internic unless $whois_hack;
163 my $soa = new FS::domain_record {
164 'svcnum' => $self->svcnum,
168 'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ".
169 "$soarefresh $soaretry $soaexpire $soadefaultttl )"
171 $error = $soa->insert;
173 $dbh->rollback if $oldAutoCommit;
174 return "couldn't insert SOA record for new domain: $error";
177 foreach my $record ( @defaultrecords ) {
178 my($zone,$af,$type,$data) = split(/\s+/,$record,4);
179 my $domain_record = new FS::domain_record {
180 'svcnum' => $self->svcnum,
186 my $error = $domain_record->insert;
188 $dbh->rollback if $oldAutoCommit;
189 return "couldn't insert record for new domain: $error";
195 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
202 Deletes this domain from the database. If there is an error, returns the
203 error, otherwise returns false.
205 The corresponding FS::cust_svc record will be deleted as well.
212 return "Can't delete a domain which has accounts!"
213 if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } );
215 #return "Can't delete a domain with (domain_record) zone entries!"
216 # if qsearch('domain_record', { 'svcnum' => $self->svcnum } );
218 local $SIG{HUP} = 'IGNORE';
219 local $SIG{INT} = 'IGNORE';
220 local $SIG{QUIT} = 'IGNORE';
221 local $SIG{TERM} = 'IGNORE';
222 local $SIG{TSTP} = 'IGNORE';
223 local $SIG{PIPE} = 'IGNORE';
225 my $oldAutoCommit = $FS::UID::AutoCommit;
226 local $FS::UID::AutoCommit = 0;
229 foreach my $domain_record ( reverse $self->domain_record ) {
230 my $error = $domain_record->delete;
232 $dbh->rollback if $oldAutoCommit;
237 my $error = $self->SUPER::delete;
239 $dbh->rollback if $oldAutoCommit;
243 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
246 =item replace OLD_RECORD
248 Replaces OLD_RECORD with this one in the database. If there is an error,
249 returns the error, otherwise returns false.
254 my ( $new, $old ) = ( shift, shift );
256 return "Can't change domain - reorder."
257 if $old->getfield('domain') ne $new->getfield('domain');
259 # Better to do it here than to force the caller to remember that svc_domain is weird.
260 $new->setfield(action => 'M');
261 my $error = $new->SUPER::replace($old);
262 return $error if $error;
267 Just returns false (no error) for now.
269 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
273 Just returns false (no error) for now.
275 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
279 Just returns false (no error) for now.
281 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
285 Checks all fields to make sure this is a valid domain. If there is an error,
286 returns the error, otherwise returns false. Called by the insert and replace
289 Sets any fixed values; see L<FS::part_svc>.
296 my $x = $self->setfixed;
297 return $x unless ref($x);
300 my $error = $self->ut_numbern('svcnum')
301 || $self->ut_numbern('catchall')
303 return $error if $error;
307 if ( $self->svcnum ) {
308 my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
309 $pkgnum = $cust_svc->pkgnum;
311 $pkgnum = $self->pkgnum;
314 my($recref) = $self->hashref;
316 unless ( $whois_hack ) {
317 unless ( $self->email ) { #find out an email address
319 foreach ( qsearch( 'cust_svc', { 'pkgnum' => $pkgnum } ) ) {
320 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $_->svcnum } );
321 push @svc_acct, $svc_acct if $svc_acct;
324 if ( scalar(@svc_acct) == 0 ) {
325 return "Must order an account in package ". $pkgnum. " first";
326 } elsif ( scalar(@svc_acct) > 1 ) {
327 return "More than one account in package ". $pkgnum. ": specify admin contact email";
329 $self->email($svc_acct[0]->email );
334 #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) {
335 if ( $recref->{domain} =~ /^([\w\-]{1,63})\.(com|net|org|edu)$/ ) {
336 $recref->{domain} = "$1.$2";
338 } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.]+)$/ ) {
339 $recref->{domain} = $1;
341 return "Illegal domain ". $recref->{domain}.
342 " (or unknown registry - try \$whois_hack)";
345 $recref->{action} =~ /^(M|N)$/
346 or return "Illegal action: ". $recref->{action};
347 $recref->{action} = $1;
349 if ( $recref->{catchall} ne '' ) {
350 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } );
351 return "Unknown catchall" unless $svc_acct;
354 $self->ut_textn('purpose')
355 or $self->SUPER::check;
375 sort { $order{$a->rectype} <=> $order{$b->rectype} }
376 qsearch('domain_record', { svcnum => $self->svcnum } );
380 sub catchall_svc_acct {
382 if ( $self->catchall ) {
383 qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } );
391 # Returns the Net::Whois::Domain object (see L<Net::Whois>) for this domain, or
392 # undef if the domain is not found in whois.
394 (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)
399 #$whois_hack or new Net::Whois::Domain $_[0]->domain;
400 $whois_hack or die "whois_hack not set...\n";
410 die "_whois depriciated";
413 =item submit_internic
415 Submits a registration email for this domain.
419 sub submit_internic {
421 carp "submit_internic depreciated";
428 Delete doesn't send a registration template.
430 All registries should be supported.
432 Should change action to a real field.
434 The $recref stuff in sub check should be cleaned up.
438 L<FS::svc_Common>, L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>,
439 L<FS::part_svc>, L<FS::cust_pkg>, L<Net::Whois>, schema.html from the base
440 documentation, config.html from the base documentation.