lfss 0.11.6__tar.gz → 0.12.1__tar.gz

{lfss-0.11.6 → lfss-0.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lfss
-Version: 0.11.6
+Version: 0.12.1
 Summary: Lite file storage service
 Home-page: https://github.com/MenxLi/lfss
 Author: Li, Mengxun

lfss-0.12.1/docs/Client.md

@@ -0,0 +1,37 @@
+
+# Client-side CLI tools
+
+To install python CLI tools without dependencies (to avoid conflicts with your existing packages):
+```sh
+pip install requests
+pip install lfss --no-deps
+```
+
+Then set the `LFSS_ENDPOINT`, `LFSS_TOKEN` environment variables, 
+then you can use the following commands:
+```sh
+# Check current user information
+lfss whoami
+
+# Query a path
+lfss i remote/file[/or_dir/]
+
+# List a specified path, 
+# with pagination and sorting
+lfss ls remote/dir/ --offset 0 --limit 100 --order access_time 
+
+# Upload a file
+lfss up local/file.txt remote/file.txt
+
+# Upload a directory, note the ending slashes
+lfss up local/dir/ remote/dir/
+
+# Download a file
+lfss down remote/file.txt local/file.txt
+
+# Download a directory, with 8 concurrent jobs
+# Overwrite existing files
+lfss down remote/dir/ local/dir/ -j 8 --conflict overwrite  
+```
+
+More commands can be found using `lfss --help`.

{lfss-0.11.6 → lfss-0.12.1}/docs/changelog.md

@@ -1,3 +1,15 @@
+## 0.12
+
+### 0.12.1
+- Add `cat` command
+- Use unicode icons for CLI list command
+
+### 0.12.0
+- Change default script to client CLI
+- Client CLI default to verbose output
+- Client CLI subcommand rename and alias
+- Add delete path and more error handling for client CLI
+
 ## 0.11
 
 ### 0.11.6

{lfss-0.11.6 → lfss-0.12.1}/lfss/api/__init__.py

@@ -75,7 +75,7 @@ def upload_directory(
             this_count = _counter
             dst_path = f"{path}{os.path.relpath(file_path, directory)}"
             if verbose:
-                print(f"[{this_count}] Uploading {file_path} to {dst_path}")
+                print(f"[{this_count}] {file_path} -> {dst_path}")
 
         if not (res:=upload_file(
             c, file_path, dst_path, 
@@ -178,7 +178,7 @@ def download_directory(
             this_count = _counter
             dst_path = f"{directory}{os.path.relpath(decode_uri_components(src_url), decode_uri_components(src_path))}"
             if verbose:
-                print(f"[{this_count}/{file_count}] Downloading {src_url} to {dst_path}")
+                print(f"[{this_count}/{file_count}] {src_url} -> {dst_path}")
 
         if not (res:=download_file(
             c, src_url, dst_path, 

{lfss-0.11.6 → lfss-0.12.1}/lfss/api/connector.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 from typing import Optional, Literal
 from collections.abc import Iterator
-import os, json
+import os
 import requests
 import requests.adapters
 import urllib.parse
 from tempfile import SpooledTemporaryFile
+from concurrent.futures import ThreadPoolExecutor, as_completed
 from lfss.eng.error import PathNotFoundError
 from lfss.eng.datatype import (
     FileReadPermission, FileRecord, DirectoryRecord, UserRecord, PathContents, AccessLevel, 
@@ -17,6 +18,13 @@ _default_endpoint = os.environ.get('LFSS_ENDPOINT', 'http://localhost:8000')
 _default_token = os.environ.get('LFSS_TOKEN', '')
 num_t = float | int
 
+def _p(x: str) -> str:
+    if x == '/':
+        return x
+    if x.startswith('/'):
+        x = x[1:]
+    return x
+
 class Connector:
     class Session:
         def __init__(
@@ -99,6 +107,7 @@ class Connector:
     def put(self, path: str, file_data: bytes, permission: int | FileReadPermission = 0, conflict: Literal['overwrite', 'abort', 'skip', 'skip-ahead'] = 'abort'):
         """Uploads a file to the specified path."""
         assert isinstance(file_data, bytes), "file_data must be bytes"
+        path = _p(path)
 
         # Skip ahead by checking if the file already exists
         if conflict == 'skip-ahead':
@@ -123,6 +132,7 @@ class Connector:
         using the POST method, with form-data/multipart.
         file can be a path to a file on disk, or bytes.
         """
+        path = _p(path)
 
         # Skip ahead by checking if the file already exists
         if conflict == 'skip-ahead':
@@ -155,6 +165,7 @@ class Connector:
         """Uploads a JSON file to the specified path."""
         assert path.endswith('.json'), "Path must end with .json"
         assert isinstance(data, dict), "data must be a dict"
+        path = _p(path)
 
         # Skip ahead by checking if the file already exists
         if conflict == 'skip-ahead':
@@ -184,6 +195,7 @@ class Connector:
 
     def get(self, path: str) -> Optional[bytes]:
         """Downloads a file from the specified path."""
+        path = _p(path)
         response = self._get(path)
         if response is None: return None
         return response.content
@@ -193,19 +205,22 @@ class Connector:
         Downloads a partial file from the specified path.
         start and end are the byte offsets, both inclusive.
         """
+        path = _p(path)
         response = self._fetch_factory('GET', path, extra_headers={
             'Range': f"bytes={range_start if range_start >= 0 else ''}-{range_end if range_end >= 0 else ''}"
         })()
         if response is None: return None
         return response.content
     
-    def get_stream(self, path: str) -> Iterator[bytes]:
+    def get_stream(self, path: str, chunk_size = 1024) -> Iterator[bytes]:
         """Downloads a file from the specified path, will raise PathNotFoundError if path not found."""
+        path = _p(path)
         response = self._get(path, stream=True)
         if response is None: raise PathNotFoundError("Path not found: " + path)
-        return response.iter_content(chunk_size=1024)
+        return response.iter_content(chunk_size)
 
     def get_json(self, path: str) -> Optional[dict]:
+        path = _p(path)
         response = self._get(path)
         if response is None: return None
         assert response.headers['Content-Type'] == 'application/json'
@@ -218,16 +233,18 @@ class Connector:
         """
         response = self._fetch_factory(
             'GET', '_api/get-multiple', 
-            {'path': paths, "skip_content": skip_content}
+            {'path': [_p(p) for p in paths], "skip_content": skip_content}
             )()
         return response.json()
     
     def delete(self, path: str):
         """Deletes the file at the specified path."""
+        path = _p(path)
         self._fetch_factory('DELETE', path)()
     
     def get_meta(self, path: str) -> Optional[FileRecord | DirectoryRecord]:
         """Gets the metadata for the file at the specified path."""
+        path = _p(path)
         try:
             response = self._fetch_factory('GET', '_api/meta', {'path': path})()
             if path.endswith('/'):
@@ -242,19 +259,9 @@ class Connector:
     def get_fmeta(self, path: str) -> Optional[FileRecord]: assert (f:=self.get_meta(path)) is None or isinstance(f, FileRecord); return f 
     def get_dmeta(self, path: str) -> Optional[DirectoryRecord]: assert (d:=self.get_meta(path)) is None or isinstance(d, DirectoryRecord); return d
     
-    def list_path(self, path: str) -> PathContents:
-        """ 
-        shorthand list with limited options, 
-        for large directories / more options, use list_files and list_dirs instead.
-        """
-        assert path.endswith('/')
-        response = self._fetch_factory('GET', path)()
-        dirs = [DirectoryRecord(**d) for d in response.json()['dirs']]
-        files = [FileRecord(**f) for f in response.json()['files']]
-        return PathContents(dirs=dirs, files=files)
-    
     def count_files(self, path: str, flat: bool = False) -> int:
         assert path.endswith('/')
+        path = _p(path)
         response = self._fetch_factory('GET', '_api/count-files', {'path': path, 'flat': flat})()
         return response.json()['count']
 
@@ -264,6 +271,7 @@ class Connector:
         flat: bool = False
     ) -> list[FileRecord]:
         assert path.endswith('/')
+        path = _p(path)
         response = self._fetch_factory('GET', "_api/list-files", {
             'path': path,
             'offset': offset, 'limit': limit, 'order_by': order_by, 'order_desc': order_desc, 'flat': flat
@@ -272,6 +280,7 @@ class Connector:
     
     def count_dirs(self, path: str) -> int:
         assert path.endswith('/')
+        path = _p(path)
         response = self._fetch_factory('GET', '_api/count-dirs', {'path': path})()
         return response.json()['count']
         
@@ -281,32 +290,97 @@ class Connector:
         skim: bool = True
     ) -> list[DirectoryRecord]:
         assert path.endswith('/')
+        path = _p(path)
         response = self._fetch_factory('GET', "_api/list-dirs", {
             'path': path,
             'offset': offset, 'limit': limit, 'order_by': order_by, 'order_desc': order_desc, 'skim': skim
         })()
         return [DirectoryRecord(**d) for d in response.json()]
+    
+    def list_path(
+        self, path: str, offset: int = 0, limit: int = 1000,
+        order_by: FileSortKey = '', order_desc: bool = False, 
+        _workers: int = 2
+    ) -> PathContents:
+        """ Aggregately lists both files and directories under the given path.  """
+        assert path.endswith('/')
+        path = _p(path)
+        if path == '/':
+            # handle root path separately
+            # TODO: change later
+            response = self._fetch_factory('GET', path)()
+            dirs = [DirectoryRecord(**d) for d in response.json()['dirs']]
+            files = [FileRecord(**f) for f in response.json()['files']]
+            return PathContents(dirs=dirs, files=files)
+
+        dirs: list[DirectoryRecord] = []
+        files: list[FileRecord] = []
+        with ThreadPoolExecutor(max_workers=_workers) as executor:
+            count_futures = {
+                executor.submit(self.count_dirs, path): 'dirs',
+                executor.submit(self.count_files, path, flat=False): 'files'
+            }
+            dir_count = 0
+            file_count = 0
+            for future in as_completed(count_futures):
+                if count_futures[future] == 'dirs':
+                    dir_count = future.result()
+                else:
+                    file_count = future.result()
+            dir_offset = offset
+            dir_limit = min(limit, max(0, dir_count - dir_offset))
+            file_offset = max(0, offset - dir_count)
+            file_limit = min(limit - dir_limit, max(0, file_count - file_offset))
+
+            dir_order_by = 'dirname' if order_by == 'url' else ''
+            file_order_by = order_by
+
+            def fetch_dirs():
+                nonlocal dirs
+                if dir_limit > 0:
+                    dirs = self.list_dirs(
+                        path, offset=dir_offset, limit=dir_limit, 
+                        order_by=dir_order_by, order_desc=order_desc
+                    )
+            def fetch_files():
+                nonlocal files
+                if file_limit > 0:
+                    files = self.list_files(
+                        path, offset=file_offset, limit=file_limit, 
+                        order_by=file_order_by, order_desc=order_desc, flat=False
+                    )
+            futures = [
+                executor.submit(fetch_dirs),
+                executor.submit(fetch_files)
+            ]
+            for future in as_completed(futures):
+                future.result()
+        return PathContents(dirs=dirs, files=files)
 
     def set_file_permission(self, path: str, permission: int | FileReadPermission):
         """Sets the file permission for the specified path."""
+        path = _p(path)
         self._fetch_factory('POST', '_api/meta', {'path': path, 'perm': int(permission)})(
             headers={'Content-Type': 'application/www-form-urlencoded'}
         )
         
     def move(self, path: str, new_path: str):
         """Move file or directory to a new path."""
+        path = _p(path); new_path = _p(new_path)
         self._fetch_factory('POST', '_api/meta', {'path': path, 'new_path': new_path})(
             headers = {'Content-Type': 'application/www-form-urlencoded'}
         )
     
     def copy(self, src: str, dst: str):
         """Copy file from src to dst."""
+        src = _p(src); dst = _p(dst)
         self._fetch_factory('POST', '_api/copy', {'src': src, 'dst': dst})(
             headers = {'Content-Type': 'application/www-form-urlencoded'}
         )
     
     def bundle(self, path: str) -> Iterator[bytes]:
         """Bundle a path into a zip file."""
+        path = _p(path)
         response = self._fetch_factory('GET', '_api/bundle', {'path': path})(
             headers = {'Content-Type': 'application/www-form-urlencoded'}, 
             stream = True

lfss-0.12.1/lfss/cli/__init__.py

@@ -0,0 +1,28 @@
+from contextlib import contextmanager
+from typing import Iterable, TypeVar, Generator, Callable, Optional
+import requests, os
+
+@contextmanager
+def catch_request_error(error_code_handler: Optional[ dict[int, Callable[[requests.Response], None]] ] = None):
+    try:
+        yield
+    except requests.RequestException as e:
+        if error_code_handler is not None:
+            if e.response is not None and e.response.status_code in error_code_handler:
+                error_code_handler[e.response.status_code](e.response)
+                return
+        print(f"\033[31m[Request error]: {e}\033[0m")
+        if e.response is not None:
+            print(f"\033[91m[Error message]: {e.response.text}\033[0m")
+
+T = TypeVar('T')
+def line_sep(iter: Iterable[T], enable=True, start=True, end=True, middle=False, color="\033[90m") -> Generator[T, None, None]:
+    screen_width = os.get_terminal_size().columns
+    def print_ln():
+        if enable: print(color + "-" * screen_width + "\033[0m")
+
+    if start: print_ln()
+    for i, line in enumerate(iter):
+        if i > 0 and middle: print_ln()
+        yield line
+    if end: print_ln()

{lfss-0.11.6 → lfss-0.12.1}/lfss/cli/cli.py

@@ -1,9 +1,15 @@
 from pathlib import Path
 import argparse, typing, sys
 from lfss.api import Connector, upload_directory, upload_file, download_file, download_directory
-from lfss.eng.datatype import FileReadPermission, FileSortKey, DirSortKey, AccessLevel
+from lfss.eng.datatype import (
+    FileReadPermission, AccessLevel, 
+    FileSortKey, DirSortKey, 
+    FileRecord, DirectoryRecord, PathContents
+    )
 from lfss.eng.utils import decode_uri_components, fmt_storage_size
+
 from . import catch_request_error, line_sep
+from .cli_lib import mimetype_unicode, stream_text
 
 def parse_permission(s: str) -> FileReadPermission:
     for p in FileReadPermission:
@@ -15,6 +21,53 @@ def parse_access_level(s: str) -> AccessLevel:
         if p.name.lower() == s.lower():
             return p
     raise ValueError(f"Invalid access level {s}")
+def default_error_handler_dict(path: str):
+    return {
+        401: lambda _: print(f"\033[31mUnauthorized\033[0m ({path})", file=sys.stderr),
+        403: lambda _: print(f"\033[31mForbidden\033[0m ({path})", file=sys.stderr),
+        404: lambda _: print(f"\033[31mNot found\033[0m ({path})", file=sys.stderr), 
+        409: lambda _: print(f"\033[31mConflict\033[0m ({path})", file=sys.stderr),
+    }
+def print_path_list(
+    path_list: list[FileRecord] | list[DirectoryRecord] | PathContents, 
+    detailed: bool = False
+    ):
+    dirs: list[DirectoryRecord]
+    files: list[FileRecord]
+    if isinstance(path_list, PathContents):
+        dirs = path_list.dirs
+        files = path_list.files
+    else:
+        dirs = [p for p in path_list if isinstance(p, DirectoryRecord)]
+        files = [p for p in path_list if isinstance(p, FileRecord)]
+    # check if terminal supports unicode
+    supports_unicode = sys.stdout.encoding.lower().startswith("utf")
+    def print_ln(r: DirectoryRecord | FileRecord):
+        nonlocal detailed, supports_unicode
+        match (r, supports_unicode):
+            case (DirectoryRecord(), True):
+                print(mimetype_unicode(r), end=" ")
+            case (DirectoryRecord(), False):
+                print("[D]", end=" ")
+            case (FileRecord(), True):
+                print(mimetype_unicode(r), end=" ")
+            case (FileRecord(), False):
+                print("[F]", end=" ")
+            case _:
+                print("[?]", end=" ")
+        print(decode_uri_components(r.url), end="")
+        if detailed:
+            if isinstance(r, FileRecord):
+                print(f" | {fmt_storage_size(r.file_size)}, permission={r.permission.name}, created={r.create_time}, accessed={r.access_time}")
+            else:
+                print()
+        else:
+            print()
+    
+    for d in line_sep(dirs, end=False):
+        print_ln(d)
+    for f in line_sep(files, start=False):
+        print_ln(f)
 
 def parse_arguments():
     parser = argparse.ArgumentParser(description="Client-side command line interface, set LFSS_ENDPOINT and LFSS_TOKEN environment variables for authentication.")
@@ -30,10 +83,10 @@ def parse_arguments():
     sp_peers.add_argument('-i', '--incoming', action='store_true', help="List users that have access to you (rather than you have access to them")
 
     # upload
-    sp_upload = sp.add_parser("upload", help="Upload file(s)")
+    sp_upload = sp.add_parser("upload", help="Upload a file or directory", aliases=["up"])
     sp_upload.add_argument("src", help="Source file or directory", type=str)
     sp_upload.add_argument("dst", help="Destination url path", type=str)
-    sp_upload.add_argument("-v", "--verbose", action="store_true", help="Verbose output")
+    sp_upload.add_argument("-q", "--quiet", action="store_true", help="Quiet output, no progress info")
     sp_upload.add_argument("-j", "--jobs", type=int, default=1, help="Number of concurrent uploads")
     sp_upload.add_argument("--interval", type=float, default=0, help="Interval between files, only works with directory upload")
     sp_upload.add_argument("--conflict", choices=["overwrite", "abort", "skip", "skip-ahead"], default="abort", help="Conflict resolution")
@@ -41,21 +94,35 @@ def parse_arguments():
     sp_upload.add_argument("--retries", type=int, default=0, help="Number of retries")
 
     # download
-    sp_download = sp.add_parser("download", help="Download file(s)")
+    sp_download = sp.add_parser("download", help="Download a file or directory", aliases=["down"])
     sp_download.add_argument("src", help="Source url path", type=str)
     sp_download.add_argument("dst", help="Destination file or directory", type=str)
-    sp_download.add_argument("-v", "--verbose", action="store_true", help="Verbose output")
+    sp_download.add_argument("-q", "--quiet", action="store_true", help="Quiet output, no progress info")
     sp_download.add_argument("-j", "--jobs", type=int, default=1, help="Number of concurrent downloads")
     sp_download.add_argument("--interval", type=float, default=0, help="Interval between files, only works with directory download")
-    sp_download.add_argument("--overwrite", action="store_true", help="Overwrite existing files")
+    sp_download.add_argument("--conflict", choices=["overwrite", "skip"], default="abort", help="Conflict resolution, only works with file download")
     sp_download.add_argument("--retries", type=int, default=0, help="Number of retries")
 
     # query
-    sp_query = sp.add_parser("query", help="Query file or directories metadata from the server")
-    sp_query.add_argument("path", help="Path to query", nargs="*", type=str)
+    sp_query = sp.add_parser("info", help="Query file or directories metadata from the server", aliases=["i"])
+    sp_query.add_argument("path", help="Path to query", nargs="+", type=str)
+
+    # delete
+    sp_delete = sp.add_parser("delete", help="Delete files or directories", aliases=["del"])
+    sp_delete.add_argument("path", help="Path to delete", nargs="+", type=str)
+    sp_delete.add_argument("-y", "--yes", action="store_true", help="Confirm deletion without prompt")
+
+    # aggregate list
+    sp_list = sp.add_parser("list", help="Aggregately list files and directories of a given path", aliases=["ls"])
+    sp_list.add_argument("path", help="Path to list", type=str)
+    sp_list.add_argument("--offset", type=int, default=0, help="Offset of the list")
+    sp_list.add_argument("--limit", type=int, default=100, help="Limit of the list")
+    sp_list.add_argument("-l", "--long", action="store_true", help="Detailed list, including all metadata")
+    sp_list.add_argument("--order", "--order-by", type=str, help="Order of the list", default="", choices=typing.get_args(FileSortKey))
+    sp_list.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
     # list directories
-    sp_list_d = sp.add_parser("list-dirs", help="List directories of a given path")
+    sp_list_d = sp.add_parser("list-d", help="List directories of a given path", aliases=["lsd"])
     sp_list_d.add_argument("path", help="Path to list", type=str)
     sp_list_d.add_argument("--offset", type=int, default=0, help="Offset of the list")
     sp_list_d.add_argument("--limit", type=int, default=100, help="Limit of the list")
@@ -64,7 +131,7 @@ def parse_arguments():
     sp_list_d.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
     # list files
-    sp_list_f = sp.add_parser("list-files", help="List files of a given path")
+    sp_list_f = sp.add_parser("list-f", help="List files of a given path", aliases=["lsf"])
     sp_list_f.add_argument("path", help="Path to list", type=str)
     sp_list_f.add_argument("--offset", type=int, default=0, help="Offset of the list")
     sp_list_f.add_argument("--limit", type=int, default=100, help="Limit of the list")
@@ -73,6 +140,10 @@ def parse_arguments():
     sp_list_f.add_argument("--order", "--order-by", type=str, help="Order of the list", default="", choices=typing.get_args(FileSortKey))
     sp_list_f.add_argument("--reverse", "--order-desc", action="store_true", help="Reverse the list order")
 
+    # show content
+    sp_show = sp.add_parser("concatenate", help="Concatenate and print files", aliases=["cat"])
+    sp_show.add_argument("path", help="Path to the text files", type=str, nargs="+")
+    sp_show.add_argument("-e", "--encoding", type=str, default="utf-8", help="Text file encoding, default utf-8")
     return parser.parse_args()
 
 def main():
@@ -99,12 +170,12 @@ def main():
             for i, u in enumerate(line_sep(users)):
                 print(f"[{i+1}] {u.username} (id={u.id})")
 
-    elif args.command == "upload":
+    elif args.command in ["upload", "up"]:
         src_path = Path(args.src)
         if src_path.is_dir():
             failed_upload = upload_directory(
                 connector, args.src, args.dst, 
-                verbose=args.verbose,
+                verbose=not args.quiet,
                 n_concurrent=args.jobs, 
                 n_retries=args.retries, 
                 interval=args.interval,
@@ -120,7 +191,7 @@ def main():
                 connector, 
                 file_path = args.src, 
                 dst_url = args.dst, 
-                verbose=args.verbose,
+                verbose=not args.quiet,
                 n_retries=args.retries, 
                 interval=args.interval,
                 conflict=args.conflict,
@@ -129,16 +200,16 @@ def main():
             if not success:
                 print("\033[91mFailed to upload: \033[0m", msg, file=sys.stderr)
     
-    elif args.command == "download":
+    elif args.command in ["download", "down"]:
         is_dir = args.src.endswith("/")
         if is_dir:
             failed_download = download_directory(
                 connector, args.src, args.dst, 
-                verbose=args.verbose,
+                verbose=not args.quiet,
                 n_concurrent=args.jobs, 
                 n_retries=args.retries, 
                 interval=args.interval,
-                overwrite=args.overwrite
+                overwrite=args.conflict == "overwrite"
             )
             if failed_download:
                 print("\033[91mFailed to download:\033[0m", file=sys.stderr)
@@ -149,7 +220,7 @@ def main():
                 connector, 
                 src_url = args.src, 
                 file_path = args.dst, 
-                verbose=args.verbose,
+                verbose=not args.quiet,
                 n_retries=args.retries, 
                 interval=args.interval,
                 overwrite=args.overwrite
@@ -157,17 +228,44 @@ def main():
             if not success:
                 print("\033[91mFailed to download: \033[0m", msg, file=sys.stderr)
     
-    elif args.command == "query":
+    elif args.command in ["delete", "del"]:
+        if not args.yes:
+            print("You are about to delete the following paths:")
+            for path in args.path:
+                print("[D]" if path.endswith("/") else "[F]", path)
+            confirm = input("Are you sure? ([yes]/no): ")
+            if confirm.lower() not in ["", "y", "yes"]:
+                print("Aborted.")
+                exit(0)
         for path in args.path:
-            with catch_request_error():
+            with catch_request_error(default_error_handler_dict(path)):
+                connector.delete(path)
+                print(f"\033[32mDeleted\033[0m ({path})")
+    
+    elif args.command in ["info", "i"]:
+        for path in args.path:
+            with catch_request_error(default_error_handler_dict(path)):
                 res = connector.get_meta(path)
                 if res is None:
                     print(f"\033[31mNot found\033[0m ({path})")
                 else:
                     print(res)
     
-    elif args.command == "list-files":
-        with catch_request_error():
+    elif args.command in ["ls", "list"]:
+        with catch_request_error(default_error_handler_dict(args.path)):
+            res = connector.list_path(
+                args.path, 
+                offset=args.offset, 
+                limit=args.limit, 
+                order_by=args.order,
+                order_desc=args.reverse,
+            )
+            print_path_list(res, detailed=args.long)
+            if len(res.dirs) + len(res.files) == args.limit:
+                print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more items.\033[0m")
+    
+    elif args.command in ["lsf", "list-f"]:
+        with catch_request_error(default_error_handler_dict(args.path)):
             res = connector.list_files(
                 args.path, 
                 offset=args.offset, 
@@ -176,15 +274,12 @@ def main():
                 order_by=args.order,
                 order_desc=args.reverse,
             )
-            for i, f in enumerate(line_sep(res)):
-                f.url = decode_uri_components(f.url)
-                print(f"[{i+1}] {f if args.long else f.url}")
-
+            print_path_list(res, detailed=args.long)
             if len(res) == args.limit:
-                print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more files.")
+                print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more files.\033[0m")
         
-    elif args.command == "list-dirs":
-        with catch_request_error():
+    elif args.command in ["lsd", "list-d"]:
+        with catch_request_error(default_error_handler_dict(args.path)):
             res = connector.list_dirs(
                 args.path, 
                 offset=args.offset, 
@@ -193,12 +288,18 @@ def main():
                 order_by=args.order,
                 order_desc=args.reverse,
             )
-            for i, d in enumerate(line_sep(res)):
-                d.url = decode_uri_components(d.url)
-                print(f"[{i+1}] {d if args.long else d.url}")
-
+            print_path_list(res, detailed=args.long)
             if len(res) == args.limit:
-                print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more directories.")
+                print(f"\033[33m[Warning] List limit reached, use --offset and --limit to list more directories.\033[0m")
+    
+    elif args.command in ["cat", "concatenate"]:
+        for _p in args.path:
+            with catch_request_error(default_error_handler_dict(_p)):
+                try:
+                    for chunk in stream_text(connector, _p, encoding=args.encoding):
+                        print(chunk, end="")
+                except (FileNotFoundError, ValueError) as e:
+                    print(f"\033[31m{e}\033[0m", file=sys.stderr)
     
     else:
         raise NotImplementedError(f"Command {args.command} not implemented.")

lfss-0.12.1/lfss/cli/cli_lib.py

@@ -0,0 +1,64 @@
+
+from ..api.connector import Connector
+from ..eng.datatype import DirectoryRecord, FileRecord
+
+def mimetype_unicode(r: DirectoryRecord | FileRecord):
+    if isinstance(r, DirectoryRecord):
+        return "📁"
+    if r.mime_type in ["application/pdf", "application/x-pdf"]:
+        return "📕"
+    elif r.mime_type.startswith("image/"):
+        return "🖼️"
+    elif r.mime_type.startswith("video/"):
+        return "🎞️"
+    elif r.mime_type.startswith("audio/"):
+        return "🎵"
+    elif r.mime_type in ["application/zip", "application/x-tar", "application/gzip", "application/x-7z-compressed"]:
+        return "📦"
+    elif r.mime_type in ["application/vnd.ms-excel", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]:
+        return "📊"
+    elif r.mime_type in ["application/x-msdownload", "application/x-executable", "application/x-mach-binary", "application/x-elf"]:
+        return "💻"
+    elif r.mime_type in ["application/vnd.ms-powerpoint", "application/vnd.openxmlformats-officedocument.presentationml.presentation"]:
+        return "📈"
+    elif r.mime_type in set([
+        "text/html", "application/xhtml+xml", "application/xml", "text/css", "text/x-scss", "application/javascript", "text/javascript",
+        "application/json", "text/x-yaml", "text/x-markdown", "application/wasm", 
+        "text/x-ruby", "application/x-ruby", "text/x-perl", "application/x-lisp", 
+        "text/x-haskell", "text/x-lua", "application/x-tcl", 
+        "text/x-python", "text/x-java-source", "text/x-go", "application/x-rust", "text/x-asm", 
+        "application/sql", "text/x-c", "text/x-c++", "text/x-csharp", 
+        "application/x-httpd-php", "application/x-sh", "application/x-shellscript", 
+        "application/x-latex", "application/x-tex", 
+    ]):
+        return "👨‍💻"
+    elif r.mime_type.startswith("text/"):
+        return "📃"
+    return "📄"
+
+def stream_text(
+    conn: Connector, 
+    path: str,
+    encoding="utf-8",
+    chunk_size=1024 * 8,
+    ):
+    """
+    Stream text content of a file from the server.
+    Raise FileNotFoundError if the file does not exist.
+    Raise ValueError if the file size exceeds MAX_TEXT_SIZE.
+    
+    Yields str chunks.
+    """
+    MAX_TEXT_SIZE = 100 * 1024 * 1024  # 100 MB
+    r = conn.get_fmeta(path)
+    if r is None:
+        raise FileNotFoundError(f"File not found: {path}")
+    if r.file_size > MAX_TEXT_SIZE:
+        raise ValueError(f"File size {r.file_size} exceeds maximum text size {MAX_TEXT_SIZE}")
+    ss = conn.get_stream(r.url, chunk_size=chunk_size)
+    total_read = 0
+    for chunk in ss:
+        total_read += len(chunk)
+        if total_read > MAX_TEXT_SIZE:
+            raise ValueError(f"File size exceeds maximum text size {MAX_TEXT_SIZE}")
+        yield chunk.decode(encoding, errors='replace')  # decode bytes to str, replace errors

{lfss-0.11.6 → lfss-0.12.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lfss"
-version = "0.11.6"
+version = "0.12.1"
 description = "Lite file storage service"
 authors = ["Li, Mengxun <mengxunli@whu.edu.cn>"]
 readme = "Readme.md"

lfss-0.11.6/docs/Client.md

@@ -1,40 +0,0 @@
-
-# Client-side CLI tools
-
-To install python CLI tools without dependencies (to avoid conflicts with your existing packages):
-```sh
-pip install requests
-pip install lfss --no-deps
-```
-
-Then set the `LFSS_ENDPOINT`, `LFSS_TOKEN` environment variables, 
-then you can use the following commands:
-```sh
-# Check current user information
-lfss whoami
-
-# Query a path
-lfss query remote/file[/or_dir/]
-
-# List directories of a specified path
-lfss list-dirs remote/dir/
-
-# List files of a specified path, 
-# with pagination and sorting
-lfss list-files --offset 0 --limit 100 --order access_time remote/dir/
-
-# Upload a file
-lfss upload local/file.txt remote/file.txt
-
-# Upload a directory, note the ending slashes
-lfss upload local/dir/ remote/dir/
-
-# Download a file
-lfss download remote/file.txt local/file.txt
-
-# Download a directory, with verbose output and 8 concurrent jobs
-# Overwrite existing files
-lfss download -v -j 8 --conflict overwrite remote/dir/ local/dir/   
-```
-
-More commands can be found using `lfss-cli --help`.

lfss-0.11.6/lfss/cli/__init__.py

@@ -1,27 +0,0 @@
-from contextlib import contextmanager
-from typing import Iterable, TypeVar, Generator
-import requests, os
-
-@contextmanager
-def catch_request_error():
-    try:
-        yield
-    except requests.RequestException as e:
-        print(f"\033[31m[Request error]: {e}\033[0m")
-        if e.response is not None:
-            print(f"\033[91m[Error message]: {e.response.text}\033[0m")
-
-T = TypeVar('T')
-def line_sep(iter: Iterable[T], enable=True, start=True, end=True, color="\033[90m") -> Generator[T, None, None]:
-    screen_width = os.get_terminal_size().columns
-    def print_ln():
-        print(color + "-" * screen_width + "\033[0m")
-
-    if start and enable:
-        print_ln()
-    for i, line in enumerate(iter):
-        if enable and i > 0:
-            print_ln()
-        yield line
-    if end and enable:
-        print_ln()