Sync helpop chmodes s and p with docs

[user/henk/code/inspircd.git] / src / modules / m_randquote.cpp

diff --git a/src/modules/m_randquote.cpp b/src/modules/m_randquote.cpp
index 435c41453ae4834ce53781e912bc83a8a5df115b..0148e48d6c0e780c9c1d0bf76e46f964bba5faae 100644 (file)
--- a/src/modules/m_randquote.cpp
+++ b/src/modules/m_randquote.cpp
@@ -1,134 +1,58 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2013, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2003, 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
-
-static FileReader *quotes = NULL;
-
-std::string q_file;
-std::string prefix;
-std::string suffix;
-
-/* $ModDesc: Provides random Quotes on Connect. */
-
-/** Handle /RANDQUOTE
- */
-class cmd_randquote : public Command
-{
- public:
-       cmd_randquote (InspIRCd* Instance) : Command(Instance,"RANDQUOTE", 0, 0)
-       {
-               this->source = "m_randquote.so";
-       }
 
-       CmdResult Handle (const char** parameters, int pcntl, User *user)
-       {
-               std::string str;
-               int fsize;
-
-               if (q_file.empty() || quotes->Exists())
-               {
-                       fsize = quotes->FileSize();
-                       str = quotes->GetLine(rand() % fsize);
-                       user->WriteServ("NOTICE %s :%s%s%s",user->nick,prefix.c_str(),str.c_str(),suffix.c_str());
-               }
-               else
-               {
-                       user->WriteServ("NOTICE %s :Your administrator specified an invalid quotes file, please bug them about this.", user->nick);
-                       return CMD_FAILURE;
-               }
-
-               return CMD_LOCALONLY;
-       }
-};
+#include "inspircd.h"
 
-/** Thrown by m_randquote
- */
-class RandquoteException : public ModuleException
+class ModuleRandQuote : public Module
 {
  private:
-       const std::string err;
- public:
-       RandquoteException(const std::string &message) : err(message) { }
-
-       ~RandquoteException() throw () { }
+       std::string prefix;
+       std::string suffix;
+       std::vector<std::string> quotes;
 
-       virtual const char* GetReason()
+ public:
+       void init() CXX11_OVERRIDE
        {
-               return err.c_str();
+               ConfigTag* conf = ServerInstance->Config->ConfValue("randquote");
+               prefix = conf->getString("prefix");
+               suffix = conf->getString("suffix");
+               FileReader reader(conf->getString("file", "quotes", 1));
+               quotes = reader.GetVector();
        }
-};
 
-class ModuleRandQuote : public Module
-{
- private:
-       cmd_randquote* mycommand;
-       ConfigReader *conf;
- public:
-       ModuleRandQuote(InspIRCd* Me)
-               : Module(Me)
+       void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
        {
-               
-               conf = new ConfigReader(ServerInstance);
-               // Sort the Randomizer thingie..
-               srand(time(NULL));
-
-               q_file = conf->ReadValue("randquote","file",0);
-               prefix = conf->ReadValue("randquote","prefix",0);
-               suffix = conf->ReadValue("randquote","suffix",0);
-
-               mycommand = NULL;
-
-               if (q_file.empty())
+               if (!quotes.empty())
                {
-                       RandquoteException e("m_randquote: Quotefile not specified - Please check your config.");
-                       throw(e);
-               }
-
-               quotes = new FileReader(ServerInstance, q_file);
-               if(!quotes->Exists())
-               {
-                       RandquoteException e("m_randquote: QuoteFile not Found!! Please check your config - module will not function.");
-                       throw(e);
-               }
-               else
-               {
-                       /* Hidden Command -- Mode clients assume /quote sends raw data to an IRCd >:D */
-                       mycommand = new cmd_randquote(ServerInstance);
-                       ServerInstance->AddCommand(mycommand);
+                       unsigned long random = ServerInstance->GenRandomInt(quotes.size());
+                       user->WriteNotice(prefix + quotes[random] + suffix);
                }
        }
 
-       void Implements(char* List)
-       {
-               List[I_OnUserConnect] = 1;
-       }
-       
-       virtual ~ModuleRandQuote()
-       {
-               DELETE(conf);
-               DELETE(quotes);
-       }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1,1,0,1,VF_VENDOR,API_VERSION);
-       }
-       
-       virtual void OnUserConnect(User* user)
+       Version GetVersion() CXX11_OVERRIDE
        {
-               if (mycommand)
-                       mycommand->Handle(NULL, 0, user);
+               return Version("Allows random quotes to be sent to users when they connect to the server.", VF_VENDOR);
        }
 };