├── qwarc ├── version.py ├── const.py ├── cli.py ├── aiohttp.py ├── warc.py ├── utils.py └── __init__.py ├── setup.py ├── README.md └── LICENSE /qwarc/version.py: -------------------------------------------------------------------------------- 1 | import pkg_resources 2 | 3 | 4 | try: 5 | __version__ = pkg_resources.get_distribution(__package__).version 6 | except pkg_resources.DistributionNotFound: 7 | __version__ = None 8 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | 4 | setuptools.setup( 5 | name = 'qwarc', 6 | description = 'A framework for quick web archival', 7 | author = 'JustAnotherArchivist', 8 | url = 'https://github.com/JustAnotherArchivist/qwarc', 9 | classifiers = [ 10 | 'Development Status :: 3 - Alpha', 11 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 12 | 'Programming Language :: Python :: 3.6', 13 | 'Programming Language :: Python :: 3.7', 14 | ], 15 | packages = ['qwarc'], 16 | setup_requires = ['setuptools_scm'], 17 | use_scm_version = True, 18 | install_requires = ['aiohttp==2.3.10', 'warcio', 'yarl'], 19 | entry_points = { 20 | 'console_scripts': [ 21 | 'qwarc = qwarc.cli:main', 22 | ], 23 | }, 24 | ) 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # qwarc 2 | qwarc is a framework for rapidly archiving a large number of URLs with little overhead. This is achieved primarily by using many parallel connections (including across multiple processes) and not employing any HTML parsing or other processing. 3 | 4 | ***Use qwarc responsibly. It can easily overwhelm web servers.*** 5 | 6 | ## License 7 | 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. 8 | 9 | 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. 10 | 11 | You should have received a copy of the GNU General Public License along with this program. If not, see . 12 | -------------------------------------------------------------------------------- /qwarc/const.py: -------------------------------------------------------------------------------- 1 | STATUS_TODO = 0 2 | '''Status of an item that has not been processed yet''' 3 | 4 | STATUS_INPROGRESS = 1 5 | '''Status of an item that is currently being processed''' 6 | 7 | STATUS_DONE = 2 8 | '''Status of an item that has been processed''' 9 | 10 | STATUS_ERROR = 3 11 | '''Status of an item during whose processing an error occurred''' 12 | 13 | ACTION_SUCCESS = 0 14 | '''Treat this response as a success''' 15 | 16 | ACTION_IGNORE = 1 #TODO Replace with ACTION_SUCCESS since it's really the same thing. 17 | '''Ignore this response''' 18 | 19 | ACTION_RETRY = 2 20 | '''Retry the same request''' 21 | 22 | ACTION_FOLLOW_OR_SUCCESS = 3 23 | '''If the response contains a Location or URI header, follow it. Otherwise, treat it as a success.''' 24 | #TODO: Rename to ACTION_FOLLOW maybe? However, the current name makes it more clear what qwarc does when there's a redirect without a redirect target... 25 | 26 | ACTION_RETRIES_EXCEEDED = 4 27 | '''This request failed repeatedly and exceeded the retry limit.''' 28 | -------------------------------------------------------------------------------- /qwarc/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import asyncio 3 | import importlib.util 4 | import logging 5 | import os.path 6 | import qwarc 7 | import qwarc.utils 8 | import qwarc.version 9 | import sys 10 | 11 | 12 | def setup_logging(logFilename): 13 | rootLogger = logging.getLogger() 14 | rootLogger.handlers = [] 15 | rootLogger.setLevel(logging.INFO) 16 | 17 | formatter = qwarc.utils.LogFormatter() 18 | 19 | fileHandler = logging.FileHandler(logFilename) 20 | fileHandler.setFormatter(formatter) 21 | rootLogger.addHandler(fileHandler) 22 | 23 | stderrHandler = logging.StreamHandler() 24 | stderrHandler.setFormatter(formatter) 25 | rootLogger.addHandler(stderrHandler) 26 | 27 | 28 | def check_files(specFilename, logFilename): 29 | success = True 30 | if not os.path.isfile(specFilename): 31 | print(f'Error: "{specFilename}" does not exist or is not a regular file', file = sys.stderr) 32 | success = False 33 | if os.path.exists(logFilename): 34 | print(f'Error: "{logFilename}" already exists', file = sys.stderr) 35 | success = False 36 | if os.path.exists('STOP'): 37 | print('Error: "STOP" exists', file = sys.stderr) 38 | success = False 39 | return success 40 | 41 | 42 | def main(): 43 | parser = argparse.ArgumentParser(formatter_class = argparse.ArgumentDefaultsHelpFormatter) 44 | parser.add_argument('--version', action = 'version', version = f'qwarc {qwarc.version.__version__}') 45 | parser.add_argument('--log', metavar = 'LOGFILE', default = './qwarc.log') 46 | parser.add_argument('--database', metavar = 'DBFILE', default = './qwarc.db') 47 | parser.add_argument('--warc', metavar = 'PREFIX', help = 'prefix for the WARC filenames', default = './qwarc') 48 | parser.add_argument('--concurrency', type = int, default = 1) 49 | parser.add_argument('--memorylimit', metavar = 'LIMIT', type = int, help = 'pause when less than LIMIT bytes memory is free; disable if 0', default = 0) 50 | parser.add_argument('--disklimit', metavar = 'LIMIT', type = int, help = 'pause when less than LIMIT bytes disk space is free; disable if 0', default = 0) 51 | parser.add_argument('--warcsplit', metavar = 'SIZE', type = int, help = 'split WARCs into files of SIZE bytes; disable if 0', default = 0) 52 | parser.add_argument('--warcdedupe', action = 'store_true', help = 'enable deduplication of WARC records') 53 | parser.add_argument('specfile') 54 | 55 | args = parser.parse_args() 56 | 57 | if not check_files(args.specfile, args.log): 58 | sys.exit(1) 59 | 60 | setup_logging(args.log) 61 | 62 | spec = importlib.util.spec_from_file_location('spec', args.specfile) 63 | specMod = importlib.util.module_from_spec(spec) 64 | spec.loader.exec_module(specMod) 65 | specDependencies = specMod.__dict__.get('specDependencies', qwarc.utils.SpecDependencies()) 66 | 67 | a = qwarc.QWARC( 68 | itemClasses = set(qwarc.Item.get_subclasses()), 69 | warcBasePath = args.warc, 70 | dbPath = args.database, 71 | command = sys.argv, 72 | specFile = args.specfile, 73 | specDependencies = specDependencies, 74 | logFilename = args.log, 75 | concurrency = args.concurrency, 76 | memoryLimit = args.memorylimit, 77 | minFreeDisk = args.disklimit, 78 | warcSizeLimit = args.warcsplit, 79 | warcDedupe = args.warcdedupe, 80 | ) 81 | if not os.path.exists(args.database): 82 | a.create_db() 83 | 84 | loop = asyncio.get_event_loop() 85 | try: 86 | loop.run_until_complete(a.run(loop)) 87 | except (Exception, KeyboardInterrupt) as e: 88 | logging.exception('Unhandled error') 89 | loop.close() 90 | -------------------------------------------------------------------------------- /qwarc/aiohttp.py: -------------------------------------------------------------------------------- 1 | import aiohttp 2 | import aiohttp.client_proto 3 | import aiohttp.connector 4 | import functools 5 | import io 6 | import itertools 7 | import qwarc.utils 8 | import time 9 | import tempfile 10 | 11 | 12 | # aiohttp does not expose the raw data sent over the wire, so we need to get a bit creative... 13 | # The ResponseHandler handles received data; the writes are done directly on the underlying transport. 14 | # So ResponseHandler is replaced with a class which keeps all received data in a list, and the transport's write method is replaced with one which sends back all written data to the ResponseHandler. 15 | # Because the ResponseHandler instance disappears when the connection is closed (ClientResponse.{_response_eof,close,release}), ClientResponse copies the references to the data objects in the RequestHandler. 16 | # aiohttp also does connection pooling/reuse, so ClientRequest resets the raw data when the request is sent. (This would not work with pipelining, but aiohttp does not support pipelining: https://github.com/aio-libs/aiohttp/issues/1740 ) 17 | # This code has been developed for aiohttp version 2.3.10. 18 | 19 | 20 | class RawData: 21 | def __init__(self): 22 | self.requestTimestamp = None 23 | self.requestData = tempfile.SpooledTemporaryFile(max_size = 1048576, dir = './') 24 | self.responseTimestamp = None 25 | self.responseData = tempfile.SpooledTemporaryFile(max_size = 1048576, dir = './') 26 | 27 | def close(self): 28 | self.requestData.close() 29 | self.responseData.close() 30 | 31 | 32 | class ResponseHandler(aiohttp.client_proto.ResponseHandler): 33 | def __init__(self, *args, **kwargs): 34 | super().__init__(*args, **kwargs) 35 | self.rawData = None 36 | self.remoteAddress = None 37 | 38 | def data_received(self, data): 39 | super().data_received(data) 40 | if not data: 41 | return 42 | if self.rawData.responseTimestamp is None: 43 | self.rawData.responseTimestamp = time.time() 44 | self.rawData.responseData.seek(0, io.SEEK_END) 45 | self.rawData.responseData.write(data) 46 | 47 | def reset_raw_data(self): 48 | self.rawData = RawData() 49 | 50 | 51 | def make_transport_write(transport, protocol): 52 | transport._real_write = transport.write 53 | def write(self, data): 54 | if protocol.rawData.requestTimestamp is None: 55 | protocol.rawData.requestTimestamp = time.time() 56 | protocol.rawData.requestData.seek(0, io.SEEK_END) 57 | protocol.rawData.requestData.write(data) 58 | self._real_write(data) 59 | return write 60 | 61 | 62 | class TCPConnector(aiohttp.connector.TCPConnector): 63 | def __init__(self, *args, loop = None, **kwargs): 64 | super().__init__(*args, loop = loop, **kwargs) 65 | self._factory = functools.partial(ResponseHandler, loop = loop) 66 | 67 | async def _wrap_create_connection(self, protocolFactory, host, port, *args, **kwargs): #FIXME: Uses internal API 68 | transport, protocol = await super()._wrap_create_connection(protocolFactory, host, port, *args, **kwargs) 69 | transport.write = make_transport_write(transport, protocol).__get__(transport, type(transport)) # https://stackoverflow.com/a/28127947 70 | protocol.remoteAddress = (host, port) 71 | return (transport, protocol) 72 | 73 | 74 | class ClientRequest(aiohttp.client_reqrep.ClientRequest): 75 | def send(self, connection): 76 | connection.protocol.reset_raw_data() 77 | return super().send(connection) 78 | 79 | 80 | class ClientResponse(aiohttp.client_reqrep.ClientResponse): 81 | def __init__(self, *args, **kwargs): 82 | super().__init__(*args, **kwargs) 83 | self._rawData = None 84 | self._remoteAddress = None 85 | 86 | async def start(self, connection, readUntilEof): 87 | self._rawData = connection.protocol.rawData 88 | self._remoteAddress = connection.protocol.remoteAddress 89 | return (await super().start(connection, readUntilEof)) 90 | 91 | @property 92 | def rawRequestTimestamp(self): 93 | return self._rawData.requestTimestamp 94 | 95 | @property 96 | def rawRequestData(self): 97 | return qwarc.utils.ReadonlyFileView(self._rawData.requestData) 98 | 99 | @property 100 | def rawResponseTimestamp(self): 101 | return self._rawData.responseTimestamp 102 | 103 | @property 104 | def rawResponseData(self): 105 | return qwarc.utils.ReadonlyFileView(self._rawData.responseData) 106 | 107 | @property 108 | def remoteAddress(self): 109 | return self._remoteAddress 110 | 111 | def set_history(self, history): 112 | self._history = history #FIXME: Uses private attribute of aiohttp.client_reqrep.ClientResponse 113 | 114 | def iter_all(self): 115 | return itertools.chain(self.history, (self,)) 116 | 117 | async def _read(self, nbytes = None): 118 | #FIXME: This uses internal undocumented APIs of aiohttp 119 | payload = Payload() 120 | self._rawData.responseData.seek(0) 121 | beginning = self._rawData.responseData.read(32768) # Headers must fit into 32 KiB. That's more than most clients out there, but aiohttp does *not* have this restriction! 122 | pos = beginning.find(b'\r\n\r\n') 123 | assert pos > -1, 'Could not find end of headers' 124 | respMsg = aiohttp.http_parser.HttpResponseParserPy().parse_message(beginning[:pos + 2].split(b'\r\n')) 125 | try: 126 | length = int(self.headers.get('Content-Length')) 127 | except (KeyError, ValueError, TypeError): 128 | length = None 129 | parser = aiohttp.http_parser.HttpPayloadParser(payload, length = length, chunked = respMsg.chunked, compression = respMsg.compression, code = respMsg.code, method = self.method) 130 | while beginning.endswith(b'0\r\n') or beginning.endswith(b'0\r\n\r'): # https://github.com/aio-libs/aiohttp/issues/4630 131 | chunk4630 = self._rawData.responseData.read(1024) 132 | if not chunk4630: 133 | break 134 | beginning = beginning + chunk4630 135 | eof, data = parser.feed_data(beginning[pos + 4:]) 136 | while True: 137 | chunk = self._rawData.responseData.read(1048576) 138 | if not chunk: 139 | break 140 | while chunk.endswith(b'0\r\n') or chunk.endswith(b'0\r\n\r'): # https://github.com/aio-libs/aiohttp/issues/4630 141 | chunk4630 = self._rawData.responseData.read(1024) 142 | if not chunk4630: 143 | break 144 | chunk = chunk + chunk4630 145 | eof, data = parser.feed_data(chunk) 146 | if nbytes is not None and payload.data.tell() >= nbytes: 147 | if payload.exc: 148 | raise Exception from payload.exc 149 | return payload.data.getvalue()[:nbytes] 150 | # data can only not be None if eof is True, so there is no need to actually do anything about it 151 | if eof: 152 | break 153 | if not eof: 154 | parser.feed_eof() 155 | 156 | if payload.exc: 157 | raise Exception from payload.exc 158 | if nbytes is not None: 159 | return payload.data.getvalue()[:nbytes] 160 | return payload.data.getvalue() 161 | 162 | async def read(self, nbytes = None): 163 | ''' 164 | Read up to nbytes from the response payload, or the entire response if nbytes is None. 165 | Note that this method always starts from the beginning of the response even if called repeatedly. 166 | ''' 167 | #FIXME: Uses internal aiohttp attribute _content 168 | if nbytes is not None: 169 | if self._content is not None: 170 | return self._content[:nbytes] 171 | return (await self._read(nbytes)) 172 | if self._content is None: 173 | self._content = await self._read() 174 | return self._content 175 | 176 | async def release(self): 177 | if not self.closed: 178 | self.connection.reset_raw_data() 179 | await super().release() 180 | 181 | def __del__(self): 182 | if self._rawData: 183 | self._rawData.close() 184 | super().__del__() 185 | 186 | 187 | class Payload: 188 | # A class implementing the minimal subset used by the HttpPayloadParser to retrieve the data 189 | def __init__(self): 190 | self.data = io.BytesIO() 191 | self.exc = None 192 | 193 | def feed_data(self, data, size): 194 | self.data.write(data) 195 | 196 | def feed_eof(self): 197 | pass 198 | 199 | def set_exception(self, exc): 200 | self.exc = exc 201 | 202 | def begin_http_chunk_receiving(self): 203 | pass 204 | 205 | def end_http_chunk_receiving(self): 206 | pass 207 | -------------------------------------------------------------------------------- /qwarc/warc.py: -------------------------------------------------------------------------------- 1 | import fcntl 2 | import gzip 3 | import io 4 | import itertools 5 | import json 6 | import logging 7 | import os 8 | import qwarc.utils 9 | import tempfile 10 | import time 11 | import warcio 12 | 13 | 14 | class WARC: 15 | def __init__(self, prefix, maxFileSize, dedupe, command, specFile, specDependencies, logFilename): 16 | ''' 17 | Initialise the WARC writer 18 | 19 | prefix: str, path prefix for WARCs; a dash, a five-digit number, and ".warc.gz" will be appended. 20 | maxFileSize: int, maximum size of an individual WARC. Use 0 to disable splitting. 21 | dedupe: bool, whether to enable record deduplication 22 | command: list, the command line call for qwarc 23 | specFile: str, path to the spec file 24 | specDependencies: qwarc.utils.SpecDependencies 25 | logFilename: str, name of the log file written by this process 26 | ''' 27 | 28 | self._prefix = prefix 29 | self._counter = 0 30 | self._maxFileSize = maxFileSize 31 | 32 | self._closed = True 33 | self._file = None 34 | self._warcWriter = None 35 | 36 | self._dedupe = dedupe 37 | self._dedupeMap = {} 38 | 39 | self._command = command 40 | self._specFile = specFile 41 | self._specDependencies = specDependencies 42 | 43 | self._logFilename = logFilename 44 | 45 | self._metaWarcinfoRecordID = None 46 | self._write_meta_warc(self._write_initial_meta_records) 47 | 48 | def _ensure_opened(self): 49 | '''Open the next file that doesn't exist yet if there is currently no file opened''' 50 | 51 | if not self._closed: 52 | return 53 | while True: 54 | filename = f'{self._prefix}-{self._counter:05d}.warc.gz' 55 | try: 56 | # Try to open the file for writing, requiring that it does not exist yet, and attempt to get an exclusive, non-blocking lock on it 57 | self._file = open(filename, 'xb') 58 | fcntl.flock(self._file.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB) 59 | except FileExistsError: 60 | logging.info(f'{filename} already exists, skipping') 61 | self._counter += 1 62 | else: 63 | break 64 | logging.info(f'Opened {filename}') 65 | self._warcWriter = warcio.warcwriter.WARCWriter(self._file, gzip = True, warc_version = '1.1') 66 | self._closed = False 67 | self._counter += 1 68 | 69 | def _write_warcinfo_record(self): 70 | data = { 71 | 'software': qwarc.utils.get_software_info(self._specFile, self._specDependencies), 72 | 'command': self._command, 73 | 'files': { 74 | 'spec': self._specFile, 75 | 'spec-dependencies': self._specDependencies.files 76 | }, 77 | 'extra': self._specDependencies.extra, 78 | } 79 | payload = io.BytesIO(json.dumps(data, indent = 2).encode('utf-8')) 80 | # Workaround for https://github.com/webrecorder/warcio/issues/87 81 | digester = warcio.utils.Digester('sha1') 82 | digester.update(payload.getvalue()) 83 | record = self._warcWriter.create_warc_record( 84 | None, 85 | 'warcinfo', 86 | payload = payload, 87 | warc_headers_dict = {'Content-Type': 'application/json; charset=utf-8', 'WARC-Block-Digest': str(digester)}, 88 | length = len(payload.getvalue()), 89 | ) 90 | self._warcWriter.write_record(record) 91 | return record.rec_headers.get_header('WARC-Record-ID') 92 | 93 | def write_client_response(self, response): 94 | ''' 95 | Write the requests and responses stored in a ClientResponse instance to the currently opened WARC. 96 | A new WARC will be started automatically if the size of the current file exceeds the limit after writing all requests and responses from this `response` to the current WARC. 97 | ''' 98 | 99 | self._ensure_opened() 100 | for r in response.iter_all(): 101 | usec = f'{(r.rawRequestTimestamp - int(r.rawRequestTimestamp)):.6f}'[2:] 102 | requestDate = time.strftime(f'%Y-%m-%dT%H:%M:%S.{usec}Z', time.gmtime(r.rawRequestTimestamp)) 103 | r.rawRequestData.seek(0, io.SEEK_END) 104 | length = r.rawRequestData.tell() 105 | r.rawRequestData.seek(0) 106 | requestRecord = self._warcWriter.create_warc_record( 107 | str(r.url), 108 | 'request', 109 | payload = r.rawRequestData, 110 | length = length, 111 | warc_headers_dict = { 112 | 'WARC-Date': requestDate, 113 | 'WARC-IP-Address': r.remoteAddress[0], 114 | 'WARC-Warcinfo-ID': self._metaWarcinfoRecordID, 115 | } 116 | ) 117 | requestRecordID = requestRecord.rec_headers.get_header('WARC-Record-ID') 118 | r.rawResponseData.seek(0, io.SEEK_END) 119 | length = r.rawResponseData.tell() 120 | r.rawResponseData.seek(0) 121 | responseRecord = self._warcWriter.create_warc_record( 122 | str(r.url), 123 | 'response', 124 | payload = r.rawResponseData, 125 | length = length, 126 | warc_headers_dict = { 127 | 'WARC-Date': requestDate, 128 | 'WARC-IP-Address': r.remoteAddress[0], 129 | 'WARC-Concurrent-To': requestRecordID, 130 | 'WARC-Warcinfo-ID': self._metaWarcinfoRecordID, 131 | } 132 | ) 133 | payloadDigest = responseRecord.rec_headers.get_header('WARC-Payload-Digest') 134 | assert payloadDigest is not None 135 | if self._dedupe and responseRecord.payload_length > 100: # Don't deduplicate small responses; the additional headers are typically larger than the payload dedupe savings... 136 | if payloadDigest in self._dedupeMap: 137 | refersToRecordId, refersToUri, refersToDate = self._dedupeMap[payloadDigest] 138 | responseHttpHeaders = responseRecord.http_headers 139 | responseRecord = self._warcWriter.create_revisit_record( 140 | str(r.url), 141 | digest = payloadDigest, 142 | refers_to_uri = refersToUri, 143 | refers_to_date = refersToDate, 144 | http_headers = responseHttpHeaders, 145 | warc_headers_dict = { 146 | 'WARC-Date': requestDate, 147 | 'WARC-IP-Address': r.remoteAddress[0], 148 | 'WARC-Concurrent-To': requestRecordID, 149 | 'WARC-Refers-To': refersToRecordId, 150 | 'WARC-Truncated': 'length', 151 | 'WARC-Warcinfo-ID': self._metaWarcinfoRecordID, 152 | } 153 | ) 154 | # Workaround for https://github.com/webrecorder/warcio/issues/94 155 | responseRecord.rec_headers.replace_header('WARC-Profile', 'http://netpreserve.org/warc/1.1/revisit/identical-payload-digest') 156 | else: 157 | self._dedupeMap[payloadDigest] = (responseRecord.rec_headers.get_header('WARC-Record-ID'), str(r.url), requestDate) 158 | self._warcWriter.write_record(requestRecord) 159 | self._warcWriter.write_record(responseRecord) 160 | 161 | if self._maxFileSize and self._file.tell() > self._maxFileSize: 162 | self._close_file() 163 | 164 | def _write_resource_records(self): 165 | '''Write spec file and dependencies''' 166 | assert self._metaWarcinfoRecordID is not None, 'write_warcinfo_record must be called first' 167 | 168 | for type_, contentType, fn in itertools.chain((('specfile', 'application/x-python', self._specFile),), map(lambda x: ('spec-dependency-file', 'application/octet-stream', x), self._specDependencies.files)): 169 | with open(fn, 'rb') as f: 170 | f.seek(0, io.SEEK_END) 171 | length = f.tell() 172 | f.seek(0) 173 | record = self._warcWriter.create_warc_record( 174 | f'file://{fn}', 175 | 'resource', 176 | payload = f, 177 | length = length, 178 | warc_headers_dict = {'X-QWARC-Type': type_, 'WARC-Warcinfo-ID': self._metaWarcinfoRecordID, 'Content-Type': contentType}, 179 | ) 180 | self._warcWriter.write_record(record) 181 | 182 | def _write_initial_meta_records(self): 183 | self._metaWarcinfoRecordID = self._write_warcinfo_record() 184 | self._write_resource_records() 185 | 186 | def _write_log_record(self): 187 | assert self._metaWarcinfoRecordID is not None, 'write_warcinfo_record must be called first' 188 | 189 | rootLogger = logging.getLogger() 190 | for handler in rootLogger.handlers: #FIXME: Uses undocumented attribute handlers 191 | handler.flush() 192 | with open(self._logFilename, 'rb') as fp: 193 | fp.seek(0, io.SEEK_END) 194 | length = fp.tell() 195 | fp.seek(0) 196 | record = self._warcWriter.create_warc_record( 197 | f'file://{self._logFilename}', 198 | 'resource', 199 | payload = fp, 200 | length = length, 201 | warc_headers_dict = {'X-QWARC-Type': 'log', 'Content-Type': 'text/plain; charset=utf-8', 'WARC-Warcinfo-ID': self._metaWarcinfoRecordID}, 202 | ) 203 | self._warcWriter.write_record(record) 204 | 205 | def _close_file(self): 206 | '''Close the currently opened WARC''' 207 | 208 | if not self._closed: 209 | self._file.close() 210 | self._warcWriter = None 211 | self._file = None 212 | self._closed = True 213 | 214 | def _write_meta_warc(self, callback): 215 | filename = f'{self._prefix}-meta.warc.gz' 216 | #TODO: Handle OSError on fcntl.flock and retry 217 | self._file = open(filename, 'ab') 218 | try: 219 | fcntl.flock(self._file.fileno(), fcntl.LOCK_EX) 220 | logging.info(f'Opened {filename}') 221 | self._warcWriter = warcio.warcwriter.WARCWriter(self._file, gzip = True, warc_version = '1.1') 222 | self._closed = False 223 | 224 | callback() 225 | finally: 226 | self._close_file() 227 | 228 | def close(self): 229 | '''Clean up everything.''' 230 | self._close_file() 231 | self._write_meta_warc(self._write_log_record) 232 | -------------------------------------------------------------------------------- /qwarc/utils.py: -------------------------------------------------------------------------------- 1 | from qwarc.const import * 2 | import aiohttp 3 | import asyncio 4 | import functools 5 | import logging 6 | import os 7 | import pkg_resources 8 | import platform 9 | import time 10 | import typing 11 | 12 | 13 | PAGESIZE = os.sysconf('SC_PAGE_SIZE') 14 | 15 | 16 | def get_rss(): 17 | '''Get the current RSS of this process in bytes''' 18 | 19 | with open('/proc/self/statm', 'r') as fp: 20 | return int(fp.readline().split()[1]) * PAGESIZE 21 | 22 | 23 | def get_disk_free(): 24 | '''Get the current free disk space on the relevant partition in bytes''' 25 | 26 | st = os.statvfs('.') 27 | return st.f_bavail * st.f_frsize 28 | 29 | 30 | def uses_too_much_memory(limit): 31 | ''' 32 | Check whether the process is using too much memory 33 | 34 | For performance reasons, this actually only checks the memory usage on every 100th call. 35 | ''' 36 | 37 | uses_too_much_memory.callCounter += 1 38 | # Only check every hundredth call 39 | if uses_too_much_memory.callCounter % 100 == 0 and get_rss() > limit: 40 | return True 41 | return False 42 | uses_too_much_memory.callCounter = 0 43 | 44 | 45 | def too_little_disk_space(limit): 46 | ''' 47 | Check whether the disk space is too small 48 | 49 | For performance reasons, this actually only checks the free disk space on every 100th call. 50 | ''' 51 | 52 | too_little_disk_space.callCounter += 1 53 | if too_little_disk_space.callCounter % 100 == 0: 54 | too_little_disk_space.currentResult = (get_disk_free() < limit) 55 | return too_little_disk_space.currentResult 56 | too_little_disk_space.callCounter = 0 57 | too_little_disk_space.currentResult = False 58 | 59 | 60 | # https://stackoverflow.com/a/4665027 61 | def find_all(aStr, sub): 62 | '''Generator yielding the start positions of every non-overlapping occurrence of sub in aStr.''' 63 | 64 | start = 0 65 | while True: 66 | start = aStr.find(sub, start) 67 | if start == -1: 68 | return 69 | yield start 70 | start += len(sub) 71 | 72 | 73 | def str_get_between(aStr, a, b): 74 | '''Get the string after the first occurrence of a in aStr and the first occurrence of b after that of a, or None if there is no such string.''' 75 | 76 | aPos = aStr.find(a) 77 | if aPos == -1: 78 | return None 79 | offset = aPos + len(a) 80 | bPos = aStr.find(b, offset) 81 | if bPos == -1: 82 | return None 83 | return aStr[offset:bPos] 84 | 85 | 86 | def maybe_str_get_between(x, a, b): 87 | '''Like str_get_between, but returns None if x evaluates to False and converts it to a str before matching.''' 88 | 89 | if x: 90 | return str_get_between(str(x), a, b) 91 | 92 | 93 | def str_get_all_between(aStr, a, b): 94 | '''Generator yielding every string between occurrences of a in aStr and the following occurrence of b.''' 95 | 96 | #TODO: This produces half-overlapping matches: str_get_all_between('aabc', 'a', 'c') will yield 'ab' and 'b'. 97 | # Might need to implement sending an offset to the find_all generator to work around this, or discard aOffset values which are smaller than the previous bPos+len(b). 98 | 99 | for aOffset in find_all(aStr, a): 100 | offset = aOffset + len(a) 101 | bPos = aStr.find(b, offset) 102 | if bPos != -1: 103 | yield aStr[offset:bPos] 104 | 105 | 106 | def maybe_str_get_all_between(x, a, b): 107 | '''Like str_get_all_between, but yields no elements if x evaluates to False and converts x to a str before matching.''' 108 | 109 | if x: 110 | yield from str_get_all_between(str(x), a, b) 111 | 112 | 113 | def generate_range_items(start, stop, step): 114 | ''' 115 | Generator for items of `step` size between `start` and `stop` (inclusive) 116 | Yields strings of the form `'a-b'` where `a` and `b` are integers such that `b - a + 1 == step`, `min(a) == start`, and `max(b) == stop`. 117 | `b - a + 1` may be unequal to `step` on the last item if `(stop - start + 1) % step != 0` (see examples below). 118 | Note that `a` and `b` can be equal on the last item if `(stop - start) % step == 0` (see examples below). 119 | 120 | Examples: 121 | - generate_range_items(0, 99, 10) yields '0-9', '10-19', '20-29', ..., '90-99' 122 | - generate_range_items(0, 42, 10): '0-9', '10-19', '20-29', '30-39', '40-42' 123 | - generate_range_items(0, 20, 10): '0-9', '10-19', '20-20' 124 | ''' 125 | 126 | for i in range(start, stop + 1, step): 127 | yield f'{i}-{min(i + step - 1, stop)}' 128 | 129 | 130 | async def handle_response_default(url, attempt, response, exc): 131 | ''' 132 | The default response handler, which behaves as follows: 133 | - If there is no response (e.g. timeout error), retry the retrieval after a delay of 5 seconds. 134 | - If the response has any of the status codes 401, 403, 404, 405, or 410, treat it as a permanent error and return. 135 | - If there was any exception and it is a asyncio.TimeoutError or a aiohttp.ClientError, treat as a potentially temporary error and retry the retrieval after a delay of 5 seconds. 136 | - If the response has any of the status codes 200, 204, 206, or 304, treat it as a success and return. 137 | - If the response has any of the status codes 301, 302, 303, 307, or 308, follow the redirect target if specified or return otherwise. 138 | - Otherwise, treat as a potentially temporary error and retry the retrieval after a delay of 5 seconds. 139 | 140 | - All responses are written to WARC by default. 141 | 142 | Note that this handler does not limit the number of retries on errors. 143 | 144 | Parameters: url (yarl.URL instance), attempt (int), response (aiohttp.ClientResponse or None), exc (Exception or None) 145 | At least one of response and exc is not None. 146 | Returns: (one of the qwarc.RESPONSE_* constants, bool signifying whether to write to WARC or not) 147 | The latter is ignored when exc is not None; responses that triggered an exception are never written to WARC. 148 | ''' 149 | 150 | #TODO: Document that `attempt` is reset on redirects 151 | 152 | if response is None: 153 | await asyncio.sleep(5) 154 | return ACTION_RETRY, True 155 | if response.status in (401, 403, 404, 405, 410): 156 | return ACTION_IGNORE, True 157 | if exc is not None: 158 | if isinstance(exc, (asyncio.TimeoutError, aiohttp.ClientError)): 159 | await asyncio.sleep(5) 160 | return ACTION_RETRY, False # Don't write to WARC since there might be an incomplete response 161 | if response.status in (200, 204, 206, 304): 162 | return ACTION_SUCCESS, True 163 | if response.status in (301, 302, 303, 307, 308): 164 | return ACTION_FOLLOW_OR_SUCCESS, True 165 | await asyncio.sleep(5) 166 | return ACTION_RETRY, True 167 | 168 | 169 | async def handle_response_ignore_redirects(url, attempt, response, exc): 170 | '''A response handler that does not follow redirects, i.e. treats them as a success instead. It behaves as handle_response_default otherwise.''' 171 | 172 | action, writeToWarc = await handle_response_default(url, attempt, response, exc) 173 | if action == ACTION_FOLLOW_OR_SUCCESS: 174 | action = ACTION_SUCCESS 175 | return action, writeToWarc 176 | 177 | 178 | def handle_response_limit_error_retries(maxRetries, handler = handle_response_default): 179 | '''A response handler that limits the number of retries on errors. It behaves as handler otherwise, which defaults to handle_response_default. 180 | 181 | Technically, this is actually a response handler factory. This is so that the intuitive use works: fetch(..., responseHandler = handle_response_limit_error_retries(5)) 182 | 183 | If you use the same limit many times, you should keep the return value (the response handler) of this method and reuse it to avoid creating a new function every time. 184 | ''' 185 | 186 | async def _handler(url, attempt, response, exc): 187 | action, writeToWarc = await handler(url, attempt, response, exc) 188 | if action == ACTION_RETRY and attempt > maxRetries: 189 | action = ACTION_RETRIES_EXCEEDED 190 | return action, writeToWarc 191 | return _handler 192 | 193 | 194 | def _get_dependency_versions(*pkgs): 195 | pending = set(pkgs) 196 | have = set(pkgs) 197 | while pending: 198 | key = pending.pop() 199 | try: 200 | dist = pkg_resources.get_distribution(key) 201 | except pkg_resources.DistributionNotFound: 202 | logging.error(f'Unable to get distribution {key}') 203 | continue 204 | yield dist.key, dist.version 205 | for requirement in dist.requires(): 206 | if requirement.key not in have: 207 | pending.add(requirement.key) 208 | have.add(requirement.key) 209 | 210 | 211 | @functools.lru_cache(maxsize = 1) 212 | def get_software_info(specFile, specDependencies): 213 | # Based on crocoite.utils, authored by PromyLOPh in commit 6ccd72ab on 2018-12-08 under MIT licence 214 | baseDependencyPackageVersions = list(_get_dependency_versions(__package__)) 215 | baseDependencyPackages = set(x[0] for x in baseDependencyPackageVersions) 216 | specDependencyPackageVersions = list(_get_dependency_versions(*specDependencies.packages)) 217 | return { 218 | 'platform': platform.platform(), 219 | 'python': { 220 | 'implementation': platform.python_implementation(), 221 | 'version': platform.python_version(), 222 | 'build': platform.python_build(), 223 | }, 224 | 'self': [{"package": package, "version": version} for package, version in baseDependencyPackageVersions], 225 | 'spec': [{"package": package, "version": version} for package, version in specDependencyPackageVersions if package not in baseDependencyPackages], 226 | } 227 | 228 | 229 | class LogFormatter(logging.Formatter): 230 | def __init__(self): 231 | super().__init__('%(asctime)s.%(msecs)03dZ %(levelname)s %(itemString)s %(message)s', datefmt = '%Y-%m-%d %H:%M:%S') 232 | self.converter = time.gmtime 233 | 234 | def format(self, record): 235 | if not hasattr(record, 'itemString'): 236 | if hasattr(record, 'itemType') and hasattr(record, 'itemValue'): 237 | record.itemString = f'{record.itemType}:{record.itemValue}' 238 | else: 239 | record.itemString = 'None' 240 | return super().format(record) 241 | 242 | 243 | class SpecDependencies(typing.NamedTuple): 244 | packages: tuple = () 245 | files: tuple = () 246 | extra: typing.Any = None 247 | 248 | 249 | class ReadonlyFileView: 250 | ''' 251 | A poor read-only view for a file object. It hides the writing methods and passes everything else through to the underlying file object. Note that this does *not* actually prevent modification at all. 252 | ''' 253 | 254 | def __init__(self, fp): 255 | self._fp = fp 256 | 257 | def __getattr__(self, key): 258 | if key in ('write', 'writelines', 'truncate'): 259 | raise AttributeError 260 | if key == 'writable': 261 | return False 262 | return getattr(self._fp, key) 263 | -------------------------------------------------------------------------------- /qwarc/__init__.py: -------------------------------------------------------------------------------- 1 | import qwarc.aiohttp 2 | from qwarc.const import * 3 | import qwarc.utils 4 | import qwarc.warc 5 | 6 | 7 | import aiohttp as _aiohttp 8 | if _aiohttp.__version__ != '2.3.10': 9 | raise ImportError('aiohttp must be version 2.3.10') 10 | import asyncio 11 | import collections 12 | import concurrent.futures 13 | import io 14 | import itertools 15 | import logging 16 | import os 17 | import random 18 | import sqlite3 19 | import yarl 20 | 21 | 22 | class Item: 23 | itemType = None 24 | 25 | def __init__(self, qwarcObj, itemValue, session, headers, warc): 26 | self.qwarcObj = qwarcObj 27 | self.itemValue = itemValue 28 | self.session = session 29 | self.headers = headers 30 | self.warc = warc 31 | self.stats = {'tx': 0, 'rx': 0, 'requests': 0} 32 | self.logger = logging.LoggerAdapter(logging.getLogger(), {'itemType': self.itemType, 'itemValue': self.itemValue}) 33 | 34 | self.childItems = [] 35 | 36 | async def fetch(self, url, responseHandler = qwarc.utils.handle_response_default, method = 'GET', data = None, headers = [], verify_ssl = True): 37 | ''' 38 | HTTP GET or POST a URL 39 | 40 | url: str or yarl.URL 41 | responseHandler: a callable that determines how the response is handled. See qwarc.utils.handle_response_default for details. 42 | method: str, must be 'GET' or 'POST' 43 | data: dict or list/tuple of lists/tuples of length two or bytes or file-like or None, the data to be sent in the request body 44 | headers: list of 2-tuples, additional headers for this request only 45 | 46 | Returns response (a ClientResponse object or None) and history (a tuple of (response, exception) tuples). 47 | response can be None and history can be an empty tuple, depending on the circumstances (e.g. timeouts). 48 | ''' 49 | 50 | #TODO: Rewrite using 'async with self.session.get' 51 | 52 | url = yarl.URL(url) # Explicitly convert for normalisation, percent-encoding, etc. 53 | assert method in ('GET', 'POST'), 'method must be GET or POST' 54 | headers = self.headers + headers 55 | #TODO Deduplicate headers with later values overriding earlier ones 56 | history = [] 57 | attempt = 0 58 | #TODO redirectLevel 59 | while True: 60 | attempt += 1 61 | response = None 62 | exc = None 63 | action = ACTION_RETRY 64 | writeToWarc = True 65 | try: 66 | try: 67 | with _aiohttp.Timeout(60): 68 | self.logger.info(f'Fetching {url}') 69 | response = await self.session.request(method, url, data = data, headers = headers, allow_redirects = False, verify_ssl = verify_ssl) 70 | try: 71 | while True: 72 | ret = await response.content.read(1048576) 73 | if not ret: 74 | break 75 | except: 76 | # No calling the handleResponse callback here because this is really bad. The not-so-bad exceptions (e.g. an error during reading the response) will be caught further down. 77 | response.close() 78 | raise 79 | else: 80 | response.rawRequestData.seek(0, io.SEEK_END) 81 | tx = response.rawRequestData.tell() 82 | response.rawResponseData.seek(0, io.SEEK_END) 83 | rx = response.rawResponseData.tell() 84 | self.logger.info(f'Fetched {url}: {response.status} (tx {tx}, rx {rx})') 85 | self.stats['tx'] += tx 86 | self.stats['rx'] += rx 87 | self.stats['requests'] += 1 88 | except (asyncio.TimeoutError, _aiohttp.ClientError) as e: 89 | self.logger.warning(f'Request for {url} failed: {e!r}') 90 | action, writeToWarc = await responseHandler(url, attempt, response, e) 91 | exc = e # Pass the exception outward for the history 92 | else: 93 | action, writeToWarc = await responseHandler(url, attempt, response, None) 94 | if response and exc is None and writeToWarc: 95 | self.warc.write_client_response(response) 96 | history.append((response, exc)) 97 | retResponse = response if exc is None else None 98 | if action in (ACTION_SUCCESS, ACTION_IGNORE): 99 | return retResponse, tuple(history) 100 | elif action == ACTION_FOLLOW_OR_SUCCESS: 101 | redirectUrl = response.headers.get('Location') or response.headers.get('URI') 102 | if not redirectUrl: 103 | return retResponse, tuple(history) 104 | url = url.join(yarl.URL(redirectUrl)) 105 | if response.status in (301, 302, 303) and method == 'POST': 106 | method = 'GET' 107 | data = None 108 | attempt = 0 109 | elif action == ACTION_RETRIES_EXCEEDED: 110 | self.logger.error(f'Request for {url} failed {attempt} times') 111 | return retResponse, tuple(history) 112 | elif action == ACTION_RETRY: 113 | # Nothing to do, just go to the next cycle 114 | pass 115 | finally: 116 | if response: 117 | await response.release() 118 | 119 | async def process(self): 120 | raise NotImplementedError 121 | 122 | @classmethod 123 | def generate(cls): 124 | yield from () # Generate no items by default 125 | 126 | @classmethod 127 | def _gen(cls): 128 | for x in cls.generate(): 129 | yield (cls.itemType, x, STATUS_TODO) 130 | 131 | def add_subitem(self, itemClassOrType, itemValue): 132 | if issubclass(itemClassOrType, Item): 133 | item = (itemClassOrType.itemType, itemValue) 134 | else: 135 | item = (itemClassOrType, itemValue) 136 | if item not in self.childItems: 137 | self.childItems.append(item) 138 | 139 | async def flush_subitems(self): 140 | await self.qwarcObj.flush_subitems(self) 141 | 142 | def clear_subitems(self): 143 | self.childItems = [] 144 | 145 | @classmethod 146 | def get_subclasses(cls): 147 | for subclass in cls.__subclasses__(): 148 | yield subclass 149 | yield from subclass.get_subclasses() 150 | 151 | 152 | class QWARC: 153 | def __init__(self, itemClasses, warcBasePath, dbPath, command, specFile, specDependencies, logFilename, concurrency = 1, memoryLimit = 0, minFreeDisk = 0, warcSizeLimit = 0, warcDedupe = False): 154 | ''' 155 | itemClasses: iterable of Item 156 | warcBasePath: str, base name of the WARC files 157 | dbPath: str, path to the sqlite3 database file 158 | command: list, the command line used to invoke qwarc 159 | specFile: str, path to the spec file 160 | specDependencies: qwarc.utils.SpecDependencies 161 | logFilename: str, name of the log file written by this process 162 | concurrency: int, number of concurrently processed items 163 | memoryLimit: int, gracefully stop when the process uses more than memoryLimit bytes of RSS; 0 disables the memory check 164 | minFreeDisk: int, pause when there's less than minFreeDisk space on the partition where WARCs are written; 0 disables the disk space check 165 | warcSizeLimit: int, size of each WARC file; 0 if the WARCs should not be split 166 | ''' 167 | 168 | self._itemClasses = itemClasses 169 | self._itemTypeMap = {cls.itemType: cls for cls in itemClasses} 170 | self._warcBasePath = warcBasePath 171 | self._dbPath = dbPath 172 | self._command = command 173 | self._specFile = specFile 174 | self._specDependencies = specDependencies 175 | self._logFilename = logFilename 176 | self._concurrency = concurrency 177 | self._memoryLimit = memoryLimit 178 | self._minFreeDisk = minFreeDisk 179 | self._warcSizeLimit = warcSizeLimit 180 | self._warcDedupe = warcDedupe 181 | 182 | self._reset_working_vars() 183 | 184 | def _reset_working_vars(self): 185 | # Working variables 186 | self._db = None 187 | self._tasks = set() 188 | self._sleepTasks = set() 189 | self._sessions = [] # aiohttp.ClientSession instances 190 | self._freeSessions = collections.deque() # ClientSession instances that are currently free 191 | self._warc = None 192 | 193 | async def obtain_exclusive_db_lock(self): 194 | c = self._db.cursor() 195 | while True: 196 | try: 197 | c.execute('BEGIN EXCLUSIVE') 198 | break 199 | except sqlite3.OperationalError as e: 200 | if str(e) != 'database is locked': 201 | raise 202 | await asyncio.sleep(1) 203 | return c 204 | 205 | def _make_item(self, itemType, itemValue, session, headers): 206 | try: 207 | itemClass = self._itemTypeMap[itemType] 208 | except KeyError: 209 | raise RuntimeError(f'No such item type: {itemType!r}') 210 | return itemClass(self, itemValue, session, headers, self._warc) 211 | 212 | async def _wait_for_free_task(self): 213 | if not self._tasks: 214 | return 215 | done, pending = await asyncio.wait(self._tasks, return_when = concurrent.futures.FIRST_COMPLETED) 216 | for future in done: 217 | newStatus = STATUS_DONE 218 | if future.taskType == 'sleep': 219 | self._sleepTasks.remove(future) 220 | elif future.taskType == 'process': 221 | item = future.item 222 | # TODO Replace all of this with `if future.cancelled():` 223 | try: 224 | await future #TODO: Is this actually necessary? asyncio.wait only returns 'done' futures... 225 | except concurrent.futures.CancelledError as e: 226 | # Got cancelled, nothing we can do about it, but let's log a warning if it's a process task 227 | if future.taskType == 'process': 228 | logging.error(f'Task for {future.itemType}:{future.itemValue} cancelled: {future!r}') 229 | newStatus = STATUS_ERROR 230 | except Exception as e: 231 | if future.taskType == 'process': 232 | logging.error(f'{future.itemType}:{future.itemValue} failed: {e!r} ({item.stats["requests"]} requests, {item.stats["tx"]} tx, {item.stats["rx"]} rx)', exc_info = e) 233 | newStatus = STATUS_ERROR 234 | else: 235 | if future.taskType == 'process': 236 | logging.info(f'{future.itemType}:{future.itemValue} done: {item.stats["requests"]} requests, {item.stats["tx"]} tx, {item.stats["rx"]} rx') 237 | if future.taskType != 'process': 238 | continue 239 | cursor = await self.obtain_exclusive_db_lock() 240 | try: 241 | cursor.execute('UPDATE items SET status = ? WHERE id = ?', (newStatus, future.id)) 242 | cursor.execute('COMMIT') 243 | except: 244 | cursor.execute('ROLLBACK') 245 | raise 246 | await self._insert_subitems(item) 247 | self._freeSessions.append(item.session) 248 | self._tasks = pending 249 | 250 | async def _insert_subitems(self, item): 251 | cursor = await self.obtain_exclusive_db_lock() 252 | try: 253 | if item.childItems: 254 | it = iter(item.childItems) 255 | while True: 256 | values = [(t, v, STATUS_TODO) for t, v in itertools.islice(it, 100000)] 257 | if not values: 258 | break 259 | cursor.executemany('INSERT OR IGNORE INTO items (type, value, status) VALUES (?, ?, ?)', values) 260 | cursor.execute('COMMIT') 261 | except: 262 | cursor.execute('ROLLBACK') 263 | raise 264 | 265 | async def run(self, loop): 266 | headers = [('User-Agent', 'Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0')] #TODO: Move elsewhere 267 | 268 | for i in range(self._concurrency): 269 | session = _aiohttp.ClientSession( 270 | connector = qwarc.aiohttp.TCPConnector(loop = loop), 271 | request_class = qwarc.aiohttp.ClientRequest, 272 | response_class = qwarc.aiohttp.ClientResponse, 273 | skip_auto_headers = ['Accept-Encoding'], 274 | loop = loop 275 | ) 276 | self._sessions.append(session) 277 | self._freeSessions.append(session) 278 | 279 | self._warc = qwarc.warc.WARC(self._warcBasePath, self._warcSizeLimit, self._warcDedupe, self._command, self._specFile, self._specDependencies, self._logFilename) 280 | 281 | self._db = sqlite3.connect(self._dbPath, timeout = 1) 282 | self._db.isolation_level = None # Transactions are handled manually below. 283 | self._db.execute('PRAGMA synchronous = OFF') 284 | 285 | try: 286 | while True: 287 | while len(self._tasks) >= self._concurrency: 288 | await self._wait_for_free_task() 289 | 290 | if os.path.exists('STOP'): 291 | logging.info('Gracefully shutting down due to STOP file') 292 | break 293 | if self._memoryLimit and qwarc.utils.uses_too_much_memory(self._memoryLimit): 294 | logging.info(f'Gracefully shutting down due to memory usage (current = {qwarc.utils.get_rss()} > limit = {self._memoryLimit})') 295 | break 296 | 297 | if self._minFreeDisk and qwarc.utils.too_little_disk_space(self._minFreeDisk): 298 | logging.info('Disk space is low, sleeping') 299 | sleepTask = asyncio.ensure_future(asyncio.sleep(random.uniform(self._concurrency / 2, self._concurrency * 1.5))) 300 | sleepTask.taskType = 'sleep' 301 | self._tasks.add(sleepTask) 302 | self._sleepTasks.add(sleepTask) 303 | continue 304 | 305 | cursor = await self.obtain_exclusive_db_lock() 306 | try: 307 | cursor.execute('SELECT id, type, value, status FROM items WHERE status = ? LIMIT 1', (STATUS_TODO,)) 308 | result = cursor.fetchone() 309 | if not result: 310 | if cursor.execute('SELECT id, status FROM items WHERE status != ? LIMIT 1', (STATUS_DONE,)).fetchone(): 311 | # There is currently no item to do, but there are still some in progress, so more TODOs may appear in the future. 312 | # It would be nice if we could just await wait_for_free_task() here, but that doesn't work because those TODOs might be in another process. 313 | # So instead, we insert a dummy task which just sleeps a bit. Average sleep time is equal to concurrency, i.e. one check per second. 314 | #TODO: The average sleep time is too large if there are only few sleep tasks; scale with len(sleepTasks)/self._concurrency? 315 | sleepTask = asyncio.ensure_future(asyncio.sleep(random.uniform(self._concurrency / 2, self._concurrency * 1.5))) 316 | sleepTask.taskType = 'sleep' 317 | self._tasks.add(sleepTask) 318 | self._sleepTasks.add(sleepTask) 319 | cursor.execute('COMMIT') 320 | continue 321 | else: 322 | # Really nothing to do anymore 323 | #TODO: Another process may be running create_db, in which case we'd still want to wait... 324 | # create_db could insert a dummy item which is marked as done when the DB is ready 325 | cursor.execute('COMMIT') 326 | break 327 | id, itemType, itemValue, status = result 328 | cursor.execute('UPDATE items SET status = ? WHERE id = ?', (STATUS_INPROGRESS, id)) 329 | cursor.execute('COMMIT') 330 | except: 331 | cursor.execute('ROLLBACK') 332 | raise 333 | 334 | session = self._freeSessions.popleft() 335 | item = self._make_item(itemType, itemValue, session, headers) 336 | task = asyncio.ensure_future(item.process()) 337 | #TODO: Is there a better way to add custom information to a task/coroutine object? 338 | task.taskType = 'process' 339 | task.id = id 340 | task.itemType = itemType 341 | task.itemValue = itemValue 342 | task.item = item 343 | self._tasks.add(task) 344 | 345 | for sleepTask in self._sleepTasks: 346 | sleepTask.cancel() 347 | 348 | while len(self._tasks): 349 | await self._wait_for_free_task() 350 | 351 | logging.info('Done') 352 | except (Exception, KeyboardInterrupt) as e: 353 | # Kill all tasks 354 | for task in self._tasks: 355 | task.cancel() 356 | await asyncio.wait(self._tasks, return_when = concurrent.futures.ALL_COMPLETED) 357 | 358 | raise 359 | finally: 360 | for session in self._sessions: 361 | session.close() 362 | self._warc.close() 363 | self._db.close() 364 | 365 | self._reset_working_vars() 366 | 367 | async def flush_subitems(self, item): 368 | await self._insert_subitems(item) 369 | item.clear_subitems() 370 | 371 | def create_db(self): 372 | db = sqlite3.connect(self._dbPath, timeout = 1) 373 | db.execute('PRAGMA synchronous = OFF') 374 | with db: 375 | db.execute('CREATE TABLE items (id INTEGER PRIMARY KEY, type TEXT, value TEXT, status INTEGER)') 376 | db.execute('CREATE INDEX items_status_idx ON items (status)') 377 | db.execute('CREATE UNIQUE INDEX items_type_value_idx ON items (type, value)') 378 | 379 | it = itertools.chain(*(i._gen() for i in self._itemClasses)) 380 | while True: 381 | values = tuple(itertools.islice(it, 100000)) 382 | if not values: 383 | break 384 | with db: 385 | db.executemany('INSERT INTO items (type, value, status) VALUES (?, ?, ?)', values) 386 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------