def clean(request):
"""HTTP Cloud Function.
Args:
request (flask.Request): The request object.
<http://flask.pocoo.org/docs/1.0/api/#flask.Request>
Returns:
The response text, or any set of values that can be turned into a
Response object using `make_response`
<http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
"""
# Wait for an HTTP POST request.
if request.method == 'POST':
# Get request JSON.
print("POST RECEIVED")
request_dict = request.get_json()
print('Received Sigfox message: {}'.format(request_dict))
# Get data and Sigfox Sequence Number.
header_bytes = int(request_dict["header_bytes"])
profile = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
bitmap = ''
BUCKET_NAME = config.BUCKET_NAME
for i in range(2**profile.N - 1):
bitmap += '0'
for i in range(2**profile.M):
upload_blob(BUCKET_NAME, bitmap,
"all_windows/window_%d/bitmap_%d" % (i, i))
upload_blob(BUCKET_NAME, bitmap,
"all_windows/window_%d/losses_mask_%d" % (i, i))
if exists_blob(BUCKET_NAME, "Reassembled_message"):
delete_blob(BUCKET_NAME, "Reassembled_message")
return '', 204
def http_reassemble(request):
# Wait for an HTTP POST request.
if request.method == 'POST':
# Get request JSON.
print("[REASSEMBLE] POST RECEIVED")
request_dict = request.get_json()
print('Received HTTP message: {}'.format(request_dict))
current_window = int(request_dict["current_window"])
last_index = int(request_dict["last_index"])
header_bytes = int(request_dict["header_bytes"])
# Initialize Cloud Storage variables.
# BUCKET_NAME = 'sigfoxschc'
# BUCKET_NAME = 'wyschc-niclabs'
BUCKET_NAME = config.BUCKET_NAME
# Initialize SCHC variables.
profile_uplink = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
n = profile_uplink.N
# Find the index of the first empty blob:
print("[REASSEMBLE] Reassembling...")
# Get all the fragments into an array in the format "fragment = [header, payload]"
fragments = []
# TODO: This assumes that the last received message is in the last window.
for i in range(current_window + 1):
for j in range(2**n - 1):
print("Loading fragment {}".format(j))
fragment_file = read_blob(
BUCKET_NAME,
"all_windows/window_%d/fragment_%d_%d" % (i, i, j))
print(fragment_file)
ultimate_header = fragment_file[:header_bytes]
ultimate_payload = fragment_file[header_bytes:]
ultimate_fragment = [
ultimate_header.encode(),
ultimate_payload.encode()
]
fragments.append(ultimate_fragment)
if i == current_window and j == last_index:
break
# Instantiate a Reassembler and start reassembling.
reassembler = Reassembler(profile_uplink, fragments)
payload = bytearray(reassembler.reassemble())
# Upload the full message.
upload_blob(BUCKET_NAME, payload.decode("utf-8"), "Reassembled_Packet")
return '', 204
def test_from_hex(self):
ack = ACK.parse_from_hex(Sigfox("UPLINK", "ACK ON ERROR", 1),
"07ff800000000000")
self.assertEqual(
ack.to_string(),
"0000011111111111100000000000000000000000000000000000000000000000")
self.assertEqual(ack.rule_id, "00")
self.assertEqual(ack.dtag, "0")
self.assertEqual(ack.w, "00")
self.assertEqual(ack.c, "1")
self.assertTrue(ack.is_receiver_abort())
def test_is_all_1(self):
profile = Sigfox("UPLINK", "ACK ON ERROR", 1)
rule_id = "0" * profile.RULE_ID_SIZE
dtag = "0" * profile.T
w = "0" * profile.M
fcn = "1" * profile.N
header = bitstring_to_bytes(rule_id + dtag + w + fcn)
payload = bytearray.fromhex("3131313231333134313531")
fragment = Fragment(profile, [header, payload])
self.assertTrue(fragment.is_all_1())
def test_from_hex(self):
profile = Sigfox("UPLINK", "ACK ON ERROR", 1)
h = "0f08000000000000"
ack = ACK.parse_from_hex(profile, h)
self.assertEqual(
ack.to_string(),
"0000111100001000000000000000000000000000000000000000000000000000")
self.assertEqual(ack.rule_id, "00")
self.assertEqual(ack.dtag, "0")
self.assertEqual(ack.w, "01")
self.assertEqual(ack.c, "1")
self.assertEqual(ack.bitmap, "1100001")
self.assertTrue(is_monochar(ack.padding) and ack.padding[0] == '0')
def test_init(self):
hex_data = "053131313231333134313531"
header = bytes.fromhex(hex_data[:2])
payload = bytearray.fromhex(hex_data[2:])
data = [header, payload]
profile = Sigfox("UPLINK", "ACK ON ERROR", 1)
fragment = Fragment(profile, data)
abort = ReceiverAbort(profile, fragment.header)
self.assertEqual(type(abort.profile), Sigfox)
self.assertEqual(abort.rule_id, fragment.header.RULE_ID)
self.assertEqual(abort.dtag, fragment.header.DTAG)
self.assertEqual(abort.w, fragment.header.W)
self.assertEqual(len(abort.to_string()), 64)
self.assertTrue(issubclass(type(abort), ACK))
self.assertTrue(abort.is_receiver_abort())
def test_receive(self):
profile = Sigfox("UPLINK", "ACK ON ERROR", 1)
ack = "0000111111111111100000000000000000000000000000000000000000000000"
ack_index_dtag = profile.RULE_ID_SIZE
ack_index_w = ack_index_dtag + profile.T
ack_index_c = ack_index_w + profile.M
ack_index_bitmap = ack_index_c + 1
ack_index_padding = ack_index_bitmap + profile.BITMAP_SIZE
received_ack = ACK(profile,
rule_id=ack[:ack_index_dtag],
dtag=ack[ack_index_dtag:ack_index_w],
w=ack[ack_index_w:ack_index_c],
c=ack[ack_index_c],
bitmap=ack[ack_index_bitmap:ack_index_padding],
padding=ack[ack_index_padding:])
self.assertTrue(received_ack.is_receiver_abort())
def test_init(self):
hex_data = "053131313231333134313531"
header = bytes.fromhex(hex_data[:2])
payload = bytearray.fromhex(hex_data[2:])
data = [header, payload]
profile = Sigfox("UPLINK", "ACK ON ERROR", 1)
fragment = Fragment(profile, data)
abort = SenderAbort(profile, fragment.header)
self.assertEqual(type(abort.profile), Sigfox)
self.assertEqual(abort.header.RULE_ID, fragment.header.RULE_ID)
self.assertEqual(abort.header.DTAG, fragment.header.DTAG)
self.assertEqual(abort.header.W, fragment.header.W)
self.assertTrue(
abort.header.FCN[0] == '1' and all(abort.header.FCN),
msg=f"{abort.header.FCN[0] == '1'} and {all(abort.header.FCN)}")
self.assertTrue(
abort.payload.decode()[0] == '0' and all(abort.payload.decode()),
msg=f"{abort.payload[0] == '0'} and {all(abort.payload)}")
self.assertFalse(abort.is_all_1())
self.assertTrue(abort.is_sender_abort())
def cleanup():
os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = config.CLIENT_SECRETS_FILE
bucket_name = config.BUCKET_NAME
header_bytes = request.get_json()["header_bytes"]
profile = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
# print("[CLN] Deleting timestamp blob")
# delete_blob(bucket_name, "timestamp")
#
# print("[CLN] Deleting modified loss mask")
# try:
# os.remove(config.LOSS_MASK_MODIFIED)
# except FileNotFoundError:
# pass
#
# print("[CLN] Resetting SSN")
# upload_blob(bucket_name, "{}", "SSN")
#
# print("[CLN] Initializing fragments...")
# delete_blob(bucket_name, "all_windows/")
# initialize_blobs(bucket_name, profile)
return '', 204
address = (ip, port)
# Read the file to be sent.
with open(filename, "rb") as data:
f = data.read()
payload = bytearray(f)
# Initialize variables.
total_size = len(payload)
current_size = 0
percent = round(0, 2)
ack = None
last_ack = None
i = 0
current_window = 0
profile_uplink = Sigfox("UPLINK", "ACK ON ERROR")
profile_downlink = Sigfox("DOWNLINK", "NO ACK")
the_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
# Fragment the file.
fragmenter = Fragmenter(profile_uplink, payload)
fragment_list = fragmenter.fragment()
# The fragment sender MUST initialize the Attempts counter to 0 for that Rule ID and DTag value pair
# (a whole SCHC packet)
attempts = 0
retransmitting = False
fragment = None
if len(fragment_list) > (2 ** profile_uplink.M) * profile_uplink.WINDOW_SIZE:
print(len(fragment_list))
def hello_get(request):
"""HTTP Cloud Function.
Args:
request (flask.Request): The request object.
<http://flask.pocoo.org/docs/1.0/api/#flask.Request>
Returns:
The response text, or any set of values that can be turned into a
Response object using `make_response`
<http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
"""
# Wait for an HTTP POST request.
if request.method == 'POST':
# Get request JSON.
print("POST RECEIVED")
request_dict = request.get_json()
print('Received Sigfox message: {}'.format(request_dict))
# Get data and Sigfox Sequence Number.
fragment = request_dict["data"]
sigfox_sequence_number = request_dict["seqNumber"]
# Initialize Cloud Storage variables.
BUCKET_NAME = config.BUCKET_NAME
# Parse fragment into "fragment = [header, payload]
header_bytes = None
header_first_hex = fragment[:1]
if (header_first_hex) == '0' or (header_first_hex) == '1':
header = bytes.fromhex(fragment[:2])
payload = bytearray.fromhex(fragment[2:])
header_bytes = 1
elif (header_first_hex) == '2':
header = bytearray.fromhex(fragment[:4])
payload = bytearray.fromhex(fragment[4:])
header_bytes = 2
else:
print("Wrong header in fragment")
return 'wrong header', 204
data = [header, payload]
# Initialize SCHC variables.
profile_uplink = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
profile_downlink = Sigfox("DOWNLINK", "NO ACK", header_bytes)
buffer_size = profile_uplink.MTU
n = profile_uplink.N
m = profile_uplink.M
# If fragment size is greater than buffer size, ignore it and end function.
if len(fragment
) / 2 * 8 > buffer_size: # Fragment is hex, 1 hex = 1/2 byte
return json.dumps(
{"message":
"Fragment size is greater than buffer size D:"}), 200
# If the folder named "all windows" does not exist, create it along with all subdirectories.
if not exists_blob(BUCKET_NAME, "all_windows/"):
print("INITIALIZING... (be patient)")
create_folder(BUCKET_NAME, "all_windows/")
# For each window in the SCHC Profile, create its blob.
for i in range(2**m):
create_folder(BUCKET_NAME, "all_windows/window_%d/" % i)
# For each fragment in the SCHC Profile, create its blob.
for j in range(2**n - 1):
upload_blob(
BUCKET_NAME, "",
"all_windows/window_%d/fragment_%d_%d" % (i, i, j))
# Create the blob for each bitmap.
if not exists_blob(
BUCKET_NAME, "all_windows/window_%d/bitmap_%d" %
(i, i) or size_blob(
BUCKET_NAME, "all_windows/window_%d/bitmap_%d" %
(i, i)) == 0):
bitmap = ""
for b in range(profile_uplink.BITMAP_SIZE):
bitmap += "0"
upload_blob(BUCKET_NAME, bitmap,
"all_windows/window_%d/bitmap_%d" % (i, i))
print("BLOBs created")
# Initialize empty window
window = []
for i in range(2**n - 1):
window.append([b"", b""])
# Compute the fragment compressed number (FCN) from the Profile
fcn_dict = {}
for j in range(2**n - 1):
fcn_dict[zfill(bin((2**n - 2) - (j % (2**n - 1)))[2:], n)] = j
# Convert to a Fragment class for easier manipulation.
fragment_message = Fragment(profile_uplink, data)
if 'enable_losses' in request_dict and not (
fragment_message.is_all_0() or fragment_message.is_all_1()):
if request_dict['enable_losses']:
loss_rate = request_dict["loss_rate"]
# loss_rate = 10
coin = random.random()
print('loss rate: {}, random toss:{}'.format(
loss_rate, coin * 100))
if coin * 100 < loss_rate:
print("[LOSS] The fragment was lost.")
return 'fragment lost', 204
# Get current window for this fragment.
current_window = int(fragment_message.header.W, 2)
# Get the current bitmap.
bitmap = read_blob(
BUCKET_NAME, "all_windows/window_%d/bitmap_%d" %
(current_window, current_window))
# Try getting the fragment number from the FCN dictionary.
try:
fragment_number = fcn_dict[fragment_message.header.FCN]
upload_blob(BUCKET_NAME, fragment_number, "fragment_number")
time_received = int(request_dict["time"])
if exists_blob(BUCKET_NAME, "timestamp"):
# Check time validation.
last_time_received = int(read_blob(BUCKET_NAME, "timestamp"))
# If this is not the very first fragment and the inactivity timer has been reached, ignore the message.
# TODO: Send SCHC abort message.
if str(fragment_number) != "0" and str(
current_window
) != "0" and time_received - last_time_received > profile_uplink.INACTIVITY_TIMER_VALUE:
return json.dumps({
"message":
"Inactivity timer reached. Message ignored."
}), 200
# Upload current timestamp.
upload_blob(BUCKET_NAME, time_received, "timestamp")
# Print some data for the user.
print("[RECV] This corresponds to the " + str(fragment_number) +
"th fragment of the " + str(current_window) + "th window.")
print("[RECV] Sigfox sequence number: " +
str(sigfox_sequence_number))
#Controlled Errors check
losses_mask = read_blob(
BUCKET_NAME, "all_windows/window_%d/losses_mask_%d" %
(current_window, current_window))
if (losses_mask[fragment_number]) != '0':
losses_mask = replace_bit(
losses_mask, fragment_number,
str(int(losses_mask[fragment_number]) - 1))
upload_blob(
BUCKET_NAME, losses_mask,
"all_windows/window_%d/losses_mask_%d" %
(current_window, current_window))
print("[LOSS] The fragment was lost.")
return 'fragment lost', 204
# Update bitmap and upload it.
bitmap = replace_bit(bitmap, fragment_number, '1')
upload_blob(
BUCKET_NAME, bitmap, "all_windows/window_%d/bitmap_%d" %
(current_window, current_window))
# Upload the fragment data.
upload_blob(
BUCKET_NAME,
data[0].decode("ISO-8859-1") + data[1].decode("utf-8"),
"all_windows/window_%d/fragment_%d_%d" %
(current_window, current_window, fragment_number))
# If the FCN could not been found, it almost certainly is the final fragment.
except KeyError:
print("[RECV] This seems to be the final fragment.")
print("is All-1:{}, is All-0:{}".format(
fragment_message.is_all_1(), fragment_message.is_all_0()))
# print("RULE_ID: {}, W:{}, FCN:{}".format(fragment.header.RULE_ID, fragment.header.W, fragment.header.FCN))
# Update bitmap and upload it.
bitmap = replace_bit(bitmap, len(bitmap) - 1, '1')
upload_blob(
BUCKET_NAME, bitmap, "all_windows/window_%d/bitmap_%d" %
(current_window, current_window))
# Get some SCHC values from the fragment.
rule_id = fragment_message.header.RULE_ID
dtag = fragment_message.header.DTAG
w = fragment_message.header.W
# Get last and current Sigfox sequence number (SSN)
last_sequence_number = 0
if exists_blob(BUCKET_NAME, "SSN"):
last_sequence_number = read_blob(BUCKET_NAME, "SSN")
upload_blob(BUCKET_NAME, sigfox_sequence_number, "SSN")
# If the fragment is at the end of a window (ALL-0 or ALL-1)
if fragment_message.is_all_0() or fragment_message.is_all_1():
# Prepare the ACK bitmap. Find the first bitmap with a 0 in it.
for i in range(current_window + 1):
bitmap_ack = read_blob(
BUCKET_NAME, "all_windows/window_%d/bitmap_%d" % (i, i))
print(bitmap_ack)
window_ack = i
if '0' in bitmap_ack:
break
# If the ACK bitmap has a 0 at the end of a non-final window, a fragment has been lost.
if fragment_message.is_all_0() and '0' in bitmap_ack:
print("[ALL0] Sending ACK for lost fragments...")
print("bitmap with errors -> {}".format(bitmap_ack))
# Create an ACK message and send it.
ack = ACK(profile_downlink, rule_id, dtag,
zfill(format(window_ack, 'b'), m), bitmap_ack, '0')
response_json = send_ack(request_dict, ack)
print("Response content -> {}".format(response_json))
return response_json, 200
# If the ACK bitmap is complete and the fragment is an ALL-0, send an ACK
# This is to be modified, as ACK-on-Error does not need an ACK for every window.
if fragment_message.is_all_0() and bitmap[0] == '1' and all(
bitmap):
print("[ALL0] All Fragments of current window received")
print("[ALL0] No need to send an ACK")
# print("[ALLX] Sending ACK after window...")
# Create an ACK message and send it.
# ack = ACK(profile_downlink, rule_id, dtag, w, bitmap, '0')
# response_json = send_ack(request_dict, ack)
# print("200, Response content -> {}".format(response_json))
# Response to continue, no ACK is sent Back.
return '', 204
# return response_json, 200
# If the fragment is an ALL-1
if fragment_message.is_all_1():
# response = {request_dict['device']: {'downlinkData': '080fffffffffffff'}}
# print("response -> {}".format(json.dumps(response)))
# return json.dumps(response), 200
# The bitmap in the last window follows the following regular expression: "1*0*1*"
# Since the ALL-1, if received, changes the least significant bit of the bitmap.
# For a "complete" bitmap in the last window, there shouldn't be non-consecutive zeroes:
# 1110001 is a valid bitmap, 1101001 is not.
pattern2 = re.compile("0*1")
if pattern2.fullmatch(bitmap):
last_index = 0
upload_blob(
BUCKET_NAME,
data[0].decode("ISO-8859-1") + data[1].decode("utf-8"),
"all_windows/window_%d/fragment_%d_%d" %
(current_window, current_window, last_index))
print(
"Info for reassemble: last_index:{}, current_window:{}"
.format(last_index, current_window))
try:
print('Activating reassembly process...')
_ = requests.post(
url=
'https://europe-west1-true-sprite-292308.cloudfunctions.net/http_reassemble',
json={
"last_index": last_index,
"current_window": current_window,
"header_bytes": header_bytes
},
timeout=1)
# except requests.exceptions.ReadTimeout:
# pass
except Exception as e:
print("exception in reassembly call: {}".format(e))
# Send last ACK to end communication.
print("[ALL1] Reassembled: Sending last ACK")
bitmap = ''
for k in range(profile_uplink.BITMAP_SIZE):
bitmap += '0'
last_ack = ACK(profile_downlink, rule_id, dtag, w, bitmap,
'1')
response_json = send_ack(request_dict, last_ack)
# return response_json, 200
# response_json = send_ack(request_dict, last_ack)
print("200, Response content -> {}".format(response_json))
return response_json, 200
pattern = re.compile("1*0*1")
# If the bitmap matches the regex, check if the last two received fragments are consecutive.
if pattern.fullmatch(bitmap):
# If the last two received fragments are consecutive, accept the ALL-1 and start reassembling
if int(sigfox_sequence_number) - int(
last_sequence_number) == 1:
last_index = int(
read_blob(BUCKET_NAME, "fragment_number")) + 1
upload_blob(
BUCKET_NAME, data[0].decode("ISO-8859-1") +
data[1].decode("utf-8"),
"all_windows/window_%d/fragment_%d_%d" %
(current_window, current_window, last_index))
print(
"Info for reassemble: last_index:{}, current_window:{}"
.format(last_index, current_window))
try:
print('Activating reassembly process...')
_ = requests.post(
url=
'https://europe-west1-true-sprite-292308.cloudfunctions.net/http_reassemble',
json={
"last_index": last_index,
"current_window": current_window,
"header_bytes": header_bytes
},
timeout=1)
# except requests.exceptions.ReadTimeout:
# pass
except Exception as e:
print("exception in reassembly call: {}".format(e))
# Send last ACK to end communication.
print("[ALL1] Reassembled: Sending last ACK")
bitmap = ''
for k in range(profile_uplink.BITMAP_SIZE):
bitmap += '0'
last_ack = ACK(profile_downlink, rule_id, dtag, w,
bitmap, '1')
response_json = send_ack(request_dict, last_ack)
# return response_json, 200
# response_json = send_ack(request_dict, last_ack)
print("200, Response content -> {}".format(
response_json))
return response_json, 200
else:
# Send NACK at the end of the window.
print("[ALLX] Sending NACK for lost fragments...")
ack = ACK(profile_downlink, rule_id, dtag,
zfill(format(window_ack, 'b'), m),
bitmap_ack, '0')
response_json = send_ack(request_dict, ack)
return response_json, 200
# If they are not, there is a gap between two fragments: a fragment has been lost.
# The same happens if the bitmap doesn't match the regex.
else:
# Send NACK at the end of the window.
print("[ALLX] Sending NACK for lost fragments...")
ack = ACK(profile_downlink, rule_id, dtag,
zfill(format(window_ack, 'b'), m), bitmap_ack,
'0')
response_json = send_ack(request_dict, ack)
return response_json, 200
return '', 204
else:
print(
'Invalid HTTP Method to invoke Cloud Function. Only POST supported'
)
return abort(405)
def reassemble():
CLEANUP_URL = "https://localhost:5000/cleanup"
if request.method == "POST":
print("[RSMB] The reassembler has been launched.")
# Get request JSON.
request_dict = request.get_json()
print(f'[RSMB] Received HTTP message: {request_dict}')
current_window = int(request_dict["current_window"])
last_index = int(request_dict["last_index"])
header_bytes = int(request_dict["header_bytes"])
# Initialize Cloud Storage variables.
BUCKET_NAME = config.BUCKET_NAME
# Initialize SCHC variables.
profile_uplink = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
n = profile_uplink.N
print("[RSMB] Loading fragments")
# Get all the fragments into an array in the format "fragment = [header, payload]"
fragments = []
# For each window, load every fragment into the fragments array
for i in range(current_window + 1):
for j in range(2**n - 1):
print(f"[RSMB] Loading fragment {j}")
fragment_file = read_blob(
BUCKET_NAME, f"all_windows/window_{i}/fragment_{i}_{j}")
print(f"[RSMB] Fragment data: {fragment_file}")
header = fragment_file[:header_bytes]
payload = fragment_file[header_bytes:]
fragment = [header.encode(), payload.encode()]
fragments.append(fragment)
if i == current_window and j == last_index:
break
# Instantiate a Reassembler and start reassembling.
print("[RSMB] Reassembling")
reassembler = Reassembler(profile_uplink, fragments)
payload = bytearray(reassembler.reassemble()).decode("utf-8")
print("[RSMB] Uploading result")
with open(config.PAYLOAD, "w") as file:
file.write(payload)
# Upload the full message.
upload_blob_using_threads(BUCKET_NAME, payload, "PAYLOAD")
if filecmp.cmp(config.PAYLOAD, config.MESSAGE):
print("The reassembled file is equal to the original message.")
else:
print("The reassembled file is corrupt.")
try:
_ = requests.post(url=CLEANUP_URL,
json={"header_bytes": header_bytes},
timeout=0.1)
except requests.exceptions.ReadTimeout:
pass
return '', 204
def schc_post():
"""HTTP Cloud Function.
Args:
request (flask.Request): The request object.
<http://flask.pocoo.org/docs/1.0/api/#flask.Request>
Returns:
The response text, or any set of values that can be turned into a
Response object using `make_response`
<http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
"""
REASSEMBLER_URL = "http://localhost:5000/reassembler"
CLEANUP_URL = "http://localhost:5000/cleanup"
# File where we will store authentication credentials after acquiring them.
os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = config.CLIENT_SECRETS_FILE
# Wait for an HTTP POST request.
if request.method == 'POST':
# Get request JSON.
print("POST RECEIVED")
request_dict = request.get_json()
print('Received Sigfox message: {}'.format(request_dict))
# Get data and Sigfox Sequence Number.
raw_data = request_dict["data"]
sigfox_sequence_number = request_dict["seqNumber"]
ack_req = request_dict["ack"]
# Initialize Cloud Storage variables.
BUCKET_NAME = config.BUCKET_NAME
header_first_hex = raw_data[:1]
if header_first_hex == '0' or header_first_hex == '1':
header = bytes.fromhex(raw_data[:2])
payload = bytearray.fromhex(raw_data[2:])
header_bytes = 1
elif header_first_hex == '2':
header = bytearray.fromhex(raw_data[:4])
payload = bytearray.fromhex(raw_data[4:])
header_bytes = 2
else:
print("Wrong header in raw_data")
return 'wrong header', 204
# Initialize SCHC variables.
profile = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
n = profile.N
m = profile.M
# If fragment size is greater than buffer size, ignore it and end function.
if len(
raw_data
) / 2 * 8 > profile.UPLINK_MTU: # Fragment is hex, 1 hex = 1/2 byte
return json.dumps(
{"message": "Fragment size is greater than buffer size"}), 200
# If the folder named "all windows" does not exist, create it along with all subdirectories.
initialize_blobs(BUCKET_NAME, profile)
# Compute the fragment compressed number (FCN) from the Profile
fcn_dict = {}
for j in range(2**n - 1):
fcn_dict[zfill(bin((2**n - 2) - (j % (2**n - 1)))[2:], 3)] = j
# Parse raw_data into "data = [header, payload]
# Convert to a Fragment class for easier manipulation.
header = bytes.fromhex(raw_data[:2])
payload = bytearray.fromhex(raw_data[2:])
data = [header, payload]
fragment_message = Fragment(profile, data)
if fragment_message.is_sender_abort():
print("Sender-Abort received")
try:
print("Cleaning")
_ = requests.post(url=CLEANUP_URL,
json={"header_bytes": header_bytes},
timeout=0.1)
except requests.exceptions.ReadTimeout:
pass
return 'Sender-Abort received', 204
# Get data from this fragment.
fcn = fragment_message.header.FCN
rule_id = fragment_message.header.RULE_ID
dtag = fragment_message.header.DTAG
current_window = int(fragment_message.header.W, 2)
# Get the current bitmap.
bitmap = read_blob(
BUCKET_NAME,
f"all_windows/window_{current_window}/bitmap_{current_window}")
# Controlling deterministic losses. This loads the file "loss_mask.txt" which states when should a fragment be
# lost, separated by windows.
fd = None
try:
fd = open(config.LOSS_MASK_MODIFIED, "r")
except FileNotFoundError:
fd = open(config.LOSS_MASK, "r")
finally:
loss_mask = []
for line in fd:
if not line.startswith("#"):
for char in line:
try:
loss_mask.append(int(char))
except ValueError:
pass
fd.close()
print(f"Loss mask: {loss_mask}")
# Controlling random losses.
if 'enable_losses' in request_dict and not (
fragment_message.is_all_0() or fragment_message.is_all_1()):
if request_dict['enable_losses']:
loss_rate = request_dict["loss_rate"]
# loss_rate = 10
coin = random.random()
print(f'loss rate: {loss_rate}, random toss:{coin * 100}')
if coin * 100 < loss_rate:
print("[LOSS] The fragment was lost.")
return 'fragment lost', 204
# Check if the fragment is an All-1
if is_monochar(fcn) and fcn[0] == '1':
print("[RECV] This is an All-1.")
# Check if fragment is to be lost (All-1 is the very last fragment)
if loss_mask[-1] != 0:
loss_mask[-1] -= 1
with open("loss_mask_modified.txt", "w") as fd:
for i in loss_mask:
fd.write(str(i))
print(f"[RECV] Fragment lost.")
return 'fragment lost', 204
# Inactivity timer validation
time_received = int(request_dict["time"])
if exists_blob(BUCKET_NAME, "timestamp"):
# Check time validation.
last_time_received = int(read_blob(BUCKET_NAME, "timestamp"))
print(f"[RECV] Previous timestamp: {last_time_received}")
print(f"[RECV] This timestamp: {time_received}")
# If the inactivity timer has been reached, abort communication.
if time_received - last_time_received > profile.INACTIVITY_TIMER_VALUE:
print("[RECV] Inactivity timer reached. Ending session.")
receiver_abort = ReceiverAbort(profile,
fragment_message.header)
print("Sending Receiver Abort")
response_json = send_ack(request_dict, receiver_abort)
print(f"Response content -> {response_json}")
try:
print("Cleaning Inactivity timer reached")
_ = requests.post(url=CLEANUP_URL,
json={"header_bytes": header_bytes},
timeout=0.1)
except requests.exceptions.ReadTimeout:
pass
return response_json, 200
# Update timestamp
upload_blob(BUCKET_NAME, time_received, "timestamp")
# Update bitmap and upload it.
bitmap = replace_bit(bitmap, len(bitmap) - 1, '1')
print(f"Bitmap is now {bitmap}")
upload_blob(
BUCKET_NAME, bitmap,
f"all_windows/window_{current_window}/bitmap_{current_window}")
# Upload the fragment data.
upload_blob(
BUCKET_NAME, data[0].decode("utf-8") + data[1].decode("utf-8"),
f"all_windows/window_{current_window}/fragment_{current_window}_{profile.WINDOW_SIZE - 1}"
)
# Else, it is a normal fragment.
else:
fragment_number = fcn_dict[fragment_message.header.FCN]
# Check if fragment is to be lost
position = current_window * profile.WINDOW_SIZE + fragment_number
if loss_mask[position] != 0:
loss_mask[position] -= 1
with open(config.LOSS_MASK_MODIFIED, "w") as fd:
for i in loss_mask:
fd.write(str(i))
print(f"[RECV] Fragment lost.")
return 'fragment lost', 204
# Inactivity timer validation
time_received = int(request_dict["time"])
if exists_blob(BUCKET_NAME, "timestamp"):
# Check time validation.
last_time_received = int(read_blob(BUCKET_NAME, "timestamp"))
print(f"[RECV] Previous timestamp: {last_time_received}")
print(f"[RECV] This timestamp: {time_received}")
# If the inactivity timer has been reached, abort communication.
if time_received - last_time_received > profile.INACTIVITY_TIMER_VALUE:
print("[RECV] Inactivity timer reached. Ending session.")
receiver_abort = ReceiverAbort(profile,
fragment_message.header)
print("Sending Receiver Abort")
response_json = send_ack(request_dict, receiver_abort)
print(f"Response content -> {response_json}")
try:
_ = requests.post(url=CLEANUP_URL,
json={"header_bytes": header_bytes},
timeout=0.1)
except requests.exceptions.ReadTimeout:
pass
return response_json, 200
# Update timestamp
upload_blob(BUCKET_NAME, time_received, "timestamp")
# Update Sigfox sequence number JSON
sequence_numbers = json.loads(read_blob(BUCKET_NAME, "SSN"))
sequence_numbers[position] = request_dict["seqNumber"]
print(sequence_numbers)
upload_blob(BUCKET_NAME, json.dumps(sequence_numbers), "SSN")
upload_blob(BUCKET_NAME, fragment_number, "fragment_number")
# Print some data for the user.
print(
f"[RECV] This corresponds to the {str(fragment_number)}th fragment "
f"of the {str(current_window)}th window.")
print(
f"[RECV] Sigfox sequence number: {str(sigfox_sequence_number)}"
)
# Update bitmap and upload it.
bitmap = replace_bit(bitmap, fragment_number, '1')
print(f"Bitmap is now {bitmap}")
upload_blob(
BUCKET_NAME, bitmap,
f"all_windows/window_{current_window}/bitmap_{current_window}")
# Upload the fragment data.
upload_blob(
BUCKET_NAME, data[0].decode("utf-8") + data[1].decode("utf-8"),
f"all_windows/window_{current_window}/fragment_{current_window}_{fragment_number}"
)
# If the fragment requests an ACK...
if ack_req:
# Prepare the ACK bitmap. Find the first bitmap with a 0 in it.
# This bitmap corresponds to the lowest-numered window with losses.
bitmap_ack = None
window_ack = None
for i in range(current_window + 1):
bitmap_ack = read_blob(BUCKET_NAME,
f"all_windows/window_{i}/bitmap_{i}")
print(bitmap_ack)
window_ack = i
if '0' in bitmap_ack:
break
# The final window is only accessible through All-1.
# If All-0, check non-final windows
if fragment_message.is_all_0():
# If the ACK bitmap has a 0 at a non-final window, a fragment has been lost.
if '0' in bitmap_ack:
print(
"[ALL0] Lost fragments have been detected. Preparing ACK."
)
print(f"[ALL0] Bitmap with errors -> {bitmap_ack}")
ack = ACK(profile=profile,
rule_id=rule_id,
dtag=dtag,
w=zfill(format(window_ack, 'b'), m),
c='0',
bitmap=bitmap_ack)
response_json = send_ack(request_dict, ack)
print(f"Response content -> {response_json}")
print("[ALL0] ACK sent.")
return response_json, 200
# If all bitmaps are complete up to this point, no losses are detected.
else:
print("[ALL0] No losses have been detected.")
print("Response content -> ''")
return '', 204
# If the fragment is All-1, the last window should be considered.
if fragment_message.is_all_1():
# First check for 0s in the bitmap. If the bitmap is of a non-final window, send corresponding ACK.
if current_window != window_ack and '0' in bitmap_ack:
print(
"[ALL1] Lost fragments have been detected. Preparing ACK."
)
print(f"[ALL1] Bitmap with errors -> {bitmap_ack}")
ack = ACK(profile=profile,
rule_id=rule_id,
dtag=dtag,
w=zfill(format(window_ack, 'b'), m),
c='0',
bitmap=bitmap_ack)
response_json = send_ack(request_dict, ack)
print(f"Response content -> {response_json}")
print("[ALL1] ACK sent.")
return response_json, 200
# If the bitmap is of the final window, check the following regex.
else:
# The bitmap in the last window follows the following regular expression: "1*0*1*"
# Since the ALL-1, if received, changes the least significant bit of the bitmap.
# For a "complete" bitmap in the last window, there shouldn't be non-consecutive zeroes:
# 1110001 is a valid bitmap, 1101001 is not.
# The bitmap may or may not contain the 0s.
pattern = re.compile("1*0*1")
# If the bitmap matches the regex, check if there are still lost fragments.
if pattern.fullmatch(bitmap_ack) is not None:
# The idea is the following:
# Assume a fragment has been lost, but the regex has been matched.
# For example, we want a bitmap 1111111 but due to a loss we have 1111101.
# This incomplete bitmap matches the regex.
# We should note that here the SSN of the All-1 and the penultimate fragment received
# are not consecutive.
# Retransmitting the lost fragment and resending the All-1 solves that problem.
# There is another problematic case: we want a bitmap 1111111 but due to losses we have 1111001.
# If the second of those two lost fragments is retransmitted, the new bitmap, 1111011, does not
# match the regex. If, instead, the first of those fragments is retransmitted, the new bitmap
# 1111101 does match the regex. As the sender should retransmit these messages sequentially,
# the SSN of the resent All-1 and the penultimate fragment are still not consecutive.
# The only way for these two SSNs to be consecutive in these cases
# is that the penultimate fragment fills the bitmap in the 6th bit,
# and the last fragment is the All-1.
# This reasoning is still valid when the last window does not contain WINDOW_SIZE fragments.
# These particular cases validate the use for this regex matching.
# Remember that 1111011 is NOT a valid bitmap.
# In conclusion, AFTER the regex matching,
# we should check if the SSNs of the two last received fragments are consecutive.
# The second to last fragment has the highest SSN registered in the JSON.
# TODO: What happens when the All-0 prior to the last window is lost and is retransmitted with the All-1?
# We should consider only the SSNs of the last window. If there is a retransmission in a window
# prior to the last, the reasoning fails since the All-1 is always consecutive to a
# retransmitted fragment of a non-final window.
# If the All-1 is the only fragment of the last window (bitmap 0000001), and bitmap check of
# prior windows has passed, check the consecutiveness of the last All-0 and the All-1.
sequence_numbers = json.loads(
read_blob(BUCKET_NAME, "SSN"))
# This array has the SSNs of the last window.
# last_window_ssn = list(sequence_numbers.values())[current_window * profile.WINDOW_SIZE + 1:]
# If this array is empty, no messages have been received in the last window. Check if the
# last All-0 and the All-1 are consecutive. If they are not, there are lost fragments. If they
# are, the All-0 may have been retransmitted.
# print(last_window_ssn)
# The last sequence number should be the highest of these values.
last_sequence_number = max(
list(map(int, list(sequence_numbers.values()))))
# TODO: If the All-0 has the highest of these values, it may have been retransmitted using the All-1
print(
f"All-1 sequence number {sigfox_sequence_number}")
print(f"Last sequence number {last_sequence_number}")
if int(sigfox_sequence_number) - int(
last_sequence_number) == 1:
print(
"[ALL1] Integrity checking complete, launching reassembler."
)
# All-1 does not define a fragment number, so its fragment number must be the next
# of the higest registered fragment number.
last_index = max(
list(map(int, list(
sequence_numbers.keys())))) + 1
upload_blob_using_threads(
BUCKET_NAME, data[0].decode("ISO-8859-1") +
data[1].decode("utf-8"),
f"all_windows/window_{current_window}/"
f"fragment_{current_window}_{last_index}")
try:
_ = requests.post(url=REASSEMBLER_URL,
json={
"last_index": last_index,
"current_window":
current_window,
"header_bytes":
header_bytes
},
timeout=0.1)
except requests.exceptions.ReadTimeout:
pass
# Send last ACK to end communication (on receiving an All-1, if no fragments are lost,
# if it has received at least one tile, return an ACK for the highest numbered window we
# currently have tiles for).
print("[ALL1] Preparing last ACK")
bitmap = ''
for k in range(profile.BITMAP_SIZE):
bitmap += '0'
last_ack = ACK(profile=profile,
rule_id=rule_id,
dtag=dtag,
w=zfill(format(window_ack, 'b'), m),
c='1',
bitmap=bitmap_ack)
response_json = send_ack(request_dict, last_ack)
print(f"200, Response content -> {response_json}")
print("[ALL1] Last ACK has been sent.")
return response_json, 200
# If the last two fragments are not consecutive, or the bitmap didn't match the regex,
# send an ACK reporting losses.
else:
# Send NACK at the end of the window.
print("[ALLX] Sending NACK for lost fragments...")
ack = ACK(profile=profile,
rule_id=rule_id,
dtag=dtag,
w=zfill(format(window_ack, 'b'), m),
c='0',
bitmap=bitmap_ack)
response_json = send_ack(request_dict, ack)
return response_json, 200
return '', 204
else:
print(
'Invalid HTTP Method to invoke Cloud Function. Only POST supported'
)
return abort(405)
exit(1)
# Read the file to be sent.
with open(filename, "rb") as data:
f = data.read()
message = bytearray(f)
# Initialize variables.
total_size = len(message)
current_size = 0
percent = round(0, 2)
i = 0
current_window = 0
header_bytes = 1 if total_size <= 300 else 2
profile_uplink = Sigfox("UPLINK", "ACK ON ERROR", header_bytes)
profile_downlink = Sigfox("DOWNLINK", "NO ACK", header_bytes)
window_size = profile_uplink.WINDOW_SIZE
parser = argparse.ArgumentParser()
parser.add_argument('--mode', type=str, help="For 'local' or 'cloud' testing.")
parser.add_argument(
'--clean',
action='store_true',
help="If set, cleans the Cloud Storage bucket before execution.")
parser.add_argument('--cleanonly',
action='store_true',
help="If sets, cleans the bucket and exits immediately.")
args = parser.parse_args()
if args.mode == 'cloud':
from Entities.Reassembler import Reassembler
from Entities.SCHC_Frag_Profile import SCHC_Frag_Profile
from Entities.Sigfox import Sigfox
from Messages.ACK import ACK
from Messages.Fragment import Fragment
from Messages.Header import Header
from Entities.Fragmenter import Fragmenter
# protocol_name = input("PROTOCOL: ")
# direction = input("DIRECTION: ")
# mode = input("MODE: ")
# mtu = input("MTU: ")
# if protocol_name == "SIGFOX":
# protocol = Sigfox(direction, mode)
profile = Sigfox("UPLINK", "ACK ON ERROR")
MTU = profile.MTU
with open("pollito_14x14.png", "rb") as data:
f = data.read()
payload = bytearray(f)
print("The payload to be transmitted is: " + str(payload))
test_header = Header(profile, rule_id="RR", dtag="D", w="WW", fcn="000", c=0)
test_header.test()
fragmenter = Fragmenter(profile, payload)
fragment_list = fragmenter.fragment()
print("Fragments:")