1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
package FS::tower;
use base qw( FS::o2m_Common FS::Record );
use strict;
use List::Util qw( max );
use FS::Record qw( qsearch qsearchs );
use FS::tower_sector;
=head1 NAME
FS::tower - Object methods for tower records
=head1 SYNOPSIS
use FS::tower;
$record = new FS::tower \%hash;
$record = new FS::tower { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::tower object represents a tower. FS::tower inherits from
FS::Record. The following fields are currently supported:
=over 4
=item towernum
primary key
=item towername
Tower name
=item disabled
Disabled flag, empty or 'Y'
=item up_rate_limit
Up Rate limit for towner
=item down_rate_limit
Down Rate limit for tower
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new tower. To add the tower to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
sub table { 'tower'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=item check
Checks all fields to make sure this is a valid tower. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_numbern('towernum')
|| $self->ut_text('towername')
|| $self->ut_enum('disabled', [ '', 'Y' ])
|| $self->ut_coordn('latitude')
|| $self->ut_coordn('longitude')
|| $self->ut_enum('coord_auto', [ '', 'Y' ])
|| $self->ut_floatn('altitude')
|| $self->ut_floatn('height')
|| $self->ut_floatn('veg_height')
|| $self->ut_alphan('color')
|| $self->ut_numbern('up_rate_limit')
|| $self->ut_numbern('down_rate_limit')
;
return $error if $error;
$self->SUPER::check;
}
=item default_sector
Returns the default sector.
=cut
sub default_sector {
my $self = shift;
qsearchs('tower_sector', { towernum => $self->towernum,
sectorname => '_default' });
}
=item tower_sector
Returns the sectors of this tower, as FS::tower_sector objects (see
L<FS::tower_sector>), except for the default sector.
=cut
sub tower_sector {
my $self = shift;
qsearch({
'table' => 'tower_sector',
'hashref' => { 'towernum' => $self->towernum,
'sectorname' => { op => '!=', value => '_default' },
},
'order_by' => 'ORDER BY sectorname',
});
}
=item process_o2m
Wrapper for the default method (see L<FS::o2m_Common>) to manage the
default sector.
=cut
sub process_o2m {
my $self = shift;
my %opt = @_;
my $params = $opt{params};
# Adjust to make sure our default sector is in the list.
my $default_sector = $self->default_sector
or warn "creating default sector for tower ".$self->towernum."\n";
my $idx = max(0, map { $_ =~ /^sectornum(\d+)$/ ? $1 : 0 } keys(%$params));
$idx++; # append to the param list
my $prefix = "sectornum$idx";
# empty sectornum will create the default sector if it doesn't exist yet
$params->{$prefix} = $default_sector ? $default_sector->sectornum : '';
$params->{$prefix.'_sectorname'} = '_default';
$params->{$prefix.'_ip_addr'} = $params->{'default_ip_addr'} || '';
$self->SUPER::process_o2m(%opt);
}
sub _upgrade_data {
# Create default sectors for any tower that doesn't have one.
# Shouldn't do any harm if they're missing, but just for completeness.
my $class = shift;
foreach my $tower (qsearch('tower',{})) {
next if $tower->default_sector;
my $sector = FS::tower_sector->new({
towernum => $tower->towernum,
sectorname => '_default',
ip_addr => '',
});
my $error = $sector->insert;
die "error creating default sector: $error\n" if $error;
}
'';
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::tower_sector>, L<FS::svc_broadband>, L<FS::Record>
=cut
1;
|
