Chris@0
|
1 #!/usr/bin/env ruby
|
Chris@0
|
2
|
Chris@0
|
3 # == Synopsis
|
Chris@0
|
4 #
|
Chris@0
|
5 # reposman: manages your repositories with Redmine
|
Chris@0
|
6 #
|
Chris@0
|
7 # == Usage
|
Chris@0
|
8 #
|
Chris@0
|
9 # reposman [OPTIONS...] -s [DIR] -r [HOST]
|
Chris@0
|
10 #
|
Chris@0
|
11 # Examples:
|
Chris@0
|
12 # reposman --svn-dir=/var/svn --redmine-host=redmine.example.net --scm subversion
|
Chris@0
|
13 # reposman -s /var/git -r redmine.example.net -u http://svn.example.net --scm git
|
Chris@0
|
14 #
|
Chris@0
|
15 # == Arguments (mandatory)
|
Chris@0
|
16 #
|
Chris@0
|
17 # -s, --svn-dir=DIR use DIR as base directory for svn repositories
|
Chris@0
|
18 # -r, --redmine-host=HOST assume Redmine is hosted on HOST. Examples:
|
Chris@0
|
19 # -r redmine.example.net
|
Chris@0
|
20 # -r http://redmine.example.net
|
Chris@0
|
21 # -r https://example.net/redmine
|
Chris@0
|
22 # -k, --key=KEY use KEY as the Redmine API key
|
Chris@0
|
23 #
|
Chris@0
|
24 # == Options
|
Chris@0
|
25 #
|
Chris@0
|
26 # -o, --owner=OWNER owner of the repository. using the rails login
|
Chris@0
|
27 # allow user to browse the repository within
|
Chris@0
|
28 # Redmine even for private project. If you want to
|
Chris@0
|
29 # share repositories through Redmine.pm, you need
|
Chris@0
|
30 # to use the apache owner.
|
Chris@0
|
31 # -g, --group=GROUP group of the repository. (default: root)
|
Chris@0
|
32 # --scm=SCM the kind of SCM repository you want to create (and
|
Chris@0
|
33 # register) in Redmine (default: Subversion).
|
Chris@0
|
34 # reposman is able to create Git and Subversion
|
Chris@0
|
35 # repositories. For all other kind, you must specify
|
Chris@0
|
36 # a --command option
|
Chris@0
|
37 # -u, --url=URL the base url Redmine will use to access your
|
Chris@0
|
38 # repositories. This option is used to automatically
|
Chris@0
|
39 # register the repositories in Redmine. The project
|
Chris@0
|
40 # identifier will be appended to this url. Examples:
|
Chris@0
|
41 # -u https://example.net/svn
|
Chris@0
|
42 # -u file:///var/svn/
|
Chris@0
|
43 # if this option isn't set, reposman won't register
|
Chris@0
|
44 # the repositories in Redmine
|
Chris@0
|
45 # -c, --command=COMMAND use this command instead of "svnadmin create" to
|
Chris@0
|
46 # create a repository. This option can be used to
|
Chris@0
|
47 # create repositories other than subversion and git
|
Chris@0
|
48 # kind.
|
Chris@0
|
49 # This command override the default creation for git
|
Chris@0
|
50 # and subversion.
|
Chris@0
|
51 # -f, --force force repository creation even if the project
|
Chris@0
|
52 # repository is already declared in Redmine
|
Chris@0
|
53 # -t, --test only show what should be done
|
Chris@0
|
54 # -h, --help show help and exit
|
Chris@0
|
55 # -v, --verbose verbose
|
Chris@0
|
56 # -V, --version print version and exit
|
Chris@0
|
57 # -q, --quiet no log
|
Chris@0
|
58 #
|
Chris@0
|
59 # == References
|
Chris@0
|
60 #
|
Chris@0
|
61 # You can find more information on the redmine's wiki : http://www.redmine.org/wiki/redmine/HowTos
|
Chris@0
|
62
|
Chris@0
|
63
|
Chris@0
|
64 require 'getoptlong'
|
Chris@0
|
65 require 'rdoc/usage'
|
Chris@0
|
66 require 'find'
|
Chris@0
|
67 require 'etc'
|
Chris@0
|
68
|
Chris@0
|
69 Version = "1.3"
|
Chris@0
|
70 SUPPORTED_SCM = %w( Subversion Darcs Mercurial Bazaar Git Filesystem )
|
Chris@0
|
71
|
Chris@0
|
72 opts = GetoptLong.new(
|
Chris@0
|
73 ['--svn-dir', '-s', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
74 ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
75 ['--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
76 ['--owner', '-o', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
77 ['--group', '-g', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
78 ['--url', '-u', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
79 ['--command' , '-c', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
80 ['--scm', GetoptLong::REQUIRED_ARGUMENT],
|
Chris@0
|
81 ['--test', '-t', GetoptLong::NO_ARGUMENT],
|
Chris@0
|
82 ['--force', '-f', GetoptLong::NO_ARGUMENT],
|
Chris@0
|
83 ['--verbose', '-v', GetoptLong::NO_ARGUMENT],
|
Chris@0
|
84 ['--version', '-V', GetoptLong::NO_ARGUMENT],
|
Chris@0
|
85 ['--help' , '-h', GetoptLong::NO_ARGUMENT],
|
Chris@0
|
86 ['--quiet' , '-q', GetoptLong::NO_ARGUMENT]
|
Chris@0
|
87 )
|
Chris@0
|
88
|
Chris@0
|
89 $verbose = 0
|
Chris@0
|
90 $quiet = false
|
Chris@0
|
91 $redmine_host = ''
|
Chris@0
|
92 $repos_base = ''
|
Chris@0
|
93 $svn_owner = 'root'
|
Chris@0
|
94 $svn_group = 'root'
|
Chris@0
|
95 $use_groupid = true
|
Chris@0
|
96 $svn_url = false
|
Chris@0
|
97 $test = false
|
Chris@0
|
98 $force = false
|
Chris@0
|
99 $scm = 'Subversion'
|
Chris@0
|
100
|
Chris@0
|
101 def log(text, options={})
|
Chris@0
|
102 level = options[:level] || 0
|
Chris@0
|
103 puts text unless $quiet or level > $verbose
|
Chris@0
|
104 exit 1 if options[:exit]
|
Chris@0
|
105 end
|
Chris@0
|
106
|
Chris@0
|
107 def system_or_raise(command)
|
Chris@0
|
108 raise "\"#{command}\" failed" unless system command
|
Chris@0
|
109 end
|
Chris@0
|
110
|
Chris@0
|
111 module SCM
|
Chris@0
|
112
|
Chris@0
|
113 module Subversion
|
Chris@0
|
114 def self.create(path)
|
Chris@0
|
115 system_or_raise "svnadmin create #{path}"
|
Chris@0
|
116 end
|
Chris@0
|
117 end
|
Chris@0
|
118
|
Chris@0
|
119 module Git
|
Chris@0
|
120 def self.create(path)
|
Chris@0
|
121 Dir.mkdir path
|
Chris@0
|
122 Dir.chdir(path) do
|
Chris@0
|
123 system_or_raise "git --bare init --shared"
|
Chris@0
|
124 system_or_raise "git update-server-info"
|
Chris@0
|
125 end
|
Chris@0
|
126 end
|
Chris@0
|
127 end
|
Chris@0
|
128
|
Chris@0
|
129 end
|
Chris@0
|
130
|
Chris@0
|
131 begin
|
Chris@0
|
132 opts.each do |opt, arg|
|
Chris@0
|
133 case opt
|
Chris@0
|
134 when '--svn-dir'; $repos_base = arg.dup
|
Chris@0
|
135 when '--redmine-host'; $redmine_host = arg.dup
|
Chris@0
|
136 when '--key'; $api_key = arg.dup
|
Chris@0
|
137 when '--owner'; $svn_owner = arg.dup; $use_groupid = false;
|
Chris@0
|
138 when '--group'; $svn_group = arg.dup; $use_groupid = false;
|
Chris@0
|
139 when '--url'; $svn_url = arg.dup
|
Chris@0
|
140 when '--scm'; $scm = arg.dup.capitalize; log("Invalid SCM: #{$scm}", :exit => true) unless SUPPORTED_SCM.include?($scm)
|
Chris@0
|
141 when '--command'; $command = arg.dup
|
Chris@0
|
142 when '--verbose'; $verbose += 1
|
Chris@0
|
143 when '--test'; $test = true
|
Chris@0
|
144 when '--force'; $force = true
|
Chris@0
|
145 when '--version'; puts Version; exit
|
Chris@0
|
146 when '--help'; RDoc::usage
|
Chris@0
|
147 when '--quiet'; $quiet = true
|
Chris@0
|
148 end
|
Chris@0
|
149 end
|
Chris@0
|
150 rescue
|
Chris@0
|
151 exit 1
|
Chris@0
|
152 end
|
Chris@0
|
153
|
Chris@0
|
154 if $test
|
Chris@0
|
155 log("running in test mode")
|
Chris@0
|
156 end
|
Chris@0
|
157
|
Chris@0
|
158 # Make sure command is overridden if SCM vendor is not handled internally (for the moment Subversion and Git)
|
Chris@0
|
159 if $command.nil?
|
Chris@0
|
160 begin
|
Chris@0
|
161 scm_module = SCM.const_get($scm)
|
Chris@0
|
162 rescue
|
Chris@0
|
163 log("Please use --command option to specify how to create a #{$scm} repository.", :exit => true)
|
Chris@0
|
164 end
|
Chris@0
|
165 end
|
Chris@0
|
166
|
Chris@0
|
167 $svn_url += "/" if $svn_url and not $svn_url.match(/\/$/)
|
Chris@0
|
168
|
Chris@0
|
169 if ($redmine_host.empty? or $repos_base.empty?)
|
Chris@0
|
170 RDoc::usage
|
Chris@0
|
171 end
|
Chris@0
|
172
|
Chris@0
|
173 unless File.directory?($repos_base)
|
Chris@0
|
174 log("directory '#{$repos_base}' doesn't exists", :exit => true)
|
Chris@0
|
175 end
|
Chris@0
|
176
|
Chris@0
|
177 begin
|
Chris@0
|
178 require 'active_resource'
|
Chris@0
|
179 rescue LoadError
|
Chris@0
|
180 log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
|
Chris@0
|
181 end
|
Chris@0
|
182
|
Chris@0
|
183 class Project < ActiveResource::Base; end
|
Chris@0
|
184
|
Chris@0
|
185 log("querying Redmine for projects...", :level => 1);
|
Chris@0
|
186
|
Chris@0
|
187 $redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
|
Chris@0
|
188 $redmine_host.gsub!(/\/$/, '')
|
Chris@0
|
189
|
Chris@0
|
190 Project.site = "#{$redmine_host}/sys";
|
Chris@0
|
191
|
Chris@0
|
192 begin
|
Chris@0
|
193 # Get all active projects that have the Repository module enabled
|
Chris@0
|
194 projects = Project.find(:all, :params => {:key => $api_key})
|
Chris@0
|
195 rescue => e
|
Chris@0
|
196 log("Unable to connect to #{Project.site}: #{e}", :exit => true)
|
Chris@0
|
197 end
|
Chris@0
|
198
|
Chris@0
|
199 if projects.nil?
|
Chris@0
|
200 log('no project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
|
Chris@0
|
201 end
|
Chris@0
|
202
|
Chris@0
|
203 log("retrieved #{projects.size} projects", :level => 1)
|
Chris@0
|
204
|
Chris@0
|
205 def set_owner_and_rights(project, repos_path, &block)
|
Chris@0
|
206 if RUBY_PLATFORM =~ /mswin/
|
Chris@0
|
207 yield if block_given?
|
Chris@0
|
208 else
|
Chris@0
|
209 uid, gid = Etc.getpwnam($svn_owner).uid, ($use_groupid ? Etc.getgrnam(project.identifier).gid : Etc.getgrnam($svn_group).gid)
|
Chris@0
|
210 right = project.is_public ? 0775 : 0770
|
Chris@0
|
211 yield if block_given?
|
Chris@0
|
212 Find.find(repos_path) do |f|
|
Chris@0
|
213 File.chmod right, f
|
Chris@0
|
214 File.chown uid, gid, f
|
Chris@0
|
215 end
|
Chris@0
|
216 end
|
Chris@0
|
217 end
|
Chris@0
|
218
|
Chris@0
|
219 def other_read_right?(file)
|
Chris@0
|
220 (File.stat(file).mode & 0007).zero? ? false : true
|
Chris@0
|
221 end
|
Chris@0
|
222
|
Chris@0
|
223 def owner_name(file)
|
Chris@0
|
224 mswin? ?
|
Chris@0
|
225 $svn_owner :
|
Chris@0
|
226 Etc.getpwuid( File.stat(file).uid ).name
|
Chris@0
|
227 end
|
Chris@0
|
228
|
Chris@0
|
229 def mswin?
|
Chris@0
|
230 (RUBY_PLATFORM =~ /(:?mswin|mingw)/) || (RUBY_PLATFORM == 'java' && (ENV['OS'] || ENV['os']) =~ /windows/i)
|
Chris@0
|
231 end
|
Chris@0
|
232
|
Chris@0
|
233 projects.each do |project|
|
Chris@0
|
234 log("treating project #{project.name}", :level => 1)
|
Chris@0
|
235
|
Chris@0
|
236 if project.identifier.empty?
|
Chris@0
|
237 log("\tno identifier for project #{project.name}")
|
Chris@0
|
238 next
|
Chris@0
|
239 elsif not project.identifier.match(/^[a-z0-9\-]+$/)
|
Chris@0
|
240 log("\tinvalid identifier for project #{project.name} : #{project.identifier}");
|
Chris@0
|
241 next;
|
Chris@0
|
242 end
|
Chris@0
|
243
|
Chris@0
|
244 repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
|
Chris@0
|
245
|
Chris@0
|
246 if File.directory?(repos_path)
|
Chris@0
|
247
|
Chris@0
|
248 # we must verify that repository has the good owner and the good
|
Chris@0
|
249 # rights before leaving
|
Chris@0
|
250 other_read = other_read_right?(repos_path)
|
Chris@0
|
251 owner = owner_name(repos_path)
|
Chris@0
|
252 next if project.is_public == other_read and owner == $svn_owner
|
Chris@0
|
253
|
Chris@0
|
254 if $test
|
Chris@0
|
255 log("\tchange mode on #{repos_path}")
|
Chris@0
|
256 next
|
Chris@0
|
257 end
|
Chris@0
|
258
|
Chris@0
|
259 begin
|
Chris@0
|
260 set_owner_and_rights(project, repos_path)
|
Chris@0
|
261 rescue Errno::EPERM => e
|
Chris@0
|
262 log("\tunable to change mode on #{repos_path} : #{e}\n")
|
Chris@0
|
263 next
|
Chris@0
|
264 end
|
Chris@0
|
265
|
Chris@0
|
266 log("\tmode change on #{repos_path}");
|
Chris@0
|
267
|
Chris@0
|
268 else
|
Chris@0
|
269 # if repository is already declared in redmine, we don't create
|
Chris@0
|
270 # unless user use -f with reposman
|
Chris@0
|
271 if $force == false and project.respond_to?(:repository)
|
Chris@0
|
272 log("\trepository for project #{project.identifier} already exists in Redmine", :level => 1)
|
Chris@0
|
273 next
|
Chris@0
|
274 end
|
Chris@0
|
275
|
Chris@0
|
276 project.is_public ? File.umask(0002) : File.umask(0007)
|
Chris@0
|
277
|
Chris@0
|
278 if $test
|
Chris@0
|
279 log("\tcreate repository #{repos_path}")
|
Chris@0
|
280 log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}") if $svn_url;
|
Chris@0
|
281 next
|
Chris@0
|
282 end
|
Chris@0
|
283
|
Chris@0
|
284 begin
|
Chris@0
|
285 set_owner_and_rights(project, repos_path) do
|
Chris@0
|
286 if scm_module.nil?
|
Chris@0
|
287 system_or_raise "#{$command} #{repos_path}"
|
Chris@0
|
288 else
|
Chris@0
|
289 scm_module.create(repos_path)
|
Chris@0
|
290 end
|
Chris@0
|
291 end
|
Chris@0
|
292 rescue => e
|
Chris@0
|
293 log("\tunable to create #{repos_path} : #{e}\n")
|
Chris@0
|
294 next
|
Chris@0
|
295 end
|
Chris@0
|
296
|
Chris@0
|
297 if $svn_url
|
Chris@0
|
298 begin
|
Chris@0
|
299 project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"}, :key => $api_key)
|
Chris@0
|
300 log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}");
|
Chris@0
|
301 rescue => e
|
Chris@0
|
302 log("\trepository #{repos_path} not registered in Redmine: #{e.message}");
|
Chris@0
|
303 end
|
Chris@0
|
304 end
|
Chris@0
|
305
|
Chris@0
|
306 log("\trepository #{repos_path} created");
|
Chris@0
|
307 end
|
Chris@0
|
308
|
Chris@0
|
309 end
|
Chris@0
|
310 |