OpenTween/ImageCache.cs

   1 // OpenTween - Client of Twitter
   2 // Copyright (c) 2013 kim_upsilon (@kim_upsilon) <https://upsilo.net/~upsilon/>
   3 // All rights reserved.
   4 //
   5 // This file is part of OpenTween.
   6 //
   7 // This program is free software; you can redistribute it and/or modify it
   8 // under the terms of the GNU General Public License as published by the Free
   9 // Software Foundation; either version 3 of the License, or (at your option)
  10 // any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  15 // for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with this program. If not, see <http://www.gnu.org/licenses/>, or write to
  19 // the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
  20 // Boston, MA 02110-1301, USA.
  21
  22 using System;
  23 using System.Collections.Generic;
  24 using System.Linq;
  25 using System.Text;
  26 using System.Threading.Tasks;
  27 using System.Net;
  28 using System.Threading;
  29 using System.Xml.Serialization;
  30 using System.Net.Http;
  31 using OpenTween.Connection;
  32
  33 namespace OpenTween
  34 {
  35     public class ImageCache : IDisposable
  36     {
  37         /// <summary>
  38         /// キャッシュとして URL と取得した画像を対に保持する辞書
  39         /// </summary>
  40         internal LRUCacheDictionary<string, Task<MemoryImage>> innerDictionary;
  41
  42         /// <summary>
  43         /// 非同期タスクをキャンセルするためのトークンのもと
  44         /// </summary>
  45         private CancellationTokenSource cancelTokenSource;
  46
  47         /// <summary>
  48         /// innerDictionary の排他制御のためのロックオブジェクト
  49         /// </summary>
  50         private object lockObject = new object();
  51
  52         /// <summary>
  53         /// オブジェクトが破棄された否か
  54         /// </summary>
  55         private bool disposed = false;
  56
  57         public ImageCache()
  58         {
  59             this.innerDictionary = new LRUCacheDictionary<string, Task<MemoryImage>>(trimLimit: 300, autoTrimCount: 100);
  60             this.innerDictionary.CacheRemoved += (s, e) => {
  61                 // まだ参照されている場合もあるのでDisposeはファイナライザ任せ
  62                 this.CacheRemoveCount++;
  63             };
  64
  65             this.cancelTokenSource = new CancellationTokenSource();
  66         }
  67
  68         /// <summary>
  69         /// 保持しているキャッシュの件数
  70         /// </summary>
  71         public long CacheCount
  72         {
  73             get { return this.innerDictionary.Count; }
  74         }
  75
  76         /// <summary>
  77         /// 破棄されたキャッシュの件数
  78         /// </summary>
  79         public int CacheRemoveCount { get; private set; }
  80
  81         /// <summary>
  82         /// 指定された URL にある画像を非同期に取得するメソッド
  83         /// </summary>
  84         /// <param name="address">取得先の URL</param>
  85         /// <param name="force">キャッシュを使用せずに取得する場合は true</param>
  86         /// <returns>非同期に画像を取得するタスク</returns>
  87         public Task<MemoryImage> DownloadImageAsync(string address, bool force = false)
  88         {
  89             var cancelToken = this.cancelTokenSource.Token;
  90
  91             return Task.Run(() =>
  92             {
  93                 lock (this.lockObject)
  94                 {
  95                     innerDictionary.TryGetValue(address, out var cachedImageTask);
  96
  97                     if (cachedImageTask != null)
  98                     {
  99                         if (force)
 100                         {
 101                             this.innerDictionary.Remove(address);
 102                             cachedImageTask = null;
 103                         }
 104                         else
 105                             return cachedImageTask;
 106                     }
 107
 108                     cancelToken.ThrowIfCancellationRequested();
 109
 110                     var imageTask = this.FetchImageAsync(address, cancelToken);
 111                     this.innerDictionary[address] = imageTask;
 112
 113                     return imageTask;
 114                 }
 115             }, cancelToken);
 116         }
 117
 118         private async Task<MemoryImage> FetchImageAsync(string uri, CancellationToken cancelToken)
 119         {
 120             using (var response = await Networking.Http.GetAsync(uri, cancelToken).ConfigureAwait(false))
 121             {
 122                 response.EnsureSuccessStatusCode();
 123
 124                 using (var imageStream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false))
 125                 {
 126                     return await MemoryImage.CopyFromStreamAsync(imageStream)
 127                         .ConfigureAwait(false);
 128                 }
 129             }
 130         }
 131
 132         public MemoryImage TryGetFromCache(string address)
 133         {
 134             lock (this.lockObject)
 135             {
 136                 if (!this.innerDictionary.TryGetValue(address, out var imageTask) ||
 137                     imageTask.Status != TaskStatus.RanToCompletion)
 138                     return null;
 139
 140                 return imageTask.Result;
 141             }
 142         }
 143
 144         public void CancelAsync()
 145         {
 146             lock (this.lockObject)
 147             {
 148                 var oldTokenSource = this.cancelTokenSource;
 149                 this.cancelTokenSource = new CancellationTokenSource();
 150
 151                 oldTokenSource.Cancel();
 152                 oldTokenSource.Dispose();
 153             }
 154         }
 155
 156         protected virtual void Dispose(bool disposing)
 157         {
 158             if (this.disposed) return;
 159
 160             if (disposing)
 161             {
 162                 this.CancelAsync();
 163
 164                 lock (this.lockObject)
 165                 {
 166                     foreach (var (_, task) in this.innerDictionary)
 167                     {
 168                         if (task.Status == TaskStatus.RanToCompletion)
 169                             task.Result?.Dispose();
 170                     }
 171
 172                     this.innerDictionary.Clear();
 173                     this.cancelTokenSource.Dispose();
 174                 }
 175             }
 176
 177             this.disposed = true;
 178         }
 179
 180         public void Dispose()
 181         {
 182             this.Dispose(true);
 183             GC.SuppressFinalize(this);
 184         }
 185
 186         ~ImageCache()
 187             => this.Dispose(false);
 188     }
 189 }