X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Faccess_user.pm;h=44d3beec1c197f521d12a113b20dde465d2f78a5;hb=96623c3c471fda6935bd57efeaa0ad484285b74b;hp=a755daff697f8c286f3759d7879ed122d9b965a6;hpb=c648976f0b7975f2328ebd7ba8c711fad0ca4195;p=freeside.git diff --git a/FS/FS/access_user.pm b/FS/FS/access_user.pm index a755daff6..44d3beec1 100644 --- a/FS/FS/access_user.pm +++ b/FS/FS/access_user.pm @@ -1,23 +1,18 @@ package FS::access_user; +use base qw( FS::m2m_Common FS::option_Common ); use strict; -use vars qw( @ISA $htpasswd_file ); +use vars qw( $DEBUG $me ); use FS::UID; +use FS::Auth; use FS::Conf; use FS::Record qw( qsearch qsearchs dbh ); -use FS::m2m_Common; -use FS::option_Common; -use FS::access_usergroup; use FS::agent; +use FS::cust_main; +use FS::sales; -@ISA = qw( FS::m2m_Common FS::option_Common FS::Record ); -#@ISA = qw( FS::m2m_Common FS::option_Common ); - -#kludge htpasswd for now (i hope this bootstraps okay) -FS::UID->install_callback( sub { - my $conf = new FS::Conf; - $htpasswd_file = $conf->base_dir. '/htpasswd'; -} ); +$DEBUG = 0; +$me = '[FS::access_user]'; =head1 NAME @@ -40,22 +35,42 @@ FS::access_user - Object methods for access_user records =head1 DESCRIPTION -An FS::access_user object represents an internal access user. FS::access_user inherits from -FS::Record. The following fields are currently supported: +An FS::access_user object represents an internal access user. FS::access_user +inherits from FS::Record. The following fields are currently supported: =over 4 -=item usernum - primary key +=item usernum + +primary key + +=item username + +=item _password + +=item _password_encoding + +Empty or bcrypt -=item username - +=item last -=item _password - +Last name -=item last - +=item first -=item first - +First name -=item disabled - empty or 'Y' +=item user_custnum + +Master customer for this employee (for commissions) + +=item report_salesnum + +Default sales person for this employee (for reports) + +=item disabled + +Empty or 'Y' =back @@ -104,7 +119,6 @@ sub insert { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - $error = $self->htpasswd_kludge(); if ( $error ) { $dbh->rollback or die $dbh->errstr if $oldAutoCommit; return $error; @@ -114,14 +128,7 @@ sub insert { if ( $error ) { $dbh->rollback or die $dbh->errstr if $oldAutoCommit; - - #make sure it isn't a dup username? or you could nuke people's passwords - #blah. really just should do our own login w/cookies - #and auth out of the db in the first place - #my $hterror = $self->htpasswd_kludge('-D'); - #$error .= " - additionally received error cleaning up htpasswd file: $hterror" return $error; - } else { $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; @@ -129,27 +136,6 @@ sub insert { } -sub htpasswd_kludge { - my $self = shift; - - #awful kludge to skip setting htpasswd for fs_* users - return '' if $self->username =~ /^fs_/; - - unshift @_, '-c' unless -e $htpasswd_file; - if ( - system('htpasswd', '-b', @_, - $htpasswd_file, - $self->username, - $self->_password, - ) == 0 - ) - { - return ''; - } else { - return 'htpasswd exited unsucessfully'; - } -} - =item delete Delete this record from the database. @@ -170,10 +156,7 @@ sub delete { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - my $error = - $self->SUPER::delete(@_) - || $self->htpasswd_kludge('-D') - ; + my $error = $self->SUPER::delete(@_); if ( $error ) { $dbh->rollback or die $dbh->errstr if $oldAutoCommit; @@ -210,13 +193,11 @@ sub replace { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - if ( $new->_password ne $old->_password ) { - my $error = $new->htpasswd_kludge(); - if ( $error ) { - $dbh->rollback or die $dbh->errstr if $oldAutoCommit; - return $error; - } - } + return "Must change password when enabling this account" + if $old->disabled && !$new->disabled + && ( $new->_password =~ /changeme/i + || $new->_password eq 'notyet' + ); my $error = $new->SUPER::replace($old, @_); @@ -247,9 +228,11 @@ sub check { my $error = $self->ut_numbern('usernum') || $self->ut_alpha_lower('username') - || $self->ut_text('_password') - || $self->ut_text('last') - || $self->ut_text('first') + || $self->ut_textn('_password') + || $self->ut_textn('last') + || $self->ut_textn('first') + || $self->ut_foreign_keyn('user_custnum', 'cust_main', 'custnum') + || $self->ut_foreign_keyn('report_salesnum', 'sales', 'salesnum') || $self->ut_enum('disabled', [ '', 'Y' ] ) ; return $error if $error; @@ -265,33 +248,40 @@ Returns a name string for this user: "Last, First". sub name { my $self = shift; - $self->get('last'). ', '. $self->first; + return $self->username + if $self->get('last') eq 'Lastname' && $self->first eq 'Firstname' + or $self->get('last') eq '' && $self->first eq ''; + return $self->get('last'). ', '. $self->first; } -=item access_usergroup +=item user_cust_main + +Returns the FS::cust_main object (see L), if any, for this +user. =cut -sub access_usergroup { +sub user_cust_main { my $self = shift; - qsearch( 'access_usergroup', { 'usernum' => $self->usernum } ); + qsearchs( 'cust_main', { 'custnum' => $self->user_custnum } ); } -#=item access_groups -# -#=cut -# -#sub access_groups { -# -#} -# -#=item access_groupnames -# -#=cut -# -#sub access_groupnames { -# -#} +=item report_sales + +Returns the FS::sales object (see L), if any, for this +user. + +=cut + +sub report_sales { + my $self = shift; + qsearchs( 'sales', { 'salesnum' => $self->report_salesnum } ); +} + +=item access_usergroup + +Returns links to the the groups this user is a part of, as FS::access_usergroup +objects (see L). =item agentnums @@ -343,6 +333,11 @@ user has the provided access right Optional table name in which agentnum is being checked. Sometimes required to resolve 'column reference "agentnum" is ambiguous' errors. +=item viewall_right + +All agents will be viewable if the current user has the provided access right. +Defaults to 'View customers of all agents'. + =back =cut @@ -353,14 +348,22 @@ sub agentnums_sql { my $agentnum = $opt{'table'} ? $opt{'table'}.'.agentnum' : 'agentnum'; - my @agentnums = map { "$agentnum = $_" } $self->agentnums; + my @or = (); - push @agentnums, "$agentnum IS NULL" + my $viewall_right = $opt{'viewall_right'} || 'View customers of all agents'; + if ( $self->access_right($viewall_right) ) { + push @or, "$agentnum IS NOT NULL"; + } else { + push @or, "$agentnum IN (". join(',', $self->agentnums). ')'; + } + + push @or, "$agentnum IS NULL" if $opt{'null'} || ( $opt{'null_right'} && $self->access_right($opt{'null_right'}) ); - return ' 1 = 0 ' unless scalar(@agentnums); - '( '. join( ' OR ', @agentnums ). ' )'; + return ' 1 = 0 ' unless scalar(@or); + '( '. join( ' OR ', @or ). ' )'; + } =item agentnum @@ -380,10 +383,10 @@ sub agentnum { $sth->fetchrow_arrayref->[0]; } -=item agents +=item agents [ HASHREF | OPTION => VALUE ... ] Returns the list of agents this user can view (via group membership), as -FS::agent objects. +FS::agent objects. Accepts the same options as the agentnums_sql method. =cut @@ -392,19 +395,51 @@ sub agents { qsearch({ 'table' => 'agent', 'hashref' => { disabled=>'' }, - 'extra_sql' => ' AND '. $self->agentnums_sql, + 'extra_sql' => ' AND '. $self->agentnums_sql(@_), + 'order_by' => 'ORDER BY agent', }); } -=item access_right +=item access_right RIGHTNAME | LISTREF -Given a right name, returns true if this user has this right (currently via -group membership, eventually also via user overrides). +Given a right name or a list reference of right names, returns true if this +user has this right, or, for a list, one of the rights (currently via group +membership, eventually also via user overrides). =cut sub access_right { my( $self, $rightname ) = @_; + + $rightname = [ $rightname ] unless ref($rightname); + + warn "$me access_right called on ". join(', ', @$rightname). "\n" + if $DEBUG; + + #some caching of ACL requests for low-hanging fruit perf improvement + #since we get a new $CurrentUser object each page view there shouldn't be any + #issues with stickiness + if ( $self->{_ACLcache} ) { + + unless ( grep !exists($self->{_ACLcache}{$_}), @$rightname ) { + warn "$me ACL cache hit for ". join(', ', @$rightname). "\n" + if $DEBUG; + return scalar( grep $self->{_ACLcache}{$_}, @$rightname ); + } + + warn "$me ACL cache miss for ". join(', ', @$rightname). "\n" + if $DEBUG; + + } else { + + warn "initializing ACL cache\n" + if $DEBUG; + $self->{_ACLcache} = {}; + + } + + my $has_right = ' rightname IN ('. join(',', map '?', @$rightname ). ') '; + my $sth = dbh->prepare(" SELECT groupnum FROM access_usergroup LEFT JOIN access_group USING ( groupnum ) @@ -412,11 +447,114 @@ sub access_right { ON ( access_group.groupnum = access_right.rightobjnum ) WHERE usernum = ? AND righttype = 'FS::access_group' - AND rightname = ? + AND $has_right + LIMIT 1 ") or die dbh->errstr; - $sth->execute($self->usernum, $rightname) or die $sth->errstr; + $sth->execute($self->usernum, @$rightname) or die $sth->errstr; my $row = $sth->fetchrow_arrayref; - $row ? $row->[0] : ''; + + my $return = $row ? $row->[0] : ''; + + #just caching the single-rightname hits should be enough of a win for now + if ( scalar(@$rightname) == 1 ) { + $self->{_ACLcache}{${$rightname}[0]} = $return; + } + + $return; + +} + +=item default_customer_view + +Returns the default customer view for this user, from the +"default_customer_view" user preference, the "cust_main-default_view" config, +or the hardcoded default, "basics" (formerly "jumbo" prior to 3.0). + +=cut + +sub default_customer_view { + my $self = shift; + + $self->option('default_customer_view') + || FS::Conf->new->config('cust_main-default_view') + || 'basics'; #s/jumbo/basics/ starting with 3.0 + +} + +=item spreadsheet_format [ OVERRIDE ] + +Returns a hashref of this user's Excel spreadsheet download settings: +'extension' (xls or xlsx), 'class' (Spreadsheet::WriteExcel or +Excel::Writer::XLSX), and 'mime_type'. If OVERRIDE is 'XLS' or 'XLSX', +use that instead of the user's setting. + +=cut + +# is there a better place to put this? +my %formats = ( + XLS => { + extension => '.xls', + class => 'Spreadsheet::WriteExcel', + mime_type => 'application/vnd.ms-excel', + }, + XLSX => { + extension => '.xlsx', + class => 'Excel::Writer::XLSX', + mime_type => # it's on wikipedia, it must be true + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + } +); + +sub spreadsheet_format { + my $self = shift; + my $override = shift; + + my $f = $override + || $self->option('spreadsheet_format') + || FS::Conf->new->config('spreadsheet_format') + || 'XLS'; + + $formats{$f}; +} + +=item is_system_user + +Returns true if this user has the name of a known system account. These +users cannot log into the web interface and can't have passwords set. + +=cut + +sub is_system_user { + my $self = shift; + return grep { $_ eq $self->username } ( qw( + fs_queue + fs_daily + fs_selfservice + fs_signup + fs_bootstrap + fs_selfserv + fs_api + ) ); +} + +=item change_password NEW_PASSWORD + +=cut + +sub change_password { + #my( $self, $password ) = @_; + #FS::Auth->auth_class->change_password( $self, $password ); + FS::Auth->auth_class->change_password( @_ ); +} + +=item change_password_fields NEW_PASSWORD + +=cut + +sub change_password_fields { + #my( $self, $password ) = @_; + #FS::Auth->auth_class->change_password_fields( $self, $password ); + FS::Auth->auth_class->change_password_fields( @_ ); } =back