/* unexpunge.c -- Program to unexpunge messages
*
* Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name "Carnegie Mellon University" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For permission or any legal
* details, please contact
* Carnegie Mellon University
* Center for Technology Transfer and Enterprise Creation
* 4615 Forbes Avenue
* Suite 302
* Pittsburgh, PA 15213
* (412) 268-7393, fax: (412) 268-7395
* innovation@andrew.cmu.edu
*
* 4. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by Computing Services
* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
*
* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <config.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <getopt.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sysexits.h>
#include <syslog.h>
#include <signal.h>
#include "annotate.h"
#include "global.h"
#include "index.h"
#include "libcyr_cfg.h"
#include "map.h"
#include "mailbox.h"
#include "mboxlist.h"
#include "util.h"
#include "xmalloc.h"
#include "sync_log.h"
/* generated headers are not necessarily in current directory */
#include "imap/imap_err.h"
/* current namespace */
static struct namespace unex_namespace;
static int verbose = 0;
static int unsetdeleted = 0;
static const char *addflag = NULL;
static void usage(void)
{
fprintf(stderr,
"unexpunge [-C <altconfig>] -l <mailbox> [<uid>...]\n"
"unexpunge [-C <altconfig>] -t time-interval [-d] [-v] [-f flag] mailbox\n"
"unexpunge [-C <altconfig>] -a [-d] [-v] [-f flag] <mailbox>\n"
"unexpunge [-C <altconfig>] -u [-d] [-v] [-f flag] <mailbox> <uid>...\n");
exit(-1);
}
static int compare_uid(const void *a, const void *b)
{
return *((unsigned long *) a) - *((unsigned long *) b);
}
enum {
MODE_UNKNOWN = -1,
MODE_LIST,
MODE_ALL,
MODE_TIME,
MODE_UID
};
static void list_expunged(const char *mboxname,
unsigned long *uids, unsigned nuids)
{
struct mailbox *mailbox = NULL;
struct index_record *records = NULL;
unsigned uidnum = 0;
int alloc = 0;
int num = 0;
int i;
int r;
r = mailbox_open_irl(mboxname, &mailbox);
if (r) {
printf("Failed to open mailbox %s: %s",
mboxname, error_message(r));
return;
}
/* first pass - read the records. Don't print until we release the
* lock */
struct mailbox_iter *iter = mailbox_iter_init(mailbox, 0, ITER_SKIP_UNLINKED);
const message_t *msg;
while ((msg = mailbox_iter_step(iter))) {
const struct index_record *record = msg_record(msg);
/* still active */
if (!(record->internal_flags & FLAG_INTERNAL_EXPUNGED))
continue;
if (nuids) {
while (uidnum < nuids && record->uid > uids[uidnum])
uidnum++;
if (uidnum >= nuids)
continue;
if (record->uid != uids[uidnum])
continue;
/* otherwise we want this one */
}
/* pre-allocate more space */
if (alloc <= num) {
alloc += 64;
records = xrealloc(records, sizeof(struct index_record) * alloc);
}
records[num] = *record;
num++;
}
mailbox_iter_done(&iter);
mailbox_unlock_index(mailbox, NULL);
for (i = 0; i < num; i++) {
const struct index_record *record = &records[i];
printf("UID: %u\n", record->uid);
printf("\tSize: %u\n", record->size);
printf("\tSent: %s", ctime(&record->sentdate));
printf("\tRecv: %s", ctime(&record->internaldate));
printf("\tExpg: %s", ctime(&record->last_updated));
if (mailbox_cacherecord(mailbox, record)) {
printf("\tERROR: cache record missing or corrupt, "
"not printing cache details\n\n");
continue;
}
printf("\tFrom: %.*s\n", cacheitem_size(record, CACHE_FROM),
cacheitem_base(record, CACHE_FROM));
printf("\tTo : %.*s\n", cacheitem_size(record, CACHE_TO),
cacheitem_base(record, CACHE_TO));
printf("\tCc : %.*s\n", cacheitem_size(record, CACHE_CC),
cacheitem_base(record, CACHE_CC));
printf("\tBcc : %.*s\n", cacheitem_size(record, CACHE_BCC),
cacheitem_base(record, CACHE_BCC));
printf("\tSubj: %.*s\n\n", cacheitem_size(record, CACHE_SUBJECT),
cacheitem_base(record, CACHE_SUBJECT));
}
free(records);
mailbox_close(&mailbox);
}
static int restore_expunged(struct mailbox *mailbox, int mode, unsigned long *uids,
unsigned nuids, time_t time_since, unsigned *numrestored,
const char *extname)
{
struct index_record newrecord;
annotate_state_t *astate = NULL;
unsigned uidnum = 0;
char oldfname[MAX_MAILBOX_PATH];
const char *fname;
char *userid = mboxname_to_userid(mailbox_name(mailbox));
int r = 0;
*numrestored = 0;
struct mailbox_iter *iter = mailbox_iter_init(mailbox, 0, ITER_SKIP_UNLINKED);
const message_t *msg;
while ((msg = mailbox_iter_step(iter))) {
const struct index_record *record = msg_record(msg);
/* still active */
if (!(record->internal_flags & FLAG_INTERNAL_EXPUNGED))
continue;
if (mode == MODE_UID) {
while (uidnum < nuids && record->uid > uids[uidnum])
uidnum++;
if (uidnum >= nuids)
continue;
if (record->uid != uids[uidnum])
continue;
/* otherwise we want this one */
}
else if (mode == MODE_TIME) {
if (record->last_updated < time_since)
continue;
/* otherwise we want this one */
}
/* work on a copy */
newrecord = *record;
/* duplicate the old filename */
fname = mailbox_record_fname(mailbox, record);
xstrncpy(oldfname, fname, MAX_MAILBOX_PATH);
/* bump the UID, strip the flags */
newrecord.uid = mailbox->i.last_uid + 1;
newrecord.internal_flags &= ~FLAG_INTERNAL_EXPUNGED;
if (unsetdeleted)
newrecord.system_flags &= ~FLAG_DELETED;
/* copy the message file */
fname = mailbox_record_fname(mailbox, &newrecord);
r = mailbox_copyfile(oldfname, fname, 0);
if (r) break;
/* add the flag if requested */
if (addflag) {
int userflag = 0;
r = mailbox_user_flag(mailbox, addflag, &userflag, 1);
if (r) break;
newrecord.user_flags[userflag/32] |= 1<<(userflag&31);
}
/* and append the new record */
r = mailbox_append_index_record(mailbox, &newrecord);
if (r) break;
/* ensure we have an astate connected to the destination
* mailbox, so that the annotation txn will be committed
* when we close the mailbox */
r = mailbox_get_annotate_state(mailbox, newrecord.uid, &astate);
if (r) break;
/* and copy over any annotations */
r = annotate_msg_copy(mailbox, record->uid,
mailbox, newrecord.uid,
userid);
if (r) break;
if (verbose)
printf("Unexpunged %s: %u => %u\n",
extname, record->uid, newrecord.uid);
/* mark the old one unlinked so we don't see it again */
struct index_record oldrecord = *record;
oldrecord.internal_flags |= FLAG_INTERNAL_UNLINKED |
FLAG_INTERNAL_NEEDS_CLEANUP;
r = mailbox_rewrite_index_record(mailbox, &oldrecord);
if (r) break;
(*numrestored)++;
}
/* better get that seen to */
if (*numrestored)
mailbox->i.options |= OPT_MAILBOX_NEEDS_UNLINK;
mailbox_iter_done(&iter);
free(userid);
return r;
}
int main(int argc, char *argv[])
{
extern char *optarg;
int opt, r = 0;
char *alt_config = NULL, *intname = NULL, *extname = NULL;
struct mailbox *mailbox = NULL;
int mode = MODE_UNKNOWN;
unsigned numrestored = 0;
time_t time_since = time(NULL);
int len, secs = 0;
unsigned long *uids = NULL;
unsigned nuids = 0;
/* keep this in alphabetical order */
static const char short_options[] = "C:adf:lt:uv";
static const struct option long_options[] = {
/* n.b. no long option for -C */
{ "all", no_argument, NULL, 'a' },
{ "unset-deleted", no_argument, NULL, 'd' },
{ "set-flag", required_argument, NULL, 'f' },
{ "list", no_argument, NULL, 'l' },
{ "within-time-interval", required_argument, NULL, 't' },
{ "uids", no_argument, NULL, 'u' },
{ "verbose", no_argument, NULL, 'v' },
{ 0, 0, 0, 0 },
};
while (-1 != (opt = getopt_long(argc, argv,
short_options, long_options, NULL)))
{
switch (opt) {
case 'C': /* alt config file */
alt_config = optarg;
break;
case 'l':
if (mode != MODE_UNKNOWN) usage();
mode = MODE_LIST;
break;
case 'a':
if (mode != MODE_UNKNOWN) usage();
mode = MODE_ALL;
break;
case 't':
if (mode != MODE_UNKNOWN) usage();
mode = MODE_TIME;
secs = atoi(optarg);
len = strlen(optarg);
if ((secs > 0) && (len > 1)) {
switch (optarg[len-1]) {
case 'm':
secs *= 60;
break;
case 'h':
secs *= (60*60);
break;
case 'd':
secs *= (24*60*60);
break;
case 'w':
secs *= (7*24*60*60);
break;
}
}
time_since = time(NULL) - secs;
break;
case 'u':
if (mode != MODE_UNKNOWN) usage();
mode = MODE_UID;
break;
case 'd':
unsetdeleted = 1;
break;
case 'f':
addflag = optarg;
break;
case 'v':
verbose = 1;
break;
default:
usage();
break;
}
}
/* sanity check */
if (mode == MODE_UNKNOWN ||
(optind + (mode == MODE_UID ? 1 : 0)) >= argc) usage();
cyrus_init(alt_config, "unexpunge", 0, 0);
sync_log_init();
if (addflag && addflag[0] == '\\') {
syslog(LOG_ERR, "can't set a system flag");
fatal("can't set a system flag", EX_SOFTWARE);
}
/* Set namespace -- force standard (internal) */
if ((r = mboxname_init_namespace(&unex_namespace, 1)) != 0) {
syslog(LOG_ERR, "%s", error_message(r));
fatal(error_message(r), EX_CONFIG);
}
/* Translate mailboxname */
intname = mboxname_from_external(argv[optind], &unex_namespace, NULL);
nuids = argc - ++optind;
if (nuids) {
unsigned i;
uids = (unsigned long *) xmalloc(nuids * sizeof(unsigned long));
for (i = 0; i < nuids; i++)
uids[i] = strtoul(argv[optind+i], NULL, 10);
/* Sort the UIDs so we can binary search */
qsort(uids, nuids, sizeof(unsigned long), compare_uid);
}
if (mode == MODE_LIST) {
list_expunged(intname, uids, nuids);
goto done;
}
/* Open/lock header */
r = mailbox_open_iwl(intname, &mailbox);
if (r) {
printf("Failed to open mailbox '%s'\n", intname);
goto done;
}
extname = mboxname_to_external(intname, &unex_namespace, NULL);
printf("restoring %sexpunged messages in mailbox '%s'\n",
mode == MODE_ALL ? "all " : "", extname);
r = restore_expunged(mailbox, mode, uids, nuids, time_since, &numrestored, extname);
if (!r) {
printf("restored %u expunged messages\n",
numrestored);
syslog(LOG_NOTICE,
"restored %u expunged messages in mailbox '%s'",
numrestored, extname);
}
mailbox_close(&mailbox);
done:
free(intname);
free(extname);
sync_log_done();
cyrus_done();
exit(r);
}