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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847
  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. &dotWhenNoCursor,
  159. &reconnectOnError,
  160. &shared,
  161. /* Compression */
  162. &autoSelect,
  163. &fullColour,
  164. &lowColourLevel,
  165. &preferredEncoding,
  166. &customCompressLevel,
  167. &compressLevel,
  168. &noJpeg,
  169. &qualityLevel,
  170. /* Screen */
  171. &fullScreen,
  172. &fullScreenMode,
  173. &fullScreenSelectedMonitors,
  174. &desktopSize,
  175. &remoteResize,
  176. /* Input */
  177. &viewOnly,
  178. &emulateMiddleButton,
  179. &acceptClipboard,
  180. &sendClipboard,
  181. #if !defined(WIN32) && !defined(__APPLE__)
  182. &sendPrimary,
  183. &setPrimary,
  184. #endif
  185. &menuKey,
  186. &fullscreenSystemKeys
  187. };
  188. static VoidParameter* readOnlyParameterArray[] = {
  189. &fullScreenAllMonitors
  190. };
  191. // Encoding Table
  192. static struct {
  193. const char first;
  194. const char second;
  195. } replaceMap[] = { { '\n', 'n' },
  196. { '\r', 'r' },
  197. { '\\', '\\' } };
  198. static bool encodeValue(const char* val, char* dest, size_t destSize) {
  199. size_t pos = 0;
  200. for (size_t i = 0; (val[i] != '\0') && (i < (destSize - 1)); i++) {
  201. bool normalCharacter;
  202. // Check for sequences which will need encoding
  203. normalCharacter = true;
  204. for (size_t j = 0; j < sizeof(replaceMap)/sizeof(replaceMap[0]); j++) {
  205. if (val[i] == replaceMap[j].first) {
  206. dest[pos] = '\\';
  207. pos++;
  208. if (pos >= destSize)
  209. return false;
  210. dest[pos] = replaceMap[j].second;
  211. normalCharacter = false;
  212. break;
  213. }
  214. if (normalCharacter) {
  215. dest[pos] = val[i];
  216. }
  217. }
  218. pos++;
  219. if (pos >= destSize)
  220. return false;
  221. }
  222. dest[pos] = '\0';
  223. return true;
  224. }
  225. static bool decodeValue(const char* val, char* dest, size_t destSize) {
  226. size_t pos = 0;
  227. for (size_t i = 0; (val[i] != '\0') && (i < (destSize - 1)); i++) {
  228. // Check for escape sequences
  229. if (val[i] == '\\') {
  230. bool escapedCharacter;
  231. escapedCharacter = false;
  232. for (size_t j = 0; j < sizeof(replaceMap)/sizeof(replaceMap[0]); j++) {
  233. if (val[i+1] == replaceMap[j].second) {
  234. dest[pos] = replaceMap[j].first;
  235. escapedCharacter = true;
  236. i++;
  237. break;
  238. }
  239. }
  240. if (!escapedCharacter)
  241. return false;
  242. } else {
  243. dest[pos] = val[i];
  244. }
  245. pos++;
  246. if (pos >= destSize) {
  247. return false;
  248. }
  249. }
  250. dest[pos] = '\0';
  251. return true;
  252. }
  253. #ifdef _WIN32
  254. static void setKeyString(const char *_name, const char *_value, HKEY* hKey) {
  255. const DWORD buffersize = 256;
  256. wchar_t name[buffersize];
  257. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  258. if (size >= buffersize)
  259. throw Exception(_("The name of the parameter is too large"));
  260. char encodingBuffer[buffersize];
  261. if (!encodeValue(_value, encodingBuffer, buffersize))
  262. throw Exception(_("The parameter is too large"));
  263. wchar_t value[buffersize];
  264. size = fl_utf8towc(encodingBuffer, strlen(encodingBuffer)+1, value, buffersize);
  265. if (size >= buffersize)
  266. throw Exception(_("The parameter is too large"));
  267. LONG res = RegSetValueExW(*hKey, name, 0, REG_SZ, (BYTE*)&value, (wcslen(value)+1)*2);
  268. if (res != ERROR_SUCCESS)
  269. throw rdr::SystemException("RegSetValueExW", res);
  270. }
  271. static void setKeyInt(const char *_name, const int _value, HKEY* hKey) {
  272. const DWORD buffersize = 256;
  273. wchar_t name[buffersize];
  274. DWORD value = _value;
  275. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  276. if (size >= buffersize)
  277. throw Exception(_("The name of the parameter is too large"));
  278. LONG res = RegSetValueExW(*hKey, name, 0, REG_DWORD, (BYTE*)&value, sizeof(DWORD));
  279. if (res != ERROR_SUCCESS)
  280. throw rdr::SystemException("RegSetValueExW", res);
  281. }
  282. static bool getKeyString(const char* _name, char* dest, size_t destSize, HKEY* hKey) {
  283. const DWORD buffersize = 256;
  284. wchar_t name[buffersize];
  285. WCHAR* value;
  286. DWORD valuesize;
  287. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  288. if (size >= buffersize)
  289. throw Exception(_("The name of the parameter is too large"));
  290. value = new WCHAR[destSize];
  291. valuesize = destSize;
  292. LONG res = RegQueryValueExW(*hKey, name, 0, NULL, (LPBYTE)value, &valuesize);
  293. if (res != ERROR_SUCCESS){
  294. delete [] value;
  295. if (res != ERROR_FILE_NOT_FOUND)
  296. throw rdr::SystemException("RegQueryValueExW", res);
  297. // The value does not exist, defaults will be used.
  298. return false;
  299. }
  300. char* utf8val = new char[destSize];
  301. size = fl_utf8fromwc(utf8val, destSize, value, wcslen(value)+1);
  302. delete [] value;
  303. if (size >= destSize) {
  304. delete [] utf8val;
  305. throw Exception(_("The parameter is too large"));
  306. }
  307. bool ret = decodeValue(utf8val, dest, destSize);
  308. delete [] utf8val;
  309. if (!ret)
  310. throw Exception(_("Invalid format or too large value"));
  311. return true;
  312. }
  313. static bool getKeyInt(const char* _name, int* dest, HKEY* hKey) {
  314. const DWORD buffersize = 256;
  315. DWORD dwordsize = sizeof(DWORD);
  316. DWORD value = 0;
  317. wchar_t name[buffersize];
  318. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  319. if (size >= buffersize)
  320. throw Exception(_("The name of the parameter is too large"));
  321. LONG res = RegQueryValueExW(*hKey, name, 0, NULL, (LPBYTE)&value, &dwordsize);
  322. if (res != ERROR_SUCCESS){
  323. if (res != ERROR_FILE_NOT_FOUND)
  324. throw rdr::SystemException("RegQueryValueExW", res);
  325. // The value does not exist, defaults will be used.
  326. return false;
  327. }
  328. *dest = (int)value;
  329. return true;
  330. }
  331. static void removeValue(const char* _name, HKEY* hKey) {
  332. const DWORD buffersize = 256;
  333. wchar_t name[buffersize];
  334. unsigned size = fl_utf8towc(_name, strlen(_name)+1, name, buffersize);
  335. if (size >= buffersize)
  336. throw Exception(_("The name of the parameter is too large"));
  337. LONG res = RegDeleteValueW(*hKey, name);
  338. if (res != ERROR_SUCCESS) {
  339. if (res != ERROR_FILE_NOT_FOUND)
  340. throw rdr::SystemException("RegDeleteValueW", res);
  341. // The value does not exist, no need to remove it.
  342. return;
  343. }
  344. }
  345. void saveHistoryToRegKey(const vector<string>& serverHistory) {
  346. HKEY hKey;
  347. LONG res = RegCreateKeyExW(HKEY_CURRENT_USER,
  348. L"Software\\TigerVNC\\vncviewer\\history", 0, NULL,
  349. REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL,
  350. &hKey, NULL);
  351. if (res != ERROR_SUCCESS)
  352. throw rdr::SystemException(_("Failed to create registry key"), res);
  353. size_t index = 0;
  354. assert(SERVER_HISTORY_SIZE < 100);
  355. char indexString[3];
  356. try {
  357. while(index < serverHistory.size() && index <= SERVER_HISTORY_SIZE) {
  358. snprintf(indexString, 3, "%d", index);
  359. setKeyString(indexString, serverHistory[index].c_str(), &hKey);
  360. index++;
  361. }
  362. } catch (Exception& e) {
  363. RegCloseKey(hKey);
  364. throw;
  365. }
  366. res = RegCloseKey(hKey);
  367. if (res != ERROR_SUCCESS)
  368. throw rdr::SystemException(_("Failed to close registry key"), res);
  369. }
  370. static void saveToReg(const char* servername) {
  371. HKEY hKey;
  372. LONG res = RegCreateKeyExW(HKEY_CURRENT_USER,
  373. L"Software\\TigerVNC\\vncviewer", 0, NULL,
  374. REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL,
  375. &hKey, NULL);
  376. if (res != ERROR_SUCCESS)
  377. throw rdr::SystemException(_("Failed to create registry key"), res);
  378. try {
  379. setKeyString("ServerName", servername, &hKey);
  380. } catch (Exception& e) {
  381. RegCloseKey(hKey);
  382. throw Exception(_("Failed to save \"%s\": %s"),
  383. "ServerName", e.str());
  384. }
  385. for (size_t i = 0; i < sizeof(parameterArray)/sizeof(VoidParameter*); i++) {
  386. try {
  387. if (dynamic_cast<StringParameter*>(parameterArray[i]) != NULL) {
  388. setKeyString(parameterArray[i]->getName(), *(StringParameter*)parameterArray[i], &hKey);
  389. } else if (dynamic_cast<IntParameter*>(parameterArray[i]) != NULL) {
  390. setKeyInt(parameterArray[i]->getName(), (int)*(IntParameter*)parameterArray[i], &hKey);
  391. } else if (dynamic_cast<BoolParameter*>(parameterArray[i]) != NULL) {
  392. setKeyInt(parameterArray[i]->getName(), (int)*(BoolParameter*)parameterArray[i], &hKey);
  393. } else {
  394. throw Exception(_("Unknown parameter type"));
  395. }
  396. } catch (Exception& e) {
  397. RegCloseKey(hKey);
  398. throw Exception(_("Failed to save \"%s\": %s"),
  399. parameterArray[i]->getName(), e.str());
  400. }
  401. }
  402. // Remove read-only parameters to replicate the behaviour of Linux/macOS when they
  403. // store a config to disk. If the parameter hasn't been migrated at this point it
  404. // will be lost.
  405. for (size_t i = 0; i < sizeof(readOnlyParameterArray)/sizeof(VoidParameter*); i++) {
  406. try {
  407. removeValue(readOnlyParameterArray[i]->getName(), &hKey);
  408. } catch (Exception& e) {
  409. RegCloseKey(hKey);
  410. throw Exception(_("Failed to remove \"%s\": %s"),
  411. readOnlyParameterArray[i]->getName(), e.str());
  412. }
  413. }
  414. res = RegCloseKey(hKey);
  415. if (res != ERROR_SUCCESS)
  416. throw rdr::SystemException(_("Failed to close registry key"), res);
  417. }
  418. void loadHistoryFromRegKey(vector<string>& serverHistory) {
  419. HKEY hKey;
  420. LONG res = RegOpenKeyExW(HKEY_CURRENT_USER,
  421. L"Software\\TigerVNC\\vncviewer\\history", 0,
  422. KEY_READ, &hKey);
  423. if (res != ERROR_SUCCESS) {
  424. if (res == ERROR_FILE_NOT_FOUND) {
  425. // The key does not exist, defaults will be used.
  426. return;
  427. }
  428. throw rdr::SystemException(_("Failed to open registry key"), res);
  429. }
  430. size_t index;
  431. const DWORD buffersize = 256;
  432. char indexString[3];
  433. for (index = 0;;index++) {
  434. snprintf(indexString, 3, "%d", index);
  435. char servernameBuffer[buffersize];
  436. try {
  437. if (!getKeyString(indexString, servernameBuffer,
  438. buffersize, &hKey))
  439. break;
  440. } catch (Exception& e) {
  441. // Just ignore this entry and try the next one
  442. vlog.error(_("Failed to read server history entry %d: %s"),
  443. (int)index, e.str());
  444. continue;
  445. }
  446. serverHistory.push_back(servernameBuffer);
  447. }
  448. res = RegCloseKey(hKey);
  449. if (res != ERROR_SUCCESS)
  450. throw rdr::SystemException(_("Failed to close registry key"), res);
  451. }
  452. static void getParametersFromReg(VoidParameter* parameters[],
  453. size_t parameters_len, HKEY* hKey)
  454. {
  455. const size_t buffersize = 256;
  456. int intValue = 0;
  457. char stringValue[buffersize];
  458. for (size_t i = 0; i < parameters_len/sizeof(VoidParameter*); i++) {
  459. try {
  460. if (dynamic_cast<StringParameter*>(parameters[i]) != NULL) {
  461. if (getKeyString(parameters[i]->getName(), stringValue, buffersize, hKey))
  462. parameters[i]->setParam(stringValue);
  463. } else if (dynamic_cast<IntParameter*>(parameters[i]) != NULL) {
  464. if (getKeyInt(parameters[i]->getName(), &intValue, hKey))
  465. ((IntParameter*)parameters[i])->setParam(intValue);
  466. } else if (dynamic_cast<BoolParameter*>(parameters[i]) != NULL) {
  467. if (getKeyInt(parameters[i]->getName(), &intValue, hKey))
  468. ((BoolParameter*)parameters[i])->setParam(intValue);
  469. } else {
  470. throw Exception(_("Unknown parameter type"));
  471. }
  472. } catch(Exception& e) {
  473. // Just ignore this entry and continue with the rest
  474. vlog.error(_("Failed to read parameter \"%s\": %s"),
  475. parameters[i]->getName(), e.str());
  476. }
  477. }
  478. }
  479. static char* loadFromReg() {
  480. HKEY hKey;
  481. LONG res = RegOpenKeyExW(HKEY_CURRENT_USER,
  482. L"Software\\TigerVNC\\vncviewer", 0,
  483. KEY_READ, &hKey);
  484. if (res != ERROR_SUCCESS) {
  485. if (res == ERROR_FILE_NOT_FOUND) {
  486. // The key does not exist, defaults will be used.
  487. return NULL;
  488. }
  489. throw rdr::SystemException(_("Failed to open registry key"), res);
  490. }
  491. const size_t buffersize = 256;
  492. static char servername[buffersize];
  493. char servernameBuffer[buffersize];
  494. try {
  495. if (getKeyString("ServerName", servernameBuffer, buffersize, &hKey))
  496. snprintf(servername, buffersize, "%s", servernameBuffer);
  497. } catch(Exception& e) {
  498. vlog.error(_("Failed to read parameter \"%s\": %s"),
  499. "ServerName", e.str());
  500. strcpy(servername, "");
  501. }
  502. getParametersFromReg(parameterArray, sizeof(parameterArray), &hKey);
  503. getParametersFromReg(readOnlyParameterArray,
  504. sizeof(readOnlyParameterArray), &hKey);
  505. res = RegCloseKey(hKey);
  506. if (res != ERROR_SUCCESS)
  507. throw rdr::SystemException(_("Failed to close registry key"), res);
  508. return servername;
  509. }
  510. #endif // _WIN32
  511. void saveViewerParameters(const char *filename, const char *servername) {
  512. const size_t buffersize = 256;
  513. char filepath[PATH_MAX];
  514. char encodingBuffer[buffersize];
  515. // Write to the registry or a predefined file if no filename was specified.
  516. if(filename == NULL) {
  517. #ifdef _WIN32
  518. saveToReg(servername);
  519. return;
  520. #endif
  521. char* homeDir = NULL;
  522. if (getvnchomedir(&homeDir) == -1)
  523. throw Exception(_("Could not obtain the home directory path"));
  524. snprintf(filepath, sizeof(filepath), "%sdefault.tigervnc", homeDir);
  525. delete[] 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, char* filepath)
  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. char* homeDir = NULL;
  609. if (getvnchomedir(&homeDir) == -1)
  610. throw Exception(_("Could not obtain the home directory path"));
  611. snprintf(filepath, sizeof(filepath), "%sdefault.tigervnc", homeDir);
  612. delete[] homeDir;
  613. } else {
  614. snprintf(filepath, sizeof(filepath), "%s", filename);
  615. }
  616. /* Read parameters from file */
  617. FILE* f = fopen(filepath, "r");
  618. if (!f) {
  619. if (!filename)
  620. return NULL; // Use defaults.
  621. throw Exception(_("Could not open \"%s\": %s"),
  622. filepath, strerror(errno));
  623. }
  624. int lineNr = 0;
  625. while (!feof(f)) {
  626. // Read the next line
  627. lineNr++;
  628. if (!fgets(line, sizeof(line), f)) {
  629. if (feof(f))
  630. break;
  631. fclose(f);
  632. throw Exception(_("Failed to read line %d in file %s: %s"),
  633. lineNr, filepath, strerror(errno));
  634. }
  635. if (strlen(line) == (sizeof(line) - 1)) {
  636. fclose(f);
  637. throw Exception(_("Failed to read line %d in file %s: %s"),
  638. lineNr, filepath, _("Line too long"));
  639. }
  640. // Make sure that the first line of the file has the file identifier string
  641. if(lineNr == 1) {
  642. if(strncmp(line, IDENTIFIER_STRING, strlen(IDENTIFIER_STRING)) == 0)
  643. continue;
  644. fclose(f);
  645. throw Exception(_("Configuration file %s is in an invalid format"),
  646. filepath);
  647. }
  648. // Skip empty lines and comments
  649. if ((line[0] == '\n') || (line[0] == '#') || (line[0] == '\r'))
  650. continue;
  651. int len = strlen(line);
  652. if (line[len-1] == '\n') {
  653. line[len-1] = '\0';
  654. len--;
  655. }
  656. if (line[len-1] == '\r') {
  657. line[len-1] = '\0';
  658. len--;
  659. }
  660. // Find the parameter value
  661. char *value = strchr(line, '=');
  662. if (value == NULL) {
  663. vlog.error(_("Failed to read line %d in file %s: %s"),
  664. lineNr, filepath, _("Invalid format"));
  665. continue;
  666. }
  667. *value = '\0'; // line only contains the parameter name below.
  668. value++;
  669. bool invalidParameterName = true; // Will be set to false below if
  670. // the line contains a valid name.
  671. try {
  672. if (strcasecmp(line, "ServerName") == 0) {
  673. if(!decodeValue(value, decodingBuffer, sizeof(decodingBuffer)))
  674. throw Exception(_("Invalid format or too large value"));
  675. snprintf(servername, sizeof(decodingBuffer), "%s", decodingBuffer);
  676. invalidParameterName = false;
  677. } else {
  678. invalidParameterName = findAndSetViewerParameterFromValue(parameterArray, sizeof(parameterArray),
  679. value, line, filepath);
  680. if (invalidParameterName) {
  681. invalidParameterName = findAndSetViewerParameterFromValue(readOnlyParameterArray, sizeof(readOnlyParameterArray),
  682. value, line, filepath);
  683. }
  684. }
  685. } catch(Exception& e) {
  686. // Just ignore this entry and continue with the rest
  687. vlog.error(_("Failed to read line %d in file %s: %s"),
  688. lineNr, filepath, e.str());
  689. continue;
  690. }
  691. if (invalidParameterName)
  692. vlog.error(_("Failed to read line %d in file %s: %s"),
  693. lineNr, filepath, _("Unknown parameter"));
  694. }
  695. fclose(f); f=0;
  696. return servername;
  697. }