PyInventory 0.19.0__py3-none-any.whl

inventory/migrations/0013_alter_itemmodel_location.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.15 on 2022-09-30 18:30
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('inventory', '0012_parent_tree2'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='itemmodel',
+            name='location',
+            field=models.ForeignKey(
+                blank=True,
+                help_text='ItemModel.location.help_text',
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name='items',
+                to='inventory.locationmodel',
+                verbose_name='ItemModel.location.verbose_name',
+            ),
+        ),
+    ]

inventory/models/__init__.py

@@ -0,0 +1,3 @@
+from inventory.models.item import ItemFileModel, ItemImageModel, ItemLinkModel, ItemModel  # noqa
+from inventory.models.location import LocationModel  # noqa
+from inventory.models.memo import MemoFileModel, MemoImageModel, MemoLinkModel, MemoModel  # noqa

inventory/models/base.py

@@ -0,0 +1,239 @@
+import logging
+import re
+import time
+import unicodedata
+import uuid
+
+import tagulous.models
+from bx_django_utils.models.timetracking import TimetrackingBaseModel
+from django.conf import settings
+from django.db import models
+from django.db.models import QuerySet
+from django.utils.translation import gettext_lazy as _
+
+from inventory.parent_tree import ValuesListTree
+from inventory.string_utils import ltruncatechars
+
+
+logger = logging.getLogger(__name__)
+
+
+class BaseModel(TimetrackingBaseModel):
+    id = models.UUIDField(
+        primary_key=True,
+        default=uuid.uuid4,
+        editable=False,
+        verbose_name=_('BaseModel.id.verbose_name'),
+        help_text=_('BaseModel.id.help_text'),
+    )
+    user = models.ForeignKey(  # "Owner" of this entry
+        settings.AUTH_USER_MODEL,
+        related_name='+',
+        on_delete=models.CASCADE,
+        editable=False,  # Must be set automatically and never changed
+        verbose_name=_('BaseModel.user.verbose_name'),
+        help_text=_('BaseModel.user.help_text'),
+    )
+    name = models.CharField(
+        max_length=255, verbose_name=_('BaseModel.name.verbose_name'), help_text=_('BaseModel.name.help_text')
+    )
+    tags = tagulous.models.TagField(
+        blank=True,
+        case_sensitive=False,
+        force_lowercase=False,
+        space_delimiter=False,
+        max_count=10,
+        verbose_name=_('BaseModel.tags.verbose_name'),
+        help_text=_('BaseModel.tags.help_text'),
+    )
+
+    def __str__(self):
+        return self.name
+
+    class Meta:
+        abstract = True
+
+
+def nomalize_text(text):
+    """
+    >>> nomalize_text('Foo Bar 1 §$% äö-üß +')
+    'foobar1aou'
+    """
+    text = unicodedata.normalize('NFKD', text).encode('ascii', 'ignore').decode('ascii')
+    text = text.lower()
+    text = re.sub(r'[^\w]', '', text)
+    return text
+
+
+def generate_path_str(path):
+    """
+    >>> generate_path_str(['Foo', 'B a  r', '1 §$% äö-üß +'])
+    'foo 0 bar 0 1aou'
+    """
+    # The choice of the separator is very important for the correct sorting by the database!
+    # Use 0, because this character is used for sorting and is the first character in the charset.
+    # The spaces are only visual separators ;)
+    return ' 0 '.join(nomalize_text(part) for part in path)
+
+
+class ParentTreeModelManager(models.Manager):
+    def update_tree_info(self) -> None:
+        start_time = time.monotonic()
+
+        values = self.all().values('pk', 'name', 'parent__pk', 'path')
+        tree = ValuesListTree(values=values)
+        tree_path = tree.get_tree_path()
+        logger.debug('Tree path: %r', tree_path)
+        update_path_info = tree.get_update_path_info()
+
+        duration = (time.monotonic() - start_time) * 1000
+        logger.info('Get update_path_info: %r in %ims', update_path_info, duration)
+
+        if not update_path_info:
+            logger.info('No tree path changed, ok')
+        else:
+            start_time = time.monotonic()
+
+            entries = self.filter(pk__in=update_path_info.keys())
+            for entry in entries:
+                path = update_path_info[entry.pk]
+                entry.path = path
+                entry.path_str = generate_path_str(path)
+                entry.level = len(path)
+
+            self.bulk_update(entries, ['path', 'path_str', 'level'])
+
+            duration = (time.monotonic() - start_time) * 1000
+            logger.info('Update %i entries in %ims', len(entries), duration)
+
+    def related_objects(self, instance: 'BaseParentTreeModel') -> QuerySet:
+        """
+        Returns a QuerySet with relation section of the tree
+        """
+        path = instance.path
+        if path is None:
+            # Not saved -> Can't have related objects ;)
+            return self.none()
+
+        root_entry = path[0]
+        qs = self.all()
+        qs = qs.filter(path__0=root_entry)
+        return qs
+
+
+class BaseParentTreeModel(BaseModel):
+    path = models.JSONField(
+        blank=True,
+        null=True,
+        editable=False,
+    )
+    path_str = models.TextField(
+        blank=True,
+        null=True,
+        editable=False,
+    )
+    level = models.PositiveSmallIntegerField(
+        blank=True,
+        null=True,
+        editable=False,
+    )
+    parent = models.ForeignKey(
+        'self',
+        on_delete=models.SET_NULL,
+        blank=True,
+        null=True,
+        verbose_name=_('LocationModel.parent.verbose_name'),
+        help_text=_('LocationModel.parent.help_text'),
+    )
+
+    objects = models.Manager()
+    tree_objects = ParentTreeModelManager()
+
+    def save(self, **kwargs):
+        if not self.path:
+            if self.parent:
+                path = self.parent.path
+                if path:
+                    self.path = [*path, self.name]
+            else:
+                self.path = [self.name]
+            self.path_str = generate_path_str(self.path)
+            self.level = len(self.path)
+            logger.info('Init path with: %r', self.path)
+
+        self.full_clean()
+        super().save(**kwargs)
+        self.__class__.tree_objects.update_tree_info()
+
+    def __str__(self):
+        if self.path:
+            text = ' › '.join(self.path)
+            text = ltruncatechars(text, max_length=settings.TREE_PATH_STR_MAX_LENGTH)
+            return text
+
+        return self.name
+
+    class Meta:
+        abstract = True
+
+
+class BaseAttachmentModel(BaseModel):
+    """
+    Base model to store files or images to Items
+    """
+
+    name = models.CharField(
+        null=True,
+        blank=True,
+        max_length=255,
+        verbose_name=_('BaseItemAttachmentModel.name.verbose_name'),
+        help_text=_('BaseItemAttachmentModel.name.help_text'),
+    )
+    position = models.PositiveSmallIntegerField(
+        # Note: Will be set in admin via adminsortable2
+        # The JavaScript which performs the sorting is 1-indexed !
+        default=0,
+        blank=False,
+        null=False,
+    )
+
+    def __str__(self):
+        return self.name
+
+    def full_clean(self, *, parent_instance, **kwargs):
+        if self.user_id is None:
+            # inherit owner of this link from parent model instance
+            self.user_id = parent_instance.user_id
+
+        return super().full_clean(**kwargs)
+
+    class Meta:
+        abstract = True
+
+
+class BaseItemAttachmentModel(BaseAttachmentModel):
+    """
+    Base model to store files or images to Items
+    """
+
+    item = models.ForeignKey('ItemModel', on_delete=models.CASCADE)
+
+    def full_clean(self, **kwargs):
+        return super().full_clean(parent_instance=self.item, **kwargs)
+
+    class Meta:
+        abstract = True
+
+
+class BaseMemoAttachmentModel(BaseAttachmentModel):
+    """
+    Base model to store files or images to Memos
+    """
+
+    memo = models.ForeignKey('MemoModel', on_delete=models.CASCADE)
+
+    def full_clean(self, **kwargs):
+        return super().full_clean(parent_instance=self.memo, **kwargs)
+
+    class Meta:
+        abstract = True

inventory/models/item.py

@@ -0,0 +1,228 @@
+import logging
+from pathlib import Path
+
+import tagulous.models
+from bx_django_utils.filename import clean_filename
+from ckeditor_uploader.fields import RichTextUploadingField
+from django.db import models
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+from django_tools.model_version_protect.models import VersionProtectBaseModel
+from django_tools.serve_media_app.models import user_directory_path
+
+from inventory.models.base import BaseItemAttachmentModel, BaseParentTreeModel
+from inventory.models.links import BaseLink
+
+
+logger = logging.getLogger(__name__)
+
+
+class ItemQuerySet(models.QuerySet):
+    def sort(self):
+        return self.order_by('kind', 'producer', 'name')
+
+
+class ItemModel(BaseParentTreeModel, VersionProtectBaseModel):
+    """
+    A Item that can be described and store somewhere ;)
+    """
+
+    objects = ItemQuerySet.as_manager()
+
+    kind = tagulous.models.TagField(
+        case_sensitive=False,
+        force_lowercase=False,
+        space_delimiter=False,
+        max_count=3,
+        verbose_name=_('ItemModel.kind.verbose_name'),
+        help_text=_('ItemModel.kind.help_text'),
+    )
+    producer = tagulous.models.TagField(
+        blank=True,
+        case_sensitive=False,
+        force_lowercase=False,
+        space_delimiter=False,
+        max_count=1,
+        verbose_name=_('ItemModel.producer.verbose_name'),
+        help_text=_('ItemModel.producer.help_text'),
+    )
+    description = RichTextUploadingField(
+        blank=True,
+        null=True,
+        config_name='ItemModel.description',
+        verbose_name=_('ItemModel.description.verbose_name'),
+        help_text=_('ItemModel.description.help_text'),
+    )
+    fcc_id = models.CharField(
+        max_length=20,
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.fcc_id.verbose_name'),
+        help_text=_('ItemModel.fcc_id.help_text'),
+    )
+    location = models.ForeignKey(
+        'inventory.LocationModel',
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL,
+        related_name='items',
+        verbose_name=_('ItemModel.location.verbose_name'),
+        help_text=_('ItemModel.location.help_text'),
+    )
+
+    # ________________________________________________________________________
+    # lent
+
+    lent_to = models.CharField(
+        max_length=64,
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.lent_to.verbose_name'),
+        help_text=_('ItemModel.lent_to.help_text'),
+    )
+    lent_from_date = models.DateField(
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.lent_from_date.verbose_name'),
+        help_text=_('ItemModel.lent_from_date.help_text'),
+    )
+    lent_until_date = models.DateField(
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.lent_until_date.verbose_name'),
+        help_text=_('ItemModel.lent_until_date.help_text'),
+    )
+
+    # ________________________________________________________________________
+    # received
+
+    received_from = models.CharField(
+        max_length=64,
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.received_from.verbose_name'),
+        help_text=_('ItemModel.received_from.help_text'),
+    )
+    received_date = models.DateField(
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.received_date.verbose_name'),
+        help_text=_('ItemModel.received_date.help_text'),
+    )
+    received_price = models.DecimalField(
+        decimal_places=2,
+        max_digits=6,  # up to 9999 with a resolution of 2 decimal places
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.received_price.verbose_name'),
+        help_text=_('ItemModel.received_price.help_text'),
+    )
+
+    # ________________________________________________________________________
+    # handed over
+
+    handed_over_to = models.CharField(
+        max_length=64,
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.handed_over_to.verbose_name'),
+        help_text=_('ItemModel.handed_over_to.help_text'),
+    )
+    handed_over_date = models.DateField(
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.handed_over_date.verbose_name'),
+        help_text=_('ItemModel.handed_over_date.help_text'),
+    )
+    handed_over_price = models.DecimalField(
+        decimal_places=2,
+        max_digits=6,  # up to 9999 with a resolution of 2 decimal places
+        blank=True,
+        null=True,
+        verbose_name=_('ItemModel.handed_over_price.verbose_name'),
+        help_text=_('ItemModel.handed_over_price.help_text'),
+    )
+
+    def local_admin_link(self):
+        url = reverse('admin:inventory_itemmodel_change', args=[self.id])
+        return url
+
+    def verbose_name(self):
+        parts = [str(part) for part in (self.kind, self.producer, self.name)]
+        return ' - '.join(part for part in parts if part)
+
+    class Meta:
+        ordering = ('path_str',)
+        verbose_name = _('ItemModel.verbose_name')
+        verbose_name_plural = _('ItemModel.verbose_name_plural')
+
+
+class ItemLinkModel(BaseLink):
+    item = models.ForeignKey(ItemModel, on_delete=models.CASCADE)
+
+    def full_clean(self, **kwargs):
+        if self.user_id is None:
+            # inherit owner of this link from item instance
+            self.user_id = self.item.user_id
+        return super().full_clean(**kwargs)
+
+    class Meta:
+        verbose_name = _('ItemLinkModel.verbose_name')
+        verbose_name_plural = _('ItemLinkModel.verbose_name_plural')
+        ordering = ('position',)
+
+
+class ItemImageModel(BaseItemAttachmentModel):
+    """
+    Store images to Items
+    """
+
+    image = models.ImageField(
+        upload_to=user_directory_path,
+        verbose_name=_('ItemImageModel.image.verbose_name'),
+        help_text=_('ItemImageModel.image.help_text'),
+    )
+
+    def __str__(self):
+        return self.name or self.image.name
+
+    def full_clean(self, **kwargs):
+        # Set name by image filename:
+        if not self.name:
+            filename = Path(self.image.name).name
+            self.name = clean_filename(filename)
+
+        return super().full_clean(**kwargs)
+
+    class Meta:
+        verbose_name = _('ItemImageModel.verbose_name')
+        verbose_name_plural = _('ItemImageModel.verbose_name_plural')
+        ordering = ('position',)
+
+
+class ItemFileModel(BaseItemAttachmentModel):
+    """
+    Store files to Items
+    """
+
+    file = models.FileField(
+        upload_to=user_directory_path,
+        verbose_name=_('ItemFileModel.file.verbose_name'),
+        help_text=_('ItemFileModel.file.help_text'),
+    )
+
+    def __str__(self):
+        return self.name or self.file.name
+
+    def full_clean(self, **kwargs):
+        # Set name by filename:
+        if not self.name:
+            filename = Path(self.file.name).name
+            self.name = clean_filename(filename)
+
+        return super().full_clean(**kwargs)
+
+    class Meta:
+        verbose_name = _('ItemFileModel.verbose_name')
+        verbose_name_plural = _('ItemFileModel.verbose_name_plural')
+        ordering = ('position',)

inventory/models/links.py

@@ -0,0 +1,104 @@
+import datetime
+import logging
+import re
+
+import requests
+from django.db import models
+from django.template.defaultfilters import striptags
+from django.utils import timezone
+from django.utils.translation import gettext_lazy as _
+
+from inventory.models.base import BaseModel
+
+
+logger = logging.getLogger(__name__)
+
+
+class BaseLink(BaseModel):
+    name = models.CharField(
+        max_length=255,
+        blank=True,
+        null=True,
+        verbose_name=_('BaseLink.name.verbose_name'),
+        help_text=_('BaseLink.name.help_text'),
+    )
+    url = models.URLField(verbose_name=_('Link.url.verbose_name'), help_text=_('Link.url.help_text'))
+    last_check = models.DateTimeField(
+        blank=True,
+        null=True,
+        editable=False,
+        verbose_name=_('Link.url.verbose_name'),
+        help_text=_('Link.url.help_text'),
+    )
+    status_code = models.PositiveSmallIntegerField(
+        blank=True,
+        null=True,
+        editable=False,
+        verbose_name=_('Link.status_code.verbose_name'),
+        help_text=_('Link.status_code.help_text'),
+    )
+    page_title = models.CharField(
+        max_length=255,
+        blank=True,
+        null=True,
+        editable=False,
+        verbose_name=_('Link.page_title.verbose_name'),
+        help_text=_('Link.page_title.help_text'),
+    )
+
+    position = models.PositiveSmallIntegerField(
+        # Note: Will be set in admin via adminsortable2
+        # The JavaScript which performs the sorting is 1-indexed !
+        default=0,
+        blank=False,
+        null=False,
+    )
+
+    def update_response_info(self):
+        if self.name:
+            logger.debug('Skip link request: because we have a name: %r', self.name)
+            return
+
+        if self.last_check:
+            delta = timezone.now() - self.last_check
+            logger.debug('Last check is %s ago.', delta)
+            if delta < datetime.timedelta(minutes=1):
+                logger.info('Skip request for: %r', self.url)
+                return
+
+        try:
+            r = requests.get(url=self.url, allow_redirects=True, timeout=10)
+        except Exception as err:
+            logger.exception('Error get %s: %s', self.url, err)
+            self.status_code = None
+            self.page_title = None
+            return
+
+        logger.debug('%r: %r', self.url, r.headers)
+
+        self.last_check = timezone.now()
+        self.status_code = r.status_code
+
+        if r.status_code == 200:
+            titles = re.findall(r'<title>(.+?)</title>', r.text)
+            if not titles:
+                logger.warning('No title found in %r', self.url)
+            else:
+                title = titles[0]
+                logger.info('Found title: %r', title)
+
+                self.page_title = striptags(title)  # TODO: remove with a better clean method!
+                if not self.name:
+                    logger.debug('set name to: %r', self.page_title)
+                    self.name = self.page_title
+
+    def full_clean(self, **kwargs):
+        if self.url is not None:
+            self.update_response_info()
+        return super().full_clean(**kwargs)
+
+    def __str__(self):
+        return self.url
+
+    class Meta:
+        abstract = True

inventory/models/location.py

@@ -0,0 +1,24 @@
+from ckeditor_uploader.fields import RichTextUploadingField
+from django.utils.translation import gettext_lazy as _
+from django_tools.model_version_protect.models import VersionProtectBaseModel
+
+from inventory.models.base import BaseParentTreeModel
+
+
+class LocationModel(BaseParentTreeModel, VersionProtectBaseModel):
+    """
+    A Storage for items.
+    """
+
+    description = RichTextUploadingField(
+        blank=True,
+        null=True,
+        config_name='LocationModel.description',
+        verbose_name=_('LocationModel.description.verbose_name'),
+        help_text=_('LocationModel.description.help_text'),
+    )
+
+    class Meta:
+        ordering = ('path_str',)
+        verbose_name = _('LocationModel.verbose_name')
+        verbose_name_plural = _('LocationModel.verbose_name_plural')