/*
* $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 "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 (!IsEmptyStr(boundary)) {
snprintf(prefixed_boundary, sizeof prefixed_boundary, "--%s", boundary);
history_msg->cm_fields['M'] = realloc(history_msg->cm_fields['M'],
- strlen(history_msg->cm_fields['M']) + strlen(diffbuf) + 512
+ strlen(history_msg->cm_fields['M']) + strlen(diffbuf) + 1024
);
ptr = bmstrcasestr(history_msg->cm_fields['M'], prefixed_boundary);
if (ptr != NULL) {
char *the_rest_of_it = strdup(ptr);
+ char uuid[32];
+ char memo[512];
+ char encoded_memo[768];
+ generate_uuid(uuid);
+ snprintf(memo, sizeof memo, "%s|%ld|%s|%s",
+ uuid,
+ time(NULL),
+ CCC->user.fullname,
+ config.c_nodename
+ /* no longer logging CCC->cs_inet_email */
+ );
+ CtdlEncodeBase64(encoded_memo, memo, strlen(memo), 0);
sprintf(ptr, "--%s\n"
"Content-type: text/plain\n"
- "From: %s <%s>\n"
+ "Content-Disposition: inline; filename=\"%s\"\n"
+ "Content-Transfer-Encoding: 8bit\n"
"\n"
"%s\n"
"%s"
,
boundary,
- CCC->user.fullname,
- CCC->cs_inet_email,
+ encoded_memo,
diffbuf,
the_rest_of_it
);
}
+/*
+ * MIME Parser callback for wiki_history()
+ *
+ * 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.
+ */
+void wiki_history_callback(char *name, char *filename, char *partnum, char *disp,
+ void *content, char *cbtype, char *cbcharset, size_t length,
+ char *encoding, char *cbid, void *cbuserdata)
+{
+ char memo[1024];
+
+ CtdlDecodeBase64(memo, filename, strlen(filename));
+ cprintf("%s\n", memo);
+}
+
+
+/*
+ * Fetch a list of revisions for a particular wiki page
+ */
+void wiki_history(char *pagename) {
+ int r;
+ char history_page_name[270];
+ long msgnum;
+ struct CtdlMessage *msg;
+
+ r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
+ if (r != om_ok) {
+ if (r == om_not_logged_in) {
+ cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
+ }
+ else {
+ cprintf("%d An unknown error has occurred.\n", ERROR);
+ }
+ return;
+ }
+
+ snprintf(history_page_name, sizeof history_page_name, "%s_HISTORY_", pagename);
+ msgnum = locate_message_by_euid(history_page_name, &CC->room);
+ if (msgnum > 0L) {
+ msg = CtdlFetchMessage(msgnum, 1);
+ }
+ else {
+ msg = NULL;
+ }
+
+ if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
+ CtdlFreeMessage(msg);
+ msg = NULL;
+ }
+
+ if (msg == NULL) {
+ cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
+ return;
+ }
+
+
+ cprintf("%d Revision history for '%s'\n", LISTING_FOLLOWS, pagename);
+ mime_parser(msg->cm_fields['M'], NULL, *wiki_history_callback, NULL, NULL, NULL, 0);
+ cprintf("000\n");
+
+ CtdlFreeMessage(msg);
+ return;
+}
+
+/*
+ * MIME Parser callback for wiki_rev()
+ *
+ * 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,
+ char *encoding, char *cbid, void *cbuserdata)
+{
+ struct HistoryEraserCallBackData *hecbd = (struct HistoryEraserCallBackData *)cbuserdata;
+ char memo[1024];
+ char this_rev[256];
+ FILE *fp;
+ char *ptr = NULL;
+ char buf[1024];
+
+ /* Did a previous callback already indicate that we've reached our target uuid?
+ * If so, don't process anything else.
+ */
+ if (hecbd->done) {
+ return;
+ }
+
+ CtdlDecodeBase64(memo, filename, strlen(filename));
+ extract_token(this_rev, memo, 0, '|', sizeof this_rev);
+ 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");
+ 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", hecbd->tempfilename);
+
+ ptr = (char *)content;
+ int linenum = 0;
+ do {
+ ++linenum;
+ ptr = memreadline(ptr, buf, sizeof buf);
+ if (*ptr != 0) {
+ if (linenum <= 2) {
+ /* skip the first two lines; they contain bogus filenames */
+ }
+ else {
+ fprintf(fp, "%s\n", buf);
+ }
+ }
+ } while ((*ptr != 0) && ((int)ptr < ((int)content + length)));
+ pclose(fp);
+ }
+
+ if (!strcasecmp(this_rev, hecbd->stop_when)) {
+ /* 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. 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, char *operation)
+{
+ int r;
+ char history_page_name[270];
+ long msgnum;
+ char temp[PATH_MAX];
+ struct CtdlMessage *msg;
+ FILE *fp;
+ struct HistoryEraserCallBackData hecbd;
+ int rv;
+
+ r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
+ if (r != om_ok) {
+ if (r == om_not_logged_in) {
+ cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
+ }
+ else {
+ cprintf("%d An unknown error has occurred.\n", ERROR);
+ }
+ return;
+ }
+
+ /* 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);
+ if (msgnum > 0L) {
+ msg = CtdlFetchMessage(msgnum, 1);
+ }
+ else {
+ msg = NULL;
+ }
+
+ if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
+ CtdlFreeMessage(msg);
+ msg = NULL;
+ }
+
+ if (msg == NULL) {
+ cprintf("%d Page '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
+ return;
+ }
+
+ /* Output it to a temporary file */
+
+ CtdlMakeTempFileName(temp, sizeof temp);
+ fp = fopen(temp, "w");
+ if (fp != NULL) {
+ r = fwrite(msg->cm_fields['M'], strlen(msg->cm_fields['M']), 1, fp);
+ fclose(fp);
+ }
+ else {
+ CtdlLogPrintf(CTDL_ALERT, "Cannot open %s: %s\n", temp, strerror(errno));
+ }
+ CtdlFreeMessage(msg);
+
+ /* 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);
+ if (msgnum > 0L) {
+ msg = CtdlFetchMessage(msgnum, 1);
+ }
+ else {
+ msg = NULL;
+ }
+
+ if ((msg != NULL) && (msg->cm_fields['M'] == NULL)) {
+ CtdlFreeMessage(msg);
+ msg = NULL;
+ }
+
+ if (msg == NULL) {
+ cprintf("%d Revision history for '%s' was not found.\n", ERROR+MESSAGE_NOT_FOUND, pagename);
+ 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")) {
+ 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;
+ msg->cm_fields['A'] = strdup("Citadel");
+ fp = fopen(temp, "r");
+ if (fp) {
+ long len;
+ 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);
+ msg->cm_fields['M'][len] = 0;
+ fclose(fp);
+ }
+ CtdlCreateRoom(wwm, 5, "", 0, 1, 1, VIEW_BBS); /* If it already exists, not an error */
+ msgnum = CtdlSubmitMsg(msg, NULL, wwm, 0); /* Store the revision here */
+ CtdlFreeMessage(msg);
+ cprintf("%d %ld\n", CIT_OK, msgnum); /* And give the client a msgnum */
+ }
+
+ else if (!strcasecmp(operation, "revert")) {
+ cprintf("%d FIXME not finished yet, check the log to find out wtf\n", ERROR);
+ }
+
+ /* We did all this work for nothing. Express anguish to the caller. */
+ else {
+ cprintf("%d An unknown operation was requested.\n", ERROR+CMD_NOT_SUPPORTED);
+ }
+
+ unlink(temp);
+ return;
+}
+
+
+
+/*
+ * commands related to wiki management
+ */
+void cmd_wiki(char *argbuf) {
+ char subcmd[32];
+ char pagename[256];
+ char rev[128];
+ char operation[16];
+
+ extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
+
+ if (!strcasecmp(subcmd, "history")) {
+ extract_token(pagename, argbuf, 1, '|', sizeof pagename);
+ wiki_history(pagename);
+ return;
+ }
+
+ if (!strcasecmp(subcmd, "rev")) {
+ extract_token(pagename, argbuf, 1, '|', sizeof pagename);
+ extract_token(rev, argbuf, 2, '|', sizeof rev);
+ extract_token(operation, argbuf, 3, '|', sizeof operation);
+ wiki_rev(pagename, rev, operation);
+ return;
+ }
+
+ cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
+}
+
+
+
/*
* Module initialization
*/
if (!threading)
{
CtdlRegisterMessageHook(wiki_upload_beforesave, EVT_BEFORESAVE);
+ CtdlRegisterProtoHook(cmd_wiki, "WIKI", "Commands related to Wiki management");
}
/* return our Subversion id for the Log */
projects / citadel.git / blobdiff