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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
|
# frozen_string_literal: true
# Redmine - project management software
# Copyright (C) 2006- Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
class Principal < ApplicationRecord
self.table_name = "#{table_name_prefix}users#{table_name_suffix}"
# Account statuses
STATUS_ANONYMOUS = 0
STATUS_ACTIVE = 1
STATUS_REGISTERED = 2
STATUS_LOCKED = 3
class_attribute :valid_statuses
has_many :members, :foreign_key => 'user_id', :dependent => :destroy
has_many :memberships,
lambda {joins(:project).where.not(:projects => {:status => Project::STATUS_ARCHIVED})},
:class_name => 'Member',
:foreign_key => 'user_id'
has_many :projects, :through => :memberships
has_many :issue_categories, :foreign_key => 'assigned_to_id', :dependent => :nullify
validate :validate_status
# Groups and active users
scope :active, lambda {where(:status => STATUS_ACTIVE)}
scope :visible, (lambda do |*args|
user = args.first || User.current
if user.admin?
all
else
view_all_active = false
if user.memberships.any?
view_all_active = User.where(id: user.id).joins(memberships: :roles).where("#{Role.table_name}.users_visibility = ?", 'all').any?
else
view_all_active = user.builtin_role.users_visibility == 'all'
end
if view_all_active
active
else
# self and members of visible projects
active.where(
"#{table_name}.id = ? OR #{table_name}.id IN (SELECT user_id FROM #{Member.table_name} WHERE project_id IN (?))",
user.id, user.visible_project_ids
)
end
end
end)
scope :like, (lambda do |q|
q = q.to_s
if q.blank?
where({})
else
pattern = "%#{sanitize_sql_like q}%"
sql = "LOWER(#{table_name}.login) LIKE LOWER(:p) ESCAPE :s"
sql << " OR #{table_name}.id IN (SELECT user_id FROM #{EmailAddress.table_name} WHERE LOWER(address) LIKE LOWER(:p) ESCAPE :s)"
params = {:p => pattern, :s => '\\'}
tokens = q.split(/\s+/).reject(&:blank?).map {|token| "%#{sanitize_sql_like token}%"}
if tokens.present?
sql << ' OR ('
sql << tokens.map.with_index do |token, index|
params[:"token_#{index}"] = token
"(LOWER(#{table_name}.firstname) LIKE LOWER(:token_#{index}) ESCAPE :s OR LOWER(#{table_name}.lastname) LIKE LOWER(:token_#{index}) ESCAPE :s)"
end.join(' AND ')
sql << ')'
end
where(sql, params)
end
end)
# Principals that are members of a collection of projects
scope :member_of, (lambda do |projects|
projects = [projects] if projects.is_a?(Project)
if projects.blank?
where("1=0")
else
ids = projects.map(&:id)
# include active and locked users
where(:status => [STATUS_LOCKED, STATUS_ACTIVE]).
where("#{Principal.table_name}.id IN (SELECT DISTINCT user_id FROM #{Member.table_name} WHERE project_id IN (?))", ids)
end
end)
# Principals that are not members of projects
scope :not_member_of, (lambda do |projects|
projects = [projects] if projects.is_a?(Project)
if projects.blank?
where("1=0")
else
ids = projects.map(&:id)
where("#{Principal.table_name}.id NOT IN (SELECT DISTINCT user_id FROM #{Member.table_name} WHERE project_id IN (?))", ids)
end
end)
scope :sorted, lambda {order(*Principal.fields_for_order_statement)}
# Principals that can be added as watchers
scope :assignable_watchers, lambda {active.visible.where(:type => ['User', 'Group'])}
before_create :set_default_empty_values
before_destroy :nullify_projects_default_assigned_to
def reload(*args)
@project_ids = nil
super
end
def name(formatter = nil)
to_s
end
def mail=(*args)
nil
end
def mail
nil
end
def active?
self.status == STATUS_ACTIVE
end
def visible?(user=User.current)
Principal.visible(user).find_by(:id => id) == self
end
# Returns true if the principal is a member of project
def member_of?(project)
project.is_a?(Project) && project_ids.include?(project.id)
end
# Returns an array of the project ids that the principal is a member of
def project_ids
@project_ids ||= super.freeze
end
def <=>(principal)
# avoid an error when sorting members without roles (#10053)
return -1 if principal.nil?
return nil unless principal.is_a?(Principal)
if self.instance_of?(principal.class)
self.to_s.casecmp(principal.to_s)
else
# groups after users
principal.class.name <=> self.class.name
end
end
# Returns an array of fields names than can be used to make an order statement for principals.
# Users are sorted before Groups.
# Examples:
def self.fields_for_order_statement(table=nil)
table ||= table_name
columns = ['type DESC'] + (User.name_formatter[:order] - ['id']) + ['lastname', 'id']
columns.uniq.map {|field| "#{table}.#{field}"}
end
# Returns the principal that matches the keyword among principals
def self.detect_by_keyword(principals, keyword)
keyword = keyword.to_s
return nil if keyword.blank?
principal = nil
principal ||= principals.detect {|a| keyword.casecmp(a.login.to_s) == 0}
principal ||= principals.detect {|a| keyword.casecmp(a.mail.to_s) == 0}
if principal.nil? && keyword.include?(' ')
firstname, lastname = *(keyword.split) # "First Last Throwaway"
principal ||=
principals.detect do |a|
a.is_a?(User) &&
firstname.casecmp(a.firstname.to_s) == 0 &&
lastname.casecmp(a.lastname.to_s) == 0
end
end
if principal.nil?
principal ||= principals.detect {|a| keyword.casecmp(a.name) == 0}
end
principal
end
def nullify_projects_default_assigned_to
Project.where(default_assigned_to: self).update_all(default_assigned_to_id: nil)
end
protected
# Make sure we don't try to insert NULL values (see #4632)
def set_default_empty_values
self.login ||= ''
self.hashed_password ||= ''
self.firstname ||= ''
self.lastname ||= ''
true
end
def validate_status
if status_changed? && self.class.valid_statuses.present?
unless self.class.valid_statuses.include?(status)
errors.add :status, :invalid
end
end
end
end
|