Allow attachment default expiry to be unlimited

Setting the expiry to 0 days is now interpreted as a default that makes
attachments never expire.  (This only applies once attached to a post;
temporary uploads still have a 1-hour expiry).

Author: jagerman

sogs.ini.sample

@@ -59,7 +59,7 @@
 
 ; How long newly uploaded files should be stored before being cleaned up, in days.  Note that
 ; changing this only affects new files.  This limit does not apply to room images and attachments in
-; pinned messages, both of which do not expire.
+; pinned messages, both of which do not expire.  Can be set to 0 to never expire new uploads.
 ;
 ;expiry = 15
 

sogs/config.py

@@ -19,7 +19,7 @@
 OMQ_INTERNAL = 'ipc://./omq.sock'
 LOG_LEVEL = 'WARNING'
 DM_EXPIRY = 15 * 86400.0  # Seconds, but specified in config file as days
-UPLOAD_DEFAULT_EXPIRY = 15 * 86400.0  # Seconds, but specified in config file as days
+UPLOAD_DEFAULT_EXPIRY = 15 * 86400.0  # Seconds (or None), but specified in config file as days
 UPLOAD_FILENAME_MAX = 60
 UPLOAD_FILENAME_KEEP_PREFIX = 40
 UPLOAD_FILENAME_KEEP_SUFFIX = 17
@@ -80,6 +80,9 @@ def val_or_none(v):
     def days_to_seconds(v):
         return float(v) * 86400.0
 
+    def days_to_seconds_or_none(v):
+        return days_to_seconds(v) if v else None
+
     truthy = ('y', 'yes', 'Y', 'Yes', 'true', 'True', 'on', 'On', '1')
     falsey = ('n', 'no', 'N', 'No', 'false', 'False', 'off', 'Off', '0')
     booly = truthy + falsey
@@ -108,7 +111,7 @@ def bool_opt(name):
             'http_show_recent': bool_opt('HTTP_SHOW_RECENT'),
         },
         'files': {
-            'expiry': ('UPLOAD_DEFAULT_EXPIRY', None, days_to_seconds),
+            'expiry': ('UPLOAD_DEFAULT_EXPIRY', None, days_to_seconds_or_none),
             'max_size': ('UPLOAD_FILE_MAX_SIZE', None, int),
             'uploads_dir': ('UPLOAD_PATH', path_exists, val_or_none),
         },

sogs/migrations/v_0_1_x.py

@@ -359,6 +359,10 @@ def ins_user(session_id):
                     )
                     timestamp = time.time()
 
+                exp = None
+                if config.UPLOAD_DEFAULT_EXPIRY:
+                    exp = timestamp + config.UPLOAD_DEFAULT_EXPIRY
+
                 new_id = db.insert_and_get_pk(
                     """
                     INSERT INTO files (room, size, uploaded, expiry, path)
@@ -368,7 +372,7 @@ def ins_user(session_id):
                     r=room_id,
                     size=size,
                     uploaded=timestamp,
-                    expiry=timestamp + config.UPLOAD_DEFAULT_EXPIRY,
+                    expiry=exp,
                     path=path,
                     dbconn=conn,
                 )

sogs/model/file.py

@@ -127,12 +127,14 @@ def set_expiry(self, duration=None, forever=False):
         True.  If duration is None (and not using forever) then the default expiry (relative to the
         current time) will be used.
         """
-        expiry = (
-            None
-            if forever
-            else time.time()
-            + (duration if duration is not None else config.UPLOAD_DEFAULT_EXPIRY)
-        )
+        if forever:
+            expiry = None
+        elif duration is not None:
+            expiry = time.time() + duration
+        elif config.UPLOAD_DEFAULT_EXPIRY:
+            expiry = time.time() + config.UPLOAD_DEFAULT_EXPIRY
+        else:
+            expiry = None
         query("UPDATE files SET expiry = :when WHERE id = :f", when=expiry, f=self.id)
         self.expiry = expiry
 

sogs/model/room.py

@@ -656,6 +656,10 @@ def _own_files(self, msg_id: int, files: List[int], user):
         Associated any of the given file ids with the given message id.  Only files that are recent,
         expiring, unowned uploads by the same user are actually updated.
         """
+        expiry = None
+        if config.UPLOAD_DEFAULT_EXPIRY:
+            expiry = time.time() + config.UPLOAD_DEFAULT_EXPIRY
+
         return db.query(
             """
             UPDATE files SET
@@ -669,7 +673,7 @@ def _own_files(self, msg_id: int, files: List[int], user):
                 AND expiry IS NOT NULL
             """,
             m=msg_id,
-            exp=time.time() + config.UPLOAD_DEFAULT_EXPIRY,
+            exp=expiry,
             ids=files,
             r=self.id,
             u=user.id,

tests/test_files.py

@@ -0,0 +1,30 @@
+from nacl.utils import random
+from request import sogs_post, sogs_post_raw
+from util import config_override, from_now, pad64
+from sogs.model.file import File
+from sogs import utils
+
+
+def _make_file_upload(filename):
+    return random(1024), {"Content-Disposition": ('attachment', {'filename': filename})}
+
+
+def test_file_unexpiring(client, room, user):
+    with config_override(UPLOAD_DEFAULT_EXPIRY=None):
+        filedata, headers = _make_file_upload('up1.txt')
+        r = sogs_post_raw(client, f'/room/{room.token}/file', filedata, user, extra_headers=headers)
+        assert r.status_code == 201
+        assert 'id' in r.json
+        f = File(id=r.json.get('id'))
+        # - verify that the file expiry is 1h from now (±1s)
+        assert f.expiry == from_now.hours(1)
+        # - add a post that references the file
+        d, s = (utils.encode_base64(x) for x in (b"post data", pad64("sig")))
+        post_info = {'data': d, 'signature': s, 'files': [f.id]}
+        r = sogs_post(client, f'/room/{room.token}/message', post_info, user)
+        assert r.status_code == 201
+        assert 'id' in r.json
+        post_id = r.json.get('id')
+        f = File(id=f.id)
+        assert f.post_id == post_id
+        assert f.expiry is None

tests/util.py

@@ -1,5 +1,7 @@
 from typing import Union
 import time
+from contextlib import contextmanager
+import sogs.config
 
 
 def pad64(data: Union[bytes, str]):
@@ -47,3 +49,27 @@ def hours(n):
     @staticmethod
     def days(n):
         return from_now.hours(24) * n
+
+
+@contextmanager
+def config_override(**kwargs):
+    """
+    Context manager that locally overrides one or more sogs.config.XXX values for all given XXX keys
+    in kwargs.  The original config values are restored when leaving the context.
+
+    e.g.
+
+        with config_override(UPLOAD_FILE_MAX_SIZE=1024):
+            ...
+    """
+
+    restore = {}
+    for k, v in kwargs.items():
+        restore[k] = getattr(sogs.config, k)
+        setattr(sogs.config, k, v)
+
+    try:
+        yield None
+    finally:
+        for k, v in restore.items():
+            setattr(sogs.config, k, v)