sticker-convert 2.8.12__py3-none-any.whl → 2.17.0.0__py3-none-any.whl

sticker_convert/uploaders/xcode_imessage.py

@@ -1,285 +1,295 @@
-#!/usr/bin/env python3
-import copy
-import json
-import os
-import plistlib
-import shutil
-import zipfile
-from pathlib import Path
-from typing import Any, Dict, List
-
-from sticker_convert.converter import StickerConvert
-from sticker_convert.definitions import ROOT_DIR
-from sticker_convert.job_option import CompOption, CredOption, OutputOption
-from sticker_convert.uploaders.upload_base import UploadBase
-from sticker_convert.utils.callback import CallbackProtocol, CallbackReturn
-from sticker_convert.utils.files.metadata_handler import XCODE_IMESSAGE_ICONSET, MetadataHandler
-from sticker_convert.utils.files.sanitize_filename import sanitize_filename
-from sticker_convert.utils.media.codec_info import CodecInfo
-from sticker_convert.utils.media.format_verify import FormatVerify
-
-
-class XcodeImessage(UploadBase):
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kwargs)
-        self.base_spec.set_size_max(500000)
-        self.base_spec.set_res(300)
-        self.base_spec.set_format(("png", ".apng", ".gif", ".jpeg", "jpg"))
-        self.base_spec.square = True
-
-        self.small_spec = copy.deepcopy(self.base_spec)
-
-        self.medium_spec = copy.deepcopy(self.base_spec)
-        self.medium_spec.set_res(408)
-
-        self.large_spec = copy.deepcopy(self.base_spec)
-        self.large_spec.set_res(618)
-
-    def create_imessage_xcode(self) -> List[str]:
-        urls: List[str] = []
-        title, author, _ = MetadataHandler.get_metadata(
-            self.opt_output.dir,
-            title=self.opt_output.title,
-            author=self.opt_output.author,
-        )
-        if not author:
-            self.cb.put("author is required for creating Xcode iMessage sticker pack")
-            return urls
-        if not title:
-            self.cb.put("title is required for creating Xcode iMessage sticker pack")
-            return urls
-
-        author = author.replace(" ", "_")
-        title = title.replace(" ", "_")
-        packs = MetadataHandler.split_sticker_packs(
-            self.opt_output.dir,
-            title=title,
-            file_per_pack=100,
-            separate_image_anim=False,
-        )
-
-        res_choice = None
-        spec_choice = None
-        opt_comp_merged = copy.deepcopy(self.opt_comp)
-
-        for pack_title, stickers in packs.items():
-            pack_title = sanitize_filename(pack_title)
-
-            for src in stickers:
-                self.cb.put(f"Verifying {src} for creating Xcode iMessage sticker pack")
-
-                fpath = Path(self.opt_output.dir, src)
-
-                if res_choice is None:
-                    res_choice, _ = CodecInfo.get_file_res(fpath)
-
-                    if res_choice == 618:
-                        spec_choice = self.large_spec
-                    elif res_choice == 408:
-                        spec_choice = self.medium_spec
-                    else:
-                        # res_choice == 300
-                        spec_choice = self.small_spec
-
-                    opt_comp_merged.merge(spec_choice)
-
-                assert spec_choice
-                if not FormatVerify.check_file(src, spec=spec_choice):
-                    StickerConvert.convert(
-                        fpath, fpath, opt_comp_merged, self.cb, self.cb_return
-                    )
-
-            self.add_metadata(author, pack_title)
-            self.create_xcode_proj(author, pack_title)
-
-            result = Path(self.opt_output.dir / pack_title).as_posix()
-            self.cb.put(result)
-            urls.append(result)
-
-        return urls
-
-    def add_metadata(self, author: str, title: str) -> None:
-        first_image_path = Path(
-            self.opt_output.dir,
-            [
-                i
-                for i in sorted(self.opt_output.dir.iterdir())
-                if (self.opt_output.dir / i).is_file() and i.suffix == ".png"
-            ][0],
-        )
-        cover_path = MetadataHandler.get_cover(self.opt_output.dir)
-        if cover_path:
-            icon_source = cover_path
-        else:
-            icon_source = first_image_path
-
-        for icon, res in XCODE_IMESSAGE_ICONSET.items():
-            spec_cover = CompOption()
-            spec_cover.set_res_w(res[0])
-            spec_cover.set_res_h(res[1])
-            spec_cover.set_fps(0)
-
-            icon_path = self.opt_output.dir / icon
-            if Path(icon) in list(
-                self.opt_output.dir.iterdir()
-            ) and not FormatVerify.check_file(icon_path, spec=spec_cover):
-                StickerConvert.convert(
-                    icon_path, icon_path, spec_cover, self.cb, self.cb_return
-                )
-            else:
-                StickerConvert.convert(
-                    icon_source, icon_path, spec_cover, self.cb, self.cb_return
-                )
-
-        MetadataHandler.set_metadata(self.opt_output.dir, author=author, title=title)
-
-    def create_xcode_proj(self, author: str, title: str) -> None:
-        pack_path = self.opt_output.dir / title
-        if (ROOT_DIR / "ios-message-stickers-template.zip").is_file():
-            with zipfile.ZipFile(
-                ROOT_DIR / "ios-message-stickers-template.zip", "r"
-            ) as f:
-                f.extractall(pack_path)
-        elif (ROOT_DIR / "ios-message-stickers-template").is_dir():
-            shutil.copytree(ROOT_DIR / "ios-message-stickers-template", pack_path)
-        else:
-            self.cb.put(
-                "Failed to create Xcode project: ios-message-stickers-template not found"
-            )
-
-        os.remove(pack_path / "README.md")
-        shutil.rmtree(
-            pack_path / "stickers.xcodeproj/project.xcworkspace",
-            ignore_errors=True,
-        )
-        shutil.rmtree(pack_path / "stickers.xcodeproj/xcuserdata", ignore_errors=True)
-
-        with open(
-            pack_path / "stickers.xcodeproj/project.pbxproj",
-            encoding="utf-8",
-        ) as f:
-            pbxproj_data = f.read()
-
-        pbxproj_data = pbxproj_data.replace(
-            "stickers StickerPackExtension", f"{title} StickerPackExtension"
-        )
-        pbxproj_data = pbxproj_data.replace("stickers.app", f"{title}.app")
-        pbxproj_data = pbxproj_data.replace("/* stickers */", f"/* {title} */")
-        pbxproj_data = pbxproj_data.replace("name = stickers", f"name = {title}")
-        pbxproj_data = pbxproj_data.replace(
-            "productName = stickers", f"productName = {title}"
-        )
-        pbxproj_data = pbxproj_data.replace(
-            '/* Build configuration list for PBXProject "stickers" */',
-            f'/* Build configuration list for PBXProject "{title}" */',
-        )
-        pbxproj_data = pbxproj_data.replace(
-            '/* Build configuration list for PBXNativeTarget "stickers StickerPackExtension" */',
-            f'/* Build configuration list for PBXNativeTarget "{title} StickerPackExtension" */',
-        )
-        pbxproj_data = pbxproj_data.replace(
-            '/* Build configuration list for PBXNativeTarget "stickers" */',
-            f'/* Build configuration list for PBXNativeTarget "{title}" */',
-        )
-        pbxproj_data = pbxproj_data.replace("com.niklaspeterson", f"com.{author}")
-        pbxproj_data = pbxproj_data.replace(
-            "stickers/Info.plist", f"{title}/Info.plist"
-        )
-
-        with open(
-            pack_path / "stickers.xcodeproj/project.pbxproj",
-            "w+",
-            encoding="utf-8",
-        ) as f:
-            f.write(pbxproj_data)
-
-        # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack
-        stickers_path = (
-            pack_path
-            / "stickers StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack"
-        )
-
-        for i in stickers_path.iterdir():
-            if i.suffix == ".sticker":
-                shutil.rmtree(stickers_path / i)
-
-        stickers_lst: List[str] = []
-        for i in sorted(self.opt_output.dir.iterdir()):
-            if (
-                CodecInfo.get_file_ext(i) == ".png"
-                and i.stem != "cover"
-                and i.name not in XCODE_IMESSAGE_ICONSET
-            ):
-                sticker_dir = f"{i.stem}.sticker"  # 0.sticker
-                stickers_lst.append(sticker_dir)
-                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker
-                sticker_path = stickers_path / sticker_dir
-                os.mkdir(sticker_path)
-                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker/0.png
-                shutil.copy(self.opt_output.dir / i.name, sticker_path / i.name)
-
-                sticker_json_content = {
-                    "info": {
-                        "author": "xcode",
-                        "version": 1,
-                    },
-                    "properties": {"filename": str(i)},
-                }
-
-                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker/Contents.json
-                with open(sticker_path / "Contents.json", "w+", encoding="utf-8") as f:
-                    json.dump(sticker_json_content, f, indent=2)
-
-        # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/Contents.json
-        with open(stickers_path / "Contents.json", encoding="utf-8") as f:
-            stickerpack_json_content: Dict[str, List[Dict[str, str]]] = json.load(f)
-
-        stickerpack_json_content["stickers"] = []
-        for sticker in stickers_lst:
-            stickerpack_json_content["stickers"].append({"filename": sticker})
-
-        with open(stickers_path / "Contents.json", "w+", encoding="utf-8") as f:
-            json.dump(stickerpack_json_content, f, indent=2)
-
-        # packname StickerPackExtension/Stickers.xcstickers/iMessage App Icon.stickersiconset
-        iconset_path = (
-            pack_path
-            / "stickers StickerPackExtension/Stickers.xcstickers/iMessage App Icon.stickersiconset"
-        )
-
-        for iconfile_name in iconset_path.iterdir():
-            if Path(iconfile_name).suffix == ".png":
-                os.remove(iconset_path / iconfile_name)
-
-        icons_lst: List[str] = []
-        for icon in XCODE_IMESSAGE_ICONSET:
-            shutil.copy(self.opt_output.dir / icon, iconset_path / icon)
-            icons_lst.append(icon)
-
-        # packname/Info.plist
-        plist_path = pack_path / "stickers/Info.plist"
-        with open(plist_path, "rb") as f:
-            plist_dict = plistlib.load(f)
-        plist_dict["CFBundleDisplayName"] = title
-
-        with open(plist_path, "wb+") as f:
-            plistlib.dump(plist_dict, f)
-
-        Path(pack_path, "stickers").rename(Path(pack_path, title))
-        Path(pack_path, "stickers StickerPackExtension").rename(
-            Path(pack_path, f"{title} StickerPackExtension")
-        )
-        Path(pack_path, "stickers.xcodeproj").rename(
-            Path(pack_path, f"{title}.xcodeproj")
-        )
-
-    @staticmethod
-    def start(
-        opt_output: OutputOption,
-        opt_comp: CompOption,
-        opt_cred: CredOption,
-        cb: CallbackProtocol,
-        cb_return: CallbackReturn,
-    ) -> List[str]:
-        exporter = XcodeImessage(opt_output, opt_comp, opt_cred, cb, cb_return)
-        return exporter.create_imessage_xcode()
+#!/usr/bin/env python3
+import copy
+import json
+import os
+import plistlib
+import shutil
+import zipfile
+from pathlib import Path
+from typing import Any, Dict, List, Tuple
+
+from sticker_convert.converter import StickerConvert
+from sticker_convert.definitions import ROOT_DIR
+from sticker_convert.job_option import CompOption, CredOption, OutputOption
+from sticker_convert.uploaders.upload_base import UploadBase
+from sticker_convert.utils.callback import CallbackProtocol, CallbackReturn
+from sticker_convert.utils.files.metadata_handler import XCODE_IMESSAGE_ICONSET, MetadataHandler
+from sticker_convert.utils.files.sanitize_filename import sanitize_filename
+from sticker_convert.utils.media.codec_info import CodecInfo
+from sticker_convert.utils.media.format_verify import FormatVerify
+from sticker_convert.utils.translate import I
+
+
+class XcodeImessage(UploadBase):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.base_spec.set_size_max(500000)
+        self.base_spec.set_res(300)
+        self.base_spec.set_format(("png", ".apng", ".gif", ".jpeg", "jpg"))
+
+        self.small_spec = copy.deepcopy(self.base_spec)
+
+        self.medium_spec = copy.deepcopy(self.base_spec)
+        self.medium_spec.set_res(408)
+
+        self.large_spec = copy.deepcopy(self.base_spec)
+        self.large_spec.set_res(618)
+
+    def create_imessage_xcode(self) -> Tuple[int, int, List[str]]:
+        urls: List[str] = []
+        title, author, _ = MetadataHandler.get_metadata(
+            self.opt_output.dir,
+            title=self.opt_output.title,
+            author=self.opt_output.author,
+        )
+        if not author:
+            self.cb.put(
+                I("author is required for creating Xcode iMessage sticker pack")
+            )
+            return 0, 0, urls
+        if not title:
+            self.cb.put(I("title is required for creating Xcode iMessage sticker pack"))
+            return 0, 0, urls
+
+        author = author.replace(" ", "_")
+        title = title.replace(" ", "_")
+        packs = MetadataHandler.split_sticker_packs(
+            self.opt_output.dir,
+            title=title,
+            file_per_pack=100,
+            separate_image_anim=False,
+        )
+
+        res_choice = None
+        spec_choice = None
+        opt_comp_merged = copy.deepcopy(self.opt_comp)
+
+        stickers_total = 0
+        for pack_title, stickers in packs.items():
+            pack_title = sanitize_filename(pack_title)
+
+            for src in stickers:
+                self.cb.put(
+                    I("Verifying {} for creating Xcode iMessage sticker pack").format(
+                        src
+                    )
+                )
+
+                fpath = Path(self.opt_output.dir, src)
+
+                if res_choice is None:
+                    res_choice, _ = CodecInfo.get_file_res(fpath)
+
+                    if res_choice == 618:
+                        spec_choice = self.large_spec
+                    elif res_choice == 408:
+                        spec_choice = self.medium_spec
+                    else:
+                        # res_choice == 300
+                        spec_choice = self.small_spec
+
+                    opt_comp_merged.merge(spec_choice)
+
+                assert spec_choice
+                if not FormatVerify.check_file(src, spec=spec_choice):
+                    StickerConvert.convert(
+                        fpath, fpath, opt_comp_merged, self.cb, self.cb_return
+                    )
+                stickers_total += 1
+
+            self.add_metadata(author, pack_title)
+            self.create_xcode_proj(author, pack_title)
+
+            result = Path(self.opt_output.dir / pack_title).as_posix()
+            self.cb.put(result)
+            urls.append(result)
+
+        return stickers_total, stickers_total, urls
+
+    def add_metadata(self, author: str, title: str) -> None:
+        first_image_path = Path(
+            self.opt_output.dir,
+            [
+                i
+                for i in sorted(self.opt_output.dir.iterdir())
+                if (self.opt_output.dir / i).is_file() and i.suffix == ".png"
+            ][0],
+        )
+        cover_path = MetadataHandler.get_cover(self.opt_output.dir)
+        if cover_path:
+            icon_source = cover_path
+        else:
+            icon_source = first_image_path
+
+        for icon, res in XCODE_IMESSAGE_ICONSET.items():
+            spec_cover = CompOption()
+            spec_cover.set_res_w(res[0])
+            spec_cover.set_res_h(res[1])
+            spec_cover.set_fps(0)
+
+            icon_path = self.opt_output.dir / icon
+            if Path(icon) in list(
+                self.opt_output.dir.iterdir()
+            ) and not FormatVerify.check_file(icon_path, spec=spec_cover):
+                StickerConvert.convert(
+                    icon_path, icon_path, spec_cover, self.cb, self.cb_return
+                )
+            else:
+                StickerConvert.convert(
+                    icon_source, icon_path, spec_cover, self.cb, self.cb_return
+                )
+
+        MetadataHandler.set_metadata(self.opt_output.dir, author=author, title=title)
+
+    def create_xcode_proj(self, author: str, title: str) -> None:
+        pack_path = self.opt_output.dir / title
+        if (ROOT_DIR / "ios-message-stickers-template.zip").is_file():
+            with zipfile.ZipFile(
+                ROOT_DIR / "ios-message-stickers-template.zip", "r"
+            ) as f:
+                f.extractall(pack_path)
+        elif (ROOT_DIR / "ios-message-stickers-template").is_dir():
+            shutil.copytree(ROOT_DIR / "ios-message-stickers-template", pack_path)
+        else:
+            self.cb.put(
+                I(
+                    "Failed to create Xcode project: ios-message-stickers-template not found"
+                )
+            )
+
+        os.remove(pack_path / "README.md")
+        shutil.rmtree(
+            pack_path / "stickers.xcodeproj/project.xcworkspace",
+            ignore_errors=True,
+        )
+        shutil.rmtree(pack_path / "stickers.xcodeproj/xcuserdata", ignore_errors=True)
+
+        with open(
+            pack_path / "stickers.xcodeproj/project.pbxproj",
+            encoding="utf-8",
+        ) as f:
+            pbxproj_data = f.read()
+
+        pbxproj_data = pbxproj_data.replace(
+            "stickers StickerPackExtension", f"{title} StickerPackExtension"
+        )
+        pbxproj_data = pbxproj_data.replace("stickers.app", f"{title}.app")
+        pbxproj_data = pbxproj_data.replace("/* stickers */", f"/* {title} */")
+        pbxproj_data = pbxproj_data.replace("name = stickers", f"name = {title}")
+        pbxproj_data = pbxproj_data.replace(
+            "productName = stickers", f"productName = {title}"
+        )
+        pbxproj_data = pbxproj_data.replace(
+            '/* Build configuration list for PBXProject "stickers" */',
+            f'/* Build configuration list for PBXProject "{title}" */',
+        )
+        pbxproj_data = pbxproj_data.replace(
+            '/* Build configuration list for PBXNativeTarget "stickers StickerPackExtension" */',
+            f'/* Build configuration list for PBXNativeTarget "{title} StickerPackExtension" */',
+        )
+        pbxproj_data = pbxproj_data.replace(
+            '/* Build configuration list for PBXNativeTarget "stickers" */',
+            f'/* Build configuration list for PBXNativeTarget "{title}" */',
+        )
+        pbxproj_data = pbxproj_data.replace("com.niklaspeterson", f"com.{author}")
+        pbxproj_data = pbxproj_data.replace(
+            "stickers/Info.plist", f"{title}/Info.plist"
+        )
+
+        with open(
+            pack_path / "stickers.xcodeproj/project.pbxproj",
+            "w+",
+            encoding="utf-8",
+        ) as f:
+            f.write(pbxproj_data)
+
+        # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack
+        stickers_path = (
+            pack_path
+            / "stickers StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack"
+        )
+
+        for i in stickers_path.iterdir():
+            if i.suffix == ".sticker":
+                shutil.rmtree(stickers_path / i)
+
+        stickers_lst: List[str] = []
+        for i in sorted(self.opt_output.dir.iterdir()):
+            if (
+                CodecInfo.get_file_ext(i) == ".png"
+                and i.stem != "cover"
+                and i.name not in XCODE_IMESSAGE_ICONSET
+            ):
+                sticker_dir = f"{i.stem}.sticker"  # 0.sticker
+                stickers_lst.append(sticker_dir)
+                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker
+                sticker_path = stickers_path / sticker_dir
+                os.mkdir(sticker_path)
+                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker/0.png
+                shutil.copy(self.opt_output.dir / i.name, sticker_path / i.name)
+
+                sticker_json_content = {
+                    "info": {
+                        "author": "xcode",
+                        "version": 1,
+                    },
+                    "properties": {"filename": str(i)},
+                }
+
+                # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/0.sticker/Contents.json
+                with open(sticker_path / "Contents.json", "w+", encoding="utf-8") as f:
+                    json.dump(sticker_json_content, f, indent=2)
+
+        # packname StickerPackExtension/Stickers.xcstickers/Sticker Pack.stickerpack/Contents.json
+        with open(stickers_path / "Contents.json", encoding="utf-8") as f:
+            stickerpack_json_content: Dict[str, List[Dict[str, str]]] = json.load(f)
+
+        stickerpack_json_content["stickers"] = []
+        for sticker in stickers_lst:
+            stickerpack_json_content["stickers"].append({"filename": sticker})
+
+        with open(stickers_path / "Contents.json", "w+", encoding="utf-8") as f:
+            json.dump(stickerpack_json_content, f, indent=2)
+
+        # packname StickerPackExtension/Stickers.xcstickers/iMessage App Icon.stickersiconset
+        iconset_path = (
+            pack_path
+            / "stickers StickerPackExtension/Stickers.xcstickers/iMessage App Icon.stickersiconset"
+        )
+
+        for iconfile_name in iconset_path.iterdir():
+            if Path(iconfile_name).suffix == ".png":
+                os.remove(iconset_path / iconfile_name)
+
+        icons_lst: List[str] = []
+        for icon in XCODE_IMESSAGE_ICONSET:
+            shutil.copy(self.opt_output.dir / icon, iconset_path / icon)
+            icons_lst.append(icon)
+
+        # packname/Info.plist
+        plist_path = pack_path / "stickers/Info.plist"
+        with open(plist_path, "rb") as f:
+            plist_dict = plistlib.load(f)
+        plist_dict["CFBundleDisplayName"] = title
+
+        with open(plist_path, "wb+") as f:
+            plistlib.dump(plist_dict, f)
+
+        Path(pack_path, "stickers").rename(Path(pack_path, title))
+        Path(pack_path, "stickers StickerPackExtension").rename(
+            Path(pack_path, f"{title} StickerPackExtension")
+        )
+        Path(pack_path, "stickers.xcodeproj").rename(
+            Path(pack_path, f"{title}.xcodeproj")
+        )
+
+    @staticmethod
+    def start(
+        opt_output: OutputOption,
+        opt_comp: CompOption,
+        opt_cred: CredOption,
+        cb: CallbackProtocol,
+        cb_return: CallbackReturn,
+    ) -> Tuple[int, int, List[str]]:
+        exporter = XcodeImessage(opt_output, opt_comp, opt_cred, cb, cb_return)
+        return exporter.create_imessage_xcode()