FS/FS/svc_dsl.pm

   1 package FS::svc_dsl;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $DEBUG $me );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::svc_Common;
   7 use FS::dsl_device;
   8 use FS::dsl_note;
   9 use FS::qual;
  10
  11 @ISA = qw( FS::svc_Common );
  12 $DEBUG = 0;
  13 $me = '[FS::svc_dsl]';
  14
  15 FS::UID->install_callback( sub {
  16   $conf = new FS::Conf;
  17 }
  18 );
  19
  20 =head1 NAME
  21
  22 FS::svc_dsl - Object methods for svc_dsl records
  23
  24 =head1 SYNOPSIS
  25
  26   use FS::svc_dsl;
  27
  28   $record = new FS::svc_dsl \%hash;
  29   $record = new FS::svc_dsl { 'column' => 'value' };
  30
  31   $error = $record->insert;
  32
  33   $error = $new_record->replace($old_record);
  34
  35   $error = $record->delete;
  36
  37   $error = $record->check;
  38
  39   $error = $record->suspend;
  40
  41   $error = $record->unsuspend;
  42
  43   $error = $record->cancel;
  44
  45 =head1 DESCRIPTION
  46
  47 An FS::svc_dsl object represents a DSL service.  FS::svc_dsl inherits from
  48 FS::svc_Common.  The following fields are currently supported:
  49
  50 =over 4
  51
  52 =item svcnum - Primary key (assigned automatcially for new DSL))
  53
  54 =item pushed - Time DSL order pushed to vendor/telco, if applicable
  55
  56 =item desired_due_date - Desired Due Date
  57
  58 =item due_date - Due Date
  59
  60 =item vendor_order_id - Vendor/telco DSL order #
  61
  62 =item vendor_order_type
  63
  64 Vendor/telco DSL order type (e.g. (M)ove, (A)dd, (C)hange, (D)elete, or similar)
  65
  66 =item vendor_order_status
  67
  68 Vendor/telco DSL order status (e.g. (N)ew, (A)ssigned, (R)ejected, (M)revised,
  69 (C)ompleted, (X)cancelled, or similar)
  70
  71 =item first - End-user first name
  72
  73 =item last - End-user last name
  74
  75 =item company - End-user company name
  76
  77 =item phonenum - DSL Telephone Number
  78
  79 =item loop_type - Loop-type - vendor/telco-specific
  80
  81 =item local_voice_provider - Local Voice Provider's name
  82
  83 =item circuitnum - Circuit #
  84
  85 =item vpi
  86
  87 =item vci
  88
  89 =item rate_band - Rate Band
  90
  91 =item isp_chg
  92
  93 =item isp_prev
  94
  95 =item staticips
  96
  97 =item vendor_qual_id
  98
  99 Ikano-specific fields, do not use otherwise
 100
 101 =item username - if outsourced PPPoE/RADIUS, username
 102
 103 =item password - if outsourced PPPoE/RADIUS, password
 104
 105 =item monitored - Order is monitored (auto-pull/sync), either Y or blank
 106
 107 =item last_pull - time of last data pull from vendor/telco
 108
 109
 110 =back
 111
 112 =head1 METHODS
 113
 114 =over 4
 115
 116 =item new HASHREF
 117
 118 Creates a new DSL.  To add the DSL to the database, see L<"insert">.
 119
 120 Note that this stores the hash reference, not a distinct copy of the hash it
 121 points to.  You can ask the object for a copy with the I<hash> method.
 122
 123 =cut
 124
 125 # the new method can be inherited from FS::Record, if a table method is defined
 126
 127 sub table_info {
 128     my %dis1 = ( disable_default=>1, disable_fixed=>1, disable_inventory=>1, disable_select=>1 );
 129     my %dis2 = ( disable_inventory=>1, disable_select=>1 );
 130
 131     {
 132         'name' => 'DSL',
 133         'name_plural' => 'DSLs',
 134         'lcname_plural' => 'DSLs',
 135         'sorts' => [ 'phonenum' ],
 136         'display_weight' => 55,
 137         'cancel_weight' => 75,
 138         'fields' => {
 139             'pushed' => {       label => 'Pushed',
 140                                 type => 'disabled' },
 141             'desired_due_date' => {     label => 'Desired Due Date', %dis2, },
 142             'due_date' => {             label => 'Due Date', %dis2, },
 143             'vendor_order_id' => { label => 'Vendor Order ID', %dis2, },
 144             'vendor_qual_id' => { label => 'Vendor Qualification ID',
 145                                 type => 'disabled' },
 146             'vendor_order_type' => { label => 'Vendor Order Type',
 147                                     disable_inventory => 1,
 148                                 },
 149             'vendor_order_status' => { label => 'Vendor Order Status',
 150                                     disable_inventory => 1,
 151                                     },
 152             'first' => {        label => 'First Name', %dis2, },
 153             'last' => {         label => 'Last Name', %dis2, },
 154             'company' => {      label => 'Company Name', %dis2, },
 155             'phonenum' => {     label => 'Service Telephone Number', },
 156             'loop_type' => {    label => 'Loop Type',
 157                                     disable_inventory => 1,
 158                         },
 159             'local_voice_provider' => {         label => 'Local Voice Provider',
 160                                     disable_inventory => 1,
 161                         },
 162             'circuitnum' => {   label => 'Circuit #',   },
 163             'rate_band' => {    label => 'Rate Band',
 164                                     disable_inventory => 1,
 165                         },
 166             'vpi' => { label => 'VPI', disable_inventory => 1 },
 167             'vci' => { label => 'VCI', disable_inventory => 1 },
 168             'isp_chg' => {      label => 'ISP Changing?',
 169                                 type => 'checkbox', %dis2 },
 170             'isp_prev' => {     label => 'Current or Previous ISP',
 171                                     disable_inventory => 1,
 172                         },
 173             'username' => {     label => 'PPPoE Username',
 174                                 type => 'text',
 175                         },
 176             'password' => {     label => 'PPPoE Password', %dis2 },
 177             'staticips' => {    label => 'Static IPs', %dis1 },
 178             'monitored' => {    label => 'Monitored',
 179                                 type => 'checkbox', %dis2 },
 180             'last_pull' => {    label => 'Last Pull', type => 'disabled' },
 181         },
 182     };
 183 }
 184
 185 sub table { 'svc_dsl'; }
 186
 187 sub label {
 188    my $self = shift;
 189    return $self->phonenum if $self->phonenum;
 190    return $self->username if $self->username;
 191    return $self->vendor_order_id if $self->vendor_order_id;
 192    return $self->svcnum;
 193 }
 194
 195 =item notes
 196
 197 Returns the set of FS::dsl_notes associated with this service
 198
 199 =cut
 200 sub notes {
 201   my $self = shift;
 202   qsearch( 'dsl_note', { 'svcnum' => $self->svcnum } );
 203 }
 204
 205 =item insert
 206
 207 Adds this record to the database.  If there is an error, returns the error,
 208 otherwise returns false.
 209
 210 =cut
 211
 212 # the insert method can be inherited from FS::Record
 213
 214 =item delete
 215
 216 Delete this record from the database.
 217
 218 =cut
 219
 220 # the delete method can be inherited from FS::Record
 221
 222 =item replace OLD_RECORD
 223
 224 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 225 returns the error, otherwise returns false.
 226
 227 =cut
 228
 229 # the replace method can be inherited from FS::Record
 230
 231 =item check
 232
 233 Checks all fields to make sure this is a valid DSL.  If there is
 234 an error, returns the error, otherwise returns false.  Called by the insert
 235 and replace methods.
 236
 237 =cut
 238
 239 # the check method should currently be supplied - FS::Record contains some
 240 # data checking routines
 241
 242 sub check {
 243   my $self = shift;
 244
 245   my $error =
 246     $self->ut_numbern('svcnum')
 247     || $self->ut_numbern('pushed')
 248     || $self->ut_numbern('desired_due_date')
 249     || $self->ut_numbern('due_date')
 250     || $self->ut_textn('vendor_order_id')
 251     || $self->ut_textn('vendor_qual_id')
 252     || $self->ut_alphan('vendor_order_type')
 253     || $self->ut_alphan('vendor_order_status')
 254     || $self->ut_textn('first')
 255     || $self->ut_textn('last')
 256     || $self->ut_textn('company')
 257     || $self->ut_numbern('phonenum')
 258     || $self->ut_alphasn('loop_type')
 259     || $self->ut_textn('local_voice_provider')
 260     || $self->ut_textn('circuitnum')
 261     || $self->ut_textn('rate_band')
 262     || $self->ut_numbern('vpi')
 263     || $self->ut_numbern('vci')
 264     || $self->ut_alphan('isp_chg')
 265     || $self->ut_textn('isp_prev')
 266     || $self->ut_textn('username')
 267     || $self->ut_textn('password')
 268     || $self->ut_textn('staticips')
 269     || $self->ut_enum('monitored',    [ '', 'Y' ])
 270     || $self->ut_numbern('last_pull')
 271   ;
 272   return $error if $error;
 273
 274   $self->SUPER::check;
 275 }
 276
 277 =item dsl_device
 278
 279 Returns the MAC addresses associated with this DSL service, as FS::dsl_device
 280 objects.
 281
 282 =cut
 283
 284 sub dsl_device {
 285   my $self = shift;
 286   qsearch('dsl_device', { 'svcnum' => $self->svcnum });
 287 }
 288
 289 sub predelete_hook_first {
 290     my $self = shift;
 291     my @exports = $self->part_svc->part_export_dsl_pull;
 292     return 'More than one DSL-pulling export attached' if scalar(@exports) > 1;
 293     if ( scalar(@exports) == 1 ) {
 294         my $export = $exports[0];
 295         return $export->dsl_pull($self);
 296     }
 297     '';
 298 }
 299
 300 sub predelete_hook {
 301     my $self = shift;
 302     my @notes = $self->notes;
 303     foreach my $note ( @notes ) {
 304         my $error = $note->delete;
 305         return $error if $error;
 306     }
 307     '';
 308 }
 309
 310 =back
 311
 312 =head1 SEE ALSO
 313
 314 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
 315 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
 316 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
 317 L<freeside-queued>, schema.html from the base documentation.
 318
 319 =cut
 320
 321 1;
 322