1 package SL::DB::Helper::TransNumberGenerator;
5 use parent qw(Exporter);
6 our @EXPORT = qw(get_next_trans_number create_trans_number);
9 use List::Util qw(max);
12 use SL::PrefixedNumber;
15 SL::DB::Manager::Order->type_filter($_[0]);
19 SL::DB::Manager::DeliveryOrder->type_filter($_[0]);
23 SL::DB::Manager::Part->type_filter($_[0]);
26 my %specs = ( ar => { number_column => 'invnumber', },
27 sales_quotation => { number_column => 'quonumber', number_range_column => 'sqnumber', scoping => \&oe_scoping, },
28 sales_order => { number_column => 'ordnumber', number_range_column => 'sonumber', scoping => \&oe_scoping, },
29 request_quotation => { number_column => 'quonumber', number_range_column => 'rfqnumber', scoping => \&oe_scoping, },
30 purchase_order => { number_column => 'ordnumber', number_range_column => 'ponumber', scoping => \&oe_scoping, },
31 sales_delivery_order => { number_column => 'donumber', number_range_column => 'sdonumber', scoping => \&do_scoping, },
32 purchase_delivery_order => { number_column => 'donumber', number_range_column => 'pdonumber', scoping => \&do_scoping, },
33 customer => { number_column => 'customernumber', number_range_column => 'customernumber', },
34 vendor => { number_column => 'vendornumber', number_range_column => 'vendornumber', },
35 part => { number_column => 'partnumber', number_range_column => 'articlenumber', scoping => \&parts_scoping, },
36 service => { number_column => 'partnumber', number_range_column => 'servicenumber', scoping => \&parts_scoping, },
37 assembly => { number_column => 'partnumber', number_range_column => 'assemblynumber', scoping => \&parts_scoping, },
40 sub get_next_trans_number {
41 my ($self, %params) = @_;
43 my $spec_type = $specs{ $self->meta->table } ? $self->meta->table : $self->type;
44 my $spec = $specs{ $spec_type } || croak("Unsupported class " . ref($self));
46 my $number_column = $spec->{number_column};
47 my $number = $self->$number_column;
48 my $number_range_column = $spec->{number_range_column} || $number_column;
49 my $scoping_conditions = $spec->{scoping};
50 my $fill_holes_in_range = !$spec->{keep_holes_in_range};
52 return $number if $self->id && $number;
54 require SL::DB::Default;
55 require SL::DB::Business;
57 my %conditions = ( query => [ $scoping_conditions ? $scoping_conditions->($spec_type) : () ] );
58 my %conditions_for_in_use = ( query => [ $scoping_conditions ? $scoping_conditions->($spec_type) : () ] );
61 if ($spec_type =~ m{^(?:customer|vendor)$}) {
62 $business = $self->business_id ? SL::DB::Business->new(id => $self->business_id)->load : $self->business;
63 if ($business && (($business->customernumberinit // '') ne '')) {
64 $number_range_column = 'customernumberinit';
65 push @{ $conditions{query} }, ( business_id => $business->id );
69 push @{ $conditions{query} }, ( business_id => undef );
74 # Lock both the table where the new number is stored and the range
75 # table. The storage table has to be locked first in order to
76 # prevent deadlocks as the legacy code in SL/TransNumber.pm locks it
79 # For the storage table we have to use a full lock in order to
80 # prevent insertion of new entries while this routine is still
81 # working. For the range table we only need a row-level lock,
82 # therefore we're re-loading the row.
83 $self->db->dbh->do("LOCK " . $self->meta->table) || die $self->db->dbh->errstr;
85 my ($query_in_use, $bind_vals_in_use) = Rose::DB::Object::QueryBuilder::build_select(
86 dbh => $self->db->dbh,
87 select => $number_column,
88 tables => [ $self->meta->table ],
89 columns => { $self->meta->table => [ $self->meta->column_names ] },
91 %conditions_for_in_use,
94 my @numbers = do { no warnings 'once'; SL::DBUtils::selectall_array_query($::form, $self->db->dbh, $query_in_use, @{ $bind_vals_in_use || [] }) };
95 my %numbers_in_use = map { ( $_ => 1 ) } @numbers;
97 my $range_table = ($business ? $business : SL::DB::Default->get)->load(for_update => 1);
99 my $start_number = $range_table->$number_range_column;
100 $start_number = $range_table->articlenumber if ($number_range_column eq 'assemblynumber') && (length($start_number) < 1);
101 my $sequence = SL::PrefixedNumber->new(number => $start_number // 0);
103 if (!$fill_holes_in_range) {
104 $sequence->set_to_max(@numbers) ;
107 my $new_number = $sequence->get_next;
108 $new_number = $sequence->get_next while $numbers_in_use{$new_number};
110 $range_table->update_attributes($number_range_column => $new_number) if $params{update_defaults};
111 $self->$number_column($new_number) if $params{update_record};
116 sub create_trans_number {
117 my ($self, %params) = @_;
119 return $self->get_next_trans_number(update_defaults => 1, update_record => 1, %params);
132 SL::DB::Helper::TransNumberGenerator - A mixin for creating unique record numbers
138 =item C<get_next_trans_number %params>
140 Generates a new unique record number for the mixing class. Each record
141 type (invoices, sales quotations, purchase orders etc) has its own
142 number range. Within these ranges all numbers should be unique. The
143 table C<defaults> contains the last record number assigned for all of
146 This function contains hard-coded knowledge about the modules it can
147 be mixed into. This way the models themselves don't have to contain
148 boilerplate code for the details like the the number range column's
149 name in the C<defaults> table.
151 The process of creating a unique number involves the following steps:
153 At first all existing record numbers for the current type are
154 retrieved from the database as well as the last number assigned from
155 the table C<defaults>.
157 The next step is separating the number range from C<defaults> into two
158 parts: an optional non-numeric prefix and its numeric suffix. The
159 prefix, if present, will be kept intact.
161 Now the number itself is increased as often as neccessary to create a
162 unique one by comparing the generated numbers with the existing ones
163 retrieved in the first step. In this step gaps in the assigned numbers
164 are filled for all currently supported tables.
166 After creating the unique record number this function can update
167 C<$self> and the C<defaults> table if requested. This is controlled
168 with the following parameters:
172 =item * C<update_record>
174 Determines whether or not C<$self>'s record number field is set to the
175 newly generated number. C<$self> will not be saved even if this
176 parameter is trueish. Defaults to false.
178 =item * C<update_defaults>
180 Determines whether or not the number range value in the C<defaults>
181 table should be updated. Unlike C<$self> the C<defaults> table will be
182 saved. Defaults to false.
186 Always returns the newly generated number. This function cannot fail
187 and return a value. If it fails then it is due to exceptions.
189 =item C<create_trans_number %params>
191 Calls and returns L</get_next_trans_number> with the parameters
192 C<update_defaults = 1> and C<update_record = 1>. C<%params> is passed
199 This mixin exports all of its functions: L</get_next_trans_number> and
200 L</create_trans_number>. There are no optional exports.
208 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>