qswiki
Go to file
2022-03-27 19:52:45 +02:00
cache fscache: Fix starts_with() broken by b41a5f4e5b 2021-11-30 19:14:59 +01:00
database Page: Add 'title' column, storing title of last revision 2022-03-27 09:23:35 +02:00
dynamic Page: Add 'title' column, storing title of last revision 2022-03-27 09:23:35 +02:00
gateway gateway: HttpGateway: convertRequest(): Don't convert param to std::string 2021-10-10 20:15:28 +02:00
handlers HandlerFactory: Wire up HandlerFeedGenerator 2022-03-27 19:52:45 +02:00
sandbox sandbox: Use exile.h vow promises 2021-12-29 11:13:47 +01:00
setup Page: Add 'title' column, storing title of last revision 2022-03-27 09:23:35 +02:00
submodules sandbox: Use exile.h vow promises 2021-12-29 11:13:47 +01:00
template/quitesimple template: display headers inline (backport from production) 2021-11-14 21:54:08 +01:00
tests Let's make (git) history! 2018-11-03 17:12:20 +01:00
.gitignore Let's make (git) history! 2018-11-03 17:12:20 +01:00
.gitmodules sandbox: Switch to exile.h (former qssb.h) 2021-12-02 10:15:11 +01:00
authenticator.cpp Remove utils::hasKey(), as we now have .contains() 2021-10-19 12:48:45 +02:00
authenticator.h Authenticator: Introduce AUTH_DEFAULT_SALT_SIZE 2021-10-03 17:01:03 +02:00
category.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
category.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
cli.cpp Fix -wreturn-type warnings 2021-10-25 18:13:25 +02:00
cli.h Add [[maybe_unused]] to silence unhelpful warnings 2021-10-25 17:56:37 +02:00
cliconsole.cpp CLIConsole: On 'exit', ask whether to quit attached instance 2021-10-10 20:15:28 +02:00
cliconsole.h Introduce CLI 2021-10-03 17:05:46 +02:00
cliserver.cpp C++20: Avoid implicit capture 2021-10-25 18:09:46 +02:00
cliserver.h Introduce CLI 2021-10-03 17:05:46 +02:00
config.cpp Config: Require rooturl,atomurl 2022-03-27 19:50:51 +02:00
config.h Config: Require rooturl,atomurl 2022-03-27 19:50:51 +02:00
cookie.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
cookie.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
Dockerfile don't link with boost anymore as regex is handled by std now 2020-04-19 17:02:21 +02:00
headline.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
headline.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
htmllink.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
htmllink.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
iparser.h Parser: Add callback support for unknown "tags" 2022-03-27 08:31:59 +02:00
LICENCE Let's make (git) history! 2018-11-03 17:12:20 +01:00
logger.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
logger.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
Makefile sandbox: Switch to exile.h (former qssb.h) 2021-12-02 10:15:11 +01:00
page.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
page.h Page: Add 'title' column, storing title of last revision 2022-03-27 09:23:35 +02:00
parser.cpp Parser: Add callback support for unknown "tags" 2022-03-27 08:31:59 +02:00
parser.h Parser: Add callback support for unknown "tags" 2022-03-27 08:31:59 +02:00
permissions.cpp Permissions: Add toString() 2021-10-03 17:01:48 +02:00
permissions.h Permissions: Add toString() 2021-10-03 17:01:48 +02:00
qswiki.cpp Add [[maybe_unused]] to silence unhelpful warnings 2021-10-25 17:56:37 +02:00
random.cpp Random: Mark getRandom* const 2021-04-18 13:35:43 +02:00
random.h Random: Mark getRandom* const 2021-04-18 13:35:43 +02:00
README.md sandbox: Switch to exile.h (former qssb.h) 2021-12-02 10:15:11 +01:00
request.cpp utils: split: Rename all splitBy*() variants to split() 2021-04-18 13:35:02 +02:00
request.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
requestworker.cpp Adjust to new Template::getPage() returning value, not reference 2021-10-08 00:11:58 +02:00
requestworker.h RequestWorker: take unique ptr (fixes regression) 2019-09-29 21:34:21 +02:00
response.cpp Response: addHeader(): Pass by value, not reference 2021-10-10 20:15:28 +02:00
response.h Response: addHeader(): Pass by value, not reference 2021-10-10 20:15:28 +02:00
revision.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
revision.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
searchresult.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
session.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
session.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
template.cpp template: Adjust after renaming: Use utils::toISODateTime() 2022-03-27 08:30:20 +02:00
template.h Template: Make loadResolvedPart() public 2022-03-27 08:30:51 +02:00
templatepage.cpp TemplatePage: Change 'content' to shared_ptr 2021-10-10 22:32:13 +02:00
templatepage.h TemplatePage: Change 'content' to shared_ptr 2021-10-10 22:32:13 +02:00
TODO updated TODO 2018-11-10 22:44:26 +01:00
urlprovider.cpp UrlProvider: Introduce combine(), rootUrl(), atomFeed() 2022-03-27 19:51:53 +02:00
urlprovider.h UrlProvider: Introduce combine(), rootUrl(), atomFeed() 2022-03-27 19:51:53 +02:00
user.cpp Let's make (git) history! 2018-11-03 17:12:20 +01:00
user.h user model: added enabled column 2019-05-03 15:56:16 +02:00
utils.cpp utils: readCompleteFile(): Throw exception if file can't be opened 2022-03-27 19:47:52 +02:00
utils.h utils: Rename/Add date functions 2022-03-27 08:29:13 +02:00
varreplacer.cpp Remove utils::hasKey(), as we now have .contains() 2021-10-19 12:48:45 +02:00
varreplacer.h Let's make (git) history! 2018-11-03 17:12:20 +01:00
version.cpp Add version.{h,cpp}: Returning version info 2021-10-03 23:01:19 +02:00
version.h Add version.{h,cpp}: Returning version info 2021-10-03 23:01:19 +02:00

qswiki

About

qswiki is a wiki software, intended for small wikis. Originally implemented in C, it's now written in C++.

History

A couple of years ago, I wanted to setup a personal wiki on my raspberry pi. However, the distribution I used back then did not have a PHP package for ARM. So instead of switching distributions or searching for other wikis that I could use, I decided I would write one in C. Yes, that's an odd way to approach the problem and indeed, I may have had too much time back then. Also, I wanted to see how it's like to write a "web app" in C and wanted to sharpen my C skills a little bit.

Of course, it's pretty straightforward at first. No really: Just use CGI. And indeed, that would have been more than enough for my use cases. Then I decided to play around and started using FastCGI (with the official library from now defunct fastcgi.com) and created a multi-threaded version. It initially used a "pile of files database", but that became too painful, so then I started using sqlite.

C++

Eventually, since it was mostly a playground for me, the code became unmaintainable. Furthermore, I wanted something quick and given that it was CGI, I didn't bother taking care of memory leaks. After initiating a FastCGI interface, they became an issue and then the task of avoiding memory leaks became too annoying. And of course, C does n ot include any "batteries" and while I could manage, this too was another good reason.

Overall, I am just continuing the experiment with C++17 now. It's not nearly as bad as you would expect perhaps. Some things are surprisingly convenient even. Still, the standard library is lacking and I would hope for a some better built-in Unicode support in future C++ standards.

Features

To be fair, at this point it doesn't even have a "diff" between revisions yet and does not have features that would make you prefer it over other wikis.

  • CGI
  • HTTP server using the header only library cpp-httplib. It's more portable and more "future-proof" than FastCGI (since the official website disappeared, the library's future appears to be uncertain).
  • Support for user accounts. Passwords are stored using PBKDF2. sqlite database, but not too much of an effort to add other types of storage backends. sqlite is using the great header only library sqlite_modern_cpp
  • Relatively fine-grained permission system.
  • Categories
  • Templates
  • FTS search
  • Caching

Security

On Linux namespaces are used to restrict the process to only access files it needs. It doesn't have access to other paths in the system. In addition, Seccomp is used to restrict the syscalls the qswiki process can call. As for "web security", all POST requests are centrally protected against CSRF attacks and all input is escaped against XSS attacks.

Building

Dependencies:

The first three are header-only libraries that are included as a git submodule. The others must be installed, e. g. by using your distributions standard method.

If all dependencies are available, run:

  git submodule init
  git submodule update
  make release

Setup

To be written