FS/bin/freeside-daily

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use Getopt::Std;
   5 use FS::UID qw(adminsuidsetup);
   6 use FS::Conf;
   7 use FS::Log;
   8
   9 &untaint_argv;  #what it sounds like  (eww)
  10 use vars qw(%opt);
  11 getopts("p:a:d:vl:sy:nmrkg:ox", \%opt);
  12
  13 my $user = shift or die &usage;
  14 adminsuidsetup $user;
  15
  16 die "The -p option has been removed in version 4 -- customers no longer have ".
  17     "a single, specific payment type\n"
  18   if $opt{'p'};
  19
  20 my $log = FS::Log->new('daily');
  21 $log->info('start');
  22
  23 #you can skip this by not having a NetworkMonitoringSystem configured
  24 use FS::Cron::nms_report qw(nms_report);
  25 nms_report(%opt);
  26
  27 #you can skip this by not having any vitelity exports configured
  28 use FS::Cron::lnp_vitelity qw(lnp_vitelity);
  29 lnp_vitelity(%opt);
  30
  31 #no way to skip this yet, but should be harmless/quick
  32 use FS::Cron::expire_banned_pay qw(expire_banned_pay);
  33 expire_banned_pay(%opt);
  34
  35 #you can skip this by setting the disable_cron_billing config
  36 use FS::Cron::bill qw(bill);
  37 bill(%opt);
  38
  39 #you can skip this by not setting enable_taxproducts to 'billsoft'
  40 use FS::Cron::tax_batch qw(process_tax_batch);
  41 process_tax_batch(%opt);
  42
  43 #you can skip this just by not having the config
  44 use FS::Cron::breakage qw(reconcile_breakage);
  45 reconcile_breakage(%opt);
  46
  47 #you can skip this just by not having the config
  48 use FS::Cron::upload qw(upload);
  49 upload(%opt);
  50
  51 #this only takes effect if WA sales taxes are enabled
  52 use FS::Cron::tax_rate_update qw(tax_rate_update);
  53 tax_rate_update(%opt);
  54
  55 use FS::Cron::set_lata_have_usage qw(set_lata_have_usage);
  56 set_lata_have_usage(%opt);
  57
  58 #what to do about the below when using -m?  that is the question.
  59
  60 #you don't want to skip this, besides, it should be cheap
  61 use FS::Cron::expire_user_pref qw(expire_user_pref);
  62 expire_user_pref();
  63
  64 unless ( $opt{k} ) {
  65   use FS::Cron::notify qw(notify_flat_delay);
  66   notify_flat_delay(%opt);
  67 }
  68
  69 #same
  70 use FS::Cron::rt_tasks qw(rt_daily);
  71 rt_daily(%opt);
  72
  73 #does nothing unless batch-gateway-* configs are set
  74 use FS::Cron::pay_batch qw(pay_batch_submit pay_batch_receive);
  75 pay_batch_submit(%opt);
  76 pay_batch_receive(%opt);
  77
  78 #does nothing unless there are batch-style exports with batches
  79 use FS::Cron::export_batch qw(export_batch_submit);
  80 export_batch_submit(%opt);
  81
  82 #does nothing unless there are users with subscribed searches
  83 use FS::Cron::send_subscribed qw(send_subscribed);
  84 send_subscribed(%opt);
  85
  86 #does nothing unless quotation_disable_after_days is set.
  87 use FS::Cron::disable_quotation qw(disable_quotation);
  88 disable_quotation();
  89
  90 #clears out cacti imports & deletes select database cache files
  91 use FS::Cron::cleanup qw( cleanup cleanup_before_backup );
  92 cleanup_before_backup();
  93
  94 #backup should be last
  95 #you can skip this just by not having the config (or with the -x option)
  96 use FS::Cron::backup qw(backup);
  97 backup() unless $opt{'x'};
  98
  99 #except we'd rather not start cleanup jobs until the backup is done
 100 cleanup( quiet => !$opt{'v'} );
 101
 102 $log->info('finish');
 103
 104 ###
 105 # subroutines
 106 ###
 107
 108 sub untaint_argv {
 109   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
 110     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 111     # Date::Parse
 112     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 113     $ARGV[$_]=$1;
 114   }
 115 }
 116
 117 sub usage {
 118   die "Usage:\n\n  freeside-daily [ -d 'date' ] [ -y days ] [ -a agentnum,agentnum,... ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] [ -x ] user [ custnum custnum ... ]\n";
 119 }
 120
 121 ###
 122 # documentation
 123 ###
 124
 125 =head1 NAME
 126
 127 freeside-daily - Run daily billing and invoice collection events.
 128
 129 =head1 SYNOPSIS
 130
 131   freeside-daily [ -d 'date' ] [ -y days ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
 132
 133 =head1 DESCRIPTION
 134
 135 Bills customers and runs invoice collection events.  Should be run from
 136 crontab daily.
 137
 138 Bills customers.  Searches for customers who are due for billing and calls
 139 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
 140
 141   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 142       but be careful.
 143
 144   -y: In addition to -d, which specifies an absolute date, the -y switch
 145       specifies an offset, in days.  For example, "-y 15" would increment the
 146       "pretend date" 15 days from whatever was specified by the -d switch
 147       (or now, if no -d switch was given).
 148
 149   -n: When used with "-d" and/or "-y", specifies that invoices should be dated
 150       with today's date, irregardless of the pretend date used to pre-generate
 151       the invoices.
 152
 153   -p: Deprecated, will produce a fatal error (formerly was: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB))
 154
 155   -a: Only process customers with the specified agentnum.  Multiple agentnums can be specified, separated with commas.
 156
 157   -g: Don't process the provided pkgpart (or pkgparts, specified as a comma-
 158       separated list).
 159
 160   -s: re-charge setup fees
 161
 162   -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up.
 163
 164   -v: enable debugging
 165
 166   -l: debugging level
 167
 168   -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing.
 169
 170   -r: Multi-process mode dry run option
 171
 172   -k: skip notify_flat_delay
 173
 174   -x: skip backup
 175
 176 user: Typically "fs_daily"
 177
 178 custnum: if one or more customer numbers are specified, only bills those
 179 customers.  Otherwise, bills all customers.
 180
 181 =head1 BUGS
 182
 183 =head1 SEE ALSO
 184
 185 L<FS::cust_main>, config.html from the base documentation
 186
 187 =cut
 188