1 package FS::cust_main::Location;
4 use vars qw( $DEBUG $me @location_fields );
5 use FS::Record qw(qsearch qsearchs);
13 $me = '[FS::cust_main::Location]';
17 # set up accessors for location fields
20 @location_fields = qw(
22 address1 address2 city county state zip country
23 district latitude longitude coord_auto censustract censusyear geocode
27 foreach my $f (@location_fields) {
28 *{"FS::cust_main::Location::$f"} = sub {
29 carp "WARNING: tried to set cust_main.$f with accessor" if (@_ > 1);
30 my $l = shift->bill_location;
33 *{"FS::cust_main::Location::ship_$f"} = sub {
34 carp "WARNING: tried to set cust_main.ship_$f with accessor" if (@_ > 1);
35 my $l = shift->ship_location;
43 #debugging shim--probably a performance hit, so remove this at some point
47 if ( $DEBUG and grep (/^(ship_)?($field)$/, @location_fields) ) {
48 carp "WARNING: tried to get() location field $field";
51 $self->FS::Record::get($field);
56 FS::cust_main::Location - Location-related methods for cust_main
60 These methods are available on FS::cust_main objects;
68 Returns an L<FS::cust_location> object for the customer's billing address.
74 $self->hashref->{bill_location}
75 ||= FS::cust_location->by_key($self->bill_locationnum)
76 # degraded mode--let the system keep running during upgrades
77 || FS::cust_location->new({
78 map { $_ => $self->get($_) } @location_fields
84 Returns an L<FS::cust_location> object for the customer's service address.
90 $self->hashref->{ship_location}
91 ||= FS::cust_location->by_key($self->ship_locationnum)
92 || FS::cust_location->new({
93 map { $_ => $self->get('ship_'.$_) || $self->get($_) } @location_fields
100 An alternative way of saying "bill_location or ship_location, depending on
101 if TYPE is 'bill' or 'ship'".
107 return $self->bill_location if $_[0] eq 'bill';
108 return $self->ship_location if $_[0] eq 'ship';
109 die "bad location type '$_[0]'";
118 =item location_fields
120 Returns a list of fields found in the location objects. All of these fields
121 can be read (but not written) by calling them as methods on the
122 L<FS::cust_main> object (prefixed with 'ship_' for the service address
127 sub location_fields { @location_fields }
133 eval "use FS::contact;
134 use FS::contact_class;
135 use FS::contact_phone;
138 local $FS::cust_location::import = 1;
142 # Step 0: set up contact classes and phone types
143 my $service_contact_class =
144 qsearchs('contact_class', { classname => 'Service'})
145 || new FS::contact_class { classname => 'Service'};
147 if ( !$service_contact_class->classnum ) {
148 warn "Creating service contact class.\n";
149 $error = $service_contact_class->insert;
150 die "error creating contact class for Service: $error" if $error;
152 my %phone_type = ( # fudge slightly
159 foreach (keys %phone_type) {
160 $phone_type{$_} = qsearchs('phone_type', { typename => $phone_type{$_}})
161 || new FS::phone_type { typename => $phone_type{$_},
163 # just in case someone still doesn't have these
164 if ( !$phone_type{$_}->phonetypenum ) {
165 $error = $phone_type{$_}->insert;
166 die "error creating phone type '$_': $error" if $error;
170 my $num_to_upgrade = FS::cust_main->count('bill_locationnum is null or ship_locationnum is null');
171 my $num_jobs = FS::queue->count('job = \'FS::cust_main::Location::process_upgrade_location\' and status != \'failed\'');
172 if ( $num_to_upgrade > 0 ) {
173 warn "Need to migrate $num_to_upgrade customer locations.\n";
176 if ( $num_jobs > 0 ) {
177 warn "Upgrade already queued.\n";
179 warn "Scheduling upgrade.\n";
180 my $job = FS::queue->new({ job => 'FS::cust_main::Location::process_upgrade_location' });
184 process_upgrade_location();
189 # repair an error in earlier upgrades
190 if (!FS::upgrade_journal->is_done('cust_location_censustract_repair')
191 and FS::Conf->new->exists('cust_main-require_censustract') ) {
193 foreach my $cust_location (
194 qsearch('cust_location', { 'censustract' => '' })
196 my $custnum = $cust_location->custnum;
197 next if !$custnum; # avoid doing this for prospect locations
198 my $address1 = $cust_location->address1;
199 # find the last history record that had that address
200 my $last_h = qsearchs({
201 table => 'h_cust_main',
202 extra_sql => " WHERE custnum = $custnum AND address1 = ".
203 dbh->quote($address1) .
204 " AND censustract IS NOT NULL",
205 order_by => " ORDER BY history_date DESC LIMIT 1",
208 # this is normal; just means it never had a census tract before
211 $cust_location->set('censustract' => $last_h->get('censustract'));
212 $cust_location->set('censusyear' => $last_h->get('censusyear'));
213 my $error = $cust_location->replace;
214 warn "Error setting census tract for customer #$custnum:\n $error\n"
216 } # foreach $cust_location
217 FS::upgrade_journal->set_done('cust_location_censustract_repair');
221 sub process_upgrade_location {
225 local $FS::cust_main::import = 1;
226 local $FS::cust_location::import = 1;
227 local $FS::contact::skip_fuzzyfiles = 1;
228 local $FS::UID::AutoCommit = 0;
230 my $tax_prefix = 'bill_';
231 if ( FS::Conf->new->exists('tax-ship_address') ) {
232 $tax_prefix = 'ship_';
235 # load some records that were created during the initial upgrade
236 my $service_contact_class =
237 qsearchs('contact_class', { classname => 'Service'});
245 foreach (keys %phone_type) {
246 $phone_type{$_} = qsearchs('phone_type', { typename => $phone_type{$_}});
250 tax_prefix => $tax_prefix,
251 service_contact_class => $service_contact_class,
252 phone_type => \%phone_type,
255 my $search = FS::Cursor->new('cust_main',
256 { bill_locationnum => '',
257 address1 => { op=>'!=', value=>'' }
259 while (my $cust_main = $search->fetch) {
260 my $error = $cust_main->upgrade_location(%opt);
262 warn "cust#".$cust_main->custnum.": $error\n";
271 sub upgrade_location { # instance method
272 my $cust_main = shift;
276 # Step 1: extract billing and service addresses into cust_location
277 my $custnum = $cust_main->custnum;
278 my $bill_location = FS::cust_location->new(
281 map { $_ => $cust_main->get($_) } location_fields(),
284 $bill_location->set('censustract', '');
285 $bill_location->set('censusyear', '');
286 # properly goes with ship_location; if they're the same, will be set
287 # on ship_location before inserting either one
288 my $ship_location = $bill_location; # until proven otherwise
290 if ( $cust_main->get('ship_address1') ) {
293 foreach (location_fields()) {
294 if ( length($cust_main->get("ship_$_")) and
295 $cust_main->get($_) ne $cust_main->get("ship_$_") ) {
301 $ship_location = FS::cust_location->new(
304 map { $_ => $cust_main->get("ship_$_") } location_fields()
307 } # else it stays equal to $bill_location
309 # Step 2: Extract shipping address contact fields into contact
310 my %unlike = map { $_ => 1 }
311 grep { $cust_main->get($_) ne $cust_main->get("ship_$_") }
312 qw( last first company daytime night fax mobile );
315 # then there IS a service contact
316 my $contact = FS::contact->new({
317 'custnum' => $custnum,
318 'classnum' => $opt{service_contact_class}->classnum,
319 'locationnum' => $ship_location->locationnum,
320 'last' => $cust_main->get('ship_last'),
321 'first' => $cust_main->get('ship_first'),
323 if ( !$cust_main->get('ship_last') or !$cust_main->get('ship_first') )
325 warn "customer $custnum has no service contact name; substituting ".
327 $contact->set('last' => $cust_main->get('last'));
328 $contact->set('first' => $cust_main->get('first'));
331 if ( $unlike{'company'} ) {
332 # there's no contact.company field, but keep a record of it
333 $contact->set(comment => 'Company: '.$cust_main->get('ship_company'));
335 $error = $contact->insert;
336 return "error migrating service contact for customer $custnum: $error"
339 foreach ( grep { $unlike{$_} } qw( daytime night fax mobile ) ) {
340 my $phone = $cust_main->get("ship_$_");
342 my $contact_phone = FS::contact_phone->new({
343 'contactnum' => $contact->contactnum,
344 'phonetypenum' => $opt{phone_type}->{$_}->phonetypenum,
345 FS::contact::_parse_phonestring( $phone )
347 $error = $contact_phone->insert;
348 return "error migrating service contact phone for customer $custnum: $error"
350 $cust_main->set("ship_$_" => '');
353 $cust_main->set("ship_$_" => '') foreach qw(last first company);
357 # special case: should go with whichever location is used to calculate
358 # taxes, because that's the one it originally came from
359 if ( my $geocode = $cust_main->get('geocode') ) {
360 $bill_location->set('geocode' => '');
361 $ship_location->set('geocode' => '');
363 if ( $opt{tax_prefix} eq 'bill_' ) {
364 $bill_location->set('geocode', $geocode);
365 } elsif ( $opt{tax_prefix} eq 'ship_' ) {
366 $ship_location->set('geocode', $geocode);
370 # this always goes with the ship_location (whether it's the same as
371 # bill_location or not)
372 $ship_location->set('censustract', $cust_main->get('censustract'));
373 $ship_location->set('censusyear', $cust_main->get('censusyear'));
375 $error = $bill_location->insert;
376 return "error migrating billing address for customer $custnum: $error"
379 $cust_main->set(bill_locationnum => $bill_location->locationnum);
381 if (!$ship_location->locationnum) {
382 $error = $ship_location->insert;
383 return "error migrating service address for customer $custnum: $error"
387 $cust_main->set(ship_locationnum => $ship_location->locationnum);
389 # Step 3: Wipe the migrated fields and update the cust_main
391 $cust_main->set("ship_$_" => '') foreach location_fields();
392 $cust_main->set($_ => '') foreach location_fields();
394 $error = $cust_main->replace;
395 return "error migrating addresses for customer $custnum: $error"
398 # Step 4: set packages at the "default service location" to ship_location
400 FS::Cursor->new('cust_pkg', { custnum => $custnum, locationnum => '' });
401 while (my $cust_pkg = $pkg_search->fetch) {
402 # not a location change
403 $cust_pkg->set('locationnum', $cust_main->ship_locationnum);
404 $error = $cust_pkg->replace;
405 return "error migrating package ".$cust_pkg->pkgnum.": $error"