include/modules/exemption.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2017, 2019 Sadie Powell <sadie@witchery.services>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 #include "event.h"
  23
  24 namespace CheckExemption
  25 {
  26         class EventListener;
  27         class EventProvider;
  28
  29         /** Helper function for calling the CheckExemption::EventListener::OnCheckExemption event.
  30          * @param prov The CheckExemption::EventProvider which is calling the event.
  31          * @param user The user to check exemption for.
  32          * @param chan The channel to check exemption on.
  33          * @param restriction The restriction to check for.
  34          * @return Either MOD_RES_ALLOW if the exemption was confirmed, MOD_RES_DENY if the exemption was
  35          *         denied or MOD_RES_PASSTHRU if no module handled the event.
  36          */
  37         inline ModResult Call(const CheckExemption::EventProvider& prov, User* user, Channel* chan, const std::string& restriction);
  38 }
  39
  40 class CheckExemption::EventListener
  41         : public Events::ModuleEventListener
  42 {
  43  protected:
  44         EventListener(Module* mod, unsigned int eventprio = DefaultPriority)
  45                 : ModuleEventListener(mod, "event/exemption", eventprio)
  46         {
  47         }
  48
  49  public:
  50         /** Called when checking if a user is exempt from something.
  51          * @param user The user to check exemption for.
  52          * @param chan The channel to check exemption on.
  53          * @param restriction The restriction to check for.
  54          * @return Either MOD_RES_ALLOW to confirm an exemption, MOD_RES_DENY to deny an exemption,
  55          *         or MOD_RES_PASSTHRU to let another module handle the event.
  56          */
  57         virtual ModResult OnCheckExemption(User* user, Channel* chan, const std::string& restriction) = 0;
  58 };
  59
  60 class CheckExemption::EventProvider
  61         : public Events::ModuleEventProvider
  62 {
  63  public:
  64         EventProvider(Module* mod)
  65                 : ModuleEventProvider(mod, "event/exemption")
  66         {
  67         }
  68 };
  69
  70 inline ModResult CheckExemption::Call(const CheckExemption::EventProvider& prov, User* user, Channel* chan, const std::string& restriction)
  71 {
  72         ModResult result;
  73         FIRST_MOD_RESULT_CUSTOM(prov, CheckExemption::EventListener, OnCheckExemption, result, (user, chan, restriction));
  74         return result;
  75 }