summaryrefslogtreecommitdiff
path: root/FS/FS/radius_group.pm
blob: 21ce25f37d2b4d4f5eba32241e77891dd55df81b (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
package FS::radius_group;
use base qw( FS::o2m_Common FS::Record );

use strict;
use FS::Record qw( qsearch dbh );
use FS::radius_attr;

=head1 NAME

FS::radius_group - Object methods for radius_group records

=head1 SYNOPSIS

  use FS::radius_group;

  $record = new FS::radius_group \%hash;
  $record = new FS::radius_group { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::radius_group object represents a RADIUS group.  FS::radius_group inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item groupnum

primary key

=item groupname

groupname

=item description

description

=item priority

priority - for export

=item speed_up, speed_down - connection speeds in bits per second.  Some 
exports may use this to generate appropriate RADIUS attributes.

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new RADIUS group.  To add the RADIUS group 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 { 'radius_group'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

sub delete {
  # okay, I guess we support it now
  my $self = shift;
  local $SIG{HUP} = 'IGNORE';
  local $SIG{INT} = 'IGNORE';
  local $SIG{QUIT} = 'IGNORE';
  local $SIG{TERM} = 'IGNORE';
  local $SIG{TSTP} = 'IGNORE';
  local $SIG{PIPE} = 'IGNORE';

  my $oldAutoCommit = $FS::UID::AutoCommit;
  local $FS::UID::AutoCommit = 0;
  my $dbh = dbh;

  my $groupnum = $self->groupnum;
  my $error = $self->process_o2m(
                'table' => 'radius_usergroup',
                'num_col' => 'groupnum',
                'fields' => ['groupnum'], # just delete them
                'params' => {},
              ) || $self->SUPER::delete(@_);

  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
    return $error;
  }

  foreach my $part_svc_column (
    qsearch('part_svc_column', { columnname => 'usergroup' }) 
  ) {
    my $new_values = join(',', 
      grep { $_ != $groupnum } split(',', $part_svc_column->columnvalue)
    );
    next if $new_values eq $part_svc_column->columnvalue;
    $part_svc_column->set(columnvalue => $new_values);
    $error = $part_svc_column->replace;
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

  foreach my $radius_attr ( $self->radius_attr ) {
    $error = $radius_attr->delete;
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

  dbh->commit;
  '';
}

=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.

=cut

# To keep these things from proliferating, we will follow the same 
# export/noexport switches that radius_attr uses.  If you _don't_ use
# Freeside to maintain your RADIUS group attributes, then it probably 
# shouldn't try to rename groups either.

sub replace {
  my ($self, $old) = @_;
  $old ||= $self->replace_old;

  my $error = $self->check;
  return $error if $error;

  if ( !$FS::radius_attr::noexport_hack ) {
    foreach ( qsearch('part_export', {}) ) {
      next if !$_->option('export_attrs',1);
      $error = $_->export_group_replace($self, $old);
      return $error if $error;
    }
  }

  $self->SUPER::replace($old);
}

=item check

Checks all fields to make sure this is a valid RADIUS group.  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('groupnum')
    || $self->ut_text('groupname')
    || $self->ut_textn('description')
    || $self->ut_numbern('priority')
    || $self->ut_numbern('speed_up')
    || $self->ut_numbern('speed_down')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item long_description

Returns a description for this group consisting of its description field, 
if any, and the RADIUS group name.

=cut

sub long_description {
    my $self = shift;
    $self->description ? $self->description . " (". $self->groupname . ")"
                       : $self->groupname;
}

=item radius_attr

Returns all L<FS::radius_attr> objects (check and reply attributes) for 
this group.

=cut

sub radius_attr {
  my $self = shift;
  qsearch({
      table   => 'radius_attr', 
      hashref => {'groupnum' => $self->groupnum },
      order_by  => 'ORDER BY attrtype, attrname',
  })
}

=back

=head1 BUGS

This isn't export-specific (i.e. groups are globally unique, as opposed to being
unique per-export).

=head1 SEE ALSO

L<FS::radius_usergroup>, L<FS::Record>, schema.html from the base documentation.

=cut

1;