Store.cs 24 KB

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