django-fast-treenode 2.1.4__py3-none-any.whl → 3.0.0__py3-none-any.whl

treenode/models/models.py

@@ -0,0 +1,365 @@
+# -*- coding: utf-8 -*-
+"""
+The TreeNode Model
+
+This module defines an abstract base model `TreeNodeModel` that
+implements hierarchical data storage using the Adjacency Table method.
+It integrates with a Closure Table for optimized tree operations.
+
+Features:
+- Implements a basic tree representation as an Adjacency List with parent-child
+  relationships.
+- Combines the Adjacency List method with a Materialized Path for efficient
+  ancestor and descendant queries.
+- Provides a caching mechanism to optimize performance.
+- Includes methods for tree traversal, manipulation, and serialization.
+
+Version: 3.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+
+Причём с абсолютной поддержкой SQL-очередей, deferred execution,
+кастомной сортировки и крутой архитектурой без лишнего дублирования.
+"""
+
+from __future__ import annotations
+
+from collections import deque
+from django.db import models, connection
+from itertools import islice
+from django.db.models.signals import pre_save, post_save
+from django.utils.translation import gettext_lazy as _
+
+from . import mixins as mx
+from .factory import TreeNodeModelBase
+from ..utils.db import ModelSQLService, SQLQueue
+from ..managers import TreeNodeManager, TreeQueryManager, TreeTaskManager
+from ..cache import treenode_cache as cache
+from ..settings import SEGMENT_LENGTH, BASE
+from ..signals import disable_signals
+
+
+class TreeNodeModel(
+        mx.TreeNodeAncestorsMixin, mx.TreeNodeChildrenMixin,
+        mx.TreeNodeFamilyMixin, mx.TreeNodeDescendantsMixin,
+        mx.TreeNodeLogicalMixin, mx.TreeNodeNodeMixin,
+        mx.TreeNodePropertiesMixin, mx.TreeNodeRootsMixin,
+        mx.TreeNodeSiblingsMixin, mx.TreeNodeTreeMixin, mx.RawSQLMixin,
+        models.Model, metaclass=TreeNodeModelBase):
+    """
+    Abstract tree node model.
+
+    Implements hierarchical storage using the adjacency table method.
+    For performance improvements, it has additional Materialized Path
+    attributes.
+    """
+
+    parent = models.ForeignKey(
+        'self',
+        null=True,
+        blank=True,
+        on_delete=models.CASCADE,
+        related_name='children',
+        verbose_name=_('parent')
+    )
+
+    # Node order among siblings
+    priority = models.PositiveIntegerField(
+        default=0, verbose_name=_('priority')
+    )
+
+    # Node materialized path
+    _path = models.TextField(default='', editable=False)
+    # Maybe in the future, sometime...
+    # _path_order = models.PositiveBigIntegerField(default=0, editable=False)
+    # Node nesting depth
+    _depth = models.PositiveIntegerField(default=0, editable=False)
+
+    # Field for display in the Admin Class
+    display_field = None
+
+    class SortingChoices(models.TextChoices):
+        """Sorting Direction Class."""
+
+        ASC = "ASC", _("Ascending order")
+        DESC = "DESC", _("Descending order")
+
+    # Sorting field
+    sorting_field = 'priority'
+    # Sorting direction
+    sorting_direction = SortingChoices.ASC
+    # Model API protection flag via mandatory authorization via login
+    api_login_required = False
+
+    # Defaul manager
+    objects = TreeNodeManager()
+    # Task manager
+    tasks = TreeTaskManager()
+    # Query manager
+    query = TreeQueryManager()
+
+    # SQL Queue
+    sqlq = SQLQueue()
+
+    # DB Service
+    db = ModelSQLService()
+
+    class Meta:
+        """Tree Meta Class."""
+
+        indexes = [
+            # models.Index(fields=["_path_order"]),
+            models.Index(fields=["parent", "priority"]),
+            models.Index(fields=["_depth", "priority"]),
+        ]
+        abstract = True
+
+# -----------------------------------------------------------------
+#
+# General Methods
+#
+# -----------------------------------------------------------------
+
+    def __str__(self):
+        """Return a human-readable string representation of an object."""
+        field = getattr(type(self), 'display_field', None)
+        if field and hasattr(self, field):
+            return str(getattr(self, field))
+        return f'Node {self.pk}'
+
+    def clear_cache(self):
+        """Clear cache for this node only."""
+        cache.invalidate(self._meta.label)
+
+    # Generation methods ------------------------------------------
+
+    def generate_path(self) -> str:
+        """Build _path based on priorities of ancestors."""
+        segment = f"{self.priority:0{SEGMENT_LENGTH}X}"
+        return segment if self.parent is None else f"{self.parent._path}.{segment}"  # noqa: D501
+
+    # Modification methods ----------------------------------------
+
+    def delete(self, cascade=True):
+        """Delete a node and clears the cache.
+
+        If cascade=False, then:
+        - If the node is not a root, its children are "lifted" to the parent,
+        - If the node is a root (parent is None), its children become
+          the new roots.
+        """
+        if not cascade:
+            self.db.reassign_children(self.id, self.parent_id)
+
+        # Delete the node itself
+        super().delete()
+        # Update subtree
+        self._update_path(self.parent_id)
+        self.sqlq.flush()
+        # Clead cache
+        self.clear_cache()
+
+    # Saving and Udating methods ----------------------------------
+
+    def save(self, *args, **kwargs):
+        """
+        Save or update the node.
+
+        Method save() acts as a fast controller. All heavy-lifting is delegated
+        to SQL queue. Queries are deterministic and ordered. Foelds of priority,
+        _path, _depth are updated in one pass. Performance is close to maximum.
+        """
+        model = self._meta.model
+
+        # Send signal pre_save
+        pre_save.send(
+            sender=model,
+            instance=self,
+            raw=False,
+            using=self._state.db,
+            update_fields=kwargs.get("update_fields", None)
+        )
+
+        # Routing
+        is_new = False
+        is_shift = False
+        is_move = False
+
+        if self.pk:
+            state = self.get_db_state()
+            if state:
+                is_shift = self.priority != state["priority"]
+                is_move = self.parent_id != state["parent_id"]
+                if is_move:
+                    self._meta.model.tasks.add("update", state["parent_id"])
+            else:
+                print("TreeNodeModel error: oject not found in DB! WTF, MF!")
+        else:
+            is_new = True
+
+        # New node ----------------------------------
+        if is_new:
+            # Step 1. Set pk
+            self.pk = self.db.get_next_id()
+
+            # Step 2. Set priority
+            if self.priority is None:
+                self.priority = BASE - 1
+
+            # Step 3. Set initial values
+            self._path = self.generate_path()
+            self._depth = self._path.count('.')
+
+        """
+        # Move node ---------------------------------
+        elif is_move:
+            # Reserved
+            pass
+
+        # Shift node --------------------------------
+        elif is_shift:
+            # Reserved
+            pass
+
+        else:
+            # Reserved
+            pass
+        """
+
+        if is_new or is_move or is_shift:
+            # Step 1: Shift siblings
+            if (is_new or is_move) and (self.priority is not None):
+                self._shift_siblings_forward()
+            # Step 2: Update paths for the new parent -> sqlq
+            self._meta.model.tasks.add("update", self.parent_id)
+            # Step 3: Clear model cache
+            self.clear_cache()
+
+        # Disable signals
+        with (disable_signals(pre_save, model),
+              disable_signals(post_save, model)):
+            super().save(*args, **kwargs)
+
+            if is_new or is_move or is_shift:
+                # Run sql
+                # self.sqlq.flush()
+                setattr(model, 'is_dry', True)
+
+        # Send signal post_save
+        post_save.send(sender=model, instance=self, created=is_new)
+
+        # Debug
+        # self.check_tree_integrity()
+
+    # Auxiliary methods -------------------------------------------
+
+    def get_db_state(self):
+        """Read paren and priority from DB."""
+        with connection.cursor() as cursor:
+            cursor.execute(
+                f"SELECT priority, parent_id FROM {self._meta.db_table} WHERE id = %s",  # noqa: D501
+                [self.pk]
+            )
+            row = cursor.fetchone()
+            if row:
+                return {"priority": row[0], "parent_id": row[1]}
+            return None
+
+    # Maybe in the future, sometime...
+    # def encode_path_order(self) -> int:
+    #     """Encode path."""
+    #     segments = self._path.split(".")
+    #     value = 0
+    #     for i, segment in enumerate(reversed(segments)):
+    #         value += int(segment, 16) * (BASE ** i)
+    #     return value
+
+    # def decode_path_order(self) -> str:
+    #     """Decode path."""
+    #     segments = []
+    #     path_order = self._path_order
+    #     while path_order:
+    #         path_order, rem = divmod(path_order, BASE)
+    #         segments.insert(0, f"{rem:0{SEGMENT_LENGTH}X}")
+    #     return ".".join(segments) if segments else "0" * SEGMENT_LENGTH
+
+    @staticmethod
+    def chunked(iterable, size):
+        """Split an iterable into chunks of a given size."""
+        it = iter(iterable)
+        return iter(lambda: list(islice(it, size)), [])
+
+    def check_tree_integrity(self, verbose: bool = True) -> list[str]:
+        """
+        Check tree consistency (_path, _depth and priority).
+
+        Returns a list of errors (if any).
+        :param verbose: If True - prints errors to console.
+        How to use:
+        root.check_tree_integrity()
+        """
+        model = self._meta.model
+        errors = []
+        queue = deque([self])
+
+        while queue:
+            node = queue.popleft()
+            node.refresh_from_db()
+
+            # Проверка _depth
+            expected_depth = node._path.count(".")
+            if node._depth != expected_depth:
+                errors.append(
+                    f"[DEPTH] id={node.pk} _depth={node._depth} ≠ path depth={expected_depth} / parent={node.parent_id}"  # noqa: D501
+                )
+
+            # Проверка generate_path
+            expected_path = ".".join(
+                f"{n.priority:0{SEGMENT_LENGTH}X}"
+                for n in node.get_ancestors(include_self=True)
+            )
+            if node._path != expected_path:
+                errors.append(
+                    f"[PATH] id={node.pk} _path={node._path} ≠ expected={expected_path} / parent={node.parent_id}"  # noqa: D501
+                )
+
+            # Проверка уникальности priority среди сиблингов
+            siblings = model.objects.filter(
+                parent=node.parent).only("pk", "priority")
+            priorities = [s.priority for s in siblings]
+            if len(priorities) != len(set(priorities)):
+                errors.append(
+                    f"[PRIORITY] Duplicate priorities in siblings of id={node.pk} parent={node.parent_id}"  # noqa: D501
+                )
+
+            queue.extend(model.objects.filter(parent=node))
+
+        if verbose and errors:
+            print("Tree integrity check failed:")
+            for err in errors:
+                print("  -", err)
+        elif verbose:
+            print("Tree integrity: OK ✅")
+
+        return errors
+
+# ------------------------------------------------------------------
+#
+# Prived properties
+#
+# -----------------------------------------------------------------
+
+    @property
+    def _parent_id(self):
+        """Lazy initialization of _parent_id."""
+        if not hasattr(self, "_self_parent_id"):
+            setattr(self, "_self_parent_id", self.parent_id)
+        return self._self_parent_id
+
+    @_parent_id.setter
+    def _parent_id(self, value):
+        """Setter for _parent_id."""
+        setattr(self, "_self_parent_id", value)
+
+
+# The End

treenode/settings.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+"""
+TreeNodeModel and TreeCache settings.
+
+Version: 3.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+"""
+
+from django.conf import settings
+
+
+CACHE_LIMIT = getattr(settings, "TREENODE_CACHE_LIMIT", 100) * 1024 * 1024
+
+# The length on Materialized Path segment
+SEGMENT_LENGTH = getattr(settings, "TREENODE_SEGMENT_LENGTH", 3)
+
+# Serialization dictionary: hexadecimal encoding, fixed segment size
+SEGMENT_BASE = 16
+
+# Nubber children per one tree node
+BASE = SEGMENT_BASE ** SEGMENT_LENGTH  # 4096
+
+
+TREENODE_PAD_CHAR = getattr(settings, "TREENODE_PAD_CHAR", "'0'")
+
+
+# The End

treenode/static/{treenode/css → css}/tree_widget.css

@@ -34,7 +34,7 @@ Email: timurkady@yandex.com
 
 */
 
-.form-row.field-tn_parent {
+.form-row.field-parent {
     position: relative;
     overflow: visible !important;
     z-index: auto;

treenode/static/{treenode/css → css}/treenode_admin.css

@@ -10,8 +10,9 @@ Features:
 - Supports both light and dark themes.
 - Smooth hover effects and animations.
 - Consistent layout adjustments for better UI interaction.
+- Visual feedback drag-n-drop operations.
 
-Version: 2.1.0
+Version: 3.0.0
 Author: Timur Kady
 Email: timurkady@yandex.com
 
@@ -97,7 +98,7 @@ Email: timurkady@yandex.com
     line-height: 10px;
     padding: 1px;
     cursor: ns-resize;
-    opacity: 0.25;
+    opacity: 0.75;
 }
 
 .treenode-drag-handle:hover {
@@ -111,3 +112,43 @@ Email: timurkady@yandex.com
 .treenode-wrapper {
     display: inline-block;
 }
+
+tr.treenode-placeholder td {
+  background-color: #eef;
+  border-top: 1px solid var(--hairline-color);
+  border-bottom: 1px solid var(--hairline-color);
+  border-left: 0px;
+  margin: 0;
+  padding: 0;
+  height: 30px;
+}
+
+tr.target-as-child{
+  border-left: 4px solid #4caf50;
+  transition: border-left 0.2s ease;
+}
+
+tr.target-as-child td {
+  background-color: #d9fbe3 !important;
+  transition: background 0.2s ease;
+}
+
+tr.flash-insert td {
+  animation: flash-green 0.6s ease-in-out;
+}
+
+@keyframes flash-green {
+  0%   { background-color: #dbffe0; }
+  100% { background-color: transparent; }
+}
+
+tr.dragging td {
+  opacity: 0.6;
+  background-color: #f8f8f8;
+}
+
+.column-treenode_field {
+  width: 100%;
+}
+
+

treenode/static/css/treenode_tabs.css

@@ -0,0 +1,51 @@
+.tabs { 
+  list-style: none; 
+  padding: 0 !important;
+  margin:0 !important;
+  display: flex; 
+  gap: 0em;
+  border-bottom: 1px solid var(--border-color);
+}
+
+.tab { 
+  padding: 0.5em 1em; 
+  cursor: pointer; 
+  color: var(--object-tools-fg);
+  background: var(--object-tools-bg);
+  border-radius: 4px;
+}
+
+.tab.active {
+  background: var(--primary);
+  font-weight: bold;
+ }
+
+.tab-content {
+  border: 1px solid var(--border-color);
+  padding: 1em; 
+  border-radius: 4px; 
+  margin-top: 1em;
+}
+
+.tabs li.tab {
+  list-style-type: none;
+  margin: 0;
+  border-radius: 5px 5px 0 0;
+}
+
+.tab-content a.button {
+  display: inline-block;
+  text-align: center;
+  padding: 10px 10px !important;
+  width: 110px;
+  
+}
+
+.tab-content form > .form-row {
+  height: 60px;
+}
+
+.tab-content .button.default {
+  display: inline-block;
+  width: 130px;
+}

treenode/static/js/lz-string.min.js

@@ -0,0 +1 @@
+var LZString=function(){function o(o,r){if(!t[o]){t[o]={};for(var n=0;n<o.length;n++)t[o][o.charAt(n)]=n}return t[o][r]}var r=String.fromCharCode,n="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",e="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-$",t={},i={compressToBase64:function(o){if(null==o)return"";var r=i._compress(o,6,function(o){return n.charAt(o)});switch(r.length%4){default:case 0:return r;case 1:return r+"===";case 2:return r+"==";case 3:return r+"="}},decompressFromBase64:function(r){return null==r?"":""==r?null:i._decompress(r.length,32,function(e){return o(n,r.charAt(e))})},compressToUTF16:function(o){return null==o?"":i._compress(o,15,function(o){return r(o+32)})+" "},decompressFromUTF16:function(o){return null==o?"":""==o?null:i._decompress(o.length,16384,function(r){return o.charCodeAt(r)-32})},compressToUint8Array:function(o){for(var r=i.compress(o),n=new Uint8Array(2*r.length),e=0,t=r.length;t>e;e++){var s=r.charCodeAt(e);n[2*e]=s>>>8,n[2*e+1]=s%256}return n},decompressFromUint8Array:function(o){if(null===o||void 0===o)return i.decompress(o);for(var n=new Array(o.length/2),e=0,t=n.length;t>e;e++)n[e]=256*o[2*e]+o[2*e+1];var s=[];return n.forEach(function(o){s.push(r(o))}),i.decompress(s.join(""))},compressToEncodedURIComponent:function(o){return null==o?"":i._compress(o,6,function(o){return e.charAt(o)})},decompressFromEncodedURIComponent:function(r){return null==r?"":""==r?null:(r=r.replace(/ /g,"+"),i._decompress(r.length,32,function(n){return o(e,r.charAt(n))}))},compress:function(o){return i._compress(o,16,function(o){return r(o)})},_compress:function(o,r,n){if(null==o)return"";var e,t,i,s={},p={},u="",c="",a="",l=2,f=3,h=2,d=[],m=0,v=0;for(i=0;i<o.length;i+=1)if(u=o.charAt(i),Object.prototype.hasOwnProperty.call(s,u)||(s[u]=f++,p[u]=!0),c=a+u,Object.prototype.hasOwnProperty.call(s,c))a=c;else{if(Object.prototype.hasOwnProperty.call(p,a)){if(a.charCodeAt(0)<256){for(e=0;h>e;e++)m<<=1,v==r-1?(v=0,d.push(n(m)),m=0):v++;for(t=a.charCodeAt(0),e=0;8>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1}else{for(t=1,e=0;h>e;e++)m=m<<1|t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t=0;for(t=a.charCodeAt(0),e=0;16>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1}l--,0==l&&(l=Math.pow(2,h),h++),delete p[a]}else for(t=s[a],e=0;h>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1;l--,0==l&&(l=Math.pow(2,h),h++),s[c]=f++,a=String(u)}if(""!==a){if(Object.prototype.hasOwnProperty.call(p,a)){if(a.charCodeAt(0)<256){for(e=0;h>e;e++)m<<=1,v==r-1?(v=0,d.push(n(m)),m=0):v++;for(t=a.charCodeAt(0),e=0;8>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1}else{for(t=1,e=0;h>e;e++)m=m<<1|t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t=0;for(t=a.charCodeAt(0),e=0;16>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1}l--,0==l&&(l=Math.pow(2,h),h++),delete p[a]}else for(t=s[a],e=0;h>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1;l--,0==l&&(l=Math.pow(2,h),h++)}for(t=2,e=0;h>e;e++)m=m<<1|1&t,v==r-1?(v=0,d.push(n(m)),m=0):v++,t>>=1;for(;;){if(m<<=1,v==r-1){d.push(n(m));break}v++}return d.join("")},decompress:function(o){return null==o?"":""==o?null:i._decompress(o.length,32768,function(r){return o.charCodeAt(r)})},_decompress:function(o,n,e){var t,i,s,p,u,c,a,l,f=[],h=4,d=4,m=3,v="",w=[],A={val:e(0),position:n,index:1};for(i=0;3>i;i+=1)f[i]=i;for(p=0,c=Math.pow(2,2),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;switch(t=p){case 0:for(p=0,c=Math.pow(2,8),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;l=r(p);break;case 1:for(p=0,c=Math.pow(2,16),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;l=r(p);break;case 2:return""}for(f[3]=l,s=l,w.push(l);;){if(A.index>o)return"";for(p=0,c=Math.pow(2,m),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;switch(l=p){case 0:for(p=0,c=Math.pow(2,8),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;f[d++]=r(p),l=d-1,h--;break;case 1:for(p=0,c=Math.pow(2,16),a=1;a!=c;)u=A.val&A.position,A.position>>=1,0==A.position&&(A.position=n,A.val=e(A.index++)),p|=(u>0?1:0)*a,a<<=1;f[d++]=r(p),l=d-1,h--;break;case 2:return w.join("")}if(0==h&&(h=Math.pow(2,m),m++),f[l])v=f[l];else{if(l!==d)return null;v=s+s.charAt(0)}w.push(v),f[d++]=s+v.charAt(0),h--,s=v,0==h&&(h=Math.pow(2,m),m++)}}};return i}();"function"==typeof define&&define.amd?define(function(){return LZString}):"undefined"!=typeof module&&null!=module&&(module.exports=LZString);

treenode/static/{treenode/js → js}/tree_widget.js

@@ -36,19 +36,9 @@ Email: timurkady@yandex.com
         // Get URL for AJAX and model data from data attributes
         var ajaxUrl = $select.data('url');
         var ajaxUrlChildren = $select.data('url-children');
-        var forwardData = $select.attr("data-forward");
-        if (typeof forwardData === "string" && forwardData.trim().length > 0) {
-            try {
-                forwardData = JSON.parse(forwardData.replace(/"/g, '"'));
-            } catch (e) {
-                console.error("Invalid JSON in data-forward:", forwardData, e);
-                forwardData = {};
-            }
-        } else {
-            forwardData = {};
-        }
+        var model = $select.attr("data-model");
         
-        var selectedId = $select.data('selected');  // Получаем значение data-selected
+        var selectedId = $select.val();
         if (selectedId === undefined) {
             selectedId = "";
         }
@@ -60,9 +50,8 @@ Email: timurkady@yandex.com
             $display: $display,
             ajaxUrl: ajaxUrl,
             urlChildren: ajaxUrlChildren,
-            model: forwardData.model || '',
+            model: model,
             selectedId: selectedId,
-            mode: selectedId ? 'selected' : 'default'
         };
         
         $widget.data('widgetData', widgetData);
@@ -77,17 +66,14 @@ Email: timurkady@yandex.com
 
     // Method of loading data via AJAX
     loadData: function (widgetData, searchQuery) {
-      var params = {model: widgetData.model};
+      var params = {
+        model: widgetData.model,
+        select_id: widgetData.selectedId
+      };
       if (searchQuery) {
         params.q = searchQuery;
-        widgetData.mode = 'search';
-      } else if (widgetData.selectedId) {
-        params.select_id = widgetData.selectedId;
-        widgetData.mode = 'selected';
-      } else {
-        widgetData.mode = 'default';
-      }
-
+      } 
+      
       $.ajax({
         url: widgetData.ajaxUrl,
         data: params,