[feature/appstore-buildflag] Remove App Store / IAP code via build flag (#1052)

felix-schwarz · web-flow · commit 2b6a83dc9aaf · 2021-11-17T13:32:52.000+01:00
* - add support and documentation for DISABLE_APPSTORE_LICENSING build flag

* - ReleaseNotesHostViewController: remove unused reference to StoreKit
- OCLicenseDuration: make sure SKProductSubscriptionPeriod conversion code is excluded when using the DISABLE_APPSTORE_LICENSING build flag
diff --git a/doc/APP_BUILD_FLAGS.md b/doc/APP_BUILD_FLAGS.md
@@ -24,3 +24,9 @@ Removes the following from the app:
 - the location description keys from the app's `Info.plist`
 
 Not used by default.
+
+### `DISABLE_APPSTORE_LICENSING`
+
+Removes the following from the app:
+- App Store integration for OCLicense
+- App Store related view controllers and settings section
diff --git a/ownCloud/Client/Actions/Action+UserInterface.swift b/ownCloud/Client/Actions/Action+UserInterface.swift
@@ -94,6 +94,7 @@ extension Action {
 		if !isLicensed {
 			if let core = core, let requirements = type(of:self).licenseRequirements {
 				OnMainThread {
+					#if !DISABLE_APPSTORE_LICENSING
 					OCLicenseManager.appStoreProvider?.refreshProductsIfNeeded(completionHandler: { (error) in
 						OnMainThread {
 							if error != nil {
@@ -107,6 +108,7 @@ extension Action {
 							}
 						}
 					})
+					#endif
 				}
 			}
 
diff --git a/ownCloud/Licensing/Offers/LicenseOfferButton.swift b/ownCloud/Licensing/Offers/LicenseOfferButton.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudAppShared
 
@@ -61,3 +63,5 @@ class LicenseOfferButton: ThemeButton {
 		fatalError("init(coder:) has not been implemented")
 	}
 }
+
+#endif
diff --git a/ownCloud/Licensing/Offers/LicenseOfferView.swift b/ownCloud/Licensing/Offers/LicenseOfferView.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -288,3 +290,5 @@ class LicenseOfferView: UIView, Themeable {
 		}
 	}
 }
+
+#endif
diff --git a/ownCloud/Licensing/Offers/LicenseOffersViewController.swift b/ownCloud/Licensing/Offers/LicenseOffersViewController.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -116,6 +118,7 @@ class LicenseOffersViewController: StaticTableViewController {
 			sections.append(subSection)
 		}
 
+		#if !DISABLE_APPSTORE_LICENSING
 		let restoreSection = StaticTableViewSection()
 
 		restoreSection.add(row: StaticTableViewRow(rowWithAction: { (_, _) in
@@ -125,6 +128,7 @@ class LicenseOffersViewController: StaticTableViewController {
 		}, title: "Restore purchases".localized, alignment: .center))
 
 		sections.append(restoreSection)
+		#endif
 
 		// Set sections
 		self.sections = sections
@@ -153,3 +157,5 @@ class LicenseOffersViewController: StaticTableViewController {
 		self.tableView.contentInsetAdjustmentBehavior = .never
 	}
 }
+
+#endif
diff --git a/ownCloud/Licensing/Product List/LicenseInAppProductListViewController.swift b/ownCloud/Licensing/Product List/LicenseInAppProductListViewController.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -132,3 +134,5 @@ class LicenseInAppProductListViewController: StaticTableViewController {
 	}
 
 }
+
+#endif
diff --git a/ownCloud/Licensing/Product List/LicenseInAppPurchaseFeatureView.swift b/ownCloud/Licensing/Product List/LicenseInAppPurchaseFeatureView.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -134,3 +136,5 @@ class LicenseInAppPurchaseFeatureView: UIView, Themeable {
 		baseViewController?.present(asCard: FrameViewController(header: offersViewController.cardHeaderView!, viewController: offersViewController), animated: true)
 	}
 }
+
+#endif
diff --git a/ownCloud/Licensing/Tools/OCLicenseManager+AppStore.swift b/ownCloud/Licensing/Tools/OCLicenseManager+AppStore.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -52,5 +54,6 @@ extension OCLicenseManager {
 			})
 		}
 	}
-
 }
+
+#endif
diff --git a/ownCloud/Licensing/Transactions/LicenseTransactionsViewController.swift b/ownCloud/Licensing/Transactions/LicenseTransactionsViewController.swift
@@ -16,6 +16,8 @@
  *
  */
 
+#if !DISABLE_APPSTORE_LICENSING
+
 import UIKit
 import ownCloudApp
 import ownCloudAppShared
@@ -111,3 +113,5 @@ class LicenseTransactionsViewController: StaticTableViewController {
 		}
 	}
 }
+
+#endif
diff --git a/ownCloud/Release Notes/ReleaseNotesHostViewController.swift b/ownCloud/Release Notes/ReleaseNotesHostViewController.swift
@@ -19,7 +19,6 @@
 import UIKit
 import ownCloudSDK
 import ownCloudAppShared
-import StoreKit
 
 class ReleaseNotesHostViewController: UIViewController {
 
diff --git a/ownCloud/Settings/PurchasesSettingsSection.swift b/ownCloud/Settings/PurchasesSettingsSection.swift
@@ -20,6 +20,7 @@ import UIKit
 import ownCloudApp
 import ownCloudAppShared
 
+#if !DISABLE_APPSTORE_LICENSING
 class PurchasesSettingsSection: SettingsSection {
 	// MARK: - More Settings Cells
 
@@ -62,3 +63,4 @@ class PurchasesSettingsSection: SettingsSection {
 		add(rows: rows)
 	}
 }
+#endif
diff --git a/ownCloud/Settings/SettingsViewController.swift b/ownCloud/Settings/SettingsViewController.swift
@@ -41,13 +41,15 @@ class SettingsViewController: StaticTableViewController {
 			self.addSection(DisplaySettingsSection(userDefaults: userDefaults))
 			self.addSection(MediaFilesSettingsSection(userDefaults: userDefaults))
 
+			#if !DISABLE_APPSTORE_LICENSING
 			if #available(iOS 13, *), // Require iOS 13
 			   !OCLicenseEMMProvider.isEMMVersion, // Do not show purchases in the EMM version
 			   // Do only show purchases section if there's at least one non-Enterprise account
 			   OCLicenseEnterpriseProvider.numberOfEnterpriseAccounts < OCBookmarkManager.shared.bookmarks.count, !VendorServices.shared.isBranded // Do not show purchases in branded app
 			{
 				self.addSection(PurchasesSettingsSection(userDefaults: userDefaults))
 			}
+			#endif
 
 			self.addSection(MoreSettingsSection(userDefaults: userDefaults))
 		}
diff --git a/ownCloudAppFramework/Licensing/Offer/OCLicenseDuration.h b/ownCloudAppFramework/Licensing/Offer/OCLicenseDuration.h
@@ -17,7 +17,10 @@
  */
 
 #import <Foundation/Foundation.h>
+
+#ifndef DISABLE_APPSTORE_LICENSING
 #import <StoreKit/StoreKit.h>
+#endif /* DISABLE_APPSTORE_LICENSING */
 
 typedef NS_ENUM(NSUInteger, OCLicenseDurationUnit)
 {
@@ -48,10 +51,12 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+#ifndef DISABLE_APPSTORE_LICENSING
 @interface SKProductSubscriptionPeriod (OCLicenseDuration)
 
 @property(readonly,nonatomic,nullable) OCLicenseDuration *licenseDuration;
 
 @end
+#endif /* DISABLE_APPSTORE_LICENSING */
 
 NS_ASSUME_NONNULL_END
diff --git a/ownCloudAppFramework/Licensing/Offer/OCLicenseDuration.m b/ownCloudAppFramework/Licensing/Offer/OCLicenseDuration.m
@@ -191,6 +191,7 @@ - (NSDate *)dateWithDurationAddedTo:(NSDate *)date
 
 @end
 
+#ifndef DISABLE_APPSTORE_LICENSING
 
 @implementation SKProductSubscriptionPeriod (OCLicenseDuration)
 
@@ -226,3 +227,5 @@ - (nullable OCLicenseDuration *)licenseDuration
 }
 
 @end
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Items/OCLicenseAppStoreItem.h b/ownCloudAppFramework/Licensing/Providers/App Store/Items/OCLicenseAppStoreItem.h
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <Foundation/Foundation.h>
 #import <StoreKit/StoreKit.h>
 #import "OCLicenseOffer.h"
@@ -47,3 +49,5 @@ typedef NSString* OCLicenseAppStoreProductIdentifier;
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Items/OCLicenseAppStoreItem.m b/ownCloudAppFramework/Licensing/Providers/App Store/Items/OCLicenseAppStoreItem.m
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import "OCLicenseAppStoreItem.h"
 
 @implementation OCLicenseAppStoreItem
@@ -50,3 +52,5 @@ - (instancetype)initWithType:(OCLicenseType)type identifier:(OCLicenseAppStorePr
 }
 
 @end
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/OCLicenseAppStoreProvider.h b/ownCloudAppFramework/Licensing/Providers/App Store/OCLicenseAppStoreProvider.h
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <ownCloudSDK/ownCloudSDK.h>
 
 #import "OCLicenseProvider.h"
@@ -70,3 +72,4 @@ extern NSErrorDomain OCLicenseAppStoreProviderErrorDomain;
 
 NS_ASSUME_NONNULL_END
 
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/OCLicenseAppStoreProvider.m b/ownCloudAppFramework/Licensing/Providers/App Store/OCLicenseAppStoreProvider.m
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <StoreKit/StoreKit.h>
 #import <ownCloudSDK/ownCloudSDK.h>
 
@@ -936,3 +938,5 @@ + (OCLicenseAppStoreProvider *)appStoreProvider
 OCLicenseProviderIdentifier OCLicenseProviderIdentifierAppStore = @"app-store";
 
 NSErrorDomain OCLicenseAppStoreProviderErrorDomain = @"OCLicenseAppStoreProviderError";
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Parser Support/OCASN1.h b/ownCloudAppFramework/Licensing/Providers/App Store/Parser Support/OCASN1.h
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <Foundation/Foundation.h>
 #import "OCLicenseAppStoreReceipt.h"
 
@@ -39,3 +41,5 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Parser Support/OCASN1.m b/ownCloudAppFramework/Licensing/Providers/App Store/Parser Support/OCASN1.m
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import "OCASN1.h"
 #import "NSDate+RFC3339.h"
 
@@ -217,3 +219,5 @@ - (OCLicenseAppStoreReceiptParseError)parseSetsOfSequencesWithContainerProvider:
 }
 
 @end
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceipt.h b/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceipt.h
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <Foundation/Foundation.h>
 #import "OCLicenseAppStoreItem.h"
 
@@ -105,3 +107,5 @@ typedef NSNumber* OCLicenseAppStoreLineItemID;
 NS_ASSUME_NONNULL_END
 
 #import "OCLicenseAppStoreReceiptInAppPurchase.h"
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceipt.m b/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceipt.m
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <UIKit/UIKit.h>
 #import <ownCloudSDK/ownCloudSDK.h>
 
@@ -243,3 +245,5 @@ - (NSString *)description
 }
 
 @end
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceiptInAppPurchase.h b/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceiptInAppPurchase.h
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import <Foundation/Foundation.h>
 #import "OCLicenseAppStoreReceipt.h"
 
@@ -46,3 +48,5 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceiptInAppPurchase.m b/ownCloudAppFramework/Licensing/Providers/App Store/Receipt/OCLicenseAppStoreReceiptInAppPurchase.m
@@ -16,6 +16,8 @@
  *
  */
 
+#ifndef DISABLE_APPSTORE_LICENSING
+
 #import "OCLicenseAppStoreReceiptInAppPurchase.h"
 #import "OCASN1.h"
 
@@ -78,3 +80,5 @@ - (NSString *)description
 }
 
 @end
+
+#endif /* DISABLE_APPSTORE_LICENSING */
diff --git a/ownCloudAppShared/Intent/OCLicenseManager+Setup.swift b/ownCloudAppShared/Intent/OCLicenseManager+Setup.swift
@@ -66,6 +66,7 @@ public extension OCLicenseManager {
 		register(OCLicenseProduct(identifier: .bundlePro, name: "Pro Features".localized, description: "Unlock all Pro Features.".localized, contents: [.documentScanner, .shortcuts, .documentMarkup, .photoProFeatures]))
 
 		// Set up App Store License Provider
+		#if !DISABLE_APPSTORE_LICENSING
 		if let disableAppStoreLicensing = classSetting(forOCClassSettingsKey: .disableAppStoreLicensing) as? Bool, disableAppStoreLicensing == false, // only add AppStore IAP provider (and IAPs) if IAP licernsing has not been disabled via ClassSettings
 		   !OCLicenseEMMProvider.isEMMVersion { // only add AppStore IAP provider (and IAPs) if this is not the EMM version (which is supposed to already include all of them)
 			let appStoreLicenseProvider = OCLicenseAppStoreProvider(items: [
@@ -78,6 +79,7 @@ public extension OCLicenseManager {
 
 			add(appStoreLicenseProvider)
 		}
+		#endif
 
 		// Set up Enterprise Provider
 		if let disableEnterpriseLicensing = classSetting(forOCClassSettingsKey: .disableEnterpriseLicensing) as? Bool, disableEnterpriseLicensing == false { // only add Enterprise provider if not disabled via ClassSettings

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ extension Action {`
`94`	`94`	`if !isLicensed {`
`95`	`95`	`if let core = core, let requirements = type(of:self).licenseRequirements {`
`96`	`96`	`OnMainThread {`
	`97`	`+ #if !DISABLE_APPSTORE_LICENSING`
`97`	`98`	`OCLicenseManager.appStoreProvider?.refreshProductsIfNeeded(completionHandler: { (error) in`
`98`	`99`	`OnMainThread {`
`99`	`100`	`if error != nil {`
`@@ -107,6 +108,7 @@ extension Action {`
`107`	`108`	`}`
`108`	`109`	`}`
`109`	`110`	`})`
	`111`	`+ #endif`
`110`	`112`	`}`
`111`	`113`	`}`
`112`	`114`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`*`
`17`	`17`	`*/`
`18`	`18`
	`19`	`+#if !DISABLE_APPSTORE_LICENSING`
	`20`	`+`
`19`	`21`	`import UIKit`
`20`	`22`	`import ownCloudAppShared`
`21`	`23`
`@@ -61,3 +63,5 @@ class LicenseOfferButton: ThemeButton {`
`61`	`63`	`fatalError("init(coder:) has not been implemented")`
`62`	`64`	`}`
`63`	`65`	`}`
	`66`	`+`
	`67`	`+#endif`