protocol: add attribute GENERATOR

Author: MaxKellermann

debian/changelog

@@ -1,6 +1,7 @@
 cm4all-pond (0.32) unstable; urgency=low
 
   * client: add JSON Lines output format
+  * protocol: add attribute GENERATOR
 
  --   
 

doc/index.rst

@@ -264,6 +264,8 @@ The following filters are available:
   all.
 - :samp:`uri-prefix=URI` shows only records whos HTTP request URI
   starts with the specified string.
+- :samp:`generator=NAME` shows only records with the specified
+  "generator" value.
 - :samp:`since=ISO8601` shows only records since the given time stamp.
   See :ref:`timestamps` for details.
 - :samp:`until=ISO8601` shows only records until the given time stamp.

libcommon

@@ -470,6 +470,20 @@ try {
 			throw SimplePondError{"Duplicate FILTER_HOST"};
 
 		return BufferedResult::AGAIN;
+
+	case PondRequestCommand::FILTER_GENERATOR:
+		if (!current.MatchId(id) ||
+		    current.command != PondRequestCommand::QUERY)
+			throw SimplePondError{"Misplaced FILTER_GENERATOR"};
+
+		if (HasNullByte(ToStringView(payload)))
+			throw SimplePondError{"Malformed FILTER_GENERATOR"};
+
+		if (auto e = current.filter.generators.emplace(ToStringView(payload));
+		    !e.second)
+			throw SimplePondError{"Duplicate FILTER_GENERATOR"};
+
+		return BufferedResult::AGAIN;
 	}
 
 	throw SimplePondError{"Command not implemented"};

src/Connection.cxx

@@ -41,7 +41,9 @@ MatchHttpUriStartsWith(const char *http_uri,
 inline bool
 Filter::MatchMore(std::span<const std::byte> raw) const noexcept
 {
-	if (!http_status && hosts.empty() && http_uri_starts_with.empty())
+	if (!http_status && hosts.empty() &&
+	    generators.empty() &&
+	    http_uri_starts_with.empty())
 		return true;
 
 	try {
@@ -51,6 +53,7 @@ Filter::MatchMore(std::span<const std::byte> raw) const noexcept
 			return false;
 
 		return MatchFilter(d.host, hosts) &&
+			MatchFilter(d.generator, generators) &&
 			MatchHttpUriStartsWith(d.http_uri, http_uri_starts_with);
 	} catch (...) {
 		return false;

src/Filter.cxx

@@ -17,7 +17,7 @@ struct SmallDatagram;
 namespace Net { namespace Log { struct Datagram; }}
 
 struct Filter {
-	std::set<std::string, std::less<>> sites, hosts;
+	std::set<std::string, std::less<>> sites, hosts, generators;
 
 	std::string http_uri_starts_with;
 

src/Filter.hxx

@@ -115,6 +115,12 @@ enum class PondRequestCommand : uint16_t {
 	 * exact string to compare with.
 	 */
 	FILTER_HOST = 17,
+
+	/**
+	 * Specify a filter on the "generator" attribute.  Payload is
+	 * the exact string to compare with.
+	 */
+	FILTER_GENERATOR = 18,
 };
 
 enum class PondResponseCommand : uint16_t {

src/Protocol.hxx

@@ -38,6 +38,9 @@ FormatJson(char *buffer, char *end,
 	if (d.analytics_id != nullptr)
 		o.AddMember("analytics_id", d.analytics_id);
 
+	if (d.generator != nullptr)
+		o.AddMember("generator", d.generator);
+
 	if (d.forwarded_to != nullptr)
 		o.AddMember("forwarded_to", d.forwarded_to);
 

src/client/FormatJson.cxx

@@ -138,6 +138,9 @@ ParseFilterItem(Filter &filter, PondGroupSitePayload &group_site,
 	} else if (auto host = IsFilter(p, "host")) {
 		if (!filter.hosts.emplace(host).second)
 			throw "Duplicate host name";
+	} else if (auto generator = IsFilter(p, "generator")) {
+		if (!filter.generators.emplace(generator).second)
+			throw "Duplicate generator name";
 	} else if (auto since = IsFilter(p, "since")) {
 		auto t = ParseTimePoint(since);
 		filter.since = Net::Log::FromSystem(t.first);
@@ -270,6 +273,9 @@ Query(const PondServerSpecification &server, ConstBuffer<const char *> args)
 	for (const auto &i : filter.hosts)
 		client.Send(id, PondRequestCommand::FILTER_HOST, i);
 
+	for (const auto &i : filter.generators)
+		client.Send(id, PondRequestCommand::FILTER_GENERATOR, i);
+
 	const bool single_site = filter.sites.begin() != filter.sites.end() &&
 		std::next(filter.sites.begin()) == filter.sites.end();
 
@@ -575,6 +581,7 @@ try {
 			   "    [site=VALUE] [group_site=[MAX][@SKIP]]\n"
 			   "    [host=VALUE]\n"
 			   "    [uri-prefix=VALUE]\n"
+			   "    [generator=VALUE]\n"
 			   "    [since=ISO8601] [until=ISO8601] [date=YYYY-MM-DD] [today]\n"
 			   "    [window=COUNT[@SKIP]]\n"
 			   "  stats\n"