Initial commit

Author: Vismayak

pyclowder/api/v2/datasets.py

@@ -349,3 +349,32 @@ def upload_thumbnail(connector, client, datasetid, thumbnail):
         return result.json()["thumbnail_id"]
     else:
         logger.error("unable to upload thumbnail %s to dataset %s", thumbnail, datasetid)
+
+def create_folder(connector, client, datasetid, foldername, parent_folder=None):
+    """Create a new folder in Clowder.
+
+        Keyword arguments:
+        connector -- connector information, used to get missing parameters and send status updates
+        client -- ClowderClient containing authentication credentials
+        datasetid -- the dataset that the folder should be associated with
+        foldername -- the name of the folder to create
+        parent_folder -- the id of the parent folder, if not provided, the folder will be created at the root of the dataset
+    """
+    
+    url = posixpath.join(client.host, 'api/v2/datasets/%s/folders' % datasetid)
+    headers = {"X-API-KEY": client.key,
+               "Content-Type": "application/json"}
+
+    if parent_folder is not None:
+        folder_data = json.dumps({"name": foldername, "parent_folder": parent_folder})
+    else:
+        folder_data = json.dumps({"name": foldername})
+    
+    result = requests.post(url, headers=headers, json=folder_data,
+                           verify=connector.ssl_verify if connector else True)
+    result.raise_for_status()
+    folder_id = result.json()["id"]
+    logger.debug("created folder id = [%s]", folder_id)
+    return folder_id
+
+

pyclowder/api/v2/files.py

@@ -406,3 +406,40 @@ def _upload_to_dataset_local(connector, client, datasetid, filepath):
         return uploadedfileid
     else:
         logger.error("unable to upload local file %s (not found)", filepath)
+
+
+def upload_multiple_files(connector, client, datasetid, filepaths, folder_id=None):
+    """Upload multiple files to existing Clowder dataset.
+
+    Keyword arguments:
+    connector -- connector information, used to get missing parameters and send status updates
+    client -- ClowderClient containing authentication credentials
+    datasetid -- the dataset that the files should be associated with
+    filepaths -- list of file paths to upload
+    folder_id -- the folder that the files should be uploaded to
+    """
+    logger = logging.getLogger(__name__)
+
+    files = []
+    for filepath in filepaths:
+        if os.path.exists(filepath):
+            files.append(os.path.basename(filepath), open(filepath, 'rb'))
+        else:
+            logger.error("unable to upload file %s (not found)", filepath)
+            return None
+    
+
+    url = posixpath.join(client.host, 'api/v2/datasets/%s/filesMultiple' % datasetid)
+    if folder_id is not None:
+        url = '%s?folder_id=%s' % (url, folder_id)
+    
+    headers = {"X-API-KEY": client.key}
+    response = connector.post(url, files=files, headers=headers,
+                              verify=connector.ssl_verify if connector else True)
+                              
+    if response.status_code == 200:
+        return response.json()
+    else:
+        logger.error("Error uploading files to dataset %s", datasetid)
+        return None
+

pyclowder/datasets.py

@@ -260,3 +260,23 @@ def upload_thumbnail(connector, host, key, datasetid, thumbnail):
 
     client = ClowderClient(host=host, key=key)
     return datasets.upload_thumbnail(connector, client, datasetid, thumbnail)
+
+
+def create_folder(connector, host, key, datasetid, foldername, parent_folder_id=None):
+    """Create a new folder in Clowder.
+
+    Keyword arguments:
+    connector -- connector information, used to get missing parameters and send status updates
+    host -- the clowder host, including http and port, should end with a /
+    key -- the secret key to login to clowder
+    datasetid -- the dataset that the folder should be associated with
+    foldername -- the name of the folder to create
+    parent_folder_id -- the id of the parent folder, if not provided, the folder will be created at the root of the dataset
+    """
+    logger = logging.getLogger(__name__)
+    if clowder_version == 2:
+        client = ClowderClient(host=host, key=key)
+        return datasets.create_folder(connector, client, datasetid, foldername, parent_folder_id)
+    else:
+        logger.error("Function not supported for Clowder version %s", clowder_version)
+        return None

pyclowder/files.py

@@ -322,3 +322,22 @@ def _upload_to_dataset_local(connector, host, key, datasetid, filepath):
     client = ClowderClient(host=host, key=key)
     uploadedfileid = files._upload_to_dataset_local(connector, client, datasetid, filepath)
     return uploadedfileid
+
+def upload_multiple_files(connector, host, key, datasetid, filepaths, folder_id=None):
+    """Upload multiple files to existing Clowder dataset.
+
+    Keyword arguments:
+    connector -- connector information, used to get missing parameters and send status updates
+    host -- the clowder host, including http and port, should end with a /
+    key -- the secret key to login to clowder
+    datasetid -- the dataset that the files should be associated with
+    filepaths -- list of file paths to upload
+    folder_id -- the folder that the files should be uploaded to
+    """
+    client = ClowderClient(host=host, key=key)
+    if clowder_version == 2:
+        return files.upload_multiple_files(connector, client, datasetid, filepaths, folder_id)
+    else:
+        logger = logging.getLogger(__name__)
+        logger.error("Function not supported for Clowder version %s", clowder_version)
+        return None