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
285 foreach (qw(address1 address2 city state zip country)) {
286 if ( $self->$_ ne $old->$_ ) {
287 return "can't change cust_location field $_";
291 my $oldAutoCommit = $FS::UID::AutoCommit;
292 local $FS::UID::AutoCommit = 0;
295 my $error = $self->SUPER::replace($old);
297 $dbh->rollback if $oldAutoCommit;
301 # cust_location exports
302 #my $export_args = $options{'export_args'} || [];
305 map qsearch( 'part_export', {exportnum=>$_} ),
306 $conf->config('cust_location-exports'); #, $agentnum
308 foreach my $part_export ( @part_export ) {
309 my $error = $part_export->export_replace($self, $old); #, @$export_args);
311 $dbh->rollback if $oldAutoCommit;
312 return "exporting to ". $part_export->exporttype.
313 " (transaction rolled back): $error";
318 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
325 Checks all fields to make sure this is a valid location. If there is
326 an error, returns the error, otherwise returns false. Called by the insert
334 return '' if $self->disabled; # so that disabling locations never fails
337 $self->ut_numbern('locationnum')
338 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
339 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
340 || $self->ut_textn('locationname')
341 || $self->ut_text('address1')
342 || $self->ut_textn('address2')
343 || ($conf->exists('cust_main-no_city_in_address')
344 ? $self->ut_textn('city')
345 : $self->ut_text('city'))
346 || $self->ut_textn('county')
347 || $self->ut_textn('state')
348 || $self->ut_country('country')
349 || (!$import && $self->ut_zip('zip', $self->country))
350 || $self->ut_coordn('latitude')
351 || $self->ut_coordn('longitude')
352 || $self->ut_enum('coord_auto', [ '', 'Y' ])
353 || $self->ut_enum('addr_clean', [ '', 'Y' ])
354 || $self->ut_alphan('location_type')
355 || $self->ut_textn('location_number')
356 || $self->ut_enum('location_kind', [ '', 'R', 'B' ] )
357 || $self->ut_alphan('geocode')
358 || $self->ut_alphan('district')
359 || $self->ut_numbern('censusyear')
361 return $error if $error;
362 if ( $self->censustract ne '' ) {
363 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
364 or return "Illegal census tract: ". $self->censustract;
366 $self->censustract("$1.$2");
369 if ( $conf->exists('cust_main-require_address2') and
370 !$self->ship_address2 =~ /\S/ ) {
371 return "Unit # is required";
374 # tricky...we have to allow for the customer to not be inserted yet
375 return "No prospect or customer!" unless $self->prospectnum
377 || $self->get('custnum_pending');
378 return "Prospect and customer!" if $self->prospectnum && $self->custnum;
380 return 'Location kind is required'
381 if $self->prospectnum
382 && $conf->exists('prospect_main-alt_address_format')
383 && ! $self->location_kind;
385 unless ( $import or qsearch('cust_main_county', {
386 'country' => $self->country,
389 return "Unknown state/county/country: ".
390 $self->state. "/". $self->county. "/". $self->country
391 unless qsearch('cust_main_county',{
392 'state' => $self->state,
393 'county' => $self->county,
394 'country' => $self->country,
398 # set coordinates, unless we already have them
399 if (!$import and !$self->latitude and !$self->longitude) {
408 Returns this location's full country name
412 #moved to geocode_Mixin.pm
416 Synonym for location_label
422 $self->location_label(@_);
425 =item has_ship_address
427 Returns false since cust_location objects do not have a separate shipping
432 sub has_ship_address {
438 Returns a list of key/value pairs, with the following keys: address1, address2,
439 city, county, state, zip, country, geocode, location_type, location_number,
444 =item disable_if_unused
446 Sets the "disabled" flag on the location if it is no longer in use as a
447 prospect location, package location, or a customer's billing or default
452 sub disable_if_unused {
455 my $locationnum = $self->locationnum;
456 return '' if FS::cust_main->count('bill_locationnum = '.$locationnum.' OR
457 ship_locationnum = '.$locationnum)
458 or FS::contact->count( 'locationnum = '.$locationnum)
459 or FS::cust_pkg->count('cancel IS NULL AND
460 locationnum = '.$locationnum)
462 $self->disabled('Y');
469 Takes a new L<FS::cust_location> object. Moves all packages that use the
470 existing location to the new one, then sets the "disabled" flag on the old
471 location. Returns nothing on success, an error message on error.
479 warn "move_to:\nFROM:".Dumper($old)."\nTO:".Dumper($new) if $DEBUG;
481 local $SIG{HUP} = 'IGNORE';
482 local $SIG{INT} = 'IGNORE';
483 local $SIG{QUIT} = 'IGNORE';
484 local $SIG{TERM} = 'IGNORE';
485 local $SIG{TSTP} = 'IGNORE';
486 local $SIG{PIPE} = 'IGNORE';
488 my $oldAutoCommit = $FS::UID::AutoCommit;
489 local $FS::UID::AutoCommit = 0;
493 # prevent this from failing because of pkg_svc quantity limits
494 local( $FS::cust_svc::ignore_quantity ) = 1;
496 if ( !$new->locationnum ) {
497 $error = $new->insert;
499 $dbh->rollback if $oldAutoCommit;
500 return "Error creating location: $error";
502 } elsif ( $new->locationnum == $old->locationnum ) {
503 # then they're the same location; the normal result of doing a minor
505 $dbh->commit if $oldAutoCommit;
509 # find all packages that have the old location as their service address,
510 # and aren't canceled,
511 # and aren't supplemental to another package.
512 my @pkgs = qsearch('cust_pkg', {
513 'locationnum' => $old->locationnum,
517 foreach my $cust_pkg (@pkgs) {
518 # don't move one-time charges that have already been charged
519 next if $cust_pkg->part_pkg->freq eq '0'
520 and ($cust_pkg->setup || 0) > 0;
522 $error = $cust_pkg->change(
523 'locationnum' => $new->locationnum,
526 if ( $error and not ref($error) ) {
527 $dbh->rollback if $oldAutoCommit;
528 return "Error moving pkgnum ".$cust_pkg->pkgnum.": $error";
532 $error = $old->disable_if_unused;
534 $dbh->rollback if $oldAutoCommit;
535 return "Error disabling old location: $error";
538 $dbh->commit if $oldAutoCommit;
544 Attempts to parse data for location_type and location_number from address1
552 return '' if $self->get('location_type')
553 || $self->get('location_number');
556 if ( 1 ) { #ikano, switch on via config
557 { no warnings 'void';
558 eval { 'use FS::part_export::ikano;' };
561 %parse = FS::part_export::ikano->location_types_parse;
566 foreach my $from ('address1', 'address2') {
567 foreach my $parse ( keys %parse ) {
568 my $value = $self->get($from);
569 if ( $value =~ s/(^|\W+)$parse\W+(\w+)\W*$//i ) {
570 $self->set('location_type', $parse{$parse});
571 $self->set('location_number', $2);
572 $self->set($from, $value);
578 #nothing matched, no changes
579 $self->get('address2')
580 ? "Can't parse unit type and number from address2"
586 Moves data from location_type and location_number to the end of address1.
593 #false laziness w/geocode_Mixin.pm::line
594 my $lt = $self->get('location_type');
598 if ( 1 ) { #ikano, switch on via config
599 { no warnings 'void';
600 eval { 'use FS::part_export::ikano;' };
603 %location_type = FS::part_export::ikano->location_types;
605 %location_type = (); #?
608 $self->address1( $self->address1. ' '. $location_type{$lt} || $lt );
609 $self->location_type('');
612 if ( length($self->location_number) ) {
613 $self->address1( $self->address1. ' '. $self->location_number );
614 $self->location_number('');
622 Returns the label of the location object.
630 Customer object (see L<FS::cust_main>)
634 Prospect object (see L<FS::prospect_main>)
638 String used to join location elements
642 Don't label the default service location as "Default service location".
643 May become the default at some point.
650 my( $self, %opt ) = @_;
652 my $prefix = $self->label_prefix;
653 $prefix .= ($opt{join_string} || ': ') if $prefix;
654 $prefix = '' if $opt{'no_prefix'};
656 $prefix . $self->SUPER::location_label(%opt);
661 Returns the optional site ID string (based on the cust_location-label_prefix
662 config option), "Default service location", or the empty string.
670 Customer object (see L<FS::cust_main>)
674 Prospect object (see L<FS::prospect_main>)
681 my( $self, %opt ) = @_;
683 my $cust_or_prospect = $opt{cust_main} || $opt{prospect_main};
684 unless ( $cust_or_prospect ) {
685 if ( $self->custnum ) {
686 $cust_or_prospect = FS::cust_main->by_key($self->custnum);
687 } elsif ( $self->prospectnum ) {
688 $cust_or_prospect = FS::prospect_main->by_key($self->prospectnum);
693 if ( $label_prefix eq 'CoStAg' ) {
694 my $agent = $conf->config('cust_main-custnum-display_prefix',
695 $cust_or_prospect->agentnum)
696 || $cust_or_prospect->agent->agent;
697 # else this location is invalid
698 $prefix = uc( join('',
700 ($self->state =~ /^(..)/),
702 sprintf('%05d', $self->locationnum)
705 } elsif ( $label_prefix eq '_location' && $self->locationname ) {
706 $prefix = $self->locationname;
708 } elsif ( ( $opt{'cust_main'} || $self->custnum )
709 && $self->locationnum == $cust_or_prospect->ship_locationnum ) {
710 $prefix = 'Default service location';
716 =item county_state_county
718 Returns a string consisting of just the county, state and country.
722 sub county_state_country {
724 my $label = $self->country;
725 $label = $self->state.", $label" if $self->state;
726 $label = $self->county." County, $label" if $self->county;
736 return '' unless $self->custnum;
737 qsearchs('cust_main', { 'custnum' => $self->custnum } );
746 =item process_censustract_update LOCATIONNUM
748 Queueable function to update the census tract to the current year (as set in
749 the 'census_year' configuration variable) and retrieve the new tract code.
753 sub process_censustract_update {
754 eval "use FS::GeocodeCache";
756 my $locationnum = shift;
758 qsearchs( 'cust_location', { locationnum => $locationnum })
759 or die "locationnum '$locationnum' not found!\n";
761 my $new_year = $conf->config('census_year') or return;
762 my $loc = FS::GeocodeCache->new( $cust_location->location_hash );
763 $loc->set_censustract;
764 my $error = $loc->get('censustract_error');
765 die $error if $error;
766 $cust_location->set('censustract', $loc->get('censustract'));
767 $cust_location->set('censusyear', $new_year);
768 $error = $cust_location->replace;
769 die $error if $error;
773 =item process_set_coord
775 Queueable function to find and fill in coordinates for all locations that
776 lack them. Because this uses the Google Maps API, it's internally rate
777 limited and must run in a single process.
781 sub process_set_coord {
783 # avoid starting multiple instances of this job
784 my @others = qsearch('queue', {
785 'status' => 'locked',
787 'jobnum' => {op=>'!=', value=>$job->jobnum},
791 $job->update_statustext('finding locations to update');
792 my @missing_coords = qsearch('cust_location', {
798 my $n = scalar @missing_coords;
799 for my $cust_location (@missing_coords) {
800 $cust_location->set_coord;
801 my $error = $cust_location->replace;
803 warn "error geocoding location#".$cust_location->locationnum.": $error\n";
806 $job->update_statustext("updated $i / $n locations");
807 dbh->commit; # so that we don't have to wait for the whole thing to finish
808 # Rate-limit to stay under the Google Maps usage limit (2500/day).
809 # 86,400 / 35 = 2,468 lookups per day.
814 die "failed to update ".$n-$i." locations\n";
819 =item process_standardize [ LOCATIONNUMS ]
821 Performs address standardization on locations with unclean addresses,
822 using whatever method you have configured. If the standardize_* method
823 returns a I<clean> address match, the location will be updated. This is
824 always an in-place update (because the physical location is the same,
825 and is just being referred to by a more accurate name).
827 Disabled locations will be skipped, as nobody cares.
829 If any LOCATIONNUMS are provided, only those locations will be updated.
833 sub process_standardize {
835 my @others = qsearch('queue', {
836 'status' => 'locked',
838 'jobnum' => {op=>'!=', value=>$job->jobnum},
841 my @locationnums = grep /^\d+$/, @_;
842 my $where = "AND locationnum IN(".join(',',@locationnums).")"
843 if scalar(@locationnums);
844 my @locations = qsearch({
845 table => 'cust_location',
846 hashref => { addr_clean => '', disabled => '' },
849 my $n_todo = scalar(@locations);
854 eval "use Text::CSV";
855 open $log, '>', "$FS::UID::cache_dir/process_standardize-" .
856 time2str('%Y%m%d',time) .
858 my $csv = Text::CSV->new({binary => 1, eol => "\n"});
860 foreach my $cust_location (@locations) {
861 $job->update_statustext( int(100 * $n_done/$n_todo) . ",$n_done / $n_todo locations" ) if $job;
862 my $result = FS::GeocodeCache->standardize($cust_location);
863 if ( $result->{addr_clean} and !$result->{error} ) {
864 my @cols = ($cust_location->locationnum);
865 foreach (keys %$result) {
866 push @cols, $cust_location->get($_), $result->{$_};
867 $cust_location->set($_, $result->{$_});
869 # bypass immutable field restrictions
870 my $error = $cust_location->FS::Record::replace;
871 warn "location ".$cust_location->locationnum.": $error\n" if $error;
872 $csv->print($log, \@cols);
875 dbh->commit; # so that we can resume if interrupted
884 L<FS::cust_main_county>, L<FS::cust_pkg>, L<FS::Record>,
885 schema.html from the base documentation.