Renames all URL methods to web_*, moves to TypedObject model.

evennia/typeclasses/models.py

@@ -31,9 +31,12 @@ from django.db.models import signals
 
 from django.db.models.base import ModelBase
 from django.db import models
+from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist
 from django.conf import settings
+from django.urls import reverse
 from django.utils.encoding import smart_str
+from django.utils.text import slugify
 
 from evennia.typeclasses.attributes import Attribute, AttributeHandler, NAttributeHandler
 from evennia.typeclasses.tags import Tag, TagHandler, AliasHandler, PermissionHandler
@@ -733,3 +736,145 @@ class TypedObject(SharedMemoryModel):
 
         """
         pass
+
+    #
+    # Web/Django methods
+    #
+    
+    def web_admin_url(self):
+        """
+        Returns the URI path for the Django Admin page for this object.
+        
+        ex. Account#1 = '/admin/accounts/accountdb/1/change/'
+        
+        Returns:
+            path (str): URI path to Django Admin page for object.
+            
+        """
+        content_type = ContentType.objects.get_for_model(self.__class__)
+        return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,))
+        
+    @classmethod
+    def web_create_url(cls):
+        """
+        Returns the URI path for a View that allows users to create new
+        instances of this object.
+        
+        ex. Chargen = '/characters/create/'
+        
+        For this to work, the developer must have defined a named view somewhere
+        in urls.py that follows the format 'modelname-action', so in this case
+        a named view of 'character-create' would be referenced by this method.
+        
+        ex.
+        url(r'characters/create/', ChargenView.as_view(), name='character-create')
+        
+        If no View has been created and defined in urls.py, returns an
+        HTML anchor.
+        
+        This method is naive and simply returns a path. Securing access to
+        the actual view and limiting who can create new objects is the 
+        developer's responsibility.
+        
+        Returns:
+            path (str): URI path to object creation page, if defined.
+            
+        """
+        try: return reverse('%s-create' % cls._meta.verbose_name.lower())
+        except: return '#'
+        
+    def web_detail_url(self):
+        """
+        Returns the URI path for a View that allows users to view details for 
+        this object.
+        
+        ex. Oscar (Character) = '/characters/oscar/1/'
+        
+        For this to work, the developer must have defined a named view somewhere
+        in urls.py that follows the format 'modelname-action', so in this case
+        a named view of 'character-detail' would be referenced by this method.
+        
+        ex.
+        url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/$', CharDetailView.as_view(), name='character-detail')
+        
+        If no View has been created and defined in urls.py, returns an
+        HTML anchor.
+        
+        This method is naive and simply returns a path. Securing access to
+        the actual view and limiting who can view this object is the developer's 
+        responsibility.
+        
+        Returns:
+            path (str): URI path to object detail page, if defined.
+            
+        """
+        try: return reverse('%s-detail' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)})
+        except: return '#'
+        
+    def web_update_url(self):
+        """
+        Returns the URI path for a View that allows users to update this
+        object.
+        
+        ex. Oscar (Character) = '/characters/oscar/1/change/'
+        
+        For this to work, the developer must have defined a named view somewhere
+        in urls.py that follows the format 'modelname-action', so in this case
+        a named view of 'character-update' would be referenced by this method.
+        
+        ex.
+        url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/change/$', CharUpdateView.as_view(), name='character-update')
+        
+        If no View has been created and defined in urls.py, returns an
+        HTML anchor.
+        
+        This method is naive and simply returns a path. Securing access to
+        the actual view and limiting who can modify objects is the developer's 
+        responsibility.
+        
+        Returns:
+            path (str): URI path to object update page, if defined.
+            
+        """
+        try: return reverse('%s-update' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)})
+        except: return '#'
+        
+    def web_delete_url(self):
+        """
+        Returns the URI path for a View that allows users to delete this object.
+        
+        ex. Oscar (Character) = '/characters/oscar/1/delete/'
+        
+        For this to work, the developer must have defined a named view somewhere
+        in urls.py that follows the format 'modelname-action', so in this case
+        a named view of 'character-detail' would be referenced by this method.
+
+        ex.
+        url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/delete/$', CharDeleteView.as_view(), name='character-delete')
+        
+        If no View has been created and defined in urls.py, returns an
+        HTML anchor.
+        
+        This method is naive and simply returns a path. Securing access to
+        the actual view and limiting who can delete this object is the developer's 
+        responsibility.
+        
+        Returns:
+            path (str): URI path to object deletion page, if defined.
+            
+        """
+        try: return reverse('%s-delete' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)})
+        except: return '#'
+        
+    def get_absolute_url(self):
+        """
+        Django construct; used by Django Sites framework and within the Admin
+        panel for reverse linking to the object detail page. 
+        
+        https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url
+        
+        Returns:
+            path (str): URI path to object detail page, if defined.
+            
+        """
+        return self.web_detail_url()