FS/bin/freeside-censustract-update

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use Getopt::Std;
   5 use Date::Parse 'str2time';
   6 use FS::UID qw(adminsuidsetup);
   7 use FS::Record qw(qsearch dbh);
   8 use FS::Conf;
   9 use FS::cust_location;
  10 use FS::h_cust_location;
  11
  12 my %opt;
  13 getopts('d:', \%opt);
  14
  15 my $user = shift or die &usage;
  16 adminsuidsetup($user);
  17 $FS::UID::AutoCommit = 0;
  18 my $dbh = dbh;
  19
  20 my $conf = FS::Conf->new;
  21 my $current_year = $conf->config('census_year')
  22   or die "No current census year configured.\n";
  23 my $date = str2time($opt{d}) if $opt{d};
  24 $date ||= time;
  25 # This now operates on cust_location, not cust_main.
  26 # Find all locations that, as of $date, did not have
  27 # censusyear = the current year.  This includes those
  28 # that have no censusyear.
  29 my %h_cust_location = map { $_->locationnum => $_ }
  30   qsearch(
  31     'h_cust_location',
  32     { censusyear => { op => '!=', value => $current_year } },
  33     FS::h_cust_location->sql_h_search($date),
  34   ) ;
  35
  36 # Find all locations that don't have censusyear = the current
  37 # year as of now.
  38 my @cust_location = qsearch( 'cust_location',
  39   { censusyear => { op => '!=', value => $current_year } },
  40 );
  41
  42 warn scalar(@cust_location)." records found.\n";
  43 my $queued = 0; my $updated = 0;
  44 foreach my $cust_location (@cust_location) {
  45   my $error;
  46   my $h = $h_cust_location{$cust_location->locationnum};
  47   if ( defined($h) and $h->censustract eq $cust_location->censustract ) {
  48     # Then the location's censustract hasn't been changed since $date
  49     # (or it didn't exist on $date, or $date is now).  Queue a censustract
  50     # update for it.
  51     my $job = FS::queue->new({
  52         job => 'FS::cust_location::process_censustract_update'
  53     });
  54     $error = $job->insert($cust_location->locationnum);
  55     $queued++;
  56   }
  57   elsif ($cust_location->censusyear eq '') {
  58     # Then it's been updated since $date, but somehow has a null censusyear.
  59     # (Is this still relevant?)
  60     $cust_location->set('censusyear', $current_year);
  61     $error = $cust_location->replace;
  62     $updated++;
  63   } # Else it's been updated since $date, so leave it alone.
  64   if ( $error ) {
  65     $dbh->rollback;
  66     die "error updating ".$cust_location->locationnum.": $error\n";
  67   }
  68 }
  69 warn "Queued $queued census code lookups, updated year in $updated records.\n";
  70 $dbh->commit;
  71
  72 sub usage {
  73     "Usage:\n\n  freeside-censustract-update [ -d date ] user\n\n"
  74   }
  75
  76 =head1 NAME
  77
  78 freeside-censustract-update - Update census tract codes to the current year.
  79
  80 =head1 SYNOPSIS
  81
  82   freeside-censustract-update [ -d date ] user
  83
  84 =head1 DESCRIPTION
  85
  86 Finds all customers whose census tract codes don't appear to be current
  87 and updates them to the current year.  The "current year" is defined by
  88 the I<census_tract> configuration variable, not the calendar year.
  89
  90 The -d option tells the script to assume that tract codes last modified
  91 after some date are already current.  Those customers will just have
  92 their 'censusyear' field set to the current year.  For all other
  93 customers with non-current censusyear values, the current tract code
  94 will be looked up externally and stored in the censustract field.
  95
  96 The actual tract code lookup runs from the job queue, because it's slow.
  97 A separate job will be created for each customer.
  98
  99 =cut