ChangesModel.cs 13.5 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
using System;
using System.Collections.Generic;
using System.Linq;
using JetBrains.Annotations;
using Unity.Cloud.Collaborate.Models.Api;
using Unity.Cloud.Collaborate.Models.Structures;
using Unity.Cloud.Collaborate.UserInterface;
using Unity.Cloud.Collaborate.Utilities;
using UnityEngine;
using UnityEngine.Assertions;

namespace Unity.Cloud.Collaborate.Models
{
    internal class ChangesModel : IChangesModel
    {
        protected readonly ISourceControlProvider m_Provider;

        /// <inheritdoc />
        public event Action UpdatedChangeList;

        /// <inheritdoc />
        public event Action OnUpdatedSelectedChanges;

        /// <inheritdoc />
        public event Action<bool> BusyStatusUpdated;

        /// <inheritdoc />
        public event Action StateChanged;

        internal Dictionary<string, IChangeEntryData> entryData;

        internal Dictionary<string, bool> toggledEntries;

        IReadOnlyList<IChangeEntryData> m_Conflicted;

        readonly ChangeEntryData m_AllItem;

        readonly HashSet<string> m_Requests;

        const string k_RequestNewList = "request-new-list";

        /// <inheritdoc />
        public string SavedRevisionSummary { get; set; }

        /// <inheritdoc />
        public string SavedSearchQuery { get; set; }

        /// <inheritdoc />
        public int ToggledCount { get; private set; }

        /// <inheritdoc />
        public int TotalCount { get; private set; }

        /// <inheritdoc />
        public int ConflictedCount => m_Conflicted.Count;

        /// <inheritdoc />
        public bool Conflicted => m_Provider.GetConflictedState();

        /// <inheritdoc />
        public bool Busy => m_Requests.Count != 0;

        public ChangesModel(ISourceControlProvider provider)
        {
            m_Provider = provider;
            m_Requests = new HashSet<string>();
            m_AllItem = new ChangeEntryData { Entry = new ChangeEntry(string.Empty), All = true };
            entryData = new Dictionary<string, IChangeEntryData>();
            m_Conflicted = new List<IChangeEntryData>();
            toggledEntries = new Dictionary<string, bool>();
            SavedSearchQuery = string.Empty;
            SavedRevisionSummary = string.Empty;
        }

        /// <inheritdoc />
        public void OnStart()
        {
            // Setup events.
            m_Provider.UpdatedChangeList += OnUpdatedChangeList;
            m_Provider.UpdatedSelectedChangeList += OnUpdatedSelectedChangesList;
        }

        /// <inheritdoc />
        public void OnStop()
        {
            // Clean up.
            m_Provider.UpdatedChangeList -= OnUpdatedChangeList;
            m_Provider.UpdatedSelectedChangeList -= OnUpdatedSelectedChangesList;
        }

        /// <inheritdoc />
        public void RestoreState(IWindowCache cache)
        {
            // Populate data from cache.
            SavedRevisionSummary = cache.RevisionSummary;
            SavedSearchQuery = cache.ChangesSearchValue;
            toggledEntries = cache.SimpleSelectedItems ?? new Dictionary<string, bool>();

            StateChanged?.Invoke();
        }

        /// <inheritdoc />
        public void SaveState(IWindowCache cache)
        {
            // Save data.
            cache.RevisionSummary = SavedRevisionSummary;
            cache.ChangesSearchValue = SavedSearchQuery;
            cache.SimpleSelectedItems = new SelectedItemsDictionary(toggledEntries);
        }

        /// <summary>
        /// Event handler for when the source control provider receives an updated history list.
        /// </summary>
        void OnUpdatedChangeList()
        {
            // Only one request at a time.
            if (!AddRequest(k_RequestNewList)) return;
            m_Provider.RequestChangeList(OnReceivedChangeList);
        }

        void OnUpdatedSelectedChangesList(IReadOnlyList<string> list)
        {
            ToggleAllEntries(false);
            foreach (var path in list)
            {
                UpdateEntryToggle(path, true);
            }

            OnUpdatedSelectedChanges?.Invoke();
        }

        /// <summary>
        /// Event handler to receive changes from the provider.
        /// </summary>
        /// <param name="list">Change list received.</param>
        void OnReceivedChangeList([CanBeNull] IReadOnlyList<IChangeEntry> list)
        {
            if (list != null)
            {
                UpdateChangeList(list);
                UpdatedChangeList?.Invoke();
            }
            else
            {
                Debug.LogError("Failed to fetch latest change list.");
            }

            RemoveRequest(k_RequestNewList);
        }

        /// <summary>
        /// Convert and cache new list of changes.
        /// </summary>
        /// <param name="list">New list of changes.</param>
        internal virtual void UpdateChangeList([NotNull] IReadOnlyList<IChangeEntry> list)
        {
            TotalCount = list.Count;

            // Create a new set of containers.
            var newEntryData = new Dictionary<string, IChangeEntryData> { [string.Empty] = m_AllItem };
            var newToggledEntries = new Dictionary<string, bool>();
            var conflicted = new List<IChangeEntryData>();

            var all = m_AllItem.Toggled;
            var toggledCount = 0;
            foreach (var entry in list)
            {
                // Transfer toggled state from old lookup into new.
                toggledEntries.TryGetValue(entry.Path, out var toggled);
                toggled = toggled || all || entry.Staged;
                newToggledEntries[entry.Path] = toggled;

                // Create a new data item for the entry.
                var item = new ChangeEntryData { Entry = entry, Toggled = toggled };
                newEntryData.Add(entry.Path, item);

                // Update counts.
                if (toggled)
                {
                    toggledCount++;
                }
                if (entry.Unmerged)
                {
                    conflicted.Add(item);
                }
            }

            // Store the new containers.
            entryData = newEntryData;
            toggledEntries = newToggledEntries;
            ToggledCount = toggledCount;
            m_Conflicted = conflicted;

            UpdateAllItemToggle();
        }

        /// <inheritdoc />
        public virtual bool UpdateEntryToggle(string path, bool toggled)
        {
            var entry = (ChangeEntryData)entryData[path];

            // Toggle all items if needed.
            if (entry.All)
            {
                return ToggleAllEntries(toggled);
            }

            // Update the toggled count.
            if (entry.Toggled && !toggled)
            {
                ToggledCount--;
            }
            else if (!entry.Toggled && toggled)
            {
                ToggledCount++;
            }

            // Store the value in the dictionary and data item.
            toggledEntries[entry.Entry.Path] = toggled;
            entry.Toggled = toggled;

            // Update the "All" option if needed.
            return UpdateAllItemToggle();
        }

        /// <inheritdoc />
        public IReadOnlyList<IChangeEntryData> GetToggledEntries(string query = null)
        {
            // Filter items by search query
            query = StringUtility.TrimAndToLower(query);
            return entryData.Values.Where(e => !e.All && e.Toggled && e.Entry.Path.ToLower().Contains(query)).ToList();
        }

        /// <inheritdoc />
        public IReadOnlyList<IChangeEntryData> GetUntoggledEntries(string query = null)
        {
            // Filter items by search query
            query = StringUtility.TrimAndToLower(query);
            return entryData.Values.Where(e => !e.All && !e.Toggled && e.Entry.Path.ToLower().Contains(query)).ToList();
        }

        /// <inheritdoc />
        public IReadOnlyList<IChangeEntryData> GetAllEntries(string query = null)
        {
            // Filter items by search query
            query = StringUtility.TrimAndToLower(query);
            return entryData.Values.Where(e => e.Entry.Path.ToLower().Contains(query)).ToList();
        }

        /// <inheritdoc />
        public IReadOnlyList<IChangeEntryData> GetConflictedEntries(string query = null)
        {
            // Filter items by search query
            query = StringUtility.TrimAndToLower(query);
            return entryData.Values.Where(e => !e.All && e.Conflicted && e.Entry.Path.ToLower().Contains(query))
                .ToList();
        }

        /// <summary>
        /// Update the state of the "All" entry. If all entries are toggled, then "All" should be toggled too;
        /// otherwise, "All" should be untoggled.
        /// </summary>
        /// <returns>True if the "All" entry was modified.</returns>
        bool UpdateAllItemToggle()
        {
            // Update state of the "All" option
            var allItemToggled = m_AllItem.Toggled;

            if (entryData.Count == 0) return false;

            if (ToggledCount == entryData.Count - 1)
            {
                // If every entry is toggled, then set AllItem as toggled.
                toggledEntries[m_AllItem.Entry.Path] = true;
                m_AllItem.Toggled = true;
                return !allItemToggled;
            }

            // Otherwise, set AllItem as not toggled.
            toggledEntries[m_AllItem.Entry.Path] = false;
            m_AllItem.Toggled = false;
            return allItemToggled;
        }

        /// <summary>
        /// Toggle on or off all entries in the list.
        /// </summary>
        /// <param name="toggled">Whether to toggle off or on.</param>
        /// <returns>True if the list has been modified.</returns>
        bool ToggleAllEntries(bool toggled)
        {
            // Update all values in the dictionary.
            toggledEntries.Keys.ToList().ForEach(x => toggledEntries[x] = toggled);

            // Compute the number of toggled items (excluding the single All).
            if (toggled)
            {
                ToggledCount = entryData.Count - 1;
            }
            else
            {
                ToggledCount = 0;
            }

            // Update all values in the list.
            foreach (var kv in entryData)
            {
                ((ChangeEntryData)kv.Value).Toggled = toggled;
            }

            return true;
        }

        /// <summary>
        /// Add a started request.
        /// </summary>
        /// <param name="requestId">Id of the request to add.</param>
        /// <returns>False if the request already exists.</returns>
        bool AddRequest(string requestId)
        {
            if (m_Requests.Contains(requestId)) return false;
            m_Requests.Add(requestId);
            // Signal background activity if this is the only thing running.
            if (m_Requests.Count == 1)
                BusyStatusUpdated?.Invoke(true);
            return true;
        }

        /// <summary>
        /// Remove a finished request.
        /// </summary>
        /// <param name="requestId">Id of the request to remove.</param>
        void RemoveRequest(string requestId)
        {
            Assert.IsTrue(m_Requests.Contains(requestId), $"Expects request to have first been made for it to have been finished: {requestId}");
            m_Requests.Remove(requestId);
            // Signal no background activity if no requests in progress
            if (m_Requests.Count == 0)
                BusyStatusUpdated?.Invoke(false);
        }

        /// <inheritdoc />
        public void RequestInitialData()
        {
            // Only one request at a time.
            if (!AddRequest(k_RequestNewList)) return;
            m_Provider.RequestChangeList(OnReceivedChangeList);
        }

        /// <inheritdoc />
        public void RequestDiffChanges(string path)
        {
            m_Provider.RequestDiffChanges(path);
        }

        /// <inheritdoc />
        public void RequestDiscard(IChangeEntry entry)
        {
            m_Provider.RequestDiscard(entry);
        }

        /// <inheritdoc />
        public void RequestBulkDiscard(IReadOnlyList<IChangeEntry> entries)
        {
            m_Provider.RequestBulkDiscard(entries);
        }

        /// <inheritdoc />
        public void RequestPublish(string message, IReadOnlyList<IChangeEntry> changes)
        {
            m_Provider.RequestPublish(message, changes);
        }

        /// <inheritdoc />
        public void RequestShowConflictedDifferences(string path)
        {
            m_Provider.RequestShowConflictedDifferences(path);
        }

        /// <inheritdoc />
        public void RequestChooseMerge(string path)
        {
            m_Provider.RequestChooseMerge(path);
        }

        /// <inheritdoc />
        public void RequestChooseMine(string[] paths)
        {
            m_Provider.RequestChooseMine(paths);
        }

        /// <inheritdoc />
        public void RequestChooseRemote(string[] paths)
        {
            m_Provider.RequestChooseRemote(paths);
        }

        /// <summary>
        /// Implementation of IChangeEntryData with each field given a setter so that the data can be updated.
        /// </summary>
        class ChangeEntryData : IChangeEntryData
        {
            /// <inheritdoc />
            public IChangeEntry Entry { get; set; }

            /// <inheritdoc />
            public bool Toggled { get; set; }

            /// <inheritdoc />
            public bool All { get; set; }

            /// <inheritdoc />
            public bool ToggleReadOnly => Entry.Staged;

            /// <inheritdoc />
            public bool Conflicted => Entry.Unmerged;
        }
    }
}