Add public timeline descriptions

2021-08-07 14:39:01 -04:00 · 2021-08-07 14:39:01 -04:00 · b781b56efd
parent 10a8a85bfc
commit b781b56efd
5 changed files with 211 additions and 5 deletions
--- a/Tusker.xcodeproj/project.pbxproj
+++ b/Tusker.xcodeproj/project.pbxproj
@ -134,6 +134,8 @@
 		D6412B0B24B0D4C600F5412E /* ProfileHeaderView.xib in Resources */ = {isa = PBXBuildFile; fileRef = D6412B0A24B0D4C600F5412E /* ProfileHeaderView.xib */; };
 		D6412B0D24B0D4CF00F5412E /* ProfileHeaderView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D6412B0C24B0D4CF00F5412E /* ProfileHeaderView.swift */; };
 		D641C77F213DC78A004B4513 /* InlineTextAttachment.swift in Sources */ = {isa = PBXBuildFile; fileRef = D641C77E213DC78A004B4513 /* InlineTextAttachment.swift */; };
+		D6420AEE26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = D6420AEC26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.swift */; };
+		D6420AEF26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.xib in Resources */ = {isa = PBXBuildFile; fileRef = D6420AED26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.xib */; };
 		D6434EB3215B1856001A919A /* XCBRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = D6434EB2215B1856001A919A /* XCBRequest.swift */; };
 		D646C956213B365700269FB5 /* LargeImageExpandAnimationController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D646C955213B365700269FB5 /* LargeImageExpandAnimationController.swift */; };
 		D646C958213B367000269FB5 /* LargeImageShrinkAnimationController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D646C957213B367000269FB5 /* LargeImageShrinkAnimationController.swift */; };
@ -535,6 +537,8 @@
 		D6412B0A24B0D4C600F5412E /* ProfileHeaderView.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = ProfileHeaderView.xib; sourceTree = "<group>"; };
 		D6412B0C24B0D4CF00F5412E /* ProfileHeaderView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProfileHeaderView.swift; sourceTree = "<group>"; };
 		D641C77E213DC78A004B4513 /* InlineTextAttachment.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InlineTextAttachment.swift; sourceTree = "<group>"; };
+		D6420AEC26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PublicTimelineDescriptionTableViewCell.swift; sourceTree = "<group>"; };
+		D6420AED26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = PublicTimelineDescriptionTableViewCell.xib; sourceTree = "<group>"; };
 		D6434EB2215B1856001A919A /* XCBRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XCBRequest.swift; sourceTree = "<group>"; };
 		D646C955213B365700269FB5 /* LargeImageExpandAnimationController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LargeImageExpandAnimationController.swift; sourceTree = "<group>"; };
 		D646C957213B367000269FB5 /* LargeImageShrinkAnimationController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LargeImageShrinkAnimationController.swift; sourceTree = "<group>"; };
@ -1240,6 +1244,15 @@
 			path = Notifications;
 			sourceTree = "<group>";
 		};
+		D6420AEB26BED17500ED8175 /* Timeline Description Cell */ = {
+			isa = PBXGroup;
+			children = (
+				D6420AEC26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.swift */,
+				D6420AED26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.xib */,
+			);
+			path = "Timeline Description Cell";
+			sourceTree = "<group>";
+		};
 		D646C954213B364600269FB5 /* Transitions */ = {
 			isa = PBXGroup;
 			children = (
@ -1470,6 +1483,7 @@
 				D611C2CC232DC5FC00C86A49 /* Hashtag Cell */,
 				D61AC1DA232EA43100C54D2D /* Instance Cell */,
 				D6DEA0DB268400AF00FE896A /* Confirm Load More Cell */,
+				D6420AEB26BED17500ED8175 /* Timeline Description Cell */,
 			);
 			path = Views;
 			sourceTree = "<group>";
@ -1886,6 +1900,7 @@
 				D6412B0B24B0D4C600F5412E /* ProfileHeaderView.xib in Resources */,
 				D6C82B5725C5F3F20017F1E6 /* ExpandThreadTableViewCell.xib in Resources */,
 				D6D4DDDA212518A200E1C4BB /* LaunchScreen.storyboard in Resources */,
+				D6420AEF26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.xib in Resources */,
 				D6E57FA325C26FAB00341037 /* Localizable.stringsdict in Resources */,
 				D6B053AC23BD2F1400A066FA /* AssetCollectionViewCell.xib in Resources */,
 				D6D4DDD7212518A200E1C4BB /* Assets.xcassets in Resources */,
@ -2147,6 +2162,7 @@
 				D6538945214D6D7500E3CEFC /* TableViewSwipeActionProvider.swift in Sources */,
 				D6F0B17524A3A1AA001E48C3 /* MainSidebarViewController.swift in Sources */,
 				D622757424EDF1CD00B82A16 /* ComposeAttachmentsList.swift in Sources */,
+				D6420AEE26BED18B00ED8175 /* PublicTimelineDescriptionTableViewCell.swift in Sources */,
 				D6E0DC8E216EDF1E00369478 /* Previewing.swift in Sources */,
 				D6BED174212667E900F02DA0 /* TimelineStatusTableViewCell.swift in Sources */,
 				D69693F42585941A00F4E116 /* UIWindowSceneDelegate+Close.swift in Sources */,
--- a/Tusker/Preferences/Preferences.swift
+++ b/Tusker/Preferences/Preferences.swift
@ -67,6 +67,9 @@ class Preferences: Codable, ObservableObject {
        
        self.silentActions = try container.decode([String: Permission].self, forKey: .silentActions)
        self.statusContentType = try container.decode(StatusContentType.self, forKey: .statusContentType)
+        
+        self.hasShownLocalTimelineDescription = try container.decodeIfPresent(Bool.self, forKey: .hasShownLocalTimelineDescription) ?? false
+        self.hasShownFederatedTimelineDescription = try container.decodeIfPresent(Bool.self, forKey: .hasShownFederatedTimelineDescription) ?? false
    }
    
    func encode(to encoder: Encoder) throws {
@ -102,6 +105,9 @@ class Preferences: Codable, ObservableObject {
        
        try container.encode(silentActions, forKey: .silentActions)
        try container.encode(statusContentType, forKey: .statusContentType)
+        
+        try container.encode(hasShownLocalTimelineDescription, forKey: .hasShownLocalTimelineDescription)
+        try container.encode(hasShownFederatedTimelineDescription, forKey: .hasShownFederatedTimelineDescription)
    }
    
    // MARK: Appearance
@ -140,7 +146,11 @@ class Preferences: Codable, ObservableObject {
    // MARK: Advanced
    @Published var silentActions: [String: Permission] = [:]
    @Published var statusContentType: StatusContentType = .plain
-
+    
+    // MARK:
+    @Published var hasShownLocalTimelineDescription = false
+    @Published var hasShownFederatedTimelineDescription = false
+    
    private enum CodingKeys: String, CodingKey {
        case theme
        case avatarStyle
@ -172,6 +182,9 @@ class Preferences: Codable, ObservableObject {
        
        case silentActions
        case statusContentType
+        
+        case hasShownLocalTimelineDescription
+        case hasShownFederatedTimelineDescription
    }
    
 }
--- a/Tusker/Screens/Timeline/TimelineTableViewController.swift
+++ b/Tusker/Screens/Timeline/TimelineTableViewController.swift
@ -20,6 +20,7 @@ class TimelineTableViewController: DiffableTimelineLikeTableViewController<Timel
    private var older: RequestRange?
    
    private var didConfirmLoadMore = false
+    private var isShowingTimelineDescription = false
    
    init(for timeline: Timeline, mastodonController: MastodonController) {
        self.timeline = timeline
@ -58,6 +59,42 @@ class TimelineTableViewController: DiffableTimelineLikeTableViewController<Timel
        
        tableView.register(UINib(nibName: "TimelineStatusTableViewCell", bundle: .main), forCellReuseIdentifier: "statusCell")
        tableView.register(UINib(nibName: "ConfirmLoadMoreTableViewCell", bundle: .main), forCellReuseIdentifier: "confirmLoadMoreCell")
+        tableView.register(UINib(nibName: "PublicTimelineDescriptionTableViewCell", bundle: .main), forCellReuseIdentifier: "publicTimelineDescriptionCell")
+        
+        if case let .public(local: local) = timeline,
+           (local && !Preferences.shared.hasShownLocalTimelineDescription) || (!local && !Preferences.shared.hasShownFederatedTimelineDescription) {
+            isShowingTimelineDescription = true
+            
+            var snapshot = self.dataSource.snapshot()
+            snapshot.appendSections([.header])
+            snapshot.appendItems([.publicTimelineDescription(local: local)], toSection: .header)
+            self.dataSource.apply(snapshot, animatingDifferences: false)
+        }
+        
+    }
+    
+    override func viewDidAppear(_ animated: Bool) {
+        super.viewDidAppear(animated)
+        
+        if case let .public(local: local) = timeline {
+            if local {
+                Preferences.shared.hasShownLocalTimelineDescription = true
+            } else {
+                Preferences.shared.hasShownFederatedTimelineDescription = true
+            }
+        }
+    }
+    
+    override func viewDidDisappear(_ animated: Bool) {
+        super.viewDidDisappear(animated)
+        
+        if isShowingTimelineDescription {
+            isShowingTimelineDescription = false
+            
+            var snapshot = self.dataSource.snapshot()
+            snapshot.deleteSections([.header])
+            self.dataSource.apply(snapshot, animatingDifferences: false)
+        }
    }
    
    // MARK: - DiffableTimelineLikeTableViewController
@ -87,6 +124,17 @@ class TimelineTableViewController: DiffableTimelineLikeTableViewController<Timel
                self.didConfirmLoadMore = false
            }
            return cell
+            
+        case .publicTimelineDescription(local: let local):
+            let cell = tableView.dequeueReusableCell(withIdentifier: "publicTimelineDescriptionCell", for: indexPath) as! PublicTimelineDescriptionTableViewCell
+            cell.mastodonController = mastodonController
+            cell.local = local
+            cell.didDismiss = { [unowned self] in
+                var snapshot = self.dataSource.snapshot()
+                snapshot.deleteSections([.header])
+                self.dataSource.apply(snapshot)
+            }
+            return cell
        }
    }
    
@ -108,10 +156,12 @@ class TimelineTableViewController: DiffableTimelineLikeTableViewController<Timel
                self.older = pagination?.older
                
                self.mastodonController.persistentContainer.addAll(statuses: statuses) {
-                    var snapshot = Snapshot()
-                    snapshot.appendSections([.statuses, .footer])
-                    snapshot.appendItems(statuses.map { .status(id: $0.id, state: .unknown) }, toSection: .statuses)
-                    completion(.success(snapshot))
+                    DispatchQueue.main.async {
+                        var snapshot = self.dataSource.snapshot()
+                        snapshot.appendSections([.statuses, .footer])
+                        snapshot.appendItems(statuses.map { .status(id: $0.id, state: .unknown) }, toSection: .statuses)
+                        completion(.success(snapshot))
+                    }
                }
            }
        }
@ -196,16 +246,33 @@ class TimelineTableViewController: DiffableTimelineLikeTableViewController<Timel
        }
    }
    
+    override func tableView(_ tableView: UITableView, didEndDisplaying cell: UITableViewCell, forRowAt indexPath: IndexPath) {
+        if let item = dataSource.itemIdentifier(for: indexPath),
+           case .publicTimelineDescription(local: _) = item {
+            // trying to remove cells right in didEndDisplaying crashes in UIKit
+            DispatchQueue.main.async {
+                    self.tableView.contentOffset.y -= cell.bounds.height
+                
+                var snapshot = self.dataSource.snapshot()
+                snapshot.deleteItems([item])
+                self.dataSource.apply(snapshot) {
+                }
+            }
+        }
+    }
+    
 }

 extension TimelineTableViewController {
    enum Section: Hashable, CaseIterable {
+        case header
        case statuses
        case footer
    }
    enum Item: Hashable {
        case status(id: String, state: StatusState)
        case confirmLoadMore
+        case publicTimelineDescription(local: Bool)
        
        static func ==(lhs: Item, rhs: Item) -> Bool {
            switch (lhs, rhs) {
@ -213,6 +280,8 @@ extension TimelineTableViewController {
                return a == b
            case (.confirmLoadMore, .confirmLoadMore):
                return true
+            case let (.publicTimelineDescription(local: a), .publicTimelineDescription(local: b)):
+                return a == b
            default:
                return false
            }
@ -225,6 +294,9 @@ extension TimelineTableViewController {
                hasher.combine(id)
            case .confirmLoadMore:
                hasher.combine(1)
+            case let .publicTimelineDescription(local: local):
+                hasher.combine(2)
+                hasher.combine(local)
            }
        }
    }
--- a/Cell/PublicTimelineDescriptionTableViewCell.swift
+++ b/Cell/PublicTimelineDescriptionTableViewCell.swift
@ -0,0 +1,57 @@
+//
+//  PublicTimelineDescriptionTableViewCell.swift
+//  PublicTimelineDescriptionTableViewCell
+//
+//  Created by Shadowfacts on 8/7/21.
+//  Copyright © 2021 Shadowfacts. All rights reserved.
+//
+
+import UIKit
+
+class PublicTimelineDescriptionTableViewCell: UITableViewCell {
+    
+    weak var mastodonController: MastodonController!
+    
+    var local = false {
+        didSet {
+            updateLabel()
+        }
+    }
+    var didDismiss: (() -> Void)?
+
+    @IBOutlet private weak var descriptionLabel: UILabel!
+    
+    override func awakeFromNib() {
+        super.awakeFromNib()
+        
+        if #available(iOS 15.0, *) {
+            contentView.backgroundColor = .tintColor
+        } else {
+            contentView.backgroundColor = .systemBlue
+        }
+    }
+    
+    private func updateLabel() {
+        let str = NSMutableAttributedString()
+        let instanceStr = NSAttributedString(string: mastodonController.instanceURL.host!, attributes: [
+            .font: UIFont(descriptor: .preferredFontDescriptor(withTextStyle: .body).withSymbolicTraits(.traitBold)!, size: 0)
+        ])
+        if local {
+            str.append(NSAttributedString(string: "The local timeline shows public posts from only "))
+            str.append(instanceStr)
+            str.append(NSAttributedString(string: "."))
+        } else {
+            str.append(NSAttributedString(string: "The federated timeline shows public posts from all users that "))
+            str.append(instanceStr)
+            str.append(NSAttributedString(string: " knows about."))
+        }
+        descriptionLabel.attributedText = str
+    }
+
+}
+
+extension PublicTimelineDescriptionTableViewCell: SelectableTableViewCell {
+    func didSelectCell() {
+        didDismiss?()
+    }
+}
--- a/Cell/PublicTimelineDescriptionTableViewCell.xib
+++ b/Cell/PublicTimelineDescriptionTableViewCell.xib
@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.XIB" version="3.0" toolsVersion="19150" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES">
+    <device id="retina6_1" orientation="portrait" appearance="light"/>
+    <dependencies>
+        <deployment identifier="iOS"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="19134"/>
+        <capability name="Safe area layout guides" minToolsVersion="9.0"/>
+        <capability name="System colors in document resources" minToolsVersion="11.0"/>
+        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
+    </dependencies>
+    <objects>
+        <placeholder placeholderIdentifier="IBFilesOwner" id="-1" userLabel="File's Owner"/>
+        <placeholder placeholderIdentifier="IBFirstResponder" id="-2" customClass="UIResponder"/>
+        <tableViewCell contentMode="scaleToFill" selectionStyle="default" indentationWidth="10" rowHeight="78" id="KGk-i7-Jjw" customClass="PublicTimelineDescriptionTableViewCell" customModule="Tusker" customModuleProvider="target">
+            <rect key="frame" x="0.0" y="0.0" width="320" height="78"/>
+            <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/>
+            <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" tableViewCell="KGk-i7-Jjw" id="H2p-sc-9uM">
+                <rect key="frame" x="0.0" y="0.0" width="320" height="78"/>
+                <autoresizingMask key="autoresizingMask"/>
+                <subviews>
+                    <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Label" textAlignment="natural" lineBreakMode="tailTruncation" numberOfLines="0" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="N97-CH-58I">
+                        <rect key="frame" x="16" y="8" width="288" height="62"/>
+                        <fontDescription key="fontDescription" type="system" pointSize="17"/>
+                        <color key="textColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
+                        <nil key="highlightedColor"/>
+                    </label>
+                </subviews>
+                <color key="backgroundColor" systemColor="systemBlueColor"/>
+                <constraints>
+                    <constraint firstAttribute="bottom" secondItem="N97-CH-58I" secondAttribute="bottom" constant="8" id="2Lg-we-j2c"/>
+                    <constraint firstItem="N97-CH-58I" firstAttribute="top" secondItem="H2p-sc-9uM" secondAttribute="top" constant="8" id="FdS-q9-obT"/>
+                    <constraint firstItem="N97-CH-58I" firstAttribute="trailing" secondItem="H2p-sc-9uM" secondAttribute="trailingMargin" id="KqX-Qy-18G"/>
+                    <constraint firstItem="N97-CH-58I" firstAttribute="leading" secondItem="H2p-sc-9uM" secondAttribute="leadingMargin" id="Pqy-8N-OnX"/>
+                </constraints>
+            </tableViewCellContentView>
+            <viewLayoutGuide key="safeArea" id="njF-e1-oar"/>
+            <connections>
+                <outlet property="descriptionLabel" destination="N97-CH-58I" id="z1W-HD-xy9"/>
+            </connections>
+            <point key="canvasLocation" x="131.8840579710145" y="121.875"/>
+        </tableViewCell>
+    </objects>
+    <resources>
+        <systemColor name="systemBlueColor">
+            <color red="0.0" green="0.47843137254901963" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
+        </systemColor>
+    </resources>
+</document>