Skip to content

Use caching for the etag using stored hash if available #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions flask_pymongo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,22 @@ def get_upload(filename):
response.headers["Content-Disposition"] = f"attachment; filename={filename}"
response.content_length = fileobj.length
response.last_modified = fileobj.upload_date
# Compute the sha1 sum of the file for the etag.
pos = fileobj.tell()
raw_data = fileobj.read()
fileobj.seek(pos)
digest = hashlib.sha1(raw_data).hexdigest()
response.set_etag(digest)

# GridFS does not manage its own checksum.
# Try to use a sha1 sum that we have added during a save_file.
# Fall back to a legacy md5 sum if it exists.
# Otherwise, compute the sha1 sum directly.
try:
etag = fileobj.sha1
except AttributeError:
etag = fileobj.md5
if etag is None:
pos = fileobj.tell()
raw_data = fileobj.read()
fileobj.seek(pos)
etag = hashlib.sha1(raw_data).hexdigest()
response.set_etag(etag)

response.cache_control.max_age = cache_for
response.cache_control.public = True
response.make_conditional(request)
Expand Down Expand Up @@ -237,5 +247,23 @@ def save_upload(filename):
db_obj = self.db
assert db_obj is not None, "Please initialize the app before calling save_file!"
storage = GridFS(db_obj, base)
id = storage.put(fileobj, filename=filename, content_type=content_type, **kwargs)
return id

# GridFS does not manage its own checksum, so we attach a sha1 to the file
# for use as an etag.
hashingfile = _Wrapper(fileobj)
with storage.new_file(filename=filename, content_type=content_type, **kwargs) as grid_file:
grid_file.write(hashingfile)
grid_file.sha1 = hashingfile.hash.hexdigest()
return grid_file._id


class _Wrapper:
def __init__(self, file):
self.file = file
self.hash = hashlib.sha1()

def read(self, n):
data = self.file.read(n)
if data:
self.hash.update(data)
return data
2 changes: 1 addition & 1 deletion tests/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ def setUp(self):
def tearDown(self):
assert self.mongo.cx is not None
self.mongo.cx.drop_database(self.dbname)

self.mongo.cx.close()
super().tearDown()
Loading