2 use base qw(FS::svc_Common);
5 use vars qw( $conf $DEBUG $me );
7 use FS::Record qw( qsearch qsearchs );
13 $me = '[FS::svc_dsl]';
15 FS::UID->install_callback( sub {
22 FS::svc_dsl - Object methods for svc_dsl records
28 $record = new FS::svc_dsl \%hash;
29 $record = new FS::svc_dsl { 'column' => 'value' };
31 $error = $record->insert;
33 $error = $new_record->replace($old_record);
35 $error = $record->delete;
37 $error = $record->check;
39 $error = $record->suspend;
41 $error = $record->unsuspend;
43 $error = $record->cancel;
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:
52 =item svcnum - Primary key (assigned automatcially for new DSL))
54 =item pushed - Time DSL order pushed to vendor/telco, if applicable
56 =item desired_due_date - Desired Due Date
58 =item due_date - Due Date
60 =item vendor_order_id - Vendor/telco DSL order #
62 =item vendor_order_type
64 Vendor/telco DSL order type (e.g. (M)ove, (A)dd, (C)hange, (D)elete, or similar)
66 =item vendor_order_status
68 Vendor/telco DSL order status (e.g. (N)ew, (A)ssigned, (R)ejected, (M)revised,
69 (C)ompleted, (X)cancelled, or similar)
71 =item first - End-user first name
73 =item last - End-user last name
75 =item company - End-user company name
77 =item phonenum - DSL Telephone Number
79 =item gateway_access_number - Gateway access number, if different
81 =item loop_type - Loop-type - vendor/telco-specific
83 =item local_voice_provider - Local Voice Provider's name
85 =item circuitnum - Circuit #
91 =item rate_band - Rate Band
101 Ikano-specific fields, do not use otherwise
103 =item username - if outsourced PPPoE/RADIUS, username
105 =item password - if outsourced PPPoE/RADIUS, password
107 =item monitored - Order is monitored (auto-pull/sync), either Y or blank
109 =item last_pull - time of last data pull from vendor/telco
120 Creates a new DSL. To add the DSL to the database, see L<"insert">.
122 Note that this stores the hash reference, not a distinct copy of the hash it
123 points to. You can ask the object for a copy with the I<hash> method.
127 # the new method can be inherited from FS::Record, if a table method is defined
130 my %dis1 = ( disable_default=>1, disable_fixed=>1, disable_inventory=>1, disable_select=>1 );
131 my %dis2 = ( disable_inventory=>1, disable_select=>1 );
135 'name_plural' => 'DSLs',
136 'lcname_plural' => 'DSLs',
137 'sorts' => [ 'phonenum' ],
138 'display_weight' => 55,
139 'cancel_weight' => 75,
140 'ip_field' => 'staticips',
142 'pushed' => { label => 'Pushed',
143 type => 'disabled' },
144 'desired_due_date' => { label => 'Desired Due Date', %dis2, },
145 'due_date' => { label => 'Due Date', %dis2, },
146 'vendor_order_id' => { label => 'Vendor Order ID', %dis2, },
147 'vendor_qual_id' => { label => 'Vendor Qualification ID',
148 type => 'disabled' },
149 'vendor_order_type' => { label => 'Vendor Order Type',
150 disable_inventory => 1, },
151 'vendor_order_status' => { label => 'Vendor Order Status',
152 disable_inventory => 1, },
153 'first' => { label => 'First Name', %dis2, },
154 'last' => { label => 'Last Name', %dis2, },
155 'company' => { label => 'Company Name', %dis2, },
156 'phonenum' => { label => 'Service Telephone Number', },
157 'gateway_access_number' => { label => 'Gateway Access Number'.
158 ' (if different)', },
159 'loop_type' => { label => 'Loop Type',
160 disable_inventory => 1, },
161 'local_voice_provider' => { label => 'Local Voice Provider',
162 disable_inventory => 1, },
163 'circuitnum' => { label => 'Circuit #', },
164 'rate_band' => { label => 'Rate Band',
165 disable_inventory => 1, },
166 'vpi' => { label => 'VPI',
167 disable_inventory => 1 },
168 'vci' => { label => 'VCI',
169 disable_inventory => 1 },
170 'isp_chg' => { label => 'ISP Changing?',
173 'isp_prev' => { label => 'Current or Previous ISP',
174 disable_inventory => 1, },
175 'username' => { label => 'PPPoE Username',
177 'password' => { label => 'PPPoE Password', %dis2 },
178 'staticips' => { label => 'Static IPs', %dis1 },
179 'monitored' => { label => 'Monitored',
180 type => 'checkbox', %dis2 },
181 'last_pull' => { label => 'Last Pull',
182 type => 'disabled' },
187 sub table { 'svc_dsl'; }
191 return $self->phonenum if $self->phonenum;
192 return $self->username if $self->username;
193 return $self->vendor_order_id if $self->vendor_order_id;
194 return $self->svcnum;
199 Returns the set of FS::dsl_notes associated with this service
204 qsearch( 'dsl_note', { 'svcnum' => $self->svcnum } );
209 Adds this record to the database. If there is an error, returns the error,
210 otherwise returns false.
214 # the insert method can be inherited from FS::Record
218 Delete this record from the database.
222 # the delete method can be inherited from FS::Record
224 =item replace OLD_RECORD
226 Replaces the OLD_RECORD with this one in the database. If there is an error,
227 returns the error, otherwise returns false.
231 # the replace method can be inherited from FS::Record
235 Checks all fields to make sure this is a valid DSL. If there is
236 an error, returns the error, otherwise returns false. Called by the insert
241 # the check method should currently be supplied - FS::Record contains some
242 # data checking routines
248 $self->ut_numbern('svcnum')
249 || $self->ut_numbern('pushed')
250 || $self->ut_numbern('desired_due_date')
251 || $self->ut_numbern('due_date')
252 || $self->ut_textn('vendor_order_id')
253 || $self->ut_textn('vendor_qual_id')
254 || $self->ut_alphan('vendor_order_type')
255 || $self->ut_alphan('vendor_order_status')
256 || $self->ut_textn('first')
257 || $self->ut_textn('last')
258 || $self->ut_textn('company')
259 || $self->ut_numbern('phonenum')
260 || $self->ut_numbern('gateway_access_number')
261 || $self->ut_alphasn('loop_type')
262 || $self->ut_textn('local_voice_provider')
263 || $self->ut_textn('circuitnum')
264 || $self->ut_textn('rate_band')
265 || $self->ut_numbern('vpi')
266 || $self->ut_numbern('vci')
267 || $self->ut_alphan('isp_chg')
268 || $self->ut_textn('isp_prev')
269 || $self->ut_textn('username')
270 || $self->ut_textn('password')
271 || $self->ut_textn('staticips')
272 || $self->ut_enum('monitored', [ '', 'Y' ])
273 || $self->ut_numbern('last_pull')
275 return $error if $error;
277 $self->gateway_access_number('')
278 if $self->phonenum && $self->phonenum eq $self->gateway_access_number;
283 =item gateway_access_or_phonenum
287 sub gateway_access_or_phonenum {
289 $self->gateway_access_number || $self->phonenum;
294 Returns the MAC addresses associated with this DSL service, as FS::dsl_device
299 sub predelete_hook_first {
301 my @exports = $self->part_svc->part_export_dsl_pull;
302 return 'More than one DSL-pulling export attached' if scalar(@exports) > 1;
303 if ( scalar(@exports) == 1 ) {
304 my $export = $exports[0];
305 return $export->dsl_pull($self);
312 my @notes = $self->notes;
313 foreach my $note ( @notes ) {
314 my $error = $note->delete;
315 return $error if $error;
324 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
325 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
326 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
327 L<freeside-queued>, schema.html from the base documentation.