Store.cs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708
  1. using System.Collections.Concurrent;
  2. using System.Reflection;
  3. using System.Text.RegularExpressions;
  4. using InABox.Configuration;
  5. using InABox.Core;
  6. using NPOI.OpenXmlFormats.Dml;
  7. using NPOI.POIFS.FileSystem;
  8. namespace InABox.Database
  9. {
  10. public static class UserTrackingCache
  11. {
  12. public static ConcurrentBag<UserTracking> Cache = new();
  13. public static DateTime Date = DateTime.MinValue;
  14. }
  15. // public interface ICacheStore<T>
  16. // {
  17. // void LoadCache();
  18. // T GetCacheItem();
  19. // void UpdateCache();
  20. // }
  21. public class Store<T> : IStore<T> where T : Entity, new()
  22. {
  23. public Type Type => typeof(T);
  24. public bool IsSubStore { get; set; }
  25. public Guid UserGuid { get; set; }
  26. public string UserID { get; set; }
  27. public Platform Platform { get; set; }
  28. public string Version { get; set; }
  29. public IProvider Provider { get; set; }
  30. public Logger Logger { get; set; }
  31. public virtual void Init()
  32. {
  33. }
  34. private Type GetTrackingType(Type type)
  35. {
  36. var attr = type.GetCustomAttribute<UserTrackingAttribute>();
  37. if (attr == null)
  38. return type;
  39. if (!attr.Enabled)
  40. return null;
  41. if (attr.Parent != null)
  42. return GetTrackingType(attr.Parent);
  43. return type;
  44. }
  45. private void UpdateUserTracking(UserTrackingAction action)
  46. {
  47. if (IsSubStore)
  48. return;
  49. if (!DbFactory.IsSupported<UserTracking>())
  50. return;
  51. if (string.IsNullOrWhiteSpace(UserID))
  52. return;
  53. var type = GetTrackingType(typeof(T));
  54. if (type == null)
  55. return;
  56. UpdateUserTracking(type, action);
  57. }
  58. protected void UpdateUserTracking(Type type, UserTrackingAction action)
  59. {
  60. if (UserTrackingCache.Date != DateTime.Today)
  61. {
  62. var tdata = Provider.Query(
  63. new Filter<UserTracking>(x => x.Date).IsEqualTo(DateTime.Today),
  64. new Columns<UserTracking>(ColumnTypeFlags.DefaultVisible | ColumnTypeFlags.IncludeForeignKeys)
  65. );
  66. UserTrackingCache.Cache = new ConcurrentBag<UserTracking>(tdata.Rows.Select(x => x.ToObject<UserTracking>()));
  67. UserTrackingCache.Date = DateTime.Today;
  68. }
  69. var tracking = UserTrackingCache.Cache.FirstOrDefault(x =>
  70. Equals(x.User.ID, UserGuid) && DateTime.Equals(x.Date, DateTime.Today) && string.Equals(x.Type, type.Name));
  71. if (tracking == null)
  72. {
  73. tracking = new UserTracking();
  74. tracking.Date = DateTime.Today;
  75. tracking.Type = type.Name;
  76. tracking.User.ID = UserGuid;
  77. UserTrackingCache.Cache.Add(tracking);
  78. }
  79. tracking.Increment(DateTime.Now, action);
  80. Provider.Save(tracking);
  81. }
  82. public IStore FindSubStore(Type t)
  83. {
  84. var defType = typeof(Store<>).MakeGenericType(t);
  85. var subType = DbFactory.Stores.Where(myType => myType.IsSubclassOf(defType)).FirstOrDefault();
  86. var result = (IStore)Activator.CreateInstance(subType == null ? defType : subType);
  87. result.UserGuid = UserGuid;
  88. result.UserID = UserID;
  89. result.Platform = Platform;
  90. result.Version = Version;
  91. result.IsSubStore = true;
  92. result.Provider = Provider;
  93. result.Logger = Logger;
  94. return result;
  95. }
  96. public IStore<TEntity> FindSubStore<TEntity>() where TEntity : Entity, new()
  97. {
  98. return (FindSubStore(typeof(TEntity)) as Store<TEntity>)!;
  99. }
  100. private Filter<T>? RunScript(ScriptType type, Filter<T>? filter)
  101. {
  102. var scriptname = type.ToString();
  103. var key = string.Format("{0} {1}", typeof(T).EntityName(), scriptname);
  104. if (DbFactory.LoadedScripts.ContainsKey(key))
  105. {
  106. var script = DbFactory.LoadedScripts[key];
  107. Logger.Send(LogType.Information, UserID, string.Format("{0}.{1} Executing..", typeof(T).EntityName(), scriptname));
  108. try
  109. {
  110. script.SetValue("Store", this);
  111. script.SetValue("Filter", filter);
  112. var result = script.Execute();
  113. Logger.Send(LogType.Information, UserID, string.Format("{0}.{1} returns {2}", typeof(T).EntityName(), scriptname, result));
  114. return result ? script.GetValue("Filter") as Filter<T> : filter;
  115. }
  116. catch (Exception eExec)
  117. {
  118. Logger.Send(LogType.Information, UserID,
  119. string.Format("{0}.{1} Invoke Exception: {2}", typeof(T).EntityName(), scriptname, eExec.Message));
  120. }
  121. }
  122. return filter;
  123. }
  124. private IEnumerable<T> RunScript(ScriptType type, IEnumerable<T> entities)
  125. {
  126. var scriptname = type.ToString();
  127. var key = string.Format("{0} {1}", typeof(T).EntityName(), scriptname);
  128. if (DbFactory.LoadedScripts.ContainsKey(key))
  129. {
  130. var variable = typeof(T).EntityName().Split('.').Last() + "s";
  131. var script = DbFactory.LoadedScripts[key];
  132. script.SetValue("Store", this);
  133. script.SetValue(variable, entities);
  134. Logger.Send(LogType.Information, UserID, string.Format("{0}.{1} Executing..", typeof(T).EntityName(), scriptname));
  135. foreach (var entity in entities)
  136. try
  137. {
  138. var result = script.Execute();
  139. Logger.Send(LogType.Information, UserID,
  140. string.Format("{0}.{1} returns {2}: {3}", typeof(T).EntityName(), scriptname, result, entity));
  141. return result ? script.GetValue(variable) as IEnumerable<T> : entities;
  142. }
  143. catch (Exception eExec)
  144. {
  145. var stack = new List<string>();
  146. var eStack = eExec;
  147. while (eStack != null)
  148. {
  149. stack.Add(eStack.Message);
  150. eStack = eStack.InnerException;
  151. }
  152. stack.Reverse();
  153. var message = string.Join("\n", stack);
  154. Logger.Send(LogType.Information, UserID,
  155. string.Format("{0}.{1} Invoke Exception: {2}", typeof(T).EntityName(), scriptname, message));
  156. }
  157. }
  158. return entities;
  159. }
  160. private CoreTable RunScript(ScriptType type, CoreTable table)
  161. {
  162. var scriptname = type.ToString();
  163. var variable = typeof(T).EntityName().Split('.').Last() + "s";
  164. var key = string.Format("{0} {1}", typeof(T).EntityName(), scriptname);
  165. if (DbFactory.LoadedScripts.ContainsKey(key))
  166. {
  167. var script = DbFactory.LoadedScripts[key];
  168. Logger.Send(LogType.Information, UserID, string.Format("{0}.{1} Executing..", typeof(T).EntityName(), scriptname));
  169. try
  170. {
  171. script.SetValue("Store", this);
  172. script.SetValue(variable, table);
  173. var result = script.Execute();
  174. Logger.Send(LogType.Information, UserID,
  175. string.Format("{0}.{1} returns {2}: {3}", typeof(T).EntityName(), scriptname, result, table));
  176. return result ? script.GetValue(variable) as CoreTable : table;
  177. }
  178. catch (Exception eExec)
  179. {
  180. Logger.Send(LogType.Information, UserID,
  181. string.Format("{0}.{1} Invoke Exception: {2}", typeof(T).EntityName(), scriptname, eExec.Message));
  182. }
  183. }
  184. return table;
  185. }
  186. #region Query Functions
  187. protected virtual CoreTable OnQuery(Filter<T>? filter, Columns<T>? columns, SortOrder<T>? sort, CoreRange? range)
  188. {
  189. return Provider.Query(filter, columns, sort, range);
  190. }
  191. private CoreTable DoQuery(Filter<T>? filter = null, Columns<T>? columns = null, SortOrder<T>? sort = null, CoreRange? range = null)
  192. {
  193. UpdateUserTracking(UserTrackingAction.Read);
  194. try
  195. {
  196. var flt = PrepareFilter(filter);
  197. flt = RunScript(ScriptType.BeforeQuery, flt);
  198. var result = OnQuery(filter, columns, sort, range);
  199. AfterQuery(result);
  200. result = RunScript(ScriptType.AfterQuery, result);
  201. return result;
  202. }
  203. catch (Exception e)
  204. {
  205. throw new Exception(e.Message + "\n\n" + e.StackTrace + "\n");
  206. }
  207. }
  208. public CoreTable Query(Filter<T>? filter = null, Columns<T>? columns = null, SortOrder<T>? sort = null, CoreRange? range = null)
  209. {
  210. return DoQuery(filter, columns, sort, range);
  211. }
  212. public CoreTable Query(IFilter? filter = null, IColumns? columns = null, ISortOrder? sort = null, CoreRange? range = null)
  213. {
  214. return DoQuery(filter as Filter<T>, columns as Columns<T>, sort as SortOrder<T>, range);
  215. }
  216. protected virtual void AfterQuery(CoreTable data)
  217. {
  218. }
  219. #endregion
  220. #region Load Functions
  221. protected virtual Filter<T>? PrepareFilter(Filter<T>? filter)
  222. {
  223. return filter;
  224. }
  225. #endregion
  226. #region Saving Functions
  227. private void CheckAutoIncrement(params T[] entities)
  228. {
  229. if (ProcessNumericAutoInc(entities))
  230. return;
  231. ProcessStringAutoIncrement(entities);
  232. }
  233. private bool ProcessStringAutoIncrement(params T[] entities)
  234. {
  235. if (!entities.Any())
  236. return false;
  237. if (entities.First() is IStringAutoIncrement<T> autoinc)
  238. {
  239. var prop = CoreUtils.GetPropertyFromExpression<T, string>(autoinc.AutoIncrementField());
  240. var requiredEntities = entities
  241. .Where(x => (prop.GetValue(x) as string).IsNullOrWhiteSpace() && (x.ID == Guid.Empty || x.HasOriginalValue(prop.Name)))
  242. .ToList();
  243. if (requiredEntities.Count > 0)
  244. {
  245. Filter<T>? filter = autoinc.AutoIncrementFilter() ?? new Filter<T>().All();
  246. var prefix = autoinc.AutoIncrementPrefix() ?? "";
  247. filter = filter.And(new Filter<T>(prop.Name).Regex($"^{prefix}\\d+$"));
  248. var result = Provider.Query<T>(
  249. filter,
  250. Columns.None<T>().Add(prop.Name)
  251. );
  252. var iValues = result.ExtractValues<T,string>(autoinc.AutoIncrementField())
  253. .Select(x=>x.Substring(prefix.Length))
  254. .Where(x=>int.TryParse(x,out int _))
  255. .Select(int.Parse)
  256. .OrderBy(x=>x)
  257. .ToArray();
  258. var maxvalue = iValues.Any() ? iValues.Max() : autoinc.AutoIncrementDefault() - 1;
  259. foreach (var entity in requiredEntities)
  260. {
  261. maxvalue++;
  262. prop.SetValue(entity, prefix + string.Format(autoinc.AutoIncrementFormat(), maxvalue));
  263. }
  264. return true;
  265. }
  266. }
  267. return false;
  268. }
  269. private bool ProcessNumericAutoInc(params T[] entities)
  270. {
  271. if (!entities.Any())
  272. return false;
  273. if (entities.First() is INumericAutoIncrement<T> autoinc)
  274. {
  275. var prop = CoreUtils.GetPropertyFromExpression(autoinc.AutoIncrementField());
  276. var requiredEntities = entities.Where(x =>
  277. {
  278. return object.Equals(prop.GetValue(x), 0) && (x.ID == Guid.Empty || x.HasOriginalValue(prop.Name));
  279. }).ToList();
  280. if (requiredEntities.Count > 0)
  281. {
  282. var row = Provider.Query(
  283. autoinc.AutoIncrementFilter(),
  284. Columns.None<T>().Add(prop.Name),
  285. new SortOrder<T>(prop.Name,SortDirection.Descending),
  286. CoreRange.Database(1)
  287. ).Rows.FirstOrDefault();
  288. int newvalue = row != null ? row.Get<int>(prop.Name) : 0;
  289. foreach (var entity in requiredEntities)
  290. {
  291. newvalue++;
  292. prop.SetValue(entity, newvalue);
  293. }
  294. return true;
  295. }
  296. }
  297. return false;
  298. }
  299. protected virtual void BeforeSave(T entity)
  300. {
  301. if(entity is IPostable)
  302. {
  303. PosterUtils.CheckPostedStatus(new GlobalConfiguration<PostableSettings>(typeof(T).Name, new DbConfigurationProvider<GlobalSettings>(UserID)).Load(), entity);
  304. }
  305. // Check for (a) blank code fields and (b) duplicate codes
  306. // There may be more than one code on an entity (why would you do this?)
  307. // so it's a bit trickier that I would hope
  308. Filter<T> codes = null;
  309. var columns = Columns.None<T>().Add(x => x.ID);
  310. var props = CoreUtils.PropertyList(typeof(T), x => x.GetCustomAttributes<UniqueCodeEditor>().Any(), true);
  311. foreach (var key in props.Keys)
  312. if (entity.HasOriginalValue(key) || entity.ID == Guid.Empty)
  313. {
  314. var code = CoreUtils.GetPropertyValue(entity, key) as string;
  315. if (string.IsNullOrWhiteSpace(code))
  316. throw new NullCodeException(typeof(T), key);
  317. var expr = CoreUtils.GetPropertyExpression<T, object?>(key); //CoreUtils.GetMemberExpression(typeof(T),key)
  318. codes = codes == null ? new Filter<T>(expr).IsEqualTo(code) : codes.Or(expr).IsEqualTo(code);
  319. columns.Add(key);
  320. }
  321. if (codes != null)
  322. {
  323. var filter = new Filter<T>(x => x.ID).IsNotEqualTo(entity.ID);
  324. filter = filter.And(codes);
  325. var others = Provider.Query(filter, columns);
  326. var duplicates = new Dictionary<string, object>();
  327. foreach (var row in others.Rows)
  328. foreach (var key in props.Keys)
  329. {
  330. var eval = CoreUtils.GetPropertyValue(entity, key);
  331. var cval = row.Get<string>(key);
  332. if (Equals(eval, cval))
  333. duplicates[key] = eval;
  334. }
  335. if (duplicates.Any())
  336. throw new DuplicateCodeException(typeof(T), duplicates);
  337. }
  338. }
  339. protected virtual void BeforeSave(IEnumerable<T> entities)
  340. {
  341. foreach(var entity in entities)
  342. {
  343. BeforeSave(entity);
  344. }
  345. }
  346. protected virtual void AfterSave(T entity)
  347. {
  348. }
  349. protected virtual void AfterSave(IEnumerable<T> entities)
  350. {
  351. foreach(var entity in entities)
  352. {
  353. AfterSave(entity);
  354. }
  355. }
  356. protected virtual void OnSave(T entity, ref string auditnote)
  357. {
  358. CheckAutoIncrement(entity);
  359. Provider.Save(entity);
  360. }
  361. private void DoSave(T entity, string auditnote)
  362. {
  363. UpdateUserTracking(UserTrackingAction.Write);
  364. entity = RunScript(ScriptType.BeforeSave, new[] { entity }).First();
  365. // Process any AutoIncrement Fields before we apply the Unique Code test
  366. // Thus, if we have a unique autoincrement, it will be populated prior to validation
  367. CheckAutoIncrement(entity);
  368. BeforeSave(entity);
  369. var changes = entity.ChangedValues();
  370. OnSave(entity, ref auditnote);
  371. if (DbFactory.IsSupported<AuditTrail>())
  372. {
  373. var notes = new List<string>();
  374. if (!string.IsNullOrEmpty(auditnote))
  375. notes.Add(auditnote);
  376. if (!string.IsNullOrEmpty(changes))
  377. notes.Add(changes);
  378. if (notes.Any()) AuditTrail(entity, notes);
  379. }
  380. AfterSave(entity);
  381. entity = RunScript(ScriptType.AfterSave, new[] { entity }).First();
  382. NotifyListeners([entity]);
  383. }
  384. protected void AuditTrail(IEnumerable<Entity> entities, IEnumerable<string> notes)
  385. {
  386. var updates = new List<AuditTrail>();
  387. foreach (var entity in entities)
  388. {
  389. var audit = new AuditTrail
  390. {
  391. EntityID = entity.ID,
  392. Timestamp = DateTime.Now,
  393. User = UserID,
  394. Note = string.Join(": ", notes)
  395. };
  396. updates.Add(audit);
  397. }
  398. Provider.Save(updates);
  399. }
  400. protected void AuditTrail(Entity entity, IEnumerable<string> notes)
  401. {
  402. AuditTrail(new[] { entity }, notes);
  403. }
  404. public void Save(T entity, string auditnote)
  405. {
  406. DoSave(entity, auditnote);
  407. }
  408. public void Save(Entity entity, string auditnote)
  409. {
  410. var ent = (T)entity;
  411. DoSave(ent, auditnote);
  412. }
  413. public void Save(IEnumerable<T> entities, string auditnote)
  414. {
  415. DoSave(entities.AsArray(), auditnote);
  416. }
  417. public void Save(IEnumerable<Entity> entities, string auditnote)
  418. {
  419. DoSave(entities.Select(x => (T)x).ToArray(), auditnote);
  420. }
  421. protected virtual void OnSave(T[] entities, ref string auditnote)
  422. {
  423. CheckAutoIncrement(entities);
  424. Provider.Save(entities);
  425. }
  426. private void DoSave(T[] entities, string auditnote)
  427. {
  428. UpdateUserTracking(UserTrackingAction.Write);
  429. entities = RunScript(ScriptType.BeforeSave, entities).AsArray();
  430. // Process any AutoIncrement Fields before we apply the Unique Code test
  431. // Thus, if we have a unique autoincrement, it will be populated prior to validation
  432. CheckAutoIncrement(entities);
  433. var changes = new Dictionary<T, string>();
  434. foreach (var entity in entities)
  435. {
  436. changes[entity] = entity.ChangedValues();
  437. }
  438. BeforeSave(entities);
  439. OnSave(entities, ref auditnote);
  440. if (DbFactory.IsSupported<AuditTrail>())
  441. {
  442. var audittrails = new List<AuditTrail>();
  443. foreach (var entity in entities)
  444. {
  445. var notes = new List<string>();
  446. if (!string.IsNullOrEmpty(auditnote))
  447. notes.Add(auditnote);
  448. if (changes.TryGetValue(entity, out string? value) && !string.IsNullOrEmpty(value))
  449. notes.Add(value);
  450. if (notes.Count != 0)
  451. {
  452. var audit = new AuditTrail
  453. {
  454. EntityID = entity.ID,
  455. Timestamp = DateTime.Now,
  456. User = UserID,
  457. Note = string.Join(": ", notes)
  458. };
  459. audittrails.Add(audit);
  460. }
  461. }
  462. if (audittrails.Count != 0)
  463. Provider.Save(audittrails);
  464. }
  465. AfterSave(entities);
  466. entities = RunScript(ScriptType.AfterSave, entities).AsArray();
  467. NotifyListeners(entities);
  468. }
  469. private static List<Tuple<Type, Action<Guid[]>>> _listeners = new List<Tuple<Type, Action<Guid[]>>>();
  470. public static void RegisterListener<TType>(Action<Guid[]> listener)
  471. => _listeners.Add(new Tuple<Type, Action<Guid[]>>(typeof(TType), listener));
  472. private void NotifyListeners(IEnumerable<T> items)
  473. {
  474. var ids = items.Select(x => x.ID).ToArray();
  475. foreach (var listener in _listeners.Where(x => x.Item1 == typeof(T)))
  476. listener.Item2(ids);
  477. }
  478. #endregion
  479. #region Delete Functions
  480. protected virtual void BeforeDelete(T entity)
  481. {
  482. }
  483. protected virtual void OnDelete(T entity)
  484. {
  485. Provider.Delete(entity, UserID);
  486. }
  487. protected virtual void OnDelete(IEnumerable<T> entities)
  488. {
  489. Provider.Delete(entities, UserID);
  490. }
  491. private void DoDelete(T entity, string auditnote)
  492. {
  493. UpdateUserTracking(UserTrackingAction.Write);
  494. entity = RunScript(ScriptType.BeforeDelete, new[] { entity }).First();
  495. try
  496. {
  497. BeforeDelete(entity);
  498. try
  499. {
  500. OnDelete(entity);
  501. }
  502. catch (Exception e)
  503. {
  504. Logger.Send(LogType.Error, "", $"Error in DoDelete(T entity, string auditnote):\n{CoreUtils.FormatException(e)}");
  505. }
  506. AfterDelete(entity);
  507. entity = RunScript(ScriptType.AfterDelete, new[] { entity }).First();
  508. NotifyListeners([entity]);
  509. }
  510. catch (Exception e)
  511. {
  512. throw new Exception(e.Message + "\n\n" + e.StackTrace + "\n");
  513. }
  514. }
  515. private void DoDelete(IEnumerable<T> entities, string auditnote)
  516. {
  517. UpdateUserTracking(UserTrackingAction.Write);
  518. entities = RunScript(ScriptType.BeforeDelete, entities);
  519. try
  520. {
  521. foreach (var entity in entities)
  522. BeforeDelete(entity);
  523. try
  524. {
  525. OnDelete(entities);
  526. }
  527. catch (Exception e)
  528. {
  529. Logger.Send(LogType.Error, "", $"Error in DoDelete(IEnumerable<T> entities, string auditnote):\n{CoreUtils.FormatException(e)}");
  530. }
  531. foreach (var entity in entities) AfterDelete(entity);
  532. entities = RunScript(ScriptType.AfterDelete, entities);
  533. NotifyListeners(entities);
  534. }
  535. catch (Exception e)
  536. {
  537. throw new Exception(e.Message + "\n\n" + e.StackTrace + "\n");
  538. }
  539. }
  540. public void Delete(T entity, string auditnote)
  541. {
  542. DoDelete(entity, auditnote);
  543. }
  544. public void Delete(Entity entity, string auditnote)
  545. {
  546. DoDelete((T)entity, auditnote);
  547. }
  548. public void Delete(IEnumerable<T> entities, string auditnote)
  549. {
  550. DoDelete(entities, auditnote);
  551. }
  552. public void Delete(IEnumerable<Entity> entities, string auditnote)
  553. {
  554. var updates = new List<T>();
  555. foreach (var entity in entities)
  556. updates.Add((T)entity);
  557. DoDelete(updates, auditnote);
  558. }
  559. protected virtual void AfterDelete(T entity)
  560. {
  561. }
  562. #endregion
  563. }
  564. }