├── rev ├── cfg.py ├── plugins ├── libinfo.py ├── liblogger.py ├── testcommand.py ├── __init__.py ├── libmesh.py ├── libcommand.py ├── libdiscordutil.py ├── info.py ├── basic_commands.py ├── basic_events.py ├── enviroment.py └── funplugin.py ├── plugins-disabled ├── gpt-config-example.yml └── gpt.py ├── .gitignore ├── README.md ├── config-example.yml ├── main.py └── LICENSE /rev: -------------------------------------------------------------------------------- 1 | 23 -------------------------------------------------------------------------------- /cfg.py: -------------------------------------------------------------------------------- 1 | config = {} -------------------------------------------------------------------------------- /plugins/libinfo.py: -------------------------------------------------------------------------------- 1 | info = [] -------------------------------------------------------------------------------- /plugins-disabled/gpt-config-example.yml: -------------------------------------------------------------------------------- 1 | open_ai_token: "put open ai token here" 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | config.yml 2 | __pycache__/ 3 | plugins/**/__pycache__/ 4 | plugins/gpt-config.yml 5 | meshlinkvenv/ 6 | .venv/ 7 | mise.toml 8 | plugins/gpt-config-example.yml 9 | plugins-disabled/gpt-config-example.yml 10 | plugins/gpt.py 11 | -------------------------------------------------------------------------------- /plugins/liblogger.py: -------------------------------------------------------------------------------- 1 | def info(any): 2 | print("[INFO] "+str(any)) 3 | 4 | def warn(any): 5 | print("\x1b[31;49m[WARN] "+str(any)+"\x1b[0m") 6 | 7 | def infoimportant(any): 8 | print("\x1b[33;49m[INFO] "+str(any)+"\x1b[0m") 9 | 10 | def infogreen(any): 11 | print("\x1b[32;49m[INFO] "+str(any)+"\x1b[0m") 12 | 13 | def infodiscord(any): 14 | print("\x1b[35;49m[DISC] "+str(any)+"\x1b[0m") -------------------------------------------------------------------------------- /plugins/testcommand.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.libcommand as LibCommand 3 | import plugins.liblogger as logger 4 | 5 | class pluginInfo(plugins.Base): 6 | 7 | def __init__(self): 8 | pass 9 | 10 | def cmdHello(self, packet, interface, client, args): 11 | logger.info("Hello command executed") 12 | return "Hello!" 13 | 14 | def start(self): 15 | LibCommand.simpleCommand().registerCommand("hello", "This command tells you hello!", self.cmdHello) -------------------------------------------------------------------------------- /plugins/__init__.py: -------------------------------------------------------------------------------- 1 | # https://gist.github.com/dorneanu/cce1cd6711969d581873a88e0257e312 2 | 3 | import os 4 | import traceback 5 | from importlib import util 6 | 7 | 8 | class Base: 9 | """Basic resource class. Concrete resources will inherit from this one 10 | """ 11 | plugins = [] 12 | 13 | # For every class that inherits from the current, 14 | # the class name will be added to plugins 15 | def __init_subclass__(cls, **kwargs): 16 | super().__init_subclass__(**kwargs) 17 | cls.plugins.append(cls) 18 | 19 | 20 | # Small utility to automatically load modules 21 | def load_module(path): 22 | name = os.path.split(path)[-1] 23 | spec = util.spec_from_file_location(name, path) 24 | module = util.module_from_spec(spec) 25 | spec.loader.exec_module(module) 26 | return module 27 | 28 | 29 | # Get current path 30 | path = os.path.abspath(__file__) 31 | dirpath = os.path.dirname(path) 32 | 33 | for fname in os.listdir(dirpath): 34 | # Load only "real modules" 35 | if not fname.startswith('.') and ( not fname.startswith('__') ) and fname.endswith('.py') and not fname.startswith("lib"): 36 | try: 37 | load_module(os.path.join(dirpath, fname)) 38 | print("[INFO] Loaded file "+fname) 39 | except Exception: 40 | traceback.print_exc() -------------------------------------------------------------------------------- /plugins-disabled/gpt.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.libdiscordutil as DiscordUtil 3 | import cfg 4 | import yaml 5 | import plugins.liblogger as logger 6 | from openai import OpenAI 7 | import plugins.libmesh as LibMesh 8 | import plugins.libinfo as libinfo 9 | import plugins.libcommand as LibCommand 10 | 11 | class gpt(plugins.Base): 12 | 13 | def __init__(self): 14 | pass 15 | 16 | def start(self): 17 | logger.info("Loading OpenAI") 18 | 19 | # Register GPT command 20 | def cmd_gpt(packet, interface, client, args): 21 | prompt = args.strip() 22 | if not prompt: 23 | logger.info("No prompt provided after 'gpt' command") 24 | return "Please provide a prompt." 25 | 26 | ai_client = self.gpt_setup() 27 | response = ai_client.chat.completions.create( 28 | model="gpt-4o-mini", 29 | messages=[ 30 | {"role": "system", "content": "Make a short comment not exceeding 20 words"}, 31 | {"role": "user", "content": prompt} 32 | ], 33 | max_tokens=60 34 | ) 35 | 36 | gpt_response = response.choices[0].message.content.strip() 37 | 38 | logger.info(f"Sent GPT response: {gpt_response}") 39 | return gpt_response 40 | 41 | LibCommand.simpleCommand().registerCommand("gpt", "Use chatgpt", cmd_gpt) 42 | 43 | def gpt_setup(self): 44 | with open("./plugins/gpt-config.yml", 'r') as file: 45 | cfg.gptconfig = yaml.safe_load(file) 46 | 47 | open_ai_token = cfg.gptconfig["open_ai_token"] 48 | return OpenAI(api_key=open_ai_token) -------------------------------------------------------------------------------- /plugins/libmesh.py: -------------------------------------------------------------------------------- 1 | import cfg 2 | 3 | def getUserLong(interface,packet): 4 | ret=None 5 | node = getNode(interface,packet) 6 | if(node and "user" in node): 7 | ret = str(node["user"]["longName"]) 8 | return ret 9 | 10 | ret = decimal_to_hex(packet["from"]) 11 | return ret 12 | 13 | def getUserShort(interface,packet): 14 | ret=None 15 | node = getNode(interface,packet) 16 | if(node and "user" in node): 17 | ret = str(node["user"]["shortName"]) 18 | return ret 19 | 20 | def getNode(interface,packet): 21 | ret = None 22 | if(packet["fromId"] in interface.nodes): 23 | ret = interface.nodes[packet["fromId"]] 24 | return ret 25 | 26 | def decimal_to_hex(decimal_number): 27 | return f"!{decimal_number:08x}" 28 | 29 | def getPosition(interface,packet): 30 | lat = None 31 | long = None 32 | hasPos = False 33 | 34 | node = getNode(interface,packet) 35 | if(packet["fromId"] in interface.nodes): 36 | if("position" in node): 37 | if("latitude" in node["position"] and "longitude" in node["position"]): 38 | lat = node["position"]["latitude"] 39 | long = node["position"]["longitude"] 40 | hasPos = True 41 | 42 | return lat, long, hasPos 43 | 44 | 45 | def sendReply(text, interface, packet, channelIndex = -1): 46 | ret = packet 47 | 48 | if(channelIndex == -1): 49 | channelIndex = cfg.config["send_channel_index"] 50 | 51 | to = 4294967295 # ^all 52 | 53 | if(packet["to"] == interface.localNode.nodeNum): 54 | to = packet["from"] 55 | interface.sendText(text=text,destinationId=to,channelIndex=channelIndex) 56 | 57 | return ret -------------------------------------------------------------------------------- /plugins/libcommand.py: -------------------------------------------------------------------------------- 1 | import plugins.liblogger as logger 2 | import plugins.libdiscordutil as DiscordUtil 3 | import plugins.libinfo as LibInfo 4 | import plugins.libmesh as LibMesh 5 | import cfg 6 | 7 | commands = [] 8 | 9 | class simpleCommand(): 10 | """Basic command class, use this to create simple commands. 11 | registerCommand("Hello", "This command tells you hello!", callback function) 12 | """ 13 | name = "" 14 | info = "" 15 | callback = None 16 | 17 | 18 | def registerCommand(self, name, info, callback): 19 | self.name = name 20 | self.info = info 21 | self.callback = callback 22 | commands.append(self) 23 | 24 | LibInfo.info.append(f"{name} - {info}") 25 | 26 | def onReceive(self, packet, interface, client): 27 | if("decoded" in packet): 28 | if(packet["decoded"]["portnum"] == "TEXT_MESSAGE_APP"): 29 | text = packet["decoded"]["text"] 30 | if(text.startswith(cfg.config["prefix"])): 31 | 32 | noprefix = text[len(cfg.config["prefix"]):] 33 | 34 | parts = noprefix.split(maxsplit=1) 35 | command_name = parts[0] 36 | args = parts[1] if len(parts) > 1 else "" 37 | 38 | if command_name == self.name: 39 | reply = self.executeCommand(packet, interface, client, args) 40 | LibMesh.sendReply(reply, interface, packet) 41 | 42 | if(cfg.config["send_mesh_commands_to_discord"]): 43 | DiscordUtil.send_msg("`MeshLink`> "+reply, client, cfg.config) 44 | 45 | 46 | def executeCommand(self, packet, interface, client, args): 47 | return self.callback(packet, interface, client, args) 48 | 49 | 50 | -------------------------------------------------------------------------------- /plugins/libdiscordutil.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import plugins.libmesh as LibMesh 3 | 4 | def genUserName(interface, packet, details=True): 5 | short = LibMesh.getUserShort(interface, packet) 6 | long = LibMesh.getUserLong(interface, packet) or "" 7 | lat, lon, hasPos = LibMesh.getPosition(interface, packet) 8 | 9 | ret = f"`{short} " if short is not None else "`" 10 | 11 | if details: 12 | if packet.get("fromId") is not None: 13 | ret += f"{packet['fromId']} " 14 | ret += f"{long}`" 15 | 16 | if details and hasPos: 17 | ret += f" [map]()" 18 | 19 | if "hopLimit" in packet: 20 | if "hopStart" in packet: 21 | ret += f" `{packet['hopStart'] - packet['hopLimit']}`/`{packet['hopStart']}`" 22 | else: 23 | ret += f" `{packet['hopLimit']}`" 24 | 25 | if "viaMqtt" in packet and str(packet["viaMqtt"]) == "True": 26 | ret += " `MQTT`" 27 | 28 | return ret 29 | 30 | def send_msg(message,client,config,channel_id=0): 31 | if config["use_discord"]: 32 | if (client.is_ready()): 33 | if config.get("secondary_channel_message_ids") and channel_id and channel_id > 0: 34 | chan = config["secondary_channel_message_ids"][channel_id-1] 35 | asyncio.run_coroutine_threadsafe(client.get_channel(chan).send(message),client.loop) 36 | else: 37 | for i in config["message_channel_ids"]: 38 | asyncio.run_coroutine_threadsafe(client.get_channel(i).send(message),client.loop) 39 | 40 | def send_info(message,client,config): 41 | if config["use_discord"]: 42 | if (client.is_ready()): 43 | for i in config["info_channel_ids"]: 44 | asyncio.run_coroutine_threadsafe(client.get_channel(i).send(message),client.loop) 45 | -------------------------------------------------------------------------------- /plugins/info.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.libdiscordutil as DiscordUtil 3 | import cfg 4 | import plugins.liblogger as logger 5 | import plugins.libinfo as libinfo 6 | import plugins.libcommand as LibCommand 7 | import plugins.libmesh as LibMesh 8 | 9 | class pluginInfo(plugins.Base): 10 | 11 | def __init__(self): 12 | pass 13 | 14 | def calcPages(self, lines): 15 | max_len = cfg.config["max_message_length"] 16 | if not lines: 17 | return 0 18 | 19 | pages = [] 20 | current_page = "" 21 | for line in lines: 22 | if len(current_page) + len(line) + 1 > max_len: 23 | pages.append(current_page.rstrip("\n")) 24 | current_page = "" 25 | current_page += line + "\n" 26 | 27 | if current_page: 28 | pages.append(current_page.rstrip("\n")) 29 | 30 | return len(pages), pages 31 | 32 | def start(self): 33 | logger.info("Loading info") 34 | 35 | def cmd_info(packet, interface, client, args): 36 | try: 37 | page = int(args.strip()) if args.strip() else 0 38 | if page < 0: 39 | page = 0 40 | except ValueError: 41 | page = 0 42 | 43 | num_pages, pages = self.calcPages(libinfo.info) 44 | 45 | if page > num_pages: 46 | page = 0 47 | 48 | 49 | if page == 0: 50 | final_info = f"""<- info -> 51 | Welcome to MeshLink! 52 | Use '{cfg.config["prefix"]}info ' to view different pages. 53 | This is page 0/{num_pages}""" 54 | 55 | else: 56 | final_info = pages[page-1] 57 | 58 | 59 | 60 | 61 | return final_info 62 | 63 | LibCommand.simpleCommand().registerCommand("info", "info ", cmd_info) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MeshLink (Beta) 2 | ## Features 3 | 4 | - Send messages to and from discord 5 | - Send packet information to discord 6 | - Plugin system (see example plugin in `plugins/testcommand.py`) 7 | 8 | ### Mesh only 9 | - Weather forecast 10 | - Ping 11 | - HF condition checker 12 | - Time 13 | - Save position as waypoint with timestamp 14 | - ChatGPT with **optional** plugin 15 | - Help command with multi page support 16 | 17 | ## Commands 18 | **prefix + command** 19 | ### Discord 20 | send (message) 21 | 22 | ## Setup 23 | 24 | 1. Download the python script and config-example.yml from Github 25 | 2. Rename config-example.yml to config.yml before editing (step 10) 26 | 3. Install the Meshtastic python CLI https://meshtastic.org/docs/software/python/cli/installation/ 27 | 4. Install discord py https://discordpy.readthedocs.io/en/latest/intro.html 28 | 5. Create a discord bot https://discord.com/developers (optional) 29 | 6. Give it admin permission in your server and give it read messages intent (google it if you don't know what to do) (optional) 30 | 7. Invite it to a server (optional) 31 | 8. Get the discord channel id (this is where the messages will go) (again google a tutorial if don't know how to get the channel id) (optional) 32 | 9. Get the discord bot token (optional) 33 | 10. Add your discord bot token and channel id(s) to config.yml (optional) 34 | 11. If you are using serial set `use_serial` to `True` otherwise get your nodes ip and put it into the `radio_ip` setting 35 | 12. configure config.yml to your liking 36 | 14. `python main.py` 37 | 38 | ## Updating 39 | You may receive a log in the console like this: 40 | `[INFO] New MeshLink update ready https://github.com/Murturtle/MeshLinkBeta` 41 | 42 | run `git pull https://github.com/Murturtle/MeshLinkBeta main` to pull the latest version without overriding config 43 | Make sure to increment the `rev` setting in `config.yml` or you will keep getting notified that there is an update! 44 | 45 | ## Suggestions/Feature Requests 46 | Put them in issues. 47 | -------------------------------------------------------------------------------- /config-example.yml: -------------------------------------------------------------------------------- 1 | # Read each setting carefully and modify to your needs 2 | 3 | ### UPDATES 4 | rev: 23 # increment after update! 5 | ignore_update_prompt: False # set this to True if you do not want to answer y/n every time there is an update (set to True if using auto restart/startup) 6 | check_for_updates: True # set to False to disable update checking 7 | 8 | ### DISCORD SETTINGS 9 | use_discord: True 10 | max_message_length: 200 # max discord -> mesh message length and info message length 11 | info_channel_ids: [ 1234567890 ] # separate using commas 12 | message_channel_ids: [ 1234567890 ] 13 | secondary_channel_message_ids: [ ] # secondary channels to send and receive messages from. Each discord channel id in this list corresponds to a node's channel id 1-7. 14 | token: "SDFjLKJVLREkjslRVJRLKjVLRKJLRVjrLKVJ" # discord bot token - DO NOT SHARE 15 | discord_prefix: "$" # discord prefix 16 | ignore_self: True # dont show your own node on discord 17 | send_packets: True # show all data not just messages 18 | ping_on_messages: True # should the bot add the message_role to the message 19 | message_role: "@here" # the role on discord to ping on messages, if you dont want to ping everyone set to a custom role 20 | permit_broadcast_of_discord_messages: True # allow messages from discord to be transmitted to your selected channel 21 | send_mesh_commands_to_discord: True # send responses to mesh commands to discord 22 | 23 | ### MESH AND RADIO SETTINGS 24 | prefix: "$" # mesh command prefix 25 | use_serial: True # set to False if using tcp 26 | radio_ip: "192.168.1.100" # ip of the radio if using tcp 27 | send_channel_index: 0 # the index of the channel to send messages on 28 | verbose_packets: False # should the full packet data be shown in the console 29 | send_start_stop: True # should the meshlink announcement be sent on connection and shut down 30 | include_username_prefix: True # include the username prefix in mesh messages from discord 31 | 32 | ### BUILT IN PLUGINS 33 | weather_lat: "45.516022" # latitude for for weather plugin 34 | weather_long: "-122.681427" 35 | max_weather_hours: 8 # how many hours ahead to send weather info for 36 | -------------------------------------------------------------------------------- /plugins/basic_commands.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.liblogger as logger 3 | import plugins.libinfo as libinfo 4 | import plugins.libmesh as LibMesh 5 | import cfg 6 | import requests 7 | import time 8 | import xml.dom.minidom 9 | from datetime import datetime 10 | import plugins.libcommand as LibCommand 11 | 12 | class basicCommands(plugins.Base): 13 | 14 | def __init__(self): 15 | pass 16 | 17 | def start(self): 18 | logger.info("Loading basic commands") 19 | 20 | # ping command 21 | def cmd_ping(packet, interface, client, args): 22 | return "pong" 23 | LibCommand.simpleCommand().registerCommand("ping", "pong!", cmd_ping) 24 | 25 | # time command 26 | def cmd_time(packet, interface, client, args): 27 | return time.strftime('%H:%M:%S') 28 | LibCommand.simpleCommand().registerCommand("time", "Sends the current time", cmd_time) 29 | 30 | # mesh command 31 | #def cmd_mesh(packet, interface, client, args): 32 | # final = "<- Mesh Stats ->" 33 | # final += "\nWARNING NODES DO NOT REPORT CHUTIL WHEN CHUTIL IS HIGH" 34 | 35 | # nodes_with_chutil = 0 36 | # total_chutil = 0 37 | # for i in interface.nodes: 38 | # a = interface.nodes[i] 39 | # if "deviceMetrics" in a: 40 | # if "channelUtilization" in a['deviceMetrics']: 41 | # nodes_with_chutil += 1 42 | # total_chutil += a['deviceMetrics']["channelUtilization"] 43 | 44 | # if nodes_with_chutil > 0: 45 | # avg_chutil = total_chutil / nodes_with_chutil 46 | # avg_chutil = round(avg_chutil, 1) 47 | # final += "\n chutil avg: " + str(avg_chutil) 48 | # else: 49 | # final += "\n chutil avg: N/A" 50 | # return final 51 | #LibCommand.simpleCommand().registerCommand("mesh", "Check channel utilization", cmd_mesh) 52 | 53 | # savepos command 54 | def cmd_savepos(packet, interface, client, args): 55 | lat, long, hasPos = LibMesh.getPosition(interface, packet) 56 | name = LibMesh.getUserLong(interface, packet) 57 | if hasPos: 58 | interface.sendWaypoint( 59 | name, 60 | description=datetime.now().strftime("%H:%M, %m/%d/%Y"), 61 | latitude=lat, 62 | longitude=long, 63 | channelIndex=cfg.config["send_channel_index"], 64 | expire=2147483647 65 | ) 66 | return f"{name} {lat} {long}" 67 | else: 68 | return "No position found!" 69 | LibCommand.simpleCommand().registerCommand("savepos", "Saves your position", cmd_savepos) -------------------------------------------------------------------------------- /plugins/basic_events.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.libdiscordutil as DiscordUtil 3 | import cfg 4 | import plugins.liblogger as logger 5 | from meshtastic import mesh_interface 6 | import plugins.libmesh as LibMesh 7 | 8 | class basicEvents(plugins.Base): 9 | 10 | def __init__(self): 11 | pass 12 | 13 | def start(self): 14 | logger.info("Loading basic events") 15 | 16 | def onReceive(self, packet, interface, client): 17 | if cfg.config["verbose_packets"]: 18 | logger.info("############################################") 19 | logger.info(packet) 20 | logger.info("--------------------------------------------") 21 | 22 | final_message = "" 23 | send_channel = 0 24 | if "decoded" not in packet: 25 | final_message += DiscordUtil.genUserName(interface, packet) + " > encrypted/failed" 26 | DiscordUtil.send_info(final_message, client, cfg.config) 27 | 28 | if cfg.config["verbose_packets"]: 29 | logger.infoimportant("Failed or encrypted") 30 | return 31 | 32 | if cfg.config["verbose_packets"]: 33 | logger.info("Decoded") 34 | 35 | portnum = packet["decoded"]["portnum"] 36 | 37 | if portnum == "TEXT_MESSAGE_APP": 38 | if "channel" in packet: 39 | send_channel = int(packet["channel"]) 40 | final_message += DiscordUtil.genUserName(interface, packet, details=False) 41 | text = packet["decoded"]["text"] 42 | 43 | if packet.get("from") is not None: 44 | logger.infogreen(f"{packet['fromId']}> {text}") 45 | else: 46 | logger.infogreen("Unknown ID> " + text) 47 | 48 | if text.lower() == "meshlink": 49 | LibMesh.sendReply("MeshLink is running on this node - rev " + str(cfg.config["rev"]) + "\n\nuse " + cfg.config["prefix"] + "info for a list of commands", interface, packet) 50 | 51 | final_message += " > " + text 52 | 53 | if cfg.config["ping_on_messages"]: 54 | final_message += " ||" + cfg.config["message_role"] + "||" 55 | 56 | DiscordUtil.send_msg(final_message, client, cfg.config, send_channel) 57 | return 58 | 59 | if cfg.config["send_packets"]: 60 | try: 61 | is_self = packet["fromId"] == interface.getMyNodeInfo()["user"]["id"] 62 | if is_self and cfg.config["ignore_self"]: 63 | if cfg.config["verbose_packets"]: 64 | logger.info("Ignoring self") 65 | else: 66 | final_message += DiscordUtil.genUserName(interface, packet) + "> " + str(portnum) 67 | except TypeError as e: 68 | logger.infoimportant(f"TypeError: {e}. We don't have our own nodenum yet.") 69 | 70 | DiscordUtil.send_info(final_message, client, cfg.config) 71 | 72 | 73 | 74 | 75 | def onConnect(self,interface,client): 76 | logger.infogreen("Node connected") 77 | 78 | 79 | DiscordUtil.send_msg("MeshLink is now running - rev "+str(cfg.config["rev"]), client, cfg.config) 80 | if(cfg.config["send_start_stop"]): 81 | interface.sendText("MeshLink is now running - rev "+str(cfg.config["rev"])+"\n\nuse "+cfg.config["prefix"]+"info for a list of commands",channelIndex = cfg.config["send_channel_index"]) 82 | 83 | def onDisconnect(self,interface,client): 84 | logger.warn("Connection to node has been lost - attemping to reconnect") 85 | DiscordUtil.send_msg("# Connection to node has been lost",client, cfg.config) 86 | -------------------------------------------------------------------------------- /plugins/enviroment.py: -------------------------------------------------------------------------------- 1 | import plugins 2 | import plugins.liblogger as logger 3 | import plugins.libinfo as libinfo 4 | import plugins.libmesh as LibMesh 5 | import cfg 6 | import requests 7 | import time 8 | import xml.dom.minidom 9 | from datetime import datetime 10 | import plugins.libcommand as LibCommand 11 | 12 | 13 | class basicCommands(plugins.Base): 14 | 15 | def __init__(self): 16 | pass 17 | 18 | def start(self): 19 | logger.info("Loading basic commands") 20 | 21 | def getLatLong(packet, interface): 22 | lat, long, hasPos = LibMesh.getPosition(interface, packet) 23 | if hasPos: 24 | return (lat, long, True) 25 | else: 26 | return (cfg.config['weather_lat'], cfg.config['weather_long'], False) 27 | 28 | # weather command 29 | def cmd_weather(packet, interface, client, args): 30 | lat, long, hasPos = getLatLong(packet, interface) 31 | weather_data_res = requests.get( 32 | f"https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={long}" 33 | "&hourly=temperature_2m,precipitation_probability&temperature_unit=fahrenheit&wind_speed_unit=mph&precipitation_unit=inch&timeformat=unixtime&timezone=auto" 34 | ) 35 | weather_data = weather_data_res.json() 36 | final = "" 37 | if weather_data_res.ok: 38 | for j in range(cfg.config["max_weather_hours"]): 39 | i = j + int(time.strftime('%H')) 40 | final += f"{i % 24} {round(weather_data['hourly']['temperature_2m'][i])}F {weather_data['hourly']['precipitation_probability'][i]}%\n" 41 | #final = final[:-1] # to remove newline at end 42 | final += "(Your position)" if hasPos else "(Config position)" 43 | else: 44 | final = "Error fetching" 45 | logger.info(final) 46 | return final 47 | LibCommand.simpleCommand().registerCommand("weather", "Gets the weather", cmd_weather) 48 | 49 | # aqi command 50 | def cmd_aqi(packet, interface, client, args): 51 | lat, long, hasPos = getLatLong(packet, interface) 52 | final = "" 53 | aqi_data_res = requests.get( 54 | f"https://air-quality-api.open-meteo.com/v1/air-quality?latitude={lat}&longitude={long}¤t=us_aqi,us_aqi_pm2_5,us_aqi_pm10,us_aqi_nitrogen_dioxide,us_aqi_carbon_monoxide,us_aqi_ozone,us_aqi_sulphur_dioxide&timezone=auto&forecast_hours=1&past_hours=1&timeformat=unixtime" 55 | ) 56 | aqi_data = aqi_data_res.json() 57 | 58 | if aqi_data_res.ok: 59 | final += f"AQI: {aqi_data['current']['us_aqi']}\n" 60 | final += f"PM2.5: {aqi_data['current']['us_aqi_pm2_5']}\n" 61 | final += f"PM10: {aqi_data['current']['us_aqi_pm10']}\n" 62 | final += f"NO2: {aqi_data['current']['us_aqi_nitrogen_dioxide']}\n" 63 | final += f"CO: {aqi_data['current']['us_aqi_carbon_monoxide']}\n" 64 | final += f"O3: {aqi_data['current']['us_aqi_ozone']}\n" 65 | final += f"SO2: {aqi_data['current']['us_aqi_sulphur_dioxide']}\n" 66 | final += "(Your position)" if hasPos else "(Config position)" 67 | else: 68 | final = "Error fetching" 69 | logger.info(final) 70 | return final 71 | LibCommand.simpleCommand().registerCommand("aqi", "Gets the AQI", cmd_aqi) 72 | 73 | # hf command 74 | def cmd_hf(packet, interface, client, args): 75 | final = "" 76 | solar = requests.get("https://www.hamqsl.com/solarxml.php") 77 | if solar.ok: 78 | solarxml = xml.dom.minidom.parseString(solar.text) 79 | for i in solarxml.getElementsByTagName("band"): 80 | final += f"{i.getAttribute('time')[0]}{i.getAttribute('name')} {i.childNodes[0].data}\n" 81 | final = final[:-1] 82 | else: 83 | final = "Error fetching" 84 | logger.info(final) 85 | return final 86 | LibCommand.simpleCommand().registerCommand("hf", "Get HF radio conditions", cmd_hf) 87 | 88 | 89 | # elevation command 90 | def cmd_elevation(packet, interface, client, args): 91 | lat, long, hasPos = LibMesh.getPosition(interface, packet) 92 | name = LibMesh.getUserLong(interface, packet) 93 | if hasPos: 94 | ele = requests.get(f"https://api.open-meteo.com/v1/elevation?latitude={lat}&longitude={long}") 95 | if ele.ok: 96 | return f"{name} elevation is {ele.json()['elevation'][0]}m asl" 97 | else: 98 | return "Error fetching" 99 | else: 100 | return "No position found!" 101 | LibCommand.simpleCommand().registerCommand("elevation", "Gets your elevation", cmd_elevation) -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | from plugins import Base 2 | 3 | # dont change unless you are making a fork 4 | update_check_url = "https://raw.githubusercontent.com/Murturtle/MeshLinkBeta/main/rev" 5 | update_url = "https://github.com/Murturtle/MeshLinkBeta" 6 | import yaml 7 | import xml.dom.minidom 8 | import os 9 | from pubsub import pub 10 | import discord 11 | from meshtastic.tcp_interface import TCPInterface 12 | from meshtastic.serial_interface import SerialInterface 13 | import asyncio 14 | import time 15 | import requests 16 | import cfg 17 | import plugins.liblogger as logger 18 | import signal 19 | import plugins.libdiscordutil as DiscordUtil 20 | from datetime import datetime 21 | import math 22 | import plugins.libcommand as LibCommand 23 | 24 | 25 | def handler(signum, frame): 26 | logger.infogreen("MeshLink is now stopping!") 27 | if(cfg.config["send_start_stop"]): 28 | interface.sendText("MeshLink is now stopping!",channelIndex = cfg.config["send_channel_index"]) 29 | exit(1) 30 | 31 | signal.signal(signal.SIGINT, handler) 32 | 33 | with open("./config.yml",'r') as file: 34 | cfg.config = yaml.safe_load(file) 35 | 36 | config_options = [ 37 | "rev", 38 | "ignore_update_prompt", 39 | "check_for_updates", 40 | "use_discord", 41 | "max_message_length", 42 | "info_channel_ids", 43 | "message_channel_ids", 44 | "secondary_channel_message_ids", 45 | "token", 46 | "discord_prefix", 47 | "ignore_self", 48 | "send_packets", 49 | "ping_on_messages", 50 | "message_role", 51 | "send_mesh_commands_to_discord", 52 | "prefix", 53 | "use_serial", 54 | "radio_ip", 55 | "send_channel_index", 56 | "verbose_packets", 57 | "send_start_stop", 58 | "include_username_prefix", 59 | "weather_lat", 60 | "weather_long", 61 | "max_weather_hours" 62 | ] 63 | 64 | for i in config_options: 65 | if i not in cfg.config: 66 | logger.infoimportant("Config option "+i+" missing in config.yml (check github for example)") 67 | exit() 68 | 69 | for i in cfg.config: 70 | if i not in config_options: 71 | logger.infoimportant("Config option "+i+" might not needed anymore") 72 | 73 | for plugin in Base.plugins: 74 | inst = plugin() 75 | inst.start() 76 | 77 | if(cfg.config["check_for_updates"]): 78 | oversion = requests.get(update_check_url) 79 | if(oversion.ok): 80 | if(cfg.config["rev"] < int(oversion.text)): 81 | logger.infoimportant("New MeshLink update ready "+update_url) 82 | logger.warn("Remember after the update to double check the plugins you want disabled stay disabled") 83 | logger.warn("Also remember to increment rev in config.yml") 84 | if(not cfg.config["ignore_update_prompt"]): 85 | if(input(" Would you like to update MeshLink? y/n ")=="y"): 86 | logger.info("running: git pull "+update_url +" main") 87 | os.system("git pull "+update_url+" main") 88 | logger.infogreen("Start MeshLink to apply updates!") 89 | exit(1) 90 | else: 91 | logger.infoimportant("Ignoring update - use the following command to update: git pull "+update_url+" main") 92 | else: 93 | logger.infogreen("MeshLink is up to date! local: " + str(cfg.config["rev"])+" remote: "+str(int(oversion.text))) 94 | else: 95 | logger.warn("Failed to check for updates using url "+update_check_url+"\x1b[0m") 96 | else: 97 | logger.infoimportant("Update checking disabled, change this using check_for_updates in config.yml") 98 | 99 | intents = discord.Intents.default() 100 | intents.message_content = True 101 | if cfg.config["use_discord"]: 102 | client = discord.Client(intents=intents) 103 | else: 104 | client = None 105 | 106 | def onConnection(interface, topic=pub.AUTO_TOPIC): 107 | for p in Base.plugins: 108 | inst = p() 109 | if hasattr(inst, "onConnect") and callable(inst.onConnect): 110 | inst.onConnect(interface,client) 111 | 112 | def onReceive(packet, interface): 113 | for p in Base.plugins: 114 | inst = p() 115 | if hasattr(inst, "onReceive") and callable(inst.onReceive): 116 | inst.onReceive(packet,interface,client) 117 | for cmd in LibCommand.commands: 118 | cmd.onReceive(packet,interface,client) 119 | 120 | def onDisconnect(interface): 121 | for p in Base.plugins: 122 | inst = p() 123 | if hasattr(inst, "onDisconnect") and callable(inst.onDisconnect): 124 | inst.onDisconnect(interface,client) 125 | init_radio() 126 | 127 | pub.subscribe(onConnection, "meshtastic.connection.established") 128 | pub.subscribe(onDisconnect, "meshtastic.connection.lost") 129 | pub.subscribe(onReceive, "meshtastic.receive") 130 | 131 | def init_radio(): 132 | global interface 133 | logger.info("Connecting to node...") 134 | if (cfg.config["use_serial"]): 135 | interface = SerialInterface() 136 | 137 | else: 138 | # interface = TCPInterface(hostname=cfg.config["radio_ip"], connectNow=True) 139 | 140 | # Determine hostname and port with sensible defaults 141 | host = cfg.config.get("radio_ip", "127.0.0.1") 142 | port = 4403 143 | 144 | # Allow "host:port" in radio_ip if provided 145 | if isinstance(host, str) and ":" in host: 146 | maybe_host, maybe_port = host.rsplit(":", 1) 147 | if maybe_port.isdigit(): 148 | host = maybe_host 149 | try: 150 | port = int(maybe_port) 151 | except ValueError: 152 | port = 4403 153 | 154 | logger.info(f"Connecting via TCPInterface to {host}:{port}…") 155 | interface = TCPInterface(hostname=host, portNumber=port, connectNow=True) 156 | 157 | 158 | init_radio() 159 | 160 | if cfg.config["use_discord"]: 161 | @client.event 162 | async def on_ready(): 163 | logger.info("Logged in as {0.user} on Discord".format(client)) 164 | #send_msg("ready") 165 | 166 | @client.event 167 | async def on_message(message): 168 | if not cfg.config["permit_broadcast_of_discord_messages"]: 169 | return 170 | 171 | global interface 172 | if message.author == client.user: 173 | return 174 | if message.content.startswith(cfg.config["discord_prefix"]+'send'): 175 | if (message.channel.id in cfg.config["message_channel_ids"] or 176 | message.channel.id in cfg.config.get("secondary_channel_message_ids", [])): 177 | await message.channel.typing() 178 | trunk_message = message.content[len(cfg.config["discord_prefix"]+"send"):] 179 | if(cfg.config["include_username_prefix"]): 180 | final_message = message.author.name+">"+ trunk_message 181 | else: 182 | final_message = trunk_message 183 | 184 | if message.channel.id in cfg.config.get("secondary_channel_message_ids", []): 185 | channel_index = cfg.config["secondary_channel_message_ids"].index(message.channel.id) + 1 186 | else: 187 | channel_index = cfg.config["send_channel_index"] 188 | 189 | if len(final_message) < cfg.config["max_message_length"] - 1: 190 | await message.reply(final_message) 191 | interface.sendText(final_message, channelIndex=channel_index) 192 | logger.infodiscord(final_message) 193 | else: 194 | short_msg = final_message[:cfg.config["max_message_length"]] 195 | await message.reply("(shortend) " + short_msg) 196 | interface.sendText(short_msg, channelIndex=channel_index) 197 | logger.infodiscord(short_msg) 198 | #await message.delete() 199 | 200 | else: 201 | return 202 | 203 | try: 204 | if cfg.config["use_discord"]: 205 | client.run(cfg.config["token"],log_handler=None) 206 | else: 207 | while True: 208 | time.sleep(1) 209 | except discord.HTTPException as e: 210 | if e.status == 429: 211 | logger.warn("Discord: too many requests") 212 | -------------------------------------------------------------------------------- /plugins/funplugin.py: -------------------------------------------------------------------------------- 1 | quotes = [ 2 | "Life isn't about getting and having, it's about giving and being. - Kevin Kruse", 3 | "Whatever the mind of man can conceive and believe, it can achieve. - Napoleon Hill", 4 | "Strive not to be a success, but rather to be of value. - Albert Einstein", 5 | "Two roads diverged in a wood, and I—I took the one less traveled by, And that has made all the difference. - Robert Frost", 6 | "I attribute my success to this: I never gave or took any excuse. - Florence Nightingale", 7 | "You miss 100% of the shots you don't take. - Wayne Gretzky", 8 | "The most difficult thing is the decision to act, the rest is merely tenacity. - Amelia Earhart", 9 | "Every strike brings me closer to the next home run. - Babe Ruth", 10 | "Definiteness of purpose is the starting point of all achievement. - W. Clement Stone", 11 | "We must balance conspicuous consumption with conscious capitalism. - Kevin Kruse", 12 | "Life is what happens to you while you're busy making other plans. - John Lennon", 13 | "We become what we think about. - Earl Nightingale", 14 | "Life is 10% what happens to me and 90% of how I react to it. - Charles Swindoll", 15 | "The most common way people give up their power is by thinking they don't have any. - Alice Walker", 16 | "The mind is everything. What you think you become. - Buddha", 17 | "The best time to plant a tree was 20 years ago. The second best time is now. - Chinese Proverb", 18 | "An unexamined life is not worth living. - Socrates", 19 | "Eighty percent of success is showing up. - Woody Allen", 20 | "Your time is limited, so don't waste it living someone else's life. - Steve Jobs", 21 | "Winning isn't everything, but wanting to win is. - Vince Lombardi", 22 | "I am not a product of my circumstances. I am a product of my decisions. - Stephen Covey", 23 | "Every child is an artist. The problem is how to remain an artist once he grows up. - Pablo Picasso", 24 | "You can never cross the ocean until you have the courage to lose sight of the shore. - Christopher Columbus", 25 | "I've learned that people will forget what you said, people will forget what you did, but people will never forget how you made them feel. - Maya Angelou", 26 | "Either you run the day, or the day runs you. - Jim Rohn", 27 | "Whether you think you can or you think you can't, you're right. - Henry Ford", 28 | "The two most important days in your life are the day you are born and the day you find out why. - Mark Twain", 29 | "Whatever you can do, or dream you can, begin it. Boldness has genius, power and magic in it. - Johann Wolfgang von Goethe", 30 | "The best revenge is massive success. - Frank Sinatra", 31 | "People often say that motivation doesn't last. Well, neither does bathing. That's why we recommend it daily. - Zig Ziglar", 32 | "Life shrinks or expands in proportion to one's courage. - Anais Nin", 33 | "If you hear a voice within you say “you cannot paint,” then by all means paint and that voice will be silenced. - Vincent Van Gogh", 34 | "There is only one way to avoid criticism: do nothing, say nothing, and be nothing. - Aristotle", 35 | "Ask and it will be given to you; search, and you will find; knock and the door will be opened for you. - Jesus", 36 | "The only person you are destined to become is the person you decide to be. - Ralph Waldo Emerson", 37 | "Go confidently in the direction of your dreams. Live the life you have imagined. - Henry David Thoreau", 38 | "Few things can help an individual more than to place responsibility on him, and to let him know that you trust him. - Booker T. Washington", 39 | "Certain things catch your eye, but pursue only those that capture the heart. - Ancient Indian Proverb", 40 | "Believe you can and you're halfway there. - Theodore Roosevelt", 41 | "Everything you've ever wanted is on the other side of fear. - George Addair", 42 | "We can easily forgive a child who is afraid of the dark; the real tragedy of life is when men are afraid of the light. - Plato", 43 | "Teach thy tongue to say, “I do not know,” and thous shalt progress. - Maimonides", 44 | "Start where you are. Use what you have. Do what you can. - Arthur Ashe", 45 | "Fall seven times and stand up eight. - Japanese Proverb", 46 | "Everything has beauty, but not everyone can see. - Confucius", 47 | "How wonderful it is that nobody need wait a single moment before starting to improve the world. - Anne Frank", 48 | "When I let go of what I am, I become what I might be. - Lao Tzu", 49 | "Life is not measured by the number of breaths we take, but by the moments that take our breath away. - Maya Angelou", 50 | "Happiness is not something readymade. It comes from your own actions. - Dalai Lama", 51 | "If you're offered a seat on a rocket ship, don't ask what seat! Just get on. - Sheryl Sandberg", 52 | "If the wind will not serve, take to the oars. - Latin Proverb", 53 | "You can't fall if you don't climb. But there's no joy in living your whole life on the ground. - Unknown", 54 | "We must believe that we are gifted for something, and that this thing, at whatever cost, must be attained. - Marie Curie", 55 | "Too many of us are not living our dreams because we are living our fears. - Les Brown", 56 | "Challenges are what make life interesting and overcoming them is what makes life meaningful. - Joshua J. Marine", 57 | "If you want to lift yourself up, lift up someone else. - Booker T. Washington", 58 | "I have been impressed with the urgency of doing. Knowing is not enough; we must apply. Being willing is not enough; we must do. - Leonardo da Vinci", 59 | "Limitations live only in our minds. But if we use our imaginations, our possibilities become limitless. - Jamie Paolinetti", 60 | "You take your life in your own hands, and what happens? A terrible thing, no one to blame. - Erica Jong", 61 | "What's money? A man is a success if he gets up in the morning and goes to bed at night and in between does what he wants to do. - Bob Dylan", 62 | "I didn't fail the test. I just found 100 ways to do it wrong. - Benjamin Franklin", 63 | "In order to succeed, your desire for success should be greater than your fear of failure. - Bill Cosby", 64 | "A person who never made a mistake never tried anything new. - Albert Einstein", 65 | "The person who says it cannot be done should not interrupt the person who is doing it. - Chinese Proverb", 66 | "There are no traffic jams along the extra mile. - Roger Staubach", 67 | "It is never too late to be what you might have been. - George Eliot", 68 | "You become what you believe. - Oprah Winfrey", 69 | "I would rather die of passion than of boredom. - Vincent van Gogh", 70 | "A truly rich man is one whose children run into his arms when his hands are empty. - Unknown", 71 | "It is not what you do for your children, but what you have taught them to do for themselves, that will make them successful human beings. - Ann Landers", 72 | "If you want your children to turn out well, spend twice as much time with them, and half as much money. - Abigail Van Buren", 73 | "Build your own dreams, or someone else will hire you to build theirs. - Farrah Gray", 74 | "Education costs money. But then so does ignorance. - Sir Claus Moser", 75 | "I have learned over the years that when one's mind is made up, this diminishes fear. - Rosa Parks", 76 | "It does not matter how slowly you go as long as you do not stop. - Confucius", 77 | "If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. - Oprah Winfrey", 78 | "Remember that not getting what you want is sometimes a wonderful stroke of luck. - Dalai Lama", 79 | "You can't use up creativity. The more you use, the more you have. - Maya Angelou", 80 | "Dream big and dare to fail. - Norman Vaughan", 81 | "Our lives begin to end the day we become silent about things that matter. - Martin Luther King Jr.", 82 | "Do what you can, where you are, with what you have. - Teddy Roosevelt", 83 | "If you do what you've always done, you'll get what you've always gotten. - Tony Robbins", 84 | "Dreaming, after all, is a form of planning. - Gloria Steinem", 85 | "It's your place in the world; it's your life. Go on and do all you can with it, and make it the life you want to live. - Mae Jemison", 86 | "You may be disappointed if you fail, but you are doomed if you don't try. - Beverly Sills", 87 | "Remember no one can make you feel inferior without your consent. - Eleanor Roosevelt", 88 | "Life is what we make it, always has been, always will be. - Grandma Moses", 89 | "The question isn't who is going to let me; it's who is going to stop me. - Ayn Rand", 90 | "When everything seems to be going against you, remember that the airplane takes off against the wind, not with it. - Henry Ford", 91 | "It's not the years in your life that count. It's the life in your years. - Abraham Lincoln", 92 | "Change your thoughts and you change your world. - Norman Vincent Peale", 93 | "Either write something worth reading or do something worth writing. - Benjamin Franklin", 94 | "Nothing is impossible, the word itself says, “I'm possible!” - Audrey Hepburn", 95 | "The only way to do great work is to love what you do. - Steve Jobs", 96 | "If you can dream it, you can achieve it. - Zig Ziglar" 97 | ] 98 | 99 | import plugins 100 | import plugins.libcommand as LibCommand 101 | import plugins.liblogger as logger 102 | import random 103 | 104 | class pluginInfo(plugins.Base): 105 | 106 | def __init__(self): 107 | pass 108 | 109 | def cmd_quote(self, packet, interface, client, args): 110 | return random.choice(quotes) 111 | 112 | def cmd_coinflip(self, packet, interface, client, args): 113 | return random.choice(["Heads", "Tails"]) 114 | 115 | def cmd_8ball(self, packet, interface, client, args): 116 | responses = [ 117 | "It is certain.", 118 | "It is decidedly so.", 119 | "Without a doubt.", 120 | "Yes - definitely.", 121 | "You may rely on it.", 122 | "As I see it, yes.", 123 | "Most likely.", 124 | "Outlook good.", 125 | "Yes.", 126 | "Signs point to yes.", 127 | "Reply hazy, try again.", 128 | "Ask again later.", 129 | "Better not tell you now.", 130 | "Cannot predict now.", 131 | "Concentrate and ask again.", 132 | "Don't count on it.", 133 | "My reply is no.", 134 | "My sources say no.", 135 | "Outlook not so good.", 136 | "Very doubtful." 137 | ] 138 | return random.choice(responses) 139 | 140 | def start(self): 141 | LibCommand.simpleCommand().registerCommand("quote", "A random quote", self.cmd_quote) 142 | LibCommand.simpleCommand().registerCommand("coinflip", "Flip a coin", self.cmd_coinflip) 143 | LibCommand.simpleCommand().registerCommand("8ball", "Magic eight ball", self.cmd_8ball) -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------