1 package FS::cust_location;
2 use base qw( FS::geocode_Mixin FS::Record );
5 use vars qw( $import $DEBUG $conf $label_prefix $allow_location_edit );
7 use Date::Format qw( time2str );
8 use FS::UID qw( dbh driver_name );
9 use FS::Record qw( qsearch qsearchs );
11 use FS::prospect_main;
13 use FS::cust_main_county;
17 # Essential fields. Can't be modified in place, will be considered in
18 # deciding if a location is "new", and (because of that) can't have
19 # leading/trailing whitespace.
20 my @essential = (qw(custnum address1 address2 city county state zip country
21 location_number location_type location_kind disabled));
27 FS::UID->install_callback( sub {
28 $conf = FS::Conf->new;
29 $label_prefix = $conf->config('cust_location-label_prefix') || '';
34 FS::cust_location - Object methods for cust_location records
38 use FS::cust_location;
40 $record = new FS::cust_location \%hash;
41 $record = new FS::cust_location { 'column' => 'value' };
43 $error = $record->insert;
45 $error = $new_record->replace($old_record);
47 $error = $record->delete;
49 $error = $record->check;
53 An FS::cust_location object represents a customer (or prospect) location.
54 FS::cust_location inherits from FS::Record. The following fields are currently
65 Customer (see L<FS::cust_main>).
69 Prospect (see L<FS::prospect_main>).
73 Optional location name.
77 Address line one (required)
81 Address line two (optional)
85 City (if cust_main-no_city_in_address config is set when inserting, this will be forced blank)
89 County (optional, see L<FS::cust_main_county>)
93 State (see L<FS::cust_main_county>)
101 Country (see L<FS::cust_main_county>)
113 Flag indicating whether coordinates were obtained automatically or manually
118 Flag indicating whether address has been normalized
126 Tax district code (optional)
130 Incorporated city flag: set to 'Y' if the address is in the legal borders
131 of an incorporated city.
135 Disabled flag; set to 'Y' to disable the location.
145 Creates a new location. To add the location to the database, see L<"insert">.
147 Note that this stores the hash reference, not a distinct copy of the hash it
148 points to. You can ask the object for a copy with the I<hash> method.
152 sub table { 'cust_location'; }
156 Finds an existing location matching the customer and address values in this
157 location, if one exists, and sets the contents of this location equal to that
158 one (including its locationnum).
160 If an existing location is not found, this one I<will> be inserted. (This is a
161 change from the "new_or_existing" method that this replaces.)
163 The following fields are considered "essential" and I<must> match: custnum,
164 address1, address2, city, county, state, zip, country, location_number,
165 location_type, location_kind. Disabled locations will be found only if this
166 location is set to disabled.
168 All other fields are considered "non-essential" and will be ignored in
169 finding a matching location. If the existing location doesn't match
170 in these fields, it will be updated in-place to match.
172 Returns an error string if inserting or updating a location failed.
174 It is unfortunately hard to determine if this created a new location or not.
181 warn "find_or_insert:\n".Dumper($self) if $DEBUG;
183 if ($conf->exists('cust_main-no_city_in_address')) {
184 warn "Warning: passed city to find_or_insert when cust_main-no_city_in_address is configured, ignoring it"
185 if $self->get('city');
186 $self->set('city','');
189 # I don't think this is necessary
190 #if ( !$self->coord_auto and $self->latitude and $self->longitude ) {
191 # push @essential, qw(latitude longitude);
192 # # but NOT coord_auto; if the latitude and longitude match the geocoded
193 # # values then that's good enough
196 # put nonempty, nonessential fields/values into this hash
197 my %nonempty = map { $_ => $self->get($_) }
198 grep {$self->get($_)} $self->fields;
199 delete @nonempty{@essential};
200 delete $nonempty{'locationnum'};
202 my %hash = map { $_ => $self->get($_) } @essential;
203 foreach (values %hash) {
207 my @matches = qsearch('cust_location', \%hash);
209 # we no longer reject matches for having different values in nonessential
210 # fields; we just alter the record to match
212 my $old = $matches[0];
213 warn "found existing location #".$old->locationnum."\n" if $DEBUG;
214 foreach my $field (keys %nonempty) {
215 if ($old->get($field) ne $nonempty{$field}) {
216 warn "altering $field to match requested location" if $DEBUG;
217 $old->set($field, $nonempty{$field});
221 if ( $old->modified ) {
222 warn "updating non-essential fields\n" if $DEBUG;
223 my $error = $old->replace;
224 return $error if $error;
226 # set $self equal to $old
227 foreach ($self->fields) {
228 $self->set($_, $old->get($_));
233 # didn't find a match
234 warn "not found; inserting new location\n" if $DEBUG;
235 return $self->insert;
240 Adds this record to the database. If there is an error, returns the error,
241 otherwise returns false.
248 if ($conf->exists('cust_main-no_city_in_address')) {
249 warn "Warning: passed city to insert when cust_main-no_city_in_address is configured, ignoring it"
250 if $self->get('city');
251 $self->set('city','');
254 if ( $self->censustract ) {
255 $self->set('censusyear' => $conf->config('census_year') || 2012);
258 my $oldAutoCommit = $FS::UID::AutoCommit;
259 local $FS::UID::AutoCommit = 0;
262 my $error = $self->SUPER::insert(@_);
264 $dbh->rollback if $oldAutoCommit;
268 # If using tax_district_method, for rows in state of Washington,
269 # without a tax district already specified, queue a job to find
274 && lc $self->state eq 'wa'
275 && $conf->config('tax_district_method')
278 my $queue = new FS::queue {
279 'job' => 'FS::geocode_Mixin::process_district_update'
281 $error = $queue->insert( ref($self), $self->locationnum );
283 $dbh->rollback if $oldAutoCommit;
289 # cust_location exports
290 #my $export_args = $options{'export_args'} || [];
292 # don't export custnum_pending cases, let follow-up replace handle that
293 if ($self->custnum || $self->prospectnum) {
295 map qsearch( 'part_export', {exportnum=>$_} ),
296 $conf->config('cust_location-exports'); #, $agentnum
298 foreach my $part_export ( @part_export ) {
299 my $error = $part_export->export_insert($self); #, @$export_args);
301 $dbh->rollback if $oldAutoCommit;
302 return "exporting to ". $part_export->exporttype.
303 " (transaction rolled back): $error";
308 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
314 Delete this record from the database.
316 =item replace OLD_RECORD
318 Replaces the OLD_RECORD with this one in the database. If there is an error,
319 returns the error, otherwise returns false.
326 $old ||= $self->replace_old;
328 warn "Warning: passed city to replace when cust_main-no_city_in_address is configured"
329 if $conf->exists('cust_main-no_city_in_address') && $self->get('city');
331 # the following fields are immutable if this is a customer location. if
332 # it's a prospect location, then there are no active packages, no billing
333 # history, no taxes, and in general no reason to keep the old location
335 if ( !$allow_location_edit and $self->custnum ) {
336 foreach (qw(address1 address2 city state zip country)) {
337 if ( $self->$_ ne $old->$_ ) {
338 return "can't change cust_location field $_";
343 my $oldAutoCommit = $FS::UID::AutoCommit;
344 local $FS::UID::AutoCommit = 0;
347 my $error = $self->SUPER::replace($old);
349 $dbh->rollback if $oldAutoCommit;
353 # cust_location exports
354 #my $export_args = $options{'export_args'} || [];
356 # don't export custnum_pending cases, let follow-up replace handle that
357 if ($self->custnum || $self->prospectnum) {
359 map qsearch( 'part_export', {exportnum=>$_} ),
360 $conf->config('cust_location-exports'); #, $agentnum
362 foreach my $part_export ( @part_export ) {
363 my $error = $part_export->export_replace($self, $old); #, @$export_args);
365 $dbh->rollback if $oldAutoCommit;
366 return "exporting to ". $part_export->exporttype.
367 " (transaction rolled back): $error";
372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
379 Checks all fields to make sure this is a valid location. If there is
380 an error, returns the error, otherwise returns false. Called by the insert
388 return '' if $self->disabled; # so that disabling locations never fails
390 # whitespace in essential fields leads to problems figuring out if a
391 # record is "new"; get rid of it.
392 $self->trim_whitespace(@essential);
395 $self->ut_numbern('locationnum')
396 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
397 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
398 || $self->ut_textn('locationname')
399 || $self->ut_text('address1')
400 || $self->ut_textn('address2')
401 || ($conf->exists('cust_main-no_city_in_address')
402 ? $self->ut_textn('city')
403 : $self->ut_text('city'))
404 || $self->ut_textn('county')
405 || $self->ut_textn('state')
406 || $self->ut_country('country')
407 || (!$import && $self->ut_zip('zip', $self->country))
408 || $self->ut_coordn('latitude')
409 || $self->ut_coordn('longitude')
410 || $self->ut_enum('coord_auto', [ '', 'Y' ])
411 || $self->ut_enum('addr_clean', [ '', 'Y' ])
412 || $self->ut_alphan('location_type')
413 || $self->ut_textn('location_number')
414 || $self->ut_enum('location_kind', [ '', 'R', 'B' ] )
415 || $self->ut_alphan('geocode')
416 || $self->ut_alphan('district')
417 || $self->ut_numbern('censusyear')
418 || $self->ut_flag('incorporated')
420 return $error if $error;
421 if ( $self->censustract ne '' ) {
422 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
423 or return "Illegal census tract: ". $self->censustract;
425 $self->censustract("$1.$2");
428 #yikes... this is ancient, pre-dates cust_location and will be harder to
429 # implement now... how do we know this location is a service location from
430 # here and not a billing? we can't just check locationnums, we might be new :/
431 return "Unit # is required"
432 if $conf->exists('cust_main-require_address2')
433 && ! $self->address2 =~ /\S/;
435 # tricky...we have to allow for the customer to not be inserted yet
436 return "No prospect or customer!" unless $self->prospectnum
438 || $self->get('custnum_pending');
439 return "Prospect and customer!" if $self->prospectnum && $self->custnum;
441 return 'Location kind is required'
442 if $self->prospectnum
443 && $conf->exists('prospect_main-alt_address_format')
444 && ! $self->location_kind;
446 # Do not allow bad tax district values in cust_location when
447 # using Washington State district sales tax calculation - would result
448 # in incorrect or missing sales tax on invoices.
449 my $tax_district_method = FS::Conf->new->config('tax_district_method');
452 && $tax_district_method eq 'wa_sales'
455 my $cust_main_county = qsearchs(
456 cust_main_county => { district => $self->district }
458 unless ( ref $cust_main_county ) {
460 'WA State tax district %s does not exist in tax table',
466 unless ( $import or qsearch('cust_main_county', {
467 'country' => $self->country,
470 return "Unknown state/county/country: ".
471 $self->state. "/". $self->county. "/". $self->country
472 unless qsearch('cust_main_county',{
473 'state' => $self->state,
474 'county' => $self->county,
475 'country' => $self->country,
479 # set coordinates, unless we already have them
480 if (!$import and !$self->latitude and !$self->longitude) {
489 Returns this location's full country name
493 #moved to geocode_Mixin.pm
497 Synonym for location_label
503 $self->location_label(@_);
506 =item has_ship_address
508 Returns false since cust_location objects do not have a separate shipping
513 sub has_ship_address {
519 Returns a list of key/value pairs, with the following keys: address1, address2,
520 city, county, state, zip, country, geocode, location_type, location_number,
525 =item disable_if_unused
527 Sets the "disabled" flag on the location if it is no longer in use as a
528 prospect location, package location, or a customer's billing or default
533 sub disable_if_unused {
536 my $locationnum = $self->locationnum;
537 return '' if FS::cust_main->count('bill_locationnum = '.$locationnum.' OR
538 ship_locationnum = '.$locationnum)
539 or FS::contact->count( 'locationnum = '.$locationnum)
540 or FS::cust_pkg->count('cancel IS NULL AND
541 locationnum = '.$locationnum)
543 $self->disabled('Y');
550 Returns array of cust_pkg objects that would have their location
551 updated by L</move_to> (all packages that have this location as
552 their service address, and aren't canceled, and aren't supplemental
553 to another package, and aren't one-time charges that have already been charged.)
560 # find all packages that have the old location as their service address,
561 # and aren't canceled,
562 # and aren't supplemental to another package
563 # and aren't one-time charges that have already been charged
564 foreach my $cust_pkg (
565 qsearch('cust_pkg', {
566 'locationnum' => $self->locationnum,
571 next if $cust_pkg->part_pkg->freq eq '0'
572 and ($cust_pkg->setup || 0) > 0;
573 push @pkgs, $cust_pkg;
578 =item move_to NEW [ move_pkgs => \@move_pkgs ]
580 Takes a new L<FS::cust_location> object. Moves all packages that use the
581 existing location to the new one, then sets the "disabled" flag on the old
582 location. Returns nothing on success, an error message on error.
584 Use option I<move_pkgs> to override the list of packages to update
594 warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG;
596 local $SIG{HUP} = 'IGNORE';
597 local $SIG{INT} = 'IGNORE';
598 local $SIG{QUIT} = 'IGNORE';
599 local $SIG{TERM} = 'IGNORE';
600 local $SIG{TSTP} = 'IGNORE';
601 local $SIG{PIPE} = 'IGNORE';
603 my $oldAutoCommit = $FS::UID::AutoCommit;
604 local $FS::UID::AutoCommit = 0;
608 # prevent this from failing because of pkg_svc quantity limits
609 local( $FS::cust_svc::ignore_quantity ) = 1;
611 if ( !$new->locationnum ) {
612 $error = $new->insert;
614 $dbh->rollback if $oldAutoCommit;
615 return "Error creating location: $error";
617 } elsif ( $new->locationnum == $old->locationnum ) {
618 # then they're the same location; the normal result of doing a minor
620 $dbh->commit if $oldAutoCommit;
625 if ($opt{'move_pkgs'}) {
626 @pkgs = @{$opt{'move_pkgs'}};
628 foreach my $pkg (@pkgs) {
629 my $pkgnum = $pkg->pkgnum;
630 $pkgerr = "cust_pkg $pkgnum has already been charged"
631 if $pkg->part_pkg->freq eq '0'
632 and ($pkg->setup || 0) > 0;
633 $pkgerr = "cust_pkg $pkgnum is supplemental"
634 if $pkg->main_pkgnum;
635 $pkgerr = "cust_pkg $pkgnum already cancelled"
637 $pkgerr = "cust_pkg $pkgnum does not use this location"
638 unless $pkg->locationnum eq $old->locationnum;
642 $dbh->rollback if $oldAutoCommit;
643 return "Cannot update package location: $pkgerr";
646 @pkgs = $old->move_pkgs;
649 foreach my $cust_pkg (@pkgs) {
650 $error = $cust_pkg->change(
651 'locationnum' => $new->locationnum,
654 if ( $error and not ref($error) ) {
655 $dbh->rollback if $oldAutoCommit;
656 return "Error moving pkgnum ".$cust_pkg->pkgnum.": $error";
660 $error = $old->disable_if_unused;
662 $dbh->rollback if $oldAutoCommit;
663 return "Error disabling old location: $error";
666 $dbh->commit if $oldAutoCommit;
672 Attempts to parse data for location_type and location_number from address1
680 return '' if $self->get('location_type')
681 || $self->get('location_number');
684 if ( 1 ) { #ikano, switch on via config
685 { no warnings 'void';
686 eval { 'use FS::part_export::ikano;' };
689 %parse = FS::part_export::ikano->location_types_parse;
694 foreach my $from ('address1', 'address2') {
695 foreach my $parse ( keys %parse ) {
696 my $value = $self->get($from);
697 if ( $value =~ s/(^|\W+)$parse\W+(\w+)\W*$//i ) {
698 $self->set('location_type', $parse{$parse});
699 $self->set('location_number', $2);
700 $self->set($from, $value);
706 #nothing matched, no changes
707 $self->get('address2')
708 ? "Can't parse unit type and number from address2"
714 Moves data from location_type and location_number to the end of address1.
721 #false laziness w/geocode_Mixin.pm::line
722 my $lt = $self->get('location_type');
726 if ( 1 ) { #ikano, switch on via config
727 { no warnings 'void';
728 eval { 'use FS::part_export::ikano;' };
731 %location_type = FS::part_export::ikano->location_types;
733 %location_type = (); #?
736 $self->address1( $self->address1. ' '. $location_type{$lt} || $lt );
737 $self->location_type('');
740 if ( length($self->location_number) ) {
741 $self->address1( $self->address1. ' '. $self->location_number );
742 $self->location_number('');
750 Returns the label of the location object.
758 Customer object (see L<FS::cust_main>)
762 Prospect object (see L<FS::prospect_main>)
766 String used to join location elements
770 Don't label the default service location as "Default service location".
771 May become the default at some point.
778 my( $self, %opt ) = @_;
780 my $prefix = $self->label_prefix(%opt);
781 $prefix .= ($opt{join_string} || ': ') if $prefix;
782 $prefix = '' if $opt{'no_prefix'};
784 $prefix . $self->SUPER::location_label(%opt);
789 Returns the optional site ID string (based on the cust_location-label_prefix
790 config option), "Default service location", or the empty string.
798 Customer object (see L<FS::cust_main>)
802 Prospect object (see L<FS::prospect_main>)
809 my( $self, %opt ) = @_;
811 my $cust_or_prospect = $opt{cust_main} || $opt{prospect_main};
812 unless ( $cust_or_prospect ) {
813 if ( $self->custnum ) {
814 $cust_or_prospect = FS::cust_main->by_key($self->custnum);
815 } elsif ( $self->prospectnum ) {
816 $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum);
821 if ( $label_prefix eq 'CoStAg' ) {
822 my $agent = $conf->config('cust_main-custnum-display_prefix',
823 $cust_or_prospect->agentnum)
824 || $cust_or_prospect->agent->agent;
825 # else this location is invalid
826 $prefix = uc( join('',
828 ($self->state =~ /^(..)/),
830 sprintf('%05d', $self->locationnum)
833 } elsif ( $label_prefix eq '_location' && $self->locationname ) {
834 $prefix = $self->locationname;
836 #} elsif ( ( $opt{'cust_main'} || $self->custnum )
837 # && $self->locationnum == $cust_or_prospect->ship_locationnum ) {
838 # $prefix = 'Default service location';
847 =item county_state_country
849 Returns a string consisting of just the county, state and country.
853 sub county_state_country {
855 my $label = $self->country;
856 $label = $self->state.", $label" if $self->state;
857 $label = $self->county." County, $label" if $self->county;
867 =item process_censustract_update LOCATIONNUM
869 Queueable function to update the census tract to the current year (as set in
870 the 'census_year' configuration variable) and retrieve the new tract code.
874 sub process_censustract_update {
875 eval "use FS::GeocodeCache";
877 my $locationnum = shift;
879 qsearchs( 'cust_location', { locationnum => $locationnum })
880 or die "locationnum '$locationnum' not found!\n";
882 my $new_year = $conf->config('census_year') or return;
883 my $loc = FS::GeocodeCache->new( $cust_location->location_hash );
884 $loc->set_censustract;
885 my $error = $loc->get('censustract_error');
886 die $error if $error;
887 $cust_location->set('censustract', $loc->get('censustract'));
888 $cust_location->set('censusyear', $new_year);
889 $error = $cust_location->replace;
890 die $error if $error;
894 =item process_set_coord
896 Queueable function to find and fill in coordinates for all locations that
897 lack them. Because this uses the Google Maps API, it's internally rate
898 limited and must run in a single process.
902 sub process_set_coord {
904 # avoid starting multiple instances of this job
905 my @others = qsearch('queue', {
906 'status' => 'locked',
908 'jobnum' => {op=>'!=', value=>$job->jobnum},
912 $job->update_statustext('finding locations to update');
913 my @missing_coords = qsearch('cust_location', {
919 my $n = scalar @missing_coords;
920 for my $cust_location (@missing_coords) {
921 $cust_location->set_coord;
922 my $error = $cust_location->replace;
924 warn "error geocoding location#".$cust_location->locationnum.": $error\n";
927 $job->update_statustext("updated $i / $n locations");
928 dbh->commit; # so that we don't have to wait for the whole thing to finish
929 # Rate-limit to stay under the Google Maps usage limit (2500/day).
930 # 86,400 / 35 = 2,468 lookups per day.
935 die "failed to update ".$n-$i." locations\n";
940 =item process_standardize [ LOCATIONNUMS ]
942 Performs address standardization on locations with unclean addresses,
943 using whatever method you have configured. If the standardize_* method
944 returns a I<clean> address match, the location will be updated. This is
945 always an in-place update (because the physical location is the same,
946 and is just being referred to by a more accurate name).
948 Disabled locations will be skipped, as nobody cares.
950 If any LOCATIONNUMS are provided, only those locations will be updated.
954 sub process_standardize {
956 my @others = qsearch('queue', {
957 'status' => 'locked',
959 'jobnum' => {op=>'!=', value=>$job->jobnum},
962 my @locationnums = grep /^\d+$/, @_;
963 my $where = "AND locationnum IN(".join(',',@locationnums).")"
964 if scalar(@locationnums);
965 my @locations = qsearch({
966 table => 'cust_location',
967 hashref => { addr_clean => '', disabled => '' },
970 my $n_todo = scalar(@locations);
975 eval "use Text::CSV";
976 open $log, '>', "$FS::UID::cache_dir/process_standardize-" .
977 time2str('%Y%m%d',time) .
979 my $csv = Text::CSV->new({binary => 1, eol => "\n"});
981 foreach my $cust_location (@locations) {
982 $job->update_statustext( int(100 * $n_done/$n_todo) . ",$n_done / $n_todo locations" ) if $job;
983 my $result = FS::GeocodeCache->standardize($cust_location);
984 if ( $result->{addr_clean} and !$result->{error} ) {
985 my @cols = ($cust_location->locationnum);
986 foreach (keys %$result) {
987 push @cols, $cust_location->get($_), $result->{$_};
988 $cust_location->set($_, $result->{$_});
990 # bypass immutable field restrictions
991 my $error = $cust_location->FS::Record::replace;
992 warn "location ".$cust_location->locationnum.": $error\n" if $error;
993 $csv->print($log, \@cols);
996 dbh->commit; # so that we can resume if interrupted
1004 # are we going to need to update tax districts?
1005 my $use_districts = $conf->config('tax_district_method') ? 1 : 0;
1007 # trim whitespace on records that need it
1008 local $allow_location_edit = 1;
1009 foreach my $field (@essential) {
1010 next if $field eq 'custnum';
1011 next if $field eq 'disabled';
1012 foreach my $location (qsearch({
1013 table => 'cust_location',
1014 extra_sql => " WHERE disabled IS NULL AND ($field LIKE ' %' OR $field LIKE '% ')"
1016 my $error = $location->replace;
1017 die "$error (fixing whitespace in $field, locationnum ".$location->locationnum.')'
1022 && !$location->district
1023 && lc $location->state eq 'wa'
1025 my $queue = new FS::queue {
1026 'job' => 'FS::geocode_Mixin::process_district_update'
1028 $error = $queue->insert( 'FS::cust_location' => $location->locationnum );
1029 die $error if $error;
1031 } # foreach $location
1040 L<FS::cust_main_county>, L<FS::cust_pkg>, L<FS::Record>,
1041 schema.html from the base documentation.