You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

parameters.cxx 27KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845
  1. /* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
  2. * Copyright 2011 Pierre Ossman <ossman@cendio.se> for Cendio AB
  3. * Copyright 2012 Samuel Mannehed <samuel@cendio.se> for Cendio AB
  4. *
  5. * This is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This software is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this software; if not, write to the Free Software
  17. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  18. * USA.
  19. */
  20. #ifdef HAVE_CONFIG_H
  21. #include <config.h>
  22. #endif
  23. #ifdef HAVE_GNUTLS
  24. #include <rfb/CSecurityTLS.h>
  25. #endif
  26. #ifdef _WIN32
  27. #include <windows.h>
  28. #include <tchar.h>
  29. #endif
  30. #include "parameters.h"
  31. #include <os/os.h>
  32. #include <rfb/Exception.h>
  33. #include <rfb/LogWriter.h>
  34. #include <rfb/SecurityClient.h>
  35. #include <FL/fl_utf8.h>
  36. #include <stdio.h>
  37. #include <string.h>
  38. #include <limits.h>
  39. #include <errno.h>
  40. #include <assert.h>
  41. #include "i18n.h"
  42. using namespace rfb;
  43. using namespace std;
  44. static LogWriter vlog("Parameters");
  45. IntParameter pointerEventInterval("PointerEventInterval",
  46. "Time in milliseconds to rate-limit"
  47. " successive pointer events", 17);
  48. BoolParameter emulateMiddleButton("EmulateMiddleButton",
  49. "Emulate middle mouse button by pressing "
  50. "left and right mouse buttons simultaneously",
  51. false);
  52. BoolParameter dotWhenNoCursor("DotWhenNoCursor",
  53. "Show the dot cursor when the server sends an "
  54. "invisible cursor", false);
  55. BoolParameter alertOnFatalError("AlertOnFatalError",
  56. "Give a dialog on connection problems rather "
  57. "than exiting immediately", true);
  58. BoolParameter reconnectOnError("ReconnectOnError",
  59. "Give a dialog on connection problems rather "
  60. "than exiting immediately and ask for a reconnect.", true);
  61. StringParameter passwordFile("PasswordFile",
  62. "Password file for VNC authentication", "");
  63. AliasParameter passwd("passwd", "Alias for PasswordFile", &passwordFile);
  64. BoolParameter autoSelect("AutoSelect",
  65. "Auto select pixel format and encoding. "
  66. "Default if PreferredEncoding and FullColor are not specified.",
  67. true);
  68. BoolParameter fullColour("FullColor",
  69. "Use full color", true);
  70. AliasParameter fullColourAlias("FullColour", "Alias for FullColor", &fullColour);
  71. IntParameter lowColourLevel("LowColorLevel",
  72. "Color level to use on slow connections. "
  73. "0 = Very Low, 1 = Low, 2 = Medium", 2);
  74. AliasParameter lowColourLevelAlias("LowColourLevel", "Alias for LowColorLevel", &lowColourLevel);
  75. StringParameter preferredEncoding("PreferredEncoding",
  76. "Preferred encoding to use (Tight, ZRLE, Hextile or"
  77. " Raw)", "Tight");
  78. BoolParameter customCompressLevel("CustomCompressLevel",
  79. "Use custom compression level. "
  80. "Default if CompressLevel is specified.", false);
  81. IntParameter compressLevel("CompressLevel",
  82. "Use specified compression level 0 = Low, 9 = High",
  83. 2);
  84. BoolParameter noJpeg("NoJPEG",
  85. "Disable lossy JPEG compression in Tight encoding.",
  86. false);
  87. IntParameter qualityLevel("QualityLevel",
  88. "JPEG quality level. 0 = Low, 9 = High",
  89. 8);
  90. BoolParameter maximize("Maximize", "Maximize viewer window", false);
  91. BoolParameter fullScreen("FullScreen", "Enable full screen", false);
  92. StringParameter fullScreenMode("FullScreenMode", "Specify which monitors to use when in full screen. "
  93. "Should be either Current, Selected or All",
  94. "Current");
  95. BoolParameter fullScreenAllMonitors("FullScreenAllMonitors",
  96. "[DEPRECATED] Enable full screen over all monitors",
  97. false);
  98. MonitorIndicesParameter fullScreenSelectedMonitors("FullScreenSelectedMonitors",
  99. "Use the given list of monitors in full screen"
  100. " when -FullScreenMode=Selected.",
  101. "1");
  102. StringParameter desktopSize("DesktopSize",
  103. "Reconfigure desktop size on the server on "
  104. "connect (if possible)", "");
  105. StringParameter geometry("geometry",
  106. "Specify size and position of viewer window", "");
  107. BoolParameter listenMode("listen", "Listen for connections from VNC servers", false);
  108. BoolParameter remoteResize("RemoteResize",
  109. "Dynamically resize the remote desktop size as "
  110. "the size of the local client window changes. "
  111. "(Does not work with all servers)", true);
  112. BoolParameter viewOnly("ViewOnly",
  113. "Don't send any mouse or keyboard events to the server",
  114. false);
  115. BoolParameter shared("Shared",
  116. "Don't disconnect other viewers upon connection - "
  117. "share the desktop instead",
  118. false);
  119. BoolParameter acceptClipboard("AcceptClipboard",
  120. "Accept clipboard changes from the server",
  121. true);
  122. BoolParameter sendClipboard("SendClipboard",
  123. "Send clipboard changes to the server", true);
  124. #if !defined(WIN32) && !defined(__APPLE__)
  125. BoolParameter setPrimary("SetPrimary",
  126. "Set the primary selection as well as the "
  127. "clipboard selection", true);
  128. BoolParameter sendPrimary("SendPrimary",
  129. "Send the primary selection to the "
  130. "server as well as the clipboard selection",
  131. true);
  132. StringParameter display("display",
  133. "Specifies the X display on which the VNC viewer window should appear.",
  134. "");
  135. #endif
  136. StringParameter menuKey("MenuKey", "The key which brings up the popup menu",
  137. "F8");
  138. BoolParameter fullscreenSystemKeys("FullscreenSystemKeys",
  139. "Pass special keys (like Alt+Tab) directly "
  140. "to the server when in full-screen mode.",
  141. true);
  142. #ifndef WIN32
  143. StringParameter via("via", "Gateway to tunnel via", "");
  144. #endif
  145. static const char* IDENTIFIER_STRING = "TigerVNC Configuration file Version 1.0";
  146. /*
  147. * We only save the sub set of parameters that can be modified from
  148. * the graphical user interface
  149. */
  150. static VoidParameter* parameterArray[] = {
  151. /* Security */
  152. #ifdef HAVE_GNUTLS
  153. &CSecurityTLS::X509CA,
  154. &CSecurityTLS::X509CRL,
  155. #endif // HAVE_GNUTLS
  156. &SecurityClient::secTypes,
  157. /* Misc. */
  158. &reconnectOnError,
  159. &shared,
  160. /* Compression */
  161. &autoSelect,
  162. &fullColour,
  163. &lowColourLevel,
  164. &preferredEncoding,
  165. &customCompressLevel,
  166. &compressLevel,
  167. &noJpeg,
  168. &qualityLevel,
  169. /* Display */
  170. &fullScreen,
  171. &fullScreenMode,
  172. &fullScreenSelectedMonitors,
  173. /* Input */
  174. &viewOnly,
  175. &emulateMiddleButton,
  176. &dotWhenNoCursor,
  177. &acceptClipboard,
  178. &sendClipboard,
  179. #if !defined(WIN32) && !defined(__APPLE__)
  180. &sendPrimary,
  181. &setPrimary,
  182. #endif
  183. &menuKey,
  184. &fullscreenSystemKeys
  185. };
  186. static VoidParameter* readOnlyParameterArray[] = {
  187. &fullScreenAllMonitors
  188. };
  189. // Encoding Table
  190. static struct {
  191. const char first;
  192. const char second;
  193. } replaceMap[] = { { '\n', 'n' },
  194. { '\r', 'r' },
  195. { '\\', '\\' } };
  196. static bool encodeValue(const char* val, char* dest, size_t destSize) {
  197. size_t pos = 0;
  198. for (size_t i = 0; (val[i] != '\0') && (i < (destSize - 1)); i++) {
  199. bool normalCharacter;
  200. // Check for sequences which will need encoding
  201. normalCharacter = true;
  202. for (size_t j = 0; j < sizeof(replaceMap)/sizeof(replaceMap[0]); j++) {
  203. if (val[i] == replaceMap[j].first) {
  204. dest[pos] = '\\';
  205. pos++;
  206. if (pos >= destSize)
  207. return false;
  208. dest[pos] = replaceMap[j].second;
  209. normalCharacter = false;
  210. break;
  211. }
  212. if (normalCharacter) {
  213. dest[pos] = val[i];
  214. }
  215. }
  216. pos++;
  217. if (pos >= destSize)
  218. return false;
  219. }
  220. dest[pos] = '\0';
  221. return true;
  222. }
  223. static bool decodeValue(const char* val, char* dest, size_t destSize) {
  224. size_t pos = 0;
  225. for (size_t i = 0; (val[i] != '\0') && (i < (destSize - 1)); i++) {
  226. // Check for escape sequences
  227. if (val[i] == '\\') {
  228. bool escapedCharacter;
  229. escapedCharacter = false;
  230. for (size_t j = 0; j < sizeof(replaceMap)/sizeof(replaceMap[0]); j++) {
  231. if (val[i+1] == replaceMap[j].second) {
  232. dest[pos] = replaceMap[j].first;
  233. escapedCharacter = true;
  234. i++;
  235. break;
  236. }
  237. }
  238. if (!escapedCharacter)
  239. return false;
  240. } else {
  241. dest[pos] = val[i];
  242. }
  243. pos++;
  244. if (pos >= destSize) {
  245. return false;
  246. }
  247. }
  248. dest[pos] = '\0';
  249. return true;
  250. }
  251. #ifdef _WIN32
  252. static void setKeyString(const char *_name, const char *_value, HKEY* hKey) {
  253. const DWORD buffersize = 256;
  254. wchar_t name[buffersize];
  255. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  256. if (size >= buffersize)
  257. throw Exception(_("The name of the parameter is too large"));
  258. char encodingBuffer[buffersize];
  259. if (!encodeValue(_value, encodingBuffer, buffersize))
  260. throw Exception(_("The parameter is too large"));
  261. wchar_t value[buffersize];
  262. size = fl_utf8towc(encodingBuffer, strlen(encodingBuffer)+1, value, buffersize);
  263. if (size >= buffersize)
  264. throw Exception(_("The parameter is too large"));
  265. LONG res = RegSetValueExW(*hKey, name, 0, REG_SZ, (BYTE*)&value, (wcslen(value)+1)*2);
  266. if (res != ERROR_SUCCESS)
  267. throw rdr::SystemException("RegSetValueExW", res);
  268. }
  269. static void setKeyInt(const char *_name, const int _value, HKEY* hKey) {
  270. const DWORD buffersize = 256;
  271. wchar_t name[buffersize];
  272. DWORD value = _value;
  273. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  274. if (size >= buffersize)
  275. throw Exception(_("The name of the parameter is too large"));
  276. LONG res = RegSetValueExW(*hKey, name, 0, REG_DWORD, (BYTE*)&value, sizeof(DWORD));
  277. if (res != ERROR_SUCCESS)
  278. throw rdr::SystemException("RegSetValueExW", res);
  279. }
  280. static bool getKeyString(const char* _name, char* dest, size_t destSize, HKEY* hKey) {
  281. const DWORD buffersize = 256;
  282. wchar_t name[buffersize];
  283. WCHAR* value;
  284. DWORD valuesize;
  285. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  286. if (size >= buffersize)
  287. throw Exception(_("The name of the parameter is too large"));
  288. value = new WCHAR[destSize];
  289. valuesize = destSize;
  290. LONG res = RegQueryValueExW(*hKey, name, 0, NULL, (LPBYTE)value, &valuesize);
  291. if (res != ERROR_SUCCESS){
  292. delete [] value;
  293. if (res != ERROR_FILE_NOT_FOUND)
  294. throw rdr::SystemException("RegQueryValueExW", res);
  295. // The value does not exist, defaults will be used.
  296. return false;
  297. }
  298. char* utf8val = new char[destSize];
  299. size = fl_utf8fromwc(utf8val, destSize, value, wcslen(value)+1);
  300. delete [] value;
  301. if (size >= destSize) {
  302. delete [] utf8val;
  303. throw Exception(_("The parameter is too large"));
  304. }
  305. bool ret = decodeValue(utf8val, dest, destSize);
  306. delete [] utf8val;
  307. if (!ret)
  308. throw Exception(_("Invalid format or too large value"));
  309. return true;
  310. }
  311. static bool getKeyInt(const char* _name, int* dest, HKEY* hKey) {
  312. const DWORD buffersize = 256;
  313. DWORD dwordsize = sizeof(DWORD);
  314. DWORD value = 0;
  315. wchar_t name[buffersize];
  316. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  317. if (size >= buffersize)
  318. throw Exception(_("The name of the parameter is too large"));
  319. LONG res = RegQueryValueExW(*hKey, name, 0, NULL, (LPBYTE)&value, &dwordsize);
  320. if (res != ERROR_SUCCESS){
  321. if (res != ERROR_FILE_NOT_FOUND)
  322. throw rdr::SystemException("RegQueryValueExW", res);
  323. // The value does not exist, defaults will be used.
  324. return false;
  325. }
  326. *dest = (int)value;
  327. return true;
  328. }
  329. static void removeValue(const char* _name, HKEY* hKey) {
  330. const DWORD buffersize = 256;
  331. wchar_t name[buffersize];
  332. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  333. if (size >= buffersize)
  334. throw Exception(_("The name of the parameter is too large"));
  335. LONG res = RegDeleteValueW(*hKey, name);
  336. if (res != ERROR_SUCCESS) {
  337. if (res != ERROR_FILE_NOT_FOUND)
  338. throw rdr::SystemException("RegDeleteValueW", res);
  339. // The value does not exist, no need to remove it.
  340. return;
  341. }
  342. }
  343. void saveHistoryToRegKey(const vector<string>& serverHistory) {
  344. HKEY hKey;
  345. LONG res = RegCreateKeyExW(HKEY_CURRENT_USER,
  346. L"Software\\TigerVNC\\vncviewer\\history", 0, NULL,
  347. REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL,
  348. &hKey, NULL);
  349. if (res != ERROR_SUCCESS)
  350. throw rdr::SystemException(_("Failed to create registry key"), res);
  351. size_t index = 0;
  352. assert(SERVER_HISTORY_SIZE < 100);
  353. char indexString[3];
  354. try {
  355. while(index < serverHistory.size() && index <= SERVER_HISTORY_SIZE) {
  356. snprintf(indexString, 3, "%d", index);
  357. setKeyString(indexString, serverHistory[index].c_str(), &hKey);
  358. index++;
  359. }
  360. } catch (Exception& e) {
  361. RegCloseKey(hKey);
  362. throw;
  363. }
  364. res = RegCloseKey(hKey);
  365. if (res != ERROR_SUCCESS)
  366. throw rdr::SystemException(_("Failed to close registry key"), res);
  367. }
  368. static void saveToReg(const char* servername) {
  369. HKEY hKey;
  370. LONG res = RegCreateKeyExW(HKEY_CURRENT_USER,
  371. L"Software\\TigerVNC\\vncviewer", 0, NULL,
  372. REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL,
  373. &hKey, NULL);
  374. if (res != ERROR_SUCCESS)
  375. throw rdr::SystemException(_("Failed to create registry key"), res);
  376. try {
  377. setKeyString("ServerName", servername, &hKey);
  378. } catch (Exception& e) {
  379. RegCloseKey(hKey);
  380. throw Exception(_("Failed to save \"%s\": %s"),
  381. "ServerName", e.str());
  382. }
  383. for (size_t i = 0; i < sizeof(parameterArray)/sizeof(VoidParameter*); i++) {
  384. try {
  385. if (dynamic_cast<StringParameter*>(parameterArray[i]) != NULL) {
  386. setKeyString(parameterArray[i]->getName(), *(StringParameter*)parameterArray[i], &hKey);
  387. } else if (dynamic_cast<IntParameter*>(parameterArray[i]) != NULL) {
  388. setKeyInt(parameterArray[i]->getName(), (int)*(IntParameter*)parameterArray[i], &hKey);
  389. } else if (dynamic_cast<BoolParameter*>(parameterArray[i]) != NULL) {
  390. setKeyInt(parameterArray[i]->getName(), (int)*(BoolParameter*)parameterArray[i], &hKey);
  391. } else {
  392. throw Exception(_("Unknown parameter type"));
  393. }
  394. } catch (Exception& e) {
  395. RegCloseKey(hKey);
  396. throw Exception(_("Failed to save \"%s\": %s"),
  397. parameterArray[i]->getName(), e.str());
  398. }
  399. }
  400. // Remove read-only parameters to replicate the behaviour of Linux/macOS when they
  401. // store a config to disk. If the parameter hasn't been migrated at this point it
  402. // will be lost.
  403. for (size_t i = 0; i < sizeof(readOnlyParameterArray)/sizeof(VoidParameter*); i++) {
  404. try {
  405. removeValue(readOnlyParameterArray[i]->getName(), &hKey);
  406. } catch (Exception& e) {
  407. RegCloseKey(hKey);
  408. throw Exception(_("Failed to remove \"%s\": %s"),
  409. readOnlyParameterArray[i]->getName(), e.str());
  410. }
  411. }
  412. res = RegCloseKey(hKey);
  413. if (res != ERROR_SUCCESS)
  414. throw rdr::SystemException(_("Failed to close registry key"), res);
  415. }
  416. void loadHistoryFromRegKey(vector<string>& serverHistory) {
  417. HKEY hKey;
  418. LONG res = RegOpenKeyExW(HKEY_CURRENT_USER,
  419. L"Software\\TigerVNC\\vncviewer\\history", 0,
  420. KEY_READ, &hKey);
  421. if (res != ERROR_SUCCESS) {
  422. if (res == ERROR_FILE_NOT_FOUND) {
  423. // The key does not exist, defaults will be used.
  424. return;
  425. }
  426. throw rdr::SystemException(_("Failed to open registry key"), res);
  427. }
  428. size_t index;
  429. const DWORD buffersize = 256;
  430. char indexString[3];
  431. for (index = 0;;index++) {
  432. snprintf(indexString, 3, "%d", index);
  433. char servernameBuffer[buffersize];
  434. try {
  435. if (!getKeyString(indexString, servernameBuffer,
  436. buffersize, &hKey))
  437. break;
  438. } catch (Exception& e) {
  439. // Just ignore this entry and try the next one
  440. vlog.error(_("Failed to read server history entry %d: %s"),
  441. (int)index, e.str());
  442. continue;
  443. }
  444. serverHistory.push_back(servernameBuffer);
  445. }
  446. res = RegCloseKey(hKey);
  447. if (res != ERROR_SUCCESS)
  448. throw rdr::SystemException(_("Failed to close registry key"), res);
  449. }
  450. static void getParametersFromReg(VoidParameter* parameters[],
  451. size_t parameters_len, HKEY* hKey)
  452. {
  453. const size_t buffersize = 256;
  454. int intValue = 0;
  455. char stringValue[buffersize];
  456. for (size_t i = 0; i < parameters_len/sizeof(VoidParameter*); i++) {
  457. try {
  458. if (dynamic_cast<StringParameter*>(parameters[i]) != NULL) {
  459. if (getKeyString(parameters[i]->getName(), stringValue, buffersize, hKey))
  460. parameters[i]->setParam(stringValue);
  461. } else if (dynamic_cast<IntParameter*>(parameters[i]) != NULL) {
  462. if (getKeyInt(parameters[i]->getName(), &intValue, hKey))
  463. ((IntParameter*)parameters[i])->setParam(intValue);
  464. } else if (dynamic_cast<BoolParameter*>(parameters[i]) != NULL) {
  465. if (getKeyInt(parameters[i]->getName(), &intValue, hKey))
  466. ((BoolParameter*)parameters[i])->setParam(intValue);
  467. } else {
  468. throw Exception(_("Unknown parameter type"));
  469. }
  470. } catch(Exception& e) {
  471. // Just ignore this entry and continue with the rest
  472. vlog.error(_("Failed to read parameter \"%s\": %s"),
  473. parameters[i]->getName(), e.str());
  474. }
  475. }
  476. }
  477. static char* loadFromReg() {
  478. HKEY hKey;
  479. LONG res = RegOpenKeyExW(HKEY_CURRENT_USER,
  480. L"Software\\TigerVNC\\vncviewer", 0,
  481. KEY_READ, &hKey);
  482. if (res != ERROR_SUCCESS) {
  483. if (res == ERROR_FILE_NOT_FOUND) {
  484. // The key does not exist, defaults will be used.
  485. return NULL;
  486. }
  487. throw rdr::SystemException(_("Failed to open registry key"), res);
  488. }
  489. const size_t buffersize = 256;
  490. static char servername[buffersize];
  491. char servernameBuffer[buffersize];
  492. try {
  493. if (getKeyString("ServerName", servernameBuffer, buffersize, &hKey))
  494. snprintf(servername, buffersize, "%s", servernameBuffer);
  495. } catch(Exception& e) {
  496. vlog.error(_("Failed to read parameter \"%s\": %s"),
  497. "ServerName", e.str());
  498. strcpy(servername, "");
  499. }
  500. getParametersFromReg(parameterArray, sizeof(parameterArray), &hKey);
  501. getParametersFromReg(readOnlyParameterArray,
  502. sizeof(readOnlyParameterArray), &hKey);
  503. res = RegCloseKey(hKey);
  504. if (res != ERROR_SUCCESS)
  505. throw rdr::SystemException(_("Failed to close registry key"), res);
  506. return servername;
  507. }
  508. #endif // _WIN32
  509. void saveViewerParameters(const char *filename, const char *servername) {
  510. const size_t buffersize = 256;
  511. char filepath[PATH_MAX];
  512. char encodingBuffer[buffersize];
  513. // Write to the registry or a predefined file if no filename was specified.
  514. if(filename == NULL) {
  515. #ifdef _WIN32
  516. saveToReg(servername);
  517. return;
  518. #endif
  519. char* homeDir = NULL;
  520. if (getvnchomedir(&homeDir) == -1)
  521. throw Exception(_("Could not obtain the home directory path"));
  522. snprintf(filepath, sizeof(filepath), "%sdefault.tigervnc", homeDir);
  523. delete[] homeDir;
  524. } else {
  525. snprintf(filepath, sizeof(filepath), "%s", filename);
  526. }
  527. /* Write parameters to file */
  528. FILE* f = fopen(filepath, "w+");
  529. if (!f)
  530. throw Exception(_("Could not open \"%s\": %s"),
  531. filepath, strerror(errno));
  532. fprintf(f, "%s\n", IDENTIFIER_STRING);
  533. fprintf(f, "\n");
  534. if (!encodeValue(servername, encodingBuffer, buffersize)) {
  535. fclose(f);
  536. throw Exception(_("Failed to save \"%s\": %s"),
  537. "ServerName", _("Could not encode parameter"));
  538. }
  539. fprintf(f, "ServerName=%s\n", encodingBuffer);
  540. for (size_t i = 0; i < sizeof(parameterArray)/sizeof(VoidParameter*); i++) {
  541. if (dynamic_cast<StringParameter*>(parameterArray[i]) != NULL) {
  542. if (!encodeValue(*(StringParameter*)parameterArray[i],
  543. encodingBuffer, buffersize)) {
  544. fclose(f);
  545. throw Exception(_("Failed to save \"%s\": %s"),
  546. parameterArray[i]->getName(),
  547. _("Could not encode parameter"));
  548. }
  549. fprintf(f, "%s=%s\n", ((StringParameter*)parameterArray[i])->getName(), encodingBuffer);
  550. } else if (dynamic_cast<IntParameter*>(parameterArray[i]) != NULL) {
  551. fprintf(f, "%s=%d\n", ((IntParameter*)parameterArray[i])->getName(), (int)*(IntParameter*)parameterArray[i]);
  552. } else if (dynamic_cast<BoolParameter*>(parameterArray[i]) != NULL) {
  553. fprintf(f, "%s=%d\n", ((BoolParameter*)parameterArray[i])->getName(), (int)*(BoolParameter*)parameterArray[i]);
  554. } else {
  555. fclose(f);
  556. throw Exception(_("Failed to save \"%s\": %s"),
  557. parameterArray[i]->getName(),
  558. _("Unknown parameter type"));
  559. }
  560. }
  561. fclose(f);
  562. }
  563. static bool findAndSetViewerParameterFromValue(
  564. VoidParameter* parameters[], size_t parameters_len,
  565. char* value, char* line, char* filepath)
  566. {
  567. const size_t buffersize = 256;
  568. char decodingBuffer[buffersize];
  569. // Find and set the correct parameter
  570. for (size_t i = 0; i < parameters_len/sizeof(VoidParameter*); i++) {
  571. if (dynamic_cast<StringParameter*>(parameters[i]) != NULL) {
  572. if (strcasecmp(line, ((StringParameter*)parameters[i])->getName()) == 0) {
  573. if(!decodeValue(value, decodingBuffer, sizeof(decodingBuffer)))
  574. throw Exception(_("Invalid format or too large value"));
  575. ((StringParameter*)parameters[i])->setParam(decodingBuffer);
  576. return false;
  577. }
  578. } else if (dynamic_cast<IntParameter*>(parameters[i]) != NULL) {
  579. if (strcasecmp(line, ((IntParameter*)parameters[i])->getName()) == 0) {
  580. ((IntParameter*)parameters[i])->setParam(atoi(value));
  581. return false;
  582. }
  583. } else if (dynamic_cast<BoolParameter*>(parameters[i]) != NULL) {
  584. if (strcasecmp(line, ((BoolParameter*)parameters[i])->getName()) == 0) {
  585. ((BoolParameter*)parameters[i])->setParam(atoi(value));
  586. return false;
  587. }
  588. } else {
  589. throw Exception(_("Unknown parameter type"));
  590. }
  591. }
  592. return true;
  593. }
  594. char* loadViewerParameters(const char *filename) {
  595. const size_t buffersize = 256;
  596. char filepath[PATH_MAX];
  597. char line[buffersize];
  598. char decodingBuffer[buffersize];
  599. static char servername[sizeof(line)];
  600. memset(servername, '\0', sizeof(servername));
  601. // Load from the registry or a predefined file if no filename was specified.
  602. if(filename == NULL) {
  603. #ifdef _WIN32
  604. return loadFromReg();
  605. #endif
  606. char* homeDir = NULL;
  607. if (getvnchomedir(&homeDir) == -1)
  608. throw Exception(_("Could not obtain the home directory path"));
  609. snprintf(filepath, sizeof(filepath), "%sdefault.tigervnc", homeDir);
  610. delete[] homeDir;
  611. } else {
  612. snprintf(filepath, sizeof(filepath), "%s", filename);
  613. }
  614. /* Read parameters from file */
  615. FILE* f = fopen(filepath, "r");
  616. if (!f) {
  617. if (!filename)
  618. return NULL; // Use defaults.
  619. throw Exception(_("Could not open \"%s\": %s"),
  620. filepath, strerror(errno));
  621. }
  622. int lineNr = 0;
  623. while (!feof(f)) {
  624. // Read the next line
  625. lineNr++;
  626. if (!fgets(line, sizeof(line), f)) {
  627. if (feof(f))
  628. break;
  629. fclose(f);
  630. throw Exception(_("Failed to read line %d in file %s: %s"),
  631. lineNr, filepath, strerror(errno));
  632. }
  633. if (strlen(line) == (sizeof(line) - 1)) {
  634. fclose(f);
  635. throw Exception(_("Failed to read line %d in file %s: %s"),
  636. lineNr, filepath, _("Line too long"));
  637. }
  638. // Make sure that the first line of the file has the file identifier string
  639. if(lineNr == 1) {
  640. if(strncmp(line, IDENTIFIER_STRING, strlen(IDENTIFIER_STRING)) == 0)
  641. continue;
  642. fclose(f);
  643. throw Exception(_("Configuration file %s is in an invalid format"),
  644. filepath);
  645. }
  646. // Skip empty lines and comments
  647. if ((line[0] == '\n') || (line[0] == '#') || (line[0] == '\r'))
  648. continue;
  649. int len = strlen(line);
  650. if (line[len-1] == '\n') {
  651. line[len-1] = '\0';
  652. len--;
  653. }
  654. if (line[len-1] == '\r') {
  655. line[len-1] = '\0';
  656. len--;
  657. }
  658. // Find the parameter value
  659. char *value = strchr(line, '=');
  660. if (value == NULL) {
  661. vlog.error(_("Failed to read line %d in file %s: %s"),
  662. lineNr, filepath, _("Invalid format"));
  663. continue;
  664. }
  665. *value = '\0'; // line only contains the parameter name below.
  666. value++;
  667. bool invalidParameterName = true; // Will be set to false below if
  668. // the line contains a valid name.
  669. try {
  670. if (strcasecmp(line, "ServerName") == 0) {
  671. if(!decodeValue(value, decodingBuffer, sizeof(decodingBuffer)))
  672. throw Exception(_("Invalid format or too large value"));
  673. snprintf(servername, sizeof(decodingBuffer), "%s", decodingBuffer);
  674. invalidParameterName = false;
  675. } else {
  676. invalidParameterName = findAndSetViewerParameterFromValue(parameterArray, sizeof(parameterArray),
  677. value, line, filepath);
  678. if (invalidParameterName) {
  679. invalidParameterName = findAndSetViewerParameterFromValue(readOnlyParameterArray, sizeof(readOnlyParameterArray),
  680. value, line, filepath);
  681. }
  682. }
  683. } catch(Exception& e) {
  684. // Just ignore this entry and continue with the rest
  685. vlog.error(_("Failed to read line %d in file %s: %s"),
  686. lineNr, filepath, e.str());
  687. continue;
  688. }
  689. if (invalidParameterName)
  690. vlog.error(_("Failed to read line %d in file %s: %s"),
  691. lineNr, filepath, _("Unknown parameter"));
  692. }
  693. fclose(f); f=0;
  694. return servername;
  695. }