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;
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. */
112 if (msg->cm_fields['E'] == NULL) return(0);
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 /* See if we can retrieve the previous version. */
129 old_msgnum = locate_message_by_euid(msg->cm_fields['E'], &CCC->room);
130 if (old_msgnum > 0L) {
131 old_msg = CtdlFetchMessage(old_msgnum, 1);
137 if ((old_msg != NULL) && (old_msg->cm_fields['M'] == NULL)) { /* old version is corrupt? */
138 CtdlFreeMessage(old_msg);
142 /* If no changes were made, don't bother saving it again */
143 if ((old_msg != NULL) && (!strcmp(msg->cm_fields['M'], old_msg->cm_fields['M']))) {
144 CtdlFreeMessage(old_msg);
151 CtdlMakeTempFileName(diff_old_filename, sizeof diff_old_filename);
152 CtdlMakeTempFileName(diff_new_filename, sizeof diff_new_filename);
154 if (old_msg != NULL) {
155 fp = fopen(diff_old_filename, "w");
156 rv = fwrite(old_msg->cm_fields['M'], strlen(old_msg->cm_fields['M']), 1, fp);
158 CtdlFreeMessage(old_msg);
161 fp = fopen(diff_new_filename, "w");
162 rv = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
167 snprintf(diff_cmd, sizeof diff_cmd,
170 ((old_msg != NULL) ? diff_old_filename : "/dev/null")
172 fp = popen(diff_cmd, "r");
175 diffbuf = realloc(diffbuf, diffbuf_len + 1025);
176 nbytes = fread(&diffbuf[diffbuf_len], 1, 1024, fp);
177 diffbuf_len += nbytes;
178 } while (nbytes == 1024);
179 diffbuf[diffbuf_len] = 0;
182 CtdlLogPrintf(CTDL_DEBUG, "diff length is %d bytes\n", diffbuf_len);
184 unlink(diff_old_filename);
185 unlink(diff_new_filename);
187 /* Determine whether this was a bogus (empty) edit */
188 if ((diffbuf_len = 0) && (diffbuf != NULL)) {
192 if (diffbuf == NULL) {
193 return(1); /* No changes at all? Abandon the post entirely! */
196 /* Now look for the existing edit history */
198 history_msgnum = locate_message_by_euid(history_page, &CCC->room);
200 if (history_msgnum > 0L) {
201 history_msg = CtdlFetchMessage(history_msgnum, 1);
204 /* Create a new history message if necessary */
205 if (history_msg == NULL) {
206 history_msg = malloc(sizeof(struct CtdlMessage));
207 memset(history_msg, 0, sizeof(struct CtdlMessage));
208 history_msg->cm_magic = CTDLMESSAGE_MAGIC;
209 history_msg->cm_anon_type = MES_NORMAL;
210 history_msg->cm_format_type = FMT_RFC822;
211 history_msg->cm_fields['A'] = strdup("Citadel");
212 history_msg->cm_fields['R'] = strdup(CCC->room.QRname);
213 history_msg->cm_fields['E'] = strdup(history_page);
214 history_msg->cm_fields['U'] = strdup(history_page);
215 snprintf(boundary, sizeof boundary, "Citadel--Multipart--%04x--%08lx", getpid(), time(NULL));
216 history_msg->cm_fields['M'] = malloc(1024);
217 snprintf(history_msg->cm_fields['M'], 1024,
218 "Content-type: multipart/mixed; boundary=\"%s\"\n\n"
219 "This is a Citadel wiki history encoded as multipart MIME.\n"
220 "Each part is comprised of a diff script representing one change set.\n"
228 /* Update the history message (regardless of whether it's new or existing) */
230 /* First, figure out the boundary string. We do this even when we generated the
231 * boundary string in the above code, just to be safe and consistent.
233 strcpy(boundary, "");
235 ptr = history_msg->cm_fields['M'];
237 ptr = memreadline(ptr, buf, sizeof buf);
240 if (!IsEmptyStr(buf) && (!strncasecmp(buf, "Content-type:", 13))) {
242 (bmstrcasestr(buf, "multipart") != NULL)
243 && (bmstrcasestr(buf, "boundary=") != NULL)
245 safestrncpy(boundary, bmstrcasestr(buf, "\""), sizeof boundary);
247 qu = strchr(boundary, '\"');
249 strcpy(boundary, ++qu);
251 qu = strchr(boundary, '\"');
258 } while ( (IsEmptyStr(boundary)) && (*ptr != 0) );
260 /* Now look for the first boundary. That is where we need to insert our fun.
262 if (!IsEmptyStr(boundary)) {
263 snprintf(prefixed_boundary, sizeof prefixed_boundary, "--%s", boundary);
264 history_msg->cm_fields['M'] = realloc(history_msg->cm_fields['M'],
265 strlen(history_msg->cm_fields['M']) + strlen(diffbuf) + 1024
267 ptr = bmstrcasestr(history_msg->cm_fields['M'], prefixed_boundary);
269 char *the_rest_of_it = strdup(ptr);
272 char encoded_memo[768];
274 snprintf(memo, sizeof memo, "%s|%ld|%s|%s",
279 /* no longer logging CCC->cs_inet_email */
281 CtdlEncodeBase64(encoded_memo, memo, strlen(memo), 0);
282 sprintf(ptr, "--%s\n"
283 "Content-type: text/plain\n"
284 "Content-Disposition: inline; filename=\"%s\"\n"
285 "Content-Transfer-Encoding: 8bit\n"
295 free(the_rest_of_it);
298 history_msg->cm_fields['T'] = realloc(history_msg->cm_fields['T'], 32);
299 snprintf(history_msg->cm_fields['T'], 32, "%ld", time(NULL));
301 CtdlSubmitMsg(history_msg, NULL, "", 0);
304 CtdlLogPrintf(CTDL_ALERT, "Empty boundary string in history message. No history!\n");
314 * MIME Parser callback for wiki_history()
316 * The "filename" field will contain a memo field. All we have to do is decode
317 * the base64 and output it. The data is already in a delimited format suitable
318 * for our client protocol.
320 void wiki_history_callback(char *name, char *filename, char *partnum, char *disp,
321 void *content, char *cbtype, char *cbcharset, size_t length,
322 char *encoding, char *cbid, void *cbuserdata)
326 CtdlDecodeBase64(memo, filename, strlen(filename));
327 cprintf("%s\n", memo);
332 * Fetch a list of revisions for a particular wiki page
334 void wiki_history(char *pagename) {
336 char history_page_name[270];
338 struct CtdlMessage *msg;
340 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
342 if (r == om_not_logged_in) {
343 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
346 cprintf("%d An unknown error has occurred.\n", ERROR);
351 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
352 msgnum = locate_message_by_euid(history_page_name, &CC->room);
354 msg = CtdlFetchMessage(msgnum, 1);
360 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
361 CtdlFreeMessage(msg);
366 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
371 cprintf("%d Revision history for '%s'\n", LISTING_FOLLOWS, pagename);
372 mime_parser(msg->cm_fields['M'], NULL, *wiki_history_callback, NULL, NULL, NULL, 0);
375 CtdlFreeMessage(msg);
380 * MIME Parser callback for wiki_rev()
382 * The "filename" field will contain a memo field, which includes (among other things)
383 * the uuid of this revision. After we hit the desired revision, we stop processing.
385 * The "content" filed will contain "diff" output suitable for applying via "patch"
386 * to our temporary file.
388 void wiki_rev_callback(char *name, char *filename, char *partnum, char *disp,
389 void *content, char *cbtype, char *cbcharset, size_t length,
390 char *encoding, char *cbid, void *cbuserdata)
392 struct HistoryEraserCallBackData *hecbd = (struct HistoryEraserCallBackData *)cbuserdata;
399 /* Did a previous callback already indicate that we've reached our target uuid?
400 * If so, don't process anything else.
406 CtdlDecodeBase64(memo, filename, strlen(filename));
407 extract_token(this_rev, memo, 0, '|', sizeof this_rev);
408 CtdlLogPrintf(CTDL_DEBUG, "callback found rev: %s\n", this_rev);
410 /* Perform the patch */
411 fp = popen("patch -f -s -p0 >/dev/null 2>/dev/null", "w");
413 /* Replace the filenames in the patch with the tempfilename we're actually tweaking */
414 fprintf(fp, "--- %s\n", hecbd->tempfilename);
415 fprintf(fp, "+++ %s\n", hecbd->tempfilename);
417 ptr = (char *)content;
421 ptr = memreadline(ptr, buf, sizeof buf);
424 /* skip the first two lines; they contain bogus filenames */
427 fprintf(fp, "%s\n", buf);
430 } while ((*ptr != 0) && ((int)ptr < ((int)content + length)));
434 if (!strcasecmp(this_rev, hecbd->stop_when)) {
435 /* Found our target rev. Tell any subsequent callbacks to suppress processing. */
436 CtdlLogPrintf(CTDL_DEBUG, "Target revision has been reached -- stop patching.\n");
443 * Fetch a specific revision of a wiki page. The "operation" string may be set to "fetch" in order
444 * to simply fetch the desired revision and store it in a temporary location for viewing, or "revert"
445 * to revert the currently active page to that revision.
447 void wiki_rev(char *pagename, char *rev, char *operation)
450 char history_page_name[270];
453 struct CtdlMessage *msg;
455 struct HistoryEraserCallBackData hecbd;
459 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
461 if (r == om_not_logged_in) {
462 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
465 cprintf("%d An unknown error has occurred.\n", ERROR);
470 /* Begin by fetching the current version of the page. We're going to patch
471 * backwards through the diffs until we get the one we want.
473 msgnum = locate_message_by_euid(pagename, &CC->room);
475 msg = CtdlFetchMessage(msgnum, 1);
481 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
482 CtdlFreeMessage(msg);
487 cprintf("%d Page '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
491 /* Output it to a temporary file */
493 CtdlMakeTempFileName(temp, sizeof temp);
494 fp = fopen(temp, "w");
496 r = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
500 CtdlLogPrintf(CTDL_ALERT, "Cannot open %s: %s\n", temp, strerror(errno));
502 CtdlFreeMessage(msg);
504 /* Get the revision history */
506 snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
507 msgnum = locate_message_by_euid(history_page_name, &CC->room);
509 msg = CtdlFetchMessage(msgnum, 1);
515 if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
516 CtdlFreeMessage(msg);
521 cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
525 /* Start patching backwards (newest to oldest) through the revision history until we
526 * hit the revision uuid requested by the user. (The callback will perform each one.)
529 memset(&hecbd, 0, sizeof(struct HistoryEraserCallBackData));
530 hecbd.tempfilename = temp;
531 hecbd.stop_when = rev;
533 mime_parser(msg->cm_fields['M'], NULL, *wiki_rev_callback, NULL, NULL, (void *)&hecbd, 0);
534 CtdlFreeMessage(msg);
536 /* Were we successful? */
537 if (hecbd.done == 0) {
538 cprintf("%d Revision '%s' of page '%s' was not found.\n",
539 ERROR + MESSAGE_NOT_FOUND, rev, pagename
543 /* We have the desired revision on disk. Now do something with it. */
545 else if (!strcasecmp(operation, "fetch")) {
546 msg = malloc(sizeof(struct CtdlMessage));
547 memset(msg, 0, sizeof(struct CtdlMessage));
548 msg->cm_magic = CTDLMESSAGE_MAGIC;
549 msg->cm_anon_type = MES_NORMAL;
550 msg->cm_format_type = FMT_RFC822;
551 msg->cm_fields['A'] = strdup("Citadel");
552 fp = fopen(temp, "r");
554 fseek(fp, 0L, SEEK_END);
556 fseek(fp, 0L, SEEK_SET);
557 msg->cm_fields['M'] = malloc(len + 1);
558 rv = fread(msg->cm_fields['M'], len, 1, fp);
559 CtdlLogPrintf(CTDL_DEBUG, "\033[32mdid %d blocks of %d bytes\033[0m\n", rv, len);
560 msg->cm_fields['M'][len] = 0;
563 CtdlCreateRoom(wwm, 5, "", 0, 1, 1, VIEW_BBS); /* If it already exists, not an error */
564 msgnum = CtdlSubmitMsg(msg, NULL, wwm, 0); /* Store the revision here */
565 CtdlFreeMessage(msg);
566 cprintf("%d %ld\n", CIT_OK, msgnum); /* And give the client a msgnum */
569 else if (!strcasecmp(operation, "revert")) {
570 msg = malloc(sizeof(struct CtdlMessage));
571 memset(msg, 0, sizeof(struct CtdlMessage));
572 msg->cm_magic = CTDLMESSAGE_MAGIC;
573 msg->cm_anon_type = MES_NORMAL;
574 msg->cm_format_type = FMT_RFC822;
575 msg->cm_fields['A'] = strdup(CC->user.fullname);
576 msg->cm_fields['F'] = strdup(CC->cs_inet_email);
577 msg->cm_fields['O'] = strdup(CC->room.QRname);
578 msg->cm_fields['N'] = strdup(NODENAME);
579 msg->cm_fields['E'] = strdup(pagename);
581 fp = fopen(temp, "r");
583 fseek(fp, 0L, SEEK_END);
585 fseek(fp, 0L, SEEK_SET);
586 msg->cm_fields['M'] = malloc(len + 1);
587 rv = fread(msg->cm_fields['M'], len, 1, fp);
588 CtdlLogPrintf(CTDL_DEBUG, "\033[31mdid %d blocks of %d bytes\033[0m\n", rv, len);
589 msg->cm_fields['M'][len] = 0;
592 msgnum = CtdlSubmitMsg(msg, NULL, "", 0); /* Store it back into the room */
593 CtdlFreeMessage(msg);
595 cprintf("%d %ld\n", CIT_OK, msgnum); /* And give the client a msgnum */
598 cprintf("%d An internal error has occurred.\n", ERROR+INTERNAL_ERROR);
602 /* We did all this work for nothing. Express anguish to the caller. */
604 cprintf("%d An unknown operation was requested.\n", ERROR+CMD_NOT_SUPPORTED);
614 * commands related to wiki management
616 void cmd_wiki(char *argbuf) {
622 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
624 if (!strcasecmp(subcmd, "history")) {
625 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
626 wiki_history(pagename);
630 if (!strcasecmp(subcmd, "rev")) {
631 extract_token(pagename, argbuf, 1, '|', sizeof pagename);
632 extract_token(rev, argbuf, 2, '|', sizeof rev);
633 extract_token(operation, argbuf, 3, '|', sizeof operation);
634 wiki_rev(pagename, rev, operation);
638 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
644 * Module initialization
646 CTDL_MODULE_INIT(wiki)
650 CtdlRegisterMessageHook(wiki_upload_beforesave, EVT_BEFORESAVE);
651 CtdlRegisterProtoHook(cmd_wiki, "WIKI", "Commands related to Wiki management");
654 /* return our Subversion id for the Log */