/* BotServ core functions
 *
 * (C) 2003-2014 Anope Team
 * Contact us at team@anope.org
 *
 * Please read COPYING and README for further details.
 *
 * Based on the original code of Epona by Lara.
 * Based on the original code of Services by Andy Church.
 *
 *
 */

/** Flags for badwords
 */
enum BadWordType
{
	/* Always kicks if the word is said */
	BW_ANY,
	/* User must say the entire word */
	BW_SINGLE,
	/* The word has to start with the badword */
	BW_START,
	/* The word has to end with the badword */
	BW_END
};

/* Structure used to contain bad words. */
class BadWord : public Serialize::Object
{
 protected:
	using Serialize::Object::Object;
 public:
	static constexpr const char *NAME = "badword";
	 
	virtual ~BadWord() = default;

	virtual ChanServ::Channel *GetChannel() anope_abstract;
	virtual void SetChannel(ChanServ::Channel *) anope_abstract;

	virtual Anope::string GetWord() anope_abstract;
	virtual void SetWord(const Anope::string &) anope_abstract;

	virtual BadWordType GetType() anope_abstract;
	virtual void SetType(const BadWordType &) anope_abstract;
};

class BadWords : public Service
{
 public:
	static constexpr const char *NAME = "badwords";
	
	BadWords(Module *me) : Service(me, NAME) { }

	/** Add a badword to the badword list
	 * @param word The badword
	 * @param type The type (SINGLE START END)
	 * @return The badword
	 */
	virtual BadWord* AddBadWord(ChanServ::Channel *, const Anope::string &word, BadWordType type) anope_abstract;

	virtual std::vector<BadWord *> GetBadWords(ChanServ::Channel *ci) anope_abstract;

	/** Get a badword structure by index
	 * @param index The index
	 * @return The badword
	 */
	virtual BadWord* GetBadWord(ChanServ::Channel *, unsigned index) anope_abstract;

	/** Get how many badwords are on this channel
	 * @return The number of badwords in the vector
	 */
	virtual unsigned GetBadWordCount(ChanServ::Channel *) anope_abstract;

	/** Remove a badword
	 * @param index The index of the badword
	 */
	virtual void EraseBadWord(ChanServ::Channel *, unsigned index) anope_abstract;

	/** Clear all badwords from the channel
	 */
	virtual void ClearBadWords(ChanServ::Channel *) anope_abstract;
};

namespace Event
{
	struct CoreExport BadWordEvents : Events
	{
		static constexpr const char *NAME = "badwords";

		using Events::Events;

		/** Called before a badword is added to the badword list
		 * @param ci The channel
		 * @param bw The badword
		 */
		virtual void OnBadWordAdd(ChanServ::Channel *ci, const BadWord *bw) anope_abstract;

		/** Called before a badword is deleted from a channel
		 * @param ci The channel
		 * @param bw The badword
		 */
		virtual void OnBadWordDel(ChanServ::Channel *ci, const BadWord *bw) anope_abstract;
	};
}