Deprecate match filter with packet (#1986)

* Deprecated matchPacketWithFilter in favor of the shorter `GenericFilter::matches`.

* Updated call sites to use matches instead of matchPacketWithFilter.

* Updated tests to use matches syntax.

* Fixed comment.

Author: Dimi1010

Examples/IPDefragUtil/main.cpp

@@ -125,7 +125,7 @@ void processPackets(pcpp::IFileReaderDevice* reader, pcpp::IFileWriterDevice* wr
 		if (filterByBpf)
 		{
 			// check if packet matches the BPF filter supplied by the user
-			if (pcpp::IPcapDevice::matchPacketWithFilter(filter, &rawPacket))
+			if (filter.matches(rawPacket))
 			{
 				stats.ipPacketsMatchBpfFilter++;
 			}

Examples/IPFragUtil/main.cpp

@@ -258,7 +258,7 @@ void processPackets(pcpp::IFileReaderDevice* reader, pcpp::IFileWriterDevice* wr
 		if (filterByBpf)
 		{
 			// check if packet matches the BPF filter supplied by the user
-			if (pcpp::IPcapDevice::matchPacketWithFilter(filter, &rawPacket))
+			if (filter.matches(rawPacket))
 			{
 				stats.ipPacketsMatchBpfFilter++;
 			}

Examples/PcapSplitter/SimpleSplitters.h

@@ -131,7 +131,7 @@ class BpfCriteriaSplitter : public Splitter
 	 */
 	int getFileNumber(pcpp::Packet& packet, std::vector<int>& filesToClose)
 	{
-		if (pcpp::IPcapDevice::matchPacketWithFilter(filter, packet.getRawPacket()))
+		if (packet.getRawPacket() != nullptr && filter.matches(*packet.getRawPacket()))
 			return 0;
 		return 1;
 	}

Pcap++/header/PcapDevice.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "Device.h"
+#include "DeprecationUtils.h"
 
 // forward declaration for the pcap descriptor defined in pcap.h
 struct pcap;
@@ -159,6 +160,8 @@ namespace pcpp
 		/// @param[in] filter A filter class to test against
 		/// @param[in] rawPacket A pointer to the raw packet to match the filter with
 		/// @return True if raw packet matches the filter or false otherwise
+		/// @deprecated This method is deprecated, use GeneralFilter::matches(...) method directly.
+		PCPP_DEPRECATED("Prefer GeneralFilter::matches(...) method directly.")
 		static bool matchPacketWithFilter(GeneralFilter& filter, RawPacket* rawPacket);
 
 		// implement abstract methods

Pcap++/header/PcapFilter.h

@@ -109,6 +109,8 @@ namespace pcpp
 		/// @param[in] rawPacket A pointer to a raw packet which the filter will be matched against
 		/// @return True if the filter matches (or if it's empty). False if the packet doesn't match or if the filter
 		/// could not be compiled
+		/// @deprecated This method is deprecated, use matches(...) overload instead.
+		PCPP_DEPRECATED("Prefer matches(...) overload.")
 		bool matchPacketWithFilter(const RawPacket* rawPacket) const;
 
 		/// Match a packet data with the filter stored in this object. If the filter is empty the method returns "true".
@@ -120,6 +122,8 @@ namespace pcpp
 		/// @param[in] linkType The packet link type
 		/// @return True if the filter matches (or if it's empty). False if the packet doesn't match or if the filter
 		/// could not be compiled
+		/// @deprecated This method is deprecated, use matches(...) overload instead.
+		PCPP_DEPRECATED("Prefer matches(...) overload.")
 		bool matchPacketWithFilter(const uint8_t* packetData, uint32_t packetDataLength, timespec packetTimestamp,
 		                           uint16_t linkType) const;
 
@@ -170,6 +174,8 @@ namespace pcpp
 		/// Match a raw packet with a given BPF filter.
 		/// @param[in] rawPacket A pointer to the raw packet to match the BPF filter with
 		/// @return True if a raw packet matches the BPF filter or false otherwise
+		/// @deprecated This method is deprecated, use matches(...) overload instead.
+		PCPP_DEPRECATED("Prefer matches(...) overload.")
 		bool matchPacketWithFilter(RawPacket* rawPacket) const;
 
 		/// @brief Match a raw packet against the filter.

Pcap++/src/PcapDevice.cpp

@@ -152,7 +152,13 @@ namespace pcpp
 
 	bool IPcapDevice::matchPacketWithFilter(GeneralFilter& filter, RawPacket* rawPacket)
 	{
-		return filter.matchPacketWithFilter(rawPacket);
+		if (rawPacket == nullptr)
+		{
+			PCPP_LOG_ERROR("Raw packet pointer is null");
+			return false;
+		}
+
+		return filter.matches(*rawPacket);
 	}
 
 	std::string IPcapDevice::getPcapLibVersionInfo()

Pcap++/src/PcapFileDevice.cpp

@@ -581,8 +581,7 @@ namespace pcpp
 			return false;
 		}
 
-		while (!m_BpfWrapper.matchPacketWithFilter(pktData, pktHeader.captured_length, pktHeader.timestamp,
-		                                           pktHeader.data_link))
+		while (!m_BpfWrapper.matches(pktData, pktHeader.captured_length, pktHeader.timestamp, pktHeader.data_link))
 		{
 			if (!light_get_next_packet(toLightPcapNgT(m_LightPcapNg), &pktHeader, &pktData))
 			{
@@ -722,7 +721,7 @@ namespace pcpp
 			return false;
 		}
 
-		if (!m_BpfWrapper.matchPacketWithFilter(&packet))
+		if (!m_BpfWrapper.matches(packet))
 		{
 			return false;
 		}

Tests/Pcap++Test/Tests/FilterTests.cpp

@@ -225,12 +225,12 @@ PTF_TEST_CASE(TestPcapFilters_General_BPFStr)
 
 	int validCounter = 0;
 
-	for (pcpp::RawPacketVector::VectorIterator iter = rawPacketVec.begin(); iter != rawPacketVec.end(); iter++)
+	for (auto* rawPacketPtr : rawPacketVec)
 	{
-		if (bpfStringFilter.matchPacketWithFilter(*iter))
+		if (bpfStringFilter.matches(*rawPacketPtr))
 		{
 			++validCounter;
-			pcpp::Packet packet(*iter);
+			pcpp::Packet packet(rawPacketPtr);
 			pcpp::EthLayer* ethLayer = packet.getLayerOfType<pcpp::EthLayer>();
 			PTF_ASSERT_EQUAL(ethLayer->getDestMac(), macAddr);
 		}
@@ -250,13 +250,13 @@ PTF_TEST_CASE(TestPcapFilters_MatchStatic)
 	fileReaderDev.close();
 
 	//	Test empty BPFstring (the "ALL" filter) in combination with a "-" (example wrong filter)
-	for (pcpp::RawPacketVector::VectorIterator iter = rawPacketVec.begin(); iter != rawPacketVec.end(); iter++)
+	for (auto* rawPacketPtr : rawPacketVec)
 	{
 		pcpp::BPFStringFilter emptyFilter("");
-		PTF_ASSERT_TRUE(emptyFilter.matchPacketWithFilter(*iter));
+		PTF_ASSERT_TRUE(emptyFilter.matches(*rawPacketPtr));
 		pcpp::BPFStringFilter wrongFilter("-");
 		pcpp::Logger::getInstance().suppressLogs();
-		PTF_ASSERT_FALSE(wrongFilter.matchPacketWithFilter(*iter));
+		PTF_ASSERT_FALSE(wrongFilter.matches(*rawPacketPtr));
 		pcpp::Logger::getInstance().enableLogs();
 	}
 
@@ -815,7 +815,7 @@ PTF_TEST_CASE(TestPcapFiltersOffline)
 
 PTF_TEST_CASE(TestPcapFilters_LinkLayer)
 {
-	// check if matchPacketWithFilter work properly for packets with different LinkLayerType
+	// check if GeneralFilter::matches(...) work properly for packets with different LinkLayerType
 
 	// pcpp::LINKTYPE_DLT_RAW1 layer
 	pcpp::PcapFileReaderDevice fileReaderDev1(RAW_IP_PCAP_PATH);
@@ -825,16 +825,16 @@ PTF_TEST_CASE(TestPcapFilters_LinkLayer)
 	fileReaderDev1.close();
 
 	int validCounter = 0;
-	for (pcpp::RawPacketVector::VectorIterator iter = rawPacketVec.begin(); iter != rawPacketVec.end(); iter++)
+	for (auto* rawPacketPtr : rawPacketVec)
 	{
-		pcpp::Packet packet(*iter);
+		pcpp::Packet packet(rawPacketPtr);
 		if (pcpp::IPv4Layer* ip4layer = packet.getLayerOfType<pcpp::IPv4Layer>())
 		{
 			pcpp::BPFStringFilter bpfStringFilter(
 			    "host " + ip4layer->getDstIPAddress().toString());  // checking against real filter, not the "" filter
-			if (bpfStringFilter.matchPacketWithFilter(*iter))
+			if (bpfStringFilter.matches(*rawPacketPtr))
 			{
-				if ((*iter)->getLinkLayerType() == pcpp::LINKTYPE_DLT_RAW1)
+				if (rawPacketPtr->getLinkLayerType() == pcpp::LINKTYPE_DLT_RAW1)
 				{
 					++validCounter;
 				}
@@ -851,16 +851,16 @@ PTF_TEST_CASE(TestPcapFilters_LinkLayer)
 	fileReaderDev2.close();
 
 	validCounter = 0;
-	for (pcpp::RawPacketVector::VectorIterator iter = rawPacketVec.begin(); iter != rawPacketVec.end(); iter++)
+	for (auto* rawPacketPtr : rawPacketVec)
 	{
-		pcpp::Packet packet(*iter);
+		pcpp::Packet packet(rawPacketPtr);
 		if (pcpp::IPv4Layer* ip4layer = packet.getLayerOfType<pcpp::IPv4Layer>())
 		{
 			pcpp::BPFStringFilter bpfStringFilter(
 			    "host " + ip4layer->getDstIPAddress().toString());  // checking against real filter, not the "" filter
-			if (bpfStringFilter.matchPacketWithFilter(*iter))
+			if (bpfStringFilter.matches(*rawPacketPtr))
 			{
-				if ((*iter)->getLinkLayerType() == pcpp::LINKTYPE_LINUX_SLL)
+				if (rawPacketPtr->getLinkLayerType() == pcpp::LINKTYPE_LINUX_SLL)
 				{
 					++validCounter;
 				}
@@ -877,16 +877,16 @@ PTF_TEST_CASE(TestPcapFilters_LinkLayer)
 	fileReaderDev3.close();
 
 	validCounter = 0;
-	for (pcpp::RawPacketVector::VectorIterator iter = rawPacketVec.begin(); iter != rawPacketVec.end(); iter++)
+	for (auto* rawPacketPtr : rawPacketVec)
 	{
-		pcpp::Packet packet(*iter);
+		pcpp::Packet packet(rawPacketPtr);
 		if (pcpp::IPv4Layer* ip4layer = packet.getLayerOfType<pcpp::IPv4Layer>())
 		{
 			pcpp::BPFStringFilter bpfStringFilter(
 			    "host " + ip4layer->getDstIPAddress().toString());  // checking against real filter, not the "" filter
-			if (bpfStringFilter.matchPacketWithFilter(*iter))
+			if (bpfStringFilter.matches(*rawPacketPtr))
 			{
-				if ((*iter)->getLinkLayerType() == pcpp::LINKTYPE_ETHERNET)
+				if (rawPacketPtr->getLinkLayerType() == pcpp::LINKTYPE_ETHERNET)
 				{
 					++validCounter;
 				}