#!/usr/bin/env ruby #-- encoding: UTF-8 #-- copyright # OpenProject is a project management system. # # Copyright (C) 2012-2013 the OpenProject Team # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License version 3. # # See doc/COPYRIGHT.rdoc for more details. #++ # == 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 through Redmine.pm, you need # to use the apache owner. # -g, --group=GROUP group of the repository. (default: root) # --public-mode=MODE file mode for new public repositories # (default: 0775) # --private-mode=MODE file mode for new private repositories # (default: 0770) # --scm=SCM the kind of SCM repository you want to create (and # register) in Redmine (default: Subversion). # reposman is able to create Git and Subversion # 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. # 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' # working around deprecation in RubyGems 1.6 # needed for rails <2.3.9 only, don't merge to unstable! require 'thread' Version = "1.3" SUPPORTED_SCM = %w( Subversion 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], ['--public-mode', GetoptLong::REQUIRED_ARGUMENT], ['--private-mode', 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' $public_mode = '0775' $private_mode = '0770' $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 '--public-mode'; $public_mode = arg.dup; when '--private-mode'; $private_mode = arg.dup; 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 'active_resource' rescue LoadError log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true) end class Project < ActiveResource::Base self.headers["User-agent"] = "Redmine repository manager/#{Version}" 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, :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 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 ? $public_mode : $private_mode right = right.to_i(8) & 007777 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) mswin? ? $svn_owner : Etc.getpwuid( File.stat(file).uid ).name end def mswin? (RUBY_PLATFORM =~ /(:?mswin|mingw)/) || (RUBY_PLATFORM == 'java' && (ENV['OS'] || ENV['os']) =~ /windows/i) 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}"}, :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