src/backend/wiki.py

   1 #!/usr/bin/python3
   2
   3 import difflib
   4 import logging
   5 import os.path
   6 import re
   7 import tornado.gen
   8 import urllib.parse
   9
  10 from . import misc
  11 from . import util
  12 from .decorators import *
  13
  14 INTERWIKIS = {
  15         "google"    : ("https://www.google.com/search?q=%(url)s", None, "fab fa-google"),
  16         "rfc"       : ("https://tools.ietf.org/html/rfc%(name)s", "RFC %s", None),
  17         "wp"        : ("https://en.wikipedia.org/wiki/%(name)s", None, "fab fa-wikipedia-w"),
  18 }
  19
  20 class Wiki(misc.Object):
  21         def _get_pages(self, query, *args):
  22                 res = self.db.query(query, *args)
  23
  24                 for row in res:
  25                         yield Page(self.backend, row.id, data=row)
  26
  27         def _get_page(self, query, *args):
  28                 res = self.db.get(query, *args)
  29
  30                 if res:
  31                         return Page(self.backend, res.id, data=res)
  32
  33         def get_page_title(self, page, default=None):
  34                 # Try to retrieve title from cache
  35                 title = self.memcache.get("wiki:title:%s" % page)
  36                 if title:
  37                         return title
  38
  39                 # If the title has not been in the cache, we will
  40                 # have to look it up
  41                 doc = self.get_page(page)
  42                 if doc:
  43                         title = doc.title
  44                 else:
  45                         title = os.path.basename(page)
  46
  47                 # Save in cache for forever
  48                 self.memcache.set("wiki:title:%s" % page, title)
  49
  50                 return title
  51
  52         def get_page(self, page, revision=None):
  53                 page = Page.sanitise_page_name(page)
  54                 assert page
  55
  56                 if revision:
  57                         return self._get_page("SELECT * FROM wiki WHERE page = %s \
  58                                 AND timestamp = %s", page, revision)
  59                 else:
  60                         return self._get_page("SELECT * FROM wiki WHERE page = %s \
  61                                 ORDER BY timestamp DESC LIMIT 1", page)
  62
  63         def get_recent_changes(self, account, limit=None):
  64                 pages = self._get_pages("SELECT * FROM wiki \
  65                         WHERE timestamp >= NOW() - INTERVAL '4 weeks' \
  66                         ORDER BY timestamp DESC")
  67
  68                 for page in pages:
  69                         if not page.check_acl(account):
  70                                 continue
  71
  72                         yield page
  73
  74                         limit -= 1
  75                         if not limit:
  76                                 break
  77
  78         def create_page(self, page, author, content, changes=None, address=None):
  79                 page = Page.sanitise_page_name(page)
  80
  81                 # Write page to the database
  82                 page = self._get_page("INSERT INTO wiki(page, author_uid, markdown, changes, address) \
  83                         VALUES(%s, %s, %s, %s, %s) RETURNING *", page, author.uid, content or None, changes, address)
  84
  85                 # Update cache
  86                 self.memcache.set("wiki:title:%s" % page.page, page.title)
  87
  88                 # Send email to all watchers
  89                 page._send_watcher_emails(excludes=[author])
  90
  91                 return page
  92
  93         def delete_page(self, page, author, **kwargs):
  94                 # Do nothing if the page does not exist
  95                 if not self.get_page(page):
  96                         return
  97
  98                 # Just creates a blank last version of the page
  99                 self.create_page(page, author=author, content=None, **kwargs)
 100
 101         def make_breadcrumbs(self, url):
 102                 # Split and strip all empty elements (double slashes)
 103                 parts = list(e for e in url.split("/") if e)
 104
 105                 ret = []
 106                 for part in ("/".join(parts[:i]) for i in range(1, len(parts))):
 107                         ret.append(("/%s" % part, self.get_page_title(part, os.path.basename(part))))
 108
 109                 return ret
 110
 111         def search(self, query, account=None, limit=None):
 112                 query = util.parse_search_query(query)
 113
 114                 res = self._get_pages("SELECT wiki.* FROM wiki_search_index search_index \
 115                         LEFT JOIN wiki ON search_index.wiki_id = wiki.id \
 116                         WHERE search_index.document @@ to_tsquery('english', %s) \
 117                                 ORDER BY ts_rank(search_index.document, to_tsquery('english', %s)) DESC",
 118                         query, query)
 119
 120                 pages = []
 121                 for page in res:
 122                         # Skip any pages the user doesn't have permission for
 123                         if not page.check_acl(account):
 124                                 continue
 125
 126                         # Return any other pages
 127                         pages.append(page)
 128
 129                         # Break when we have found enough pages
 130                         if limit and len(pages) >= limit:
 131                                 break
 132
 133                 return pages
 134
 135         def refresh(self):
 136                 """
 137                         Needs to be called after a page has been changed
 138                 """
 139                 self.db.execute("REFRESH MATERIALIZED VIEW wiki_search_index")
 140
 141         # ACL
 142
 143         def check_acl(self, page, account):
 144                 res = self.db.query("SELECT * FROM wiki_acls \
 145                         WHERE %s ILIKE (path || '%%') ORDER BY LENGTH(path) DESC LIMIT 1", page)
 146
 147                 for row in res:
 148                         # Access not permitted when user is not logged in
 149                         if not account:
 150                                 return False
 151
 152                         # If user is in a matching group, we grant permission
 153                         for group in row.groups:
 154                                 if group in account.groups:
 155                                         return True
 156
 157                         # Otherwise access is not permitted
 158                         return False
 159
 160                 # If no ACLs are found, we permit access
 161                 return True
 162
 163         # Files
 164
 165         def _get_files(self, query, *args):
 166                 res = self.db.query(query, *args)
 167
 168                 for row in res:
 169                         yield File(self.backend, row.id, data=row)
 170
 171         def _get_file(self, query, *args):
 172                 res = self.db.get(query, *args)
 173
 174                 if res:
 175                         return File(self.backend, res.id, data=res)
 176
 177         def get_files(self, path):
 178                 files = self._get_files("SELECT * FROM wiki_files \
 179                         WHERE path = %s AND deleted_at IS NULL ORDER BY filename", path)
 180
 181                 return list(files)
 182
 183         def get_file_by_path(self, path):
 184                 path, filename = os.path.dirname(path), os.path.basename(path)
 185
 186                 return self._get_file("SELECT * FROM wiki_files \
 187                         WHERE path = %s AND filename = %s AND deleted_at IS NULL", path, filename)
 188
 189         def upload(self, path, filename, data, mimetype, author, address):
 190                 # Upload the blob first
 191                 blob = self.db.get("INSERT INTO wiki_blobs(data) VALUES(%s) RETURNING id", data)
 192
 193                 # Create entry for file
 194                 return self._get_file("INSERT INTO wiki_files(path, filename, author_uid, address, \
 195                         mimetype, blob_id, size) VALUES(%s,  %s, %s, %s, %s, %s, %s) RETURNING *", path,
 196                         filename, author.uid, address, mimetype, blob.id, len(data))
 197
 198         def find_image(self, path, filename):
 199                 for p in (path, os.path.dirname(path)):
 200                         file = self.get_file_by_path(os.path.join(p, filename))
 201
 202                         if file and file.is_image():
 203                                 return file
 204
 205
 206 class Page(misc.Object):
 207         # External links
 208         external_link = re.compile(r"\[\[((?:ftp|git|https?|rsync|sftp|ssh|webcal)\:\/\/.+?)(?:\|(.+?))\]\]")
 209
 210         # Interwiki links e.g. [[wp>IPFire]]
 211         interwiki_link = re.compile(r"\[\[(\w+)>(.+?)(?:\|(.+?))?\]\]")
 212
 213         def init(self, id, data=None):
 214                 self.id = id
 215                 self.data = data
 216
 217         def __repr__(self):
 218                 return "<%s %s %s>" % (self.__class__.__name__, self.page, self.timestamp)
 219
 220         def __eq__(self, other):
 221                 if isinstance(other, self.__class__):
 222                         return self.id == other.id
 223
 224         def __lt__(self, other):
 225                 if isinstance(other, self.__class__):
 226                         if self.page == other.page:
 227                                 return self.timestamp < other.timestamp
 228
 229                         return self.page < other.page
 230
 231         @staticmethod
 232         def sanitise_page_name(page):
 233                 if not page:
 234                         return "/"
 235
 236                 # Make sure that the page name does NOT end with a /
 237                 if page.endswith("/"):
 238                         page = page[:-1]
 239
 240                 # Make sure the page name starts with a /
 241                 if not page.startswith("/"):
 242                         page = "/%s" % page
 243
 244                 # Remove any double slashes
 245                 page = page.replace("//", "/")
 246
 247                 return page
 248
 249         @property
 250         def url(self):
 251                 return self.page
 252
 253         @property
 254         def full_url(self):
 255                 return "https://wiki.ipfire.org%s" % self.url
 256
 257         @property
 258         def page(self):
 259                 return self.data.page
 260
 261         @property
 262         def title(self):
 263                 return self._title or os.path.basename(self.page[1:])
 264
 265         @property
 266         def _title(self):
 267                 if not self.markdown:
 268                         return
 269
 270                 # Find first H1 headline in markdown
 271                 markdown = self.markdown.splitlines()
 272
 273                 m = re.match(r"^# (.*)( #)?$", markdown[0])
 274                 if m:
 275                         return m.group(1)
 276
 277         @lazy_property
 278         def author(self):
 279                 if self.data.author_uid:
 280                         return self.backend.accounts.get_by_uid(self.data.author_uid)
 281
 282         def _render_external_link(self, m):
 283                 url, alias = m.groups()
 284
 285                 return """<a class="link-external" href="%s">%s</a>""" % (url, alias or url)
 286
 287         def _render_interwiki_link(self, m):
 288                 wiki = m.group(1)
 289                 if not wiki:
 290                         return
 291
 292                 # Retrieve URL
 293                 try:
 294                         url, repl, icon = INTERWIKIS[wiki]
 295                 except KeyError:
 296                         logging.warning("Invalid interwiki: %s" % wiki)
 297                         return
 298
 299                 # Name of the page
 300                 name = m.group(2)
 301
 302                 # Expand URL
 303                 url = url % {
 304                         "name" : name,
 305                         "url"  : urllib.parse.quote(name),
 306                 }
 307
 308                 # Get alias (if present)
 309                 alias = m.group(3)
 310
 311                 if not alias and repl:
 312                         alias = repl % name
 313
 314                 # Put everything together
 315                 s = []
 316
 317                 if icon:
 318                         s.append("<span class=\"%s\"></span>" % icon)
 319
 320                 s.append("""<a class="link-external" href="%s">%s</a>""" % (url, alias or name))
 321
 322                 return " ".join(s)
 323
 324         def _render(self, text):
 325                 logging.debug("Rendering %s" % self)
 326
 327                 # Link images
 328                 replacements = []
 329                 for match in re.finditer(r"!\[(.*?)\]\((.*?)\)", text):
 330                         alt_text, url = match.groups()
 331
 332                         # Skip any absolute and external URLs
 333                         if url.startswith("/") or url.startswith("https://") or url.startswith("http://"):
 334                                 continue
 335
 336                         # Try to split query string
 337                         url, delimiter, qs = url.partition("?")
 338
 339                         # Parse query arguments
 340                         args = urllib.parse.parse_qs(qs)
 341
 342                         # Find image
 343                         file = self.backend.wiki.find_image(self.page, url)
 344                         if not file:
 345                                 continue
 346
 347                         # Scale down the image if not already done
 348                         if not "s" in args:
 349                                 args["s"] = "768"
 350
 351                         # Format URL
 352                         url = "%s?%s" % (file.url, urllib.parse.urlencode(args))
 353
 354                         replacements.append((match.span(), file, alt_text, url))
 355
 356                 # Apply all replacements
 357                 for (start, end), file, alt_text, url in reversed(replacements):
 358                         text = text[:start] + "[![%s](%s)](%s?action=detail)" % (alt_text, url, file.url) + text[end:]
 359
 360                 # Handle interwiki links
 361                 text = self.interwiki_link.sub(self._render_interwiki_link, text)
 362
 363                 # Handle external links
 364                 text = self.external_link.sub(self._render_external_link, text)
 365
 366                 # Add wiki links
 367                 patterns = (
 368                         (r"\[\[([\w\d\/\-\.]+)(?:\|(.+?))\]\]", r"\1", r"\2", None, True),
 369                         (r"\[\[([\w\d\/\-\.]+)\]\]", r"\1", r"\1", self.backend.wiki.get_page_title, True),
 370
 371                         # Mail
 372                         (r"\[\[([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)\]\]",
 373                                 r"\1", r"\1", None, False),
 374                 )
 375
 376                 for pattern, link, title, repl, internal in patterns:
 377                         replacements = []
 378
 379                         for match in re.finditer(pattern, text):
 380                                 l = match.expand(link)
 381                                 t = match.expand(title)
 382
 383                                 if internal:
 384                                         # Allow relative links
 385                                         if not l.startswith("/"):
 386                                                 l = os.path.join(self.page, l)
 387
 388                                         # Normalise links
 389                                         l = os.path.normpath(l)
 390
 391                                 if callable(repl):
 392                                         t = repl(l) or t
 393
 394                                 replacements.append((match.span(), t or l, l))
 395
 396                         # Apply all replacements
 397                         for (start, end), t, l in reversed(replacements):
 398                                 text = text[:start] + "[%s](%s)" % (t, l) + text[end:]
 399
 400                 # Borrow this from the blog
 401                 return self.backend.blog._render_text(text, lang="markdown")
 402
 403         @property
 404         def markdown(self):
 405                 return self.data.markdown or ""
 406
 407         @property
 408         def html(self):
 409                 return self._render(self.markdown)
 410
 411         @property
 412         def timestamp(self):
 413                 return self.data.timestamp
 414
 415         def was_deleted(self):
 416                 return self.markdown is None
 417
 418         @lazy_property
 419         def breadcrumbs(self):
 420                 return self.backend.wiki.make_breadcrumbs(self.page)
 421
 422         def get_latest_revision(self):
 423                 revisions = self.get_revisions()
 424
 425                 # Return first object
 426                 for rev in revisions:
 427                         return rev
 428
 429         def get_revisions(self):
 430                 return self.backend.wiki._get_pages("SELECT * FROM wiki \
 431                         WHERE page = %s ORDER BY timestamp DESC", self.page)
 432
 433         @lazy_property
 434         def previous_revision(self):
 435                 return self.backend.wiki._get_page("SELECT * FROM wiki \
 436                         WHERE page = %s AND timestamp < %s ORDER BY timestamp DESC \
 437                         LIMIT 1", self.page, self.timestamp)
 438
 439         @property
 440         def changes(self):
 441                 return self.data.changes
 442
 443         # ACL
 444
 445         def check_acl(self, account):
 446                 return self.backend.wiki.check_acl(self.page, account)
 447
 448         # Sidebar
 449
 450         @lazy_property
 451         def sidebar(self):
 452                 parts = self.page.split("/")
 453
 454                 while parts:
 455                         sidebar = self.backend.wiki.get_page("%s/sidebar" % os.path.join(*parts))
 456                         if sidebar:
 457                                 return sidebar
 458
 459                         parts.pop()
 460
 461         # Watchers
 462
 463         @lazy_property
 464         def diff(self):
 465                 if self.previous_revision:
 466                         diff = difflib.unified_diff(
 467                                 self.previous_revision.markdown.splitlines(),
 468                                 self.markdown.splitlines(),
 469                         )
 470
 471                         return "\n".join(diff)
 472
 473         @property
 474         def watchers(self):
 475                 res = self.db.query("SELECT uid FROM wiki_watchlist \
 476                         WHERE page = %s", self.page)
 477
 478                 for row in res:
 479                         # Search for account by UID and skip if none was found
 480                         account = self.backend.accounts.get_by_uid(row.uid)
 481                         if not account:
 482                                 continue
 483
 484                         # Return the account
 485                         yield account
 486
 487         def is_watched_by(self, account):
 488                 res = self.db.get("SELECT 1 FROM wiki_watchlist \
 489                         WHERE page = %s AND uid = %s", self.page, account.uid)
 490
 491                 if res:
 492                         return True
 493
 494                 return False
 495
 496         def add_watcher(self, account):
 497                 if self.is_watched_by(account):
 498                         return
 499
 500                 self.db.execute("INSERT INTO wiki_watchlist(page, uid) \
 501                         VALUES(%s, %s)", self.page, account.uid)
 502
 503         def remove_watcher(self, account):
 504                 self.db.execute("DELETE FROM wiki_watchlist \
 505                         WHERE page = %s AND uid = %s", self.page, account.uid)
 506
 507         def _send_watcher_emails(self, excludes=[]):
 508                 # Nothing to do if there was no previous revision
 509                 if not self.previous_revision:
 510                         return
 511
 512                 for watcher in self.watchers:
 513                         # Skip everyone who is excluded
 514                         if watcher in excludes:
 515                                 logging.debug("Excluding %s" % watcher)
 516                                 continue
 517
 518                         logging.debug("Sending watcher email to %s" % watcher)
 519
 520                         # Compose message
 521                         self.backend.messages.send_template("wiki/messages/page-changed",
 522                                 recipients=[watcher], page=self, priority=-10)
 523
 524
 525 class File(misc.Object):
 526         def init(self, id, data):
 527                 self.id   = id
 528                 self.data = data
 529
 530         @property
 531         def url(self):
 532                 return os.path.join(self.path, self.filename)
 533
 534         @property
 535         def path(self):
 536                 return self.data.path
 537
 538         @property
 539         def filename(self):
 540                 return self.data.filename
 541
 542         @property
 543         def mimetype(self):
 544                 return self.data.mimetype
 545
 546         @property
 547         def size(self):
 548                 return self.data.size
 549
 550         @lazy_property
 551         def author(self):
 552                 if self.data.author_uid:
 553                         return self.backend.accounts.get_by_uid(self.data.author_uid)
 554
 555         @property
 556         def created_at(self):
 557                 return self.data.created_at
 558
 559         def is_pdf(self):
 560                 return self.mimetype in ("application/pdf", "application/x-pdf")
 561
 562         def is_image(self):
 563                 return self.mimetype.startswith("image/")
 564
 565         @lazy_property
 566         def blob(self):
 567                 res = self.db.get("SELECT data FROM wiki_blobs \
 568                         WHERE id = %s", self.data.blob_id)
 569
 570                 if res:
 571                         return bytes(res.data)
 572
 573         def get_thumbnail(self, size):
 574                 cache_key = "-".join((self.path, util.normalize(self.filename), self.created_at.isoformat(), "%spx" % size))
 575
 576                 # Try to fetch the data from the cache
 577                 thumbnail = self.memcache.get(cache_key)
 578                 if thumbnail:
 579                         return thumbnail
 580
 581                 # Generate the thumbnail
 582                 thumbnail = util.generate_thumbnail(self.blob, size)
 583
 584                 # Put it into the cache for forever
 585                 self.memcache.set(cache_key, thumbnail)
 586
 587                 return thumbnail