view bin/warc.py @ 60:7b68c3ebc35a

tests 1 & 2 now working
author Henry S. Thompson <ht@inf.ed.ac.uk>
date Thu, 13 Jul 2023 14:02:02 +0100
parents 5d40d7511374
children f182d09ad1cd
line wrap: on
line source

#!/usr/bin/env python3
'''Stream a warc format file, unzipping if necessary, invoking a
callback on each record.  Callback can be limited by WARC-Type, record
part'''

import sys,io
from isal import igzip

def warc(filename,callback,types=['response'],whole=False,parts=7,debug=False):
  types=[(t if isinstance(t,bytes) else bytes(t,'utf8')) for t in types]
  nb=0
  if filename.endswith(".gz"):
    stream=igzip.IGzipFile(filename=filename)
  else:
    stream=open(filename,'rb',0)
  bufSize=2*1024*1024
  hdrMax=16*1024
  buf=bytearray(bufSize)
  bufView=memoryview(buf)
  fpos=bl=stream.readinto(buf)
  bp=0
  done=False
  while True:
    while buf.startswith(b'\r\n',bp): # will Fail if buffer (nearly) empty 
      bp+=2
    start_1=bp
    if not buf.startswith(b'WARC/1.0\r\n',bp):
      if done and bl-bp==0:
        # really done
        return
      raise ValueError("Not a WARC file? At %s: %s[%s]"%(bp,
                       buf[bp:min(bl,bp+20)].decode('latin-1'), bl-bp))
    bp+=10
    wtype=None
    length=None
    state=1
    tr=None # Was this record truncated?
    while not buf.startswith(b'\r\n',bp):
      # there should always be enough in the buffer to complete this loop,
      #  because of the buffer update logic below
      eol=buf.index(b'\r\n',bp)+2
      if buf.startswith(b"Content-Length: ",bp):
        length=wl=int(bufView[bp+16:eol-2])
      elif buf.startswith(b"WARC-Truncated: ",bp):
        if bp+16==eol-2:
          tr=b"EMPTY"
        else:
          tr=bytes(bufView[bp+16:eol-2])
      elif buf.startswith(b'WARC-Type: ',bp):
        if buf.startswith(b's',bp+13):
          wtype = b'response'
        elif buf.startswith(b'q',bp+13):
          wtype = b'request'
        elif buf.startswith(b'm',bp+11):
          wtype = b'metadata'
        elif buf.startswith(b'w',bp+11):
          wtype = b'warcinfo'
        else:
          raise ValueError("Unknown WARC-Type: %s at %s"%(
                             bytes(bufView[bp+11:eol-2]),
                             fpos-(bl-bp)))
      bp=eol
    bp=eol+2
    if done:
      if (bp+length)>bl:
        raise ValueError("Done but need more! %s + %s > %s"%(bp,
                         length,bl))
    elif (bp+(length+hdrMax))>bl:
      # Need more data
      if wtype in types:
        # we need to keep from start_1 to bl
        keepFrom=start_1
        keepLen=bl-keepFrom
        buf[0:keepLen]=bufView[keepFrom:bl]
        eol=eol-start_1
        start_1=0
        bp=eol+2
      else:
        # we can skip the rest of this part
        if (bp+length)<=bl:
          # we have at least some bytes from the next part
          keepLen=bl-(bp+length)
          buf[0:keepLen]=bufView[bl-keepLen:bl]
        else:
          # we don't have all of the bytes from the current part
          #  so can skip the rest of it
          keepLen=0
          fpos=stream.seek(fpos+(bp+length-bl))
        bp=0
      spaceToFill=bufSize-keepLen
      with memoryview(buf)[keepLen:bufSize] as xBuf:
        nb=stream.readinto(xBuf)
      fpos+=nb
      bl=keepLen+nb
      if nb<spaceToFill:
        done=True
      if wtype not in types:
        continue
    if (wtype in types):
      if whole:
        pass # buf[bp:(bp:=bp+ln)]=l @fixme
      elif (parts & 1):
        OUT=callback(wtype,bufView[start_1:eol],1)
      if parts!=1:
        # everything from bv= goes here
        pass
    bp+=length
    print('end of loop',wtype,start_1,bp,eol,length,bl,file=sys.stderr)
    #while not buf.startswith(b'\r\n',bp):
    continue
    bv=memoryview(buf)[start_2:start_2+length]
    ii=0
    while True and not stream.closed:
      if (i:=stream.readinto(bv))==0:
        break
      ii+=i
      if ii>=length:
        break
      bv=memoryview(buf)[start_2+ii:start_2+length]
    if ii!=length:
      raise ValueError("Chunk read losing, from %s got %s expected %s"%(nb,ii,length))
    nb+=length
    if wtype in types:
      if whole:
        callback(wtype,bufView[0:start_2+length],7)
        continue
      # Only output parts (1 = WARC header, 2 = HTTP header, 4 = body) that are wanted
      bl=None # for HTTP Content-Length for the length of the body?
      L_start=start_2
      state=2
      bv=memoryview(buf)[start_2:start_2+length]
      with io.BytesIO(bv) as rec_text:
        for L in rec_text:
          if state==2:
            # HTTP header
            wl -= len(L)
            if not (L==b"" or L.startswith(b"\r")):
              # Non-empty, it's (a continuation of) a header
              if bl is None and L.startswith(b"Content-Length: "):
                bl=int(L[16:].rstrip())
            else:
              # Blank line, HTTP header is finished
              if parts & 2:
                callback(wtype,bufView[start_2:start_2+L_start],2)
              state=4
              # The above is just for sanity, because we do _not_
              #  continue with the outer loop,
              #  since we can now block-output the entire rest of the
              #  input buffer.
              if bl is not None:
                if bl!=wl:
                  print("length mismatch: %s %s %s here: %s given: %s trunc: %s"%\
                        (length,offset,filename,wl,bl,tr),file=sys.stderr)
              # HTTP body
              balance=start_2+rec_text.tell()
              #print(balance,bl,wl,ll,ll-balance,file=sys.stderr)
              # Output whatever is left
              if parts & 4:
                callback(wtype,bufView[balance:balance+wl],4)
              state=1
              
          L_start=rec_text.tell()