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