summaryrefslogtreecommitdiff
path: root/FS/bin/freeside-username_list
blob: 5352f02eb2902dd2d4e2eed9e06e43a96a3166f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
#!/usr/bin/perl

use strict;
use vars qw( $opt_o $opt_l $opt_p $opt_b $opt_d $opt_s $opt_t );
use Getopt::Std;
use FS::UID qw(adminsuidsetup);
use FS::Conf;
use FS::Record qw(qsearch);
use FS::svc_acct;

getopts('olp:b:d:s:t:');

my $user = shift or &usage;
adminsuidsetup $user;

my $conf = new FS::Conf;
my $default_locale = $conf->config('locale') || 'en_US';

my %search = ();

$search{payby}        = [ split(/\s*,\s*/, $opt_p) ] if $opt_p;
$search{balance}      = $opt_b                       if $opt_b;
$search{balance_days} = $opt_d                       if $opt_d;
$search{svcpart}      = [ split(/\s*,\s*/, $opt_s) ] if $opt_s;
$search{cust_status}  = lc($opt_t)                   if $opt_t;

my @svc_acct = qsearch( FS::svc_acct->search(\%search) );

foreach my $svc_acct (@svc_acct) {
  print $svc_acct->username;
  print '@'. $svc_acct->domain if $opt_o;
  if ( $opt_l ) {
    my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
    print ','. ($cust_pkg && $cust_pkg->cust_main->locale || $default_locale);
  }
  print "\n";  
}

sub usage {
  die "usage: freeside-username_list [ -c ] [ -l ] [ -p payby,payby... ] [ -b balance [ -d balance_days ] ] [ -s svcpart,svcpart... ] username \n";
}

=head1 NAME

freeside-username_list

=head1 SYNOPSIS

  freeside-username_list [ -c ] [ -l ] [ -p payby,payby... ] [ -b balance [ -d balance_days ] ] [ -s svcpart,svcpart... ] username

=head1 DESCRIPTION

Command-line tool to list usernames.

Display options:

-o: Include domain

-l: Include customer locale

Selection options:

-p: Customer payby (CARD, BILL, etc.).  Separate multiple values with commas.

-b: Customer balance over (or equal to) this amount

-d: Customer balance age over this many days 

-s: Service definition (svcpart).  Separate multiple values with commas.

-t: Customer status: prospect, active, ordered, inactive, suspended or cancelled

username: Employee username

=head1 BUGS

=head1 SEE ALSO

L<FS::svc_acct>, L<FS::cust_main>

=cut

1;