##// END OF EJS Templates
Use Postgresql's reset_pk_sequence in Trac importer to reset issue id sequence (#595)....
Jean-Philippe Lang -
r1105:a3dda6dc4a3d
parent child
Show More
@@ -1,566 +1,558
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 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
149 149 def self.columns
150 150 # Hides readonly Trac field to prevent clash with AR readonly? method (Rails 2.0)
151 151 super.select {|column| column.name.to_s != 'readonly'}
152 152 end
153 153 end
154 154
155 155 class TracPermission < ActiveRecord::Base
156 156 set_table_name :permission
157 157 end
158 158
159 159 def self.find_or_create_user(username, project_member = false)
160 160 u = User.find_by_login(username)
161 161 if !u
162 162 # Create a new user if not found
163 163 mail = username[0,limit_for(User, 'mail')]
164 164 mail = "#{mail}@foo.bar" unless mail.include?("@")
165 165 u = User.new :firstname => username[0,limit_for(User, 'firstname')].gsub(/[^\w\s\'\-]/i, '-'),
166 166 :lastname => '-',
167 167 :mail => mail.gsub(/[^-@a-z0-9\.]/i, '-')
168 168 u.login = username[0,limit_for(User, 'login')].gsub(/[^a-z0-9_\-@\.]/i, '-')
169 169 u.password = 'trac'
170 170 u.admin = true if TracPermission.find_by_username_and_action(username, 'admin')
171 171 # finally, a default user is used if the new user is not valid
172 172 u = User.find(:first) unless u.save
173 173 end
174 174 # Make sure he is a member of the project
175 175 if project_member && !u.member_of?(@target_project)
176 176 role = DEFAULT_ROLE
177 177 if u.admin
178 178 role = ROLE_MAPPING['admin']
179 179 elsif TracPermission.find_by_username_and_action(username, 'developer')
180 180 role = ROLE_MAPPING['developer']
181 181 end
182 182 Member.create(:user => u, :project => @target_project, :role => role)
183 183 u.reload
184 184 end
185 185 u
186 186 end
187 187
188 188 # Basic wiki syntax conversion
189 189 def self.convert_wiki_text(text)
190 190 # Titles
191 191 text = text.gsub(/^(\=+)\s(.+)\s(\=+)/) {|s| "\nh#{$1.length}. #{$2}\n"}
192 192 # External Links
193 193 text = text.gsub(/\[(http[^\s]+)\s+([^\]]+)\]/) {|s| "\"#{$2}\":#{$1}"}
194 194 # Internal Links
195 195 text = text.gsub(/\[\[BR\]\]/, "\n") # This has to go before the rules below
196 196 text = text.gsub(/\[\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
197 197 text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
198 198 text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
199 199 text = text.gsub(/\[wiki:([^\s\]]+).*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
200 200 # Revisions links
201 201 text = text.gsub(/\[(\d+)\]/, 'r\1')
202 202 # Ticket number re-writing
203 203 text = text.gsub(/#(\d+)/) do |s|
204 204 TICKET_MAP[$1.to_i] ||= $1
205 205 "\##{TICKET_MAP[$1.to_i] || $1}"
206 206 end
207 207 # Preformatted blocks
208 208 text = text.gsub(/\{\{\{/, '<pre>')
209 209 text = text.gsub(/\}\}\}/, '</pre>')
210 210 # Highlighting
211 211 text = text.gsub(/'''''([^\s])/, '_*\1')
212 212 text = text.gsub(/([^\s])'''''/, '\1*_')
213 213 text = text.gsub(/'''/, '*')
214 214 text = text.gsub(/''/, '_')
215 215 text = text.gsub(/__/, '+')
216 216 text = text.gsub(/~~/, '-')
217 217 text = text.gsub(/`/, '@')
218 218 text = text.gsub(/,,/, '~')
219 219 # Lists
220 220 text = text.gsub(/^([ ]+)\* /) {|s| '*' * $1.length + " "}
221 221
222 222 text
223 223 end
224 224
225 225 def self.migrate
226 226 establish_connection
227 227
228 228 # Quick database test
229 229 TracComponent.count
230 230
231 231 migrated_components = 0
232 232 migrated_milestones = 0
233 233 migrated_tickets = 0
234 234 migrated_custom_values = 0
235 235 migrated_ticket_attachments = 0
236 236 migrated_wiki_edits = 0
237 237
238 238 # Components
239 239 print "Migrating components"
240 240 issues_category_map = {}
241 241 TracComponent.find(:all).each do |component|
242 242 print '.'
243 243 STDOUT.flush
244 244 c = IssueCategory.new :project => @target_project,
245 245 :name => encode(component.name[0, limit_for(IssueCategory, 'name')])
246 246 next unless c.save
247 247 issues_category_map[component.name] = c
248 248 migrated_components += 1
249 249 end
250 250 puts
251 251
252 252 # Milestones
253 253 print "Migrating milestones"
254 254 version_map = {}
255 255 TracMilestone.find(:all).each do |milestone|
256 256 print '.'
257 257 STDOUT.flush
258 258 v = Version.new :project => @target_project,
259 259 :name => encode(milestone.name[0, limit_for(Version, 'name')]),
260 260 :description => encode(milestone.description.to_s[0, limit_for(Version, 'description')]),
261 261 :effective_date => milestone.due
262 262 next unless v.save
263 263 version_map[milestone.name] = v
264 264 migrated_milestones += 1
265 265 end
266 266 puts
267 267
268 268 # Custom fields
269 269 # TODO: read trac.ini instead
270 270 print "Migrating custom fields"
271 271 custom_field_map = {}
272 272 TracTicketCustom.find_by_sql("SELECT DISTINCT name FROM #{TracTicketCustom.table_name}").each do |field|
273 273 print '.'
274 274 STDOUT.flush
275 275 # Redmine custom field name
276 276 field_name = encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize
277 277 # Find if the custom already exists in Redmine
278 278 f = IssueCustomField.find_by_name(field_name)
279 279 # Or create a new one
280 280 f ||= IssueCustomField.create(:name => encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize,
281 281 :field_format => 'string')
282 282
283 283 next if f.new_record?
284 284 f.trackers = Tracker.find(:all)
285 285 f.projects << @target_project
286 286 custom_field_map[field.name] = f
287 287 end
288 288 puts
289 289
290 290 # Trac 'resolution' field as a Redmine custom field
291 291 r = IssueCustomField.find(:first, :conditions => { :name => "Resolution" })
292 292 r = IssueCustomField.new(:name => 'Resolution',
293 293 :field_format => 'list',
294 294 :is_filter => true) if r.nil?
295 295 r.trackers = Tracker.find(:all)
296 296 r.projects << @target_project
297 297 r.possible_values = %w(fixed invalid wontfix duplicate worksforme)
298 298 custom_field_map['resolution'] = r if r.save
299 299
300 300 # Tickets
301 301 print "Migrating tickets"
302 302 TracTicket.find(:all, :order => 'id ASC').each do |ticket|
303 303 print '.'
304 304 STDOUT.flush
305 305 i = Issue.new :project => @target_project,
306 306 :subject => encode(ticket.summary[0, limit_for(Issue, 'subject')]),
307 307 :description => convert_wiki_text(encode(ticket.description)),
308 308 :priority => PRIORITY_MAPPING[ticket.priority] || DEFAULT_PRIORITY,
309 309 :created_on => ticket.time
310 310 i.author = find_or_create_user(ticket.reporter)
311 311 i.category = issues_category_map[ticket.component] unless ticket.component.blank?
312 312 i.fixed_version = version_map[ticket.milestone] unless ticket.milestone.blank?
313 313 i.status = STATUS_MAPPING[ticket.status] || DEFAULT_STATUS
314 314 i.tracker = TRACKER_MAPPING[ticket.ticket_type] || DEFAULT_TRACKER
315 315 i.custom_values << CustomValue.new(:custom_field => custom_field_map['resolution'], :value => ticket.resolution) unless ticket.resolution.blank?
316 316 i.id = ticket.id unless Issue.exists?(ticket.id)
317 317 next unless i.save
318 318 TICKET_MAP[ticket.id] = i.id
319 319 migrated_tickets += 1
320 320
321 321 # Owner
322 322 unless ticket.owner.blank?
323 323 i.assigned_to = find_or_create_user(ticket.owner, true)
324 324 i.save
325 325 end
326 326
327 327 # Comments and status/resolution changes
328 328 ticket.changes.group_by(&:time).each do |time, changeset|
329 329 status_change = changeset.select {|change| change.field == 'status'}.first
330 330 resolution_change = changeset.select {|change| change.field == 'resolution'}.first
331 331 comment_change = changeset.select {|change| change.field == 'comment'}.first
332 332
333 333 n = Journal.new :notes => (comment_change ? convert_wiki_text(encode(comment_change.newvalue)) : ''),
334 334 :created_on => time
335 335 n.user = find_or_create_user(changeset.first.author)
336 336 n.journalized = i
337 337 if status_change &&
338 338 STATUS_MAPPING[status_change.oldvalue] &&
339 339 STATUS_MAPPING[status_change.newvalue] &&
340 340 (STATUS_MAPPING[status_change.oldvalue] != STATUS_MAPPING[status_change.newvalue])
341 341 n.details << JournalDetail.new(:property => 'attr',
342 342 :prop_key => 'status_id',
343 343 :old_value => STATUS_MAPPING[status_change.oldvalue].id,
344 344 :value => STATUS_MAPPING[status_change.newvalue].id)
345 345 end
346 346 if resolution_change
347 347 n.details << JournalDetail.new(:property => 'cf',
348 348 :prop_key => custom_field_map['resolution'].id,
349 349 :old_value => resolution_change.oldvalue,
350 350 :value => resolution_change.newvalue)
351 351 end
352 352 n.save unless n.details.empty? && n.notes.blank?
353 353 end
354 354
355 355 # Attachments
356 356 ticket.attachments.each do |attachment|
357 357 next unless attachment.exist?
358 358 a = Attachment.new :created_on => attachment.time
359 359 a.file = attachment
360 360 a.author = find_or_create_user(attachment.author)
361 361 a.container = i
362 362 migrated_ticket_attachments += 1 if a.save
363 363 end
364 364
365 365 # Custom fields
366 366 ticket.customs.each do |custom|
367 367 next if custom_field_map[custom.name].nil?
368 368 v = CustomValue.new :custom_field => custom_field_map[custom.name],
369 369 :value => custom.value
370 370 v.customized = i
371 371 next unless v.save
372 372 migrated_custom_values += 1
373 373 end
374 374 end
375 375
376 # update issue id sequence if needed
377 begin
378 case ActiveRecord::Base.connection.adapter_name.downcase
379 when 'mysql'
380 # nothing to do
381 when 'postgresql'
382 sql = "SELECT setval('#{Issue.table_name}_id_seq', (SELECT MAX(id) FROM #{Issue.table_name}))"
383 ActiveRecord::Base.connection.execute(sql)
384 end
385 end
376 # update issue id sequence if needed (postgresql)
377 Issue.connection.reset_pk_sequence!(Issue.table_name) if Issue.connection.respond_to?('reset_pk_sequence!')
386 378 puts
387 379
388 380 # Wiki
389 381 print "Migrating wiki"
390 382 @target_project.wiki.destroy if @target_project.wiki
391 383 @target_project.reload
392 384 wiki = Wiki.new(:project => @target_project, :start_page => 'WikiStart')
393 385 if wiki.save
394 386 TracWikiPage.find(:all, :order => 'name, version').each do |page|
395 387 print '.'
396 388 STDOUT.flush
397 389 p = wiki.find_or_new_page(page.name)
398 390 p.content = WikiContent.new(:page => p) if p.new_record?
399 391 p.content.text = page.text
400 392 p.content.author = find_or_create_user(page.author) unless page.author.blank? || page.author == 'trac'
401 393 p.content.comments = page.comment
402 394 p.new_record? ? p.save : p.content.save
403 395 migrated_wiki_edits += 1 unless p.content.new_record?
404 396 end
405 397
406 398 wiki.reload
407 399 wiki.pages.each do |page|
408 400 page.content.text = convert_wiki_text(page.content.text)
409 401 page.content.save
410 402 end
411 403 end
412 404 puts
413 405
414 406 puts
415 407 puts "Components: #{migrated_components}/#{TracComponent.count}"
416 408 puts "Milestones: #{migrated_milestones}/#{TracMilestone.count}"
417 409 puts "Tickets: #{migrated_tickets}/#{TracTicket.count}"
418 410 puts "Ticket files: #{migrated_ticket_attachments}/" + TracAttachment.count("type = 'ticket'").to_s
419 411 puts "Custom values: #{migrated_custom_values}/#{TracTicketCustom.count}"
420 412 puts "Wiki edits: #{migrated_wiki_edits}/#{TracWikiPage.count}"
421 413 end
422 414
423 415 def self.limit_for(klass, attribute)
424 416 klass.columns_hash[attribute.to_s].limit
425 417 end
426 418
427 419 def self.encoding(charset)
428 420 @ic = Iconv.new('UTF-8', charset)
429 421 rescue Iconv::InvalidEncoding
430 422 puts "Invalid encoding!"
431 423 return false
432 424 end
433 425
434 426 def self.set_trac_directory(path)
435 427 @@trac_directory = path
436 428 raise "This directory doesn't exist!" unless File.directory?(path)
437 429 raise "#{trac_attachments_directory} doesn't exist!" unless File.directory?(trac_attachments_directory)
438 430 @@trac_directory
439 431 rescue Exception => e
440 432 puts e
441 433 return false
442 434 end
443 435
444 436 def self.trac_directory
445 437 @@trac_directory
446 438 end
447 439
448 440 def self.set_trac_adapter(adapter)
449 441 return false if adapter.blank?
450 442 raise "Unknown adapter: #{adapter}!" unless %w(sqlite sqlite3 mysql postgresql).include?(adapter)
451 443 # If adapter is sqlite or sqlite3, make sure that trac.db exists
452 444 raise "#{trac_db_path} doesn't exist!" if %w(sqlite sqlite3).include?(adapter) && !File.exist?(trac_db_path)
453 445 @@trac_adapter = adapter
454 446 rescue Exception => e
455 447 puts e
456 448 return false
457 449 end
458 450
459 451 def self.set_trac_db_host(host)
460 452 return nil if host.blank?
461 453 @@trac_db_host = host
462 454 end
463 455
464 456 def self.set_trac_db_port(port)
465 457 return nil if port.to_i == 0
466 458 @@trac_db_port = port.to_i
467 459 end
468 460
469 461 def self.set_trac_db_name(name)
470 462 return nil if name.blank?
471 463 @@trac_db_name = name
472 464 end
473 465
474 466 def self.set_trac_db_username(username)
475 467 @@trac_db_username = username
476 468 end
477 469
478 470 def self.set_trac_db_password(password)
479 471 @@trac_db_password = password
480 472 end
481 473
482 474 mattr_reader :trac_directory, :trac_adapter, :trac_db_host, :trac_db_port, :trac_db_name, :trac_db_username, :trac_db_password
483 475
484 476 def self.trac_db_path; "#{trac_directory}/db/trac.db" end
485 477 def self.trac_attachments_directory; "#{trac_directory}/attachments" end
486 478
487 479 def self.target_project_identifier(identifier)
488 480 project = Project.find_by_identifier(identifier)
489 481 if !project
490 482 # create the target project
491 483 project = Project.new :name => identifier.humanize,
492 484 :description => ''
493 485 project.identifier = identifier
494 486 puts "Unable to create a project with identifier '#{identifier}'!" unless project.save
495 487 # enable issues and wiki for the created project
496 488 project.enabled_module_names = ['issue_tracking', 'wiki']
497 489 end
498 490 project.trackers << TRACKER_BUG
499 491 project.trackers << TRACKER_FEATURE
500 492 @target_project = project.new_record? ? nil : project
501 493 end
502 494
503 495 def self.connection_params
504 496 if %w(sqlite sqlite3).include?(trac_adapter)
505 497 {:adapter => trac_adapter,
506 498 :database => trac_db_path}
507 499 else
508 500 {:adapter => trac_adapter,
509 501 :database => trac_db_name,
510 502 :host => trac_db_host,
511 503 :port => trac_db_port,
512 504 :username => trac_db_username,
513 505 :password => trac_db_password}
514 506 end
515 507 end
516 508
517 509 def self.establish_connection
518 510 constants.each do |const|
519 511 klass = const_get(const)
520 512 next unless klass.respond_to? 'establish_connection'
521 513 klass.establish_connection connection_params
522 514 end
523 515 end
524 516
525 517 private
526 518 def self.encode(text)
527 519 @ic.iconv text
528 520 rescue
529 521 text
530 522 end
531 523 end
532 524
533 525 puts
534 526 puts "WARNING: a new project will be added to Redmine during this process."
535 527 print "Are you sure you want to continue ? [y/N] "
536 528 break unless STDIN.gets.match(/^y$/i)
537 529 puts
538 530
539 531 def prompt(text, options = {}, &block)
540 532 default = options[:default] || ''
541 533 while true
542 534 print "#{text} [#{default}]: "
543 535 value = STDIN.gets.chomp!
544 536 value = default if value.blank?
545 537 break if yield value
546 538 end
547 539 end
548 540
549 541 DEFAULT_PORTS = {'mysql' => 3306, 'postgresl' => 5432}
550 542
551 543 prompt('Trac directory') {|directory| TracMigrate.set_trac_directory directory}
552 544 prompt('Trac database adapter (sqlite, sqlite3, mysql, postgresql)', :default => 'sqlite') {|adapter| TracMigrate.set_trac_adapter adapter}
553 545 unless %w(sqlite sqlite3).include?(TracMigrate.trac_adapter)
554 546 prompt('Trac database host', :default => 'localhost') {|host| TracMigrate.set_trac_db_host host}
555 547 prompt('Trac database port', :default => DEFAULT_PORTS[TracMigrate.trac_adapter]) {|port| TracMigrate.set_trac_db_port port}
556 548 prompt('Trac database name') {|name| TracMigrate.set_trac_db_name name}
557 549 prompt('Trac database username') {|username| TracMigrate.set_trac_db_username username}
558 550 prompt('Trac database password') {|password| TracMigrate.set_trac_db_password password}
559 551 end
560 552 prompt('Trac database encoding', :default => 'UTF-8') {|encoding| TracMigrate.encoding encoding}
561 553 prompt('Target project identifier') {|identifier| TracMigrate.target_project_identifier identifier}
562 554 puts
563 555
564 556 TracMigrate.migrate
565 557 end
566 558 end
General Comments 0
You need to be logged in to leave comments. Login now