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

use strict;
use FS::Record qw( qsearch qsearchs );
use FS::svc_acct;
use FS::radius_group;

=head1 NAME

FS::radius_usergroup - Object methods for radius_usergroup records

=head1 SYNOPSIS

  use FS::radius_usergroup;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::radius_usergroup object links an account (see L<FS::svc_acct>) with a
RADIUS group (see L<FS::radius_group>).  FS::radius_usergroup inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item usergroupnum - primary key

=item svcnum - Account (see L<FS::svc_acct>).

=item groupnum - RADIUS group (see L<FS::radius_group>).

=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_usergroup'; }

=item insert

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

=cut

#inherited from FS::Record

=item delete

Delete this record from the database.

=cut

#inherited from FS::Record

=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

#inherited from FS::Record

=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 $svcnum = $self->svcnum;
  die "radius_usergroup.groupname is deprecated" if $self->groupname;

  $self->ut_numbern('usergroupnum')
    || ( $self->ut_foreign_key('svcnum','svc_acct','svcnum')
      && $self->ut_foreign_key('svcnum','svc_broadband','svcnum')
      && "Can't find radius_usergroup.svcnum $svcnum in svc_acct.svcnum or svc_broadband.svcnum" ) 
    || $self->ut_foreign_key('groupnum','radius_group','groupnum')
    || $self->SUPER::check
  ;
}

=item svc_x

Returns the account associated with this record (see L<FS::svc_acct> and 
L<FS::svc_broadband>).

=cut

sub svc_acct {
  my $self = shift;
  qsearchs('svc_acct', { svcnum => $self->svcnum } ) ||
  qsearchs('svc_broadband', { svcnum => $self->svcnum } )
}

=item radius_group

Returns the RADIUS group associated with this record (see L<FS::radius_group>).

=cut

sub _upgrade_data {  #class method
  my ($class, %opts) = @_;

  my %group_cache = map { $_->groupname => $_->groupnum } 
                                                qsearch('radius_group', {});

  my @radius_usergroup = qsearch('radius_usergroup', {} );
  my $error = '';
  foreach my $rug ( @radius_usergroup ) {
        my $groupname = $rug->groupname;
        next unless $groupname;
        unless(defined($group_cache{$groupname})) {
            my $g = new FS::radius_group {
                            'groupname' => $groupname,
                            'description' => $groupname,
                            };
            $error = $g->insert;
            die $error if $error;
            $group_cache{$groupname} = $g->groupnum;
        }
        $rug->groupnum($group_cache{$groupname});
        $rug->groupname('');
        $error = $rug->replace;
        die $error if $error;
  }
}

=back

=head1 SEE ALSO

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

=cut

1;