include/modules/exemption.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2016-2017 Peter Powell <petpow@saberuk.com>
   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
  30 class CheckExemption::EventListener
  31         : public Events::ModuleEventListener
  32 {
  33  protected:
  34         EventListener(Module* mod)
  35                 : ModuleEventListener(mod, "event/exemption")
  36         {
  37         }
  38
  39  public:
  40         /** Called when checking if a user is exempt from something.
  41          * @param user The user to check exemption for.
  42          * @param chan The channel to check exemption on.
  43          * @param restriction The restriction to check for.
  44          * @return Either MOD_RES_ALLOW to confirm an exemption, MOD_RES_DENY to deny an exemption,
  45          *         or MOD_RES_PASSTHRU to let another module handle the event.
  46          */
  47         virtual ModResult OnCheckExemption(User* user, Channel* chan, const std::string& restriction) = 0;
  48 };
  49
  50 class CheckExemption::EventProvider
  51         : public Events::ModuleEventProvider
  52 {
  53  public:
  54         EventProvider(Module* mod)
  55                 : ModuleEventProvider(mod, "event/exemption")
  56         {
  57         }
  58 };