Back to index

citadel  8.12
Classes | Defines | Typedefs | Functions | Variables
citserver.h File Reference
#include "serv_extensions.h"
#include "context.h"

Go to the source code of this file.

Classes

struct  RoomProcList
struct  UserProcList

Defines

#define CTDLUSERIP   (IsEmptyStr(CC->cs_addr) ? CC->cs_clientinfo: CC->cs_addr)

Typedefs

typedef struct RoomProcList

Functions

void cit_backtrace (void)
void cit_oneline_backtrace (void)
void cit_panic_backtrace (int SigNum)
void master_startup (void)
void master_cleanup (int exitcode)
void set_wtmpsupp (char *newtext)
void set_wtmpsupp_to_current_room (void)
void do_command_loop (void)
void do_async_loop (void)
void begin_session (struct CitContext *con)
void citproto_begin_session (void)
void citproto_begin_admin_session (void)
void GenerateRoomDisplay (char *real_room, CitContext *viewed, CitContext *viewer)
char CtdlCheckExpress (void)

Variables

int panic_fd
time_t server_startup_time
int openid_level_supported

Class Documentation

struct RoomProcList

Definition at line 18 of file citserver.h.

Collaboration diagram for RoomProcList:
Class Members
long key
char lcname
char name
long namelen
struct RoomProcList * next
long QRNum
struct UserProcList

Definition at line 26 of file citserver.h.

Collaboration diagram for UserProcList:
Class Members
struct UserProcList * next
char user

Define Documentation

#define CTDLUSERIP   (IsEmptyStr(CC->cs_addr) ? CC->cs_clientinfo: CC->cs_addr)

Definition at line 31 of file citserver.h.


Typedef Documentation

typedef struct RoomProcList

Definition at line 17 of file citserver.h.


Function Documentation

void begin_session ( struct CitContext con)

Definition at line 859 of file citserver.c.

{
       /* 
        * Initialize some variables specific to our context.
        */
       con->logged_in = 0;
       con->internal_pgm = 0;
       con->download_fp = NULL;
       con->upload_fp = NULL;
       con->cached_msglist = NULL;
       con->cached_num_msgs = 0;
       con->FirstExpressMessage = NULL;
       time(&con->lastcmd);
       time(&con->lastidle);
       strcpy(con->lastcmdname, "    ");
       strcpy(con->cs_clientname, "(unknown)");
       strcpy(con->curr_user, NLI);
       *con->net_node = '\0';
       *con->fake_username = '\0';
       *con->fake_hostname = '\0';
       *con->fake_roomname = '\0';
       *con->cs_clientinfo = '\0';
       safestrncpy(con->cs_host, config.c_fqdn, sizeof con->cs_host);
       safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
       con->cs_UDSclientUID = -1;
       con->cs_host[sizeof con->cs_host - 1] = 0;
       if (!CC->is_local_socket) {
              locate_host(con->cs_host, sizeof con->cs_host,
                     con->cs_addr, sizeof con->cs_addr,
                     con->client_socket
              );
       }
       else {
              con->cs_host[0] = 0;
              con->cs_addr[0] = 0;
#ifdef HAVE_STRUCT_UCRED
              {
                     /* as http://www.wsinnovations.com/softeng/articles/uds.html told us... */
                     struct ucred credentials;
                     socklen_t ucred_length = sizeof(struct ucred);
                     
                     /*fill in the user data structure */
                     if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
                            syslog(LOG_NOTICE, "could obtain credentials from unix domain socket");
                            
                     }
                     else {        
                            /* the process ID of the process on the other side of the socket */
                            /* credentials.pid; */
                            
                            /* the effective UID of the process on the other side of the socket  */
                            con->cs_UDSclientUID = credentials.uid;
                            
                            /* the effective primary GID of the process on the other side of the socket */
                            /* credentials.gid; */
                            
                            /* To get supplemental groups, we will have to look them up in our account
                               database, after a reverse lookup on the UID to get the account name.
                               We can take this opportunity to check to see if this is a legit account.
                            */
                            snprintf(con->cs_clientinfo, sizeof(con->cs_clientinfo),
                                    "PID: "F_PID_T"; UID: "F_UID_T"; GID: "F_XPID_T" ", 
                                    credentials.pid,
                                    credentials.uid,
                                    credentials.gid);
                     }
              }
#endif
       }
       con->cs_flags = 0;
       con->upload_type = UPL_FILE;
       con->dl_is_net = 0;

       con->nologin = 0;
       if (((config.c_maxsessions > 0)&&(num_sessions > config.c_maxsessions)) || CtdlWantSingleUser()) {
              con->nologin = 1;
       }

       if (!CC->is_local_socket) {
              syslog(LOG_NOTICE, "Session (%s) started from %s (%s).\n", con->ServiceName, con->cs_host, con->cs_addr);
       }
       else {
              syslog(LOG_NOTICE, "Session (%s) started via local socket UID:%d.\n", con->ServiceName, con->cs_UDSclientUID);
       }

       /* Run any session startup routines registered by loadable modules */
       PerformSessionHooks(EVT_START);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void cit_backtrace ( void  )

Definition at line 90 of file citserver.c.

{
#ifdef HAVE_BACKTRACE
       void *stack_frames[50];
       size_t size, i;
       char **strings;


       size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
       strings = backtrace_symbols(stack_frames, size);
       for (i = 0; i < size; i++) {
              if (strings != NULL)
                     syslog(LOG_ALERT, "%s\n", strings[i]);
              else
                     syslog(LOG_ALERT, "%p\n", stack_frames[i]);
       }
       free(strings);
#endif
}

Here is the caller graph for this function:

void cit_oneline_backtrace ( void  )

Definition at line 110 of file citserver.c.

{
#ifdef HAVE_BACKTRACE
       void *stack_frames[50];
       size_t size, i;
       char **strings;
       StrBuf *Buf;

       size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
       strings = backtrace_symbols(stack_frames, size);
       if (size > 0)
       {
              Buf = NewStrBuf();
              for (i = 1; i < size; i++) {
                     if (strings != NULL)
                            StrBufAppendPrintf(Buf, "%s : ", strings[i]);
                     else
                            StrBufAppendPrintf(Buf, "%p : ", stack_frames[i]);
              }
              free(strings);
              syslog(LOG_ALERT, "%s\n", ChrPtr(Buf));
              FreeStrBuf(&Buf);
       }
#endif
}
void cit_panic_backtrace ( int  SigNum)

Definition at line 139 of file citserver.c.

{
#ifdef HAVE_BACKTRACE
       void *stack_frames[10];
       size_t size, i;
       char **strings;

       printf("caught signal 11\n");
       size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
       strings = backtrace_symbols(stack_frames, size);
       for (i = 0; i < size; i++) {
              if (strings != NULL)
                     syslog(LOG_ALERT, "%s\n", strings[i]);
              else
                     syslog(LOG_ALERT, "%p\n", stack_frames[i]);
       }
       free(strings);
#endif
       exit(-1);
}

Here is the caller graph for this function:

Definition at line 964 of file citserver.c.

                                    {
       CC->internal_pgm = 1;
       cprintf("%d %s Citadel server ADMIN CONNECTION ready.\n", CIT_OK, config.c_nodename);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void citproto_begin_session ( void  )

Definition at line 949 of file citserver.c.

                              {
       if (CC->nologin==1) {
              cprintf("%d %s: Too many users are already online (maximum is %d)\n",
                     ERROR + MAX_SESSIONS_EXCEEDED,
                     config.c_nodename, config.c_maxsessions
              );
              CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
       }
       else {
              cprintf("%d %s Citadel server ready.\n", CIT_OK, config.c_nodename);
              CC->can_receive_im = 1;
       }
}

Here is the call graph for this function:

Here is the caller graph for this function:

char CtdlCheckExpress ( void  )

Definition at line 328 of file citserver.c.

                            {
       if (CC->FirstExpressMessage == NULL) {
              return(' ');
       }
       else {
              return('*');
       }
}

Here is the caller graph for this function:

void do_async_loop ( void  )

Definition at line 1061 of file citserver.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void do_command_loop ( void  )

Definition at line 1000 of file citserver.c.

                           {
       char cmdbuf[SIZ];
       
       time(&CC->lastcmd);
       memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
       if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
              syslog(LOG_ERR, "Citadel client disconnected: ending session.\n");
              CC->kill_me = KILLME_CLIENT_DISCONNECTED;
              return;
       }

       /* Log the server command, but don't show passwords... */
       if ( (strncasecmp(cmdbuf, "PASS", 4)) && (strncasecmp(cmdbuf, "SETP", 4)) ) {
              syslog(LOG_INFO, "[%d][%s(%ld)] %s",
                     CC->cs_pid, CC->curr_user, CC->user.usernum, cmdbuf
              );
       }
       else {
              syslog(LOG_INFO, "[%d][%s(%ld)] <password command hidden from log>",
                     CC->cs_pid, CC->curr_user, CC->user.usernum
              );
       }

       buffer_output();

       /*
        * Let other clients see the last command we executed, and
        * update the idle time, but not NOOP, QNOP, PEXP, GEXP, RWHO, or TIME.
        */
       if ( (strncasecmp(cmdbuf, "NOOP", 4))
          && (strncasecmp(cmdbuf, "QNOP", 4))
          && (strncasecmp(cmdbuf, "PEXP", 4))
          && (strncasecmp(cmdbuf, "GEXP", 4))
          && (strncasecmp(cmdbuf, "RWHO", 4))
          && (strncasecmp(cmdbuf, "TIME", 4)) ) {
              strcpy(CC->lastcmdname, "    ");
              safestrncpy(CC->lastcmdname, cmdbuf, sizeof(CC->lastcmdname));
              time(&CC->lastidle);
       }
       
       if ((strncasecmp(cmdbuf, "ENT0", 4))
          && (strncasecmp(cmdbuf, "MESG", 4))
          && (strncasecmp(cmdbuf, "MSGS", 4)))
       {
          CC->cs_flags &= ~CS_POSTING;
       }
                 
       if (!DLoader_Exec_Cmd(cmdbuf)) {
              cprintf("%d Unrecognized or unsupported command.\n", ERROR + CMD_NOT_SUPPORTED);
       }      

       unbuffer_output();

       /* Run any after-each-command routines registered by modules */
       PerformSessionHooks(EVT_CMD);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void GenerateRoomDisplay ( char *  real_room,
CitContext viewed,
CitContext viewer 
)

Definition at line 643 of file citserver.c.

                                         {

       int ra;

       strcpy(real_room, viewed->room.QRname);
       if (viewed->room.QRflags & QR_MAILBOX) {
              strcpy(real_room, &real_room[11]);
       }
       if (viewed->room.QRflags & QR_PRIVATE) {
              CtdlRoomAccess(&viewed->room, &viewer->user, &ra, NULL);
              if ( (ra & UA_KNOWN) == 0) {
                     strcpy(real_room, " ");
              }
       }

       if (viewed->cs_flags & CS_CHAT) {
              while (strlen(real_room) < 14) {
                     strcat(real_room, " ");
              }
              strcpy(&real_room[14], "<chat>");
       }

}

Here is the call graph for this function:

Here is the caller graph for this function:

void master_cleanup ( int  exitcode)

Definition at line 221 of file citserver.c.

                                  {
       struct CleanupFunctionHook *fcn;
       static int already_cleaning_up = 0;

       if (already_cleaning_up) while(1) usleep(1000);
       already_cleaning_up = 1;

       /* Run any cleanup routines registered by loadable modules */
       for (fcn = CleanupHookTable; fcn != NULL; fcn = fcn->next) {
              (*fcn->h_function_pointer)();
       }

       /* Close the AdjRefCount queue file */
       AdjRefCount(-1, 0);

       /* Do system-dependent stuff */
       sysdep_master_cleanup();
       
       /* Close databases */
       syslog(LOG_INFO, "Closing databases\n");
       close_databases();

       /* If the operator requested a halt but not an exit, halt here. */
       if (shutdown_and_halt) {
              syslog(LOG_NOTICE, "citserver: Halting server without exiting.\n");
              fflush(stdout); fflush(stderr);
              while(1) {
                     sleep(32767);
              }
       }
       
       release_control();

       /* Now go away. */
       syslog(LOG_NOTICE, "citserver: Exiting with status %d\n", exitcode);
       fflush(stdout); fflush(stderr);
       
       if (restart_server != 0)
              exit(1);
       if ((running_as_daemon != 0) && ((exitcode == 0) ))
              exitcode = CTDLEXIT_SHUTDOWN;
       exit(exitcode);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void master_startup ( void  )

Definition at line 163 of file citserver.c.

                          {
       struct timeval tv;
       unsigned int seed;
       FILE *urandom;
       struct ctdlroom qrbuf;
       int rv;
       
       syslog(LOG_DEBUG, "master_startup() started\n");
       time(&server_startup_time);
       get_config();

       syslog(LOG_INFO, "Opening databases\n");
       open_databases();
       check_ref_counts();

       syslog(LOG_INFO, "Creating base rooms (if necessary)\n");
       CtdlCreateRoom(config.c_baseroom,  0, "", 0, 1, 0, VIEW_BBS);
       CtdlCreateRoom(AIDEROOM,           3, "", 0, 1, 0, VIEW_BBS);
       CtdlCreateRoom(SYSCONFIGROOM,             3, "", 0, 1, 0, VIEW_BBS);
       CtdlCreateRoom(config.c_twitroom,  0, "", 0, 1, 0, VIEW_BBS);

       /* The "Local System Configuration" room doesn't need to be visible */
        if (CtdlGetRoomLock(&qrbuf, SYSCONFIGROOM) == 0) {
                qrbuf.QRflags2 |= QR2_SYSTEM;
                CtdlPutRoomLock(&qrbuf);
        }

       /* Aide needs to be public postable, else we're not RFC conformant. */
        if (CtdlGetRoomLock(&qrbuf, AIDEROOM) == 0) {
                qrbuf.QRflags2 |= QR2_SMTP_PUBLIC;
                CtdlPutRoomLock(&qrbuf);
        }

       syslog(LOG_INFO, "Seeding the pseudo-random number generator...\n");
       urandom = fopen("/dev/urandom", "r");
       if (urandom != NULL) {
              rv = fread(&seed, sizeof seed, 1, urandom);
              if (rv == -1)
                     syslog(LOG_EMERG, "failed to read random seed: %s\n", 
                            strerror(errno));
              fclose(urandom);
       }
       else {
              gettimeofday(&tv, NULL);
              seed = tv.tv_usec;
       }
       srand(seed);
       srandom(seed);

       put_config();

       syslog(LOG_DEBUG, "master_startup() finished\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void set_wtmpsupp ( char *  newtext)

Variable Documentation

Definition at line 85 of file citserver.c.

int panic_fd

Definition at line 84 of file citserver.c.

Definition at line 83 of file citserver.c.