jro_apps/redmine Commit - r3087:cf9bb2699fa1

Adds on optional API key to repositories management controller and reposman.rb....

Jean-Philippe Lang -

r3087:cf9bb2699fa1

parent child

Context file:

r3087:cf9bb2699fa1

Collapse all files

app/controllers/sys_controller.rb +2 -2

             # Redmine - project management software
             # Copyright (C) 2006-2009  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 SysController < ActionController::Base
               before_filter :check_enabled
               def projects
                 p = Project.active.has_module(:repository).find(:all, :include => :repository, :order => 'identifier')
                 render :xml => p.to_xml(:include => :repository)
               end
               def create_project_repository
                 project = Project.find(params[:id])
                 if project.repository
                   render :nothing => true, :status => 409
                 else
                   logger.info "Repository for #{project.name} was reported to be created by #{request.remote_ip}."
                   project.repository = Repository.factory(params[:vendor], params[:repository])
                   if project.repository && project.repository.save
                     render :xml => project.repository, :status => 201
                   else
                     render :nothing => true, :status => 422
                   end
                 end
               end
               def fetch_changesets
                 projects = []
                 if params[:id]
                   projects << Project.active.has_module(:repository).find(params[:id])
                 else
                   projects = Project.active.has_module(:repository).find(:all, :include => :repository)
                 end
                 projects.each do |project|
                   if project.repository
                     project.repository.fetch_changesets
                   end
                 end
                 render :nothing => true, :status => 200
               rescue ActiveRecord::RecordNotFound
                 render :nothing => true, :status => 404
               end
               protected
               def check_enabled
                 User.current = nil
-                unless Setting.sys_api_enabled?
+                unless Setting.sys_api_enabled? && params[:key].to_s == Setting.sys_api_key
-                  render :nothing => 'Access denied. Repository management WS is disabled.', :status => 403
+                  render :text => 'Access denied. Repository management WS is disabled or key is invalid.', :status => 403
                   return false
                 end
               end
             end

app/views/settings/_repositories.rhtml +9 -1

             <% form_tag({:action => 'edit', :tab => 'repositories'}) do %>
             <div class="box tabular settings">
             <p><%= setting_check_box :autofetch_changesets %></p>
-            <p><%= setting_check_box :sys_api_enabled %></p>
+            <p><%= setting_check_box :sys_api_enabled,
+            				 :onclick => "if (this.checked) { Form.Element.enable('settings_sys_api_key'); } else { Form.Element.disable('settings_sys_api_key'); }" %></p>
+            <p><%= setting_text_field :sys_api_key, :size => 30,
+            																				:id => 'settings_sys_api_key',
+            																				:disabled => !Setting.sys_api_enabled?,
+            																				:label => :setting_mail_handler_api_key %>
+              <%= link_to_function l(:label_generate_key), "if ($('settings_sys_api_key').disabled == false) { $('settings_sys_api_key').value = randomKey(20) }" %>
+            </p>
             <p><%= setting_multiselect(:enabled_scm, REDMINE_SUPPORTED_SCM) %></p>
             <p><%= setting_text_field :repositories_encodings, :size => 60 %><br />
             <em><%= l(:text_comma_separated) %></em></p>
             <p><%= setting_select :commit_logs_encoding, Setting::ENCODINGS %></p>
             <p><%= setting_text_field :repository_log_display_limit, :size => 6 %></p>
             </div>
             <fieldset class="box tabular settings"><legend><%= l(:text_issues_ref_in_commit_messages) %></legend>
             <p><%= setting_text_field :commit_ref_keywords, :size => 30 %><br />
             <em><%= l(:text_comma_separated) %></em></p>
             <p><%= setting_text_field :commit_fix_keywords, :size => 30 %>
             &nbsp;<%= l(:label_applied_status) %>: <%= setting_select :commit_fix_status_id, [["", 0]] + IssueStatus.find(:all).collect{|status| [status.name, status.id.to_s]}, :label => false %>
             &nbsp;<%= l(:field_done_ratio) %>: <%= setting_select :commit_fix_done_ratio, (0..10).to_a.collect {|r| ["#{r*10} %", "#{r*10}"] }, :blank => :label_no_change_option, :label => false %>
             <br /><em><%= l(:text_comma_separated) %></em></p>
             </fieldset>
             <%= submit_tag l(:button_save) %>
             <% end %>

config/settings.yml +2 0

             # redMine - project management software
             # Copyright (C) 2006-2007  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.
             # DO NOT MODIFY THIS FILE !!!
             # Settings can be defined through the application in Admin -> Settings
             app_title:
               default: Redmine
             app_subtitle:
               default: Project management
             welcome_text:
               default:
             login_required:
               default: 0
             self_registration:
               default: '2'
             lost_password:
               default: 1
             password_min_length:
               format: int
               default: 4
             attachment_max_size:
               format: int
               default: 5120
             issues_export_limit:
               format: int
               default: 500
             activity_days_default:
               format: int
               default: 30
             per_page_options:
               default: '25,50,100'
             mail_from:
               default: redmine@example.net
             bcc_recipients:
               default: 1
             plain_text_mail:
               default: 0
             text_formatting:
               default: textile
             wiki_compression:
               default: ""
             default_language:
               default: en
             host_name:
               default: localhost:3000
             protocol:
               default: http
             feeds_limit:
               format: int
               default: 15
             # Maximum size of files that can be displayed
             # inline through the file viewer (in KB)
             file_max_size_displayed:
               format: int
               default: 512
             diff_max_lines_displayed:
               format: int
               default: 1500
             enabled_scm:
               serialized: true
               default:
               - Subversion
               - Darcs
               - Mercurial
               - Cvs
               - Bazaar
               - Git
             autofetch_changesets:
               default: 1
             sys_api_enabled:
               default: 0
+            sys_api_key:
+              default: ''
             commit_ref_keywords:
               default: 'refs,references,IssueID'
             commit_fix_keywords:
               default: 'fixes,closes'
             commit_fix_status_id:
               format: int
               default: 0
             commit_fix_done_ratio:
               default: 100
             # autologin duration in days
             # 0 means autologin is disabled
             autologin:
               format: int
               default: 0
             # date format
             date_format:
               default: ''
             time_format:
               default: ''
             user_format:
               default: :firstname_lastname
               format: symbol
             cross_project_issue_relations:
               default: 0
             notified_events:
               serialized: true
               default:
               - issue_added
               - issue_updated
             mail_handler_api_enabled:
               default: 0
             mail_handler_api_key:
               default:
             issue_list_default_columns:
               serialized: true
               default:
               - tracker
               - status
               - priority
               - subject
               - assigned_to
               - updated_on
             display_subprojects_issues:
               default: 1
             issue_done_ratio:
               default: 'issue_field'
             default_projects_public:
               default: 1
             default_projects_modules:
               serialized: true
               default:
               - issue_tracking
               - time_tracking
               - news
               - documents
               - files
               - wiki
               - repository
               - boards
             # Role given to a non-admin user who creates a project
             new_project_user_role_id:
               format: int
               default: ''
             sequential_project_identifiers:
               default: 0
             # encodings used to convert repository files content to UTF-8
             # multiple values accepted, comma separated
             repositories_encodings:
               default: ''
             # encoding used to convert commit logs to UTF-8
             commit_logs_encoding:
               default: 'UTF-8'
             repository_log_display_limit:
               format: int
               default: 100
             ui_theme:
               default: ''
             emails_footer:
               default: |-
                 You have received this notification because you have either subscribed to it, or are involved in it.
                 To change your notification preferences, please click here: http://hostname/my/account
             gravatar_enabled:
               default: 0
             openid:
               default: 0
             gravatar_default:
               default: ''
             start_of_week:
               default: ''

extra/svn/reposman.rb +17 -10

             #!/usr/bin/env ruby
             # == Synopsis
             #
             # reposman: manages your repositories with Redmine
             #
             # == Usage
             #
             #    reposman [OPTIONS...] -s [DIR] -r [HOST]
             #
             #  Examples:
             #    reposman --svn-dir=/var/svn --redmine-host=redmine.example.net --scm subversion
             #    reposman -s /var/git -r redmine.example.net -u http://svn.example.net --scm git
             #
             # == Arguments (mandatory)
             #
             #   -s, --svn-dir=DIR         use DIR as base directory for svn repositories
             #   -r, --redmine-host=HOST   assume Redmine is hosted on HOST. Examples:
             #                             -r redmine.example.net
             #                             -r http://redmine.example.net
             #                             -r https://example.net/redmine
+            #   -k, --key=KEY             use KEY as the Redmine API key
             #
             # == Options
             #
             #   -o, --owner=OWNER         owner of the repository. using the rails login
             #                             allow user to browse the repository within
-            #                             Redmine even for private project. If you want to share repositories
+            #                             Redmine even for private project. If you want to
-            #                             through Redmine.pm, you need to use the apache owner.
+            #                             share repositories through Redmine.pm, you need
+            #                             to use the apache owner.
             #   -g, --group=GROUP         group of the repository. (default: root)
-            #   --scm=SCM                 the kind of SCM repository you want to create (and register) in
+            #   --scm=SCM                 the kind of SCM repository you want to create (and
-            #                             Redmine (default: Subversion). reposman is able to create Git
+            #                             register) in Redmine (default: Subversion).
-            #                             and Subversion repositories. For all other kind (Bazaar,
+            #                             reposman is able to create Git and Subversion
-            #                             Darcs, Filesystem, Mercurial) you must specify a --command option
+            #                             repositories. For all other kind, you must specify
+            #                             a --command option
             #   -u, --url=URL             the base url Redmine will use to access your
             #                             repositories. This option is used to automatically
             #                             register the repositories in Redmine. The project
             #                             identifier will be appended to this url. Examples:
             #                             -u https://example.net/svn
             #                             -u file:///var/svn/
             #                             if this option isn't set, reposman won't register
             #                             the repositories in Redmine
             #   -c, --command=COMMAND     use this command instead of "svnadmin create" to
             #                             create a repository. This option can be used to
-            #                             create repositories other than subversion and git kind.
+            #                             create repositories other than subversion and git
-            #                             This command override the default creation for git and subversion.
+            #                             kind.
+            #                             This command override the default creation for git
+            #                             and subversion.
             #   -f, --force               force repository creation even if the project
             #                             repository is already declared in Redmine
             #   -t, --test                only show what should be done
             #   -h, --help                show help and exit
             #   -v, --verbose             verbose
             #   -V, --version             print version and exit
             #   -q, --quiet               no log
             #
             # == References
             #
             # You can find more information on the redmine's wiki : http://www.redmine.org/wiki/redmine/HowTos
             require 'getoptlong'
             require 'rdoc/usage'
             require 'find'
             require 'etc'
             Version = "1.3"
             SUPPORTED_SCM = %w( Subversion Darcs Mercurial Bazaar Git Filesystem )
             opts = GetoptLong.new(
                                   ['--svn-dir',      '-s', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
+                                  ['--key',          '-k', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--owner',        '-o', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--group',        '-g', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--url',          '-u', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--command' ,     '-c', GetoptLong::REQUIRED_ARGUMENT],
                                   ['--scm',                GetoptLong::REQUIRED_ARGUMENT],
                                   ['--test',         '-t', GetoptLong::NO_ARGUMENT],
                                   ['--force',        '-f', GetoptLong::NO_ARGUMENT],
                                   ['--verbose',      '-v', GetoptLong::NO_ARGUMENT],
                                   ['--version',      '-V', GetoptLong::NO_ARGUMENT],
                                   ['--help'   ,      '-h', GetoptLong::NO_ARGUMENT],
                                   ['--quiet'  ,      '-q', GetoptLong::NO_ARGUMENT]
                                   )
             $verbose      = 0
             $quiet        = false
             $redmine_host = ''
             $repos_base   = ''
             $svn_owner    = 'root'
             $svn_group    = 'root'
             $use_groupid  = true
             $svn_url      = false
             $test         = false
             $force        = false
             $scm          = 'Subversion'
             def log(text, options={})
               level = options[:level] || 0
               puts text unless $quiet or level > $verbose
               exit 1 if options[:exit]
             end
             def system_or_raise(command)
               raise "\"#{command}\" failed" unless system command
             end
             module SCM
               module Subversion
                 def self.create(path)
                   system_or_raise "svnadmin create #{path}"
                 end
               end
               module Git
                 def self.create(path)
                   Dir.mkdir path
                   Dir.chdir(path) do
                     system_or_raise "git --bare init --shared"
                     system_or_raise "git update-server-info"
                   end
                 end
               end
             end
             begin
               opts.each do |opt, arg|
                 case opt
                 when '--svn-dir';        $repos_base   = arg.dup
                 when '--redmine-host';   $redmine_host = arg.dup
+                when '--key';            $api_key      = arg.dup
                 when '--owner';          $svn_owner    = arg.dup; $use_groupid = false;
                 when '--group';          $svn_group    = arg.dup; $use_groupid = false;
                 when '--url';            $svn_url      = arg.dup
                 when '--scm';            $scm          = arg.dup.capitalize; log("Invalid SCM: #{$scm}", :exit => true) unless SUPPORTED_SCM.include?($scm)
                 when '--command';        $command =      arg.dup
                 when '--verbose';        $verbose += 1
                 when '--test';           $test = true
                 when '--force';          $force = true
                 when '--version';        puts Version; exit
                 when '--help';           RDoc::usage
                 when '--quiet';          $quiet = true
                 end
               end
             rescue
               exit 1
             end
             if $test
               log("running in test mode")
             end
             # Make sure command is overridden if SCM vendor is not handled internally (for the moment Subversion and Git)
             if $command.nil?
               begin
                 scm_module = SCM.const_get($scm)
               rescue
                 log("Please use --command option to specify how to create a #{$scm} repository.", :exit => true)
               end
             end
             $svn_url += "/" if $svn_url and not $svn_url.match(/\/$/)
             if ($redmine_host.empty? or $repos_base.empty?)
               RDoc::usage
             end
             unless File.directory?($repos_base)
               log("directory '#{$repos_base}' doesn't exists", :exit => true)
             end
             begin
               require 'activeresource'
             rescue LoadError
               log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
             end
             class Project < ActiveResource::Base; end
             log("querying Redmine for projects...", :level => 1);
             $redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
             $redmine_host.gsub!(/\/$/, '')
             Project.site = "#{$redmine_host}/sys";
             begin
               # Get all active projects that have the Repository module enabled
-              projects = Project.find(:all)
+              projects = Project.find(:all, :params => {:key => $api_key})
             rescue => e
               log("Unable to connect to #{Project.site}: #{e}", :exit => true)
             end
             if projects.nil?
               log('no project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
             end
             log("retrieved #{projects.size} projects", :level => 1)
             def set_owner_and_rights(project, repos_path, &block)
               if RUBY_PLATFORM =~ /mswin/
                 yield if block_given?
               else
                 uid, gid = Etc.getpwnam($svn_owner).uid, ($use_groupid ? Etc.getgrnam(project.identifier).gid : Etc.getgrnam($svn_group).gid)
                 right = project.is_public ? 0775 : 0770
                 yield if block_given?
                 Find.find(repos_path) do |f|
                   File.chmod right, f
                   File.chown uid, gid, f
                 end
               end
             end
             def other_read_right?(file)
               (File.stat(file).mode & 0007).zero? ? false : true
             end
             def owner_name(file)
               RUBY_PLATFORM =~ /mswin/ ?
                 $svn_owner :
                 Etc.getpwuid( File.stat(file).uid ).name
             end
             projects.each do |project|
               log("treating project #{project.name}", :level => 1)
               if project.identifier.empty?
                 log("\tno identifier for project #{project.name}")
                 next
               elsif not project.identifier.match(/^[a-z0-9\-]+$/)
                 log("\tinvalid identifier for project #{project.name} : #{project.identifier}");
                 next;
               end
               repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
               if File.directory?(repos_path)
                 # we must verify that repository has the good owner and the good
                 # rights before leaving
                 other_read = other_read_right?(repos_path)
                 owner      = owner_name(repos_path)
                 next if project.is_public == other_read and owner == $svn_owner
                 if $test
                   log("\tchange mode on #{repos_path}")
                   next
                 end
                 begin
                   set_owner_and_rights(project, repos_path)
                 rescue Errno::EPERM => e
                   log("\tunable to change mode on #{repos_path} : #{e}\n")
                   next
                 end
                 log("\tmode change on #{repos_path}");
               else
                 # if repository is already declared in redmine, we don't create
                 # unless user use -f with reposman
                 if $force == false and project.respond_to?(:repository)
                   log("\trepository for project #{project.identifier} already exists in Redmine", :level => 1)
                   next
                 end
                 project.is_public ? File.umask(0002) : File.umask(0007)
                 if $test
                   log("\tcreate repository #{repos_path}")
                   log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}") if $svn_url;
                   next
                 end
                 begin
                   set_owner_and_rights(project, repos_path) do
                     if scm_module.nil?
                       system_or_raise "#{$command} #{repos_path}"
                     else
                       scm_module.create(repos_path)
                     end
                   end
                 rescue => e
                   log("\tunable to create #{repos_path} : #{e}\n")
                   next
                 end
                 if $svn_url
                   begin
-                    project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"})
+                    project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"}, :key => $api_key)
                     log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}");
                   rescue => e
                     log("\trepository #{repos_path} not registered in Redmine: #{e.message}");
                   end
                 end
                 log("\trepository #{repos_path} created");
               end
             end

test/functional/sys_controller_test.rb +21 0

             # Redmine - project management software
             # Copyright (C) 2006-2009  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.
             require File.dirname(__FILE__) + '/../test_helper'
             require 'sys_controller'
             # Re-raise errors caught by the controller.
             class SysController; def rescue_action(e) raise e end; end
             class SysControllerTest < ActionController::TestCase
               fixtures :projects, :repositories
               def setup
                 @controller = SysController.new
                 @request    = ActionController::TestRequest.new
                 @response   = ActionController::TestResponse.new
                 Setting.sys_api_enabled = '1'
                 Setting.enabled_scm = %w(Subversion Git)
               end
               def test_projects_with_repository_enabled
                 get :projects
                 assert_response :success
                 assert_equal 'application/xml', @response.content_type
                 with_options :tag => 'projects' do |test|
                   test.assert_tag :children => { :count  => Project.active.has_module(:repository).count }
                 end
               end
               def test_create_project_repository
                 assert_nil Project.find(4).repository
                 post :create_project_repository, :id => 4,
                                                  :vendor => 'Subversion',
                                                  :repository => { :url => 'file:///create/project/repository/subproject2'}
                 assert_response :created
                 r = Project.find(4).repository
                 assert r.is_a?(Repository::Subversion)
                 assert_equal 'file:///create/project/repository/subproject2', r.url
               end
               def test_fetch_changesets
                 get :fetch_changesets
                 assert_response :success
               end
               def test_fetch_changesets_one_project
                 get :fetch_changesets, :id => 'ecookbook'
                 assert_response :success
               end
               def test_fetch_changesets_unknown_project
                 get :fetch_changesets, :id => 'unknown'
                 assert_response 404
               end
+              def test_disabled_ws_should_respond_with_403_error
+                with_settings :sys_api_enabled => '0' do
+                  get :projects
+                  assert_response 403
+                end
+              end
+              def test_api_key
+                with_settings :sys_api_key => 'my_secret_key' do
+                  get :projects, :key => 'my_secret_key'
+                  assert_response :success
+                end
+              end
+              def test_wrong_key_should_respond_with_403_error
+                with_settings :sys_api_enabled => 'my_secret_key' do
+                  get :projects, :key => 'wrong_key'
+                  assert_response 403
+                end
+              end
             end

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