]>
git.ipfire.org Git - ipfire.org.git/blob - src/backend/wiki.py
11 from .decorators
import *
13 class Wiki(misc
.Object
):
14 def _get_pages(self
, query
, *args
):
15 res
= self
.db
.query(query
, *args
)
18 yield Page(self
.backend
, row
.id, data
=row
)
20 def _get_page(self
, query
, *args
):
21 res
= self
.db
.get(query
, *args
)
24 return Page(self
.backend
, res
.id, data
=res
)
26 def make_path(self
, page
, path
):
27 # Nothing to do for absolute links
28 if path
.startswith("/"):
31 # Relative links (one-level down)
32 elif path
.startswith("./"):
33 path
= os
.path
.join(page
, path
)
35 # All other relative links
37 p
= os
.path
.dirname(page
)
38 path
= os
.path
.join(p
, path
)
41 return os
.path
.normpath(path
)
43 def page_exists(self
, path
):
44 page
= self
.get_page(path
)
46 # Page must have been found and not deleted
47 return page
and not page
.was_deleted()
49 def get_page_title(self
, page
, default
=None):
50 # Try to retrieve title from cache
51 title
= self
.memcache
.get("wiki:title:%s" % page
)
55 # If the title has not been in the cache, we will
57 doc
= self
.get_page(page
)
61 title
= os
.path
.basename(page
)
63 # Save in cache for forever
64 self
.memcache
.set("wiki:title:%s" % page
, title
)
68 def get_page(self
, page
, revision
=None):
69 page
= Page
.sanitise_page_name(page
)
73 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
74 AND timestamp = %s", page
, revision
)
76 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
77 ORDER BY timestamp DESC LIMIT 1", page
)
79 def get_recent_changes(self
, account
, limit
=None):
80 pages
= self
._get
_pages
("SELECT * FROM wiki \
81 ORDER BY timestamp DESC")
84 if not page
.check_acl(account
):
93 def create_page(self
, page
, author
, content
, changes
=None, address
=None):
94 page
= Page
.sanitise_page_name(page
)
96 # Write page to the database
97 page
= self
._get
_page
("INSERT INTO wiki(page, author_uid, markdown, changes, address) \
98 VALUES(%s, %s, %s, %s, %s) RETURNING *", page
, author
.uid
, content
or None, changes
, address
)
101 self
.memcache
.set("wiki:title:%s" % page
.page
, page
.title
)
103 # Send email to all watchers
104 page
._send
_watcher
_emails
(excludes
=[author
])
108 def delete_page(self
, page
, author
, **kwargs
):
109 # Do nothing if the page does not exist
110 if not self
.get_page(page
):
113 # Just creates a blank last version of the page
114 self
.create_page(page
, author
=author
, content
=None, **kwargs
)
116 def make_breadcrumbs(self
, url
):
117 # Split and strip all empty elements (double slashes)
118 parts
= list(e
for e
in url
.split("/") if e
)
121 for part
in ("/".join(parts
[:i
]) for i
in range(1, len(parts
))):
122 ret
.append(("/%s" % part
, self
.get_page_title(part
, os
.path
.basename(part
))))
126 def search(self
, query
, account
=None, limit
=None):
127 query
= util
.parse_search_query(query
)
129 res
= self
._get
_pages
("SELECT wiki.* FROM wiki_search_index search_index \
130 LEFT JOIN wiki ON search_index.wiki_id = wiki.id \
131 WHERE search_index.document @@ to_tsquery('english', %s) \
132 ORDER BY ts_rank(search_index.document, to_tsquery('english', %s)) DESC",
137 # Skip any pages the user doesn't have permission for
138 if not page
.check_acl(account
):
141 # Return any other pages
144 # Break when we have found enough pages
145 if limit
and len(pages
) >= limit
:
152 Needs to be called after a page has been changed
154 self
.db
.execute("REFRESH MATERIALIZED VIEW wiki_search_index")
156 def get_watchlist(self
, account
):
157 pages
= self
._get
_pages
(
158 "WITH pages AS (SELECT * FROM wiki_current \
159 LEFT JOIN wiki ON wiki_current.id = wiki.id) \
160 SELECT * FROM wiki_watchlist watchlist \
161 LEFT JOIN pages ON watchlist.page = pages.page \
162 WHERE watchlist.uid = %s",
170 def check_acl(self
, page
, account
):
171 res
= self
.db
.query("SELECT * FROM wiki_acls \
172 WHERE %s ILIKE (path || '%%') ORDER BY LENGTH(path) DESC LIMIT 1", page
)
175 # Access not permitted when user is not logged in
179 # If user is in a matching group, we grant permission
180 for group
in row
.groups
:
181 if account
.is_member_of_group(group
):
184 # Otherwise access is not permitted
187 # If no ACLs are found, we permit access
192 def _get_files(self
, query
, *args
):
193 res
= self
.db
.query(query
, *args
)
196 yield File(self
.backend
, row
.id, data
=row
)
198 def _get_file(self
, query
, *args
):
199 res
= self
.db
.get(query
, *args
)
202 return File(self
.backend
, res
.id, data
=res
)
204 def get_files(self
, path
):
205 files
= self
._get
_files
("SELECT * FROM wiki_files \
206 WHERE path = %s AND deleted_at IS NULL ORDER BY filename", path
)
210 def get_file_by_path(self
, path
, revision
=None):
211 path
, filename
= os
.path
.dirname(path
), os
.path
.basename(path
)
214 # Fetch a specific revision
215 return self
._get
_file
("SELECT * FROM wiki_files \
216 WHERE path = %s AND filename = %s AND created_at <= %s \
217 ORDER BY created_at DESC LIMIT 1", path
, filename
, revision
)
219 # Fetch latest version
220 return self
._get
_file
("SELECT * FROM wiki_files \
221 WHERE path = %s AND filename = %s AND deleted_at IS NULL",
224 def get_file_by_path_and_filename(self
, path
, filename
):
225 return self
._get
_file
("SELECT * FROM wiki_files \
226 WHERE path = %s AND filename = %s AND deleted_at IS NULL",
229 def upload(self
, path
, filename
, data
, mimetype
, author
, address
):
230 # Replace any existing files
231 file = self
.get_file_by_path_and_filename(path
, filename
)
235 # Upload the blob first
236 blob
= self
.db
.get("INSERT INTO wiki_blobs(data) VALUES(%s) \
237 ON CONFLICT (digest(data, %s)) DO UPDATE SET data = EXCLUDED.data \
238 RETURNING id", data
, "MD5")
240 # Create entry for file
241 return self
._get
_file
("INSERT INTO wiki_files(path, filename, author_uid, address, \
242 mimetype, blob_id, size) VALUES(%s, %s, %s, %s, %s, %s, %s) RETURNING *", path
,
243 filename
, author
.uid
, address
, mimetype
, blob
.id, len(data
))
245 def render(self
, path
, text
):
246 r
= WikiRenderer(self
.backend
, path
)
248 return r
.render(text
)
251 class Page(misc
.Object
):
252 def init(self
, id, data
=None):
257 return "<%s %s %s>" % (self
.__class
__.__name
__, self
.page
, self
.timestamp
)
259 def __eq__(self
, other
):
260 if isinstance(other
, self
.__class
__):
261 return self
.id == other
.id
263 def __lt__(self
, other
):
264 if isinstance(other
, self
.__class
__):
265 if self
.page
== other
.page
:
266 return self
.timestamp
< other
.timestamp
268 return self
.page
< other
.page
271 def sanitise_page_name(page
):
275 # Make sure that the page name does NOT end with a /
276 if page
.endswith("/"):
279 # Make sure the page name starts with a /
280 if not page
.startswith("/"):
283 # Remove any double slashes
284 page
= page
.replace("//", "/")
294 return "https://wiki.ipfire.org%s" % self
.url
298 return self
.data
.page
302 return self
._title
or os
.path
.basename(self
.page
[1:])
306 if not self
.markdown
:
309 # Find first H1 headline in markdown
310 markdown
= self
.markdown
.splitlines()
312 m
= re
.match(r
"^#\s*(.*)( #)?$", markdown
[0])
318 if self
.data
.author_uid
:
319 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
323 return self
.data
.markdown
or ""
327 return self
.backend
.wiki
.render(self
.page
, self
.markdown
)
331 return self
.data
.timestamp
333 def was_deleted(self
):
334 return not self
.markdown
337 def breadcrumbs(self
):
338 return self
.backend
.wiki
.make_breadcrumbs(self
.page
)
340 def is_latest_revision(self
):
341 return self
.get_latest_revision() == self
343 def get_latest_revision(self
):
344 revisions
= self
.get_revisions()
346 # Return first object
347 for rev
in revisions
:
350 def get_revisions(self
):
351 return self
.backend
.wiki
._get
_pages
("SELECT * FROM wiki \
352 WHERE page = %s ORDER BY timestamp DESC", self
.page
)
355 def previous_revision(self
):
356 return self
.backend
.wiki
._get
_page
("SELECT * FROM wiki \
357 WHERE page = %s AND timestamp < %s ORDER BY timestamp DESC \
358 LIMIT 1", self
.page
, self
.timestamp
)
362 return self
.data
.changes
366 def check_acl(self
, account
):
367 return self
.backend
.wiki
.check_acl(self
.page
, account
)
373 parts
= self
.page
.split("/")
376 sidebar
= self
.backend
.wiki
.get_page("%s/sidebar" % os
.path
.join(*parts
))
386 if self
.previous_revision
:
387 diff
= difflib
.unified_diff(
388 self
.previous_revision
.markdown
.splitlines(),
389 self
.markdown
.splitlines(),
392 return "\n".join(diff
)
396 res
= self
.db
.query("SELECT uid FROM wiki_watchlist \
397 WHERE page = %s", self
.page
)
400 # Search for account by UID and skip if none was found
401 account
= self
.backend
.accounts
.get_by_uid(row
.uid
)
408 def is_watched_by(self
, account
):
409 res
= self
.db
.get("SELECT 1 FROM wiki_watchlist \
410 WHERE page = %s AND uid = %s", self
.page
, account
.uid
)
417 def add_watcher(self
, account
):
418 if self
.is_watched_by(account
):
421 self
.db
.execute("INSERT INTO wiki_watchlist(page, uid) \
422 VALUES(%s, %s)", self
.page
, account
.uid
)
424 def remove_watcher(self
, account
):
425 self
.db
.execute("DELETE FROM wiki_watchlist \
426 WHERE page = %s AND uid = %s", self
.page
, account
.uid
)
428 def _send_watcher_emails(self
, excludes
=[]):
429 # Nothing to do if there was no previous revision
430 if not self
.previous_revision
:
433 for watcher
in self
.watchers
:
434 # Skip everyone who is excluded
435 if watcher
in excludes
:
436 logging
.debug("Excluding %s" % watcher
)
440 if not self
.backend
.wiki
.check_acl(self
.page
, watcher
):
441 logging
.debug("Watcher %s does not have permissions" % watcher
)
444 logging
.debug("Sending watcher email to %s" % watcher
)
447 self
.backend
.messages
.send_template("wiki/messages/page-changed",
448 recipients
=[watcher
], page
=self
, priority
=-10)
450 def restore(self
, author
, address
):
451 changes
= "Restore to revision from %s" % self
.timestamp
.isoformat()
453 return self
.backend
.wiki
.create_page(self
.page
,
454 author
, self
.markdown
, changes
=changes
, address
=address
)
457 class File(misc
.Object
):
458 def init(self
, id, data
):
462 def __eq__(self
, other
):
463 if isinstance(other
, self
.__class
__):
464 return self
.id == other
.id
468 return os
.path
.join(self
.path
, self
.filename
)
472 return self
.data
.path
476 return self
.data
.filename
480 return self
.data
.mimetype
484 return self
.data
.size
488 if self
.data
.author_uid
:
489 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
492 def created_at(self
):
493 return self
.data
.created_at
495 def delete(self
, author
=None):
496 self
.db
.execute("UPDATE wiki_files SET deleted_at = NOW(), deleted_by = %s \
497 WHERE id = %s", author
.uid
if author
else None, self
.id)
500 def deleted_at(self
):
501 return self
.data
.deleted_at
503 def get_latest_revision(self
):
504 revisions
= self
.get_revisions()
506 # Return first object
507 for rev
in revisions
:
510 def get_revisions(self
):
511 revisions
= self
.backend
.wiki
._get
_files
("SELECT * FROM wiki_files \
512 WHERE path = %s ORDER BY created_at DESC", self
.path
)
514 return list(revisions
)
517 return self
.mimetype
in ("application/pdf", "application/x-pdf")
520 return self
.mimetype
.startswith("image/")
524 res
= self
.db
.get("SELECT data FROM wiki_blobs \
525 WHERE id = %s", self
.data
.blob_id
)
528 return bytes(res
.data
)
530 def get_thumbnail(self
, size
):
531 cache_key
= "-".join((self
.path
, util
.normalize(self
.filename
), self
.created_at
.isoformat(), "%spx" % size
))
533 # Try to fetch the data from the cache
534 thumbnail
= self
.memcache
.get(cache_key
)
538 # Generate the thumbnail
539 thumbnail
= util
.generate_thumbnail(self
.blob
, size
)
541 # Put it into the cache for forever
542 self
.memcache
.set(cache_key
, thumbnail
)
547 class WikiRenderer(misc
.Object
):
560 links
= re
.compile(r
"<a href=\"(.*?
)\">(.*?
)</a
>")
563 images = re.compile(r"<img
alt(?
:=\"(.*?
)\")? src
=\"(.*?
)\" (?
:title
=\"(.*?
)\" )?
/>")
565 def init(self, path):
568 def _render_link(self, m):
569 url, text = m.groups()
574 if url.startswith("mailto
:"):
577 return """<a class="link
-external
" href="mailto
:%s">%s</a>""" % \
581 for schema in self.schemas:
582 if url.startswith(schema):
583 return """<a class="link
-external
" href="%s">%s</a>""" % \
586 # Everything else must be an internal link
587 path = self.backend.wiki.make_path(self.path, url)
589 return """<a href="%s">%s</a>""" % \
590 (path, text or self.backend.wiki.get_page_title(path))
592 def _render_image(self, m):
593 alt_text, url, caption = m.groups()
595 # Skip any absolute and external URLs
596 if url.startswith("/") or url.startswith("https
://") or url.startswith("http
://"):
597 return """<figure class="figure
"><img src="%s" class="figure
-img img
-fluid rounded
" alt="%s">
598 <figcaption class="figure
-caption
">%s</figcaption></figure>
599 """ % (url, alt_text, caption or "")
601 # Try to split query string
602 url, delimiter, qs = url.partition("?
")
604 # Parse query arguments
605 args = urllib.parse.parse_qs(qs)
607 # Build absolute path
608 url = self.backend.wiki.make_path(self.path, url)
611 file = self.backend.wiki.get_file_by_path(url)
612 if not file or not file.is_image():
613 return "<!-- Could
not find image
%s in %s -->" % (url, self.path)
615 # Scale down the image if not already done
619 return """<figure class="figure
"><img src="%s?
%s" class="figure
-img img
-fluid rounded
" alt="%s">
620 <figcaption class="figure
-caption
">%s</figcaption></figure>
621 """ % (url, urllib.parse.urlencode(args), caption, caption or "")
623 def render(self, text):
624 logging.debug("Rendering
%s" % self.path)
626 # Borrow this from the blog
627 text = self.backend.blog._render_text(text, lang="markdown
")
630 text = self.links.sub(self._render_link, text)
632 # Postprocess images to <figure>
633 text = self.images.sub(self._render_image, text)