4 * Server-side module for Wiki rooms. This handles things like version control.
6 * Copyright (c) 2009 by the citadel.org team
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <sys/types.h>
34 #if TIME_WITH_SYS_TIME
35 # include <sys/time.h>
39 # include <sys/time.h>
48 #include <libcitadel.h>
51 #include "citserver.h"
58 #include "euidindex.h"
59 #include "ctdl_module.h"
62 * Data passed back and forth between wiki_rev() and its MIME parser callback
64 struct HistoryEraserCallBackData {
65 char *tempfilename; /* name of temp file being patched */
66 char *stop_when; /* stop when we hit this uuid */
67 int done; /* set to nonzero when we're done patching */
71 * Name of the temporary room we create to store old revisions when someone requests them.
72 * We put it in an invalid namespace so the DAP cleans up after us later.
74 char *wwm = "9999999999.WikiWaybackMachine";
77 * Before allowing a wiki page save to execute, we have to perform version control.
78 * This involves fetching the old version of the page if it exists.
80 int wiki_upload_beforesave(struct CtdlMessage *msg) {
81 struct CitContext *CCC = CC;
82 long old_msgnum = (-1L);
83 struct CtdlMessage *old_msg = NULL;
84 long history_msgnum = (-1L);
85 struct CtdlMessage *history_msg = NULL;
86 char diff_old_filename[PATH_MAX];
87 char diff_new_filename[PATH_MAX];
88 char diff_cmd[PATH_MAX];
91 char history_page[1024];
93 char prefixed_boundary[258];
97 size_t diffbuf_len = 0;
100 if (!CCC->logged_in) return(0); /* Only do this if logged in. */
102 /* Is this a room with a Wiki in it, don't run this hook. */
103 if (CCC->room.QRdefaultview != VIEW_WIKI) {
107 /* If this isn't a MIME message, don't bother. */
108 if (msg->cm_format_type != 4) return(0);
110 /* If there's no EUID we can't do this. Reject the post. */
111 if (msg->cm_fields['E'] == NULL) return(1);
113 snprintf(history_page, sizeof history_page, "%s_HISTORY_", msg->cm_fields['E']);
115 /* Make sure we're saving a real wiki page rather than a wiki history page.
116 * This is important in order to avoid recursing infinitely into this hook.
118 if ( (strlen(msg->cm_fields['E']) >= 9)
119 && (!strcasecmp(&msg->cm_fields['E'][strlen(msg->cm_fields['E'])-9], "_HISTORY_"))
121 CtdlLogPrintf(CTDL_DEBUG, "History page not being historied\n");
125 /* If there's no message text, obviously this is all b0rken and shouldn't happen at all */
126 if (msg->cm_fields['M'] == NULL) return(0);
128 /* Set the message subject identical to the page name */
129 if (msg->cm_fields['U'] != NULL) {
130 free(msg->cm_fields['U']);
132 msg->cm_fields['U'] = strdup(msg->cm_fields['E']);
134 /* See if we can retrieve the previous version. */
135 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields['E'], &CCC->room);
136 if (old_msgnum > 0L) {
137 old_msg = CtdlFetchMessage(old_msgnum, 1);
143 if ((old_msg != NULL) && (old_msg->cm_fields['M'] == NULL)) { /* old version is corrupt? */
144 CtdlFreeMessage(old_msg);
148 /* If no changes were made, don't bother saving it again */
149 if ((old_msg != NULL) && (!strcmp(msg->cm_fields['M'], old_msg->cm_fields['M']))) {
150 CtdlFreeMessage(old_msg);
157 CtdlMakeTempFileName(diff_old_filename, sizeof diff_old_filename);
158 CtdlMakeTempFileName(diff_new_filename, sizeof diff_new_filename);
160 if (old_msg != NULL) {
161 fp = fopen(diff_old_filename, "w");
162 rv = fwrite(old_msg->cm_fields['M'], strlen(old_msg->cm_fields['M']), 1, fp);
164 CtdlFreeMessage(old_msg);
167 fp = fopen(diff_new_filename, "w");
168 rv = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
173 snprintf(diff_cmd, sizeof diff_cmd,
176 ((old_msg != NULL) ? diff_old_filename : "/dev/null")
178 fp = popen(diff_cmd, "r");
181 diffbuf = realloc(diffbuf, diffbuf_len + 1025);
182 nbytes = fread(&diffbuf[diffbuf_len], 1, 1024, fp);
183 diffbuf_len += nbytes;
184 } while (nbytes == 1024);
185 diffbuf[diffbuf_len] = 0;
186 if (pclose(fp) != 0) {
187 CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - diff failed\n");
190 CtdlLogPrintf(CTDL_DEBUG, "diff length is %d bytes\n", diffbuf_len);
192 unlink(diff_old_filename);
193 unlink(diff_new_filename);
195 /* Determine whether this was a bogus (empty) edit */
196 if ((diffbuf_len = 0) && (diffbuf != NULL)) {
200 if (diffbuf == NULL) {
201 return(1); /* No changes at all? Abandon the post entirely! */
204 /* Now look for the existing edit history */
206 history_msgnum = CtdlLocateMessageByEuid(history_page, &CCC->room);
208 if (history_msgnum > 0L) {
209 history_msg = CtdlFetchMessage(history_msgnum, 1);
212 /* Create a new history message if necessary */
213 if (history_msg == NULL) {
214 history_msg = malloc(sizeof(struct CtdlMessage));
215 memset(history_msg, 0, sizeof(struct CtdlMessage));
216 history_msg->cm_magic = CTDLMESSAGE_MAGIC;
217 history_msg->cm_anon_type = MES_NORMAL;
218 history_msg->cm_format_type = FMT_RFC822;
219 history_msg->cm_fields['A'] = strdup("Citadel");
220 history_msg->cm_fields['R'] = strdup(CCC->room.QRname);
221 history_msg->cm_fields['E'] = strdup(history_page);
222 history_msg->cm_fields['U'] = strdup(history_page);
223 history_msg->cm_fields['1'] = strdup("1"); /* suppress full text indexing */
224 snprintf(boundary, sizeof boundary, "Citadel--Multipart--%04x--%08lx", getpid(), time(NULL));
225 history_msg->cm_fields['M'] = malloc(1024);
226 snprintf(history_msg->cm_fields['M'], 1024,
227 "Content-type: multipart/mixed; boundary=\"%s\"\n\n"
228 "This is a Citadel wiki history encoded as multipart MIME.\n"
229 "Each part is comprised of a diff script representing one change set.\n"
237 /* Update the history message (regardless of whether it's new or existing) */
239 /* Remove the Message-ID from the old version of the history message. This will cause a brand
240 * new one to be generated, avoiding an uninitentional hit of the loop zapper when we replicate.
242 if (history_msg->cm_fields['I'] != NULL) {
243 free(history_msg->cm_fields['I']);
246 /* Figure out the boundary string. We do this even when we generated the
247 * boundary string in the above code, just to be safe and consistent.
249 strcpy(boundary, "");
251 ptr = history_msg->cm_fields['M'];
253 ptr = memreadline(ptr, buf, sizeof buf);
256 if (!IsEmptyStr(buf) && (!strncasecmp(buf, "Content-type:", 13))) {
258 (bmstrcasestr(buf, "multipart") != NULL)
259 && (bmstrcasestr(buf, "boundary=") != NULL)
261 safestrncpy(boundary, bmstrcasestr(buf, "\""), sizeof boundary);
263 qu = strchr(boundary, '\"');
265 strcpy(boundary, ++qu);
267 qu = strchr(boundary, '\"');
274 } while ( (IsEmptyStr(boundary)) && (*ptr != 0) );
276 /* Now look for the first boundary. That is where we need to insert our fun.
278 if (!IsEmptyStr(boundary)) {
279 snprintf(prefixed_boundary, sizeof prefixed_boundary, "--%s", boundary);
280 history_msg->cm_fields['M'] = realloc(history_msg->cm_fields['M'],
281 strlen(history_msg->cm_fields['M']) + strlen(diffbuf) + 1024
283 ptr = bmstrcasestr(history_msg->cm_fields['M'], prefixed_boundary);
285 char *the_rest_of_it = strdup(ptr);
288 char encoded_memo[768];
290 snprintf(memo, sizeof memo, "%s|%ld|%s|%s",
295 /* no longer logging CCC->cs_inet_email */
297 CtdlEncodeBase64(encoded_memo, memo, strlen(memo), 0);
298 sprintf(ptr, "--%s\n"
299 "Content-type: text/plain\n"
300 "Content-Disposition: inline; filename=\"%s\"\n"
301 "Content-Transfer-Encoding: 8bit\n"
311 free(the_rest_of_it);
314 history_msg->cm_fields['T'] = realloc(history_msg->cm_fields['T'], 32);
315 snprintf(history_msg->cm_fields['T'], 32, "%ld", time(NULL));
317 CtdlSubmitMsg(history_msg, NULL, "", 0);
320 CtdlLogPrintf(CTDL_ALERT, "Empty boundary string in history message. No history!\n");
330 * MIME Parser callback for wiki_history()
332 * The "filename" field will contain a memo field. All we have to do is decode
333 * the base64 and output it. The data is already in a delimited format suitable
334 * for our client protocol.
336 void wiki_history_callback(char *name, char *filename, char *partnum, char *disp,
337 void *content, char *cbtype, char *cbcharset, size_t length,
338 char *encoding, char *cbid, void *cbuserdata)
342 CtdlDecodeBase64(memo, filename, strlen(filename));
343 cprintf("%s\n", memo);
348 * Fetch a list of revisions for a particular wiki page
350 void wiki_history(char *pagename) {
352 char history_page_name[270];
354 struct CtdlMessage *msg;
356 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
358 if (r == om_not_logged_in) {
359 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
362 cprintf("%d An unknown error has occurred.\n", ERROR);
367 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
368 msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
370 msg = CtdlFetchMessage(msgnum, 1);
376 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
377 CtdlFreeMessage(msg);
382 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
387 cprintf("%d Revision history for '%s'\n", LISTING_FOLLOWS, pagename);
388 mime_parser(msg->cm_fields['M'], NULL, *wiki_history_callback, NULL, NULL, NULL, 0);
391 CtdlFreeMessage(msg);
396 * MIME Parser callback for wiki_rev()
398 * The "filename" field will contain a memo field, which includes (among other things)
399 * the uuid of this revision. After we hit the desired revision, we stop processing.
401 * The "content" filed will contain "diff" output suitable for applying via "patch"
402 * to our temporary file.
404 void wiki_rev_callback(char *name, char *filename, char *partnum, char *disp,
405 void *content, char *cbtype, char *cbcharset, size_t length,
406 char *encoding, char *cbid, void *cbuserdata)
408 struct HistoryEraserCallBackData *hecbd = (struct HistoryEraserCallBackData *)cbuserdata;
415 /* Did a previous callback already indicate that we've reached our target uuid?
416 * If so, don't process anything else.
422 CtdlDecodeBase64(memo, filename, strlen(filename));
423 extract_token(this_rev, memo, 0, '|', sizeof this_rev);
424 CtdlLogPrintf(CTDL_DEBUG, "callback found rev: %s\n", this_rev);
426 /* Perform the patch */
427 fp = popen("patch -f -s -p0 --global-reject-file=/dev/null >/dev/null 2>/dev/null", "w");
429 /* Replace the filenames in the patch with the tempfilename we're actually tweaking */
430 fprintf(fp, "--- %s\n", hecbd->tempfilename);
431 fprintf(fp, "+++ %s\n", hecbd->tempfilename);
433 ptr = (char *)content;
437 ptr = memreadline(ptr, buf, sizeof buf);
440 /* skip the first two lines; they contain bogus filenames */
443 fprintf(fp, "%s\n", buf);
446 } while ((*ptr != 0) && (ptr < ((char*)content + length)));
447 if (pclose(fp) != 0) {
448 CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - patch failed\n");
452 if (!strcasecmp(this_rev, hecbd->stop_when)) {
453 /* Found our target rev. Tell any subsequent callbacks to suppress processing. */
454 CtdlLogPrintf(CTDL_DEBUG, "Target revision has been reached -- stop patching.\n");
461 * Fetch a specific revision of a wiki page. The "operation" string may be set to "fetch" in order
462 * to simply fetch the desired revision and store it in a temporary location for viewing, or "revert"
463 * to revert the currently active page to that revision.
465 void wiki_rev(char *pagename, char *rev, char *operation)
468 char history_page_name[270];
472 struct CtdlMessage *msg;
474 struct HistoryEraserCallBackData hecbd;
478 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
480 if (r == om_not_logged_in) {
481 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
484 cprintf("%d An unknown error has occurred.\n", ERROR);
489 /* Begin by fetching the current version of the page. We're going to patch
490 * backwards through the diffs until we get the one we want.
492 msgnum = CtdlLocateMessageByEuid(pagename, &CC->room);
494 msg = CtdlFetchMessage(msgnum, 1);
500 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
501 CtdlFreeMessage(msg);
506 cprintf("%d Page '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
510 /* Output it to a temporary file */
512 CtdlMakeTempFileName(temp, sizeof temp);
513 fp = fopen(temp, "w");
515 r = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
519 CtdlLogPrintf(CTDL_ALERT, "Cannot open %s: %s\n", temp, strerror(errno));
521 CtdlFreeMessage(msg);
523 /* Get the revision history */
525 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
526 msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
528 msg = CtdlFetchMessage(msgnum, 1);
534 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
535 CtdlFreeMessage(msg);
540 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
544 /* Start patching backwards (newest to oldest) through the revision history until we
545 * hit the revision uuid requested by the user. (The callback will perform each one.)
548 memset(&hecbd, 0, sizeof(struct HistoryEraserCallBackData));
549 hecbd.tempfilename = temp;
550 hecbd.stop_when = rev;
552 mime_parser(msg->cm_fields['M'], NULL, *wiki_rev_callback, NULL, NULL, (void *)&hecbd, 0);
553 CtdlFreeMessage(msg);
555 /* Were we successful? */
556 if (hecbd.done == 0) {
557 cprintf("%d Revision '%s' of page '%s' was not found.\n",
558 ERROR + MESSAGE_NOT_FOUND, rev, pagename
562 /* We have the desired revision on disk. Now do something with it. */
564 else if ( (!strcasecmp(operation, "fetch")) || (!strcasecmp(operation, "revert")) ) {
565 msg = malloc(sizeof(struct CtdlMessage));
566 memset(msg, 0, sizeof(struct CtdlMessage));
567 msg->cm_magic = CTDLMESSAGE_MAGIC;
568 msg->cm_anon_type = MES_NORMAL;
569 msg->cm_format_type = FMT_RFC822;
570 fp = fopen(temp, "r");
572 fseek(fp, 0L, SEEK_END);
574 fseek(fp, 0L, SEEK_SET);
575 msg->cm_fields['M'] = malloc(len + 1);
576 rv = fread(msg->cm_fields['M'], len, 1, fp);
577 CtdlLogPrintf(CTDL_DEBUG, "did %d blocks of %d bytes\n", rv, len);
578 msg->cm_fields['M'][len] = 0;
584 else if (!strcasecmp(operation, "fetch")) {
585 msg->cm_fields['A'] = strdup("Citadel");
586 CtdlCreateRoom(wwm, 5, "", 0, 1, 1, VIEW_BBS); /* Not an error if already exists */
587 msgnum = CtdlSubmitMsg(msg, NULL, wwm, 0); /* Store the revision here */
589 else if (!strcasecmp(operation, "revert")) {
590 snprintf(timestamp, sizeof timestamp, "%ld", time(NULL));
591 msg->cm_fields['T'] = strdup(timestamp);
592 msg->cm_fields['A'] = strdup(CC->user.fullname);
593 msg->cm_fields['F'] = strdup(CC->cs_inet_email);
594 msg->cm_fields['O'] = strdup(CC->room.QRname);
595 msg->cm_fields['N'] = strdup(NODENAME);
596 msg->cm_fields['E'] = strdup(pagename);
597 msgnum = CtdlSubmitMsg(msg, NULL, "", 0); /* Replace the current revision */
600 /* Theoretically it is impossible to get here, but throw an error anyway */
603 CtdlFreeMessage(msg);
605 cprintf("%d %ld\n", CIT_OK, msgnum); /* Give the client a msgnum */
608 cprintf("%d Error %ld has occurred.\n", ERROR+INTERNAL_ERROR, msgnum);
612 /* We did all this work for nothing. Express anguish to the caller. */
614 cprintf("%d An unknown operation was requested.\n", ERROR+CMD_NOT_SUPPORTED);
624 * commands related to wiki management
626 void cmd_wiki(char *argbuf) {
632 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
634 if (!strcasecmp(subcmd, "history")) {
635 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
636 wiki_history(pagename);
640 if (!strcasecmp(subcmd, "rev")) {
641 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
642 extract_token(rev, argbuf, 2, '|', sizeof rev);
643 extract_token(operation, argbuf, 3, '|', sizeof operation);
644 wiki_rev(pagename, rev, operation);
648 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
654 * Module initialization
656 CTDL_MODULE_INIT(wiki)
660 CtdlRegisterMessageHook(wiki_upload_beforesave, EVT_BEFORESAVE);
661 CtdlRegisterProtoHook(cmd_wiki, "WIKI", "Commands related to Wiki management");
664 /* return our Subversion id for the Log */