1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
#--depends-on check_mode
#--depends-on commands
#--depends-on permissions
import binascii, enum, os, uuid
from src import ModuleManager, utils
STR_NOVOTE = "Unknown vote '%s'"
class VoteCastResult(enum.Enum):
Cast = 1
Changed = 2
Unchanged = 3
@utils.export("channelset", utils.BoolSetting("votes-start-restricted",
"Whether starting a vote should be restricted to ops"))
@utils.export("channelset", utils.BoolSetting("votes-cast-restricted",
"Whether casting a vote should be restricted to voiced-and-above users"))
class Module(ModuleManager.BaseModule):
def _get_vote(self, channel, vote_id):
return channel.get_setting("vote-%s" % vote_id, None)
def _set_vote(self, channel, vote_id, vote):
channel.set_setting("vote-%s" % vote_id, vote)
def _random_id(self, channel):
while True:
vote_id = binascii.hexlify(os.urandom(3)).decode("ascii")
if self._get_vote(channel, vote_id) == None:
return vote_id
def _close_vote(self, channel, vote_id):
vote = self._get_vote(channel, vote_id)
if vote:
vote["open"] = False
self._set_vote(channel, vote_id, vote)
return True
return False
def _start_vote(self, channel, description):
vote_id = self._random_id(channel)
vote = {"description": description, "options": {"yes": [], "no": []},
"electorate": [], "open": True, "id": vote_id}
self._set_vote(channel, vote_id, vote)
return vote
def _format_vote(self, vote):
options = ["%d %s" % (len(v), k) for k, v in vote["options"].items()]
return "%s (%s)" % (vote["description"], ", ".join(options))
def _format_options(self, vote):
return ", ".join("'%s'" % o for o in vote["options"])
def _cast_vote(self, channel, vote_id, user, chosen_option):
vote = self._get_vote(channel, vote_id)
option_nicks = vote["options"][chosen_option]
cast_type = VoteCastResult.Cast
for option, nicks in vote["options"].items():
if user.name in nicks:
if option == chosen_option:
return VoteCastResult.Unchanged
else:
nicks.remove(user.name)
cast_type = VoteCastResult.Changed
break
option_nicks.append(user.name)
self._set_vote(channel, vote_id, vote)
return cast_type
def _open_votes(self, channel):
open = []
for setting, vote in channel.find_settings(prefix="vote-"):
if vote["open"]:
open.append(vote)
return open
@utils.hook("received.command.startvote", channel_only=True, min_args=1)
def start_vote(self, event):
"""
:help: Start a vote
:usage: <description>
"""
if event["target"].get_setting("votes-start-restricted", True):
event["check_assert"](utils.Check("channel-mode", "o")|
utils.Check("permission", "vote")|
utils.Check("channel-access", "vote"))
vote = self._start_vote(event["target"], event["args"])
event["stdout"].write(
"Vote %s started. use '%svote %s <option>' to vote (options: %s)" %
(vote["id"], event["command_prefix"], vote["id"],
self._format_options(vote)))
@utils.hook("received.command.endvote", channel_only=True, min_args=1)
def end_vote(self, event):
"""
:help: End a vote
:usage: <id>
:require_mode: o
:require_access: vote
:permission: vote
"""
vote_id = event["args_split"][0]
if self._close_vote(event["target"], vote_id):
vote = self._get_vote(event["target"], vote_id)
event["stdout"].write("Vote %s ended: %s" %
(vote_id, self._format_vote(vote)))
else:
event["stderr"].write(STR_NOVOTE % vote_id)
@utils.hook("received.command.vote", channel_only=True, min_args=1)
def vote(self, event):
"""
:help: Cast choice for a given vote
:usage: <id> [choice]
"""
if event["target"].get_setting("votes-scast-restricted", True):
event["check_assert"](utils.Check("channel-mode", "v")|
utils.Check("permission", "vote")|
utils.Check("channel-access", "vote"))
vote_id = event["args_split"][0]
vote = self._get_vote(event["target"], vote_id)
if vote == None:
raise utils.EventError(STR_NOVOTE % vote_id)
if not len(event["args_split"]) > 1:
closed = "" if vote["open"] else " (closed)"
event["stdout"].write("Vote %s%s: %s" % (
vote_id, closed, self._format_vote(vote)))
else:
if not vote["open"]:
raise utils.EventError("%s: vote %s is closed" % (
event["user"].nickname, vote_id))
choice = event["args_split"][1].lower()
if not choice in vote["options"]:
raise utils.EventError("Vote options: %s" %
self._format_options(vote))
cast_result = self._cast_vote(event["target"], vote_id,
event["user"], choice)
cast_desc = "has been cast"
if cast_result == VoteCastResult.Changed:
cast_desc = "has been changed"
elif cast_result == VoteCastResult.Unchanged:
cast_desc = "is unchanged"
event["stdout"].write("%s: your vote %s." %
(event["user"].nickname, cast_desc))
@utils.hook("received.command.votes", channel_only=True)
def votes(self, event):
"""
:help: List open votes in the current channel
"""
open_votes = self._open_votes(event["target"])
if open_votes:
open_votes_str = [
"%s (%s)" % (v["description"], v["id"]) for v in open_votes]
event["stdout"].write("Open votes: %s" % ", ".join(open_votes_str))
else:
event["stderr"].write("There are no open votes")
|
