More logging for Global Address Book saves, for debugging
[citadel.git] / citadel / modules / vcard / serv_vcard.c
index 4e41299808a55b571ae1f97dbe06c0d5cd97d68e..5486e094783a1bc5af878ce03d32d2bdbf40c3cc 100644 (file)
@@ -1,10 +1,22 @@
 /*
- * $Id$
- * 
  * A server-side module for Citadel which supports address book information
  * using the standard vCard format.
  * 
- * Copyright (c) 1999-2009 / released under the GNU General Public License v3
+ * Copyright (c) 1999-2009 by the citadel.org team
+ *
+ * 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
  */
 
 /*
@@ -54,9 +66,7 @@
 #include "support.h"
 #include "config.h"
 #include "control.h"
-#include "room_ops.h"
 #include "user_ops.h"
-#include "policy.h"
 #include "database.h"
 #include "msgbase.h"
 #include "internet_addressing.h"
@@ -136,18 +146,18 @@ void vcard_directory_add_user(char *internet_addr, char *citadel_addr) {
         * probably just the networker or something.
         */
        if (CC->logged_in) {
-               CtdlLogPrintf(CTDL_DEBUG, "Checking for <%s>...\n", internet_addr);
+               syslog(LOG_DEBUG, "Checking for <%s>...\n", internet_addr);
                if (CtdlDirectoryLookup(buf, internet_addr, sizeof buf) == 0) {
                        if (strcasecmp(buf, citadel_addr)) {
                                /* This address belongs to someone else.
                                 * Bail out silently without saving.
                                 */
-                               CtdlLogPrintf(CTDL_DEBUG, "DOOP!\n");
+                               syslog(LOG_DEBUG, "DOOP!\n");
                                return;
                        }
                }
        }
-       CtdlLogPrintf(CTDL_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
+       syslog(LOG_INFO, "Adding %s (%s) to directory\n", citadel_addr, internet_addr);
        CtdlDirectoryAddUser(internet_addr, citadel_addr);
 }
 
@@ -177,8 +187,8 @@ void cmd_igab(char *argbuf) {
 
        strcpy(hold_rm, CC->room.QRname);       /* save current room */
 
-       if (getroom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
-               getroom(&CC->room, hold_rm);
+       if (CtdlGetRoom(&CC->room, ADDRESS_BOOK_ROOM) != 0) {
+               CtdlGetRoom(&CC->room, hold_rm);
                cprintf("%d cannot get address book room\n", ERROR + ROOM_NOT_FOUND);
                return;
        }
@@ -188,10 +198,10 @@ void cmd_igab(char *argbuf) {
        CtdlDirectoryInit();
 
        /* We want *all* vCards in this room */
-       CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
+       CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
                NULL, vcard_add_to_directory, NULL);
 
-       getroom(&CC->room, hold_rm);    /* return to saved room */
+       CtdlGetRoom(&CC->room, hold_rm);        /* return to saved room */
        cprintf("%d Directory has been rebuilt.\n", CIT_OK);
 }
 
@@ -274,7 +284,7 @@ void vcard_extract_vcard(char *name, char *filename, char *partnum, char *disp,
        if (  (!strcasecmp(cbtype, "text/x-vcard"))
           || (!strcasecmp(cbtype, "text/vcard")) ) {
 
-               CtdlLogPrintf(CTDL_DEBUG, "Part %s contains a vCard!  Loading...\n", partnum);
+               syslog(LOG_DEBUG, "Part %s contains a vCard!  Loading...\n", partnum);
                if (*v != NULL) {
                        vcard_free(*v);
                }
@@ -308,10 +318,11 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
           && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
                /* Yes, we want to do this */
                yes_my_citadel_config = 1;
+               syslog(LOG_DEBUG, "GAB: user config room detected");
 
 #ifdef VCARD_SAVES_BY_AIDES_ONLY
                /* Prevent non-aides from performing registration changes */
-               if (CC->user.axlevel < 6) {
+               if (CC->user.axlevel < AxAideU) {
                        return(1);
                }
 #endif
@@ -321,6 +332,7 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
        /* Is this a room with an address book in it? */
        if (CC->room.QRdefaultview == VIEW_ADDRESSBOOK) {
                yes_any_vcard_room = 1;
+               syslog(LOG_DEBUG, "GAB: address book room detected");
        }
 
        /* If neither condition exists, don't run this hook. */
@@ -347,12 +359,12 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
        if (v == NULL) return(0);       /* no vCards were found in this message */
 
        /* If users cannot create their own accounts, they cannot re-register either. */
-       if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
+       if ( (yes_my_citadel_config) && (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
                return(1);
        }
 
        s = vcard_get_prop(v, "fn", 1, 0, 0);
-       if (s) CtdlLogPrintf(CTDL_DEBUG, "vCard beforesave hook running for <%s>\n", s);
+       if (s) syslog(LOG_DEBUG, "GAB: vCard beforesave hook running for <%s>\n", s);
 
        if (yes_my_citadel_config) {
                /* Bingo!  The user is uploading a new vCard, so
@@ -366,7 +378,7 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
                        memcpy(&usbuf, &CC->user, sizeof(struct ctdluser));
                }
                
-               else if (getuserbynumber(&usbuf, what_user) == 0) {
+               else if (CtdlGetUserByNumber(&usbuf, what_user) == 0) {
                        /* We fetched a valid user record */
                }
 
@@ -383,7 +395,8 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
                 * vCard in the user's config room at all times.
                 *
                 */
-               CtdlDeleteMessages(CC->room.QRname, NULL, 0, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
+               syslog(LOG_DEBUG, "GAB: deleting old vCard for user");
+               CtdlDeleteMessages(CC->room.QRname, NULL, 0, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$");
 
                /* Make the author of the message the name of the user. */
                if (msg->cm_fields['A'] != NULL) {
@@ -458,6 +471,7 @@ int vcard_upload_beforesave(struct CtdlMessage *msg) {
 
        /* Now allow the save to complete. */
        vcard_free(v);
+       syslog(LOG_DEBUG, "GAB: save will proceed");
        return(0);
 }
 
@@ -486,14 +500,17 @@ int vcard_upload_aftersave(struct CtdlMessage *msg) {
 
        if ( (strlen(CC->room.QRname) >= 12) && (!strcasecmp(&CC->room.QRname[11], USERCONFIGROOM)) ) {
                is_UserConf = 1;        /* It's someone's config room */
+               syslog(LOG_DEBUG, "GAB: this is someone's config room");
        }
-       MailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
+       CtdlMailboxName(roomname, sizeof roomname, &CC->user, USERCONFIGROOM);
        if (!strcasecmp(CC->room.QRname, roomname)) {
                is_UserConf = 1;
                is_MY_UserConf = 1;     /* It's MY config room */
+               syslog(LOG_DEBUG, "GAB: this is MY config room");
        }
        if (!strcasecmp(CC->room.QRname, ADDRESS_BOOK_ROOM)) {
                is_GAB = 1;             /* It's the Global Address Book */
+               syslog(LOG_DEBUG, "GAB: this is the Global Address Book");
        }
 
        if (!is_UserConf && !is_GAB) return(0);
@@ -528,6 +545,7 @@ int vcard_upload_aftersave(struct CtdlMessage *msg) {
                        if (!is_GAB)
                        {       // This is not the GAB
                                /* Put it in the Global Address Book room... */
+                               syslog(LOG_DEBUG, "GAB: copying to Global Address Book");
                                CtdlSaveMsgPointerInRoom(ADDRESS_BOOK_ROOM, I, 1, msg);
                        }
 
@@ -539,19 +557,19 @@ int vcard_upload_aftersave(struct CtdlMessage *msg) {
                         * But if the user was an Aide or was edited by an Aide then we can
                         * Assume they don't need validating.
                         */
-                       if (CC->user.axlevel >= 6) {
-                               lgetuser(&CC->user, CC->curr_user);
+                       if (CC->user.axlevel >= AxAideU) {
+                               CtdlGetUserLock(&CC->user, CC->curr_user);
                                CC->user.flags |= US_REGIS;
-                               lputuser(&CC->user);
+                               CtdlPutUserLock(&CC->user);
                                return (0);
                        }
                        
                        set_mm_valid();
 
                        /* ...which also means we need to flag the user */
-                       lgetuser(&CC->user, CC->curr_user);
+                       CtdlGetUserLock(&CC->user, CC->curr_user);
                        CC->user.flags |= (US_REGIS|US_NEEDVALID);
-                       lputuser(&CC->user);
+                       CtdlPutUserLock(&CC->user);
 
                        return(0);
                }
@@ -588,18 +606,18 @@ struct vCard *vcard_get_user(struct ctdluser *u) {
        long VCmsgnum;
 
        strcpy(hold_rm, CC->room.QRname);       /* save current room */
-       MailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
+       CtdlMailboxName(config_rm, sizeof config_rm, u, USERCONFIGROOM);
 
-       if (getroom(&CC->room, config_rm) != 0) {
-               getroom(&CC->room, hold_rm);
+       if (CtdlGetRoom(&CC->room, config_rm) != 0) {
+               CtdlGetRoom(&CC->room, hold_rm);
                return vcard_new();
        }
 
        /* We want the last (and probably only) vcard in this room */
        VCmsgnum = (-1);
-       CtdlForEachMessage(MSGS_LAST, 1, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
+       CtdlForEachMessage(MSGS_LAST, 1, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$",
                NULL, vcard_gu_backend, (void *)&VCmsgnum );
-       getroom(&CC->room, hold_rm);    /* return to saved room */
+       CtdlGetRoom(&CC->room, hold_rm);        /* return to saved room */
 
        if (VCmsgnum < 0L) return vcard_new();
 
@@ -672,7 +690,7 @@ void cmd_regi(char *argbuf) {
        }
 
        /* If users cannot create their own accounts, they cannot re-register either. */
-       if ( (config.c_disable_newu) && (CC->user.axlevel < 6) ) {
+       if ( (config.c_disable_newu) && (CC->user.axlevel < AxAideU) ) {
                cprintf("%d Self-service registration is not allowed here.\n",
                        ERROR + HIGHER_ACCESS_REQUIRED);
        }
@@ -735,13 +753,13 @@ void cmd_greg(char *argbuf)
 
        if (!strcasecmp(who,"_SELF_")) strcpy(who,CC->curr_user);
 
-       if ((CC->user.axlevel < 6) && (strcasecmp(who,CC->curr_user))) {
+       if ((CC->user.axlevel < AxAideU) && (strcasecmp(who,CC->curr_user))) {
                cprintf("%d Higher access required.\n",
                        ERROR + HIGHER_ACCESS_REQUIRED);
                return;
        }
 
-       if (getuser(&usbuf, who) != 0) {
+       if (CtdlGetUser(&usbuf, who) != 0) {
                cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, who);
                return;
        }
@@ -800,7 +818,7 @@ void vcard_newuser(struct ctdluser *usbuf) {
        struct vCard *v;
 
        vcard_fn_to_n(vname, usbuf->fullname, sizeof vname);
-       CtdlLogPrintf(CTDL_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
+       syslog(LOG_DEBUG, "Converted <%s> to <%s>\n", usbuf->fullname, vname);
 
        /* Create and save the vCard */
        v = vcard_new();
@@ -819,7 +837,7 @@ void vcard_newuser(struct ctdluser *usbuf) {
                if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer) != NULL) {
 #else // SOLARIS_GETPWUID
                struct passwd *result = NULL;
-               CtdlLogPrintf(CTDL_DEBUG, "Searching for uid %d\n", usbuf->uid);
+               syslog(LOG_DEBUG, "Searching for uid %d\n", usbuf->uid);
                if (getpwuid_r(usbuf->uid, &pwd, pwd_buffer, sizeof pwd_buffer, &result) == 0) {
 #endif // HAVE_GETPWUID_R
                        snprintf(buf, sizeof buf, "%s@%s", pwd.pw_name, config.c_fqdn);
@@ -1106,14 +1124,15 @@ void check_get(void) {
        time(&CC->lastcmd);
        memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
        if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
-               CtdlLogPrintf(CTDL_CRIT, "Client disconnected: ending session.\n");
-               CC->kill_me = 1;
+               syslog(LOG_CRIT, "vcard client disconnected: ending session.\n");
+               CC->kill_me = KILLME_CLIENT_DISCONNECTED;
                return;
        }
-       CtdlLogPrintf(CTDL_INFO, ": %s\n", cmdbuf);
+       syslog(LOG_INFO, ": %s\n", cmdbuf);
        while (strlen(cmdbuf) < 3) strcat(cmdbuf, " ");
-
-       if (strcasecmp(cmdbuf, "GET "));
+       syslog(LOG_INFO, "[ %s]\n", cmdbuf);
+       
+       if (strncasecmp(cmdbuf, "GET ", 4)==0)
        {
                struct recptypes *rcpt;
                char *argbuf = &cmdbuf[4];
@@ -1128,15 +1147,22 @@ void check_get(void) {
                {
 
                        cprintf("200 OK %s\n", internet_addr);
-                       CtdlLogPrintf(CTDL_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
+                       syslog(LOG_INFO, "sending 200 OK for the room %s\n", rcpt->display_recp);
                }
                else 
                {
                        cprintf("500 REJECT noone here by that name.\n");
                        
-                       CtdlLogPrintf(CTDL_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
+                       syslog(LOG_INFO, "sending 500 REJECT noone here by that name: %s\n", internet_addr);
                }
-               if (rcpt != NULL) free_recipients(rcpt);
+               if (rcpt != NULL) 
+                       free_recipients(rcpt);
+       }
+       else 
+       {
+               cprintf("500 REJECT invalid Query.\n");
+               
+               syslog(LOG_INFO, "sending 500 REJECT invalid Query: %s\n", internet_addr);
        }
 }
 
@@ -1148,22 +1174,22 @@ void check_get_greeting(void) {
 /*
  * We don't know if the Contacts room exists so we just create it at login
  */
-void vcard_create_room(void)
+void vcard_CtdlCreateRoom(void)
 {
        struct ctdlroom qr;
-       struct visit vbuf;
+       visit vbuf;
 
        /* Create the calendar room if it doesn't already exist */
-       create_room(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
+       CtdlCreateRoom(USERCONTACTSROOM, 4, "", 0, 1, 0, VIEW_ADDRESSBOOK);
 
        /* Set expiration policy to manual; otherwise objects will be lost! */
-       if (lgetroom(&qr, USERCONTACTSROOM)) {
-               CtdlLogPrintf(CTDL_ERR, "Couldn't get the user CONTACTS room!\n");
+       if (CtdlGetRoomLock(&qr, USERCONTACTSROOM)) {
+               syslog(LOG_ERR, "Couldn't get the user CONTACTS room!\n");
                return;
        }
        qr.QRep.expire_mode = EXPIRE_MANUAL;
        qr.QRdefaultview = VIEW_ADDRESSBOOK;    /* 2 = address book view */
-       lputroom(&qr);
+       CtdlPutRoomLock(&qr);
 
        /* Set the view to a calendar view */
        CtdlGetRelationship(&vbuf, &CC->user, &qr);
@@ -1215,7 +1241,7 @@ void vcard_session_login_hook(void) {
        /*
         * Create the user's 'Contacts' room (personal address book) if it doesn't already exist.
         */
-       vcard_create_room();
+       vcard_CtdlCreateRoom();
 }
 
 
@@ -1297,15 +1323,14 @@ void strip_addresses_already_have(long msgnum, void *userdata) {
  */
 void store_this_ha(struct addresses_to_be_filed *aptr) {
        struct CtdlMessage *vmsg = NULL;
-       long vmsgnum = (-1L);
        char *ser = NULL;
        struct vCard *v = NULL;
        char recipient[256];
        int i;
 
        /* First remove any addresses we already have in the address book */
-       usergoto(aptr->roomname, 0, 0, NULL, NULL);
-       CtdlForEachMessage(MSGS_ALL, 0, NULL, "^[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
+       CtdlUserGoto(aptr->roomname, 0, 0, NULL, NULL);
+       CtdlForEachMessage(MSGS_ALL, 0, NULL, "[Tt][Ee][Xx][Tt]/.*[Vv][Cc][Aa][Rr][Dd]$", NULL,
                strip_addresses_already_have, aptr->collected_addresses);
 
        if (!IsEmptyStr(aptr->collected_addresses))
@@ -1333,8 +1358,8 @@ void store_this_ha(struct addresses_to_be_filed *aptr) {
                        }
                        vcard_free(v);
 
-                       CtdlLogPrintf(CTDL_DEBUG, "Adding contact: %s\n", recipient);
-                       vmsgnum = CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
+                       syslog(LOG_DEBUG, "Adding contact: %s\n", recipient);
+                       CtdlSubmitMsg(vmsg, NULL, aptr->roomname, QP_EADDR);
                        CtdlFreeMessage(vmsg);
                }
        }
@@ -1423,13 +1448,13 @@ CTDL_MODULE_INIT(vcard)
                CtdlRegisterFixedOutputHook("text/vcard", vcard_fixed_output);
 
                /* Create the Global ADdress Book room if necessary */
-               create_room(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
+               CtdlCreateRoom(ADDRESS_BOOK_ROOM, 3, "", 0, 1, 0, VIEW_ADDRESSBOOK);
 
                /* Set expiration policy to manual; otherwise objects will be lost! */
-               if (!lgetroom(&qr, ADDRESS_BOOK_ROOM)) {
+               if (!CtdlGetRoomLock(&qr, ADDRESS_BOOK_ROOM)) {
                        qr.QRep.expire_mode = EXPIRE_MANUAL;
                        qr.QRdefaultview = VIEW_ADDRESSBOOK;    /* 2 = address book view */
-                       lputroom(&qr);
+                       CtdlPutRoomLock(&qr);
 
                        /*
                         * Also make sure it has a netconfig file, so the networker runs
@@ -1441,6 +1466,9 @@ CTDL_MODULE_INIT(vcard)
                        fp = fopen(filename, "a");
                        if (fp != NULL) fclose(fp);
                        rv = chown(filename, CTDLUID, (-1));
+                       if (rv == -1)
+                               syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n", 
+                                      filename, strerror(errno));
                }
 
                /* for postfix tcpdict */
@@ -1452,6 +1480,6 @@ CTDL_MODULE_INIT(vcard)
                                        CitadelServiceDICT_TCP);
        }
        
-       /* return our Subversion id for the Log */
-       return "$Id$";
+       /* return our module name for the log */
+       return "vcard";
 }