*
* You might also see this module affectionately referred to as the DAP (the Dreaded Auto-Purger).
*
- * Copyright (c) 1988-2011 by citadel.org (Art Cancro, Wilifried Goesgens, and others)
+ * Copyright (c) 1988-2017 by citadel.org (Art Cancro, Wilifried Goesgens, and others)
*
* This program is open source software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* 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 "msgbase.h"
#include "user_ops.h"
#include "control.h"
-#include "serv_network.h" /* Needed for definition of UseTable */
#include "threads.h"
#include "context.h"
long vu_usernum;
};
-
struct ctdlroomref {
struct ctdlroomref *next;
long msgnum;
return;
}
-
/* If the room is set to expire by count, do that */
if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
if (num_msgs > epbuf.expire_value) {
for (a=0; a<num_msgs; ++a) {
delnum = msglist[a];
- msg = CtdlFetchMessage(delnum, 0); /* dont need body */
+ msg = CtdlFetchMessage(delnum, 0, 1); /* dont need body */
if (msg != NULL) {
- xtime = atol(msg->cm_fields['T']);
- CtdlFreeMessage(msg);
+ xtime = atol(msg->cm_fields[eTimestamp]);
+ CM_Free(msg);
} else {
xtime = 0L;
}
void PurgeMessages(void) {
FILE *purgelist;
- syslog(LOG_DEBUG, "PurgeMessages() called\n");
+ syslog(LOG_DEBUG, "PurgeMessages() called");
messages_purged = 0;
purgelist = tmpfile();
if (purgelist == NULL) {
- syslog(LOG_CRIT, "Can't create purgelist temp file: %s\n",
- strerror(errno));
+ syslog(LOG_CRIT, "Can't create purgelist temp file: %s", strerror(errno));
return;
}
if (qrbuf->QRmtime <= (time_t)0) return;
/* If no room purge time is set, be safe and don't purge */
- if (config.c_roompurge < 0) return;
+ if (CtdlGetConfigLong("c_roompurge") < 0) return;
/* Otherwise, check the date of last modification */
age = time(NULL) - (qrbuf->QRmtime);
- purge_secs = (time_t)config.c_roompurge * (time_t)86400;
+ purge_secs = CtdlGetConfigLong("c_roompurge") * 86400;
if (purge_secs <= (time_t)0) return;
- syslog(LOG_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
+ syslog(LOG_DEBUG, "<%s> is <%ld> seconds old", qrbuf->QRname, (long)age);
if (age > purge_secs) do_purge = 1;
} /* !QR_MAILBOX */
}
-
int PurgeRooms(void) {
struct PurgeList *pptr;
int num_rooms_purged = 0;
struct ValidUser *vuptr;
char *transcript = NULL;
- syslog(LOG_DEBUG, "PurgeRooms() called\n");
-
+ syslog(LOG_DEBUG, "PurgeRooms() called");
/* Load up a table full of valid user numbers so we can delete
* user-owned rooms for users who no longer exist */
ValidUserList = vuptr;
}
-
transcript = malloc(SIZ);
strcpy(transcript, "The following rooms have been auto-purged:\n");
if (num_rooms_purged > 0) CtdlAideMessage(transcript, "Room Autopurger Message");
free(transcript);
- syslog(LOG_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
+ syslog(LOG_DEBUG, "Purged %d rooms.", num_rooms_purged);
return(num_rooms_purged);
}
}
-
-
/*
* Back end function to check user accounts for expiration.
*/
/* Set purge time; if the user overrides the system default, use it */
if (us->USuserpurge > 0) {
- purge_time = ((time_t)us->USuserpurge) * 86400L;
+ purge_time = ((time_t)us->USuserpurge) * 86400;
}
else {
- purge_time = ((time_t)config.c_userpurge) * 86400L;
+ purge_time = CtdlGetConfigLong("c_userpurge") * 86400;
}
/* 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.
*/
- if (config.c_userpurge > 0)
+ if (CtdlGetConfigLong("c_userpurge") > 0)
{
now = time(NULL);
if ((now - us->lastcall) > purge_time) purge = 1;
*/
if (us->usernum < 0L) purge = 1;
- /** Don't purge user 0. That user is there for the system */
+ /* Don't purge user 0. That user is there for the system */
if (us->usernum == 0L)
{
/* FIXME: Temporary log message. Until we do unauth access with user 0 we should
* we will need to try and purge them from users data bases.Some will not have names but
* those with names should be purged.
*/
- syslog(LOG_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>", us->fullname);
// purge = 0;
}
if (users_corrupt_msg == NULL)
{
users_corrupt_msg = malloc(SIZ);
- strcpy(users_corrupt_msg, "The auto-purger found the following user numbers with no name.\n"
- "The system has no way to purge user with no name and should not be able to\n"
- "create them either.\n"
- "This indicates corruption of the user DB or possibly a bug.\n"
- "It may be a good idea to restore your DB from a backup.\n");
+ strcpy(users_corrupt_msg,
+ "The auto-purger found the following user numbers with no name.\n"
+ "The system has no way to purge a user with no name,"
+ " and should not be able to create them either.\n"
+ "This indicates corruption of the user DB or possibly a bug.\n"
+ "It may be a good idea to restore your DB from a backup.\n"
+ );
}
users_corrupt_msg=realloc(users_corrupt_msg, strlen(users_corrupt_msg)+30);
}
}
-skip_all_this:
-
if (purge == 1) {
pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
pptr->next = UserPurgeList;
}
-
int PurgeUsers(void) {
struct PurgeList *pptr;
int num_users_purged = 0;
char *transcript = NULL;
- syslog(LOG_DEBUG, "PurgeUsers() called\n");
+ syslog(LOG_DEBUG, "PurgeUsers() called");
users_not_purged = 0;
- switch(config.c_auth_mode) {
+ switch(CtdlGetConfigInt("c_auth_mode")) {
case AUTHMODE_NATIVE:
ForEachUser(do_user_purge, NULL);
break;
ForEachUser(do_uid_user_purge, NULL);
break;
default:
- syslog(LOG_DEBUG, "User purge for auth mode %d is not implemented.\n",
- config.c_auth_mode);
+ syslog(LOG_DEBUG, "User purge for auth mode %d is not implemented.", CtdlGetConfigInt("c_auth_mode"));
break;
}
users_zero_msg = NULL;
}
- syslog(LOG_DEBUG, "Purged %d users.\n", num_users_purged);
+ syslog(LOG_DEBUG, "Purged %d users.", num_users_purged);
return(num_users_purged);
}
return(purged);
}
+
/*
* Purge the use table of old entries.
*
*/
-int PurgeUseTable(void) {
+int PurgeUseTable(StrBuf *ErrMsg) {
int purged = 0;
struct cdbdata *cdbut;
struct UseTable ut;
struct UPurgeList *uptr;
/* Phase 1: traverse through the table, discovering old records... */
- syslog(LOG_DEBUG, "Purge use table: phase 1\n");
- cdb_rewind(CDB_USETABLE);
- while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL) {
+ if (CheckTDAPVeto(CDB_USETABLE, ErrMsg))
+ {
+ syslog(LOG_DEBUG, "Purge use table: VETO!");
+ return 0;
+ }
- /*
- * TODODRW: change this to create a new function time_t cdb_get_timestamp( struct cdbdata *)
- * this will release this file from the serv_network.h
- * Maybe it could be a macro that extracts and casts the reult
- */
- memcpy(&ut, cdbut->ptr,
- ((cdbut->len > sizeof(struct UseTable)) ?
- sizeof(struct UseTable) : cdbut->len));
- cdb_free(cdbut);
+ syslog(LOG_DEBUG, "Purge use table: phase 1");
+ cdb_rewind(CDB_USETABLE);
+ while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL)
+ {
+ if (cdbut->len > sizeof(struct UseTable))
+ memcpy(&ut, cdbut->ptr, sizeof(struct UseTable));
+ else
+ {
+ memset(&ut, 0, sizeof(struct UseTable));
+ memcpy(&ut, cdbut->ptr, cdbut->len);
+ }
+ cdb_free(cdbut);
- if ( (time(NULL) - ut.ut_timestamp) > USETABLE_RETAIN ) {
+ if ( (time(NULL) - ut.ut_timestamp) > USETABLE_RETAIN )
+ {
uptr = (struct UPurgeList *) malloc(sizeof(struct UPurgeList));
- if (uptr != NULL) {
+ if (uptr != NULL)
+ {
uptr->next = ul;
safestrncpy(uptr->up_key, ut.ut_msgid, sizeof uptr->up_key);
ul = uptr;
}
/* Phase 2: delete the records */
- syslog(LOG_DEBUG, "Purge use table: phase 2\n");
+ syslog(LOG_DEBUG, "Purge use table: phase 2");
while (ul != NULL) {
cdb_delete(CDB_USETABLE, ul->up_key, strlen(ul->up_key));
uptr = ul->next;
ul = uptr;
}
- syslog(LOG_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
+ syslog(LOG_DEBUG, "Purge use table: finished (purged %d records)", purged);
return(purged);
}
-
/*
* Purge the EUID Index of old records.
*
struct CtdlMessage *msg = NULL;
/* Phase 1: traverse through the table, discovering old records... */
- syslog(LOG_DEBUG, "Purge EUID index: phase 1\n");
+ syslog(LOG_DEBUG, "Purge EUID index: phase 1");
cdb_rewind(CDB_EUIDINDEX);
while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei != NULL) {
memcpy(&msgnum, cdbei->ptr, sizeof(long));
- msg = CtdlFetchMessage(msgnum, 0);
+ msg = CtdlFetchMessage(msgnum, 0, 1);
if (msg != NULL) {
- CtdlFreeMessage(msg); /* it still exists, so do nothing */
+ CM_Free(msg); /* it still exists, so do nothing */
}
else {
eptr = (struct EPurgeList *) malloc(sizeof(struct EPurgeList));
}
/* Phase 2: delete the records */
- syslog(LOG_DEBUG, "Purge euid index: phase 2\n");
+ syslog(LOG_DEBUG, "Purge euid index: phase 2");
while (el != NULL) {
cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
free(el->ep_key);
el = eptr;
}
- syslog(LOG_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
+ syslog(LOG_DEBUG, "Purge euid index: finished (purged %d records)", purged);
return(purged);
}
-
/*
* Purge OpenID assocations for missing users (theoretically this will never delete anything)
*/
HashPos = GetNewHashPos(keys, 0);
while (GetNextHashPos(keys, HashPos, &len, &Key, &Value)!=0)
{
- syslog(LOG_DEBUG, "Deleting associated OpenID <%s>\n", (char*)Value);
+ syslog(LOG_DEBUG, "Deleting associated OpenID <%s>", (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;
}
-
-
-
void purge_databases(void)
{
int retval;
*/
now = time(NULL);
localtime_r(&now, &tm);
- if (
- ((tm.tm_hour != config.c_purge_hour) || ((now - last_purge) < 43200))
- && (force_purge_now == 0)
- ) {
+ if (((tm.tm_hour != CtdlGetConfigInt("c_purge_hour")) || ((now - last_purge) < 43200)) && (force_purge_now == 0))
+ {
return;
}
- syslog(LOG_INFO, "Auto-purger: starting.\n");
+ syslog(LOG_INFO, "Auto-purger: starting.");
if (!server_shutting_down)
{
retval = PurgeUsers();
- syslog(LOG_NOTICE, "Purged %d users.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d users.", retval);
}
if (!server_shutting_down)
{
PurgeMessages();
- syslog(LOG_NOTICE, "Expired %d messages.\n", messages_purged);
+ syslog(LOG_NOTICE, "Expired %d messages.", messages_purged);
}
if (!server_shutting_down)
{
retval = PurgeRooms();
- syslog(LOG_NOTICE, "Expired %d rooms.\n", retval);
+ syslog(LOG_NOTICE, "Expired %d rooms.", retval);
}
if (!server_shutting_down)
{
retval = PurgeVisits();
- syslog(LOG_NOTICE, "Purged %d visits.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d visits.", retval);
}
if (!server_shutting_down)
{
- retval = PurgeUseTable();
- syslog(LOG_NOTICE, "Purged %d entries from the use table.\n", retval);
+ StrBuf *ErrMsg;
+
+ ErrMsg = NewStrBuf ();
+ retval = PurgeUseTable(ErrMsg);
+ syslog(LOG_NOTICE, "Purged %d entries from the use table.", retval);
+////TODO: fix errmsg
+ FreeStrBuf(&ErrMsg);
}
if (!server_shutting_down)
{
retval = PurgeEuidIndexTable();
- syslog(LOG_NOTICE, "Purged %d entries from the EUID index.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d entries from the EUID index.", retval);
}
if (!server_shutting_down)
{
retval = PurgeStaleOpenIDassociations();
- syslog(LOG_NOTICE, "Purged %d stale OpenID associations.\n", retval);
+ syslog(LOG_NOTICE, "Purged %d stale OpenID associations.", retval);
}
if (!server_shutting_down)
{
retval = TDAP_ProcessAdjRefCountQueue();
- syslog(LOG_NOTICE, "Processed %d message reference count adjustments.\n", retval);
+ syslog(LOG_NOTICE, "Processed %d message reference count adjustments.", retval);
}
if (!server_shutting_down)
{
- syslog(LOG_INFO, "Auto-purger: finished.\n");
+ syslog(LOG_INFO, "Auto-purger: finished.");
last_purge = now; /* So we don't do it again soon */
force_purge_now = 0;
}
else {
- syslog(LOG_INFO, "Auto-purger: STOPPED.\n");
+ syslog(LOG_INFO, "Auto-purger: STOPPED.");
}
-
- CtdlClearSystemContext();
}
}
-
CTDL_MODULE_INIT(expire)
{
if (!threading)
CtdlRegisterProtoHook(cmd_tdap, "TDAP", "Manually initiate auto-purger");
CtdlRegisterProtoHook(cmd_gpex, "GPEX", "Get expire policy");
CtdlRegisterProtoHook(cmd_spex, "SPEX", "Set expire policy");
- CtdlRegisterSessionHook(purge_databases, EVT_TIMER);
+ CtdlRegisterSessionHook(purge_databases, EVT_TIMER, PRIO_CLEANUP + 20);
}
- /* return our Subversion id for the Log */
+ /* return our module name for the log */
return "expire";
}
projects / citadel.git / blobdiff