FS/FS/svc_www.pm

   1 package FS::svc_www;
   2
   3 use strict;
   4 use vars qw(@ISA $conf $apacheip);
   5 #use FS::Record qw( qsearch qsearchs );
   6 use FS::Record qw( qsearchs dbh );
   7 use FS::svc_Common;
   8 use FS::cust_svc;
   9 use FS::domain_record;
  10 use FS::svc_acct;
  11 use FS::svc_domain;
  12
  13 @ISA = qw( FS::svc_Common );
  14
  15 #ask FS::UID to run this stuff for us later
  16 $FS::UID::callback{'FS::svc_www'} = sub {
  17   $conf = new FS::Conf;
  18   $apacheip = $conf->config('apacheip');
  19 };
  20
  21 =head1 NAME
  22
  23 FS::svc_www - Object methods for svc_www records
  24
  25 =head1 SYNOPSIS
  26
  27   use FS::svc_www;
  28
  29   $record = new FS::svc_www \%hash;
  30   $record = new FS::svc_www { 'column' => 'value' };
  31
  32   $error = $record->insert;
  33
  34   $error = $new_record->replace($old_record);
  35
  36   $error = $record->delete;
  37
  38   $error = $record->check;
  39
  40   $error = $record->suspend;
  41
  42   $error = $record->unsuspend;
  43
  44   $error = $record->cancel;
  45
  46 =head1 DESCRIPTION
  47
  48 An FS::svc_www object represents an web virtual host.  FS::svc_www inherits
  49 from FS::svc_Common.  The following fields are currently supported:
  50
  51 =over 4
  52
  53 =item svcnum - primary key
  54
  55 =item recnum - DNS `A' record corresponding to this web virtual host. (see L<FS::domain_record>)
  56
  57 =item usersvc - account (see L<FS::svc_acct>) corresponding to this web virtual host.
  58
  59 =back
  60
  61 =head1 METHODS
  62
  63 =over 4
  64
  65 =item new HASHREF
  66
  67 Creates a new web virtual host.  To add the record to the database, see
  68 L<"insert">.
  69
  70 Note that this stores the hash reference, not a distinct copy of the hash it
  71 points to.  You can ask the object for a copy with the I<hash> method.
  72
  73 =cut
  74
  75 sub table_info {
  76   {
  77     'name' => 'Hosting',
  78     'name_plural' => 'Virtual hosting services',
  79     'display_weight' => 40,
  80     'cancel_weight'  => 20,
  81     'fields' => {
  82     },
  83   };
  84 };
  85
  86 sub table { 'svc_www'; }
  87
  88 =item label [ END_TIMESTAMP [ START_TIMESTAMP ] ]
  89
  90 Returns the zone name for this virtual host.
  91
  92 END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with
  93 history records.
  94
  95 =cut
  96
  97 sub label {
  98   my $self = shift;
  99   $self->domain_record(@_)->zone;
 100 }
 101
 102 =item insert [ , OPTION => VALUE ... ]
 103
 104 Adds this record to the database.  If there is an error, returns the error,
 105 otherwise returns false.
 106
 107 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
 108 defined.  An FS::cust_svc record will be created and inserted.
 109
 110 Currently available options are: I<depend_jobnum>
 111
 112 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
 113 jobnums), all provisioning jobs will have a dependancy on the supplied
 114 jobnum(s) (they will not run until the specific job(s) complete(s)).
 115
 116 =cut
 117
 118 sub preinsert_hook {
 119   my $self = shift;
 120
 121   #return '' unless $self->recnum =~ /^([\w\-]+|\@)\.(([\w\.\-]+\.)+\w+)$/;
 122   return '' unless $self->recnum =~ /^([\w\-]+|\@)\.(\d+)$/;
 123
 124   my( $reczone, $domain_svcnum ) = ( $1, $2 );
 125   unless ( $apacheip ) {
 126     return "Configuration option apacheip not set; can't autocreate A record";
 127            #"for $reczone". $svc_domain->domain;
 128   }
 129   my $domain_record = new FS::domain_record {
 130     'svcnum'  => $domain_svcnum,
 131     'reczone' => $reczone,
 132     'recaf'   => 'IN',
 133     'rectype' => 'A',
 134     'recdata' => $apacheip,
 135   };
 136   my $error = $domain_record->insert;
 137   return $error if $error;
 138
 139   $self->recnum($domain_record->recnum);
 140   return '';
 141 }
 142
 143 =item delete
 144
 145 Delete this record from the database.
 146
 147 =cut
 148
 149 sub delete {
 150   my $self = shift;
 151   my $error;
 152
 153   $error = $self->SUPER::delete(@_);
 154   return $error if $error;
 155
 156   '';
 157 }
 158
 159 =item replace OLD_RECORD
 160
 161 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 162 returns the error, otherwise returns false.
 163
 164 =cut
 165
 166 sub replace {
 167   my ( $new, $old ) = ( shift, shift );
 168   my $error;
 169
 170   $error = $new->SUPER::replace($old, @_);
 171   return $error if $error;
 172
 173   '';
 174 }
 175
 176 =item suspend
 177
 178 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 179
 180 =item unsuspend
 181
 182 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 183
 184 =item cancel
 185
 186 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
 187
 188 =item check
 189
 190 Checks all fields to make sure this is a valid web virtual host.  If there is
 191 an error, returns the error, otherwise returns false.  Called by the insert
 192 and replace methods.
 193
 194 =cut
 195
 196 sub check {
 197   my $self = shift;
 198
 199   my $x = $self->setfixed;
 200   return $x unless ref($x);
 201   #my $part_svc = $x;
 202
 203   my $error =
 204     $self->ut_numbern('svcnum')
 205 #    || $self->ut_number('recnum')
 206     || $self->ut_numbern('usersvc')
 207     || $self->ut_anything('config')
 208   ;
 209   return $error if $error;
 210
 211   if ( $self->recnum =~ /^(\d+)$/ ) {
 212
 213     $self->recnum($1);
 214     return "Unknown recnum: ". $self->recnum
 215       unless qsearchs('domain_record', { 'recnum' => $self->recnum } );
 216
 217   } elsif ( $self->recnum =~ /^([\w\-]+|\@)\.(([\w\.\-]+\.)+\w+)$/ ) {
 218
 219     my( $reczone, $domain ) = ( $1, $2 );
 220
 221     my $svc_domain = qsearchs( 'svc_domain', { 'domain' => $domain } )
 222       or return "unknown domain $domain (recnum $1.$2)";
 223
 224     my $domain_record = qsearchs( 'domain_record', {
 225       'reczone' => $reczone,
 226       'svcnum' => $svc_domain->svcnum,
 227     });
 228
 229     if ( $domain_record ) {
 230       $self->recnum($domain_record->recnum);
 231     } else {
 232       #insert will create it
 233       #$self->recnum("$reczone.$domain");
 234       $self->recnum("$reczone.". $svc_domain->svcnum);
 235     }
 236
 237   } else {
 238     return "Illegal recnum: ". $self->recnum;
 239   }
 240
 241   if ( $self->usersvc ) {
 242     return "Unknown usersvc0 (svc_acct.svcnum): ". $self->usersvc
 243       unless qsearchs('svc_acct', { 'svcnum' => $self->usersvc } );
 244   }
 245
 246   $self->SUPER::check;
 247
 248 }
 249
 250 =item domain_record
 251
 252 Returns the FS::domain_record record for this web virtual host's zone (see
 253 L<FS::domain_record>).
 254
 255 =cut
 256
 257 sub domain_record {
 258   my $self = shift;
 259   qsearchs('domain_record', { 'recnum' => $self->recnum } );
 260 }
 261
 262 =item svc_acct
 263
 264 Returns the FS::svc_acct record for this web virtual host's owner (see
 265 L<FS::svc_acct>).
 266
 267 =cut
 268
 269 sub svc_acct {
 270   my $self = shift;
 271   qsearchs('svc_acct', { 'svcnum' => $self->usersvc } );
 272 }
 273
 274 =back
 275
 276 =head1 BUGS
 277
 278 =head1 SEE ALSO
 279
 280 L<FS::svc_Common>, L<FS::Record>, L<FS::domain_record>, L<FS::cust_svc>,
 281 L<FS::part_svc>, L<FS::cust_pkg>, schema.html from the base documentation.
 282
 283 =cut
 284
 285 1;
 286