enh: add tool button for creating a collection in the My Data tab (close #93)

Author: paulmueller

CHANGELOG

@@ -6,6 +6,7 @@
  - fix: cache download resource file size
  - fix: action button behavior in downloads panel (#94)
  - fix: action button behavior in uploads panel
+ - enh: add tool button for creating a collection in the "My Data" tab (#93)
  - enh: unify action button size, alignment, and spacing across all tabs
  - enh: allow sharing individual datasets instead of collections (#32)
  - enh: add preview option for dataset description in upload dialog (#52)

dcoraid/api/ckan_api.py

@@ -6,6 +6,7 @@
 import logging
 import numbers
 import pathlib
+import random
 import traceback
 import urllib.parse
 
@@ -441,20 +442,39 @@ def post(self, api_call, data, dump_json=True, headers=None,
 
     def require_collection(self,
                            name: str,
-                           title: str = None):
+                           title: str = None,
+                           exist_ok: bool = True,
+                           ):
         """Return a collection dict with the given name and optional title
 
-        The collection is created if it does not exist already. If the
-        collection already exists, `title` is ignored.
+        If a collection by that name already exists, it is returned only
+        if `exist_ok` is True (in which case `title` is ignored). Otherwise,
+        a new collection with a modified `name` is created and returned.
         """
-        # check whether the group exists
         try:
             col_dict = self.get("group_show", id=name)
         except APINotFoundError:
-            # Create non-existent group
-            self.post("group_create",
-                      data={"name": name,
-                            "title": title or name,
-                            })
-            col_dict = self.get("group_show", id=name)
+            col_dict = None
+
+        if exist_ok and col_dict is not None:
+            return col_dict
+        else:
+            rand = ""
+            title = (title or name).strip()
+            # create the collection
+            for ii in range(10):
+                try:
+                    col_dict = self.post("group_create",
+                                         {"title": title,
+                                          "name": name + rand,
+                                          })
+                except APIConflictError:
+                    if not rand:
+                        rand += "-"
+                    rand += random.choice("abcdefghijkmpqrstuvwxyz0123456789")
+                else:
+                    break
+            else:
+                raise ValueError("Could not create collection")
+
         return col_dict

dcoraid/gui/panel_my_data/filter_chain_my_data.py

@@ -1,9 +1,5 @@
-import random
-
 from PyQt6 import QtCore, QtWidgets
 
-from ...api import errors
-
 from ..dbview import FilterChain
 from ..tools import ShowWaitCursor
 from ..api import get_ckan_api
@@ -20,7 +16,14 @@ def __init__(self, *args, **kwargs):
         """Filter chain with user-related features"""
         super(FilterChainMyData, self).__init__(*args, **kwargs)
 
-        # Enable the "add to collection tool box"
+        # Enable "create collection" toolbutton
+        self.fw_collections.pushButton_custom.setText(
+            "Create new collection...")
+        self.fw_collections.pushButton_custom.setVisible(True)
+        self.fw_collections.pushButton_custom.clicked.connect(
+            self.on_create_collection)
+
+        # Enable the "add to collection" toolbutton
         self.fw_datasets.pushButton_custom.setText(
             "Add selected datasets to a collection...")
         self.fw_datasets.pushButton_custom.setVisible(True)
@@ -42,8 +45,6 @@ def choose_collaborator(self, what_for=None):
         # Fetch a list of users
         with ShowWaitCursor():
             api = get_ckan_api()
-            # TODO: let the user search for collaborators and add them to a
-            #       memoized list.
             users = api.get("user_autocomplete", q="", limit=100)
 
         for_what_for = f" for {what_for}"
@@ -93,7 +94,8 @@ def on_add_datasets_to_collection(self):
                     "Select a collection",
                     f"Please choose a collection for "
                     f"{len(dataset_ids)} datasets.",
-                    [f"{i}: {g['display_name']}" for i, g in enumerate(grps)],
+                    [f"{i}: {g['display_name']} ({g['name']})"
+                     for i, g in enumerate(grps)],
                     0,  # current index
                     False,  # editable
                     )
@@ -106,22 +108,15 @@ def on_add_datasets_to_collection(self):
                     "Create a collection",
                     "Type the name of a collection to create",
                 )
-                # create a valid name
-                name = "".join(
-                    [c.lower() if c.isalnum() else "-" for c in text])
-                name = name.strip("-")
-                for ii in range(10):
-                    try:
-                        collection = api.post("group_create",
-                                              {"title": text.strip(),
-                                               "name": name,
-                                               })
-                    except errors.APIConflictError:
-                        name = name + random.choice("abcdefghijkm0123456789")
-                    else:
-                        break
-                else:
-                    raise ValueError("Could not create collection")
+                if ok:
+                    # create a valid name
+                    name = "".join(
+                        [c.lower() if c.isalnum() else "-" for c in text])
+                    name = name.strip("-")
+                    # create the collection
+                    collection = api.require_collection(name=name,
+                                                        title=text,
+                                                        exist_ok=False)
             if ok:
                 with ShowWaitCursor():
                     # add all datasets to that collection
@@ -137,6 +132,29 @@ def on_add_datasets_to_collection(self):
                     self.added_datasets_to_collection.emit(collection,
                                                            dataset_ids)
 
+    @QtCore.pyqtSlot()
+    def on_create_collection(self):
+        text, ok = QtWidgets.QInputDialog.getText(
+            self,
+            "Create a collection",
+            "Type the name of a collection to create",
+        )
+        if ok:
+            api = get_ckan_api()
+            # create a valid name
+            name = "".join(
+                [c.lower() if c.isalnum() else "-" for c in text])
+            name = name.strip("-")
+            collection = api.require_collection(name=name,
+                                                title=text,
+                                                exist_ok=False)
+            QtWidgets.QMessageBox.information(
+                self,
+                "Collection created",
+                f"You may now add datasets to "
+                f"collection '{collection['name']}'.",
+            )
+
     @QtCore.pyqtSlot(str, str)
     def on_remove_item(self, id_type, identifier):
         """Remove a dataset from a collection"""