summaryrefslogtreecommitdiff
path: root/FS/FS/o2m_Common.pm
blob: 915393ae9808832d94cff43dcba0617ac3808ccb (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
package FS::o2m_Common;

use strict;
use vars qw( $DEBUG $me );
use Carp;
use FS::Schema qw( dbdef );
use FS::Record qw( qsearch qsearchs dbh );

$DEBUG = 0;

$me = '[FS::o2m_Common]';

=head1 NAME

FS::o2m_Common - Mixin class for tables with a related table

=head1 SYNOPSIS

use FS::o2m_Common;

@ISA = qw( FS::o2m_Common FS::Record );

=head1 DESCRIPTION

FS::o2m_Common is intended as a mixin class for classes which have a
related table.

=head1 METHODS

=over 4

=item process_o2m OPTION => VALUE, ...

Available options:

table (required) - Table into which the records are inserted.

fields (required) - Arrayref of the field names in the "many" table.

params (required) - Hashref of keys and values, often passed as
C<scalar($cgi->Vars)> from a form. This will be scanned for keys of the form
"pkeyNN" (where pkey is the primary key column name, and NN is an integer).
Each of these designates one record in the "many" table. The contents of
that record will be taken from other parameters with the names
"pkeyNN_myfield" (where myfield is one of the fields in the 'fields'
array).

num_col (optional) - Name of the foreign key column in the "many" table, which
links to the primary key of the base table. If not specified, it is assumed
this has the same name as in the base table.

=cut

#a little more false laziness w/m2m_Common.pm than m2_name_Common.pm
# still, far from the worse of it.  at least we're a reuable mixin!
sub process_o2m {
  my( $self, %opt ) = @_;

  my $self_pkey = $self->dbdef_table->primary_key;
  my $link_sourcekey = $opt{'num_col'} || $self_pkey;

  my $hashref = {}; #$opt{'hashref'} || {};
  $hashref->{$link_sourcekey} = $self->$self_pkey();

  my $table = $self->_load_table($opt{'table'});
  my $table_pkey = dbdef->table($table)->primary_key;

#  my $link_static = $opt{'link_static'} || {};

  warn "$me processing o2m from ". $self->table. ".$link_sourcekey".
       " to $table\n"
    if $DEBUG;

  #if ( ref($opt{'params'}) eq 'ARRAY' ) {
  #  $opt{'params'} = { map { $_=>1 } @{$opt{'params'}} };
  #}

  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 @fields = grep { /^$table_pkey\d+$/ }
               keys %{ $opt{'params'} };

  my %edits = map  { $opt{'params'}->{$_} => $_ }
              grep { $opt{'params'}->{$_} }
              @fields;

  foreach my $del_obj (
    grep { ! $edits{$_->$table_pkey()} }
         $self->process_o2m_qsearch( $table, $hashref )
  ) {
    my $error = $del_obj->delete;
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

  foreach my $pkey_value ( keys %edits ) {
    my $old_obj = $self->process_o2m_qsearchs( $table, { %$hashref, $table_pkey => $pkey_value } );
    my $add_param = $edits{$pkey_value};
    my %hash = ( $table_pkey => $pkey_value,
                 map { $_ => $opt{'params'}->{$add_param."_$_"} }
                     @{ $opt{'fields'} }
               );
    &{ $opt{'hash_callback'} }( \%hash, $old_obj ) if $opt{'hash_callback'};
    #next unless grep { $_ =~ /\S/ } values %hash;

    my $new_obj = "FS::$table"->new( { %$hashref, %hash } );
    my $error = $new_obj->replace($old_obj);
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

  foreach my $add_param ( grep { ! $opt{'params'}->{$_} } @fields ) {

    my %hash = map { $_ => $opt{'params'}->{$add_param."_$_"} }
               @{ $opt{'fields'} };
    &{ $opt{'hash_callback'} }( \%hash ) if $opt{'hash_callback'};
    next unless grep { $_ =~ /\S/ } values %hash;

    my $add_obj = "FS::$table"->new( { %$hashref, %hash } );
    my $error = $add_obj->insert;
    if ( $error ) {
      $dbh->rollback if $oldAutoCommit;
      return $error;
    }
  }

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

sub process_o2m_qsearch  { my $self = shift; qsearch(  @_ ); }
sub process_o2m_qsearchs { my $self = shift; qsearchs( @_ ); }

sub _load_table {
  my( $self, $table ) = @_;
  eval "use FS::$table";
  die $@ if $@;
  $table;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>

=cut

1;