Reshuffling the Evennia package into the new template paradigm.

lib/help/manager.py

@@ -0,0 +1,99 @@
+"""
+Custom manager for HelpEntry objects.
+"""
+from django.db import models
+from src.utils import logger, utils
+__all__ = ("HelpEntryManager",)
+
+
+class HelpEntryManager(models.Manager):
+    """
+    This HelpEntryManager implements methods for searching
+    and manipulating HelpEntries directly from the database.
+
+    These methods will all return database objects
+    (or QuerySets) directly.
+
+    Evennia-specific:
+    find_topicmatch
+    find_apropos
+    find_topicsuggestions
+    find_topics_with_category
+    all_to_category
+    search_help (equivalent to ev.search_helpentry)
+
+    """
+    def find_topicmatch(self, topicstr, exact=False):
+        """
+        Searches for matching topics based on player's input.
+        """
+        dbref = utils.dbref(topicstr)
+        if dbref:
+            return self.filter(id=dbref)
+        topics = self.filter(db_key__iexact=topicstr)
+        if not topics and not exact:
+            topics = self.filter(db_key__istartswith=topicstr)
+            if not topics:
+                topics = self.filter(db_key__icontains=topicstr)
+        return topics
+
+    def find_apropos(self, topicstr):
+        """
+        Do a very loose search, returning all help entries containing
+        the search criterion in their titles.
+        """
+        return self.filter(db_key__icontains=topicstr)
+
+    def find_topicsuggestions(self, topicstr):
+        """
+        Do a fuzzy match, preferably within the category of the
+        current topic.
+        """
+        return self.filter(db_key__icontains=topicstr).exclude(db_key__iexact=topicstr)
+
+    def find_topics_with_category(self, help_category):
+        """
+        Search topics having a particular category
+        """
+        return self.filter(db_help_category__iexact=help_category)
+
+    def get_all_topics(self):
+        """
+        Return all topics.
+        """
+        return self.all()
+
+    def get_all_categories(self, pobject):
+        """
+        Return all defined category names with at least one
+        topic in them.
+        """
+        return list(set(topic.help_category for topic in self.all()))
+
+    def all_to_category(self, default_category):
+        """
+        Shifts all help entries in database to default_category.
+        This action cannot be reverted. It is used primarily by
+        the engine when importing a default help database, making
+        sure this ends up in one easily separated category.
+        """
+        topics = self.all()
+        for topic in topics:
+            topic.help_category = default_category
+            topic.save()
+        string = "Help database moved to category %s" % default_category
+        logger.log_infomsg(string)
+
+    def search_help(self, ostring, help_category=None):
+        """
+        Retrieve a search entry object.
+
+        ostring - the help topic to look for
+        category - limit the search to a particular help topic
+        """
+        ostring = ostring.strip().lower()
+        if help_category:
+            return self.filter(db_key__iexact=ostring,
+                               db_help_category__iexact=help_category)
+        else:
+            return self.filter(db_key__iexact=ostring)