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
|
package FS::nas;
use strict;
use base qw( FS::m2m_Common FS::Record );
use FS::Record qw( qsearch qsearchs dbh );
use FS::export_nas;
use FS::part_export;
=head1 NAME
FS::nas - Object methods for nas records
=head1 SYNOPSIS
use FS::nas;
$record = new FS::nas \%hash;
$record = new FS::nas { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::nas object represents a RADIUS client. FS::nas inherits from
FS::Record. The following fields are currently supported:
=over 4
=item nasnum - primary key
=item nasname - "NAS name", i.e. IP address
=item shortname - short descriptive name
=item type - the equipment vendor
=item ports
=item secret - the authentication secret for this client
=item server - virtual server name (optional)
=item community
=item description - a longer descriptive name
=item svcnum - the L<FS::svc_broadband> record that 'owns' this device
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new NAS. To add the NAS 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
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'nas'; }
=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 and remove all linked exports.
=cut
sub delete {
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $self = shift;
my $error = $self->process_m2m(
link_table => 'export_nas',
target_table => 'part_export',
params => []
) || $self->SUPER::delete;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit if $oldAutoCommit;
'';
}
=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.
To change the list of linked exports, see the C<export_nas> method.
=cut
sub replace {
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my ($self, $old) = @_;
$old ||= qsearchs('nas', { 'nasnum' => $self->nasnum });
my $error;
foreach my $part_export ( $self->part_export ) {
$error ||= $part_export->export_nas_replace($self, $old);
}
$error ||= $self->SUPER::replace($old);
if ( $error ) {
$dbh->rollback;
return $error;
}
$dbh->commit if $oldAutoCommit;
'';
}
=item check
Checks all fields to make sure this is a valid NAS. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('nasnum')
|| $self->ut_text('nasname')
|| $self->ut_textn('shortname')
|| $self->ut_text('type')
|| $self->ut_numbern('ports')
|| $self->ut_text('secret')
|| $self->ut_textn('server')
|| $self->ut_textn('community')
|| $self->ut_text('description')
|| $self->ut_foreign_keyn('svcnum', 'svc_broadband', 'svcnum')
;
return $error if $error;
$self->SUPER::check;
}
=item part_export
Return all L<FS::part_export> objects to which this NAS is being exported.
=cut
sub part_export {
my $self = shift;
map { qsearchs('part_export', { exportnum => $_->exportnum }) }
qsearch('export_nas', { nasnum => $self->nasnum})
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
