FS/FS/svc_domain.pm

   1 package FS::svc_domain;
   2
   3 use strict;
   4 use base qw( FS::svc_Parent_Mixin FS::svc_CGP_Mixin FS::svc_CGPRule_Mixin
   5              FS::svc_Common );
   6 use vars qw( $whois_hack $conf
   7   @defaultrecords $soadefaultttl $soaemail $soaexpire $soamachine
   8   $soarefresh $soaretry
   9 );
  10 use Carp;
  11 use Scalar::Util qw( blessed );
  12 use Date::Format;
  13 #use Net::Whois::Raw;
  14 use Net::Domain::TLD qw(tld_exists);
  15 use FS::Record qw(fields qsearch qsearchs dbh);
  16 use FS::Conf;
  17 use FS::cust_svc;
  18 use FS::svc_acct;
  19 use FS::cust_pkg;
  20 use FS::cust_main;
  21 use FS::domain_record;
  22 use FS::queue;
  23
  24 #ask FS::UID to run this stuff for us later
  25 $FS::UID::callback{'FS::domain'} = sub {
  26   $conf = new FS::Conf;
  27
  28   @defaultrecords = $conf->config('defaultrecords');
  29   $soadefaultttl = $conf->config('soadefaultttl');
  30   $soaemail      = $conf->config('soaemail');
  31   $soaexpire     = $conf->config('soaexpire');
  32   $soamachine    = $conf->config('soamachine');
  33   $soarefresh    = $conf->config('soarefresh');
  34   $soaretry      = $conf->config('soaretry');
  35
  36 };
  37
  38 =head1 NAME
  39
  40 FS::svc_domain - Object methods for svc_domain records
  41
  42 =head1 SYNOPSIS
  43
  44   use FS::svc_domain;
  45
  46   $record = new FS::svc_domain \%hash;
  47   $record = new FS::svc_domain { 'column' => 'value' };
  48
  49   $error = $record->insert;
  50
  51   $error = $new_record->replace($old_record);
  52
  53   $error = $record->delete;
  54
  55   $error = $record->check;
  56
  57   $error = $record->suspend;
  58
  59   $error = $record->unsuspend;
  60
  61   $error = $record->cancel;
  62
  63 =head1 DESCRIPTION
  64
  65 An FS::svc_domain object represents a domain.  FS::svc_domain inherits from
  66 FS::svc_Common.  The following fields are currently supported:
  67
  68 =over 4
  69
  70 =item svcnum - primary key (assigned automatically for new accounts)
  71
  72 =item domain
  73
  74 =item catchall - optional svcnum of an svc_acct record, designating an email catchall account.
  75
  76 =item suffix -
  77
  78 =item parent_svcnum -
  79
  80 =item registrarnum - Registrar (see L<FS::registrar>)
  81
  82 =item registrarkey - Registrar key or password for this domain
  83
  84 =item setup_date - UNIX timestamp
  85
  86 =item renewal_interval - Number of days before expiration date to start renewal
  87
  88 =item expiration_date - UNIX timestamp
  89
  90 =item max_accounts
  91
  92 =back
  93
  94 =head1 METHODS
  95
  96 =over 4
  97
  98 =item new HASHREF
  99
 100 Creates a new domain.  To add the domain to the database, see L<"insert">.
 101
 102 =cut
 103
 104 sub table_info {
 105   {
 106     'name' => 'Domain',
 107     'sorts' => 'domain',
 108     'display_weight' => 20,
 109     'cancel_weight'  => 60,
 110     'fields' => {
 111       'domain' => 'Domain',
 112       'parent_svcnum' => {
 113                          label => 'Parent domain / Communigate administrator domain',
 114                          type  => 'select',
 115                          select_table => 'svc_domain',
 116                          select_key => 'svcnum',
 117                          select_label => 'domain',
 118                          disable_inventory => 1,
 119                          disable_select    => 1,
 120                        },
 121       'max_accounts' => { label => 'Maximum number of accounts',
 122                           'disable_inventory' => 1,
 123                         },
 124       'cgp_aliases' => {
 125                          label => 'Communigate aliases',
 126                          type  => 'text',
 127                          disable_inventory => 1,
 128                          disable_select    => 1,
 129                        },
 130       'cgp_accessmodes' => {
 131                              label => 'Communigate enabled services',
 132                              type  => 'communigate_pro-accessmodes',
 133                              disable_inventory => 1,
 134                              disable_select    => 1,
 135                            },
 136
 137       'acct_def_cgp_accessmodes' => {
 138                              label => 'Acct. default Communigate enabled services',
 139                              type  => 'communigate_pro-accessmodes',
 140                              disable_inventory => 1,
 141                              disable_select    => 1,
 142                            },
 143       'acct_def_password_selfchange' => { label => 'Acct. default Password modification',
 144                                  type  => 'checkbox',
 145                             disable_inventory => 1,
 146                             disable_select    => 1,
 147                                },
 148       'acct_def_password_recover'    => { label => 'Acct. default Password recovery',
 149                                  type  => 'checkbox',
 150                             disable_inventory => 1,
 151                             disable_select    => 1,
 152                                },
 153       'acct_def_cgp_deletemode' => {
 154                             label => 'Acct. default Communigate message delete method',
 155                             type  => 'select',
 156                             select_list => [ 'Move To Trash', 'Immediately', 'Mark' ],
 157                             disable_inventory => 1,
 158                             disable_select    => 1,
 159                           },
 160       'acct_def_cgp_emptytrash' => {
 161                             label => 'Acct. default Communigate on logout remove trash',
 162                             type        => 'select',
 163                             select_list => __PACKAGE__->cgp_emptytrash_values,
 164                             disable_inventory => 1,
 165                             disable_select    => 1,
 166                           },
 167       'acct_def_quota'     => {
 168                        label => 'Acct. default Quota', #Mail storage limit
 169                        type => 'text',
 170                        disable_inventory => 1,
 171                        disable_select => 1,
 172                      },
 173       'acct_def_file_quota'=> {
 174                        label => 'Acct. default File storage limit',
 175                        type => 'text',
 176                        disable_inventory => 1,
 177                        disable_select => 1,
 178                      },
 179       'acct_def_file_maxnum'=> {
 180                        label => 'Acct. default Number of files limit',
 181                        type => 'text',
 182                        disable_inventory => 1,
 183                        disable_select => 1,
 184                      },
 185       'acct_def_file_maxsize'=> {
 186                        label => 'Acct. default File size limit',
 187                        type => 'text',
 188                        disable_inventory => 1,
 189                        disable_select => 1,
 190                      },
 191       'acct_def_cgp_rulesallowed'   => {
 192         label       => 'Acct. default Allowed mail rules',
 193         type        => 'select',
 194         select_list => [ '', 'No', 'Filter Only', 'All But Exec', 'Any' ],
 195         disable_inventory => 1,
 196         disable_select    => 1,
 197       },
 198       'acct_def_cgp_rpopallowed'    => {
 199         label => 'Acct. default RPOP modifications',
 200         type  => 'checkbox',
 201       },
 202       'acct_def_cgp_mailtoall'      => {
 203         label => 'Acct. default Accepts mail to "all"',
 204         type  => 'checkbox',
 205       },
 206       'acct_def_cgp_addmailtrailer' => {
 207         label => 'Acct. default Add trailer to sent mail',
 208         type  => 'checkbox',
 209       },
 210       'acct_def_cgp_archiveafter'   => {
 211         label       => 'Archive messages after',
 212         type        => 'select',
 213         select_hash => [
 214                          -2 => 'default(730 days)',
 215                          0 => 'Never',
 216                          86400 => '24 hours',
 217                          172800 => '2 days',
 218                          259200 => '3 days',
 219                          432000 => '5 days',
 220                          604800 => '7 days',
 221                          1209600 => '2 weeks',
 222                          2592000 => '30 days',
 223                          7776000 => '90 days',
 224                          15552000 => '180 days',
 225                          31536000 => '365 days',
 226                          63072000 => '730 days',
 227                        ],
 228         disable_inventory => 1,
 229         disable_select    => 1,
 230       },
 231       'trailer' => {
 232         label => 'Mail trailer',
 233         type  => 'textarea',
 234         disable_inventory => 1,
 235         disable_select    => 1,
 236       },
 237       'acct_def_cgp_language' => {
 238                             label => 'Acct. default language',
 239                             type  => 'select',
 240                             select_list => [ '', qw( English Arabic Chinese Dutch French German Hebrew Italian Japanese Portuguese Russian Slovak Spanish Thai ) ],
 241                             disable_inventory => 1,
 242                             disable_select    => 1,
 243                         },
 244       'acct_def_cgp_timezone' => {
 245                             label       => 'Acct. default time zone',
 246                             type        => 'select',
 247                             select_list => __PACKAGE__->cgp_timezone_values,
 248                             disable_inventory => 1,
 249                             disable_select    => 1,
 250                         },
 251       'acct_def_cgp_skinname' => {
 252                             label => 'Acct. default layout',
 253                             type  => 'select',
 254                             select_list => [ '', '***', 'GoldFleece', 'Skin2' ],
 255                             disable_inventory => 1,
 256                             disable_select    => 1,
 257                         },
 258       'acct_def_cgp_prontoskinname' => {
 259                             label => 'Acct. default Pronto style',
 260                             type  => 'select',
 261                             select_list => [ '', 'Pronto', 'Pronto-darkflame', 'Pronto-steel', 'Pronto-twilight', ],
 262                             disable_inventory => 1,
 263                             disable_select    => 1,
 264                         },
 265       'acct_def_cgp_sendmdnmode' => {
 266         label => 'Acct. default send read receipts',
 267         type  => 'select',
 268         select_list => [ '', 'Never', 'Manually', 'Automatically' ],
 269         disable_inventory => 1,
 270         disable_select    => 1,
 271       },
 272     },
 273   };
 274 }
 275
 276 sub table { 'svc_domain'; }
 277
 278 sub search_sql {
 279   my($class, $string) = @_;
 280   $class->search_sql_field('domain', $string);
 281 }
 282
 283
 284 =item label
 285
 286 Returns the domain.
 287
 288 =cut
 289
 290 sub label {
 291   my $self = shift;
 292   $self->domain;
 293 }
 294
 295 =item insert [ , OPTION => VALUE ... ]
 296
 297 Adds this domain to the database.  If there is an error, returns the error,
 298 otherwise returns false.
 299
 300 The additional fields I<pkgnum> and I<svcpart> (see L<FS::cust_svc>) should be
 301 defined.  An FS::cust_svc record will be created and inserted.
 302
 303 The additional field I<action> should be set to I<N> for new domains, I<M>
 304 for transfers, or I<I> for no action (registered elsewhere).
 305
 306 A registration or transfer email will be submitted unless
 307 $FS::svc_domain::whois_hack is true.
 308
 309 The additional field I<email> can be used to manually set the admin contact
 310 email address on this email.  Otherwise, the svc_acct records for this package
 311 (see L<FS::cust_pkg>) are searched.  If there is exactly one svc_acct record
 312 in the same package, it is automatically used.  Otherwise an error is returned.
 313
 314 If any I<soamachine> configuration file exists, an SOA record is added to
 315 the domain_record table (see <FS::domain_record>).
 316
 317 If any records are defined in the I<defaultrecords> configuration file,
 318 appropriate records are added to the domain_record table (see
 319 L<FS::domain_record>).
 320
 321 Currently available options are: I<depend_jobnum>
 322
 323 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
 324 jobnums), all provisioning jobs will have a dependancy on the supplied
 325 jobnum(s) (they will not run until the specific job(s) complete(s)).
 326
 327 =cut
 328
 329 sub insert {
 330   my $self = shift;
 331   my $error;
 332
 333   local $SIG{HUP} = 'IGNORE';
 334   local $SIG{INT} = 'IGNORE';
 335   local $SIG{QUIT} = 'IGNORE';
 336   local $SIG{TERM} = 'IGNORE';
 337   local $SIG{TSTP} = 'IGNORE';
 338   local $SIG{PIPE} = 'IGNORE';
 339
 340   my $oldAutoCommit = $FS::UID::AutoCommit;
 341   local $FS::UID::AutoCommit = 0;
 342   my $dbh = dbh;
 343
 344   $error = $self->SUPER::insert(@_);
 345   if ( $error ) {
 346     $dbh->rollback if $oldAutoCommit;
 347     return $error;
 348   }
 349
 350   if ( $soamachine ) {
 351     my $soa = new FS::domain_record {
 352       'svcnum'  => $self->svcnum,
 353       'reczone' => '@',
 354       'recaf'   => 'IN',
 355       'rectype' => 'SOA',
 356       'recdata' => "$soamachine $soaemail ( ". time2str("%Y%m%d", time). "00 ".
 357                    "$soarefresh $soaretry $soaexpire $soadefaultttl )"
 358     };
 359     $error = $soa->insert;
 360     if ( $error ) {
 361       $dbh->rollback if $oldAutoCommit;
 362       return "couldn't insert SOA record for new domain: $error";
 363     }
 364
 365     foreach my $record ( @defaultrecords ) {
 366       my($zone,$af,$type,$data) = split(/\s+/,$record,4);
 367       my $domain_record = new FS::domain_record {
 368         'svcnum'  => $self->svcnum,
 369         'reczone' => $zone,
 370         'recaf'   => $af,
 371         'rectype' => $type,
 372         'recdata' => $data,
 373       };
 374       my $error = $domain_record->insert;
 375       if ( $error ) {
 376         $dbh->rollback if $oldAutoCommit;
 377         return "couldn't insert record for new domain: $error";
 378       }
 379     }
 380
 381   }
 382
 383   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 384
 385   ''; #no error
 386 }
 387
 388 =item delete
 389
 390 Deletes this domain from the database.  If there is an error, returns the
 391 error, otherwise returns false.
 392
 393 The corresponding FS::cust_svc record will be deleted as well.
 394
 395 =cut
 396
 397 sub delete {
 398   my $self = shift;
 399
 400   return "Can't delete a domain which has accounts!"
 401     if qsearch( 'svc_acct', { 'domsvc' => $self->svcnum } );
 402
 403   #return "Can't delete a domain with (domain_record) zone entries!"
 404   #  if qsearch('domain_record', { 'svcnum' => $self->svcnum } );
 405
 406   local $SIG{HUP} = 'IGNORE';
 407   local $SIG{INT} = 'IGNORE';
 408   local $SIG{QUIT} = 'IGNORE';
 409   local $SIG{TERM} = 'IGNORE';
 410   local $SIG{TSTP} = 'IGNORE';
 411   local $SIG{PIPE} = 'IGNORE';
 412
 413   my $oldAutoCommit = $FS::UID::AutoCommit;
 414   local $FS::UID::AutoCommit = 0;
 415   my $dbh = dbh;
 416
 417   foreach my $domain_record ( reverse $self->domain_record ) {
 418     my $error = $domain_record->delete;
 419     if ( $error ) {
 420       $dbh->rollback if $oldAutoCommit;
 421       return "can't delete DNS entry: ".
 422              join(' ', map $domain_record->$_(),
 423                            qw( reczone recaf rectype recdata )
 424                  ).
 425              ":$error";
 426     }
 427   }
 428
 429   my $error = $self->SUPER::delete(@_);
 430   if ( $error ) {
 431     $dbh->rollback if $oldAutoCommit;
 432     return $error;
 433   }
 434
 435   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 436 }
 437
 438 =item replace OLD_RECORD
 439
 440 Replaces OLD_RECORD with this one in the database.  If there is an error,
 441 returns the error, otherwise returns false.
 442
 443 =cut
 444
 445 sub replace {
 446   my $new = shift;
 447
 448   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
 449               ? shift
 450               : $new->replace_old;
 451
 452   return "Can't change domain - reorder."
 453     if $old->getfield('domain') ne $new->getfield('domain')
 454     && ! $conf->exists('svc_domain-edit_domain');
 455
 456   # Better to do it here than to force the caller to remember that svc_domain is weird.
 457   $new->setfield(action => 'I');
 458   my $error = $new->SUPER::replace($old, @_);
 459   return $error if $error;
 460 }
 461
 462 =item suspend
 463
 464 Just returns false (no error) for now.
 465
 466 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 467
 468 =item unsuspend
 469
 470 Just returns false (no error) for now.
 471
 472 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 473
 474 =item cancel
 475
 476 Just returns false (no error) for now.
 477
 478 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
 479
 480 =item check
 481
 482 Checks all fields to make sure this is a valid domain.  If there is an error,
 483 returns the error, otherwise returns false.  Called by the insert and replace
 484 methods.
 485
 486 Sets any fixed values; see L<FS::part_svc>.
 487
 488 =cut
 489
 490 sub check {
 491   my $self = shift;
 492
 493   my $x = $self->setfixed;
 494   return $x unless ref($x);
 495   #my $part_svc = $x;
 496
 497   my $error = $self->ut_numbern('svcnum')
 498               || $self->ut_numbern('catchall')
 499               || $self->ut_numbern('max_accounts')
 500               || $self->ut_anything('trailer') #well
 501               || $self->ut_textn('cgp_aliases') #well
 502               || $self->ut_enum('acct_def_password_selfchange', [ '', 'Y' ])
 503               || $self->ut_enum('acct_def_password_recover',    [ '', 'Y' ])
 504               || $self->ut_textn('acct_def_cgp_accessmodes')
 505               || $self->ut_alphan('acct_def_quota')
 506               || $self->ut_alphan('acct_def_file_quota')
 507               || $self->ut_alphan('acct_def_maxnum')
 508               || $self->ut_alphan('acct_def_maxsize')
 509               #settings
 510               || $self->ut_alphasn('acct_def_cgp_rulesallowed')
 511               || $self->ut_enum('acct_def_cgp_rpopallowed', [ '', 'Y' ])
 512               || $self->ut_enum('acct_def_cgp_mailtoall', [ '', 'Y' ])
 513               || $self->ut_enum('acct_def_cgp_addmailtrailer', [ '', 'Y' ])
 514               || $self->ut_snumbern('acct_def_cgp_archiveafter')
 515               #preferences
 516               || $self->ut_alphasn('acct_def_cgp_deletemode')
 517               || $self->ut_enum('acct_def_cgp_emptytrash',
 518                                    $self->cgp_emptytrash_values )
 519               || $self->ut_alphan('acct_def_cgp_language')
 520               || $self->ut_textn('acct_def_cgp_timezone')
 521               || $self->ut_textn('acct_def_cgp_skinname')
 522               || $self->ut_textn('acct_def_cgp_prontoskinname')
 523               || $self->ut_alphan('acct_def_cgp_sendmdnmode')
 524               #mail
 525   ;
 526   return $error if $error;
 527
 528   #hmm
 529   my $pkgnum;
 530   if ( $self->svcnum ) {
 531     my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
 532     $pkgnum = $cust_svc->pkgnum;
 533   } else {
 534     $pkgnum = $self->pkgnum;
 535   }
 536
 537   my($recref) = $self->hashref;
 538
 539   #if ( $recref->{domain} =~ /^([\w\-\.]{1,22})\.(com|net|org|edu)$/ ) {
 540   if ( $recref->{domain} =~ /^([\w\-]{1,63})\.(com|net|org|edu|tv|info|biz)$/ ) {
 541     $recref->{domain} = "$1.$2";
 542     $recref->{suffix} ||= $2;
 543   # hmmmmmmmm.
 544   } elsif ( $whois_hack && $recref->{domain} =~ /^([\w\-\.]+)\.(\w+)$/ ) {
 545     $recref->{domain} = "$1.$2";
 546     # need to match a list of suffixes - no guarantee they're top-level..
 547     # http://wiki.mozilla.org/TLD_List
 548     # but this will have to do for now...
 549     $recref->{suffix} ||= $2;
 550   } else {
 551     return "Illegal domain ". $recref->{domain}.
 552            " (or unknown registry - try \$whois_hack)";
 553   }
 554
 555   $self->suffix =~ /(^|\.)(\w+)$/
 556     or return "can't parse suffix for TLD: ". $self->suffix;
 557   my $tld = $2;
 558   return "No such TLD: .$tld" unless tld_exists($tld);
 559
 560   if ( $recref->{catchall} ne '' ) {
 561     my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $recref->{catchall} } );
 562     return "Unknown catchall" unless $svc_acct;
 563   }
 564
 565   $self->ut_alphan('suffix')
 566     or $self->ut_foreign_keyn('registrarnum', 'registrar', 'registrarnum')
 567     or $self->ut_textn('registrarkey')
 568     or $self->ut_numbern('setup_date')
 569     or $self->ut_numbern('renewal_interval')
 570     or $self->ut_numbern('expiration_date')
 571     or $self->SUPER::check;
 572
 573 }
 574
 575 sub _check_duplicate {
 576   my $self = shift;
 577
 578   $self->lock_table;
 579
 580   if ( qsearchs( 'svc_domain', { 'domain' => $self->domain } ) ) {
 581     return "Domain in use (here)";
 582   } else {
 583     return '';
 584   }
 585 }
 586
 587 =item domain_record
 588
 589 =cut
 590
 591 sub domain_record {
 592   my $self = shift;
 593
 594   my %order = (
 595     'SOA'   => 1,
 596     'NS'    => 2,
 597     'MX'    => 3,
 598     'CNAME' => 4,
 599     'A'     => 5,
 600     'TXT'   => 6,
 601     'PTR'   => 7,
 602   );
 603
 604   my %sort = (
 605     #'SOA'   => sub { $_[0]->recdata cmp $_[1]->recdata }, #sure hope not though
 606 #    'SOA'   => sub { 0; },
 607 #    'NS'    => sub { 0; },
 608     'MX'    => sub { my( $a_weight, $a_name ) = split(/\s+/, $_[0]->recdata);
 609                      my( $b_weight, $b_name ) = split(/\s+/, $_[1]->recdata);
 610                      $a_weight <=> $b_weight or $a_name cmp $b_name;
 611                    },
 612     'CNAME' => sub { $_[0]->reczone cmp $_[1]->reczone },
 613     'A'     => sub { $_[0]->reczone cmp $_[1]->reczone },
 614
 615 #    'TXT'   => sub { 0; },
 616     'PTR'   => sub { $_[0]->reczone <=> $_[1]->reczone },
 617   );
 618
 619   map { $_ } #return $self->num_domain_record( PARAMS ) unless wantarray;
 620   sort {    $order{$a->rectype} <=> $order{$b->rectype}
 621          or &{ $sort{$a->rectype} || sub { 0; } }($a, $b)
 622        }
 623        qsearch('domain_record', { svcnum => $self->svcnum } );
 624
 625 }
 626
 627 sub catchall_svc_acct {
 628   my $self = shift;
 629   if ( $self->catchall ) {
 630     qsearchs( 'svc_acct', { 'svcnum' => $self->catchall } );
 631   } else {
 632     '';
 633   }
 634 }
 635
 636 =item whois
 637
 638 # Returns the Net::Whois::Domain object (see L<Net::Whois>) for this domain, or
 639 # undef if the domain is not found in whois.
 640
 641 (If $FS::svc_domain::whois_hack is true, returns that in all cases instead.)
 642
 643 =cut
 644
 645 sub whois {
 646   #$whois_hack or new Net::Whois::Domain $_[0]->domain;
 647   #$whois_hack or die "whois_hack not set...\n";
 648 }
 649
 650 =back
 651
 652 =head1 BUGS
 653
 654 Delete doesn't send a registration template.
 655
 656 All registries should be supported.
 657
 658 Should change action to a real field.
 659
 660 The $recref stuff in sub check should be cleaned up.
 661
 662 =head1 SEE ALSO
 663
 664 L<FS::svc_Common>, L<FS::Record>, L<FS::Conf>, L<FS::cust_svc>,
 665 L<FS::part_svc>, L<FS::cust_pkg>, L<Net::Whois>, schema.html from the base
 666 documentation, config.html from the base documentation.
 667
 668 =cut
 669
 670 1;
 671
 672