Add Optimize Images setting and enable it by default

RELEASE-NOTES.txt

@@ -2,6 +2,7 @@
 -----
 * [*] Bug fix: Reader now scrolls to the top when tapping the status bar. [#21914]
 * [*] Fix an issue in Menu screen where it fails to create default menu items. [#21949]
+* [**] Add Optimize Images setting for image uploads and enable it by default [#21981]
 
 23.6
 -----

WordPress/Classes/Services/MediaCoordinator.swift

@@ -154,7 +154,7 @@ class MediaCoordinator: NSObject {
         addMedia(from: asset, post: post, coordinator: coordinator(for: post), analyticsInfo: analyticsInfo)
     }
 
-    /// Create a `Media` instance from the main context and upload the asset to the Meida Library.
+    /// Create a `Media` instance from the main context and upload the asset to the Media Library.
     ///
     /// - Warning: This function must be called from the main thread.
     ///
@@ -186,7 +186,7 @@ class MediaCoordinator: NSObject {
         return media
     }
 
-    /// Create a `Media` instance and upload the asset to the Meida Library.
+    /// Create a `Media` instance and upload the asset to the Media Library.
     ///
     /// - SeeAlso: `MediaImportService.createMedia(with:blog:post:receiveUpdate:thumbnailCallback:completion:)`
     private func addMedia(from asset: ExportableAsset, blog: Blog, post: AbstractPost?, coordinator: MediaProgressCoordinator, analyticsInfo: MediaAnalyticsInfo? = nil) {

WordPress/Classes/Services/MediaHelper.swift

@@ -67,6 +67,37 @@ class MediaHelper: NSObject {
         }
 
     }
+
+    static func advertiseImageOptimization(completion: @escaping (() -> Void)) {
+        guard MediaSettings().advertiseImageOptimization else {
+            completion()
+            return
+        }
+
+        let title = NSLocalizedString("Keep optimizing images?",
+                                        comment: "Title of an alert informing users to enable image optimization in uploads.")
+        let message = NSLocalizedString("Image optimization shrinks images for quicker uploading.\n\nBy default it's enabled but you can change this any time in app settings.",
+                                        comment: "Message of an alert informing users to enable image optimization in uploads.")
+        let turnOffTitle = NSLocalizedString("No, turn off", comment: "Title of button for turning off image optimization, displayed in the alert informing users to enable image optimization in uploads.")
+        let leaveOnTitle = NSLocalizedString("Yes, leave on", comment: "Title of button for leaving on image optimization, displayed in the alert informing users to enable image optimization in uploads.")
+
+        let alert = UIAlertController(title: title, message: message, preferredStyle: .alert)
+        alert.addAction(UIAlertAction(title: turnOffTitle, style: .default) { _ in
+            MediaSettings().imageOptimizationSetting = false
+            WPAnalytics.track(.appSettingsOptimizeImagesPopupTapped, properties: ["option": "off" as
+                                                                                     AnyObject])
+            completion()
+        })
+        alert.addAction(UIAlertAction(title: leaveOnTitle, style: .default) { _ in
+            MediaSettings().imageOptimizationSetting = true
+            WPAnalytics.track(.appSettingsOptimizeImagesPopupTapped, properties: ["option": "on" as
+                                                                                     AnyObject])
+            completion()
+        })
+        alert.presentFromRootViewController()
+
+        MediaSettings().advertiseImageOptimization = false
+    }
 }
 
 extension Media {

WordPress/Classes/Services/MediaImportService.swift

@@ -378,7 +378,7 @@ class MediaImportService: NSObject {
         var options = MediaImageExporter.Options()
         options.maximumImageSize = self.exporterMaximumImageSize()
         options.stripsGeoLocationIfNeeded = MediaSettings().removeLocationSetting
-        options.imageCompressionQuality = MediaImportService.preferredImageCompressionQuality
+        options.imageCompressionQuality = MediaSettings().imageQualityForUpload.doubleValue
         return options
     }
 

WordPress/Classes/Services/MediaSettings.swift

@@ -3,14 +3,70 @@ import AVFoundation
 
 class MediaSettings: NSObject {
     // MARK: - Constants
+    fileprivate let imageOptimizationKey = "SavedImageOptimizationSetting"
     fileprivate let maxImageSizeKey = "SavedMaxImageSizeSetting"
+    fileprivate let imageQualityKey = "SavedImageQualitySetting"
     fileprivate let removeLocationKey = "SavedRemoveLocationSetting"
     fileprivate let maxVideoSizeKey = "SavedMaxVideoSizeSetting"
+    fileprivate let advertiseImageOptimizationKey = "SavedAdvertiseImageOptimization"
 
+    fileprivate let defaultImageOptimization = true
+    fileprivate let defaultMaxImageSize = 2000
+    fileprivate let defaultImageQuality: ImageQuality = .medium
+    fileprivate let defaultMaxVideoSize: VideoResolution = .sizeOriginal
+    fileprivate let defaultRemoveLocation = true
 
     fileprivate let minImageDimension = 150
     fileprivate let maxImageDimension = 3000
 
+    enum ImageQuality: String {
+        case maximum = "MaximumQuality100"
+        case high = "HighQuality90"
+        case medium = "MediumQuality80"
+        case low = "LowQuality70"
+
+        var doubleValue: Double {
+            switch self {
+            case .maximum:
+                return 1.0
+            case .high:
+                return 0.9
+            case .medium:
+                return 0.8
+            case .low:
+                return 0.7
+            }
+        }
+
+        var description: String {
+            switch self {
+            case .maximum:
+                return NSLocalizedString("Maximum", comment: "Indicates an image will use maximum quality when uploaded.")
+            case .high:
+                return NSLocalizedString("High", comment: "Indicates an image will use high quality when uploaded.")
+            case .medium:
+                return NSLocalizedString("Medium", comment: "Indicates an image will use medium quality when uploaded.")
+            case(.low):
+                return NSLocalizedString("Low", comment: "Indicates an image will use low quality when uploaded.")
+            }
+        }
+
+        static func imageQuality(from value: Float) -> MediaSettings.ImageQuality {
+            switch value {
+            case 1.0:
+                return .maximum
+            case 0.9:
+                return .high
+            case 0.8:
+                return .medium
+            case 0.7:
+                return .low
+            default:
+                return .medium
+            }
+        }
+    }
+
     enum VideoResolution: String {
         case size640x480 = "AVAssetExportPreset640x480"
         case size1280x720 = "AVAssetExportPreset1280x720"
@@ -110,13 +166,19 @@ class MediaSettings: NSObject {
     /// - Note: if the image doesn't need to be resized, it returns `Int.max`
     ///
     @objc var imageSizeForUpload: Int {
-        if maxImageSizeSetting >= maxImageDimension {
+        // When image optimization is enabled, setting the max image size setting to
+        // the maximum value will be considered as to using the original size.
+        if !imageOptimizationSetting || maxImageSizeSetting >= maxImageDimension {
             return Int.max
         } else {
             return maxImageSizeSetting
         }
     }
 
+    var imageQualityForUpload: ImageQuality {
+        return imageOptimizationSetting ? imageQualitySetting : .high
+    }
+
     /// The stored value for the maximum size images can have before uploading.
     /// If you set this to `maxImageDimension` or higher, it means images won't
     /// be resized on upload.
@@ -134,7 +196,7 @@ class MediaSettings: NSObject {
                 database.set(newSize, forKey: maxImageSizeKey)
                 return Int(newSize)
             } else {
-                return maxImageDimension
+                return defaultMaxImageSize
             }
         }
         set {
@@ -148,7 +210,7 @@ class MediaSettings: NSObject {
             if let savedRemoveLocation = database.object(forKey: removeLocationKey) as? Bool {
                 return savedRemoveLocation
             } else {
-                return true
+                return defaultRemoveLocation
             }
         }
         set {
@@ -160,12 +222,56 @@ class MediaSettings: NSObject {
         get {
             guard let savedSize = database.object(forKey: maxVideoSizeKey) as? String,
                   let videoSize = VideoResolution(rawValue: savedSize) else {
-                    return .sizeOriginal
+                    return defaultMaxVideoSize
             }
             return videoSize
         }
         set {
             database.set(newValue.rawValue, forKey: maxVideoSizeKey)
         }
     }
+
+    var imageOptimizationSetting: Bool {
+        get {
+            if let savedImageOptimization = database.object(forKey: imageOptimizationKey) as? Bool {
+                return savedImageOptimization
+            } else {
+                return defaultImageOptimization
+            }
+        }
+        set {
+            database.set(newValue, forKey: imageOptimizationKey)
+
+            // If the user changes this setting manually, we disable the image optimization popup.
+            if advertiseImageOptimization {
+                advertiseImageOptimization = false
+            }
+        }
+    }
+
+    var imageQualitySetting: ImageQuality {
+        get {
+            guard let savedQuality = database.object(forKey: imageQualityKey) as? String,
+                  let imageQuality = ImageQuality(rawValue: savedQuality) else {
+                    return defaultImageQuality
+            }
+            return imageQuality
+        }
+        set {
+            database.set(newValue.rawValue, forKey: imageQualityKey)
+        }
+    }
+
+    var advertiseImageOptimization: Bool {
+        get {
+            if let savedAdvertiseImageOptimization = database.object(forKey: advertiseImageOptimizationKey) as? Bool {
+                return savedAdvertiseImageOptimization
+            } else {
+                return true
+            }
+        }
+        set {
+            database.set(newValue, forKey: advertiseImageOptimizationKey)
+        }
+    }
 }

WordPress/Classes/Utility/Analytics/WPAnalyticsEvent.swift

@@ -283,10 +283,14 @@ import Foundation
     case accountCloseCompleted
 
     // App Settings
+    case appSettingsOptimizeImagesChanged
+    case appSettingsMaxImageSizeChanged
+    case appSettingsImageQualityChanged
     case appSettingsClearMediaCacheTapped
     case appSettingsClearSpotlightIndexTapped
     case appSettingsClearSiriSuggestionsTapped
     case appSettingsOpenDeviceSettingsTapped
+    case appSettingsOptimizeImagesPopupTapped
 
     // Notifications
     case notificationsPreviousTapped
@@ -1007,6 +1011,14 @@ import Foundation
             return "app_settings_clear_siri_suggestions_tapped"
         case .appSettingsOpenDeviceSettingsTapped:
             return "app_settings_open_device_settings_tapped"
+        case .appSettingsOptimizeImagesChanged:
+            return "app_settings_optimize_images_changed"
+        case .appSettingsMaxImageSizeChanged:
+            return "app_settings_max_image_size_changed"
+        case .appSettingsImageQualityChanged:
+            return "app_settings_image_quality_changed"
+        case .appSettingsOptimizeImagesPopupTapped:
+            return "app_settings_optimize_images_popup_tapped"
 
         // Account Close
         case .accountCloseTapped:

WordPress/Classes/ViewRelated/Gutenberg/GutenbergMediaPickerHelper.swift

@@ -110,8 +110,10 @@ extension GutenbergMediaPickerHelper: ImagePickerControllerDelegate {
             switch mediaType {
             case UTType.image.identifier:
                 if let image = info[.originalImage] as? UIImage {
-                    self.didPickMediaCallback?([image])
-                    self.didPickMediaCallback = nil
+                    MediaHelper.advertiseImageOptimization() { [self] in
+                        self.didPickMediaCallback?([image])
+                        self.didPickMediaCallback = nil
+                    }
                 }
 
             case UTType.movie.identifier:
@@ -191,8 +193,21 @@ extension GutenbergMediaPickerHelper: PHPickerViewControllerDelegate {
     func picker(_ picker: PHPickerViewController, didFinishPicking results: [PHPickerResult]) {
         context.dismiss(animated: true)
 
-        didPickMediaCallback?(results.map(\.itemProvider))
-        didPickMediaCallback = nil
+        guard results.count > 0 else {
+            return
+        }
+
+        let mediaFilter = picker.configuration.filter
+        if mediaFilter == PHPickerFilter(.all) || mediaFilter == PHPickerFilter(.image) {
+            MediaHelper.advertiseImageOptimization() { [self] in
+                didPickMediaCallback?(results.map(\.itemProvider))
+                didPickMediaCallback = nil
+            }
+        }
+        else {
+            didPickMediaCallback?(results.map(\.itemProvider))
+            didPickMediaCallback = nil
+        }
     }
 }