New 'sender' filter

Author: NotStatilko

tgbox/api/utils.py

@@ -415,10 +415,8 @@ async def _async_iter_from(_iter_from):
         else:
             file_path = ''
 
-        # We will use it as flags, the first
-        # is for 'include', the second is for
-        # 'exclude'. Both should be True to
-        # match SearchFilter filters.
+        # We will use it as flags, the first is for 'include', the second is
+        # for 'exclude'. Both should be True to match SearchFilter filters.
         yield_result = [True, True]
 
         for indx, filter in enumerate((sf.in_filters, sf.ex_filters)):
@@ -433,6 +431,42 @@ async def _async_iter_from(_iter_from):
                         yield_result[indx] = False
                         break
 
+            for sender in filter['sender']:
+                # If sender is int, then it we check only against
+                # the 'sender_id', if str, we check against the
+                # 'sender', and if sender isnumeric(), we convert
+                # to int and also check against 'sender_id'
+
+                # sender and sender_id is presented only in RemoteBox
+                # files and only in Box channels with Sign Messages
+                # -> Show Author Profiles enabled. If file doesn't
+                # have sender, then always skip a file.
+
+                file_sender_id, _check = getattr(file, 'sender_id', None), False
+
+                if isinstance(sender, int):
+                    if sender == file_sender:
+                        _check = True
+
+                if isinstance(sender, str):
+                    file_sender = getattr(file, 'sender') or ''
+
+                    if in_func(sender, file_sender):
+                        _check = True
+                    else:
+                        if sender.isnumeric() and int(sender) == file_sender_id:
+                            _check = True
+
+                if _check:
+                    if indx == 1:
+                        yield_result[indx] = False
+                    break
+            else:
+                if filter['sender']:
+                    if indx == 0:
+                        yield_result[indx] = False
+                        break
+
             for minor_version in filter['minor_version']:
                 if minor_version == file.minor_version:
                     if indx == 1:

tgbox/tools.py

@@ -177,6 +177,20 @@ class SearchFilter:
         * **verbyte**   *bytes*: File version byte
         * **mime**      *str*: File mime type
 
+        * **sender** *integer/str*: File sender name or ID:
+            Only works on RemoteBox files and only on
+            RemoteBox that enabled Sign Messages (&
+            Show Author Profiles, optionally for IDs),
+            otherwise will never return files.
+
+            This filter can be Sender name or Sender ID,
+            e.g sender='black sabbath' or sender=36265675;
+            if 'sender' is string but .isnumeric(), Generator
+            will also convert it to int and check against
+            ID (if available), essentially, sender=36265675
+            and sender='36265675' both valid, but latter
+            will also check '36265675' in name.
+
         * **minor_version** *integer*: File minor version
 
         * **min_id** *integer*: File ID should be > min_id
@@ -208,6 +222,7 @@ def __init__(self, **kwargs):
             'min_time':  _TypeList((int,float)),
             'max_time':  _TypeList((int,float)),
             'mime':      _TypeList(str),
+            'sender':    _TypeList((str,int)),
             'imported':  _TypeList(bool),
             're':        _TypeList(bool),
             'minor_version': _TypeList(int),