crud group ownership (#601)

Author: ciur

papermerge/core/features/custom_fields/db/api.py

@@ -3,7 +3,7 @@
 import uuid
 
 from sqlalchemy import select, func, or_
-from sqlalchemy.orm import Session
+from sqlalchemy.orm import Session, aliased
 
 
 from papermerge.core import schema, orm
@@ -17,6 +17,8 @@
     "-type": orm.CustomField.type.desc(),
     "name": orm.CustomField.name.asc(),
     "-name": orm.CustomField.name.desc(),
+    "group_name": orm.Group.name.asc().nullsfirst(),
+    "-group_name": orm.Group.name.desc().nullslast(),
 }
 
 
@@ -29,9 +31,16 @@ def get_custom_fields(
     filter: str,
     order_by: str = "name",
 ) -> schema.PaginatedResponse[schema.CustomField]:
+
+    UserGroupAlias = aliased(orm.user_groups_association)
+    subquery = select(UserGroupAlias.c.group_id).where(
+        UserGroupAlias.c.user_id == user_id
+    )
+
     stmt_total_cf = select(func.count(orm.CustomField.id)).where(
-        orm.CustomField.user_id == user_id
+        or_(orm.CustomField.user_id == user_id, orm.CustomField.group_id.in_(subquery))
     )
+
     if filter:
         stmt_total_cf = stmt_total_cf.where(
             or_(
@@ -45,8 +54,18 @@ def get_custom_fields(
 
     offset = page_size * (page_number - 1)
     stmt = (
-        select(orm.CustomField)
-        .where(orm.CustomField.user_id == user_id)
+        select(
+            orm.CustomField,
+            orm.Group.name.label("group_name"),
+            orm.Group.id.label("group_id"),
+        )
+        .join(orm.Group, orm.Group.id == orm.CustomField.group_id, isouter=True)
+        .where(
+            or_(
+                orm.CustomField.user_id == user_id,
+                orm.CustomField.group_id.in_(subquery),
+            )
+        )
         .limit(page_size)
         .offset(offset)
         .order_by(order_by_value)
@@ -59,9 +78,20 @@ def get_custom_fields(
                 orm.CustomField.type.icontains(filter),
             )
         )
+    items = []
 
-    db_cfs = db_session.scalars(stmt).all()
-    items = [schema.CustomField.model_validate(db_cf) for db_cf in db_cfs]
+    for row in db_session.execute(stmt):
+        kwargs = {
+            "id": row.CustomField.id,
+            "name": row.CustomField.name,
+            "type": row.CustomField.type,
+            "extra_data": row.CustomField.extra_data,
+        }
+        if row.group_name and row.group_id:
+            kwargs["group_id"] = row.group_id
+            kwargs["group_name"] = row.group_name
+
+        items.append(schema.CustomField(**kwargs))
 
     total_pages = math.ceil(total_cf / page_size)
 
@@ -127,9 +157,23 @@ def create_custom_field(
 def get_custom_field(
     session: Session, custom_field_id: uuid.UUID
 ) -> schema.CustomField:
-    stmt = select(orm.CustomField).where(orm.CustomField.id == custom_field_id)
-    db_item = session.scalars(stmt).unique().one()
-    result = schema.CustomField.model_validate(db_item)
+    stmt = (
+        select(orm.CustomField, orm.Group)
+        .join(orm.Group, orm.Group.id == orm.CustomField.group_id, isouter=True)
+        .where(orm.CustomField.id == custom_field_id)
+    )
+    row = session.execute(stmt).unique().one()
+    kwargs = {
+        "id": row.CustomField.id,
+        "name": row.CustomField.name,
+        "type": row.CustomField.type,
+        "extra_data": row.CustomField.extra_data,
+    }
+    if row.Group and row.Group.id:
+        kwargs["group_id"] = row.Group.id
+        kwargs["group_name"] = row.Group.name
+
+    result = schema.CustomField(**kwargs)
     return result
 
 
@@ -156,13 +200,16 @@ def update_custom_field(
     if attrs.extra_data:
         cfield.extra_data = attrs.extra_data
 
-    if attrs.user_id:
-        cfield.user_id = attrs.user_id
-        cfield.group_id = None
-
     if attrs.group_id:
         cfield.user_id = None
         cfield.group_id = attrs.group_id
+    elif attrs.user_id:
+        cfield.user_id = attrs.user_id
+        cfield.group_id = None
+    else:
+        raise ValueError(
+            "Either attrs.user_id or attrs.group_id should be non-empty value"
+        )
 
     session.commit()
     result = schema.CustomField.model_validate(cfield)

papermerge/core/features/custom_fields/router.py

@@ -228,14 +228,16 @@ def update_custom_field(
         if attrs.group_id:
             group_id = attrs.group_id
             ok = user_dbapi.user_belongs_to(
-                db_session, user_id=attrs.id, group_id=group_id
+                db_session, user_id=cur_user.id, group_id=group_id
             )
             if not ok:
                 user_id = cur_user.id
                 detail = f"User {user_id=} does not belong to group {group_id=}"
                 raise HTTPException(
                     status_code=status.HTTP_403_FORBIDDEN, detail=detail
                 )
+        else:
+            attrs.user_id = cur_user.id
         try:
             cfield: cf_schema.CustomField = dbapi.update_custom_field(
                 db_session, custom_field_id=custom_field_id, attrs=attrs

papermerge/core/features/custom_fields/schema.py

@@ -25,6 +25,8 @@ class CustomField(BaseModel):
     # Basically `extra_data` is either a stringified JSON i.e. json.dumps(...)
     # or an actually python dict (or None)
     extra_data: str | dict | None
+    group_id: UUID | None = None
+    group_name: str | None = None
 
     # Config
     model_config = ConfigDict(from_attributes=True)

papermerge/core/features/custom_fields/tests/test_dbapi_custom_fields.py

@@ -45,7 +45,7 @@ def test_custom_field_update(db_session: Session, user: User):
     dbapi.update_custom_field(
         db_session,
         custom_field_id=cfield.id,
-        attrs=schema.UpdateCustomField(name="new_cf1_name"),
+        attrs=schema.UpdateCustomField(name="new_cf1_name", user_id=user.id),
     )
 
     updated_cf1 = dbapi.get_custom_field(db_session, cfield.id)

papermerge/core/features/custom_fields/types.py

@@ -8,6 +8,8 @@ class OrderBy(str, Enum):
     name_desc = "-name"
     type_asc = "type"
     type_desc = "-type"
+    owner_asc = "group_name"
+    owner_desc = "-group_name"
 
 
 class PaginatedQueryParams(BaseParams):

ui2/src/components/OwnerSelect/OwnerSelect.tsx

@@ -0,0 +1,55 @@
+import {useGetUserGroupHomesQuery} from "@/features/users/apiSlice"
+
+import {ComboboxItem, ComboboxItemGroup, Select, Skeleton} from "@mantine/core"
+
+interface Args {
+  value: ComboboxItem
+  onChange: (value: ComboboxItem) => void
+}
+
+export default function OwnerSelector({onChange, value}: Args) {
+  const {data, isLoading} = useGetUserGroupHomesQuery()
+
+  const onLocalChange = (_value: string | null, option: ComboboxItem) => {
+    onChange(option)
+  }
+
+  if (isLoading) {
+    return (
+      <Skeleton>
+        <Select />
+      </Skeleton>
+    )
+  }
+
+  let owners_data: ComboboxItemGroup[] = [
+    {
+      group: "Me",
+      items: [{value: "", label: "Me"}]
+    }
+  ]
+
+  if (data && data?.length > 0) {
+    let items = data.map(i => {
+      return {value: i.group_id, label: i.group_name}
+    })
+    owners_data = owners_data.concat({
+      group: "My Groups",
+      items: items
+    })
+  }
+
+  return (
+    <Select
+      mt="md"
+      label={"Owner"}
+      data={owners_data}
+      value={value ? value.value : null}
+      onChange={onLocalChange}
+      allowDeselect={false}
+      defaultValue={""}
+      searchable
+      checkIconPosition="right"
+    />
+  )
+}

ui2/src/components/OwnerSelect/index.tsx

@@ -31,6 +31,13 @@ export default function CustomFieldForm({customField}: Args) {
         data={CUSTOM_FIELD_DATA_TYPES}
         onChange={() => {}}
       />
+      <TextInput
+        my="md"
+        label="Owner"
+        value={customField?.group_name || "Me"}
+        onChange={() => {}}
+        rightSection={<CopyButton value={customField?.group_name || "Me"} />}
+      />
     </Box>
   )
 }

ui2/src/features/custom-fields/components/CustomFieldForm.tsx

@@ -38,6 +38,7 @@ export default function CustomFieldRow({customField}: Args) {
       <Table.Td>
         <Link to={`/custom-fields/${customField.id}`}>{customField.type}</Link>
       </Table.Td>
+      <Table.Td>{customField.group_name || "Me"}</Table.Td>
     </Table.Tr>
   )
 }

ui2/src/features/custom-fields/components/CustomFieldRow.tsx

@@ -1,6 +1,8 @@
+import OwnerSelector from "@/components/OwnerSelect/OwnerSelect"
 import type {CurrencyType, CustomFieldDataType} from "@/types"
 import {
   Button,
+  ComboboxItem,
   Group,
   Loader,
   LoadingOverlay,
@@ -38,6 +40,7 @@ export default function EditGroupModal({
   const [dataType, setDataType] = useState<CustomFieldDataType>(
     data?.type || "text"
   )
+  const [owner, setOwner] = useState<ComboboxItem>({value: "", label: "Me"})
 
   useEffect(() => {
     formReset()
@@ -46,6 +49,11 @@ export default function EditGroupModal({
   const formReset = () => {
     if (data) {
       setName(data.name || "")
+      if (data.group_id && data.group_name) {
+        setOwner({value: data.group_id, label: data.group_name})
+      } else {
+        setOwner({value: "", label: "Me"})
+      }
     }
   }
 
@@ -56,14 +64,22 @@ export default function EditGroupModal({
       extra_data = JSON.stringify({currency: currency})
     }
 
-    let updatedData = {
+    const updatedData = {
       id: customFieldId,
       name: name,
       type: dataType,
       extra_data: extra_data
     }
 
-    await updateCustomField(updatedData)
+    let cfData
+    if (owner.value && owner.value != "") {
+      // @ts-ignore
+      cfData = {...updatedData, group_id: owner.value}
+    } else {
+      cfData = updatedData
+    }
+
+    await updateCustomField(cfData)
     formReset()
     onSubmit()
   }
@@ -77,6 +93,10 @@ export default function EditGroupModal({
     setCurrency(value as CurrencyType)
   }
 
+  const onOwnerChange = (option: ComboboxItem) => {
+    setOwner(option)
+  }
+
   return (
     <Modal
       title={"Edit Custom Field"}
@@ -104,6 +124,7 @@ export default function EditGroupModal({
           setDataType(e.currentTarget.value as CustomFieldDataType)
         }
       />
+      <OwnerSelector value={owner} onChange={onOwnerChange} />
       {dataType == "monetary" && (
         <Select
           mt="sm"

ui2/src/features/custom-fields/components/EditCustomFieldModal.tsx

@@ -7,9 +7,11 @@ import {
   lastPageSizeUpdate,
   selectLastPageSize,
   selectReverseSortedByName,
+  selectReverseSortedByOwner,
   selectReverseSortedByType,
   selectSelectedIds,
   selectSortedByName,
+  selectSortedByOwner,
   selectSortedByType,
   selectTableSortColumns,
   selectionAddMany,
@@ -27,8 +29,10 @@ export default function CustomFieldsList() {
   const tablerSortCols = useSelector(selectTableSortColumns)
   const sortedByName = useSelector(selectSortedByName)
   const sortedByType = useSelector(selectSortedByType)
+  const sortedByOwner = useSelector(selectSortedByOwner)
   const reverseSortedByName = useSelector(selectReverseSortedByName)
   const reverseSortedByType = useSelector(selectReverseSortedByType)
+  const reverseSortedByOwner = useSelector(selectReverseSortedByOwner)
   const dispatch = useDispatch()
   const lastPageSize = useSelector(selectLastPageSize)
   const [page, setPage] = useState<number>(1)
@@ -141,6 +145,13 @@ export default function CustomFieldsList() {
             >
               Type
             </Th>
+            <Th
+              sorted={sortedByOwner}
+              reversed={reverseSortedByOwner}
+              onSort={() => onSortBy("group_name")}
+            >
+              Owner
+            </Th>
           </Table.Tr>
         </Table.Thead>
         <Table.Tbody>{customFieldRows}</Table.Tbody>