project.rb
337 lines
| 13.1 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r330 | # 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 Project < ActiveRecord::Base | ||||
|
Jean-Philippe Lang
|
r546 | # Project statuses | ||
| STATUS_ACTIVE = 1 | ||||
| STATUS_ARCHIVED = 9 | ||||
|
Jean-Philippe Lang
|
r962 | has_many :members, :include => :user, :conditions => "#{User.table_name}.status=#{User::STATUS_ACTIVE}" | ||
|
Jean-Philippe Lang
|
r330 | has_many :users, :through => :members | ||
|
Jean-Philippe Lang
|
r714 | has_many :enabled_modules, :dependent => :delete_all | ||
|
Jean-Philippe Lang
|
r907 | has_and_belongs_to_many :trackers, :order => "#{Tracker.table_name}.position" | ||
|
Jean-Philippe Lang
|
r334 | has_many :issues, :dependent => :destroy, :order => "#{Issue.table_name}.created_on DESC", :include => [:status, :tracker] | ||
|
Jean-Philippe Lang
|
r640 | has_many :issue_changes, :through => :issues, :source => :journals | ||
|
Jean-Philippe Lang
|
r571 | has_many :versions, :dependent => :destroy, :order => "#{Version.table_name}.effective_date DESC, #{Version.table_name}.name DESC" | ||
|
Jean-Philippe Lang
|
r365 | has_many :time_entries, :dependent => :delete_all | ||
|
Jean-Philippe Lang
|
r330 | has_many :queries, :dependent => :delete_all | ||
| has_many :documents, :dependent => :destroy | ||||
| has_many :news, :dependent => :delete_all, :include => :author | ||||
|
Jean-Philippe Lang
|
r334 | has_many :issue_categories, :dependent => :delete_all, :order => "#{IssueCategory.table_name}.name" | ||
|
Jean-Philippe Lang
|
r1301 | has_many :boards, :dependent => :destroy, :order => "position ASC" | ||
|
Jean-Philippe Lang
|
r330 | has_one :repository, :dependent => :destroy | ||
|
Jean-Philippe Lang
|
r703 | has_many :changesets, :through => :repository | ||
|
Jean-Philippe Lang
|
r330 | has_one :wiki, :dependent => :destroy | ||
|
Jean-Philippe Lang
|
r888 | # Custom field for the project issues | ||
|
Jean-Philippe Lang
|
r1578 | has_and_belongs_to_many :issue_custom_fields, | ||
|
Jean-Philippe Lang
|
r888 | :class_name => 'IssueCustomField', | ||
| :order => "#{CustomField.table_name}.position", | ||||
| :join_table => "#{table_name_prefix}custom_fields_projects#{table_name_suffix}", | ||||
| :association_foreign_key => 'custom_field_id' | ||||
|
Jean-Philippe Lang
|
r2302 | acts_as_nested_set :order => 'name', :dependent => :destroy | ||
|
Jean-Philippe Lang
|
r2115 | acts_as_attachable :view_permission => :view_files, | ||
| :delete_permission => :manage_files | ||||
|
Jean-Philippe Lang
|
r755 | |||
|
Jean-Philippe Lang
|
r1578 | acts_as_customizable | ||
|
Jean-Philippe Lang
|
r1420 | acts_as_searchable :columns => ['name', 'description'], :project_key => 'id', :permission => nil | ||
|
Jean-Philippe Lang
|
r755 | acts_as_event :title => Proc.new {|o| "#{l(:label_project)}: #{o.name}"}, | ||
|
Jean-Philippe Lang
|
r1639 | :url => Proc.new {|o| {:controller => 'projects', :action => 'show', :id => o.id}}, | ||
| :author => nil | ||||
|
Jean-Philippe Lang
|
r755 | |||
|
Jean-Philippe Lang
|
r714 | attr_protected :status, :enabled_module_names | ||
|
Jean-Philippe Lang
|
r546 | |||
|
Jean-Philippe Lang
|
r1074 | validates_presence_of :name, :identifier | ||
|
Jean-Philippe Lang
|
r393 | validates_uniqueness_of :name, :identifier | ||
|
Jean-Philippe Lang
|
r330 | validates_associated :repository, :wiki | ||
|
Jean-Philippe Lang
|
r397 | validates_length_of :name, :maximum => 30 | ||
|
Jean-Philippe Lang
|
r1443 | validates_length_of :homepage, :maximum => 255 | ||
|
Jean-Philippe Lang
|
r2219 | validates_length_of :identifier, :in => 2..20 | ||
|
Jean-Philippe Lang
|
r393 | validates_format_of :identifier, :with => /^[a-z0-9\-]*$/ | ||
|
Jean-Philippe Lang
|
r962 | before_destroy :delete_all_members | ||
|
Jean-Philippe Lang
|
r1812 | |||
| named_scope :has_module, lambda { |mod| { :conditions => ["#{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name=?)", mod.to_s] } } | ||||
|
Jean-Philippe Lang
|
r2302 | named_scope :active, { :conditions => "#{Project.table_name}.status = #{STATUS_ACTIVE}"} | ||
|
Jean-Philippe Lang
|
r2317 | named_scope :public, { :conditions => { :is_public => true } } | ||
|
Jean-Philippe Lang
|
r2302 | named_scope :visible, lambda { { :conditions => Project.visible_by(User.current) } } | ||
|
Jean-Philippe Lang
|
r962 | |||
|
Jean-Philippe Lang
|
r393 | def identifier=(identifier) | ||
| super unless identifier_frozen? | ||||
| end | ||||
| def identifier_frozen? | ||||
| errors[:identifier].nil? && !(new_record? || identifier.blank?) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r395 | def issues_with_subprojects(include_subprojects=false) | ||
| conditions = nil | ||||
|
Jean-Philippe Lang
|
r1416 | if include_subprojects | ||
|
Jean-Philippe Lang
|
r2302 | ids = [id] + descendants.collect(&:id) | ||
|
Jean-Philippe Lang
|
r1416 | conditions = ["#{Project.table_name}.id IN (#{ids.join(',')}) AND #{Project.visible_by}"] | ||
|
Jean-Philippe Lang
|
r395 | end | ||
|
Jean-Philippe Lang
|
r1349 | conditions ||= ["#{Project.table_name}.id = ?", id] | ||
|
Jean-Philippe Lang
|
r969 | # Quick and dirty fix for Rails 2 compatibility | ||
| Issue.send(:with_scope, :find => { :conditions => conditions }) do | ||||
|
Jean-Philippe Lang
|
r1349 | Version.send(:with_scope, :find => { :conditions => conditions }) do | ||
| yield | ||||
| end | ||||
|
Jean-Philippe Lang
|
r395 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r879 | |||
|
Jean-Philippe Lang
|
r330 | # returns latest created projects | ||
| # non public projects will be returned only if user is a member of those | ||||
| def self.latest(user=nil, count=5) | ||||
|
Jean-Philippe Lang
|
r334 | find(:all, :limit => count, :conditions => visible_by(user), :order => "created_on DESC") | ||
|
Jean-Philippe Lang
|
r330 | end | ||
Eric Davis
|
r2536 | # Returns a SQL :conditions string used to find all active projects for the specified user. | ||
| # | ||||
| # Examples: | ||||
| # Projects.visible_by(admin) => "projects.status = 1" | ||||
| # Projects.visible_by(normal_user) => "projects.status = 1 AND projects.is_public = 1" | ||||
|
Jean-Philippe Lang
|
r330 | def self.visible_by(user=nil) | ||
|
Jean-Philippe Lang
|
r1416 | user ||= User.current | ||
|
Jean-Philippe Lang
|
r457 | if user && user.admin? | ||
|
Jean-Philippe Lang
|
r673 | return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE}" | ||
|
Jean-Philippe Lang
|
r566 | elsif user && user.memberships.any? | ||
|
Jean-Philippe Lang
|
r673 | return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE} AND (#{Project.table_name}.is_public = #{connection.quoted_true} or #{Project.table_name}.id IN (#{user.memberships.collect{|m| m.project_id}.join(',')}))" | ||
|
Jean-Philippe Lang
|
r330 | else | ||
|
Jean-Philippe Lang
|
r673 | return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE} AND #{Project.table_name}.is_public = #{connection.quoted_true}" | ||
|
Jean-Philippe Lang
|
r546 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r1213 | def self.allowed_to_condition(user, permission, options={}) | ||
|
Jean-Philippe Lang
|
r1162 | statements = [] | ||
|
Jean-Philippe Lang
|
r1213 | base_statement = "#{Project.table_name}.status=#{Project::STATUS_ACTIVE}" | ||
|
Jean-Philippe Lang
|
r1905 | if perm = Redmine::AccessControl.permission(permission) | ||
| unless perm.project_module.nil? | ||||
| # If the permission belongs to a project module, make sure the module is enabled | ||||
| base_statement << " AND EXISTS (SELECT em.id FROM #{EnabledModule.table_name} em WHERE em.name='#{perm.project_module}' AND em.project_id=#{Project.table_name}.id)" | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1213 | if options[:project] | ||
| project_statement = "#{Project.table_name}.id = #{options[:project].id}" | ||||
|
Jean-Philippe Lang
|
r2302 | project_statement << " OR (#{Project.table_name}.lft > #{options[:project].lft} AND #{Project.table_name}.rgt < #{options[:project].rgt})" if options[:with_subprojects] | ||
|
Jean-Philippe Lang
|
r1213 | base_statement = "(#{project_statement}) AND (#{base_statement})" | ||
| end | ||||
|
Jean-Philippe Lang
|
r1162 | if user.admin? | ||
| # no restriction | ||||
| else | ||||
|
Jean-Philippe Lang
|
r1213 | statements << "1=0" | ||
|
Jean-Philippe Lang
|
r1635 | if user.logged? | ||
| statements << "#{Project.table_name}.is_public = #{connection.quoted_true}" if Role.non_member.allowed_to?(permission) | ||||
| allowed_project_ids = user.memberships.select {|m| m.role.allowed_to?(permission)}.collect {|m| m.project_id} | ||||
| statements << "#{Project.table_name}.id IN (#{allowed_project_ids.join(',')})" if allowed_project_ids.any? | ||||
| elsif Role.anonymous.allowed_to?(permission) | ||||
| # anonymous user allowed on public project | ||||
| statements << "#{Project.table_name}.is_public = #{connection.quoted_true}" | ||||
| else | ||||
| # anonymous user is not authorized | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1162 | end | ||
|
Jean-Philippe Lang
|
r1213 | statements.empty? ? base_statement : "((#{base_statement}) AND (#{statements.join(' OR ')}))" | ||
|
Jean-Philippe Lang
|
r1162 | end | ||
|
Eric Davis
|
r2536 | |||
| # Returns a :conditions SQL string that can be used to find the issues associated with this project. | ||||
| # | ||||
| # Examples: | ||||
| # project.project_condition(true) => "(projects.id = 1 OR (projects.lft > 1 AND projects.rgt < 10))" | ||||
| # project.project_condition(false) => "projects.id = 1" | ||||
|
Jean-Philippe Lang
|
r1283 | def project_condition(with_subprojects) | ||
| cond = "#{Project.table_name}.id = #{id}" | ||||
|
Jean-Philippe Lang
|
r2302 | cond = "(#{cond} OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt}))" if with_subprojects | ||
|
Jean-Philippe Lang
|
r1283 | cond | ||
| end | ||||
|
Jean-Philippe Lang
|
r994 | def self.find(*args) | ||
| if args.first && args.first.is_a?(String) && !args.first.match(/^\d*$/) | ||||
| project = find_by_identifier(*args) | ||||
| raise ActiveRecord::RecordNotFound, "Couldn't find Project with identifier=#{args.first}" if project.nil? | ||||
| project | ||||
| else | ||||
| super | ||||
| end | ||||
| end | ||||
| def to_param | ||||
|
Jean-Philippe Lang
|
r1459 | # id is used for projects with a numeric identifier (compatibility) | ||
| @to_param ||= (identifier.to_s =~ %r{^\d*$} ? id : identifier) | ||||
|
Jean-Philippe Lang
|
r994 | end | ||
|
Jean-Philippe Lang
|
r546 | def active? | ||
| self.status == STATUS_ACTIVE | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2302 | # Archives the project and its descendants recursively | ||
|
Jean-Philippe Lang
|
r546 | def archive | ||
| # Archive subprojects if any | ||||
| children.each do |subproject| | ||||
| subproject.archive | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r546 | update_attribute :status, STATUS_ARCHIVED | ||
| end | ||||
|
Jean-Philippe Lang
|
r2302 | # Unarchives the project | ||
| # All its ancestors must be active | ||||
|
Jean-Philippe Lang
|
r546 | def unarchive | ||
|
Jean-Philippe Lang
|
r2302 | return false if ancestors.detect {|a| !a.active?} | ||
|
Jean-Philippe Lang
|
r546 | update_attribute :status, STATUS_ACTIVE | ||
| end | ||||
|
Jean-Philippe Lang
|
r2302 | # Returns an array of projects the project can be moved to | ||
| def possible_parents | ||||
| @possible_parents ||= (Project.active.find(:all) - self_and_descendants) | ||||
| end | ||||
| # Sets the parent of the project | ||||
| # Argument can be either a Project, a String, a Fixnum or nil | ||||
| def set_parent!(p) | ||||
| unless p.nil? || p.is_a?(Project) | ||||
| if p.to_s.blank? | ||||
| p = nil | ||||
| else | ||||
| p = Project.find_by_id(p) | ||||
| return false unless p | ||||
| end | ||||
| end | ||||
| if p == parent && !p.nil? | ||||
| # Nothing to do | ||||
| true | ||||
| elsif p.nil? || (p.active? && move_possible?(p)) | ||||
| # Insert the project so that target's children or root projects stay alphabetically sorted | ||||
| sibs = (p.nil? ? self.class.roots : p.children) | ||||
| to_be_inserted_before = sibs.detect {|c| c.name.to_s.downcase > name.to_s.downcase } | ||||
| if to_be_inserted_before | ||||
| move_to_left_of(to_be_inserted_before) | ||||
| elsif p.nil? | ||||
| if sibs.empty? | ||||
| # move_to_root adds the project in first (ie. left) position | ||||
| move_to_root | ||||
| else | ||||
| move_to_right_of(sibs.last) unless self == sibs.last | ||||
| end | ||||
| else | ||||
| # move_to_child_of adds the project in last (ie.right) position | ||||
| move_to_child_of(p) | ||||
| end | ||||
| true | ||||
| else | ||||
| # Can not move to the given target | ||||
| false | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r2309 | # Returns an array of the trackers used by the project and its active sub projects | ||
|
Jean-Philippe Lang
|
r1057 | def rolled_up_trackers | ||
| @rolled_up_trackers ||= | ||||
| Tracker.find(:all, :include => :projects, | ||||
| :select => "DISTINCT #{Tracker.table_name}.*", | ||||
|
Jean-Philippe Lang
|
r2309 | :conditions => ["#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status = #{STATUS_ACTIVE}", lft, rgt], | ||
|
Jean-Philippe Lang
|
r1057 | :order => "#{Tracker.table_name}.position") | ||
| end | ||||
|
Jean-Philippe Lang
|
r962 | # Deletes all project's members | ||
| def delete_all_members | ||||
| Member.delete_all(['project_id = ?', id]) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r806 | # Users issues can be assigned to | ||
| def assignable_users | ||||
|
Jean-Philippe Lang
|
r926 | members.select {|m| m.role.assignable?}.collect {|m| m.user}.sort | ||
|
Jean-Philippe Lang
|
r806 | end | ||
|
Jean-Philippe Lang
|
r842 | # Returns the mail adresses of users that should be always notified on project events | ||
| def recipients | ||||
| members.select {|m| m.mail_notification? || m.user.mail_notification?}.collect {|m| m.user.mail} | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | # Returns an array of all custom fields enabled for project issues | ||
| # (explictly associated custom fields and custom fields enabled for all projects) | ||||
|
Jean-Philippe Lang
|
r1578 | def all_issue_custom_fields | ||
|
Jean-Philippe Lang
|
r1730 | @all_issue_custom_fields ||= (IssueCustomField.for_all + issue_custom_fields).uniq.sort | ||
|
Jean-Philippe Lang
|
r330 | end | ||
|
Jean-Philippe Lang
|
r692 | |||
|
Jean-Philippe Lang
|
r1420 | def project | ||
| self | ||||
| end | ||||
|
Jean-Philippe Lang
|
r692 | def <=>(project) | ||
|
Jean-Philippe Lang
|
r904 | name.downcase <=> project.name.downcase | ||
|
Jean-Philippe Lang
|
r692 | end | ||
|
Jean-Philippe Lang
|
r714 | |||
|
Jean-Philippe Lang
|
r1074 | def to_s | ||
| name | ||||
| end | ||||
| # Returns a short description of the projects (first lines) | ||||
| def short_description(length = 255) | ||||
|
Jean-Philippe Lang
|
r2302 | description.gsub(/^(.{#{length}}[^\n\r]*).*$/m, '\1...').strip if description | ||
|
Jean-Philippe Lang
|
r1074 | end | ||
|
Eric Davis
|
r2536 | # Return true if this project is allowed to do the specified action. | ||
| # action can be: | ||||
| # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit') | ||||
| # * a permission Symbol (eg. :edit_project) | ||||
|
Jean-Philippe Lang
|
r714 | def allows_to?(action) | ||
| if action.is_a? Hash | ||||
| allowed_actions.include? "#{action[:controller]}/#{action[:action]}" | ||||
| else | ||||
| allowed_permissions.include? action | ||||
| end | ||||
| end | ||||
| def module_enabled?(module_name) | ||||
| module_name = module_name.to_s | ||||
| enabled_modules.detect {|m| m.name == module_name} | ||||
| end | ||||
| def enabled_module_names=(module_names) | ||||
|
Jean-Philippe Lang
|
r2412 | if module_names && module_names.is_a?(Array) | ||
| module_names = module_names.collect(&:to_s) | ||||
| # remove disabled modules | ||||
| enabled_modules.each {|mod| mod.destroy unless module_names.include?(mod.name)} | ||||
| # add new modules | ||||
| module_names.each {|name| enabled_modules << EnabledModule.new(:name => name)} | ||||
| else | ||||
| enabled_modules.clear | ||||
|
Jean-Philippe Lang
|
r714 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r1776 | |||
| # Returns an auto-generated project identifier based on the last identifier used | ||||
| def self.next_identifier | ||||
| p = Project.find(:first, :order => 'created_on DESC') | ||||
| p.nil? ? nil : p.identifier.to_s.succ | ||||
| end | ||||
|
Jean-Philippe Lang
|
r330 | |||
| protected | ||||
| def validate | ||||
|
Jean-Philippe Lang
|
r2430 | errors.add(:identifier, :invalid) if !identifier.blank? && identifier.match(/^\d*$/) | ||
|
Jean-Philippe Lang
|
r5 | end | ||
|
Jean-Philippe Lang
|
r714 | |||
| private | ||||
| def allowed_permissions | ||||
| @allowed_permissions ||= begin | ||||
| module_names = enabled_modules.collect {|m| m.name} | ||||
| Redmine::AccessControl.modules_permissions(module_names).collect {|p| p.name} | ||||
| end | ||||
| end | ||||
| def allowed_actions | ||||
| @actions_allowed ||= allowed_permissions.inject([]) { |actions, permission| actions += Redmine::AccessControl.allowed_actions(permission) }.flatten | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2 | end | ||