From: Peter Powell <petpow@saberuk.com>
Date: Wed, 12 Jun 2019 11:42:47 +0000 (+0100)
Subject: Add an API for accessing a batch end event.
X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=9b35c4c78cb15bdae0431f1425983bc41150fee5;p=user%2Fhenk%2Fcode%2Finspircd.git

Add an API for accessing a batch end event.

This is essentially identical to the one for the start event.
---

diff --git a/include/modules/ircv3_batch.h b/include/modules/ircv3_batch.h
index 841554bdb..7708e8d01 100644
--- a/include/modules/ircv3_batch.h
+++ b/include/modules/ircv3_batch.h
@@ -89,6 +89,7 @@ class IRCv3::Batch::Batch
 	unsigned int bit;
 	BatchInfo* batchinfo;
 	ClientProtocol::Message* batchstartmsg;
+	ClientProtocol::Message* batchendmsg;
 
 	void Setup(unsigned int b)
 	{
@@ -158,6 +159,15 @@ class IRCv3::Batch::Batch
 	 */
 	ClientProtocol::Message& GetBatchStartMessage() { return *batchstartmsg; }
 
+	/** Get the batch end client protocol message.
+	 * The returned message object can be manipulated to add extra parameters or labels to the message. The first
+	 * parameter of the message is the batch reference tag generated by the module providing batch support.
+	 * If the batch type string was specified, it will be the second parameter of the message.
+	 * May only be called if IsRunning() == true.
+	 * @return Mutable batch end client protocol message.
+	 */
+	ClientProtocol::Message& GetBatchEndMessage() { return *batchendmsg; }
+
 	friend class ManagerImpl;
 };
 
diff --git a/src/modules/m_ircv3_batch.cpp b/src/modules/m_ircv3_batch.cpp
index df2b00f49..91ff0b140 100644
--- a/src/modules/m_ircv3_batch.cpp
+++ b/src/modules/m_ircv3_batch.cpp
@@ -44,10 +44,14 @@ struct IRCv3::Batch::BatchInfo
 	std::vector<LocalUser*> users;
 	BatchMessage startmsg;
 	ClientProtocol::Event startevent;
+	BatchMessage endmsg;
+	ClientProtocol::Event endevent;
 
 	BatchInfo(ClientProtocol::EventProvider& protoevprov, IRCv3::Batch::Batch& b)
 		: startmsg(b, true)
 		, startevent(protoevprov, startmsg)
+		, endmsg(b, false)
+		, endevent(protoevprov, endmsg)
 	{
 	}
 };
@@ -151,6 +155,7 @@ class IRCv3::Batch::ManagerImpl : public Manager
 		batch.manager = this;
 		batch.batchinfo = new IRCv3::Batch::BatchInfo(protoevprov, batch);
 		batch.batchstartmsg = &batch.batchinfo->startmsg;
+		batch.batchendmsg = &batch.batchinfo->endmsg;
 		active_batches.push_back(&batch);
 	}
 
@@ -164,12 +169,10 @@ class IRCv3::Batch::ManagerImpl : public Manager
 
 		BatchInfo& batchinfo = *batch.batchinfo;
 		// Send end batch message to all users who got the batch start message and unset bit so it can be reused
-		BatchMessage endbatchmsg(batch, false);
-		ClientProtocol::Event endbatchevent(protoevprov, endbatchmsg);
 		for (std::vector<LocalUser*>::const_iterator i = batchinfo.users.begin(); i != batchinfo.users.end(); ++i)
 		{
 			LocalUser* const user = *i;
-			user->Send(endbatchevent);
+			user->Send(batchinfo.endevent);
 			batchbits.set(user, batchbits.get(user) & ~batch.GetBit());
 		}