FS/FS/Report/FCC_477.pm

   1 package FS::Report::FCC_477;
   2 use base qw( FS::Report );
   3
   4 use strict;
   5 use vars qw( @upload @download @technology @part2aoption @part2boption
   6              %states
   7            );
   8 use FS::Record qw( dbh );
   9
  10 use Tie::IxHash;
  11 use Storable;
  12
  13 our $DEBUG = 0;
  14
  15 =head1 NAME
  16
  17 FS::Report::FCC_477 - Routines for FCC Form 477 reports
  18
  19 =head1 SYNOPSIS
  20
  21 =head1 BUGS
  22
  23 Documentation.
  24
  25 =head1 SEE ALSO
  26
  27 =cut
  28
  29 @upload = qw(
  30  <200kbps
  31  200-768kbps
  32  768kbps-1.5mbps
  33  1.5-3mpbs
  34  3-6mbps
  35  6-10mbps
  36  10-25mbps
  37  25-100mbps
  38  >100mbps
  39 );
  40
  41 @download = qw(
  42  200-768kbps
  43  768kbps-1.5mbps
  44  1.5-3mbps
  45  3-6mbps
  46  6-10mbps
  47  10-25mbps
  48  25-100mbps
  49  >100mbps
  50 );
  51
  52 @technology = (
  53   'Asymmetric xDSL',
  54   'Symmetric xDSL',
  55   'Other Wireline',
  56   'Cable Modem',
  57   'Optical Carrier',
  58   'Satellite',
  59   'Terrestrial Fixed Wireless',
  60   'Terrestrial Mobile Wireless',
  61   'Electric Power Line',
  62   'Other Technology',
  63 );
  64
  65 @part2aoption = (
  66  'LD carrier',
  67  'owned loops',
  68  'unswitched UNE loops',
  69  'UNE-P',
  70  'UNE-P replacement',
  71  'FTTP',
  72  'coax',
  73  'wireless',
  74 );
  75
  76 @part2boption = (
  77  'nomadic',
  78  'copper',
  79  'FTTP',
  80  'coax',
  81  'wireless',
  82  'other broadband',
  83 );
  84
  85 #from the select at http://www.ffiec.gov/census/default.aspx
  86 #though this is now in the database, also
  87 %states = (
  88   '01' => 'ALABAMA (AL)',
  89   '02' => 'ALASKA (AK)',
  90   '04' => 'ARIZONA (AZ)',
  91   '05' => 'ARKANSAS (AR)',
  92   '06' => 'CALIFORNIA (CA)',
  93   '08' => 'COLORADO (CO)',
  94
  95   '09' => 'CONNECTICUT (CT)',
  96   '10' => 'DELAWARE (DE)',
  97   '11' => 'DISTRICT OF COLUMBIA (DC)',
  98   '12' => 'FLORIDA (FL)',
  99   '13' => 'GEORGIA (GA)',
 100   '15' => 'HAWAII (HI)',
 101
 102   '16' => 'IDAHO (ID)',
 103   '17' => 'ILLINOIS (IL)',
 104   '18' => 'INDIANA (IN)',
 105   '19' => 'IOWA (IA)',
 106   '20' => 'KANSAS (KS)',
 107   '21' => 'KENTUCKY (KY)',
 108
 109   '22' => 'LOUISIANA (LA)',
 110   '23' => 'MAINE (ME)',
 111   '24' => 'MARYLAND (MD)',
 112   '25' => 'MASSACHUSETTS (MA)',
 113   '26' => 'MICHIGAN (MI)',
 114   '27' => 'MINNESOTA (MN)',
 115
 116   '28' => 'MISSISSIPPI (MS)',
 117   '29' => 'MISSOURI (MO)',
 118   '30' => 'MONTANA (MT)',
 119   '31' => 'NEBRASKA (NE)',
 120   '32' => 'NEVADA (NV)',
 121   '33' => 'NEW HAMPSHIRE (NH)',
 122
 123   '34' => 'NEW JERSEY (NJ)',
 124   '35' => 'NEW MEXICO (NM)',
 125   '36' => 'NEW YORK (NY)',
 126   '37' => 'NORTH CAROLINA (NC)',
 127   '38' => 'NORTH DAKOTA (ND)',
 128   '39' => 'OHIO (OH)',
 129
 130   '40' => 'OKLAHOMA (OK)',
 131   '41' => 'OREGON (OR)',
 132   '42' => 'PENNSYLVANIA (PA)',
 133   '44' => 'RHODE ISLAND (RI)',
 134   '45' => 'SOUTH CAROLINA (SC)',
 135   '46' => 'SOUTH DAKOTA (SD)',
 136
 137   '47' => 'TENNESSEE (TN)',
 138   '48' => 'TEXAS (TX)',
 139   '49' => 'UTAH (UT)',
 140   '50' => 'VERMONT (VT)',
 141   '51' => 'VIRGINIA (VA)',
 142   '53' => 'WASHINGTON (WA)',
 143
 144   '54' => 'WEST VIRGINIA (WV)',
 145   '55' => 'WISCONSIN (WI)',
 146   '56' => 'WYOMING (WY)',
 147   '72' => 'PUERTO RICO (PR)',
 148 );
 149
 150 sub restore_fcc477map {
 151   my $key = shift;
 152   FS::Record::scalar_sql('',"select formvalue from fcc477map where formkey = ?",$key);
 153 }
 154
 155 sub save_fcc477map {
 156   my $key = shift;
 157   my $value = shift;
 158
 159   local $SIG{HUP} = 'IGNORE';
 160   local $SIG{INT} = 'IGNORE';
 161   local $SIG{QUIT} = 'IGNORE';
 162   local $SIG{TERM} = 'IGNORE';
 163   local $SIG{TSTP} = 'IGNORE';
 164   local $SIG{PIPE} = 'IGNORE';
 165
 166   my $oldAutoCommit = $FS::UID::AutoCommit;
 167   local $FS::UID::AutoCommit = 0;
 168   my $dbh = dbh;
 169
 170   my $sql = "delete from fcc477map where formkey = ?";
 171   my $sth = dbh->prepare($sql) or die dbh->errstr;
 172   $sth->execute($key) or do {
 173     warn "WARNING: Error removing FCC 477 form defaults: " . $sth->errstr;
 174     $dbh->rollback if $oldAutoCommit;
 175   };
 176
 177   $sql = "insert into fcc477map (formkey,formvalue) values (?,?)";
 178   $sth = dbh->prepare($sql) or die dbh->errstr;
 179   $sth->execute($key,$value) or do {
 180     warn "WARNING: Error setting FCC 477 form defaults: " . $sth->errstr;
 181     $dbh->rollback if $oldAutoCommit;
 182   };
 183
 184   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 185
 186   '';
 187 }
 188
 189 sub parse_technology_option {
 190   my $cgi = shift;
 191   my $save = shift;
 192   my @result = ();
 193   my $i = 0;
 194   for (my $i = 0; $i < scalar(@technology); $i++) {
 195     my $value = $cgi->param("part1_technology_option_$i"); #lame
 196     save_fcc477map("part1_technology_option_$i",$value)
 197         if $save && $value =~ /^\d+$/;
 198     push @result, $value =~ /^\d+$/ ? $value : 0;
 199   }
 200   return (@result);
 201 }
 202
 203 sub statenum2state {
 204   my $num = shift;
 205   $states{$num};
 206 }
 207 ### everything above this point is unmaintained ###
 208
 209
 210 =head1 THE "NEW" REPORT (October 2014 and later)
 211
 212 =head2 METHODS
 213
 214 =over 4
 215
 216 =cut
 217
 218 # functions for internal use
 219
 220 sub join_optionnames {
 221   join(' ', map { join_optionname($_) } @_);
 222 }
 223
 224 sub join_optionnames_int {
 225   join(' ', map { join_optionname_int($_) } @_);
 226 }
 227
 228 sub join_optionname {
 229   # Returns a FROM phrase to join a specific option into the query (via
 230   # part_pkg).  The option value will appear as a field with the same name
 231   # as the option.
 232   my $name = shift;
 233   "LEFT JOIN (SELECT pkgpart, optionvalue AS $name FROM part_pkg_fcc_option".
 234     " WHERE fccoptionname = '$name') AS t_$name".
 235     " ON (part_pkg.pkgpart = t_$name.pkgpart)";
 236 }
 237
 238 sub join_optionname_int {
 239   # Returns a FROM phrase to join a specific option into the query (via
 240   # part_pkg) and cast it to integer..  Note this does not convert nulls
 241   # to zero.
 242   my $name = shift;
 243   "LEFT JOIN (SELECT pkgpart, CAST(optionvalue AS int) AS $name
 244    FROM part_pkg_fcc_option".
 245     " WHERE fccoptionname = '$name') AS t_$name".
 246     " ON (part_pkg.pkgpart = t_$name.pkgpart)";
 247 }
 248
 249 sub dbaname {
 250   # Returns an sql expression for the DBA name
 251   "COALESCE( deploy_zone.dbaname,
 252      (SELECT value FROM conf WHERE conf.name = 'company_name'
 253                              AND (conf.agentnum = deploy_zone.agentnum
 254                                   OR conf.agentnum IS NULL)
 255                              ORDER BY conf.agentnum IS NOT NULL DESC
 256                              LIMIT 1)
 257      ) AS dbaname"
 258 }
 259
 260 sub active_on {
 261   # Returns a condition to limit packages to those that were setup before a
 262   # certain date, and not canceled before that date.
 263   #
 264   # (Strictly speaking this should also exclude suspended packages but
 265   # "suspended as of some past date" is a complicated query.)
 266   my $date = shift;
 267   "cust_pkg.setup <= $date AND ".
 268   "(cust_pkg.cancel IS NULL OR cust_pkg.cancel > $date) AND ".
 269   "(cust_pkg.change_date IS NULL OR cust_pkg.change_date <= $date)"
 270 }
 271
 272 sub is_fixed_broadband {
 273   "is_broadband::int = 1 AND technology::int IN( 10, 11, 12, 20, 30, 40, 41, 42, 50, 60, 70, 90, 0 )"
 274 }
 275
 276 sub is_mobile_broadband {
 277   "is_broadband::int = 1 AND technology::int IN( 80, 81, 82, 83, 84, 85, 86, 87, 88)"
 278 }
 279
 280
 281 =item report SECTION, OPTIONS
 282
 283 Returns the report section SECTION (see the C<parts> method for section
 284 name strings).  OPTIONS may contain the following:
 285
 286 - date: a timestamp value. Packages that were active on that date will be
 287 counted.
 288
 289 - agentnum: limit to packages with this agent.
 290
 291 - ignore_quantity: if true, package quantities will be ignored (only distinct
 292 packages will be counted).
 293
 294 The result will be a hashref containing three parallel arrayrefs:
 295 - "data", the columns required by the FCC.
 296 - "detail", a list of the package numbers included in each row's aggregation
 297 - "error", a hashref containing any error status strings in that row. Keys
 298 are error identifiers, values are the messages to show the user.
 299 as well as an informational item:
 300 - "num_errors", the number of rows that contain errors
 301
 302 =item report_data SECTION, OPTIONS
 303
 304 Returns only the data, not the detail or error columns.  This is the part that
 305 will be submitted to the FCC.
 306
 307 =cut
 308
 309 sub report {
 310   my $class = shift;
 311   my $section = shift;
 312   my %opt = @_;
 313   $opt{detail} = 1;
 314
 315   # add the error column
 316   my $data = $class->report_data($section, %opt);
 317   my $error = [];
 318   my $detail = [];
 319   my $check_method = $section.'_check';
 320   my $num_errors = 0;
 321   foreach my $row (@$data) {
 322     if ( $class->can($check_method) ) { # they don't all have these
 323       my $eh = $class->$check_method( $row );
 324       $num_errors++ if keys(%$eh);
 325       push @$error, $eh
 326     }
 327     push @$detail, pop @$row; # this comes from the query
 328   }
 329
 330   return +{
 331     data => $data,
 332     error => $error,
 333     detail => $detail,
 334     num_errors => $num_errors,
 335   };
 336 }
 337
 338 sub report_data {
 339   my $class = shift;
 340   my $section = shift;
 341   my %opt = @_;
 342
 343   my $method = $section.'_sql';
 344   die "Report section '$section' is not implemented\n"
 345     unless $class->can($method);
 346   my $statement = $class->$method(%opt);
 347
 348   warn $statement if $DEBUG;
 349   my $sth = dbh->prepare($statement);
 350   $sth->execute or die $sth->errstr;
 351   return $sth->fetchall_arrayref;
 352 }
 353
 354 sub fbd_sql {
 355   my $class = shift;
 356   my %opt = @_;
 357   my $date = $opt{date} || time;
 358   my $agentnum = $opt{agentnum};
 359
 360   my @select = (
 361     'censusblock',
 362     dbaname(),
 363     'technology',
 364     'CASE WHEN is_consumer IS NOT NULL THEN 1 ELSE 0 END',
 365     'adv_speed_down',
 366     'adv_speed_up',
 367     'CASE WHEN is_business IS NOT NULL THEN 1 ELSE 0 END',
 368   );
 369   push @select, 'cir_speed_down', 'cir_speed_up'
 370     if $opt{date} < 1569826800; #9/30/2019, halfway between the two filing
 371                                 # "as of" dates when it changed
 372   push @select, 'blocknum'
 373     if $opt{detail};
 374
 375   my $from = 'deploy_zone_block
 376     JOIN deploy_zone USING (zonenum)
 377     JOIN agent USING (agentnum)';
 378   my @where = (
 379     "zonetype = 'B'",
 380     "active_date  < $date",
 381     "(expire_date > $date OR expire_date IS NULL)",
 382   );
 383   push @where, "agentnum = $agentnum" if $agentnum;
 384
 385   #my $order_by = 'censusblock, agentnum, technology, is_consumer, is_business';
 386   my $order_by = 'censusblock, technology';
 387
 388   "SELECT DISTINCT ".join(', ', @select) . "
 389   FROM $from
 390   WHERE ".join(' AND ', @where)."
 391   ORDER BY $order_by
 392   ";
 393 }
 394
 395 sub fbs_sql {
 396   my $class = shift;
 397   my %opt = @_;
 398   my $date = $opt{date} || time;
 399   my $agentnum = $opt{agentnum};
 400   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 401
 402   my $censustract = "substr( replace(cust_location.censustract, '.', ''), 1, 11)";
 403
 404   my @select = (
 405     "$censustract AS censustract",
 406     '(technology - technology % 10) AS media_type',
 407       # media types are multiples of 10
 408     'broadband_downstream',
 409     'broadband_upstream',
 410     "SUM($q)",
 411     "SUM(COALESCE(is_consumer,0) * $q)",
 412   );
 413   push @select, "array_to_string(array_agg(pkgnum), ',')" if $opt{detail};
 414
 415   my $from =
 416     'cust_pkg
 417       JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 418       JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 419       JOIN part_pkg USING (pkgpart) '.
 420       join_optionnames_int(qw(
 421         is_broadband technology
 422         is_consumer
 423         )).
 424       join_optionnames(qw(broadband_downstream broadband_upstream))
 425   ;
 426   my @where = (
 427     active_on($date),
 428     is_fixed_broadband()
 429   );
 430   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 431   my $group_by = "$censustract, technology, broadband_downstream, broadband_upstream ";
 432   my $order_by = $group_by;
 433
 434   "SELECT ".join(', ', @select) . "
 435   FROM $from
 436   WHERE ".join(' AND ', @where)."
 437   GROUP BY $group_by
 438   ORDER BY $order_by
 439   ";
 440
 441 }
 442
 443 sub fbs_check {
 444   my $class = shift;
 445   my $row = shift;
 446   my %e;
 447   #censustract
 448   if ( length($row->[0]) == 0 ) {
 449     $e{'censustract_null'} = 'The package location has no census tract.';
 450   } elsif ($row->[0] !~ /^\d{11}$/) {
 451     $e{'censustract_bad'} = 'The census tract must be exactly 11 digits.';
 452   }
 453
 454   #technology
 455   if ( length($row->[1]) == 0 ) {
 456     $e{'technology_null'} = 'The package has no technology type.';
 457   }
 458
 459   #speeds
 460   if ( length($row->[2]) == 0 or length($row->[3]) == 0 ) {
 461     $e{'speed_null'} = 'The package is missing downstream or upstream speeds.';
 462   } elsif ( $row->[2] !~ /^\d*(\.\d+)?$/ or $row->[3] !~ /^\d*(\.\d+)?$/ ) {
 463     $e{'speed_bad'} = 'The downstream and upstream speeds must be decimal numbers in Mbps.';
 464   } elsif ( $row->[2] == 0 or $row->[3] == 0 ) {
 465     $e{'speed_zero'} = 'The downstream and upstream speeds cannot be zero.';
 466   }
 467
 468   return \%e;
 469 }
 470
 471 sub fvs_sql {
 472   my $class = shift;
 473   my %opt = @_;
 474   my $date = $opt{date} || time;
 475   my $agentnum = $opt{agentnum};
 476   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 477   my $censustract = "substr( replace(cust_location.censustract, '.', ''), 1, 11)";
 478
 479   my @select = (
 480     "$censustract AS censustract",
 481     # VoIP indicator (0 for non-VoIP, 1 for VoIP)
 482     'COALESCE(is_voip, 0)',
 483     # number of lines/subscriptions
 484     "SUM($q * (CASE WHEN is_voip = 1 THEN 1 ELSE phone_lines END))",
 485     # consumer grade lines/subscriptions
 486     "SUM($q * COALESCE(is_consumer,0) * (CASE WHEN is_voip = 1 THEN voip_sessions ELSE phone_lines END))",
 487   );
 488   push @select, "array_to_string(array_agg(pkgnum), ',')" if $opt{detail};
 489
 490   my $from = 'cust_pkg
 491     JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 492     JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 493     JOIN part_pkg USING (pkgpart) '.
 494     join_optionnames_int(qw(
 495       is_phone is_voip is_consumer phone_lines voip_sessions
 496       ))
 497   ;
 498
 499   my @where = (
 500     active_on($date),
 501     "(is_voip = 1 OR is_phone = 1)",
 502   );
 503   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 504   my $group_by = "$censustract, COALESCE(is_voip, 0)";
 505   my $order_by = $group_by;
 506
 507   "SELECT ".join(', ', @select) . "
 508   FROM $from
 509   WHERE ".join(' AND ', @where)."
 510   GROUP BY $group_by
 511   ORDER BY $order_by
 512   ";
 513
 514 }
 515
 516 sub fvs_check {
 517   my $class = shift;
 518   my $row = shift;
 519   my %e;
 520   #censustract
 521   if ( length($row->[0]) == 0 ) {
 522     $e{'censustract_null'} = 'The package location has no census tract.';
 523   } elsif ($row->[0] !~ /^\d{11}$/) {
 524     $e{'censustract_bad'} = 'The census tract must be exactly 11 digits.';
 525   }
 526   return \%e;
 527 }
 528
 529 sub lts_sql {
 530   my $class = shift;
 531   my %opt = @_;
 532   my $date = $opt{date} || time;
 533   my $agentnum = $opt{agentnum};
 534   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 535
 536   my @select = (
 537     "state.fips",
 538     "SUM($q * phone_vges)",
 539     "SUM($q * phone_circuits)",
 540     "SUM($q * phone_lines)",
 541     "SUM($q * (CASE WHEN is_broadband = 1 THEN phone_lines ELSE 0 END))",
 542     "SUM($q * (CASE WHEN is_consumer = 1 AND phone_longdistance IS NULL THEN phone_lines ELSE 0 END))",
 543     "SUM($q * (CASE WHEN is_consumer = 1 AND phone_longdistance = 1 THEN phone_lines ELSE 0 END))",
 544     "SUM($q * (CASE WHEN is_consumer IS NULL AND phone_longdistance IS NULL THEN phone_lines ELSE 0 END))",
 545     "SUM($q * (CASE WHEN is_consumer IS NULL AND phone_longdistance = 1 THEN phone_lines ELSE 0 END))",
 546     "SUM($q * (CASE WHEN phone_localloop = 'owned' THEN phone_lines ELSE 0 END))",
 547     "SUM($q * (CASE WHEN phone_localloop = 'leased' THEN phone_lines ELSE 0 END))",
 548     "SUM($q * (CASE WHEN phone_localloop = 'resale' THEN phone_lines ELSE 0 END))",
 549     "SUM($q * (CASE WHEN media = 'Fiber' THEN phone_lines ELSE 0 END))",
 550     "SUM($q * (CASE WHEN media = 'Cable Modem' THEN phone_lines ELSE 0 END))",
 551     "SUM($q * (CASE WHEN media = 'Fixed Wireless' THEN phone_lines ELSE 0 END))",
 552   );
 553   push @select, "array_to_string(array_agg(pkgnum),',')" if $opt{detail};
 554
 555   my $from =
 556     'cust_pkg
 557       JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 558       JOIN state USING (country, state)
 559       JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 560       JOIN part_pkg USING (pkgpart) '.
 561       join_optionnames_int(qw(
 562         is_phone is_broadband
 563         phone_vges phone_circuits phone_lines
 564         is_consumer phone_longdistance
 565         )).
 566       join_optionnames('media', 'phone_localloop')
 567   ;
 568   my @where = (
 569     active_on($date),
 570     "is_phone = 1",
 571   );
 572   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 573   my $group_by = 'state.fips';
 574   my $order_by = $group_by;
 575
 576   "SELECT ".join(', ', @select) . "
 577   FROM $from
 578   WHERE ".join(' AND ', @where)."
 579   GROUP BY $group_by
 580   ORDER BY $order_by
 581   ";
 582 }
 583
 584 # voip_sql has a special case: the fifth column, "Voice with Internet",
 585 # must test whether there are _any_ broadband packages at the same location,
 586 # not just whether this package is both VoIP and broadband.
 587
 588 sub voip_sql {
 589   my $class = shift;
 590   my %opt = @_;
 591   my $date = $opt{date} || time;
 592   my $agentnum = $opt{agentnum};
 593   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 594
 595   # subquery to test whether there's an is_broadband package at this location
 596   my $broadband_pkg =
 597     "SELECT 1 FROM cust_pkg AS broadband_pkg
 598     WHERE broadband_pkg.locationnum = cust_pkg.locationnum
 599     AND EXISTS(SELECT 1 FROM part_pkg_fcc_option
 600       WHERE fccoptionname = 'is_broadband'
 601       AND part_pkg_fcc_option.pkgpart = broadband_pkg.pkgpart
 602       AND optionvalue = '1')
 603     AND ".  active_on( $date );
 604
 605   my $has_broadband = "EXISTS($broadband_pkg)";
 606
 607   my @select = (
 608     "state.fips",
 609     # OTT, OTT + consumer
 610     "SUM($q * (CASE WHEN (voip_lastmile IS NULL) THEN 1 ELSE 0 END))",
 611     "SUM($q * (CASE WHEN (voip_lastmile IS NULL AND is_consumer = 1) THEN 1 ELSE 0 END))",
 612     # non-OTT: total, consumer, broadband bundle, media types
 613     "SUM($q * (CASE WHEN (voip_lastmile = 1) THEN 1 ELSE 0 END))",
 614     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND is_consumer = 1) THEN 1 ELSE 0 END))",
 615     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND $has_broadband) THEN 1 ELSE 0 END))",
 616     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND media = 'Copper') THEN 1 ELSE 0 END))",
 617     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND media = 'Fiber') THEN 1 ELSE 0 END))",
 618     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND media = 'Cable Modem') THEN 1 ELSE 0 END))",
 619     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND media = 'Fixed Wireless') THEN 1 ELSE 0 END))",
 620     "SUM($q * (CASE WHEN (voip_lastmile = 1 AND media NOT IN('Copper', 'Fiber', 'Cable Modem', 'Fixed Wireless') ) THEN 1 ELSE 0 END))",
 621   );
 622   push @select, "array_to_string(array_agg(pkgnum),',')" if $opt{detail};
 623
 624   my $from =
 625     'cust_pkg
 626       JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 627       JOIN state USING (country, state)
 628       JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 629       JOIN part_pkg USING (pkgpart) '.
 630       join_optionnames_int(
 631         qw( is_voip is_consumer voip_lastmile)
 632       ).
 633       join_optionnames('media')
 634   ;
 635   my @where = (
 636     active_on($date),
 637     "is_voip = 1",
 638   );
 639   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 640   my $group_by = 'state.fips';
 641   my $order_by = $group_by;
 642
 643   "SELECT ".join(', ', @select) . "
 644   FROM $from
 645   WHERE ".join(' AND ', @where)."
 646   GROUP BY $group_by
 647   ORDER BY $order_by
 648   ";
 649 }
 650
 651 sub mbs_sql {
 652   my $class = shift;
 653   my %opt = @_;
 654   my $date = $opt{date} || time;
 655   my $agentnum = $opt{agentnum};
 656   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 657
 658   my @select = (
 659     'state.fips',
 660     'broadband_downstream',
 661     'broadband_upstream',
 662     "SUM($q)",
 663     "SUM(COALESCE(is_consumer, 0) * $q)",
 664   );
 665   push @select, "array_to_string(array_agg(pkgnum),',')" if $opt{detail};
 666
 667   my $from =
 668     'cust_pkg
 669       JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 670       JOIN state USING (country, state)
 671       JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 672       JOIN part_pkg USING (pkgpart) '.
 673       join_optionnames_int(qw(
 674         is_broadband technology
 675         is_consumer
 676         )).
 677       join_optionnames(qw(broadband_downstream broadband_upstream))
 678   ;
 679   my @where = (
 680     active_on($date),
 681     is_mobile_broadband()
 682   );
 683   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 684   my $group_by = 'state.fips, broadband_downstream, broadband_upstream ';
 685   my $order_by = $group_by;
 686
 687   "SELECT ".join(', ', @select) . "
 688   FROM $from
 689   WHERE ".join(' AND ', @where)."
 690   GROUP BY $group_by
 691   ORDER BY $order_by
 692   ";
 693 }
 694
 695 sub mvs_sql {
 696   my $class = shift;
 697   my %opt = @_;
 698   my $date = $opt{date} || time;
 699   my $agentnum = $opt{agentnum};
 700   my $q = $opt{ignore_quantity} ? '1' : 'COALESCE(cust_pkg.quantity, 1)';
 701
 702   my @select = (
 703     'state.fips',
 704     "SUM($q)",
 705     "SUM($q * COALESCE(mobile_direct,0))",
 706   );
 707   push @select, "array_to_string(array_agg(pkgnum),',')" if $opt{detail};
 708
 709   my $from =
 710     'cust_pkg
 711       JOIN cust_location ON (cust_pkg.locationnum = cust_location.locationnum)
 712       JOIN state USING (country, state)
 713       JOIN cust_main ON (cust_pkg.custnum = cust_main.custnum)
 714       JOIN part_pkg USING (pkgpart) '.
 715       join_optionnames_int(qw( is_mobile mobile_direct) )
 716   ;
 717   my @where = (
 718     active_on($date),
 719     'is_mobile = 1'
 720   );
 721   push @where, "cust_main.agentnum = $agentnum" if $agentnum;
 722   my $group_by = 'state.fips';
 723   my $order_by = $group_by;
 724
 725   "SELECT ".join(', ', @select) . "
 726   FROM $from
 727   WHERE ".join(' AND ', @where)."
 728   GROUP BY $group_by
 729   ORDER BY $order_by
 730   ";
 731 }
 732
 733 =item parts
 734
 735 Returns a Tie::IxHash reference of the internal short names used for the
 736 report sections ('fbd', 'mbs', etc.) to the full names.
 737
 738 =cut
 739
 740 tie our %parts, 'Tie::IxHash', (
 741   fbd   => 'Fixed Broadband Deployment',
 742   fbs   => 'Fixed Broadband Subscription',
 743   fvs   => 'Fixed Voice Subscription',
 744   lts   => 'Local Exchange Telephone Subscription',
 745   voip  => 'Interconnected VoIP Subscription',
 746   mbd   => 'Mobile Broadband Deployment',
 747   mbsa  => 'Mobile Broadband Service Availability',
 748   mbs   => 'Mobile Broadband Subscription',
 749   mvd   => 'Mobile Voice Deployment',
 750   mvs   => 'Mobile Voice Subscription',
 751 );
 752
 753 sub parts {
 754   Storable::dclone(\%parts);
 755 }
 756
 757 =item part_table SECTION
 758
 759 Returns the name of the primary table that's aggregated in the report section
 760 SECTION. The last column of the report returned by the L</report> method is
 761 a comma-separated list of record numbers, in this table, that are included in
 762 the report line item.
 763
 764 =cut
 765
 766 sub part_table {
 767   my ($class, $part) = @_;
 768   if ($part eq 'fbd') {
 769     return 'deploy_zone_block';
 770   } else {
 771     return 'cust_pkg';
 772   } # add other cases as we add more of the deployment/availability reports
 773 }
 774
 775 1;