X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_location.pm;h=4f0bd9bbed8fba00385de7e4f007bb2df6f96c4e;hb=622c72770c971ae44d37dfb59a0f25972051a25a;hp=d772dab0897b9db7357827dd49c4072c6c92924a;hpb=0501f29819775ab5a167ab81bcd9baba45c198ab;p=freeside.git diff --git a/FS/FS/cust_location.pm b/FS/FS/cust_location.pm index d772dab08..4f0bd9bbe 100644 --- a/FS/FS/cust_location.pm +++ b/FS/FS/cust_location.pm @@ -2,7 +2,9 @@ package FS::cust_location; use base qw( FS::geocode_Mixin FS::Record ); use strict; -use vars qw( $import ); +use vars qw( $import $DEBUG $conf $label_prefix ); +use Data::Dumper; +use Date::Format qw( time2str ); use Locale::Country; use FS::UID qw( dbh driver_name ); use FS::Record qw( qsearch qsearchs ); @@ -10,9 +12,18 @@ use FS::Conf; use FS::prospect_main; use FS::cust_main; use FS::cust_main_county; +use FS::part_export; +use FS::GeocodeCache; $import = 0; +$DEBUG = 0; + +FS::UID->install_callback( sub { + $conf = FS::Conf->new; + $label_prefix = $conf->config('cust_location-label_prefix') || ''; +}); + =head1 NAME FS::cust_location - Object methods for cust_location records @@ -57,7 +68,7 @@ Address line two (optional) =item city -City +City (optional only if cust_main-no_city_in_address config is set) =item county @@ -118,17 +129,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,15 +142,29 @@ It is unfortunately hard to determine if this created a new location or not. sub find_or_insert { my $self = shift; - my @essential = (qw(custnum address1 address2 city county state zip country + warn "find_or_insert:\n".Dumper($self) if $DEBUG; + + my @essential = (qw(custnum address1 address2 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 + # Just in case this conf was accidentally/temporarily set, + # we'll never overwrite existing city; see city method + if ($conf->exists('cust_main-no_city_in_address')) { + warn "Warning: find_or_insert specified city when cust_main-no_city_in_address was configured" + if $self->get('city'); + $self->set('city',''); # won't end up in %nonempty, hence old value is preserved + } else { + # otherwise, of course, city is essential + push(@essential,'city') } + # 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($_) } grep {$self->get($_)} $self->fields; @@ -157,28 +174,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 +199,7 @@ sub find_or_insert { } # didn't find a match + warn "not found; inserting new location\n" if $DEBUG; return $self->insert; } @@ -202,25 +212,59 @@ otherwise returns false. sub insert { my $self = shift; - my $conf = new FS::Conf; + + # Ideally, this should never happen, + # but throw a warning and save the value anyway, to avoid data loss + warn "Warning: inserting city when cust_main-no_city_in_address is configured" + if $conf->exists('cust_main-no_city_in_address') && $self->get('city'); if ( $self->censustract ) { $self->set('censusyear' => $conf->config('census_year') || 2012); } + 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; + } #false laziness with cust_main, will go away eventually - if ( !$import and !$error and $conf->config('tax_district_method') ) { + if ( !$import and $conf->config('tax_district_method') ) { my $queue = new FS::queue { 'job' => 'FS::geocode_Mixin::process_district_update' }; $error = $queue->insert( ref($self), $self->locationnum ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } } - $error || ''; + # cust_location exports + #my $export_args = $options{'export_args'} || []; + + my @part_export = + map qsearch( 'part_export', {exportnum=>$_} ), + $conf->config('cust_location-exports'); #, $agentnum + + foreach my $part_export ( @part_export ) { + my $error = $part_export->export_insert($self); #, @$export_args); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "exporting to ". $part_export->exporttype. + " (transaction rolled back): $error"; + } + } + + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; } =item delete @@ -238,6 +282,15 @@ sub replace { my $self = shift; my $old = shift; $old ||= $self->replace_old; + + # Just in case this conf was accidentally/temporarily set, + # we'll never overwrite existing city; see city method + if ($conf->exists('cust_main-no_city_in_address')) { + warn "Warning: replace attempted to change city when cust_main-no_city_in_address was configured" + if $self->get('city') && ($old->get('city') != $self->get('city')); + $self->set('city',$old->get('city')); + } + # the following fields are immutable foreach (qw(address1 address2 city state zip country)) { if ( $self->$_ ne $old->$_ ) { @@ -245,7 +298,35 @@ sub replace { } } - $self->SUPER::replace($old); + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $error = $self->SUPER::replace($old); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + # cust_location exports + #my $export_args = $options{'export_args'} || []; + + my @part_export = + map qsearch( 'part_export', {exportnum=>$_} ), + $conf->config('cust_location-exports'); #, $agentnum + + foreach my $part_export ( @part_export ) { + my $error = $part_export->export_replace($self, $old); #, @$export_args); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "exporting to ". $part_export->exporttype. + " (transaction rolled back): $error"; + } + } + + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; } @@ -257,19 +338,21 @@ 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') || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum') + || $self->ut_textn('locationname') || $self->ut_text('address1') || $self->ut_textn('address2') - || $self->ut_text('city') + || ($conf->exists('cust_main-no_city_in_address') + ? $self->ut_textn('city') + : $self->ut_text('city')) || $self->ut_textn('county') || $self->ut_textn('state') || $self->ut_country('country') @@ -330,6 +413,30 @@ sub check { $self->SUPER::check; } +=item city + +When the I config is set, the +city method will return a blank string no matter the previously +set value of the field. You can still use the get method to +access the contents of the field directly. + +Just in case this config was accidentally/temporarily set, +we'll never overwrite existing city while the config is active. +L will throw a warning if passed any true value for city, +ignore the city field when finding, and preserve the existing value. +L will only throw a warning if passed a true value that is +different than the existing value of city, and will preserve the existing value. +L will throw a warning but still insert a true city value, +to avoid unnecessary data loss. + +=cut + +sub city { + my $self = shift; + return '' if $conf->exists('cust_main-no_city_in_address'); + return $self->get('city'); +} + =item country_full Returns this locations's full country name @@ -349,7 +456,7 @@ Synonym for location_label sub line { my $self = shift; - $self->location_label; + $self->location_label(@_); } =item has_ship_address @@ -383,8 +490,8 @@ sub disable_if_unused { my $self = shift; my $locationnum = $self->locationnum; - return '' if FS::cust_main->count('bill_locationnum = '.$locationnum) - or FS::cust_main->count('ship_locationnum = '.$locationnum) + return '' if FS::cust_main->count('bill_locationnum = '.$locationnum.' OR + ship_locationnum = '.$locationnum) or FS::contact->count( 'locationnum = '.$locationnum) or FS::cust_pkg->count('cancel IS NULL AND locationnum = '.$locationnum) @@ -405,6 +512,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 +536,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 +552,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 @@ -538,26 +656,72 @@ sub dealternize { =item location_label -Returns the label of the location object, with an optional site ID -string (based on the cust_location-label_prefix config option). +Returns the label of the location object. + +Options: + +=over 4 + +=item cust_main + +Customer object (see L) + +=item prospect_main + +Prospect object (see L) + +=item join_string + +String used to join location elements + +=back =cut sub location_label { - my $self = shift; - my %opt = @_; - my $conf = new FS::Conf; - my $prefix = ''; - my $format = $conf->config('cust_location-label_prefix') || ''; - my $cust_or_prospect; - if ( $self->custnum ) { - $cust_or_prospect = FS::cust_main->by_key($self->custnum); - } - elsif ( $self->prospectnum ) { - $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum); + my( $self, %opt ) = @_; + + my $prefix = $self->label_prefix; + $prefix .= ($opt{join_string} || ': ') if $prefix; + + $prefix . $self->SUPER::location_label(%opt); +} + +=item label_prefix + +Returns the optional site ID string (based on the cust_location-label_prefix +config option), "Default service location", or the empty string. + +Options: + +=over 4 + +=item cust_main + +Customer object (see L) + +=item prospect_main + +Prospect object (see L) + +=back + +=cut + +sub label_prefix { + my( $self, %opt ) = @_; + + my $cust_or_prospect = $opt{cust_main} || $opt{prospect_main}; + unless ( $cust_or_prospect ) { + if ( $self->custnum ) { + $cust_or_prospect = FS::cust_main->by_key($self->custnum); + } elsif ( $self->prospectnum ) { + $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum); + } } - if ( $format eq 'CoStAg' ) { + my $prefix = ''; + if ( $label_prefix eq 'CoStAg' ) { my $agent = $conf->config('cust_main-custnum-display_prefix', $cust_or_prospect->agentnum) || $cust_or_prospect->agent->agent; @@ -568,13 +732,16 @@ sub location_label { ($agent =~ /^(..)/), sprintf('%05d', $self->locationnum) ) ); - } - elsif ( $self->custnum and - $self->locationnum == $cust_or_prospect->ship_locationnum ) { + + } elsif ( $label_prefix eq '_location' && $self->locationname ) { + $prefix = $self->locationname; + + } elsif ( ( $opt{'cust_main'} || $self->custnum ) + && $self->locationnum == $cust_or_prospect->ship_locationnum ) { $prefix = 'Default service location'; } - $prefix .= ($opt{join_string} || ': ') if $prefix; - $prefix . $self->SUPER::location_label(%opt); + + $prefix; } =item county_state_county @@ -591,6 +758,16 @@ sub county_state_country { $label; } +=item cust_main + +=cut + +sub cust_main { + my $self = shift; + return '' unless $self->custnum; + qsearchs('cust_main', { 'custnum' => $self->custnum } ); +} + =back =head1 CLASS METHODS @@ -609,25 +786,29 @@ names in order. =cut +### Is this actually used for anything anymore? Grep doesn't show anything... sub in_county_sql { # replaces FS::cust_pkg::location_sql my ($class, %opt) = @_; my $ornull = $opt{ornull} ? ' OR ? IS NULL' : ''; my $x = $ornull ? 3 : 2; my @fields = (('district') x 3, - ('city') x 3, ('county') x $x, ('state') x $x, 'country'); + unless ($conf->exists('cust_main-no_city_in_address')) { + push( @fields, (('city') x 3) ); + } + my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text'; my @where = ( "cust_location.district = ? OR ? = '' OR CAST(? AS $text) IS NULL", - "cust_location.city = ? OR ? = '' OR CAST(? AS $text) IS NULL", "cust_location.county = ? OR (? = '' AND cust_location.county IS NULL) $ornull", "cust_location.state = ? OR (? = '' AND cust_location.state IS NULL ) $ornull", - "cust_location.country = ?" + "cust_location.country = ?", + "cust_location.city = ? OR ? = '' OR CAST(? AS $text) IS NULL" ); my $sql = join(' AND ', map "($_)\n", @where); if ( $opt{param} ) { @@ -643,6 +824,47 @@ 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 $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 +903,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