DocSpace-client/common/ASC.Common/Threading/DistributedTaskQueue.cs

/*
 *
 * (c) Copyright Ascensio System Limited 2010-2018
 *
 * This program is freeware. You can redistribute it and/or modify it under the terms of the GNU 
 * General Public License (GPL) version 3 as published by the Free Software Foundation (https://www.gnu.org/copyleft/gpl.html). 
 * In accordance with Section 7(a) of the GNU GPL its Section 15 shall be amended to the effect that 
 * Ascensio System SIA expressly excludes the warranty of non-infringement of any third-party rights.
 *
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE. For more details, see GNU GPL at https://www.gnu.org/copyleft/gpl.html
 *
 * You can contact Ascensio System SIA by email at sales@onlyoffice.com
 *
 * The interactive user interfaces in modified source and object code versions of ONLYOFFICE must display 
 * Appropriate Legal Notices, as required under Section 5 of the GNU GPL version 3.
 *
 * Pursuant to Section 7 § 3(b) of the GNU GPL you must retain the original ONLYOFFICE logo which contains 
 * relevant author attributions when distributing the software. If the display of the logo in its graphic 
 * form is not reasonably feasible for technical reasons, you must include the words "Powered by ONLYOFFICE" 
 * in every copy of the program you distribute. 
 * Pursuant to Section 7 § 3(e) we decline to grant you any rights under trademark law for use of our trademarks.
 *
*/


using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

using ASC.Common.Caching;

namespace ASC.Common.Threading
{
    [Singletone]
    public class DistributedTaskCacheNotify
    {
        public ConcurrentDictionary<string, CancellationTokenSource> Cancelations { get; }
        public ICache Cache { get; }
        private readonly ICacheNotify<DistributedTaskCancelation> notify;
        private readonly ICacheNotify<DistributedTaskCache> notifyCache;

        public DistributedTaskCacheNotify(
            ICacheNotify<DistributedTaskCancelation> notify, 
            ICacheNotify<DistributedTaskCache> notifyCache,
            ICache cache)
        {
            Cancelations = new ConcurrentDictionary<string, CancellationTokenSource>();

            Cache = cache;

            this.notify = notify;

            notify.Subscribe((c) =>
            {
                if (Cancelations.TryGetValue(c.Id, out var s))
                {
                    s.Cancel();
                }
            }, CacheNotifyAction.Remove);

            this.notifyCache = notifyCache;

            notifyCache.Subscribe((c) =>
            {
                Cache.HashSet(c.Key, c.Id, (DistributedTaskCache)null);
            }, CacheNotifyAction.Remove);

            notifyCache.Subscribe((c) =>
            {
                Cache.HashSet(c.Key, c.Id, c);
            }, CacheNotifyAction.InsertOrUpdate);
        }

        public void CancelTask(string id)
        {
            notify.Publish(new DistributedTaskCancelation() { Id = id }, CacheNotifyAction.Remove);
        }

        public void SetTask(DistributedTask task)
        {
            notifyCache.Publish(task.DistributedTaskCache, CacheNotifyAction.InsertOrUpdate);
        }

        public void RemoveTask(string id, string key)
        {
            notifyCache.Publish(new DistributedTaskCache() { Id = id, Key = key }, CacheNotifyAction.Remove);
        }
    }

    public class DistributedTaskQueue
    {
        public static readonly int InstanceId;

        private readonly string key;
        private readonly ICache cache;
        private readonly TaskScheduler scheduler;
        private readonly ConcurrentDictionary<string, CancellationTokenSource> cancelations;

        private DistributedTaskCacheNotify DistributedTaskCacheNotify { get; }

        static DistributedTaskQueue()
        {
            InstanceId = Process.GetCurrentProcess().Id;
        }


        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="name">Name of queue</param>
        /// <param name="maxThreadsCount">limit of threads count; Default: -1 - no limit</param>
        public DistributedTaskQueue(DistributedTaskCacheNotify distributedTaskCacheNotify, string name, int maxThreadsCount = -1)
        {
            if (string.IsNullOrEmpty(name))
            {
                throw new ArgumentNullException(nameof(name));
            }

            key = name + GetType().Name;
            scheduler = maxThreadsCount <= 0
                ? TaskScheduler.Default
                : new ConcurrentExclusiveSchedulerPair(TaskScheduler.Default, maxThreadsCount).ConcurrentScheduler;
            DistributedTaskCacheNotify = distributedTaskCacheNotify;
            cancelations = DistributedTaskCacheNotify.Cancelations;
            cache = DistributedTaskCacheNotify.Cache;
        }


        public void QueueTask(Action<DistributedTask, CancellationToken> action, DistributedTask distributedTask = null)
        {
            if (distributedTask == null)
            {
                distributedTask = new DistributedTask();
            }

            distributedTask.InstanceId = InstanceId;

            var cancelation = new CancellationTokenSource();
            var token = cancelation.Token;
            cancelations[distributedTask.Id] = cancelation;

            var task = new Task(() => { action(distributedTask, token); }, token, TaskCreationOptions.LongRunning);
            task
                .ConfigureAwait(false)
                .GetAwaiter()
                .OnCompleted(() => OnCompleted(task, distributedTask.Id));

            distributedTask.Status = DistributedTaskStatus.Running;

            if (distributedTask.Publication == null)
            {
                distributedTask.Publication = GetPublication();
            }
            distributedTask.PublishChanges();

            task.Start(scheduler);
        }

        public IEnumerable<DistributedTask> GetTasks()
        {
            var tasks = cache.HashGetAll<DistributedTaskCache>(key).Select(r => new DistributedTask(r.Value)).ToList();
            tasks.ForEach(t =>
            {
                if (t.Publication == null)
                {
                    t.Publication = GetPublication();
                }
            });
            return tasks;
        }

        public DistributedTask GetTask(string id)
        {
            var task = new DistributedTask(cache.HashGet<DistributedTaskCache>(key, id));
            if (task != null && task.Publication == null)
            {
                task.Publication = GetPublication();
            }
            return task;
        }

        public void SetTask(DistributedTask task)
        {
            DistributedTaskCacheNotify.SetTask(task);
        }

        public void RemoveTask(string id)
        {
            DistributedTaskCacheNotify.RemoveTask(id, key);
        }

        public void CancelTask(string id)
        {
            DistributedTaskCacheNotify.CancelTask(id);
        }

        private void OnCompleted(Task task, string id)
        {
            var distributedTask = GetTask(id);
            if (distributedTask != null)
            {
                distributedTask.Status = DistributedTaskStatus.Completed;
                distributedTask.Exception = task.Exception;
                if (task.IsFaulted)
                {
                    distributedTask.Status = DistributedTaskStatus.Failted;
                }
                if (task.IsCanceled)
                {
                    distributedTask.Status = DistributedTaskStatus.Canceled;
                }

                cancelations.TryRemove(id, out _);

                distributedTask.PublishChanges();
            }
        }

        private Action<DistributedTask> GetPublication()
        {
            return (t) =>
            {
                if (t.DistributedTaskCache != null)
                {
                    t.DistributedTaskCache.Key = key;
                }
                DistributedTaskCacheNotify.SetTask(t);
            };
        }
    }
}