/*
- * $Id$
- *
* This module handles the expiry of old messages and the purging of old users.
*
- */
-
-
-/*
+ * You might also see this module affectionately referred to as the DAP (the Dreaded Auto-Purger).
+ *
+ * Copyright (c) 1988-2009 by citadel.org (Art Cancro, Wilifried Goesgens, and others)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ *
* A brief technical discussion:
*
* Several of the purge operations found in this module operate in two
#include "citserver.h"
#include "support.h"
#include "config.h"
-#include "room_ops.h"
#include "policy.h"
#include "database.h"
#include "msgbase.h"
#include "user_ops.h"
#include "control.h"
-#include "serv_network.h" /* Needed for defenition of UseTable */
+#include "serv_network.h" /* Needed for definition of UseTable */
#include "threads.h"
+#include "context.h"
#include "ctdl_module.h"
char *users_corrupt_msg = NULL;
char *users_zero_msg = NULL;
struct ctdlroomref *rr = NULL;
-extern struct CitContext *ContextList;
int force_purge_now = 0; /* set to nonzero to force a run right now */
void PurgeMessages(void) {
FILE *purgelist;
- CtdlLogPrintf(CTDL_DEBUG, "PurgeMessages() called\n");
+ syslog(LOG_DEBUG, "PurgeMessages() called\n");
messages_purged = 0;
purgelist = tmpfile();
if (purgelist == NULL) {
- CtdlLogPrintf(CTDL_CRIT, "Can't create purgelist temp file: %s\n",
+ syslog(LOG_CRIT, "Can't create purgelist temp file: %s\n",
strerror(errno));
return;
}
- ForEachRoom(GatherPurgeMessages, (void *)purgelist );
+ CtdlForEachRoom(GatherPurgeMessages, (void *)purgelist );
DoPurgeMessages(purgelist);
fclose(purgelist);
}
if (qrbuf->QRflags & QR_NETWORK) return;
if (qrbuf->QRflags2 & QR2_SYSTEM) return;
if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
- if (is_noneditable(qrbuf)) return;
+ if (CtdlIsNonEditable(qrbuf)) return;
/* If we don't know the modification date, be safe and don't purge */
if (qrbuf->QRmtime <= (time_t)0) return;
age = time(NULL) - (qrbuf->QRmtime);
purge_secs = (time_t)config.c_roompurge * (time_t)86400;
if (purge_secs <= (time_t)0) return;
- CtdlLogPrintf(CTDL_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
+ syslog(LOG_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
if (age > purge_secs) do_purge = 1;
} /* !QR_MAILBOX */
struct ValidUser *vuptr;
char *transcript = NULL;
- CtdlLogPrintf(CTDL_DEBUG, "PurgeRooms() called\n");
+ syslog(LOG_DEBUG, "PurgeRooms() called\n");
/* Load up a table full of valid user numbers so we can delete
ForEachUser(AddValidUser, NULL);
/* Then cycle through the room file */
- ForEachRoom(DoPurgeRooms, NULL);
+ CtdlForEachRoom(DoPurgeRooms, NULL);
/* Free the valid user list */
while (ValidUserList != NULL) {
strcpy(transcript, "The following rooms have been auto-purged:\n");
while (RoomPurgeList != NULL) {
- if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
+ if (CtdlGetRoom(&qrbuf, RoomPurgeList->name) == 0) {
transcript=realloc(transcript, strlen(transcript)+SIZ);
snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
qrbuf.QRname);
- delete_room(&qrbuf);
+ CtdlDeleteRoom(&qrbuf);
}
pptr = RoomPurgeList->next;
free(RoomPurgeList);
++num_rooms_purged;
}
- if (num_rooms_purged > 0) aide_message(transcript, "Room Autopurger Message");
+ if (num_rooms_purged > 0) CtdlAideMessage(transcript, "Room Autopurger Message");
free(transcript);
- CtdlLogPrintf(CTDL_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
+ syslog(LOG_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
return(num_rooms_purged);
}
/* The default rule is to not purge. */
purge = 0;
+
+ /* don't attempt to purge system users. */
+ if (!strncmp(us->fullname, "SYS_", 4))
+ goto skip_all_this;
/* If the user hasn't called in two months and expiring of accounts is turned on, his/her account
* has expired, so purge the record.
* we will need to try and purge them from users data bases.Some will not have names but
* those with names should be purged.
*/
- CtdlLogPrintf(CTDL_DEBUG, "Auto purger found a user 0 with name \"%s\"\n", us->fullname);
+ syslog(LOG_DEBUG, "Auto purger found a user 0 with name \"%s\"\n", us->fullname);
// purge = 0;
}
}
}
-
+skip_all_this:
+
if (purge == 1) {
pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
pptr->next = UserPurgeList;
int num_users_purged = 0;
char *transcript = NULL;
- CtdlLogPrintf(CTDL_DEBUG, "PurgeUsers() called\n");
+ syslog(LOG_DEBUG, "PurgeUsers() called\n");
users_not_purged = 0;
switch(config.c_auth_mode) {
ForEachUser(do_uid_user_purge, NULL);
break;
default:
- CtdlLogPrintf(CTDL_DEBUG, "Unknown authentication mode!\n");
+ syslog(LOG_DEBUG, "User purge for auth mode %d is not implemented.\n",
+ config.c_auth_mode);
break;
}
}
}
- if (num_users_purged > 0) aide_message(transcript, "User Purge Message");
+ if (num_users_purged > 0) CtdlAideMessage(transcript, "User Purge Message");
free(transcript);
if(users_corrupt_msg)
{
- aide_message(users_corrupt_msg, "User Corruption Message");
+ CtdlAideMessage(users_corrupt_msg, "User Corruption Message");
free (users_corrupt_msg);
users_corrupt_msg = NULL;
}
if(users_zero_msg)
{
- aide_message(users_zero_msg, "User Zero Message");
+ CtdlAideMessage(users_zero_msg, "User Zero Message");
free (users_zero_msg);
users_zero_msg = NULL;
}
- CtdlLogPrintf(CTDL_DEBUG, "Purged %d users.\n", num_users_purged);
+ syslog(LOG_DEBUG, "Purged %d users.\n", num_users_purged);
return(num_users_purged);
}
*/
int PurgeVisits(void) {
struct cdbdata *cdbvisit;
- struct visit vbuf;
+ visit vbuf;
struct VPurgeList *VisitPurgeList = NULL;
struct VPurgeList *vptr;
int purged = 0;
int RoomIsValid, UserIsValid;
/* First, load up a table full of valid room/gen combinations */
- ForEachRoom(AddValidRoom, NULL);
+ CtdlForEachRoom(AddValidRoom, NULL);
/* Then load up a table full of valid user numbers */
ForEachUser(AddValidUser, NULL);
/* Now traverse through the visits, purging irrelevant records... */
cdb_rewind(CDB_VISIT);
while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
- memset(&vbuf, 0, sizeof(struct visit));
+ memset(&vbuf, 0, sizeof(visit));
memcpy(&vbuf, cdbvisit->ptr,
- ( (cdbvisit->len > sizeof(struct visit)) ?
- sizeof(struct visit) : cdbvisit->len) );
+ ( (cdbvisit->len > sizeof(visit)) ?
+ sizeof(visit) : cdbvisit->len) );
cdb_free(cdbvisit);
RoomIsValid = 0;
struct UPurgeList *uptr;
/* Phase 1: traverse through the table, discovering old records... */
- CtdlLogPrintf(CTDL_DEBUG, "Purge use table: phase 1\n");
+ syslog(LOG_DEBUG, "Purge use table: phase 1\n");
cdb_rewind(CDB_USETABLE);
while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL) {
}
/* Phase 2: delete the records */
- CtdlLogPrintf(CTDL_DEBUG, "Purge use table: phase 2\n");
+ syslog(LOG_DEBUG, "Purge use table: phase 2\n");
while (ul != NULL) {
cdb_delete(CDB_USETABLE, ul->up_key, strlen(ul->up_key));
uptr = ul->next;
ul = uptr;
}
- CtdlLogPrintf(CTDL_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
+ syslog(LOG_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
return(purged);
}
struct CtdlMessage *msg = NULL;
/* Phase 1: traverse through the table, discovering old records... */
- CtdlLogPrintf(CTDL_DEBUG, "Purge EUID index: phase 1\n");
+ syslog(LOG_DEBUG, "Purge EUID index: phase 1\n");
cdb_rewind(CDB_EUIDINDEX);
while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei != NULL) {
}
/* Phase 2: delete the records */
- CtdlLogPrintf(CTDL_DEBUG, "Purge euid index: phase 2\n");
+ syslog(LOG_DEBUG, "Purge euid index: phase 2\n");
while (el != NULL) {
cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
free(el->ep_key);
el = eptr;
}
- CtdlLogPrintf(CTDL_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
+ syslog(LOG_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
return(purged);
}
char *deleteme = NULL;
long len;
void *Value;
- char *Key;
+ const char *Key;
int num_deleted = 0;
+ long usernum = 0L;
keys = NewHash(1, NULL);
if (!keys) return(0);
cdb_rewind(CDB_OPENID);
while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
if (cdboi->len > sizeof(long)) {
- long usernum;
- usernum = ((long)*(cdboi->ptr));
- if (getuserbynumber(&usbuf, usernum) != 0) {
+ memcpy(&usernum, cdboi->ptr, sizeof(long));
+ if (CtdlGetUserByNumber(&usbuf, usernum) != 0) {
deleteme = strdup(cdboi->ptr + sizeof(long)),
- Put(keys, deleteme, strlen(deleteme), deleteme, generic_free_handler);
+ Put(keys, deleteme, strlen(deleteme), deleteme, NULL);
}
}
cdb_free(cdboi);
/* Go through the hash list, deleting keys we stored in it */
- HashPos = GetNewHashPos();
+ HashPos = GetNewHashPos(keys, 0);
while (GetNextHashPos(keys, HashPos, &len, &Key, &Value)!=0)
{
- CtdlLogPrintf(CTDL_DEBUG, "Deleting associated OpenID <%s>\n", Value);
+ syslog(LOG_DEBUG, "Deleting associated OpenID <%s>\n", (char*)Value);
cdb_delete(CDB_OPENID, Value, strlen(Value));
/* note: don't free(Value) -- deleting the hash list will handle this for us */
++num_deleted;
struct tm tm;
struct CitContext purgerCC;
- CtdlLogPrintf(CTDL_DEBUG, "Auto-purger_thread() initializing\n");
-
CtdlFillSystemContext(&purgerCC, "purger");
citthread_setspecific(MyConKey, (void *)&purgerCC );
+ syslog(LOG_DEBUG, "Auto-purger_thread() initializing\n");
while (!CtdlThreadCheckStop()) {
/* Do the auto-purge if the current hour equals the purge hour,
}
- CtdlLogPrintf(CTDL_INFO, "Auto-purger: starting.\n");
+ syslog(LOG_INFO, "Auto-purger: starting.\n");
if (!CtdlThreadCheckStop())
{
retval = PurgeUsers();
- CtdlLogPrintf(CTDL_NOTICE, "Purged %d users.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d users.\n", retval);
}
if (!CtdlThreadCheckStop())
{
PurgeMessages();
- CtdlLogPrintf(CTDL_NOTICE, "Expired %d messages.\n", messages_purged);
+ syslog(LOG_NOTICE, "Expired %d messages.\n", messages_purged);
}
if (!CtdlThreadCheckStop())
{
retval = PurgeRooms();
- CtdlLogPrintf(CTDL_NOTICE, "Expired %d rooms.\n", retval);
+ syslog(LOG_NOTICE, "Expired %d rooms.\n", retval);
}
if (!CtdlThreadCheckStop())
{
retval = PurgeVisits();
- CtdlLogPrintf(CTDL_NOTICE, "Purged %d visits.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d visits.\n", retval);
}
if (!CtdlThreadCheckStop())
{
retval = PurgeUseTable();
- CtdlLogPrintf(CTDL_NOTICE, "Purged %d entries from the use table.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d entries from the use table.\n", retval);
}
if (!CtdlThreadCheckStop())
{
retval = PurgeEuidIndexTable();
- CtdlLogPrintf(CTDL_NOTICE, "Purged %d entries from the EUID index.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d entries from the EUID index.\n", retval);
}
if (!CtdlThreadCheckStop())
{
retval = PurgeStaleOpenIDassociations();
- CtdlLogPrintf(CTDL_NOTICE, "Purged %d stale OpenID associations.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d stale OpenID associations.\n", retval);
}
if (!CtdlThreadCheckStop())
{
retval = TDAP_ProcessAdjRefCountQueue();
- CtdlLogPrintf(CTDL_NOTICE, "Processed %d message reference count adjustments.\n", retval);
+ syslog(LOG_NOTICE, "Processed %d message reference count adjustments.\n", retval);
}
if (!CtdlThreadCheckStop())
{
- CtdlLogPrintf(CTDL_INFO, "Auto-purger: finished.\n");
+ syslog(LOG_INFO, "Auto-purger: finished.\n");
last_purge = now; /* So we don't do it again soon */
force_purge_now = 0;
}
else
- CtdlLogPrintf(CTDL_INFO, "Auto-purger: STOPPED.\n");
+ syslog(LOG_INFO, "Auto-purger: STOPPED.\n");
}
+ CtdlClearSystemContext();
return NULL;
}
/*****************************************************************************/
+/* The FSCK command has been removed because people were misusing it */
+
+#if 0
+
void do_fsck_msg(long msgnum, void *userdata) {
struct ctdlroomref *ptr;
void do_fsck_room(struct ctdlroom *qrbuf, void *data)
{
- getroom(&CC->room, qrbuf->QRname);
+ CtdlGetRoom(&CC->room, qrbuf->QRname);
CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, do_fsck_msg, NULL);
}
cprintf("\nThis could take a while. Please be patient!\n\n");
cprintf("Gathering pointers...\n");
- ForEachRoom(do_fsck_room, NULL);
+ CtdlForEachRoom(do_fsck_room, NULL);
get_control();
cprintf("Checking message base...\n");
}
+#endif /* end of commented-out fsck cmd */
/*
* Manually initiate a run of The Dreaded Auto-Purger (tm)
{
if (!threading)
{
- CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
+ /* CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts"); */
CtdlRegisterProtoHook(cmd_tdap, "TDAP", "Manually initiate auto-purger");
+
+ CtdlRegisterProtoHook(cmd_gpex, "GPEX", "Get expire policy");
+ CtdlRegisterProtoHook(cmd_spex, "SPEX", "Set expire policy");
}
else
CtdlThreadCreate("Auto Purger", CTDLTHREAD_BIGSTACK, purge_databases, NULL);
/* return our Subversion id for the Log */
- return "$Id$";
+ return "expire";
}
projects / citadel.git / blobdiff