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 26KB

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