├── Procfile ├── voting ├── vote_types │ ├── con_vote.py │ ├── vis_vote.py │ ├── reaction_roles.py │ ├── stv_vote.py │ ├── stv.py │ └── std_vote.py ├── symbols.py ├── vote_manager.py ├── parsers.py ├── voteDB.py └── vote_commands.py ├── requirements.txt ├── db ├── __init__.py ├── build.sql └── db.py ├── react_decorators.py ├── README.md ├── votebot.py └── LICENSE /Procfile: -------------------------------------------------------------------------------- 1 | worker: python votebot.py -------------------------------------------------------------------------------- /voting/vote_types/con_vote.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | discord.py 2 | psycopg2-binary -------------------------------------------------------------------------------- /db/__init__.py: -------------------------------------------------------------------------------- 1 | from . import db 2 | 3 | db.build() 4 | -------------------------------------------------------------------------------- /react_decorators.py: -------------------------------------------------------------------------------- 1 | import functools 2 | from discord.ext.commands import Context 3 | 4 | 5 | def wait_react(func): 6 | @functools.wraps(func) 7 | async def decorator(*args, **kwargs): 8 | ctx: Context = next(a for a in args if isinstance(a, Context)) 9 | await ctx.message.add_reaction("🕐") 10 | await func(*args, **kwargs) 11 | await ctx.message.remove_reaction("🕐", ctx.me) 12 | return decorator 13 | 14 | 15 | def done_react(func): 16 | @functools.wraps(func) 17 | async def decorator(*args, **kwargs): 18 | ctx: Context = next(a for a in args if isinstance(a, Context)) 19 | await func(*args, **kwargs) 20 | await ctx.message.add_reaction("👍") 21 | return decorator 22 | 23 | 24 | def remove_command(func): 25 | @functools.wraps(func) 26 | async def decorator(*args, **kwargs): 27 | ctx: Context = next(a for a in args if isinstance(a, Context)) 28 | await func(*args, **kwargs) 29 | await ctx.message.delete() 30 | return decorator 31 | -------------------------------------------------------------------------------- /db/build.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS Prefix ( 2 | GuildID BIGINT PRIMARY KEY, 3 | Prefix TEXT DEFAULT '+' 4 | ); 5 | 6 | CREATE TABLE IF NOT EXISTS Votes ( 7 | VoteID BIGSERIAL PRIMARY KEY, 8 | CreatorID BIGINT, 9 | Question TEXT DEFAULT 'Poll', 10 | VoteLimit INTEGER DEFAULT 0, 11 | GuildID BIGINT NOT NULL, 12 | ChannelID BIGINT NOT NULL, 13 | PollStage INTEGER NOT NULL, 14 | Type INTEGER NOT NULL, 15 | NumWinners INTEGER DEFAULT 1, 16 | CreationDate TIMESTAMP DEFAULT NOW() 17 | ); 18 | -- Stage: 0 = Created, 1 = Posted, 2 = Reactions added - running, -1 = Finished 19 | -- Type: 0 = Quick Poll, 1 = Standard Poll, 2 = STV Poll 20 | 21 | CREATE TABLE IF NOT EXISTS Options ( 22 | VoteID BIGINT, 23 | OptionNumb INTEGER, 24 | Prompt TEXT NOT NULL, 25 | PRIMARY KEY (VoteID, OptionNumb), 26 | FOREIGN KEY (VoteID) REFERENCES Votes(VoteID) ON DELETE CASCADE 27 | ); 28 | 29 | CREATE TABLE IF NOT EXISTS VoteMessages ( 30 | VoteID BIGINT, 31 | MessageID BIGINT, 32 | Part INTEGER NOT NULL, 33 | PRIMARY KEY (MessageID), 34 | FOREIGN KEY (VoteID) REFERENCES Votes(VoteID) ON DELETE CASCADE 35 | ); 36 | 37 | CREATE TABLE IF NOT EXISTS UserVote ( 38 | VoteID BIGINT, 39 | UserID BIGINT, 40 | Choice INTEGER NOT NULL, 41 | Preference INTEGER NOT NULL, 42 | PRIMARY KEY (VoteID, UserID, Choice), 43 | FOREIGN KEY (VoteID) REFERENCES Votes(VoteID) ON DELETE CASCADE 44 | ); -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VoteBot 2 | 3 | Discord voting bot capable of standard polls, as found in many other bots; anonymous polls, where votes are hidden and totals are only displayed at the end; 4 | and STV (Single Transferable Vote) polls, where users rank their choices, which is combined to find your set of winning options. This all supports up to **256 options**, 5 | though due to Discord's message and API restrictions, large numbers of options are discouraged due to the time it will take to post the messages and add the reactions. 6 | This bot also supports limiting votes per user and a variable number of winners for STV. 7 | 8 | I plan to support other voting methods (including STV variants) in the future. Currently, the STV ruleset supported is taken from Scottish Local Elections. 9 | I also plan to improve handling of reaction counting, as multiple simultaneous votes can lead to some being ignored. 10 | 11 | 12 | **Quick Poll Example** 13 | 14 | ![image](https://user-images.githubusercontent.com/8903016/114238390-6f770e80-997c-11eb-8176-cb1f3e0eb111.png) 15 | 16 | **Anonymous Poll Example** 17 | 18 | ![image](https://user-images.githubusercontent.com/8903016/114238757-0d6ad900-997d-11eb-9bd8-85b2a89f2106.png) 19 | 20 | ![image](https://user-images.githubusercontent.com/8903016/114238819-21163f80-997d-11eb-826f-25d025159669.png) 21 | 22 | **STV Poll Example** 23 | 24 | ![image](https://user-images.githubusercontent.com/8903016/114240445-6a678e80-997f-11eb-8a6a-5072b26d7a7c.png) 25 | 26 | ![image](https://user-images.githubusercontent.com/8903016/114240575-a3076800-997f-11eb-9239-4a25078fc9c6.png) 27 | -------------------------------------------------------------------------------- /voting/vote_types/vis_vote.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | 3 | from voting.vote_types.std_vote import StdVote 4 | 5 | import discord 6 | from discord.ext.commands import Context 7 | 8 | from voting.symbols import * 9 | 10 | 11 | class VisibleVote(StdVote): 12 | def __init__(self, bot): 13 | super().__init__(bot) 14 | self.remove_reactions = False 15 | self.clear = False 16 | 17 | async def on_react_add(self, emoji: str, msg: discord.Message, user: discord.Member, t: tuple) -> None: 18 | if user.bot: return 19 | voteID, part, _, limit, _ = t 20 | 21 | # Process vote 22 | result = self.react_action(user, emoji, voteID, part, limit, msg) 23 | if result == "over limit" or not result: await msg.remove_reaction(emoji, user) 24 | 25 | # Send DM with confirmation 26 | if result: 27 | await self.give_feedback(result, user, indexes.get(emoji, -1), voteID, limit) 28 | 29 | 30 | def react_action(self, user: discord.Member, em: str, voteID: int, part: int, limit: int, msg) -> Union[str, tuple[str, list[int]]]: 31 | if voteID is None: return "" 32 | if user.bot: return "" 33 | 34 | ind = indexes.get(em, -1) 35 | if not (part <= ind < part + 20): 36 | return "" 37 | else: 38 | return self.count_vote(ind, user, voteID, limit) 39 | 40 | 41 | async def on_react_remove(self, emoji: str, msg: discord.Message, user: discord.Member, t: tuple) -> None: 42 | return await self.on_react_add(emoji, msg, user, t) 43 | 44 | 45 | async def create_vote(self, ctx: Context, args, desc=None, type=0, title_pre="Visible Poll") -> None: 46 | await super().create_vote(ctx, args, desc, type=type, title_pre=title_pre) 47 | 48 | -------------------------------------------------------------------------------- /voting/symbols.py: -------------------------------------------------------------------------------- 1 | TEMP_DATA_PATH = "./data/temp" 2 | 3 | clear_symbol = "❌" 4 | # List of symbols to use in reacts. Discord formats of these strangely 5 | symbols = [ 6 | "1️⃣", "2⃣", "3⃣", "4⃣", "5⃣", "6⃣", "7⃣", "8⃣", "9⃣", "🔟", "🇦", "🇧", "🇨", "🇩", "🇪", "🇫", "🇬", "🇭", "🇮", "🇯", "🇰", "🇱", "🇲", "🇳", "🇴", "🇵", "🇶", "🇷", "🇸", "🇹", "🇺", "🇻", "🇼", "🇽", "🇾", "🇿", 7 | "⚪", "🔴", "🟠", "🟡", "🟢", "🔵", "🟣", "🟤", "⬜", "🟥", "🟧", "🟨", "🟩", "🟦", "🟪", "🟫", "🤍", "❤️", "🧡", "💛", "💚", "💙", "💜", "🤎", 8 | "🐶", "🐱", "🐭", "🐹", "🐰", "🦊", "🐻", "🐼", "🐨", "🦁", "🐮", "🐷", "🐸", "🐵", "🐔", "🐧", "🐦", "🦆", "🦅", "🦉", "🦇", "🐺", "🐗", "🐴", "🦄", "🐝", "🐛", "🦋", "🐌", "🪱", "🐞", 9 | "🪳", "🪲", "🐢", "🦎", "🦕", "🐙", "🦑", "🦀", "🐠", "🐟", "🐬", "🦈", "🦓", "🐘", "🐪", "🦒", "🦚", "🦜", "🦢", "🦩", "🦔", 10 | "🌍", "🌕", "🪐", "⭐", "⚡", "💥", "🔥", "🌈", "☀️", "☁️", "❄️", "💨", "💧", 11 | "🌲", "🌳", "🌴", "🌿", "🍁", "🍄", "🐚", "🌾", "🌹", "🍏", "🍎", "🍐", "🍊", "🍋", "🍌", "🍉", "🍇", "🫐", "🍓", "🍈", "🍒", "🍍", 12 | "🥝", "🍆", "🥕", "🧄", "🥐", "🍞", "🧀", "🥞", "🥓", "🥩", "🍗", "🌭", "🍔", "🍟", "🍕", "🍨", "🍬", "🍫", "🍿", "🍩", "☕", "🍺", 13 | "⚽", "🏀", "🏈", "⚾", "🎾", "🏐", "🏉", "🪃", "🏓", "🏏", "🪁", "🛹", 14 | "🏆", "🥇", "🥈", "🥉", "🏅", "🎨", "🎬", "🥁", "🪘", "🎷", "🎺", "🎸", "🪗", "🎲", "♟️", "🎯", "🎳", "🧩", 15 | "🚗", "🚕", "🚙", "🚎", "🏎️", "🚑", "🚜", "🚨", "🚆", "✈️", "🚀", "🛸", "🚁", "⛵", "🚢", "⛽", "🗺️", "⛱️", "⛺", "🏛️", "⛩️", "🌠", "🎇", "🏙️", "🌉", 16 | "💻", "🖨️", "🖱️", "📀", "☎️", "🎙️", "⏰", "⌛", "💡", "🕯️", "🪙", "💎", "⚖️", "🔧", "🧱", "🧲", "🔫", "🛡️", "✉️", "📒", "📕", "📗", "📘", "📙", "📎", "🖌️", "📝", "🔒", "🔶", "🔷", "🔈", "🔔", 17 | ] 18 | 19 | indexes = {symbols[i]: i for i in range(len(symbols))} 20 | -------------------------------------------------------------------------------- /db/db.py: -------------------------------------------------------------------------------- 1 | import os 2 | import psycopg2 3 | 4 | from os.path import join 5 | BUILD_PATH = join(".", "db", "build.sql") 6 | 7 | 8 | try: DATABASE_URL = os.environ['DATABASE_URL'] 9 | except KeyError: DATABASE_URL = None 10 | 11 | conn = psycopg2.connect(DATABASE_URL) 12 | 13 | # cxn = connect(DB_PATH, check_same_thread=False) 14 | cur = conn.cursor() 15 | 16 | 17 | def with_commit(func): 18 | def inner(*args, **kwargs): 19 | v = func(*args, **kwargs) 20 | commit() 21 | return v 22 | return inner 23 | 24 | 25 | @with_commit 26 | def build(): 27 | scriptexec(BUILD_PATH) 28 | 29 | 30 | def close(): 31 | cur.close() 32 | conn.close() 33 | 34 | 35 | def commit(): 36 | conn.commit() 37 | 38 | 39 | def field(command, *values): 40 | cur.execute(command, tuple(values)) 41 | 42 | if (fetch := cur.fetchone()) is not None: 43 | return fetch[0] 44 | 45 | 46 | def record(command, *values): 47 | cur.execute(command, tuple(values)) 48 | 49 | return cur.fetchone() 50 | 51 | 52 | def records(command, *values): 53 | cur.execute(command, tuple(values)) 54 | 55 | return cur.fetchall() 56 | 57 | 58 | def column(command, *values): 59 | cur.execute(command, tuple(values)) 60 | 61 | return [item[0] for item in cur.fetchall()] 62 | 63 | 64 | def execute(command, *values): 65 | return cur.execute(command, tuple(values)) 66 | 67 | 68 | def executeF1(command, *values): 69 | cur.execute(command, tuple(values)) 70 | return cur.fetchone() 71 | 72 | 73 | def executeFAll(command, *values): 74 | cur.execute(command, tuple(values)) 75 | return cur.fetchall() 76 | 77 | 78 | def multiexec(command, valueset): 79 | return cur.executemany(command, valueset) 80 | 81 | 82 | def scriptexec(path): 83 | with open(path, "r", encoding="utf-8") as script: 84 | cur.execute(script.read()) 85 | print("PG Ran", path) 86 | -------------------------------------------------------------------------------- /voting/vote_manager.py: -------------------------------------------------------------------------------- 1 | import discord 2 | from discord.ext.commands import Bot, Context 3 | 4 | from voting import voteDB 5 | from voting.vote_types.reaction_roles import ReactionRoles 6 | from voting.vote_types.std_vote import StdVote 7 | from voting.vote_types.stv_vote import STVVote 8 | from voting.vote_types.vis_vote import VisibleVote 9 | 10 | 11 | class VoteManager: 12 | bot: Bot 13 | 14 | def __init__(self, bot): 15 | self.bot = bot 16 | 17 | def get_vote_type(self, t): 18 | if t == 0: return VisibleVote(self.bot) 19 | elif t == 1: return StdVote(self.bot) 20 | elif t == 2: return STVVote(self.bot) 21 | elif t == 100: return ReactionRoles(self.bot) 22 | else: return None 23 | 24 | 25 | async def visible_poll(self, ctx: Context, args): 26 | vv = VisibleVote(self.bot) 27 | await vv.create_vote(ctx, args) 28 | 29 | 30 | async def std_vote(self, ctx, args): 31 | sv = StdVote(self.bot) 32 | await sv.create_vote(ctx, args) 33 | 34 | 35 | async def stv_vote(self, ctx, args): 36 | stv = STVVote(self.bot) 37 | await stv.create_vote(ctx, args) 38 | 39 | 40 | async def reaction_roles(self, ctx, args): 41 | rr = ReactionRoles(self.bot) 42 | await rr.create_vote(ctx, args) 43 | 44 | 45 | 46 | async def on_reaction_add(self, r_event: discord.RawReactionActionEvent, emoji: str, message: discord.Message, user: discord.Member): 47 | t = voteDB.getMsgVote(r_event.message_id) 48 | 49 | if t is None: return 50 | vid, _, type, _, stage = t 51 | if stage < 0: return 52 | 53 | v = self.get_vote_type(type) 54 | print(t, v) 55 | if v: await v.on_react_add(emoji, message, user, t) 56 | 57 | async def on_reaction_remove(self, r_event: discord.RawReactionActionEvent, emoji: str, message: discord.Message, user: discord.Member): 58 | t = voteDB.getMsgVote(r_event.message_id) 59 | if t is None: return 60 | vid, _, type, _, stage = t 61 | if stage < 0: return 62 | 63 | v = self.get_vote_type(type) 64 | if v: await v.on_react_remove(emoji, message, user, t) 65 | 66 | 67 | async def close(self, vid): 68 | _, _, _, _, type, _ = voteDB.getVote(vid) 69 | v = self.get_vote_type(type) 70 | 71 | if v: await v.post_results(vid) 72 | 73 | 74 | async def halt(self, vid): 75 | _, _, _, _, type, _ = voteDB.getVote(vid) 76 | v = self.get_vote_type(type) 77 | 78 | if v: await v.halt(vid) 79 | 80 | -------------------------------------------------------------------------------- /voting/vote_types/reaction_roles.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | 3 | from voting import voteDB 4 | from voting.vote_types.std_vote import StdVote 5 | 6 | import discord 7 | from discord.ext.commands import Context 8 | 9 | from voting.symbols import * 10 | 11 | 12 | class ReactionRoles(StdVote): 13 | def __init__(self, bot): 14 | super().__init__(bot) 15 | self.clear = False 16 | self.close_desc = False 17 | 18 | 19 | def count_vote(self, ind: int, user: discord.Member, vid: int, limit: int) -> str: 20 | role_name = voteDB.getOptions(vid)[ind] 21 | # print(role_name[1].lower(), [r.name.lower() for r in user.roles]) 22 | role: discord.Role = next((r for r in user.roles if role_name[1].lower() == r.name.lower()), None) 23 | if not role: return "added vote" 24 | else: return "removed vote" 25 | 26 | 27 | async def give_feedback(self, result, user: discord.Member, index, vid, limit): 28 | await user.create_dm() 29 | print(f"Sending DM for {result} to {user}") 30 | 31 | options = [x[1] for x in voteDB.getOptions(vid)] 32 | 33 | if isinstance(result, tuple) and result[0] == "clear votes": 34 | await user.dm_channel.send(f"Reaction Action {vid}: Your roles have been cleared for:\n\t\t" + 35 | '\n\t\t'.join(f"{symbols[i]} **{options[i]}**" for i in result[1])) 36 | 37 | elif result == "added vote": 38 | role_name = voteDB.getOptions(vid)[index] 39 | role: discord.Role = next((r for r in user.guild.roles if role_name[1].lower() == r.name.lower()), None) 40 | await user.add_roles(role, atomic=True) 41 | await user.dm_channel.send(f"Reaction Action {vid}: Added role {symbols[index]} **{options[index]}**") 42 | 43 | elif result == "removed vote": 44 | role_name = voteDB.getOptions(vid)[index] 45 | role: discord.Role = next((r for r in user.roles if role_name[1].lower() == r.name.lower()), None) 46 | await user.remove_roles(role, atomic=True) 47 | await user.dm_channel.send(f"Reaction Action {vid}: Removed role {symbols[index]} **{options[index]}**") 48 | 49 | elif result == "over limit": 50 | await user.dm_channel.send( 51 | f"Poll {vid}: Your vote for **{options[index]}** was **not counted**. You have voted for the **maximum of {limit}** choices. \n" 52 | f"\t\t**Remove a vote** before voting again: \n\t\tYour current choices are:\n\t\t\t" + 53 | '\n\t\t\t'.join(f"{symbols[i]} **{options[i]}**" for i, _ in voteDB.getUserVotes(vid, user.id)) 54 | ) 55 | 56 | 57 | async def create_vote(self, ctx: Context, args, desc=None, type=100, title_pre="Reaction Roles") -> None: 58 | await super().create_vote(ctx, args, "", type=type, title_pre=title_pre) 59 | 60 | -------------------------------------------------------------------------------- /voting/parsers.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | from discord.ext.commands import ExpectedClosingQuoteError 4 | 5 | 6 | class ParseException(Exception): pass 7 | 8 | 9 | # Edits ArgumentParser to throw exception with message instead of argparse's default handling, which printed to stderr and called sys.exit (raised SystemExit). 10 | # which is a neater way to forward the message to discord and catching SystemExit is potentially bad if I wanted to use it elsewhere functionality 11 | class PollParser(argparse.ArgumentParser): 12 | def error(self, message): 13 | raise ParseException(self.format_usage() + f"\n{self.prog}: error: {message}\n") 14 | 15 | 16 | # Creates the parser for a poll command, allowing limit and show options 17 | poll_parser = PollParser(prog='+poll', description='Runs an anonymous poll of the given options. Use +close to end this poll.') 18 | poll_parser.add_argument("title", action="store", type=str, help="Title of the poll") 19 | win_arg = poll_parser.add_argument("-w", "--winners", dest="winners", action="store", type=int, default=1, help="Number of winners to select") 20 | lim_arg = poll_parser.add_argument("-l", "--limit", dest="limit", action="store", type=int, default=0, help="Maximum amount of choices per user. 0 allows infinite") 21 | opt_arg = poll_parser.add_argument("options", action="store", nargs="*", help="Options in the poll. At least 2 must be given.") 22 | 23 | # Creates the parser for a poll command, allowing limit and show options 24 | vis_poll_parser = PollParser(prog='+vpoll', description='Runs a non-anonymous poll. Votes are visible to all. Use +close to end this poll.') 25 | vis_poll_parser.add_argument("title", action="store", type=str, help="Title of the poll") 26 | vis_poll_parser.add_argument("-w", "--winners", dest="winners", action="store", type=int, default=1, help="Number of winners to select") 27 | vis_poll_parser.add_argument("-l", "--limit", dest="limit", action="store", type=int, default=0, help="Maximum amount of choices per user. 0 allows infinite") 28 | vis_poll_parser.add_argument("options", action="store", nargs="*", help="Options in the poll. At least 2 must be given.") 29 | 30 | # Creates the parser for a poll command, allowing limit and show options 31 | stv_parser = PollParser(prog='+stvpoll', description='Runs an STV poll. Use +close to end this poll.') 32 | stv_parser.add_argument("title", action="store", type=str, help="Title of the poll") 33 | stv_parser.add_argument("-w", "--winners", dest="winners", action="store", type=int, default=1, help="Number of winners to select") 34 | stv_parser.add_argument("-l", "--limit", dest="limit", action="store", type=int, default=0, help="Maximum amount of choices per user. 0 allows infinite. This options should probably not be used with STV.") 35 | stv_parser.add_argument("options", action="store", nargs="*", help="Options in the poll") 36 | 37 | 38 | def run_parser(parser, options, extra_checks): 39 | try: # Attempt to parse results 40 | args = parser.parse_args(options) 41 | extra_checks(args) 42 | 43 | except (ParseException, argparse.ArgumentError) as e: 44 | return f"```{str(e)}```" 45 | return args 46 | -------------------------------------------------------------------------------- /votebot.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import os 3 | from typing import Optional 4 | 5 | import discord 6 | from discord.ext.commands import when_mentioned_or, CommandNotFound, has_permissions, NoPrivateMessage, Bot, \ 7 | ExpectedClosingQuoteError 8 | 9 | from react_decorators import * 10 | from voting import voteDB 11 | 12 | TOKEN = os.getenv('DISCORD_TOKEN') 13 | 14 | intents = discord.Intents.default() 15 | intents.reactions = True 16 | intents.members = True 17 | 18 | if not os.path.exists("data/temp"): 19 | os.makedirs("data/temp") 20 | 21 | 22 | def get_prefix(bot, message: discord.Message): 23 | prefix = voteDB.getPrefix(message.guild.id if message.guild else -1) 24 | return when_mentioned_or(prefix)(bot, message) 25 | 26 | 27 | bot = Bot(command_prefix=get_prefix, intents=intents) 28 | 29 | 30 | @bot.event 31 | async def on_ready(): 32 | print(f'{bot.user.name} has connected to Discord') 33 | await resume_posting() 34 | 35 | 36 | async def resume_posting(): 37 | # TODO 38 | pass 39 | 40 | 41 | # Prefix get/set command 42 | @has_permissions(administrator=True) 43 | @bot.command(name='prefix', help='Changes prefix on the server') 44 | async def prefix(ctx, prefix: Optional[str]): 45 | if prefix is None: 46 | prefix = voteDB.getPrefix(ctx.guild.id) 47 | await ctx.send(f"Current prefix is `{prefix}`") 48 | else: 49 | voteDB.setPrefix(ctx.guild.id, prefix) 50 | await ctx.send(f"Prefix changed to `{prefix}`") 51 | 52 | 53 | @has_permissions(administrator=True) 54 | @bot.command(name="purge", help="Removes messages older than the given number of days. Limited to checking 100 messages per call.") 55 | @done_react 56 | @wait_react 57 | async def purge(ctx: Context, days: int, limit: int = 100): 58 | date = ctx.message.created_at - datetime.timedelta(days=days) 59 | 60 | def check(m: discord.Message, deleted=[0]): 61 | if deleted[0] >= limit: return False 62 | r = m.created_at <= date 63 | if r: deleted[0] += 1 64 | return r 65 | 66 | print(f"Purging {limit} messages before {date}.") 67 | await ctx.channel.purge(limit=100, check=check) 68 | 69 | 70 | # VC 71 | @bot.event 72 | async def on_voice_state_update(member, before, after): 73 | if not before.channel and after.channel: 74 | role = discord.utils.get(member.guild.roles, name="talking") 75 | await member.add_roles(role) 76 | elif before.channel and not after.channel: 77 | role = discord.utils.get(member.guild.roles, name="talking") 78 | await member.remove_roles(role) 79 | 80 | 81 | @bot.event 82 | async def on_error(ctx, err, *args, **kwargs): 83 | if err == "on_command_error": 84 | await args[0].send("Something went wrong") 85 | raise 86 | 87 | 88 | @bot.event 89 | async def on_command_error(ctx, error): 90 | if isinstance(error, CommandNotFound): 91 | pass 92 | elif isinstance(error, NoPrivateMessage): 93 | await ctx.send("Cannot run this command in DMs") 94 | elif isinstance(error, ExpectedClosingQuoteError): 95 | await ctx.send(f"Mismatching quotes, {str(error)}") 96 | elif hasattr(error, "original"): 97 | raise error.original 98 | else: raise error 99 | 100 | 101 | # Load poll functionality 102 | bot.load_extension("voting.vote_commands") 103 | 104 | bot.run(TOKEN) 105 | -------------------------------------------------------------------------------- /voting/vote_types/stv_vote.py: -------------------------------------------------------------------------------- 1 | import io 2 | from collections import defaultdict, Counter 3 | from typing import Union 4 | 5 | import discord 6 | from discord.ext.commands import Context 7 | 8 | from voting import voteDB 9 | from voting.symbols import * 10 | from voting.vote_types.std_vote import EmbedData, StdVote 11 | from voting.vote_types import stv 12 | 13 | 14 | class STVVote(StdVote): 15 | def __init__(self, bot): 16 | super().__init__(bot) 17 | self.order_text = "Preference/Ranked" 18 | 19 | async def create_vote(self, ctx: Context, args, desc=None, type=2, title_pre="STV Poll") -> None: 20 | await super(STVVote, self).create_vote(ctx, args, desc, type=type, title_pre=title_pre) 21 | 22 | def count_vote(self, ind: int, user: discord.Member, vid: int, limit: int) -> str: 23 | """ 24 | Counts a vote for ind from user 25 | :param ind: Index of option chosen 26 | :param user: User selected 27 | :param vid: id of vote 28 | :param limit: vote limit 29 | :return: feedback result 30 | """ 31 | users_votes = voteDB.getUserVoteCount(vid, uid=user.id) 32 | if limit and users_votes >= limit: 33 | return "over limit" 34 | 35 | preference = voteDB.getUserNextPref(vid, user.id) 36 | r = voteDB.prefUserVote(vid, user.id, ind, preference) 37 | return "added vote" if r else "already counted" 38 | 39 | # async def __give_feedback(self, result: str, user: discord.User, index: Union[int, list[int]], vid: int, limit: int) -> None: 40 | async def give_feedback(self, result, user: discord.Member, index, vid, limit): 41 | """ 42 | Sends DM to user with result of reaction 43 | :param result: str with result of reaction 44 | :param user: user to send DM to 45 | :param index: index of option, -1 if wrong (ignored) or index of choice. If clear, list of indexes removed 46 | :param vid: vote ID 47 | :param limit: vote limit 48 | """ 49 | await user.create_dm() 50 | print(f"Sending DM for {result} to {user}") 51 | 52 | options = [x[1] for x in voteDB.getOptions(vid)] 53 | user_votes = [x[0] for x in sorted(voteDB.getUserVotes(vid, user.id), key=lambda x: x[1])] 54 | 55 | if result == "added vote": 56 | await user.dm_channel.send(f"Poll {vid}: Counted your vote for {symbols[index]} **{options[index]}** at preference {user_votes.index(index)+1}.\n" 57 | f"Your order: " + ', '.join(symbols[c] for i, c in enumerate(user_votes))) 58 | elif result == "removed vote": 59 | await user.dm_channel.send(f"Poll {vid}: Removed your vote for {symbols[index]} **{options[index]}**") 60 | elif result == "over limit": 61 | await user.dm_channel.send(f"Poll {vid}: Your vote for **{options[index]}** was **not counted**. " 62 | f"You have voted for the **maximum of {limit}** choices. \n" 63 | f"\t\t**Remove a vote** before voting again: \n\t\tYour current choices are:\n\t\t\t" + 64 | '\n\t\t\t'.join(f"{symbols[i]} **{options[i]}**" for i in user_votes) 65 | ) 66 | elif result == "clear votes": 67 | await user.dm_channel.send(f"Poll {vid}: Your votes have been cleared for:\n\t\t" + 68 | '\n\t\t'.join(f"{symbols[i]} **{options[i]}**" for i in index)) 69 | elif result == "already counted": 70 | await user.dm_channel.send(f"Poll {vid}: You have **already voted** for {options[index]} option as preference #{user_votes.index(index)+1}. " 71 | f"To change your ordering, **clear votes** and enter your updated order.\n" 72 | f"your current preferences are:\n\t\t" + 73 | '\n\t\t'.join(f"{i+1}: {symbols[c]} **{options[c]}**" for i, c in enumerate(user_votes))) 74 | 75 | 76 | def make_results(self, vid: int, num_win: int) -> list[Union[discord.File, EmbedData]]: 77 | """ 78 | Makes result list for vote 79 | :param vid: Vote ID 80 | :return: List of embed parts 81 | """ 82 | 83 | # Get votes from DB 84 | votes = voteDB.getUserVotes(vid) 85 | 86 | # Group by user in dict 87 | user_prefs = defaultdict(dict) 88 | for uid, choice, pref in votes: 89 | user_prefs[uid][pref] = choice 90 | 91 | # Convert dict to list 92 | counts = Counter() 93 | first_pref = Counter() 94 | for uid, ord_dict in user_prefs.items(): 95 | uv = [] 96 | for k in sorted(ord_dict.keys()): 97 | for i in range(len(uv)-1, k, 1): 98 | uv.append(0) 99 | uv[k] = ord_dict[k] 100 | counts[tuple(uv)] += 1 101 | first_pref[uv[0]] += 1 102 | 103 | options = [x[1] for x in voteDB.getOptions(vid)] 104 | indexes = list(range(len(options))) 105 | print("Votes parcelled ", counts, first_pref) 106 | vote = stv.STV(indexes.copy(), counts, num_win) 107 | 108 | # Make file of votes 109 | file = io.StringIO() 110 | print("Count: pref1, pref2, pref3,...", file=file) 111 | for k, v in vote.preferences.items(): 112 | print(f"{v}: {', '.join(map(str, k))}", file=file) 113 | 114 | print(file.getvalue()) 115 | winners = vote.run() 116 | print("STV Run, winners are", winners) 117 | 118 | first_prefs = indexes.copy() 119 | first_prefs.sort(key=lambda x: -first_pref[x]) 120 | 121 | return [discord.File(file, filename=f"{vid}.votes"), ("STV Winners", [f"{symbols[i]} **{options[i]}**" for i in winners] if winners else ["No winners."], False), 122 | self.list_results(options, first_prefs, first_pref, "First Preference Votes")] 123 | -------------------------------------------------------------------------------- /voting/vote_types/stv.py: -------------------------------------------------------------------------------- 1 | from collections import Counter 2 | import random 3 | 4 | # STV implemented according to Scottish STV rules from https://www.opavote.com/methods/scottish-stv-rules 5 | # Summarized in https://blog.opavote.com/2016/11/plain-english-explanation-of-scottish.html 6 | # Not good for low numbers fo votes: potentially arbitrary draws at early stages 7 | 8 | 9 | class STV: 10 | def __init__(self, choices: list[int], preferences: Counter, winner_count: int): 11 | # self.choices = [c for c in choices] 12 | self.choices = choices 13 | self.preferences = preferences 14 | self.votes = self.calc_votes() 15 | self.total_votes = sum(self.votes.values()) 16 | 17 | self.winner_count = winner_count 18 | self.win_quota = (self.total_votes // (self.winner_count + 1)) + 1 19 | self.winners = [] 20 | self.round_no = 0 21 | self.report = [] 22 | self.tie_weights = Counter() # Breaks ties based on number of votes in previous rounds 23 | self.round_weight = 1 24 | 25 | def calc_votes(self): 26 | votes = Counter() 27 | for pref in self.preferences: 28 | votes[pref[0]] += self.preferences[pref] 29 | # print(votes) 30 | return votes 31 | 32 | def run(self): 33 | while len(self.winners) < self.winner_count: 34 | self.round_no += 1 35 | # print("Running round", self.round_no) 36 | 37 | for c in self.choices: 38 | self.tie_weights[c] += self.votes[c] * self.round_weight 39 | # print("Weights", self.round_weight, self.tie_weights) 40 | 41 | self.round() 42 | # print(self.choices, self.votes, len(self.winners), self.winner_count) 43 | 44 | if self.round_no > 1000: 45 | print("Way too many rounds, ending...") 46 | break 47 | 48 | self.round_weight *= self.total_votes 49 | return self.winners 50 | 51 | def round(self): 52 | # If available choices <= winners remaining to allocate, declare all winners 53 | if len(self.choices) <= self.winner_count - len(self.winners): 54 | # print(f"Only {len(self.choices)} choices remaining, and {self.winner_count - len(self.winners)} places") 55 | self.winners += self.choices 56 | else: 57 | over_quota = [] 58 | # Declare winners as choices above threshold 59 | for choice in self.choices: 60 | if self.votes[choice] >= self.win_quota: 61 | over_quota.append(choice) 62 | 63 | # Redistribute surplus winner votes 64 | if over_quota: 65 | # Reassign most voted choice first, others will be processed in following rounds 66 | choice = max(over_quota, key=lambda x: (self.votes[x], self.tie_weights[x], random.random())) # Pick by votes, then previous round's votes, then random 67 | self.winners.append(choice) 68 | surplus = self.votes[choice] - self.win_quota 69 | # print(f"{choice} above threshold, redistributing {surplus} votes") 70 | self.redistribute_votes(choice, surplus) 71 | # print(self.winners) 72 | 73 | # Error checking case, if less votes than options and all votes have been counted, end with the current choice of options 74 | elif all(c == 0 for c in self.votes.values()): 75 | self.winner_count = len(self.winners) 76 | # print(f"No votes remaining, truncating to {self.winner_count} winners.") 77 | 78 | # Otherwise, eliminate lowest voted choice 79 | else: 80 | lowest = min(self.choices, key=lambda x: (self.votes[x], self.tie_weights[x], random.random())) # Pick by votes, then previous round's votes, then random 81 | # print(f"No winners, {lowest} has fewest votes, redistributing {self.votes[lowest]} votes") 82 | self.redistribute_votes(lowest, self.votes[lowest]) 83 | # print(self.winners) 84 | 85 | 86 | def redistribute_votes(self, choice, surplus): 87 | # Remove record for the choice from votes and from possibilities 88 | self.choices.remove(choice) 89 | if self.votes[choice] == 0: return 90 | total_votes = self.votes.pop(choice) 91 | reassign_ratio = min(surplus / total_votes, 1) # Calculate weight of each vote 92 | 93 | # Used to record changes to pref to avoid concurrent modification 94 | remove_pref = [] 95 | adding_pref = Counter() 96 | 97 | # Reassign each group of preferences 98 | for pref in self.preferences: 99 | if pref[0] == choice: # Find preferences for choice 100 | if len(pref) > 1: # If pref has second choice 101 | count = self.preferences[pref] 102 | 103 | new_pref = pref[1:] # Create new run of preferences 104 | if new_pref[0] in self.winners: # If next chosen has already won, skip over them 105 | new_pref = new_pref[1:] 106 | 107 | # Calculate and assign the new amount of votes for the preference 108 | new_votes = count * reassign_ratio 109 | self.votes[new_pref[0]] += new_votes 110 | adding_pref[new_pref] += new_votes 111 | 112 | remove_pref.append(pref) 113 | # Apply changes 114 | for p in remove_pref: self.preferences.pop(p) 115 | for k, v in adding_pref.items(): self.preferences[k] += v 116 | 117 | # print(self.votes) 118 | # print(self.preferences) 119 | 120 | 121 | if __name__ == '__main__': 122 | choices = [i for i in range(6)] 123 | 124 | # preferences = Counter({ 125 | # # (0,): 4, 126 | # # (1, 0): 2, 127 | # # (2, 3): 8, 128 | # # (2, 4): 4, 129 | # # (3,): 1, 130 | # # (4,): 1 131 | # (1, 3): 1 132 | # }) 133 | preferences = Counter({(3, 2, 5, 4, 0, 1): 5, (1, 0): 5}) 134 | 135 | 136 | stv = STV(choices, preferences, 1) 137 | stv.run() 138 | print("WINNERS", stv.winners) 139 | -------------------------------------------------------------------------------- /voting/voteDB.py: -------------------------------------------------------------------------------- 1 | from pprint import pprint 2 | from typing import Union 3 | 4 | import discord 5 | 6 | from db import db 7 | 8 | 9 | def setPrefix(gid, prefix): 10 | db.execute("INSERT INTO Prefix (GuildID, Prefix) VALUES (%s, %s) ON CONFLICT (GuildID) DO UPDATE SET Prefix = EXCLUDED.Prefix;", gid, prefix) 11 | pprint(db.executeFAll("SELECT * FROM Prefix;")) 12 | 13 | 14 | def getPrefix(gid: int): 15 | prefix = db.executeF1("SELECT COALESCE(Prefix, '+') FROM Prefix WHERE GuildID = %s;", gid) 16 | if not prefix: return "+" 17 | return prefix[0] 18 | 19 | 20 | @db.with_commit 21 | def addVote(creator: discord.User, question: str, options: list[str], limit: int, guild: discord.Guild, channel: discord.TextChannel, stage: int = 0, type: int = 1, num_win: int = 1, title_pre: str = "Poll") -> tuple[int, str]: 22 | # noinspection SyntaxError 23 | vid = db.executeF1("INSERT INTO Votes (CreatorID, Question, VoteLimit, GuildID, ChannelID, PollStage, Type, NumWinners) VALUES (%s, %s, %s, %s, %s, %s, %s, %s) RETURNING VoteID;", 24 | creator.id, question, limit, guild.id, channel.id, stage, type, num_win)[0] 25 | title = f"{title_pre} `{vid}`: " + question 26 | db.execute("UPDATE Votes SET Question = %s WHERE VoteID = %s", title, vid) 27 | 28 | db.multiexec("INSERT INTO Options (VoteID, OptionNumb, Prompt) VALUES (%s, %s, %s);", ((vid, i, p) for i, p in enumerate(options))) 29 | return vid, title 30 | 31 | 32 | @db.with_commit 33 | def removeVote(vid: int): 34 | db.execute("DELETE FROM Votes WHERE VoteID = %s;", vid) 35 | # Should cascade to others 36 | 37 | 38 | def getVote(vid: int): 39 | return db.executeF1("SELECT CreatorID, Question, GuildID, ChannelID, Type, NumWinners " 40 | "FROM Votes WHERE VoteID = %s;", vid) 41 | 42 | 43 | def getMsgVote(mid: int): 44 | return db.executeF1("SELECT M.VoteID, Part, Type, VoteLimit, PollStage " 45 | "FROM VoteMessages M JOIN Votes V USING (VoteID) WHERE MessageID = %s;", mid) 46 | 47 | 48 | @db.with_commit 49 | def addMessage(vid: int, mid: int, part: int): 50 | db.execute("INSERT INTO VoteMessages (VoteID, MessageID, Part) VALUES (%s, %s, %s);", vid, mid, part) 51 | 52 | 53 | def getMessages(vid: int = None): 54 | if vid: return db.executeFAll("SELECT GuildID, ChannelID, MessageID " 55 | "FROM Votes JOIN VoteMessages USING (VoteID) " 56 | "WHERE PollStage > -1 AND VoteID = %s;", vid) 57 | 58 | else: return db.executeFAll("SELECT VoteID, GuildID, ChannelID, MessageID " 59 | "FROM Votes JOIN VoteMessages USING (VoteID) " 60 | "WHERE PollStage >= 0;") 61 | 62 | 63 | @db.with_commit 64 | def addUserVote(vid: int, uid: int, choice: int, pref: int): 65 | db.execute("INSERT INTO UserVote (VoteID, UserID, Choice, Preference) VALUES (%s, %s, %s, %s);", vid, uid, choice, pref) 66 | 67 | 68 | @db.with_commit 69 | def removeUserVote(vid: int, uid: int, choice: int = None): 70 | if choice is None: 71 | sel = db.executeFAll("SELECT Choice FROM UserVote WHERE UserID = %s AND VoteID = %s;", uid, vid) 72 | db.execute("DELETE FROM UserVote WHERE UserID = %s AND VoteID = %s;", uid, vid) 73 | return [s[0] for s in sel] 74 | else: db.execute("DELETE FROM UserVote WHERE UserID = %s AND VoteID = %s AND Choice = %s;", uid, vid, choice) 75 | 76 | 77 | class OverLimitException(Exception): pass 78 | 79 | 80 | def toggleUserVote(vid: int, uid: int, choice: int, pref: int, limit: int = None): 81 | if getUserPref(vid, uid, choice) == -1: 82 | if limit and getUserVoteCount(vid, uid=uid) >= limit: 83 | raise OverLimitException() 84 | addUserVote(vid, uid, choice, pref) 85 | return True 86 | else: 87 | removeUserVote(vid, uid, choice) 88 | return False 89 | 90 | 91 | 92 | def prefUserVote(vid: int, uid: int, choice: int, pref: int): 93 | if getUserPref(vid, uid, choice) == -1: 94 | addUserVote(vid, uid, choice, pref) 95 | return True 96 | else: 97 | return False 98 | 99 | def getUserVotes(vid: int, uid: int = None): 100 | if uid is None: return db.executeFAll("SELECT UserID, Choice, Preference FROM UserVote WHERE VoteID = %s ORDER BY UserID, Choice, Preference;", vid) 101 | else: return db.executeFAll("SELECT Choice, Preference FROM UserVote WHERE VoteID = %s AND UserID = %s ORDER BY Choice, Preference;", vid, uid) 102 | 103 | 104 | def getOptions(vid: int): 105 | return db.executeFAll("SELECT OptionNumb, Prompt FROM Options WHERE VoteID = %s ORDER BY OptionNumb;", vid) 106 | 107 | 108 | def getUserVoteCount(vid: int, choice: int = None, uid: int = None) -> Union[int, list]: 109 | if choice is None: 110 | if uid is None: 111 | return db.executeFAll("SELECT O.OptionNumb, COALESCE(T.Count, 0) AS Count FROM Options O LEFT JOIN (" 112 | " SELECT O2.OptionNumb AS Numb, COUNT(*) AS Count " 113 | " FROM Options O2 JOIN UserVote UV ON (UV.VoteID = O2.VoteID AND UV.Choice = O2.OptionNumb) " 114 | " WHERE O2.VoteID = %s GROUP BY O2.OptionNumb" 115 | ") T ON O.OptionNumb = T.Numb WHERE O.VoteID = %s ORDER BY Count DESC;", vid, vid) 116 | 117 | else: vs = db.executeF1("SELECT COUNT(*) FROM UserVote WHERE VoteID = %s AND UserID = %s;", vid, uid) 118 | else: 119 | if uid is None: vs = db.executeF1("SELECT COUNT(*) FROM UserVote WHERE VoteID = %s AND Choice = %s;", vid, choice) 120 | else: vs = db.executeF1("SELECT COUNT(*) FROM UserVote WHERE VoteID = %s AND UserID = %s AND Choice = %s;", vid, uid, choice) # Of questionable usefulness, but present for completeness 121 | 122 | if vs: return vs[0] 123 | else: return 0 124 | 125 | 126 | def getVoterCount(vid: int): 127 | return db.executeF1("SELECT COUNT(DISTINCT UserID) FROM Votes V JOIN UserVote UV USING (VoteID) WHERE VoteID = %s", vid)[0] 128 | 129 | 130 | def getUserNextPref(vid: int, uid: int): 131 | vs = db.executeFAll("SELECT COALESCE(MAX(Preference), -1) FROM UserVote WHERE VoteID = %s AND UserID = %s;", vid, uid) 132 | return 1 + extract1Val(vs) 133 | 134 | 135 | def getUserPref(vid: int, uid: int, choice: int): 136 | vs = db.executeFAll("SELECT COALESCE(Preference, -1) FROM UserVote WHERE VoteID = %s AND UserID = %s AND Choice = %s;", vid, uid, choice) 137 | return extract1Val(vs) 138 | 139 | 140 | def allowedEnd(vid: int, uid: int): 141 | vs = db.executeFAll("SELECT EXISTS(SELECT 1 FROM Votes WHERE VoteID = %s AND CreatorID = %s);", vid, uid) 142 | return extract1Val(vs, False) 143 | 144 | 145 | @db.with_commit 146 | def updateStage(vid: int, stage: int): 147 | db.execute("UPDATE Votes SET PollStage = %s WHERE VoteID = %s;", stage, vid) 148 | 149 | 150 | def extract1Row(vals, default=-1): 151 | if len(vals) > 0: return vals[0] 152 | else: return default 153 | 154 | 155 | def extract1Val(vals, default=-1): 156 | r = extract1Row(vals, default) 157 | if r == default: return default 158 | return r[0] 159 | 160 | -------------------------------------------------------------------------------- /voting/vote_commands.py: -------------------------------------------------------------------------------- 1 | import discord 2 | from discord.ext import commands 3 | from discord.ext.commands import Bot, has_permissions 4 | 5 | from voting import voteDB 6 | from react_decorators import * 7 | from voting.symbols import symbols 8 | from voting.parsers import * 9 | 10 | 11 | # Main poll class, mainly a wrapper around Vote 12 | from voting.vote_manager import VoteManager 13 | 14 | 15 | class Voting(commands.Cog): 16 | bot: Bot 17 | 18 | def __init__(self, bot): 19 | self.bot = bot 20 | self.vm = VoteManager(bot) 21 | 22 | 23 | @commands.command(name="createpoll", aliases=["poll", "secretpoll"], help=poll_parser.format_help()) 24 | @commands.guild_only() 25 | @wait_react 26 | async def create_poll(self, ctx: Context, *options): 27 | try: 28 | print("Parsing args") 29 | 30 | def extra_checks(args): # Extra checks past the parser's basic ones. These are caught and forwarded in run_parser 31 | if len(args.options) < 2 or len(symbols) < len(args.options): raise argparse.ArgumentError(opt_arg, f"Between 2 and {len(symbols)} options must be supplied.") 32 | if args.winners <= 0: raise argparse.ArgumentError(win_arg, f"Cannot select less than 1 winner.") 33 | if args.limit < 0: raise argparse.ArgumentError(lim_arg, f"Cannot have limit less than 1.") 34 | for op in args.options: 35 | if len(op) > 50: raise argparse.ArgumentError(opt_arg, f"Option {op} is too long. Lines can be no longer than 50 characters (current length {len(op)}))") 36 | 37 | args = run_parser(poll_parser, options, extra_checks) 38 | # Send feedback or run vote 39 | if isinstance(args, str): await ctx.send(args) 40 | else: 41 | await self.vm.std_vote(ctx, args) 42 | 43 | # Catch any exception, to ensure the bot continues running for other votes 44 | # and to give error message due to error messages in async blocks not being reported otherwise 45 | except Exception as e: 46 | print(e) 47 | raise e 48 | 49 | 50 | @commands.command(name="visiblepoll", aliases=["vpoll"], help=("Runs a poll with visible votes.\n" + vis_poll_parser.format_help())) 51 | @commands.guild_only() 52 | @wait_react 53 | async def create_visible_poll(self, ctx: Context, *options): 54 | try: 55 | print("Parsing args") 56 | 57 | def extra_checks(args): # Extra checks past the parser's basic ones. These are caught and forwarded in run_parser 58 | if len(args.options) < 2 or len(symbols) < len(args.options): raise argparse.ArgumentError(opt_arg, f"Between 2 and {len(symbols)} options must be supplied.") 59 | if args.winners <= 0: raise argparse.ArgumentError(win_arg, f"Cannot select less than 1 winner.") 60 | if args.limit < 0: raise argparse.ArgumentError(lim_arg, f"Cannot have limit less than 1.") 61 | for op in args.options: 62 | if len(op) > 50: raise argparse.ArgumentError(opt_arg, f"Option {op} is too long. Lines can be no longer than 50 characters (current length {len(op)}))") 63 | 64 | args = run_parser(vis_poll_parser, options, extra_checks) 65 | # Send feedback or run vote 66 | if isinstance(args, str): 67 | await ctx.send(args) 68 | else: 69 | await self.vm.visible_poll(ctx, args) 70 | 71 | # Catch any exception, to ensure the bot continues running for other votes 72 | # and to give error message due to error messages in async blocks not being reported otherwise 73 | except Exception as e: 74 | print(e) 75 | raise e 76 | 77 | 78 | 79 | @commands.command(name="stvpoll", help=("Runs a STV poll.\n" + stv_parser.format_help())) 80 | @commands.guild_only() 81 | @wait_react 82 | async def create_stv_poll(self, ctx: Context, *options): 83 | try: 84 | print("Parsing args") 85 | 86 | def extra_checks(args): 87 | if len(args.options) < 2 or len(symbols) < len(args.options): raise argparse.ArgumentError(opt_arg, f"Between 2 and {len(symbols)} options must be supplied.") 88 | if args.winners <= 0: raise argparse.ArgumentError(win_arg, f"Cannot select less than 1 winner.") 89 | if args.limit < 0: raise argparse.ArgumentError(lim_arg, f"Cannot have limit less than 1.") 90 | for op in args.options: 91 | if len(op) > 50: raise argparse.ArgumentError(opt_arg, f"Option {op} is too long. Lines can be no longer than 50 characters (current length {len(op)}))") 92 | 93 | args = run_parser(stv_parser, options, extra_checks) 94 | if isinstance(args, str): await ctx.send(args) 95 | else: 96 | await self.vm.stv_vote(ctx, args) 97 | 98 | except Exception as e: 99 | print(e) 100 | raise e 101 | 102 | @has_permissions(administrator=True) 103 | @commands.command(name="roles", help="Reaction roles") 104 | @commands.guild_only() 105 | @wait_react 106 | async def reaction_roles(self, ctx: Context, *options): 107 | try: 108 | print("Parsing args") 109 | 110 | def extra_checks(args): # Extra checks past the parser's basic ones. These are caught and forwarded in run_parser 111 | if len(args.options) < 1 or len(symbols) < len(args.options): raise argparse.ArgumentError(opt_arg, f"Between 1 and {len(symbols)} roles must be supplied.") 112 | if args.limit < 0: raise argparse.ArgumentError(lim_arg, f"Cannot have limit less than 1.") 113 | for op in args.options: 114 | if len(op) > 50: raise argparse.ArgumentError(opt_arg, f"Role name {op} is too long. Lines can be no longer than 50 characters (current length {len(op)}))") 115 | 116 | # TODO CHECK ALL ROLES EXIST 117 | 118 | args = run_parser(poll_parser, options, extra_checks) 119 | # Send feedback or run vote 120 | if isinstance(args, str): 121 | await ctx.send(args) 122 | else: 123 | await self.vm.reaction_roles(ctx, args) 124 | 125 | # Catch any exception, to ensure the bot continues running for other votes 126 | # and to give error message due to error messages in async blocks not being reported otherwise 127 | except Exception as e: 128 | print(e) 129 | raise e 130 | 131 | 132 | @commands.command(name="close", aliases=["closepoll", "closevote"], help="Ends a poll with ID `pid`") 133 | @done_react 134 | @wait_react 135 | async def close_poll(self, ctx: Context, vid: int): 136 | if voteDB.allowedEnd(vid, ctx.author.id): 137 | await self.vm.close(vid) 138 | else: await ctx.send("You cannot end this poll") 139 | 140 | 141 | @commands.command(name="voters", help="Gets the number of people who have voted in a poll.") 142 | @wait_react 143 | async def voters(self, ctx: Context, vid: int): 144 | if voteDB.allowedEnd(vid, ctx.author.id): 145 | voters = voteDB.getVoterCount(vid) 146 | await ctx.send(f"{voters} people have voted so far in vote {vid}.") 147 | 148 | 149 | @commands.command(name="myvotes", help="Will DM with your current votes for vote `vid`.") 150 | @wait_react 151 | @done_react 152 | async def myvotes(self, ctx: Context, vid: int): 153 | user = ctx.author 154 | await user.create_dm() 155 | 156 | options = [x[1] for x in voteDB.getOptions(vid)] 157 | uvs = voteDB.getUserVotes(vid, user.id) 158 | 159 | if not uvs: await user.dm_channel.send(f"Poll {vid}: You have no votes so far.") 160 | else: await user.dm_channel.send( 161 | f"Poll {vid}: Your current votes are:\n\t\t" + 162 | '\n\t\t'.join(f"{symbols[i]} **{options[i]}**" for i, _ in uvs) 163 | ) 164 | 165 | 166 | 167 | @commands.command(name="halt", help="Ends a vote early with no results page.") 168 | @wait_react 169 | @done_react 170 | async def halt(self, ctx: Context, vid: int): 171 | if voteDB.allowedEnd(vid, ctx.author.id): 172 | await self.vm.halt(vid) 173 | 174 | 175 | @commands.Cog.listener() 176 | @commands.guild_only() 177 | async def on_raw_reaction_add(self, reaction: discord.RawReactionActionEvent): 178 | # user = self.bot.get_user(reaction.user_id) 179 | user = reaction.member 180 | emoji = str(reaction.emoji) 181 | 182 | guild: discord.Guild = self.bot.get_guild(reaction.guild_id) 183 | if not guild: return # In DM, ignore 184 | channel: discord.TextChannel = guild.get_channel(reaction.channel_id) 185 | message: discord.Message = await channel.fetch_message(reaction.message_id) 186 | 187 | if user.bot: return 188 | await self.vm.on_reaction_add(reaction, emoji, message, user) 189 | 190 | @commands.Cog.listener() 191 | @commands.guild_only() 192 | async def on_raw_reaction_remove(self, reaction: discord.RawReactionActionEvent): 193 | # user = self.bot.get_user(reaction.user_id) 194 | # user = reaction.member 195 | emoji = str(reaction.emoji) 196 | 197 | guild: discord.Guild = self.bot.get_guild(reaction.guild_id) 198 | user = guild.get_member(reaction.user_id) 199 | if not guild: return # In DM, ignore 200 | channel: discord.TextChannel = guild.get_channel(reaction.channel_id) 201 | message: discord.Message = await channel.fetch_message(reaction.message_id) 202 | 203 | if user.bot: return 204 | await self.vm.on_reaction_remove(reaction, emoji, message, user) 205 | 206 | 207 | # Register module with bot 208 | def setup(bot): 209 | bot.add_cog(Voting(bot)) 210 | 211 | -------------------------------------------------------------------------------- /voting/vote_types/std_vote.py: -------------------------------------------------------------------------------- 1 | import os 2 | from datetime import datetime 3 | from math import ceil 4 | from typing import Optional, Union, Iterable 5 | 6 | import discord 7 | from discord import TextChannel 8 | from discord.ext.commands import Bot, Context 9 | 10 | from voting import voteDB 11 | from voting.symbols import * 12 | from voting.voteDB import OverLimitException 13 | 14 | EmbedData = tuple[str, list[str], bool] 15 | 16 | 17 | class StdVote: 18 | bot: Bot 19 | 20 | def __init__(self, bot): 21 | self.bot = bot 22 | self.remove_reactions = True 23 | self.clear = True 24 | self.order_text = "Any" 25 | self.close_desc = True 26 | 27 | async def on_react_add(self, emoji: str, msg: discord.Message, user: discord.Member, t: tuple) -> None: 28 | """ 29 | Called on reaction add to a poll of this type. Entry point 30 | :param reaction: Reaction added 31 | :param user: User adding the reaction 32 | """ 33 | 34 | if user.bot: return 35 | voteID, part, _, limit, _ = t 36 | 37 | # Process vote 38 | result = self.react_action(user, emoji, voteID, part, limit, msg) 39 | if self.remove_reactions or not result: await msg.remove_reaction(emoji, user) 40 | 41 | # Send DM with confirmation 42 | if result: 43 | await self.give_feedback(result, user, indexes.get(emoji, -1), voteID, limit) 44 | 45 | 46 | async def on_react_remove(self, emoji: str, msg: discord.Message, user: discord.Member, t: tuple) -> None: 47 | pass 48 | 49 | 50 | def react_action(self, user: discord.Member, em: str, voteID: int, part: int, limit: int, msg: discord.Message) -> Union[str, tuple[str, list[int]]]: 51 | """ 52 | Action to be taken when a reaction is added to a poll 53 | :param msg: 54 | :param user: User voting 55 | :param em: Reaction (option) added 56 | :param voteID: ID of vote of message 57 | :param part: message part of the poll 58 | :param limit: maximum # of votes 59 | :return: result to give to feedback sender 60 | """ 61 | 62 | if voteID is None: return "" 63 | if user.bot: return "" 64 | 65 | # If X, clear votes 66 | if em == clear_symbol: 67 | rem = voteDB.removeUserVote(voteID, user.id) 68 | return "clear votes", rem 69 | 70 | ind = indexes.get(em, -1) 71 | if not (part <= ind < part + 20): 72 | return "" 73 | else: 74 | return self.count_vote(ind, user, voteID, limit) 75 | 76 | 77 | def count_vote(self, ind: int, user: discord.Member, vid: int, limit: int) -> str: 78 | """ 79 | Counts a vote for ind from user 80 | :param ind: Index of option chosen 81 | :param user: User selected 82 | :param vid: id of vote 83 | :param limit: vote limit 84 | :return: feedback result 85 | """ 86 | preference = voteDB.getUserNextPref(vid, user.id) 87 | try: 88 | r = voteDB.toggleUserVote(vid, user.id, ind, preference, limit) 89 | return "added vote" if r else "removed vote" 90 | except OverLimitException: 91 | return "over limit" 92 | 93 | 94 | async def give_feedback(self, result, user: discord.Member, index, vid, limit): 95 | """ 96 | Sends DM to user with result of reaction 97 | :param result: str with result of reaction 98 | :param user: user to send DM to 99 | :param index: index of option, -1 if wrong (ignored) or index of choice. If clear, list of indexes removed 100 | :param vid: vote ID 101 | :param limit: vote limit 102 | """ 103 | await user.create_dm() 104 | print(f"Sending DM for {result} to {user}") 105 | 106 | options = [x[1] for x in voteDB.getOptions(vid)] 107 | 108 | if isinstance(result, tuple) and result[0] == "clear votes": 109 | await user.dm_channel.send(f"Poll {vid}: Your votes have been cleared for:\n\t\t" + 110 | '\n\t\t'.join(f"{symbols[i]} **{options[i]}**" for i in result[1])) 111 | 112 | elif result == "added vote": 113 | await user.dm_channel.send(f"Poll {vid}: Counted your vote for {symbols[index]} **{options[index]}**") 114 | elif result == "removed vote": 115 | await user.dm_channel.send(f"Poll {vid}: Removed your vote for {symbols[index]} **{options[index]}**") 116 | 117 | elif result == "over limit": 118 | await user.dm_channel.send( 119 | f"Poll {vid}: Your vote for **{options[index]}** was **not counted**. You have voted for the **maximum of {limit}** choices. \n" 120 | f"\t\t**Remove a vote** before voting again: \n\t\tYour current choices are:\n\t\t\t" + 121 | '\n\t\t\t'.join(f"{symbols[i]} **{options[i]}**" for i, _ in voteDB.getUserVotes(vid, user.id)) 122 | ) 123 | 124 | 125 | 126 | async def create_vote(self, ctx: Context, args, desc=None, type=1, title_pre: str = "Anonymous Poll") -> None: 127 | """ 128 | Creates a vote, entry point. 129 | :param ctx: Context of vote (channel) 130 | :param args: args of command 131 | :param desc: Description of vote 132 | """ 133 | # Extract values 134 | creator = ctx.author 135 | title = args.title 136 | options = args.options 137 | limit = args.limit 138 | num_wins = args.winners 139 | 140 | # Add to DB 141 | id, title = voteDB.addVote(creator, title, options, limit, ctx.guild, ctx.channel, 0, type, num_wins, title_pre) 142 | 143 | if desc is None: 144 | desc = self.vote_summary(args) 145 | else: desc = desc 146 | if self.close_desc: desc += f" End the vote with `{voteDB.getPrefix(ctx.guild.id)}close {id}`." 147 | 148 | # Post messages and add reactions, store stage to allow resume 149 | messages = await self.post_vote(ctx, id, title, desc, options, creator.colour) 150 | voteDB.updateStage(id, 1) 151 | await self.add_reactions(messages, options) 152 | voteDB.updateStage(id, 2) 153 | 154 | 155 | def vote_summary(self, args): 156 | return f"Votes: **{'Hidden' if self.remove_reactions else 'Visible'}** Order: **{self.order_text}** Vote Limit: **{str(args.limit) if args.limit > 0 else 'None'}** Winners: **{args.winners}**\n"\ 157 | 158 | 159 | async def post_vote(self, ctx: Context, vid: int, title: str, desc: str, options: list[str], colour) -> list[discord.Message]: 160 | """ 161 | Posts the messages for a vote, 20 options per message, as that is discord's limit on reacts per message 162 | :param ctx: Context (channel) to send to 163 | :param vid: Vote ID 164 | :param title: Vote question 165 | :param desc: Vote description 166 | :param options: Vote options 167 | :param colour: Colour of vote embed 168 | """ 169 | print("Posting") 170 | # Embed fields can be no longer than 1024 characters, so limit of 50 chars / option and 20 options per field 171 | lines = [f"{symbols[i]} {options[i]}" for i in range(len(options))] 172 | if self.clear and self.remove_reactions: lines.append(f"\n\n{clear_symbol} Clear all your votes") 173 | 174 | messages = [] 175 | 176 | # Add each 20 lines to new embed then post 177 | max_part = ceil(len(lines) / 20.0) 178 | for i in range(0, len(lines), 20): 179 | limit = min(i + 20, len(lines)) 180 | d = desc if i == 0 else f"Part of poll `{vid}`. Split due to reaction count limit" 181 | embed = discord.Embed(title=f"{title} {f'part {i // 20 + 1}/{max_part}' if max_part > 1 else ''}", 182 | description=d, 183 | colour=colour, timestamp=datetime.utcnow()) 184 | 185 | embed.add_field(name=f"Options" + ("" if i == 0 else "continued"), value="\n".join(lines[i:limit]), 186 | inline=False) 187 | 188 | message = await ctx.send(embed=embed) 189 | messages.append(message) 190 | voteDB.addMessage(vid, message.id, i) 191 | return messages 192 | 193 | 194 | async def add_reactions(self, messages: list[discord.Message], options: list[str]) -> None: 195 | """ 196 | Adds the reactions to the vote messages, 20 per message due to discord limit 197 | :param messages: list of posted messages 198 | :param options: # of options 199 | """ 200 | # Add reactions, discord has max of 20 per message 201 | for i0, m in enumerate(messages): 202 | limit = min(i0 * 20 + 20, len(options)) 203 | for i in range(i0 * 20, limit): 204 | await m.add_reaction(symbols[i]) 205 | 206 | if self.clear: 207 | # Add clear symbol 208 | msg = messages[len(options) // 20] 209 | await msg.add_reaction(clear_symbol) 210 | 211 | 212 | 213 | async def post_results(self, vid: int): 214 | """ 215 | Posts results of a vote, entry point 216 | :param vid: vote ID 217 | """ 218 | # Get information from DB and discord (messages, etc.) 219 | print("Making results of vote", vid) 220 | messages = voteDB.getMessages(vid) 221 | for gid, cid, mid in messages: 222 | guild: discord.Guild = self.bot.get_guild(gid) 223 | channel: TextChannel = guild.get_channel(cid) 224 | message: discord.Message = await channel.fetch_message(mid) 225 | await message.clear_reactions() 226 | print("Clearing reactions from msg", mid) 227 | 228 | uid, question, gid, cid, type, num_win = voteDB.getVote(vid) 229 | 230 | voteDB.updateStage(vid, -1) 231 | fields = self.make_results(vid, num_win) 232 | 233 | guild: discord.Guild = self.bot.get_guild(gid) 234 | channel: TextChannel = guild.get_channel(cid) 235 | creator = guild.get_member(uid) 236 | 237 | # If first field is file (used in STV export, etc.), extract it 238 | file: Optional[discord.File] = None 239 | if isinstance(fields[0], discord.File): 240 | file = fields[0] 241 | fields = fields[1:] 242 | 243 | # Split fields into 20 entries per field, so do not go over limit 244 | split_fields = [] 245 | for field in fields: 246 | title, lines, inline = field 247 | max_part = ceil(len(lines) / 20.0) 248 | 249 | # Split field 250 | split_fields.append((title, "\n".join(lines if len(lines) < 20 else lines[:20]), inline)) 251 | for i in range(20, len(lines), 20): 252 | limit = min(i + 20, len(lines)) 253 | split_fields.append((title + f" part {i // 20 + 1}/{max_part}", "\n".join(lines[i:limit]), inline)) 254 | 255 | # Create embeds, split if embed ends up being too long, shouldn't be necessary with option length limit 256 | embed = discord.Embed(title="Results of " + question, colour=creator.colour, timestamp=datetime.utcnow()) 257 | msg_length = 0 258 | part = 1 259 | for n, v, i in split_fields: 260 | msg_length += len(v) 261 | if msg_length > 4000: # If too long, send and reset embed 262 | await channel.send(embed=embed) 263 | part += 1 264 | embed = discord.Embed(title=f"Results part {part} of " + question, colour=creator.colour, 265 | timestamp=datetime.utcnow()) 266 | embed.add_field(name=n, value=v, inline=i) 267 | 268 | # If file, attach it and delete temp 269 | if file: await channel.send(embed=embed, file=file) 270 | else: await channel.send(embed=embed) 271 | 272 | voteDB.removeVote(vid) 273 | 274 | 275 | async def halt(self, vid: int): 276 | """ 277 | Ends vote without results 278 | :param vid: vote ID 279 | """ 280 | # Get information from DB and discord (messages, etc.) 281 | print("Halting vote", vid) 282 | messages = voteDB.getMessages(vid) 283 | for gid, cid, mid in messages: 284 | guild: discord.Guild = self.bot.get_guild(gid) 285 | channel: TextChannel = guild.get_channel(cid) 286 | message: discord.Message = await channel.fetch_message(mid) 287 | # await message.clear_reactions() 288 | await message.delete() 289 | 290 | uid, question, gid, cid, type, num_win = voteDB.getVote(vid) 291 | 292 | voteDB.updateStage(vid, -1) 293 | 294 | guild: discord.Guild = self.bot.get_guild(gid) 295 | channel: TextChannel = guild.get_channel(cid) 296 | 297 | voteDB.removeVote(vid) 298 | 299 | await channel.send(f"Vote {vid} halted.") 300 | 301 | 302 | 303 | def make_results(self, vid: int, num_win: int) -> list[Union[discord.File, EmbedData]]: 304 | """ 305 | Makes result list for vote 306 | :param vid: Vote ID 307 | :return: List of embed parts 308 | """ 309 | votes = dict(voteDB.getUserVoteCount(vid)) 310 | options = ["" for _ in range(len(votes))] 311 | for i, text in voteDB.getOptions(vid): 312 | options[i] = text 313 | 314 | sections = [StdVote.top_n_results(num_win, options, votes, title="Winners")] 315 | if num_win < 5: sections.append(StdVote.top_n_results(5, options, votes)) 316 | sections.append(StdVote.list_results(options, list(range(len(options))), votes)) 317 | 318 | return sections 319 | 320 | 321 | @staticmethod 322 | def list_results(options: list[str], order: list[int], votes: dict[int, int], title="Results") -> EmbedData: 323 | """ 324 | Creates embed parts that list options in order 325 | :param options: Options to list 326 | :param order: Order of options to display 327 | :param title: Title of embed 328 | :param votes: Source votes to include 329 | :return: Embed parts 330 | """ 331 | start_msg = "" 332 | if len(options) > 20: # If long, only display non-zero results 333 | order = [p for p in order if votes[p] > 0] 334 | start_msg = "As a large number of results, omitting options with zero votes\n" 335 | if len(order) == 0: return title, [start_msg] + ["All options received 0 votes."], False 336 | 337 | print(order, options, votes) 338 | return title, [start_msg] + [f"{symbols[i]} **{options[i]}**: **{votes[i]}** votes" for i in order], False 339 | 340 | 341 | @staticmethod 342 | def top_n_results(n: int, options: list[str], votes: dict[int, int], title=None) -> EmbedData: 343 | """ 344 | Gets the top n results of options by votes 345 | :param n: number of top results to get 346 | :param options: options to pick from 347 | :param votes: vote data to sort by 348 | :return: Embed parts 349 | """ 350 | 351 | order = list(votes.keys()) 352 | order.sort(key=lambda x: -votes.get(x, 0)) 353 | 354 | picked = order[:n] 355 | for i in range(len(picked)-1, -1, -1): 356 | if votes.get(picked[i], 0) == 0: picked.pop(i) 357 | 358 | limit = votes.get(picked[-1], 0) 359 | for op in order[n:]: 360 | if votes.get(op, 0) >= limit: 361 | picked.append(op) 362 | 363 | n = min(len(options), n) 364 | if title is None: title = f"Top {n}" 365 | 366 | return StdVote.list_results(options, picked, votes, title) 367 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------