UtilityDashboard.xaml.cs 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel;
  4. using System.Linq;
  5. using System.Reflection;
  6. using System.Windows;
  7. using System.Windows.Controls;
  8. using System.Windows.Media;
  9. using Comal.Classes;
  10. using InABox.Configuration;
  11. using InABox.Core;
  12. using InABox.DynamicGrid;
  13. using InABox.WPF;
  14. using InABox.Wpf;
  15. using InABox.WPF.Themes;
  16. using Microsoft.Xaml.Behaviors.Core;
  17. using Syncfusion.Windows.Tools.Controls;
  18. namespace PRSDesktop
  19. {
  20. public class DashboardFavourite : BaseObject
  21. {
  22. [TextBoxEditor]
  23. [EditorSequence(1)]
  24. public string Name { get; set; }
  25. [CheckBoxEditor]
  26. [EditorSequence(2)]
  27. public bool IsGlobal { get; set; }
  28. [NullEditor]
  29. public string Layout { get; set; }
  30. }
  31. public class GlobalUtilityDashboardSettings : IGlobalConfigurationSettings
  32. {
  33. public List<DashboardFavourite> Favourites { get; set; }
  34. public GlobalUtilityDashboardSettings()
  35. {
  36. Favourites = new();
  37. }
  38. }
  39. public class UtilityDashboardSettings : IUserConfigurationSettings
  40. {
  41. public UtilityDashboardSettings()
  42. {
  43. Dashboards = new Dictionary<string, string>();
  44. Favourites = new();
  45. }
  46. public Dictionary<string, string> Dashboards { get; set; }
  47. public List<DashboardFavourite> Favourites { get; set; }
  48. public int Selected { get; set; }
  49. public bool AutoHide { get; set; }
  50. }
  51. /// <summary>
  52. /// Interaction logic for UtilityDashboard.xaml
  53. /// </summary>
  54. public partial class UtilityDashboard : UserControl, IBasePanel
  55. {
  56. private readonly Dictionary<string, DynamicFormDesignGrid> _dashboards = new();
  57. private readonly Dictionary<DynamicFormDesignGrid, List<ICorePanel>> _panels = new();
  58. private class WidgetDashboardElement
  59. {
  60. public Type DashboardElement { get; set; }
  61. public Type Widget { get; set; }
  62. public Type Group { get; set; }
  63. public Type Properties { get; set; }
  64. public string GroupCaption { get; set; }
  65. public string WidgetCaption { get; set; }
  66. public Type[] SecurityTokens { get; set; }
  67. public WidgetDashboardElement(Type dashboardElement, Type widget, Type group, Type properties, Type[] securityTokens)
  68. {
  69. DashboardElement = dashboardElement;
  70. Widget = widget;
  71. Group = group;
  72. Properties = properties;
  73. SecurityTokens = securityTokens;
  74. GroupCaption = UtilityDashboard.GetCaption(group);
  75. WidgetCaption = UtilityDashboard.GetCaption(widget);
  76. }
  77. }
  78. private static List<WidgetDashboardElement>? _dashboardElements;
  79. private string? CurrentDashboardName => DashboardsTab.SelectedTab?.Header?.ToString();
  80. private DynamicFormDesignGrid? CurrentDashboard => CurrentDashboardName != null ? _dashboards.GetValueOrDefault(CurrentDashboardName) : null;
  81. private UtilityDashboardSettings _settings = new();
  82. public UtilityDashboard()
  83. {
  84. InitializeComponent();
  85. }
  86. public void CreateToolbarButtons(IPanelHost host)
  87. {
  88. }
  89. private void SaveSettings()
  90. {
  91. new UserConfiguration<UtilityDashboardSettings>().Save(_settings);
  92. }
  93. #region Panel Functions & Properties
  94. public event DataModelUpdateEvent? OnUpdateDataModel;
  95. public bool IsReady { get; set; }
  96. public string SectionName => "Utility Dashboard";
  97. public DataModel DataModel(Selection selection)
  98. {
  99. return new EmptyDataModel();
  100. }
  101. public void Setup()
  102. {
  103. _settings = new UserConfiguration<UtilityDashboardSettings>().Load();
  104. if (_settings.Dashboards.Count == 0) _settings.Dashboards["New Dashboard"] = CreateForm("").SaveLayout();
  105. foreach (var key in _settings.Dashboards.Keys)
  106. CreateTab(key);
  107. if (_settings.Selected >= -1 && _settings.Selected < DashboardsTab.Items.Count)
  108. DashboardsTab.SelectedIndex = _settings.Selected;
  109. //DashboardsTab.FullScreenMode = _settings.AutoHide ? FullScreenMode.ControlMode : FullScreenMode.None;
  110. }
  111. public Dictionary<string, object[]> Selected()
  112. {
  113. return new Dictionary<string, object[]>();
  114. }
  115. public void Heartbeat(TimeSpan time)
  116. {
  117. }
  118. public void Refresh()
  119. {
  120. if(CurrentDashboardName is string name)
  121. {
  122. RefreshDashboard(name);
  123. }
  124. }
  125. public void Shutdown(CancelEventArgs? cancel)
  126. {
  127. foreach (var (name, grid) in _dashboards)
  128. {
  129. ShutdownDashboard(name, grid);
  130. }
  131. _panels.Clear();
  132. }
  133. #endregion
  134. #region Favourites
  135. private IEnumerable<DashboardFavourite> GetFavourites()
  136. {
  137. foreach(var favourite in _settings.Favourites)
  138. {
  139. yield return favourite;
  140. }
  141. var global = new GlobalConfiguration<GlobalUtilityDashboardSettings>().Load(false).Favourites;
  142. foreach (var favourite in global)
  143. {
  144. yield return favourite;
  145. }
  146. }
  147. private void ManageFavourites_Click()
  148. {
  149. var favourites = GetFavourites().ToList();
  150. var grid = new DynamicItemsListGrid<DashboardFavourite>() { Items = favourites };
  151. grid.Reconfigure(options =>
  152. {
  153. options.DeleteRows = true;
  154. options.EditRows = true;
  155. options.MultiSelect = true;
  156. });
  157. grid.OnCustomiseEditor += FavouritesGrid_OnCustomiseEditor;
  158. DynamicGridUtils.CreateGridWindow("Manage Favourites", grid).ShowDialog();
  159. _settings.Favourites = favourites.Where(x => !x.IsGlobal).ToList();
  160. SaveSettings();
  161. if (Security.IsAllowed<CanSetGlobalDashboardFavourites>())
  162. {
  163. var config = new GlobalConfiguration<GlobalUtilityDashboardSettings>();
  164. var global = config.Load();
  165. global.Favourites = favourites.Where(x => x.IsGlobal).ToList();
  166. config.Save(global);
  167. }
  168. }
  169. private void FavouritesGrid_OnCustomiseEditor(IDynamicEditorForm sender, DashboardFavourite[]? items, DynamicGridColumn column, BaseEditor editor)
  170. {
  171. if(column.ColumnName == "IsGlobal")
  172. {
  173. editor.Editable = Security.IsAllowed<CanSetGlobalDashboardFavourites>() ? Editable.Enabled : Editable.Disabled;
  174. }
  175. }
  176. private void SaveAsFavourite_Click(string dashboardName)
  177. {
  178. _settings.Favourites.Add(new DashboardFavourite
  179. {
  180. Name = dashboardName,
  181. Layout = _dashboards.GetValueOrDefault(dashboardName)?.Form.SaveLayout() ?? _settings.Dashboards[dashboardName]
  182. });
  183. SaveSettings();
  184. }
  185. private void LoadFavourite_Click(DashboardFavourite favourite)
  186. {
  187. var name = CreateNewTabName(favourite.Name);
  188. _settings.Dashboards[name] = favourite.Layout;
  189. SaveSettings();
  190. var tab = CreateTab(name);
  191. DashboardsTab.SelectedItem = tab;
  192. }
  193. #endregion
  194. #region Tabs
  195. private void Tab_OnContextMenuOpening(object sender, DynamicTabItemContextMenuEventArgs args)
  196. {
  197. var name = (DashboardsTab.SelectedItem as DynamicTabItem)?.Header?.ToString();
  198. if (string.IsNullOrEmpty(name))
  199. return;
  200. DynamicFormDesignGrid grid = _dashboards[name];
  201. var menu = args.Menu;
  202. menu.AddSeparatorIfNeeded();
  203. var isDesigning = grid.Mode != FormMode.Preview;
  204. menu.Items.Add(new MenuItem()
  205. {
  206. Header = isDesigning ? "Close Design Mode" : "Design Mode",
  207. Command = new ActionCommand(() =>
  208. {
  209. if (grid.Mode == FormMode.Designing)
  210. {
  211. grid.Mode = FormMode.Preview;
  212. SaveCurrentDashboard();
  213. DashboardsTab.ChangedCommand.Execute(null);
  214. }
  215. else
  216. {
  217. ShutdownDashboard();
  218. grid.Mode = FormMode.Designing;
  219. }
  220. }),
  221. Icon = new Image() { Source = (isDesigning ? PRSDesktop.Resources.delete : PRSDesktop.Resources.pencil).AsBitmapImage(24, 24) }
  222. });
  223. var index = 0;
  224. var favourites = GetFavourites().ToList();
  225. if (favourites.Any())
  226. {
  227. foreach (var favourite in favourites)
  228. {
  229. menu.AddItem(favourite.Name, null, favourite, LoadFavourite_Click, index: index++);
  230. }
  231. menu.AddSeparatorIfNeeded(index: index++);
  232. menu.AddItem("Manage Favourites", null, ManageFavourites_Click, index: index++);
  233. }
  234. menu.AddItem("Save as Favourite", null, name, SaveAsFavourite_Click, index: index++);
  235. menu.AddSeparator(index: index++);
  236. }
  237. private void Tab_OnCloseTab(object sender, DynamicTabControlEventArgs args)
  238. {
  239. var name = args.TabItem.Header?.ToString();
  240. if (name is null)
  241. return;
  242. _dashboards.Remove(name);
  243. _settings.Dashboards.Remove(name);
  244. if (!_settings.Dashboards.Any())
  245. {
  246. var tab = new DynamicTabItem();
  247. InitializeNewDashboardTab(tab);
  248. DashboardsTab.Items.Add(tab);
  249. }
  250. else
  251. {
  252. DashboardsTab.ChangedCommand.Execute(null);
  253. }
  254. }
  255. private void Tab_OnTabRenamed(object sender, DynamicTabItemRenamedEventArgs args)
  256. {
  257. var oldSettings = _settings.Dashboards[args.OldName];
  258. _settings.Dashboards.Remove(args.OldName);
  259. args.NewName = CreateNewTabName(args.NewName);
  260. if (_dashboards.TryGetValue(args.OldName, out var dashboard))
  261. {
  262. _dashboards.Remove(args.OldName);
  263. _dashboards[args.NewName] = dashboard;
  264. _settings.Dashboards[args.NewName] = dashboard.Form.SaveLayout();
  265. }
  266. else
  267. {
  268. _settings.Dashboards[args.NewName] = oldSettings;
  269. }
  270. }
  271. /// <summary>
  272. /// Setup events on a new tab.
  273. /// </summary>
  274. /// <param name="tab"></param>
  275. private void InitializeTab(DynamicTabItem tab)
  276. {
  277. tab.CanClose = true;
  278. tab.OnCloseTab += Tab_OnCloseTab;
  279. tab.CanRename = true;
  280. tab.OnTabRenamed += Tab_OnTabRenamed;
  281. tab.OnContextMenuOpening += Tab_OnContextMenuOpening;
  282. }
  283. private string CreateNewTabName(string name)
  284. {
  285. var newName = name;
  286. int i = 1;
  287. while (TabNameExists(newName))
  288. {
  289. newName = $"{name} ({i})";
  290. ++i;
  291. }
  292. return newName;
  293. }
  294. private bool TabNameExists(string name)
  295. {
  296. return _settings.Dashboards.ContainsKey(name);
  297. }
  298. /// <summary>
  299. /// Creates a new tab with a given header and adds it to <see cref="DashboardsTab"/>.
  300. /// </summary>
  301. /// <param name="header"></param>
  302. /// <returns></returns>
  303. private DynamicTabItem CreateTab(string header)
  304. {
  305. var tab = new DynamicTabItem() { Header = header };
  306. InitializeTab(tab);
  307. DashboardsTab.Items.Add(tab);
  308. return tab;
  309. }
  310. /// <summary>
  311. /// Creates a new dashboard for a tab, and then initializes the tab.
  312. /// </summary>
  313. /// <param name="tab"></param>
  314. private void InitializeNewDashboardTab(DynamicTabItem tab)
  315. {
  316. var name = CreateNewTabName("New Dashboard");
  317. _settings.Dashboards[name] = CreateForm("").SaveLayout();
  318. DashboardsTab.ChangedCommand.Execute(null);
  319. SaveSettings();
  320. tab.Header = name;
  321. InitializeTab(tab);
  322. }
  323. private void DashboardsTab_OnOnCreateTab(object sender, DynamicTabControlEventArgs args)
  324. {
  325. InitializeNewDashboardTab(args.TabItem);
  326. }
  327. private void DashboardsTab_OnSelectionChanged(object sender, SelectionChangedEventArgs e)
  328. {
  329. if (e.OriginalSource != DashboardsTab)
  330. return;
  331. if (e.AddedItems.Count == 0)
  332. return;
  333. ShutdownDashboard();
  334. if (e.AddedItems[0] is DynamicTabItem tab)
  335. {
  336. var name = (tab.Header as string)!;
  337. if (tab!.Content == null)
  338. tab.Content = CreateDashboard(name, _settings.Dashboards[name]);
  339. else
  340. {
  341. RefreshDashboard(name);
  342. }
  343. if (IsReady)
  344. {
  345. _settings.Selected = tab.TabIndex;
  346. DashboardsTab.ChangedCommand.Execute(null);
  347. }
  348. }
  349. }
  350. private void DashboardsTab_OnOnTabsChanged(object sender, EventArgs args)
  351. {
  352. SaveSettings();
  353. }
  354. #endregion
  355. #region Dashboard & Design
  356. private void SaveDashboard(string name, DynamicFormDesignGrid grid)
  357. {
  358. _settings.Dashboards[name] = grid.Form.SaveLayout();
  359. if (IsReady)
  360. SaveSettings();
  361. }
  362. private void SaveCurrentDashboard()
  363. {
  364. var name = CurrentDashboardName;
  365. if (name == null) return;
  366. var grid = CurrentDashboard;
  367. if (grid == null) return;
  368. SaveDashboard(name, grid);
  369. }
  370. private void ShutdownDashboard(string name, DynamicFormDesignGrid grid)
  371. {
  372. SaveDashboard(name, grid);
  373. var cancel = new CancelEventArgs();
  374. foreach (var panel in _panels[grid])
  375. {
  376. panel.Shutdown(cancel);
  377. if (cancel.Cancel)
  378. {
  379. return;
  380. }
  381. }
  382. _panels[grid].Clear();
  383. }
  384. private void ShutdownDashboard()
  385. {
  386. var name = CurrentDashboardName;
  387. if (name == null) return;
  388. var grid = CurrentDashboard;
  389. if (grid == null) return;
  390. ShutdownDashboard(name, grid);
  391. }
  392. private void RefreshDashboard(string name)
  393. {
  394. if (!_dashboards.ContainsKey(name))
  395. return;
  396. var grid = _dashboards[name];
  397. if (_panels.ContainsKey(grid))
  398. {
  399. foreach (var panel in _panels[grid])
  400. panel.Refresh();
  401. }
  402. }
  403. private FrameworkElement CreateElement<TWidget, TGroup, TProperties>(DynamicFormDesignGrid grid, DFLayoutElement<TProperties> element)
  404. where TWidget : FrameworkElement, IDashboardWidget<TGroup, TProperties>, new()
  405. where TGroup : DashboardWidgetGroup
  406. where TProperties : IConfigurationSettings, IDashboardProperties, new()
  407. {
  408. if (!_panels.ContainsKey(grid))
  409. _panels[grid] = new List<ICorePanel>();
  410. var dashboardName = GetDashboardElements()
  411. .Where(x => x.DashboardElement == element.GetType())
  412. .FirstOrDefault()?.WidgetCaption ?? "Unknown Dashboard";
  413. var container = DashboardContainer.Create<TWidget, TGroup, TProperties>(element, dashboardName);
  414. _panels[grid].Add(container.Panel);
  415. return container;
  416. }
  417. private FrameworkElement OnCreateElement(object sender, DynamicFormCreateElementArgs e)
  418. {
  419. var widgetType = GetVisibleDashboardElements().Where(x => x.DashboardElement == e.Element.GetType()).FirstOrDefault();
  420. if(widgetType == null)
  421. {
  422. var border = new Border
  423. {
  424. BorderBrush = new SolidColorBrush(Colors.Gray),
  425. BorderThickness = new Thickness(0.0),
  426. Margin = new Thickness(0.0),
  427. Background = ThemeManager.WorkspaceBackgroundBrush //new SolidColorBrush(Colors.Silver);
  428. };
  429. return border;
  430. }
  431. var method = typeof(UtilityDashboard)
  432. .GetMethod(nameof(CreateElement), BindingFlags.Instance | BindingFlags.NonPublic)!
  433. .MakeGenericMethod(widgetType.Widget, widgetType.Group, widgetType.Properties);
  434. return (method.Invoke(this, new object[] { sender, e.Element }) as FrameworkElement)!;
  435. }
  436. private static string GetCaption(Type groupType)
  437. {
  438. var caption = groupType.GetCustomAttribute<Caption>();
  439. if(caption != null)
  440. {
  441. return caption.Text;
  442. }
  443. return CoreUtils.Neatify(groupType.Name);
  444. }
  445. private static List<WidgetDashboardElement> GetDashboardElements()
  446. {
  447. if (_dashboardElements == null)
  448. {
  449. _dashboardElements = new();
  450. var types = CoreUtils.Entities.Where(x => x.IsClass && !x.IsGenericType && x.GetInterfaces().Contains(typeof(IDashboardElement)));
  451. foreach (var type in types)
  452. {
  453. var dashboardElementDef = type.GetSuperclassDefinition(typeof(DashboardElement<,,>));
  454. if (dashboardElementDef != null)
  455. {
  456. var dashboard = dashboardElementDef.GenericTypeArguments[0];
  457. var group = dashboardElementDef.GenericTypeArguments[1];
  458. var properties = dashboardElementDef.GenericTypeArguments[2];
  459. var requires = dashboard.GetInterfaces(typeof(IRequiresSecurity<>)).Select(x => x.GenericTypeArguments[0]);
  460. _dashboardElements.Add(new(type, dashboard, group, properties, requires.ToArray()));
  461. }
  462. }
  463. }
  464. return _dashboardElements;
  465. }
  466. private static IEnumerable<WidgetDashboardElement> GetVisibleDashboardElements()
  467. {
  468. return GetDashboardElements().Where(x =>
  469. {
  470. foreach (var require in x.SecurityTokens)
  471. {
  472. if (!Security.IsAllowed(require))
  473. return false;
  474. }
  475. return true;
  476. });
  477. }
  478. private Border CreateDashboard(string name, string layout)
  479. {
  480. var form = CreateForm(layout);
  481. var grid = new DynamicFormDesignGrid();
  482. foreach(var widget in GetVisibleDashboardElements())
  483. {
  484. grid.AddElement(widget.DashboardElement, widget.WidgetCaption, widget.GroupCaption, true);
  485. }
  486. grid.ShowBorders = false;
  487. grid.OnCreateElement += OnCreateElement;
  488. grid.OnAfterDesign += OnAfterDesign;
  489. grid.OnAfterRender += OnAfterRender;
  490. grid.Mode = FormMode.Preview;
  491. var border = new Border
  492. {
  493. BorderBrush = new SolidColorBrush(Colors.Silver),
  494. BorderThickness = new Thickness(0.75),
  495. Child = grid // scroll;
  496. };
  497. _dashboards[name] = grid;
  498. _panels[grid] = new List<ICorePanel>();
  499. grid.Form = form;
  500. grid.Initialize();
  501. return border;
  502. }
  503. private void OnAfterRender(DynamicFormDesignGrid sender)
  504. {
  505. if (!sender.IsDesigning)
  506. {
  507. if (_panels.TryGetValue(sender, out var panels))
  508. {
  509. foreach (var panel in panels)
  510. panel.Refresh();
  511. }
  512. }
  513. }
  514. private static DFLayout CreateForm(string layout)
  515. {
  516. var form = new DFLayout();
  517. if (string.IsNullOrWhiteSpace(layout))
  518. {
  519. form.ColumnWidths.Add("*");
  520. form.ColumnWidths.Add("*");
  521. form.ColumnWidths.Add("*");
  522. form.RowHeights.Add("*");
  523. form.RowHeights.Add("*");
  524. form.RowHeights.Add("*");
  525. }
  526. else
  527. {
  528. form.LoadLayout(layout);
  529. }
  530. return form;
  531. }
  532. private void OnAfterDesign(object sender)
  533. {
  534. SaveCurrentDashboard();
  535. if(CurrentDashboardName is string name) // Null-check
  536. {
  537. RefreshDashboard(name);
  538. }
  539. }
  540. #endregion
  541. }
  542. }