dmart 1.4.40.post8__py3-none-any.whl

dmart/sample/spaces/applications/schema/query.json

@@ -0,0 +1,118 @@
+{
+  "title": "Report",
+  "type": "object",
+  "required": [],
+  "properties": {
+    "type": {
+      "title": "Query Type",
+      "type": "string",
+      "default": "search"
+    },
+    "space_name": {
+      "title": "Space Name",
+      "type": "string",
+      "default": "aftersales"
+    },
+    "query_subpath": {
+      "title": "Subpath",
+      "type": "string"
+    },
+    "filter_schema_names": {
+      "title": "Filter Schema Names",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "filter_shortnames": {
+      "title": "Filter Shortnames",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "filter_types": {
+      "title": "Filter Resource Type",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "user",
+          "group",
+          "folder",
+          "schema",
+          "content",
+          "acl",
+          "comment",
+          "media",
+          "locator",
+          "relationship",
+          "alteration",
+          "history",
+          "space",
+          "permission",
+          "role",
+          "ticket",
+          "plugin_wrapper"
+        ]
+      }
+    },
+    "filter_tags": {
+      "title": "Filter Tags",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "exclude_fields": {
+      "title": "Exclude Fields",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "include_fields": {
+      "title": "Include Fields",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "search": {
+      "title": "Redis Search String",
+      "type": "string"
+    },
+    "highlight_fields": {
+      "title": "Highlight Fields",
+      "type": "object",
+      "properties": {}
+    },
+    "offset": {
+      "title": "Offset",
+      "type": "integer"
+    },
+    "limit": {
+      "title": "Limit",
+      "type": "integer"
+    },
+    "retrieve_json_payload": {
+      "type": "boolean"
+    },
+    "retrieve_attachments": {
+      "type": "boolean",
+      "title": "Retrieve Attachments"
+    },
+    "sort_by": {
+      "title": "Sort By",
+      "type": "string"
+    },
+    "sort_type": {
+      "title": "Sort Type",
+      "type": "string",
+      "enum": [
+        "ascending",
+        "descending"
+      ]
+    }
+  }
+}

dmart/sample/spaces/applications/schema/translation.json

@@ -0,0 +1,26 @@
+{
+  "type": "object",
+  "title": "title",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "en": {
+            "type": "string"
+          },
+          "ar": {
+            "type": "string"
+          },
+          "ku": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

dmart/sample/spaces/applications/schema.json

@@ -0,0 +1 @@
+{"shortname_title": "schema", "index_attributes": [{"key": "shortname", "name": "name"}], "allow_create": true, "allow_update": true, "allow_delete": true, "use_media": true, "content_resource_types": ["schema"]}

dmart/sample/spaces/applications/translations/.dm/meta.folder.json

@@ -0,0 +1 @@
+{"uuid": "120ebe81-d5c4-49c5-8051-02049229a6e2", "shortname": "translations", "is_active": true, "tags": [], "created_at": "2023-02-27T15:11:30.204623", "updated_at": "2023-03-18T14:21:11.514700", "owner_shortname": "dmart", "payload": {"content_type": "json", "schema_shortname": "folder_rendering", "body": "translations.json"}}

dmart/sample/spaces/applications/translations.json

@@ -0,0 +1 @@
+{"shortname_title": "translations", "index_attributes": [{"key": "shortname", "name": "name"}], "allow_create": true, "allow_update": true, "allow_delete": true, "use_media": true, "content_schema_shortnames": ["translation", "error"], "content_resource_types": ["content"], "filter": [], "expand_children": true, "allow_view": true}

dmart/sample/spaces/archive/.dm/meta.space.json

@@ -0,0 +1,27 @@
+{
+    "uuid": "4a001e1f-a844-4bb9-a340-7f8eb1a77480",
+    "shortname": "archive",
+    "is_active": true,
+    "displayname": {
+        "en": "archive"
+    },
+    "tags": [],
+    "created_at": "2024-09-02T12:55:00.899747",
+    "updated_at": "2024-09-02T12:55:00.906988",
+    "owner_shortname": "dmart",
+    "root_registration_signature": "",
+    "primary_website": "",
+    "indexing_enabled": false,
+    "capture_misses": false,
+    "check_health": false,
+    "languages": [
+        "english"
+    ],
+    "icon": "",
+    "mirrors": [],
+    "hide_folders": [],
+    "hide_space": true,
+    "active_plugins": [
+    ],
+    "ordinal": 1
+}

dmart/sample/spaces/custom_plugins/dummy/config.json

@@ -0,0 +1,28 @@
+{
+  "shortname": "dummy",
+	"is_active": true,
+	"filters": {
+		"subpaths": [
+			"__ALL__"
+		],
+		"resource_types": [
+			"__ALL__"
+		],
+		"schema_shortnames": [
+			"__ALL__"
+		],
+		"actions": [
+			"query",
+			"view",
+			"update",
+			"create",
+			"delete",
+			"move",
+			"progress_ticket",
+			"lock",
+			"unlock"
+		]
+	},
+	"type": "hook",
+	"listen_time": "after"
+}

dmart/sample/spaces/custom_plugins/dummy/plugin.py

@@ -0,0 +1,6 @@
+from models.core import PluginBase, Event
+
+
+class Plugin(PluginBase):
+    async def hook(self, data: Event):
+        print(f"Reached to the dummy custom plugin, data recieved: {data}")

dmart/sample/spaces/custom_plugins/missed_entry/config.json

@@ -0,0 +1,12 @@
+{
+  "shortname": "missed",
+	"is_active": false,
+	"filters": {
+		"subpaths": ["__ALL__"],
+		"resource_types": ["__ALL__"],
+		"schema_shortnames": ["__ALL__"],
+		"actions": ["view", "query"]
+	},
+	"type": "hook",
+	"listen_time": "before"
+}

dmart/sample/spaces/custom_plugins/missed_entry/plugin.py

@@ -0,0 +1,119 @@
+import json
+import sys
+import aiofiles
+from models.core import ActionType, PluginBase, Event, Space
+from utils.helpers import camel_case
+from utils.redis_services import RedisServices
+from utils.spaces import get_spaces
+from data_adapters.adapter import data_adapter as db
+from models import core
+from models.enums import ContentType, ResourceType
+from utils.settings import settings
+from fastapi.logger import logger
+
+class Plugin(PluginBase):
+
+    def __init__(self) -> None:
+        pass
+
+
+    async def hook(self, data: Event):
+
+        # Type narrowing for PyRight
+        if not isinstance(data.shortname, str) and not isinstance(data.attributes, dict):
+            logger.error(f"invalid data at missed_entry")
+            return
+
+        spaces = await get_spaces()
+        if not Space.parse_raw(spaces[data.space_name]).capture_misses:
+            return
+
+        if data.action_type == ActionType.query and "filter_shortnames" in data.attributes:
+            for shortname in data.attributes["filter_shortnames"]:
+                data.shortname = shortname
+                data.resource_type = data.resource_type or ResourceType.content
+                await self.check_miss(data)
+
+        else:
+            await self.check_miss(data)
+
+        
+
+    async def check_miss(self, data: Event):
+        # Type narrowing for PyRight
+        if not isinstance(data.shortname, str):
+            logger.error(f"data.shortname is None and str is required at missed_entry")
+            return
+
+        class_type = getattr(
+            sys.modules["models.core"], camel_case(core.ResourceType(data.resource_type))
+        )
+        path, filename = db.metapath(data.space_name, data.subpath, data.shortname, class_type)
+        if (path/filename).is_file():
+            return
+
+        if data.subpath[0] == "/":
+            data.subpath = data.subpath.replace("/", "", 1)
+
+        miss_shortname = f"{data.subpath}_{data.shortname}"
+        if len(miss_shortname) > 32:
+            miss_shortname = miss_shortname[:32]
+
+        miss_file = (
+            settings.spaces_folder / 
+            data.space_name / 
+            f"misses/{miss_shortname}.json"
+        )
+        miss_content = None
+        if miss_file.is_file():
+            async with aiofiles.open(miss_file, "r") as file:
+                miss_content = json.loads(await file.read())
+
+        missed_obj_meta = core.Content(
+            shortname=miss_shortname,
+            owner_shortname=data.user_shortname,
+            is_active=True,
+            payload=core.Payload(
+                content_type=ContentType.json,
+                schema_shortname="miss",
+                body=miss_shortname + ".json",
+            ),
+        )
+        async with RedisServices() as redis_services:
+            meta_doc_id, meta_json = redis_services.prepate_meta_doc(
+                data.space_name, "misses", missed_obj_meta
+            )
+            if not miss_content:
+                await db.save(data.space_name, "misses", missed_obj_meta)
+                await redis_services.save_doc(meta_doc_id, meta_json)
+                num_of_requests = 1
+
+            else:
+                num_of_requests = miss_content["num_of_requests"] + 1
+
+            await db.save_payload_from_json(
+                data.space_name,
+                "misses",
+                missed_obj_meta,
+                {
+                    "requested_subpath": data.subpath,
+                    "requested_shortname": data.shortname,
+                    "num_of_requests": num_of_requests,
+                    "actioned": "No",
+                },
+            )
+            payload_dict = {
+                **meta_json,
+                "requested_subpath": data.subpath,
+                "requested_shortname": data.shortname,
+                "num_of_requests": num_of_requests,
+                "actioned": "No"
+                
+            }
+            await redis_services.save_payload_doc(
+                space_name=data.space_name,
+                subpath="misses",
+                meta=missed_obj_meta,
+                payload=payload_dict,
+                resource_type=ResourceType.content
+            )

dmart/sample/spaces/custom_plugins/own_changed_notification/config.json

@@ -0,0 +1,12 @@
+{
+  "shortname": "own_changed_notification",
+	"is_active": true,
+	"filters": {
+		"subpaths": ["__ALL__"],
+		"resource_types": ["__ALL__"],
+		"schema_shortnames": ["__ALL__"],
+		"actions": ["update", "delete"]
+	},
+	"type": "hook",
+	"listen_time": "after"
+}

dmart/sample/spaces/custom_plugins/own_changed_notification/plugin.py

@@ -0,0 +1,65 @@
+import sys
+from models.core import Content, Payload, PluginBase, Event
+from models.enums import ContentType, ResourceType
+from utils.helpers import camel_case
+from data_adapters.adapter import data_adapter as db
+from uuid import uuid4
+from fastapi.logger import logger
+
+
+class Plugin(PluginBase):
+
+    async def hook(self, data: Event):
+       
+        # Type narrowing for PyRight
+        if not isinstance(data.shortname, str):
+            logger.error(f"data.shortname is None and str is required at system_notification_sender")
+            return
+
+        class_type = getattr(
+            sys.modules["models.core"], camel_case(ResourceType(data.resource_type))
+        )
+
+        entry = await db.load(
+            space_name=data.space_name,
+            subpath=data.subpath,
+            shortname=data.shortname,
+            class_type=class_type,
+            user_shortname=data.user_shortname
+        )
+
+        if not entry.owner_shortname or entry.owner_shortname == data.user_shortname:
+            return
+
+        
+        uuid = uuid4()
+        meta_obj = Content(
+            uuid=uuid,
+            shortname=str(uuid)[:8],
+            owner_shortname=data.user_shortname,
+            payload=Payload(
+                content_type=ContentType.json,
+                schema_shortname="notification",
+                body=f"{str(uuid)[:8]}.json"
+            )
+        )
+        await db.save(
+            "personal",
+            f"people/{entry.owner_shortname}/notifications",
+            meta_obj,
+        )
+
+        notification_obj = {
+            "entry_space": data.space_name,
+            "entry_subpath": data.subpath,
+            "entry_shortname": data.shortname,
+            "action_by": data.user_shortname,
+            "action_type": data.action_type,
+            "is_read": "no"
+        }
+        await db.save_payload_from_json(
+            "personal",
+            f"people/{entry.owner_shortname}/notifications",
+            meta_obj,
+            notification_obj,  # type: ignore
+        )

dmart/sample/spaces/custom_plugins/reports_stats/config.json

@@ -0,0 +1,14 @@
+{
+  "shortname": "reports_stats",
+  "is_active": false,
+  "filters": {
+    "subpaths": [
+      "reports"
+    ],
+    "resource_types": ["__ALL__"],
+    "schema_shortnames": ["__ALL__"],
+    "actions": ["query"]
+  },
+  "listen_time": "before",
+  "type": "hook"
+}

dmart/sample/spaces/custom_plugins/reports_stats/plugin.py

@@ -0,0 +1,82 @@
+from os import scandir
+from re import sub
+from models.core import PluginBase, Event
+from utils.access_control import access_control
+from data_adapters.adapter import data_adapter as db
+from models.core import Content
+from models.api import Query
+from utils.repository import get_last_updated_entry, serve_query, internal_sys_update_model
+from utils.settings import settings
+
+
+
+class Plugin(PluginBase):
+    async def hook(self, data: Event):
+        if data.subpath[0] == "/":
+            data.subpath = data.subpath[1:]
+        reports_path = (
+            settings.spaces_folder
+            / data.space_name
+            / data.subpath
+        )
+
+        reports_iterator = scandir(reports_path)
+        for report_entry in reports_iterator:
+            if not report_entry.is_file():
+                continue
+
+            shortname, _ = report_entry.name.split(".")
+            subpath, class_type = "reports", Content
+
+            try:
+                report_meta = await db.load(
+                    space_name=data.space_name,
+                    subpath=subpath,
+                    shortname=shortname,  # type: ignore
+                    class_type=class_type,
+                    user_shortname=data.user_shortname,
+                )
+
+                report_payload = await db.load_resource_payload(
+                    space_name=data.space_name,
+                    subpath=subpath,
+                    filename=report_meta.payload.body,  # type: ignore
+                    class_type=class_type,
+                )
+            except Exception:
+                continue
+            
+            report_payload["query"]["search"] = sub(
+                r"\$\w*", "", report_payload["query"]["search"]
+            )
+            
+            report_query = Query(**report_payload["query"])
+            report_query.limit = 0
+            redis_query_policies = await access_control.get_user_query_policies(
+                data.user_shortname, report_query.space_name, report_query.subpath
+            )
+            total, records = await serve_query(
+                report_query, data.user_shortname, redis_query_policies
+            )
+            report_last_updated_entry = await get_last_updated_entry(
+                data.space_name,
+                report_payload["query"]["filter_schema_names"],
+                False,
+                data.user_shortname,
+            )
+
+            report_updates: dict = {
+                "number_of_records": total
+            }
+            if report_last_updated_entry:
+                report_updates["last_updated"] = str(
+                    report_last_updated_entry.attributes["updated_at"]
+                )
+
+            await internal_sys_update_model(
+                data.space_name,
+                "reports",
+                report_meta,
+                report_updates
+            )
+

dmart/sample/spaces/custom_plugins/system_notification_sender/config.json

@@ -0,0 +1,22 @@
+{
+  "shortname": "system_notification_sender",
+  "is_active": false,
+  "filters": {
+    "subpaths": ["__ALL__"],
+    "resource_types": ["__ALL__"],
+    "schema_shortnames": ["__ALL__"],
+    "actions": [
+      "progress_ticket",
+      "view",
+      "create",
+      "update",
+      "delete",
+      "attach",
+      "move"
+    ]
+  },
+  "type": "hook",
+  "listen_time": "after",
+  "created_at": "2022-08-11T11:27:28.866048",
+  "updated_at": "2022-08-11T11:27:28.866052"
+}