1 package FS::svc_broadband;
4 use vars qw(@ISA $conf);
5 use FS::Record qw( qsearchs qsearch dbh );
11 @ISA = qw( FS::svc_Common );
13 $FS::UID::callback{'FS::svc_broadband'} = sub {
19 FS::svc_broadband - Object methods for svc_broadband records
23 use FS::svc_broadband;
25 $record = new FS::svc_broadband \%hash;
26 $record = new FS::svc_broadband { 'column' => 'value' };
28 $error = $record->insert;
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
36 $error = $record->suspend;
38 $error = $record->unsuspend;
40 $error = $record->cancel;
44 An FS::svc_broadband object represents a 'broadband' Internet connection, such
45 as a DSL, cable modem, or fixed wireless link. These services are assumed to
46 have the following properties:
48 FS::svc_broadband inherits from FS::svc_Common. The following fields are
53 =item svcnum - primary key
55 =item blocknum - see FS::addr_block
58 speed_up - maximum upload speed, in bits per second. If set to zero, upload
59 speed will be unlimited. Exports that do traffic shaping should handle this
60 correctly, and not blindly set the upload speed to zero and kill the customer's
64 speed_down - maximum download speed, as above
66 =item ip_addr - the customer's IP address. If the customer needs more than one
67 IP address, set this to the address of the customer's router. As a result, the
68 customer's router will have the same address for both its internal and external
69 interfaces thus saving address space. This has been found to work on most NAT
80 Creates a new svc_broadband. To add the record to the database, see
83 Note that this stores the hash reference, not a distinct copy of the hash it
84 points to. You can ask the object for a copy with the I<hash> method.
90 'name' => 'Broadband',
91 'name_plural' => 'Broadband services',
92 'longname_plural' => 'Fixed (username-less) broadband services',
93 'display_weight' => 50,
94 'cancel_weight' => 70,
96 'description' => 'Descriptive label for this particular device.',
97 'speed_down' => 'Maximum download speed for this service in Kbps. 0 denotes unlimited.',
98 'speed_up' => 'Maximum upload speed for this service in Kbps. 0 denotes unlimited.',
99 'ip_addr' => 'IP address. Leave blank for automatic assignment.',
100 'blocknum' => 'Address block.',
105 sub table { 'svc_broadband'; }
107 =item search_sql STRING
109 Class method which returns an SQL fragment to search for the given string.
114 my( $class, $string ) = @_;
115 if ( $string =~ /^(\d{1,3}\.){3}\d{1,3}$/ ) {
116 $class->search_sql_field('ip_addr', $string );
124 Returns the IP address.
133 =item insert [ , OPTION => VALUE ... ]
135 Adds this record to the database. If there is an error, returns the error,
136 otherwise returns false.
138 The additional fields pkgnum and svcpart (see FS::cust_svc) should be
139 defined. An FS::cust_svc record will be created and inserted.
141 Currently available options are: I<depend_jobnum>
143 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
144 jobnums), all provisioning jobs will have a dependancy on the supplied
145 jobnum(s) (they will not run until the specific job(s) complete(s)).
149 # Standard FS::svc_Common::insert
153 Delete this record from the database.
157 # Standard FS::svc_Common::delete
159 =item replace OLD_RECORD
161 Replaces the OLD_RECORD with this one in the database. If there is an error,
162 returns the error, otherwise returns false.
166 # Standard FS::svc_Common::replace
170 Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
174 Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
178 Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
182 Checks all fields to make sure this is a valid broadband service. If there is
183 an error, returns the error, otherwise returns false. Called by the insert
190 my $x = $self->setfixed;
192 return $x unless ref($x);
195 $self->ut_numbern('svcnum')
196 || $self->ut_foreign_key('blocknum', 'addr_block', 'blocknum')
197 || $self->ut_textn('description')
198 || $self->ut_number('speed_up')
199 || $self->ut_number('speed_down')
200 || $self->ut_ipn('ip_addr')
201 || $self->ut_hexn('mac_addr')
202 || $self->ut_hexn('auth_key')
203 || $self->ut_coordn('latitude', -90, 90)
204 || $self->ut_coordn('longitude', -180, 180)
205 || $self->ut_sfloatn('altitude')
206 || $self->ut_textn('vlan_profile')
208 return $error if $error;
210 if($self->speed_up < 0) { return 'speed_up must be positive'; }
211 if($self->speed_down < 0) { return 'speed_down must be positive'; }
213 if (not($self->ip_addr) or $self->ip_addr eq '0.0.0.0') {
214 my $next_addr = $self->addr_block->next_free_addr;
216 $self->ip_addr($next_addr->addr);
218 return "No free addresses in addr_block (blocknum: ".$self->blocknum.")";
222 # This should catch errors in the ip_addr. If it doesn't,
223 # they'll almost certainly not map into the block anyway.
224 my $self_addr = $self->NetAddr; #netmask is /32
225 return ('Cannot parse address: ' . $self->ip_addr) unless $self_addr;
227 my $block_addr = $self->addr_block->NetAddr;
228 unless ($block_addr->contains($self_addr)) {
229 return 'blocknum '.$self->blocknum.' does not contain address '.$self->ip_addr;
232 my $router = $self->addr_block->router
233 or return 'Cannot assign address from unallocated block:'.$self->addr_block->blocknum;
234 if(grep { $_->routernum == $router->routernum} $self->allowed_routers) {
237 return 'Router '.$router->routernum.' cannot provide svcpart '.$self->svcpart;
245 Returns a NetAddr::IP object containing the IP address of this service. The netmask
252 return new NetAddr::IP ($self->ip_addr);
257 Returns the FS::addr_block record (i.e. the address block) for this broadband service.
264 return qsearchs('addr_block', { blocknum => $self->blocknum });
269 =item allowed_routers
271 Returns a list of allowed FS::router objects.
275 sub allowed_routers {
278 return map { $_->router } qsearch('part_svc_router', { svcpart => $self->svcpart });
283 The business with sb_field has been 'fixed', in a manner of speaking.
287 FS::svc_Common, FS::Record, FS::addr_block,
288 FS::part_svc, schema.html from the base documentation.