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

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