1 package FS::svc_domain;
4 use vars qw( @ISA $whois_hack $conf
5 @defaultrecords $soadefaultttl $soaemail $soaexpire $soamachine
9 use Scalar::Util qw( blessed );
12 use Net::Domain::TLD qw(tld_exists);
13 use FS::Record qw(fields qsearch qsearchs dbh);
16 use FS::svc_Parent_Mixin;
21 use FS::domain_record;
24 @ISA = qw( FS::svc_Parent_Mixin FS::svc_Common );
26 #ask FS::UID to run this stuff for us later
27 $FS::UID::callback{'FS::domain'} = sub {
30 @defaultrecords = $conf->config('defaultrecords');
31 $soadefaultttl = $conf->config('soadefaultttl');
32 $soaemail = $conf->config('soaemail');
33 $soaexpire = $conf->config('soaexpire');
34 $soamachine = $conf->config('soamachine');
35 $soarefresh = $conf->config('soarefresh');
36 $soaretry = $conf->config('soaretry');
42 FS::svc_domain - Object methods for svc_domain records
48 $record = new FS::svc_domain \%hash;
49 $record = new FS::svc_domain { 'column' => 'value' };
51 $error = $record->insert;
53 $error = $new_record->replace($old_record);
55 $error = $record->delete;
57 $error = $record->check;
59 $error = $record->suspend;
61 $error = $record->unsuspend;
63 $error = $record->cancel;
67 An FS::svc_domain object represents a domain. FS::svc_domain inherits from
68 FS::svc_Common. The following fields are currently supported:
72 =item svcnum - primary key (assigned automatically for new accounts)
76 =item catchall - optional svcnum of an svc_acct record, designating an email catchall account.
82 =item registrarnum - Registrar (see L<FS::registrar>)
84 =item registrarkey - Registrar key or password for this domain
86 =item setup_date - UNIX timestamp
88 =item renewal_interval - Number of days before expiration date to start renewal
90 =item expiration_date - UNIX timestamp
102 Creates a new domain. To add the domain to the database, see L<"insert">.
110 'display_weight' => 20,
111 'cancel_weight' => 60,
113 'domain' => 'Domain',
115 label => 'Parent domain / Communigate administrator domain',
117 select_table => 'svc_domain',
118 select_key => 'svcnum',
119 select_label => 'domain',
120 disable_inventory => 1,
123 'max_accounts' => { label => 'Maximum number of accounts',
124 'disable_inventory' => 1,
127 label => 'Communigate aliases',
129 disable_inventory => 1,
132 'cgp_accessmodes' => {
133 label => 'Communigate enabled services',
134 type => 'communigate_pro-accessmodes',
135 disable_inventory => 1,
139 'acct_def_cgp_accessmodes' => {
140 label => 'Acct. default Communigate enabled services',
141 type => 'communigate_pro-accessmodes',
142 disable_inventory => 1,
145 'acct_def_password_selfchange' => { label => 'Acct. default Password modification',
147 disable_inventory => 1,
150 'acct_def_password_recover' => { label => 'Acct. default Password recovery',
152 disable_inventory => 1,
155 'acct_def_cgp_deletemode' => {
156 label => 'Acct. default Communigate message delete method',
158 select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
159 disable_inventory => 1,
162 'acct_def_cgp_emptytrash' => {
163 label => 'Acct. default Communigate on logout remove trash',
165 disable_inventory => 1,
168 'acct_def_quota' => {
169 label => 'Acct. default Quota', #Mail storage limit
171 disable_inventory => 1,
174 'acct_def_file_quota'=> {
175 label => 'Acct. default File storage limit',
177 disable_inventory => 1,
180 'acct_def_file_maxnum'=> {
181 label => 'Acct. default Number of files limit',
183 disable_inventory => 1,
186 'acct_def_file_maxsize'=> {
187 label => 'Acct. default File size limit',
189 disable_inventory => 1,
192 'acct_def_cgp_rulesallowed' => {
193 label => 'Acct. default Allowed mail rules',
195 select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
196 disable_inventory => 1,
199 'acct_def_cgp_rpopallowed' => {
200 label => 'Acct. default RPOP modifications',
203 'acct_def_cgp_mailtoall' => {
204 label => 'Acct. default Accepts mail to "all"',
207 'acct_def_cgp_addmailtrailer' => {
208 label => 'Acct. default Add trailer to sent mail',
212 label => 'Mail trailer',
214 disable_inventory => 1,
217 'acct_def_cgp_language' => {
218 label => 'Acct. default language',
220 select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
221 disable_inventory => 1,
224 'acct_def_cgp_timezone' => {
225 label => 'Acct. default time zone',
229 '(+0100) Algeria/Congo',
230 '(+0200) Egypt/South Africa',
231 '(+0300) Saudi Arabia',
234 '(+0600) Bangladesh',
235 '(+0700) Thailand/Vietnam',
236 '(+0800) China/Malaysia',
237 '(+0900) Japan/Korea',
238 '(+1000) Queensland',
239 '(+1100) Micronesia',
241 '(+1300) Tonga/Kiribati',
242 '(+1400) Christmas Islands',
243 '(-0100) Azores/Cape Verde',
244 '(-0200) Fernando de Noronha',
245 '(-0300) Argentina/Uruguay',
246 '(-0400) Venezuela/Guyana',
247 '(-0500) Haiti/Peru',
248 '(-0600) Central America',
251 '(-0900) Marquesas Islands',
252 '(-1000) Hawaii/Tahiti',
262 'Australia/Adelaide',
264 'Australia/NorthernTerritory',
271 'NewZealand/Auckland',
272 'NorthAmerica/Alaska',
273 'NorthAmerica/Atlantic',
274 'NorthAmerica/Central',
275 'NorthAmerica/Eastern',
276 'NorthAmerica/Mountain',
277 'NorthAmerica/Pacific',
278 'Russia/Ekaterinburg',
281 'Russia/Krasnoyarsk',
283 'Russia/Novosibirsk',
284 'Russia/Vladivostok',
286 'SouthAmerica/Brasil',
287 'SouthAmerica/Chile',
288 'SouthAmerica/Paraguay',
290 disable_inventory => 1,
293 'acct_def_cgp_skinname' => {
294 label => 'Acct. default layout',
296 select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
297 disable_inventory => 1,
300 'acct_def_cgp_prontoskinname' => {
301 label => 'Acct. default Pronto style',
303 select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
304 disable_inventory => 1,
307 'acct_def_cgp_sendmdnmode' => {
308 label => 'Acct. default send read receipts',
310 select_list => [ '', 'Never', 'Manually', 'Automatically' ],
311 disable_inventory => 1,
318 sub table { 'svc_domain'; }
321 my($class, $string) = @_;
322 $class->search_sql_field('domain', $string);
337 =item insert [ , OPTION => VALUE ... ]
339 Adds this domain to the database. If there is an error, returns the error,
340 otherwise returns false.
342 The additional fields I<pkgnum> and I<svcpart> (see L<FS::cust_svc>) should be
343 defined. An FS::cust_svc record will be created and inserted.
345 The additional field I<action> should be set to I<N> for new domains, I<M>
346 for transfers, or I<I> for no action (registered elsewhere).
348 A registration or transfer email will be submitted unless
349 $FS::svc_domain::whois_hack is true.
351 The additional field I<email> can be used to manually set the admin contact
352 email address on this email. Otherwise, the svc_acct records for this package
353 (see L<FS::cust_pkg>) are searched. If there is exactly one svc_acct record
354 in the same package, it is automatically used. Otherwise an error is returned.
356 If any I<soamachine> configuration file exists, an SOA record is added to
357 the domain_record table (see <FS::domain_record>).
359 If any records are defined in the I<defaultrecords> configuration file,
360 appropriate records are added to the domain_record table (see
361 L<FS::domain_record>).
363 Currently available options are: I<depend_jobnum>
365 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
366 jobnums), all provisioning jobs will have a dependancy on the supplied
367 jobnum(s) (they will not run until the specific job(s) complete(s)).
375 local $SIG{HUP} = 'IGNORE';
376 local $SIG{INT} = 'IGNORE';
377 local $SIG{QUIT} = 'IGNORE';
378 local $SIG{TERM} = 'IGNORE';
379 local $SIG{TSTP} = 'IGNORE';
380 local $SIG{PIPE} = 'IGNORE';
382 my $oldAutoCommit = $FS::UID::AutoCommit;
383 local $FS::UID::AutoCommit = 0;
386 $error = $self->SUPER::insert(@_);
388 $dbh->rollback if $oldAutoCommit;
393 my $soa = new FS::domain_record {
394 'svcnum' => $self->svcnum,
398 'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ".
399 "$soarefresh $soaretry $soaexpire $soadefaultttl )"
401 $error = $soa->insert;
403 $dbh->rollback if $oldAutoCommit;
404 return "couldn't insert SOA record for new domain: $error";
407 foreach my $record ( @defaultrecords ) {
408 my($zone,$af,$type,$data) = split(/\s+/,$record,4);
409 my $domain_record = new FS::domain_record {
410 'svcnum' => $self->svcnum,
416 my $error = $domain_record->insert;
418 $dbh->rollback if $oldAutoCommit;
419 return "couldn't insert record for new domain: $error";
425 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
432 Deletes this domain from the database. If there is an error, returns the
433 error, otherwise returns false.
435 The corresponding FS::cust_svc record will be deleted as well.
442 return "Can't delete a domain which has accounts!"
443 if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } );
445 #return "Can't delete a domain with (domain_record) zone entries!"
446 # if qsearch('domain_record', { 'svcnum' => $self->svcnum } );
448 local $SIG{HUP} = 'IGNORE';
449 local $SIG{INT} = 'IGNORE';
450 local $SIG{QUIT} = 'IGNORE';
451 local $SIG{TERM} = 'IGNORE';
452 local $SIG{TSTP} = 'IGNORE';
453 local $SIG{PIPE} = 'IGNORE';
455 my $oldAutoCommit = $FS::UID::AutoCommit;
456 local $FS::UID::AutoCommit = 0;
459 foreach my $domain_record ( reverse $self->domain_record ) {
460 my $error = $domain_record->delete;
462 $dbh->rollback if $oldAutoCommit;
463 return "can't delete DNS entry: ".
464 join(' ', map $domain_record->$_(),
465 qw( reczone recaf rectype recdata )
471 my $error = $self->SUPER::delete(@_);
473 $dbh->rollback if $oldAutoCommit;
477 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
480 =item replace OLD_RECORD
482 Replaces OLD_RECORD with this one in the database. If there is an error,
483 returns the error, otherwise returns false.
490 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
494 return "Can't change domain - reorder."
495 if $old->getfield('domain') ne $new->getfield('domain')
496 && ! $conf->exists('svc_domain-edit_domain');
498 # Better to do it here than to force the caller to remember that svc_domain is weird.
499 $new->setfield(action => 'I');
500 my $error = $new->SUPER::replace($old, @_);
501 return $error if $error;
506 Just returns false (no error) for now.
508 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
512 Just returns false (no error) for now.
514 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
518 Just returns false (no error) for now.
520 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
524 Checks all fields to make sure this is a valid domain. If there is an error,
525 returns the error, otherwise returns false. Called by the insert and replace
528 Sets any fixed values; see L<FS::part_svc>.
535 my $x = $self->setfixed;
536 return $x unless ref($x);
539 my $error = $self->ut_numbern('svcnum')
540 || $self->ut_numbern('catchall')
541 || $self->ut_numbern('max_accounts')
542 || $self->ut_anything('trailer') #well
543 || $self->ut_textn('cgp_aliases') #well
544 || $self->ut_enum('acct_def_password_selfchange', [ '', 'Y' ])
545 || $self->ut_enum('acct_def_password_recover', [ '', 'Y' ])
546 || $self->ut_textn('acct_def_cgp_accessmodes')
547 || $self->ut_alphan('acct_def_quota')
548 || $self->ut_alphan('acct_def_file_quota')
549 || $self->ut_alphan('acct_def_maxnum')
550 || $self->ut_alphan('acct_def_maxsize')
552 || $self->ut_alphasn('acct_def_cgp_rulesallowed')
553 || $self->ut_enum('acct_def_cgp_rpopallowed', [ '', 'Y' ])
554 || $self->ut_enum('acct_def_cgp_mailtoall', [ '', 'Y' ])
555 || $self->ut_enum('acct_def_cgp_addmailtrailer', [ '', 'Y' ])
556 #XXX archive messages
558 || $self->ut_alphasn('acct_def_cgp_deletemode')
559 || $self->ut_alphan('acct_def_cgp_emptytrash')
560 || $self->ut_alphan('acct_def_cgp_language')
561 || $self->ut_textn('acct_def_cgp_timezone')
562 || $self->ut_textn('acct_def_cgp_skinname')
563 || $self->ut_textn('acct_def_cgp_prontoskinname')
564 || $self->ut_alphan('acct_def_cgp_sendmdnmode')
566 #XXX rules, archive rule, spam foldering rule(s)
568 return $error if $error;
572 if ( $self->svcnum ) {
573 my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
574 $pkgnum = $cust_svc->pkgnum;
576 $pkgnum = $self->pkgnum;
579 my($recref) = $self->hashref;
581 #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) {
582 if ( $recref->{domain} =~ /^([\w\-]{1,63})\.(com|net|org|edu|tv|info|biz)$/ ) {
583 $recref->{domain} = "$1.$2";
584 $recref->{suffix} ||= $2;
586 } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.]+)\.(\w+)$/ ) {
587 $recref->{domain} = "$1.$2";
588 # need to match a list of suffixes - no guarantee they're top-level..
589 # http://wiki.mozilla.org/TLD_List
590 # but this will have to do for now...
591 $recref->{suffix} ||= $2;
593 return "Illegal domain ". $recref->{domain}.
594 " (or unknown registry - try \$whois_hack)";
597 $self->suffix =~ /(^|\.)(\w+)$/
598 or return "can't parse suffix for TLD: ". $self->suffix;
600 return "No such TLD: .$tld" unless tld_exists($tld);
602 if ( $recref->{catchall} ne '' ) {
603 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } );
604 return "Unknown catchall" unless $svc_acct;
607 $self->ut_alphan('suffix')
608 or $self->ut_foreign_keyn('registrarnum', 'registrar', 'registrarnum')
609 or $self->ut_textn('registrarkey')
610 or $self->ut_numbern('setup_date')
611 or $self->ut_numbern('renewal_interval')
612 or $self->ut_numbern('expiration_date')
613 or $self->SUPER::check;
617 sub _check_duplicate {
622 if ( qsearchs( 'svc_domain', { 'domain' => $self->domain } ) ) {
623 return "Domain in use (here)";
647 #'SOA' => sub { $_[0]->recdata cmp $_[1]->recdata }, #sure hope not though
648 # 'SOA' => sub { 0; },
649 # 'NS' => sub { 0; },
650 'MX' => sub { my( $a_weight, $a_name ) = split(/\s+/, $_[0]->recdata);
651 my( $b_weight, $b_name ) = split(/\s+/, $_[1]->recdata);
652 $a_weight <=> $b_weight or $a_name cmp $b_name;
654 'CNAME' => sub { $_[0]->reczone cmp $_[1]->reczone },
655 'A' => sub { $_[0]->reczone cmp $_[1]->reczone },
657 # 'TXT' => sub { 0; },
658 'PTR' => sub { $_[0]->reczone <=> $_[1]->reczone },
661 map { $_ } #return $self->num_domain_record( PARAMS ) unless wantarray;
662 sort { $order{$a->rectype} <=> $order{$b->rectype}
663 or &{ $sort{$a->rectype} || sub { 0; } }($a, $b)
665 qsearch('domain_record', { svcnum => $self->svcnum } );
669 sub catchall_svc_acct {
671 if ( $self->catchall ) {
672 qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } );
680 # Returns the Net::Whois::Domain object (see L<Net::Whois>) for this domain, or
681 # undef if the domain is not found in whois.
683 (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)
688 #$whois_hack or new Net::Whois::Domain $_[0]->domain;
689 #$whois_hack or die "whois_hack not set...\n";
696 Delete doesn't send a registration template.
698 All registries should be supported.
700 Should change action to a real field.
702 The $recref stuff in sub check should be cleaned up.
706 L<FS::svc_Common>, L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>,
707 L<FS::part_svc>, L<FS::cust_pkg>, L<Net::Whois>, schema.html from the base
708 documentation, config.html from the base documentation.