Add a folder property to feeds

Author: jbernal0019

chris_backend/feeds/migrations/0012_feed_folder.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.5 on 2024-03-28 19:29
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0006_remove_chrislinkfile_is_folder_and_more'),
+        ('feeds', '0011_feed_public'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='feed',
+            name='folder',
+            field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='feed', to='core.chrisfolder'),
+        ),
+    ]

chris_backend/feeds/models.py

@@ -1,9 +1,12 @@
 
 from django.db import models
+from django.db.models.signals import post_delete
+from django.dispatch import receiver
 
 import django_filters
 from django_filters.rest_framework import FilterSet
 
+from core.models import ChrisFolder
 from userfiles.models import UserFile
 
 
@@ -12,6 +15,8 @@ class Feed(models.Model):
     modification_date = models.DateTimeField(auto_now_add=True)
     name = models.CharField(max_length=200, blank=True, db_index=True)
     public = models.BooleanField(blank=True, default=False, db_index=True)
+    folder = models.OneToOneField(ChrisFolder, on_delete=models.CASCADE, null=True,
+                                  related_name='feed')
     owner = models.ManyToManyField('auth.User', related_name='feed')
 
     class Meta:
@@ -51,6 +56,11 @@ def get_plugin_instances_status_count(self, status):
         return self.plugin_instances.filter(status=status).count()
 
 
+@receiver(post_delete, sender=Feed)
+def auto_delete_folder_with_feed(sender, instance, **kwargs):
+    instance.folder.delete()
+
+
 class FeedFilter(FilterSet):
     min_id = django_filters.NumberFilter(field_name="id", lookup_expr='gte')
     max_id = django_filters.NumberFilter(field_name="id", lookup_expr='lte')
@@ -83,7 +93,7 @@ def filter_by_fname_icontains(self, queryset, name, value):
         qs_l = []
 
         for feed in queryset:
-            qs = UserFile.objects.filter(fname__contains=f'/feeds/feed_{feed.id}/')
+            qs = UserFile.objects.filter(fname__startswith=feed.folder.path)
             for val in value_l:
                 qs = qs.filter(fname__icontains=val)
             qs_l.append(qs)
@@ -94,9 +104,8 @@ def filter_by_fname_icontains(self, queryset, name, value):
         for f in files_qs:
             path = f.fname.name
             path_tokens = path.split('/', 4)
-            if path_tokens[2] == 'feeds':
-                feed_id = int(path_tokens[3].split('_')[1])
-                feed_ids.add(feed_id)
+            feed_id = int(path_tokens[3].split('_')[1])
+            feed_ids.add(feed_id)
 
         return queryset.filter(pk__in=list(feed_ids))
 

chris_backend/feeds/serializers.py

@@ -92,6 +92,7 @@ def validate_feed(self, feed_id):
 
 class FeedSerializer(serializers.HyperlinkedModelSerializer):
     creator_username = serializers.SerializerMethodField()
+    folder_path = serializers.ReadOnlyField(source='folder.path')
     created_jobs = serializers.SerializerMethodField()
     waiting_jobs = serializers.SerializerMethodField()
     scheduled_jobs = serializers.SerializerMethodField()
@@ -100,6 +101,8 @@ class FeedSerializer(serializers.HyperlinkedModelSerializer):
     finished_jobs = serializers.SerializerMethodField()
     errored_jobs = serializers.SerializerMethodField()
     cancelled_jobs = serializers.SerializerMethodField()
+    folder = serializers.HyperlinkedRelatedField(view_name='chrisfolder-detail',
+                                                 read_only=True)
     note = serializers.HyperlinkedRelatedField(view_name='note-detail', read_only=True)
     tags = serializers.HyperlinkedIdentityField(view_name='feed-tag-list')
     taggings = serializers.HyperlinkedIdentityField(view_name='feed-tagging-list')
@@ -112,10 +115,10 @@ class FeedSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Feed
         fields = ('url', 'id', 'creation_date', 'modification_date', 'name', 'public',
-                  'creator_username', 'created_jobs', 'waiting_jobs', 'scheduled_jobs',
-                  'started_jobs', 'registering_jobs', 'finished_jobs', 'errored_jobs',
-                  'cancelled_jobs', 'owner', 'note', 'tags', 'taggings', 'comments',
-                  'plugin_instances')
+                  'creator_username', 'folder_path', 'created_jobs', 'waiting_jobs',
+                  'scheduled_jobs', 'started_jobs', 'registering_jobs',
+                  'finished_jobs',  'errored_jobs', 'cancelled_jobs', 'folder', 'note',
+                  'tags', 'taggings', 'comments', 'plugin_instances', 'owner')
 
     def validate_name(self, name):
         """

chris_backend/plugininstances/models.py

@@ -99,6 +99,13 @@ def _save_feed(self):
         feed = Feed()
         feed.name = self.title or self.plugin.meta.name
         feed.save()
+
+        # feed's folder path: SWIFT_CONTAINER_NAME/home/<username>/feeds/feed_<id>
+        feed_folder_path = f'home/{self.owner.username}/feeds/feed_{feed.id}'
+        folder = ChrisFolder(path=feed_folder_path, owner=self.owner)
+        folder.save()
+
+        feed.folder = folder
         feed.owner.set([self.owner])
         feed.save()
         return feed
@@ -187,7 +194,8 @@ def get_output_path(self):
 
 @receiver(post_delete, sender=PluginInstance)
 def auto_delete_output_folder_with_plugin_instance(sender, instance, **kwargs):
-    instance.output_folder.delete()
+    if instance.output_folder:
+        instance.output_folder.delete()
 
 
 class PluginInstanceFilter(FilterSet):