/*
- * $Id$
- *
- * Server-side module for Wiki rooms. This will handle things like version control.
+ * Server-side module for Wiki rooms. This handles things like version control.
*
* Copyright (c) 2009 by the citadel.org team
*
#include "config.h"
#include "control.h"
#include "user_ops.h"
-#include "policy.h"
#include "database.h"
#include "msgbase.h"
#include "euidindex.h"
#include "ctdl_module.h"
+/*
+ * Data passed back and forth between wiki_rev() and its MIME parser callback
+ */
+struct HistoryEraserCallBackData {
+ char *tempfilename; /* name of temp file being patched */
+ char *stop_when; /* stop when we hit this uuid */
+ int done; /* set to nonzero when we're done patching */
+};
+
+/*
+ * Name of the temporary room we create to store old revisions when someone requests them.
+ * We put it in an invalid namespace so the DAP cleans up after us later.
+ */
+char *wwm = "9999999999.WikiWaybackMachine";
+
/*
* Before allowing a wiki page save to execute, we have to perform version control.
* This involves fetching the old version of the page if it exists.
/* If this isn't a MIME message, don't bother. */
if (msg->cm_format_type != 4) return(0);
- /* If there's no EUID we can't do this. */
- if (msg->cm_fields['E'] == NULL) return(0);
+ /* If there's no EUID we can't do this. Reject the post. */
+ if (msg->cm_fields['E'] == NULL) return(1);
+
snprintf(history_page, sizeof history_page, "%s_HISTORY_", msg->cm_fields['E']);
/* Make sure we're saving a real wiki page rather than a wiki history page.
/* If there's no message text, obviously this is all b0rken and shouldn't happen at all */
if (msg->cm_fields['M'] == NULL) return(0);
+ /* Set the message subject identical to the page name */
+ if (msg->cm_fields['U'] != NULL) {
+ free(msg->cm_fields['U']);
+ }
+ msg->cm_fields['U'] = strdup(msg->cm_fields['E']);
+
/* See if we can retrieve the previous version. */
- old_msgnum = locate_message_by_euid(msg->cm_fields['E'], &CCC->room);
+ old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields['E'], &CCC->room);
if (old_msgnum > 0L) {
old_msg = CtdlFetchMessage(old_msgnum, 1);
}
diffbuf_len += nbytes;
} while (nbytes == 1024);
diffbuf[diffbuf_len] = 0;
- pclose(fp);
+ if (pclose(fp) != 0) {
+ CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - diff failed\n");
+ }
}
CtdlLogPrintf(CTDL_DEBUG, "diff length is %d bytes\n", diffbuf_len);
/* Now look for the existing edit history */
- history_msgnum = locate_message_by_euid(history_page, &CCC->room);
+ history_msgnum = CtdlLocateMessageByEuid(history_page, &CCC->room);
history_msg = NULL;
if (history_msgnum > 0L) {
history_msg = CtdlFetchMessage(history_msgnum, 1);
history_msg->cm_fields['R'] = strdup(CCC->room.QRname);
history_msg->cm_fields['E'] = strdup(history_page);
history_msg->cm_fields['U'] = strdup(history_page);
+ history_msg->cm_fields['1'] = strdup("1"); /* suppress full text indexing */
snprintf(boundary, sizeof boundary, "Citadel--Multipart--%04x--%08lx", getpid(), time(NULL));
history_msg->cm_fields['M'] = malloc(1024);
snprintf(history_msg->cm_fields['M'], 1024,
/* Update the history message (regardless of whether it's new or existing) */
- /* First, figure out the boundary string. We do this even when we generated the
+ /* Remove the Message-ID from the old version of the history message. This will cause a brand
+ * new one to be generated, avoiding an uninitentional hit of the loop zapper when we replicate.
+ */
+ if (history_msg->cm_fields['I'] != NULL) {
+ free(history_msg->cm_fields['I']);
+ }
+
+ /* Figure out the boundary string. We do this even when we generated the
* boundary string in the above code, just to be safe and consistent.
*/
strcpy(boundary, "");
}
snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
- msgnum = locate_message_by_euid(history_page_name, &CC->room);
+ msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
if (msgnum > 0L) {
msg = CtdlFetchMessage(msgnum, 1);
}
return;
}
-
-struct HistoryEraserCallBackData {
- char *tempfilename; /* name of temp file being patched */
- char *stop_when; /* stop when we hit this uuid */
- int done; /* set to nonzero when we're done patching */
-};
-
-
-
/*
* MIME Parser callback for wiki_rev()
*
- * The "filename" field will contain a memo field. All we have to do is decode
- * the base64 and output it. The data is already in a delimited format suitable
- * for our client protocol.
+ * The "filename" field will contain a memo field, which includes (among other things)
+ * the uuid of this revision. After we hit the desired revision, we stop processing.
+ *
+ * The "content" filed will contain "diff" output suitable for applying via "patch"
+ * to our temporary file.
*/
void wiki_rev_callback(char *name, char *filename, char *partnum, char *disp,
void *content, char *cbtype, char *cbcharset, size_t length,
CtdlLogPrintf(CTDL_DEBUG, "callback found rev: %s\n", this_rev);
/* Perform the patch */
- fp = popen("patch -f -s -p0 >/dev/null 2>/dev/null", "w");
+ //fp = popen("patch -f -s -p0 --global-reject-file=/dev/null >/dev/null 2>/dev/null", "w");
+ fp = popen("patch -f -s -p0 --global-reject-file=/dev/null >/dev/null 2>>/tmp/patcherr.txt", "w");
if (fp) {
/* Replace the filenames in the patch with the tempfilename we're actually tweaking */
fprintf(fp, "--- %s\n", hecbd->tempfilename);
fprintf(fp, "%s\n", buf);
}
}
- } while ((*ptr != 0) && ((int)ptr < ((int)content + length)));
- pclose(fp);
+ } while ((*ptr != 0) && (ptr < ((char*)content + length)));
+ if (pclose(fp) != 0) {
+ CtdlLogPrintf(CTDL_ERR, "pclose() returned an error - patch failed\n");
+ }
}
if (!strcasecmp(this_rev, hecbd->stop_when)) {
- CtdlLogPrintf(CTDL_DEBUG, "Found our target rev. Stopping!\n");
+ /* Found our target rev. Tell any subsequent callbacks to suppress processing. */
+ CtdlLogPrintf(CTDL_DEBUG, "Target revision has been reached -- stop patching.\n");
hecbd->done = 1;
}
}
/*
- * Fetch a specific revision of a wiki page
+ * Fetch a specific revision of a wiki page. The "operation" string may be set to "fetch" in order
+ * to simply fetch the desired revision and store it in a temporary location for viewing, or "revert"
+ * to revert the currently active page to that revision.
*/
-void wiki_rev(char *pagename, char *rev)
+void wiki_rev(char *pagename, char *rev, char *operation)
{
int r;
char history_page_name[270];
long msgnum;
char temp[PATH_MAX];
+ char timestamp[64];
struct CtdlMessage *msg;
FILE *fp;
struct HistoryEraserCallBackData hecbd;
+ long len = 0L;
+ int rv;
r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
if (r != om_ok) {
/* Begin by fetching the current version of the page. We're going to patch
* backwards through the diffs until we get the one we want.
*/
- msgnum = locate_message_by_euid(pagename, &CC->room);
+ msgnum = CtdlLocateMessageByEuid(pagename, &CC->room);
if (msgnum > 0L) {
msg = CtdlFetchMessage(msgnum, 1);
}
return;
}
- /* Output it to a file... */
+ /* Output it to a temporary file */
CtdlMakeTempFileName(temp, sizeof temp);
fp = fopen(temp, "w");
}
CtdlFreeMessage(msg);
- /* Now go get the revision history and patch backwards through the diffs until
- * we get to the revision we want.
- */
+ /* Get the revision history */
snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
- msgnum = locate_message_by_euid(history_page_name, &CC->room);
+ msgnum = CtdlLocateMessageByEuid(history_page_name, &CC->room);
if (msgnum > 0L) {
msg = CtdlFetchMessage(msgnum, 1);
}
return;
}
+ /* Start patching backwards (newest to oldest) through the revision history until we
+ * hit the revision uuid requested by the user. (The callback will perform each one.)
+ */
+
memset(&hecbd, 0, sizeof(struct HistoryEraserCallBackData));
hecbd.tempfilename = temp;
hecbd.stop_when = rev;
mime_parser(msg->cm_fields['M'], NULL, *wiki_rev_callback, NULL, NULL, (void *)&hecbd, 0);
CtdlFreeMessage(msg);
+ /* Were we successful? */
if (hecbd.done == 0) {
cprintf("%d Revision '%s' of page '%s' was not found.\n",
ERROR + MESSAGE_NOT_FOUND, rev, pagename
);
}
+
+ /* We have the desired revision on disk. Now do something with it. */
+
+ else if ( (!strcasecmp(operation, "fetch")) || (!strcasecmp(operation, "revert")) ) {
+ msg = malloc(sizeof(struct CtdlMessage));
+ memset(msg, 0, sizeof(struct CtdlMessage));
+ msg->cm_magic = CTDLMESSAGE_MAGIC;
+ msg->cm_anon_type = MES_NORMAL;
+ msg->cm_format_type = FMT_RFC822;
+ fp = fopen(temp, "r");
+ if (fp) {
+ fseek(fp, 0L, SEEK_END);
+ len = ftell(fp);
+ fseek(fp, 0L, SEEK_SET);
+ msg->cm_fields['M'] = malloc(len + 1);
+ rv = fread(msg->cm_fields['M'], len, 1, fp);
+ CtdlLogPrintf(CTDL_DEBUG, "did %d blocks of %ld bytes\n", rv, len);
+ msg->cm_fields['M'][len] = 0;
+ fclose(fp);
+ }
+ if (len <= 0) {
+ msgnum = (-1L);
+ }
+ else if (!strcasecmp(operation, "fetch")) {
+ msg->cm_fields['A'] = strdup("Citadel");
+ CtdlCreateRoom(wwm, 5, "", 0, 1, 1, VIEW_BBS); /* Not an error if already exists */
+ msgnum = CtdlSubmitMsg(msg, NULL, wwm, 0); /* Store the revision here */
+ }
+ else if (!strcasecmp(operation, "revert")) {
+ snprintf(timestamp, sizeof timestamp, "%ld", time(NULL));
+ msg->cm_fields['T'] = strdup(timestamp);
+ msg->cm_fields['A'] = strdup(CC->user.fullname);
+ msg->cm_fields['F'] = strdup(CC->cs_inet_email);
+ msg->cm_fields['O'] = strdup(CC->room.QRname);
+ msg->cm_fields['N'] = strdup(NODENAME);
+ msg->cm_fields['E'] = strdup(pagename);
+ msgnum = CtdlSubmitMsg(msg, NULL, "", 0); /* Replace the current revision */
+ }
+ else {
+ /* Theoretically it is impossible to get here, but throw an error anyway */
+ msgnum = (-1L);
+ }
+ CtdlFreeMessage(msg);
+ if (msgnum >= 0L) {
+ cprintf("%d %ld\n", CIT_OK, msgnum); /* Give the client a msgnum */
+ }
+ else {
+ cprintf("%d Error %ld has occurred.\n", ERROR+INTERNAL_ERROR, msgnum);
+ }
+ }
+
+ /* We did all this work for nothing. Express anguish to the caller. */
else {
- cprintf("%d FIXME not finished yet, check the log to find out wtf\n", ERROR);
+ cprintf("%d An unknown operation was requested.\n", ERROR+CMD_NOT_SUPPORTED);
}
- /* unlink(temp); FIXME uncomment this when we're done. reverted page is now sitting in /tmp */
+ unlink(temp);
return;
}
char subcmd[32];
char pagename[256];
char rev[128];
+ char operation[16];
extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
if (!strcasecmp(subcmd, "rev")) {
extract_token(pagename, argbuf, 1, '|', sizeof pagename);
extract_token(rev, argbuf, 2, '|', sizeof rev);
- wiki_rev(pagename, rev);
+ extract_token(operation, argbuf, 3, '|', sizeof operation);
+ wiki_rev(pagename, rev, operation);
return;
}
}
/* return our Subversion id for the Log */
- return "$Id$";
+ return "wiki";
}
projects / citadel.git / blobdiff