package FS::svc_domain; use strict; use base qw( FS::svc_Parent_Mixin FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin FS::svc_Common ); use vars qw( $whois_hack $conf @defaultrecords $soadefaultttl $soaemail $soaexpire $soamachine $soarefresh $soaretry ); use Carp; use Scalar::Util qw( blessed ); use Date::Format; #use Net::Whois::Raw; use Net::Domain::TLD qw(tld_exists); use FS::Record qw(fields qsearch qsearchs dbh); use FS::Conf; use FS::cust_svc; use FS::svc_acct; use FS::cust_pkg; use FS::cust_main; use FS::domain_record; use FS::queue; #ask FS::UID to run this stuff for us later $FS::UID::callback{'FS::domain'} = sub { $conf = new FS::Conf; @defaultrecords = $conf->config('defaultrecords'); $soadefaultttl = $conf->config('soadefaultttl'); $soaemail = $conf->config('soaemail'); $soaexpire = $conf->config('soaexpire'); $soamachine = $conf->config('soamachine'); $soarefresh = $conf->config('soarefresh'); $soaretry = $conf->config('soaretry'); }; =head1 NAME FS::svc_domain - Object methods for svc_domain records =head1 SYNOPSIS use FS::svc_domain; $record = new FS::svc_domain \%hash; $record = new FS::svc_domain { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; $error = $record->suspend; $error = $record->unsuspend; $error = $record->cancel; =head1 DESCRIPTION An FS::svc_domain object represents a domain. FS::svc_domain inherits from FS::svc_Common. The following fields are currently supported: =over 4 =item svcnum primary key (assigned automatically for new accounts) =item domain =item catchall optional svcnum of an svc_acct record, designating an email catchall account. =item suffix =item parent_svcnum =item quota Storage limit =item registrarnum Registrar (see L) =item registrarkey Registrar key or password for this domain =item setup_date UNIX timestamp =item renewal_interval Number of days before expiration date to start renewal =item expiration_date UNIX timestamp =item max_accounts =item au_eligibility_type AU-specific field for domain registrations =item au_registrant_name AU-specific field for domain registrations =back =head1 METHODS =over 4 =item new HASHREF Creates a new domain. To add the domain to the database, see L<"insert">. =cut sub table_info { { 'name' => 'Domain', 'sorts' => 'domain', 'display_weight' => 20, 'cancel_weight' => 60, 'fields' => { 'domain' => 'Domain', 'parent_svcnum' => { label => 'Parent domain / Communigate administrator domain', type => 'select', select_table => 'svc_domain', select_key => 'svcnum', select_label => 'domain', disable_inventory => 1, disable_select => 1, }, 'au_registrant_name' => { label => 'AU Registrant Name', disable_inventory => 1, disable_select => 1, }, 'au_eligibility_type' => { label => 'AU Eligibility Type', type => 'select', select_list => __PACKAGE__->au_eligibility_type_values, disable_inventory => 1, disable_select => 1, }, 'max_accounts' => { label => 'Maximum number of accounts', 'disable_inventory' => 1, }, 'quota' => { label => 'Quota', #storage limit type => 'text', disable_inventory => 1, }, 'cgp_aliases' => { label => 'Communigate aliases', type => 'text', disable_inventory => 1, disable_select => 1, }, 'cgp_accessmodes' => { label => 'Communigate enabled services', type => 'communigate_pro-accessmodes', disable_inventory => 1, disable_select => 1, }, 'cgp_certificatetype' => { label => 'Communigate PKI services', type => 'select', select_list => __PACKAGE__->cgp_certificatetype_values, disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_accessmodes' => { label => 'Acct. default Communigate enabled services', type => 'communigate_pro-accessmodes', disable_inventory => 1, disable_select => 1, }, 'acct_def_password_selfchange' => { label => 'Acct. default Password modification', type => 'checkbox', disable_inventory => 1, disable_select => 1, }, 'acct_def_password_recover' => { label => 'Acct. default Password recovery', type => 'checkbox', disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_deletemode' => { label => 'Acct. default Communigate message delete method', type => 'select', select_list => [ 'Move To Trash', 'Immediately', 'Mark' ], disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_emptytrash' => { label => 'Acct. default Communigate on logout remove trash', type => 'select', select_list => __PACKAGE__->cgp_emptytrash_values, disable_inventory => 1, disable_select => 1, }, 'acct_def_quota' => { label => 'Acct. default Quota', #Mail storage limit type => 'text', disable_inventory => 1, disable_select => 1, }, 'acct_def_file_quota'=> { label => 'Acct. default File storage limit', type => 'text', disable_inventory => 1, disable_select => 1, }, 'acct_def_file_maxnum'=> { label => 'Acct. default Number of files limit', type => 'text', disable_inventory => 1, disable_select => 1, }, 'acct_def_file_maxsize'=> { label => 'Acct. default File size limit', type => 'text', disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_rulesallowed' => { label => 'Acct. default Allowed mail rules', type => 'select', select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ], disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_rpopallowed' => { label => 'Acct. default RPOP modifications', type => 'checkbox', }, 'acct_def_cgp_mailtoall' => { label => 'Acct. default Accepts mail to "all"', type => 'checkbox', }, 'acct_def_cgp_addmailtrailer' => { label => 'Acct. default Add trailer to sent mail', type => 'checkbox', }, 'acct_def_cgp_archiveafter' => { label => 'Archive messages after', type => 'select', select_hash => [ -2 => 'default(730 days)', 0 => 'Never', 86400 => '24 hours', 172800 => '2 days', 259200 => '3 days', 432000 => '5 days', 604800 => '7 days', 1209600 => '2 weeks', 2592000 => '30 days', 7776000 => '90 days', 15552000 => '180 days', 31536000 => '365 days', 63072000 => '730 days', ], disable_inventory => 1, disable_select => 1, }, 'trailer' => { label => 'Mail trailer', type => 'textarea', disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_language' => { label => 'Acct. default language', type => 'select', select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ], disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_timezone' => { label => 'Acct. default time zone', type => 'select', select_list => __PACKAGE__->cgp_timezone_values, disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_skinname' => { label => 'Acct. default layout', type => 'select', select_list => [ '', '***', 'GoldFleece', 'Skin2' ], disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_prontoskinname' => { label => 'Acct. default Pronto style', type => 'select', select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ], disable_inventory => 1, disable_select => 1, }, 'acct_def_cgp_sendmdnmode' => { label => 'Acct. default send read receipts', type => 'select', select_list => [ '', 'Never', 'Manually', 'Automatically' ], disable_inventory => 1, disable_select => 1, }, }, }; } sub table { 'svc_domain'; } sub search_sql { my($class, $string) = @_; $class->search_sql_field('domain', $string); } =item au_eligibility_type_values =cut sub au_eligibility_type_values { [ '', 'Charity', 'Child Care Centre', 'Citizen/Resident', 'Club', 'Commercial Statutory Body', 'Company', 'Government School', 'Higher Education Institution', 'Incorporated Association', 'Industry Body', 'National Body', 'Non-Government School', 'Non-profit Organisation', 'Other', 'Partnership', 'Pending TM Owner', 'Political Party', 'Pre-school', 'Registered Business', 'Religious/Church Group', 'Research Organisation', 'Sole Trader', 'Trade Union', 'Trademark Owner', 'Training Organisation', ]; } =item label Returns the domain. =cut sub label { my $self = shift; $self->domain; } =item insert [ , OPTION => VALUE ... ] Adds this domain to the database. If there is an error, returns the error, otherwise returns false. The additional fields I and I (see L) should be defined. An FS::cust_svc record will be created and inserted. The additional field I should be set to I for new domains, I for transfers, or I for no action (registered elsewhere). The additional field I can be used to manually set the admin contact email address on this email. Otherwise, the svc_acct records for this package (see L) are searched. If there is exactly one svc_acct record in the same package, it is automatically used. Otherwise an error is returned. If any I configuration file exists, an SOA record is added to the domain_record table (see ). If any records are defined in the I configuration file, appropriate records are added to the domain_record table (see L). Currently available options are: I If I is set (to a scalar jobnum or an array reference of jobnums), all provisioning jobs will have a dependancy on the supplied jobnum(s) (they will not run until the specific job(s) complete(s)). =cut sub insert { my $self = shift; my $error; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; local $SIG{TERM} = 'IGNORE'; local $SIG{TSTP} = 'IGNORE'; local $SIG{PIPE} = 'IGNORE'; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $dbh = dbh; $error = $self->SUPER::insert(@_) || $self->insert_defaultrecords; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; #no error } =item insert_defaultrecords =cut sub insert_defaultrecords { my $self = shift; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; local $SIG{TERM} = 'IGNORE'; local $SIG{TSTP} = 'IGNORE'; local $SIG{PIPE} = 'IGNORE'; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $dbh = dbh; if ( $soamachine ) { my $soa = new FS::domain_record { 'svcnum' => $self->svcnum, 'reczone' => '@', 'recaf' => 'IN', 'rectype' => 'SOA', 'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ". "$soarefresh $soaretry $soaexpire $soadefaultttl )" }; my $error = $soa->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "couldn't insert SOA record: $error"; } foreach my $record ( @defaultrecords ) { my($zone,$af,$type,$data) = split(/\s+/,$record,4); my $domain_record = new FS::domain_record { 'svcnum' => $self->svcnum, 'reczone' => $zone, 'recaf' => $af, 'rectype' => $type, 'recdata' => $data, }; my $error = $domain_record->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "couldn't insert record: $error"; } } } $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; #no error } =item delete Deletes this domain from the database. If there is an error, returns the error, otherwise returns false. The corresponding FS::cust_svc record will be deleted as well. =cut sub delete { my $self = shift; return "Can't delete a domain which has accounts!" if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } ); #return "Can't delete a domain with (domain_record) zone entries!" # if qsearch('domain_record', { 'svcnum' => $self->svcnum } ); local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; local $SIG{TERM} = 'IGNORE'; local $SIG{TSTP} = 'IGNORE'; local $SIG{PIPE} = 'IGNORE'; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $dbh = dbh; foreach my $domain_record ( reverse $self->domain_record ) { my $error = $domain_record->delete; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "can't delete DNS entry: ". join(' ', map $domain_record->$_(), qw( reczone recaf rectype recdata ) ). ":$error"; } } my $error = $self->SUPER::delete(@_); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } $dbh->commit or die $dbh->errstr if $oldAutoCommit; } =item replace OLD_RECORD Replaces OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. =cut sub replace { my $new = shift; my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') ) ? shift : $new->replace_old; return "Can't change domain - reorder." if $old->getfield('domain') ne $new->getfield('domain') && ! $conf->exists('svc_domain-edit_domain'); # Better to do it here than to force the caller to remember that svc_domain is weird. $new->setfield(action => 'I'); my $error = $new->SUPER::replace($old, @_); return $error if $error; } =item suspend Just returns false (no error) for now. Called by the suspend method of FS::cust_pkg (see L). =item unsuspend Just returns false (no error) for now. Called by the unsuspend method of FS::cust_pkg (see L). =item cancel Just returns false (no error) for now. Called by the cancel method of FS::cust_pkg (see L). =item check Checks all fields to make sure this is a valid domain. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. Sets any fixed values; see L. =cut sub check { my $self = shift; my $x = $self->setfixed; return $x unless ref($x); #my $part_svc = $x; my $error = $self->ut_numbern('svcnum') || $self->ut_textn('au_eligibility_type') || $self->ut_textn('au_registrant_name') || $self->ut_numbern('catchall') || $self->ut_numbern('max_accounts') || $self->ut_alphan('quota') || $self->ut_anything('trailer') #well || $self->ut_textn('cgp_aliases') #well || $self->ut_enum('acct_def_password_selfchange', [ '', 'Y' ]) || $self->ut_enum('acct_def_password_recover', [ '', 'Y' ]) || $self->ut_textn('acct_def_cgp_accessmodes') || $self->ut_alphan('acct_def_quota') || $self->ut_alphan('acct_def_file_quota') || $self->ut_alphan('acct_def_maxnum') || $self->ut_alphan('acct_def_maxsize') #settings || $self->ut_alphasn('acct_def_cgp_rulesallowed') || $self->ut_enum('acct_def_cgp_rpopallowed', [ '', 'Y' ]) || $self->ut_enum('acct_def_cgp_mailtoall', [ '', 'Y' ]) || $self->ut_enum('acct_def_cgp_addmailtrailer', [ '', 'Y' ]) || $self->ut_snumbern('acct_def_cgp_archiveafter') #preferences || $self->ut_alphasn('acct_def_cgp_deletemode') || $self->ut_enum('acct_def_cgp_emptytrash', $self->cgp_emptytrash_values ) || $self->ut_alphan('acct_def_cgp_language') || $self->ut_textn('acct_def_cgp_timezone') || $self->ut_textn('acct_def_cgp_skinname') || $self->ut_textn('acct_def_cgp_prontoskinname') || $self->ut_alphan('acct_def_cgp_sendmdnmode') #mail ; return $error if $error; #hmm my $pkgnum; if ( $self->svcnum ) { my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } ); $pkgnum = $cust_svc->pkgnum; } else { $pkgnum = $self->pkgnum; } my($recref) = $self->hashref; #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) { if ( $recref->{domain} =~ /^([\w\-]{1,63})\.(com|net|org|edu|tv|info|biz)$/ ) { $recref->{domain} = "$1.$2"; $recref->{suffix} ||= $2; # hmmmmmmmm. } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.\/]+)\.(\w+)$/ ) { $recref->{domain} = "$1.$2"; # need to match a list of suffixes - no guarantee they're top-level.. # http://wiki.mozilla.org/TLD_List # but this will have to do for now... $recref->{suffix} ||= $2; } else { return "Illegal domain ". $recref->{domain}. " (or unknown registry - try \$whois_hack)"; } $self->suffix =~ /(^|\.)(\w+)$/ or return "can't parse suffix for TLD: ". $self->suffix; my $tld = $2; return "No such TLD: .$tld" unless tld_exists($tld); if ( $recref->{catchall} ne '' ) { my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } ); return "Unknown catchall" unless $svc_acct; } $self->ut_alphan('suffix') or $self->ut_foreign_keyn('registrarnum', 'registrar', 'registrarnum') or $self->ut_textn('registrarkey') or $self->ut_numbern('setup_date') or $self->ut_numbern('renewal_interval') or $self->ut_numbern('expiration_date') or $self->SUPER::check; } sub _check_duplicate { my $self = shift; $self->lock_table; if ( qsearchs( 'svc_domain', { 'domain' => $self->domain } ) ) { return "Domain in use (here)"; } else { return ''; } } =item domain_record =cut sub domain_record { my $self = shift; my %order = ( 'SOA' => 1, 'NS' => 2, 'MX' => 3, 'CNAME' => 4, 'A' => 5, 'TXT' => 6, 'PTR' => 7, 'SRV' => 8, ); my %sort = ( #'SOA' => sub { $_[0]->recdata cmp $_[1]->recdata }, #sure hope not though # 'SOA' => sub { 0; }, # 'NS' => sub { 0; }, 'MX' => sub { my( $a_weight, $a_name ) = split(/\s+/, $_[0]->recdata); my( $b_weight, $b_name ) = split(/\s+/, $_[1]->recdata); $a_weight <=> $b_weight or $a_name cmp $b_name; }, 'CNAME' => sub { $_[0]->reczone cmp $_[1]->reczone }, 'A' => sub { $_[0]->reczone cmp $_[1]->reczone }, # 'TXT' => sub { 0; }, 'PTR' => sub { $_[0]->reczone <=> $_[1]->reczone }, ); map { $_ } #return $self->num_domain_record( PARAMS ) unless wantarray; sort { $order{$a->rectype} <=> $order{$b->rectype} or &{ $sort{$a->rectype} || sub { 0; } }($a, $b) } qsearch('domain_record', { svcnum => $self->svcnum } ); } sub catchall_svc_acct { my $self = shift; if ( $self->catchall ) { qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } ); } else { ''; } } =item whois # Returns the Net::Whois::Domain object (see L) for this domain, or # undef if the domain is not found in whois. (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.) =cut sub whois { #$whois_hack or new Net::Whois::Domain $_[0]->domain; #$whois_hack or die "whois_hack not set...\n"; } =back =head1 BUGS Delete doesn't send a registration template. All registries should be supported. Should change action to a real field. The $recref stuff in sub check should be cleaned up. =head1 SEE ALSO L, L, L, L, L, L, L, schema.html from the base documentation, config.html from the base documentation. =cut 1;