bin/svc_broadband_update_speeds

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use Getopt::Std;
   5 use FS::UID qw(adminsuidsetup);
   6 use FS::Record qw(qsearch qsearchs);
   7 use FS::svc_broadband;
   8 use Data::Dumper;
   9
  10 ###
  11 # parse command line
  12 ###
  13
  14 use vars qw( $opt_h $opt_v $opt_n $opt_e $opt_s $opt_c $opt_r $opt_p $opt_d );
  15 getopts('hvnes:c:r:pd:');
  16
  17 my $user = shift or die &usage;
  18 adminsuidsetup $user;
  19
  20 sub usage { "
  21   Usage:
  22       svc_broadband_update_speeds [ -h help] [ -v verbose] [ -n only update services with a null up/down speed] [ -e export service ] [ -s service_part_num (required) ] [ -c sibling service_part_num ] [ -r (speed rate in KB 'up,down') ] [ -p (get speed from package fcc rate) ] [ -d directory for exception file (required) ] user (required)\n
  23       A directory for the exception file, freeside user name and a service to update is required.\n
  24       Must set one or more of options p, c, or r. \n
  25       Also must run this report as user freeside.\n
  26       Option r up and down speed seperated by a comma in kbps.
  27       Getting speed from option p (package fcc rates) first if set, if no rates found then checks for option c (rate of sibling service) if set, if still no rates found checks for rate in option r if set.  If no rates found service will be placed in exception file.
  28       By default serivce will not export if there is a export assigned to service.  Setting option e will perform the export.
  29 " }
  30
  31 unless ($opt_d && $opt_s) { die &usage(); }
  32 if ($opt_h) { die &usage(); }
  33 unless ($opt_p || $opt_c || $opt_r) { die &usage(); }
  34
  35 my $exception_file = "$opt_d/svcbroadband_update_exceptions_".time().".txt";
  36
  37 ### get list of all provisioned services
  38 my $only_null_speed_services = " AND (svc_broadband.speed_up IS NULL OR svc_broadband.speed_down IS NULL)" if $opt_n;
  39 my $extra_sql = " WHERE cust_svc.svcpart = $opt_s $only_null_speed_services";
  40 my @services = qsearch({
  41     'select'    => 'svc_broadband.*, cust_svc.svcpart, cust_svc.pkgnum, cust_pkg.pkgpart',
  42     'table'     => 'svc_broadband',
  43     'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum ) LEFT JOIN cust_pkg USING (pkgnum)',
  44     'extra_sql' => $extra_sql,
  45 });
  46
  47 ### get list of all unprovisioned services
  48 my $ups_extra_sql = "where cust_pkg.cancel is null and pkg_svc.quantity > 0 and  pkg_svc.quantity > (select count(1) from cust_svc where  cust_svc.pkgnum = cust_pkg.pkgnum and  cust_svc.svcpart = pkg_svc.svcpart)  and pkg_svc.svcpart = $opt_s";
  49 my @unprovisioned_services = qsearchs({
  50     'table'     => 'cust_pkg',
  51     'addl_from' => 'JOIN pkg_svc using (pkgpart)',
  52     'extra_sql' => $ups_extra_sql,
  53 });
  54
  55 my $speed;
  56 $speed = 'package' if $opt_p;
  57
  58 foreach my $svc (@services) {
  59   _update_service($svc, $exception_file);
  60 }
  61
  62 sub _update_service {
  63   my $service = shift;
  64   my $exception_file = shift;
  65   my $speed_up;
  66   my $speed_down;
  67
  68   my $package = qsearchs({
  69      'table'     => 'part_pkg',
  70      'hashref'   => { 'pkgpart' => $service->pkgpart, },
  71   });
  72
  73   ## get speed from package fcc option first if option p
  74   if ($opt_p) {
  75         warn ("Getting speed for service ".$service->description."(".$service->svcnum.") from package fcc info\n") if $opt_v;
  76      $speed_up = $package->fcc_option('broadband_upstream') * 1000;
  77      $speed_down = $package->fcc_option('broadband_downstream') * 1000;
  78   }
  79
  80   ## if no fcc option get speed from sibling broadband service if option c
  81   if ((!$speed_up || !$speed_down) && $opt_c) {
  82         warn ("Getting speed for service ".$service->description."(".$service->svcnum.") from sibling service of package ".$service->pkgnum) if $opt_v;
  83      my $sibling_service = qsearchs({
  84        'select'    => 'svc_broadband.*, cust_svc.svcpart',
  85        'table'     => 'svc_broadband',
  86        'addl_from' => ' LEFT JOIN cust_svc USING ( svcnum )',
  87        'extra_sql' => ' WHERE cust_svc.pkgnum = '.$service->pkgnum.' AND cust_svc.svcpart = '.$opt_c.' AND (svc_broadband.speed_up IS NOT NULL AND svc_broadband.speed_down IS NOT NULL)',
  88      });
  89      $speed_up = $sibling_service->speed_up if $sibling_service;
  90      $speed_down = $sibling_service->speed_down if $sibling_service;
  91   }
  92
  93   ## if no fcc options and no speed from sibling service than get speed from option r if option r is set.
  94   if ((!$speed_up || !$speed_down) && $opt_r) {
  95         warn ("Getting speed for service ".$service->description."(".$service->svcnum.") from option r ($opt_r)\n") if $opt_v;
  96      ($speed_up, $speed_down) = split /\,/, $opt_r;
  97      warn ("Option r speeds not correct.  Must be in kbps up and down seperated by comma. [ -r xxxxxx,xxxxxx ]\n") if $opt_v && (!$speed_up || !$speed_down);
  98   }
  99
 100   ## update service with new speed.
 101   if ($speed_up && $speed_down) {
 102     $service->set('speed_up', $speed_up);
 103     $service->set('speed_down', $speed_down);
 104
 105     warn("updating service ".$service->description."(".$service->svcnum.") with upload speed ($speed_up) and download speed ($speed_down)\n") if $opt_v;
 106     $service->set('no_export', $opt_e);
 107     my $error = $service->replace();
 108     warn($error) if $error;
 109     ###todo: if no error provision service if not provisioned ie new svc_broadband.
 110   }
 111   else {
 112     open(FILE, ">>$exception_file")
 113       or die "can't open $opt_d: $!";
 114       print FILE "Service ".$service->description."(".$service->svcnum.") could not set a up or download speed.\n";
 115     close FILE or die "can't close $opt_d: $!";
 116     warn($service->description."(".$service->svcnum.") could not set a up or download speed, added to exception file.\n") if $opt_v;
 117   }
 118   return;
 119 }
 120
 121 exit;
 122
 123 =head2 svc_broadband_update_speeds
 124
 125 This script allows for the mas update of up and down speeds for a svc_broadband service.
 126
 127 the script will obtain the new speed from option p (package fcc rates) first if set,
 128 if no rates found then checks for option c (rate of sibling service) if set,
 129 if still no rates found checks for rate in option r if set.
 130 If no rates found service will be placed in exception file.
 131
 132 Script must be run as user freeside.
 133 Options -s, -d and freeside user are required.
 134
 135 example:
 136 sudo -u freeside ./svc_broadband_update_speeds -v -s 4 -c 2 -r 148000,248000 -p -d /home/freeside/ freesideuser
 137
 138 =cut