PyInventory 0.19.0__py3-none-any.whl

inventory/models/memo.py

@@ -0,0 +1,109 @@
+import logging
+from pathlib import Path
+
+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 BaseMemoAttachmentModel, BaseModel
+from inventory.models.links import BaseLink
+
+
+logger = logging.getLogger(__name__)
+
+
+class MemoModel(BaseModel, VersionProtectBaseModel):
+    """
+    A Memo to hold some information independ of items/location
+    """
+
+    memo = RichTextUploadingField(
+        blank=True,
+        null=True,
+        config_name='MemoModel.description',
+        verbose_name=_('MemoModel.description.verbose_name'),
+        help_text=_('MemoModel.description.help_text'),
+    )
+
+    def local_admin_link(self):
+        url = reverse('admin:inventory_memomodel_change', args=[self.id])
+        return url
+
+    class Meta:
+        verbose_name = _('MemoModel.verbose_name')
+        verbose_name_plural = _('MemoModel.verbose_name_plural')
+
+
+class MemoLinkModel(BaseLink):
+    memo = models.ForeignKey(MemoModel, 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.memo.user_id
+        return super().full_clean(**kwargs)
+
+    class Meta:
+        verbose_name = _('MemoLinkModel.verbose_name')
+        verbose_name_plural = _('MemoLinkModel.verbose_name_plural')
+        ordering = ('position',)
+
+
+class MemoImageModel(BaseMemoAttachmentModel):
+    """
+    Store images to Memos
+    """
+
+    image = models.ImageField(
+        upload_to=user_directory_path,
+        verbose_name=_('MemoImageModel.image.verbose_name'),
+        help_text=_('MemoImageModel.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 = _('MemoImageModel.verbose_name')
+        verbose_name_plural = _('MemoImageModel.verbose_name_plural')
+        ordering = ('position',)
+
+
+class MemoFileModel(BaseMemoAttachmentModel):
+    """
+    Store files to Memos
+    """
+
+    file = models.FileField(
+        upload_to=user_directory_path,
+        verbose_name=_('MemoFileModel.file.verbose_name'),
+        help_text=_('MemoFileModel.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 = _('MemoFileModel.verbose_name')
+        verbose_name_plural = _('MemoFileModel.verbose_name_plural')
+        ordering = ('position',)

inventory/parent_tree.py

@@ -0,0 +1,71 @@
+class TreeNode:
+    def __init__(self, pk, name, current_path):
+        self.pk = pk
+        self.name = name
+        self.current_path = current_path
+        self.parent_node = None
+        self.path = None
+
+    def _set_parent(self, parent_node):
+        self.parent_node = parent_node
+
+    def _get_path(self):
+        if self.parent_node:
+            parent_path = self.parent_node._get_path()
+            return [*parent_path, self.name]
+        else:
+            return [self.name]
+
+    def _set_tree_info(self):
+        self.path = self._get_path()
+
+    @property
+    def path_string(self):
+        return ' / '.join(self.path)
+
+    def __str__(self):
+        return f'pk:{self.pk} name:"{self.name}" path:"{self.path_string}"'
+
+    def __repr__(self):
+        return f'<TreeNode {self.__str__()}>'
+
+
+class ValuesListTree:
+    def __init__(self, values):
+        nodes = {}
+
+        # init all nodes:
+        for entry in values:
+            pk = entry['pk']
+            name = entry['name']
+            current_path = entry['path']
+            nodes[pk] = TreeNode(pk=pk, name=name, current_path=current_path)
+
+        # Set parents:
+        for entry in values:
+            parent_pk = entry['parent__pk']
+            if parent_pk:
+                pk = entry['pk']
+                node = nodes[pk]
+                parent_node = nodes[parent_pk]
+                node._set_parent(parent_node=parent_node)
+
+        # Set tree info:
+        nodes = list(nodes.values())
+        for node in nodes:
+            node._set_tree_info()
+
+        # Oder by hierarchy:
+        nodes.sort(key=lambda x: x.path)
+
+        self.nodes = nodes
+
+    def get_tree_path(self):
+        return [node.path_string for node in self.nodes]
+
+    def get_update_path_info(self):
+        update_info = {}
+        for node in self.nodes:
+            if node.current_path != node.path:
+                update_info[node.pk] = node.path
+        return update_info

inventory/permissions.py

@@ -0,0 +1,60 @@
+from django.contrib.auth.models import Group, Permission
+from django.contrib.contenttypes.models import ContentType
+
+from inventory.models import (
+    ItemFileModel,
+    ItemImageModel,
+    ItemLinkModel,
+    ItemModel,
+    LocationModel,
+    MemoFileModel,
+    MemoImageModel,
+    MemoLinkModel,
+    MemoModel,
+)
+
+
+NORMAL_USER_GROUP_NAME = 'normal user'
+
+
+def get_permissions(*models):
+    content_types = []
+    for model in models:
+        content_types.append(ContentType.objects.get_for_model(model))
+
+    return Permission.objects.filter(content_type__in=content_types)
+
+
+def get_or_create_normal_user_group():
+    """
+    Will be called by:
+        inventory.signals.post_migrate_callback()
+    """
+    return Group.objects.get_or_create(name=NORMAL_USER_GROUP_NAME)
+
+
+def setup_normal_user_permissions(normal_user_group):
+    """
+    Setup PyInventory "normal user" permissions.
+    Will be called by:
+        inventory.signals.post_migrate_callback()
+    """
+    assert normal_user_group.name == NORMAL_USER_GROUP_NAME
+    permissions = get_permissions(
+        ItemFileModel,
+        ItemImageModel,
+        ItemLinkModel,
+        ItemModel,
+        LocationModel,
+        MemoFileModel,
+        MemoImageModel,
+        MemoLinkModel,
+        MemoModel,
+    )
+    existing_permissions = normal_user_group.permissions.all()
+
+    if set(permissions) != set(existing_permissions):
+        normal_user_group.permissions.set(permissions)
+        return True
+
+    return False

inventory/request_dict.py

@@ -0,0 +1,16 @@
+import threading
+
+
+__request_dict = threading.local()
+
+
+def get_request_dict():
+    try:
+        return __request_dict.context
+    except AttributeError:
+        __request_dict.context = {}
+        return __request_dict.context
+
+
+def clear_request_dict():
+    __request_dict.context = {}

inventory/signals.py

@@ -0,0 +1,15 @@
+from django.db.models.signals import post_migrate
+from django.dispatch import receiver
+
+from inventory.permissions import get_or_create_normal_user_group, setup_normal_user_permissions
+
+
+@receiver(post_migrate)
+def post_migrate_callback(sender, **kwargs):
+    normal_user_group, created = get_or_create_normal_user_group()
+    if created:
+        print(f'User group {normal_user_group} created')
+
+    updated = setup_normal_user_permissions(normal_user_group)
+    if updated:
+        print(f'Update permissions for {normal_user_group}')

inventory/string_utils.py

@@ -0,0 +1,15 @@
+def ltruncatechars(text, max_length, truncate='…'):
+    """
+    >>> ltruncatechars('1234567890', max_length=10)
+    '1234567890'
+    >>> ltruncatechars('1234567890', max_length=5)
+    '…7890'
+    >>> ltruncatechars('1234567890', max_length=6)
+    '…67890'
+    >>> ltruncatechars('1234567890', max_length=6, truncate='...')
+    '...890'
+    """
+    if len(text) > max_length:
+        length = max_length - len(truncate)
+        text = truncate + text[-length:]
+    return text

inventory/templates/admin/item/related_items.html

@@ -0,0 +1,18 @@
+{% load i18n admin_urls %}
+
+<table>
+<thead>
+    <tr>
+        <th>{% trans "No." %}</th>
+        <th>{% trans "ItemModel.verbose_name_plural" %}</th>
+    </tr>
+</thead>
+<tbody>
+    {% for obj in items %}
+    <tr>
+        <td>{{ forloop.counter }}</td>
+        <td><a href="{% url opts|admin_urlname:'change' obj.pk %}">{{ obj }}</a></td>
+    </tr>
+    {% endfor %}
+</tbody>
+</table>

inventory/templates/admin/location/items.html

@@ -0,0 +1,18 @@
+{% load i18n admin_urls %}
+
+<table>
+<thead>
+    <tr>
+        <th>{% trans "No." %}</th>
+        <th>{% trans "ItemModel.verbose_name_plural" %}</th>
+    </tr>
+</thead>
+<tbody>
+    {% for obj in items %}
+    <tr>
+        <td>{{ forloop.counter }}</td>
+        <td><a href="{% url opts|admin_urlname:'change' obj.pk %}">{{ obj }}</a></td>
+    </tr>
+    {% endfor %}
+</tbody>
+</table>

inventory/tests/fixtures/users.py

@@ -0,0 +1,11 @@
+from django.contrib.auth.models import User
+from model_bakery import baker
+
+from inventory.permissions import get_or_create_normal_user_group
+
+
+def get_normal_pyinventory_user(**baker_kwargs):
+    pyinventory_user_group = get_or_create_normal_user_group()[0]
+    pyinventory_user = baker.make(User, is_staff=True, is_active=True, is_superuser=False, **baker_kwargs)
+    pyinventory_user.groups.set([pyinventory_user_group])
+    return pyinventory_user

inventory/tests/test_admin_location.py

@@ -0,0 +1,34 @@
+from unittest import mock
+
+from bx_django_utils.test_utils.html_assertion import HtmlAssertionMixin, assert_html_response_snapshot
+from django.template.defaulttags import CsrfTokenNode, NowNode
+from django.test import TestCase, override_settings
+
+from inventory_project.tests.fixtures import get_normal_user
+from inventory_project.tests.mocks import MockInventoryVersionString
+
+
+@override_settings(SECURE_SSL_REDIRECT=False)
+class AdminTestCase(HtmlAssertionMixin, TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.normaluser = get_normal_user()
+
+    def test_empty_change_list(self):
+        self.client.force_login(self.normaluser)
+        with mock.patch.object(NowNode, 'render', return_value='MockedNowNode'), mock.patch.object(
+            CsrfTokenNode, 'render', return_value='MockedCsrfTokenNode'
+        ), MockInventoryVersionString():
+            response = self.client.get(
+                path='/admin/inventory/locationmodel/',
+            )
+            assert response.status_code == 200
+        self.assert_html_parts(
+            response,
+            parts=(
+                '<title>Select Location to change | PyInventory vMockedVersionString</title>',
+                '<a href="/admin/inventory/locationmodel/add/" class="addlink">Add Location</a>',
+                '<p class="paginator">0 Locations</p>',
+            ),
+        )
+        assert_html_response_snapshot(response=response, validate=False)

inventory/tests/test_admin_location_empty_change_list_1.snapshot.html

@@ -0,0 +1,84 @@
+<div class="" id="content">
+ <h1>
+  Select Location to change
+ </h1>
+ <div id="content-main">
+  <ul class="object-tools">
+   <li>
+    <a class="import_link" href="/admin/inventory/locationmodel/import/">
+     Import
+    </a>
+   </li>
+   <li>
+    <a class="export_link" href="/admin/inventory/locationmodel/export/?">
+     Export
+    </a>
+   </li>
+   <li>
+    <a class="recoverlink" href="/admin/inventory/locationmodel/recover/">
+     Recover deleted Locations
+    </a>
+   </li>
+   <li>
+    <a class="addlink" href="/admin/inventory/locationmodel/add/">
+     Add Location
+    </a>
+   </li>
+  </ul>
+  <div class="module filtered" id="changelist">
+   <div class="changelist-form-container">
+    <div id="toolbar">
+     <form id="changelist-search" method="get">
+      <div>
+       <!-- DIV needed for valid HTML -->
+       <label for="searchbar">
+        <img alt="Search" src="/static/admin/img/search.svg"/>
+       </label>
+       <input id="searchbar" name="q" size="40" type="text" value=""/>
+       <input type="submit" value="Search"/>
+      </div>
+     </form>
+    </div>
+    <form id="changelist-form" method="post" novalidate="">
+     MockedCsrfTokenNode
+     <p class="paginator">
+      0 Locations
+     </p>
+    </form>
+   </div>
+   <div id="changelist-filter">
+    <h2>
+     Filter
+    </h2>
+    <details data-filter-title="Limit tree depth" open="">
+     <summary>
+      By Limit tree depth
+     </summary>
+     <ul>
+      <li class="selected">
+       <a href="?">
+        All
+       </a>
+      </li>
+      <li>
+       <a href="?level=1">
+        Only root
+       </a>
+      </li>
+      <li>
+       <a href="?level=2">
+        Root + first sub
+       </a>
+      </li>
+      <li>
+       <a href="?level=3">
+        Root + first + second sub
+       </a>
+      </li>
+     </ul>
+    </details>
+   </div>
+  </div>
+ </div>
+ <br class="clear"/>
+</div>

inventory/tests/test_item_images.py

@@ -0,0 +1,76 @@
+import tempfile
+from unittest import mock
+
+from django.http import FileResponse
+from django.test import TestCase, override_settings
+from django_tools.serve_media_app.models import UserMediaTokenModel
+from model_bakery import baker
+
+from inventory.models import ItemImageModel
+from inventory.tests.fixtures.users import get_normal_pyinventory_user
+
+
+@override_settings(SECURE_SSL_REDIRECT=True)
+class ItemImagesTestCase(TestCase):
+    def test_basics(self):
+        with mock.patch('secrets.token_urlsafe', return_value='user1token'):
+            pyinventory_user1 = get_normal_pyinventory_user(id=1)
+
+        with mock.patch('secrets.token_urlsafe', return_value='user2token'):
+            pyinventory_user2 = get_normal_pyinventory_user(id=2)
+
+        token1_instance = UserMediaTokenModel.objects.get(user=pyinventory_user1)
+        assert repr(token1_instance) == (f"<UserMediaTokenModel: user:1 token:'user1token' ({token1_instance.pk})>")
+        token2_instance = UserMediaTokenModel.objects.get(user=pyinventory_user2)
+        assert repr(token2_instance) == (f"<UserMediaTokenModel: user:2 token:'user2token' ({token2_instance.pk})>")
+
+        with tempfile.TemporaryDirectory() as temp:
+            with override_settings(MEDIA_ROOT=temp):
+                with mock.patch('secrets.token_urlsafe', return_value='12345678901234567890'):
+                    image_instance = baker.make(ItemImageModel, user=pyinventory_user1, _create_files=True)
+
+                assert image_instance.image is not None
+                url = image_instance.image.url
+                assert url == '/media/user1token/12345678901234567890/mock_img.jpeg'
+
+                # HTTP -> HTTPS redirect:
+                response = self.client.get('/media/user1token/12345678901234567890/mock_img.jpeg', secure=False)
+                self.assertRedirects(
+                    response,
+                    status_code=301,
+                    expected_url='https://testserver/media/user1token/12345678901234567890/mock_img.jpeg',
+                    fetch_redirect_response=False,
+                )
+
+                # Anonymous has no access:
+                response = self.client.get(
+                    '/media/user1token/12345678901234567890/mock_img.jpeg',
+                    secure=True,
+                )
+                assert response.status_code == 403
+
+                # Can't access with wrong user:
+                self.client.force_login(pyinventory_user2)
+                response = self.client.get(
+                    '/media/user1token/12345678901234567890/mock_img.jpeg',
+                    secure=True,
+                )
+                assert response.status_code == 403
+
+                # Can access with the right user:
+                self.client.force_login(pyinventory_user1)
+                response = self.client.get(
+                    '/media/user1token/12345678901234567890/mock_img.jpeg',
+                    secure=True,
+                )
+                assert response.status_code == 200
+                assert isinstance(response, FileResponse)
+                assert response.getvalue() == image_instance.image.open('rb').read()
+
+                # Test whats happen, if token was deleted
+                UserMediaTokenModel.objects.all().delete()
+                response = self.client.get(
+                    '/media/user1token/12345678901234567890/mock_img.jpeg',
+                    secure=True,
+                )
+                assert response.status_code == 400  # SuspiciousOperation -> HttpResponseBadRequest

inventory/tests/test_link_model.py

@@ -0,0 +1,72 @@
+import datetime
+import logging
+from unittest.mock import patch
+
+import requests_mock
+from bx_django_utils.test_utils.datetime import MockDatetimeGenerator
+from bx_py_utils.test_utils.datetime import parse_dt
+from django.test import TestCase
+from django.utils import timezone
+from model_bakery import baker
+
+from inventory.models import ItemLinkModel, ItemModel
+
+
+class ItemLinkModelTestCase(TestCase):
+    def test_set_name_by_request(self):
+        with self.assertLogs('django_tools'):
+            item = baker.make(ItemModel)
+
+            link = ItemLinkModel(item=item, url='http://test.tld/foo/bar')
+
+            offset = datetime.timedelta(seconds=30)
+            with patch.object(timezone, 'now', MockDatetimeGenerator(offset)):
+                with requests_mock.Mocker() as m:
+                    m.get('http://test.tld/foo/bar', text='No title')
+
+                    assert link.last_check is None
+                    with self.assertLogs('inventory.models.links', level=logging.WARNING) as logs:
+                        link.full_clean()
+                        assert link.page_title is None
+                        assert link.name is None
+                        assert link.last_check == parse_dt('2000-01-01T00:00:30+0000')
+
+                    logs = logs.output
+                    assert logs == ["WARNING:inventory.models.links:No title found in 'http://test.tld/foo/bar'"]
+
+                    # We should not create request on every admin save call
+
+                    with self.assertLogs('inventory.models.links', level=logging.DEBUG) as logs:
+                        link.full_clean()
+                        assert link.page_title is None
+                        assert link.name is None
+
+                    logs = logs.output
+                    assert logs == [
+                        'DEBUG:inventory.models.links:Last check is 0:00:30 ago.',
+                        "INFO:inventory.models.links:Skip request for: 'http://test.tld/foo/bar'",
+                    ]
+
+                    # Next try after 1 Min
+
+                    m.get('http://test.tld/foo/bar', text='<title>A <boom>Title</boom>!</title>')
+                    with self.assertLogs('inventory.models.links', level=logging.INFO) as logs:
+                        link.full_clean()
+                        assert link.page_title == 'A Title!'
+                        assert link.name == 'A Title!'
+
+                    logs = logs.output
+                    assert logs == ["INFO:inventory.models.links:Found title: 'A <boom>Title</boom>!'"]
+
+                # Don't make requests, if we have a link name!
+
+                with requests_mock.Mocker():
+                    with self.assertLogs('inventory.models.links', level=logging.DEBUG) as logs:
+                        link.full_clean()
+                        assert link.page_title == 'A Title!'
+                        assert link.name == 'A Title!'
+
+                    logs = logs.output
+                    assert logs == [
+                        ("DEBUG:inventory.models.links:Skip link request:" " because we have a name: 'A Title!'")
+                    ]

inventory/tests/test_management_command_seed_data.py

@@ -0,0 +1,49 @@
+import inspect
+import io
+
+from django.contrib.auth.models import User
+from django.core import management
+from django.test import TestCase
+
+from inventory.management.commands import seed_data
+from inventory.models import ItemModel, LocationModel
+
+
+class ManagementCommandTestCase(TestCase):
+    def test_seed_data_command(self):
+        output = io.StringIO()
+
+        management.call_command(seed_data.Command(), user_count=2, location_count=2, item_count=2, stdout=output)
+        assert User.objects.count() == 2
+        assert LocationModel.objects.count() == 8
+        assert ItemModel.objects.count() == 16
+
+        output = output.getvalue()
+        reference = inspect.cleandoc(
+            '''
+            Fill database with example data
+            ____________________________________________________________________________________________________
+            Create seed data for user seed-data-user-1
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 001
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 001 › Item 001
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 001 › Item 001 › Part 001
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 001 › Item 001 › Part 002
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 002
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 002 › Item 002
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 002 › Item 002 › Part 003
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 002 › Item 002 › Part 004
+            ____________________________________________________________________________________________________
+            Create seed data for user seed-data-user-2
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 003
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 003 › Item 003
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 003 › Item 003 › Part 005
+            Room 1 › Cupboard 1 › Drawer 1 | Equipment 003 › Item 003 › Part 006
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 004
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 004 › Item 004
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 004 › Item 004 › Part 007
+            Room 1 › Cupboard 1 › Drawer 2 | Equipment 004 › Item 004 › Part 008
+
+            Seed data created.
+            '''
+        )
+        assert output.strip() == reference.strip()