use base qw( FS::geocode_Mixin FS::Record );
use strict;
-use vars qw( $import $DEBUG $conf $label_prefix );
+use vars qw( $import $DEBUG $conf $label_prefix $allow_location_edit );
use Data::Dumper;
use Date::Format qw( time2str );
use FS::UID qw( dbh driver_name );
use FS::part_export;
use FS::GeocodeCache;
+# Essential fields. Can't be modified in place, will be considered in
+# deciding if a location is "new", and (because of that) can't have
+# leading/trailing whitespace.
+my @essential = (qw(custnum address1 address2 city county state zip country
+ location_number location_type location_kind disabled));
+
$import = 0;
$DEBUG = 0;
=head1 DESCRIPTION
-An FS::cust_location object represents a customer location. FS::cust_location
-inherits from FS::Record. The following fields are currently supported:
+An FS::cust_location object represents a customer (or prospect) location.
+FS::cust_location inherits from FS::Record. The following fields are currently
+supported:
=over 4
=item custnum
-custnum
+Customer (see L<FS::cust_main>).
+
+=item prospectnum
+
+Prospect (see L<FS::prospect_main>).
+
+=item locationname
+
+Optional location name.
=item address1
Geocode
+=item latitude
+
+=item longitude
+
+=item coord_auto
+
+Flag indicating whether coordinates were obtained automatically or manually
+entered
+
+=item addr_clean
+
+Flag indicating whether address has been normalized
+
+=item censustract
+
+=item censusyear
+
=item district
Tax district code (optional)
warn "find_or_insert:\n".Dumper($self) if $DEBUG;
- my @essential = (qw(custnum address1 address2 city county state zip country
- location_number location_type location_kind disabled));
-
if ($conf->exists('cust_main-no_city_in_address')) {
warn "Warning: passed city to find_or_insert when cust_main-no_city_in_address is configured, ignoring it"
if $self->get('city');
delete $nonempty{'locationnum'};
my %hash = map { $_ => $self->get($_) } @essential;
+ foreach (values %hash) {
+ s/^\s+//;
+ s/\s+$//;
+ }
my @matches = qsearch('cust_location', \%hash);
# we no longer reject matches for having different values in nonessential
# it's a prospect location, then there are no active packages, no billing
# history, no taxes, and in general no reason to keep the old location
# around.
- if ( $self->custnum ) {
+ if ( !$allow_location_edit and $self->custnum ) {
foreach (qw(address1 address2 city state zip country)) {
if ( $self->$_ ne $old->$_ ) {
return "can't change cust_location field $_";
return '' if $self->disabled; # so that disabling locations never fails
+ # whitespace in essential fields leads to problems figuring out if a
+ # record is "new"; get rid of it.
+ $self->trim_whitespace(@essential);
+
my $error =
$self->ut_numbern('locationnum')
|| $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
}
-=item move_to
+=item move_pkgs
+
+Returns array of cust_pkg objects that would have their location
+updated by L</move_to> (all packages that have this location as
+their service address, and aren't canceled, and aren't supplemental
+to another package, and aren't one-time charges that have already been charged.)
+
+=cut
+
+sub move_pkgs {
+ my $self = shift;
+ my @pkgs = ();
+ # find all packages that have the old location as their service address,
+ # and aren't canceled,
+ # and aren't supplemental to another package
+ # and aren't one-time charges that have already been charged
+ foreach my $cust_pkg (
+ qsearch('cust_pkg', {
+ 'locationnum' => $self->locationnum,
+ 'cancel' => '',
+ 'main_pkgnum' => '',
+ })
+ ) {
+ next if $cust_pkg->part_pkg->freq eq '0'
+ and ($cust_pkg->setup || 0) > 0;
+ push @pkgs, $cust_pkg;
+ }
+ return @pkgs;
+}
+
+=item move_to NEW [ move_pkgs => \@move_pkgs ]
Takes a new L<FS::cust_location> object. Moves all packages that use the
existing location to the new one, then sets the "disabled" flag on the old
location. Returns nothing on success, an error message on error.
+Use option I<move_pkgs> to override the list of packages to update
+(see L</move_pkgs>.)
+
=cut
sub move_to {
my $old = shift;
my $new = shift;
+ my %opt = @_;
warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG;
return '';
}
- # find all packages that have the old location as their service address,
- # and aren't canceled,
- # and aren't supplemental to another package.
- my @pkgs = qsearch('cust_pkg', {
- 'locationnum' => $old->locationnum,
- 'cancel' => '',
- 'main_pkgnum' => '',
- });
- foreach my $cust_pkg (@pkgs) {
- # don't move one-time charges that have already been charged
- next if $cust_pkg->part_pkg->freq eq '0'
- and ($cust_pkg->setup || 0) > 0;
+ my @pkgs;
+ if ($opt{'move_pkgs'}) {
+ @pkgs = @{$opt{'move_pkgs'}};
+ my $pkgerr;
+ foreach my $pkg (@pkgs) {
+ my $pkgnum = $pkg->pkgnum;
+ $pkgerr = "cust_pkg $pkgnum has already been charged"
+ if $pkg->part_pkg->freq eq '0'
+ and ($pkg->setup || 0) > 0;
+ $pkgerr = "cust_pkg $pkgnum is supplemental"
+ if $pkg->main_pkgnum;
+ $pkgerr = "cust_pkg $pkgnum already cancelled"
+ if $pkg->cancel;
+ $pkgerr = "cust_pkg $pkgnum does not use this location"
+ unless $pkg->locationnum eq $old->locationnum;
+ last if $pkgerr;
+ }
+ if ($pkgerr) {
+ $dbh->rollback if $oldAutoCommit;
+ return "Cannot update package location: $pkgerr";
+ }
+ } else {
+ @pkgs = $old->move_pkgs;
+ }
+ foreach my $cust_pkg (@pkgs) {
$error = $cust_pkg->change(
'locationnum' => $new->locationnum,
'keep_dates' => 1
close $log;
}
+sub _upgrade_data {
+ my $class = shift;
+
+ # are we going to need to update tax districts?
+ my $use_districts = $conf->config('tax_district_method') ? 1 : 0;
+
+ # trim whitespace on records that need it
+ local $allow_location_edit = 1;
+ foreach my $field (@essential) {
+ next if $field eq 'custnum';
+ next if $field eq 'disabled';
+ foreach my $location (qsearch({
+ table => 'cust_location',
+ extra_sql => " WHERE disabled IS NULL AND ($field LIKE ' %' OR $field LIKE '% ')"
+ })) {
+ my $error = $location->replace;
+ die "$error (fixing whitespace in $field, locationnum ".$location->locationnum.')'
+ if $error;
+
+ if ( $use_districts ) {
+ my $queue = new FS::queue {
+ 'job' => 'FS::geocode_Mixin::process_district_update'
+ };
+ $error = $queue->insert( 'FS::cust_location' => $location->locationnum );
+ die $error if $error;
+ }
+ } # foreach $location
+ } # foreach $field
+ '';
+}
+
=head1 BUGS
=head1 SEE ALSO