summaryrefslogtreecommitdiff
path: root/FS/FS/radius_attr.pm
blob: 1b7df2ee46c3563274d2e5c90c2d8e2f998c8784 (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
package FS::radius_attr;
use base qw( FS::Record );

use strict;
use vars qw( $noexport_hack );
use FS::Record qw( qsearch dbh );

$noexport_hack = 0;

=head1 NAME

FS::radius_attr - Object methods for radius_attr records

=head1 SYNOPSIS

  use FS::radius_attr;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

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

=over 4

=item attrnum - primary key

=item groupnum - L<FS::radius_group> to assign this attribute

=item attrname - Attribute name, as defined in the RADIUS server's dictionary

=item value - Attribute value

=item attrtype - 'C' (check) or 'R' (reply)

=item op - Operator (see L<http://wiki.freeradius.org/Operators>)

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record 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_attr'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.  If any sqlradius-type exports exist and have the 
C<export_attrs> option enabled, the new attribute will be exported to them.

=cut

sub insert {
  my $self = shift;
  my $error = $self->SUPER::insert;
  return $error if $error;
  return if $noexport_hack;

  foreach ( qsearch('part_export', {}) ) {
    next if !$_->option('export_attrs',1);
    $error = $_->export_attr_insert($self);
    return $error if $error;
  }

  '';
}


=item delete

Delete this record from the database.  Like C<insert>, this will delete 
the attribute from any attached RADIUS databases.

=cut

sub delete {
  my $self = shift;
  my $error;
  if ( !$noexport_hack ) {
    foreach ( qsearch('part_export', {}) ) {
      next if !$_->option('export_attrs',1);
      $error = $_->export_attr_delete($self);
      return $error if $error;
    }
  }
  
  $self->SUPER::delete;
}

=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

sub replace {
  my ($self, $old) = @_;
  $old ||= $self->replace_old;
  return 'can\'t change radius_attr.groupnum'
    if $self->groupnum != $old->groupnum;
  return ''
    unless grep { $self->$_ ne $old->$_ } qw(attrname value op attrtype);

  # don't attempt export on an invalid record
  my $error = $self->check;
  return $error if $error;

  # exportage
  $old->set('groupname', $old->radius_group->groupname);
  if ( !$noexport_hack ) {
    foreach ( qsearch('part_export', {}) ) {
      next if !$_->option('export_attrs',1);
      $error = $_->export_attr_replace($self, $old);
      return $error if $error;
    }
  }
  
  $self->SUPER::replace($old);
}


=item check

Checks all fields to make sure this is a valid record.  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('attrnum')
    || $self->ut_foreign_key('groupnum', 'radius_group', 'groupnum')
    || $self->ut_text('attrname')
    || $self->ut_text('value')
    || $self->ut_enum('attrtype', [ 'C', 'R' ])
  ;
  return $error if $error;

  my @ops = $self->ops($self->get('attrtype'));
  $self->set('op' => $ops[0]) if !$self->get('op');
  $error ||= $self->ut_enum('op', \@ops);
  
  return $error if $error;

  $self->SUPER::check;
}

=item radius_group

Returns the L<FS::radius_group> object to which this attribute applies.

=back

=head1 CLASS METHODS

=over 4

=item ops ATTRTYPE

Returns a list of all legal values of the "op" field.  ATTRTYPE must be C for 
check or R for reply.

=cut

my %ops = (
  C => [ '=', '==', ':=', '+=', '!=', '>', '>=', '<', '<=', '=~', '!~', '=*', '!*' ],
  R => [ '=', ':=', '+=' ],
);

sub ops {
  my $self = shift;
  my $attrtype = shift;
  return @{ $ops{$attrtype} };
}

=back

=cut

sub _upgrade_schema {
  my ($class, %opts) = @_;

  my $sql = '
    DELETE FROM radius_attr WHERE NOT EXISTS
      ( SELECT 1 FROM radius_group WHERE radius_group.groupnum = radius_attr.groupnum )
  ';

  my $sth = dbh->prepare($sql) or die dbh->errstr;
  $sth->execute or die $sth->errstr;
  '';
}

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;