Class: Lich::Util::Update::ReleaseInstaller

Inherits:
Object
  • Object
show all
Defined in:
documented/common/update/release_installer.rb

Overview

Handles the installation of Lich5 from GitHub releases.

This class manages release announcements, downloads, Ruby compatibility checks, and file extraction. It delegates data/script updates to FileUpdater and backups to SnapshotManager.

Constant Summary collapse

TOP_LEVEL_FILES =

Top-level files (besides lib/ and lich.rbw) to copy from release archive. lich.rbw is handled separately due to its dynamic target name.

%w[Gemfile LICENSE].freeze

Instance Method Summary collapse

Constructor Details

#initialize(client, resolver, snapshot_manager) ⇒ void

Initializes a new ReleaseInstaller instance.

Parameters:

  • client (Object) —

    the client used to interact with GitHub.

  • resolver (Object) —

    the resolver for versioning.

  • snapshot_manager (Object) —

    the manager for snapshots.



32
33
34
35
36
37
38
39
40
41
 
# File 'documented/common/update/release_installer.rb', line 32

def initialize(client, resolver, snapshot_manager)
  @client = client
  @resolver = resolver
  @snapshot_manager = snapshot_manager
  @current = LICH_VERSION
  @update_to = nil
  @holder = nil
  @new_features = nil
  @zipfile = nil
end

Instance Method Details

#announce ⇒ void

Note:

This method checks the current version and compares it to the latest available version.

This method returns an undefined value.

Announces the availability of a new version of Lich5.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'documented/common/update/release_installer.rb', line 46

def announce
  prep_update
  if "#{LICH_VERSION}".chr == '5'
    if Gem::Version.new(@current) < Gem::Version.new(@update_to)
      unless @new_features.empty?
        respond ''
        _respond monsterbold_start() + "*** NEW VERSION AVAILABLE ***" + monsterbold_end()
        respond ''
        respond ''
        respond ''
        respond @new_features
        respond ''
        respond ''
        respond "If you are interested in updating, run '#{$clean_lich_char}lich5-update --update' now."
        respond ''
      end
    else
      respond ''
      respond "Lich version #{LICH_VERSION} is good.  Enjoy!"
      respond ''
    end
  else
    respond "This script does not support Lich #{LICH_VERSION}."
  end
end

#check_ruby_compatibility(source_dir, version) ⇒ Boolean

Checks if the Ruby version is compatible with the specified Lich version.

Parameters:

  • source_dir (String) —

    the directory containing the Lich version files.

  • version (String) —

    the version of Lich to check compatibility for.

Returns:

  • (Boolean) —

    true if compatible, false otherwise.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'documented/common/update/release_installer.rb', line 296

def check_ruby_compatibility(source_dir, version)
  version_file_path = File.join(source_dir, "lib", "version.rb")
  if File.exist?(version_file_path)
    version_file_content = File.read(version_file_path)
    if (match = version_file_content.match(/REQUIRED_RUBY\s*=\s*["']([^"']+)["']/))
      required_ruby_version = match[1]
      current_ruby_version = RUBY_VERSION
      if Gem::Version.new(current_ruby_version) < Gem::Version.new(required_ruby_version)
        respond
        respond "*** UPDATE ABORTED ***"
        respond
        respond "Lich version #{version} requires Ruby #{required_ruby_version} or higher."
        respond "Your current Ruby version is #{current_ruby_version}."
        respond
        respond "Please update your Ruby installation before updating Lich."
        respond
        respond "DragonRealms - https://github.com/elanthia-online/lich-5/wiki/Documentation-for-Installing-and-Upgrading-Lich"
        respond "Gemstone IV  - https://gswiki.play.net/Lich:Software/Installation"
        respond
        return false
      end
    end
  end
  true
end

#download_release_update ⇒ void

This method returns an undefined value.

Downloads the release update for Lich5.

Raises:

  • (StandardError) —

    if the update cannot be performed.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'documented/common/update/release_installer.rb', line 191

def download_release_update
  prep_update if @update_to.nil? || @update_to.empty?
  if Gem::Version.new("#{@update_to}") <= Gem::Version.new("#{@current}") && !defined?(LICH_BRANCH)
    respond ''
    respond "Lich version #{LICH_VERSION} is good.  Enjoy!"
    respond ''
  else
    respond
    respond 'Getting ready to update.  First we will create a'
    respond 'snapshot in case there are problems with the update.'

    @snapshot_manager.snapshot

    respond
    respond "Downloading Lich5 version #{@update_to}"
    respond
    filename = "lich5-#{@update_to}"
    File.open(File.join(TEMP_DIR, "#{filename}.tar.gz"), "wb") do |file|
      file.write URI.parse(@zipfile).open.read
    end

    FileUtils.mkdir_p(File.join(TEMP_DIR, filename))
    Gem::Package.new("").extract_tar_gz(File.open(File.join(TEMP_DIR, "#{filename}.tar.gz"), "rb"),
                                        File.join(TEMP_DIR, filename))
    new_target = Dir.children(File.join(TEMP_DIR, filename))
    FileUtils.cp_r(File.join(TEMP_DIR, filename, new_target[0]), TEMP_DIR)
    FileUtils.remove_dir(File.join(TEMP_DIR, filename))
    FileUtils.mv(File.join(TEMP_DIR, new_target[0]), File.join(TEMP_DIR, filename))

    source_dir = File.join(TEMP_DIR, filename)

    unless check_ruby_compatibility(source_dir, @update_to)
      FileUtils.remove_dir(source_dir) if File.directory?(source_dir)
      FileUtils.rm(File.join(TEMP_DIR, "#{filename}.tar.gz")) if File.exist?(File.join(TEMP_DIR, "#{filename}.tar.gz"))
      return
    end

    unless perform_update(source_dir, @update_to)
      FileUtils.remove_dir(source_dir) if File.directory?(source_dir)
      FileUtils.rm(File.join(TEMP_DIR, "#{filename}.tar.gz")) if File.exist?(File.join(TEMP_DIR, "#{filename}.tar.gz"))
      return
    end

    FileUtils.remove_dir(source_dir)
    FileUtils.rm(File.join(TEMP_DIR, "#{filename}.tar.gz"))

    Lich::Util::Update.clear_branch_tracking

    respond
    respond "Lich5 has been updated to Lich5 version #{@update_to}"
    respond "You should exit the game, then log back in.  This will start the game"
    respond "with your updated Lich.  Enjoy!"
  end
end

#extract_version_from_file(version_file_path) ⇒ String?

Extracts the Lich version from the specified version file.

Parameters:

  • version_file_path (String) —

    the path to the version file.

Returns:

  • (String, nil) —

    the extracted version or nil if not found.



325
326
327
328
329
330
331
332
333
 
# File 'documented/common/update/release_installer.rb', line 325

def extract_version_from_file(version_file_path)
  return nil unless File.exist?(version_file_path)

  version_file_content = File.read(version_file_path)
  if version_file_content =~ /LICH_VERSION\s*=\s*['"]([^'"]+)['"]/
    return $1
  end
  nil
end

#perform_update(source_dir, version) ⇒ Boolean

Performs the update of Lich5 to the specified version.

Parameters:

  • source_dir (String) —

    the directory containing the new version files.

  • version (String) —

    the version to update to.

Returns:

  • (Boolean) —

    true if the update was successful, false otherwise.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'documented/common/update/release_installer.rb', line 250

def perform_update(source_dir, version)
  unless validate_lich_structure(source_dir)
    respond "Error: extracted source is missing required files. Aborting update to protect installation."
    return false
  end

  FileUtils.rm_rf(Dir.glob(File.join(LIB_DIR, "*")))

  respond
  respond 'Copying updated lich files to their locations.'

  FileUtils.copy_entry(File.join(source_dir, "lib"), File.join(LIB_DIR))
  respond
  respond "All Lich lib files have been updated."
  respond

  # Copy top-level release files to LICH_DIR
  TOP_LEVEL_FILES.each do |filename|
    src = File.join(source_dir, filename)
    if File.exist?(src)
      FileUtils.cp(src, File.join(LICH_DIR, filename))
      respond "Updated #{filename}."
    end
  end

  file_updater = FileUpdater.new(@client, @resolver)
  file_updater.update_core_data_and_scripts(version)

  lich_to_update = File.join(LICH_DIR, File.basename($PROGRAM_NAME))
  update_to_lich = File.join(source_dir, "lich.rbw")
  File.open(update_to_lich, 'rb') { |r| File.open(lich_to_update, 'wb') { |w| w.write(r.read) } }
  true
end

#prep_betatest(type = nil, requested_file = nil) ⇒ void

This method returns an undefined value.

Prepares for beta testing of the next Lich release.

Parameters:

  • type (String, nil) (defaults to: nil) —

    the type of beta test.

  • requested_file (String, nil) (defaults to: nil) —

    the file requested for the beta test.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'documented/common/update/release_installer.rb', line 104

def prep_betatest(type = nil, requested_file = nil)
  if type.nil?
    respond 'You are electing to participate in the beta testing of the next Lich release.'
    respond 'This beta test will include only Lich code, and does not include Ruby upates.'
    respond 'While we will do everything we can to ensure you have a smooth experience, '
    respond 'it is a test, and untoward things can result.  Please confirm your choice:'
    respond "Please confirm your participation:  #{$clean_lich_char}send Y or #{$clean_lich_char}send N"
    respond "You have 10 seconds to confirm, otherwise will be cancelled."

    client_sock = $_CLIENT_ || $_DETACHABLE_CLIENT_
    unless client_sock
      respond 'No client connection available. Aborting beta test request.'
      return
    end
    deadline = Time.now + 10
    line = nil
    loop do
      remaining = deadline - Time.now
      break if remaining <= 0

      reader = Thread.new { client_sock.gets }
      if reader.join(remaining)
        line = reader.value
        break if line.is_a?(String) && line.strip =~ /^(?:<c>)?(?:#{$clean_lich_char}send|#{$clean_lich_char}s) /i
      else
        reader.kill
        break
      end
    end

    if line.is_a?(String) && line =~ /send Y|s Y/i
      beta_response = 'accepted'
      respond 'Beta test installation accepted.  Thank you for considering!'
    else
      beta_response = 'rejected'
      respond 'Aborting beta test installation request.  Thank you for considering!'
      respond
    end

    if beta_response =~ /accepted/
      ref = @resolver.resolve_channel_ref(:beta)
      if ref.nil?
        respond 'No viable beta found. Aborting beta update.'
        return
      end

      releases_url = "https://api.github.com/repos/#{GITHUB_REPO}/releases"
      update_info = URI.parse(releases_url).open.read
      releases = JSON.parse(update_info)
      record = releases.find { |r| r['prerelease'] && r['tag_name'] == (ref.start_with?('v') ? ref : "v#{ref}") }

      if record
        record.each do |entry, value|
          if entry.include? 'tag_name'
            @update_to = value.sub('v', '')
          elsif entry.include? 'assets'
            @holder = value
          elsif entry.include? 'body'
            @new_features = value.gsub(/\#\# What's Changed.+$/m, '').gsub(/<!--[\s\S]*?-->/, '')
          end
        end
        release_asset = @holder && @holder.find { |x| x['name'] =~ /\b#{ASSET_TARBALL_NAME}\b/ }
        if release_asset
          @zipfile = release_asset.fetch('browser_download_url')
        else
          @zipfile = "https://codeload.github.com/#{GITHUB_REPO}/tar.gz/#{ref}"
        end
      else
        @update_to = ref.sub(/^v/, '')
        @zipfile = "https://codeload.github.com/#{GITHUB_REPO}/tar.gz/#{ref}"
      end
      download_release_update
    elsif beta_response =~ /rejected/
      nil
    else
      respond 'This is not where I want to be on a beta test request.'
      respond
    end
  else
    file_updater = FileUpdater.new(@client, @resolver)
    file_updater.update_file(type, requested_file, 'beta')
  end
end

#prep_update ⇒ void

This method returns an undefined value.

Prepares for an update by fetching the latest release information.

Raises:

  • (StandardError) —

    if the latest release payload cannot be read.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'documented/common/update/release_installer.rb', line 75

def prep_update
  latest = @client.fetch_github_json("https://api.github.com/repos/#{GITHUB_REPO}/releases/latest")
  if latest.is_a?(Hash) && latest['prerelease']
    all = @client.fetch_github_json("https://api.github.com/repos/#{GITHUB_REPO}/releases")
    if all.is_a?(Array)
      stable = all.select { |r| !r['prerelease'] && r['tag_name'] }.max_by { |r| @resolver.version_key(r['tag_name']) }
      latest = stable if stable
    end
  end
  unless latest.is_a?(Hash)
    respond "Update notice: could not read latest release payload (prep_update)."
    return
  end

  @holder = latest['assets']
  release_asset = @holder && @holder.find { |x| x['name'] =~ /\b#{ASSET_TARBALL_NAME}\b/ }
  unless release_asset
    respond "Update notice: no release tarball found in assets (prep_update)."
    return
  end
  @update_to = latest['tag_name'].to_s.sub('v', '')
  @new_features = latest['body'].to_s.gsub(/\#\# What's Changed.+$/m, '').gsub(/<!--[\s\S]*?-->/, '')
  @zipfile = release_asset.fetch('browser_download_url')
end

#validate_lich_structure(dir) ⇒ Boolean

Validates the structure of the Lich installation directory.

Parameters:

  • dir (String) —

    the directory to validate.

Returns:

  • (Boolean) —

    true if the structure is valid, false otherwise.



287
288
289
290
 
# File 'documented/common/update/release_installer.rb', line 287

def validate_lich_structure(dir)
  required_items = ['lib', 'lich.rbw'] + TOP_LEVEL_FILES
  required_items.all? { |item| File.exist?(File.join(dir, item)) }
end