merge import
This commit is contained in:
		
						commit
						a25eca2818
					
				
					 15 changed files with 1228 additions and 139 deletions
				
			
		|  | @ -22,9 +22,10 @@ from flask import request, Response, abort | |||
| from multiprocessing import Process | ||||
| from gevent.wsgi import WSGIServer | ||||
| import sys, random, threading, hmac, hashlib, base64, time, math, os, logger, config | ||||
| 
 | ||||
| from core import Core | ||||
| from onionrblockapi import Block | ||||
| import onionrutils, onionrcrypto | ||||
| 
 | ||||
| class API: | ||||
|     ''' | ||||
|         Main HTTP API (Flask) | ||||
|  | @ -50,7 +51,7 @@ class API: | |||
|         ''' | ||||
| 
 | ||||
|         config.reload() | ||||
|          | ||||
| 
 | ||||
|         if config.get('devmode', True): | ||||
|             self._developmentMode = True | ||||
|             logger.set_level(logger.LEVEL_DEBUG) | ||||
|  | @ -69,7 +70,7 @@ class API: | |||
|         self.clientToken = config.get('client')['client_hmac'] | ||||
|         self.timeBypassToken = base64.b16encode(os.urandom(32)).decode() | ||||
| 
 | ||||
|         self.i2pEnabled = config.get('i2p')['host'] | ||||
|         self.i2pEnabled = config.get('i2p', {'host' : False})['host'] | ||||
| 
 | ||||
|         self.mimeType = 'text/plain' | ||||
| 
 | ||||
|  | @ -80,13 +81,13 @@ class API: | |||
|             logger.debug('Your web password (KEEP SECRET): ' + logger.colors.underline + self.clientToken) | ||||
| 
 | ||||
|         if not debug and not self._developmentMode: | ||||
|             hostNums = [random.randint(1, 255), random.randint(1, 255), random.randint(1, 255)] | ||||
|             self.host = '127.' + str(hostNums[0]) + '.' + str(hostNums[1]) + '.' + str(hostNums[2]) | ||||
|             hostOctets = [127, random.randint(0x02, 0xFF), random.randint(0x02, 0xFF), random.randint(0x02, 0xFF)] | ||||
|             self.host = '.'.join(hostOctets) | ||||
|         else: | ||||
|             self.host = '127.0.0.1' | ||||
|         hostFile = open('data/host.txt', 'w') | ||||
|         hostFile.write(self.host) | ||||
|         hostFile.close() | ||||
|          | ||||
|         with open('data/host.txt', 'w') as file: | ||||
|             file.write(self.host) | ||||
| 
 | ||||
|         @app.before_request | ||||
|         def beforeReq(): | ||||
|  | @ -258,7 +259,7 @@ class API: | |||
| 
 | ||||
|             return resp | ||||
|         if not os.environ.get("WERKZEUG_RUN_MAIN") == "true": | ||||
|             logger.info('Starting client on ' + self.host + ':' + str(bindPort) + '...', timestamp=True) | ||||
|             logger.info('Starting client on ' + self.host + ':' + str(bindPort) + '...', timestamp=False) | ||||
| 
 | ||||
|         try: | ||||
|             self.http_server = WSGIServer((self.host, bindPort), app) | ||||
|  |  | |||
|  | @ -21,6 +21,7 @@ | |||
| ''' | ||||
| import sqlite3, requests, hmac, hashlib, time, sys, os, math, logger, urllib.parse, base64, binascii, random, json, threading | ||||
| import core, onionrutils, onionrcrypto, netcontroller, onionrproofs, config, onionrplugins as plugins | ||||
| from onionrblockapi import Block | ||||
| 
 | ||||
| class OnionrCommunicate: | ||||
|     def __init__(self, debug, developmentMode): | ||||
|  | @ -76,7 +77,7 @@ class OnionrCommunicate: | |||
|         while True: | ||||
|             command = self._core.daemonQueue() | ||||
|             # Process blocks based on a timer | ||||
|             self.timerTick()  | ||||
|             self.timerTick() | ||||
|             # TODO: migrate below if statements to be own functions which are called in the above timerTick() function | ||||
|             if self.communicatorTimers['highFailure'] == self.communicatorTimerCounts['highFailure']: | ||||
|                 self.communicatorTimerCounts['highFailure'] = 0 | ||||
|  | @ -122,16 +123,16 @@ class OnionrCommunicate: | |||
|                     announceAttempts = 3 | ||||
|                     announceAttemptCount = 0 | ||||
|                     announceVal = False | ||||
|                     logger.info('Announcing node to ' + command[1], timestamp=True) | ||||
|                     logger.info('Announcing node to %s...' % command[1], timestamp=True) | ||||
|                     while not announceVal: | ||||
|                         announceAttemptCount += 1 | ||||
|                         announceVal = self.performGet('announce', command[1], data=self._core.hsAdder.replace('\n', ''), skipHighFailureAddress=True) | ||||
|                         logger.info(announceVal) | ||||
|                         # logger.info(announceVal) | ||||
|                         if announceAttemptCount >= announceAttempts: | ||||
|                             logger.warn('Unable to announce to ' + command[1]) | ||||
|                             logger.warn('Unable to announce to %s' % command[1]) | ||||
|                             break | ||||
|                 elif command[0] == 'runCheck': | ||||
|                     logger.info('Status check; looks good.') | ||||
|                     logger.debug('Status check; looks good.') | ||||
|                     open('data/.runcheck', 'w+').close() | ||||
|                 elif command[0] == 'kex': | ||||
|                     self.pexCount = pexTimer - 1 | ||||
|  | @ -187,13 +188,17 @@ class OnionrCommunicate: | |||
|     id_peer_cache = {} | ||||
| 
 | ||||
|     def registerTimer(self, timerName, rate, timerFunc=None): | ||||
|         '''Register a communicator timer''' | ||||
|         ''' | ||||
|             Register a communicator timer | ||||
|         ''' | ||||
|         self.communicatorTimers[timerName] = rate | ||||
|         self.communicatorTimerCounts[timerName] = 0 | ||||
|         self.communicatorTimerFuncs[timerName] = timerFunc | ||||
|      | ||||
| 
 | ||||
|     def timerTick(self): | ||||
|         '''Increments timers "ticks" and calls funcs if applicable''' | ||||
|         ''' | ||||
|             Increments timers "ticks" and calls funcs if applicable | ||||
|         ''' | ||||
|         tName = '' | ||||
|         for i in self.communicatorTimers.items(): | ||||
|             tName = i[0] | ||||
|  | @ -616,7 +621,9 @@ class OnionrCommunicate: | |||
|         return | ||||
| 
 | ||||
|     def removeBlockFromProcessingList(self, block): | ||||
|         '''Remove a block from the processing list''' | ||||
|         ''' | ||||
|             Remove a block from the processing list | ||||
|         ''' | ||||
|         try: | ||||
|             self.blocksProcessing.remove(block) | ||||
|         except ValueError: | ||||
|  | @ -723,7 +730,8 @@ class OnionrCommunicate: | |||
|                     r = requests.get(url, headers=headers, proxies=proxies, allow_redirects=False, timeout=(15, 30)) | ||||
|                 retData = r.text | ||||
|         except requests.exceptions.RequestException as e: | ||||
|             logger.debug("%s failed with peer %s" % (action, peer)) | ||||
|             logger.debug('%s failed with peer %s' % (action, peer)) | ||||
|             logger.debug('Error: %s' % str(e)) | ||||
|             retData = False | ||||
| 
 | ||||
|         if not retData: | ||||
|  |  | |||
|  | @ -109,7 +109,7 @@ class Core: | |||
|         ''' | ||||
|             Add an address to the address database (only tor currently) | ||||
|         ''' | ||||
|         if address == config.get('i2p')['ownAddr']: | ||||
|         if (not (config.is_set('i2p') and 'ownAddr' in config.get('i2p'))) or address == config.get('i2p')['ownAddr']: | ||||
|             return False | ||||
|         if self._utils.validateID(address): | ||||
|             conn = sqlite3.connect(self.addressDB) | ||||
|  | @ -654,7 +654,7 @@ class Core: | |||
|         conn.close() | ||||
|         return True | ||||
| 
 | ||||
|     def insertBlock(self, data, header='txt', sign=False): | ||||
|     def insertBlock(self, data, header='txt', sign=False, metadata = {}): | ||||
|         ''' | ||||
|             Inserts a block into the network | ||||
|         ''' | ||||
|  | @ -687,7 +687,11 @@ class Core: | |||
|             data = data.encode() | ||||
| 
 | ||||
|         retData = '' | ||||
|         metadata = {'type': header, 'powHash': powHash, 'powToken': powToken} | ||||
|          | ||||
|         metadata['type'] = header | ||||
|         metadata['powHash'] = powHash | ||||
|         metadata['powToken'] = powToken | ||||
|          | ||||
|         sig = {} | ||||
| 
 | ||||
|         metadata = json.dumps(metadata) | ||||
|  |  | |||
|  | @ -19,6 +19,7 @@ | |||
| ''' | ||||
| 
 | ||||
| import subprocess, os, random, sys, logger, time, signal | ||||
| from onionrblockapi import Block | ||||
| 
 | ||||
| class NetController: | ||||
|     ''' | ||||
|  | @ -102,7 +103,7 @@ DataDirectory data/tordata/ | |||
|             logger.fatal("Got keyboard interrupt") | ||||
|             return False | ||||
| 
 | ||||
|         logger.info('Finished starting Tor', timestamp=True) | ||||
|         logger.debug('Finished starting Tor.', timestamp=True) | ||||
|         self.readyState = True | ||||
| 
 | ||||
|         myID = open('data/hs/hostname', 'r') | ||||
|  |  | |||
|  | @ -31,6 +31,7 @@ import api, core, config, logger, onionrplugins as plugins, onionrevents as even | |||
| import onionrutils | ||||
| from onionrutils import OnionrUtils | ||||
| from netcontroller import NetController | ||||
| from onionrblockapi import Block | ||||
| 
 | ||||
| try: | ||||
|     from urllib3.contrib.socks import SOCKSProxyManager | ||||
|  | @ -38,7 +39,8 @@ except ImportError: | |||
|     raise Exception("You need the PySocks module (for use with socks5 proxy to use Tor)") | ||||
| 
 | ||||
| ONIONR_TAGLINE = 'Anonymous P2P Platform - GPLv3 - https://Onionr.VoidNet.Tech' | ||||
| ONIONR_VERSION = '0.0.0' # for debugging and stuff | ||||
| ONIONR_VERSION = '0.1.0' # for debugging and stuff | ||||
| ONIONR_VERSION_TUPLE = tuple(ONIONR_VERSION.split('.')) # (MAJOR, MINOR, VERSION) | ||||
| API_VERSION = '2' # increments of 1; only change when something fundemental about how the API works changes. This way other nodes knows how to communicate without learning too much information about you. | ||||
| 
 | ||||
| class Onionr: | ||||
|  | @ -191,8 +193,11 @@ class Onionr: | |||
|             'add-addr': self.addAddress, | ||||
|             'addaddr': self.addAddress, | ||||
|             'addaddress': self.addAddress, | ||||
|              | ||||
|             'add-file': self.addFile, | ||||
|             'addfile': self.addFile, | ||||
| 
 | ||||
|             'import-blocks': self.onionrUtils.importNewBlocks, | ||||
|             'importblocks': self.onionrUtils.importNewBlocks, | ||||
| 
 | ||||
|             'introduce': self.onionrCore.introduceNode, | ||||
|  | @ -215,8 +220,8 @@ class Onionr: | |||
|             'add-msg': 'Broadcasts a message to the Onionr network', | ||||
|             'pm': 'Adds a private message to block', | ||||
|             'get-pms': 'Shows private messages sent to you', | ||||
|             'addfile': 'Create an Onionr block from a file', | ||||
|             'importblocks': 'import blocks from the disk (Onionr is transport-agnostic!)', | ||||
|             'add-file': 'Create an Onionr block from a file', | ||||
|             'import-blocks': 'import blocks from the disk (Onionr is transport-agnostic!)', | ||||
|             'introduce': 'Introduce your node to the public Onionr network', | ||||
|         } | ||||
| 
 | ||||
|  | @ -390,12 +395,11 @@ class Onionr: | |||
|             except KeyboardInterrupt: | ||||
|                 return | ||||
| 
 | ||||
|         #addedHash = self.onionrCore.setData(messageToAdd) | ||||
|         addedHash = self.onionrCore.insertBlock(messageToAdd, header='txt') | ||||
|         #self.onionrCore.addToBlockDB(addedHash, selfInsert=True) | ||||
|         #self.onionrCore.setBlockType(addedHash, 'txt') | ||||
|         if addedHash != '': | ||||
|         addedHash = Block('txt', messageToAdd).save() | ||||
|         if addedHash != None: | ||||
|             logger.info("Message inserted as as block %s" % addedHash) | ||||
|         else: | ||||
|             logger.error('Failed to insert block.', timestamp = False) | ||||
|         return | ||||
| 
 | ||||
|     def getPMs(self): | ||||
|  | @ -519,12 +523,12 @@ class Onionr: | |||
| 
 | ||||
|         if not os.environ.get("WERKZEUG_RUN_MAIN") == "true": | ||||
|             if self._developmentMode: | ||||
|                 logger.warn('DEVELOPMENT MODE ENABLED (THIS IS LESS SECURE!)') | ||||
|                 logger.warn('DEVELOPMENT MODE ENABLED (THIS IS LESS SECURE!)', timestamp = False) | ||||
|             net = NetController(config.get('client')['port']) | ||||
|             logger.info('Tor is starting...') | ||||
|             if not net.startTor(): | ||||
|                 sys.exit(1) | ||||
|             logger.info('Started Tor .onion service: ' + logger.colors.underline + net.myID) | ||||
|             logger.info('Started .onion service: ' + logger.colors.underline + net.myID) | ||||
|             logger.info('Our Public key: ' + self.onionrCore._crypto.pubKey) | ||||
|             time.sleep(1) | ||||
|             subprocess.Popen(["./communicator.py", "run", str(net.socksPort)]) | ||||
|  | @ -561,6 +565,9 @@ class Onionr: | |||
| 
 | ||||
|         try: | ||||
|             # define stats messages here | ||||
|             totalBlocks = len(Block.getBlocks()) | ||||
|             signedBlocks = len(Block.getBlocks(signed = True)) | ||||
|              | ||||
|             messages = { | ||||
|                 # info about local client | ||||
|                 'Onionr Daemon Status' : ((logger.colors.fg.green + 'Online') if self.onionrUtils.isCommunicatorRunning(timeout = 2) else logger.colors.fg.red + 'Offline'), | ||||
|  | @ -576,7 +583,9 @@ class Onionr: | |||
|                 # count stats | ||||
|                 'div2' : True, | ||||
|                 'Known Peers Count' : str(len(self.onionrCore.listPeers()) - 1), | ||||
|                 'Enabled Plugins Count' : str(len(config.get('plugins')['enabled'])) + ' / ' + str(len(os.listdir('data/plugins/'))) | ||||
|                 'Enabled Plugins Count' : str(len(config.get('plugins')['enabled'])) + ' / ' + str(len(os.listdir('data/plugins/'))), | ||||
|                 'Known Blocks Count' : str(totalBlocks), | ||||
|                 'Percent Blocks Signed' : str(round(100 * signedBlocks / totalBlocks, 2)) + '%' | ||||
|             } | ||||
| 
 | ||||
|             # color configuration | ||||
|  | @ -638,18 +647,30 @@ class Onionr: | |||
|             return None | ||||
| 
 | ||||
|     def addFile(self): | ||||
|         '''command to add a file to the onionr network''' | ||||
|         if len(sys.argv) >= 2: | ||||
|             newFile = sys.argv[2] | ||||
|             logger.info('Attempting to add file...') | ||||
|             try: | ||||
|                 with open(newFile, 'rb') as new: | ||||
|                     new = new.read() | ||||
|             except FileNotFoundError: | ||||
|         ''' | ||||
|             Adds a file to the onionr network | ||||
|         ''' | ||||
| 
 | ||||
|         if len(sys.argv) >= 3: | ||||
|             filename = sys.argv[2] | ||||
|             contents = None | ||||
|              | ||||
|             if not os.path.exists(filename): | ||||
|                 logger.warn('That file does not exist. Improper path?') | ||||
|              | ||||
|             try: | ||||
|                 with open(filename, 'rb') as file: | ||||
|                     contents = file.read().decode() | ||||
|             except: | ||||
|                 pass | ||||
|              | ||||
|             if not contents is None: | ||||
|                 blockhash = Block('bin', contents).save() | ||||
|                 logger.info('File %s saved in block %s.' % (filename, blockhash)) | ||||
|             else: | ||||
|                 logger.debug(new) | ||||
|                 logger.info(self.onionrCore.insertBlock(new, header='bin')) | ||||
|                 logger.error('Failed to save file in block.', timestamp = False) | ||||
|         else: | ||||
|             logger.error('%s add-file <filename>' % sys.argv[0], timestamp = False) | ||||
| 
 | ||||
| 
 | ||||
| Onionr() | ||||
|  |  | |||
|  | @ -57,6 +57,7 @@ class Block: | |||
|         self.signature = None | ||||
|         self.signedData = None | ||||
|         self.blockFile = None | ||||
|         self.parent = None | ||||
|         self.bheader = {} | ||||
|         self.bmetadata = {} | ||||
| 
 | ||||
|  | @ -98,7 +99,8 @@ class Block: | |||
| 
 | ||||
|                     filelocation = 'data/blocks/%s.dat' % self.getHash() | ||||
| 
 | ||||
|                 blockdata = open(filelocation, 'rb').read().decode('utf-8') | ||||
|                 with open(filelocation, 'rb') as f: | ||||
|                     blockdata = f.read().decode('utf-8') | ||||
| 
 | ||||
|                 self.blockFile = filelocation | ||||
|             else: | ||||
|  | @ -109,6 +111,7 @@ class Block: | |||
|             self.bheader = json.loads(self.getRaw()[:self.getRaw().index('\n')]) | ||||
|             self.bcontent = self.getRaw()[self.getRaw().index('\n') + 1:] | ||||
|             self.bmetadata = json.loads(self.getHeader('meta')) | ||||
|             self.parent = (None if not 'parent' in self.getMetadata() else Block(self.getMetadata('parent'))) | ||||
|             self.btype = self.getMetadata('type') | ||||
|             self.powHash = self.getMetadata('powHash') | ||||
|             self.powToken = self.getMetadata('powToken') | ||||
|  | @ -161,9 +164,9 @@ class Block: | |||
|                         blockFile.write(self.getRaw().encode()) | ||||
|                     self.update() | ||||
|                 else: | ||||
|                     self.hash = self.getCore().insertBlock(self.getContent(), header = self.getType(), sign = sign) | ||||
|                     self.hash = self.getCore().insertBlock(self.getContent(), header = self.getType(), sign = sign, metadata = self.getMetadata()) | ||||
|                     self.update() | ||||
|                 return True | ||||
|                 return self.getHash() | ||||
|             else: | ||||
|                 logger.warn('Not writing block; it is invalid.') | ||||
|         except Exception as e: | ||||
|  | @ -225,8 +228,7 @@ class Block: | |||
| 
 | ||||
|         if not key is None: | ||||
|             return self.getHeader()[key] | ||||
|         else: | ||||
|             return self.bheader | ||||
|         return self.bheader | ||||
| 
 | ||||
|     def getMetadata(self, key = None): | ||||
|         ''' | ||||
|  | @ -241,8 +243,7 @@ class Block: | |||
| 
 | ||||
|         if not key is None: | ||||
|             return self.getMetadata()[key] | ||||
|         else: | ||||
|             return self.bmetadata | ||||
|         return self.bmetadata | ||||
| 
 | ||||
|     def getContent(self): | ||||
|         ''' | ||||
|  | @ -253,6 +254,16 @@ class Block: | |||
|         ''' | ||||
| 
 | ||||
|         return str(self.bcontent) | ||||
|          | ||||
|     def getParent(self): | ||||
|         ''' | ||||
|             Returns the Block's parent Block, or None | ||||
|              | ||||
|             Outputs: | ||||
|             - (Block): the Block's parent | ||||
|         ''' | ||||
|          | ||||
|         return self.parent | ||||
| 
 | ||||
|     def getDate(self): | ||||
|         ''' | ||||
|  | @ -344,11 +355,31 @@ class Block: | |||
|             - btype (str): the type of block to be set to | ||||
| 
 | ||||
|             Outputs: | ||||
|             - (Block): the block instance | ||||
|             - (Block): the Block instance | ||||
|         ''' | ||||
| 
 | ||||
|         self.btype = btype | ||||
|         return self | ||||
|          | ||||
|     def setMetadata(self, key, val): | ||||
|         ''' | ||||
|             Sets a custom metadata value | ||||
|              | ||||
|             Metadata should not store block-specific data structures. | ||||
|              | ||||
|             Inputs: | ||||
|             - key (str): the key | ||||
|             - val: the value (type is irrelevant) | ||||
|              | ||||
|             Outputs: | ||||
|             - (Block): the Block instance | ||||
|         ''' | ||||
|          | ||||
|         if key == 'parent' and (not val is None) and (not val == self.getParent().getHash()): | ||||
|             self.setParent(val) | ||||
|         else: | ||||
|             self.bmetadata[key] = val | ||||
|         return self | ||||
| 
 | ||||
|     def setContent(self, bcontent): | ||||
|         ''' | ||||
|  | @ -358,13 +389,31 @@ class Block: | |||
|             - bcontent (str): the contents to be set to | ||||
| 
 | ||||
|             Outputs: | ||||
|             - (Block): the block instance | ||||
|             - (Block): the Block instance | ||||
|         ''' | ||||
| 
 | ||||
|         self.bcontent = str(bcontent) | ||||
|         return self | ||||
|          | ||||
|     def setParent(self, parent): | ||||
|         ''' | ||||
|             Sets the Block's parent | ||||
|              | ||||
|             Inputs: | ||||
|             - parent (Block/str): the Block's parent, to be stored in metadata | ||||
|              | ||||
|             Outputs: | ||||
|             - (Block): the Block instance | ||||
|         ''' | ||||
|          | ||||
|         if type(parent) == str: | ||||
|             parent = Block(parent, core = self.getCore()) | ||||
|          | ||||
|         self.parent = parent | ||||
|         self.setMetadata('parent', (None if parent is None else self.getParent().getHash())) | ||||
|         return self | ||||
| 
 | ||||
|     # static | ||||
|     # static functions | ||||
| 
 | ||||
|     def getBlocks(type = None, signer = None, signed = None, reverse = False, core = None): | ||||
|         ''' | ||||
|  | @ -420,6 +469,119 @@ class Block: | |||
| 
 | ||||
|         return list() | ||||
| 
 | ||||
|     def merge(child, file = None, maximumFollows = 32, core = None): | ||||
|         ''' | ||||
|             Follows a child Block to its root parent Block, merging content | ||||
|              | ||||
|             Inputs: | ||||
|             - child (str/Block): the child Block to be followed | ||||
|             - file (str/file): the file to write the content to, instead of returning it | ||||
|             - maximumFollows (int): the maximum number of Blocks to follow | ||||
|              | ||||
|         ''' | ||||
|          | ||||
|         # validate data and instantiate Core | ||||
|         core = (core if not core is None else onionrcore.Core()) | ||||
|         maximumFollows = max(0, maximumFollows) | ||||
|          | ||||
|         # type conversions | ||||
|         if type(child) == str: | ||||
|             child = Block(child) | ||||
|         if (not file is None) and (type(file) == str): | ||||
|             file = open(file, 'ab') | ||||
|          | ||||
|         # only store hashes to avoid intensive memory usage | ||||
|         blocks = [child.getHash()] | ||||
|          | ||||
|         # generate a list of parent Blocks | ||||
|         while True: | ||||
|             # end if the maximum number of follows has been exceeded | ||||
|             if len(blocks) - 1 >= maximumFollows: | ||||
|                 break | ||||
|              | ||||
|             block = Block(blocks[-1], core = core).getParent() | ||||
|              | ||||
|             # end if there is no parent Block | ||||
|             if block is None: | ||||
|                 break | ||||
|              | ||||
|             # end if the Block is pointing to a previously parsed Block | ||||
|             if block.getHash() in blocks: | ||||
|                 break | ||||
|                  | ||||
|             # end if the block is not valid | ||||
|             if not block.isValid(): | ||||
|                 break | ||||
|              | ||||
|             blocks.append(block.getHash()) | ||||
|          | ||||
|         buffer = '' | ||||
|          | ||||
|         # combine block contents | ||||
|         for hash in blocks: | ||||
|             block = Block(hash, core = core) | ||||
|             contents = block.getContent() | ||||
|              | ||||
|             if file is None: | ||||
|                 buffer += contents | ||||
|             else: | ||||
|                 file.write(contents) | ||||
|          | ||||
|         return (None if not file is None else buffer) | ||||
| 
 | ||||
|     def create(data = None, chunksize = 4999000, file = None, type = 'chunk', sign = True): | ||||
|         ''' | ||||
|             Creates a chain of blocks to store larger amounts of data | ||||
| 
 | ||||
|             The chunksize is set to 4999000 because it provides the least amount of PoW for the most amount of data. | ||||
|              | ||||
|             TODO: Add docs | ||||
|         ''' | ||||
|          | ||||
|         blocks = list() | ||||
|          | ||||
|         # initial datatype checks | ||||
|         if data is None and file is None: | ||||
|             return blocks | ||||
|         elif not (file is None or (isinstance(file, str) and os.path.exists(file))): | ||||
|             return blocks | ||||
|         elif isinstance(file, str): | ||||
|             file = open(file, 'rb') | ||||
|         if isinstance(data, str): | ||||
|             data = str(data) | ||||
|          | ||||
|         if not file is None: | ||||
|             while True: | ||||
|                 # read chunksize bytes from the file | ||||
|                 content = file.read(chunksize) | ||||
|                  | ||||
|                 # if it is the end of the file, exit | ||||
|                 if not content: | ||||
|                     break | ||||
|                  | ||||
|                 # create block | ||||
|                 block = Block() | ||||
|                 block.setType(type) | ||||
|                 block.setContent(content) | ||||
|                 block.setParent((blocks[-1] if len(blocks) != 0 else None)) | ||||
|                 hash = block.save(sign = sign) | ||||
|                  | ||||
|                 # remember the hash in cache | ||||
|                 blocks.append(hash) | ||||
|         elif not data is None: | ||||
|             for content in [data[n:n + chunksize] for n in range(0, len(data), chunksize)]: | ||||
|                 # create block | ||||
|                 block = Block() | ||||
|                 block.setType(type) | ||||
|                 block.setContent(content) | ||||
|                 block.setParent((blocks[-1] if len(blocks) != 0 else None)) | ||||
|                 hash = block.save(sign = sign) | ||||
|                  | ||||
|                 # remember the hash in cache | ||||
|                 blocks.append(hash) | ||||
|                  | ||||
|         return blocks | ||||
|      | ||||
|     def exists(hash): | ||||
|         ''' | ||||
|             Checks if a block is saved to file or not | ||||
|  |  | |||
|  | @ -77,7 +77,7 @@ def enable(name, onionr = None, start_event = True): | |||
|         else: | ||||
|             return False | ||||
|     else: | ||||
|         logger.error('Failed to enable plugin \"' + name + '\", disabling plugin.') | ||||
|         logger.error('Failed to enable plugin \"%s\", disabling plugin.' % name) | ||||
|         disable(name) | ||||
| 
 | ||||
|         return False | ||||
|  | @ -121,9 +121,9 @@ def start(name, onionr = None): | |||
| 
 | ||||
|             return plugin | ||||
|         except: | ||||
|             logger.error('Failed to start module \"' + name + '\".') | ||||
|             logger.error('Failed to start module \"%s\".' % name) | ||||
|     else: | ||||
|         logger.error('Failed to start nonexistant module \"' + name + '\".') | ||||
|         logger.error('Failed to start nonexistant module \"%s\".' % name) | ||||
| 
 | ||||
|     return None | ||||
| 
 | ||||
|  | @ -145,9 +145,9 @@ def stop(name, onionr = None): | |||
| 
 | ||||
|             return plugin | ||||
|         except: | ||||
|             logger.error('Failed to stop module \"' + name + '\".') | ||||
|             logger.error('Failed to stop module \"%s\".' % name) | ||||
|     else: | ||||
|         logger.error('Failed to stop nonexistant module \"' + name + '\".') | ||||
|         logger.error('Failed to stop nonexistant module \"%s\".' % name) | ||||
| 
 | ||||
|     return None | ||||
| 
 | ||||
|  |  | |||
|  | @ -22,7 +22,7 @@ import nacl.encoding, nacl.hash, nacl.utils, time, math, threading, binascii, lo | |||
| import core | ||||
| 
 | ||||
| class POW: | ||||
|     def pow(self, reporting = False): | ||||
|     def pow(self, reporting = False, myCore = None): | ||||
|         startTime = math.floor(time.time()) | ||||
|         self.hashing = True | ||||
|         self.reporting = reporting | ||||
|  | @ -30,7 +30,7 @@ class POW: | |||
|         answer = '' | ||||
|         heartbeat = 200000 | ||||
|         hbCount = 0 | ||||
|         myCore = core.Core() | ||||
|          | ||||
|         while self.hashing: | ||||
|             rand = nacl.utils.random() | ||||
|             token = nacl.hash.blake2b(rand + self.data).decode() | ||||
|  | @ -39,23 +39,22 @@ class POW: | |||
|                 self.hashing = False | ||||
|                 iFound = True | ||||
|                 break | ||||
|         else: | ||||
|             logger.debug('POW thread exiting, another thread found result') | ||||
|                  | ||||
|         if iFound: | ||||
|             endTime = math.floor(time.time()) | ||||
|             if self.reporting: | ||||
|                 logger.info('Found token ' + token, timestamp=True) | ||||
|                 logger.info('rand value: ' + base64.b64encode(rand).decode()) | ||||
|                 logger.info('took ' + str(endTime - startTime) + ' seconds', timestamp=True) | ||||
|                 logger.debug('Found token after %s seconds: %s' % (endTime - startTime, token), timestamp=True) | ||||
|                 logger.debug('Random value was: %s' % base64.b64encode(rand).decode()) | ||||
|             self.result = (token, rand) | ||||
| 
 | ||||
|     def __init__(self, data): | ||||
|     def __init__(self, data, threadCount = 5): | ||||
|         self.foundHash = False | ||||
|         self.difficulty = 0 | ||||
|         self.data = data | ||||
|         self.threadCount = threadCount | ||||
| 
 | ||||
|         dataLen = sys.getsizeof(data) | ||||
|         self.difficulty = math.floor(dataLen/1000000) | ||||
|         self.difficulty = math.floor(dataLen / 1000000) | ||||
|         if self.difficulty <= 2: | ||||
|             self.difficulty = 4 | ||||
| 
 | ||||
|  | @ -63,19 +62,19 @@ class POW: | |||
|             self.data = self.data.encode() | ||||
|         except AttributeError: | ||||
|             pass | ||||
|          | ||||
|         self.data = nacl.hash.blake2b(self.data) | ||||
| 
 | ||||
|         logger.debug('Computing difficulty of ' + str(self.difficulty)) | ||||
|         logger.info('Computing POW (difficulty: %s)...' % self.difficulty) | ||||
| 
 | ||||
|         self.mainHash = '0000000000000000000000000000000000000000000000000000000000000000'#nacl.hash.blake2b(nacl.utils.random()).decode() | ||||
|         self.puzzle = self.mainHash[0:self.difficulty] | ||||
|         #logger.debug('trying to find ' + str(self.mainHash)) | ||||
|         tOne = threading.Thread(name='one', target=self.pow, args=(True,)) | ||||
|         tTwo = threading.Thread(name='two', target=self.pow, args=(True,)) | ||||
|         tThree = threading.Thread(name='three', target=self.pow, args=(True,)) | ||||
|         tOne.start() | ||||
|         tTwo.start() | ||||
|         tThree.start() | ||||
|         self.mainHash = '0' * 70 | ||||
|         self.puzzle = self.mainHash[0:min(self.difficulty, len(self.mainHash))] | ||||
|          | ||||
|         myCore = core.Core() | ||||
|         for i in range(max(1, threadCount)): | ||||
|             t = threading.Thread(name = 'thread%s' % i, target = self.pow, args = (True,myCore)) | ||||
|             t.start() | ||||
|          | ||||
|         return | ||||
| 
 | ||||
|     def shutdown(self): | ||||
|  | @ -89,9 +88,11 @@ class POW: | |||
|         ''' | ||||
|             Returns the result then sets to false, useful to automatically clear the result | ||||
|         ''' | ||||
|          | ||||
|         try: | ||||
|             retVal = self.result | ||||
|         except AttributeError: | ||||
|             retVal = False | ||||
|              | ||||
|         self.result = False | ||||
|         return retVal | ||||
|  |  | |||
|  | @ -20,6 +20,7 @@ | |||
| # Misc functions that do not fit in the main api, but are useful | ||||
| import getpass, sys, requests, os, socket, hashlib, logger, sqlite3, config, binascii, time, base64, json, glob, shutil, math | ||||
| import nacl.signing, nacl.encoding | ||||
| from onionrblockapi import Block | ||||
| 
 | ||||
| if sys.version_info < (3, 6): | ||||
|     try: | ||||
|  | @ -347,47 +348,41 @@ class OnionrUtils: | |||
|         ''' | ||||
|             Find, decrypt, and return array of PMs (array of dictionary, {from, text}) | ||||
|         ''' | ||||
|         #blocks = self._core.getBlockList() | ||||
|         blocks = self._core.getBlocksByType('pm') | ||||
|         blocks = Block.getBlocks(type = 'pm', core = self._core) | ||||
|         message = '' | ||||
|         sender = '' | ||||
|         for i in blocks: | ||||
|             if len (i) == 0: | ||||
|                 continue | ||||
|             try: | ||||
|                 with open('data/blocks/' + i + '.dat', 'r') as potentialMessage: | ||||
|                     potentialMessage = potentialMessage.read() | ||||
|                     blockMetadata = json.loads(potentialMessage[:potentialMessage.find('\n')]) | ||||
|                     blockContent = potentialMessage[potentialMessage.find('\n') + 1:] | ||||
|                 blockContent = i.getContent() | ||||
| 
 | ||||
|                 try: | ||||
|                     message = self._core._crypto.pubKeyDecrypt(blockContent, encodedData=True, anonymous=True) | ||||
|                 except nacl.exceptions.CryptoError as e: | ||||
|                     pass | ||||
|                 else: | ||||
|                     try: | ||||
|                         message = message.decode() | ||||
|                     except AttributeError: | ||||
|                         pass | ||||
| 
 | ||||
|                     try: | ||||
|                         message = self._core._crypto.pubKeyDecrypt(blockContent, encodedData=True, anonymous=True) | ||||
|                     except nacl.exceptions.CryptoError as e: | ||||
|                         message = json.loads(message) | ||||
|                     except json.decoder.JSONDecodeError: | ||||
|                         pass | ||||
|                     else: | ||||
|                         try: | ||||
|                             message = message.decode() | ||||
|                         except AttributeError: | ||||
|                             pass | ||||
|                         logger.debug('Decrypted %s:' % i.getHash()) | ||||
|                         logger.info(message["msg"]) | ||||
| 
 | ||||
|                         try: | ||||
|                             message = json.loads(message) | ||||
|                         except json.decoder.JSONDecodeError: | ||||
|                             pass | ||||
|                         else: | ||||
|                             logger.info('Decrypted %s:' % i) | ||||
|                             logger.info(message["msg"]) | ||||
|                         signer = message["id"] | ||||
|                         sig = message["sig"] | ||||
| 
 | ||||
|                             signer = message["id"] | ||||
|                             sig = message["sig"] | ||||
| 
 | ||||
|                             if self.validatePubKey(signer): | ||||
|                                 if self._core._crypto.edVerify(message["msg"], signer, sig, encodedData=True): | ||||
|                                     logger.info("Good signature by %s" % signer) | ||||
|                                 else: | ||||
|                                     logger.warn("Bad signature by %s" % signer) | ||||
|                         if self.validatePubKey(signer): | ||||
|                             if self._core._crypto.edVerify(message["msg"], signer, sig, encodedData=True): | ||||
|                                 logger.info("Good signature by %s" % signer) | ||||
|                             else: | ||||
|                                 logger.warn('Bad sender id: %s' % signer) | ||||
|                                 logger.warn("Bad signature by %s" % signer) | ||||
|                         else: | ||||
|                             logger.warn('Bad sender id: %s' % signer) | ||||
| 
 | ||||
|             except FileNotFoundError: | ||||
|                 pass | ||||
|  | @ -475,7 +470,7 @@ class OnionrUtils: | |||
| 
 | ||||
|         sys.stdout.write("\r┣{0}┫ {1}%".format(arrow + spaces, int(round(percent * 100)))) | ||||
|         sys.stdout.flush() | ||||
|      | ||||
| 
 | ||||
|     def getEpoch(self): | ||||
|         '''returns epoch''' | ||||
|         return math.floor(time.time()) | ||||
|  | @ -504,4 +499,4 @@ def humanSize(num, suffix='B'): | |||
|         if abs(num) < 1024.0: | ||||
|             return "%.1f %s%s" % (num, unit, suffix) | ||||
|         num /= 1024.0 | ||||
|     return "%.1f %s%s" % (num, 'Yi', suffix) | ||||
|     return "%.1f %s%s" % (num, 'Yi', suffix) | ||||
|  |  | |||
							
								
								
									
										104
									
								
								onionr/static-data/default-plugins/pluginmanager/.gitignore
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										104
									
								
								onionr/static-data/default-plugins/pluginmanager/.gitignore
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,104 @@ | |||
| # Byte-compiled / optimized / DLL files | ||||
| __pycache__/ | ||||
| *.py[cod] | ||||
| *$py.class | ||||
| 
 | ||||
| # C extensions | ||||
| *.so | ||||
| 
 | ||||
| # Distribution / packaging | ||||
| .Python | ||||
| build/ | ||||
| develop-eggs/ | ||||
| dist/ | ||||
| downloads/ | ||||
| eggs/ | ||||
| .eggs/ | ||||
| lib/ | ||||
| lib64/ | ||||
| parts/ | ||||
| sdist/ | ||||
| var/ | ||||
| wheels/ | ||||
| *.egg-info/ | ||||
| .installed.cfg | ||||
| *.egg | ||||
| MANIFEST | ||||
| 
 | ||||
| # PyInstaller | ||||
| #  Usually these files are written by a python script from a template | ||||
| #  before PyInstaller builds the exe, so as to inject date/other infos into it. | ||||
| *.manifest | ||||
| *.spec | ||||
| 
 | ||||
| # Installer logs | ||||
| pip-log.txt | ||||
| pip-delete-this-directory.txt | ||||
| 
 | ||||
| # Unit test / coverage reports | ||||
| htmlcov/ | ||||
| .tox/ | ||||
| .coverage | ||||
| .coverage.* | ||||
| .cache | ||||
| nosetests.xml | ||||
| coverage.xml | ||||
| *.cover | ||||
| .hypothesis/ | ||||
| .pytest_cache/ | ||||
| 
 | ||||
| # Translations | ||||
| *.mo | ||||
| *.pot | ||||
| 
 | ||||
| # Django stuff: | ||||
| *.log | ||||
| local_settings.py | ||||
| db.sqlite3 | ||||
| 
 | ||||
| # Flask stuff: | ||||
| instance/ | ||||
| .webassets-cache | ||||
| 
 | ||||
| # Scrapy stuff: | ||||
| .scrapy | ||||
| 
 | ||||
| # Sphinx documentation | ||||
| docs/_build/ | ||||
| 
 | ||||
| # PyBuilder | ||||
| target/ | ||||
| 
 | ||||
| # Jupyter Notebook | ||||
| .ipynb_checkpoints | ||||
| 
 | ||||
| # pyenv | ||||
| .python-version | ||||
| 
 | ||||
| # celery beat schedule file | ||||
| celerybeat-schedule | ||||
| 
 | ||||
| # SageMath parsed files | ||||
| *.sage.py | ||||
| 
 | ||||
| # Environments | ||||
| .env | ||||
| .venv | ||||
| env/ | ||||
| venv/ | ||||
| ENV/ | ||||
| env.bak/ | ||||
| venv.bak/ | ||||
| 
 | ||||
| # Spyder project settings | ||||
| .spyderproject | ||||
| .spyproject | ||||
| 
 | ||||
| # Rope project settings | ||||
| .ropeproject | ||||
| 
 | ||||
| # mkdocs documentation | ||||
| /site | ||||
| 
 | ||||
| # mypy | ||||
| .mypy_cache/ | ||||
							
								
								
									
										674
									
								
								onionr/static-data/default-plugins/pluginmanager/LICENSE
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										674
									
								
								onionr/static-data/default-plugins/pluginmanager/LICENSE
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,674 @@ | |||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
| 
 | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> | ||||
|  Everyone is permitted to copy and distribute verbatim copies | ||||
|  of this license document, but changing it is not allowed. | ||||
| 
 | ||||
|                             Preamble | ||||
| 
 | ||||
|   The GNU General Public License is a free, copyleft license for | ||||
| software and other kinds of works. | ||||
| 
 | ||||
|   The licenses for most software and other practical works are designed | ||||
| to take away your freedom to share and change the works.  By contrast, | ||||
| the GNU General Public License is intended to guarantee your freedom to | ||||
| share and change all versions of a program--to make sure it remains free | ||||
| software for all its users.  We, the Free Software Foundation, use the | ||||
| GNU General Public License for most of our software; it applies also to | ||||
| any other work released this way by its authors.  You can apply it to | ||||
| your programs, too. | ||||
| 
 | ||||
|   When we speak of free software, we are referring to freedom, not | ||||
| price.  Our General Public Licenses are designed to make sure that you | ||||
| have the freedom to distribute copies of free software (and charge for | ||||
| them if you wish), that you receive source code or can get it if you | ||||
| want it, that you can change the software or use pieces of it in new | ||||
| free programs, and that you know you can do these things. | ||||
| 
 | ||||
|   To protect your rights, we need to prevent others from denying you | ||||
| these rights or asking you to surrender the rights.  Therefore, you have | ||||
| certain responsibilities if you distribute copies of the software, or if | ||||
| you modify it: responsibilities to respect the freedom of others. | ||||
| 
 | ||||
|   For example, if you distribute copies of such a program, whether | ||||
| gratis or for a fee, you must pass on to the recipients the same | ||||
| freedoms that you received.  You must make sure that they, too, receive | ||||
| or can get the source code.  And you must show them these terms so they | ||||
| know their rights. | ||||
| 
 | ||||
|   Developers that use the GNU GPL protect your rights with two steps: | ||||
| (1) assert copyright on the software, and (2) offer you this License | ||||
| giving you legal permission to copy, distribute and/or modify it. | ||||
| 
 | ||||
|   For the developers' and authors' protection, the GPL clearly explains | ||||
| that there is no warranty for this free software.  For both users' and | ||||
| authors' sake, the GPL requires that modified versions be marked as | ||||
| changed, so that their problems will not be attributed erroneously to | ||||
| authors of previous versions. | ||||
| 
 | ||||
|   Some devices are designed to deny users access to install or run | ||||
| modified versions of the software inside them, although the manufacturer | ||||
| can do so.  This is fundamentally incompatible with the aim of | ||||
| protecting users' freedom to change the software.  The systematic | ||||
| pattern of such abuse occurs in the area of products for individuals to | ||||
| use, which is precisely where it is most unacceptable.  Therefore, we | ||||
| have designed this version of the GPL to prohibit the practice for those | ||||
| products.  If such problems arise substantially in other domains, we | ||||
| stand ready to extend this provision to those domains in future versions | ||||
| of the GPL, as needed to protect the freedom of users. | ||||
| 
 | ||||
|   Finally, every program is threatened constantly by software patents. | ||||
| States should not allow patents to restrict development and use of | ||||
| software on general-purpose computers, but in those that do, we wish to | ||||
| avoid the special danger that patents applied to a free program could | ||||
| make it effectively proprietary.  To prevent this, the GPL assures that | ||||
| patents cannot be used to render the program non-free. | ||||
| 
 | ||||
|   The precise terms and conditions for copying, distribution and | ||||
| modification follow. | ||||
| 
 | ||||
|                        TERMS AND CONDITIONS | ||||
| 
 | ||||
|   0. Definitions. | ||||
| 
 | ||||
|   "This License" refers to version 3 of the GNU General Public License. | ||||
| 
 | ||||
|   "Copyright" also means copyright-like laws that apply to other kinds of | ||||
| works, such as semiconductor masks. | ||||
| 
 | ||||
|   "The Program" refers to any copyrightable work licensed under this | ||||
| License.  Each licensee is addressed as "you".  "Licensees" and | ||||
| "recipients" may be individuals or organizations. | ||||
| 
 | ||||
|   To "modify" a work means to copy from or adapt all or part of the work | ||||
| in a fashion requiring copyright permission, other than the making of an | ||||
| exact copy.  The resulting work is called a "modified version" of the | ||||
| earlier work or a work "based on" the earlier work. | ||||
| 
 | ||||
|   A "covered work" means either the unmodified Program or a work based | ||||
| on the Program. | ||||
| 
 | ||||
|   To "propagate" a work means to do anything with it that, without | ||||
| permission, would make you directly or secondarily liable for | ||||
| infringement under applicable copyright law, except executing it on a | ||||
| computer or modifying a private copy.  Propagation includes copying, | ||||
| distribution (with or without modification), making available to the | ||||
| public, and in some countries other activities as well. | ||||
| 
 | ||||
|   To "convey" a work means any kind of propagation that enables other | ||||
| parties to make or receive copies.  Mere interaction with a user through | ||||
| a computer network, with no transfer of a copy, is not conveying. | ||||
| 
 | ||||
|   An interactive user interface displays "Appropriate Legal Notices" | ||||
| to the extent that it includes a convenient and prominently visible | ||||
| feature that (1) displays an appropriate copyright notice, and (2) | ||||
| tells the user that there is no warranty for the work (except to the | ||||
| extent that warranties are provided), that licensees may convey the | ||||
| work under this License, and how to view a copy of this License.  If | ||||
| the interface presents a list of user commands or options, such as a | ||||
| menu, a prominent item in the list meets this criterion. | ||||
| 
 | ||||
|   1. Source Code. | ||||
| 
 | ||||
|   The "source code" for a work means the preferred form of the work | ||||
| for making modifications to it.  "Object code" means any non-source | ||||
| form of a work. | ||||
| 
 | ||||
|   A "Standard Interface" means an interface that either is an official | ||||
| standard defined by a recognized standards body, or, in the case of | ||||
| interfaces specified for a particular programming language, one that | ||||
| is widely used among developers working in that language. | ||||
| 
 | ||||
|   The "System Libraries" of an executable work include anything, other | ||||
| than the work as a whole, that (a) is included in the normal form of | ||||
| packaging a Major Component, but which is not part of that Major | ||||
| Component, and (b) serves only to enable use of the work with that | ||||
| Major Component, or to implement a Standard Interface for which an | ||||
| implementation is available to the public in source code form.  A | ||||
| "Major Component", in this context, means a major essential component | ||||
| (kernel, window system, and so on) of the specific operating system | ||||
| (if any) on which the executable work runs, or a compiler used to | ||||
| produce the work, or an object code interpreter used to run it. | ||||
| 
 | ||||
|   The "Corresponding Source" for a work in object code form means all | ||||
| the source code needed to generate, install, and (for an executable | ||||
| work) run the object code and to modify the work, including scripts to | ||||
| control those activities.  However, it does not include the work's | ||||
| System Libraries, or general-purpose tools or generally available free | ||||
| programs which are used unmodified in performing those activities but | ||||
| which are not part of the work.  For example, Corresponding Source | ||||
| includes interface definition files associated with source files for | ||||
| the work, and the source code for shared libraries and dynamically | ||||
| linked subprograms that the work is specifically designed to require, | ||||
| such as by intimate data communication or control flow between those | ||||
| subprograms and other parts of the work. | ||||
| 
 | ||||
|   The Corresponding Source need not include anything that users | ||||
| can regenerate automatically from other parts of the Corresponding | ||||
| Source. | ||||
| 
 | ||||
|   The Corresponding Source for a work in source code form is that | ||||
| same work. | ||||
| 
 | ||||
|   2. Basic Permissions. | ||||
| 
 | ||||
|   All rights granted under this License are granted for the term of | ||||
| copyright on the Program, and are irrevocable provided the stated | ||||
| conditions are met.  This License explicitly affirms your unlimited | ||||
| permission to run the unmodified Program.  The output from running a | ||||
| covered work is covered by this License only if the output, given its | ||||
| content, constitutes a covered work.  This License acknowledges your | ||||
| rights of fair use or other equivalent, as provided by copyright law. | ||||
| 
 | ||||
|   You may make, run and propagate covered works that you do not | ||||
| convey, without conditions so long as your license otherwise remains | ||||
| in force.  You may convey covered works to others for the sole purpose | ||||
| of having them make modifications exclusively for you, or provide you | ||||
| with facilities for running those works, provided that you comply with | ||||
| the terms of this License in conveying all material for which you do | ||||
| not control copyright.  Those thus making or running the covered works | ||||
| for you must do so exclusively on your behalf, under your direction | ||||
| and control, on terms that prohibit them from making any copies of | ||||
| your copyrighted material outside their relationship with you. | ||||
| 
 | ||||
|   Conveying under any other circumstances is permitted solely under | ||||
| the conditions stated below.  Sublicensing is not allowed; section 10 | ||||
| makes it unnecessary. | ||||
| 
 | ||||
|   3. Protecting Users' Legal Rights From Anti-Circumvention Law. | ||||
| 
 | ||||
|   No covered work shall be deemed part of an effective technological | ||||
| measure under any applicable law fulfilling obligations under article | ||||
| 11 of the WIPO copyright treaty adopted on 20 December 1996, or | ||||
| similar laws prohibiting or restricting circumvention of such | ||||
| measures. | ||||
| 
 | ||||
|   When you convey a covered work, you waive any legal power to forbid | ||||
| circumvention of technological measures to the extent such circumvention | ||||
| is effected by exercising rights under this License with respect to | ||||
| the covered work, and you disclaim any intention to limit operation or | ||||
| modification of the work as a means of enforcing, against the work's | ||||
| users, your or third parties' legal rights to forbid circumvention of | ||||
| technological measures. | ||||
| 
 | ||||
|   4. Conveying Verbatim Copies. | ||||
| 
 | ||||
|   You may convey verbatim copies of the Program's source code as you | ||||
| receive it, in any medium, provided that you conspicuously and | ||||
| appropriately publish on each copy an appropriate copyright notice; | ||||
| keep intact all notices stating that this License and any | ||||
| non-permissive terms added in accord with section 7 apply to the code; | ||||
| keep intact all notices of the absence of any warranty; and give all | ||||
| recipients a copy of this License along with the Program. | ||||
| 
 | ||||
|   You may charge any price or no price for each copy that you convey, | ||||
| and you may offer support or warranty protection for a fee. | ||||
| 
 | ||||
|   5. Conveying Modified Source Versions. | ||||
| 
 | ||||
|   You may convey a work based on the Program, or the modifications to | ||||
| produce it from the Program, in the form of source code under the | ||||
| terms of section 4, provided that you also meet all of these conditions: | ||||
| 
 | ||||
|     a) The work must carry prominent notices stating that you modified | ||||
|     it, and giving a relevant date. | ||||
| 
 | ||||
|     b) The work must carry prominent notices stating that it is | ||||
|     released under this License and any conditions added under section | ||||
|     7.  This requirement modifies the requirement in section 4 to | ||||
|     "keep intact all notices". | ||||
| 
 | ||||
|     c) You must license the entire work, as a whole, under this | ||||
|     License to anyone who comes into possession of a copy.  This | ||||
|     License will therefore apply, along with any applicable section 7 | ||||
|     additional terms, to the whole of the work, and all its parts, | ||||
|     regardless of how they are packaged.  This License gives no | ||||
|     permission to license the work in any other way, but it does not | ||||
|     invalidate such permission if you have separately received it. | ||||
| 
 | ||||
|     d) If the work has interactive user interfaces, each must display | ||||
|     Appropriate Legal Notices; however, if the Program has interactive | ||||
|     interfaces that do not display Appropriate Legal Notices, your | ||||
|     work need not make them do so. | ||||
| 
 | ||||
|   A compilation of a covered work with other separate and independent | ||||
| works, which are not by their nature extensions of the covered work, | ||||
| and which are not combined with it such as to form a larger program, | ||||
| in or on a volume of a storage or distribution medium, is called an | ||||
| "aggregate" if the compilation and its resulting copyright are not | ||||
| used to limit the access or legal rights of the compilation's users | ||||
| beyond what the individual works permit.  Inclusion of a covered work | ||||
| in an aggregate does not cause this License to apply to the other | ||||
| parts of the aggregate. | ||||
| 
 | ||||
|   6. Conveying Non-Source Forms. | ||||
| 
 | ||||
|   You may convey a covered work in object code form under the terms | ||||
| of sections 4 and 5, provided that you also convey the | ||||
| machine-readable Corresponding Source under the terms of this License, | ||||
| in one of these ways: | ||||
| 
 | ||||
|     a) Convey the object code in, or embodied in, a physical product | ||||
|     (including a physical distribution medium), accompanied by the | ||||
|     Corresponding Source fixed on a durable physical medium | ||||
|     customarily used for software interchange. | ||||
| 
 | ||||
|     b) Convey the object code in, or embodied in, a physical product | ||||
|     (including a physical distribution medium), accompanied by a | ||||
|     written offer, valid for at least three years and valid for as | ||||
|     long as you offer spare parts or customer support for that product | ||||
|     model, to give anyone who possesses the object code either (1) a | ||||
|     copy of the Corresponding Source for all the software in the | ||||
|     product that is covered by this License, on a durable physical | ||||
|     medium customarily used for software interchange, for a price no | ||||
|     more than your reasonable cost of physically performing this | ||||
|     conveying of source, or (2) access to copy the | ||||
|     Corresponding Source from a network server at no charge. | ||||
| 
 | ||||
|     c) Convey individual copies of the object code with a copy of the | ||||
|     written offer to provide the Corresponding Source.  This | ||||
|     alternative is allowed only occasionally and noncommercially, and | ||||
|     only if you received the object code with such an offer, in accord | ||||
|     with subsection 6b. | ||||
| 
 | ||||
|     d) Convey the object code by offering access from a designated | ||||
|     place (gratis or for a charge), and offer equivalent access to the | ||||
|     Corresponding Source in the same way through the same place at no | ||||
|     further charge.  You need not require recipients to copy the | ||||
|     Corresponding Source along with the object code.  If the place to | ||||
|     copy the object code is a network server, the Corresponding Source | ||||
|     may be on a different server (operated by you or a third party) | ||||
|     that supports equivalent copying facilities, provided you maintain | ||||
|     clear directions next to the object code saying where to find the | ||||
|     Corresponding Source.  Regardless of what server hosts the | ||||
|     Corresponding Source, you remain obligated to ensure that it is | ||||
|     available for as long as needed to satisfy these requirements. | ||||
| 
 | ||||
|     e) Convey the object code using peer-to-peer transmission, provided | ||||
|     you inform other peers where the object code and Corresponding | ||||
|     Source of the work are being offered to the general public at no | ||||
|     charge under subsection 6d. | ||||
| 
 | ||||
|   A separable portion of the object code, whose source code is excluded | ||||
| from the Corresponding Source as a System Library, need not be | ||||
| included in conveying the object code work. | ||||
| 
 | ||||
|   A "User Product" is either (1) a "consumer product", which means any | ||||
| tangible personal property which is normally used for personal, family, | ||||
| or household purposes, or (2) anything designed or sold for incorporation | ||||
| into a dwelling.  In determining whether a product is a consumer product, | ||||
| doubtful cases shall be resolved in favor of coverage.  For a particular | ||||
| product received by a particular user, "normally used" refers to a | ||||
| typical or common use of that class of product, regardless of the status | ||||
| of the particular user or of the way in which the particular user | ||||
| actually uses, or expects or is expected to use, the product.  A product | ||||
| is a consumer product regardless of whether the product has substantial | ||||
| commercial, industrial or non-consumer uses, unless such uses represent | ||||
| the only significant mode of use of the product. | ||||
| 
 | ||||
|   "Installation Information" for a User Product means any methods, | ||||
| procedures, authorization keys, or other information required to install | ||||
| and execute modified versions of a covered work in that User Product from | ||||
| a modified version of its Corresponding Source.  The information must | ||||
| suffice to ensure that the continued functioning of the modified object | ||||
| code is in no case prevented or interfered with solely because | ||||
| modification has been made. | ||||
| 
 | ||||
|   If you convey an object code work under this section in, or with, or | ||||
| specifically for use in, a User Product, and the conveying occurs as | ||||
| part of a transaction in which the right of possession and use of the | ||||
| User Product is transferred to the recipient in perpetuity or for a | ||||
| fixed term (regardless of how the transaction is characterized), the | ||||
| Corresponding Source conveyed under this section must be accompanied | ||||
| by the Installation Information.  But this requirement does not apply | ||||
| if neither you nor any third party retains the ability to install | ||||
| modified object code on the User Product (for example, the work has | ||||
| been installed in ROM). | ||||
| 
 | ||||
|   The requirement to provide Installation Information does not include a | ||||
| requirement to continue to provide support service, warranty, or updates | ||||
| for a work that has been modified or installed by the recipient, or for | ||||
| the User Product in which it has been modified or installed.  Access to a | ||||
| network may be denied when the modification itself materially and | ||||
| adversely affects the operation of the network or violates the rules and | ||||
| protocols for communication across the network. | ||||
| 
 | ||||
|   Corresponding Source conveyed, and Installation Information provided, | ||||
| in accord with this section must be in a format that is publicly | ||||
| documented (and with an implementation available to the public in | ||||
| source code form), and must require no special password or key for | ||||
| unpacking, reading or copying. | ||||
| 
 | ||||
|   7. Additional Terms. | ||||
| 
 | ||||
|   "Additional permissions" are terms that supplement the terms of this | ||||
| License by making exceptions from one or more of its conditions. | ||||
| Additional permissions that are applicable to the entire Program shall | ||||
| be treated as though they were included in this License, to the extent | ||||
| that they are valid under applicable law.  If additional permissions | ||||
| apply only to part of the Program, that part may be used separately | ||||
| under those permissions, but the entire Program remains governed by | ||||
| this License without regard to the additional permissions. | ||||
| 
 | ||||
|   When you convey a copy of a covered work, you may at your option | ||||
| remove any additional permissions from that copy, or from any part of | ||||
| it.  (Additional permissions may be written to require their own | ||||
| removal in certain cases when you modify the work.)  You may place | ||||
| additional permissions on material, added by you to a covered work, | ||||
| for which you have or can give appropriate copyright permission. | ||||
| 
 | ||||
|   Notwithstanding any other provision of this License, for material you | ||||
| add to a covered work, you may (if authorized by the copyright holders of | ||||
| that material) supplement the terms of this License with terms: | ||||
| 
 | ||||
|     a) Disclaiming warranty or limiting liability differently from the | ||||
|     terms of sections 15 and 16 of this License; or | ||||
| 
 | ||||
|     b) Requiring preservation of specified reasonable legal notices or | ||||
|     author attributions in that material or in the Appropriate Legal | ||||
|     Notices displayed by works containing it; or | ||||
| 
 | ||||
|     c) Prohibiting misrepresentation of the origin of that material, or | ||||
|     requiring that modified versions of such material be marked in | ||||
|     reasonable ways as different from the original version; or | ||||
| 
 | ||||
|     d) Limiting the use for publicity purposes of names of licensors or | ||||
|     authors of the material; or | ||||
| 
 | ||||
|     e) Declining to grant rights under trademark law for use of some | ||||
|     trade names, trademarks, or service marks; or | ||||
| 
 | ||||
|     f) Requiring indemnification of licensors and authors of that | ||||
|     material by anyone who conveys the material (or modified versions of | ||||
|     it) with contractual assumptions of liability to the recipient, for | ||||
|     any liability that these contractual assumptions directly impose on | ||||
|     those licensors and authors. | ||||
| 
 | ||||
|   All other non-permissive additional terms are considered "further | ||||
| restrictions" within the meaning of section 10.  If the Program as you | ||||
| received it, or any part of it, contains a notice stating that it is | ||||
| governed by this License along with a term that is a further | ||||
| restriction, you may remove that term.  If a license document contains | ||||
| a further restriction but permits relicensing or conveying under this | ||||
| License, you may add to a covered work material governed by the terms | ||||
| of that license document, provided that the further restriction does | ||||
| not survive such relicensing or conveying. | ||||
| 
 | ||||
|   If you add terms to a covered work in accord with this section, you | ||||
| must place, in the relevant source files, a statement of the | ||||
| additional terms that apply to those files, or a notice indicating | ||||
| where to find the applicable terms. | ||||
| 
 | ||||
|   Additional terms, permissive or non-permissive, may be stated in the | ||||
| form of a separately written license, or stated as exceptions; | ||||
| the above requirements apply either way. | ||||
| 
 | ||||
|   8. Termination. | ||||
| 
 | ||||
|   You may not propagate or modify a covered work except as expressly | ||||
| provided under this License.  Any attempt otherwise to propagate or | ||||
| modify it is void, and will automatically terminate your rights under | ||||
| this License (including any patent licenses granted under the third | ||||
| paragraph of section 11). | ||||
| 
 | ||||
|   However, if you cease all violation of this License, then your | ||||
| license from a particular copyright holder is reinstated (a) | ||||
| provisionally, unless and until the copyright holder explicitly and | ||||
| finally terminates your license, and (b) permanently, if the copyright | ||||
| holder fails to notify you of the violation by some reasonable means | ||||
| prior to 60 days after the cessation. | ||||
| 
 | ||||
|   Moreover, your license from a particular copyright holder is | ||||
| reinstated permanently if the copyright holder notifies you of the | ||||
| violation by some reasonable means, this is the first time you have | ||||
| received notice of violation of this License (for any work) from that | ||||
| copyright holder, and you cure the violation prior to 30 days after | ||||
| your receipt of the notice. | ||||
| 
 | ||||
|   Termination of your rights under this section does not terminate the | ||||
| licenses of parties who have received copies or rights from you under | ||||
| this License.  If your rights have been terminated and not permanently | ||||
| reinstated, you do not qualify to receive new licenses for the same | ||||
| material under section 10. | ||||
| 
 | ||||
|   9. Acceptance Not Required for Having Copies. | ||||
| 
 | ||||
|   You are not required to accept this License in order to receive or | ||||
| run a copy of the Program.  Ancillary propagation of a covered work | ||||
| occurring solely as a consequence of using peer-to-peer transmission | ||||
| to receive a copy likewise does not require acceptance.  However, | ||||
| nothing other than this License grants you permission to propagate or | ||||
| modify any covered work.  These actions infringe copyright if you do | ||||
| not accept this License.  Therefore, by modifying or propagating a | ||||
| covered work, you indicate your acceptance of this License to do so. | ||||
| 
 | ||||
|   10. Automatic Licensing of Downstream Recipients. | ||||
| 
 | ||||
|   Each time you convey a covered work, the recipient automatically | ||||
| receives a license from the original licensors, to run, modify and | ||||
| propagate that work, subject to this License.  You are not responsible | ||||
| for enforcing compliance by third parties with this License. | ||||
| 
 | ||||
|   An "entity transaction" is a transaction transferring control of an | ||||
| organization, or substantially all assets of one, or subdividing an | ||||
| organization, or merging organizations.  If propagation of a covered | ||||
| work results from an entity transaction, each party to that | ||||
| transaction who receives a copy of the work also receives whatever | ||||
| licenses to the work the party's predecessor in interest had or could | ||||
| give under the previous paragraph, plus a right to possession of the | ||||
| Corresponding Source of the work from the predecessor in interest, if | ||||
| the predecessor has it or can get it with reasonable efforts. | ||||
| 
 | ||||
|   You may not impose any further restrictions on the exercise of the | ||||
| rights granted or affirmed under this License.  For example, you may | ||||
| not impose a license fee, royalty, or other charge for exercise of | ||||
| rights granted under this License, and you may not initiate litigation | ||||
| (including a cross-claim or counterclaim in a lawsuit) alleging that | ||||
| any patent claim is infringed by making, using, selling, offering for | ||||
| sale, or importing the Program or any portion of it. | ||||
| 
 | ||||
|   11. Patents. | ||||
| 
 | ||||
|   A "contributor" is a copyright holder who authorizes use under this | ||||
| License of the Program or a work on which the Program is based.  The | ||||
| work thus licensed is called the contributor's "contributor version". | ||||
| 
 | ||||
|   A contributor's "essential patent claims" are all patent claims | ||||
| owned or controlled by the contributor, whether already acquired or | ||||
| hereafter acquired, that would be infringed by some manner, permitted | ||||
| by this License, of making, using, or selling its contributor version, | ||||
| but do not include claims that would be infringed only as a | ||||
| consequence of further modification of the contributor version.  For | ||||
| purposes of this definition, "control" includes the right to grant | ||||
| patent sublicenses in a manner consistent with the requirements of | ||||
| this License. | ||||
| 
 | ||||
|   Each contributor grants you a non-exclusive, worldwide, royalty-free | ||||
| patent license under the contributor's essential patent claims, to | ||||
| make, use, sell, offer for sale, import and otherwise run, modify and | ||||
| propagate the contents of its contributor version. | ||||
| 
 | ||||
|   In the following three paragraphs, a "patent license" is any express | ||||
| agreement or commitment, however denominated, not to enforce a patent | ||||
| (such as an express permission to practice a patent or covenant not to | ||||
| sue for patent infringement).  To "grant" such a patent license to a | ||||
| party means to make such an agreement or commitment not to enforce a | ||||
| patent against the party. | ||||
| 
 | ||||
|   If you convey a covered work, knowingly relying on a patent license, | ||||
| and the Corresponding Source of the work is not available for anyone | ||||
| to copy, free of charge and under the terms of this License, through a | ||||
| publicly available network server or other readily accessible means, | ||||
| then you must either (1) cause the Corresponding Source to be so | ||||
| available, or (2) arrange to deprive yourself of the benefit of the | ||||
| patent license for this particular work, or (3) arrange, in a manner | ||||
| consistent with the requirements of this License, to extend the patent | ||||
| license to downstream recipients.  "Knowingly relying" means you have | ||||
| actual knowledge that, but for the patent license, your conveying the | ||||
| covered work in a country, or your recipient's use of the covered work | ||||
| in a country, would infringe one or more identifiable patents in that | ||||
| country that you have reason to believe are valid. | ||||
| 
 | ||||
|   If, pursuant to or in connection with a single transaction or | ||||
| arrangement, you convey, or propagate by procuring conveyance of, a | ||||
| covered work, and grant a patent license to some of the parties | ||||
| receiving the covered work authorizing them to use, propagate, modify | ||||
| or convey a specific copy of the covered work, then the patent license | ||||
| you grant is automatically extended to all recipients of the covered | ||||
| work and works based on it. | ||||
| 
 | ||||
|   A patent license is "discriminatory" if it does not include within | ||||
| the scope of its coverage, prohibits the exercise of, or is | ||||
| conditioned on the non-exercise of one or more of the rights that are | ||||
| specifically granted under this License.  You may not convey a covered | ||||
| work if you are a party to an arrangement with a third party that is | ||||
| in the business of distributing software, under which you make payment | ||||
| to the third party based on the extent of your activity of conveying | ||||
| the work, and under which the third party grants, to any of the | ||||
| parties who would receive the covered work from you, a discriminatory | ||||
| patent license (a) in connection with copies of the covered work | ||||
| conveyed by you (or copies made from those copies), or (b) primarily | ||||
| for and in connection with specific products or compilations that | ||||
| contain the covered work, unless you entered into that arrangement, | ||||
| or that patent license was granted, prior to 28 March 2007. | ||||
| 
 | ||||
|   Nothing in this License shall be construed as excluding or limiting | ||||
| any implied license or other defenses to infringement that may | ||||
| otherwise be available to you under applicable patent law. | ||||
| 
 | ||||
|   12. No Surrender of Others' Freedom. | ||||
| 
 | ||||
|   If conditions are imposed on you (whether by court order, agreement or | ||||
| otherwise) that contradict the conditions of this License, they do not | ||||
| excuse you from the conditions of this License.  If you cannot convey a | ||||
| covered work so as to satisfy simultaneously your obligations under this | ||||
| License and any other pertinent obligations, then as a consequence you may | ||||
| not convey it at all.  For example, if you agree to terms that obligate you | ||||
| to collect a royalty for further conveying from those to whom you convey | ||||
| the Program, the only way you could satisfy both those terms and this | ||||
| License would be to refrain entirely from conveying the Program. | ||||
| 
 | ||||
|   13. Use with the GNU Affero General Public License. | ||||
| 
 | ||||
|   Notwithstanding any other provision of this License, you have | ||||
| permission to link or combine any covered work with a work licensed | ||||
| under version 3 of the GNU Affero General Public License into a single | ||||
| combined work, and to convey the resulting work.  The terms of this | ||||
| License will continue to apply to the part which is the covered work, | ||||
| but the special requirements of the GNU Affero General Public License, | ||||
| section 13, concerning interaction through a network will apply to the | ||||
| combination as such. | ||||
| 
 | ||||
|   14. Revised Versions of this License. | ||||
| 
 | ||||
|   The Free Software Foundation may publish revised and/or new versions of | ||||
| the GNU General Public License from time to time.  Such new versions will | ||||
| be similar in spirit to the present version, but may differ in detail to | ||||
| address new problems or concerns. | ||||
| 
 | ||||
|   Each version is given a distinguishing version number.  If the | ||||
| Program specifies that a certain numbered version of the GNU General | ||||
| Public License "or any later version" applies to it, you have the | ||||
| option of following the terms and conditions either of that numbered | ||||
| version or of any later version published by the Free Software | ||||
| Foundation.  If the Program does not specify a version number of the | ||||
| GNU General Public License, you may choose any version ever published | ||||
| by the Free Software Foundation. | ||||
| 
 | ||||
|   If the Program specifies that a proxy can decide which future | ||||
| versions of the GNU General Public License can be used, that proxy's | ||||
| public statement of acceptance of a version permanently authorizes you | ||||
| to choose that version for the Program. | ||||
| 
 | ||||
|   Later license versions may give you additional or different | ||||
| permissions.  However, no additional obligations are imposed on any | ||||
| author or copyright holder as a result of your choosing to follow a | ||||
| later version. | ||||
| 
 | ||||
|   15. Disclaimer of Warranty. | ||||
| 
 | ||||
|   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | ||||
| APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | ||||
| HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | ||||
| OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | ||||
| THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||||
| PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | ||||
| IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | ||||
| ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | ||||
| 
 | ||||
|   16. Limitation of Liability. | ||||
| 
 | ||||
|   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | ||||
| WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | ||||
| THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | ||||
| GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | ||||
| USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | ||||
| DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | ||||
| PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | ||||
| EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | ||||
| SUCH DAMAGES. | ||||
| 
 | ||||
|   17. Interpretation of Sections 15 and 16. | ||||
| 
 | ||||
|   If the disclaimer of warranty and limitation of liability provided | ||||
| above cannot be given local legal effect according to their terms, | ||||
| reviewing courts shall apply local law that most closely approximates | ||||
| an absolute waiver of all civil liability in connection with the | ||||
| Program, unless a warranty or assumption of liability accompanies a | ||||
| copy of the Program in return for a fee. | ||||
| 
 | ||||
|                      END OF TERMS AND CONDITIONS | ||||
| 
 | ||||
|             How to Apply These Terms to Your New Programs | ||||
| 
 | ||||
|   If you develop a new program, and you want it to be of the greatest | ||||
| possible use to the public, the best way to achieve this is to make it | ||||
| free software which everyone can redistribute and change under these terms. | ||||
| 
 | ||||
|   To do so, attach the following notices to the program.  It is safest | ||||
| to attach them to the start of each source file to most effectively | ||||
| state the exclusion of warranty; and each file should have at least | ||||
| the "copyright" line and a pointer to where the full notice is found. | ||||
| 
 | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
| 
 | ||||
|     This program is free software: you can redistribute it and/or modify | ||||
|     it under the terms of the GNU General Public License as published by | ||||
|     the Free Software Foundation, either version 3 of the License, or | ||||
|     (at your option) any later version. | ||||
| 
 | ||||
|     This program is distributed in the hope that it will be useful, | ||||
|     but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
|     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | ||||
|     GNU General Public License for more details. | ||||
| 
 | ||||
|     You should have received a copy of the GNU General Public License | ||||
|     along with this program.  If not, see <http://www.gnu.org/licenses/>. | ||||
| 
 | ||||
| Also add information on how to contact you by electronic and paper mail. | ||||
| 
 | ||||
|   If the program does terminal interaction, make it output a short | ||||
| notice like this when it starts in an interactive mode: | ||||
| 
 | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | ||||
|     This is free software, and you are welcome to redistribute it | ||||
|     under certain conditions; type `show c' for details. | ||||
| 
 | ||||
| The hypothetical commands `show w' and `show c' should show the appropriate | ||||
| parts of the General Public License.  Of course, your program's commands | ||||
| might be different; for a GUI interface, you would use an "about box". | ||||
| 
 | ||||
|   You should also get your employer (if you work as a programmer) or school, | ||||
| if any, to sign a "copyright disclaimer" for the program, if necessary. | ||||
| For more information on this, and how to apply and follow the GNU GPL, see | ||||
| <http://www.gnu.org/licenses/>. | ||||
| 
 | ||||
|   The GNU General Public License does not permit incorporating your program | ||||
| into proprietary programs.  If your program is a subroutine library, you | ||||
| may consider it more useful to permit linking proprietary applications with | ||||
| the library.  If this is what you want to do, use the GNU Lesser General | ||||
| Public License instead of this License.  But first, please read | ||||
| <http://www.gnu.org/philosophy/why-not-lgpl.html>. | ||||
|  | @ -0,0 +1,2 @@ | |||
| # pluginmanager | ||||
| Onionr's plugin manager source code | ||||
|  | @ -34,9 +34,9 @@ def writeKeys(): | |||
|         Serializes and writes the keystore in memory to file | ||||
|     ''' | ||||
| 
 | ||||
|     file = open(keys_file, 'w') | ||||
|     file.write(json.dumps(keys_data, indent=4, sort_keys=True)) | ||||
|     file.close() | ||||
|     with open(keys_file, 'w') as file: | ||||
|         file.write(json.dumps(keys_data, indent=4, sort_keys=True)) | ||||
|         file.close() | ||||
| 
 | ||||
| def readKeys(): | ||||
|     ''' | ||||
|  | @ -44,7 +44,8 @@ def readKeys(): | |||
|     ''' | ||||
| 
 | ||||
|     global keys_data | ||||
|     keys_data = json.loads(open(keys_file).read()) | ||||
|     with open(keys_file) as file: | ||||
|         keys_data = json.loads(file.read()) | ||||
|     return keys_data | ||||
| 
 | ||||
| def getKey(plugin): | ||||
|  | @ -106,27 +107,37 @@ def getRepositories(): | |||
|     readKeys() | ||||
|     return keys_data['repositories'] | ||||
| 
 | ||||
| def addRepository(repositories, data): | ||||
| def addRepository(blockhash, data): | ||||
|     ''' | ||||
|         Saves the plugin name, to remember that it was installed by the pluginmanager | ||||
|     ''' | ||||
| 
 | ||||
|     global keys_data | ||||
|     readKeys() | ||||
|     keys_data['repositories'][repositories] = data | ||||
|     keys_data['repositories'][blockhash] = data | ||||
|     writeKeys() | ||||
| 
 | ||||
| def removeRepository(repositories): | ||||
| def removeRepository(blockhash): | ||||
|     ''' | ||||
|         Removes the plugin name from the pluginmanager's records | ||||
|     ''' | ||||
| 
 | ||||
|     global keys_data | ||||
|     readKeys() | ||||
|     if plugin in keys_data['repositories']: | ||||
|         del keys_data['repositories'][repositories] | ||||
|     if blockhash in keys_data['repositories']: | ||||
|         del keys_data['repositories'][blockhash] | ||||
|         writeKeys() | ||||
| 
 | ||||
| def createRepository(plugins): | ||||
|     contents = {'plugins' : plugins, 'author' : getpass.getuser(), 'compiled-by' : plugin_name} | ||||
| 
 | ||||
|     block = Block(core = pluginapi.get_core()) | ||||
|      | ||||
|     block.setType('repository') | ||||
|     block.setContent(json.dumps(contents)) | ||||
|      | ||||
|     return block.save(True) | ||||
| 
 | ||||
| def check(): | ||||
|     ''' | ||||
|         Checks to make sure the keystore file still exists | ||||
|  | @ -144,7 +155,7 @@ def sanitize(name): | |||
| 
 | ||||
| def blockToPlugin(block): | ||||
|     try: | ||||
|         block = Block(block) | ||||
|         block = Block(block, core = pluginapi.get_core()) | ||||
|         blockContent = json.loads(block.getContent()) | ||||
| 
 | ||||
|         name = sanitize(blockContent['name']) | ||||
|  | @ -194,14 +205,19 @@ def pluginToBlock(plugin, import_block = True): | |||
|                 shutil.rmtree(directory + '__pycache__') | ||||
| 
 | ||||
|             shutil.make_archive(zipfile[:-4], 'zip', directory) | ||||
|             data = base64.b64encode(open(zipfile, 'rb').read()) | ||||
|             data = '' | ||||
|             with open(zipfile, 'rb') as file: | ||||
|                 data = base64.b64encode(file.read()) | ||||
| 
 | ||||
|             author = getpass.getuser() | ||||
|             description = 'Default plugin description' | ||||
|             info = {"name" : plugin} | ||||
|             try: | ||||
|                 if os.path.exists(directory + 'info.json'): | ||||
|                     info = json.loads(open(directory + 'info.json').read()) | ||||
|                     info = '' | ||||
|                     with open(directory + 'info.json').read() as file: | ||||
|                         info = json.loads(file.read()) | ||||
|                      | ||||
|                     if 'author' in info: | ||||
|                         author = info['author'] | ||||
|                     if 'description' in info: | ||||
|  | @ -211,7 +227,13 @@ def pluginToBlock(plugin, import_block = True): | |||
| 
 | ||||
|             metadata = {'author' : author, 'date' : str(datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')), 'name' : plugin, 'info' : info, 'compiled-by' : plugin_name, 'content' : data.decode('utf-8'), 'description' : description} | ||||
| 
 | ||||
|             hash = pluginapi.get_core().insertBlock(json.dumps(metadata), header = 'plugin', sign = True) | ||||
|             block = Block(core = pluginapi.get_core()) | ||||
|              | ||||
|             block.setType('plugin') | ||||
|             block.setContent(json.dumps(metadata)) | ||||
|              | ||||
|             hash = block.save(True) | ||||
|             # hash = pluginapi.get_core().insertBlock(, header = 'plugin', sign = True) | ||||
| 
 | ||||
|             if import_block: | ||||
|                 pluginapi.get_utils().importNewBlocks() | ||||
|  | @ -226,7 +248,7 @@ def pluginToBlock(plugin, import_block = True): | |||
| 
 | ||||
| def installBlock(block): | ||||
|     try: | ||||
|         block = Block(block) | ||||
|         block = Block(block, core = pluginapi.get_core()) | ||||
|         blockContent = json.loads(block.getContent()) | ||||
| 
 | ||||
|         name = sanitize(blockContent['name']) | ||||
|  | @ -353,7 +375,8 @@ def commandInstallPlugin(): | |||
|                             choice = logger.readline('Select the number of the key to use, from 1 to %s, or press Ctrl+C to cancel:' % (index - 1)) | ||||
| 
 | ||||
|                             try: | ||||
|                                 if int(choice) < index and int(choice) >= 1: | ||||
|                                 choice = int(choice) | ||||
|                                 if choice <= index and choice >= 1: | ||||
|                                     distributor = distributors[int(choice)] | ||||
|                                     valid = True | ||||
|                             except KeyboardInterrupt: | ||||
|  | @ -367,10 +390,12 @@ def commandInstallPlugin(): | |||
|             except Exception as e: | ||||
|                 logger.warn('Failed to lookup plugin in repositories.', timestamp = False) | ||||
|                 logger.error('asdf', error = e, timestamp = False) | ||||
|                  | ||||
|                 return True | ||||
| 
 | ||||
|         if pkobh is None: | ||||
|             logger.error('No key for this plugin found in keystore or repositories, please specify.') | ||||
|             help() | ||||
|             logger.error('No key for this plugin found in keystore or repositories, please specify.', timestamp = False) | ||||
|              | ||||
|             return True | ||||
| 
 | ||||
|         valid_hash = pluginapi.get_utils().validateHash(pkobh) | ||||
|  | @ -386,7 +411,7 @@ def commandInstallPlugin(): | |||
|         blockhash = None | ||||
| 
 | ||||
|         if valid_hash and not real_block: | ||||
|             logger.error('Block hash not found. Perhaps it has not been synced yet?') | ||||
|             logger.error('Block hash not found. Perhaps it has not been synced yet?', timestamp = False) | ||||
|             logger.debug('Is valid hash, but does not belong to a known block.') | ||||
| 
 | ||||
|             return True | ||||
|  | @ -396,7 +421,7 @@ def commandInstallPlugin(): | |||
| 
 | ||||
|             installBlock(blockhash) | ||||
|         elif valid_key and not real_key: | ||||
|             logger.error('Public key not found. Try adding the node by address manually, if possible.') | ||||
|             logger.error('Public key not found. Try adding the node by address manually, if possible.', timestamp = False) | ||||
|             logger.debug('Is valid key, but the key is not a known one.') | ||||
|         elif valid_key and real_key: | ||||
|             publickey = str(pkobh) | ||||
|  | @ -432,10 +457,11 @@ def commandInstallPlugin(): | |||
|                 except Exception as e: | ||||
|                     pass | ||||
| 
 | ||||
|             logger.warn('Only continue the installation is you are absolutely certain that you trust the plugin distributor. Public key of plugin distributor: %s' % publickey, timestamp = False) | ||||
|             logger.warn('Only continue the installation if you are absolutely certain that you trust the plugin distributor. Public key of plugin distributor: %s' % publickey, timestamp = False) | ||||
|             logger.debug('Most recent block matching parameters is %s' % mostRecentVersionBlock) | ||||
|             installBlock(mostRecentVersionBlock) | ||||
|         else: | ||||
|             logger.error('Unknown data "%s"; must be public key or block hash.' % str(pkobh)) | ||||
|             logger.error('Unknown data "%s"; must be public key or block hash.' % str(pkobh), timestamp = False) | ||||
|             return | ||||
|     else: | ||||
|         logger.info(sys.argv[0] + ' ' + sys.argv[1] + ' <plugin> [public key/block hash]') | ||||
|  | @ -463,11 +489,11 @@ def commandAddRepository(): | |||
|         if pluginapi.get_utils().validateHash(blockhash): | ||||
|             if Block.exists(blockhash): | ||||
|                 try: | ||||
|                     blockContent = json.loads(Block(blockhash).getContent()) | ||||
|                     blockContent = json.loads(Block(blockhash, core = pluginapi.get_core()).getContent()) | ||||
| 
 | ||||
|                     pluginslist = dict() | ||||
| 
 | ||||
|                     for pluginname, distributor in blockContent['plugins'].items(): | ||||
|                     for pluginname, distributor in blockContent['plugins']: | ||||
|                         if pluginapi.get_utils().validatePubKey(distributor): | ||||
|                             pluginslist[pluginname] = distributor | ||||
| 
 | ||||
|  | @ -477,14 +503,14 @@ def commandAddRepository(): | |||
|                         addRepository(blockhash, pluginslist) | ||||
|                         logger.info('Successfully added repository.') | ||||
|                     else: | ||||
|                         logger.error('Repository contains no records, not importing.') | ||||
|                         logger.error('Repository contains no records, not importing.', timestamp = False) | ||||
|                 except Exception as e: | ||||
|                     logger.error('Failed to parse block.', error = e) | ||||
|             else: | ||||
|                 logger.error('Block hash not found. Perhaps it has not been synced yet?') | ||||
|                 logger.error('Block hash not found. Perhaps it has not been synced yet?', timestamp = False) | ||||
|                 logger.debug('Is valid hash, but does not belong to a known block.') | ||||
|         else: | ||||
|             logger.error('Unknown data "%s"; must be block hash.' % str(pkobh)) | ||||
|             logger.error('Unknown data "%s"; must be block hash.' % str(pkobh), timestamp = False) | ||||
|     else: | ||||
|         logger.info(sys.argv[0] + ' ' + sys.argv[1] + ' [block hash]') | ||||
| 
 | ||||
|  | @ -500,10 +526,11 @@ def commandRemoveRepository(): | |||
|             if blockhash in getRepositories(): | ||||
|                 try: | ||||
|                     removeRepository(blockhash) | ||||
|                     logger.info('Successfully removed repository.') | ||||
|                 except Exception as e: | ||||
|                     logger.error('Failed to parse block.', error = e) | ||||
|             else: | ||||
|                 logger.error('Repository has not been imported, nothing to remove.') | ||||
|                 logger.error('Repository has not been imported, nothing to remove.', timestamp = False) | ||||
|         else: | ||||
|             logger.error('Unknown data "%s"; must be block hash.' % str(pkobh)) | ||||
|     else: | ||||
|  | @ -525,7 +552,49 @@ def commandPublishPlugin(): | |||
|             logger.error('Plugin %s does not exist.' % pluginname, timestamp = False) | ||||
|     else: | ||||
|         logger.info(sys.argv[0] + ' ' + sys.argv[1] + ' <plugin>') | ||||
| 
 | ||||
|          | ||||
| def commandCreateRepository(): | ||||
|     if len(sys.argv) >= 3: | ||||
|         check() | ||||
|          | ||||
|         plugins = list() | ||||
|         script = sys.argv[0] | ||||
|          | ||||
|         del sys.argv[:2] | ||||
|         success = True | ||||
|         for pluginname in sys.argv: | ||||
|             distributor = None | ||||
|              | ||||
|             if ':' in pluginname: | ||||
|                 split = pluginname.split(':') | ||||
|                 pluginname = split[0] | ||||
|                 distributor = split[1] | ||||
|              | ||||
|             pluginname = sanitize(pluginname) | ||||
|              | ||||
|             if distributor is None: | ||||
|                 distributor = getKey(pluginname) | ||||
|             if distributor is None: | ||||
|                 logger.error('No distributor key was found for the plugin %s.' % pluginname, timestamp = False) | ||||
|                 success = False | ||||
|              | ||||
|             plugins.append([pluginname, distributor]) | ||||
|              | ||||
|         if not success: | ||||
|             logger.error('Please correct the above errors, then recreate the repository.') | ||||
|             return True | ||||
|          | ||||
|         blockhash = createRepository(plugins) | ||||
|         print(blockhash) | ||||
|         if not blockhash is None: | ||||
|             logger.info('Successfully created repository. Execute the following command to add the repository:\n    ' + logger.colors.underline + '%s --add-repository %s' % (script, blockhash)) | ||||
|         else: | ||||
|             logger.error('Failed to create repository, an unknown error occurred.') | ||||
|     else: | ||||
|         logger.info(sys.argv[0] + ' ' + sys.argv[1] + ' [plugins...]') | ||||
|          | ||||
|     return True | ||||
|      | ||||
| # event listeners | ||||
| 
 | ||||
| def on_init(api, data = None): | ||||
|  | @ -540,6 +609,7 @@ def on_init(api, data = None): | |||
|     api.commands.register(['add-repo', 'add-repository', 'addrepo', 'addrepository', 'repository-add', 'repo-add', 'repoadd', 'addrepository', 'add-plugin-repository', 'add-plugin-repo', 'add-pluginrepo', 'add-pluginrepository', 'addpluginrepo', 'addpluginrepository'], commandAddRepository) | ||||
|     api.commands.register(['remove-repo', 'remove-repository', 'removerepo', 'removerepository', 'repository-remove', 'repo-remove', 'reporemove', 'removerepository', 'remove-plugin-repository', 'remove-plugin-repo', 'remove-pluginrepo', 'remove-pluginrepository', 'removepluginrepo', 'removepluginrepository', 'rm-repo', 'rm-repository', 'rmrepo', 'rmrepository', 'repository-rm', 'repo-rm', 'reporm', 'rmrepository', 'rm-plugin-repository', 'rm-plugin-repo', 'rm-pluginrepo', 'rm-pluginrepository', 'rmpluginrepo', 'rmpluginrepository'], commandRemoveRepository) | ||||
|     api.commands.register(['publish-plugin', 'plugin-publish', 'publishplugin', 'pluginpublish', 'publish'], commandPublishPlugin) | ||||
|     api.commands.register(['create-repository', 'create-repo', 'createrepo', 'createrepository', 'repocreate'], commandCreateRepository) | ||||
| 
 | ||||
|     # add help menus once the features are actually implemented | ||||
| 
 | ||||
|  |  | |||
|  | @ -5,6 +5,7 @@ | |||
| 
 | ||||
| # Imports some useful libraries | ||||
| import logger, config | ||||
| from onionrblockapi import Block | ||||
| 
 | ||||
| plugin_name = '$name' | ||||
| 
 | ||||
|  |  | |||
|  | @ -117,6 +117,51 @@ class OnionrTests(unittest.TestCase): | |||
| 
 | ||||
|         self.assertTrue(True) | ||||
| 
 | ||||
|     def testBlockAPI(self): | ||||
|         logger.debug('-'*26 + '\n') | ||||
|         logger.info('Running BlockAPI test #1...') | ||||
| 
 | ||||
|         content = 'Onionr test block' | ||||
| 
 | ||||
|         from onionrblockapi import Block | ||||
|         hash = Block('test', content).save() | ||||
|         block = Block(hash) # test init | ||||
| 
 | ||||
|         if len(Block.getBlocks(type = 'test')) == 0: | ||||
|             logger.warn('Failed to find test block.') | ||||
|             self.assertTrue(False) | ||||
|         if not block.getContent() == content: | ||||
|             logger.warn('Test block content is invalid! (%s != %s)' % (block.getContent(), content)) | ||||
|             self.assertTrue(False) | ||||
|          | ||||
|         logger.debug('-'*26 + '\n') | ||||
|         logger.info('Running BlockAPI test #2...') | ||||
|          | ||||
|         original_content = 'onionr' | ||||
|         contents = [original_content[i:i+2] for i in range(0, len(original_content), 2)] | ||||
|         contents.reverse() | ||||
|          | ||||
|         blocks = list() | ||||
|         parent = None | ||||
|          | ||||
|         for content in contents: | ||||
|             block = Block('test', content) | ||||
|             block.setParent(parent) | ||||
|             parent = block | ||||
|             print('block "%s": %s' % (content, block.save())) | ||||
|             blocks.append(block) | ||||
| 
 | ||||
|         child = blocks[-1] | ||||
|          | ||||
|         merged = Block.merge(child) | ||||
|          | ||||
|         print('merged blocks: %s' % merged) | ||||
|          | ||||
|         if merged != original_content: | ||||
|             self.assertTrue(False) | ||||
|         self.assertTrue(True) | ||||
| 
 | ||||
| 
 | ||||
|     def testBitcoinNode(self): | ||||
|         # temporarily disabled- this takes a lot of time the CI doesn't have | ||||
|         self.assertTrue(True) | ||||
|  | @ -234,6 +279,6 @@ class OnionrTests(unittest.TestCase): | |||
|             else: | ||||
|                 self.assertTrue(False) | ||||
|         else: | ||||
|             self.assertTrue(False) | ||||
|             self.assertTrue(False) # <- annoying :( | ||||
| 
 | ||||
| unittest.main() | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue