1 package FS::cust_location;
2 use base qw( FS::geocode_Mixin FS::Record );
5 use vars qw( $import $DEBUG $conf $label_prefix );
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 Disabled flag; set to 'Y' to disable the location.
108 Creates a new location. To add the location to the database, see L<"insert">.
110 Note that this stores the hash reference, not a distinct copy of the hash it
111 points to. You can ask the object for a copy with the I<hash> method.
115 sub table { 'cust_location'; }
119 Finds an existing location matching the customer and address values in this
120 location, if one exists, and sets the contents of this location equal to that
121 one (including its locationnum).
123 If an existing location is not found, this one I<will> be inserted. (This is a
124 change from the "new_or_existing" method that this replaces.)
126 The following fields are considered "essential" and I<must> match: custnum,
127 address1, address2, city, county, state, zip, country, location_number,
128 location_type, location_kind. Disabled locations will be found only if this
129 location is set to disabled.
131 All other fields are considered "non-essential" and will be ignored in
132 finding a matching location. If the existing location doesn't match
133 in these fields, it will be updated in-place to match.
135 Returns an error string if inserting or updating a location failed.
137 It is unfortunately hard to determine if this created a new location or not.
144 warn "find_or_insert:\n".Dumper($self) if $DEBUG;
146 my @essential = (qw(custnum address1 address2 city county state zip country
147 location_number location_type location_kind disabled));
149 if ($conf->exists('cust_main-no_city_in_address')) {
150 warn "Warning: passed city to find_or_insert when cust_main-no_city_in_address is configured, ignoring it"
151 if $self->get('city');
152 $self->set('city','');
155 # I don't think this is necessary
156 #if ( !$self->coord_auto and $self->latitude and $self->longitude ) {
157 # push @essential, qw(latitude longitude);
158 # # but NOT coord_auto; if the latitude and longitude match the geocoded
159 # # values then that's good enough
162 # put nonempty, nonessential fields/values into this hash
163 my %nonempty = map { $_ => $self->get($_) }
164 grep {$self->get($_)} $self->fields;
165 delete @nonempty{@essential};
166 delete $nonempty{'locationnum'};
168 my %hash = map { $_ => $self->get($_) } @essential;
169 my @matches = qsearch('cust_location', \%hash);
171 # we no longer reject matches for having different values in nonessential
172 # fields; we just alter the record to match
174 my $old = $matches[0];
175 warn "found existing location #".$old->locationnum."\n" if $DEBUG;
176 foreach my $field (keys %nonempty) {
177 if ($old->get($field) ne $nonempty{$field}) {
178 warn "altering $field to match requested location" if $DEBUG;
179 $old->set($field, $nonempty{$field});
183 if ( $old->modified ) {
184 warn "updating non-essential fields\n" if $DEBUG;
185 my $error = $old->replace;
186 return $error if $error;
188 # set $self equal to $old
189 foreach ($self->fields) {
190 $self->set($_, $old->get($_));
195 # didn't find a match
196 warn "not found; inserting new location\n" if $DEBUG;
197 return $self->insert;
202 Adds this record to the database. If there is an error, returns the error,
203 otherwise returns false.
210 if ($conf->exists('cust_main-no_city_in_address')) {
211 warn "Warning: passed city to insert when cust_main-no_city_in_address is configured, ignoring it"
212 if $self->get('city');
213 $self->set('city','');
216 if ( $self->censustract ) {
217 $self->set('censusyear' => $conf->config('census_year') || 2012);
220 my $oldAutoCommit = $FS::UID::AutoCommit;
221 local $FS::UID::AutoCommit = 0;
224 my $error = $self->SUPER::insert(@_);
226 $dbh->rollback if $oldAutoCommit;
230 #false laziness with cust_main, will go away eventually
231 if ( !$import and $conf->config('tax_district_method') ) {
233 my $queue = new FS::queue {
234 'job' => 'FS::geocode_Mixin::process_district_update'
236 $error = $queue->insert( ref($self), $self->locationnum );
238 $dbh->rollback if $oldAutoCommit;
244 # cust_location exports
245 #my $export_args = $options{'export_args'} || [];
248 map qsearch( 'part_export', {exportnum=>$_} ),
249 $conf->config('cust_location-exports'); #, $agentnum
251 foreach my $part_export ( @part_export ) {
252 my $error = $part_export->export_insert($self); #, @$export_args);
254 $dbh->rollback if $oldAutoCommit;
255 return "exporting to ". $part_export->exporttype.
256 " (transaction rolled back): $error";
261 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
267 Delete this record from the database.
269 =item replace OLD_RECORD
271 Replaces the OLD_RECORD with this one in the database. If there is an error,
272 returns the error, otherwise returns false.
279 $old ||= $self->replace_old;
281 warn "Warning: passed city to replace when cust_main-no_city_in_address is configured"
282 if $conf->exists('cust_main-no_city_in_address') && $self->get('city');
284 # the following fields are immutable if this is a customer location. if
285 # it's a prospect location, then there are no active packages, no billing
286 # history, no taxes, and in general no reason to keep the old location
288 if ( $self->custnum ) {
289 foreach (qw(address1 address2 city state zip country)) {
290 if ( $self->$_ ne $old->$_ ) {
291 return "can't change cust_location field $_";
296 my $oldAutoCommit = $FS::UID::AutoCommit;
297 local $FS::UID::AutoCommit = 0;
300 my $error = $self->SUPER::replace($old);
302 $dbh->rollback if $oldAutoCommit;
306 # cust_location exports
307 #my $export_args = $options{'export_args'} || [];
310 map qsearch( 'part_export', {exportnum=>$_} ),
311 $conf->config('cust_location-exports'); #, $agentnum
313 foreach my $part_export ( @part_export ) {
314 my $error = $part_export->export_replace($self, $old); #, @$export_args);
316 $dbh->rollback if $oldAutoCommit;
317 return "exporting to ". $part_export->exporttype.
318 " (transaction rolled back): $error";
323 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
330 Checks all fields to make sure this is a valid location. If there is
331 an error, returns the error, otherwise returns false. Called by the insert
339 return '' if $self->disabled; # so that disabling locations never fails
342 $self->ut_numbern('locationnum')
343 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
344 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
345 || $self->ut_textn('locationname')
346 || $self->ut_text('address1')
347 || $self->ut_textn('address2')
348 || ($conf->exists('cust_main-no_city_in_address')
349 ? $self->ut_textn('city')
350 : $self->ut_text('city'))
351 || $self->ut_textn('county')
352 || $self->ut_textn('state')
353 || $self->ut_country('country')
354 || (!$import && $self->ut_zip('zip', $self->country))
355 || $self->ut_coordn('latitude')
356 || $self->ut_coordn('longitude')
357 || $self->ut_enum('coord_auto', [ '', 'Y' ])
358 || $self->ut_enum('addr_clean', [ '', 'Y' ])
359 || $self->ut_alphan('location_type')
360 || $self->ut_textn('location_number')
361 || $self->ut_enum('location_kind', [ '', 'R', 'B' ] )
362 || $self->ut_alphan('geocode')
363 || $self->ut_alphan('district')
364 || $self->ut_numbern('censusyear')
366 return $error if $error;
367 if ( $self->censustract ne '' ) {
368 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
369 or return "Illegal census tract: ". $self->censustract;
371 $self->censustract("$1.$2");
374 if ( $conf->exists('cust_main-require_address2') and
375 !$self->ship_address2 =~ /\S/ ) {
376 return "Unit # is required";
379 # tricky...we have to allow for the customer to not be inserted yet
380 return "No prospect or customer!" unless $self->prospectnum
382 || $self->get('custnum_pending');
383 return "Prospect and customer!" if $self->prospectnum && $self->custnum;
385 return 'Location kind is required'
386 if $self->prospectnum
387 && $conf->exists('prospect_main-alt_address_format')
388 && ! $self->location_kind;
390 unless ( $import or qsearch('cust_main_county', {
391 'country' => $self->country,
394 return "Unknown state/county/country: ".
395 $self->state. "/". $self->county. "/". $self->country
396 unless qsearch('cust_main_county',{
397 'state' => $self->state,
398 'county' => $self->county,
399 'country' => $self->country,
403 # set coordinates, unless we already have them
404 if (!$import and !$self->latitude and !$self->longitude) {
413 Returns this location's full country name
417 #moved to geocode_Mixin.pm
421 Synonym for location_label
427 $self->location_label(@_);
430 =item has_ship_address
432 Returns false since cust_location objects do not have a separate shipping
437 sub has_ship_address {
443 Returns a list of key/value pairs, with the following keys: address1, address2,
444 city, county, state, zip, country, geocode, location_type, location_number,
449 =item disable_if_unused
451 Sets the "disabled" flag on the location if it is no longer in use as a
452 prospect location, package location, or a customer's billing or default
457 sub disable_if_unused {
460 my $locationnum = $self->locationnum;
461 return '' if FS::cust_main->count('bill_locationnum = '.$locationnum.' OR
462 ship_locationnum = '.$locationnum)
463 or FS::contact->count( 'locationnum = '.$locationnum)
464 or FS::cust_pkg->count('cancel IS NULL AND
465 locationnum = '.$locationnum)
467 $self->disabled('Y');
474 Takes a new L<FS::cust_location> object. Moves all packages that use the
475 existing location to the new one, then sets the "disabled" flag on the old
476 location. Returns nothing on success, an error message on error.
484 warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG;
486 local $SIG{HUP} = 'IGNORE';
487 local $SIG{INT} = 'IGNORE';
488 local $SIG{QUIT} = 'IGNORE';
489 local $SIG{TERM} = 'IGNORE';
490 local $SIG{TSTP} = 'IGNORE';
491 local $SIG{PIPE} = 'IGNORE';
493 my $oldAutoCommit = $FS::UID::AutoCommit;
494 local $FS::UID::AutoCommit = 0;
498 # prevent this from failing because of pkg_svc quantity limits
499 local( $FS::cust_svc::ignore_quantity ) = 1;
501 if ( !$new->locationnum ) {
502 $error = $new->insert;
504 $dbh->rollback if $oldAutoCommit;
505 return "Error creating location: $error";
507 } elsif ( $new->locationnum == $old->locationnum ) {
508 # then they're the same location; the normal result of doing a minor
510 $dbh->commit if $oldAutoCommit;
514 # find all packages that have the old location as their service address,
515 # and aren't canceled,
516 # and aren't supplemental to another package.
517 my @pkgs = qsearch('cust_pkg', {
518 'locationnum' => $old->locationnum,
522 foreach my $cust_pkg (@pkgs) {
523 # don't move one-time charges that have already been charged
524 next if $cust_pkg->part_pkg->freq eq '0'
525 and ($cust_pkg->setup || 0) > 0;
527 $error = $cust_pkg->change(
528 'locationnum' => $new->locationnum,
531 if ( $error and not ref($error) ) {
532 $dbh->rollback if $oldAutoCommit;
533 return "Error moving pkgnum ".$cust_pkg->pkgnum.": $error";
537 $error = $old->disable_if_unused;
539 $dbh->rollback if $oldAutoCommit;
540 return "Error disabling old location: $error";
543 $dbh->commit if $oldAutoCommit;
549 Attempts to parse data for location_type and location_number from address1
557 return '' if $self->get('location_type')
558 || $self->get('location_number');
561 if ( 1 ) { #ikano, switch on via config
562 { no warnings 'void';
563 eval { 'use FS::part_export::ikano;' };
566 %parse = FS::part_export::ikano->location_types_parse;
571 foreach my $from ('address1', 'address2') {
572 foreach my $parse ( keys %parse ) {
573 my $value = $self->get($from);
574 if ( $value =~ s/(^|\W+)$parse\W+(\w+)\W*$//i ) {
575 $self->set('location_type', $parse{$parse});
576 $self->set('location_number', $2);
577 $self->set($from, $value);
583 #nothing matched, no changes
584 $self->get('address2')
585 ? "Can't parse unit type and number from address2"
591 Moves data from location_type and location_number to the end of address1.
598 #false laziness w/geocode_Mixin.pm::line
599 my $lt = $self->get('location_type');
603 if ( 1 ) { #ikano, switch on via config
604 { no warnings 'void';
605 eval { 'use FS::part_export::ikano;' };
608 %location_type = FS::part_export::ikano->location_types;
610 %location_type = (); #?
613 $self->address1( $self->address1. ' '. $location_type{$lt} || $lt );
614 $self->location_type('');
617 if ( length($self->location_number) ) {
618 $self->address1( $self->address1. ' '. $self->location_number );
619 $self->location_number('');
627 Returns the label of the location object.
635 Customer object (see L<FS::cust_main>)
639 Prospect object (see L<FS::prospect_main>)
643 String used to join location elements
647 Don't label the default service location as "Default service location".
648 May become the default at some point.
655 my( $self, %opt ) = @_;
657 my $prefix = $self->label_prefix;
658 $prefix .= ($opt{join_string} || ': ') if $prefix;
659 $prefix = '' if $opt{'no_prefix'};
661 $prefix . $self->SUPER::location_label(%opt);
666 Returns the optional site ID string (based on the cust_location-label_prefix
667 config option), "Default service location", or the empty string.
675 Customer object (see L<FS::cust_main>)
679 Prospect object (see L<FS::prospect_main>)
686 my( $self, %opt ) = @_;
688 my $cust_or_prospect = $opt{cust_main} || $opt{prospect_main};
689 unless ( $cust_or_prospect ) {
690 if ( $self->custnum ) {
691 $cust_or_prospect = FS::cust_main->by_key($self->custnum);
692 } elsif ( $self->prospectnum ) {
693 $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum);
698 if ( $label_prefix eq 'CoStAg' ) {
699 my $agent = $conf->config('cust_main-custnum-display_prefix',
700 $cust_or_prospect->agentnum)
701 || $cust_or_prospect->agent->agent;
702 # else this location is invalid
703 $prefix = uc( join('',
705 ($self->state =~ /^(..)/),
707 sprintf('%05d', $self->locationnum)
710 } elsif ( $label_prefix eq '_location' && $self->locationname ) {
711 $prefix = $self->locationname;
713 } elsif ( ( $opt{'cust_main'} || $self->custnum )
714 && $self->locationnum == $cust_or_prospect->ship_locationnum ) {
715 $prefix = 'Default service location';
721 =item county_state_county
723 Returns a string consisting of just the county, state and country.
727 sub county_state_country {
729 my $label = $self->country;
730 $label = $self->state.", $label" if $self->state;
731 $label = $self->county." County, $label" if $self->county;
741 return '' unless $self->custnum;
742 qsearchs('cust_main', { 'custnum' => $self->custnum } );
751 =item process_censustract_update LOCATIONNUM
753 Queueable function to update the census tract to the current year (as set in
754 the 'census_year' configuration variable) and retrieve the new tract code.
758 sub process_censustract_update {
759 eval "use FS::GeocodeCache";
761 my $locationnum = shift;
763 qsearchs( 'cust_location', { locationnum => $locationnum })
764 or die "locationnum '$locationnum' not found!\n";
766 my $new_year = $conf->config('census_year') or return;
767 my $loc = FS::GeocodeCache->new( $cust_location->location_hash );
768 $loc->set_censustract;
769 my $error = $loc->get('censustract_error');
770 die $error if $error;
771 $cust_location->set('censustract', $loc->get('censustract'));
772 $cust_location->set('censusyear', $new_year);
773 $error = $cust_location->replace;
774 die $error if $error;
778 =item process_set_coord
780 Queueable function to find and fill in coordinates for all locations that
781 lack them. Because this uses the Google Maps API, it's internally rate
782 limited and must run in a single process.
786 sub process_set_coord {
788 # avoid starting multiple instances of this job
789 my @others = qsearch('queue', {
790 'status' => 'locked',
792 'jobnum' => {op=>'!=', value=>$job->jobnum},
796 $job->update_statustext('finding locations to update');
797 my @missing_coords = qsearch('cust_location', {
803 my $n = scalar @missing_coords;
804 for my $cust_location (@missing_coords) {
805 $cust_location->set_coord;
806 my $error = $cust_location->replace;
808 warn "error geocoding location#".$cust_location->locationnum.": $error\n";
811 $job->update_statustext("updated $i / $n locations");
812 dbh->commit; # so that we don't have to wait for the whole thing to finish
813 # Rate-limit to stay under the Google Maps usage limit (2500/day).
814 # 86,400 / 35 = 2,468 lookups per day.
819 die "failed to update ".$n-$i." locations\n";
824 =item process_standardize [ LOCATIONNUMS ]
826 Performs address standardization on locations with unclean addresses,
827 using whatever method you have configured. If the standardize_* method
828 returns a I<clean> address match, the location will be updated. This is
829 always an in-place update (because the physical location is the same,
830 and is just being referred to by a more accurate name).
832 Disabled locations will be skipped, as nobody cares.
834 If any LOCATIONNUMS are provided, only those locations will be updated.
838 sub process_standardize {
840 my @others = qsearch('queue', {
841 'status' => 'locked',
843 'jobnum' => {op=>'!=', value=>$job->jobnum},
846 my @locationnums = grep /^\d+$/, @_;
847 my $where = "AND locationnum IN(".join(',',@locationnums).")"
848 if scalar(@locationnums);
849 my @locations = qsearch({
850 table => 'cust_location',
851 hashref => { addr_clean => '', disabled => '' },
854 my $n_todo = scalar(@locations);
859 eval "use Text::CSV";
860 open $log, '>', "$FS::UID::cache_dir/process_standardize-" .
861 time2str('%Y%m%d',time) .
863 my $csv = Text::CSV->new({binary => 1, eol => "\n"});
865 foreach my $cust_location (@locations) {
866 $job->update_statustext( int(100 * $n_done/$n_todo) . ",$n_done / $n_todo locations" ) if $job;
867 my $result = FS::GeocodeCache->standardize($cust_location);
868 if ( $result->{addr_clean} and !$result->{error} ) {
869 my @cols = ($cust_location->locationnum);
870 foreach (keys %$result) {
871 push @cols, $cust_location->get($_), $result->{$_};
872 $cust_location->set($_, $result->{$_});
874 # bypass immutable field restrictions
875 my $error = $cust_location->FS::Record::replace;
876 warn "location ".$cust_location->locationnum.": $error\n" if $error;
877 $csv->print($log, \@cols);
880 dbh->commit; # so that we can resume if interrupted
889 L<FS::cust_main_county>, L<FS::cust_pkg>, L<FS::Record>,
890 schema.html from the base documentation.