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;
21 FS::UID->install_callback( sub {
22 $conf = FS::Conf->new;
23 $label_prefix = $conf->config('cust_location-label_prefix') || '';
28 FS::cust_location - Object methods for cust_location records
32 use FS::cust_location;
34 $record = new FS::cust_location \%hash;
35 $record = new FS::cust_location { 'column' => 'value' };
37 $error = $record->insert;
39 $error = $new_record->replace($old_record);
41 $error = $record->delete;
43 $error = $record->check;
47 An FS::cust_location object represents a customer location. FS::cust_location
48 inherits from FS::Record. The following fields are currently supported:
62 Address line one (required)
66 Address line two (optional)
70 City (if cust_main-no_city_in_address config is set when inserting, this will be forced blank)
74 County (optional, see L<FS::cust_main_county>)
78 State (see L<FS::cust_main_county>)
86 Country (see L<FS::cust_main_county>)
94 Tax district code (optional)
98 Incorporated city flag: set to 'Y' if the address is in the legal borders
99 of an incorporated city.
103 Disabled flag; set to 'Y' to disable the location.
113 Creates a new location. To add the location to the database, see L<"insert">.
115 Note that this stores the hash reference, not a distinct copy of the hash it
116 points to. You can ask the object for a copy with the I<hash> method.
120 sub table { 'cust_location'; }
124 Finds an existing location matching the customer and address values in this
125 location, if one exists, and sets the contents of this location equal to that
126 one (including its locationnum).
128 If an existing location is not found, this one I<will> be inserted. (This is a
129 change from the "new_or_existing" method that this replaces.)
131 The following fields are considered "essential" and I<must> match: custnum,
132 address1, address2, city, county, state, zip, country, location_number,
133 location_type, location_kind. Disabled locations will be found only if this
134 location is set to disabled.
136 All other fields are considered "non-essential" and will be ignored in
137 finding a matching location. If the existing location doesn't match
138 in these fields, it will be updated in-place to match.
140 Returns an error string if inserting or updating a location failed.
142 It is unfortunately hard to determine if this created a new location or not.
149 warn "find_or_insert:\n".Dumper($self) if $DEBUG;
151 my @essential = (qw(custnum address1 address2 city county state zip country
152 location_number location_type location_kind disabled));
154 if ($conf->exists('cust_main-no_city_in_address')) {
155 warn "Warning: passed city to find_or_insert when cust_main-no_city_in_address is configured, ignoring it"
156 if $self->get('city');
157 $self->set('city','');
160 # I don't think this is necessary
161 #if ( !$self->coord_auto and $self->latitude and $self->longitude ) {
162 # push @essential, qw(latitude longitude);
163 # # but NOT coord_auto; if the latitude and longitude match the geocoded
164 # # values then that's good enough
167 # put nonempty, nonessential fields/values into this hash
168 my %nonempty = map { $_ => $self->get($_) }
169 grep {$self->get($_)} $self->fields;
170 delete @nonempty{@essential};
171 delete $nonempty{'locationnum'};
173 my %hash = map { $_ => $self->get($_) } @essential;
174 foreach (values %hash) {
178 my @matches = qsearch('cust_location', \%hash);
180 # we no longer reject matches for having different values in nonessential
181 # fields; we just alter the record to match
183 my $old = $matches[0];
184 warn "found existing location #".$old->locationnum."\n" if $DEBUG;
185 foreach my $field (keys %nonempty) {
186 if ($old->get($field) ne $nonempty{$field}) {
187 warn "altering $field to match requested location" if $DEBUG;
188 $old->set($field, $nonempty{$field});
192 if ( $old->modified ) {
193 warn "updating non-essential fields\n" if $DEBUG;
194 my $error = $old->replace;
195 return $error if $error;
197 # set $self equal to $old
198 foreach ($self->fields) {
199 $self->set($_, $old->get($_));
204 # didn't find a match
205 warn "not found; inserting new location\n" if $DEBUG;
206 return $self->insert;
211 Adds this record to the database. If there is an error, returns the error,
212 otherwise returns false.
219 if ($conf->exists('cust_main-no_city_in_address')) {
220 warn "Warning: passed city to insert when cust_main-no_city_in_address is configured, ignoring it"
221 if $self->get('city');
222 $self->set('city','');
225 if ( $self->censustract ) {
226 $self->set('censusyear' => $conf->config('census_year') || 2012);
229 my $oldAutoCommit = $FS::UID::AutoCommit;
230 local $FS::UID::AutoCommit = 0;
233 my $error = $self->SUPER::insert(@_);
235 $dbh->rollback if $oldAutoCommit;
239 #false laziness with cust_main, will go away eventually
240 if ( !$import and $conf->config('tax_district_method') ) {
242 my $queue = new FS::queue {
243 'job' => 'FS::geocode_Mixin::process_district_update'
245 $error = $queue->insert( ref($self), $self->locationnum );
247 $dbh->rollback if $oldAutoCommit;
253 # cust_location exports
254 #my $export_args = $options{'export_args'} || [];
256 # don't export custnum_pending cases, let follow-up replace handle that
257 if ($self->custnum || $self->prospectnum) {
259 map qsearch( 'part_export', {exportnum=>$_} ),
260 $conf->config('cust_location-exports'); #, $agentnum
262 foreach my $part_export ( @part_export ) {
263 my $error = $part_export->export_insert($self); #, @$export_args);
265 $dbh->rollback if $oldAutoCommit;
266 return "exporting to ". $part_export->exporttype.
267 " (transaction rolled back): $error";
272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
278 Delete this record from the database.
280 =item replace OLD_RECORD
282 Replaces the OLD_RECORD with this one in the database. If there is an error,
283 returns the error, otherwise returns false.
290 $old ||= $self->replace_old;
292 warn "Warning: passed city to replace when cust_main-no_city_in_address is configured"
293 if $conf->exists('cust_main-no_city_in_address') && $self->get('city');
295 # the following fields are immutable if this is a customer location. if
296 # it's a prospect location, then there are no active packages, no billing
297 # history, no taxes, and in general no reason to keep the old location
299 if ( !$allow_location_edit and $self->custnum ) {
300 foreach (qw(address1 address2 city state zip country)) {
301 if ( $self->$_ ne $old->$_ ) {
302 return "can't change cust_location field $_";
307 my $oldAutoCommit = $FS::UID::AutoCommit;
308 local $FS::UID::AutoCommit = 0;
311 my $error = $self->SUPER::replace($old);
313 $dbh->rollback if $oldAutoCommit;
317 # cust_location exports
318 #my $export_args = $options{'export_args'} || [];
320 # don't export custnum_pending cases, let follow-up replace handle that
321 if ($self->custnum || $self->prospectnum) {
323 map qsearch( 'part_export', {exportnum=>$_} ),
324 $conf->config('cust_location-exports'); #, $agentnum
326 foreach my $part_export ( @part_export ) {
327 my $error = $part_export->export_replace($self, $old); #, @$export_args);
329 $dbh->rollback if $oldAutoCommit;
330 return "exporting to ". $part_export->exporttype.
331 " (transaction rolled back): $error";
336 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
343 Checks all fields to make sure this is a valid location. If there is
344 an error, returns the error, otherwise returns false. Called by the insert
352 return '' if $self->disabled; # so that disabling locations never fails
354 # maybe should just do all fields in the table?
356 $self->trim_whitespace(qw(district city county state country));
359 $self->ut_numbern('locationnum')
360 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
361 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
362 || $self->ut_textn('locationname')
363 || $self->ut_text('address1')
364 || $self->ut_textn('address2')
365 || ($conf->exists('cust_main-no_city_in_address')
366 ? $self->ut_textn('city')
367 : $self->ut_text('city'))
368 || $self->ut_textn('county')
369 || $self->ut_textn('state')
370 || $self->ut_country('country')
371 || (!$import && $self->ut_zip('zip', $self->country))
372 || $self->ut_coordn('latitude')
373 || $self->ut_coordn('longitude')
374 || $self->ut_enum('coord_auto', [ '', 'Y' ])
375 || $self->ut_enum('addr_clean', [ '', 'Y' ])
376 || $self->ut_alphan('location_type')
377 || $self->ut_textn('location_number')
378 || $self->ut_enum('location_kind', [ '', 'R', 'B' ] )
379 || $self->ut_alphan('geocode')
380 || $self->ut_alphan('district')
381 || $self->ut_numbern('censusyear')
382 || $self->ut_flag('incorporated')
384 return $error if $error;
385 if ( $self->censustract ne '' ) {
386 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
387 or return "Illegal census tract: ". $self->censustract;
389 $self->censustract("$1.$2");
392 #yikes... this is ancient, pre-dates cust_location and will be harder to
393 # implement now... how do we know this location is a service location from
394 # here and not a billing? we can't just check locationnums, we might be new :/
395 return "Unit # is required"
396 if $conf->exists('cust_main-require_address2')
397 && ! $self->address2 =~ /\S/;
399 # tricky...we have to allow for the customer to not be inserted yet
400 return "No prospect or customer!" unless $self->prospectnum
402 || $self->get('custnum_pending');
403 return "Prospect and customer!" if $self->prospectnum && $self->custnum;
405 return 'Location kind is required'
406 if $self->prospectnum
407 && $conf->exists('prospect_main-alt_address_format')
408 && ! $self->location_kind;
410 unless ( $import or qsearch('cust_main_county', {
411 'country' => $self->country,
414 return "Unknown state/county/country: ".
415 $self->state. "/". $self->county. "/". $self->country
416 unless qsearch('cust_main_county',{
417 'state' => $self->state,
418 'county' => $self->county,
419 'country' => $self->country,
423 # set coordinates, unless we already have them
424 if (!$import and !$self->latitude and !$self->longitude) {
433 Returns this location's full country name
437 #moved to geocode_Mixin.pm
441 Synonym for location_label
447 $self->location_label(@_);
450 =item has_ship_address
452 Returns false since cust_location objects do not have a separate shipping
457 sub has_ship_address {
463 Returns a list of key/value pairs, with the following keys: address1, address2,
464 city, county, state, zip, country, geocode, location_type, location_number,
469 =item disable_if_unused
471 Sets the "disabled" flag on the location if it is no longer in use as a
472 prospect location, package location, or a customer's billing or default
477 sub disable_if_unused {
480 my $locationnum = $self->locationnum;
481 return '' if FS::cust_main->count('bill_locationnum = '.$locationnum.' OR
482 ship_locationnum = '.$locationnum)
483 or FS::contact->count( 'locationnum = '.$locationnum)
484 or FS::cust_pkg->count('cancel IS NULL AND
485 locationnum = '.$locationnum)
487 $self->disabled('Y');
494 Takes a new L<FS::cust_location> object. Moves all packages that use the
495 existing location to the new one, then sets the "disabled" flag on the old
496 location. Returns nothing on success, an error message on error.
504 warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG;
506 local $SIG{HUP} = 'IGNORE';
507 local $SIG{INT} = 'IGNORE';
508 local $SIG{QUIT} = 'IGNORE';
509 local $SIG{TERM} = 'IGNORE';
510 local $SIG{TSTP} = 'IGNORE';
511 local $SIG{PIPE} = 'IGNORE';
513 my $oldAutoCommit = $FS::UID::AutoCommit;
514 local $FS::UID::AutoCommit = 0;
518 # prevent this from failing because of pkg_svc quantity limits
519 local( $FS::cust_svc::ignore_quantity ) = 1;
521 if ( !$new->locationnum ) {
522 $error = $new->insert;
524 $dbh->rollback if $oldAutoCommit;
525 return "Error creating location: $error";
527 } elsif ( $new->locationnum == $old->locationnum ) {
528 # then they're the same location; the normal result of doing a minor
530 $dbh->commit if $oldAutoCommit;
534 # find all packages that have the old location as their service address,
535 # and aren't canceled,
536 # and aren't supplemental to another package.
537 my @pkgs = qsearch('cust_pkg', {
538 'locationnum' => $old->locationnum,
542 foreach my $cust_pkg (@pkgs) {
543 # don't move one-time charges that have already been charged
544 next if $cust_pkg->part_pkg->freq eq '0'
545 and ($cust_pkg->setup || 0) > 0;
547 $error = $cust_pkg->change(
548 'locationnum' => $new->locationnum,
551 if ( $error and not ref($error) ) {
552 $dbh->rollback if $oldAutoCommit;
553 return "Error moving pkgnum ".$cust_pkg->pkgnum.": $error";
557 $error = $old->disable_if_unused;
559 $dbh->rollback if $oldAutoCommit;
560 return "Error disabling old location: $error";
563 $dbh->commit if $oldAutoCommit;
569 Attempts to parse data for location_type and location_number from address1
577 return '' if $self->get('location_type')
578 || $self->get('location_number');
581 if ( 1 ) { #ikano, switch on via config
582 { no warnings 'void';
583 eval { 'use FS::part_export::ikano;' };
586 %parse = FS::part_export::ikano->location_types_parse;
591 foreach my $from ('address1', 'address2') {
592 foreach my $parse ( keys %parse ) {
593 my $value = $self->get($from);
594 if ( $value =~ s/(^|\W+)$parse\W+(\w+)\W*$//i ) {
595 $self->set('location_type', $parse{$parse});
596 $self->set('location_number', $2);
597 $self->set($from, $value);
603 #nothing matched, no changes
604 $self->get('address2')
605 ? "Can't parse unit type and number from address2"
611 Moves data from location_type and location_number to the end of address1.
618 #false laziness w/geocode_Mixin.pm::line
619 my $lt = $self->get('location_type');
623 if ( 1 ) { #ikano, switch on via config
624 { no warnings 'void';
625 eval { 'use FS::part_export::ikano;' };
628 %location_type = FS::part_export::ikano->location_types;
630 %location_type = (); #?
633 $self->address1( $self->address1. ' '. $location_type{$lt} || $lt );
634 $self->location_type('');
637 if ( length($self->location_number) ) {
638 $self->address1( $self->address1. ' '. $self->location_number );
639 $self->location_number('');
647 Returns the label of the location object.
655 Customer object (see L<FS::cust_main>)
659 Prospect object (see L<FS::prospect_main>)
663 String used to join location elements
667 Don't label the default service location as "Default service location".
668 May become the default at some point.
675 my( $self, %opt ) = @_;
677 my $prefix = $self->label_prefix(%opt);
678 $prefix .= ($opt{join_string} || ': ') if $prefix;
679 $prefix = '' if $opt{'no_prefix'};
681 $prefix . $self->SUPER::location_label(%opt);
686 Returns the optional site ID string (based on the cust_location-label_prefix
687 config option), "Default service location", or the empty string.
695 Customer object (see L<FS::cust_main>)
699 Prospect object (see L<FS::prospect_main>)
706 my( $self, %opt ) = @_;
708 my $cust_or_prospect = $opt{cust_main} || $opt{prospect_main};
709 unless ( $cust_or_prospect ) {
710 if ( $self->custnum ) {
711 $cust_or_prospect = FS::cust_main->by_key($self->custnum);
712 } elsif ( $self->prospectnum ) {
713 $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum);
718 if ( $label_prefix eq 'CoStAg' ) {
719 my $agent = $conf->config('cust_main-custnum-display_prefix',
720 $cust_or_prospect->agentnum)
721 || $cust_or_prospect->agent->agent;
722 # else this location is invalid
723 $prefix = uc( join('',
725 ($self->state =~ /^(..)/),
727 sprintf('%05d', $self->locationnum)
730 } elsif ( $label_prefix eq '_location' && $self->locationname ) {
731 $prefix = $self->locationname;
733 #} elsif ( ( $opt{'cust_main'} || $self->custnum )
734 # && $self->locationnum == $cust_or_prospect->ship_locationnum ) {
735 # $prefix = 'Default service location';
744 =item county_state_country
746 Returns a string consisting of just the county, state and country.
750 sub county_state_country {
752 my $label = $self->country;
753 $label = $self->state.", $label" if $self->state;
754 $label = $self->county." County, $label" if $self->county;
764 =item process_censustract_update LOCATIONNUM
766 Queueable function to update the census tract to the current year (as set in
767 the 'census_year' configuration variable) and retrieve the new tract code.
771 sub process_censustract_update {
772 eval "use FS::GeocodeCache";
774 my $locationnum = shift;
776 qsearchs( 'cust_location', { locationnum => $locationnum })
777 or die "locationnum '$locationnum' not found!\n";
779 my $new_year = $conf->config('census_year') or return;
780 my $loc = FS::GeocodeCache->new( $cust_location->location_hash );
781 $loc->set_censustract;
782 my $error = $loc->get('censustract_error');
783 die $error if $error;
784 $cust_location->set('censustract', $loc->get('censustract'));
785 $cust_location->set('censusyear', $new_year);
786 $error = $cust_location->replace;
787 die $error if $error;
791 =item process_set_coord
793 Queueable function to find and fill in coordinates for all locations that
794 lack them. Because this uses the Google Maps API, it's internally rate
795 limited and must run in a single process.
799 sub process_set_coord {
801 # avoid starting multiple instances of this job
802 my @others = qsearch('queue', {
803 'status' => 'locked',
805 'jobnum' => {op=>'!=', value=>$job->jobnum},
809 $job->update_statustext('finding locations to update');
810 my @missing_coords = qsearch('cust_location', {
816 my $n = scalar @missing_coords;
817 for my $cust_location (@missing_coords) {
818 $cust_location->set_coord;
819 my $error = $cust_location->replace;
821 warn "error geocoding location#".$cust_location->locationnum.": $error\n";
824 $job->update_statustext("updated $i / $n locations");
825 dbh->commit; # so that we don't have to wait for the whole thing to finish
826 # Rate-limit to stay under the Google Maps usage limit (2500/day).
827 # 86,400 / 35 = 2,468 lookups per day.
832 die "failed to update ".$n-$i." locations\n";
837 =item process_standardize [ LOCATIONNUMS ]
839 Performs address standardization on locations with unclean addresses,
840 using whatever method you have configured. If the standardize_* method
841 returns a I<clean> address match, the location will be updated. This is
842 always an in-place update (because the physical location is the same,
843 and is just being referred to by a more accurate name).
845 Disabled locations will be skipped, as nobody cares.
847 If any LOCATIONNUMS are provided, only those locations will be updated.
851 sub process_standardize {
853 my @others = qsearch('queue', {
854 'status' => 'locked',
856 'jobnum' => {op=>'!=', value=>$job->jobnum},
859 my @locationnums = grep /^\d+$/, @_;
860 my $where = "AND locationnum IN(".join(',',@locationnums).")"
861 if scalar(@locationnums);
862 my @locations = qsearch({
863 table => 'cust_location',
864 hashref => { addr_clean => '', disabled => '' },
867 my $n_todo = scalar(@locations);
872 eval "use Text::CSV";
873 open $log, '>', "$FS::UID::cache_dir/process_standardize-" .
874 time2str('%Y%m%d',time) .
876 my $csv = Text::CSV->new({binary => 1, eol => "\n"});
878 foreach my $cust_location (@locations) {
879 $job->update_statustext( int(100 * $n_done/$n_todo) . ",$n_done / $n_todo locations" ) if $job;
880 my $result = FS::GeocodeCache->standardize($cust_location);
881 if ( $result->{addr_clean} and !$result->{error} ) {
882 my @cols = ($cust_location->locationnum);
883 foreach (keys %$result) {
884 push @cols, $cust_location->get($_), $result->{$_};
885 $cust_location->set($_, $result->{$_});
887 # bypass immutable field restrictions
888 my $error = $cust_location->FS::Record::replace;
889 warn "location ".$cust_location->locationnum.": $error\n" if $error;
890 $csv->print($log, \@cols);
893 dbh->commit; # so that we can resume if interrupted
901 # are we going to need to update tax districts?
902 my $use_districts = $conf->config('tax_district_method') ? 1 : 0;
904 # trim whitespace on records that need it
905 local $allow_location_edit = 1;
906 foreach my $field (qw(city county state country district)) {
907 foreach my $location (qsearch({
908 table => 'cust_location',
909 extra_sql => " WHERE $field LIKE ' %' OR $field LIKE '% '"
911 my $error = $location->replace;
912 die "$error (fixing whitespace in $field, locationnum ".$location->locationnum.')'
915 if ( $use_districts ) {
916 my $queue = new FS::queue {
917 'job' => 'FS::geocode_Mixin::process_district_update'
919 $error = $queue->insert( 'FS::cust_location' => $location->locationnum );
920 die $error if $error;
922 } # foreach $location
931 L<FS::cust_main_county>, L<FS::cust_pkg>, L<FS::Record>,
932 schema.html from the base documentation.