FS/FS/access_right.pm

   1 package FS::access_right;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use Tie::IxHash;
   6 use FS::Record qw( qsearch qsearchs );
   7 use FS::upgrade_journal;
   8 use FS::access_group;
   9
  10 @ISA = qw(FS::Record);
  11
  12 =head1 NAME
  13
  14 FS::access_right - Object methods for access_right records
  15
  16 =head1 SYNOPSIS
  17
  18   use FS::access_right;
  19
  20   $record = new FS::access_right \%hash;
  21   $record = new FS::access_right { 'column' => 'value' };
  22
  23   $error = $record->insert;
  24
  25   $error = $new_record->replace($old_record);
  26
  27   $error = $record->delete;
  28
  29   $error = $record->check;
  30
  31 =head1 DESCRIPTION
  32
  33 An FS::access_right object represents a granted access right.  FS::access_right
  34 inherits from FS::Record.  The following fields are currently supported:
  35
  36 =over 4
  37
  38 =item rightnum - primary key
  39
  40 =item righttype -
  41
  42 =item rightobjnum -
  43
  44 =item rightname -
  45
  46
  47 =back
  48
  49 =head1 METHODS
  50
  51 =over 4
  52
  53 =item new HASHREF
  54
  55 Creates a new right.  To add the right to the database, see L<"insert">.
  56
  57 Note that this stores the hash reference, not a distinct copy of the hash it
  58 points to.  You can ask the object for a copy with the I<hash> method.
  59
  60 =cut
  61
  62 # the new method can be inherited from FS::Record, if a table method is defined
  63
  64 sub table { 'access_right'; }
  65
  66 =item insert
  67
  68 Adds this record to the database.  If there is an error, returns the error,
  69 otherwise returns false.
  70
  71 =cut
  72
  73 # the insert method can be inherited from FS::Record
  74
  75 =item delete
  76
  77 Delete this record from the database.
  78
  79 =cut
  80
  81 # the delete method can be inherited from FS::Record
  82
  83 =item replace OLD_RECORD
  84
  85 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  86 returns the error, otherwise returns false.
  87
  88 =cut
  89
  90 # the replace method can be inherited from FS::Record
  91
  92 =item check
  93
  94 Checks all fields to make sure this is a valid right.  If there is
  95 an error, returns the error, otherwise returns false.  Called by the insert
  96 and replace methods.
  97
  98 =cut
  99
 100 # the check method should currently be supplied - FS::Record contains some
 101 # data checking routines
 102
 103 sub check {
 104   my $self = shift;
 105
 106   my $error =
 107     $self->ut_numbern('rightnum')
 108     || $self->ut_text('righttype')
 109     || $self->ut_text('rightobjnum')
 110     || $self->ut_text('rightname')
 111   ;
 112   return $error if $error;
 113
 114   $self->SUPER::check;
 115 }
 116
 117 # _upgrade_data
 118 #
 119 # Used by FS::Upgrade to migrate to a new database.
 120
 121 sub _upgrade_data { # class method
 122   my ($class, %opts) = @_;
 123
 124   my @unmigrated = ( qsearch( 'access_right',
 125                               { 'righttype'=>'FS::access_group',
 126                                 'rightname'=>'Engineering configuration',
 127                               }
 128                             ),
 129                      qsearch( 'access_right',
 130                               { 'righttype'=>'FS::access_group',
 131                                 'rightname'=>'Engineering global configuration',
 132                               }
 133                             )
 134                    );
 135   foreach ( @unmigrated ) {
 136     my $rightname = $_->rightname;
 137     $rightname =~ s/Engineering/Dialup/;
 138     $_->rightname($rightname);
 139     my $error = $_->replace;
 140     die "Failed to update access right: $error"
 141       if $error;
 142     my $broadband = new FS::access_right { $_->hash };
 143     $rightname =~ s/Dialup/Broadband/;
 144     $broadband->rightnum('');
 145     $broadband->rightname($rightname);
 146     $error = $broadband->insert;
 147     die "Failed to insert access right: $error"
 148       if $error;
 149   }
 150
 151   my %migrate = (
 152     'Post payment'    => [ 'Post check payment', 'Post cash payment' ],
 153     'Process payment' => [ 'Process credit card payment', 'Process Echeck payment' ],
 154     'Post refund'     => [ 'Post check refund', 'Post cash refund' ],
 155     'Refund payment'  => [ 'Refund credit card payment', 'Refund Echeck payment' ],
 156   );
 157
 158   foreach my $oldright (keys %migrate) {
 159     my @old = qsearch('access_right', { 'righttype'=>'FS::access_group',
 160                                         'rightname'=>$oldright,
 161                                       }
 162                      );
 163
 164     foreach my $old ( @old ) {
 165
 166       foreach my $newright ( @{ $migrate{$oldright} } ) {
 167         my %hash = (
 168           'righttype'   => 'FS::access_group',
 169           'rightobjnum' => $old->rightobjnum,
 170           'rightname'   => $newright,
 171         );
 172         next if qsearchs('access_right', \%hash);
 173         my $access_right = new FS::access_right \%hash;
 174         my $error = $access_right->insert;
 175         die $error if $error;
 176       }
 177
 178       #after the WEST stuff is sorted, etc.
 179       #my $error = $old->delete;
 180       #die $error if $error;
 181
 182     }
 183
 184   }
 185
 186   my @all_groups = qsearch('access_group', {});
 187
 188   tie my %onetime, 'Tie::IxHash',
 189     'List customers'                      => 'List all customers',
 190     'List all customers'                  => 'Advanced customer search',
 191     'List packages'                       => 'Summarize packages',
 192     'Post payment'                        => 'Backdate payment',
 193     'Cancel customer package immediately' => 'Un-cancel customer package',
 194     'Suspend customer package'            => 'Suspend customer',
 195     'Unsuspend customer package'          => 'Unsuspend customer',
 196     'Post credit'                         => 'Credit line items',
 197     #'View customer tax exemptions'        => 'Edit customer tax exemptions',
 198     'Edit customer'                       => 'Edit customer tax exemptions',
 199     'Edit package definitions'            => 'Bulk edit package definitions',
 200
 201     'List services'    => [ 'Services: Accounts',
 202                             'Services: Domains',
 203                             'Services: Certificates',
 204                             'Services: Mail forwards',
 205                             'Services: Virtual hosting services',
 206                             'Services: Wireless broadband services',
 207                             'Services: DSLs',
 208                             'Services: Dish services',
 209                             'Services: Hardware',
 210                             'Services: Phone numbers',
 211                             'Services: PBXs',
 212                             'Services: Ports',
 213                             'Services: Mailing lists',
 214                             'Services: External services',
 215                           ],
 216
 217     'Services: Accounts' => 'Services: Accounts: Advanced search',
 218     'Services: Wireless broadband services' => 'Services: Wireless broadband services: Advanced search',
 219     'Services: Hardware' => 'Services: Hardware: Advanced search',
 220     'Services: Phone numbers' => 'Services: Phone numbers: Advanced search',
 221
 222     'List rating data' => [ 'Usage: RADIUS sessions',
 223                             'Usage: Call Detail Records (CDRs)',
 224                             'Usage: Unrateable CDRs',
 225                           ],
 226
 227     'Edit customer' => [ 'Edit customer basics',
 228                          'Edit customer addresses',
 229                          'Edit customer contacts',
 230                        ],
 231
 232     'Provision customer service' => [ 'Edit password' ],
 233
 234     'Financial reports' => [ 'Employees: Commission Report',
 235                              'Employees: Audit Report',
 236                            ],
 237     'Services: Accounts' => 'Services: Cable Subscribers',
 238 ;
 239
 240   foreach my $old_acl ( keys %onetime ) {
 241
 242     my @new_acl = ref($onetime{$old_acl})
 243                     ? @{ $onetime{$old_acl} }
 244                     :  ( $onetime{$old_acl} );
 245
 246     foreach my $new_acl ( @new_acl ) {
 247
 248       ( my $journal = 'ACL_'.lc($new_acl) ) =~ s/\W/_/g;
 249       next if FS::upgrade_journal->is_done($journal);
 250
 251       # grant $new_acl to all groups who have $old_acl
 252       for my $group (@all_groups) {
 253         next unless $group->access_right($old_acl);
 254         next if     $group->access_right($new_acl);
 255         my $access_right = FS::access_right->new( {
 256             'righttype'   => 'FS::access_group',
 257             'rightobjnum' => $group->groupnum,
 258             'rightname'   => $new_acl,
 259         } );
 260         my $error = $access_right->insert;
 261         die $error if $error;
 262       }
 263
 264       FS::upgrade_journal->set_done($journal);
 265
 266     }
 267
 268   }
 269
 270   ### ACL_download_report_data
 271   if ( !FS::upgrade_journal->is_done('ACL_download_report_data') ) {
 272
 273     # grant to everyone
 274     for my $group (@all_groups) {
 275       my $access_right = FS::access_right->new( {
 276           'righttype'   => 'FS::access_group',
 277           'rightobjnum' => $group->groupnum,
 278           'rightname'   => 'Download report data',
 279       } );
 280       my $error = $access_right->insert;
 281       warn $error if $error;
 282     }
 283
 284     FS::upgrade_journal->set_done('ACL_download_report_data');
 285   }
 286
 287   '';
 288
 289 }
 290
 291 =back
 292
 293 =head1 BUGS
 294
 295 =head1 SEE ALSO
 296
 297 L<FS::Record>, schema.html from the base documentation.
 298
 299 =cut
 300
 301 1;
 302