ZlibLevel parameter marked deprecated

Trying to set the ZlibLevel will set off a warning to users.
TigerVNC · Jul 20, 2023 · e7d14cc · e7d14cc
1 parent 8051f19
commit e7d14cc
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/common/rfb/ZRLEEncoder.cxx b/common/rfb/ZRLEEncoder.cxx
@@ -31,7 +31,7 @@
 
 using namespace rfb;
 
-IntParameter zlibLevel("ZlibLevel","Zlib compression level",-1);
+IntParameter zlibLevel("ZlibLevel","[DEPRECATED] Zlib compression level",-1);
 
 ZRLEEncoder::ZRLEEncoder(SConnection* conn)
   : Encoder(conn, encodingZRLE, EncoderPlain, 127),

diff --git a/unix/x0vncserver/x0vncserver.cxx b/unix/x0vncserver/x0vncserver.cxx
@@ -113,6 +113,19 @@ static void CleanupSignalHandler(int /*sig*/)
   caughtSignal = true;
 }
 
+static void migrateDeprecatedOptions()
+{
+  rfb::VoidParameter* param = Configuration::getParam("ZlibLevel");
+  if (param == NULL)
+    return;
+
+  int compressLevel = *((rfb::IntParameter*) param);
+  if (compressLevel != -1) {
+    vlog.info("ZlibLevel is deprecated, let clients set the compression level instead.");
+    param->setParam("-1");
+  }
+}
+
 
 class FileTcpFilter : public TcpFilter
 {
@@ -275,6 +288,8 @@ int main(int argc, char** argv)
     usage();
   }
 
+  migrateDeprecatedOptions();
+
   if (!(dpy = XOpenDisplay(displayname))) {
     // FIXME: Why not vlog.error(...)?
     fprintf(stderr,"%s: unable to open display \"%s\"\r\n",