delphimvcframework/sources/MVCFramework.Cache.pas

// *************************************************************************** }
//
// Delphi MVC Framework
//
// Copyright (c) 2010-2022 Daniele Teti and the DMVCFramework Team
//
// https://github.com/danieleteti/delphimvcframework
//
// ***************************************************************************
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ***************************************************************************

unit MVCFramework.Cache;

interface

uses
  System.Classes, System.SysUtils, System.Generics.Collections, System.Rtti,
  System.SyncObjs, MVCFramework.Commons, System.DateUtils;

const
  DEFAULT_CACHE_DURATION = OneMinute * 10;

type
  TMVCCacheItem = class
  private
    FCriticalSection: TCriticalSection;
    FValue: TValue;
    FTimeStamp: TDateTime;
    function GetValue: TValue;
    procedure SetValue(const Value: TValue);
  public
    constructor Create;
    destructor Destroy; override;
    property Value: TValue read GetValue write SetValue;
    property TimeStamp: TDateTime read FTimeStamp;
  end;

  TMVCCache = class sealed
  private
    FStorage: TObjectDictionary<string, TMVCCacheItem>;
    FMREW: TMultiReadExclusiveWriteSynchronizer;
  public
    constructor Create;
    destructor Destroy; override;
    function SetValue(const AName: string; const AValue: TValue): TMVCCacheItem;
    function Contains(const AName: string; out AValue: TValue): Boolean;
    function ContainsItem(const AName: string; out AItem: TMVCCacheItem): Boolean;
    function GetValue(const AName: string): TValue;
    function ExecOnItemWithWriteLock(const AName: string; const AAction: TProc<TValue>): Boolean;
  end;

  TMVCCacheSingleton = class
  private
    class var Lock: TObject;
    class var SInstance: TMVCCache;
  protected
    class function GetInstance: TMVCCache; static;
  public
    class property Instance: TMVCCache read GetInstance;
    class constructor Create;
    class destructor Destroy;
  end;

  TMVCThreadedObjectCache<T: class> = class
  private
    fCS: TCriticalSection;
    fItems: TObjectDictionary<String, T>;
  public
    constructor Create;
    destructor Destroy; override;
    function TryGetValue(const Key: String; out Value: T): Boolean;
    procedure Add(const Key: String; const Value: T);
  end;

implementation

uses
  System.Math;

{ TCache }

function TMVCCache.SetValue(const AName: string; const AValue: TValue): TMVCCacheItem;
var
  lCacheItem: TMVCCacheItem;
  Value: TValue;
begin
  Value := AValue;

  FMREW.DoWithWriteLock(
    procedure
    var
      lItem: TMVCCacheItem;
    begin
      if FStorage.TryGetValue(AName, lItem) then
      begin
        lItem.Value := Value;
      end
      else
      begin
        lCacheItem := TMVCCacheItem.Create;
        try
          lCacheItem.Value := Value;
          FStorage.Add(AName, lCacheItem);
        except
          lCacheItem.Free;
          raise;
        end;
      end;
    end);
  Result := lCacheItem;
end;

function TMVCCache.ExecOnItemWithWriteLock(const AName: string; const AAction: TProc<TValue>): Boolean;
var
  lItem: TMVCCacheItem;
begin
  Result := False;
  FMREW.BeginWrite;
  try
    if FStorage.TryGetValue(AName, lItem) then
    begin
      Result := True;
      AAction(lItem.Value);
    end;
  finally
    FMREW.EndWrite;
  end;
end;

function TMVCCache.Contains(const AName: string; out AValue: TValue): Boolean;
var
  lItem: TMVCCacheItem;
begin
  Result := ContainsItem(AName, lItem);
  if Result then
    AValue := lItem.Value;
end;

function TMVCCache.ContainsItem(const AName: string;
out AItem: TMVCCacheItem): Boolean;
var
  lItem: TMVCCacheItem;
  lRes: Boolean;
begin
  FMREW.DoWithReadLock(
    procedure
    begin
      lRes := FStorage.TryGetValue(AName, lItem);
    end);
  Result := lRes;
  if Result then
    AItem := lItem;
end;

constructor TMVCCache.Create;
begin
  inherited Create;
  FStorage := TObjectDictionary<string, TMVCCacheItem>.Create([doOwnsValues]);
  FMREW := TMultiReadExclusiveWriteSynchronizer.Create;
end;

destructor TMVCCache.Destroy;
begin
  FMREW.Free;
  FStorage.Free;
  inherited;
end;

function TMVCCache.GetValue(const AName: string): TValue;
var
  lItem: TMVCCacheItem;
  lResult: TValue;
begin
  Result := TValue.Empty;
  FMREW.DoWithReadLock(
    procedure
    begin
      if FStorage.TryGetValue(AName, lItem) then
      begin
        lResult := lItem.Value;
      end;
    end);
  Result := lResult;
end;

{ TMVCFrameworkCacheItem }

constructor TMVCCacheItem.Create;
begin
  inherited Create;
  FCriticalSection := TCriticalSection.Create;
  FValue := TValue.Empty;
  FTimeStamp := 0;
end;

destructor TMVCCacheItem.Destroy;
begin
  FCriticalSection.Free;
  inherited;
end;

function TMVCCacheItem.GetValue: TValue;
begin
  Result := FValue;
end;

procedure TMVCCacheItem.SetValue(const Value: TValue);
begin
  FValue := Value;
  FTimeStamp := Now;
end;

{ TMVCCacheSingleton }

class constructor TMVCCacheSingleton.Create;
begin
  SInstance := nil;
  Lock := TObject.Create;
end;

class destructor TMVCCacheSingleton.Destroy;
begin
  FreeAndNil(SInstance);
  FreeAndNil(Lock);
end;

class function TMVCCacheSingleton.GetInstance: TMVCCache;
begin
  if not Assigned(SInstance) then
  begin
    TMonitor.Enter(Lock);
    try
      if not Assigned(SInstance) then // doublecheck here
      begin
        SInstance := TMVCCache.Create;
      end;
    finally
      TMonitor.Exit(Lock);
    end;
  end;
  Result := SInstance;
end;

{ TMVCThreadedObjectCache<T> }

procedure TMVCThreadedObjectCache<T>.Add(const Key: String; const Value: T);
begin
  fCS.Enter;
  try
    fItems.Add(Key, Value);
  finally
    fCS.Leave;
  end;
end;

constructor TMVCThreadedObjectCache<T>.Create;
begin
  inherited;
  fCS := TCriticalSection.Create;
  fItems := TObjectDictionary<String, T>.Create([doOwnsValues]);
end;

destructor TMVCThreadedObjectCache<T>.Destroy;
begin
  fItems.Free;
  fCS.Free;
  inherited;
end;

function TMVCThreadedObjectCache<T>.TryGetValue(const Key: String;
  out Value: T): Boolean;
begin
  fCS.Enter;
  try
    Result := fItems.TryGetValue(Key, Value);
  finally
    fCS.Leave;
  end;
end;



end.