]>
git.ipfire.org Git - ipfire.org.git/blob - src/backend/wiki.py
9 from .decorators
import *
11 class Wiki(misc
.Object
):
12 def _get_pages(self
, query
, *args
):
13 res
= self
.db
.query(query
, *args
)
16 yield Page(self
.backend
, row
.id, data
=row
)
18 def _get_page(self
, query
, *args
):
19 res
= self
.db
.get(query
, *args
)
22 return Page(self
.backend
, res
.id, data
=res
)
24 def get_page_title(self
, page
, default
=None):
25 doc
= self
.get_page(page
)
29 return default
or os
.path
.basename(page
)
31 def get_page(self
, page
, revision
=None):
32 page
= Page
.sanitise_page_name(page
)
36 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
37 AND timestamp = %s", page
, revision
)
39 return self
._get
_page
("SELECT * FROM wiki WHERE page = %s \
40 ORDER BY timestamp DESC LIMIT 1", page
)
42 def get_recent_changes(self
, limit
=None):
43 return self
._get
_pages
("SELECT * FROM wiki \
44 WHERE timestamp >= NOW() - INTERVAL '4 weeks' \
45 ORDER BY timestamp DESC LIMIT %s", limit
)
47 def create_page(self
, page
, author
, content
, changes
=None, address
=None):
48 page
= Page
.sanitise_page_name(page
)
50 return self
._get
_page
("INSERT INTO wiki(page, author_uid, markdown, changes, address) \
51 VALUES(%s, %s, %s, %s, %s) RETURNING *", page
, author
.uid
, content
or None, changes
, address
)
53 def delete_page(self
, page
, author
, **kwargs
):
54 # Do nothing if the page does not exist
55 if not self
.get_page(page
):
58 # Just creates a blank last version of the page
59 self
.create_page(page
, author
=author
, content
=None, **kwargs
)
61 def make_breadcrumbs(self
, url
):
62 # Split and strip all empty elements (double slashes)
63 parts
= list(e
for e
in url
.split("/") if e
)
66 for part
in ("/".join(parts
[:i
]) for i
in range(1, len(parts
))):
67 ret
.append(("/%s" % part
, self
.get_page_title(part
, os
.path
.basename(part
))))
71 def search(self
, query
, limit
=None):
72 query
= util
.parse_search_query(query
)
74 res
= self
._get
_pages
("SELECT wiki.* FROM wiki_search_index search_index \
75 LEFT JOIN wiki ON search_index.wiki_id = wiki.id \
76 WHERE search_index.document @@ to_tsquery('english', %s) \
77 ORDER BY ts_rank(search_index.document, to_tsquery('english', %s)) DESC \
78 LIMIT %s", query
, query
, limit
)
84 Needs to be called after a page has been changed
86 self
.db
.execute("REFRESH MATERIALIZED VIEW wiki_search_index")
89 class Page(misc
.Object
):
90 def init(self
, id, data
=None):
94 def __lt__(self
, other
):
95 if isinstance(other
, self
.__class
__):
96 if self
.page
== other
.page
:
97 return self
.timestamp
< other
.timestamp
99 return self
.page
< other
.page
102 def sanitise_page_name(page
):
106 # Make sure that the page name does NOT end with a /
107 if page
.endswith("/"):
110 # Make sure the page name starts with a /
111 if not page
.startswith("/"):
114 # Remove any double slashes
115 page
= page
.replace("//", "/")
125 return self
.data
.page
129 return self
._title
or self
.page
[1:]
133 if not self
.markdown
:
136 # Find first H1 headline in markdown
137 markdown
= self
.markdown
.splitlines()
139 m
= re
.match(r
"^# (.*)( #)?$", markdown
[0])
145 if self
.data
.author_uid
:
146 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
148 def _render(self
, text
):
149 logging
.debug("Rendering %s" % self
)
152 (r
"\[\[([\w\d\/]+)(?:\|([\w\d\s]+))\]\]", r
"/\1", r
"\2", None, None),
153 (r
"\[\[([\w\d\/\-]+)\]\]", r
"/\1", r
"\1", self
.backend
.wiki
.get_page_title
, r
"\1"),
156 for pattern
, link
, title
, repl
, args
in patterns
:
159 for match
in re
.finditer(pattern
, text
):
160 l
= match
.expand(link
)
161 t
= match
.expand(title
)
164 t
= repl(match
.expand(args
)) or t
166 replacements
.append((match
.span(), t
or l
, l
))
168 # Apply all replacements
169 for (start
, end
), t
, l
in reversed(replacements
):
170 text
= text
[:start
] + "[%s](%s)" % (t
, l
) + text
[end
:]
172 # Borrow this from the blog
173 return self
.backend
.blog
._render
_text
(text
, lang
="markdown")
177 return self
.data
.markdown
181 return self
.data
.html
or self
._render
(self
.markdown
)
185 return self
.data
.timestamp
187 def was_deleted(self
):
188 return self
.markdown
is None
191 def breadcrumbs(self
):
192 return self
.backend
.wiki
.make_breadcrumbs(self
.page
)
194 def get_latest_revision(self
):
195 revisions
= self
.get_revisions()
197 # Return first object
198 for rev
in revisions
:
201 def get_revisions(self
):
202 return self
.backend
.wiki
._get
_pages
("SELECT * FROM wiki \
203 WHERE page = %s ORDER BY timestamp DESC", self
.page
)
207 return self
.data
.changes
213 parts
= self
.page
.split("/")
216 sidebar
= self
.backend
.wiki
.get_page("%s/sidebar" % os
.path
.join(*parts
))