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

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