transport: Renamed misleading is_multi to should_switch_transport in the proxy and in its init

HofiOne · HofiOne · commit 4ba6ca2163d1 · 2024-06-05T21:05:06.000+02:00
Signed-off-by: Hofi &lt;hofione@gmail.com&gt;
diff --git a/lib/transport/transport-socket-proxy.c b/lib/transport/transport-socket-proxy.c
@@ -316,7 +316,7 @@ _parse_proxy_header(LogTransportSocketProxy *self)
 static LogTransport *
 _active_log_transport(LogTransportSocketProxy *self)
 {
-  return (self->is_multi ?
+  return (self->should_switch_transport ?
           &((MultiTransport *)self->base_transport)->super :
           self->base_transport);
 }
@@ -325,7 +325,7 @@ static LogTransportSocket *
 _active_log_transport_socket(LogTransportSocketProxy *self)
 {
   LogTransport *active_log_transport = _active_log_transport(self);
-  return (self->is_multi ?
+  return (self->should_switch_transport ?
           (LogTransportSocket *) ((MultiTransport *)active_log_transport)->active_transport :
           (LogTransportSocket *) active_log_transport);
 }
@@ -548,7 +548,7 @@ _proccess_proxy_header(LogTransportSocketProxy *self)
   if (parsable)
     {
       msg_trace("PROXY protocol header parsed successfully");
-      if (self->is_multi && !_switch_to_tls(self))
+      if (self->should_switch_transport && !_switch_to_tls(self))
         return FALSE;
       return TRUE;
     }
@@ -606,12 +606,12 @@ log_transport_socket_proxy_free(LogTransportSocketProxy *self)
 }
 
 LogTransportSocketProxy *
-log_transport_socket_proxy_new(LogTransport *base_transport, gboolean is_multi)
+log_transport_socket_proxy_new(LogTransport *base_transport, gboolean should_switch_transport)
 {
   LogTransportSocketProxy *self = g_new0(LogTransportSocketProxy, 1);
 
   self->base_transport = base_transport;
-  self->is_multi = is_multi;
+  self->should_switch_transport = should_switch_transport;
 
   /* As the proxy is presented now only in LogTransportSocket (not in LogTransport :( )
    * we cannot simply manipulate the MultiTransport read/write because in that case we do not have
diff --git a/lib/transport/transport-socket-proxy.h b/lib/transport/transport-socket-proxy.h
@@ -39,7 +39,7 @@ struct _LogTransportSocketProxy
   LogTransport *base_transport;
   gssize (*base_read)(LogTransport *self, gpointer buf, gsize count, LogTransportAuxData *aux);
   gssize (*base_write)(LogTransport *self, const gpointer buf, gsize count);
-  gboolean is_multi;
+  gboolean should_switch_transport;
 
   /* Info received from the proxy that should be added as LogTransportAuxData to
    * any message received through this server instance. */
diff --git a/modules/afsocket/transport-mapper-inet.c b/modules/afsocket/transport-mapper-inet.c
@@ -93,9 +93,9 @@ _construct_multitransport_with_tls_factory(TransportMapperInet *self, gint fd)
 }
 
 static LogTransport *
-_construct_tls_transport(TransportMapperInet *self, gint fd)
+_construct_tls_or_multi_transport(TransportMapperInet *self, gboolean create_multi_transport, gint fd)
 {
-  if (self->super.create_multitransport)
+  if (create_multi_transport)
     return _construct_multitransport_with_tls_factory(self, fd);
 
   TLSSession *tls_session = tls_context_setup_session(self->tls_context);
@@ -127,9 +127,9 @@ _construct_multitransport_with_plain_and_tls_factories(TransportMapperInet *self
 }
 
 static LogTransport *
-_construct_plain_tcp_transport(TransportMapperInet *self, gint fd)
+_construct_plain_tcp_or_multi_transport(TransportMapperInet *self, gboolean create_multi_transport, gint fd)
 {
-  if (self->super.create_multitransport)
+  if (create_multi_transport)
     return _construct_multitransport_with_plain_tcp_factory(self, fd);
 
   if (self->super.sock_type == SOCK_DGRAM)
@@ -143,25 +143,25 @@ transport_mapper_inet_construct_log_transport(TransportMapper *s, gint fd)
 {
   TransportMapperInet *self = (TransportMapperInet *) s;
 
-  gboolean is_multi = FALSE;
+  gboolean proxy_should_switch_transport = FALSE;
   LogTransport *transport = NULL;
 
   if (self->tls_context && _is_tls_required(self))
     {
-      transport = _construct_tls_transport(self, fd);
+      transport = _construct_tls_or_multi_transport(self, self->super.create_multitransport, fd);
     }
   else if (self->tls_context)
     {
-      is_multi = TRUE;
+      proxy_should_switch_transport = TRUE;
       transport = _construct_multitransport_with_plain_and_tls_factories(self, fd);
     }
   else
     {
-      transport = _construct_plain_tcp_transport(self, fd);
+      transport = _construct_plain_tcp_or_multi_transport(self, self->super.create_multitransport, fd);
     }
 
   if (self->proxied)
-    log_transport_socket_proxy_new(transport, is_multi);
+    log_transport_socket_proxy_new(transport, proxy_should_switch_transport);
 
   return transport;
 }
@@ -411,7 +411,7 @@ transport_mapper_network_apply_transport(TransportMapper *s, GlobalConfig *cfg)
       self->super.sock_type = SOCK_STREAM;
       self->super.sock_proto = IPPROTO_TCP;
       self->proxied = TRUE;
-      self->super.transport_name = g_strdup("rfc3164+proxied-tcp"); // ???
+      self->super.transport_name = g_strdup("rfc3164+proxied-tcp");
     }
   else if (strcasecmp(transport, "tls") == 0)
     {
@@ -437,7 +437,7 @@ transport_mapper_network_apply_transport(TransportMapper *s, GlobalConfig *cfg)
       self->super.sock_proto = IPPROTO_TCP;
       self->proxied = TRUE;
       self->allow_tls = TRUE;
-      self->super.transport_name = g_strdup("rfc3164+proxied-tls-passthrough"); // ???
+      self->super.transport_name = g_strdup("rfc3164+proxied-tls-passthrough");
     }
   else
     {
@@ -510,7 +510,7 @@ transport_mapper_syslog_apply_transport(TransportMapper *s, GlobalConfig *cfg)
       self->super.sock_type = SOCK_STREAM;
       self->super.sock_proto = IPPROTO_TCP;
       self->proxied = TRUE;
-      self->super.transport_name = g_strdup("rfc6587+proxied-tcp"); // ???
+      self->super.transport_name = g_strdup("rfc6587+proxied-tcp");
     }
   else if (strcasecmp(transport, "tls") == 0)
     {
@@ -536,7 +536,7 @@ transport_mapper_syslog_apply_transport(TransportMapper *s, GlobalConfig *cfg)
       self->super.sock_proto = IPPROTO_TCP;
       self->proxied = TRUE;
       self->require_tls = TRUE;
-      self->super.transport_name = g_strdup("rfc5424+proxied-tls"); // ???
+      self->super.transport_name = g_strdup("rfc5424+proxied-tls");
     }
   else if (strcasecmp(transport, "proxied-tls-passthrough") == 0)
     {
@@ -546,7 +546,7 @@ transport_mapper_syslog_apply_transport(TransportMapper *s, GlobalConfig *cfg)
       self->super.sock_proto = IPPROTO_TCP;
       self->proxied = TRUE;
       self->allow_tls = TRUE;
-      self->super.transport_name = g_strdup("rfc5424+proxied-tls-passthrough"); // ???
+      self->super.transport_name = g_strdup("rfc5424+proxied-tls-passthrough");
     }
   else
     {

Original file line number	Diff line number	Diff line change
`@@ -316,7 +316,7 @@ _parse_proxy_header(LogTransportSocketProxy *self)`
`316`	`316`	`static LogTransport *`
`317`	`317`	`_active_log_transport(LogTransportSocketProxy *self)`
`318`	`318`	`{`
`319`		`- return (self->is_multi ?`
	`319`	`+ return (self->should_switch_transport ?`
`320`	`320`	`&((MultiTransport *)self->base_transport)->super :`
`321`	`321`	`self->base_transport);`
`322`	`322`	`}`
`@@ -325,7 +325,7 @@ static LogTransportSocket *`
`325`	`325`	`_active_log_transport_socket(LogTransportSocketProxy *self)`
`326`	`326`	`{`
`327`	`327`	`LogTransport *active_log_transport = _active_log_transport(self);`
`328`		`- return (self->is_multi ?`
	`328`	`+ return (self->should_switch_transport ?`
`329`	`329`	`(LogTransportSocket ) ((MultiTransport )active_log_transport)->active_transport :`
`330`	`330`	`(LogTransportSocket *) active_log_transport);`
`331`	`331`	`}`
`@@ -548,7 +548,7 @@ _proccess_proxy_header(LogTransportSocketProxy *self)`
`548`	`548`	`if (parsable)`
`549`	`549`	`{`
`550`	`550`	`msg_trace("PROXY protocol header parsed successfully");`
`551`		`- if (self->is_multi && !_switch_to_tls(self))`
	`551`	`+ if (self->should_switch_transport && !_switch_to_tls(self))`
`552`	`552`	`return FALSE;`
`553`	`553`	`return TRUE;`
`554`	`554`	`}`
`@@ -606,12 +606,12 @@ log_transport_socket_proxy_free(LogTransportSocketProxy *self)`
`606`	`606`	`}`
`607`	`607`
`608`	`608`	`LogTransportSocketProxy *`
`609`		`-log_transport_socket_proxy_new(LogTransport *base_transport, gboolean is_multi)`
	`609`	`+log_transport_socket_proxy_new(LogTransport *base_transport, gboolean should_switch_transport)`
`610`	`610`	`{`
`611`	`611`	`LogTransportSocketProxy *self = g_new0(LogTransportSocketProxy, 1);`
`612`	`612`
`613`	`613`	`self->base_transport = base_transport;`
`614`		`- self->is_multi = is_multi;`
	`614`	`+ self->should_switch_transport = should_switch_transport;`
`615`	`615`
`616`	`616`	`/* As the proxy is presented now only in LogTransportSocket (not in LogTransport :( )`
`617`	`617`	`* we cannot simply manipulate the MultiTransport read/write because in that case we do not have`
Original file line number	Diff line number	Diff line change
`@@ -93,9 +93,9 @@ _construct_multitransport_with_tls_factory(TransportMapperInet *self, gint fd)`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`static LogTransport *`
`96`		`-_construct_tls_transport(TransportMapperInet *self, gint fd)`
	`96`	`+_construct_tls_or_multi_transport(TransportMapperInet *self, gboolean create_multi_transport, gint fd)`
`97`	`97`	`{`
`98`		`- if (self->super.create_multitransport)`
	`98`	`+ if (create_multi_transport)`
`99`	`99`	`return _construct_multitransport_with_tls_factory(self, fd);`
`100`	`100`
`101`	`101`	`TLSSession *tls_session = tls_context_setup_session(self->tls_context);`
`@@ -127,9 +127,9 @@ _construct_multitransport_with_plain_and_tls_factories(TransportMapperInet *self`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`static LogTransport *`
`130`		`-_construct_plain_tcp_transport(TransportMapperInet *self, gint fd)`
	`130`	`+_construct_plain_tcp_or_multi_transport(TransportMapperInet *self, gboolean create_multi_transport, gint fd)`
`131`	`131`	`{`
`132`		`- if (self->super.create_multitransport)`
	`132`	`+ if (create_multi_transport)`
`133`	`133`	`return _construct_multitransport_with_plain_tcp_factory(self, fd);`
`134`	`134`
`135`	`135`	`if (self->super.sock_type == SOCK_DGRAM)`
`@@ -143,25 +143,25 @@ transport_mapper_inet_construct_log_transport(TransportMapper *s, gint fd)`
`143`	`143`	`{`
`144`	`144`	`TransportMapperInet self = (TransportMapperInet ) s;`
`145`	`145`
`146`		`- gboolean is_multi = FALSE;`
	`146`	`+ gboolean proxy_should_switch_transport = FALSE;`
`147`	`147`	`LogTransport *transport = NULL;`
`148`	`148`
`149`	`149`	`if (self->tls_context && _is_tls_required(self))`
`150`	`150`	`{`
`151`		`- transport = _construct_tls_transport(self, fd);`
	`151`	`+ transport = _construct_tls_or_multi_transport(self, self->super.create_multitransport, fd);`
`152`	`152`	`}`
`153`	`153`	`else if (self->tls_context)`
`154`	`154`	`{`
`155`		`- is_multi = TRUE;`
	`155`	`+ proxy_should_switch_transport = TRUE;`
`156`	`156`	`transport = _construct_multitransport_with_plain_and_tls_factories(self, fd);`
`157`	`157`	`}`
`158`	`158`	`else`
`159`	`159`	`{`
`160`		`- transport = _construct_plain_tcp_transport(self, fd);`
	`160`	`+ transport = _construct_plain_tcp_or_multi_transport(self, self->super.create_multitransport, fd);`
`161`	`161`	`}`
`162`	`162`
`163`	`163`	`if (self->proxied)`
`164`		`- log_transport_socket_proxy_new(transport, is_multi);`
	`164`	`+ log_transport_socket_proxy_new(transport, proxy_should_switch_transport);`
`165`	`165`
`166`	`166`	`return transport;`
`167`	`167`	`}`
`@@ -411,7 +411,7 @@ transport_mapper_network_apply_transport(TransportMapper s, GlobalConfig cfg)`
`411`	`411`	`self->super.sock_type = SOCK_STREAM;`
`412`	`412`	`self->super.sock_proto = IPPROTO_TCP;`
`413`	`413`	`self->proxied = TRUE;`
`414`		`- self->super.transport_name = g_strdup("rfc3164+proxied-tcp"); // ???`
	`414`	`+ self->super.transport_name = g_strdup("rfc3164+proxied-tcp");`
`415`	`415`	`}`
`416`	`416`	`else if (strcasecmp(transport, "tls") == 0)`
`417`	`417`	`{`
`@@ -437,7 +437,7 @@ transport_mapper_network_apply_transport(TransportMapper s, GlobalConfig cfg)`
`437`	`437`	`self->super.sock_proto = IPPROTO_TCP;`
`438`	`438`	`self->proxied = TRUE;`
`439`	`439`	`self->allow_tls = TRUE;`
`440`		`- self->super.transport_name = g_strdup("rfc3164+proxied-tls-passthrough"); // ???`
	`440`	`+ self->super.transport_name = g_strdup("rfc3164+proxied-tls-passthrough");`
`441`	`441`	`}`
`442`	`442`	`else`
`443`	`443`	`{`
`@@ -510,7 +510,7 @@ transport_mapper_syslog_apply_transport(TransportMapper s, GlobalConfig cfg)`
`510`	`510`	`self->super.sock_type = SOCK_STREAM;`
`511`	`511`	`self->super.sock_proto = IPPROTO_TCP;`
`512`	`512`	`self->proxied = TRUE;`
`513`		`- self->super.transport_name = g_strdup("rfc6587+proxied-tcp"); // ???`
	`513`	`+ self->super.transport_name = g_strdup("rfc6587+proxied-tcp");`
`514`	`514`	`}`
`515`	`515`	`else if (strcasecmp(transport, "tls") == 0)`
`516`	`516`	`{`
`@@ -536,7 +536,7 @@ transport_mapper_syslog_apply_transport(TransportMapper s, GlobalConfig cfg)`
`536`	`536`	`self->super.sock_proto = IPPROTO_TCP;`
`537`	`537`	`self->proxied = TRUE;`
`538`	`538`	`self->require_tls = TRUE;`
`539`		`- self->super.transport_name = g_strdup("rfc5424+proxied-tls"); // ???`
	`539`	`+ self->super.transport_name = g_strdup("rfc5424+proxied-tls");`
`540`	`540`	`}`
`541`	`541`	`else if (strcasecmp(transport, "proxied-tls-passthrough") == 0)`
`542`	`542`	`{`
`@@ -546,7 +546,7 @@ transport_mapper_syslog_apply_transport(TransportMapper s, GlobalConfig cfg)`
`546`	`546`	`self->super.sock_proto = IPPROTO_TCP;`
`547`	`547`	`self->proxied = TRUE;`
`548`	`548`	`self->allow_tls = TRUE;`
`549`		`- self->super.transport_name = g_strdup("rfc5424+proxied-tls-passthrough"); // ???`
	`549`	`+ self->super.transport_name = g_strdup("rfc5424+proxied-tls-passthrough");`
`550`	`550`	`}`
`551`	`551`	`else`
`552`	`552`	`{`