1 package FS::svc_broadband;
4 use vars qw(@ISA $conf);
6 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 );
12 use FS::part_svc_router;
15 $FS::UID::callback{'FS::svc_broadband'} = sub {
21 FS::svc_broadband - Object methods for svc_broadband records
25 use FS::svc_broadband;
27 $record = new FS::svc_broadband \%hash;
28 $record = new FS::svc_broadband { 'column' => 'value' };
30 $error = $record->insert;
32 $error = $new_record->replace($old_record);
34 $error = $record->delete;
36 $error = $record->check;
38 $error = $record->suspend;
40 $error = $record->unsuspend;
42 $error = $record->cancel;
46 An FS::svc_broadband object represents a 'broadband' Internet connection, such
47 as a DSL, cable modem, or fixed wireless link. These services are assumed to
48 have the following properties:
50 FS::svc_broadband inherits from FS::svc_Common. The following fields are
55 =item svcnum - primary key
57 =item blocknum - see FS::addr_block
60 speed_up - maximum upload speed, in bits per second. If set to zero, upload
61 speed will be unlimited. Exports that do traffic shaping should handle this
62 correctly, and not blindly set the upload speed to zero and kill the customer's
66 speed_down - maximum download speed, as above
68 =item ip_addr - the customer's IP address. If the customer needs more than one
69 IP address, set this to the address of the customer's router. As a result, the
70 customer's router will have the same address for both its internal and external
71 interfaces thus saving address space. This has been found to work on most NAT
84 Creates a new svc_broadband. To add the record to the database, see
87 Note that this stores the hash reference, not a distinct copy of the hash it
88 points to. You can ask the object for a copy with the I<hash> method.
94 'name' => 'Wireless broadband',
95 'name_plural' => 'Wireless broadband services',
96 'longname_plural' => 'Fixed wireless broadband services',
97 'display_weight' => 50,
98 'cancel_weight' => 70,
99 'ip_field' => 'ip_addr',
101 'svcnum' => 'Service',
102 'description' => 'Descriptive label for this particular device',
103 'speed_down' => 'Maximum download speed for this service in Kbps. 0 denotes unlimited.',
104 'speed_up' => 'Maximum upload speed for this service in Kbps. 0 denotes unlimited.',
105 'ip_addr' => 'IP address. Leave blank for automatic assignment.',
107 { 'label' => 'Address block',
109 'select_table' => 'addr_block',
110 'select_key' => 'blocknum',
111 'select_label' => 'cidr',
112 'disable_inventory' => 1,
114 'plan_id' => 'Service Plan Id',
115 'performance_profile' => 'Peformance Profile',
116 'authkey' => 'Authentication key',
117 'mac_addr' => 'MAC address',
118 'latitude' => 'Latitude',
119 'longitude' => 'Longitude',
120 'altitude' => 'Altitude',
121 'vlan_profile' => 'VLAN profile',
122 'sectornum' => 'Tower/sector',
123 'routernum' => 'Router/block',
125 label => 'RADIUS groups',
126 type => 'select-radius_group.html',
127 #select_table => 'radius_group',
128 #select_key => 'groupnum',
129 #select_label => 'groupname',
130 disable_inventory => 1,
137 sub table { 'svc_broadband'; }
139 sub table_dupcheck_fields { ( 'ip_addr', 'mac_addr' ); }
143 Class method which returns a qsearch hash expression to search for parameters
144 specified in HASHREF.
150 =item unlinked - set to search for all unlinked services. Overrides all other options.
160 =item pkgpart - arrayref
162 =item routernum - arrayref
164 =item sectornum - arrayref
166 =item towernum - arrayref
175 my ($class, $params) = @_;
178 'LEFT JOIN cust_svc USING ( svcnum )',
179 'LEFT JOIN part_svc USING ( svcpart )',
180 'LEFT JOIN cust_pkg USING ( pkgnum )',
181 'LEFT JOIN cust_main USING ( custnum )',
184 # based on FS::svc_acct::search, probably the most mature of the bunch
186 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
189 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
190 push @where, "cust_main.agentnum = $1";
192 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
193 'null_right' => 'View/link unlinked services',
194 'table' => 'cust_main'
198 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
199 push @where, "custnum = $1";
202 #pkgpart, now properly untainted, can be arrayref
203 for my $pkgpart ( $params->{'pkgpart'} ) {
204 if ( ref $pkgpart ) {
205 my $where = join(',', map { /^(\d+)$/ ? $1 : () } @$pkgpart );
206 push @where, "cust_pkg.pkgpart IN ($where)" if $where;
208 elsif ( $pkgpart =~ /^(\d+)$/ ) {
209 push @where, "cust_pkg.pkgpart = $1";
213 #routernum, can be arrayref
214 for my $routernum ( $params->{'routernum'} ) {
215 # this no longer uses addr_block
216 if ( ref $routernum and grep { $_ } @$routernum ) {
217 my $in = join(',', map { /^(\d+)$/ ? $1 : () } @$routernum );
219 push @orwhere, "svc_broadband.routernum IN ($in)" if $in;
220 push @orwhere, "svc_broadband.routernum IS NULL"
221 if grep /^none$/, @$routernum;
222 push @where, '( '.join(' OR ', @orwhere).' )';
224 elsif ( $routernum =~ /^(\d+)$/ ) {
225 push @where, "svc_broadband.routernum = $1";
227 elsif ( $routernum eq 'none' ) {
228 push @where, "svc_broadband.routernum IS NULL";
232 #sector and tower, as above
233 my @where_sector = $class->tower_sector_sql($params);
234 if ( @where_sector ) {
235 push @where, @where_sector;
236 push @from, 'LEFT JOIN tower_sector USING ( sectornum )';
240 if ( $params->{'svcnum'} =~ /^(\d+)$/ ) {
241 push @where, "svcnum = $1";
245 if ( $params->{'svcpart'} =~ /^(\d+)$/ ) {
246 push @where, "svcpart = $1";
250 if ( $params->{'exportnum'} =~ /^(\d+)$/ ) {
251 push @from, 'LEFT JOIN export_svc USING ( svcpart )';
252 push @where, "exportnum = $1";
256 if ( $params->{'ip_addr'} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/ ) {
257 push @where, "ip_addr = '$1'";
261 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1) {
262 push @where, "custnum = $1";
265 my $addl_from = join(' ', @from);
267 $extra_sql = 'WHERE '.join(' AND ', @where) if @where;
268 my $count_query = "SELECT COUNT(*) FROM svc_broadband $addl_from $extra_sql";
270 'table' => 'svc_broadband',
272 'select' => join(', ',
276 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
278 'extra_sql' => $extra_sql,
279 'addl_from' => $addl_from,
280 'order_by' => "ORDER BY ".($params->{'order_by'} || 'svcnum'),
281 'count_query' => $count_query,
285 =item search_sql STRING
287 Class method which returns an SQL fragment to search for the given string.
292 my( $class, $string ) = @_;
293 if ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
294 $class->search_sql_field('ip_addr', $string );
295 }elsif ( $string =~ /^([a-fA-F0-9]{12})$/ ) {
296 $class->search_sql_field('mac_addr', uc($string));
297 }elsif ( $string =~ /^(([a-fA-F0-9]{1,2}:){5}([a-fA-F0-9]{1,2}))$/ ) {
298 $class->search_sql_field('mac_addr', uc("$2$3$4$5$6$7") );
306 Returns the IP address.
315 =item insert [ , OPTION => VALUE ... ]
317 Adds this record to the database. If there is an error, returns the error,
318 otherwise returns false.
320 The additional fields pkgnum and svcpart (see FS::cust_svc) should be
321 defined. An FS::cust_svc record will be created and inserted.
323 Currently available options are: I<depend_jobnum>
325 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
326 jobnums), all provisioning jobs will have a dependancy on the supplied
327 jobnum(s) (they will not run until the specific job(s) complete(s)).
329 # Standard FS::svc_Common::insert
333 Delete this record from the database.
337 # Standard FS::svc_Common::delete
339 =item replace OLD_RECORD
341 Replaces the OLD_RECORD with this one in the database. If there is an error,
342 returns the error, otherwise returns false.
344 # Standard FS::svc_Common::replace
348 Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
352 Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
356 Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
360 Checks all fields to make sure this is a valid broadband service. If there is
361 an error, returns the error, otherwise returns false. Called by the insert
368 my $x = $self->setfixed;
370 return $x unless ref($x);
373 my $mac_addr = uc($self->get('mac_addr'));
374 $mac_addr =~ s/[-: ]//g;
375 $self->set('mac_addr', $mac_addr);
378 $self->ut_numbern('svcnum')
379 || $self->ut_numbern('blocknum')
380 || $self->ut_foreign_keyn('routernum', 'router', 'routernum')
381 || $self->ut_foreign_keyn('sectornum', 'tower_sector', 'sectornum')
382 || $self->ut_textn('description')
383 || $self->ut_numbern('speed_up')
384 || $self->ut_numbern('speed_down')
385 || $self->ut_ipn('ip_addr')
386 || $self->ut_hexn('mac_addr')
387 || $self->ut_hexn('auth_key')
388 || $self->ut_coordn('latitude')
389 || $self->ut_coordn('longitude')
390 || $self->ut_sfloatn('altitude')
391 || $self->ut_textn('vlan_profile')
392 || $self->ut_textn('plan_id')
394 return $error if $error;
396 if(($self->speed_up || 0) < 0) { return 'speed_up must be positive'; }
397 if(($self->speed_down || 0) < 0) { return 'speed_down must be positive'; }
399 my $cust_svc = $self->svcnum
400 ? qsearchs('cust_svc', { 'svcnum' => $self->svcnum } )
405 $cust_pkg = $cust_svc->cust_pkg;
406 $svcpart = $cust_svc->svcpart;
408 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
409 return "Invalid pkgnum" unless $cust_pkg;
410 $svcpart = $self->svcpart;
412 my $agentnum = $cust_pkg->cust_main->agentnum if $cust_pkg;
414 if ( $conf->exists('auto_router') and $self->ip_addr and !$self->routernum ) {
415 # assign_router is guaranteed to provide a router that's legal
416 # for this agent and svcpart
417 my $error = $self->_check_ip_addr || $self->assign_router;
418 return $error if $error;
420 elsif ($self->routernum) {
421 return "Router ".$self->routernum." does not provide this service"
422 unless qsearchs('part_svc_router', {
424 routernum => $self->routernum
427 my $router = $self->router;
428 return "Router ".$self->routernum." does not serve this customer"
429 if $router->agentnum and $agentnum and $router->agentnum != $agentnum;
431 if ( $router->manual_addr ) {
435 my $addr_block = $self->addr_block;
436 if ( $self->ip_addr eq ''
437 and not ( $addr_block and $addr_block->manual_flag ) ) {
438 my $error = $self->assign_ip_addr;
439 return $error if $error;
443 my $error = $self->_check_ip_addr;
444 return $error if $error;
445 } # if $self->routernum
447 if ( $cust_pkg && ! $self->latitude && ! $self->longitude ) {
448 my $l = $cust_pkg->cust_location_or_main;
449 if ( $l->ship_latitude && $l->ship_longitude ) {
450 $self->latitude( $l->ship_latitude );
451 $self->longitude( $l->ship_longitude );
452 } elsif ( $l->latitude && $l->longitude ) {
453 $self->latitude( $l->latitude );
454 $self->longitude( $l->longitude );
463 Assign an IP address matching the selected router, and the selected block
473 if ( $self->addr_block and $self->addr_block->routernum == $self->routernum ) {
474 # simple case: user chose a block, find an address in that block
475 # (this overrides an existing IP address if it's not in the block)
476 @blocks = ($self->addr_block);
478 elsif ( $self->routernum ) {
479 @blocks = $self->router->auto_addr_block;
484 #warn "assigning ip address in blocks\n".join("\n",map{$_->cidr} @blocks)."\n";
486 foreach my $block ( @blocks ) {
487 if ( $self->ip_addr and $block->NetAddr->contains($self->NetAddr) ) {
488 # don't change anything
491 $ip_addr = $block->next_free_addr;
493 $self->set(ip_addr => $ip_addr->addr);
494 $self->set(blocknum => $block->blocknum);
498 return 'No IP address available on this router';
503 Assign an address block and router matching the selected IP address.
504 Does nothing if IP address is null.
510 return '' if !$self->ip_addr;
511 #warn "assigning router/block for ".$self->ip_addr."\n";
512 foreach my $router ($self->allowed_routers) {
513 foreach my $block ($router->addr_block) {
514 if ( $block->NetAddr->contains($self->NetAddr) ) {
515 $self->blocknum($block->blocknum);
516 $self->routernum($block->routernum);
521 return $self->ip_addr.' is not in an allowed block.';
527 if (not($self->ip_addr) or $self->ip_addr eq '0.0.0.0') {
528 return '' if $conf->exists('svc_broadband-allow_null_ip_addr');
529 return 'IP address required';
532 return 'Cannot parse address: '.$self->ip_addr unless $self->NetAddr;
535 if ( $self->addr_block
536 and not $self->addr_block->NetAddr->contains($self->NetAddr) ) {
537 return 'Address '.$self->ip_addr.' not in block '.$self->addr_block->cidr;
540 # if (my $dup = qsearchs('svc_broadband', {
541 # ip_addr => $self->ip_addr,
542 # svcnum => {op=>'!=', value => $self->svcnum}
544 # return 'IP address conflicts with svcnum '.$dup->svcnum;
549 sub _check_duplicate {
551 # Not a reliable check because the table isn't locked, but
552 # that's why we have a unique index. This is just to give a
553 # friendlier error message.
555 @dup = $self->find_duplicates('global', 'ip_addr');
557 return "IP address in use (svcnum ".$dup[0]->svcnum.")";
559 @dup = $self->find_duplicates('global', 'mac_addr');
561 return "MAC address in use (svcnum ".$dup[0]->svcnum.")";
570 Returns a NetAddr::IP object containing the IP address of this service. The netmask
577 new NetAddr::IP ($self->ip_addr);
582 Returns the FS::addr_block record (i.e. the address block) for this broadband service.
588 qsearchs('addr_block', { blocknum => $self->blocknum });
593 Returns the FS::router record for this service.
599 qsearchs('router', { routernum => $self->routernum });
602 =item allowed_routers
604 Returns a list of allowed FS::router objects.
608 sub allowed_routers {
610 my $svcpart = $self->svcnum ? $self->cust_svc->svcpart : $self->svcpart;
611 my @r = map { $_->router } qsearch('part_svc_router',
612 { svcpart => $svcpart });
613 if ( $self->cust_main ) {
614 my $agentnum = $self->cust_main->agentnum;
615 return grep { !$_->agentnum or $_->agentnum == $agentnum } @r;
625 =item mac_addr_formatted CASE DELIMITER
627 Format the MAC address (for use by exports). If CASE starts with "l"
628 (for "lowercase"), it's returned in lowercase. DELIMITER is inserted
633 sub mac_addr_formatted {
635 my ($case, $delim) = @_;
636 my $addr = $self->mac_addr;
637 $addr = lc($addr) if $case =~ /^l/i;
638 join( $delim || '', $addr =~ /../g );
645 local($FS::svc_Common::noexport_hack) = 1;
647 # set routernum to addr_block.routernum
648 foreach my $self (qsearch('svc_broadband', {
649 blocknum => {op => '!=', value => ''},
652 my $addr_block = $self->addr_block;
653 if ( !$addr_block ) {
654 # super paranoid mode
655 warn "WARNING: svcnum ".$self->svcnum." is assigned to addr_block ".$self->blocknum.", which does not exist; skipped.\n";
658 my $ip_addr = $self->ip_addr;
659 my $routernum = $addr_block->routernum;
661 $self->set(routernum => $routernum);
662 my $error = $self->check;
663 # sanity check: don't allow this to change IP address or block
664 # (other than setting blocknum to null for a non-auto-assigned router)
665 if ( $self->ip_addr ne $ip_addr
666 or ($self->blocknum and $self->blocknum != $addr_block->blocknum)) {
667 warn "WARNING: Upgrading service ".$self->svcnum." would change its block/address; skipped.\n";
671 $error ||= $self->replace;
672 warn "WARNING: error assigning routernum $routernum to service ".$self->svcnum.
673 ":\n$error; skipped\n"
677 warn "svcnum ".$self->svcnum.
678 ": no routernum in address block ".$addr_block->cidr.", skipped\n";
682 # assign blocknums to services that should have them
683 my @all_blocks = qsearch('addr_block', { });
684 SVC: foreach my $self (
686 'select' => 'svc_broadband.*',
687 'table' => 'svc_broadband',
688 'addl_from' => 'JOIN router USING (routernum)',
690 'extra_sql' => 'WHERE svc_broadband.blocknum IS NULL '.
691 'AND router.manual_addr IS NULL',
695 next SVC if $self->ip_addr eq '';
696 my $NetAddr = $self->NetAddr;
697 # inefficient, but should only need to run once
698 foreach my $block (@all_blocks) {
699 if ($block->NetAddr->contains($NetAddr)) {
700 $self->set(blocknum => $block->blocknum);
701 my $error = $self->replace;
702 warn "WARNING: error assigning blocknum ".$block->blocknum.
703 " to service ".$self->svcnum."\n$error; skipped\n"
708 warn "WARNING: no block found containing ".$NetAddr->addr." for service ".
720 The business with sb_field has been 'fixed', in a manner of speaking.
722 allowed_routers isn't agent virtualized because part_svc isn't agent
725 Having both routernum and blocknum as foreign keys is somewhat dubious.
729 FS::svc_Common, FS::Record, FS::addr_block,
730 FS::part_svc, schema.html from the base documentation.