To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / lib / tasks / migrate_from_trac.rake @ 1568:bc47b68a9487

History | View | Annotate | Download (29.7 KB)

1
# Redmine - project management software
2
# Copyright (C) 2006-2014  Jean-Philippe Lang
3
#
4
# This program is free software; you can redistribute it and/or
5
# modify it under the terms of the GNU General Public License
6
# as published by the Free Software Foundation; either version 2
7
# of the License, or (at your option) any later version.
8
#
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
# GNU General Public License for more details.
13
#
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17

    
18
require 'active_record'
19
require 'iconv' if RUBY_VERSION < '1.9'
20
require 'pp'
21

    
22
namespace :redmine do
23
  desc 'Trac migration script'
24
  task :migrate_from_trac => :environment do
25

    
26
    module TracMigrate
27
        TICKET_MAP = []
28

    
29
        DEFAULT_STATUS = IssueStatus.default
30
        assigned_status = IssueStatus.find_by_position(2)
31
        resolved_status = IssueStatus.find_by_position(3)
32
        feedback_status = IssueStatus.find_by_position(4)
33
        closed_status = IssueStatus.where(:is_closed => true).first
34
        STATUS_MAPPING = {'new' => DEFAULT_STATUS,
35
                          'reopened' => feedback_status,
36
                          'assigned' => assigned_status,
37
                          'closed' => closed_status
38
                          }
39

    
40
        priorities = IssuePriority.all
41
        DEFAULT_PRIORITY = priorities[0]
42
        PRIORITY_MAPPING = {'lowest' => priorities[0],
43
                            'low' => priorities[0],
44
                            'normal' => priorities[1],
45
                            'high' => priorities[2],
46
                            'highest' => priorities[3],
47
                            # ---
48
                            'trivial' => priorities[0],
49
                            'minor' => priorities[1],
50
                            'major' => priorities[2],
51
                            'critical' => priorities[3],
52
                            'blocker' => priorities[4]
53
                            }
54

    
55
        TRACKER_BUG = Tracker.find_by_position(1)
56
        TRACKER_FEATURE = Tracker.find_by_position(2)
57
        DEFAULT_TRACKER = TRACKER_BUG
58
        TRACKER_MAPPING = {'defect' => TRACKER_BUG,
59
                           'enhancement' => TRACKER_FEATURE,
60
                           'task' => TRACKER_FEATURE,
61
                           'patch' =>TRACKER_FEATURE
62
                           }
63

    
64
        roles = Role.where(:builtin => 0).order('position ASC').all
65
        manager_role = roles[0]
66
        developer_role = roles[1]
67
        DEFAULT_ROLE = roles.last
68
        ROLE_MAPPING = {'admin' => manager_role,
69
                        'developer' => developer_role
70
                        }
71

    
72
      class ::Time
73
        class << self
74
          alias :real_now :now
75
          def now
76
            real_now - @fake_diff.to_i
77
          end
78
          def fake(time)
79
            @fake_diff = real_now - time
80
            res = yield
81
            @fake_diff = 0
82
           res
83
          end
84
        end
85
      end
86

    
87
      class TracComponent < ActiveRecord::Base
88
        self.table_name = :component
89
      end
90

    
91
      class TracMilestone < ActiveRecord::Base
92
        self.table_name = :milestone
93
        # If this attribute is set a milestone has a defined target timepoint
94
        def due
95
          if read_attribute(:due) && read_attribute(:due) > 0
96
            Time.at(read_attribute(:due)).to_date
97
          else
98
            nil
99
          end
100
        end
101
        # This is the real timepoint at which the milestone has finished.
102
        def completed
103
          if read_attribute(:completed) && read_attribute(:completed) > 0
104
            Time.at(read_attribute(:completed)).to_date
105
          else
106
            nil
107
          end
108
        end
109

    
110
        def description
111
          # Attribute is named descr in Trac v0.8.x
112
          has_attribute?(:descr) ? read_attribute(:descr) : read_attribute(:description)
113
        end
114
      end
115

    
116
      class TracTicketCustom < ActiveRecord::Base
117
        self.table_name = :ticket_custom
118
      end
119

    
120
      class TracAttachment < ActiveRecord::Base
121
        self.table_name = :attachment
122
        set_inheritance_column :none
123

    
124
        def time; Time.at(read_attribute(:time)) end
125

    
126
        def original_filename
127
          filename
128
        end
129

    
130
        def content_type
131
          ''
132
        end
133

    
134
        def exist?
135
          File.file? trac_fullpath
136
        end
137

    
138
        def open
139
          File.open("#{trac_fullpath}", 'rb') {|f|
140
            @file = f
141
            yield self
142
          }
143
        end
144

    
145
        def read(*args)
146
          @file.read(*args)
147
        end
148

    
149
        def description
150
          read_attribute(:description).to_s.slice(0,255)
151
        end
152

    
153
      private
154
        def trac_fullpath
155
          attachment_type = read_attribute(:type)
156
          #replace exotic characters with their hex representation to avoid invalid filenames
157
          trac_file = filename.gsub( /[^a-zA-Z0-9\-_\.!~*']/n ) do |x|
158
            codepoint = RUBY_VERSION < '1.9' ? x[0] : x.codepoints.to_a[0]
159
            sprintf('%%%02x', codepoint)
160
          end
161
          "#{TracMigrate.trac_attachments_directory}/#{attachment_type}/#{id}/#{trac_file}"
162
        end
163
      end
164

    
165
      class TracTicket < ActiveRecord::Base
166
        self.table_name = :ticket
167
        set_inheritance_column :none
168

    
169
        # ticket changes: only migrate status changes and comments
170
        has_many :ticket_changes, :class_name => "TracTicketChange", :foreign_key => :ticket
171
        has_many :customs, :class_name => "TracTicketCustom", :foreign_key => :ticket
172

    
173
        def attachments
174
          TracMigrate::TracAttachment.all(:conditions => ["type = 'ticket' AND id = ?", self.id.to_s])
175
        end
176

    
177
        def ticket_type
178
          read_attribute(:type)
179
        end
180

    
181
        def summary
182
          read_attribute(:summary).blank? ? "(no subject)" : read_attribute(:summary)
183
        end
184

    
185
        def description
186
          read_attribute(:description).blank? ? summary : read_attribute(:description)
187
        end
188

    
189
        def time; Time.at(read_attribute(:time)) end
190
        def changetime; Time.at(read_attribute(:changetime)) end
191
      end
192

    
193
      class TracTicketChange < ActiveRecord::Base
194
        self.table_name = :ticket_change
195

    
196
        def self.columns
197
          # Hides Trac field 'field' to prevent clash with AR field_changed? method (Rails 3.0)
198
          super.select {|column| column.name.to_s != 'field'}
199
        end
200

    
201
        def time; Time.at(read_attribute(:time)) end
202
      end
203

    
204
      TRAC_WIKI_PAGES = %w(InterMapTxt InterTrac InterWiki RecentChanges SandBox TracAccessibility TracAdmin TracBackup TracBrowser TracCgi TracChangeset \
205
                           TracEnvironment TracFastCgi TracGuide TracImport TracIni TracInstall TracInterfaceCustomization \
206
                           TracLinks TracLogging TracModPython TracNotification TracPermissions TracPlugins TracQuery \
207
                           TracReports TracRevisionLog TracRoadmap TracRss TracSearch TracStandalone TracSupport TracSyntaxColoring TracTickets \
208
                           TracTicketsCustomFields TracTimeline TracUnicode TracUpgrade TracWiki WikiDeletePage WikiFormatting \
209
                           WikiHtml WikiMacros WikiNewPage WikiPageNames WikiProcessors WikiRestructuredText WikiRestructuredTextLinks \
210
                           CamelCase TitleIndex)
211

    
212
      class TracWikiPage < ActiveRecord::Base
213
        self.table_name = :wiki
214
        set_primary_key :name
215

    
216
        def self.columns
217
          # Hides readonly Trac field to prevent clash with AR readonly? method (Rails 2.0)
218
          super.select {|column| column.name.to_s != 'readonly'}
219
        end
220

    
221
        def attachments
222
          TracMigrate::TracAttachment.all(:conditions => ["type = 'wiki' AND id = ?", self.id.to_s])
223
        end
224

    
225
        def time; Time.at(read_attribute(:time)) end
226
      end
227

    
228
      class TracPermission < ActiveRecord::Base
229
        self.table_name = :permission
230
      end
231

    
232
      class TracSessionAttribute < ActiveRecord::Base
233
        self.table_name = :session_attribute
234
      end
235

    
236
      def self.find_or_create_user(username, project_member = false)
237
        return User.anonymous if username.blank?
238

    
239
        u = User.find_by_login(username)
240
        if !u
241
          # Create a new user if not found
242
          mail = username[0, User::MAIL_LENGTH_LIMIT]
243
          if mail_attr = TracSessionAttribute.find_by_sid_and_name(username, 'email')
244
            mail = mail_attr.value
245
          end
246
          mail = "#{mail}@foo.bar" unless mail.include?("@")
247

    
248
          name = username
249
          if name_attr = TracSessionAttribute.find_by_sid_and_name(username, 'name')
250
            name = name_attr.value
251
          end
252
          name =~ (/(\w+)(\s+\w+)?/)
253
          fn = ($1 || "-").strip
254
          ln = ($2 || '-').strip
255

    
256
          u = User.new :mail => mail.gsub(/[^-@a-z0-9\.]/i, '-'),
257
                       :firstname => fn[0, limit_for(User, 'firstname')],
258
                       :lastname => ln[0, limit_for(User, 'lastname')]
259

    
260
          u.login = username[0, User::LOGIN_LENGTH_LIMIT].gsub(/[^a-z0-9_\-@\.]/i, '-')
261
          u.password = 'trac'
262
          u.admin = true if TracPermission.find_by_username_and_action(username, 'admin')
263
          # finally, a default user is used if the new user is not valid
264
          u = User.first unless u.save
265
        end
266
        # Make sure user is a member of the project
267
        if project_member && !u.member_of?(@target_project)
268
          role = DEFAULT_ROLE
269
          if u.admin
270
            role = ROLE_MAPPING['admin']
271
          elsif TracPermission.find_by_username_and_action(username, 'developer')
272
            role = ROLE_MAPPING['developer']
273
          end
274
          Member.create(:user => u, :project => @target_project, :roles => [role])
275
          u.reload
276
        end
277
        u
278
      end
279

    
280
      # Basic wiki syntax conversion
281
      def self.convert_wiki_text(text)
282
        # Titles
283
        text = text.gsub(/^(\=+)\s(.+)\s(\=+)/) {|s| "\nh#{$1.length}. #{$2}\n"}
284
        # External Links
285
        text = text.gsub(/\[(http[^\s]+)\s+([^\]]+)\]/) {|s| "\"#{$2}\":#{$1}"}
286
        # Ticket links:
287
        #      [ticket:234 Text],[ticket:234 This is a test]
288
        text = text.gsub(/\[ticket\:([^\ ]+)\ (.+?)\]/, '"\2":/issues/show/\1')
289
        #      ticket:1234
290
        #      #1 is working cause Redmine uses the same syntax.
291
        text = text.gsub(/ticket\:([^\ ]+)/, '#\1')
292
        # Milestone links:
293
        #      [milestone:"0.1.0 Mercury" Milestone 0.1.0 (Mercury)]
294
        #      The text "Milestone 0.1.0 (Mercury)" is not converted,
295
        #      cause Redmine's wiki does not support this.
296
        text = text.gsub(/\[milestone\:\"([^\"]+)\"\ (.+?)\]/, 'version:"\1"')
297
        #      [milestone:"0.1.0 Mercury"]
298
        text = text.gsub(/\[milestone\:\"([^\"]+)\"\]/, 'version:"\1"')
299
        text = text.gsub(/milestone\:\"([^\"]+)\"/, 'version:"\1"')
300
        #      milestone:0.1.0
301
        text = text.gsub(/\[milestone\:([^\ ]+)\]/, 'version:\1')
302
        text = text.gsub(/milestone\:([^\ ]+)/, 'version:\1')
303
        # Internal Links
304
        text = text.gsub(/\[\[BR\]\]/, "\n") # This has to go before the rules below
305
        text = text.gsub(/\[\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
306
        text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
307
        text = text.gsub(/\[wiki:\"(.+)\".*\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
308
        text = text.gsub(/\[wiki:([^\s\]]+)\]/) {|s| "[[#{$1.delete(',./?;|:')}]]"}
309
        text = text.gsub(/\[wiki:([^\s\]]+)\s(.*)\]/) {|s| "[[#{$1.delete(',./?;|:')}|#{$2.delete(',./?;|:')}]]"}
310

    
311
  # Links to pages UsingJustWikiCaps
312
  text = text.gsub(/([^!]|^)(^| )([A-Z][a-z]+[A-Z][a-zA-Z]+)/, '\\1\\2[[\3]]')
313
  # Normalize things that were supposed to not be links
314
  # like !NotALink
315
  text = text.gsub(/(^| )!([A-Z][A-Za-z]+)/, '\1\2')
316
        # Revisions links
317
        text = text.gsub(/\[(\d+)\]/, 'r\1')
318
        # Ticket number re-writing
319
        text = text.gsub(/#(\d+)/) do |s|
320
          if $1.length < 10
321
#            TICKET_MAP[$1.to_i] ||= $1
322
            "\##{TICKET_MAP[$1.to_i] || $1}"
323
          else
324
            s
325
          end
326
        end
327
        # We would like to convert the Code highlighting too
328
        # This will go into the next line.
329
        shebang_line = false
330
        # Reguar expression for start of code
331
        pre_re = /\{\{\{/
332
        # Code hightlighing...
333
        shebang_re = /^\#\!([a-z]+)/
334
        # Regular expression for end of code
335
        pre_end_re = /\}\}\}/
336

    
337
        # Go through the whole text..extract it line by line
338
        text = text.gsub(/^(.*)$/) do |line|
339
          m_pre = pre_re.match(line)
340
          if m_pre
341
            line = '<pre>'
342
          else
343
            m_sl = shebang_re.match(line)
344
            if m_sl
345
              shebang_line = true
346
              line = '<code class="' + m_sl[1] + '">'
347
            end
348
            m_pre_end = pre_end_re.match(line)
349
            if m_pre_end
350
              line = '</pre>'
351
              if shebang_line
352
                line = '</code>' + line
353
              end
354
            end
355
          end
356
          line
357
        end
358

    
359
        # Highlighting
360
        text = text.gsub(/'''''([^\s])/, '_*\1')
361
        text = text.gsub(/([^\s])'''''/, '\1*_')
362
        text = text.gsub(/'''/, '*')
363
        text = text.gsub(/''/, '_')
364
        text = text.gsub(/__/, '+')
365
        text = text.gsub(/~~/, '-')
366
        text = text.gsub(/`/, '@')
367
        text = text.gsub(/,,/, '~')
368
        # Lists
369
        text = text.gsub(/^([ ]+)\* /) {|s| '*' * $1.length + " "}
370

    
371
        text
372
      end
373

    
374
      def self.migrate
375
        establish_connection
376

    
377
        # Quick database test
378
        TracComponent.count
379

    
380
        migrated_components = 0
381
        migrated_milestones = 0
382
        migrated_tickets = 0
383
        migrated_custom_values = 0
384
        migrated_ticket_attachments = 0
385
        migrated_wiki_edits = 0
386
        migrated_wiki_attachments = 0
387

    
388
        #Wiki system initializing...
389
        @target_project.wiki.destroy if @target_project.wiki
390
        @target_project.reload
391
        wiki = Wiki.new(:project => @target_project, :start_page => 'WikiStart')
392
        wiki_edit_count = 0
393

    
394
        # Components
395
        print "Migrating components"
396
        issues_category_map = {}
397
        TracComponent.all.each do |component|
398
        print '.'
399
        STDOUT.flush
400
          c = IssueCategory.new :project => @target_project,
401
                                :name => encode(component.name[0, limit_for(IssueCategory, 'name')])
402
        next unless c.save
403
        issues_category_map[component.name] = c
404
        migrated_components += 1
405
        end
406
        puts
407

    
408
        # Milestones
409
        print "Migrating milestones"
410
        version_map = {}
411
        TracMilestone.all.each do |milestone|
412
          print '.'
413
          STDOUT.flush
414
          # First we try to find the wiki page...
415
          p = wiki.find_or_new_page(milestone.name.to_s)
416
          p.content = WikiContent.new(:page => p) if p.new_record?
417
          p.content.text = milestone.description.to_s
418
          p.content.author = find_or_create_user('trac')
419
          p.content.comments = 'Milestone'
420
          p.save
421

    
422
          v = Version.new :project => @target_project,
423
                          :name => encode(milestone.name[0, limit_for(Version, 'name')]),
424
                          :description => nil,
425
                          :wiki_page_title => milestone.name.to_s,
426
                          :effective_date => milestone.completed
427

    
428
          next unless v.save
429
          version_map[milestone.name] = v
430
          migrated_milestones += 1
431
        end
432
        puts
433

    
434
        # Custom fields
435
        # TODO: read trac.ini instead
436
        print "Migrating custom fields"
437
        custom_field_map = {}
438
        TracTicketCustom.find_by_sql("SELECT DISTINCT name FROM #{TracTicketCustom.table_name}").each do |field|
439
          print '.'
440
          STDOUT.flush
441
          # Redmine custom field name
442
          field_name = encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize
443
          # Find if the custom already exists in Redmine
444
          f = IssueCustomField.find_by_name(field_name)
445
          # Or create a new one
446
          f ||= IssueCustomField.create(:name => encode(field.name[0, limit_for(IssueCustomField, 'name')]).humanize,
447
                                        :field_format => 'string')
448

    
449
          next if f.new_record?
450
          f.trackers = Tracker.all
451
          f.projects << @target_project
452
          custom_field_map[field.name] = f
453
        end
454
        puts
455

    
456
        # Trac 'resolution' field as a Redmine custom field
457
        r = IssueCustomField.where(:name => "Resolution").first
458
        r = IssueCustomField.new(:name => 'Resolution',
459
                                 :field_format => 'list',
460
                                 :is_filter => true) if r.nil?
461
        r.trackers = Tracker.all
462
        r.projects << @target_project
463
        r.possible_values = (r.possible_values + %w(fixed invalid wontfix duplicate worksforme)).flatten.compact.uniq
464
        r.save!
465
        custom_field_map['resolution'] = r
466

    
467
        # Tickets
468
        print "Migrating tickets"
469
          TracTicket.find_each(:batch_size => 200) do |ticket|
470
          print '.'
471
          STDOUT.flush
472
          i = Issue.new :project => @target_project,
473
                          :subject => encode(ticket.summary[0, limit_for(Issue, 'subject')]),
474
                          :description => convert_wiki_text(encode(ticket.description)),
475
                          :priority => PRIORITY_MAPPING[ticket.priority] || DEFAULT_PRIORITY,
476
                          :created_on => ticket.time
477
          i.author = find_or_create_user(ticket.reporter)
478
          i.category = issues_category_map[ticket.component] unless ticket.component.blank?
479
          i.fixed_version = version_map[ticket.milestone] unless ticket.milestone.blank?
480
          i.status = STATUS_MAPPING[ticket.status] || DEFAULT_STATUS
481
          i.tracker = TRACKER_MAPPING[ticket.ticket_type] || DEFAULT_TRACKER
482
          i.id = ticket.id unless Issue.exists?(ticket.id)
483
          next unless Time.fake(ticket.changetime) { i.save }
484
          TICKET_MAP[ticket.id] = i.id
485
          migrated_tickets += 1
486

    
487
          # Owner
488
            unless ticket.owner.blank?
489
              i.assigned_to = find_or_create_user(ticket.owner, true)
490
              Time.fake(ticket.changetime) { i.save }
491
            end
492

    
493
          # Comments and status/resolution changes
494
          ticket.ticket_changes.group_by(&:time).each do |time, changeset|
495
              status_change = changeset.select {|change| change.field == 'status'}.first
496
              resolution_change = changeset.select {|change| change.field == 'resolution'}.first
497
              comment_change = changeset.select {|change| change.field == 'comment'}.first
498

    
499
              n = Journal.new :notes => (comment_change ? convert_wiki_text(encode(comment_change.newvalue)) : ''),
500
                              :created_on => time
501
              n.user = find_or_create_user(changeset.first.author)
502
              n.journalized = i
503
              if status_change &&
504
                   STATUS_MAPPING[status_change.oldvalue] &&
505
                   STATUS_MAPPING[status_change.newvalue] &&
506
                   (STATUS_MAPPING[status_change.oldvalue] != STATUS_MAPPING[status_change.newvalue])
507
                n.details << JournalDetail.new(:property => 'attr',
508
                                               :prop_key => 'status_id',
509
                                               :old_value => STATUS_MAPPING[status_change.oldvalue].id,
510
                                               :value => STATUS_MAPPING[status_change.newvalue].id)
511
              end
512
              if resolution_change
513
                n.details << JournalDetail.new(:property => 'cf',
514
                                               :prop_key => custom_field_map['resolution'].id,
515
                                               :old_value => resolution_change.oldvalue,
516
                                               :value => resolution_change.newvalue)
517
              end
518
              n.save unless n.details.empty? && n.notes.blank?
519
          end
520

    
521
          # Attachments
522
          ticket.attachments.each do |attachment|
523
            next unless attachment.exist?
524
              attachment.open {
525
                a = Attachment.new :created_on => attachment.time
526
                a.file = attachment
527
                a.author = find_or_create_user(attachment.author)
528
                a.container = i
529
                a.description = attachment.description
530
                migrated_ticket_attachments += 1 if a.save
531
              }
532
          end
533

    
534
          # Custom fields
535
          custom_values = ticket.customs.inject({}) do |h, custom|
536
            if custom_field = custom_field_map[custom.name]
537
              h[custom_field.id] = custom.value
538
              migrated_custom_values += 1
539
            end
540
            h
541
          end
542
          if custom_field_map['resolution'] && !ticket.resolution.blank?
543
            custom_values[custom_field_map['resolution'].id] = ticket.resolution
544
          end
545
          i.custom_field_values = custom_values
546
          i.save_custom_field_values
547
        end
548

    
549
        # update issue id sequence if needed (postgresql)
550
        Issue.connection.reset_pk_sequence!(Issue.table_name) if Issue.connection.respond_to?('reset_pk_sequence!')
551
        puts
552

    
553
        # Wiki
554
        print "Migrating wiki"
555
        if wiki.save
556
          TracWikiPage.order('name, version').all.each do |page|
557
            # Do not migrate Trac manual wiki pages
558
            next if TRAC_WIKI_PAGES.include?(page.name)
559
            wiki_edit_count += 1
560
            print '.'
561
            STDOUT.flush
562
            p = wiki.find_or_new_page(page.name)
563
            p.content = WikiContent.new(:page => p) if p.new_record?
564
            p.content.text = page.text
565
            p.content.author = find_or_create_user(page.author) unless page.author.blank? || page.author == 'trac'
566
            p.content.comments = page.comment
567
            Time.fake(page.time) { p.new_record? ? p.save : p.content.save }
568

    
569
            next if p.content.new_record?
570
            migrated_wiki_edits += 1
571

    
572
            # Attachments
573
            page.attachments.each do |attachment|
574
              next unless attachment.exist?
575
              next if p.attachments.find_by_filename(attachment.filename.gsub(/^.*(\\|\/)/, '').gsub(/[^\w\.\-]/,'_')) #add only once per page
576
              attachment.open {
577
                a = Attachment.new :created_on => attachment.time
578
                a.file = attachment
579
                a.author = find_or_create_user(attachment.author)
580
                a.description = attachment.description
581
                a.container = p
582
                migrated_wiki_attachments += 1 if a.save
583
              }
584
            end
585
          end
586

    
587
          wiki.reload
588
          wiki.pages.each do |page|
589
            page.content.text = convert_wiki_text(page.content.text)
590
            Time.fake(page.content.updated_on) { page.content.save }
591
          end
592
        end
593
        puts
594

    
595
        puts
596
        puts "Components:      #{migrated_components}/#{TracComponent.count}"
597
        puts "Milestones:      #{migrated_milestones}/#{TracMilestone.count}"
598
        puts "Tickets:         #{migrated_tickets}/#{TracTicket.count}"
599
        puts "Ticket files:    #{migrated_ticket_attachments}/" + TracAttachment.count(:conditions => {:type => 'ticket'}).to_s
600
        puts "Custom values:   #{migrated_custom_values}/#{TracTicketCustom.count}"
601
        puts "Wiki edits:      #{migrated_wiki_edits}/#{wiki_edit_count}"
602
        puts "Wiki files:      #{migrated_wiki_attachments}/" + TracAttachment.count(:conditions => {:type => 'wiki'}).to_s
603
      end
604

    
605
      def self.limit_for(klass, attribute)
606
        klass.columns_hash[attribute.to_s].limit
607
      end
608

    
609
      def self.encoding(charset)
610
        @charset = charset
611
      end
612

    
613
      def self.set_trac_directory(path)
614
        @@trac_directory = path
615
        raise "This directory doesn't exist!" unless File.directory?(path)
616
        raise "#{trac_attachments_directory} doesn't exist!" unless File.directory?(trac_attachments_directory)
617
        @@trac_directory
618
      rescue Exception => e
619
        puts e
620
        return false
621
      end
622

    
623
      def self.trac_directory
624
        @@trac_directory
625
      end
626

    
627
      def self.set_trac_adapter(adapter)
628
        return false if adapter.blank?
629
        raise "Unknown adapter: #{adapter}!" unless %w(sqlite3 mysql postgresql).include?(adapter)
630
        # If adapter is sqlite or sqlite3, make sure that trac.db exists
631
        raise "#{trac_db_path} doesn't exist!" if %w(sqlite3).include?(adapter) && !File.exist?(trac_db_path)
632
        @@trac_adapter = adapter
633
      rescue Exception => e
634
        puts e
635
        return false
636
      end
637

    
638
      def self.set_trac_db_host(host)
639
        return nil if host.blank?
640
        @@trac_db_host = host
641
      end
642

    
643
      def self.set_trac_db_port(port)
644
        return nil if port.to_i == 0
645
        @@trac_db_port = port.to_i
646
      end
647

    
648
      def self.set_trac_db_name(name)
649
        return nil if name.blank?
650
        @@trac_db_name = name
651
      end
652

    
653
      def self.set_trac_db_username(username)
654
        @@trac_db_username = username
655
      end
656

    
657
      def self.set_trac_db_password(password)
658
        @@trac_db_password = password
659
      end
660

    
661
      def self.set_trac_db_schema(schema)
662
        @@trac_db_schema = schema
663
      end
664

    
665
      mattr_reader :trac_directory, :trac_adapter, :trac_db_host, :trac_db_port, :trac_db_name, :trac_db_schema, :trac_db_username, :trac_db_password
666

    
667
      def self.trac_db_path; "#{trac_directory}/db/trac.db" end
668
      def self.trac_attachments_directory; "#{trac_directory}/attachments" end
669

    
670
      def self.target_project_identifier(identifier)
671
        project = Project.find_by_identifier(identifier)
672
        if !project
673
          # create the target project
674
          project = Project.new :name => identifier.humanize,
675
                                :description => ''
676
          project.identifier = identifier
677
          puts "Unable to create a project with identifier '#{identifier}'!" unless project.save
678
          # enable issues and wiki for the created project
679
          project.enabled_module_names = ['issue_tracking', 'wiki']
680
        else
681
          puts
682
          puts "This project already exists in your Redmine database."
683
          print "Are you sure you want to append data to this project ? [Y/n] "
684
          STDOUT.flush
685
          exit if STDIN.gets.match(/^n$/i)
686
        end
687
        project.trackers << TRACKER_BUG unless project.trackers.include?(TRACKER_BUG)
688
        project.trackers << TRACKER_FEATURE unless project.trackers.include?(TRACKER_FEATURE)
689
        @target_project = project.new_record? ? nil : project
690
        @target_project.reload
691
      end
692

    
693
      def self.connection_params
694
        if trac_adapter == 'sqlite3'
695
          {:adapter => 'sqlite3',
696
           :database => trac_db_path}
697
        else
698
          {:adapter => trac_adapter,
699
           :database => trac_db_name,
700
           :host => trac_db_host,
701
           :port => trac_db_port,
702
           :username => trac_db_username,
703
           :password => trac_db_password,
704
           :schema_search_path => trac_db_schema
705
          }
706
        end
707
      end
708

    
709
      def self.establish_connection
710
        constants.each do |const|
711
          klass = const_get(const)
712
          next unless klass.respond_to? 'establish_connection'
713
          klass.establish_connection connection_params
714
        end
715
      end
716

    
717
      def self.encode(text)
718
        if RUBY_VERSION < '1.9'
719
          @ic ||= Iconv.new('UTF-8', @charset)
720
          @ic.iconv text
721
        else
722
          text.to_s.force_encoding(@charset).encode('UTF-8')
723
        end
724
      end
725
    end
726

    
727
    puts
728
    if Redmine::DefaultData::Loader.no_data?
729
      puts "Redmine configuration need to be loaded before importing data."
730
      puts "Please, run this first:"
731
      puts
732
      puts "  rake redmine:load_default_data RAILS_ENV=\"#{ENV['RAILS_ENV']}\""
733
      exit
734
    end
735

    
736
    puts "WARNING: a new project will be added to Redmine during this process."
737
    print "Are you sure you want to continue ? [y/N] "
738
    STDOUT.flush
739
    break unless STDIN.gets.match(/^y$/i)
740
    puts
741

    
742
    def prompt(text, options = {}, &block)
743
      default = options[:default] || ''
744
      while true
745
        print "#{text} [#{default}]: "
746
        STDOUT.flush
747
        value = STDIN.gets.chomp!
748
        value = default if value.blank?
749
        break if yield value
750
      end
751
    end
752

    
753
    DEFAULT_PORTS = {'mysql' => 3306, 'postgresql' => 5432}
754

    
755
    prompt('Trac directory') {|directory| TracMigrate.set_trac_directory directory.strip}
756
    prompt('Trac database adapter (sqlite3, mysql2, postgresql)', :default => 'sqlite3') {|adapter| TracMigrate.set_trac_adapter adapter}
757
    unless %w(sqlite3).include?(TracMigrate.trac_adapter)
758
      prompt('Trac database host', :default => 'localhost') {|host| TracMigrate.set_trac_db_host host}
759
      prompt('Trac database port', :default => DEFAULT_PORTS[TracMigrate.trac_adapter]) {|port| TracMigrate.set_trac_db_port port}
760
      prompt('Trac database name') {|name| TracMigrate.set_trac_db_name name}
761
      prompt('Trac database schema', :default => 'public') {|schema| TracMigrate.set_trac_db_schema schema}
762
      prompt('Trac database username') {|username| TracMigrate.set_trac_db_username username}
763
      prompt('Trac database password') {|password| TracMigrate.set_trac_db_password password}
764
    end
765
    prompt('Trac database encoding', :default => 'UTF-8') {|encoding| TracMigrate.encoding encoding}
766
    prompt('Target project identifier') {|identifier| TracMigrate.target_project_identifier identifier}
767
    puts
768

    
769
    old_notified_events = Setting.notified_events
770
    old_password_min_length = Setting.password_min_length
771
    begin
772
      # Turn off email notifications temporarily
773
      Setting.notified_events = []
774
      Setting.password_min_length = 4
775
      # Run the migration
776
      TracMigrate.migrate
777
    ensure
778
      # Restore previous settings
779
      Setting.notified_events = old_notified_events
780
      Setting.password_min_length = old_password_min_length
781
    end
782
  end
783
end
784