jro_apps/redmine Commit - r13191:13f9ccaed853

Adds configuration settings to limit valid repository path (#1415)....

Jean-Philippe Lang -

r13191:13f9ccaed853

parent child

Context file:

r13191:13f9ccaed853

Collapse all files

app/helpers/repositories_helper.rb +29 -7

                def subversion_field_tags(form, repository)
                    content_tag('p', form.text_field(:url, :size => 60, :required => true,
                                     :disabled => !repository.safe_attribute?('url')) +
-                                    content_tag('em', '(file:///, http://, https://, svn://, svn+[tunnelscheme]://)', :class => 'info')) +
+                                    scm_path_info_tag(repository)) +
                    content_tag('p', form.text_field(:login, :size => 30)) +
                    content_tag('p', form.password_field(
                                          :password, :size => 30, :name => 'ignore',
                  content_tag('p', form.text_field(
                                   :url, :label => l(:field_path_to_repository),
                                   :size => 60, :required => true,
-                                  :disabled => !repository.safe_attribute?('url'))) +
+                                  :disabled => !repository.safe_attribute?('url')) +
+                                  scm_path_info_tag(repository)) +
                  scm_log_encoding_tag(form, repository)
                end
                                     :size => 60, :required => true,
                                     :disabled => !repository.safe_attribute?('url')
                                       ) +
-                                  content_tag('em', l(:text_mercurial_repository_note), :class => 'info')) +
+                                  scm_path_info_tag(repository)) +
                  scm_path_encoding_tag(form, repository)
                end
                                     :size => 60, :required => true,
                                     :disabled => !repository.safe_attribute?('url')
                                       ) +
-                                   content_tag('em', l(:text_git_repository_note), :class => 'info')) +
+                                   scm_path_info_tag(repository)) +
                  scm_path_encoding_tag(form, repository) +
                  content_tag('p', form.check_box(
                                      :extra_report_last_commit,
                                   :root_url,
                                   :label => l(:field_cvsroot),
                                   :size => 60, :required => true,
-                                  :disabled => !repository.safe_attribute?('root_url'))) +
+                                  :disabled => !repository.safe_attribute?('root_url')) +
+                                  scm_path_info_tag(repository)) +
                  content_tag('p', form.text_field(
                                   :url,
                                   :label => l(:field_cvs_module),
                  content_tag('p', form.text_field(
                                   :url, :label => l(:field_path_to_repository),
                                   :size => 60, :required => true,
-                                  :disabled => !repository.safe_attribute?('url'))) +
+                                  :disabled => !repository.safe_attribute?('url')) +
+                                  scm_path_info_tag(repository)) +
                  scm_log_encoding_tag(form, repository)
                end
                  content_tag('p', form.text_field(
                                   :url, :label => l(:field_root_directory),
                                   :size => 60, :required => true,
-                                  :disabled => !repository.safe_attribute?('url'))) +
+                                  :disabled => !repository.safe_attribute?('url')) +
+                                  scm_path_info_tag(repository)) +
                  scm_path_encoding_tag(form, repository)
                end
+               def scm_path_info_tag(repository)
+                 text = scm_path_info(repository)
+                 if text.present?
+                   content_tag('em', text, :class => 'info')
+                 else
+                   ''
+                 end
+               end
+               def scm_path_info(repository)
+                 scm_name = repository.scm_name.to_s.downcase
+                 info_from_config = Redmine::Configuration["scm_#{scm_name}_path_info"].presence
+                 return info_from_config.html_safe if info_from_config
+                 l("text_#{scm_name}_repository_note", :default => '')
+               end
                def scm_log_encoding_tag(form, repository)
                  select = form.select(
                    :log_encoding,

app/models/repository.rb +13 0

                validates_format_of :identifier, :with => /\A(?!\d+$)[a-z0-9\-_]*\z/, :allow_blank => true
                # Checks if the SCM is enabled when creating a repository
                validate :repo_create_validation, :on => :create
+               validate :validate_repository_path
                attr_protected :id
                safe_attributes 'identifier',
                protected
+               # Validates repository url based against an optional regular expression
+               # that can be set in the Redmine configuration file.
+               def validate_repository_path(attribute=:url)
+                 regexp = Redmine::Configuration["scm_#{scm_name.to_s.downcase}_path_regexp"]
+                 if changes[attribute] && regexp.present?
+                   regexp = regexp.to_s.strip.gsub('%project%') {Regexp.escape(project.try(:identifier).to_s)}
+                   unless send(attribute).to_s.match(Regexp.new("\\A#{regexp}\\z"))
+                     errors.add(attribute, :invalid)
+                   end
+                 end
+               end
                def check_default
                  if !is_default? && set_as_default?
                    self.is_default = true

app/models/repository/cvs.rb +8 0

                  @current_revision_number = nil
                end
+               protected
+               # Overrides Repository#validate_repository_path to validate
+               # against root_url attribute.
+               def validate_repository_path(attribute=:root_url)
+                 super(attribute)
+               end
                private
                # Returns the next revision number to assign to a CVS changeset

config/configuration.yml.example +27 0

		@@ -108,6 +108,33 default:
108	108	scm_bazaar_command:
109	109	scm_darcs_command:
110	110
	111	# SCM paths validation.
	112	#
	113	# You can configure a regular expression for each SCM that will be used to
	114	# validate the path of new repositories (eg. path entered by users with the
	115	# "Manage repositories" permission and path returned by reposman.rb).
	116	# The regexp will be wrapped with \A \z, so it must match the whole path.
	117	# And the regexp is case sensitive.
	118	#
	119	# You can match the project identifier by using %project% in the regexp.
	120	#
	121	# You can also set a custom hint message for each SCM that will be displayed
	122	# on the repository form instead of the default one.
	123	#
	124	# Examples:
	125	# scm_subversion_path_regexp: file:///svnpath/[a-z0-9_]+
	126	# scm_subversion_path_info: SVN URL (eg. file:///svnpath/foo)
	127	#
	128	# scm_git_path_regexp: /gitpath/%project%(\.[a-z0-9_])?/
	129	#
	130	scm_subversion_path_regexp:
	131	scm_mercurial_path_regexp:
	132	scm_git_path_regexp:
	133	scm_cvs_path_regexp:
	134	scm_bazaar_path_regexp:
	135	scm_darcs_path_regexp:
	136	scm_filesystem_path_regexp:
	137
111	138	# Absolute path to the SCM commands errors (stderr) log file.
112	139	# The default is to log in the 'log' directory of your Redmine instance.
113	140	# Example:

config/locales/en.yml +1 0

                text_zoom_out: Zoom out
                text_warn_on_leaving_unsaved: "The current page contains unsaved text that will be lost if you leave this page."
                text_scm_path_encoding_note: "Default: UTF-8"
+               text_subversion_repository_note: "Examples: file:///, http://, https://, svn://, svn+[tunnelscheme]://"
                text_git_repository_note: Repository is bare and local (e.g. /gitrepo, c:\gitrepo)
                text_mercurial_repository_note: Local repository (e.g. /hgrepo, c:\hgrepo)
                text_scm_command: Command

config/locales/fr.yml +3 -2

                text_zoom_out: Zoom arrière
                text_warn_on_leaving_unsaved: "Cette page contient du texte non sauvegardé qui sera perdu si vous quittez la page."
                text_scm_path_encoding_note: "Défaut : UTF-8"
-               text_git_repository_note: "Le dépôt est vide et local (exemples : /gitrepo, c:\\gitrepo)"
-               text_mercurial_repository_note: "Dépôt local (exemples : /hgrepo, c:\\hgrepo)"
+               text_subversion_repository_note: "Exemples (en fonction des protocoles supportés) : file:///, http://, https://, svn://, svn+[tunnelscheme]://"
+               text_git_repository_note: "Chemin vers un dépôt vide et local (exemples : /gitrepo, c:\\gitrepo)"
+               text_mercurial_repository_note: "Chemin vers un dépôt local (exemples : /hgrepo, c:\\hgrepo)"
                text_scm_command: Commande
                text_scm_command_version: Version
                text_scm_config: Vous pouvez configurer les commandes des SCM dans config/configuration.yml. Redémarrer l'application après modification.

lib/redmine/configuration.rb +15 0

                        end
                      end
+                     check_regular_expressions
                      @config
                    end
                        @config.merge!({'email_delivery' => load_from_yaml(deprecated_email_conf, env)})
                      end
                    end
+                   # Checks the validness of regular expressions set for repository paths at startup
+                   def check_regular_expressions
+                     @config.each do |name, value|
+                       if value.present? && name =~ /^scm_.+_path_regexp$/
+                         begin
+                           Regexp.new value.to_s.strip
+                         rescue => e
+                           $stderr.puts "Invalid regular expression set as #{name} setting in your Redmine configuration file:\n#{e.message}"
+                           exit 1
+                         end
+                       end
+                     end
+                   end
                  end
                end
              end

test/unit/repository_cvs_test.rb +18 0

                  assert_include str, repo.errors.full_messages
                end
+               def test_root_url_should_be_validated_against_regexp_set_in_configuration
+                 Redmine::Configuration.with 'scm_cvs_path_regexp' => '/cvspath/[a-z]+' do
+                   repo = Repository::Cvs.new(
+                     :project       => @project,
+                     :identifier    => 'test',
+                     :log_encoding  => 'UTF-8',
+                     :path_encoding => '',
+                     :url           => MODULE_NAME
+                   )
+                   repo.root_url = '/wrong_path'
+                   assert !repo.valid?
+                   assert repo.errors[:root_url].present?
+                   repo.root_url = '/cvspath/foo'
+                   assert repo.valid?
+                 end
+               end
                if File.directory?(REPOSITORY_PATH)
                  def test_fetch_changesets_from_scratch
                    assert_equal 0, @repository.changesets.count

test/unit/repository_subversion_test.rb +31 0

		@@ -57,6 +57,37 class RepositorySubversionTest < ActiveSupport::TestCase
57	57	end
58	58	end
59	59
	60	def test_url_should_be_validated_against_regexp_set_in_configuration
	61	Redmine::Configuration.with 'scm_subversion_path_regexp' => 'file:///svnpath/[a-z]+' do
	62	repo = Repository::Subversion.new(:project => @project, :identifier => 'test')
	63	repo.url = 'http://foo'
	64	assert !repo.valid?
	65	assert repo.errors[:url].present?
	66
	67	repo.url = 'file:///svnpath/foo/bar'
	68	assert !repo.valid?
	69	assert repo.errors[:url].present?
	70
	71	repo.url = 'file:///svnpath/foo'
	72	assert repo.valid?
	73	end
	74	end
	75
	76	def test_url_should_be_validated_against_regexp_set_in_configuration_with_project_identifier
	77	Redmine::Configuration.with 'scm_subversion_path_regexp' => 'file:///svnpath/%project%(\.[a-z]+)?' do
	78	repo = Repository::Subversion.new(:project => @project, :identifier => 'test')
	79	repo.url = 'file:///svnpath/invalid'
	80	assert !repo.valid?
	81	assert repo.errors[:url].present?
	82
	83	repo.url = 'file:///svnpath/subproject1'
	84	assert repo.valid?
	85
	86	repo.url = 'file:///svnpath/subproject1.foo'
	87	assert repo.valid?
	88	end
	89	end
	90
60	91	if repository_configured?('subversion')
61	92	def test_fetch_changesets_from_scratch
62	93	assert_equal 0, @repository.changesets.count

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages