├── hamtools ├── __init__.py ├── ctydat │ ├── history.txt │ └── readme.txt ├── qrz.py ├── ctydat.py ├── adif.py ├── geolog.py └── kml.py ├── setup.cfg ├── runtests.py ├── geologrc_example ├── tests ├── test_ctydat.py └── test_adif.py ├── geolog ├── setup.py ├── vk ├── README.md ├── LGPL3.txt └── AGPL3.txt /hamtools/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /runtests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Describe file""" 3 | import pytest 4 | 5 | if __name__ == '__main__': 6 | pytest.main() 7 | -------------------------------------------------------------------------------- /geologrc_example: -------------------------------------------------------------------------------- 1 | [geolog] 2 | ctydatpath=path/to/cty.dat 3 | 4 | [qrz] 5 | username=myusername 6 | password=mypassword 7 | cachepath=path/to/cachefile 8 | -------------------------------------------------------------------------------- /tests/test_ctydat.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Describe file""" 3 | from hamtools.ctydat import CtyDat 4 | from pkg_resources import resource_stream 5 | import pytest 6 | 7 | call = 'SW8/SW1KYQ//P' 8 | 9 | @pytest.fixture('session') 10 | def ctydat(): 11 | ctydatflo = resource_stream('hamtools', "ctydat/cty.dat") 12 | ctydat = CtyDat(ctydatflo) 13 | return ctydat 14 | 15 | 16 | def test_getwpx(ctydat): 17 | assert ctydat.getwpx(call) == 'SW8' 18 | 19 | -------------------------------------------------------------------------------- /geolog: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2009, 2012, 2014 by Jeffrey M. Laughlin 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as 7 | # published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | 18 | import sys 19 | 20 | from hamtools.geolog import main 21 | 22 | sys.exit(main()) 23 | 24 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | 5 | setup( 6 | name='hamtools', 7 | version='0.3', 8 | description='N1YWB Python Ham Radio Tools', 9 | author='Jeff Laughlin', 10 | author_email='jeff@jefflaughlinconsulting.com', 11 | url='https://github.com/n1ywb/python-hamtools', 12 | download_url='https://github.com/n1ywb/python-hamtools/archive/0.3.zip', 13 | packages = ['hamtools'], 14 | package_data={'hamtools': ['ctydat/cty.dat']}, 15 | scripts = ['geolog', 'vk'], 16 | install_requires = ['geojson', 'requests', 'requests-cache'], 17 | keywords = ['ham', 'amateur', 'qrz', 'adif', 'cabrillo', 'kml', 'geojson', 'ctydat'], 18 | long_description = ( 19 | """Collection of amateur radio tools. Includes ability to read ADIF and 20 | Cabrillo log files, cty.dat files, georeference callsigns via QRZ.com, 21 | callook, and ctydat, and output GIS data in GeoJSON and KML formats.""") 22 | ) 23 | -------------------------------------------------------------------------------- /vk: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Trivial voice keyer utility. 4 | 5 | Copyright 2014 by Jeffrey M. Laughlin 6 | 7 | This program is free software: you can redistribute it and/or modify 8 | it under the terms of the GNU Affero General Public License as 9 | published by the Free Software Foundation, either version 3 of the 10 | License, or (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU Affero General Public License for more details. 16 | 17 | You should have received a copy of the GNU Affero General Public License 18 | along with this program. If not, see . 19 | """ 20 | 21 | 22 | import serial 23 | import os 24 | import sys 25 | 26 | sp = serial.Serial("/dev/ttyUSB0", rtscts=1) 27 | 28 | sp.setRTS(1) 29 | 30 | # play sound 31 | os.system("aplay " + sys.argv[1]) 32 | 33 | sp.setRTS(0) 34 | 35 | sp.close 36 | 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # N1YWB Python Ham Radio Tools # 2 | 3 | Copyright 2014 by Jeffrey M. Laughlin 4 | Copyright 2006 by Herrmann Hofer 5 | 6 | This package includes several Python modules and scripts of interest to the 7 | radio amateur. 8 | 9 | This stuff is very alpha. Really just a bunch of quick hacks I slapped 10 | together. But I will take bug reports and try to improve things over time. 11 | 12 | Includes: 13 | 14 | * QRZ.com lookup 15 | * ADIF file parsing 16 | * Cabrillo file parsing 17 | * cty.dat parsing and querying 18 | * Logged callsign georeferencing 19 | * Geojson output 20 | * KML output 21 | 22 | ## geolog ## 23 | 24 | The geolog script reads a log file in ADIF or Cabrillo format, georeferences 25 | the callsigns therein, and outputs a set of GeoJSON and KML files suitable for 26 | importing in Google Earth, Quantum GIS (QGIS), ArcGIS, etc. 27 | 28 | I've only tested it with ARRL 10m contest logs. It will probably barf on other 29 | cabrillo files with different formats. If so, please file a bug report. 30 | 31 | To georeference calls the program first looks it up on QRZ. If QRZ has no 32 | lat/lon information for the call, the program uses cty.dat. This will place the 33 | point in the center of the call area based on the prefix, so it's not very 34 | accurate, but better than nothing. 35 | 36 | Should probably factor out the cabrillo parser into a separate module. 37 | 38 | To avoid typing your QRZ username and password each time, you may save these to 39 | a config file at `$HOME/.geologrc`. You may also specify the config file 40 | location explicity with the `-c` command line option. See the included 41 | `geologrc_example` file. You may also use the config file to override the 42 | default QRZ cache file location. 43 | 44 | hamtools comes with a recent copy of the big cty.dat. If you wish to install a newer version, download from http://www.country-files.com/contest/ and in .geologrc specify 45 | 46 | [geolog] 47 | ctydatpath=path/to/cty.dat 48 | 49 | ## hamtools.adif ## 50 | 51 | The adif module implements a subset of the ADIF standard for reading and 52 | writing. 53 | 54 | ## hamtools.qrz ## 55 | 56 | Simple interface to the QRZ.com XML data service. 57 | 58 | To improve speed, this module caches QRZ.com XML responses in 59 | `$HOME/.qrz_cache`. You may wish to periodically delete this file to avoid 60 | stale data. 61 | 62 | ## hamtools.ctydat ## 63 | 64 | Straight port of the YFKLog cty.dat parsing/lookup code. I haven't tested this 65 | extensively, it's probably buggy. 66 | 67 | ## hamtools.kml ## 68 | 69 | Simple KML generation based on minidom. 70 | 71 | ## vk ## 72 | 73 | A very trivial voice keyer script which plays an audio file while 74 | simultaniously keying a radio via the serial port. Requires pyserial. 75 | 76 | # License # 77 | 78 | kml.py is released under the LGPL v3 79 | All other files are released under the AGPL v3 80 | 81 | -------------------------------------------------------------------------------- /hamtools/ctydat/history.txt: -------------------------------------------------------------------------------- 1 | Big CTY - 29 December 2013 2 | 3 | Version entity is Sweden, SM 4 | 5 | Added/changed Callsigns/prefixes: 6 | 7 | * A91ACC/GR is Bahrain, A9 8 | * CE9/UA4WHX is Chile, CE in ITU zone 16 9 | * IA/IZ3SUS is Antarctica, CE9 in CQ zone 29, ITU zone 70 10 | * EA7URA/YOTA is Spain, EA 11 | * EA5RKB/6 is Balearic Islands, EA6 12 | * TO6D is Guadeloupe, FG 13 | * TX6G is Austral Islands, FO/a 14 | * 2Z, G0FBJ, GB0BL, GB2CAS, GB2ELH, GB2ELH/LH, GB2IGS, GB2LHI, GB2QM, 15 | GB2SB, GB2SLH, GB2SR, GB2WG, GB2ZET, GB3LER, GB3LER/B, GB4LER, GB4SI, GM0DHZ/P, 16 | GM0GFL/P, GM0SGB/P, GM3TXF/P, GM3USR/P, GM3VLB/P, GM4AFF/P, GM4CHX/P, GS4WAB/P, 17 | GZ, MM/F5BLC/P, MM/OK1FZM/P, MM/W5ZE/P, MM0LON/M, MM5PSL/P, MM5YLO/P, MO5PSL, 18 | MQ5PSL, MR5PSL and MZ are all Scotland, GM 19 | * II1RT/N, IZ0DBA/N and IZ1POA/N are all Italy, I 20 | * AB2QH is Mariana Islands, KH0 21 | * KC6HOX, KC7ASJ, KD0MSD, KD0QLR, KD0WVZ, KE6AXN, KF7TUU, KG6TFI, KJ6QQT, 22 | KJ6SKC, KL1TP, N0CAN, N7TSV, N7WBX and W7NX are all Hawaii, KH6 23 | * AF5S, KB7VFZ, KB7ZVZ, KB8SBG, KE6SYD, KF7LUA, KH2YN, KJ4ZWI, N8ZPO, 24 | NA7WM, W6TN and WH6CYY are all Alaska, KL 25 | * WI7C is US Virgin Islands, KP2 26 | * AF4OU, KB3BPK, KE0SH, KE1MA and KX5DX are all Puerto Rico, KP4 27 | * LU5XP/D and LU6FEC/T are both Argentina, LU 28 | * OH1FJ/SA, OH1KW/S, OH1LEO/S, OH1SJ/SA, OH2BNX/SA, OH2EO/S, OH2ET/S, 29 | OH2MEE/SA, OH2MO/SA, OH2NAS/SA, OH2PO/SA, OH2S/S, OH2XL/S, OH2ZL/SA, OH3FJQ/S, 30 | OH3HB/SA, OH3IH/SA, OH3LS/S, OH4FSL/SA, OH5A/S, OH5EAB/S, OH5EAB/SA, OH6QR/SA, 31 | OH7ND/S, OH9AR/S, OH9TM/S, OH9TO/S, OI4JM/SA and OI6SP/SA are all Finland, OH 32 | * R95DOD, R95NRL, RA22, RW2F/6, UA0QGM/3, UA9KHD/3 and UE22A are all European Russia, UA 33 | * RA22KO, RA22XA, RA22XF, RN22OG and RN22OV are all European Russia, UA in CQ zone 17, ITU zone 19 34 | * RV22PM is European Russia, UA in CQ zone 17, ITU zone 30 35 | * RD22FU and RJ22DX are both Kaliningrad, UA2 36 | * R22BIA, R22SKE, R22SKJ, RA22MX, RA22QF, RT22MC, RT22MD, RU22AZ, RU22CR, 37 | RU22LR, RW22MW, RW22QA, RW22QC, RY22MC and RY22RZ are all Asiatic Russia, UA9 38 | * RT22TK, RT22WF, RU22WZ, RV22WB and RX22WN are all Asiatic Russia, UA9 in CQ zone 16 39 | * R9/UN7JMO, RT22UA and RZ22WW are all Asiatic Russia, UA9 in CQ zone 18, ITU zone 31 40 | * RN110RAEM/P and RT22SA are both Asiatic Russia, UA9 in CQ zone 18, ITU zone 32 41 | * RW22WR and UA9KW/0 are both Asiatic Russia, UA9 in CQ zone 19, ITU zone 23 42 | * RT22CT is Asiatic Russia, UA9 in CQ zone 19, ITU zone 33 43 | * RW22GO is Asiatic Russia, UA9 in CQ zone 19, ITU zone 34 44 | * RT22ZS is Asiatic Russia, UA9 in CQ zone 19, ITU zone 35 45 | * UU4JO/LH is Ukraine, UR 46 | * RI20ANT and RI44ANT are both South Shetland Islands, VP8/h 47 | 48 | Retired Callsigns/prefixes: 49 | 50 | * RI1ANT in Antarctica, CE9 51 | * 2T in Isle of Man, GD 52 | * 2N in Northern Ireland, GI 53 | * 2H in Jersey, GJ 54 | * 2P in Guernsey, GU 55 | * 2Y in Wales, GW 56 | * KC7RXR and KP4X in Alaska, KL 57 | * KD0ETC/LH in Canada, VE 58 | -------------------------------------------------------------------------------- /tests/test_adif.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2009, 2012 by Jeffrey M. Laughlin 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as 7 | # published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | import cStringIO as StringIO 20 | import hamtools.adif 21 | from decimal import Decimal 22 | from datetime import datetime 23 | 24 | TEST_ADIF = """ 25 | Exported using NA Version 10.57, conforming to ADIF specification 1.0 26 | 1.00 27 | 28 | AB9RN14.150SSB201207141200 29 | 59 59 08 30 | K4NNQ14.150SSB201207141206 31 | 59 59 08 32 | KC0YSH14.150SSB201207141206 33 | 59 59 07 34 | """ 35 | 36 | 37 | import pytest 38 | 39 | 40 | def eq_(a, b): 41 | __tracebackhide__ = True 42 | assert a == b 43 | 44 | 45 | def test_parse(): 46 | flo = StringIO.StringIO(TEST_ADIF) 47 | reader = hamtools.adif.Reader(flo) 48 | i = reader._lex() 49 | eq_(i.next(), hamtools.adif.Field(name='call', type='', body='AB9RN')) 50 | eq_(i.next(), hamtools.adif.Field(name='freq', type='', body='14.150')) 51 | eq_(i.next(), hamtools.adif.Field(name='mode', type='', body='SSB')) 52 | eq_(i.next(), hamtools.adif.Field(name='qso_date', type='', body='20120714')) 53 | eq_(i.next(), hamtools.adif.Field(name='time_on', type='', body='1200')) 54 | eq_(i.next(), hamtools.adif.Field(name='rst_sent', type='', body='59 ')) 55 | eq_(i.next(), hamtools.adif.Field(name='rst_rcvd', type='', body='59 ')) 56 | eq_(i.next(), hamtools.adif.Field(name='comment', type='', body='08')) 57 | eq_(i.next(), hamtools.adif.Field(name='eor', type='', body='')) 58 | eq_(i.next(), hamtools.adif.Field(name='call', type='', body='K4NNQ')) 59 | 60 | 61 | def test_iter_records(): 62 | flo = StringIO.StringIO(TEST_ADIF) 63 | reader = hamtools.adif.Reader(flo) 64 | i = iter(reader) 65 | eq_(i.next(), {'call': 'AB9RN', 'freq': '14.150', 'mode': 'SSB', 'qso_date': '20120714', 66 | 'time_on': '1200', 'rst_sent': '59 ', 'rst_rcvd': '59 ', 67 | 'comment': '08', 68 | 'app_datetime_on': datetime(2012, 07, 14, 12, 0)}) 69 | 70 | 71 | def test_version(): 72 | flo = StringIO.StringIO(TEST_ADIF) 73 | reader = hamtools.adif.Reader(flo) 74 | eq_(reader.adif_ver, '1.00') 75 | 76 | -------------------------------------------------------------------------------- /hamtools/ctydat/readme.txt: -------------------------------------------------------------------------------- 1 | Big CTY.DAT 2 | 3 | ------------------------------------------------------------------------ 4 | 5 | The last release was on 2 August 2013. 6 | 7 | This version of CTY.DAT has callsign data starting with 1 January 2000. 8 | This is useful for people who are using contest logging software to log 9 | their everyday QSOs, and want somewhat accurate country tracking. Here 10 | are the features of this file: 11 | 12 | 1. Exception callsigns go back to the starting date shown above. If a 13 | callsign was used multiple times, then only the most recent entity 14 | is used. For example, TO5M was used from Martinique (FM) in 1993, 15 | St. Pierre & Miquelon (FP) in 1995, and Reunion (FR) in 2004. Thus, 16 | if you log TO5M using this file, you will get Reunion (FR) 17 | 18 | 2. Prefixes do not go back, they are current as of the day the file was 19 | released. For example, Montenegro (4O) was added to the DXCC list 20 | effective 28 June 2006. If you try to log a QSO with 4O1T in 21 | Yugoslavia from 2003, it will come up as Montenegro, because that's 22 | the current entity associated with the 4O prefix. Here is a list of 23 | known problems . 24 | 25 | 3. This is a complete file, meaning all prefixes that require CQ and/or 26 | ITU zone overrides are listed. This is primarily for BY, K, UA9, VE 27 | and VK - these entities all span multiple CQ zones. Remember that 28 | the normal CTY.DAT has only a subset of these prefixes; many have 29 | been implemented in software and therefore don't need to be listed. 30 | 31 | 4. Some software like CT by K1EA doesn't save the country information 32 | in the log with the QSOs. Instead, the country for each QSO is 33 | determined when the program is started, based on whatever country 34 | file is in use. Thus, it may not be possible to "fix" a QSO that is 35 | associated with the wrong country. You could use the override 36 | method, like "FO8XYZ=FO0" to assign it to Clipperton Island. 37 | However, if/when you over-write your country file with a new one, 38 | those customizations will be lost. One known case of this problem is 39 | a certain well-known IARU HQ station that uses the same callsign 40 | from different DXCC countries, on different bands, at the same time. 41 | It's very hard to get these cases right. 42 | 43 | 5. This file comes in only one format: using '=' to distinguish full 44 | callsigns from prefixes. 45 | 46 | ------------------------------------------------------------------------ 47 | 48 | 49 | Installation instructions 50 | 51 | The instructions for installing the CTY.DAT file are specific to each 52 | logging program. However, the instructions for installing this file are 53 | the same as the normal contest country files, so start HERE 54 | <../cty/index.htm>. Follow the written instructions on that page, but 55 | don't download the file from those links. 56 | 57 | Here are some logging experiments to try to see if the larger file is 58 | installed in the right place, and is working: 59 | 60 | 1. *VERSION* - should match the VERSION entity in the revision history 61 | 2. *OR4TN* - should be Antarctica (not Belgium) 62 | 3. *MR6TMS* - should be Scotland (not England) 63 | 4. *LW7DQQ/Y* - should be Argentina in ITU Zone 16 64 | 5. *UI9XA* - should be European Russia (not Asiatic) 65 | 6. *ZS85SARL* - should be South Africa (not Marion Island) 66 | 67 | ------------------------------------------------------------------------ 68 | 69 | 70 | Compatibility 71 | 72 | Because of its size, this file may cause problems with your logging 73 | software. Here are some programs that are known to work: 74 | 75 | CT 76 | CT 9.92 (DOS) and CT 10.04 (Windows) both work. Once can therefore 77 | assume that CT 9.92 (Windows) and CT 10.x (DOS) also work. It's 78 | unknown how old a CT9 version can be and still work. 79 | fldigi 80 | version 3.2.38 (Linux) 81 | LM 82 | DL8WAA reports no problems. 83 | MixW 84 | version 3.1.1h and later 85 | Xlog 86 | version 2.0.5 (Linux) 87 | 88 | ------------------------------------------------------------------------ 89 | 90 | 91 | Areas for Improvement 92 | 93 | Here are some changes that may be coming - stay tuned for details! 94 | 95 | 1. The file contains all possible prefix mappings to determine the 96 | correct CQ and ITU zones. If people are only tracking countries, 97 | this may not be necessary, and would substantially reduce the number 98 | of prefixes in the file. 99 | -------------------------------------------------------------------------------- /hamtools/qrz.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2009, 2012, 2014 by Jeffrey M. Laughlin 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as 7 | # published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | import httplib, urllib 20 | from xml.dom import minidom 21 | import sys 22 | import os 23 | import sqlite3 24 | import logging 25 | 26 | log = logging.getLogger(__name__) 27 | 28 | CACHEPATH = os.path.join(os.environ.get('XDG_CACHE_HOME', os.environ['HOME']), '.qrz_cache') 29 | 30 | testSessionXML = """\ 31 | 32 | 33 | 34 | 2331uf894c4bd29f3923f3bacf02c532d7bd9 35 | Sun Aug 16 03:51:47 2006 36 | 37 | 38 | """ 39 | 40 | class QrzError(Exception): 41 | pass 42 | 43 | class NotFound(QrzError): 44 | pass 45 | 46 | class CallMismatch(QrzError): 47 | pass 48 | 49 | class QrzRequestError(QrzError): 50 | pass 51 | 52 | class Callsign(object): 53 | conversions = dict( 54 | lat=float, 55 | lon=float, 56 | ) 57 | 58 | def __init__(self, node): 59 | self.node = node 60 | 61 | def __getitem__(self, key): 62 | try: 63 | value = self.node.getElementsByTagName(key)[0].firstChild.data 64 | except IndexError, e: 65 | return None 66 | if key in self.conversions.keys(): 67 | value = self.conversions[key](value) 68 | return value 69 | 70 | class Session(object): 71 | def __init__(self, user=None, passwd=None, cachepath=CACHEPATH, key=None): 72 | # post http://xml.qrz.com/xml?username=user;password=passwdo 73 | # self.key = minidom parse key 74 | # check for alert or error 75 | if not key: 76 | xml = self.request(dict(username=user, password=passwd)) 77 | log.debug(xml) 78 | dom = minidom.parseString(xml) 79 | session = dom.getElementsByTagName("Session")[0] 80 | self.checkErr(session) 81 | key = session.getElementsByTagName("Key")[0].firstChild.data 82 | self.key = key 83 | self.db = sqlite3.connect(cachepath) 84 | self.db.text_factory = str 85 | try: 86 | self.db.execute(""" 87 | create table dict ( 88 | key, 89 | val 90 | ) 91 | """) 92 | self.db.commit(); 93 | except sqlite3.OperationalError: 94 | log.warning("maybe cache table exists?") 95 | 96 | def request(self, params): 97 | hc = httplib.HTTPConnection("xml.qrz.com") 98 | headers = {"Content-type": "application/x-www-form-urlencoded", 99 | "Accept": "text/plain"} 100 | hc.request("POST", "/xml", urllib.urlencode(params), headers) 101 | resp = hc.getresponse() 102 | if resp.status != httplib.OK: 103 | raise QrzRequestError("Status %d" % resp.status) 104 | return resp.read() 105 | 106 | 107 | def qrz(self, callsign): 108 | # http://xml.qrz.com/xml?s=2331uf894c4bd29f3923f3bacf02c532d7bd9;callsign=aa7bq 109 | log.debug("qrz %s" % callsign) 110 | miss = True 111 | c = self.db.cursor() 112 | xml = c.execute('select val from dict where key == ?', 113 | (callsign,)).fetchone() 114 | if not xml: 115 | log.debug("miss %s" % callsign) 116 | xml = self.request(dict(s=self.key,callsign=callsign)) 117 | else: 118 | log.debug("hit %s" % callsign) 119 | miss = False 120 | xml = xml[0] 121 | try: 122 | dom = minidom.parseString(xml) 123 | session = Callsign(dom.getElementsByTagName("Session")[0]) 124 | e = session['Error'] 125 | if e: 126 | if not e.startswith("Not found"): 127 | raise QrzError(e) 128 | if miss: 129 | self.db.execute("insert into dict values (?, ?)", (callsign, xml)) 130 | self.db.commit(); 131 | if e: 132 | raise NotFound(callsign) 133 | callnode = dom.getElementsByTagName("Callsign")[0] 134 | data = Callsign(callnode) 135 | if data['call'].lower() != callsign.lower(): 136 | raise CallMismatch("Calls do not match", data['call'], callsign) 137 | return data 138 | except QrzError, e: 139 | log.warning("QRZ.com lookup failed: %s", repr(e)) 140 | raise 141 | except Exception: 142 | log.debug(xml) 143 | raise 144 | 145 | def __enter__(self, *args, **kwargs): 146 | return self 147 | 148 | def __exit__(self, *args, **kwargs): 149 | self.db.close() 150 | 151 | 152 | -------------------------------------------------------------------------------- /hamtools/ctydat.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | cty.dat file reader and lookup 4 | 5 | Copyright 2014 by Jeffrey M. Laughlin 6 | Copyright (C) 2005-2009 Fabian Kurz, DJ1YFK 7 | 8 | This program is free software: you can redistribute it and/or modify 9 | it under the terms of the GNU Affero General Public License as 10 | published by the Free Software Foundation, either version 3 of the 11 | License, or (at your option) any later version. 12 | 13 | This program is distributed in the hope that it will be useful, 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | GNU Affero General Public License for more details. 17 | 18 | You should have received a copy of the GNU Affero General Public License 19 | along with this program. If not, see . 20 | 21 | Ported from yfklog 22 | 23 | Alpha quality, largely untested; please help! 24 | """ 25 | 26 | from collections import defaultdict 27 | import re 28 | 29 | import pdb 30 | 31 | 32 | class InvalidDxcc(Exception): pass 33 | class InvalidCallsign(Exception): pass 34 | 35 | 36 | class CtyDat(object): 37 | fields = ['name', 'cq', 'itu', 'cont', 'lat', 'lon', 'utcoff', 'prefix'] 38 | 39 | def __init__(self, infile): 40 | self.prefixes = defaultdict(list) 41 | self.dxcc = {} 42 | for line in infile: 43 | if line[0] != ' ': 44 | # DXCC line 45 | line=line.strip() 46 | fields = [f.strip() for f in line.split(':')] 47 | dxcc = dict(zip(self.fields, fields)) 48 | mainprefix = dxcc['prefix'] 49 | self.dxcc[mainprefix] = dxcc 50 | else: 51 | line=line.strip() 52 | line = line.rstrip(';') 53 | line = line.rstrip(',') 54 | prefixes = line.split(',') 55 | self.prefixes[mainprefix].extend(prefixes) 56 | 57 | def getwpx(self, call): 58 | prefix = None 59 | a, b, c = None, None, None 60 | fields = re.split('/+', call) 61 | try: 62 | a, b, c = fields 63 | except Exception: 64 | try: a, b = fields 65 | except Exception: 66 | a = fields 67 | 68 | if c is None and None not in (a,b): 69 | if b in ('QRP', 'LGT'): 70 | b = a 71 | a = None 72 | 73 | if b.isdigit(): 74 | raise InvalidCallsign(call) 75 | 76 | if a is None and c is None: 77 | if re.search('\d', b) is not None: 78 | prefix = re.search('(.+\d)[A-Z]*', b).group(0) 79 | else: 80 | prefix = b[0:2] + '0' 81 | elif a is None and c is not None: 82 | if len(c) == 1 and c.isdigit(): 83 | _1 = re.search('(.+\d)[A-Z]*', b).group(0) 84 | mo = re.search('^([A-Z]\d)\d$', _1) 85 | if mo is not None: 86 | prefix = _1 + c 87 | else: 88 | mo = re.search('(.*[A-Z])\d+', _1) 89 | prefix = mo.group(0) + c 90 | elif re.search('(^P$)|(^M{1,2}$)|(^AM$)|(^A$)', c) is not None: 91 | mo = re.search('(.+\d)[A-Z]*', b) 92 | prefix = mo.group(0) 93 | elif re.search('^\d\d+$/', c) is not None: 94 | mo = re.search('(.+\d)[A-Z]*', b) 95 | prefix = mo.group(0) 96 | else: 97 | if c[-1].isdigit(): 98 | prefix = c 99 | else: 100 | prefix = c + '0' 101 | elif a is not None: 102 | if a[-1].isdigit(): 103 | prefix = a 104 | else: 105 | prefix = a + '0' 106 | return prefix 107 | 108 | def getdxcc(self, call): 109 | matchchars = 0 110 | goodzone = None 111 | matchprefix = None 112 | if re.search('(^OH/)|(/OH[1-9]?$)', call) is not None: 113 | call = 'OH' 114 | elif re.search('(^3D2R)|(^3D2.+\/R)', call) is not None: 115 | call = '3D2RR' 116 | elif re.search('^3D2C', call) is not None: 117 | call = '3D2CR' 118 | elif '/' in call: 119 | prefix = self.getwpx(call) 120 | if prefix is None: 121 | prefix = 'QQ' 122 | call = prefix + 'AA' 123 | 124 | letter = call[0] 125 | for mainprefix, tests in self.prefixes.iteritems(): 126 | for test in tests: 127 | testlen = len(test) 128 | if letter != test[0]: 129 | continue 130 | zones = '' 131 | if testlen > 5 and '(' in test or '[' in test: 132 | mo = re.search('^([A-Z0-9\/]+)([\[\(].+)', test) 133 | if mo.group(1) is not None: 134 | zones += mo.group(1) 135 | testlen = len(mo.group(0)) 136 | 137 | if call[:testlen] == test[:testlen] and matchchars <= testlen: 138 | matchchars = testlen 139 | matchprefix = mainprefix 140 | goodzone = zones 141 | 142 | try: 143 | mydxcc = self.dxcc[matchprefix] 144 | except KeyError: 145 | raise InvalidDxcc(matchprefix) 146 | 147 | if goodzone is not None: 148 | mo = re.search('\((\d+)\)', goodzone) 149 | if mo is not None: 150 | mydxcc['cq'] = mo.group(0) 151 | mo = re.search('\[(\d+)\]', goodzone) 152 | if mo is not None: 153 | mydxcc['itu'] = mo.group(0) 154 | 155 | if mydxcc['prefix'].startswith('*'): 156 | if (mydxcc['prefix'] == '*TA1'): mydxcc['prefix'] = "TA" # Turkey 157 | if (mydxcc['prefix'] == '*4U1V'): mydxcc['prefix'] = "OE" # 4U1VIC is in OE.. 158 | if (mydxcc['prefix'] == '*GM/s'): mydxcc['prefix'] = "GM" # Shetlands 159 | if (mydxcc['prefix'] == '*IG9'): mydxcc['prefix'] = "I" # African Italy 160 | if (mydxcc['prefix'] == '*IT9'): mydxcc['prefix'] = "I" # Sicily 161 | if (mydxcc['prefix'] == '*JW/b'): mydxcc['prefix'] = "JW" # Bear Island 162 | 163 | return mydxcc 164 | 165 | -------------------------------------------------------------------------------- /hamtools/adif.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2009, 2012, 2013 by Jeffrey M. Laughlin 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as 7 | # published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | """ 20 | Python API for reading the Amateur Data Interchange Format, aka ADIF. 21 | 22 | ADIF version 1.0 is supported. 23 | """ 24 | 25 | from collections import namedtuple, OrderedDict 26 | from decimal import Decimal 27 | from datetime import datetime 28 | 29 | 30 | BLOCKSIZE = 1024 31 | 32 | 33 | class ParseError(Exception): 34 | pass 35 | 36 | 37 | class Field(object): 38 | __slots__ = ['name', 'type', 'body'] 39 | def __init__(self, name='', type='', body=''): 40 | self.name = name 41 | self.type = type 42 | self.body = body 43 | 44 | def __repr__(self): 45 | return ' '.join(('')) 46 | 47 | def __eq__(self, s2): 48 | if self.name == s2.name and self.type == s2.type and s2.body == self.body: 49 | return True 50 | return False 51 | 52 | def __ne__(self, s2): 53 | if self.name == s2.name or self.type == s2.type or s2.body == self.body: 54 | return False 55 | return True 56 | 57 | 58 | class Reader(object): 59 | def __init__(self, flo): 60 | self.adif_ver = None 61 | self.flo = flo 62 | # read header 63 | flo.seek(0) 64 | c = flo.read(1) 65 | if c == '<': 66 | self.header_present = False 67 | flo.seek(0) 68 | else: 69 | self.header_present = True 70 | for field in self._lex(blocksize=1): 71 | if field.name == 'adif_ver': 72 | self.adif_ver = field.body 73 | elif field.name == 'eoh': 74 | break 75 | self.bookmark = flo.tell() 76 | 77 | def _lex(self, blocksize=BLOCKSIZE): 78 | """Given a file like object, yield named tuple for each record.""" 79 | flo = self.flo 80 | state = 'comment' 81 | pos = 0 82 | field = Field() 83 | while True: 84 | buf = flo.read(blocksize) 85 | #print buf 86 | for c in buf: 87 | #print "c = '%s'" % c 88 | if state == 'comment': 89 | if c == '<': 90 | state = 'name' 91 | field = Field() 92 | elif state == 'name': 93 | if c == ':': 94 | state = 'len' 95 | field_len = '' 96 | elif c == '>': 97 | state = 'comment' 98 | field.name = field.name.lower() 99 | field.type = field.type.lower() 100 | #print field 101 | yield field 102 | else: 103 | field.name = field.name + c 104 | elif state == 'len': 105 | if c == ':': 106 | state = 'type' 107 | field_len = int(field_len) 108 | elif c == '>': 109 | state = 'body' 110 | field_len = int(field_len) 111 | else: 112 | field_len = field_len + c 113 | elif state == 'type': 114 | if c == ':': 115 | raise ParseError() 116 | elif c == '>': 117 | state = 'body' 118 | else: 119 | field.type = field.type + c 120 | elif state == 'body': 121 | if field_len > 0: 122 | field.body = field.body + c 123 | field_len -= 1 124 | if field_len == 0: 125 | state = 'comment' 126 | field.name = field.name.lower() 127 | field.type = field.type.lower() 128 | #print field 129 | yield field 130 | else: 131 | raise Exception("Invalid state at %d" % pos) 132 | pos += 1 133 | #print field 134 | #print pos 135 | if len(buf) < blocksize: 136 | #print 'EOF' 137 | break 138 | 139 | def __iter__(self): 140 | """Iterate over records in file""" 141 | self.flo.seek(self.bookmark) 142 | rec = OrderedDict() 143 | for field in self._lex(): 144 | #print field 145 | if field.name == 'eor': 146 | #print 'yield rec' 147 | if 'qso_date' in rec and 'time_on' in rec: 148 | rec['app_datetime_on'] = datetime(int(rec['qso_date'][:4]), 149 | int(rec['qso_date'][4:6]), 150 | int(rec['qso_date'][6:8]), 151 | int(rec['time_on'][:2]), 152 | int(rec['time_on'][2:4])) 153 | if 'qso_date' in rec and 'time_off' in rec: 154 | rec['app_datetime_off'] = datetime(int(rec['qso_date'][:4]), 155 | int(rec['qso_date'][4:6]), 156 | int(rec['qso_date'][6:8]), 157 | int(rec['time_off'][:2]), 158 | int(rec['time_off'][2:4])) 159 | yield rec 160 | rec = OrderedDict() 161 | else: 162 | # TODO: type conversion and validation 163 | rec[field.name] = field.body 164 | #print rec 165 | 166 | def format_header(header_text=' ', adif_ver=None): 167 | assert header_text != '' 168 | if adif_ver is None: 169 | return "%s" % header_text 170 | return "%s%s" % ( 171 | header_text, len(adif_ver), adif_ver) 172 | 173 | def format_record(record): 174 | fields = [] 175 | for k,v in record.iteritems(): 176 | if k == 'app_datetime_on': 177 | continue 178 | fields.append("<%s:%d>%s" % (k, len(v), v)) 179 | fields.append('') 180 | return ''.join(fields) 181 | 182 | -------------------------------------------------------------------------------- /LGPL3.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /hamtools/geolog.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2009, 2012, 2014 by Jeffrey M. Laughlin 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as 7 | # published by the Free Software Foundation, either version 3 of the 8 | # License, or (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | import argparse 20 | import ConfigParser 21 | import logging 22 | import os 23 | import sys 24 | import traceback 25 | from pkg_resources import resource_stream 26 | import geojson as gj 27 | from hamtools import adif 28 | from hamtools.ctydat import CtyDat, InvalidDxcc, InvalidCallsign 29 | from hamtools import kml 30 | from hamtools import qrz 31 | import requests 32 | import requests_cache 33 | 34 | 35 | log = logging.getLogger(__name__) 36 | 37 | # log.setLevel(logging.INFO) 38 | 39 | # 1. Load log 40 | # 2. Georeference log 41 | # 3. Cache georeferenced calls 42 | # 4. Output GeoJSON 43 | 44 | CABRILLO_FIELDS = ['header', 'freq', 'mode', 'date', 'time', 45 | 'from_call', 'sent_rst', 'sent_ex', 'call', 'receved_rst', 46 | 'received_ex'] 47 | 48 | CACHEPATH = os.path.join(os.environ['HOME'], '.qrz_cache') 49 | 50 | 51 | class OperatorGeoRefFail(Exception): pass 52 | 53 | 54 | class GeoRefFail(Exception): pass 55 | 56 | 57 | class GeoRefError(Exception): pass 58 | 59 | 60 | class NullLoc(GeoRefError): pass 61 | 62 | 63 | class NotFound(GeoRefError): pass 64 | 65 | 66 | class QrzReferencer(object): 67 | def __init__(self, session): 68 | self.session = session 69 | 70 | ## TODO memoize and cache 71 | def reference(self, callsign): 72 | """Returns lon, lat from QRZ""" 73 | try: 74 | rec = self.session.qrz(callsign) 75 | if None in (rec['lat'], rec['lon']): 76 | raise NullLoc(callsign) 77 | lat, lon = rec['lat'], rec['lon'] 78 | log.debug("qrz rec %s" % rec) 79 | except qrz.NotFound, e: 80 | raise NotFound(callsign) 81 | except qrz.QrzError, e: 82 | raise GeoRefError(*e.args) 83 | return lon, lat 84 | 85 | 86 | class CtyDatReferencer(object): 87 | def __init__(self, ctydat): 88 | self.ctydat = ctydat 89 | 90 | def reference(self, callsign): 91 | """Returns lon, lat from ctydat""" 92 | try: 93 | dxcc = self.ctydat.getdxcc(callsign) 94 | except (InvalidDxcc, InvalidCallsign): 95 | raise GeoRefError(callsign) 96 | lat = float(dxcc['lat']) 97 | lon = float(dxcc['lon']) * -1 98 | return lon, lat 99 | 100 | 101 | class FCCReferencer(object): 102 | PREFIXES = list('aknw') 103 | CACHEPATH = os.path.join(os.environ.get('XDG_CACHE_HOME', os.environ['HOME']), '.callook_cache') 104 | requests_cache.install_cache(CACHEPATH) 105 | def reference(self, callsign): 106 | if callsign[0].lower() not in self.PREFIXES: 107 | raise NotFound(callsign) 108 | r = requests.get("https://callook.info/%s/json" % callsign) 109 | if r.status_code == 404: 110 | raise NotFound(callsign) 111 | if r.status_code != 200: 112 | raise GeoRefError(r.status_code) 113 | try: 114 | data = r.json() 115 | except ValueError: 116 | raise GeoRefError('bad json') 117 | if data['status'] != 'VALID': 118 | raise GeoRefError('invalid') 119 | raw_lon = data['location']['longitude'] 120 | raw_lat = data['location']['latitude'] 121 | if not raw_lon or not raw_lat: 122 | raise GeoRefError("No location data") 123 | try: 124 | lon = float(data['location']['longitude']) 125 | lat = float(data['location']['latitude']) 126 | return lon, lat 127 | except Exception, e: 128 | log.debug(data) 129 | raise 130 | 131 | 132 | class Log(object): 133 | def __init__(self): 134 | self.qsos = [] 135 | self.callsign = None 136 | 137 | @staticmethod 138 | def from_cabrillo(logfile): 139 | self = Log() 140 | for line in logfile: 141 | if line.startswith("QSO"): 142 | qso = dict(zip(CABRILLO_FIELDS, line.split())) 143 | # Pygeojson just repr's numbers, which doesn't add .0 to 144 | # floats, which makes them JSON ints, which QGIS won't allow to 145 | # use for a graduated scale. 146 | qso['time'] = float(qso['time'] + '.000000001') 147 | try: 148 | freq = float(qso['freq']) + 0.00000001 149 | except ValueError: 150 | pass 151 | else: 152 | qso['freq'] = freq 153 | self.qsos.append(qso) 154 | log.debug(qso) 155 | elif line.startswith("CALLSIGN:"): 156 | self.callsign = line.split()[1] 157 | log.info("Callsign: %s" % self.callsign) 158 | log.info("Read %d records" % len(self.qsos)) 159 | return self 160 | 161 | @staticmethod 162 | def from_adif(logfile): 163 | # TODO check for invalid ADIF file 164 | self = Log() 165 | log = adif.Reader(logfile) 166 | for qso in log: 167 | try: 168 | del qso['app_datetime_on'] 169 | except KeyError: 170 | pass 171 | try: 172 | del qso['app_datetime_off'] 173 | except KeyError: 174 | pass 175 | self.qsos.append(qso) 176 | if self.qsos: 177 | qso = self.qsos[0] 178 | self.callsign = qso.get('station_callsign', None) 179 | if not self.callsign: 180 | self.callsign = qso.get('operator', None) 181 | return self 182 | 183 | def _georef(self, callsign): 184 | for d in self.drivers: 185 | try: 186 | return d.reference(callsign) 187 | except GeoRefError, e: 188 | log.warning("%r failed on call %s: %s", d, callsign, e) 189 | else: 190 | raise GeoRefFail(callsign) 191 | 192 | def georeference(self, sess, ctydat): 193 | drivers = self.drivers = [] 194 | sess and drivers.append(QrzReferencer(sess)) 195 | drivers.append(FCCReferencer()) 196 | ctydat and drivers.append(CtyDatReferencer(ctydat)) 197 | 198 | if not drivers: 199 | raise Exception("No georef drivers") 200 | 201 | if not self.callsign: 202 | raise OperatorGeoRefFail("Unable to determine op callsign from log") 203 | 204 | try: 205 | self.lon, self.lat = self._georef(self.callsign) 206 | except GeoRefFail: 207 | raise OperatorGeoRefFail("Failed to georeference operator callsign", self.callsign) 208 | 209 | for qso in self.qsos: 210 | try: 211 | qso['lon'], qso['lat'] = self._georef(qso['call']) 212 | except GeoRefFail: 213 | log.warning("Failed to georef call %s", qso['call']) 214 | 215 | def geojson_dumps(self, *args, **kwargs): 216 | qth, pointsFC, linesFC = self.geojson() 217 | r = dict(qth=qth, pointsFC=pointsFC, linesFC=linesFC) 218 | return gj.dumps(r) 219 | 220 | def geojson(self): 221 | qth = gj.Feature(geometry=gj.Point((self.lon, self.lat))) 222 | points = [] 223 | lines = [] 224 | for qso in self.qsos: 225 | point, line = None, None 226 | coords = qso.get('lon', None), qso.get('lat', None) 227 | if None not in coords: 228 | point = gj.Point(coords) 229 | line = gj.LineString([ 230 | (self.lon, self.lat), 231 | coords 232 | ]) 233 | points.append(gj.Feature(geometry=point, 234 | properties=qso)) 235 | lines.append(gj.Feature(geometry=line, 236 | properties=qso)) 237 | pointsFC = gj.FeatureCollection(points) 238 | linesFC = gj.FeatureCollection(lines) 239 | return qth, pointsFC, linesFC 240 | 241 | def write_kml(self, file): 242 | dom = kml.KML() 243 | doc = dom.createDocument(self.callsign + " log") 244 | folder = dom.createFolder(self.callsign + " log") 245 | doc.appendChild(folder) 246 | dom.root.appendChild(doc) 247 | callnode = dom.createPlacemark(self.callsign, self.lat, self.lon) 248 | folder.appendChild(callnode) 249 | for qso in self.qsos: 250 | call, lat, lon = qso['call'], qso["lat"], qso["lon"] 251 | callnode = dom.createPlacemark(call, lat, lon) 252 | callnode2 = dom.createPlacemark(call, lat, lon) 253 | theline = dom.createLineString( 254 | ((lat, lon, 0), (self.lat, self.lon, 0)), 255 | tessel=True) 256 | folder.appendChild(callnode2) 257 | callnode.appendChild(theline) 258 | callnode.removeChild(callnode.childNodes[1]) 259 | folder.appendChild(callnode) 260 | dom.writepretty(file) 261 | 262 | 263 | def geolog(logfilepath, outfile, username, password, cachepath, ctydatflo): 264 | with open(logfilepath) as logfile: 265 | line = logfile.next() 266 | 267 | with open(logfilepath) as logfile: 268 | if line.startswith('START-OF-LOG'): 269 | log.info("Opened Cabrillo format log %r" % logfile) 270 | qsolog = Log.from_cabrillo(logfile) 271 | else: 272 | log.info("Opened ADIF format log %r" % logfile) 273 | qsolog = Log.from_adif(logfile) 274 | 275 | ctydat = CtyDat(ctydatflo) 276 | with qrz.Session(username, password, cachepath) as sess: 277 | qsolog.georeference(sess, ctydat) 278 | 279 | points, lines = qsolog.geojson_dumps(sort_keys=True) 280 | 281 | pointfile = '_'.join((outfile, 'points.geojson')) 282 | with open(pointfile, "w") as pointfile: 283 | pointfile.write(points) 284 | 285 | linefile = '_'.join((outfile, 'lines.geojson')) 286 | with open(linefile, "w") as linefile: 287 | linefile.write(lines) 288 | 289 | kmlfile = ''.join((outfile, '.kml')) 290 | with open(kmlfile, "w") as kmlfile: 291 | qsolog.write_kml(kmlfile) 292 | 293 | 294 | def main(argv=None): 295 | if argv is None: 296 | argv = sys.argv 297 | 298 | parser = argparse.ArgumentParser( 299 | description= 300 | """Read ham log and output GIS data for callsigns worked. Output files will be 301 | prefixed with output path. E.g. given "foo/bar", the following files will be 302 | created: "foo/bar_points.geojson", "foo/bar_lines.geojson", and "foo/bar.kml" 303 | """) 304 | parser.add_argument('infile', type=str, 305 | help='Input log file (ADIF or Cabrillo)') 306 | parser.add_argument('outpath', type=str, 307 | help='Output path prefix') 308 | parser.add_argument('-c', '--cfg', type=str, 309 | help='Config file path', default=os.path.join(os.environ['HOME'], '.geologrc')) 310 | parser.add_argument('-v', '--verbose', type=bool, 311 | help='Turn on additional output', default=False) 312 | args = parser.parse_args(argv[1:]) 313 | 314 | cfg = ConfigParser.SafeConfigParser() 315 | 316 | cfg.read(args.cfg) 317 | 318 | try: 319 | un = cfg.get('qrz', 'username') 320 | except ConfigParser.Error: 321 | un = raw_input("QRZ.com user name:") 322 | 323 | try: 324 | pw = cfg.get('qrz', 'password') 325 | except ConfigParser.Error: 326 | pw = raw_input("QRZ.com password (not stored):") 327 | 328 | try: 329 | cachepath = cfg.get('qrz', 'cachepath') 330 | except ConfigParser.Error: 331 | cachepath = CACHEPATH 332 | 333 | try: 334 | cachepath = cfg.get('qrz', 'cachepath') 335 | except ConfigParser.Error: 336 | cachepath = CACHEPATH 337 | 338 | try: 339 | ctydatpath = cfg.get('geolog', 'cachepath') 340 | ctydatflo = open(ctydatpath) 341 | except ConfigParser.Error: 342 | ctydatflo = resource_stream(__name__, "ctydat/cty.dat") 343 | 344 | log.info("QRZ cache: %s" % cachepath) 345 | 346 | geolog(args.infile, args.outpath, un, pw, cachepath, ctydatflo) 347 | 348 | return 0 349 | 350 | 351 | if __name__ == "__main__": 352 | logging.basicConfig(level=logging.INFO) 353 | sys.exit(main()) 354 | -------------------------------------------------------------------------------- /hamtools/kml.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | http://sourceforge.net/projects/pykml/ 5 | 6 | Copyright 2006 by Herrmann Hofer 7 | 8 | This program is free software: you can redistribute it and/or modify 9 | it under the terms of the GNU General Public License as published by 10 | the Free Software Foundation, either version 3 of the License, or 11 | (at your option) any later version. 12 | 13 | This program is distributed in the hope that it will be useful, 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | GNU General Public License for more details. 17 | 18 | You should have received a copy of the GNU General Public License 19 | along with this program. If not, see . 20 | """ 21 | 22 | from xml.dom.minidom import getDOMImplementation 23 | 24 | ALT_CLAMPED = "clampedToGround" 25 | ALT_RELATIVE = "relativeToGround" 26 | ALT_ABSOLUTE = "absolute" 27 | 28 | class KML(object): 29 | 30 | def __init__(self, comment=None): 31 | impl = getDOMImplementation() 32 | self.xml = impl.createDocument(None, "kml", None) 33 | self.root = self.xml.documentElement 34 | self.root.setAttribute("xmlns", "http://earth.google.com/kml/2.1") 35 | if comment: 36 | self.root.appendChild(self.xml.createComment(comment)) 37 | 38 | # dirty subclassing ;-) 39 | def __getattr__(self, name): 40 | if not hasattr(self.root, name): 41 | raise AttributeError, "%s instance has no attribute '%s'" %\ 42 | (self.__class__.__name__, name) 43 | else: 44 | return getattr(self.root, name) 45 | 46 | def createDocument(self, name, desc=None, visible=True): 47 | doc = self.xml.createElement("Document") 48 | 49 | nm = self.xml.createElement('name') 50 | nm.appendChild(self.xml.createTextNode(name)) 51 | doc.appendChild(nm) 52 | if desc: 53 | elt = self.xml.createElement('description') 54 | elt.appendChild(self.xml.createCDATASection(desc)) 55 | doc.appendChild(elt) 56 | if not visible: 57 | elt = self.xml.createElement('visibility') 58 | elt.appendChild(self.xml.createTextNode("0")) 59 | doc.appendChild(elt) 60 | 61 | return doc 62 | 63 | def createIcon(self, iconUrl=None, x=None, y=None, w=None, h=None, dim=None): 64 | icon = self.xml.createElement("Icon") 65 | if iconUrl != None: 66 | url = self.xml.createElement("href") 67 | url.appendChild(self.xml.createTextNode(iconUrl)) 68 | icon.appendChild(url) 69 | if dim: 70 | dimensions=dim 71 | else: 72 | dimensions = [ ('x', x), ('y', y), ('w', w), ('h', h) ] 73 | for d in dimensions: 74 | if d[1] != None: 75 | elt = self.xml.createElement(d[0]) 76 | elt.appendChild(self.xml.createTextNode(`d[1]`)) 77 | icon.appendChild(elt) 78 | return icon 79 | 80 | def createIconStyle(self, scale=None, icon=None, color=None): 81 | istyle = self.xml.createElement("IconStyle") 82 | if scale != None: 83 | elt = self.xml.createElement("scale") 84 | elt.appendChild(self.xml.createTextNode(`scale`)) 85 | istyle.appendChild(elt) 86 | if icon != None: 87 | istyle.appendChild(icon) 88 | if color: 89 | elt = self.xml.createElement("color") 90 | elt.appendChild(self.xml.createTextNode(color)) 91 | istyle.appendChild(elt) 92 | return istyle 93 | 94 | def createLabelStyle(self, scale=None, color=None, colorMode=None): 95 | lstyle = self.xml.createElement("LabelStyle") 96 | if scale != None: 97 | elt = self.xml.createElement("scale") 98 | elt.appendChild(self.xml.createTextNode(`scale`)) 99 | lstyle.appendChild(elt) 100 | if color: 101 | elt = self.xml.createElement("color") 102 | elt.appendChild(self.xml.createTextNode(color)) 103 | lstyle.appendChild(elt) 104 | if colorMode: 105 | elt = self.xml.createElement("colorMode") 106 | elt.appendChild(self.xml.createTextNode(colorMode)) 107 | lstyle.appendChild(elt) 108 | return lstyle 109 | 110 | def createPolyStyle(self, color=None, outline=True): 111 | pstyle = self.xml.createElement("PolyStyle") 112 | if color: 113 | elt = self.xml.createElement("color") 114 | elt.appendChild(self.xml.createTextNode(color)) 115 | pstyle.appendChild(elt) 116 | if not outline: 117 | elt = self.xml.createElement("outline") 118 | elt.appendChild(self.xml.createTextNode("0")) 119 | pstyle.appendChild(elt) 120 | 121 | return pstyle 122 | 123 | def createLineStyle(self, color=None, width=None): 124 | lstyle = self.xml.createElement("LineStyle") 125 | if color: 126 | elt = self.xml.createElement("color") 127 | elt.appendChild(self.xml.createTextNode(color)) 128 | lstyle.appendChild(elt) 129 | if width != None: 130 | elt = self.xml.createElement("width") 131 | elt.appendChild(self.xml.createTextNode("%f" % width)) 132 | lstyle.appendChild(elt) 133 | 134 | return lstyle 135 | 136 | def createBalloonStyle(self, text, color=None): 137 | bstyle = self.xml.createElement("BalloonStyle") 138 | elt = self.xml.createElement("text") 139 | elt.appendChild(self.xml.createCDATASection(text)) 140 | bstyle.appendChild(elt) 141 | if color: 142 | elt = self.xml.createElement("color") 143 | elt.appendChild(self.xml.createTextNode(color)) 144 | bstyle.appendChild(elt) 145 | return bstyle 146 | 147 | def createStyle(self, id=None, children=None): 148 | style = self.xml.createElement("Style") 149 | if id: 150 | style.setAttribute("id", id) 151 | if children: 152 | if type(children) == list: 153 | for c in children: 154 | style.appendChild(c) 155 | else: 156 | style.appendChild(children) 157 | return style 158 | 159 | def createLookAt(self, lat, lon, range=None, tilt=None, heading=None): 160 | pt = self.xml.createElement("LookAt") 161 | elt = self.xml.createElement("longitude") 162 | elt.appendChild(self.xml.createTextNode("%f" % lon)) 163 | pt.appendChild(elt) 164 | elt = self.xml.createElement("latitude") 165 | elt.appendChild(self.xml.createTextNode("%f" % lat)) 166 | pt.appendChild(elt) 167 | if range != None: 168 | elt = self.xml.createElement("range") 169 | elt.appendChild(self.xml.createTextNode(`range`)) 170 | pt.appendChild(elt) 171 | if tilt != None: 172 | elt = self.xml.createElement("tilt") 173 | elt.appendChild(self.xml.createTextNode(`tilt`)) 174 | pt.appendChild(elt) 175 | if heading != None: 176 | elt = self.xml.createElement("heading") 177 | elt.appendChild(self.xml.createTextNode(`heading`)) 178 | pt.appendChild(elt) 179 | return pt 180 | 181 | def createFolder(self, name, isOpen=False): 182 | fld = self.xml.createElement("Folder") 183 | elt = self.xml.createElement("name") 184 | elt.appendChild(self.xml.createTextNode(name)) 185 | fld.appendChild(elt) 186 | 187 | if isOpen: 188 | elt = self.xml.createElement("open") 189 | elt.appendChild(self.xml.createTextNode("1")) 190 | fld.appendChild(elt) 191 | 192 | return fld 193 | 194 | def createPlacemark(self, name, lat=None, lon=None, desc=None, style=None, range=None, tilt=None, alt=None, 195 | heading=None, visible=True, altMode=None, timeStamp=None): 196 | pm = self.xml.createElement("Placemark") 197 | elt = self.xml.createElement("name") 198 | elt.appendChild(self.xml.createTextNode(name)) 199 | pm.appendChild(elt) 200 | 201 | if lat != None and lon != None: 202 | pt = self.xml.createElement("Point") 203 | elt = self.xml.createElement("coordinates") 204 | coor = "%f,%f" % (lon, lat) 205 | if alt != None: coor += ",%f" % alt 206 | elt.appendChild(self.xml.createTextNode(coor)) 207 | pt.appendChild(elt) 208 | if altMode: 209 | elt = self.xml.createElement("altitudeMode") 210 | elt.appendChild(self.xml.createTextNode(altMode)) 211 | pt.appendChild(elt) 212 | pm.appendChild(pt) 213 | 214 | if range or tilt: 215 | pm.appendChild(self.createLookAt(lat, lon, range, tilt, heading)) 216 | 217 | if style: 218 | if type(style) == str or type(style) == unicode: 219 | elt = self.xml.createElement("styleUrl") 220 | elt.appendChild(self.xml.createTextNode(style)) 221 | pm.appendChild(elt) 222 | else: 223 | pm.appendChild(style) 224 | 225 | if desc: 226 | elt = self.xml.createElement("description") 227 | elt.appendChild(self.xml.createCDATASection(desc)) 228 | pm.appendChild(elt) 229 | 230 | if not visible: 231 | elt = self.xml.createElement("visibility") 232 | elt.appendChild(self.xml.createTextNode("0")) 233 | pm.appendChild(elt) 234 | 235 | if timeStamp: 236 | pm.appendChild(self.createTimeStamp(timeStamp)) 237 | 238 | return pm 239 | 240 | def createTimeStamp(self, dt, tz="Z"): 241 | ts = self.xml.createElement("TimeStamp") 242 | wh = self.xml.createElement("when") 243 | wh.appendChild(self.xml.createTextNode(dt.strftime("%Y-%m-%dT%H:%M:%S") + tz)) 244 | ts.appendChild(wh) 245 | return ts 246 | 247 | def createMultiGeometry(self): 248 | return self.xml.createElement("MultiGeometry") 249 | 250 | def createLineString(self, coords, altMode=None, tessel=False, extrude=False): 251 | ls = self.xml.createElement("LineString") 252 | 253 | if tessel: 254 | elt = self.xml.createElement("tessellate") 255 | elt.appendChild(self.xml.createTextNode("1")) 256 | ls.appendChild(elt) 257 | 258 | if extrude: 259 | elt = self.xml.createElement("extrude") 260 | elt.appendChild(self.xml.createTextNode("1")) 261 | ls.appendChild(elt) 262 | 263 | if altMode: 264 | elt = self.xml.createElement("altitudeMode") 265 | elt.appendChild(self.xml.createTextNode(altMode)) 266 | ls.appendChild(elt) 267 | 268 | elt = self.xml.createElement("coordinates") 269 | coo = "" 270 | for c in coords: 271 | coo += "%f,%f,%f " % (c[1], c[0], c[2]) 272 | elt.appendChild(self.xml.createTextNode(coo)) 273 | 274 | ls.appendChild(elt) 275 | 276 | return ls 277 | 278 | def createLink(self, url, # This is KML 2.1 / GoogleEarth > 4.x 279 | refreshMode=None, refreshInterval=None): # TODO: all view... elts 280 | ln = self.xml.createElement("Link") 281 | elt = self.xml.createElement("href") 282 | elt.appendChild(self.xml.createTextNode(url)) 283 | ln.appendChild(elt) 284 | if refreshMode != None: 285 | if not refreshMode in [ "onChange", "onInterval", "onExpire" ]: 286 | raise ValueError("Invalid refresh mode '%s'" % refreshMode) 287 | elt = self.xml.createElement("refreshMode") 288 | elt.appendChild(self.xml.createTextNode(refreshMode)) 289 | ln.appendChild(elt) 290 | if refreshInterval != None: 291 | elt = self.xml.createElement("refreshInterval") 292 | elt.appendChild(self.xml.createTextNode(str(refreshInterval))) 293 | ln.appendChild(elt) 294 | return ln 295 | 296 | def createNetworkLink(self, url, name=None, desc=None, 297 | visible=True, isOpen=True, 298 | refreshMode=None, refreshInterval=None): # TODO: all view... elts 299 | nl = self.xml.createElement("NetworkLink") 300 | ln = self.createLink(url, refreshMode, refreshInterval) 301 | nl.appendChild(ln) 302 | if name != None: 303 | elt = self.xml.createElement("name") 304 | elt.appendChild(self.xml.createTextNode(name)) 305 | nl.appendChild(elt) 306 | if desc != None: 307 | elt = self.xml.createElement("description") 308 | elt.appendChild(self.xml.createCDATASection(desc)) 309 | nl.appendChild(elt) 310 | if not visible: 311 | elt = self.xml.createElement("visibility") 312 | elt.appendChild(self.xml.createTextNode("0")) 313 | nl.appendChild(elt) 314 | if isOpen: 315 | elt = self.xml.createElement("open") 316 | elt.appendChild(self.xml.createTextNode("1")) 317 | nl.appendChild(elt) 318 | return nl 319 | 320 | 321 | def createNetworkLinkControl(self, name=None, desc=None, 322 | refresh=None, msg=None, cookie=None): 323 | nlc = self.xml.createElement("NetworkLinkControl") 324 | if name != None: 325 | elt = self.xml.createElement("linkName") 326 | elt.appendChild(self.xml.createTextNode(name)) 327 | nlc.appendChild(elt) 328 | if desc != None: 329 | elt = self.xml.createElement("linkDescription") 330 | elt.appendChild(self.xml.createCDATASection(desc)) 331 | nlc.appendChild(elt) 332 | if refresh != None: 333 | elt = self.xml.createElement("minRefreshPeriod") 334 | elt.appendChild(self.xml.createTextNode("%d" % refresh)) 335 | nlc.appendChild(elt) 336 | if msg != None: 337 | elt = self.xml.createElement("message") 338 | elt.appendChild(self.xml.createTextNode(msg)) 339 | nlc.appendChild(elt) 340 | if cookie != None: 341 | elt = self.xml.createElement("cookie") 342 | elt.appendChild(self.xml.createTextNode(cookie)) 343 | nlc.appendChild(elt) 344 | return nlc 345 | 346 | def writepretty(self, f, encoding="utf-8"): 347 | self.xml.writexml(f, addindent=" ", newl="\n") 348 | 349 | def writeplain(self, f): 350 | self.xml.writexml(f) 351 | 352 | write = writepretty 353 | 354 | # def appendChild(self, node): 355 | # self.root.appendChild(node) 356 | 357 | 358 | # root.appendChild(root) 359 | 360 | if __name__ == "__main__": 361 | print "Syntax OK!" 362 | -------------------------------------------------------------------------------- /AGPL3.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------