]>
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")
90 def _get_files(self
, query
, *args
):
91 res
= self
.db
.query(query
, *args
)
94 yield File(self
.backend
, row
.id, data
=row
)
96 def _get_file(self
, query
, *args
):
97 res
= self
.db
.get(query
, *args
)
100 return File(self
.backend
, res
.id, data
=res
)
102 def get_files(self
, path
):
103 files
= self
._get
_files
("SELECT * FROM wiki_files \
104 WHERE path = %s AND deleted_at IS NULL ORDER BY filename", path
)
108 def get_file_by_path(self
, path
):
109 path
, filename
= os
.path
.dirname(path
), os
.path
.basename(path
)
111 return self
._get
_file
("SELECT * FROM wiki_files \
112 WHERE path = %s AND filename = %s AND deleted_at IS NULL", path
, filename
)
114 def upload(self
, path
, filename
, data
, mimetype
, author
, address
):
115 # Upload the blob first
116 blob
= self
.db
.get("INSERT INTO wiki_blobs(data) VALUES(%s) RETURNING id", data
)
118 # Create entry for file
119 return self
._get
_file
("INSERT INTO wiki_files(path, filename, author_uid, address, \
120 mimetype, blob_id, size) VALUES(%s, %s, %s, %s, %s, %s, %s) RETURNING *", path
,
121 filename
, author
.uid
, address
, mimetype
, blob
.id, len(data
))
124 class Page(misc
.Object
):
125 def init(self
, id, data
=None):
129 def __lt__(self
, other
):
130 if isinstance(other
, self
.__class
__):
131 if self
.page
== other
.page
:
132 return self
.timestamp
< other
.timestamp
134 return self
.page
< other
.page
137 def sanitise_page_name(page
):
141 # Make sure that the page name does NOT end with a /
142 if page
.endswith("/"):
145 # Make sure the page name starts with a /
146 if not page
.startswith("/"):
149 # Remove any double slashes
150 page
= page
.replace("//", "/")
160 return self
.data
.page
164 return self
._title
or self
.page
[1:]
168 if not self
.markdown
:
171 # Find first H1 headline in markdown
172 markdown
= self
.markdown
.splitlines()
174 m
= re
.match(r
"^# (.*)( #)?$", markdown
[0])
180 if self
.data
.author_uid
:
181 return self
.backend
.accounts
.get_by_uid(self
.data
.author_uid
)
183 def _render(self
, text
):
184 logging
.debug("Rendering %s" % self
)
187 (r
"\[\[([\w\d\/]+)(?:\|([\w\d\s]+))\]\]", r
"/\1", r
"\2", None, None),
188 (r
"\[\[([\w\d\/\-]+)\]\]", r
"/\1", r
"\1", self
.backend
.wiki
.get_page_title
, r
"\1"),
191 for pattern
, link
, title
, repl
, args
in patterns
:
194 for match
in re
.finditer(pattern
, text
):
195 l
= match
.expand(link
)
196 t
= match
.expand(title
)
199 t
= repl(match
.expand(args
)) or t
201 replacements
.append((match
.span(), t
or l
, l
))
203 # Apply all replacements
204 for (start
, end
), t
, l
in reversed(replacements
):
205 text
= text
[:start
] + "[%s](%s)" % (t
, l
) + text
[end
:]
207 # Borrow this from the blog
208 return self
.backend
.blog
._render
_text
(text
, lang
="markdown")
212 return self
.data
.markdown
216 return self
.data
.html
or self
._render
(self
.markdown
)
220 return self
.data
.timestamp
222 def was_deleted(self
):
223 return self
.markdown
is None
226 def breadcrumbs(self
):
227 return self
.backend
.wiki
.make_breadcrumbs(self
.page
)
229 def get_latest_revision(self
):
230 revisions
= self
.get_revisions()
232 # Return first object
233 for rev
in revisions
:
236 def get_revisions(self
):
237 return self
.backend
.wiki
._get
_pages
("SELECT * FROM wiki \
238 WHERE page = %s ORDER BY timestamp DESC", self
.page
)
242 return self
.data
.changes
248 parts
= self
.page
.split("/")
251 sidebar
= self
.backend
.wiki
.get_page("%s/sidebar" % os
.path
.join(*parts
))
258 class File(misc
.Object
):
259 def init(self
, id, data
):
265 return os
.path
.join(self
.path
, self
.filename
)
269 return self
.data
.path
273 return self
.data
.filename
277 return self
.data
.mimetype
281 return self
.data
.size
284 return self
.mimetype
.startswith("image/")
288 res
= self
.db
.get("SELECT data FROM wiki_blobs \
289 WHERE id = %s", self
.data
.blob_id
)
292 return bytes(res
.data
)