X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_location.pm;h=eb4a7239f1b54574903bfda746b322106ba3ab47;hb=a0e00fa0547e99893c735ab3dbdacdb2bb054f5a;hp=d772dab0897b9db7357827dd49c4072c6c92924a;hpb=e6210bad824b2efc0a2d54abe8fc79093e7cc5ed;p=freeside.git diff --git a/FS/FS/cust_location.pm b/FS/FS/cust_location.pm index d772dab08..eb4a7239f 100644 --- a/FS/FS/cust_location.pm +++ b/FS/FS/cust_location.pm @@ -2,7 +2,7 @@ package FS::cust_location; use base qw( FS::geocode_Mixin FS::Record ); use strict; -use vars qw( $import ); +use vars qw( $import $DEBUG ); use Locale::Country; use FS::UID qw( dbh driver_name ); use FS::Record qw( qsearch qsearchs ); @@ -10,9 +10,15 @@ use FS::Conf; use FS::prospect_main; use FS::cust_main; use FS::cust_main_county; +use FS::GeocodeCache; +use Date::Format qw( time2str ); + +use Data::Dumper; $import = 0; +$DEBUG = 0; + =head1 NAME FS::cust_location - Object methods for cust_location records @@ -118,17 +124,9 @@ address1, address2, city, county, state, zip, country, location_number, location_type, location_kind. Disabled locations will be found only if this location is set to disabled. -If 'coord_auto' is null, and latitude and longitude are not null, then -latitude and longitude are also essential fields. - -All other fields are considered "non-essential". If a non-essential field is -empty in this location, it will be ignored in determining whether an existing -location matches. - -If a non-essential field is non-empty in this location, existing locations -that contain a different non-empty value for that field will not match. An -existing location in which the field is I will match, but will be -updated in-place with the value of that field. +All other fields are considered "non-essential" and will be ignored in +finding a matching location. If the existing location doesn't match +in these fields, it will be updated in-place to match. Returns an error string if inserting or updating a location failed. @@ -139,14 +137,17 @@ It is unfortunately hard to determine if this created a new location or not. sub find_or_insert { my $self = shift; + 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 ( !$self->coord_auto and $self->latitude and $self->longitude ) { - push @essential, qw(latitude longitude); - # but NOT coord_auto; if the latitude and longitude match the geocoded - # values then that's good enough - } + # I don't think this is necessary + #if ( !$self->coord_auto and $self->latitude and $self->longitude ) { + # push @essential, qw(latitude longitude); + # # but NOT coord_auto; if the latitude and longitude match the geocoded + # # values then that's good enough + #} # put nonempty, nonessential fields/values into this hash my %nonempty = map { $_ => $self->get($_) } @@ -157,28 +158,20 @@ sub find_or_insert { my %hash = map { $_ => $self->get($_) } @essential; my @matches = qsearch('cust_location', \%hash); - # consider candidate locations - MATCH: foreach my $old (@matches) { - my $reject = 0; + # we no longer reject matches for having different values in nonessential + # fields; we just alter the record to match + if ( @matches ) { + my $old = $matches[0]; + warn "found existing location #".$old->locationnum."\n" if $DEBUG; foreach my $field (keys %nonempty) { - my $old_value = $old->get($field); - if ( length($old_value) > 0 ) { - if ( $field eq 'latitude' or $field eq 'longitude' ) { - # special case, because these are decimals - if ( abs($old_value - $nonempty{$field}) > 0.000001 ) { - $reject = 1; - } - } elsif ( $old_value ne $nonempty{$field} ) { - $reject = 1; - } - } else { - # it's empty in $old, has a value in $self + if ($old->get($field) ne $nonempty{$field}) { + warn "altering $field to match requested location" if $DEBUG; $old->set($field, $nonempty{$field}); } - next MATCH if $reject; } # foreach $field if ( $old->modified ) { + warn "updating non-essential fields\n" if $DEBUG; my $error = $old->replace; return $error if $error; } @@ -190,6 +183,7 @@ sub find_or_insert { } # didn't find a match + warn "not found; inserting new location\n" if $DEBUG; return $self->insert; } @@ -257,12 +251,12 @@ and replace methods. =cut -#some false laziness w/cust_main, but since it should eventually lose these -#fields anyway... sub check { my $self = shift; my $conf = new FS::Conf; + return '' if $self->disabled; # so that disabling locations never fails + my $error = $self->ut_numbern('locationnum') || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum') @@ -405,6 +399,8 @@ location. Returns nothing on success, an error message on error. sub move_to { my $old = shift; my $new = shift; + + warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -427,6 +423,11 @@ sub move_to { $dbh->rollback if $oldAutoCommit; return "Error creating location: $error"; } + } elsif ( $new->locationnum == $old->locationnum ) { + # then they're the same location; the normal result of doing a minor + # location edit + $dbh->commit if $oldAutoCommit; + return ''; } # find all packages that have the old location as their service address, @@ -438,6 +439,10 @@ sub move_to { '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; + $error = $cust_pkg->change( 'locationnum' => $new->locationnum, 'keep_dates' => 1 @@ -643,6 +648,48 @@ sub in_county_sql { } } +=back + +=head2 SUBROUTINES + +=over 4 + +=item process_censustract_update LOCATIONNUM + +Queueable function to update the census tract to the current year (as set in +the 'census_year' configuration variable) and retrieve the new tract code. + +=cut + +sub process_censustract_update { + eval "use FS::GeocodeCache"; + die $@ if $@; + my $locationnum = shift; + my $cust_location = + qsearchs( 'cust_location', { locationnum => $locationnum }) + or die "locationnum '$locationnum' not found!\n"; + + my $conf = FS::Conf->new; + my $new_year = $conf->config('census_year') or return; + my $loc = FS::GeocodeCache->new( $cust_location->location_hash ); + $loc->set_censustract; + my $error = $loc->get('censustract_error'); + die $error if $error; + $cust_location->set('censustract', $loc->get('censustract')); + $cust_location->set('censusyear', $new_year); + $error = $cust_location->replace; + die $error if $error; + return; +} + +=item process_set_coord + +Queueable function to find and fill in coordinates for all locations that +lack them. Because this uses the Google Maps API, it's internally rate +limited and must run in a single process. + +=cut + sub process_set_coord { my $job = shift; # avoid starting multiple instances of this job @@ -681,6 +728,67 @@ sub process_set_coord { return; } +=item process_standardize [ LOCATIONNUMS ] + +Performs address standardization on locations with unclean addresses, +using whatever method you have configured. If the standardize_* method +returns a I address match, the location will be updated. This is +always an in-place update (because the physical location is the same, +and is just being referred to by a more accurate name). + +Disabled locations will be skipped, as nobody cares. + +If any LOCATIONNUMS are provided, only those locations will be updated. + +=cut + +sub process_standardize { + my $job = shift; + my @others = qsearch('queue', { + 'status' => 'locked', + 'job' => $job->job, + 'jobnum' => {op=>'!=', value=>$job->jobnum}, + }); + return if @others; + my @locationnums = grep /^\d+$/, @_; + my $where = "AND locationnum IN(".join(',',@locationnums).")" + if scalar(@locationnums); + my @locations = qsearch({ + table => 'cust_location', + hashref => { addr_clean => '', disabled => '' }, + extra_sql => $where, + }); + my $n_todo = scalar(@locations); + my $n_done = 0; + + # special: log this + my $log; + eval "use Text::CSV"; + open $log, '>', "$FS::UID::cache_dir/process_standardize-" . + time2str('%Y%m%d',time) . + ".csv"; + my $csv = Text::CSV->new({binary => 1, eol => "\n"}); + + foreach my $cust_location (@locations) { + $job->update_statustext( int(100 * $n_done/$n_todo) . ",$n_done / $n_todo locations" ) if $job; + my $result = FS::GeocodeCache->standardize($cust_location); + if ( $result->{addr_clean} and !$result->{error} ) { + my @cols = ($cust_location->locationnum); + foreach (keys %$result) { + push @cols, $cust_location->get($_), $result->{$_}; + $cust_location->set($_, $result->{$_}); + } + # bypass immutable field restrictions + my $error = $cust_location->FS::Record::replace; + warn "location ".$cust_location->locationnum.": $error\n" if $error; + $csv->print($log, \@cols); + } + $n_done++; + dbh->commit; # so that we can resume if interrupted + } + close $log; +} + =head1 BUGS =head1 SEE ALSO