Chris@1517: # Redmine - project management software
Chris@1517: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1517: #
Chris@1517: # This program is free software; you can redistribute it and/or
Chris@1517: # modify it under the terms of the GNU General Public License
Chris@1517: # as published by the Free Software Foundation; either version 2
Chris@1517: # of the License, or (at your option) any later version.
Chris@1517: #
Chris@1517: # This program is distributed in the hope that it will be useful,
Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1517: # GNU General Public License for more details.
Chris@1517: #
Chris@1517: # You should have received a copy of the GNU General Public License
Chris@1517: # along with this program; if not, write to the Free Software
Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1517: 
Chris@1517: class Principal < ActiveRecord::Base
Chris@1517:   self.table_name = "#{table_name_prefix}users#{table_name_suffix}"
Chris@1517: 
Chris@1517:   # Account statuses
Chris@1517:   STATUS_ANONYMOUS  = 0
Chris@1517:   STATUS_ACTIVE     = 1
Chris@1517:   STATUS_REGISTERED = 2
Chris@1517:   STATUS_LOCKED     = 3
Chris@1517: 
Chris@1517:   has_many :members, :foreign_key => 'user_id', :dependent => :destroy
Chris@1517:   has_many :memberships, :class_name => 'Member',
Chris@1517:            :foreign_key => 'user_id',
Chris@1517:            :include => [:project, :roles],
Chris@1517:            :conditions => "#{Project.table_name}.status<>#{Project::STATUS_ARCHIVED}",
Chris@1517:            :order => "#{Project.table_name}.name"
Chris@1517:   has_many :projects, :through => :memberships
Chris@1517:   has_many :issue_categories, :foreign_key => 'assigned_to_id', :dependent => :nullify
Chris@1517: 
Chris@1517:   # Groups and active users
Chris@1517:   scope :active, lambda { where(:status => STATUS_ACTIVE) }
Chris@1517: 
Chris@1517:   scope :like, lambda {|q|
Chris@1517:     q = q.to_s
Chris@1517:     if q.blank?
Chris@1517:       where({})
Chris@1517:     else
Chris@1517:       pattern = "%#{q}%"
Chris@1517:       sql = %w(login firstname lastname mail).map {|column| "LOWER(#{table_name}.#{column}) LIKE LOWER(:p)"}.join(" OR ")
Chris@1517:       params = {:p => pattern}
Chris@1517:       if q =~ /^(.+)\s+(.+)$/
Chris@1517:         a, b = "#{$1}%", "#{$2}%"
Chris@1517:         sql << " OR (LOWER(#{table_name}.firstname) LIKE LOWER(:a) AND LOWER(#{table_name}.lastname) LIKE LOWER(:b))"
Chris@1517:         sql << " OR (LOWER(#{table_name}.firstname) LIKE LOWER(:b) AND LOWER(#{table_name}.lastname) LIKE LOWER(:a))"
Chris@1517:         params.merge!(:a => a, :b => b)
Chris@1517:       end
Chris@1517:       where(sql, params)
Chris@1517:     end
Chris@1517:   }
Chris@1517: 
Chris@1517:   # Principals that are members of a collection of projects
Chris@1517:   scope :member_of, lambda {|projects|
Chris@1517:     projects = [projects] unless projects.is_a?(Array)
Chris@1517:     if projects.empty?
Chris@1517:       where("1=0")
Chris@1517:     else
Chris@1517:       ids = projects.map(&:id)
Chris@1517:       active.uniq.joins(:members).where("#{Member.table_name}.project_id IN (?)", ids)
Chris@1517:     end
Chris@1517:   }
Chris@1517:   # Principals that are not members of projects
Chris@1517:   scope :not_member_of, lambda {|projects|
Chris@1517:     projects = [projects] unless projects.is_a?(Array)
Chris@1517:     if projects.empty?
Chris@1517:       where("1=0")
Chris@1517:     else
Chris@1517:       ids = projects.map(&:id)
Chris@1517:       where("#{Principal.table_name}.id NOT IN (SELECT DISTINCT user_id FROM #{Member.table_name} WHERE project_id IN (?))", ids)
Chris@1517:     end
Chris@1517:   }
Chris@1517:   scope :sorted, lambda { order(*Principal.fields_for_order_statement)}
Chris@1517: 
Chris@1517:   before_create :set_default_empty_values
Chris@1517: 
Chris@1517:   def name(formatter = nil)
Chris@1517:     to_s
Chris@1517:   end
Chris@1517: 
Chris@1517:   def <=>(principal)
Chris@1517:     if principal.nil?
Chris@1517:       -1
Chris@1517:     elsif self.class.name == principal.class.name
Chris@1517:       self.to_s.downcase <=> principal.to_s.downcase
Chris@1517:     else
Chris@1517:       # groups after users
Chris@1517:       principal.class.name <=> self.class.name
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Returns an array of fields names than can be used to make an order statement for principals.
Chris@1517:   # Users are sorted before Groups.
Chris@1517:   # Examples:
Chris@1517:   def self.fields_for_order_statement(table=nil)
Chris@1517:     table ||= table_name
Chris@1517:     columns = ['type DESC'] + (User.name_formatter[:order] - ['id']) + ['lastname', 'id']
Chris@1517:     columns.uniq.map {|field| "#{table}.#{field}"}
Chris@1517:   end
Chris@1517: 
Chris@1517:   protected
Chris@1517: 
Chris@1517:   # Make sure we don't try to insert NULL values (see #4632)
Chris@1517:   def set_default_empty_values
Chris@1517:     self.login ||= ''
Chris@1517:     self.hashed_password ||= ''
Chris@1517:     self.firstname ||= ''
Chris@1517:     self.lastname ||= ''
Chris@1517:     self.mail ||= ''
Chris@1517:     true
Chris@1517:   end
Chris@1517: end