Merge branch 'master' into snyk-fix-688d5aa50af99bbf53ce9b383e137980

Author: const-cloudinary

.github/workflows/cloudinary-cli-test.yml

@@ -13,12 +13,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

CHANGELOG.md

@@ -1,3 +1,13 @@
+1.10.3 / 2024-07-31
+==================
+
+  * Add missing delivery types in `url` command
+
+1.10.2 / 2024-07-15
+==================
+
+  * Fix folder existence error in `sync` command
+
 1.10.1 / 2024-01-29
 ==================
 

Dockerfile

@@ -0,0 +1,12 @@
+# syntax=docker/dockerfile:1
+
+ARG PYTHON_VERSION
+FROM python:${PYTHON_VERSION:-3.12-slim}
+
+# For available labels, see OCI Annotations Spec docs:
+# https://specs.opencontainers.org/image-spec/annotations/#pre-defined-annotation-keys
+LABEL org.opencontainers.image.source="https://github.com/cloudinary/cloudinary-cli"
+
+RUN pip3 install --no-cache cloudinary-cli
+
+ENTRYPOINT [ "cloudinary" ]

cloudinary_cli/core/__init__.py

@@ -2,7 +2,7 @@
 
 from cloudinary_cli.core.admin import admin
 from cloudinary_cli.core.config import config
-from cloudinary_cli.core.search import search
+from cloudinary_cli.core.search import search, search_folders
 from cloudinary_cli.core.uploader import uploader
 from cloudinary_cli.core.provisioning import provisioning
 from cloudinary_cli.core.utils import url, utils
@@ -13,6 +13,7 @@
 commands = [
     config,
     search,
+    search_folders,
     admin,
     uploader,
     provisioning,

cloudinary_cli/core/search.py

@@ -1,5 +1,6 @@
 import cloudinary
 from click import command, argument, option, launch
+from functools import wraps
 
 from cloudinary_cli.defaults import logger
 from cloudinary_cli.utils.json_utils import write_json_to_file, print_json
@@ -9,45 +10,86 @@
 DEFAULT_MAX_RESULTS = 500
 
 
+def shared_options(func):
+    @option("-f", "--with_field", multiple=True, help="Specify which non-default asset attributes to include "
+                                                      "in the result as a comma separated list.")
+    @option("-fi", "--fields", multiple=True, help="Specify which asset attributes to include in the result "
+                                                   "(together with a subset of the default attributes) as a comma separated"
+                                                   " list. This overrides any value specified for with_field.")
+    @option("-s", "--sort_by", nargs=2, help="Sort search results by (field, <asc|desc>).")
+    @option("-a", "--aggregate", nargs=1,
+            help="Specify the attribute for which an aggregation count should be calculated and returned.")
+    @option("-n", "--max_results", nargs=1, default=10,
+            help="The maximum number of results to return. Default: 10, maximum: 500.")
+    @option("-c", "--next_cursor", nargs=1, help="Continue a search using an existing cursor.")
+    @option("-A", "--auto_paginate", is_flag=True, help="Return all results. Will call Admin API multiple times.")
+    @option("-F", "--force", is_flag=True, help="Skip confirmation when running --auto-paginate.")
+    @option("-ff", "--filter_fields", multiple=True, help="Specify which attributes to show in the response. "
+                                                          "None of the others will be shown.")
+    @option("-sq", "--search-query", is_flag=True, help="Show the search request query.", hidden=True)
+    @option("--json", nargs=1, help="Save JSON output to a file. Usage: --json <filename>")
+    @option("--csv", nargs=1, help="Save CSV output to a file. Usage: --csv <filename>")
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        return func(*args, **kwargs)
+
+    return wrapper
+
+
 @command("search",
-         short_help="Run the admin API search method.",
+         short_help="Run the Admin API search method.",
          help="""\b
-Run the admin API search method.
+Run the Admin API search method.
 Format: cld <cli options> search <command options> <Lucene query syntax string>
 e.g. cld search cat AND tags:kitten -s public_id desc -f context -f tags -n 10
 """)
 @argument("query", nargs=-1)
-@option("-f", "--with_field", multiple=True, help="Specify which non-default asset attributes to include "
-                                                  "in the result as a comma separated list. ")
-@option("-fi", "--fields", multiple=True, help="Specify which asset attributes to include in the result "
-                                               "(together with a subset of the default attributes) as a comma separated"
-                                               " list. This overrides any value specified for with_field.")
-@option("-s", "--sort_by", nargs=2, help="Sort search results by (field, <asc|desc>).")
-@option("-a", "--aggregate", nargs=1,
-        help="Specify the attribute for which an aggregation count should be calculated and returned.")
-@option("-n", "--max_results", nargs=1, default=10,
-        help="The maximum number of results to return. Default: 10, maximum: 500.")
-@option("-c", "--next_cursor", nargs=1, help="Continue a search using an existing cursor.")
-@option("-A", "--auto_paginate", is_flag=True, help="Return all results. Will call Admin API multiple times.")
-@option("-F", "--force", is_flag=True, help="Skip confirmation when running --auto-paginate.")
-@option("-ff", "--filter_fields", multiple=True, help="Specify which attributes to show in the response. "
-                                                      "None of the others will be shown.")
+@shared_options
 @option("-t", "--ttl", nargs=1, default=300, help="Set the Search URL TTL in seconds. Default: 300.")
 @option("-u", "--url", is_flag=True, help="Build a signed search URL.")
-@option("-sq", "--search-query", is_flag=True, help="Show the search request query.", hidden=True)
-@option("--json", nargs=1, help="Save JSON output to a file. Usage: --json <filename>")
-@option("--csv", nargs=1, help="Save CSV output to a file. Usage: --csv <filename>")
 @option("-d", "--doc", is_flag=True, help="Open Search API documentation page.")
 def search(query, with_field, fields, sort_by, aggregate, max_results, next_cursor,
            auto_paginate, force, filter_fields, ttl, url, search_query, json, csv, doc):
+    search_instance = cloudinary.search.Search()
+    doc_url = "https://cloudinary.com/documentation/search_api"
+    result_field = 'resources'
+    return _perform_search(query, with_field, fields, sort_by, aggregate, max_results, next_cursor,
+                           auto_paginate, force, filter_fields, ttl, url, search_query, json, csv, doc,
+                           search_instance, doc_url, result_field)
+
+
+@command("search_folders",
+         short_help="Run the Admin API search folders method.",
+         help="""\b
+Run the Admin API search folders method.
+Format: cld <cli options> search_folders <command options> <Lucene query syntax string>
+e.g. cld search_folders name:folder AND path:my_parent AND created_at>4w
+""")
+@argument("query", nargs=-1)
+@shared_options
+@option("-d", "--doc", is_flag=True, help="Open Search Folders API documentation page.")
+def search_folders(query, with_field, fields, sort_by, aggregate, max_results, next_cursor,
+                   auto_paginate, force, filter_fields, search_query, json, csv, doc):
+    search_instance = cloudinary.search_folders.SearchFolders()
+    doc_url = "https://cloudinary.com/documentation/admin_api#search_folders"
+    result_field = 'folders'
+    return _perform_search(query, with_field, fields, sort_by, aggregate, max_results, next_cursor,
+                           auto_paginate, force, filter_fields, 300, False, search_query, json, csv, doc,
+                           search_instance, doc_url, result_field)
+
+
+def _perform_search(query, with_field, fields, sort_by, aggregate, max_results, next_cursor,
+                    auto_paginate, force, filter_fields, ttl, url, search_query, json, csv, doc,
+                    search_instance, doc_url, result_field):
+    """Shared logic for running a search."""
     if doc:
-        return launch("https://cloudinary.com/documentation/search_api")
+        return launch(doc_url)
 
     fields_to_keep = []
     if filter_fields:
         fields_to_keep = tuple(normalize_list_params(filter_fields)) + tuple(normalize_list_params(with_field))
 
-    search = cloudinary.search.Search().expression(" ".join(query))
+    search = search_instance.expression(" ".join(query))
 
     if auto_paginate:
         max_results = DEFAULT_MAX_RESULTS
@@ -74,32 +116,32 @@ def search(query, with_field, fields, sort_by, aggregate, max_results, next_curs
         print_json(search.as_dict())
         return True
 
-    res = execute_single_request(search, fields_to_keep)
+    res = execute_single_request(search, fields_to_keep, result_field)
 
     if auto_paginate:
-        res = handle_auto_pagination(res, search, force, fields_to_keep)
+        res = handle_auto_pagination(res, search, force, fields_to_keep, result_field)
 
     print_json(res)
 
     if json:
-        write_json_to_file(res['resources'], json)
+        write_json_to_file(res[result_field], json)
         logger.info(f"Saved search JSON to '{json}' file")
 
     if csv:
-        write_json_list_to_csv(res['resources'], csv, fields_to_keep)
+        write_json_list_to_csv(res[result_field], csv, fields_to_keep)
         logger.info(f"Saved search to '{csv}.csv' file")
 
 
-def execute_single_request(expression, fields_to_keep):
+def execute_single_request(expression, fields_to_keep, result_field='resources'):
     res = expression.execute()
 
     if fields_to_keep:
-        res['resources'] = whitelist_keys(res['resources'], fields_to_keep)
+        res[result_field] = whitelist_keys(res[result_field], fields_to_keep)
 
     return res
 
 
-def handle_auto_pagination(res, expression, force, fields_to_keep):
+def handle_auto_pagination(res, expression, force, fields_to_keep, result_field='resources'):
     if 'next_cursor' not in res:
         return res
 
@@ -119,9 +161,9 @@ def handle_auto_pagination(res, expression, force, fields_to_keep):
     while 'next_cursor' in res.keys():
         expression.next_cursor(res['next_cursor'])
 
-        res = execute_single_request(expression, fields_to_keep)
+        res = execute_single_request(expression, fields_to_keep, result_field)
 
-        all_results['resources'] += res['resources']
+        all_results[result_field] += res[result_field]
         all_results['time'] += res['time']
 
     all_results.pop('next_cursor', None)  # it is empty by now

cloudinary_cli/core/utils.py

@@ -36,7 +36,11 @@ def utils(params, optional_parameter, optional_parameter_parsed, ls):
 @argument("transformation", default="")
 @option("-rt", "--resource_type", default="image", type=Choice(['image', 'video', 'raw']), help="The asset type")
 @option("-t", "--type", "delivery_type", default="upload",
-        type=Choice(['upload', 'private', 'authenticated', 'fetch', 'list', 'url2png']),
+        type=Choice([
+            'upload', 'private', 'public', 'authenticated', 'fetch', 'list', 'url2png',
+            'sprite', 'text', 'multi', 'facebook', 'twitter', 'twitter_name', 'gravatar',
+            'youtube', 'hulu', 'vimeo', 'animoto', 'worldstarhiphop', 'dailymotion'
+        ]),
         help="The delivery type.")
 @option("-o", "--open", 'open_in_browser', is_flag=True, help="Generate the derived asset and open it in your browser.")
 @option("-s", "--sign", is_flag=True, help="Generate a signed URL.", default=False)

cloudinary_cli/modules/__init__.py

@@ -3,11 +3,13 @@
 from .sync import sync
 from .upload_dir import upload_dir
 from .regen_derived import regen_derived
+from .clone import clone
 
 commands = [
     upload_dir,
     make,
     migrate,
     sync,
-    regen_derived
+    regen_derived,
+    clone
 ]

cloudinary_cli/modules/clone.py

@@ -0,0 +1,112 @@
+from click import command, option, style, argument
+from cloudinary_cli.utils.utils import normalize_list_params, print_help_and_exit
+import cloudinary
+from cloudinary_cli.utils.utils import run_tasks_concurrently
+from cloudinary_cli.utils.api_utils import upload_file
+from cloudinary_cli.utils.config_utils import load_config, get_cloudinary_config, config_to_dict
+from cloudinary_cli.defaults import logger
+from cloudinary_cli.core.search import execute_single_request, handle_auto_pagination
+
+DEFAULT_MAX_RESULTS = 500
+
+
+@command("clone",
+         short_help="""Clone assets from one product environment to another.""",
+         help="""
+\b
+Clone assets from one product environment to another with/without tags and/or context (structured metadata is not currently supported).
+Source will be your `CLOUDINARY_URL` environment variable but you also can specify a different source using the `-c/-C` option.
+Cloning restricted assets is also not supported currently.
+Format: cld clone <target_environment> <command options>
+`<target_environment>` can be a CLOUDINARY_URL or a saved config (see `config` command)
+Example 1 (Copy all assets including tags and context using CLOUDINARY URL):
+    cld clone cloudinary://<api_key>:<api_secret>@<cloudname> -fi tags,context
+Example 2 (Copy all assets with a specific tag via a search expression using a saved config):
+    cld clone <config_name> -se "tags:<tag_name>"
+""")
+@argument("target")
+@option("-F", "--force", is_flag=True,
+        help="Skip confirmation.")
+@option("-ow", "--overwrite", is_flag=True, default=False,
+        help="Specify whether to overwrite existing assets.")
+@option("-w", "--concurrent_workers", type=int, default=30,
+        help="Specify the number of concurrent network threads.")
+@option("-fi", "--fields", multiple=True,
+        help="Specify whether to copy tags and/or context. Valid options: `tags,context`.")
+@option("-se", "--search_exp", default="",
+        help="Define a search expression to filter the assets to clone.")
+@option("--async", "async_", is_flag=True, default=False,
+        help="Clone the assets asynchronously.")
+@option("-nu", "--notification_url",
+        help="Webhook notification URL.")
+def clone(target, force, overwrite, concurrent_workers, fields, search_exp, async_, notification_url):
+    if not target:
+        print_help_and_exit()
+
+    target_config = get_cloudinary_config(target)
+    if not target_config:
+        logger.error("The specified config does not exist or the CLOUDINARY_URL scheme provided is invalid"
+                     " (expecting to start with 'cloudinary://').")
+        return False
+
+    if cloudinary.config().cloud_name == target_config.cloud_name:
+        logger.error("Target environment cannot be the same as source environment.")
+        return False
+
+    source_assets = search_assets(force, search_exp)
+
+    upload_list = []
+    for r in source_assets.get('resources'):
+        updated_options, asset_url = process_metadata(r, overwrite, async_, notification_url,
+                                                      normalize_list_params(fields))
+        updated_options.update(config_to_dict(target_config))
+        upload_list.append((asset_url, {**updated_options}))
+
+    if not upload_list:
+        logger.error(style(f'No assets found in {cloudinary.config().cloud_name}', fg="red"))
+        return False
+
+    logger.info(style(f'Copying {len(upload_list)} asset(s) from {cloudinary.config().cloud_name} to {target_config.cloud_name}', fg="blue"))
+
+    run_tasks_concurrently(upload_file, upload_list, concurrent_workers)
+
+    return True
+
+
+def search_assets(force, search_exp):
+    search = cloudinary.search.Search().expression(search_exp)
+    search.fields(['tags', 'context', 'access_control', 'secure_url', 'display_name'])
+    search.max_results(DEFAULT_MAX_RESULTS)
+
+    res = execute_single_request(search, fields_to_keep="")
+    res = handle_auto_pagination(res, search, force, fields_to_keep="")
+
+    return res
+
+
+def process_metadata(res, overwrite, async_, notification_url, copy_fields=""):
+    cloned_options = {}
+    asset_url = res.get('secure_url')
+    cloned_options['public_id'] = res.get('public_id')
+    cloned_options['type'] = res.get('type')
+    cloned_options['resource_type'] = res.get('resource_type')
+    cloned_options['overwrite'] = overwrite
+    cloned_options['async'] = async_
+    if "tags" in copy_fields:
+        cloned_options['tags'] = res.get('tags')
+    if "context" in copy_fields:
+        cloned_options['context'] = res.get('context')
+    if res.get('folder'):
+        # This is required to put the asset in the correct asset_folder
+        # when copying from a fixed to DF (dynamic folder) cloud as if
+        # you just pass a `folder` param to a DF cloud, it will append
+        # this to the `public_id` and we don't want this.
+        cloned_options['asset_folder'] = res.get('folder')
+    elif res.get('asset_folder'):
+        cloned_options['asset_folder'] = res.get('asset_folder')
+    if res.get('display_name'):
+        cloned_options['display_name'] = res.get('display_name')
+    if notification_url:
+        cloned_options['notification_url'] = notification_url
+
+    return cloned_options, asset_url