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

use strict;
use FS::Record qw( dbh ); # qsearch qsearchs dbh );
use FS::reg_code_pkg;

=head1 NAME

FS::reg_code - One-time registration codes

=head1 SYNOPSIS

  use FS::reg_code;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::reg_code object is a one-time registration code.  FS::reg_code inherits
from FS::Record.  The following fields are currently supported:

=over 4

=item codenum - primary key

=item code - registration code string

=item agentnum - Agent (see L<FS::agent>)

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new registration code.  To add the code 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 { 'reg_code'; }

=item insert [ PKGPART_ARRAYREF ] 

Adds this record to the database.  If an arrayref of pkgparts
(see L<FS::part_pkg>) is specified, the appropriate reg_code_pkg records
(see L<FS::reg_code_pkg>) will be inserted.

If there is an error, returns the error, otherwise returns false.

=cut

sub insert {
  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 $error = $self->SUPER::insert;
  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
    return $error;
  }

  if ( @_ ) {
    my $pkgparts = shift;
    foreach my $pkgpart ( @$pkgparts ) {
      my $reg_code_pkg = new FS::reg_code_pkg ( {
        'codenum' => $self->codenum,
        'pkgpart' => $pkgpart,
      } );
      $error = $reg_code_pkg->insert;
      if ( $error ) {
        $dbh->rollback if $oldAutoCommit;
        return $error;
      }
    }
  }

  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
  '';

}

=item delete

Delete this record (and all associated reg_code_pkg records) from the database.

=cut

sub delete {
  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;

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

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

  $dbh->commit or die $dbh->errstr 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.

=cut

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

=item check

Checks all fields to make sure this is a valid registration code.  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('codenum')
    || $self->ut_alpha('code')
    || $self->ut_foreign_key('agentnum', 'agent', 'agentnum')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item part_pkg

Returns all package definitions (see L<FS::part_pkg> for this registration
code.

=cut

sub part_pkg {
  my $self = shift;
  map { $_->part_pkg } $self->reg_code_pkg;
}

=item reg_code_pkg

Returns all FS::reg_code_pkg records for this registration code.

=back

=head1 BUGS

Feeping creaturitis.

=head1 SEE ALSO

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

=cut

1;