deltachat-ios/deltachat-ios/ViewModel/ChatListViewModel.swift

import UIKit
import DcCore

// MARK: - ChatListViewModelProtocol
protocol ChatListViewModelProtocol: class, UISearchResultsUpdating {

    var onChatListUpdate: VoidFunction? { get set }

    var isArchive: Bool { get }

    var numberOfSections: Int { get }
    func numberOfRowsIn(section: Int) -> Int
    func cellDataFor(section: Int, row: Int) -> AvatarCellViewModel

    func msgIdFor(row: Int) -> Int?
    func chatIdFor(section: Int, row: Int) -> Int? // needed to differentiate betweeen deaddrop / archive / default

    // search related
    var searchActive: Bool { get }
    func beginSearch()
    func endSearch()
    func titleForHeaderIn(section: Int) -> String? // only visible on search results
    var emptySearchText: String? { get }

    func deleteChat(chatId: Int)
    func archiveChatToggle(chatId: Int)
    func pinChatToggle(chatId: Int)
    func refreshData()
}

// MARK: - ChatListViewModel
class ChatListViewModel: NSObject, ChatListViewModelProtocol {

    var onChatListUpdate: VoidFunction?

    private var inBgSearch = false
    private var needsAnotherBgSearch = false

    enum ChatListSectionType {
        case chats
        case contacts
        case messages
    }

    var isArchive: Bool
    private let dcContext: DcContext

    var searchActive: Bool = false

    // if searchfield is empty we show default chat list
    private var showSearchResults: Bool {
        return searchActive && searchText.containsCharacters()
    }

    private var chatList: DcChatlist!

    // for search filtering
    private var searchText: String = ""
    private var searchResultChatList: DcChatlist?
    private var searchResultContactIds: [Int] = []
    private var searchResultMessageIds: [Int] = []

    // to manage sections dynamically
    private var searchResultsChatsSection: ChatListSectionType = .chats
    private var searchResultsContactsSection: ChatListSectionType = .contacts
    private var searchResultsMessagesSection: ChatListSectionType = .messages
    private var searchResultSections: [ChatListSectionType] = []

    init(dcContext: DcContext, isArchive: Bool) {
        self.isArchive = isArchive
        self.dcContext = dcContext
        super.init()
        updateChatList(notifyListener: true)
    }

    private func updateChatList(notifyListener: Bool) {
        var gclFlags: Int32 = 0
        if isArchive {
            gclFlags |= DC_GCL_ARCHIVED_ONLY
        } else if RelayHelper.sharedInstance.isForwarding() {
            gclFlags |= DC_GCL_FOR_FORWARDING
        }
        self.chatList = dcContext.getChatlist(flags: gclFlags, queryString: nil, queryId: 0)
        if notifyListener, let onChatListUpdate = onChatListUpdate {
            if Thread.isMainThread {
                onChatListUpdate()
            } else {
                DispatchQueue.main.async {
                    onChatListUpdate()
                }
            }
        }
    }

    var numberOfSections: Int {
        if showSearchResults {
            return searchResultSections.count
        }
        return 1
    }

    func numberOfRowsIn(section: Int) -> Int {
        if showSearchResults {
            switch searchResultSections[section] {
            case .chats:
                return searchResultChatList?.length ?? 0
            case .contacts:
                return searchResultContactIds.count
            case .messages:
                return searchResultMessageIds.count
            }
        }
        return chatList.length
    }

    func cellDataFor(section: Int, row: Int) -> AvatarCellViewModel {
        if showSearchResults {
            switch searchResultSections[section] {
            case .chats:
                return makeChatCellViewModel(index: row, searchText: searchText)

            case .contacts:
                if row >= 0 && row < searchResultContactIds.count {
                    return ContactCellViewModel.make(contactId: searchResultContactIds[row], searchText: searchText, dcContext: dcContext)
                } else {
                    logger.warning("search: requested contact index \(row) not in range 0..\(searchResultContactIds.count)")
                }

            case .messages:
                if row >= 0 && row < searchResultMessageIds.count {
                    return makeMessageCellViewModel(msgId: searchResultMessageIds[row])
                } else {
                    logger.warning("search: requested message index \(row) not in range 0..\(searchResultMessageIds.count)")
                }
            }
        }
        return makeChatCellViewModel(index: row, searchText: "")
    }

    func titleForHeaderIn(section: Int) -> String? {
        if showSearchResults {
            switch searchResultSections[section] {
            case .chats:
                return String.localized(stringID: "n_chats", count: numberOfRowsIn(section: section))
            case .contacts:
                return String.localized(stringID: "n_contacts", count: numberOfRowsIn(section: section))
            case .messages:
                let count = numberOfRowsIn(section: section)
                var ret = String.localized(stringID: "n_messages", count: count)
                if count==1000 {
                    // a count of 1000 results may be limited, see documentation of dc_search_msgs()
                    // (formatting may be "1.000" or "1,000", so just skip the first digit)
                    ret = ret.replacingOccurrences(of: "000", with: "000+")
                }
                return ret
            }
        }
        return nil
    }

    func chatIdFor(section: Int, row: Int) -> Int? {
        let cellData = cellDataFor(section: section, row: row)
        switch cellData.type {
        case .deaddrop(let data):
            return data.chatId
        case .chat(let data):
            return data.chatId
        case .contact:
            return nil
        case .profile:
            return nil
        }
    }

    func msgIdFor(row: Int) -> Int? {
        if showSearchResults {
            return nil
        }
        return chatList.getMsgId(index: row)
    }

    func refreshData() {
        updateChatList(notifyListener: true)
    }

    func beginSearch() {
        searchActive = true
    }

    func endSearch() {
        searchActive = false
        searchText = ""
        resetSearch()
    }

    var emptySearchText: String? {
        if searchActive && numberOfSections == 0 {
            return searchText
        }
        return nil
    }

    func deleteChat(chatId: Int) {
        dcContext.deleteChat(chatId: chatId)
        NotificationManager.removeNotificationsForChat(chatId: chatId)
    }

    func archiveChatToggle(chatId: Int) {
        let chat = dcContext.getChat(chatId: chatId)
        dcContext.archiveChat(chatId: chatId, archive: !chat.isArchived)
        updateChatList(notifyListener: false)
    }

    func pinChatToggle(chatId: Int) {
        let chat: DcChat = dcContext.getChat(chatId: chatId)
        let pinned = chat.visibility==DC_CHAT_VISIBILITY_PINNED
        self.dcContext.setChatVisibility(chatId: chatId, visibility: pinned ? DC_CHAT_VISIBILITY_NORMAL : DC_CHAT_VISIBILITY_PINNED)
        updateChatList(notifyListener: false)
    }
}

private extension ChatListViewModel {

    /// MARK: - avatarCellViewModel factory
    func makeChatCellViewModel(index: Int, searchText: String) -> AvatarCellViewModel {

        let list: DcChatlist = searchResultChatList ?? chatList
        let chatId = list.getChatId(index: index)
        let summary = list.getSummary(index: index)


        if let msgId = msgIdFor(row: index), chatId == DC_CHAT_ID_DEADDROP {
            return ChatCellViewModel(dcContext: dcContext, deaddropCellData: DeaddropCellData(chatId: chatId, msgId: msgId, summary: summary))
        }

        let chat = dcContext.getChat(chatId: chatId)
        let unreadMessages = dcContext.getUnreadMessages(chatId: chatId)

        var chatTitleIndexes: [Int] = []
        if searchText.containsCharacters() {
            let chatName = chat.name
            chatTitleIndexes = chatName.containsExact(subSequence: searchText)
        }

        let viewModel = ChatCellViewModel(
            dcContext: dcContext,
            chatData: ChatCellData(
                chatId: chatId,
                highlightMsgId: nil,
                summary: summary,
                unreadMessages: unreadMessages
            ),
            titleHighlightIndexes: chatTitleIndexes
        )
        return viewModel
    }

    func makeMessageCellViewModel(msgId: Int) -> AvatarCellViewModel {
        let msg: DcMsg = DcMsg(id: msgId)
        let chatId: Int = msg.chatId
        let chat: DcChat = dcContext.getChat(chatId: chatId)
        let summary: DcLot = msg.summary(chat: chat)
        let unreadMessages = dcContext.getUnreadMessages(chatId: chatId)

        let viewModel = ChatCellViewModel(
            dcContext: dcContext,
            chatData: ChatCellData(
                chatId: chatId,
                highlightMsgId: msgId,
                summary: summary,
                unreadMessages: unreadMessages
            )
        )
        let subtitle = viewModel.subtitle
        viewModel.subtitleHighlightIndexes = subtitle.containsExact(subSequence: searchText)
        return viewModel
    }

    // MARK: - search
    private func updateSearchResultSections() {
        var sections: [ChatListSectionType] = []
        if let chatList = searchResultChatList, chatList.length > 0 {
            sections.append(searchResultsChatsSection)
        }
        if !searchResultContactIds.isEmpty {
            sections.append(searchResultsContactsSection)
        }
        if !searchResultMessageIds.isEmpty {
            sections.append(searchResultsMessagesSection)
        }
        searchResultSections = sections
    }

    private func resetSearch() {
        searchResultChatList = nil
        searchResultContactIds = []
        searchResultMessageIds = []
        updateSearchResultSections()
    }

    private func filterContentForSearchText(_ searchText: String) {
        if !searchText.isEmpty {
            filterAndUpdateList(searchText: searchText)
        } else {
            // when search input field empty we show default chatList
            resetSearch()
        }
        if let onChatListUpdate = onChatListUpdate {
            if Thread.isMainThread {
                onChatListUpdate()
            } else {
                DispatchQueue.main.async {
                    onChatListUpdate()
                }
            }
        }
    }

    func filterAndUpdateList(searchText: String) {
        var overallCnt = 0

        // #1 chats with searchPattern in title bar
        searchResultChatList = dcContext.getChatlist(flags: DC_GCL_NO_SPECIALS, queryString: searchText, queryId: 0)
        if let chatlist = searchResultChatList {
            overallCnt += chatlist.length
        }

        // #2 contacts with searchPattern in name or in email
        if searchText != self.searchText && overallCnt > 0 {
            logger.info("... skipping getContacts and searchMessages, more recent search pending")
            searchResultContactIds = []
            searchResultMessageIds = []
            updateSearchResultSections()
            return
        }

        searchResultContactIds = dcContext.getContacts(flags: DC_GCL_ADD_SELF, queryString: searchText)
        overallCnt += searchResultContactIds.count

        // #3 messages with searchPattern (filtered by dc_core)
        if searchText != self.searchText && overallCnt > 0 {
            logger.info("... skipping searchMessages, more recent search pending")
            searchResultMessageIds = []
            updateSearchResultSections()
            return
        }

        if searchText.count <= 1 {
            logger.info("... skipping searchMessages, string too short")
            searchResultMessageIds = []
            updateSearchResultSections()
            return
        }

        searchResultMessageIds = dcContext.searchMessages(searchText: searchText)
        updateSearchResultSections()
    }
}

// MARK: UISearchResultUpdating
extension ChatListViewModel: UISearchResultsUpdating {
    func updateSearchResults(for searchController: UISearchController) {

        self.searchText = searchController.searchBar.text ?? ""

        if inBgSearch {
            needsAnotherBgSearch = true
            logger.info("... search call debounced")
        } else {
            inBgSearch = true
            DispatchQueue.global(qos: .userInteractive).async { [weak self] in
                usleep(100000)
                self?.needsAnotherBgSearch = false
                self?.filterContentForSearchText(self?.searchText ?? "")

                while self?.needsAnotherBgSearch != false {
                    usleep(100000)
                    self?.needsAnotherBgSearch = false
                    logger.info("... executing debounced search call")
                    self?.filterContentForSearchText(self?.searchText ?? "")
                }

                self?.inBgSearch = false
            }
        }
    }
}