FS/FS/access_user.pm

   1 package FS::access_user;
   2
   3 use strict;
   4 use base qw( FS::m2m_Common FS::option_Common );
   5 use vars qw( $DEBUG $me $conf $htpasswd_file );
   6 use FS::UID;
   7 use FS::Conf;
   8 use FS::Record qw( qsearch qsearchs dbh );
   9 use FS::access_user_pref;
  10 use FS::access_usergroup;
  11 use FS::agent;
  12 use FS::cust_main;
  13 use FS::sales;
  14
  15 $DEBUG = 0;
  16 $me = '[FS::access_user]';
  17
  18 #kludge htpasswd for now (i hope this bootstraps okay)
  19 FS::UID->install_callback( sub {
  20   $conf = new FS::Conf;
  21   $htpasswd_file = $conf->base_dir. '/htpasswd';
  22 } );
  23
  24 =head1 NAME
  25
  26 FS::access_user - Object methods for access_user records
  27
  28 =head1 SYNOPSIS
  29
  30   use FS::access_user;
  31
  32   $record = new FS::access_user \%hash;
  33   $record = new FS::access_user { 'column' => 'value' };
  34
  35   $error = $record->insert;
  36
  37   $error = $new_record->replace($old_record);
  38
  39   $error = $record->delete;
  40
  41   $error = $record->check;
  42
  43 =head1 DESCRIPTION
  44
  45 An FS::access_user object represents an internal access user.  FS::access_user
  46 inherits from FS::Record.  The following fields are currently supported:
  47
  48 =over 4
  49
  50 =item usernum - primary key
  51
  52 =item username -
  53
  54 =item _password -
  55
  56 =item last -
  57
  58 =item first -
  59
  60 =item disabled - empty or 'Y'
  61
  62 =back
  63
  64 =head1 METHODS
  65
  66 =over 4
  67
  68 =item new HASHREF
  69
  70 Creates a new internal access user.  To add the user to the database, see L<"insert">.
  71
  72 Note that this stores the hash reference, not a distinct copy of the hash it
  73 points to.  You can ask the object for a copy with the I<hash> method.
  74
  75 =cut
  76
  77 # the new method can be inherited from FS::Record, if a table method is defined
  78
  79 sub table { 'access_user'; }
  80
  81 sub _option_table    { 'access_user_pref'; }
  82 sub _option_namecol  { 'prefname'; }
  83 sub _option_valuecol { 'prefvalue'; }
  84
  85 =item insert
  86
  87 Adds this record to the database.  If there is an error, returns the error,
  88 otherwise returns false.
  89
  90 =cut
  91
  92 sub insert {
  93   my $self = shift;
  94
  95   my $error = $self->check;
  96   return $error if $error;
  97
  98   local $SIG{HUP} = 'IGNORE';
  99   local $SIG{INT} = 'IGNORE';
 100   local $SIG{QUIT} = 'IGNORE';
 101   local $SIG{TERM} = 'IGNORE';
 102   local $SIG{TSTP} = 'IGNORE';
 103   local $SIG{PIPE} = 'IGNORE';
 104
 105   my $oldAutoCommit = $FS::UID::AutoCommit;
 106   local $FS::UID::AutoCommit = 0;
 107   my $dbh = dbh;
 108
 109   $error = $self->htpasswd_kludge();
 110   if ( $error ) {
 111     $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 112     return $error;
 113   }
 114
 115   $error = $self->SUPER::insert(@_);
 116
 117   if ( $error ) {
 118     $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 119
 120     #make sure it isn't a dup username?  or you could nuke people's passwords
 121     #blah.  really just should do our own login w/cookies
 122     #and auth out of the db in the first place
 123     #my $hterror = $self->htpasswd_kludge('-D');
 124     #$error .= " - additionally received error cleaning up htpasswd file: $hterror"
 125     return $error;
 126
 127   } else {
 128     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 129     '';
 130   }
 131
 132 }
 133
 134 sub htpasswd_kludge {
 135   my $self = shift;
 136
 137   return '' if $self->is_system_user;
 138
 139   unshift @_, '-c' unless -e $htpasswd_file;
 140   if (
 141        system('htpasswd', '-b', @_,
 142                           $htpasswd_file,
 143                           $self->username,
 144                           $self->_password,
 145              ) == 0
 146      )
 147   {
 148     return '';
 149   } else {
 150     return 'htpasswd exited unsucessfully';
 151   }
 152 }
 153
 154 =item delete
 155
 156 Delete this record from the database.
 157
 158 =cut
 159
 160 sub delete {
 161   my $self = shift;
 162
 163   local $SIG{HUP} = 'IGNORE';
 164   local $SIG{INT} = 'IGNORE';
 165   local $SIG{QUIT} = 'IGNORE';
 166   local $SIG{TERM} = 'IGNORE';
 167   local $SIG{TSTP} = 'IGNORE';
 168   local $SIG{PIPE} = 'IGNORE';
 169
 170   my $oldAutoCommit = $FS::UID::AutoCommit;
 171   local $FS::UID::AutoCommit = 0;
 172   my $dbh = dbh;
 173
 174   my $error =
 175        $self->SUPER::delete(@_)
 176     || $self->htpasswd_kludge('-D')
 177   ;
 178
 179   if ( $error ) {
 180     $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 181     return $error;
 182   } else {
 183     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 184     '';
 185   }
 186
 187 }
 188
 189 =item replace OLD_RECORD
 190
 191 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 192 returns the error, otherwise returns false.
 193
 194 =cut
 195
 196 sub replace {
 197   my $new = shift;
 198
 199   my $old = ( ref($_[0]) eq ref($new) )
 200               ? shift
 201               : $new->replace_old;
 202
 203   local $SIG{HUP} = 'IGNORE';
 204   local $SIG{INT} = 'IGNORE';
 205   local $SIG{QUIT} = 'IGNORE';
 206   local $SIG{TERM} = 'IGNORE';
 207   local $SIG{TSTP} = 'IGNORE';
 208   local $SIG{PIPE} = 'IGNORE';
 209
 210   my $oldAutoCommit = $FS::UID::AutoCommit;
 211   local $FS::UID::AutoCommit = 0;
 212   my $dbh = dbh;
 213
 214   if ( $new->_password ne $old->_password ) {
 215     my $error = $new->htpasswd_kludge();
 216     if ( $error ) {
 217       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 218       return $error;
 219     }
 220   } elsif ( $old->disabled && !$new->disabled
 221               && $new->_password =~ /changeme/i ) {
 222     return "Must change password when enabling this account";
 223   }
 224
 225   my $error = $new->SUPER::replace($old, @_);
 226
 227   if ( $error ) {
 228     $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
 229     return $error;
 230   } else {
 231     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 232     '';
 233   }
 234
 235 }
 236
 237 =item check
 238
 239 Checks all fields to make sure this is a valid internal access user.  If there is
 240 an error, returns the error, otherwise returns false.  Called by the insert
 241 and replace methods.
 242
 243 =cut
 244
 245 # the check method should currently be supplied - FS::Record contains some
 246 # data checking routines
 247
 248 sub check {
 249   my $self = shift;
 250
 251   my $error =
 252     $self->ut_numbern('usernum')
 253     || $self->ut_alpha_lower('username')
 254     || $self->ut_text('_password')
 255     || $self->ut_text('last')
 256     || $self->ut_text('first')
 257     || $self->ut_foreign_keyn('user_custnum', 'cust_main', 'custnum')
 258     || $self->ut_foreign_keyn('report_salesnum', 'sales', 'salesnum')
 259     || $self->ut_enum('disabled', [ '', 'Y' ] )
 260   ;
 261   return $error if $error;
 262
 263   $self->SUPER::check;
 264 }
 265
 266 =item name
 267
 268 Returns a name string for this user: "Last, First".
 269
 270 =cut
 271
 272 sub name {
 273   my $self = shift;
 274   return $self->username
 275     if $self->get('last') eq 'Lastname' && $self->first eq 'Firstname';
 276   return $self->get('last'). ', '. $self->first;
 277 }
 278
 279 =item user_cust_main
 280
 281 Returns the FS::cust_main object (see L<FS::cust_main>), if any, for this
 282 user.
 283
 284 =cut
 285
 286 sub user_cust_main {
 287   my $self = shift;
 288   qsearchs( 'cust_main', { 'custnum' => $self->user_custnum } );
 289 }
 290
 291 =item report_sales
 292
 293 Returns the FS::sales object (see L<FS::sales>), if any, for this
 294 user.
 295
 296 =cut
 297
 298 sub report_sales {
 299   my $self = shift;
 300   qsearchs( 'sales', { 'salesnum' => $self->report_salesnum } );
 301 }
 302
 303 =item access_usergroup
 304
 305 Returns links to the the groups this user is a part of, as FS::access_usergroup
 306 objects (see L<FS::access_usergroup>).
 307
 308 =cut
 309
 310 sub access_usergroup {
 311   my $self = shift;
 312   qsearch( 'access_usergroup', { 'usernum' => $self->usernum } );
 313 }
 314
 315 #=item access_groups
 316 #
 317 #=cut
 318 #
 319 #sub access_groups {
 320 #
 321 #}
 322 #
 323 #=item access_groupnames
 324 #
 325 #=cut
 326 #
 327 #sub access_groupnames {
 328 #
 329 #}
 330
 331 =item agentnums
 332
 333 Returns a list of agentnums this user can view (via group membership).
 334
 335 =cut
 336
 337 sub agentnums {
 338   my $self = shift;
 339   my $sth = dbh->prepare(
 340     "SELECT DISTINCT agentnum FROM access_usergroup
 341                               JOIN access_groupagent USING ( groupnum )
 342        WHERE usernum = ?"
 343   ) or die dbh->errstr;
 344   $sth->execute($self->usernum) or die $sth->errstr;
 345   map { $_->[0] } @{ $sth->fetchall_arrayref };
 346 }
 347
 348 =item agentnums_href
 349
 350 Returns a hashref of agentnums this user can view.
 351
 352 =cut
 353
 354 sub agentnums_href {
 355   my $self = shift;
 356   scalar( { map { $_ => 1 } $self->agentnums } );
 357 }
 358
 359 =item agentnums_sql [ HASHREF | OPTION => VALUE ... ]
 360
 361 Returns an sql fragement to select only agentnums this user can view.
 362
 363 Options are passed as a hashref or a list.  Available options are:
 364
 365 =over 4
 366
 367 =item null
 368
 369 The frament will also allow the selection of null agentnums.
 370
 371 =item null_right
 372
 373 The fragment will also allow the selection of null agentnums if the current
 374 user has the provided access right
 375
 376 =item table
 377
 378 Optional table name in which agentnum is being checked.  Sometimes required to
 379 resolve 'column reference "agentnum" is ambiguous' errors.
 380
 381 =item viewall_right
 382
 383 All agents will be viewable if the current user has the provided access right.
 384 Defaults to 'View customers of all agents'.
 385
 386 =back
 387
 388 =cut
 389
 390 sub agentnums_sql {
 391   my( $self ) = shift;
 392   my %opt = ref($_[0]) ? %{$_[0]} : @_;
 393
 394   my $agentnum = $opt{'table'} ? $opt{'table'}.'.agentnum' : 'agentnum';
 395
 396   my @or = ();
 397
 398   my $viewall_right = $opt{'viewall_right'} || 'View customers of all agents';
 399   if ( $self->access_right($viewall_right) ) {
 400     push @or, "$agentnum IS NOT NULL";
 401   } else {
 402     push @or, "$agentnum IN (". join(',', $self->agentnums). ')';
 403   }
 404
 405   push @or, "$agentnum IS NULL"
 406     if $opt{'null'}
 407     || ( $opt{'null_right'} && $self->access_right($opt{'null_right'}) );
 408
 409   return ' 1 = 0 ' unless scalar(@or);
 410   '( '. join( ' OR ', @or ). ' )';
 411
 412 }
 413
 414 =item agentnum
 415
 416 Returns true if the user can view the specified agent.
 417
 418 =cut
 419
 420 sub agentnum {
 421   my( $self, $agentnum ) = @_;
 422   my $sth = dbh->prepare(
 423     "SELECT COUNT(*) FROM access_usergroup
 424                      JOIN access_groupagent USING ( groupnum )
 425        WHERE usernum = ? AND agentnum = ?"
 426   ) or die dbh->errstr;
 427   $sth->execute($self->usernum, $agentnum) or die $sth->errstr;
 428   $sth->fetchrow_arrayref->[0];
 429 }
 430
 431 =item agents [ HASHREF | OPTION => VALUE ... ]
 432
 433 Returns the list of agents this user can view (via group membership), as
 434 FS::agent objects.  Accepts the same options as the agentnums_sql method.
 435
 436 =cut
 437
 438 sub agents {
 439   my $self = shift;
 440   qsearch({
 441     'table'     => 'agent',
 442     'hashref'   => { disabled=>'' },
 443     'extra_sql' => ' AND '. $self->agentnums_sql(@_),
 444     'order_by'  => 'ORDER BY agent',
 445   });
 446 }
 447
 448 =item access_right RIGHTNAME | LISTREF
 449
 450 Given a right name or a list reference of right names, returns true if this
 451 user has this right, or, for a list, one of the rights (currently via group
 452 membership, eventually also via user overrides).
 453
 454 =cut
 455
 456 sub access_right {
 457   my( $self, $rightname ) = @_;
 458
 459   $rightname = [ $rightname ] unless ref($rightname);
 460
 461   warn "$me access_right called on ". join(', ', @$rightname). "\n"
 462     if $DEBUG;
 463
 464   #some caching of ACL requests for low-hanging fruit perf improvement
 465   #since we get a new $CurrentUser object each page view there shouldn't be any
 466   #issues with stickiness
 467   if ( $self->{_ACLcache} ) {
 468
 469     unless ( grep !exists($self->{_ACLcache}{$_}), @$rightname ) {
 470       warn "$me ACL cache hit for ". join(', ', @$rightname). "\n"
 471         if $DEBUG;
 472       return scalar( grep $self->{_ACLcache}{$_}, @$rightname );
 473     }
 474
 475     warn "$me ACL cache miss for ". join(', ', @$rightname). "\n"
 476       if $DEBUG;
 477
 478   } else {
 479
 480     warn "initializing ACL cache\n"
 481       if $DEBUG;
 482     $self->{_ACLcache} = {};
 483
 484   }
 485
 486   my $has_right = ' rightname IN ('. join(',', map '?', @$rightname ). ') ';
 487
 488   my $sth = dbh->prepare("
 489     SELECT groupnum FROM access_usergroup
 490                     LEFT JOIN access_group USING ( groupnum )
 491                     LEFT JOIN access_right
 492                          ON ( access_group.groupnum = access_right.rightobjnum )
 493       WHERE usernum = ?
 494         AND righttype = 'FS::access_group'
 495         AND $has_right
 496       LIMIT 1
 497   ") or die dbh->errstr;
 498   $sth->execute($self->usernum, @$rightname) or die $sth->errstr;
 499   my $row = $sth->fetchrow_arrayref;
 500
 501   my $return = $row ? $row->[0] : '';
 502
 503   #just caching the single-rightname hits should be enough of a win for now
 504   if ( scalar(@$rightname) == 1 ) {
 505     $self->{_ACLcache}{${$rightname}[0]} = $return;
 506   }
 507
 508   $return;
 509
 510 }
 511
 512 =item default_customer_view
 513
 514 Returns the default customer view for this user, from the
 515 "default_customer_view" user preference, the "cust_main-default_view" config,
 516 or the hardcoded default, "basics" (formerly "jumbo" prior to 3.0).
 517
 518 =cut
 519
 520 sub default_customer_view {
 521   my $self = shift;
 522
 523   $self->option('default_customer_view')
 524     || $conf->config('cust_main-default_view')
 525     || 'basics'; #s/jumbo/basics/ starting with 3.0
 526
 527 }
 528
 529 =item spreadsheet_format [ OVERRIDE ]
 530
 531 Returns a hashref of this user's Excel spreadsheet download settings:
 532 'extension' (xls or xlsx), 'class' (Spreadsheet::WriteExcel or
 533 Excel::Writer::XLSX), and 'mime_type'.  If OVERRIDE is 'XLS' or 'XLSX',
 534 use that instead of the user's setting.
 535
 536 =cut
 537
 538 # is there a better place to put this?
 539 my %formats = (
 540   XLS => {
 541     extension => '.xls',
 542     class => 'Spreadsheet::WriteExcel',
 543     mime_type => 'application/vnd.ms-excel',
 544   },
 545   XLSX => {
 546     extension => '.xlsx',
 547     class => 'Excel::Writer::XLSX',
 548     mime_type => # it's on wikipedia, it must be true
 549       'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
 550   }
 551 );
 552
 553 sub spreadsheet_format {
 554   my $self = shift;
 555   my $override = shift;
 556
 557   my $f =  $override
 558         || $self->option('spreadsheet_format')
 559         || $conf->config('spreadsheet_format')
 560         || 'XLS';
 561
 562   $formats{$f};
 563 }
 564
 565 =item is_system_user
 566
 567 Returns true if this user has the name of a known system account.  These
 568 users will not appear in the htpasswd file and can't have passwords set.
 569
 570 =cut
 571
 572 sub is_system_user {
 573   my $self = shift;
 574   return grep { $_ eq $self->username } ( qw(
 575     fs_queue
 576     fs_daily
 577     fs_selfservice
 578     fs_signup
 579     fs_bootstrap
 580     fs_selfserv
 581 ) );
 582 }
 583
 584 =back
 585
 586 =head1 BUGS
 587
 588 =head1 SEE ALSO
 589
 590 L<FS::Record>, schema.html from the base documentation.
 591
 592 =cut
 593
 594 1;
 595