1 package FS::svc_broadband;
2 use base qw(FS::svc_Radius_Mixin FS::svc_Tower_Mixin FS::svc_Common);
7 { no warnings 'redefine'; use NetAddr::IP; }
8 use FS::Record qw( qsearchs qsearch dbh );
11 use FS::part_svc_router;
14 $FS::UID::callback{'FS::svc_broadband'} = sub {
20 FS::svc_broadband - Object methods for svc_broadband records
24 use FS::svc_broadband;
26 $record = new FS::svc_broadband \%hash;
27 $record = new FS::svc_broadband { 'column' => 'value' };
29 $error = $record->insert;
31 $error = $new_record->replace($old_record);
33 $error = $record->delete;
35 $error = $record->check;
37 $error = $record->suspend;
39 $error = $record->unsuspend;
41 $error = $record->cancel;
45 An FS::svc_broadband object represents a 'broadband' Internet connection, such
46 as a DSL, cable modem, or fixed wireless link. These services are assumed to
47 have the following properties:
49 FS::svc_broadband inherits from FS::svc_Common. The following fields are
54 =item svcnum - primary key
56 =item blocknum - see FS::addr_block
59 speed_up - maximum upload speed, in bits per second. If set to zero, upload
60 speed will be unlimited. Exports that do traffic shaping should handle this
61 correctly, and not blindly set the upload speed to zero and kill the customer's
65 speed_down - maximum download speed, as above
67 =item ip_addr - the customer's IP address. If the customer needs more than one
68 IP address, set this to the address of the customer's router. As a result, the
69 customer's router will have the same address for both its internal and external
70 interfaces thus saving address space. This has been found to work on most NAT
83 Creates a new svc_broadband. To add the record to the database, see
86 Note that this stores the hash reference, not a distinct copy of the hash it
87 points to. You can ask the object for a copy with the I<hash> method.
93 'name' => 'Wireless broadband',
94 'name_plural' => 'Wireless broadband services',
95 'longname_plural' => 'Fixed wireless broadband services',
96 'display_weight' => 50,
97 'cancel_weight' => 70,
98 'ip_field' => 'ip_addr',
100 'svcnum' => 'Service',
101 'description' => 'Descriptive label for this particular device',
102 'speed_down' => 'Maximum download speed for this service in Kbps. 0 denotes unlimited.',
103 'speed_up' => 'Maximum upload speed for this service in Kbps. 0 denotes unlimited.',
104 'ip_addr' => 'IP address. Leave blank for automatic assignment.',
106 { 'label' => 'Address block',
108 'select_table' => 'addr_block',
109 'select_key' => 'blocknum',
110 'select_label' => 'cidr',
111 'disable_inventory' => 1,
113 'plan_id' => 'Service Plan Id',
114 'performance_profile' => 'Peformance Profile',
115 'authkey' => 'Authentication key',
116 'mac_addr' => 'MAC address',
117 'latitude' => 'Latitude',
118 'longitude' => 'Longitude',
119 'altitude' => 'Altitude',
120 'vlan_profile' => 'VLAN profile',
121 'sectornum' => 'Tower/sector',
122 'routernum' => 'Router/block',
124 label => 'RADIUS groups',
125 type => 'select-radius_group.html',
126 #select_table => 'radius_group',
127 #select_key => 'groupnum',
128 #select_label => 'groupname',
129 disable_inventory => 1,
136 sub table { 'svc_broadband'; }
138 sub table_dupcheck_fields { ( 'ip_addr', 'mac_addr' ); }
142 Class method which returns a qsearch hash expression to search for parameters
143 specified in HASHREF.
149 =item unlinked - set to search for all unlinked services. Overrides all other options.
159 =item pkgpart - arrayref
161 =item routernum - arrayref
163 =item sectornum - arrayref
165 =item towernum - arrayref
174 my ($class, $params) = @_;
177 'LEFT JOIN cust_svc USING ( svcnum )',
178 'LEFT JOIN part_svc USING ( svcpart )',
179 'LEFT JOIN cust_pkg USING ( pkgnum )',
180 'LEFT JOIN cust_main USING ( custnum )',
183 # based on FS::svc_acct::search, probably the most mature of the bunch
185 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
188 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
189 push @where, "cust_main.agentnum = $1";
191 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
192 'null_right' => 'View/link unlinked services',
193 'table' => 'cust_main'
197 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
198 push @where, "custnum = $1";
201 #pkgpart, now properly untainted, can be arrayref
202 for my $pkgpart ( $params->{'pkgpart'} ) {
203 if ( ref $pkgpart ) {
204 my $where = join(',', map { /^(\d+)$/ ? $1 : () } @$pkgpart );
205 push @where, "cust_pkg.pkgpart IN ($where)" if $where;
207 elsif ( $pkgpart =~ /^(\d+)$/ ) {
208 push @where, "cust_pkg.pkgpart = $1";
212 #routernum, can be arrayref
213 for my $routernum ( $params->{'routernum'} ) {
214 # this no longer uses addr_block
215 if ( ref $routernum and grep { $_ } @$routernum ) {
216 my $in = join(',', map { /^(\d+)$/ ? $1 : () } @$routernum );
218 push @orwhere, "svc_broadband.routernum IN ($in)" if $in;
219 push @orwhere, "svc_broadband.routernum IS NULL"
220 if grep /^none$/, @$routernum;
221 push @where, '( '.join(' OR ', @orwhere).' )';
223 elsif ( $routernum =~ /^(\d+)$/ ) {
224 push @where, "svc_broadband.routernum = $1";
226 elsif ( $routernum eq 'none' ) {
227 push @where, "svc_broadband.routernum IS NULL";
231 #sector and tower, as above
232 my @where_sector = $class->tower_sector_sql($params);
233 if ( @where_sector ) {
234 push @where, @where_sector;
235 push @from, 'LEFT JOIN tower_sector USING ( sectornum )';
239 if ( $params->{'svcnum'} =~ /^(\d+)$/ ) {
240 push @where, "svcnum = $1";
244 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
245 push @where, "svcpart = $1";
249 if ( $params->{'ip_addr'} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/ ) {
250 push @where, "ip_addr = '$1'";
254 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1) {
255 push @where, "custnum = $1";
258 my $addl_from = join(' ', @from);
260 $extra_sql = 'WHERE '.join(' AND ', @where) if @where;
261 my $count_query = "SELECT COUNT(*) FROM svc_broadband $addl_from $extra_sql";
263 'table' => 'svc_broadband',
265 'select' => join(', ',
269 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
271 'extra_sql' => $extra_sql,
272 'addl_from' => $addl_from,
273 'order_by' => "ORDER BY ".($params->{'order_by'} || 'svcnum'),
274 'count_query' => $count_query,
278 =item search_sql STRING
280 Class method which returns an SQL fragment to search for the given string.
285 my( $class, $string ) = @_;
286 if ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
287 $class->search_sql_field('ip_addr', $string );
288 }elsif ( $string =~ /^([a-fA-F0-9]{12})$/ ) {
289 $class->search_sql_field('mac_addr', uc($string));
290 }elsif ( $string =~ /^(([a-fA-F0-9]{1,2}:){5}([a-fA-F0-9]{1,2}))$/ ) {
291 $class->search_sql_field('mac_addr', uc("$2$3$4$5$6$7") );
299 Returns the IP address.
308 =item insert [ , OPTION => VALUE ... ]
310 Adds this record to the database. If there is an error, returns the error,
311 otherwise returns false.
313 The additional fields pkgnum and svcpart (see FS::cust_svc) should be
314 defined. An FS::cust_svc record will be created and inserted.
316 Currently available options are: I<depend_jobnum>
318 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
319 jobnums), all provisioning jobs will have a dependancy on the supplied
320 jobnum(s) (they will not run until the specific job(s) complete(s)).
324 # Standard FS::svc_Common::insert
328 Delete this record from the database.
332 # Standard FS::svc_Common::delete
334 =item replace OLD_RECORD
336 Replaces the OLD_RECORD with this one in the database. If there is an error,
337 returns the error, otherwise returns false.
339 # Standard FS::svc_Common::replace
343 Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
347 Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
351 Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
355 Checks all fields to make sure this is a valid broadband service. If there is
356 an error, returns the error, otherwise returns false. Called by the insert
363 my $x = $self->setfixed;
365 return $x unless ref($x);
368 my $mac_addr = uc($self->get('mac_addr'));
369 $mac_addr =~ s/[-: ]//g;
370 $self->set('mac_addr', $mac_addr);
373 $self->ut_numbern('svcnum')
374 || $self->ut_numbern('blocknum')
375 || $self->ut_foreign_keyn('routernum', 'router', 'routernum')
376 || $self->ut_foreign_keyn('sectornum', 'tower_sector', 'sectornum')
377 || $self->ut_textn('description')
378 || $self->ut_numbern('speed_up')
379 || $self->ut_numbern('speed_down')
380 || $self->ut_ipn('ip_addr')
381 || $self->ut_hexn('mac_addr')
382 || $self->ut_hexn('auth_key')
383 || $self->ut_coordn('latitude')
384 || $self->ut_coordn('longitude')
385 || $self->ut_sfloatn('altitude')
386 || $self->ut_textn('vlan_profile')
387 || $self->ut_textn('plan_id')
389 return $error if $error;
391 if(($self->speed_up || 0) < 0) { return 'speed_up must be positive'; }
392 if(($self->speed_down || 0) < 0) { return 'speed_down must be positive'; }
394 my $cust_svc = $self->svcnum
395 ? qsearchs('cust_svc', { 'svcnum' => $self->svcnum } )
400 $cust_pkg = $cust_svc->cust_pkg;
401 $svcpart = $cust_svc->svcpart;
403 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
404 return "Invalid pkgnum" unless $cust_pkg;
405 $svcpart = $self->svcpart;
407 my $agentnum = $cust_pkg->cust_main->agentnum if $cust_pkg;
409 if ( $conf->exists('auto_router') and $self->ip_addr and !$self->routernum ) {
410 # assign_router is guaranteed to provide a router that's legal
411 # for this agent and svcpart
412 my $error = $self->_check_ip_addr || $self->assign_router;
413 return $error if $error;
415 elsif ($self->routernum) {
416 return "Router ".$self->routernum." does not provide this service"
417 unless qsearchs('part_svc_router', {
419 routernum => $self->routernum
422 my $router = $self->router;
423 return "Router ".$self->routernum." does not serve this customer"
424 if $router->agentnum and $agentnum and $router->agentnum != $agentnum;
426 if ( $router->manual_addr ) {
430 my $addr_block = $self->addr_block;
431 if ( $self->ip_addr eq ''
432 and not ( $addr_block and $addr_block->manual_flag ) ) {
433 my $error = $self->assign_ip_addr;
434 return $error if $error;
438 my $error = $self->_check_ip_addr;
439 return $error if $error;
440 } # if $self->routernum
442 if ( $cust_pkg && ! $self->latitude && ! $self->longitude ) {
443 my $l = $cust_pkg->cust_location_or_main;
444 if ( $l->ship_latitude && $l->ship_longitude ) {
445 $self->latitude( $l->ship_latitude );
446 $self->longitude( $l->ship_longitude );
447 } elsif ( $l->latitude && $l->longitude ) {
448 $self->latitude( $l->latitude );
449 $self->longitude( $l->longitude );
458 Assign an IP address matching the selected router, and the selected block
468 if ( $self->addr_block and $self->addr_block->routernum == $self->routernum ) {
469 # simple case: user chose a block, find an address in that block
470 # (this overrides an existing IP address if it's not in the block)
471 @blocks = ($self->addr_block);
473 elsif ( $self->routernum ) {
474 @blocks = $self->router->auto_addr_block;
479 #warn "assigning ip address in blocks\n".join("\n",map{$_->cidr} @blocks)."\n";
481 foreach my $block ( @blocks ) {
482 if ( $self->ip_addr and $block->NetAddr->contains($self->NetAddr) ) {
483 # don't change anything
486 $ip_addr = $block->next_free_addr;
488 $self->set(ip_addr => $ip_addr->addr);
489 $self->set(blocknum => $block->blocknum);
493 return 'No IP address available on this router';
498 Assign an address block and router matching the selected IP address.
499 Does nothing if IP address is null.
505 return '' if !$self->ip_addr;
506 #warn "assigning router/block for ".$self->ip_addr."\n";
507 foreach my $router ($self->allowed_routers) {
508 foreach my $block ($router->addr_block) {
509 if ( $block->NetAddr->contains($self->NetAddr) ) {
510 $self->blocknum($block->blocknum);
511 $self->routernum($block->routernum);
516 return $self->ip_addr.' is not in an allowed block.';
522 if (not($self->ip_addr) or $self->ip_addr eq '0.0.0.0') {
523 return '' if $conf->exists('svc_broadband-allow_null_ip_addr');
524 return 'IP address required';
527 return 'Cannot parse address: '.$self->ip_addr unless $self->NetAddr;
530 if ( $self->addr_block
531 and not $self->addr_block->NetAddr->contains($self->NetAddr) ) {
532 return 'Address '.$self->ip_addr.' not in block '.$self->addr_block->cidr;
535 # if (my $dup = qsearchs('svc_broadband', {
536 # ip_addr => $self->ip_addr,
537 # svcnum => {op=>'!=', value => $self->svcnum}
539 # return 'IP address conflicts with svcnum '.$dup->svcnum;
544 sub _check_duplicate {
546 # Not a reliable check because the table isn't locked, but
547 # that's why we have a unique index. This is just to give a
548 # friendlier error message.
550 @dup = $self->find_duplicates('global', 'ip_addr');
552 return "IP address in use (svcnum ".$dup[0]->svcnum.")";
554 @dup = $self->find_duplicates('global', 'mac_addr');
556 return "MAC address in use (svcnum ".$dup[0]->svcnum.")";
565 Returns a NetAddr::IP object containing the IP address of this service. The netmask
572 new NetAddr::IP ($self->ip_addr);
577 Returns the FS::addr_block record (i.e. the address block) for this broadband service.
583 qsearchs('addr_block', { blocknum => $self->blocknum });
588 Returns the FS::router record for this service.
594 qsearchs('router', { routernum => $self->routernum });
597 =item allowed_routers
599 Returns a list of allowed FS::router objects.
603 sub allowed_routers {
605 my $svcpart = $self->svcnum ? $self->cust_svc->svcpart : $self->svcpart;
606 my @r = map { $_->router } qsearch('part_svc_router',
607 { svcpart => $svcpart });
608 if ( $self->cust_main ) {
609 my $agentnum = $self->cust_main->agentnum;
610 return grep { !$_->agentnum or $_->agentnum == $agentnum } @r;
620 =item mac_addr_formatted CASE DELIMITER
622 Format the MAC address (for use by exports). If CASE starts with "l"
623 (for "lowercase"), it's returned in lowercase. DELIMITER is inserted
628 sub mac_addr_formatted {
630 my ($case, $delim) = @_;
631 my $addr = $self->mac_addr;
632 $addr = lc($addr) if $case =~ /^l/i;
633 join( $delim || '', $addr =~ /../g );
640 local($FS::svc_Common::noexport_hack) = 1;
642 # set routernum to addr_block.routernum
643 foreach my $self (qsearch('svc_broadband', {
644 blocknum => {op => '!=', value => ''},
647 my $addr_block = $self->addr_block;
648 if ( !$addr_block ) {
649 # super paranoid mode
650 warn "WARNING: svcnum ".$self->svcnum." is assigned to addr_block ".$self->blocknum.", which does not exist; skipped.\n";
653 my $ip_addr = $self->ip_addr;
654 my $routernum = $addr_block->routernum;
656 $self->set(routernum => $routernum);
657 my $error = $self->check;
658 # sanity check: don't allow this to change IP address or block
659 # (other than setting blocknum to null for a non-auto-assigned router)
660 if ( $self->ip_addr ne $ip_addr
661 or ($self->blocknum and $self->blocknum != $addr_block->blocknum)) {
662 warn "WARNING: Upgrading service ".$self->svcnum." would change its block/address; skipped.\n";
666 $error ||= $self->replace;
667 warn "WARNING: error assigning routernum $routernum to service ".$self->svcnum.
668 ":\n$error; skipped\n"
672 warn "svcnum ".$self->svcnum.
673 ": no routernum in address block ".$addr_block->cidr.", skipped\n";
677 # assign blocknums to services that should have them
678 my @all_blocks = qsearch('addr_block', { });
679 SVC: foreach my $self (
681 'select' => 'svc_broadband.*',
682 'table' => 'svc_broadband',
683 'addl_from' => 'JOIN router USING (routernum)',
685 'extra_sql' => 'WHERE svc_broadband.blocknum IS NULL '.
686 'AND router.manual_addr IS NULL',
690 next SVC if $self->ip_addr eq '';
691 my $NetAddr = $self->NetAddr;
692 # inefficient, but should only need to run once
693 foreach my $block (@all_blocks) {
694 if ($block->NetAddr->contains($NetAddr)) {
695 $self->set(blocknum => $block->blocknum);
696 my $error = $self->replace;
697 warn "WARNING: error assigning blocknum ".$block->blocknum.
698 " to service ".$self->svcnum."\n$error; skipped\n"
703 warn "WARNING: no block found containing ".$NetAddr->addr." for service ".
715 The business with sb_field has been 'fixed', in a manner of speaking.
717 allowed_routers isn't agent virtualized because part_svc isn't agent
720 Having both routernum and blocknum as foreign keys is somewhat dubious.
724 FS::svc_Common, FS::Record, FS::addr_block,
725 FS::part_svc, schema.html from the base documentation.