Module: BranchIOCLI::Helper::IOSHelper

Included in:
BranchHelper
Defined in:
lib/branch_io_cli/helper/ios_helper.rb

Constant Summary collapse 

"applinks"
ASSOCIATED_DOMAINS = 
"com.apple.developer.associated-domains"
CODE_SIGN_ENTITLEMENTS = 
"CODE_SIGN_ENTITLEMENTS"
DEVELOPMENT_TEAM = 
"DEVELOPMENT_TEAM"
PRODUCT_BUNDLE_IDENTIFIER = 
"PRODUCT_BUNDLE_IDENTIFIER"
RELEASE_CONFIGURATION = 
"Release"

Instance Method Summary collapse

Instance Method Details



29
30
31
32
33
34
35
36
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 29

def add_branch_universal_link_domains_to_info_plist(project, target_name, domains, configuration = RELEASE_CONFIGURATION)
  # Add all supplied domains unless all are app.link domains.
  return if domains.all? { |d| d =~ /app\.link$/ }

  update_info_plist_setting project, target_name, configuration do |info_plist|
    info_plist["branch_universal_link_domains"] = domains
  end
end

#add_keys_to_info_plist(project, target_name, keys, configuration = RELEASE_CONFIGURATION) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 16

def add_keys_to_info_plist(project, target_name, keys, configuration = RELEASE_CONFIGURATION)
  update_info_plist_setting project, target_name, configuration do |info_plist|
    # add/overwrite Branch key(s)
    if keys.count > 1
      info_plist["branch_key"] = keys
    elsif keys[:live]
      info_plist["branch_key"] = keys[:live]
    else # no need to validate here, which was done by the action
      info_plist["branch_key"] = keys[:test]
    end
  end
end

#add_system_frameworks(project, target_name, frameworks) ⇒ Object 



336
337
338
339
340
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 336

def add_system_frameworks(project, target_name, frameworks)
  target = target_from_project project, target_name

  target.add_system_framework frameworks
end

#add_universal_links_to_project(project, target_name, domains, remove_existing, configuration = RELEASE_CONFIGURATION) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 61

def add_universal_links_to_project(project, target_name, domains, remove_existing, configuration = RELEASE_CONFIGURATION)
  # raises
  target = target_from_project project, target_name

  relative_entitlements_path = expanded_build_setting target, CODE_SIGN_ENTITLEMENTS, configuration
  project_parent = File.dirname project.path

  if relative_entitlements_path.nil?
    relative_entitlements_path = File.join target.name, "#{target.name}.entitlements"
    entitlements_path = File.expand_path relative_entitlements_path, project_parent

    # Add CODE_SIGN_ENTITLEMENTS setting to each configuration
    target.build_configuration_list.set_setting CODE_SIGN_ENTITLEMENTS, relative_entitlements_path

    # Add the file to the project
    project.new_file relative_entitlements_path

    entitlements = {}
    current_domains = []

    add_change project.path
    new_path = entitlements_path
  else
    entitlements_path = File.expand_path relative_entitlements_path, project_parent
    # Raises
    entitlements = File.open(entitlements_path) { |f| Plist.parse_xml f }
    raise "Failed to parse entitlements file #{entitlements_path}" if entitlements.nil?

    if remove_existing
      current_domains = []
    else
      current_domains = entitlements[ASSOCIATED_DOMAINS]
    end
  end

  current_domains += domains.map { |d| "#{APPLINKS}:#{d}" }
  all_domains = current_domains.uniq

  entitlements[ASSOCIATED_DOMAINS] = all_domains

  Plist::Emit.save_plist entitlements, entitlements_path
  add_change entitlements_path

  new_path
end

#app_ids_from_aasa_file(domain) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 154

def app_ids_from_aasa_file(domain)
  data = contents_of_aasa_file domain
  # errors reported in the method above
  return nil if data.nil?

  # raises
  file = JSON.parse data

  applinks = file[APPLINKS]
  @errors << "[#{domain}] No #{APPLINKS} found in AASA file" and return if applinks.nil?

  details = applinks["details"]
  @errors << "[#{domain}] No details found for #{APPLINKS} in AASA file" and return if details.nil?

  identifiers = details.map { |d| d["appID"] }.uniq
  @errors << "[#{domain}] No appID found in AASA file" and return if identifiers.count <= 0
  identifiers
rescue JSON::ParserError => e
  @errors << "[#{domain}] Failed to parse AASA file: #{e.message}"
  nil
end

#contents_of_aasa_file(domain) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 176

def contents_of_aasa_file(domain)
  uris = [
    URI("https://#{domain}/.well-known/apple-app-site-association"),
    URI("https://#{domain}/apple-app-site-association")
    # URI("http://#{domain}/.well-known/apple-app-site-association"),
    # URI("http://#{domain}/apple-app-site-association")
  ]

  data = nil

  uris.each do |uri|
    break unless data.nil?

    Net::HTTP.start uri.host, uri.port, use_ssl: uri.scheme == "https" do |http|
      request = Net::HTTP::Get.new uri
      response = http.request request

      # Better to use Net::HTTPRedirection and Net::HTTPSuccess here, but
      # having difficulty with the unit tests.
      if (300..399).cover?(response.code.to_i)
        say "#{uri} cannot result in a redirect. Ignoring."
        next
      elsif response.code.to_i != 200
        # Try the next URI.
        say "Could not retrieve #{uri}: #{response.code} #{response.message}. Ignoring."
        next
      end

      content_type = response["Content-type"]
      @errors << "[#{domain}] AASA Response does not contain a Content-type header" and next if content_type.nil?

      case content_type
      when %r{application/pkcs7-mime}
        # Verify/decrypt PKCS7 (non-Branch domains)
        cert_store = OpenSSL::X509::Store.new
        signature = OpenSSL::PKCS7.new response.body
        # raises
        signature.verify nil, cert_store, nil, OpenSSL::PKCS7::NOVERIFY
        data = signature.data
      else
        @error << "[#{domain}] Unsigned AASA files must be served via HTTPS" and next if uri.scheme == "http"
        data = response.body
      end

      say "GET #{uri}: #{response.code} #{response.message} (Content-type:#{content_type}) ✅"
    end
  end

  @errors << "[#{domain}] Failed to retrieve AASA file" and return nil if data.nil?

  data
rescue IOError, SocketError => e
  @errors << "[#{domain}] Socket error: #{e.message}"
  nil
rescue OpenSSL::PKCS7::PKCS7Error => e
  @errors << "[#{domain}] Failed to verify signed AASA file: #{e.message}"
  nil
end

#domains_from_project(project, target_name, configuration = RELEASE_CONFIGURATION) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 301

def domains_from_project(project, target_name, configuration = RELEASE_CONFIGURATION)
  # Raises. Does not return nil.
  target = target_from_project project, target_name

  relative_entitlements_path = expanded_build_setting target, CODE_SIGN_ENTITLEMENTS, configuration
  return [] if relative_entitlements_path.nil?

  project_parent = File.dirname project.path
  entitlements_path = File.expand_path relative_entitlements_path, project_parent

  # Raises
  entitlements = File.open(entitlements_path) { |f| Plist.parse_xml f }
  raise "Failed to parse entitlements file #{entitlements_path}" if entitlements.nil?

  entitlements[ASSOCIATED_DOMAINS].select { |d| d =~ /^applinks:/ }.map { |d| d.sub(/^applinks:/, "") }
end

#expanded_build_setting(target, setting_name, configuration) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 318

def expanded_build_setting(target, setting_name, configuration)
  setting_value = target.resolved_build_setting(setting_name)[configuration]
  return if setting_value.nil?

  search_position = 0
  while (matches = /\$\(([^(){}]*)\)|\$\{([^(){}]*)\}/.match(setting_value, search_position))
    macro_name = matches[1] || matches[2]
    search_position = setting_value.index(macro_name) - 2

    expanded_macro = macro_name == "SRCROOT" ? "." : expanded_build_setting(target, macro_name, configuration)
    search_position += macro_name.length + 3 and next if expanded_macro.nil?

    setting_value.gsub!(/\$\(#{macro_name}\)|\$\{#{macro_name}\}/, expanded_macro)
    search_position += expanded_macro.length
  end
  setting_value
end

#patch_app_delegate_objc(project) ⇒ Object 



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 420

def patch_app_delegate_objc(project)
  app_delegate_objc = project.files.find { |f| f.path =~ /AppDelegate.m$/ }
  return false if app_delegate_objc.nil?

  app_delegate_objc_path = app_delegate_objc.real_path.to_s

  app_delegate = File.open(app_delegate_objc_path, &:read)
  return false if app_delegate =~ %r{^\s+#import\s+<Branch/Branch.h>|^\s+@import\s+Branch;}

  say "Patching #{app_delegate_objc_path}"

  apply_patch(
    files: app_delegate_objc_path,
    regexp: /^\s+@import|^\s+#import.*$/,
    text: "\n#import <Branch/Branch.h>",
    mode: :prepend
  )

  init_session_text = ConfigurationHelper.keys.count <= 1 ? "" : <<EOF
#ifdef DEBUG
    [Branch setUseTestBranchKey:YES];
#endif // DEBUG

EOF

  init_session_text += <<-EOF
    [[Branch getInstance] initSessionWithLaunchOptions:launchOptions
  andRegisterDeepLinkHandlerUsingBranchUniversalObject:^(BranchUniversalObject *universalObject, BranchLinkProperties *linkProperties, NSError *error){
  // TODO: Route Branch links
    }];
  EOF

  apply_patch(
    files: app_delegate_objc_path,
    regexp: /didFinishLaunchingWithOptions.*?\{[^\n]*\n/m,
    text: init_session_text,
    mode: :append
  )

  if app_delegate =~ /application:.*continueUserActivity:.*restorationHandler:/
    continue_user_activity_text = <<-EOF
    // TODO: Adjust your method as you see fit.
    if ([[Branch getInstance] continueUserActivity:userActivity]) {
  return YES;
    }

EOF

    apply_patch(
      files: app_delegate_objc_path,
      regexp: /application:.*continueUserActivity:.*restorationHandler:.*?\{.*?\n/m,
      text: continue_user_activity_text,
      mode: :append
    )
  else
    # Add the application:continueUserActivity:restorationHandler method if it does not exist
    continue_user_activity_text = <<-EOF


- (BOOL)application:(UIApplication *)app continueUserActivity:(nonnull NSUserActivity *)userActivity restorationHandler:(nonnull void (^)(NSArray * _Nullable))restorationHandler
{
    return [[Branch getInstance] continueUserActivity:userActivity];
}
    EOF

    apply_patch(
      files: app_delegate_objc_path,
      regexp: /\n\s*@end[^@]*\Z/m,
      text: continue_user_activity_text,
      mode: :prepend
    )
  end

  add_change app_delegate_objc_path
  true
end

#patch_app_delegate_swift(project) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 342

def patch_app_delegate_swift(project)
  app_delegate_swift = project.files.find { |f| f.path =~ /AppDelegate.swift$/ }
  return false if app_delegate_swift.nil?

  app_delegate_swift_path = app_delegate_swift.real_path.to_s

  app_delegate = File.open(app_delegate_swift_path, &:read)
  return false if app_delegate =~ /import\s+Branch/

  say "Patching #{app_delegate_swift_path}"

  apply_patch(
    files: app_delegate_swift_path,
    regexp: /^\s*import .*$/,
    text: "\nimport Branch",
    mode: :prepend
  )

  init_session_text = ConfigurationHelper.keys.count <= 1 ? "" : <<EOF
  #if DEBUG
      Branch.setUseTestBranchKey(true)
  #endif

EOF

  init_session_text += <<-EOF
  Branch.getInstance().initSession(launchOptions: launchOptions) {
      universalObject, linkProperties, error in

      // TODO: Route Branch links
  }
  EOF

  apply_patch(
    files: app_delegate_swift_path,
    regexp: /didFinishLaunchingWithOptions.*?\{[^\n]*\n/m,
    text: init_session_text,
    mode: :append
  )

  if app_delegate =~ /application:.*continue userActivity:.*restorationHandler:/
    # Add something to the top of the method
    continue_user_activity_text = <<-EOF
  // TODO: Adjust your method as you see fit.
  if Branch.getInstance.continue(userActivity) {
      return true
  }

    EOF

    apply_patch(
      files: app_delegate_swift_path,
      regexp: /application:.*continue userActivity:.*restorationHandler:.*?\{.*?\n/m,
      text: continue_user_activity_text,
      mode: :append
    )
  else
    # Add the application:continueUserActivity:restorationHandler method if it does not exist
    continue_user_activity_text = <<-EOF


    func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
  return Branch.getInstance().continue(userActivity)
    }
    EOF

    apply_patch(
      files: app_delegate_swift_path,
      regexp: /\n\s*\}[^{}]*\Z/m,
      text: continue_user_activity_text,
      mode: :prepend
    )
  end

  add_change app_delegate_swift_path
  true
end

#patch_cartfile(cartfile_path) ⇒ Object 



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 516

def patch_cartfile(cartfile_path)
  cartfile = File.open(cartfile_path, &:read)

  # Cartfile already contains the Branch framework
  return false if cartfile =~ /git.+Branch/

  say "Adding \"Branch\" to #{cartfile_path}"

  apply_patch(
    files: cartfile_path,
    regexp: /\z/,
    text: "git \"https://github.com/BranchMetrics/ios-branch-deep-linking\"\n",
    mode: :append
  )

  true
end

#patch_podfile(podfile_path) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 497

def patch_podfile(podfile_path)
  podfile = File.open(podfile_path, &:read)

  # Podfile already contains the Branch pod
  return false if podfile =~ /pod\s+('Branch'|"Branch")/

  say "Adding pod \"Branch\" to #{podfile_path}"

  # TODO: Improve this patch. Should work in the majority of cases for now.
  apply_patch(
    files: podfile_path,
    regexp: /^(\s*)pod\s*/,
    text: "\n\\1pod \"Branch\"\n",
    mode: :prepend
  )

  true
end

#target_from_project(project, target_name) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 289

def target_from_project(project, target_name)
  if target_name
    target = project.targets.find { |t| t.name == target_name }
    raise "Target #{target} not found" if target.nil?
  else
    # find the first application target
    target = project.targets.find { |t| !t.extension_target_type? && !t.test_target_type? }
    raise "No application target found" if target.nil?
  end
  target
end

#team_and_bundle_from_app_id(identifier) ⇒ Object 



107
108
109
110
111
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 107

def team_and_bundle_from_app_id(identifier)
  team = identifier.sub(/\..+$/, "")
  bundle = identifier.sub(/^[^.]+\./, "")
  [team, bundle]
end

#update_info_plist_setting(project, target_name, configuration = RELEASE_CONFIGURATION) {|info_plist| ... } ⇒ Object

Yields:

  • (info_plist) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 38

def update_info_plist_setting(project, target_name, configuration = RELEASE_CONFIGURATION, &b)
  # raises
  target = target_from_project project, target_name

  # find the Info.plist paths for this configuration
  info_plist_path = expanded_build_setting target, "INFOPLIST_FILE", configuration

  raise "Info.plist not found for configuration #{configuration}" if info_plist_path.nil?

  project_parent = File.dirname project.path

  info_plist_path = File.expand_path info_plist_path, project_parent

  # try to open and parse the Info.plist (raises)
  info_plist = File.open(info_plist_path) { |f| Plist.parse_xml f }
  raise "Failed to parse #{info_plist_path}" if info_plist.nil?

  yield info_plist

  Plist::Emit.save_plist info_plist, info_plist_path
  add_change info_plist_path
end

#update_team_and_bundle_ids(project, target_name, team, bundle) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 275

def update_team_and_bundle_ids(project, target_name, team, bundle)
  # raises
  target = target_from_project project, target_name

  target.build_configuration_list.set_setting PRODUCT_BUNDLE_IDENTIFIER, bundle
  target.build_configuration_list.set_setting DEVELOPMENT_TEAM, team

  # also update the team in the first test target
  target = project.targets.find(&:test_target_type?)
  return if target.nil?

  target.build_configuration_list.set_setting DEVELOPMENT_TEAM, team
end

#update_team_and_bundle_ids_from_aasa_file(project, target_name, domain) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 113

def update_team_and_bundle_ids_from_aasa_file(project, target_name, domain)
  # raises
  identifiers = app_ids_from_aasa_file domain
  raise "Multiple appIDs found in AASA file" if identifiers.count > 1

  identifier = identifiers[0]
  team, bundle = team_and_bundle_from_app_id identifier

  update_team_and_bundle_ids project, target_name, team, bundle
  add_change project.path.expand_path
end

#validate_project_domains(expected, project, target, configuration = RELEASE_CONFIGURATION) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 255

def validate_project_domains(expected, project, target, configuration = RELEASE_CONFIGURATION)
  @errors = []
  project_domains = domains_from_project project, target, configuration
  valid = expected.count == project_domains.count
  if valid
    sorted = expected.sort
    project_domains.sort.each_with_index do |domain, index|
      valid = false and break unless sorted[index] == domain
    end
  end

  unless valid
    @errors << "Project domains do not match :domains parameter"
    @errors << "Project domains: #{project_domains}"
    @errors << ":domains parameter: #{expected}"
  end

  valid
end

#validate_team_and_bundle_ids(project, target_name, domain, configuration) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 235

def validate_team_and_bundle_ids(project, target_name, domain, configuration)
  # raises
  target = target_from_project project, target_name

  product_bundle_identifier = expanded_build_setting target, PRODUCT_BUNDLE_IDENTIFIER, configuration
  development_team = expanded_build_setting target, DEVELOPMENT_TEAM, configuration

  identifiers = app_ids_from_aasa_file domain
  return false if identifiers.nil?

  app_id = "#{development_team}.#{product_bundle_identifier}"
  match_found = identifiers.include? app_id

  unless match_found
    @errors << "[#{domain}] appID mismatch. Project: #{app_id}. AASA: #{identifiers}"
  end

  match_found
end

#validate_team_and_bundle_ids_from_aasa_files(project, target_name, domains = [], remove_existing = false, configuration = RELEASE_CONFIGURATION) ⇒ Object 



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
 
# File 'lib/branch_io_cli/helper/ios_helper.rb', line 125

def validate_team_and_bundle_ids_from_aasa_files(project, target_name, domains = [], remove_existing = false, configuration = RELEASE_CONFIGURATION)
  @errors = []
  valid = true

  # Include any domains already in the project.
  # Raises. Returns a non-nil array of strings.
  if remove_existing
    # Don't validate domains to be removed (#16)
    all_domains = domains
  else
    all_domains = (domains + domains_from_project(project, target_name, configuration)).uniq
  end

  if all_domains.empty?
    # Cannot get here from SetupBranchAction, since the domains passed in will never be empty.
    # If called from ValidateUniversalLinksAction, this is a failure, possibly caused by
    # failure to add applinks:.
    @errors << "No Universal Link domains in project. Be sure each Universal Link domain is prefixed with applinks:."
    return false
  end

  all_domains.each do |domain|
    domain_valid = validate_team_and_bundle_ids project, target_name, domain, configuration
    valid &&= domain_valid
    say "Valid Universal Link configuration for #{domain} ✅" if domain_valid
  end
  valid
end