X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=03540018b85d7816266ef304441427a34e7e2400;hb=30fc51c6ddca487a1b89da9ab0ab59da003aee36;hp=4029daa5346bccd899d44853a5c44cc6f9971fd7;hpb=393cc8f9d65aefd92628115edae341562ea440e7;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/users.h b/include/users.h
index 4029daa53..03540018b 100644
--- a/include/users.h
+++ b/include/users.h
@@ -248,6 +248,22 @@ class CoreExport User : public Extensible
 	std::bitset<ModeParser::MODEID_MAX> modes;
 
  public:
+	/** To execute a function for each local neighbor of a user, inherit from this class and
+	 * pass an instance of it to User::ForEachNeighbor().
+	 */
+	class ForEachNeighborHandler
+	{
+	 public:
+		/** Method to execute for each local neighbor of a user.
+		 * Derived classes must implement this.
+		 * @param user Current neighbor
+		 */
+		virtual void Execute(LocalUser* user) = 0;
+	};
+
+	/** List of Memberships for this user
+	 */
+	typedef insp::intrusive_list<Membership> ChanList;
 
 	/** Hostname of connection.
 	 * This should be valid as per RFC1035.
@@ -302,7 +318,7 @@ class CoreExport User : public Extensible
 
 	/** Channels this user is on
 	 */
-	UserChanList chans;
+	ChanList chans;
 
 	/** The server the user is connected to.
 	 */
@@ -532,12 +548,15 @@ class CoreExport User : public Extensible
 	 */
 	void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
-	/** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
-	 * quit message for opers only.
-	 * @param normal_text Normal user quit message
-	 * @param oper_text Oper only quit message
+	/** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
+	 * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
+	 * This function is used for example to send something conditionally to neighbors, or to send different messages
+	 * to different users depending on their oper status.
+	 * @param handler Function object to call, inherited from ForEachNeighborHandler.
+	 * @param include_self True to include this user in the set of neighbors, false otherwise.
+	 * Modules may override this. Has no effect if this user is not local.
 	 */
-	void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
+	void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
 
 	/** Dump text to a user target, splitting it appropriately to fit
 	 * @param linePrefix text to prefix each complete line with
@@ -588,7 +607,7 @@ class CoreExport User : public Extensible
 	bool ChangeName(const std::string& gecos);
 
 	/** Change a user's nick
-	 * @param newnick The new nick
+	 * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
 	 * @return True if the change succeeded
 	 */
 	bool ChangeNick(const std::string& newnick, time_t newts = 0);
@@ -622,7 +641,7 @@ class CoreExport UserIOHandler : public StreamSocket
 
 typedef unsigned int already_sent_t;
 
-class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public intrusive_list_node<LocalUser>
+class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
 {
  public:
 	LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
@@ -729,27 +748,6 @@ class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public i
 	void Write(const std::string& text);
 	void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
 
-	/** Returns the list of channels this user has been invited to but has not yet joined.
-	 * @return A list of channels the user is invited to
-	 */
-	InviteList& GetInviteList();
-
-	/** Returns true if a user is invited to a channel.
-	 * @param chan A channel to look up
-	 * @return True if the user is invited to the given channel
-	 */
-	bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
-
-	/** Removes a channel from a users invite list.
-	 * This member function is called on successfully joining an invite only channel
-	 * to which the user has previously been invited, to clear the invitation.
-	 * @param chan The channel to remove the invite to
-	 * @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
-	 */
-	bool RemoveInvite(Channel* chan);
-
-	void RemoveExpiredInvites();
-
 	/** Returns true or false for if a user can execute a privilaged oper command.
 	 * This is done by looking up their oper type from User::oper, then referencing
 	 * this to their oper classes and checking the commands they can execute.