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"
59 #include "euidindex.h"
60 #include "ctdl_module.h"
63 * Data passed back and forth between wiki_rev() and its MIME parser callback
65 struct HistoryEraserCallBackData {
66 char *tempfilename; /* name of temp file being patched */
67 char *stop_when; /* stop when we hit this uuid */
68 int done; /* set to nonzero when we're done patching */
72 * Name of the temporary room we create to store old revisions when someone requests them.
73 * We put it in an invalid namespace so the DAP cleans up after us later.
75 char *wwm = "9999999999.WikiWaybackMachine";
78 * Before allowing a wiki page save to execute, we have to perform version control.
79 * This involves fetching the old version of the page if it exists.
81 int wiki_upload_beforesave(struct CtdlMessage *msg) {
82 struct CitContext *CCC = CC;
83 long old_msgnum = (-1L);
84 struct CtdlMessage *old_msg = NULL;
85 long history_msgnum = (-1L);
86 struct CtdlMessage *history_msg = NULL;
87 char diff_old_filename[PATH_MAX];
88 char diff_new_filename[PATH_MAX];
89 char diff_cmd[PATH_MAX];
92 char history_page[1024];
94 char prefixed_boundary[258];
98 size_t diffbuf_len = 0;
99 const char *ptr = NULL;
101 if (!CCC->logged_in) return(0); /* Only do this if logged in. */
103 /* Is this a room with a Wiki in it, don't run this hook. */
104 if (CCC->room.QRdefaultview != VIEW_WIKI) {
108 /* If this isn't a MIME message, don't bother. */
109 if (msg->cm_format_type != 4) return(0);
111 /* If there's no EUID we can't do this. Reject the post. */
112 if (msg->cm_fields['E'] == NULL) return(1);
114 snprintf(history_page, sizeof history_page, "%s_HISTORY_", msg->cm_fields['E']);
116 /* Make sure we're saving a real wiki page rather than a wiki history page.
117 * This is important in order to avoid recursing infinitely into this hook.
119 if ( (strlen(msg->cm_fields['E']) >= 9)
120 && (!strcasecmp(&msg->cm_fields['E'][strlen(msg->cm_fields['E'])-9], "_HISTORY_"))
122 CtdlLogPrintf(CTDL_DEBUG, "History page not being historied\n");
126 /* If there's no message text, obviously this is all b0rken and shouldn't happen at all */
127 if (msg->cm_fields['M'] == NULL) return(0);
129 /* Set the message subject identical to the page name */
130 if (msg->cm_fields['U'] != NULL) {
131 free(msg->cm_fields['U']);
133 msg->cm_fields['U'] = strdup(msg->cm_fields['E']);
135 /* See if we can retrieve the previous version. */
136 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields['E'], &CCC->room);
137 if (old_msgnum > 0L) {
138 old_msg = CtdlFetchMessage(old_msgnum, 1);
144 if ((old_msg != NULL) && (old_msg->cm_fields['M'] == NULL)) { /* old version is corrupt? */
145 CtdlFreeMessage(old_msg);
149 /* If no changes were made, don't bother saving it again */
150 if ((old_msg != NULL) && (!strcmp(msg->cm_fields['M'], old_msg->cm_fields['M']))) {
151 CtdlFreeMessage(old_msg);
158 CtdlMakeTempFileName(diff_old_filename, sizeof diff_old_filename);
159 CtdlMakeTempFileName(diff_new_filename, sizeof diff_new_filename);
161 if (old_msg != NULL) {
162 fp = fopen(diff_old_filename, "w");
163 rv = fwrite(old_msg->cm_fields['M'], strlen(old_msg->cm_fields['M']), 1, fp);
165 CtdlFreeMessage(old_msg);
168 fp = fopen(diff_new_filename, "w");
169 rv = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
174 snprintf(diff_cmd, sizeof diff_cmd,
177 ((old_msg != NULL) ? diff_old_filename : "/dev/null")
179 fp = popen(diff_cmd, "r");
182 diffbuf = realloc(diffbuf, diffbuf_len + 1025);
183 nbytes = fread(&diffbuf[diffbuf_len], 1, 1024, fp);
184 diffbuf_len += nbytes;
185 } while (nbytes == 1024);
186 diffbuf[diffbuf_len] = 0;
187 if (pclose(fp) != 0) {
188 CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - diff failed\n");
191 CtdlLogPrintf(CTDL_DEBUG, "diff length is %d bytes\n", diffbuf_len);
193 unlink(diff_old_filename);
194 unlink(diff_new_filename);
196 /* Determine whether this was a bogus (empty) edit */
197 if ((diffbuf_len = 0) && (diffbuf != NULL)) {
201 if (diffbuf == NULL) {
202 return(1); /* No changes at all? Abandon the post entirely! */
205 /* Now look for the existing edit history */
207 history_msgnum = CtdlLocateMessageByEuid(history_page, &CCC->room);
209 if (history_msgnum > 0L) {
210 history_msg = CtdlFetchMessage(history_msgnum, 1);
213 /* Create a new history message if necessary */
214 if (history_msg == NULL) {
215 history_msg = malloc(sizeof(struct CtdlMessage));
216 memset(history_msg, 0, sizeof(struct CtdlMessage));
217 history_msg->cm_magic = CTDLMESSAGE_MAGIC;
218 history_msg->cm_anon_type = MES_NORMAL;
219 history_msg->cm_format_type = FMT_RFC822;
220 history_msg->cm_fields['A'] = strdup("Citadel");
221 history_msg->cm_fields['R'] = strdup(CCC->room.QRname);
222 history_msg->cm_fields['E'] = strdup(history_page);
223 history_msg->cm_fields['U'] = strdup(history_page);
224 history_msg->cm_fields['1'] = strdup("1"); /* suppress full text indexing */
225 snprintf(boundary, sizeof boundary, "Citadel--Multipart--%04x--%08lx", getpid(), time(NULL));
226 history_msg->cm_fields['M'] = malloc(1024);
227 snprintf(history_msg->cm_fields['M'], 1024,
228 "Content-type: multipart/mixed; boundary=\"%s\"\n\n"
229 "This is a Citadel wiki history encoded as multipart MIME.\n"
230 "Each part is comprised of a diff script representing one change set.\n"
238 /* Update the history message (regardless of whether it's new or existing) */
240 /* Remove the Message-ID from the old version of the history message. This will cause a brand
241 * new one to be generated, avoiding an uninitentional hit of the loop zapper when we replicate.
243 if (history_msg->cm_fields['I'] != NULL) {
244 free(history_msg->cm_fields['I']);
247 /* Figure out the boundary string. We do this even when we generated the
248 * boundary string in the above code, just to be safe and consistent.
250 strcpy(boundary, "");
252 ptr = history_msg->cm_fields['M'];
254 ptr = memreadline(ptr, buf, sizeof buf);
257 if (!IsEmptyStr(buf) && (!strncasecmp(buf, "Content-type:", 13))) {
259 (bmstrcasestr(buf, "multipart") != NULL)
260 && (bmstrcasestr(buf, "boundary=") != NULL)
262 safestrncpy(boundary, bmstrcasestr(buf, "\""), sizeof boundary);
264 qu = strchr(boundary, '\"');
266 strcpy(boundary, ++qu);
268 qu = strchr(boundary, '\"');
275 } while ( (IsEmptyStr(boundary)) && (*ptr != 0) );
277 /* Now look for the first boundary. That is where we need to insert our fun.
279 if (!IsEmptyStr(boundary)) {
280 snprintf(prefixed_boundary, sizeof prefixed_boundary, "--%s", boundary);
281 history_msg->cm_fields['M'] = realloc(history_msg->cm_fields['M'],
282 strlen(history_msg->cm_fields['M']) + strlen(diffbuf) + 1024
284 ptr = bmstrcasestr(history_msg->cm_fields['M'], prefixed_boundary);
286 char *the_rest_of_it = strdup(ptr);
289 char encoded_memo[768];
291 snprintf(memo, sizeof memo, "%s|%ld|%s|%s",
296 /* no longer logging CCC->cs_inet_email */
298 CtdlEncodeBase64(encoded_memo, memo, strlen(memo), 0);
299 sprintf(ptr, "--%s\n"
300 "Content-type: text/plain\n"
301 "Content-Disposition: inline; filename=\"%s\"\n"
302 "Content-Transfer-Encoding: 8bit\n"
312 free(the_rest_of_it);
315 history_msg->cm_fields['T'] = realloc(history_msg->cm_fields['T'], 32);
316 snprintf(history_msg->cm_fields['T'], 32, "%ld", time(NULL));
318 CtdlSubmitMsg(history_msg, NULL, "", 0);
321 CtdlLogPrintf(CTDL_ALERT, "Empty boundary string in history message. No history!\n");
331 * MIME Parser callback for wiki_history()
333 * The "filename" field will contain a memo field. All we have to do is decode
334 * the base64 and output it. The data is already in a delimited format suitable
335 * for our client protocol.
337 void wiki_history_callback(char *name, char *filename, char *partnum, char *disp,
338 void *content, char *cbtype, char *cbcharset, size_t length,
339 char *encoding, char *cbid, void *cbuserdata)
343 CtdlDecodeBase64(memo, filename, strlen(filename));
344 cprintf("%s\n", memo);
349 * Fetch a list of revisions for a particular wiki page
351 void wiki_history(char *pagename) {
353 char history_page_name[270];
355 struct CtdlMessage *msg;
357 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
359 if (r == om_not_logged_in) {
360 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
363 cprintf("%d An unknown error has occurred.\n", ERROR);
368 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
369 msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
371 msg = CtdlFetchMessage(msgnum, 1);
377 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
378 CtdlFreeMessage(msg);
383 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
388 cprintf("%d Revision history for '%s'\n", LISTING_FOLLOWS, pagename);
389 mime_parser(msg->cm_fields['M'], NULL, *wiki_history_callback, NULL, NULL, NULL, 0);
392 CtdlFreeMessage(msg);
397 * MIME Parser callback for wiki_rev()
399 * The "filename" field will contain a memo field, which includes (among other things)
400 * the uuid of this revision. After we hit the desired revision, we stop processing.
402 * The "content" filed will contain "diff" output suitable for applying via "patch"
403 * to our temporary file.
405 void wiki_rev_callback(char *name, char *filename, char *partnum, char *disp,
406 void *content, char *cbtype, char *cbcharset, size_t length,
407 char *encoding, char *cbid, void *cbuserdata)
409 struct HistoryEraserCallBackData *hecbd = (struct HistoryEraserCallBackData *)cbuserdata;
416 /* Did a previous callback already indicate that we've reached our target uuid?
417 * If so, don't process anything else.
423 CtdlDecodeBase64(memo, filename, strlen(filename));
424 extract_token(this_rev, memo, 0, '|', sizeof this_rev);
425 CtdlLogPrintf(CTDL_DEBUG, "callback found rev: %s\n", this_rev);
427 /* Perform the patch */
428 fp = popen("patch -f -s -p0 --global-reject-file=/dev/null >/dev/null 2>/dev/null", "w");
430 /* Replace the filenames in the patch with the tempfilename we're actually tweaking */
431 fprintf(fp, "--- %s\n", hecbd->tempfilename);
432 fprintf(fp, "+++ %s\n", hecbd->tempfilename);
434 ptr = (char *)content;
438 ptr = memreadline(ptr, buf, sizeof buf);
441 /* skip the first two lines; they contain bogus filenames */
444 fprintf(fp, "%s\n", buf);
447 } while ((*ptr != 0) && (ptr < ((char*)content + length)));
448 if (pclose(fp) != 0) {
449 CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - patch failed\n");
453 if (!strcasecmp(this_rev, hecbd->stop_when)) {
454 /* Found our target rev. Tell any subsequent callbacks to suppress processing. */
455 CtdlLogPrintf(CTDL_DEBUG, "Target revision has been reached -- stop patching.\n");
462 * Fetch a specific revision of a wiki page. The "operation" string may be set to "fetch" in order
463 * to simply fetch the desired revision and store it in a temporary location for viewing, or "revert"
464 * to revert the currently active page to that revision.
466 void wiki_rev(char *pagename, char *rev, char *operation)
469 char history_page_name[270];
473 struct CtdlMessage *msg;
475 struct HistoryEraserCallBackData hecbd;
479 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
481 if (r == om_not_logged_in) {
482 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
485 cprintf("%d An unknown error has occurred.\n", ERROR);
490 /* Begin by fetching the current version of the page. We're going to patch
491 * backwards through the diffs until we get the one we want.
493 msgnum = CtdlLocateMessageByEuid(pagename, &CC->room);
495 msg = CtdlFetchMessage(msgnum, 1);
501 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
502 CtdlFreeMessage(msg);
507 cprintf("%d Page '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
511 /* Output it to a temporary file */
513 CtdlMakeTempFileName(temp, sizeof temp);
514 fp = fopen(temp, "w");
516 r = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
520 CtdlLogPrintf(CTDL_ALERT, "Cannot open %s: %s\n", temp, strerror(errno));
522 CtdlFreeMessage(msg);
524 /* Get the revision history */
526 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
527 msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
529 msg = CtdlFetchMessage(msgnum, 1);
535 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
536 CtdlFreeMessage(msg);
541 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
545 /* Start patching backwards (newest to oldest) through the revision history until we
546 * hit the revision uuid requested by the user. (The callback will perform each one.)
549 memset(&hecbd, 0, sizeof(struct HistoryEraserCallBackData));
550 hecbd.tempfilename = temp;
551 hecbd.stop_when = rev;
553 mime_parser(msg->cm_fields['M'], NULL, *wiki_rev_callback, NULL, NULL, (void *)&hecbd, 0);
554 CtdlFreeMessage(msg);
556 /* Were we successful? */
557 if (hecbd.done == 0) {
558 cprintf("%d Revision '%s' of page '%s' was not found.\n",
559 ERROR + MESSAGE_NOT_FOUND, rev, pagename
563 /* We have the desired revision on disk. Now do something with it. */
565 else if ( (!strcasecmp(operation, "fetch")) || (!strcasecmp(operation, "revert")) ) {
566 msg = malloc(sizeof(struct CtdlMessage));
567 memset(msg, 0, sizeof(struct CtdlMessage));
568 msg->cm_magic = CTDLMESSAGE_MAGIC;
569 msg->cm_anon_type = MES_NORMAL;
570 msg->cm_format_type = FMT_RFC822;
571 fp = fopen(temp, "r");
573 fseek(fp, 0L, SEEK_END);
575 fseek(fp, 0L, SEEK_SET);
576 msg->cm_fields['M'] = malloc(len + 1);
577 rv = fread(msg->cm_fields['M'], len, 1, fp);
578 CtdlLogPrintf(CTDL_DEBUG, "did %d blocks of %d bytes\n", rv, len);
579 msg->cm_fields['M'][len] = 0;
585 else if (!strcasecmp(operation, "fetch")) {
586 msg->cm_fields['A'] = strdup("Citadel");
587 CtdlCreateRoom(wwm, 5, "", 0, 1, 1, VIEW_BBS); /* Not an error if already exists */
588 msgnum = CtdlSubmitMsg(msg, NULL, wwm, 0); /* Store the revision here */
590 else if (!strcasecmp(operation, "revert")) {
591 snprintf(timestamp, sizeof timestamp, "%ld", time(NULL));
592 msg->cm_fields['T'] = strdup(timestamp);
593 msg->cm_fields['A'] = strdup(CC->user.fullname);
594 msg->cm_fields['F'] = strdup(CC->cs_inet_email);
595 msg->cm_fields['O'] = strdup(CC->room.QRname);
596 msg->cm_fields['N'] = strdup(NODENAME);
597 msg->cm_fields['E'] = strdup(pagename);
598 msgnum = CtdlSubmitMsg(msg, NULL, "", 0); /* Replace the current revision */
601 /* Theoretically it is impossible to get here, but throw an error anyway */
604 CtdlFreeMessage(msg);
606 cprintf("%d %ld\n", CIT_OK, msgnum); /* Give the client a msgnum */
609 cprintf("%d Error %ld has occurred.\n", ERROR+INTERNAL_ERROR, msgnum);
613 /* We did all this work for nothing. Express anguish to the caller. */
615 cprintf("%d An unknown operation was requested.\n", ERROR+CMD_NOT_SUPPORTED);
625 * commands related to wiki management
627 void cmd_wiki(char *argbuf) {
633 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
635 if (!strcasecmp(subcmd, "history")) {
636 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
637 wiki_history(pagename);
641 if (!strcasecmp(subcmd, "rev")) {
642 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
643 extract_token(rev, argbuf, 2, '|', sizeof rev);
644 extract_token(operation, argbuf, 3, '|', sizeof operation);
645 wiki_rev(pagename, rev, operation);
649 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
655 * Module initialization
657 CTDL_MODULE_INIT(wiki)
661 CtdlRegisterMessageHook(wiki_upload_beforesave, EVT_BEFORESAVE);
662 CtdlRegisterProtoHook(cmd_wiki, "WIKI", "Commands related to Wiki management");
665 /* return our Subversion id for the Log */