##// END OF EJS Templates
Trac importer:...
Jean-Philippe Lang -
r933:e4724c7626a3
parent child
Show More
@@ -1,500 +1,550
1 1 # redMine - project management software
2 2 # Copyright (C) 2006-2007 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require 'active_record'
19 19 require 'iconv'
20 20 require 'pp'
21 21
22 22 namespace :redmine do
23 23 desc 'Trac migration script'
24 24 task :migrate_from_trac => :environment do
25 25
26 26 module TracMigrate
27 TICKET_MAP = [];
27 TICKET_MAP = []
28 28
29 29 DEFAULT_STATUS = IssueStatus.default
30 30 assigned_status = IssueStatus.find_by_position(2)
31 31 resolved_status = IssueStatus.find_by_position(3)
32 32 feedback_status = IssueStatus.find_by_position(4)
33 33 closed_status = IssueStatus.find :first, :conditions => { :is_closed => true }
34 34 STATUS_MAPPING = {'new' => DEFAULT_STATUS,
35 35 'reopened' => feedback_status,
36 36 'assigned' => assigned_status,
37 37 'closed' => closed_status
38 38 }
39 39
40 40 priorities = Enumeration.get_values('IPRI')
41 41 DEFAULT_PRIORITY = priorities[0]
42 42 PRIORITY_MAPPING = {'lowest' => priorities[0],
43 43 'low' => priorities[0],
44 44 'normal' => priorities[1],
45 45 'high' => priorities[2],
46 46 'highest' => priorities[3]
47 47 }
48 48
49 49 TRACKER_BUG = Tracker.find_by_position(1)
50 50 TRACKER_FEATURE = Tracker.find_by_position(2)
51 51 DEFAULT_TRACKER = TRACKER_BUG
52 52 TRACKER_MAPPING = {'defect' => TRACKER_BUG,
53 53 'enhancement' => TRACKER_FEATURE,
54 54 'task' => TRACKER_FEATURE,
55 55 'patch' =>TRACKER_FEATURE
56 56 }
57 57
58 58 roles = Role.find(:all, :conditions => {:builtin => 0}, :order => 'position ASC')
59 59 manager_role = roles[0]
60 60 developer_role = roles[1]
61 61 DEFAULT_ROLE = roles.last
62 62 ROLE_MAPPING = {'admin' => manager_role,
63 63 'developer' => developer_role
64 64 }
65 65
66 66 class TracComponent < ActiveRecord::Base
67 67 set_table_name :component
68 68 end
69 69
70 70 class TracMilestone < ActiveRecord::Base
71 71 set_table_name :milestone
72 72
73 73 def due
74 74 if read_attribute(:due) > 0
75 75 Time.at(read_attribute(:due)).to_date
76 76 else
77 77 nil
78 78 end
79 79 end
80 80 end
81 81
82 82 class TracTicketCustom < ActiveRecord::Base
83 83 set_table_name :ticket_custom
84 84 end
85 85
86 86 class TracAttachment < ActiveRecord::Base
87 87 set_table_name :attachment
88 88 set_inheritance_column :none
89 89
90 90 def time; Time.at(read_attribute(:time)) end
91 91
92 92 def original_filename
93 93 filename
94 94 end
95 95
96 96 def content_type
97 97 Redmine::MimeType.of(filename) || ''
98 98 end
99 99
100 100 def exist?
101 101 File.file? trac_fullpath
102 102 end
103 103
104 104 def read
105 105 File.open("#{trac_fullpath}", 'rb').read
106 106 end
107 107
108 108 private
109 109 def trac_fullpath
110 110 attachment_type = read_attribute(:type)
111 111 trac_file = filename.gsub( /[^a-zA-Z0-9\-_\.!~*']/n ) {|x| sprintf('%%%02x', x[0]) }
112 112 "#{TracMigrate.trac_attachments_directory}/#{attachment_type}/#{id}/#{trac_file}"
113 113 end
114 114 end
115 115
116 116 class TracTicket < ActiveRecord::Base
117 117 set_table_name :ticket
118 118 set_inheritance_column :none
119 119
120 120 # ticket changes: only migrate status changes and comments
121 121 has_many :changes, :class_name => "TracTicketChange", :foreign_key => :ticket
122 122 has_many :attachments, :class_name => "TracAttachment", :foreign_key => :id, :conditions => "#{TracMigrate::TracAttachment.table_name}.type = 'ticket'"
123 123 has_many :customs, :class_name => "TracTicketCustom", :foreign_key => :ticket
124 124
125 125 def ticket_type
126 126 read_attribute(:type)
127 127 end
128 128
129 129 def summary
130 130 read_attribute(:summary).blank? ? "(no subject)" : read_attribute(:summary)
131 131 end
132 132
133 133 def description
134 134 read_attribute(:description).blank? ? summary : read_attribute(:description)
135 135 end
136 136
137 137 def time; Time.at(read_attribute(:time)) end
138 138 end
139 139
140 140 class TracTicketChange < ActiveRecord::Base
141 141 set_table_name :ticket_change
142 142
143 143 def time; Time.at(read_attribute(:time)) end
144 144 end
145 145
146 146 class TracWikiPage < ActiveRecord::Base
147 147 set_table_name :wiki
148 148 end
149 149
150 150 class TracPermission < ActiveRecord::Base
151 151 set_table_name :permission
152 152 end
153 153
154 154 def self.find_or_create_user(username, project_member = false)
155 155 u = User.find_by_login(username)
156 156 if !u
157 157 # Create a new user if not found
158 158 mail = username[0,limit_for(User, 'mail')]
159 159 mail = "#{mail}@foo.bar" unless mail.include?("@")
160 160 u = User.new :firstname => username[0,limit_for(User, 'firstname')].gsub(/[^\w\s\'\-]/i, '-'),
161 161 :lastname => '-',
162 162 :mail => mail.gsub(/[^-@a-z0-9\.]/i, '-')
163 163 u.login = username[0,limit_for(User, 'login')].gsub(/[^a-z0-9_\-@\.]/i, '-')
164 164 u.password = 'trac'
165 165 u.admin = true if TracPermission.find_by_username_and_action(username, 'admin')
166 166 # finally, a default user is used if the new user is not valid
167 167 u = User.find(:first) unless u.save
168 168 end
169 169 # Make sure he is a member of the project
170 170 if project_member && !u.member_of?(@target_project)
171 171 role = DEFAULT_ROLE
172 172 if u.admin
173 173 role = ROLE_MAPPING['admin']
174 174 elsif TracPermission.find_by_username_and_action(username, 'developer')
175 175 role = ROLE_MAPPING['developer']
176 176 end
177 177 Member.create(:user => u, :project => @target_project, :role => role)
178 178 u.reload
179 179 end
180 180 u
181 181 end
182 182
183 183 # Basic wiki syntax conversion
184 184 def self.convert_wiki_text(text)
185 185 # Titles
186 186 text = text.gsub(/^(\=+)\s(.+)\s(\=+)/) {|s| "\nh#{$1.length}. #{$2}\n"}
187 187 # External Links
188 188 text = text.gsub(/\[(http[^\s]+)\s+([^\]]+)\]/) {|s| "\"#{$2}\":#{$1}"}
189 189 # Internal Links
190 text = text.gsub(/[[BR]]/, "\n") # This has to go before the rules below
190 text = text.gsub(/\[\[BR\]\]/, "\n") # This has to go before the rules below
191 191 text = text.gsub(/\[\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
192 192 text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
193 193 text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
194 194 text = text.gsub(/\[wiki:([^\s\]]+).*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
195 195 # Revisions links
196 196 text = text.gsub(/\[(\d+)\]/, 'r\1')
197 197 # Ticket number re-writing
198 198 text = text.gsub(/#(\d+)/) do |s|
199 199 TICKET_MAP[$1.to_i] ||= $1
200 "\##{TICKET_MAP[$1.to_i]}"
200 "\##{TICKET_MAP[$1.to_i] || $1}"
201 201 end
202 202 # Preformatted blocks
203 203 text = text.gsub(/\{\{\{/, '<pre>')
204 204 text = text.gsub(/\}\}\}/, '</pre>')
205 205 # Highlighting
206 206 text = text.gsub(/'''''([^\s])/, '_*\1')
207 207 text = text.gsub(/([^\s])'''''/, '\1*_')
208 208 text = text.gsub(/'''/, '*')
209 209 text = text.gsub(/''/, '_')
210 210 text = text.gsub(/__/, '+')
211 211 text = text.gsub(/~~/, '-')
212 212 text = text.gsub(/`/, '@')
213 213 text = text.gsub(/,,/, '~')
214 214 # Lists
215 215 text = text.gsub(/^([ ]+)\* /) {|s| '*' * $1.length + " "}
216 216
217
218 217 text
219 218 end
220 219
221 220 def self.migrate
222 establish_connection({:adapter => trac_adapter,
223 :database => trac_db_path})
221 establish_connection
224 222
225 223 # Quick database test
226 224 TracComponent.count
227 225
228 226 migrated_components = 0
229 227 migrated_milestones = 0
230 228 migrated_tickets = 0
231 229 migrated_custom_values = 0
232 230 migrated_ticket_attachments = 0
233 231 migrated_wiki_edits = 0
234 232
235 233 # Components
236 234 print "Migrating components"
237 235 issues_category_map = {}
238 236 TracComponent.find(:all).each do |component|
239 237 print '.'
240 238 STDOUT.flush
241 239 c = IssueCategory.new :project => @target_project,
242 240 :name => encode(component.name[0, limit_for(IssueCategory, 'name')])
243 241 next unless c.save
244 242 issues_category_map[component.name] = c
245 243 migrated_components += 1
246 244 end
247 245 puts
248 246
249 247 # Milestones
250 248 print "Migrating milestones"
251 249 version_map = {}
252 250 TracMilestone.find(:all).each do |milestone|
253 251 print '.'
254 252 STDOUT.flush
255 253 v = Version.new :project => @target_project,
256 254 :name => encode(milestone.name[0, limit_for(Version, 'name')]),
257 255 :description => encode(milestone.description.to_s[0, limit_for(Version, 'description')]),
258 256 :effective_date => milestone.due
259 257 next unless v.save
260 258 version_map[milestone.name] = v
261 259 migrated_milestones += 1
262 260 end
263 261 puts
264 262
265 263 # Custom fields
266 264 # TODO: read trac.ini instead
267 265 print "Migrating custom fields"
268 266 custom_field_map = {}
269 267 TracTicketCustom.find_by_sql("SELECT DISTINCT name FROM #{TracTicketCustom.table_name}").each do |field|
270 268 print '.'
271 269 STDOUT.flush
272 270 # Redmine custom field name
273 271 field_name = encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize
274 272 # Find if the custom already exists in Redmine
275 273 f = IssueCustomField.find_by_name(field_name)
276 274 # Or create a new one
277 275 f ||= IssueCustomField.create(:name => encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize,
278 276 :field_format => 'string')
279 277
280 278 next if f.new_record?
281 279 f.trackers = Tracker.find(:all)
282 280 f.projects << @target_project
283 281 custom_field_map[field.name] = f
284 282 end
285 283 puts
286 284
287 285 # Trac 'resolution' field as a Redmine custom field
288 286 r = IssueCustomField.find(:first, :conditions => { :name => "Resolution" })
289 287 r = IssueCustomField.new(:name => 'Resolution',
290 288 :field_format => 'list',
291 289 :is_filter => true) if r.nil?
292 290 r.trackers = Tracker.find(:all)
293 291 r.projects << @target_project
294 292 r.possible_values = %w(fixed invalid wontfix duplicate worksforme)
295 293 custom_field_map['resolution'] = r if r.save
296 294
297 295 # Tickets
298 296 print "Migrating tickets"
299 297 TracTicket.find(:all, :order => 'id ASC').each do |ticket|
300 298 print '.'
301 299 STDOUT.flush
302 300 i = Issue.new :project => @target_project,
303 301 :subject => encode(ticket.summary[0, limit_for(Issue, 'subject')]),
304 302 :description => convert_wiki_text(encode(ticket.description)),
305 303 :priority => PRIORITY_MAPPING[ticket.priority] || DEFAULT_PRIORITY,
306 304 :created_on => ticket.time
307 305 i.author = find_or_create_user(ticket.reporter)
308 306 i.category = issues_category_map[ticket.component] unless ticket.component.blank?
309 307 i.fixed_version = version_map[ticket.milestone] unless ticket.milestone.blank?
310 308 i.status = STATUS_MAPPING[ticket.status] || DEFAULT_STATUS
311 309 i.tracker = TRACKER_MAPPING[ticket.ticket_type] || DEFAULT_TRACKER
312 310 i.custom_values << CustomValue.new(:custom_field => custom_field_map['resolution'], :value => ticket.resolution) unless ticket.resolution.blank?
313 311 i.id = ticket.id unless Issue.exists?(ticket.id)
314 312 next unless i.save
315 313 TICKET_MAP[ticket.id] = i.id
316 314 migrated_tickets += 1
317 315
318 316 # Owner
319 317 unless ticket.owner.blank?
320 318 i.assigned_to = find_or_create_user(ticket.owner, true)
321 319 i.save
322 320 end
323 321
324 322 # Comments and status/resolution changes
325 323 ticket.changes.group_by(&:time).each do |time, changeset|
326 324 status_change = changeset.select {|change| change.field == 'status'}.first
327 325 resolution_change = changeset.select {|change| change.field == 'resolution'}.first
328 326 comment_change = changeset.select {|change| change.field == 'comment'}.first
329 327
330 328 n = Journal.new :notes => (comment_change ? convert_wiki_text(encode(comment_change.newvalue)) : ''),
331 329 :created_on => time
332 330 n.user = find_or_create_user(changeset.first.author)
333 331 n.journalized = i
334 332 if status_change &&
335 333 STATUS_MAPPING[status_change.oldvalue] &&
336 334 STATUS_MAPPING[status_change.newvalue] &&
337 335 (STATUS_MAPPING[status_change.oldvalue] != STATUS_MAPPING[status_change.newvalue])
338 336 n.details << JournalDetail.new(:property => 'attr',
339 337 :prop_key => 'status_id',
340 338 :old_value => STATUS_MAPPING[status_change.oldvalue].id,
341 339 :value => STATUS_MAPPING[status_change.newvalue].id)
342 340 end
343 341 if resolution_change
344 342 n.details << JournalDetail.new(:property => 'cf',
345 343 :prop_key => custom_field_map['resolution'].id,
346 344 :old_value => resolution_change.oldvalue,
347 345 :value => resolution_change.newvalue)
348 346 end
349 347 n.save unless n.details.empty? && n.notes.blank?
350 348 end
351 349
352 350 # Attachments
353 351 ticket.attachments.each do |attachment|
354 352 next unless attachment.exist?
355 353 a = Attachment.new :created_on => attachment.time
356 354 a.file = attachment
357 355 a.author = find_or_create_user(attachment.author)
358 356 a.container = i
359 357 migrated_ticket_attachments += 1 if a.save
360 358 end
361 359
362 360 # Custom fields
363 361 ticket.customs.each do |custom|
364 362 next if custom_field_map[custom.name].nil?
365 363 v = CustomValue.new :custom_field => custom_field_map[custom.name],
366 364 :value => custom.value
367 365 v.customized = i
368 366 next unless v.save
369 367 migrated_custom_values += 1
370 368 end
371 369 end
372 370 puts
373 371
374 372 # Wiki
375 373 print "Migrating wiki"
376 374 @target_project.wiki.destroy if @target_project.wiki
377 375 @target_project.reload
378 376 wiki = Wiki.new(:project => @target_project, :start_page => 'WikiStart')
379 377 if wiki.save
380 378 TracWikiPage.find(:all, :order => 'name, version').each do |page|
381 379 print '.'
382 380 STDOUT.flush
383 381 p = wiki.find_or_new_page(page.name)
384 382 p.content = WikiContent.new(:page => p) if p.new_record?
385 383 p.content.text = page.text
386 384 p.content.author = find_or_create_user(page.author) unless page.author.blank? || page.author == 'trac'
387 385 p.content.comments = page.comment
388 386 p.new_record? ? p.save : p.content.save
389 387 migrated_wiki_edits += 1 unless p.content.new_record?
390 388 end
391 389
392 390 wiki.reload
393 391 wiki.pages.each do |page|
394 392 page.content.text = convert_wiki_text(page.content.text)
395 393 page.content.save
396 394 end
397 395 end
398 396 puts
399 397
400 398 puts
401 399 puts "Components: #{migrated_components}/#{TracComponent.count}"
402 400 puts "Milestones: #{migrated_milestones}/#{TracMilestone.count}"
403 401 puts "Tickets: #{migrated_tickets}/#{TracTicket.count}"
404 402 puts "Ticket files: #{migrated_ticket_attachments}/" + TracAttachment.count("type = 'ticket'").to_s
405 403 puts "Custom values: #{migrated_custom_values}/#{TracTicketCustom.count}"
406 404 puts "Wiki edits: #{migrated_wiki_edits}/#{TracWikiPage.count}"
407 405 end
408 406
409 407 def self.limit_for(klass, attribute)
410 408 klass.columns_hash[attribute.to_s].limit
411 409 end
412 410
413 411 def self.encoding(charset)
414 412 @ic = Iconv.new('UTF-8', charset)
415 413 rescue Iconv::InvalidEncoding
416 414 puts "Invalid encoding!"
417 415 return false
418 416 end
419 417
420 418 def self.set_trac_directory(path)
421 @trac_directory = path
419 @@trac_directory = path
422 420 raise "This directory doesn't exist!" unless File.directory?(path)
423 raise "#{trac_db_path} doesn't exist!" unless File.exist?(trac_db_path)
424 421 raise "#{trac_attachments_directory} doesn't exist!" unless File.directory?(trac_attachments_directory)
425 @trac_directory
422 @@trac_directory
426 423 rescue Exception => e
427 424 puts e
428 425 return false
429 426 end
430 427
431 428 def self.trac_directory
432 @trac_directory
429 @@trac_directory
433 430 end
434 431
435 432 def self.set_trac_adapter(adapter)
436 return false unless %w(sqlite sqlite3).include?(adapter)
437 @trac_adapter = adapter
433 return false if adapter.blank?
434 raise "Unknown adapter: #{adapter}!" unless %w(sqlite sqlite3 mysql postgresql).include?(adapter)
435 # If adapter is sqlite or sqlite3, make sure that trac.db exists
436 raise "#{trac_db_path} doesn't exist!" if %w(sqlite sqlite3).include?(adapter) && !File.exist?(trac_db_path)
437 @@trac_adapter = adapter
438 rescue Exception => e
439 puts e
440 return false
441 end
442
443 def self.set_trac_db_host(host)
444 return nil if host.blank?
445 @@trac_db_host = host
446 end
447
448 def self.set_trac_db_port(port)
449 return nil if port.to_i == 0
450 @@trac_db_port = port.to_i
451 end
452
453 def self.set_trac_db_name(name)
454 return nil if name.blank?
455 @@trac_db_name = name
456 end
457
458 def self.set_trac_db_username(username)
459 @@trac_db_username = username
438 460 end
439 461
440 def self.trac_adapter; @trac_adapter end
462 def self.set_trac_db_password(password)
463 @@trac_db_password = password
464 end
465
466 mattr_reader :trac_directory, :trac_adapter, :trac_db_host, :trac_db_port, :trac_db_name, :trac_db_username, :trac_db_password
467
441 468 def self.trac_db_path; "#{trac_directory}/db/trac.db" end
442 469 def self.trac_attachments_directory; "#{trac_directory}/attachments" end
443 470
444 471 def self.target_project_identifier(identifier)
445 472 project = Project.find_by_identifier(identifier)
446 473 if !project
447 474 # create the target project
448 475 project = Project.new :name => identifier.humanize,
449 476 :description => identifier.humanize
450 477 project.identifier = identifier
451 478 puts "Unable to create a project with identifier '#{identifier}'!" unless project.save
452 479 # enable issues and wiki for the created project
453 480 project.enabled_module_names = ['issue_tracking', 'wiki']
481 end
454 482 project.trackers << TRACKER_BUG
455 483 project.trackers << TRACKER_FEATURE
456 end
457 484 @target_project = project.new_record? ? nil : project
458 485 end
459 486
460 def self.establish_connection(params)
487 def self.connection_params
488 if %w(sqlite sqlite3).include?(trac_adapter)
489 {:adapter => trac_adapter,
490 :database => trac_db_path}
491 else
492 {:adapter => trac_adapter,
493 :database => trac_db_name,
494 :host => trac_db_host,
495 :port => trac_db_port,
496 :username => trac_db_username,
497 :password => trac_db_password}
498 end
499 end
500
501 def self.establish_connection
461 502 constants.each do |const|
462 503 klass = const_get(const)
463 504 next unless klass.respond_to? 'establish_connection'
464 klass.establish_connection params
505 klass.establish_connection connection_params
465 506 end
466 507 end
467 508
468 509 private
469 510 def self.encode(text)
470 511 @ic.iconv text
471 512 rescue
472 513 text
473 514 end
474 515 end
475 516
476 517 puts
477 puts "WARNING: Your Redmine install will have a new project added during this process."
518 puts "WARNING: a new project will be added to Redmine during this process."
478 519 print "Are you sure you want to continue ? [y/N] "
479 520 break unless STDIN.gets.match(/^y$/i)
480 521 puts
481 522
482 523 def prompt(text, options = {}, &block)
483 524 default = options[:default] || ''
484 525 while true
485 526 print "#{text} [#{default}]: "
486 527 value = STDIN.gets.chomp!
487 528 value = default if value.blank?
488 529 break if yield value
489 530 end
490 531 end
491 532
533 DEFAULT_PORTS = {'mysql' => 3306, 'postgresl' => 5432}
534
492 535 prompt('Trac directory') {|directory| TracMigrate.set_trac_directory directory}
493 prompt('Trac database adapter (sqlite, sqlite3)', :default => 'sqlite') {|adapter| TracMigrate.set_trac_adapter adapter}
536 prompt('Trac database adapter (sqlite, sqlite3, mysql, postgresql)', :default => 'sqlite') {|adapter| TracMigrate.set_trac_adapter adapter}
537 unless %w(sqlite sqlite3).include?(TracMigrate.trac_adapter)
538 prompt('Trac database host', :default => 'localhost') {|host| TracMigrate.set_trac_db_host host}
539 prompt('Trac database port', :default => DEFAULT_PORTS[TracMigrate.trac_adapter]) {|port| TracMigrate.set_trac_db_port port}
540 prompt('Trac database name') {|name| TracMigrate.set_trac_db_name name}
541 prompt('Trac database username') {|username| TracMigrate.set_trac_db_username username}
542 prompt('Trac database password') {|password| TracMigrate.set_trac_db_password password}
543 end
494 544 prompt('Trac database encoding', :default => 'UTF-8') {|encoding| TracMigrate.encoding encoding}
495 545 prompt('Target project identifier') {|identifier| TracMigrate.target_project_identifier identifier}
496 546 puts
497 547
498 548 TracMigrate.migrate
499 549 end
500 550 end
General Comments 0
You need to be logged in to leave comments. Login now