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

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