element-ios/Riot/Modules/MatrixKit/Models/RoomList/MXKRecentsDataSource.m

/*
Copyright 2018-2024 New Vector Ltd.
Copyright 2017 Vector Creations Ltd
Copyright 2015 OpenMarket Ltd

SPDX-License-Identifier: AGPL-3.0-only
Please see LICENSE in the repository root for full details.
 */

#import "MXKRecentsDataSource.h"

@import MatrixSDK.MXMediaManager;

#import "NSBundle+MatrixKit.h"

#import "MXKConstants.h"

@interface MXKRecentsDataSource ()
{
    /**
     Array of `MXSession` instances.
     */
    NSMutableArray *mxSessionArray;
    
    /**
     Array of `MXKSessionRecentsDataSource` instances (one by matrix session).
     */
    NSMutableArray *recentsDataSourceArray;
}

@end

@implementation MXKRecentsDataSource

- (instancetype)init
{
    self = [super init];
    if (self)
    {
        mxSessionArray = [NSMutableArray array];
        recentsDataSourceArray = [NSMutableArray array];
        
        displayedRecentsDataSourceArray = [NSMutableArray array];
        shrinkedRecentsDataSourceArray = [NSMutableArray array];
        
        // Set default data and view classes
        [self registerCellDataClass:MXKRecentCellData.class forCellIdentifier:kMXKRecentCellIdentifier];
        
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(didMXSessionInviteRoomUpdate:) name:kMXSessionInvitedRoomsDidChangeNotification object:nil];        
    }
    return self;
}

- (instancetype)initWithMatrixSession:(MXSession *)matrixSession
{
    self = [self init];
    if (self)
    {
        [self addMatrixSession:matrixSession];
    }
    return self;
}

- (MXKSessionRecentsDataSource *)addMatrixSession:(MXSession *)matrixSession
{
    MXKSessionRecentsDataSource *recentsDataSource = [[MXKSessionRecentsDataSource alloc] initWithMatrixSession:matrixSession];
    
    if (recentsDataSource)
    {
        // Set the actual data and view classes
        [recentsDataSource registerCellDataClass:[self cellDataClassForCellIdentifier:kMXKRecentCellIdentifier] forCellIdentifier:kMXKRecentCellIdentifier];
        
        [mxSessionArray addObject:matrixSession];
        
        recentsDataSource.delegate = self;
        [recentsDataSourceArray addObject:recentsDataSource];
        
        [recentsDataSource finalizeInitialization];
        
        if (self.delegate && [self.delegate respondsToSelector:@selector(dataSource:didAddMatrixSession:)])
        {
            [self.delegate dataSource:self didAddMatrixSession:matrixSession];
        }
        
        // Check the current state of the data source
        [self dataSource:recentsDataSource didStateChange:recentsDataSource.state];
    }
    
    return recentsDataSource;
}

- (void)removeMatrixSession:(MXSession*)matrixSession
{
    for (NSUInteger index = 0; index < mxSessionArray.count; index++)
    {
        MXSession *mxSession = [mxSessionArray objectAtIndex:index];
        if (mxSession == matrixSession)
        {
            MXKSessionRecentsDataSource *recentsDataSource = [recentsDataSourceArray objectAtIndex:index];
            [recentsDataSource destroy];
            
            [displayedRecentsDataSourceArray removeObject:recentsDataSource];
            
            [recentsDataSourceArray removeObjectAtIndex:index];
            [mxSessionArray removeObjectAtIndex:index];
            
            // Loop on 'didCellChange' method to let inherited 'MXKRecentsDataSource' class handle this removed data source.
            [self dataSource:recentsDataSource didCellChange:nil];
            
            if (self.delegate && [self.delegate respondsToSelector:@selector(dataSource:didRemoveMatrixSession:)])
            {
                [self.delegate dataSource:self didRemoveMatrixSession:matrixSession];
            }
            
            break;
        }
    }
}

- (void)setCurrentSpace:(MXSpace *)currentSpace
{
    _currentSpace = currentSpace;

    for (MXKSessionRecentsDataSource *recentsDataSource in recentsDataSourceArray) {
        recentsDataSource.currentSpace = currentSpace;
    }
}

#pragma mark - MXKDataSource overridden

- (MXSession*)mxSession
{
    if (mxSessionArray.count > 1)
    {
        MXLogDebug(@"[MXKRecentsDataSource] CAUTION: mxSession property is not relevant in case of multi-sessions (%tu)", mxSessionArray.count);
    }
    
    // TODO: This property is not well adapted in case of multi-sessions
    // We consider by default the first added session as the main one...
    if (mxSessionArray.count)
    {
        return [mxSessionArray firstObject];
    }
    return nil;
}

- (MXKDataSourceState)state
{
    // Manage a global state based on the state of each internal data source.
    
    MXKDataSourceState currentState = MXKDataSourceStateUnknown;
    MXKSessionRecentsDataSource *dataSource;
    
    if (recentsDataSourceArray.count)
    { 
        dataSource = [recentsDataSourceArray firstObject];
        currentState = dataSource.state;
        
        // Deduce the current state according to the internal data sources
        for (NSUInteger index = 1; index < recentsDataSourceArray.count; index++)
        {
            dataSource = [recentsDataSourceArray objectAtIndex:index];
            
            switch (dataSource.state)
            {
                case MXKDataSourceStateUnknown:
                    break;
                case MXKDataSourceStatePreparing:
                    currentState = MXKDataSourceStatePreparing;
                    break;
                case MXKDataSourceStateFailed:
                    if (currentState == MXKDataSourceStateUnknown)
                    {
                        currentState = MXKDataSourceStateFailed;
                    }
                    break;
                case MXKDataSourceStateReady:
                    if (currentState == MXKDataSourceStateUnknown || currentState == MXKDataSourceStateFailed)
                    {
                        currentState = MXKDataSourceStateReady;
                    }
                    break;
                    
                default:
                    break;
            }
        }
    }
    
    return currentState;
}

- (void)destroy
{
    for (MXKSessionRecentsDataSource *recentsDataSource in recentsDataSourceArray)
    {
        [recentsDataSource destroy];
    }
    displayedRecentsDataSourceArray = nil;
    recentsDataSourceArray = nil;
    shrinkedRecentsDataSourceArray = nil;
    mxSessionArray = nil;
    
    _searchPatternsList = nil;
    
    [[NSNotificationCenter defaultCenter] removeObserver:self name:kMXSessionInvitedRoomsDidChangeNotification object:nil];
    
    [super destroy];
}

#pragma mark -

- (NSArray*)mxSessions
{
    return [NSArray arrayWithArray:mxSessionArray];
}

- (NSUInteger)displayedRecentsDataSourcesCount
{
    return displayedRecentsDataSourceArray.count;
}

- (BOOL)hasUnread
{
    // Check hasUnread flag in all ready data sources
    for (MXKSessionRecentsDataSource *recentsDataSource in displayedRecentsDataSourceArray)
    {
        if (recentsDataSource.hasUnread)
        {
            return YES;
        }
    }
    return NO;
}

- (void)searchWithPatterns:(NSArray*)patternsList
{
    _searchPatternsList = patternsList;
    
    // CAUTION: Apply here the search pattern to all ready data sources (not only displayed ones).
    // Some data sources may have been removed from 'displayedRecentsDataSourceArray' during a previous search if no recent was matching.
    for (MXKSessionRecentsDataSource *recentsDataSource in recentsDataSourceArray)
    {
        if (recentsDataSource.state == MXKDataSourceStateReady)
        {
            [recentsDataSource searchWithPatterns:patternsList];
        }
    }
}

- (UIView *)viewForHeaderInSection:(NSInteger)section withFrame:(CGRect)frame inTableView:(UITableView*)tableView
{
    UIView *sectionHeader = nil;
    
    if (displayedRecentsDataSourceArray.count > 1 && section < displayedRecentsDataSourceArray.count)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:section];
        
        NSString* sectionTitle = recentsDataSource.mxSession.myUser.userId;
        
        sectionHeader = [[UIView alloc] initWithFrame:frame];
        sectionHeader.backgroundColor = [UIColor colorWithRed:0.9 green:0.9 blue:0.9 alpha:1.0];
        
        // Add shrink button
        UIButton *shrinkButton = [UIButton buttonWithType:UIButtonTypeCustom];
        frame.origin.x = frame.origin.y = 0;
        shrinkButton.frame = frame;
        shrinkButton.backgroundColor = [UIColor clearColor];
        [shrinkButton addTarget:self action:@selector(onButtonPressed:) forControlEvents:UIControlEventTouchUpInside];
        shrinkButton.tag = section;
        [sectionHeader addSubview:shrinkButton];
        sectionHeader.userInteractionEnabled = YES;
        
        // Add shrink icon
        UIImage *chevron;
        if ([shrinkedRecentsDataSourceArray indexOfObject:recentsDataSource] != NSNotFound)
        {
            chevron = [NSBundle mxk_imageFromMXKAssetsBundleWithName:@"disclosure"];
        }
        else
        {
            chevron = [NSBundle mxk_imageFromMXKAssetsBundleWithName:@"shrink"];
        }
        UIImageView *chevronView = [[UIImageView alloc] initWithImage:chevron];
        chevronView.contentMode = UIViewContentModeCenter;
        frame = chevronView.frame;
        frame.origin.x = sectionHeader.frame.size.width - frame.size.width - 8;
        frame.origin.y = (sectionHeader.frame.size.height - frame.size.height) / 2;
        chevronView.frame = frame;
        [sectionHeader addSubview:chevronView];
        chevronView.autoresizingMask = (UIViewAutoresizingFlexibleLeftMargin | UIViewAutoresizingFlexibleRightMargin);
        
        // Add label
        frame = sectionHeader.frame;
        frame.origin.x = 5;
        frame.origin.y = 5;
        frame.size.width = chevronView.frame.origin.x - 10;
        frame.size.height -= 10;
        UILabel *headerLabel = [[UILabel alloc] initWithFrame:frame];
        headerLabel.font = [UIFont boldSystemFontOfSize:16];
        headerLabel.backgroundColor = [UIColor clearColor];
        headerLabel.text = sectionTitle;
        [sectionHeader addSubview:headerLabel];
    }
    
    return sectionHeader;
}

- (id<MXKRecentCellDataStoring>)cellDataAtIndexPath:(NSIndexPath *)indexPath
{
    if (indexPath.section < displayedRecentsDataSourceArray.count)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:indexPath.section];
        
        return [recentsDataSource cellDataAtIndex:indexPath.row];
    }
    return nil;
}

- (CGFloat)cellHeightAtIndexPath:(NSIndexPath *)indexPath
{
    if (indexPath.section < displayedRecentsDataSourceArray.count)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:indexPath.section];
        
        return [recentsDataSource cellHeightAtIndex:indexPath.row];
    }
    return 0;
}

- (NSIndexPath*)cellIndexPathWithRoomId:(NSString*)roomId andMatrixSession:(MXSession*)matrixSession
{
    NSIndexPath *indexPath = nil;
    
    // Look for the right data source
    for (NSInteger section = 0; section < displayedRecentsDataSourceArray.count; section++)
    {
        MXKSessionRecentsDataSource *recentsDataSource = displayedRecentsDataSourceArray[section];
        if (recentsDataSource.mxSession == matrixSession)
        {
            // Check whether the source is not shrinked
            if ([shrinkedRecentsDataSourceArray indexOfObject:recentsDataSource] == NSNotFound)
            {
                // Look for the cell
                for (NSInteger index = 0; index < recentsDataSource.numberOfCells; index ++)
                {
                    id<MXKRecentCellDataStoring> recentCellData = [recentsDataSource cellDataAtIndex:index];
                    if ([roomId isEqualToString:recentCellData.roomIdentifier])
                    {
                        // Got it
                        indexPath = [NSIndexPath indexPathForRow:index inSection:section];
                        break;
                    }
                }
            }
            break;
        }
    }
    
    return indexPath;
}

#pragma mark - UITableViewDataSource

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView
{
    // Check whether all data sources are ready before rendering recents
    if (self.state == MXKDataSourceStateReady)
    {
        return displayedRecentsDataSourceArray.count;
    }
    return 0;
}

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section
{
    if (section < displayedRecentsDataSourceArray.count)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:section];
        
        // Check whether the source is shrinked
        if ([shrinkedRecentsDataSourceArray indexOfObject:recentsDataSource] == NSNotFound)
        {
            return recentsDataSource.numberOfCells;
        }
    }
    
    return 0;
}

- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section
{
    NSString* sectionTitle = nil;
    
    if (displayedRecentsDataSourceArray.count > 1 && section < displayedRecentsDataSourceArray.count)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:section];
        
        sectionTitle = recentsDataSource.mxSession.myUser.userId;
    }
    
    return sectionTitle;
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
    if (indexPath.section < displayedRecentsDataSourceArray.count && self.delegate)
    {
        MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:indexPath.section];
        
        id<MXKRecentCellDataStoring> roomData = [recentsDataSource cellDataAtIndex:indexPath.row];
        
        NSString *cellIdentifier = [self.delegate cellReuseIdentifierForCellData:roomData];
        if (cellIdentifier)
        {
            UITableViewCell<MXKCellRendering> *cell  = [tableView dequeueReusableCellWithIdentifier:cellIdentifier forIndexPath:indexPath];
            
            // Make sure we listen to user actions on the cell
            cell.delegate = self;
            
            // Make the bubble display the data
            [cell render:roomData];
            
            return cell;
        }
    }
    
    // Return a fake cell to prevent app from crashing.
    return [[UITableViewCell alloc] init];
}

- (BOOL)tableView:(UITableView *)tableView canEditRowAtIndexPath:(NSIndexPath *)indexPath
{
    // Return NO if you do not want the specified item to be editable.
    return YES;
}

- (void)tableView:(UITableView *)tableView commitEditingStyle:(UITableViewCellEditingStyle)editingStyle forRowAtIndexPath:(NSIndexPath *)indexPath
{
    if (editingStyle == UITableViewCellEditingStyleDelete)
    {
        [self leaveRoomAtIndexPath:indexPath];
    }
}

#pragma mark - MXKDataSourceDelegate

- (Class<MXKCellRendering>)cellViewClassForCellData:(MXKCellData*)cellData
{
    // Retrieve the class from the delegate here
    if (self.delegate)
    {
        return [self.delegate cellViewClassForCellData:cellData];
    }
    
    return nil;
}

- (NSString *)cellReuseIdentifierForCellData:(MXKCellData*)cellData
{
    // Retrieve the identifier from the delegate here
    if (self.delegate)
    {
        return [self.delegate cellReuseIdentifierForCellData:cellData];
    }
    
    return nil;
}

- (void)dataSource:(MXKDataSource*)dataSource didCellChange:(id)changes
{
    // Keep update readyRecentsDataSourceArray by checking number of cells
    if (dataSource.state == MXKDataSourceStateReady)
    {
        MXKSessionRecentsDataSource *recentsDataSource = (MXKSessionRecentsDataSource*)dataSource;
        
        if (recentsDataSource.numberOfCells)
        {
            // Check whether the data source must be added
            if ([displayedRecentsDataSourceArray indexOfObject:recentsDataSource] == NSNotFound)
            {
                // Add this data source first
                [self dataSource:dataSource didStateChange:dataSource.state];
                return;
            }
        }
        else
        {
            // Check whether this data source must be removed
            if ([displayedRecentsDataSourceArray indexOfObject:recentsDataSource] != NSNotFound)
            {
                [displayedRecentsDataSourceArray removeObject:recentsDataSource];
                
                // Loop on 'didCellChange' method to let inherited 'MXKRecentsDataSource' class handle this removed data source.
                [self dataSource:recentsDataSource didCellChange:nil];
                return;
            }
        }
    }
    
    // Notify delegate
    [self.delegate dataSource:self didCellChange:changes];
}

- (void)dataSource:(MXKDataSource*)dataSource didStateChange:(MXKDataSourceState)state
{
    // Update list of ready data sources
    MXKSessionRecentsDataSource *recentsDataSource = (MXKSessionRecentsDataSource*)dataSource;
    if (dataSource.state == MXKDataSourceStateReady && recentsDataSource.numberOfCells)
    {
        if ([displayedRecentsDataSourceArray indexOfObject:recentsDataSource] == NSNotFound)
        {
            // Add this new recents data source.
            if (!displayedRecentsDataSourceArray.count)
            {
                [displayedRecentsDataSourceArray addObject:recentsDataSource];
            }
            else
            {
                // To display multiple accounts in a consistent order, we sort the recents data source by considering the account user id (alphabetic order).
                NSUInteger index;
                for (index = 0; index < displayedRecentsDataSourceArray.count; index++)
                {
                    MXKSessionRecentsDataSource *currentRecentsDataSource = displayedRecentsDataSourceArray[index];
                    if ([currentRecentsDataSource.mxSession.myUser.userId compare:recentsDataSource.mxSession.myUser.userId] == NSOrderedDescending)
                    {
                        break;
                    }
                }
                
                // Insert this data source
                [displayedRecentsDataSourceArray insertObject:recentsDataSource atIndex:index];
            }
            
            // Check whether a search session is in progress
            if (_searchPatternsList)
            {
                [recentsDataSource searchWithPatterns:_searchPatternsList];
            }
            else
            {
                // Loop on 'didCellChange' method to let inherited 'MXKRecentsDataSource' class handle this new added data source.
                [self dataSource:recentsDataSource didCellChange:nil];
            }
        }
    }
    else if ([displayedRecentsDataSourceArray indexOfObject:recentsDataSource] != NSNotFound)
    {
        [displayedRecentsDataSourceArray removeObject:recentsDataSource];
        
        // Loop on 'didCellChange' method to let inherited 'MXKRecentsDataSource' class handle this removed data source.
        [self dataSource:recentsDataSource didCellChange:nil];
    }
    
    if (self.delegate && [self.delegate respondsToSelector:@selector(dataSource:didStateChange:)])
    {
        [self.delegate dataSource:self didStateChange:self.state];
    }
}

#pragma mark - Action

- (IBAction)onButtonPressed:(id)sender
{
    if ([sender isKindOfClass:[UIButton class]])
    {
        UIButton *shrinkButton = (UIButton*)sender;
        
        if (shrinkButton.tag < displayedRecentsDataSourceArray.count)
        {
            MXKSessionRecentsDataSource *recentsDataSource = [displayedRecentsDataSourceArray objectAtIndex:shrinkButton.tag];
            
            NSUInteger index = [shrinkedRecentsDataSourceArray indexOfObject:recentsDataSource];
            if (index != NSNotFound)
            {
                // Disclose the
                [shrinkedRecentsDataSourceArray removeObjectAtIndex:index];
            }
            else
            {
                // Shrink the recents from this session
                [shrinkedRecentsDataSourceArray addObject:recentsDataSource];
            }
            
            // Loop on 'didCellChange' method to let inherited 'MXKRecentsDataSource' class handle change on this data source.
            [self dataSource:recentsDataSource didCellChange:nil];
        }
    }
}

#pragma mark - room actions
- (MXRoom*)getRoomAtIndexPath:(NSIndexPath *)indexPath
{
    // Leave the selected room
    id<MXKRecentCellDataStoring> recentCellData = [self cellDataAtIndexPath:indexPath];
    
    if (recentCellData)
    {
        return [self.mxSession roomWithRoomId:recentCellData.roomIdentifier];
    }
    
    return nil;
}

- (void)leaveRoomAtIndexPath:(NSIndexPath *)indexPath
{
    MXRoom* room = [self getRoomAtIndexPath:indexPath];
    
    if (room)
    {
        // cancel pending uploads/downloads
        // they are useless by now
        [MXMediaManager cancelDownloadsInCacheFolder:room.roomId];
        
        // TODO GFO cancel pending uploads related to this room
        
        [room leave:^{
            
            // Trigger recents table refresh
            if (self.delegate)
            {
                [self.delegate dataSource:self didCellChange:nil];
            }
            
        } failure:^(NSError *error) {
            
            MXLogDebug(@"[MXKRecentsDataSource] Failed to leave room (%@) failed", room.roomId);
            
            // Notify MatrixKit user
            NSString *myUserId = room.mxSession.myUser.userId;
            [[NSNotificationCenter defaultCenter] postNotificationName:kMXKErrorNotification object:error userInfo:myUserId ? @{kMXKErrorUserIdKey: myUserId} : nil];
            
        }];
    }
}

- (void)didMXSessionInviteRoomUpdate:(NSNotification *)notif
{
    MXSession *mxSession = notif.object;
    if ([self.mxSessions indexOfObject:mxSession] != NSNotFound)
    {
        // do nothing by default
        // the inherited classes might require to perform a full or a particial refresh.
        //[self.delegate dataSource:self didCellChange:nil];
    }
}

@end