]> code.citadel.org Git - citadel.git/blobdiff - citadel/modules/ctdlproto/serv_user.c
I was checking something in serv_user.c and just couldn't help myself -- style cleanup
[citadel.git] / citadel / modules / ctdlproto / serv_user.c
index a3238a522c9663e36cc5f074ae1ba8edf8058f3f..4829a5e1d130f20c90d50ffbfd854771c4d4b9b3 100644 (file)
@@ -1,16 +1,14 @@
-/* 
- * Server functions which perform operations on user objects.
- *
- * Copyright (c) 1987-2017 by the citadel.org team
- *
- * This program is open source software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License, version 3.
- *
- * 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.
- */
+// Server functions which perform operations on user objects.
+//
+// Copyright (c) 1987-2022 by the citadel.org team
+//
+// This program is open source software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License, version 3.
+//
+// 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.
 
 
 #include "support.h"
 #include "internet_addressing.h"
 
 
-/*
- * USER cmd
- */
-void cmd_user(char *cmdbuf)
-{
+// USER command -- attempt to log in as an existing user
+void cmd_user(char *cmdbuf) {
        char username[256];
        int a;
 
@@ -34,7 +29,7 @@ void cmd_user(char *cmdbuf)
        striplt(username);
        syslog(LOG_DEBUG, "user_ops: cmd_user(%s)", username);
 
-       a = CtdlLoginExistingUser(NULL, username);
+       a = CtdlLoginExistingUser(username);
        switch (a) {
        case login_already_logged_in:
                cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
@@ -47,8 +42,7 @@ void cmd_user(char *cmdbuf)
                        CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions"));
                return;
        case login_ok:
-               cprintf("%d Password required for %s\n",
-                       MORE_DATA, CC->curr_user);
+               cprintf("%d Password required for %s\n", MORE_DATA, CC->curr_user);
                return;
        case login_not_found:
                cprintf("%d %s not found.\n", ERROR + NO_SUCH_USER, username);
@@ -59,8 +53,8 @@ void cmd_user(char *cmdbuf)
 }
 
 
-void cmd_pass(char *buf)
-{
+// PASS command -- complete logging in as an existing user (used after USER returns MORE_DATA)
+void cmd_pass(char *buf) {
        char password[SIZ];
        int a;
        long len;
@@ -87,11 +81,8 @@ void cmd_pass(char *buf)
 }
 
 
-/*
- * cmd_newu()  -  create a new user account and log in as that user
- */
-void cmd_newu(char *cmdbuf)
-{
+// cmd_newu()  -  create a new user account and log in as that user
+void cmd_newu(char *cmdbuf) {
        int a;
        char username[SIZ];
 
@@ -102,8 +93,7 @@ void cmd_newu(char *cmdbuf)
        }
 
        if (CtdlGetConfigInt("c_disable_newu")) {
-               cprintf("%d Self-service user account creation "
-                       "is disabled on this system.\n", ERROR + NOT_HERE);
+               cprintf("%d Self-service user account creation is disabled on this system.\n", ERROR + NOT_HERE);
                return;
        }
 
@@ -127,34 +117,35 @@ void cmd_newu(char *cmdbuf)
 
        if ((!strcasecmp(username, "bbs")) ||
            (!strcasecmp(username, "new")) ||
-           (!strcasecmp(username, "."))) {
+           (!strcasecmp(username, "."))
+       ) {
                cprintf("%d '%s' is an invalid login name.\n", ERROR + ILLEGAL_VALUE, username);
                return;
        }
 
-       a = create_user(username, CREATE_USER_BECOME_USER);
+       a = create_user(username, CREATE_USER_BECOME_USER, NATIVE_AUTH_UID);
 
        if (a == 0) {
                logged_in_response();
-       } else if (a == ERROR + ALREADY_EXISTS) {
+       }
+       else if (a == ERROR + ALREADY_EXISTS) {
                cprintf("%d '%s' already exists.\n",
                        ERROR + ALREADY_EXISTS, username);
                return;
-       } else if (a == ERROR + INTERNAL_ERROR) {
+       }
+       else if (a == ERROR + INTERNAL_ERROR) {
                cprintf("%d Internal error - user record disappeared?\n",
                        ERROR + INTERNAL_ERROR);
                return;
-       } else {
+       }
+       else {
                cprintf("%d unknown error\n", ERROR + INTERNAL_ERROR);
        }
 }
 
 
-/*
- * set password - citadel protocol implementation
- */
-void cmd_setp(char *new_pw)
-{
+// set password - citadel protocol implementation
+void cmd_setp(char *new_pw) {
        if (CtdlAccessCheck(ac_logged_in)) {
                return;
        }
@@ -162,11 +153,6 @@ void cmd_setp(char *new_pw)
                cprintf("%d Not allowed.  Use the 'passwd' command.\n", ERROR + NOT_HERE);
                return;
        }
-       if (CC->is_master) {
-               cprintf("%d The master prefix password cannot be changed with this command.\n",
-                       ERROR + NOT_HERE);
-               return;
-       }
 
        if (!strcasecmp(new_pw, "GENERATE_RANDOM_PASSWORD")) {
                char random_password[17];
@@ -186,11 +172,8 @@ void cmd_setp(char *new_pw)
 }
 
 
-/*
- * cmd_creu() - administratively create a new user account (do not log in to it)
- */
-void cmd_creu(char *cmdbuf)
-{
+// cmd_creu() - administratively create a new user account (do not log in to it)
+void cmd_creu(char *cmdbuf) {
        int a;
        char username[SIZ];
        char password[SIZ];
@@ -210,7 +193,7 @@ void cmd_creu(char *cmdbuf)
 
        extract_token(password, cmdbuf, 1, '|', sizeof password);
 
-       a = create_user(username, CREATE_USER_DO_NOT_BECOME_USER);
+       a = create_user(username, CREATE_USER_DO_NOT_BECOME_USER, NATIVE_AUTH_UID);
 
        if (a == 0) {
                if (!IsEmptyStr(password)) {
@@ -220,38 +203,37 @@ void cmd_creu(char *cmdbuf)
                }
                cprintf("%d User '%s' created %s.\n", CIT_OK, username, (!IsEmptyStr(password)) ? "and password set" : "with no password");
                return;
-       } else if (a == ERROR + ALREADY_EXISTS) {
+       }
+       else if (a == ERROR + ALREADY_EXISTS) {
                cprintf("%d '%s' already exists.\n", ERROR + ALREADY_EXISTS, username);
                return;
-       } else if ( (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) && (a == ERROR + NO_SUCH_USER) ) {
+       }
+       else if ( (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) && (a == ERROR + NO_SUCH_USER) ) {
                cprintf("%d User accounts are not created within Citadel in host authentication mode.\n", ERROR + NO_SUCH_USER);
                return;
-       } else {
+       }
+       else {
                cprintf("%d An error occurred creating the user account.\n", ERROR + INTERNAL_ERROR);
        }
 }
 
 
-/*
- * get user parameters
- */
-void cmd_getu(char *cmdbuf)
-{
-       if (CtdlAccessCheck(ac_logged_in))
+// get user parameters
+void cmd_getu(char *cmdbuf) {
+       if (CtdlAccessCheck(ac_logged_in)) {
                return;
+       }
 
        CtdlGetUser(&CC->user, CC->curr_user);
        cprintf("%d 80|24|%d|\n", CIT_OK, (CC->user.flags & US_USER_SET));
 }
 
 
-/*
- * set user parameters
- */
-void cmd_setu(char *new_parms)
-{
-       if (CtdlAccessCheck(ac_logged_in))
+// set user parameters
+void cmd_setu(char *new_parms) {
+       if (CtdlAccessCheck(ac_logged_in)) {
                return;
+       }
 
        if (num_parms(new_parms) < 3) {
                cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
@@ -265,11 +247,8 @@ void cmd_setu(char *new_parms)
 }
 
 
-/*
- * set last read pointer
- */
-void cmd_slrp(char *new_ptr)
-{
+// set last read pointer (marks all messages in the current room as read, up to the specified point)
+void cmd_slrp(char *new_ptr) {
        long newlr;
        visit vbuf;
        visit original_vbuf;
@@ -280,7 +259,8 @@ void cmd_slrp(char *new_ptr)
 
        if (!strncasecmp(new_ptr, "highest", 7)) {
                newlr = CC->room.QRhighest;
-       } else {
+       }
+       else {
                newlr = atol(new_ptr);
        }
 
@@ -291,9 +271,10 @@ void cmd_slrp(char *new_ptr)
        vbuf.v_lastseen = newlr;
        snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld", newlr);
 
-       /* Only rewrite the record if it changed */
-       if ( (vbuf.v_lastseen != original_vbuf.v_lastseen)
-          || (strcmp(vbuf.v_seen, original_vbuf.v_seen)) ) {
+       // Only rewrite the record if it changed
+       if (    (vbuf.v_lastseen != original_vbuf.v_lastseen)
+               || (strcmp(vbuf.v_seen, original_vbuf.v_seen))
+       ) {
                CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
        }
 
@@ -331,7 +312,7 @@ void cmd_gtsn(char *argbuf) {
                return;
        }
 
-       /* Learn about the user and room in question */
+       // Learn about the user and room in question
        CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 
        cprintf("%d ", CIT_OK);
@@ -340,27 +321,24 @@ void cmd_gtsn(char *argbuf) {
 }
 
 
-/*
- * INVT and KICK commands
- */
+// INVT and KICK commands (grant/revoke access to an invitation-only room)
 void cmd_invt_kick(char *iuser, int op) {
 
-       /*
-        * These commands are only allowed by admins, room admins,
-        * and room namespace owners
-        */
+       // These commands are only allowed by admins, room admins,
+       // and room namespace owners
        if (is_room_aide()) {
-               /* access granted */
-       } else if ( ((atol(CC->room.QRname) == CC->user.usernum) ) && (CC->user.usernum != 0) ) {
-               /* access granted */
-       } else {
-               /* access denied */
+               // access granted
+       }
+       else if ( ((atol(CC->room.QRname) == CC->user.usernum) ) && (CC->user.usernum != 0) ) {
+               // access granted
+       }
+       else {
+               // access denied
                cprintf("%d Higher access or room ownership required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
                return;
        }
 
-       if (!strncasecmp(CC->room.QRname, CtdlGetConfigStr("c_baseroom"),
-                        ROOMNAMELEN)) {
+       if (!strncasecmp(CC->room.QRname, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
                cprintf("%d Can't add/remove users from this room.\n", ERROR + NOT_HERE);
                return;
        }
@@ -388,11 +366,8 @@ void cmd_kick(char *iuser) {
 }
 
 
-/*
- * forget (Zap) the current room
- */
-void cmd_forg(char *argbuf)
-{
+// forget (Zap) the current room
+void cmd_forg(char *argbuf) {
 
        if (CtdlAccessCheck(ac_logged_in)) {
                return;
@@ -407,11 +382,8 @@ void cmd_forg(char *argbuf)
 }
 
 
-/*
- * Get Next Unregistered User
- */
-void cmd_gnur(char *argbuf)
-{
+// Get Next Unregistered User
+void cmd_gnur(char *argbuf) {
        struct cdbdata *cdbus;
        struct ctdluser usbuf;
 
@@ -424,9 +396,7 @@ void cmd_gnur(char *argbuf)
                return;
        }
 
-       /* There are unvalidated users.  Traverse the user database,
-        * and return the first user we find that needs validation.
-        */
+       // There are unvalidated users.  Traverse the user database, and return the first user we find that needs validation.
        cdb_rewind(CDB_USERS);
        while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
                memset(&usbuf, 0, sizeof(struct ctdluser));
@@ -439,10 +409,7 @@ void cmd_gnur(char *argbuf)
                }
        }
 
-       /* If we get to this point, there are no more unvalidated users.
-        * Therefore we clear the "users need validation" flag.
-        */
-
+       // If we get to this point, there are no more unvalidated users.  Therefore we clear the "users need validation" flag.
        begin_critical_section(S_CONTROL);
        int flags;
        flags = CtdlGetConfigInt("MMflags");
@@ -453,11 +420,8 @@ void cmd_gnur(char *argbuf)
 }
 
 
-/*
- * validate a user
- */
-void cmd_vali(char *v_args)
-{
+// validate a user
+void cmd_vali(char *v_args) {
        char user[128];
        int newax;
        struct ctdluser userbuf;
@@ -479,7 +443,7 @@ void cmd_vali(char *v_args)
 
        CtdlPutUserLock(&userbuf);
 
-       /* If the access level was set to zero, delete the user */
+       // If the access level was set to zero, delete the user
        if (newax == 0) {
                if (purge_user(user) == 0) {
                        cprintf("%d %s Deleted.\n", CIT_OK, userbuf.fullname);
@@ -489,11 +453,39 @@ void cmd_vali(char *v_args)
        cprintf("%d User '%s' validated.\n", CIT_OK, userbuf.fullname);
 }
 
-/* 
- *  List users (searchstring may be empty to list all users)
- */
-void cmd_list(char *cmdbuf)
-{
+
+// List one user (this works with cmd_list)
+void ListThisUser(char *username, void *data) {
+       char *searchstring;
+       struct ctdluser usbuf;
+
+       if (CtdlGetUser(&usbuf, username) != 0) {
+               return;
+       }
+
+       searchstring = (char *)data;
+       if (bmstrcasestr(usbuf.fullname, searchstring) == NULL) {
+               return;
+       }
+
+       if (usbuf.axlevel > AxDeleted) {
+               if ((CC->user.axlevel >= AxAideU)
+                   || ((usbuf.flags & US_UNLISTED) == 0)
+                   || ((CC->internal_pgm))) {
+                       cprintf("%s|%d|%ld|%ld|%ld|%ld||\n",
+                               usbuf.fullname,
+                               usbuf.axlevel,
+                               usbuf.usernum,
+                               (long)usbuf.lastcall,
+                               usbuf.timescalled,
+                               usbuf.posted);
+               }
+       }
+}
+
+
+//  List users (searchstring may be empty to list all users)
+void cmd_list(char *cmdbuf) {
        char searchstring[256];
        extract_token(searchstring, cmdbuf, 0, '|', sizeof searchstring);
        striplt(searchstring);
@@ -503,11 +495,8 @@ void cmd_list(char *cmdbuf)
 }
 
 
-/*
- * assorted info we need to check at login
- */
-void cmd_chek(char *argbuf)
-{
+// assorted info we need to check at login
+void cmd_chek(char *argbuf) {
        int mail = 0;
        int regis = 0;
        int vali = 0;
@@ -528,31 +517,25 @@ void cmd_chek(char *argbuf)
        }
 
        mail = InitialMailCheck();              // check for mail
-
        cprintf("%d %d|%d|%d|%s|\n", CIT_OK, mail, regis, vali, CC->cs_inet_email);
 }
 
 
-/*
- * check to see if a user exists
- */
-void cmd_qusr(char *who)
-{
+// check to see if a user exists
+void cmd_qusr(char *who) {
        struct ctdluser usbuf;
 
        if (CtdlGetUser(&usbuf, who) == 0) {
                cprintf("%d %s\n", CIT_OK, usbuf.fullname);
-       } else {
+       }
+       else {
                cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
        }
 }
 
 
-/*
- * Administrative Get User Parameters
- */
-void cmd_agup(char *cmdbuf)
-{
+// Administrative Get User Parameters
+void cmd_agup(char *cmdbuf) {
        struct ctdluser usbuf;
        char requested_user[128];
 
@@ -579,11 +562,8 @@ void cmd_agup(char *cmdbuf)
 }
 
 
-/*
- * Administrative Set User Parameters
- */
-void cmd_asup(char *cmdbuf)
-{
+// Administrative Set User Parameters
+void cmd_asup(char *cmdbuf) {
        struct ctdluser usbuf;
        char requested_user[128];
        char notify[SIZ];
@@ -643,9 +623,7 @@ void cmd_asup(char *cmdbuf)
 }
 
 
-/*
- * Citadel protocol command to do the same
- */
+// Citadel protocol command to do the same
 void cmd_isme(char *argbuf) {
        char addr[256];
 
@@ -662,11 +640,8 @@ void cmd_isme(char *argbuf) {
 }
 
 
-/*
- * Administrative Get Email Addresses
- */
-void cmd_agea(char *cmdbuf)
-{
+// Retrieve all Internet email addresses/aliases for the specified user
+void cmd_agea(char *cmdbuf) {
        struct ctdluser usbuf;
        char requested_user[128];
        int i, num_e;
@@ -691,17 +666,13 @@ void cmd_agea(char *cmdbuf)
 }
 
 
-/*
- * Administrative Set Email Addresses
- */
-void cmd_asea(char *cmdbuf)
-{
+// Set the Internet email addresses/aliases for the specified user
+void cmd_asea(char *cmdbuf) {
        struct ctdluser usbuf;
        char requested_user[128];
        char buf[SIZ];
        char whodat[64];
        char new_emailaddrs[512] = { 0 } ;
-       int i;
 
        if (CtdlAccessCheck(ac_aide)) return;
 
@@ -713,15 +684,20 @@ void cmd_asea(char *cmdbuf)
 
        cprintf("%d Ok\n", SEND_LISTING);
        while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
-               if (                                                                                    // addresses must be:
-                       (!IsEmptyStr(buf))                                                              // non-empty
-                       && ((strlen(new_emailaddrs) + strlen(buf) + 2) < sizeof(new_emailaddrs))        // fit in the remaining buffer
-                       && (IsDirectory(buf, 0))                                                        // in one of our own domains
-                       && (                                                                            // not belong to someone else
-                               (CtdlDirectoryLookup(whodat, buf, sizeof whodat) != 0)
-                               || (!strcasecmp(whodat, requested_user))
-                       )
-               ) {
+               if (IsEmptyStr(buf)) {
+                       syslog(LOG_ERR, "user_ops: address <%s> is empty - not using", buf);
+               }
+               else if ((strlen(new_emailaddrs) + strlen(buf) + 2) > sizeof(new_emailaddrs)) {
+                       syslog(LOG_ERR, "user_ops: address <%s> does not fit in buffer - not using", buf);
+               }
+               else if (!IsDirectory(buf, 0)) {
+                       syslog(LOG_ERR, "user_ops: address <%s> is not in one of our domains - not using", buf);
+               }
+               else if ( (CtdlDirectoryLookup(whodat, buf, sizeof whodat) == 0) && (CtdlUserCmp(whodat, requested_user)) ) {
+                       syslog(LOG_ERR, "user_ops: address <%s> already belongs to <%s> - not using", buf, whodat);
+               }
+               else {
+                       syslog(LOG_DEBUG, "user_ops: address <%s> validated", buf);
                        if (!IsEmptyStr(new_emailaddrs)) {
                                strcat(new_emailaddrs, "|");
                        }
@@ -729,31 +705,11 @@ void cmd_asea(char *cmdbuf)
                }
        }
 
-       if (CtdlGetUserLock(&usbuf, requested_user) != 0) {     // We are relying on the fact that the DirectoryIndex functions don't lock.
-               return;                                         // Silently fail here if we can't acquire a lock on the user record.
-       }
-
-       /* Delete all of the existing directory index records for the user (easier this way) */
-       for (i=0; i<num_tokens(usbuf.emailaddrs, '|'); ++i) {
-               extract_token(buf, usbuf.emailaddrs, i, '|', sizeof buf);
-               CtdlDirectoryDelUser(buf, requested_user);
-       }
-
-       strcpy(usbuf.emailaddrs, new_emailaddrs);               // make it official.
-
-       /* Index all of the new email addresses (they've already been sanitized) */
-       for (i=0; i<num_tokens(usbuf.emailaddrs, '|'); ++i) {
-               extract_token(buf, usbuf.emailaddrs, i, '|', sizeof buf);
-               CtdlDirectoryAddUser(buf, requested_user);
-       }
-
-       CtdlPutUserLock(&usbuf);
+       CtdlSetEmailAddressesForUser(requested_user, new_emailaddrs);
 }
 
 
-/*
- * Set the preferred view for the current user/room combination
- */
+// Set the preferred view for the current user/room combination
 void cmd_view(char *cmdbuf) {
        int requested_view;
        visit vbuf;
@@ -772,11 +728,8 @@ void cmd_view(char *cmdbuf) {
 }
 
 
-/*
- * Rename a user
- */
-void cmd_renu(char *cmdbuf)
-{
+// Rename a user
+void cmd_renu(char *cmdbuf) {
        int retcode;
        char oldname[USERNAME_SIZE];
        char newname[USERNAME_SIZE];
@@ -810,15 +763,13 @@ void cmd_renu(char *cmdbuf)
 }
 
 
-void cmd_quit(char *argbuf)
-{
+void cmd_quit(char *argbuf) {
        cprintf("%d Goodbye.\n", CIT_OK);
        CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
 }
 
 
-void cmd_lout(char *argbuf)
-{
+void cmd_lout(char *argbuf) {
        if (CC->logged_in) 
                CtdlUserLogout();
        cprintf("%d logged out.\n", CIT_OK);