Merge pull request #29 from ileodo/feature/feed

[Add] Support downloading pictures from the posts in feed (only liked ones)

Author: jacobbunk

README.md

@@ -82,10 +82,15 @@ Options:
                                   FAMLY_PASSWORD env var
   --access-token TOKEN            Your famly.co access token, can be set via
                                   FAMLY_ACCESS_TOKEN env var
+  --famly-base-url URL            Your famly.co instance baseurl (default:
+                                  https://app.famly.co), can be set via
+                                  FAMLY_BASE_URL env var
   --no-tagged                     Don't download tagged images
   -j, --journey                   Download images from child Learning Journey
   -n, --notes                     Download images from child notes
   -m, --messages                  Download images from messages
+  -l, --liked                     Download images which is liked by the
+                                  parents from all posts (in the feed)
   -p, --pictures-folder DIRECTORY
                                   Directory to save downloaded pictures, can
                                   be set via FAMLY_PICTURES_FOLDER env var
@@ -94,7 +99,7 @@ Options:
                                   file is encountered
   -u, --user-agent                User Agent used in Famly requests, can be
                                   set via FAMLY_USER_AGENT env var  [default:
-                                  famly-fetch/0.2.0]
+                                  famly-fetch/0.4.0]
   --latitude LAT                  Latitude for EXIF GPS data, can be set via
                                   LATITUDE env var
   --longitude LONG                Longitude for EXIF GPS data, can be set via

pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "famly-fetch"
-version = "0.3.0"
+version = "0.4.0"
 authors = [
     { name = "Jacob Bunk Nielsen" },
     { name = "Morten Siebuhr" },
-    { name = "iLeoDo" },
-    { name = "Tom Vincent" },    
+    { name = "Tianwei Dong", email = "iLeoDo@Gmail.com" },
+    { name = "Tom Vincent" },
 ]
 description = "Fetch your (kid's) images from famly.co"
 license-files = ["LICENSE"]

src/famly_fetch/api_client.py

@@ -24,9 +24,13 @@ def get_device_id() -> str:
 
 class ApiClient:
     _access_token = None
-    _base = "https://app.famly.co"
 
-    def __init__(self, user_agent: str | None = None, access_token: str | None = None):
+    def __init__(
+        self,
+        base_url: str,
+        user_agent: str | None = None,
+        access_token: str | None = None,
+    ):
         """
         Initialize the ApiClient.
 
@@ -37,6 +41,7 @@ def __init__(self, user_agent: str | None = None, access_token: str | None = Non
         self._user_agent: str | None = user_agent
         self._device_id = get_device_id()
         self._access_token = access_token
+        self._base = base_url
 
     def login(self, email, password):
         """
@@ -159,6 +164,21 @@ def make_api_request(self, method, path, body=None, params=None):
             print("Error code: ", e.code)
             print("Response body: ", e.read())
 
+    def feed(
+        self,
+        cursor: str | None = None,
+        older_than: str | None = None,
+        limit: int | None = None,
+    ):
+        params = {}
+        if cursor:
+            params["cursor"] = cursor
+        if older_than:
+            params["olderThan"] = older_than
+        if limit:
+            params["first"] = limit
+        return self.make_api_request("GET", "/api/feed/feed/feed", params=params)
+
     def me_me_me(self):
         """
         Get information about the currently authenticated user.
@@ -172,3 +192,17 @@ def me_me_me(self):
         """
 
         return self.make_api_request("GET", "/api/me/me/me")
+
+    def get_relations(self, child_id: str) -> list[dict]:
+        """
+        Get the relations of a given child ID.
+
+        Args:
+            child_id (str): The ID of the child.
+
+        Returns:
+            list[dict]: A list of dictionary representing the relations.
+        """
+        return self.make_api_request(
+            "GET", "/api/v2/relations", params={"childId": child_id}
+        )

src/famly_fetch/cli.py

@@ -36,12 +36,26 @@ def get_version():
     metavar="TOKEN",
     type=str,
 )
+@click.option(
+    "--famly-base-url",
+    envvar="FAMLY_BASE_URL",
+    help="Your famly.co instance baseurl (default: https://app.famly.co), can be set via FAMLY_BASE_URL env var",
+    metavar="URL",
+    default="https://app.famly.co",
+    type=str,
+)
 @click.option("--no-tagged", is_flag=True, help="Don't download tagged images")
 @click.option(
     "-j", "--journey", is_flag=True, help="Download images from child Learning Journey"
 )
 @click.option("-n", "--notes", is_flag=True, help="Download images from child notes")
 @click.option("-m", "--messages", is_flag=True, help="Download images from messages")
+@click.option(
+    "-l",
+    "--liked",
+    is_flag=True,
+    help="Download images which is liked by the parents from all posts (in the feed)",
+)
 @click.option(
     "-p",
     "--pictures-folder",
@@ -123,10 +137,12 @@ def main(
     email: str,
     password: str,
     access_token: str,
+    famly_base_url: str,
     no_tagged: bool,
     journey: bool,
     notes: bool,
     messages: bool,
+    liked: bool,
     pictures_folder: Path,
     stop_on_existing: bool,
     user_agent: str,
@@ -160,6 +176,7 @@ def main(
         famly_downloader = FamlyDownloader(
             email=email,
             password=password,
+            famly_base_url=famly_base_url,
             pictures_folder=pictures_folder,
             stop_on_existing=stop_on_existing,
             text_comments=text_comments,
@@ -175,7 +192,9 @@ def main(
             famly_downloader.download_images_from_messages()
 
         # Process each child
+        parent_ids = set()
         for child_id, first_name in famly_downloader.get_all_children():
+            parent_ids |= famly_downloader.get_parents_ids(child_id)
             if not no_tagged:
                 famly_downloader.download_tagged_images(child_id, first_name)
             if journey:
@@ -184,6 +203,10 @@ def main(
                 )
             if notes:
                 famly_downloader.download_images_from_notes(child_id, first_name)
+
+        if liked:
+            famly_downloader.download_images_from_feed(parent_ids)
+
     except Exception as e:
         click.secho(f"An exception occurred: {e}", fg="red")
 

src/famly_fetch/downloader.py

@@ -31,6 +31,7 @@ def __init__(
         self,
         email: str,
         password: str,
+        famly_base_url: str,
         pictures_folder: Path,
         stop_on_existing: bool,
         text_comments: bool,
@@ -52,7 +53,9 @@ def __init__(
         self.state_file = state_file
         self.downloaded_images = self.load_state()
 
-        self._apiClient = ApiClient(user_agent=user_agent, access_token=access_token)
+        self._apiClient = ApiClient(
+            base_url=famly_base_url, user_agent=user_agent, access_token=access_token
+        )
         if not access_token:
             self._apiClient.login(email, password)
 
@@ -88,6 +91,10 @@ def get_all_children(self):
 
         return all_children
 
+    def get_parents_ids(self, child_id: str) -> set[str]:
+        relations = self._apiClient.get_relations(child_id)
+        return {x["loginId"] for x in relations if x["loginId"]}
+
     def download_images_from_notes(self, child_id, first_name):
         click.secho(
             f"Downloading learning journey images for {first_name}...", fg="green"
@@ -254,6 +261,59 @@ def download_images_from_messages(self):
 
         self.save_state()
 
+    def download_images_from_feed(self, liked_by_ids: set[str]):
+        click.secho("Downloading liked images in posts...", fg="green")
+
+        cursor = None
+        older_than = None
+        while True:
+            click.echo("Fetching next 10 Posts")
+            response = self._apiClient.feed(
+                cursor=cursor, older_than=older_than, limit=10
+            )
+            if not response["feedItems"]:
+                break
+            last_item = response["feedItems"][-1]
+            cursor = last_item["feedItemId"]
+            older_than = last_item["createdDate"]
+            for feed_item in response["feedItems"]:
+                if not feed_item["originatorId"].startswith("Post:"):
+                    # not a Post item
+                    continue
+                create_date = feed_item["createdDate"]
+                for img_dict in feed_item["images"]:
+                    if not (
+                        img_dict["liked"]
+                        or [
+                            like
+                            for like in img_dict["likes"]
+                            if like["loginId"] in liked_by_ids
+                        ]
+                    ):
+                        # not liked by parents
+                        continue
+                    img = Image.from_dict(
+                        img_dict,
+                        date_override=create_date,
+                        text_override=feed_item["body"] if self.text_comments else None,
+                    )
+                    click.echo(f" - image {img.img_id} from post at {create_date}")
+
+                    if img.img_id in self.downloaded_images:
+                        click.secho(
+                            f"Image {img.img_id} already downloaded, {'stopping download' if self.stop_on_existing else 'skipping'}.",
+                            fg="yellow",
+                        )
+                        if self.stop_on_existing:
+                            return
+                        else:
+                            continue
+                    file_path = self.download_file_path(img, "post")
+                    self.fetch_image(img, file_path)
+                    self.mark_as_downloaded(img.img_id)
+
+        self.save_state()
+
     def download_file_path(self, img: BaseImage, filename_prefix: str) -> Path:
         """Generate the file path for the downloaded image."""