Merge pull request #23 from achimoraites/fix/CVE-2023-4863

Fix/CVE 2023 4863

Author: achimoraites

CONTRIBUTING.md

@@ -55,6 +55,8 @@ We are using pytest, the `tests` folder contains our unit tests.
 pytest tests
 ```
 
+For improving our Unit Tests we are using [codium.ai](https://www.codium.ai/) ✨
+
 ## Reporting Issues
 
 - Check if the issue has already been reported.

raw_image_converter/__main__.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 import os
 from raw_image_converter.utils import (
-    check_extension,
+    check_file_type,
     convert_file,
     convert_raw,
     image_not_exists,
@@ -83,8 +83,10 @@ def main():
             )
             print("Converting -> " + srcDir + " Directory !\n")
             for file in os.listdir(srcDir):
+                file = file.lower()
                 if image_not_exists(file, tgtDir, args.ext):
-                    if "RAW" == check_extension(file):
+                    type = check_file_type(file)
+                    if "RAW" == type:
                         executor.submit(
                             convert_raw,
                             file,
@@ -94,7 +96,7 @@ def main():
                             resolution,
                         )
 
-                    if "NOT_RAW" == check_extension(file):
+                    if "NOT_RAW" == type:
                         executor.submit(
                             convert_file,
                             file,

raw_image_converter/utils.py

@@ -6,6 +6,8 @@
 from datetime import datetime
 import shutil
 
+def split_file_extension(file):
+    return os.path.splitext(file)
 
 def message(file, converted):
     current_time = datetime.now().time().strftime("%H:%M:%S")
@@ -20,7 +22,7 @@ def message(file, converted):
 # convert RAW images function
 def convert_raw(file, srcDir, tgtDir, extension=".jpg", resolution=("100%", "100%")):
     try:
-        ext = "." + file.split(".")[-1].lower()
+        filename, _ = split_file_extension(file)
         print(datetime.now().time().strftime("%H:%M:%S") + " Converting:  " + file)
         source = os.path.join(srcDir, file)
         with rawpy.imread(source) as raw:
@@ -34,7 +36,7 @@ def convert_raw(file, srcDir, tgtDir, extension=".jpg", resolution=("100%", "100
             pil_image = pil_image.resize((width, height))
 
             rgb = np.array(pil_image)
-        imageio.imsave(os.path.join(tgtDir, file.replace(ext, "") + extension), rgb)
+        imageio.imsave(os.path.join(tgtDir, filename + extension), rgb)
         message(file, True)
     except Exception as e:
         print(e)
@@ -59,15 +61,15 @@ def convert_file(file, srcDir, tgtDir, extension=".jpg", resolution=("100%", "10
     }
     save_format = mappings.get(extension, "JPEG")
     try:
-        ext = "." + file.split(".")[-1].lower()
+        filename, _ = split_file_extension(file)
         message(file, False)
         path = os.path.join(srcDir, file)
         im = Image.open(path)
         if resolution:
             width = calculate_image_dimension(im.width, resolution[0])
             height = calculate_image_dimension(im.height, resolution[1])
             im = im.resize((width, height))
-        im.save(os.path.join(tgtDir, file.replace(ext, "") + extension), save_format)
+        im.save(os.path.join(tgtDir, filename + extension), save_format)
         message(file, True)
     except:
         pass
@@ -86,27 +88,26 @@ def ai_2_pdf(file):
 
 # IT IS POINTLESS TO CONVERT WHAT IS ALREADY CONVERTED!!!!
 def image_not_exists(image, tgtDir, tgtExt):
-    ext = image.split(".")[-1].lower()
-    target = os.path.join(tgtDir, image.replace(ext, tgtExt.replace(".", "")))
+    filename, _ = split_file_extension(image)
+    target = os.path.join(tgtDir, filename + tgtExt)
     if os.path.isfile(target):
         return False
     else:
         return True
 
 
 # here we check each file to decide what to do
-def check_extension(file):
+def check_file_type(file):
     # get the extension as a String and check if the string is contained in the array extensionsForRawConversion
-    ext = "." + file.split(".")[-1].lower()
+    _, ext = split_file_extension(file)
     # set supported raw conversion extensions!
-    extensionsForRawConversion = [
+    raw = [
         ".dng",
         ".raw",
         ".cr2",
         ".crw",
         ".erf",
         ".raf",
-        ".tif",
         ".kdc",
         ".dcr",
         ".mos",
@@ -124,11 +125,11 @@ def check_extension(file):
         ".mrw",
     ]
     # set supported imageio conversion extensions
-    extensionsForConversion = [".ppm", ".psd", ".tif", ".webp"]
+    not_raw = [".ppm", ".psd", ".tiff", ".webp"]
 
-    if ext in extensionsForRawConversion:
+    if ext in raw:
         return "RAW"
-    if ext in extensionsForConversion:
+    if ext in not_raw:
         return "NOT RAW"
     # check if an .ai exists and rename it to .pdf	!
     ai_2_pdf(file)

requirements.txt

@@ -1,5 +1,5 @@
 imageio==2.16.2
-Pillow==9.3.0
+Pillow==10.0.1
 rawpy==0.17.1
 numpy==1.22.3
 colorama==0.4.6

setup.py

@@ -27,7 +27,7 @@
     keywords='cli, converter, raw, images',
     packages=["raw_image_converter"],
     install_requires=["numpy==1.22.3", "rawpy==0.17.1",
-                      "imageio==2.16.2", "Pillow==9.3.0", "colorama==0.4.6"],
+                      "imageio==2.16.2", "Pillow==10.0.1", "colorama==0.4.6"],
     entry_points={
         "console_scripts": [
             "raw_image_converter=raw_image_converter.__main__:main",

tests/test_utils_check_file_type.py

@@ -0,0 +1,47 @@
+from unittest.mock import patch
+from raw_image_converter.utils import check_file_type
+
+
+class TestCheckFileType:
+    # Case: Returns "RAW" if file extension is raw
+    def test_returns_raw_if_extension_in_raw_conversion_array(self):
+        extensions= [
+            ".dng",
+            ".raw",
+            ".cr2",
+            ".crw",
+            ".erf",
+            ".raf",
+            ".kdc",
+            ".dcr",
+            ".mos",
+            ".mef",
+            ".nef",
+            ".orf",
+            ".rw2",
+            ".pef",
+            ".x3f",
+            ".srw",
+            ".srf",
+            ".sr2",
+            ".arw",
+            ".mdc",
+            ".mrw",
+        ]
+
+        for ext in extensions:
+            assert check_file_type(f"file{ext}") == "RAW"
+
+    # Case: Returns "NOT RAW" if file extension is not raw
+    def test_returns_not_raw_if_extension_in_conversion_array(self):
+        extensions2 = [".ppm", ".psd", ".webp", ".tiff"]
+
+        for ext in extensions2:
+            assert check_file_type(f"file{ext}") == "NOT RAW"
+
+    # Case: Calls ai_2_pdf function if file extension is ".ai"
+    def test_calls_ai_2_pdf_if_extension_is_ai(self):
+        with patch("os.rename") as mock_rename:
+            check_file_type("file.ai")
+            mock_rename.assert_called_once_with("file.ai", "file.ai.pdf")
+

tests/test_utils_split_file_extension.py

@@ -0,0 +1,33 @@
+from raw_image_converter.utils import split_file_extension
+
+
+class TestSplitFileExtension:
+    # Case: Test with a file name with an extension
+    def test_extension(self):
+        file = "example.jpg"
+        result = split_file_extension(file)
+        assert result == ("example", ".jpg")
+
+    # Case: Test with a file name with no extension
+    def test_no_extension(self):
+        file = "example"
+        result = split_file_extension(file)
+        assert result == ("example", "")
+
+    # Case: Test with an empty file name
+    def test_empty_file_name(self):
+        file = ""
+        result = split_file_extension(file)
+        assert result == ("", "")
+
+    # Case: Test with a file name starting with a dot
+    def test_starting_with_dot(self):
+        file = ".example"
+        result = split_file_extension(file)
+        assert result == (".example", "")
+
+    # Case: Test with a file name containing multiple dots
+    def test_multiple_dots(self):
+        file = "example.file.with.dots"
+        result = split_file_extension(file)
+        assert result == ("example.file.with", ".dots")