package FS::svc_dsl; use base qw(FS::Password_Mixin FS::svc_Common); use strict; use vars qw( $conf $DEBUG $me ); use FS::UID; use FS::Record qw( qsearch qsearchs dbh ); use FS::svc_Common; use FS::dsl_note; use FS::qual; $DEBUG = 0; $me = '[FS::svc_dsl]'; FS::UID->install_callback( sub { $conf = new FS::Conf; } ); =head1 NAME FS::svc_dsl - Object methods for svc_dsl records =head1 SYNOPSIS use FS::svc_dsl; $record = new FS::svc_dsl \%hash; $record = new FS::svc_dsl { '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_dsl object represents a DSL service. FS::svc_dsl inherits from FS::svc_Common. The following fields are currently supported: =over 4 =item svcnum - Primary key (assigned automatcially for new DSL)) =item pushed - Time DSL order pushed to vendor/telco, if applicable =item desired_due_date - Desired Due Date =item due_date - Due Date =item vendor_order_id - Vendor/telco DSL order # =item vendor_order_type Vendor/telco DSL order type (e.g. (M)ove, (A)dd, (C)hange, (D)elete, or similar) =item vendor_order_status Vendor/telco DSL order status (e.g. (N)ew, (A)ssigned, (R)ejected, (M)revised, (C)ompleted, (X)cancelled, or similar) =item first - End-user first name =item last - End-user last name =item company - End-user company name =item phonenum - DSL Telephone Number =item gateway_access_number - Gateway access number, if different =item loop_type - Loop-type - vendor/telco-specific =item local_voice_provider - Local Voice Provider's name =item circuitnum - Circuit # =item vpi =item vci =item rate_band - Rate Band =item isp_chg =item isp_prev =item staticips =item vendor_qual_id Ikano-specific fields, do not use otherwise =item username - if outsourced PPPoE/RADIUS, username =item password - if outsourced PPPoE/RADIUS, password =item monitored - Order is monitored (auto-pull/sync), either Y or blank =item last_pull - time of last data pull from vendor/telco =back =head1 METHODS =over 4 =item new HASHREF Creates a new DSL. To add the DSL to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. =cut # the new method can be inherited from FS::Record, if a table method is defined sub table_info { my %dis1 = ( disable_default=>1, disable_fixed=>1, disable_inventory=>1, disable_select=>1 ); my %dis2 = ( disable_inventory=>1, disable_select=>1 ); { 'name' => 'DSL', 'name_plural' => 'DSLs', 'lcname_plural' => 'DSLs', 'sorts' => [ 'phonenum' ], 'display_weight' => 55, 'cancel_weight' => 75, 'ip_field' => 'staticips', 'fields' => { 'pushed' => { label => 'Pushed', type => 'disabled' }, 'desired_due_date' => { label => 'Desired Due Date', %dis2, }, 'due_date' => { label => 'Due Date', %dis2, }, 'vendor_order_id' => { label => 'Vendor Order ID', %dis2, }, 'vendor_qual_id' => { label => 'Vendor Qualification ID', type => 'disabled' }, 'vendor_order_type' => { label => 'Vendor Order Type', disable_inventory => 1, }, 'vendor_order_status' => { label => 'Vendor Order Status', disable_inventory => 1, }, 'first' => { label => 'First Name', %dis2, }, 'last' => { label => 'Last Name', %dis2, }, 'company' => { label => 'Company Name', %dis2, }, 'phonenum' => { label => 'Service Telephone Number', }, 'gateway_access_number' => { label => 'Gateway Access Number'. ' (if different)', }, 'loop_type' => { label => 'Loop Type', disable_inventory => 1, }, 'local_voice_provider' => { label => 'Local Voice Provider', disable_inventory => 1, }, 'circuitnum' => { label => 'Circuit #', }, 'rate_band' => { label => 'Rate Band', disable_inventory => 1, }, 'vpi' => { label => 'VPI', disable_inventory => 1 }, 'vci' => { label => 'VCI', disable_inventory => 1 }, 'isp_chg' => { label => 'ISP Changing?', type => 'checkbox', %dis2, }, 'isp_prev' => { label => 'Current or Previous ISP', disable_inventory => 1, }, 'username' => { label => 'PPPoE Username', type => 'text', }, 'password' => { label => 'PPPoE Password', %dis2 }, 'staticips' => { label => 'Static IPs', %dis1 }, 'monitored' => { label => 'Monitored', type => 'checkbox', %dis2 }, 'last_pull' => { label => 'Last Pull', type => 'disabled' }, }, }; } sub table { 'svc_dsl'; } sub label { my $self = shift; return $self->phonenum if $self->phonenum; return $self->username if $self->username; return $self->vendor_order_id if $self->vendor_order_id; return $self->svcnum; } =item notes Returns the set of FS::dsl_notes associated with this service =cut sub notes { my $self = shift; qsearch( 'dsl_note', { 'svcnum' => $self->svcnum } ); } =item insert Adds this record to the database. If there is an error, returns the error, otherwise returns false. =cut sub insert { my $self = shift; my $dbh = dbh; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $error = $self->SUPER::insert(@_); if ( length($self->password) ) { $error ||= $self->insert_password_history; } if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } $dbh->commit if $oldAutoCommit; ''; } =item delete Delete this record from the database. =cut # the delete method can be inherited from FS::Record =item replace OLD_RECORD Replaces the 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 = shift || $new->replace_old; my $dbh = dbh; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $error = $new->SUPER::replace($old, @_); if ( $old->password ne $new->password ) { $error ||= $new->insert_password_history; } if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } $dbh->commit if $oldAutoCommit; ''; } # the replace method can be inherited from FS::Record =item check Checks all fields to make sure this is a valid DSL. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut # the check method should currently be supplied - FS::Record contains some # data checking routines sub check { my $self = shift; my $error = $self->ut_numbern('svcnum') || $self->ut_numbern('pushed') || $self->ut_numbern('desired_due_date') || $self->ut_numbern('due_date') || $self->ut_textn('vendor_order_id') || $self->ut_textn('vendor_qual_id') || $self->ut_alphan('vendor_order_type') || $self->ut_alphan('vendor_order_status') || $self->ut_textn('first') || $self->ut_textn('last') || $self->ut_textn('company') || $self->ut_numbern('phonenum') || $self->ut_numbern('gateway_access_number') || $self->ut_alphasn('loop_type') || $self->ut_textn('local_voice_provider') || $self->ut_textn('circuitnum') || $self->ut_textn('rate_band') || $self->ut_numbern('vpi') || $self->ut_numbern('vci') || $self->ut_alphan('isp_chg') || $self->ut_textn('isp_prev') || $self->ut_textn('username') || $self->ut_textn('password') || $self->ut_textn('staticips') || $self->ut_enum('monitored', [ '', 'Y' ]) || $self->ut_numbern('last_pull') ; return $error if $error; $self->gateway_access_number('') if $self->phonenum && $self->phonenum eq $self->gateway_access_number; $self->SUPER::check; } =item gateway_access_or_phonenum =cut sub gateway_access_or_phonenum { my $self = shift; $self->gateway_access_number || $self->phonenum; } =item dsl_device Returns the MAC addresses associated with this DSL service, as FS::dsl_device objects. =cut sub predelete_hook_first { my $self = shift; my @exports = $self->part_svc->part_export_dsl_pull; return 'More than one DSL-pulling export attached' if scalar(@exports) > 1; if ( scalar(@exports) == 1 ) { my $export = $exports[0]; return $export->dsl_pull($self); } ''; } sub predelete_hook { my $self = shift; my @notes = $self->notes; foreach my $note ( @notes ) { my $error = $note->delete; return $error if $error; } ''; } # password_history compatibility sub _password { my $self = shift; $self->get('password'); } sub _password_encoding { 'plain'; } =back =head1 SEE ALSO L, edit/part_svc.cgi from an installed web interface, export.html from the base documentation, L, L, L, L, L, L, L, schema.html from the base documentation. =cut 1;