Settings.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. /**
  2. * Copyright (c) 2006-2017, JGraph Ltd
  3. * Copyright (c) 2006-2017, Gaudenz Alder
  4. */
  5. /**
  6. * Contains current settings.
  7. */
  8. var mxSettings =
  9. {
  10. /**
  11. * Defines current version of settings.
  12. */
  13. currentVersion: 18,
  14. defaultFormatWidth: (screen.width < 600) ? '0' : '240',
  15. // NOTE: Hardcoded in index.html due to timing of JS loading
  16. key: Editor.settingsKey,
  17. getLanguage: function()
  18. {
  19. return mxSettings.settings.language;
  20. },
  21. setLanguage: function(lang)
  22. {
  23. mxSettings.settings.language = lang;
  24. },
  25. isMainSettings: function()
  26. {
  27. return mxSettings.key == '.drawio-config';
  28. },
  29. getMainSettings: function()
  30. {
  31. var value = localStorage.getItem('.drawio-config');
  32. if (value == null)
  33. {
  34. value = mxSettings.getDefaults();
  35. delete value.isNew;
  36. }
  37. else
  38. {
  39. value = JSON.parse(value);
  40. value.version = mxSettings.currentVersion;
  41. }
  42. return value;
  43. },
  44. getUi: function()
  45. {
  46. return (mxSettings.isMainSettings()) ? mxSettings.settings.ui :
  47. mxSettings.getMainSettings().ui;
  48. },
  49. setUi: function(ui)
  50. {
  51. if (mxSettings.isMainSettings())
  52. {
  53. mxSettings.settings.ui = ui;
  54. if (!Editor.enableCssDarkMode && (ui == 'kennedy' || ui == ''))
  55. {
  56. mxSettings.settings.darkMode = false;
  57. }
  58. mxSettings.save();
  59. }
  60. else
  61. {
  62. var value = mxSettings.getMainSettings();
  63. value.ui = ui;
  64. if (!Editor.enableCssDarkMode && ui == 'kennedy')
  65. {
  66. value.darkMode = false;
  67. }
  68. localStorage.setItem('.drawio-config', JSON.stringify(value));
  69. }
  70. },
  71. getShowStartScreen: function()
  72. {
  73. return mxSettings.settings.showStartScreen;
  74. },
  75. setShowStartScreen: function(showStartScreen)
  76. {
  77. mxSettings.settings.showStartScreen = showStartScreen;
  78. },
  79. getGridColor: function(darkMode)
  80. {
  81. return (darkMode) ? mxSettings.settings.darkGridColor : mxSettings.settings.gridColor;
  82. },
  83. setGridColor: function(gridColor, darkMode)
  84. {
  85. if (darkMode)
  86. {
  87. mxSettings.settings.darkGridColor = gridColor;
  88. }
  89. else
  90. {
  91. mxSettings.settings.gridColor = gridColor;
  92. }
  93. },
  94. getAutosave: function()
  95. {
  96. return mxSettings.settings.autosave;
  97. },
  98. setAutosave: function(autosave)
  99. {
  100. mxSettings.settings.autosave = autosave;
  101. },
  102. getResizeImages: function()
  103. {
  104. return mxSettings.settings.resizeImages;
  105. },
  106. setResizeImages: function(resizeImages)
  107. {
  108. mxSettings.settings.resizeImages = resizeImages;
  109. },
  110. getOpenCounter: function()
  111. {
  112. return mxSettings.settings.openCounter;
  113. },
  114. setOpenCounter: function(openCounter)
  115. {
  116. mxSettings.settings.openCounter = openCounter;
  117. },
  118. setCustomFonts: function(fonts)
  119. {
  120. mxSettings.settings.customFonts = fonts;
  121. },
  122. getCustomFonts: function()
  123. {
  124. //Convert from old format to the new one
  125. var custFonts = mxSettings.settings.customFonts || [];
  126. for (var i = 0 ; i < custFonts.length; i++)
  127. {
  128. if (typeof custFonts[i] === 'string')
  129. {
  130. custFonts[i] = {name: custFonts[i], url: null};
  131. }
  132. }
  133. return custFonts;
  134. },
  135. getLibraries: function()
  136. {
  137. return mxSettings.settings.libraries;
  138. },
  139. setLibraries: function(libs)
  140. {
  141. mxSettings.settings.libraries = libs;
  142. },
  143. addCustomLibrary: function(id)
  144. {
  145. // Makes sure to update the latest data from the localStorage
  146. mxSettings.load();
  147. //If the setting is incorrect, reset it to an empty array
  148. if (!Array.isArray(mxSettings.settings.customLibraries))
  149. {
  150. mxSettings.settings.customLibraries = [];
  151. }
  152. if (mxUtils.indexOf(mxSettings.settings.customLibraries, id) < 0)
  153. {
  154. // Makes sure scratchpad is below search in sidebar
  155. if (id === 'L.scratchpad')
  156. {
  157. mxSettings.settings.customLibraries.splice(0, 0, id);
  158. }
  159. else
  160. {
  161. mxSettings.settings.customLibraries.push(id);
  162. }
  163. }
  164. mxSettings.save();
  165. },
  166. removeCustomLibrary: function(id)
  167. {
  168. // Makes sure to update the latest data from the localStorage
  169. mxSettings.load();
  170. mxUtils.remove(id, mxSettings.settings.customLibraries);
  171. mxSettings.save();
  172. },
  173. getCustomLibraries: function()
  174. {
  175. return mxSettings.settings.customLibraries;
  176. },
  177. getPlugins: function()
  178. {
  179. return mxSettings.settings.plugins;
  180. },
  181. setPlugins: function(plugins)
  182. {
  183. mxSettings.settings.plugins = plugins;
  184. },
  185. getRecentColors: function()
  186. {
  187. return mxSettings.settings.recentColors;
  188. },
  189. setRecentColors: function(recentColors)
  190. {
  191. mxSettings.settings.recentColors = recentColors;
  192. },
  193. getFormatWidth: function()
  194. {
  195. return parseInt(mxSettings.settings.formatWidth);
  196. },
  197. setFormatWidth: function(formatWidth)
  198. {
  199. mxSettings.settings.formatWidth = formatWidth;
  200. },
  201. isCreateTarget: function()
  202. {
  203. return mxSettings.settings.createTarget;
  204. },
  205. setCreateTarget: function(value)
  206. {
  207. mxSettings.settings.createTarget = value;
  208. },
  209. getPageFormat: function()
  210. {
  211. return mxSettings.settings.pageFormat;
  212. },
  213. setPageFormat: function(value)
  214. {
  215. mxSettings.settings.pageFormat = value;
  216. },
  217. getUnit: function()
  218. {
  219. return mxSettings.settings.unit || mxConstants.POINTS;
  220. },
  221. setUnit: function(value)
  222. {
  223. mxSettings.settings.unit = value;
  224. },
  225. isRulerOn: function()
  226. {
  227. return mxSettings.settings.isRulerOn;
  228. },
  229. setRulerOn: function(value)
  230. {
  231. mxSettings.settings.isRulerOn = value;
  232. },
  233. getDraftSaveDelay: function()
  234. {
  235. return mxSettings.settings.draftSaveDelay;
  236. },
  237. setDraftSaveDelay: function(value)
  238. {
  239. mxSettings.settings.draftSaveDelay = value;
  240. },
  241. getDefaults: function()
  242. {
  243. return {
  244. language: '',
  245. configVersion: Editor.configVersion,
  246. customFonts: [],
  247. libraries: Sidebar.prototype.defaultEntries,
  248. customLibraries: Editor.defaultCustomLibraries,
  249. plugins: [],
  250. recentColors: [],
  251. formatWidth: mxSettings.defaultFormatWidth,
  252. createTarget: urlParams['sketch'] == '1',
  253. pageFormat: mxGraph.prototype.pageFormat,
  254. search: true,
  255. showStartScreen: true,
  256. gridColor: mxGraphView.prototype.defaultGridColor,
  257. darkGridColor: mxGraphView.prototype.defaultDarkGridColor,
  258. autosave: !EditorUi.isElectronApp,
  259. resizeImages: null,
  260. openCounter: 0,
  261. version: mxSettings.currentVersion,
  262. // Only defined and true for new settings which haven't been saved
  263. isNew: true,
  264. unit: mxConstants.POINTS,
  265. isRulerOn: false
  266. };
  267. },
  268. init: function()
  269. {
  270. mxSettings.settings = mxSettings.getDefaults();
  271. },
  272. save: function()
  273. {
  274. if (isLocalStorage && typeof(JSON) !== 'undefined')
  275. {
  276. try
  277. {
  278. delete mxSettings.settings.isNew;
  279. mxSettings.settings.version = mxSettings.currentVersion;
  280. localStorage.setItem(mxSettings.key, JSON.stringify(mxSettings.settings));
  281. }
  282. catch (e)
  283. {
  284. // ignores quota exceeded
  285. }
  286. }
  287. },
  288. load: function()
  289. {
  290. try
  291. {
  292. if (isLocalStorage && typeof(JSON) !== 'undefined')
  293. {
  294. mxSettings.parse(localStorage.getItem(mxSettings.key));
  295. }
  296. }
  297. catch (e)
  298. {
  299. if (window.console != null)
  300. {
  301. console.log('Error loading settings:', mxSettings.key, e);
  302. }
  303. }
  304. if (mxSettings.settings == null)
  305. {
  306. mxSettings.init();
  307. }
  308. },
  309. parse: function(value)
  310. {
  311. var config = (value != null) ? JSON.parse(value) : null;
  312. if (config == null || (config.configVersion != Editor.configVersion) ||
  313. (Editor.config != null && Editor.config.override))
  314. {
  315. mxSettings.settings = null;
  316. mxSettings.init();
  317. }
  318. else
  319. {
  320. mxSettings.settings = config;
  321. if (mxSettings.settings.plugins == null)
  322. {
  323. mxSettings.settings.plugins = [];
  324. }
  325. if (mxSettings.settings.recentColors == null)
  326. {
  327. mxSettings.settings.recentColors = [];
  328. }
  329. if (mxSettings.settings.customFonts == null)
  330. {
  331. mxSettings.settings.customFonts = [];
  332. }
  333. if (mxSettings.settings.libraries == null)
  334. {
  335. mxSettings.settings.libraries = Sidebar.prototype.defaultEntries;
  336. }
  337. if (mxSettings.settings.customLibraries == null)
  338. {
  339. mxSettings.settings.customLibraries = Editor.defaultCustomLibraries;
  340. }
  341. if (mxSettings.settings.ui == null)
  342. {
  343. mxSettings.settings.ui = '';
  344. }
  345. if (mxSettings.settings.formatWidth == null)
  346. {
  347. mxSettings.settings.formatWidth = mxSettings.defaultFormatWidth;
  348. }
  349. if (mxSettings.settings.lastAlert != null)
  350. {
  351. delete mxSettings.settings.lastAlert;
  352. }
  353. if (mxSettings.settings.createTarget == null)
  354. {
  355. mxSettings.settings.createTarget = false;
  356. }
  357. if (mxSettings.settings.pageFormat == null)
  358. {
  359. mxSettings.settings.pageFormat = mxGraph.prototype.pageFormat;
  360. }
  361. if (mxSettings.settings.search == null)
  362. {
  363. mxSettings.settings.search = true;
  364. }
  365. if (mxSettings.settings.showStartScreen == null)
  366. {
  367. mxSettings.settings.showStartScreen = true;
  368. }
  369. if (mxSettings.settings.gridColor == null)
  370. {
  371. mxSettings.settings.gridColor = mxGraphView.prototype.defaultGridColor;
  372. }
  373. if (mxSettings.settings.darkGridColor == null)
  374. {
  375. mxSettings.settings.darkGridColor = mxGraphView.prototype.defaultDarkGridColor;
  376. }
  377. if (mxSettings.settings.autosave == null)
  378. {
  379. mxSettings.settings.autosave = !EditorUi.isElectronApp;
  380. }
  381. else if (EditorUi.isElectronApp && localStorage.getItem('._autoSaveTrans_') == null) //Transition to no autosave
  382. {
  383. localStorage.setItem('._autoSaveTrans_', '1');
  384. mxSettings.settings.autosave = false;
  385. mxSettings.save();
  386. }
  387. if (mxSettings.settings.scratchpadSeen != null)
  388. {
  389. delete mxSettings.settings.scratchpadSeen;
  390. }
  391. }
  392. },
  393. clear: function()
  394. {
  395. if (isLocalStorage)
  396. {
  397. localStorage.removeItem(mxSettings.key);
  398. }
  399. }
  400. }
  401. /**
  402. * Variable: mxLoadSettings
  403. *
  404. * Optional global config variable to toggle loading the settings. Default is true.
  405. *
  406. * (code)
  407. * <script type="text/javascript">
  408. * var mxLoadSettings = false;
  409. * </script>
  410. * (end)
  411. */
  412. if (typeof(mxLoadSettings) == 'undefined' || mxLoadSettings)
  413. {
  414. // Loads initial content
  415. mxSettings.load();
  416. }