ref: 2.3.グループ管理連携機能開発: Update code handle groups addon

Author: tma-hcphat

addons.json

@@ -33,7 +33,8 @@
         "onedrivebusiness",
         "metadata",
         "onlyoffice",
-        "workflow"
+        "workflow",
+        "groups"
     ],
     "addons_default": [
         "osfstorage",
@@ -140,7 +141,8 @@
         "onedrivebusiness": "OneDrive for Office365 is a file storage add-on. Connect your Microsoft OneDrive account to a GakuNin RDM project to interact with files hosted on Microsoft OneDrive via the GakuNin RDM.",
         "metadata": "The Metadata addon provides the functionality to register metadata to files and generate reports.",
         "onlyoffice": "ONLYOFFICE document server.",
-        "workflow": "Workflow gateway integration that serves engine key material to trusted services."
+        "workflow": "Workflow gateway integration that serves engine key material to trusted services.",
+        "groups": "Groups is an add-on that allows users to create and manage groups of users within the GakuNin RDM."
     },
     "addons_url": {
         "box": "http://www.box.com",
@@ -169,7 +171,8 @@
         "onedrivebusiness": "https://onedrive.live.com",
         "metadata": "https://rcos.nii.ac.jp/service/rdm/",
         "onlyoffice": "https://onlyoffice.com/",
-        "workflow": "https://rcos.nii.ac.jp/service/rdm/"
+        "workflow": "https://rcos.nii.ac.jp/service/rdm/",
+        "groups": "https://rcos.nii.ac.jp/service/rdm/groups/"
     },
     "institutional_storage_add_on_method": [
         "nextcloudinstitutions",

addons/groups/README.md

@@ -0,0 +1,5 @@
+# RDM Groups Addon
+
+## Feature
+
+The RDM Groups Addon provides a way to enable/disable groups management in project

addons/groups/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+DISPLAY_NAME = 'Groups'
+SHORT_NAME = 'groups'
+FULL_NAME = 'addons.groups'
+default_app_config = 'addons.{}.apps.AddonAppConfig'.format(SHORT_NAME)

addons/groups/apps.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+import os
+from addons.base.apps import BaseAddonAppConfig
+from . import DISPLAY_NAME, SHORT_NAME
+
+
+HERE = os.path.dirname(os.path.abspath(__file__))
+TEMPLATE_PATH = os.path.join(
+    HERE,
+    'templates'
+)
+
+
+class AddonAppConfig(BaseAddonAppConfig):
+
+    short_name = SHORT_NAME
+    name = 'addons.{}'.format(SHORT_NAME)
+    label = 'addons_{}'.format(SHORT_NAME)
+
+    full_name = DISPLAY_NAME
+
+    owners = ['user', 'node']
+
+    views = ['page']
+    configs = ['node']
+
+    categories = ['other']
+
+    include_js = {}
+
+    include_css = {
+        'widget': [],
+        'page': [],
+    }
+
+    added_default = []
+
+    has_page_icon = False
+
+    node_settings_template = os.path.join(TEMPLATE_PATH, 'groups_node_settings.mako')
+
+    @property
+    def routes(self):
+        from . import routes
+        return [routes.api_routes, routes.page_routes]
+
+    @property
+    def user_settings(self):
+        return self.get_model('UserSettings')
+
+    @property
+    def node_settings(self):
+        return self.get_model('NodeSettings')

addons/groups/migrations/0001_initial.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.28 on 2026-03-09 07:22
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django_extensions.db.fields
+import osf.models.base
+import osf.utils.fields
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='NodeSettings',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('_id', models.CharField(db_index=True, default=osf.models.base.generate_object_id, max_length=24, unique=True)),
+                ('is_deleted', models.BooleanField(default=False)),
+                ('deleted', osf.utils.fields.NonNaiveDateTimeField(blank=True, null=True)),
+                ('owner', models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='addons_groups_node_settings', to='osf.AbstractNode')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=(models.Model, osf.models.base.QuerySetExplainMixin),
+        ),
+        migrations.CreateModel(
+            name='UserSettings',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('_id', models.CharField(db_index=True, default=osf.models.base.generate_object_id, max_length=24, unique=True)),
+                ('is_deleted', models.BooleanField(default=False)),
+                ('deleted', osf.utils.fields.NonNaiveDateTimeField(blank=True, null=True)),
+                ('owner', models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='addons_groups_user_settings', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=(models.Model, osf.models.base.QuerySetExplainMixin),
+        ),
+        migrations.AddField(
+            model_name='nodesettings',
+            name='user_settings',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='addons_groups.UserSettings'),
+        ),
+    ]

addons/groups/migrations/__init__.py

@@ -0,0 +1,10 @@
+from addons.base.models import BaseUserSettings, BaseNodeSettings
+from django.db import models
+
+
+class UserSettings(BaseUserSettings):
+    pass
+
+
+class NodeSettings(BaseNodeSettings):
+    user_settings = models.ForeignKey(UserSettings, null=True, blank=True, on_delete=models.CASCADE)

addons/groups/models.py

@@ -0,0 +1,24 @@
+"""
+Routes associated with the groups addon
+"""
+
+from framework.routing import Rule, json_renderer
+from . import SHORT_NAME
+from . import views
+
+
+TEMPLATE_DIR = './addons/groups/templates/'
+
+api_routes = {
+    'rules': [
+        Rule([
+            '/project/<pid>/{}/settings/'.format(SHORT_NAME),
+            '/project/<pid>/node/<nid>/{}/settings/'.format(SHORT_NAME),
+        ], 'get', views.groups_get_config, json_renderer),
+    ],
+    'prefix': '/api/v1',
+}
+
+page_routes = {
+    'rules': []
+}

addons/groups/routes.py

@@ -0,0 +1,10 @@
+import logging
+from .defaults import *  # noqa
+
+
+logger = logging.getLogger(__name__)
+
+try:
+    from .local import *  # noqa
+except ImportError:
+    logger.warn('No local.py settings file found')

addons/groups/settings/__init__.py

@@ -0,0 +1,3 @@
+"""
+Groups addon default settings
+"""