]>
git.ipfire.org Git - ipfire.org.git/blob - src/backend/wiki.py
95849ee13979de6d8cf958fe7a4809a3e58ff11e
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
)
27 return self
._get
_pages
(
28 "SELECT wiki.* FROM wiki_current current \
29 LEFT JOIN wiki ON current.id = wiki.id \
30 WHERE current.deleted IS FALSE \
34 def make_path(self
, page
, path
):
35 # Nothing to do for absolute links
36 if path
.startswith("/"):
39 # Relative links (one-level down)
40 elif path
.startswith("./"):
41 path
= os
.path
.join(page
, path
)
43 # All other relative links
45 p
= os
.path
.dirname(page
)
46 path
= os
.path
.join(p
, path
)
49 return os
.path
.normpath(path
)
51 def page_exists(self
, path
):
52 page
= self
.get_page(path
)
54 # Page must have been found and not deleted
55 return page
and not page
.was_deleted()
57 def get_page_title(self
, page
, default
=None):
58 # Try to retrieve title from cache
59 title
= self
.memcache
.get("wiki:title:%s" % page
)
63 # If the title has not been in the cache, we will
65 doc
= self
.get_page(page
)
69 title
= os
.path
.basename(page
)
71 # Save in cache for forever
72 self
.memcache
.set("wiki:title:%s" % page
, title
)
76 def get_page(self
, page
, revision
=None):
77 page
= Page
.sanitise_page_name(page
)
81 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
82 AND timestamp = %s", page
, revision
)
84 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
85 ORDER BY timestamp DESC LIMIT 1", page
)
87 def get_recent_changes(self
, account
, limit
=None):
88 pages
= self
._get
_pages
("SELECT * FROM wiki \
89 ORDER BY timestamp DESC")
92 if not page
.check_acl(account
):
101 def create_page(self
, page
, author
, content
, changes
=None, address
=None):
102 page
= Page
.sanitise_page_name(page
)
104 # Write page to the database
105 page
= self
._get
_page
("INSERT INTO wiki(page, author_uid, markdown, changes, address) \
106 VALUES(%s, %s, %s, %s, %s) RETURNING *", page
, author
.uid
, content
or None, changes
, address
)
109 self
.memcache
.set("wiki:title:%s" % page
.page
, page
.title
)
111 # Send email to all watchers
112 page
._send
_watcher
_emails
(excludes
=[author
])
116 def delete_page(self
, page
, author
, **kwargs
):
117 # Do nothing if the page does not exist
118 if not self
.get_page(page
):
121 # Just creates a blank last version of the page
122 self
.create_page(page
, author
=author
, content
=None, **kwargs
)
124 def make_breadcrumbs(self
, url
):
125 # Split and strip all empty elements (double slashes)
126 parts
= list(e
for e
in url
.split("/") if e
)
129 for part
in ("/".join(parts
[:i
]) for i
in range(1, len(parts
))):
130 ret
.append(("/%s" % part
, self
.get_page_title(part
, os
.path
.basename(part
))))
134 def search(self
, query
, account
=None, limit
=None):
135 res
= self
._get
_pages
("SELECT wiki.* FROM wiki_search_index search_index \
136 LEFT JOIN wiki ON search_index.wiki_id = wiki.id \
137 WHERE search_index.document @@ websearch_to_tsquery('english', %s) \
138 ORDER BY ts_rank(search_index.document, websearch_to_tsquery('english', %s)) DESC",
143 # Skip any pages the user doesn't have permission for
144 if not page
.check_acl(account
):
147 # Return any other pages
150 # Break when we have found enough pages
151 if limit
and len(pages
) >= limit
:
158 Needs to be called after a page has been changed
160 self
.db
.execute("REFRESH MATERIALIZED VIEW wiki_search_index")
162 def get_watchlist(self
, account
):
163 pages
= self
._get
_pages
(
164 "WITH pages AS (SELECT * FROM wiki_current \
165 LEFT JOIN wiki ON wiki_current.id = wiki.id) \
166 SELECT * FROM wiki_watchlist watchlist \
167 LEFT JOIN pages ON watchlist.page = pages.page \
168 WHERE watchlist.uid = %s",
176 def check_acl(self
, page
, account
):
177 res
= self
.db
.query("SELECT * FROM wiki_acls \
178 WHERE %s ILIKE (path || '%%') ORDER BY LENGTH(path) DESC LIMIT 1", page
)
181 # Access not permitted when user is not logged in
185 # If user is in a matching group, we grant permission
186 for group
in row
.groups
:
187 if account
.is_member_of_group(group
):
190 # Otherwise access is not permitted
193 # If no ACLs are found, we permit access
198 def _get_files(self
, query
, *args
):
199 res
= self
.db
.query(query
, *args
)
202 yield File(self
.backend
, row
.id, data
=row
)
204 def _get_file(self
, query
, *args
):
205 res
= self
.db
.get(query
, *args
)
208 return File(self
.backend
, res
.id, data
=res
)
210 def get_files(self
, path
):
211 files
= self
._get
_files
("SELECT * FROM wiki_files \
212 WHERE path = %s AND deleted_at IS NULL ORDER BY filename", path
)
216 def get_file_by_path(self
, path
, revision
=None):
217 path
, filename
= os
.path
.dirname(path
), os
.path
.basename(path
)
220 # Fetch a specific revision
221 return self
._get
_file
("SELECT * FROM wiki_files \
222 WHERE path = %s AND filename = %s AND created_at <= %s \
223 ORDER BY created_at DESC LIMIT 1", path
, filename
, revision
)
225 # Fetch latest version
226 return self
._get
_file
("SELECT * FROM wiki_files \
227 WHERE path = %s AND filename = %s AND deleted_at IS NULL",
230 def get_file_by_path_and_filename(self
, path
, filename
):
231 return self
._get
_file
("SELECT * FROM wiki_files \
232 WHERE path = %s AND filename = %s AND deleted_at IS NULL",
235 def upload(self
, path
, filename
, data
, mimetype
, author
, address
):
236 # Replace any existing files
237 file = self
.get_file_by_path_and_filename(path
, filename
)
241 # Upload the blob first
242 blob
= self
.db
.get("INSERT INTO wiki_blobs(data) VALUES(%s) \
243 ON CONFLICT (digest(data, %s)) DO UPDATE SET data = EXCLUDED.data \
244 RETURNING id", data
, "MD5")
246 # Create entry for file
247 return self
._get
_file
("INSERT INTO wiki_files(path, filename, author_uid, address, \
248 mimetype, blob_id, size) VALUES(%s, %s, %s, %s, %s, %s, %s) RETURNING *", path
,
249 filename
, author
.uid
, address
, mimetype
, blob
.id, len(data
))
251 def render(self
, path
, text
):
252 r
= WikiRenderer(self
.backend
, path
)
254 return r
.render(text
)
257 class Page(misc
.Object
):
258 def init(self
, id, data
=None):
263 return "<%s %s %s>" % (self
.__class
__.__name
__, self
.page
, self
.timestamp
)
265 def __eq__(self
, other
):
266 if isinstance(other
, self
.__class
__):
267 return self
.id == other
.id
269 return NotImplemented
271 def __lt__(self
, other
):
272 if isinstance(other
, self
.__class
__):
273 if self
.page
== other
.page
:
274 return self
.timestamp
< other
.timestamp
276 return self
.page
< other
.page
278 return NotImplemented
281 def sanitise_page_name(page
):
285 # Make sure that the page name does NOT end with a /
286 if page
.endswith("/"):
289 # Make sure the page name starts with a /
290 if not page
.startswith("/"):
293 # Remove any double slashes
294 page
= page
.replace("//", "/")
300 return urllib
.parse
.urljoin("/docs", self
.page
)
304 return "https://www.ipfire.org/docs%s" % self
.url
308 return self
.data
.page
312 return self
._title
or os
.path
.basename(self
.page
[1:])
316 if not self
.markdown
:
319 # Find first H1 headline in markdown
320 markdown
= self
.markdown
.splitlines()
322 m
= re
.match(r
"^#\s*(.*)( #)?$", markdown
[0])
328 if self
.data
.author_uid
:
329 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
333 return self
.data
.markdown
or ""
337 return self
.backend
.wiki
.render(self
.page
, self
.markdown
)
341 return self
.data
.timestamp
343 def was_deleted(self
):
344 return not self
.markdown
347 def breadcrumbs(self
):
348 return self
.backend
.wiki
.make_breadcrumbs(self
.page
)
350 def is_latest_revision(self
):
351 return self
.get_latest_revision() == self
353 def get_latest_revision(self
):
354 revisions
= self
.get_revisions()
356 # Return first object
357 for rev
in revisions
:
360 def get_revisions(self
):
361 return self
.backend
.wiki
._get
_pages
("SELECT * FROM wiki \
362 WHERE page = %s ORDER BY timestamp DESC", self
.page
)
365 def previous_revision(self
):
366 return self
.backend
.wiki
._get
_page
("SELECT * FROM wiki \
367 WHERE page = %s AND timestamp < %s ORDER BY timestamp DESC \
368 LIMIT 1", self
.page
, self
.timestamp
)
372 return self
.data
.changes
376 def check_acl(self
, account
):
377 return self
.backend
.wiki
.check_acl(self
.page
, account
)
383 parts
= self
.page
.split("/")
386 sidebar
= self
.backend
.wiki
.get_page("%s/sidebar" % os
.path
.join(*parts
))
396 if self
.previous_revision
:
397 diff
= difflib
.unified_diff(
398 self
.previous_revision
.markdown
.splitlines(),
399 self
.markdown
.splitlines(),
402 return "\n".join(diff
)
406 res
= self
.db
.query("SELECT uid FROM wiki_watchlist \
407 WHERE page = %s", self
.page
)
410 # Search for account by UID and skip if none was found
411 account
= self
.backend
.accounts
.get_by_uid(row
.uid
)
418 def is_watched_by(self
, account
):
419 res
= self
.db
.get("SELECT 1 FROM wiki_watchlist \
420 WHERE page = %s AND uid = %s", self
.page
, account
.uid
)
427 def add_watcher(self
, account
):
428 if self
.is_watched_by(account
):
431 self
.db
.execute("INSERT INTO wiki_watchlist(page, uid) \
432 VALUES(%s, %s)", self
.page
, account
.uid
)
434 def remove_watcher(self
, account
):
435 self
.db
.execute("DELETE FROM wiki_watchlist \
436 WHERE page = %s AND uid = %s", self
.page
, account
.uid
)
438 def _send_watcher_emails(self
, excludes
=[]):
439 # Nothing to do if there was no previous revision
440 if not self
.previous_revision
:
443 for watcher
in self
.watchers
:
444 # Skip everyone who is excluded
445 if watcher
in excludes
:
446 logging
.debug("Excluding %s" % watcher
)
450 if not self
.backend
.wiki
.check_acl(self
.page
, watcher
):
451 logging
.debug("Watcher %s does not have permissions" % watcher
)
454 logging
.debug("Sending watcher email to %s" % watcher
)
457 self
.backend
.messages
.send_template("wiki/messages/page-changed",
458 account
=watcher
, page
=self
, priority
=-10)
460 def restore(self
, author
, address
, comment
=None):
461 changes
= "Restore to revision from %s" % self
.timestamp
.isoformat()
465 changes
= "%s: %s" % (changes
, comment
)
467 return self
.backend
.wiki
.create_page(self
.page
,
468 author
, self
.markdown
, changes
=changes
, address
=address
)
471 class File(misc
.Object
):
472 def init(self
, id, data
):
476 def __eq__(self
, other
):
477 if isinstance(other
, self
.__class
__):
478 return self
.id == other
.id
482 return os
.path
.join(self
.path
, self
.filename
)
486 return self
.data
.path
490 return self
.data
.filename
494 return self
.data
.mimetype
498 return self
.data
.size
502 if self
.data
.author_uid
:
503 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
506 def created_at(self
):
507 return self
.data
.created_at
509 def delete(self
, author
=None):
510 self
.db
.execute("UPDATE wiki_files SET deleted_at = NOW(), deleted_by = %s \
511 WHERE id = %s", author
.uid
if author
else None, self
.id)
514 def deleted_at(self
):
515 return self
.data
.deleted_at
517 def get_latest_revision(self
):
518 revisions
= self
.get_revisions()
520 # Return first object
521 for rev
in revisions
:
524 def get_revisions(self
):
525 revisions
= self
.backend
.wiki
._get
_files
("SELECT * FROM wiki_files \
526 WHERE path = %s AND filename = %s ORDER BY created_at DESC", self
.path
, self
.filename
)
528 return list(revisions
)
531 return self
.mimetype
in ("application/pdf", "application/x-pdf")
534 return self
.mimetype
.startswith("image/")
536 def is_vector_image(self
):
537 return self
.mimetype
in ("image/svg+xml",)
539 def is_bitmap_image(self
):
540 return self
.is_image() and not self
.is_vector_image()
544 res
= self
.db
.get("SELECT data FROM wiki_blobs \
545 WHERE id = %s", self
.data
.blob_id
)
548 return bytes(res
.data
)
550 def get_thumbnail(self
, size
):
551 assert self
.is_bitmap_image()
553 cache_key
= "-".join((self
.path
, util
.normalize(self
.filename
), self
.created_at
.isoformat(), "%spx" % size
))
555 # Try to fetch the data from the cache
556 thumbnail
= self
.memcache
.get(cache_key
)
560 # Generate the thumbnail
561 thumbnail
= util
.generate_thumbnail(self
.blob
, size
)
563 # Put it into the cache for forever
564 self
.memcache
.set(cache_key
, thumbnail
)
569 class WikiRenderer(misc
.Object
):
582 links
= re
.compile(r
"<a href=\"(.*?
)\">(.*?
)</a
>")
585 images = re.compile(r"<img
alt(?
:=\"(.*?
)\")? src
=\"(.*?
)\" (?
:title
=\"(.*?
)\" )?
/>")
587 def init(self, path):
590 def _render_link(self, m):
591 url, text = m.groups()
596 if url.startswith("mailto
:"):
599 return """<a class="link
-external
" href="mailto
:%s">%s</a>""" % \
603 for schema in self.schemas:
604 if url.startswith(schema):
605 return """<a class="link
-external
" href="%s">%s</a>""" % \
608 # Everything else must be an internal link
609 path = self.backend.wiki.make_path(self.path, url)
611 return """<a href="/docs
%s">%s</a>""" % \
612 (path, text or self.backend.wiki.get_page_title(path))
614 def _render_image(self, m):
615 alt_text, url, caption = m.groups()
618 <figure class="image
">
619 <img src="/docs
%s" alt="%s">
620 <figcaption class="figure
-caption
">%s</figcaption>
624 # Skip any absolute and external URLs
625 if url.startswith("/") or url.startswith("https
://") or url.startswith("http
://"):
626 return html % (url, alt_text, caption or "")
628 # Try to split query string
629 url, delimiter, qs = url.partition("?
")
631 # Parse query arguments
632 args = urllib.parse.parse_qs(qs)
634 # Build absolute path
635 url = self.backend.wiki.make_path(self.path, url)
638 file = self.backend.wiki.get_file_by_path(url)
639 if not file or not file.is_image():
640 return "<!-- Could
not find image
%s in %s -->" % (url, self.path)
642 # Scale down the image if not already done
646 # Append arguments to the URL
648 url = "%s?
%s" % (url, urllib.parse.urlencode(args))
650 return html % (url, caption, caption or "")
652 def render(self, text):
653 logging.debug("Rendering
%s" % self.path)
655 # Borrow this from the blog
656 text = self.backend.blog._render_text(text, lang="markdown
")
659 text = self.links.sub(self._render_link, text)
661 # Postprocess images to <figure>
662 text = self.images.sub(self._render_image, text)