2170 introduce gender model

docs/Actions-Overview.md

@@ -207,6 +207,12 @@ A more general format description see in [Action-Service](https://github.com/Ope
 - [theme.delete](actions/theme.delete.md)
 - [theme.update](actions/theme.update.md)
 
+## Gender
+
+- [gender.create](actions/theme.create.md)
+- [gender.delete](actions/theme.delete.md)
+- [gender.update](actions/theme.update.md)
+
 ## Topics
 
 - [topic.create](actions/topic.create.md)

docs/actions/account.json_upload.md

@@ -14,7 +14,7 @@ The types noted below are the internal types after conversion in the backend. Se
         member_number: string, // unique member_number, info: done (used as matching field), new (newly added) or error
         title: string,
         pronoun: string,
-        gender: string, // as defined in organization/genders, info: done or warning
+        gender: string, // info: done or warning
         default_password: string,  // info: generated, done or warning
         is_active: boolean,
         is_physical_person: boolean,

docs/actions/gender.create.md

@@ -0,0 +1,13 @@
+## Payload
+```
+{
+// Required
+    name: string;
+}
+```
+
+## Action
+Creates the gender if a gender with the same name doesn't exist.
+
+## Permissions
+The user needs to have the organization management level `can_manage_organization`.

docs/actions/gender.delete.md

@@ -0,0 +1,10 @@
+## Payload
+```
+{id: Id;}
+```
+
+## Action
+Deletes the gender.
+
+## Permissions
+The user needs to have the organization management level `can_manage_organization`.

docs/actions/gender.update.md

@@ -0,0 +1,15 @@
+## Payload
+```js
+ {
+// Required
+    id: number;
+// Group A
+    name: string;
+}
+```
+
+## Action
+Updates the gender if a gender with that name doesn't exist.
+
+## Permissions
+- Group A: The user needs the OML `can_manage_organization`

docs/actions/meeting.import.md

@@ -16,10 +16,11 @@ Import one meeting from a file. The file must only contain exactly one meeting.
 - The request user is assigned to the admin group.
 - meeting.is_active_in_organization_id is set.
 - It has to be checked, whether the organization.limit_of_meetings is unlimited(=0) or lower than the active meetings in organization.active_meeting_ids, if the new meeting is not archived (`is_active_in_organization_id` is set)
-- Search for users and if username, first-name, last-name and email are identical use this user instead creating a duplicate. Keep the data, including password, of the exiating user.
+- Search for users and if username, first-name, last-name and email are identical use this existing user instead of creating a duplicate. Keep the data, including password, of the existing user. Relevant relations such as to the meeting will be updated though.
 - Users, that still have to be duplicated:
   - Imported usernames will be checked for uniqueness and adjusted in the case of collisions.
   - All previously set user passwords will be replaced
+- Genders will only be updated or imported if a new user needs to be created. Updated users will not have their genders updated.
 
 
 ## Permissions

docs/actions/organization.update.md

@@ -1,5 +1,5 @@
 ## Payload
-```
+```js
 {
 // Required
     id: Id;
@@ -17,7 +17,6 @@
     users_email_replyto: string;
     users_email_subject: string;
     users_email_body: text;
-    genders: string[];
     require_duplicate_from: boolean;
 
 // Group B
@@ -38,8 +37,6 @@
 Updates the organization.
 It has to be checked that the theme_id has to be one of the theme_ids.
 
-Checks for deleted genders and clean the gender of users which have deleted genders.
-
 ## Permissions
 - Users with OML of `can_manage_organization` can modify group A
 - Users with OML of `superadmin` can modify group B

docs/actions/participant.json_upload.md

@@ -14,7 +14,7 @@ The types noted below are the internal types after conversion in the backend. Se
           member_number: string, // unique member_number, info: done, error, new (newly added) or remove (missing field permission)
           title: string,  // info: done or remove (missing field permission)
           pronoun: string,  // info: done or remove (missing field permission)
-          gender: string, // as defined in organization/genders, info: done, warning (undefined gender) or remove (missing field permission)
+          gender: string, // info: done, warning (undefined gender) or remove (missing field permission)
           default_password: string,  // info: generated, done, warning or remove (missing field permission)
           is_active: boolean,  // info: done or remove (missing field permission)
           is_physical_person: boolean,  // info: done or remove (missing field permission)

docs/actions/user.create.md

@@ -1,5 +1,5 @@
 ## Payload
-```
+```js
 {
 // Optional
 // Group A
@@ -11,7 +11,7 @@
     is_active: boolean;
     is_physical_person: boolean;
     can_change_own_password: boolean;
-    gender: string;
+    gender_id: Id;
     pronoun: string;
     email: string;
     default_vote_weight: decimal(6);
@@ -57,7 +57,7 @@ Creates a user.
 * If `username` is given, it has to be unique within all users. If there already exists a user with the same username, an error must be returned. If the `username` is not given, 1. the saml_id will be used or 2. it has to be generated (see [user.create#generate-a-username](user.create.md#generate-a-username) below). Also the username may not contain spaces.
 * The `organization_management_level` as restring can be taken from the enum of this user field.
 * Remove starting and trailing spaces from `username`, `first_name` and `last_name`
-* The given `gender` must be present in `organization/genders`
+* The given `gender_id` must be present in `organization/gender_ids`
 * If `saml_id` is set in payload, there may be no `password` or `default_password` set or generated and `set_change_own_password` will be set to False.
 * The `member_number` must be unique within all users.
 * Will throw an error if the `group_ids` contain the meetings `anonymous_group_id`.

docs/actions/user.merge_together.md

@@ -13,7 +13,7 @@
     is_active: boolean;
     is_physical_person: boolean;
     default_password: string;
-    gender: string;
+    gender_id: Id;
     email: string;
     default_vote_weight: decimal(6);
     pronoun: string;

docs/actions/user.save_saml_account.md

@@ -16,7 +16,7 @@
 
 ## Action
 The attributes for the payload are all configured in organization-wide settings. The configuration consists of a list of source attribute - target attribute pairs, where the target attributes are the ones documented in the payload.
-Creates or updates the saml-account, depending whether the given `saml_id` exists or not. The `saml_id` is guaranteed to be unique in the whole system. The other fields will be set on creation or update.
+Creates or updates the saml-account, depending whether the given `saml_id` exists or not. The `saml_id` is guaranteed to be unique in the whole system. If a gender does not exist in the collection, it will be created. The other fields will be set on creation or update.
 The action must be `STACK_INTERNAL`. It should be called only from the auth service.
 
 Extras to do on creation:

docs/actions/user.update.md

@@ -1,5 +1,5 @@
 ## Payload
-```
+```js
 {
 // Required
     id: Id;
@@ -14,7 +14,7 @@
     is_active: boolean;
     is_physical_person: boolean;
     can_change_own_password: boolean;
-    gender: string;
+    gender_id: Id;
     pronoun: string;
     email: string;
     default_vote_weight: decimal(6);

docs/actions/user.update_self.md

@@ -4,7 +4,7 @@
 // Optional
     username: string;
     email: string;
-    gender: string;
+    gender_id: Id;
     pronoun: string;
 }
 ```

docs/presenters/export_meeting.md

@@ -11,10 +11,11 @@
 ```
 JSON with export
 ```
+The users genders are exported as their names not ids.
 
 # Logic
 The presenter exports the meeting, the collections which belong to the meeting and users of the meeting. It uses the meeting.user_id for that. And it excludes the organization tags and the committee.
-Will raise an exception if the meeting is locked voa the `locked_from_inside` setting.
+Will raise an exception if the meeting is locked via the `locked_from_inside` setting.
 
 # Permissions
 The request user must have the `SUPERADMIN` organization management level.

global/data/example-data.json

@@ -1,13 +1,39 @@
 {
-    "_migration_index": 54,
+    "_migration_index": 55,
+    "gender":{
+        "1":{
+            "id": 1,
+            "name": "male",
+            "organization_id": 1,
+            "user_ids":[1]
+        },
+        "2":{
+            "id": 2,
+            "name": "female",
+            "organization_id": 1,
+            "user_ids":[2]
+        },
+        "3":{
+            "id": 3,
+            "name": "diverse",
+            "organization_id": 1,
+            "user_ids":[3]
+        },
+        "4":{
+            "id": 4,
+            "name": "non-binary",
+            "organization_id": 1,
+            "user_ids":[]
+        }
+    },
     "organization": {
         "1": {
             "id": 1,
             "name": "Test Organization",
             "legal_notice": "<a href=\"http://www.openslides.org\">OpenSlides</a> is a free web based presentation and assembly system for visualizing and controlling agenda, motions and elections of an assembly.",
             "login_text": "Good Morning!",
             "default_language": "en",
-            "genders": ["male", "female", "diverse", "non-binary"],
+            "gender_ids": [1, 2 ,3 ,4],
             "enable_electronic_voting": true,
             "enable_chat": true,
             "reset_password_verbose_errors": true,
@@ -60,7 +86,7 @@
             "password": "316af7b2ddc20ead599c38541fbe87e9a9e4e960d4017d6e59de188b41b2758flD5BVZAZ8jLy4nYW9iomHcnkXWkfk3PgBjeiTSxjGG7+fBjMBxsaS1vIiAMxYh+K38l0gDW4wcP+i8tgoc4UBg==",
             "default_password": "admin",
             "can_change_own_password": true,
-            "gender": "male",
+            "gender_id": 1,
             "default_vote_weight": "1.000000",
             "organization_management_level": "superadmin",
             "is_present_in_meeting_ids": [
@@ -89,7 +115,7 @@
             "password": "316af7b2ddc20ead599c38541fbe87e9a9e4e960d4017d6e59de188b41b2758fDB3tv5HcCtPRREt7bPGqerTf1AbmoKXt/fVFkLY4znDRh2Yy0m3ZjXD0nHI8oa6KrGlHH/cvysfvf8i2fWIzmw==",
             "default_password": "a",
             "can_change_own_password": true,
-            "gender": "female",
+            "gender_id": 2,
             "default_vote_weight": "1.000000",
             "committee_ids": [
                 1
@@ -110,7 +136,7 @@
             "password": "316af7b2ddc20ead599c38541fbe87e9a9e4e960d4017d6e59de188b41b2758fIxDxvpkn6dDLRxT9DxJhZ/f04AL2oK2beICRFobSw53CI93U+dfN+w+NaL7BvrcR4JWuMj9NkH4dVjnnI0YTkg==",
             "default_password": "jKwSLGCk",
             "can_change_own_password": true,
-            "gender": "diverse",
+            "gender_id": 3,
             "default_vote_weight": "1.000000",
             "option_ids": [8, 11],
             "meeting_user_ids": [3],

global/data/initial-data.json

@@ -1,12 +1,38 @@
 {
-    "_migration_index": 54,
+    "_migration_index": 55, 
+    "gender":{
+        "1":{
+            "id": 1,
+            "name": "male",
+            "organization_id": 1,
+            "user_ids":[]
+        },
+        "2":{
+            "id": 2,
+            "name": "female",
+            "organization_id": 1,
+            "user_ids":[]
+        },
+        "3":{
+            "id": 3,
+            "name": "diverse",
+            "organization_id": 1,
+            "user_ids":[]
+        },
+        "4":{
+            "id": 4,
+            "name": "non-binary",
+            "organization_id": 1,
+            "user_ids":[]
+        }
+    },
     "organization": {
         "1": {
             "id": 1,
             "name": "[Your organization]",
             "legal_notice": "<a href=\"http://www.openslides.org\">OpenSlides</a> is a free web based presentation and assembly system for visualizing and controlling agenda, motions and elections of an assembly. The event organizer is resposible for the content.",
             "login_text": "Welcome to OpenSlides. Please login.",
-            "genders": ["male", "female", "diverse", "non-binary"],
+            "gender_ids": [1, 2, 3, 4],
             "default_language": "en",
             "enable_electronic_voting": true,
             "limit_of_meetings": 0,

openslides_backend/action/actions/__init__.py

@@ -12,6 +12,7 @@ def prepare_actions_map() -> None:
         chat_group,
         chat_message,
         committee,
+        gender,
         group,
         list_of_speakers,
         mediafile,

openslides_backend/action/actions/gender/__init__.py

@@ -0,0 +1 @@
+from . import create, delete, update  # noqa

openslides_backend/action/actions/gender/create.py

@@ -0,0 +1,28 @@
+from typing import Any
+
+from ....action.mixins.archived_meeting_check_mixin import CheckForArchivedMeetingMixin
+from ....models.models import Gender
+from ....permissions.management_levels import OrganizationManagementLevel
+from ....shared.util import ONE_ORGANIZATION_ID
+from ...generics.create import CreateAction
+from ...util.default_schema import DefaultSchema
+from ...util.register import register_action
+from .mixins import GenderUniqueMixin
+
+
+@register_action("gender.create")
+class GenderCreate(CreateAction, CheckForArchivedMeetingMixin, GenderUniqueMixin):
+    """
+    Action to create a gender.
+    """
+
+    model = Gender()
+    schema = DefaultSchema(Gender()).get_create_schema(
+        required_properties=["name"],
+    )
+    permission = OrganizationManagementLevel.CAN_MANAGE_USERS
+
+    def update_instance(self, instance: dict[str, Any]) -> dict[str, Any]:
+        super().update_instance(instance)
+        instance["organization_id"] = ONE_ORGANIZATION_ID
+        return instance

openslides_backend/action/actions/gender/delete.py

@@ -0,0 +1,18 @@
+from ....models.models import Gender
+from ....permissions.management_levels import OrganizationManagementLevel
+from ...generics.delete import DeleteAction
+from ...util.default_schema import DefaultSchema
+from ...util.register import register_action
+from .mixins import GenderPermissionMixin
+
+
+@register_action("gender.delete")
+class GenderDeleteAction(DeleteAction, GenderPermissionMixin):
+    """
+    Action to delete a gender.
+    """
+
+    model = Gender()
+    schema = DefaultSchema(Gender()).get_delete_schema()
+    permission = OrganizationManagementLevel.CAN_MANAGE_USERS
+    skip_archived_meeting_check = True

openslides_backend/action/actions/gender/mixins.py

@@ -0,0 +1,38 @@
+from typing import Any
+
+from datastore.shared.util import fqid_from_collection_and_id
+
+from openslides_backend.action.action import Action
+from openslides_backend.shared.exceptions import ActionException, PermissionException
+
+from ...mixins.check_unique_name_mixin import CheckUniqueInContextMixin
+
+
+class GenderUniqueMixin(CheckUniqueInContextMixin):
+    def validate_instance(self, instance: dict[str, Any]) -> None:
+        if instance.get("name") == "":
+            raise ActionException("Empty gender name not allowed.")
+        super().validate_instance(instance)
+        self.check_unique_in_context(
+            "name",
+            instance.get("name", ""),
+            "Gender '" + instance.get("name", "") + "' already exists.",
+            instance.get("id"),
+        )
+
+
+class GenderPermissionMixin(Action):
+    def check_permissions(self, instance: dict[str, Any]) -> None:
+        super().check_permissions(instance)
+        # default genders shall not be mutable
+        gender_id = instance.get("id", 0)
+        if 0 < gender_id < 5:
+            if gender_name := self.datastore.get(
+                fqid_from_collection_and_id("gender", gender_id),
+                ["name"],
+                lock_result=False,
+            ).get("name"):
+                msg = f"Cannot delete or update gender '{gender_name}' from default selection."
+            else:
+                msg = f"Cannot delete or update gender '{gender_id}' from default selection."
+            raise PermissionException(msg)