summaryrefslogtreecommitdiff
path: root/include/accessgroup.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/accessgroup.h')
-rw-r--r--include/accessgroup.h62
1 files changed, 62 insertions, 0 deletions
diff --git a/include/accessgroup.h b/include/accessgroup.h
new file mode 100644
index 000000000..76d30f622
--- /dev/null
+++ b/include/accessgroup.h
@@ -0,0 +1,62 @@
+/*
+ * Anope IRC Services
+ *
+ * Copyright (C) 2011-2017 Anope Team <team@anope.org>
+ *
+ * This file is part of Anope. Anope 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 see <http://www.gnu.org/licenses/>.
+ */
+
+#include "modules/chanserv.h"
+
+#pragma once
+
+namespace ChanServ
+{
+
+/* A group of access entries. This is used commonly, for example with ChanServ::Channel::AccessFor,
+ * to show what access a user has on a channel because users can match multiple access entries.
+ */
+class CoreExport AccessGroup : public std::vector<ChanAccess *>
+{
+ public:
+ /* Channel these access entries are on */
+ ChanServ::Channel *ci = nullptr;
+ /* Account these entries affect, if any */
+ const NickServ::Account *nc = nullptr;
+ /* super_admin always gets all privs. founder is a special case where ci->founder == nc */
+ bool super_admin = false, founder = false;
+
+ /** Check if this access group has a certain privilege. Eg, it
+ * will check every ChanAccess entry of this group for any that
+ * has the given privilege.
+ * @param priv The privilege
+ * @return true if any entry has the given privilege
+ */
+ bool HasPriv(const Anope::string &priv);
+
+ /** Get the "highest" access entry from this group of entries.
+ * The highest entry is determined by the entry that has the privilege
+ * with the highest rank (see Privilege::rank).
+ * @return The "highest" entry
+ */
+ ChanAccess *Highest() const;
+
+ /* Comparison operators to other AccessGroups */
+ bool operator>(AccessGroup &other);
+ bool operator<(AccessGroup &other);
+ bool operator>=(AccessGroup &other);
+ bool operator<=(AccessGroup &other);
+};
+
+} // namespace ChanServ