]> git.ipfire.org Git - ipfire.org.git/blobdiff - src/backend/wiki.py
wiki: Automatically redirect from /start pages
[ipfire.org.git] / src / backend / wiki.py
index eb889bad803d8c4591e1a5ec8fba57fc1a6d9bd4..4a90069333b20b8a36d25e46643cc3bb433f506c 100644 (file)
@@ -11,12 +11,6 @@ from . import misc
 from . import util
 from .decorators import *
 
-INTERWIKIS = {
-       "google"    : ("https://www.google.com/search?q=%(url)s", None, "fab fa-google"),
-       "rfc"       : ("https://tools.ietf.org/html/rfc%(name)s", "RFC %s", None),
-       "wp"        : ("https://en.wikipedia.org/wiki/%(name)s", None, "fab fa-wikipedia-w"),
-}
-
 class Wiki(misc.Object):
        def _get_pages(self, query, *args):
                res = self.db.query(query, *args)
@@ -30,6 +24,29 @@ class Wiki(misc.Object):
                if res:
                        return Page(self.backend, res.id, data=res)
 
+       def make_path(self, page, path):
+               # Nothing to do for absolute links
+               if path.startswith("/"):
+                       pass
+
+               # Relative links (one-level down)
+               elif path.startswith("./"):
+                       path = os.path.join(page, path)
+
+               # All other relative links
+               else:
+                       p = os.path.dirname(page)
+                       path = os.path.join(p, path)
+
+               # Normalise links
+               return os.path.normpath(path)
+
+       def page_exists(self, path):
+               page = self.get_page(path)
+
+               # Page must have been found and not deleted
+               return page and not page.was_deleted()
+
        def get_page_title(self, page, default=None):
                # Try to retrieve title from cache
                title = self.memcache.get("wiki:title:%s" % page)
@@ -62,7 +79,6 @@ class Wiki(misc.Object):
 
        def get_recent_changes(self, account, limit=None):
                pages = self._get_pages("SELECT * FROM wiki \
-                       WHERE timestamp >= NOW() - INTERVAL '4 weeks' \
                        ORDER BY timestamp DESC")
 
                for page in pages:
@@ -138,6 +154,18 @@ class Wiki(misc.Object):
                """
                self.db.execute("REFRESH MATERIALIZED VIEW wiki_search_index")
 
+       def get_watchlist(self, account):
+               pages = self._get_pages(
+                       "WITH pages AS (SELECT * FROM wiki_current \
+                                       LEFT JOIN wiki ON wiki_current.id = wiki.id) \
+                       SELECT * FROM wiki_watchlist watchlist \
+                               LEFT JOIN pages ON watchlist.page = pages.page \
+                               WHERE watchlist.uid = %s",
+                       account.uid,
+               )
+
+               return sorted(pages)
+
        # ACL
 
        def check_acl(self, page, account):
@@ -195,24 +223,13 @@ class Wiki(misc.Object):
                        mimetype, blob_id, size) VALUES(%s,  %s, %s, %s, %s, %s, %s) RETURNING *", path,
                        filename, author.uid, address, mimetype, blob.id, len(data))
 
-       def find_image(self, path, filename):
-               for p in (path, os.path.dirname(path)):
-                       file = self.get_file_by_path(os.path.join(p, filename))
+       def render(self, path, text):
+               r = WikiRenderer(self.backend, path)
 
-                       if file and file.is_image():
-                               return file
+               return r.render(text)
 
 
 class Page(misc.Object):
-       # External links
-       external_link = re.compile(r"\[\[((?:ftp|git|https?|rsync|sftp|ssh|webcal)\:\/\/.+?)(?:\|(.+?))\]\]")
-
-       # Interwiki links e.g. [[wp>IPFire]]
-       interwiki_link = re.compile(r"\[\[(\w+)>(.+?)(?:\|(.+?))?\]\]")
-
-       # Mail link
-       email_link = re.compile(r"\[\[([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)(?:\|(.+?))?\]\]")
-
        def init(self, id, data=None):
                self.id = id
                self.data = data
@@ -273,7 +290,7 @@ class Page(misc.Object):
                # Find first H1 headline in markdown
                markdown = self.markdown.splitlines()
 
-               m = re.match(r"^# (.*)( #)?$", markdown[0])
+               m = re.match(r"^#\s*(.*)( #)?$", markdown[0])
                if m:
                        return m.group(1)
 
@@ -282,139 +299,13 @@ class Page(misc.Object):
                if self.data.author_uid:
                        return self.backend.accounts.get_by_uid(self.data.author_uid)
 
-       def _render_external_link(self, m):
-               url, alias = m.groups()
-
-               return """<a class="link-external" href="%s">%s</a>""" % (url, alias or url)
-
-       def _render_interwiki_link(self, m):
-               wiki = m.group(1)
-               if not wiki:
-                       return
-
-               # Retrieve URL
-               try:
-                       url, repl, icon = INTERWIKIS[wiki]
-               except KeyError:
-                       logging.warning("Invalid interwiki: %s" % wiki)
-                       return
-
-               # Name of the page
-               name = m.group(2)
-
-               # Expand URL
-               url = url % {
-                       "name" : name,
-                       "url"  : urllib.parse.quote(name),
-               }
-
-               # Get alias (if present)
-               alias = m.group(3)
-
-               if not alias and repl:
-                       alias = repl % name
-
-               # Put everything together
-               s = []
-
-               if icon:
-                       s.append("<span class=\"%s\"></span>" % icon)
-
-               s.append("""<a class="link-external" href="%s">%s</a>""" % (url, alias or name))
-
-               return " ".join(s)
-
-       def _render_email_link(self, m):
-               address, alias = m.groups()
-
-               return """<a class="link-external" href="mailto:%s">%s</a>""" \
-                       % (address, alias or address)
-
-       def _render(self, text):
-               logging.debug("Rendering %s" % self)
-
-               # Link images
-               replacements = []
-               for match in re.finditer(r"!\[(.*?)\]\((.*?)\)", text):
-                       alt_text, url = match.groups()
-
-                       # Skip any absolute and external URLs
-                       if url.startswith("/") or url.startswith("https://") or url.startswith("http://"):
-                               continue
-
-                       # Try to split query string
-                       url, delimiter, qs = url.partition("?")
-
-                       # Parse query arguments
-                       args = urllib.parse.parse_qs(qs)
-
-                       # Find image
-                       file = self.backend.wiki.find_image(self.page, url)
-                       if not file:
-                               continue
-
-                       # Scale down the image if not already done
-                       if not "s" in args:
-                               args["s"] = "768"
-
-                       # Format URL
-                       url = "%s?%s" % (file.url, urllib.parse.urlencode(args))
-
-                       replacements.append((match.span(), file, alt_text, url))
-
-               # Apply all replacements
-               for (start, end), file, alt_text, url in reversed(replacements):
-                       text = text[:start] + "[![%s](%s)](%s?action=detail)" % (alt_text, url, file.url) + text[end:]
-
-               # Handle interwiki links
-               text = self.interwiki_link.sub(self._render_interwiki_link, text)
-
-               # Handle external links
-               text = self.external_link.sub(self._render_external_link, text)
-
-               # Handle email links
-               text = self.email_link.sub(self._render_email_link, text)
-
-               # Add wiki links
-               patterns = (
-                       (r"\[\[([\w\d\/\-\.]+)(?:\|(.+?))\]\]", r"\1", r"\2", None, True),
-                       (r"\[\[([\w\d\/\-\.]+)\]\]", r"\1", r"\1", self.backend.wiki.get_page_title, True),
-               )
-
-               for pattern, link, title, repl, internal in patterns:
-                       replacements = []
-
-                       for match in re.finditer(pattern, text):
-                               l = match.expand(link)
-                               t = match.expand(title)
-
-                               if internal:
-                                       # Allow relative links
-                                       if not l.startswith("/"):
-                                               l = os.path.join(self.page, l)
-
-                                       # Normalise links
-                                       l = os.path.normpath(l)
-
-                               if callable(repl):
-                                       t = repl(l) or t
-
-                               replacements.append((match.span(), t or l, l))
-
-                       # Apply all replacements
-                       for (start, end), t, l in reversed(replacements):
-                               text = text[:start] + "[%s](%s)" % (t, l) + text[end:]
-
-               # Borrow this from the blog
-               return self.backend.blog._render_text(text, lang="markdown")
-
        @property
        def markdown(self):
                return self.data.markdown or ""
 
        @property
        def html(self):
-               return self._render(self.markdown)
+               return self.backend.wiki.render(self.page, self.markdown)
 
        @property
        def timestamp(self):
@@ -523,11 +414,17 @@ class Page(misc.Object):
                                logging.debug("Excluding %s" % watcher)
                                continue
 
+                       # Check permissions
+                       if not self.backend.wiki.check_acl(self.page, watcher):
+                               logging.debug("Watcher %s does not have permissions" % watcher)
+                               continue
+
                        logging.debug("Sending watcher email to %s" % watcher)
 
                        # Compose message
                        self.backend.messages.send_template("wiki/messages/page-changed",
-                               recipients=[watcher], page=self, priority=-10)
+                               sender="IPFire Wiki <wiki@ipfire.org>", recipients=[watcher],
+                               page=self, priority=-10)
 
 
 class File(misc.Object):
@@ -593,3 +490,94 @@ class File(misc.Object):
                self.memcache.set(cache_key, thumbnail)
 
                return thumbnail
+
+
+class WikiRenderer(misc.Object):
+       schemas = (
+               "ftp://",
+               "git://",
+               "http://",
+               "https://",
+               "rsync://",
+               "sftp://",
+               "ssh://",
+               "webcal://",
+       )
+
+       # Links
+       links = re.compile(r"<a href=\"(.*?)\">(.*?)</a>")
+
+       # Images
+       images = re.compile(r"<img alt(?:=\"(.*?)\")? src=\"(.*?)\" (?:title=\"(.*?)\" )?/>")
+
+       def init(self, path):
+               self.path = path
+
+       def _render_link(self, m):
+               url, text = m.groups()
+
+               # Emails
+               if "@" in url:
+                       # Strip mailto:
+                       if url.startswith("mailto:"):
+                               url = url[7:]
+
+                       return """<a class="link-external" href="mailto:%s">%s</a>""" % \
+                               (url, text or url)
+
+               # External Links
+               for schema in self.schemas:
+                       if url.startswith(schema):
+                               return """<a class="link-external" href="%s">%s</a>""" % \
+                                       (url, text or url)
+
+               # Everything else must be an internal link
+               path = self.backend.wiki.make_path(self.path, url)
+
+               return """<a href="%s">%s</a>""" % \
+                       (path, text or self.backend.wiki.get_page_title(path))
+
+       def _render_image(self, m):
+               alt_text, url, caption = m.groups()
+
+               # Skip any absolute and external URLs
+               if url.startswith("/") or url.startswith("https://") or url.startswith("http://"):
+                       return """<figure class="figure"><img src="%s" class="figure-img img-fluid rounded" alt="%s">
+                               <figcaption class="figure-caption">%s</figcaption></figure>
+                       """ % (url, alt_text, caption or "")
+
+               # Try to split query string
+               url, delimiter, qs = url.partition("?")
+
+               # Parse query arguments
+               args = urllib.parse.parse_qs(qs)
+
+               # Build absolute path
+               url = self.backend.wiki.make_path(self.path, url)
+
+               # Find image
+               file = self.backend.wiki.get_file_by_path(url)
+               if not file or not file.is_image():
+                       return "<!-- Could not find image %s in %s -->" % (url, self.path)
+
+               # Scale down the image if not already done
+               if not "s" in args:
+                       args["s"] = "920"
+
+               return """<figure class="figure"><img src="%s?%s" class="figure-img img-fluid rounded" alt="%s">
+               <figcaption class="figure-caption">%s</figcaption></figure>
+               """ % (url, urllib.parse.urlencode(args), caption, caption or "")
+
+       def render(self, text):
+               logging.debug("Rendering %s" % self.path)
+
+               # Borrow this from the blog
+               text = self.backend.blog._render_text(text, lang="markdown")
+
+               # Postprocess links
+               text = self.links.sub(self._render_link, text)
+
+               # Postprocess images to <figure>
+               text = self.images.sub(self._render_image, text)
+
+               return text