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' => 'Broadband',
95 'name_plural' => 'Broadband services',
96 'longname_plural' => 'Fixed (username-less) 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->{'ip_addr'} =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/ ) {
251 push @where, "ip_addr = '$1'";
255 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1) {
256 push @where, "custnum = $1";
259 my $addl_from = join(' ', @from);
261 $extra_sql = 'WHERE '.join(' AND ', @where) if @where;
262 my $count_query = "SELECT COUNT(*) FROM svc_broadband $addl_from $extra_sql";
264 'table' => 'svc_broadband',
266 'select' => join(', ',
270 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
272 'extra_sql' => $extra_sql,
273 'addl_from' => $addl_from,
274 'order_by' => "ORDER BY ".($params->{'order_by'} || 'svcnum'),
275 'count_query' => $count_query,
279 =item search_sql STRING
281 Class method which returns an SQL fragment to search for the given string.
286 my( $class, $string ) = @_;
287 if ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
288 $class->search_sql_field('ip_addr', $string );
289 }elsif ( $string =~ /^([a-fA-F0-9]{12})$/ ) {
290 $class->search_sql_field('mac_addr', uc($string));
291 }elsif ( $string =~ /^(([a-fA-F0-9]{1,2}:){5}([a-fA-F0-9]{1,2}))$/ ) {
292 $class->search_sql_field('mac_addr', uc("$2$3$4$5$6$7") );
300 Returns the IP address.
309 =item insert [ , OPTION => VALUE ... ]
311 Adds this record to the database. If there is an error, returns the error,
312 otherwise returns false.
314 The additional fields pkgnum and svcpart (see FS::cust_svc) should be
315 defined. An FS::cust_svc record will be created and inserted.
317 Currently available options are: I<depend_jobnum>
319 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
320 jobnums), all provisioning jobs will have a dependancy on the supplied
321 jobnum(s) (they will not run until the specific job(s) complete(s)).
323 # Standard FS::svc_Common::insert
327 Delete this record from the database.
331 # Standard FS::svc_Common::delete
333 =item replace OLD_RECORD
335 Replaces the OLD_RECORD with this one in the database. If there is an error,
336 returns the error, otherwise returns false.
338 # Standard FS::svc_Common::replace
342 Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
346 Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
350 Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
354 Checks all fields to make sure this is a valid broadband service. If there is
355 an error, returns the error, otherwise returns false. Called by the insert
362 my $x = $self->setfixed;
364 return $x unless ref($x);
367 my $mac_addr = uc($self->get('mac_addr'));
368 $mac_addr =~ s/[-: ]//g;
369 $self->set('mac_addr', $mac_addr);
372 $self->ut_numbern('svcnum')
373 || $self->ut_numbern('blocknum')
374 || $self->ut_foreign_keyn('routernum', 'router', 'routernum')
375 || $self->ut_foreign_keyn('sectornum', 'tower_sector', 'sectornum')
376 || $self->ut_textn('description')
377 || $self->ut_numbern('speed_up')
378 || $self->ut_numbern('speed_down')
379 || $self->ut_ipn('ip_addr')
380 || $self->ut_hexn('mac_addr')
381 || $self->ut_hexn('auth_key')
382 || $self->ut_coordn('latitude')
383 || $self->ut_coordn('longitude')
384 || $self->ut_sfloatn('altitude')
385 || $self->ut_textn('vlan_profile')
386 || $self->ut_textn('plan_id')
388 return $error if $error;
390 if(($self->speed_up || 0) < 0) { return 'speed_up must be positive'; }
391 if(($self->speed_down || 0) < 0) { return 'speed_down must be positive'; }
393 my $cust_svc = $self->svcnum
394 ? qsearchs('cust_svc', { 'svcnum' => $self->svcnum } )
399 $cust_pkg = $cust_svc->cust_pkg;
400 $svcpart = $cust_svc->svcpart;
402 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
403 return "Invalid pkgnum" unless $cust_pkg;
404 $svcpart = $self->svcpart;
406 my $agentnum = $cust_pkg->cust_main->agentnum if $cust_pkg;
408 if ( $conf->exists('auto_router') and $self->ip_addr and !$self->routernum ) {
409 # assign_router is guaranteed to provide a router that's legal
410 # for this agent and svcpart
411 my $error = $self->_check_ip_addr || $self->assign_router;
412 return $error if $error;
414 elsif ($self->routernum) {
415 return "Router ".$self->routernum." does not provide this service"
416 unless qsearchs('part_svc_router', {
418 routernum => $self->routernum
421 my $router = $self->router;
422 return "Router ".$self->routernum." does not serve this customer"
423 if $router->agentnum and $router->agentnum != $agentnum;
425 if ( $router->manual_addr ) {
429 my $addr_block = $self->addr_block;
430 unless ( $addr_block and $addr_block->manual_flag ) {
431 my $error = $self->assign_ip_addr;
432 return $error if $error;
436 my $error = $self->_check_ip_addr;
437 return $error if $error;
438 } # if $self->routernum
440 if ( $cust_pkg && ! $self->latitude && ! $self->longitude ) {
441 my $l = $cust_pkg->cust_location_or_main;
442 if ( $l->ship_latitude && $l->ship_longitude ) {
443 $self->latitude( $l->ship_latitude );
444 $self->longitude( $l->ship_longitude );
445 } elsif ( $l->latitude && $l->longitude ) {
446 $self->latitude( $l->latitude );
447 $self->longitude( $l->longitude );
456 Assign an IP address matching the selected router, and the selected block
466 if ( $self->blocknum and $self->addr_block->routernum == $self->routernum ) {
467 # simple case: user chose a block, find an address in that block
468 # (this overrides an existing IP address if it's not in the block)
469 @blocks = ($self->addr_block);
471 elsif ( $self->routernum ) {
472 @blocks = $self->router->auto_addr_block;
477 #warn "assigning ip address in blocks\n".join("\n",map{$_->cidr} @blocks)."\n";
479 foreach my $block ( @blocks ) {
480 if ( $self->ip_addr and $block->NetAddr->contains($self->NetAddr) ) {
481 # don't change anything
484 $ip_addr = $block->next_free_addr;
488 $self->set(ip_addr => $ip_addr->addr);
492 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;
529 # if (my $dup = qsearchs('svc_broadband', {
530 # ip_addr => $self->ip_addr,
531 # svcnum => {op=>'!=', value => $self->svcnum}
533 # return 'IP address conflicts with svcnum '.$dup->svcnum;
538 sub _check_duplicate {
544 @dup = $self->find_duplicates('global', 'ip_addr');
546 return "IP address in use (svcnum ".$dup[0]->svcnum.")";
548 @dup = $self->find_duplicates('global', 'mac_addr');
550 return "MAC address in use (svcnum ".$dup[0]->svcnum.")";
559 Returns a NetAddr::IP object containing the IP address of this service. The netmask
566 new NetAddr::IP ($self->ip_addr);
571 Returns the FS::addr_block record (i.e. the address block) for this broadband service.
577 qsearchs('addr_block', { blocknum => $self->blocknum });
582 Returns the FS::router record for this service.
588 qsearchs('router', { routernum => $self->routernum });
591 =item allowed_routers
593 Returns a list of allowed FS::router objects.
597 sub allowed_routers {
599 my $svcpart = $self->svcnum ? $self->cust_svc->svcpart : $self->svcpart;
600 my @r = map { $_->router } qsearch('part_svc_router',
601 { svcpart => $self->cust_svc->svcpart });
602 if ( $self->cust_main ) {
603 my $agentnum = $self->cust_main->agentnum;
604 return grep { !$_->agentnum or $_->agentnum == $agentnum } @r;
614 =item mac_addr_formatted CASE DELIMITER
616 Format the MAC address (for use by exports). If CASE starts with "l"
617 (for "lowercase"), it's returned in lowercase. DELIMITER is inserted
622 sub mac_addr_formatted {
624 my ($case, $delim) = @_;
625 my $addr = $self->mac_addr;
626 $addr = lc($addr) if $case =~ /^l/i;
627 join( $delim || '', $addr =~ /../g );
634 local($FS::svc_Common::noexport_hack) = 1;
636 # set routernum to addr_block.routernum
637 foreach my $self (qsearch('svc_broadband', {
638 blocknum => {op => '!=', value => ''},
641 my $addr_block = $self->addr_block;
642 my $ip_addr = $self->ip_addr;
643 my $routernum = $addr_block->routernum;
645 $self->set(routernum => $routernum);
646 my $error = $self->check;
647 # sanity check: don't allow this to change IP address or block
648 # (other than setting blocknum to null for a non-auto-assigned router)
649 if ( $self->ip_addr ne $ip_addr
650 or ($self->blocknum and $self->blocknum != $addr_block->blocknum)) {
651 warn "WARNING: Upgrading service ".$self->svcnum." would change its block/address; skipped.\n";
655 $error ||= $self->replace;
656 warn "WARNING: error assigning routernum $routernum to service ".$self->svcnum.
657 ":\n$error; skipped\n"
661 warn "svcnum ".$self->svcnum.
662 ": no routernum in address block ".$addr_block->cidr.", skipped\n";
672 The business with sb_field has been 'fixed', in a manner of speaking.
674 allowed_routers isn't agent virtualized because part_svc isn't agent
677 Having both routernum and blocknum as foreign keys is somewhat dubious.
681 FS::svc_Common, FS::Record, FS::addr_block,
682 FS::part_svc, schema.html from the base documentation.