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