Merge pull request #6927 from vector-im/alfogrillo/6847_avatar_image

Update avatar image loading logics (PSB-198)

Riot/Modules/Common/Avatar/AvatarView.swift

@@ -106,19 +106,9 @@ class AvatarView: UIView, Themable {
  return
  }
 
- let defaultAvatarImage: UIImage?
- var defaultAvatarImageContentMode: UIView.ContentMode = .scaleAspectFill
+ let (defaultAvatarImage, defaultAvatarImageContentMode) = viewData.fallbackImageParameters() ?? (nil, .scaleAspectFill)
+ updateAvatarImageView(image: defaultAvatarImage, contentMode: defaultAvatarImageContentMode)
 
- switch viewData.fallbackImage {
- case .matrixItem(let matrixItemId, let matrixItemDisplayName):
- defaultAvatarImage = AvatarGenerator.generateAvatar(forMatrixItem: matrixItemId, withDisplayName: matrixItemDisplayName)
- case .image(let image, let contentMode):
- defaultAvatarImage = image
- defaultAvatarImageContentMode = contentMode ?? .scaleAspectFill
- case .none:
- defaultAvatarImage = nil
- }
-
  if let avatarUrl = viewData.avatarUrl {
  avatarImageView.setImageURI(avatarUrl,
  withType: nil,
@@ -127,12 +117,9 @@ class AvatarView: UIView, Themable {
  with: MXThumbnailingMethodScale,
  previewImage: defaultAvatarImage,
  mediaManager: viewData.mediaManager)
- avatarImageView.contentMode = .scaleAspectFill
- avatarImageView.imageView?.contentMode = .scaleAspectFill
+ updateAvatarContentMode(contentMode: .scaleAspectFill)
  } else {
- avatarImageView.image = defaultAvatarImage
- avatarImageView.contentMode = defaultAvatarImageContentMode
- avatarImageView.imageView?.contentMode = defaultAvatarImageContentMode
+ updateAvatarImageView(image: defaultAvatarImage, contentMode: defaultAvatarImageContentMode)
  }
  }
 
@@ -148,6 +135,16 @@ class AvatarView: UIView, Themable {
  gestureRecognizer.minimumPressDuration = 0
  self.addGestureRecognizer(gestureRecognizer)
  }
+
+ private func updateAvatarImageView(image: UIImage?, contentMode: UIView.ContentMode) {
+ avatarImageView?.image = image
+ updateAvatarContentMode(contentMode: contentMode)
+ }
+
+ private func updateAvatarContentMode(contentMode: UIView.ContentMode) {
+ avatarImageView?.contentMode = contentMode
+ avatarImageView?.imageView.contentMode = contentMode
+ }
 
  // MARK: - Actions
 

Riot/Modules/Common/Avatar/AvatarViewData.swift

@@ -29,6 +29,21 @@ struct AvatarViewData: AvatarViewDataProtocol {
  /// Matrix media handler if exists
  var mediaManager: MXMediaManager?
 
- /// Fallback image used when avatarUrl is nil
- var fallbackImage: AvatarFallbackImage?
+ /// Fallback images used when avatarUrl is nil
+ var fallbackImages: [AvatarFallbackImage]?
+}
+
+extension AvatarViewData {
+ init(matrixItemId: String,
+ displayName: String? = nil,
+ avatarUrl: String? = nil,
+ mediaManager: MXMediaManager? = nil,
+ fallbackImage: AvatarFallbackImage?) {
+
+ self.matrixItemId = matrixItemId
+ self.displayName = displayName
+ self.avatarUrl = avatarUrl
+ self.mediaManager = mediaManager
+ self.fallbackImages = fallbackImage.map { [$0] }
+ }
 }

Riot/Modules/Common/Avatar/AvatarViewDataProtocol.swift

@@ -41,6 +41,24 @@ protocol AvatarViewDataProtocol: AvatarProtocol {
  /// Matrix media handler
  var mediaManager: MXMediaManager? { get }
 
- /// Fallback image used when avatarUrl is nil
- var fallbackImage: AvatarFallbackImage? { get }
+ /// Fallback images used when avatarUrl is nil
+ var fallbackImages: [AvatarFallbackImage]? { get }
+}
+
+extension AvatarViewDataProtocol {
+ func fallbackImageParameters() -> (UIImage?, UIView.ContentMode)? {
+ fallbackImages?
+ .lazy
+ .map { fallbackImage in
+ switch fallbackImage {
+ case .matrixItem(let matrixItemId, let matrixItemDisplayName):
+ return (AvatarGenerator.generateAvatar(forMatrixItem: matrixItemId, withDisplayName: matrixItemDisplayName), .scaleAspectFill)
+ case .image(let image, let contentMode):
+ return (image, contentMode ?? .scaleAspectFill)
+ }
+ }
+ .first { (image, contentMode) in
+ image != nil
+ }
+ }
 }

Riot/Modules/Home/AllChats/AllChatsCoordinator.swift

@@ -332,7 +332,7 @@ class AllChatsCoordinator: NSObject, SplitViewMasterCoordinatorProtocol {
  createAvatarButtonItem(for: viewController)
  }
 
- private func createAvatarButtonItem(for viewController: UIViewController) {
+ private var avatarMenu: UIMenu {
  var actions: [UIMenuElement] = []
 
  actions.append(UIAction(title: VectorL10n.allChatsUserMenuSettings, image: UIImage(systemName: "gearshape")) { [weak self] action in
@@ -358,32 +358,30 @@ class AllChatsCoordinator: NSObject, SplitViewMasterCoordinatorProtocol {
  }
  ]))
 
- let menu = UIMenu(options: .displayInline, children: actions)
-
+ return UIMenu(options: .displayInline, children: actions)
+ }
+
+ private func createAvatarButtonItem(for viewController: UIViewController) {
  let view = UIView(frame: CGRect(x: 0, y: 0, width: 36, height: 36))
  view.backgroundColor = .clear
 
- let button: UIButton = UIButton(frame: view.bounds.inset(by: UIEdgeInsets(top: 7, left: 7, bottom: 7, right: 7)))
+ let avatarInsets: UIEdgeInsets = .init(top: 7, left: 7, bottom: 7, right: 7)
+ let button: UIButton = .init(frame: view.bounds.inset(by: avatarInsets))
  button.setImage(Asset.Images.tabPeople.image, for: .normal)
- button.menu = menu
+ button.menu = avatarMenu
  button.showsMenuAsPrimaryAction = true
  button.autoresizingMask = [.flexibleHeight, .flexibleWidth]
  button.accessibilityLabel = VectorL10n.allChatsUserMenuAccessibilityLabel
  view.addSubview(button)
  self.avatarMenuButton = button
 
- let avatarView = UserAvatarView(frame: view.bounds.inset(by: UIEdgeInsets(top: 7, left: 7, bottom: 7, right: 7)))
+ let avatarView = UserAvatarView(frame: view.bounds.inset(by: avatarInsets))
  avatarView.isUserInteractionEnabled = false
  avatarView.update(theme: ThemeService.shared().theme)
  avatarView.autoresizingMask = [.flexibleHeight, .flexibleWidth]
  view.addSubview(avatarView)
  self.avatarMenuView = avatarView
-
- if let avatar = userAvatarViewData(from: currentMatrixSession) {
- avatarView.fill(with: avatar)
- button.setImage(nil, for: .normal)
- }
-
+ updateAvatarButtonItem()
  viewController.navigationItem.leftBarButtonItem = UIBarButtonItem(customView: view)
  }
 

Riot/Modules/Room/NotificationSettings/UIKit/RoomNotificationSettingsAvatarView.swift

@@ -25,7 +25,7 @@ class RoomNotificationSettingsAvatarView: UIView {
  func configure(viewData: AvatarViewDataProtocol) {
  avatarView.fill(with: viewData)
 
- switch viewData.fallbackImage {
+ switch viewData.fallbackImages?.first {
  case .matrixItem(_, let matrixItemDisplayName):
  nameLabel.text = matrixItemDisplayName
  default:

Riot/Modules/Room/Views/Avatar/RoomAvatarViewData.swift

@@ -26,7 +26,7 @@ struct RoomAvatarViewData: AvatarViewDataProtocol {
  return roomId
  }
 
- var fallbackImage: AvatarFallbackImage? {
- return .matrixItem(matrixItemId, displayName)
+ var fallbackImages: [AvatarFallbackImage]? {
+ [.matrixItem(matrixItemId, displayName)]
  }
 }

Riot/Modules/Rooms/ShowDirectory/Cells/Room/DirectoryRoomTableViewCellVM.swift

@@ -27,19 +27,7 @@ struct DirectoryRoomTableViewCellVM {
 
  // TODO: Use AvatarView subclass in the cell view
  func setAvatar(in avatarImageView: MXKImageView) {
-
- let defaultAvatarImage: UIImage?
- var defaultAvatarImageContentMode: UIView.ContentMode = .scaleAspectFill
-
- switch self.avatarViewData.fallbackImage {
- case .matrixItem(let matrixItemId, let matrixItemDisplayName):
- defaultAvatarImage = AvatarGenerator.generateAvatar(forMatrixItem: matrixItemId, withDisplayName: matrixItemDisplayName)
- case .image(let image, let contentMode):
- defaultAvatarImage = image
- defaultAvatarImageContentMode = contentMode ?? .scaleAspectFill
- case .none:
- defaultAvatarImage = nil
- }
+ let (defaultAvatarImage, defaultAvatarImageContentMode) = avatarViewData.fallbackImageParameters() ?? (nil, .scaleAspectFill)
 
  if let avatarUrl = self.avatarViewData.avatarUrl {
  avatarImageView.enableInMemoryCache = true

Riot/Modules/User/Avatar/UserAvatarViewData.swift

@@ -26,7 +26,7 @@ struct UserAvatarViewData: AvatarViewDataProtocol {
  return userId
  }
 
- var fallbackImage: AvatarFallbackImage? {
- return .matrixItem(matrixItemId, displayName)
+ var fallbackImages: [AvatarFallbackImage]? {
+ [.matrixItem(matrixItemId, displayName), .image(Asset.Images.tabPeople.image, .scaleAspectFill)]
  }
 }

changelog.d/6847.bugfix

@@ -0,0 +1 @@
+Updates the avatar image loading logics.