squid-cache · kinkie · Mar 13, 2024 · Mar 13, 2024 · Mar 13, 2024 · Mar 13, 2024
diff --git a/src/Makefile.am b/src/Makefile.am
@@ -2388,12 +2388,12 @@ check_PROGRAMS += tests/testIpAddress
 tests_testIpAddress_SOURCES = \
 	tests/testIpAddress.cc
 nodist_tests_testIpAddress_SOURCES = \
-	tests/stub_SBuf.cc \
 	tests/stub_debug.cc \
 	tests/stub_libmem.cc \
 	tests/stub_tools.cc
 tests_testIpAddress_LDADD = \
 	ip/libip.la \
+	sbuf/libsbuf.la \
 	base/libbase.la \
 	$(LIBCPPUNIT_LIBS) \
 	$(COMPAT_LIB) \

diff --git a/src/ip/Address.cc b/src/ip/Address.cc
@@ -12,6 +12,7 @@
 #include "debug/Stream.h"
 #include "ip/Address.h"
 #include "ip/tools.h"
+#include "sbuf/Stream.h"
 #include "util.h"
 
 #include <cassert>
@@ -1043,3 +1044,44 @@ Ip::Address::getInAddr(struct in_addr &buf) const
     return false;
 }
 
+Ip::AddressText::AddressText(const Address &ip) :
+    ip_(ip)
+{}
+
+std::ostream&
+Ip::AddressText::print(std::ostream& os) const
+{
+    if (printBrackets_ && ip_.isIPv6())
+        os << '[';
+
+    /* some external code may have blindly memset a parent. */
+    /* that's okay, our default is known */
+    if ( ip_.isAnyAddr() ) {
+        if (ip_.isIPv6())
+            os << "::";
+        if (ip_.isIPv4())
+            os << "0.0.0.0";
+    } else {
+
+        char buf[INET6_ADDRSTRLEN];
+        if (ip_.isIPv6()) {
+            inet_ntop(AF_INET6, &ip_.mSocketAddr_.sin6_addr, buf, INET6_ADDRSTRLEN);
+        } else if (ip_.isIPv4()) {
+            struct in_addr tmp;
+            ip_.getInAddr(tmp);
+            inet_ntop(AF_INET, &tmp, buf, INET6_ADDRSTRLEN);
+        } else {
+            debugs(14, DBG_CRITICAL, "corrupted IP address details");
+            assert(false);
+        }
+        os << buf;
+    }
+
+    if (printBrackets_ && ip_.isIPv6())
+        os << ']';
+
+    if (printPort_ && ip_.port() != 0)
+        os << ":" << ip_.port();
+
+    return os;
+}
diff --git a/src/ip/Address.h b/src/ip/Address.h
@@ -12,6 +12,7 @@
 #define SQUID_SRC_IP_ADDRESS_H
 
 #include "ip/forward.h"
+#include "sbuf/SBuf.h"
 
 #include <iosfwd>
 #include <ostream>
@@ -34,6 +35,49 @@
 namespace Ip
 {
 
+/**
+ * Formats an Address for stream output
+ *
+ * Normally instantiated via factory method Ip::Address::asText().
+ * Methods manipulate flags to determine output format
+ */
+class AddressText
+{
+public:
+    explicit AddressText(const Address &ip);
+
+    /// if the Address has a port, output it (default: no)
+    /// if set to true, also print brackets for IPv6 addresses
+    AddressText &withPort(bool b = true)
+    {
+        printPort_ = b;
+        if (b)
+            printBrackets_ = true;
+        return *this;
+    };
+
+    /// whether to print brackets surrounding the IP portion of IPv6 addresses (default: yes)
+    /// IPv4 addresses never have brackets
+    AddressText &bracketed(bool b = true)
+    {
+        printBrackets_ = b;
+        return *this;
+    };
+    /// output to ostream. Normally used through operator <<
+    std::ostream &print(std::ostream &) const;
+
+private:
+    const Address &ip_;
+    bool printPort_ = false;
+    bool printBrackets_ = true;
+};
+
+inline std::ostream &
+operator<<(std::ostream &os, const AddressText &at)
+{
+    return at.print(os);
+}
+
 /**
  * Holds and manipulates IPv4, IPv6, and Socket Addresses.
  */
@@ -212,6 +256,9 @@ class Address
      */
     char* toStr(char *buf, const unsigned int blen, int force = AF_UNSPEC) const;
 
+    /// Return object textually representing an Address for stream output
+    AddressText asText() const { return AddressText(*this); }
+
     /** Return the ASCII equivalent of the address:port combination
      *  Provides a URL formatted version of the content.
      *  If buffer is not large enough the data is truncated silently.
@@ -354,6 +401,8 @@ class Address
     static const struct in6_addr v4_anyaddr;
     static const struct in6_addr v4_noaddr;
     static const struct in6_addr v6_noaddr;
+
+    friend class AddressText;
 };
 
 inline std::ostream &

diff --git a/src/peer_sourcehash.cc b/src/peer_sourcehash.cc
@@ -16,6 +16,7 @@
 #include "neighbors.h"
 #include "peer_sourcehash.h"
 #include "PeerSelectState.h"
+#include "sbuf/Stream.h"
 #include "SquidConfig.h"
 #include "Store.h"
 
@@ -137,28 +138,25 @@ peerSourceHashRegisterWithCacheManager(void)
 CachePeer *
 peerSourceHashSelectParent(PeerSelector *ps)
 {
-    const char *c;
     CachePeer *p = nullptr;
     unsigned int user_hash = 0;
     unsigned int combined_hash;
     double score;
     double high_score = 0;
-    const char *key = nullptr;
-    char ntoabuf[MAX_IPSTRLEN];
 
     if (SourceHashPeers().empty())
         return nullptr;
 
     assert(ps);
     HttpRequest *request = ps->request;
 
-    key = request->client_addr.toStr(ntoabuf, sizeof(ntoabuf));
+    const auto key = ToSBuf(request->client_addr.asText());
 
     /* calculate hash key */
     debugs(39, 2, "peerSourceHashSelectParent: Calculating hash for " << key);
 
-    for (c = key; *c != 0; ++c)
-        user_hash += ROTATE_LEFT(user_hash, 19) + *c;
+    for (auto c : key)
+        user_hash += ROTATE_LEFT(user_hash, 19) + c;
 
     /* select CachePeer */
     for (const auto &tp: SourceHashPeers()) {

diff --git a/src/proxyp/Header.cc b/src/proxyp/Header.cc
@@ -52,15 +52,13 @@ ProxyProtocol::Header::getValues(const uint32_t headerType, const char sep) cons
             return SBuf();
         auto logAddr = sourceAddress;
         logAddr.applyClientMask(Config.Addrs.client_netmask);
-        char ipBuf[MAX_IPSTRLEN];
-        return SBuf(logAddr.toStr(ipBuf, sizeof(ipBuf)));
+        return ToSBuf(logAddr.asText());
     }
 
     case Two::htPseudoDstAddr: {
         if (!hasAddresses())
             return SBuf();
-        char ipBuf[MAX_IPSTRLEN];
-        return SBuf(destinationAddress.toStr(ipBuf, sizeof(ipBuf)));
+        return ToSBuf(destinationAddress.asText());
     }
 
     case Two::htPseudoSrcPort: {

diff --git a/src/tests/testIpAddress.cc b/src/tests/testIpAddress.cc
@@ -10,6 +10,8 @@
 #include "compat/cppunit.h"
 #include "ip/Address.h"
 #include "ip/tools.h"
+#include "sbuf/SBuf.h"
+#include "sbuf/Stream.h"
 #include "unitTestMain.h"
 
 #include <cstring>
@@ -48,6 +50,7 @@ class TestIpAddress : public CPPUNIT_NS::TestFixture
     CPPUNIT_TEST(testtoUrl_fromSockAddr);
     CPPUNIT_TEST(testgetReverseString);
     CPPUNIT_TEST(testMasking);
+    CPPUNIT_TEST(testAddressText);
 
     CPPUNIT_TEST(testBugNullingDisplay);
     CPPUNIT_TEST_SUITE_END();
@@ -72,6 +75,7 @@ class TestIpAddress : public CPPUNIT_NS::TestFixture
     void testtoStr();
     void testtoUrl_fromInAddr();
     void testtoUrl_fromSockAddr();
+    void testAddressText();
     void testgetReverseString();
     void testMasking();
 
@@ -465,24 +469,23 @@ void
 TestIpAddress::testtoStr()
 {
     struct in_addr inval;
-    char buf[MAX_IPSTRLEN];
     Ip::Address anIPA;
 
     anIPA.setAnyAddr();
 
     /* test AnyAddr display values */
-    CPPUNIT_ASSERT( memcmp("::", anIPA.toStr(buf,MAX_IPSTRLEN), 2) == 0 );
+    CPPUNIT_ASSERT_EQUAL(SBuf("::"), ToSBuf(anIPA.asText().bracketed(false)));
 
     inval.s_addr = htonl(0xC0A8640C);
     anIPA = inval;
 
     /* test IP display */
-    CPPUNIT_ASSERT( memcmp("192.168.100.12",anIPA.toStr(buf,MAX_IPSTRLEN), 14) == 0 );
+    CPPUNIT_ASSERT_EQUAL(SBuf("192.168.100.12"), ToSBuf(anIPA.asText()));
 
     anIPA.setNoAddr();
 
     /* test NoAddr display values */
-    CPPUNIT_ASSERT( memcmp("ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",anIPA.toStr(buf,MAX_IPSTRLEN), 39) == 0 );
+    CPPUNIT_ASSERT_EQUAL(SBuf("ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"), ToSBuf(anIPA.asText().bracketed(false)));
 }
 
 void
@@ -588,7 +591,6 @@ TestIpAddress::testgetReverseString()
 void
 TestIpAddress::testMasking()
 {
-    char buf[MAX_IPSTRLEN];
     Ip::Address anIPA;
     Ip::Address maskIPA;
 
@@ -617,8 +619,7 @@ TestIpAddress::testMasking()
     CPPUNIT_ASSERT_EQUAL( 80, anIPA.cidr() );
 
     /* BUG Check: test values by display. */
-    CPPUNIT_ASSERT( anIPA.toStr(buf,MAX_IPSTRLEN) != nullptr );
-    CPPUNIT_ASSERT( memcmp("ffff:ffff:ffff:ffff:ffff::", buf, 26) == 0 );
+    CPPUNIT_ASSERT_EQUAL(SBuf("ffff:ffff:ffff:ffff:ffff::"), ToSBuf(anIPA.asText().bracketed(false)) );
 
     /* Test Network Bitmask from Ip::Address */
     anIPA.setNoAddr();
@@ -635,7 +636,7 @@ TestIpAddress::testMasking()
     CPPUNIT_ASSERT_EQUAL( (uint32_t)htonl(0xFFFFF000), btest.s_addr );
 
     /* BUG Check failing test. Masked values for display. */
-    CPPUNIT_ASSERT( memcmp("255.255.240.0",anIPA.toStr(buf,MAX_IPSTRLEN), 13) == 0 );
+    CPPUNIT_ASSERT_EQUAL(SBuf("255.255.240.0"), ToSBuf(anIPA.asText()));
 
     anIPA.setNoAddr();
     maskIPA.setNoAddr();
@@ -799,6 +800,56 @@ TestIpAddress::testBugNullingDisplay()
 
 }
 
+void
+TestIpAddress::testAddressText()
+{
+    std::vector<const char *> testAddresses = {
+        "192.168.100.12",
+        "2000:800::45",
+        "::",
+        "0.0.0.0",
+        "::1",
+        "::ffff:192.168.100.12",
+    };
+
+    std::vector<unsigned short int> testPorts = {
+        0,
+        1,
+        1024,
+        65535,
+    };
+
+    for (const auto p : testPorts) {
+        for (const auto& a : testAddresses) {
+            Ip::Address addr(a);
+            addr.port(p);
+
+            static char buf[MAX_IPSTRLEN];
+            SBufStream ss;
+
+            ss << Ip::AddressText(addr).bracketed(false).withPort(false);
+            addr.toStr(buf, MAX_IPSTRLEN);
+            CPPUNIT_ASSERT_EQUAL(SBuf(buf), ss.buf());
+            ss.clearBuf();
+
+            ss << Ip::AddressText(addr).bracketed(true).withPort(true);
+            addr.toUrl(buf, MAX_IPSTRLEN);
+            CPPUNIT_ASSERT_EQUAL(SBuf(buf), ss.buf());
+            ss.clearBuf();
+
+            ss << Ip::AddressText(addr).withPort(true);
+            addr.toUrl(buf, MAX_IPSTRLEN);
+            CPPUNIT_ASSERT_EQUAL(SBuf(buf), ss.buf());
+            ss.clearBuf();
+
+            ss << Ip::AddressText(addr);
+            addr.toHostStr(buf, MAX_IPSTRLEN);
+            CPPUNIT_ASSERT_EQUAL(SBuf(buf), ss.buf());
+            ss.clearBuf();
+        }
+    }
+}
+
 int
 main(int argc, char *argv[])
 {