jsm.h

Go to the documentation of this file.

/*
 * Copyrights
 * 
 * Portions created by or assigned to Jabber.com, Inc. are 
 * Copyright (c) 1999-2002 Jabber.com, Inc.  All Rights Reserved.  Contact
 * information for Jabber.com, Inc. is available at http://www.jabber.com/.
 *
 * Portions Copyright (c) 1998-1999 Jeremie Miller.
 *
 * Portions Copyright (c) 2006-2007 Matthias Wimmer
 *
 * This file is part of jabberd14.
 *
 * This software 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 2 of the
 * License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 */

#include "jabberd.h"

#define SESSION_WAITERS 10

#define HOSTS_PRIME 17  
#define USERS_PRIME 3001 
typedef int event;

#define e_SESSION  0

#define e_OFFLINE  1

#define e_SERVER   2

#define e_DELIVER  3

#define e_SHUTDOWN 4

#define e_AUTH     5

#define e_REGISTER 6

#define e_CREATE   7

#define e_DELETE   8

#define e_DESERIALIZE 9

#define e_PRE_REGISTER 10

#define e_PASSWORDCHANGE 11

#define e_FILTER_IN 12

#define e_FILTER_OUT 13

#define e_ROSTERCHANGE 14

/* always add new event types here, to maintain backwards binary compatibility */
#define e_LAST     15  
/* session event types */

#define es_IN      0

#define es_OUT     1

#define es_END     2

#define es_SERIALIZE 3

#define es_FILTER_IN 4

#define es_FILTER_OUT 5

/* always add new event types here, to maintain backwards binary compatibility */
#define es_LAST    6  
/* admin user account flags */
#define ADMIN_MOTD      "motd"          
#define ADMIN_LISTSESSIONS "listsessions"       
#define ADMIN_ADMINMSG  "adminmsg"      
#define ADMIN_SHOWPRES  "showpres"      
#define ADMIN_DYNAMIC   "dynamic"       
typedef enum {
    M_PASS,   
    M_IGNORE, 
    M_HANDLED 
} mreturn;

typedef struct udata_struct *udata,     
        _udata;                         
typedef struct session_struct *session, 
        _session;                       
typedef struct jsmi_struct *jsmi,       
        _jsmi;                          
typedef struct mapi_struct {
    jsmi si;            
    jpacket packet;     
    event e;            
    udata user;         
    session s;          
    xmlnode serialization_node; 
    jpacket additional_result; 
} *mapi, _mapi;

typedef mreturn (*mcall)(mapi m, void *arg);

typedef struct mlist_struct
{
    mcall c;                    
    void *arg;                  
    unsigned char mask;         
    struct mlist_struct *next;  
} *mlist, _mlist;

struct history_storage_conf {
    int general:1;              
    int offline:1;              
    int special:1;              
};

struct jsmi_struct {
    instance i;                 
    /* xmlnode config; */
    xht hosts;                  
    xht sc_sessions;            
    xht std_namespace_prefixes; 
    xdbcache xc;                
    mlist events[e_LAST];       
    pool p;                     
    struct history_storage_conf history_sent; 
    struct history_storage_conf history_recv; 
    char *statefile;            
    char *auth;                 
};

struct udata_struct
{
    jid id;                    
    jid utrust;                
    jid useen;          
    jsmi si;                   
    session sessions;          
    int ref;                   
    pool p;
    xht aux_data;               
};

xmlnode js_config(jsmi si, const char* query, const char* lang);

udata js_user(jsmi si, jid id, xht ht);
int js_user_create(jsmi si, jid id);
int js_user_delete(jsmi si, jid id);
void js_deliver(jsmi si, jpacket p, session sending_s);


struct session_struct {
    /* general session data */
    jsmi si;                    
    char *res;                  
    jid id;                     
    udata u;                    
    xmlnode presence;           
    int priority;               
    int roster;
    int c_in;                   
    int c_out;                  
    time_t started;             
    /* mechanics */
    pool p;                     
    int exit_flag;              
    mlist events[es_LAST];      
    mtq q;                      
    /* our routed id, and remote session id */
    jid route;          
    jid sid;            
    char *sc_c2s;       
    char *sc_sm;        
    xht aux_data;       
    struct session_struct *next; 
};

#define PACKET_FROM_OFFLINE_MAGIC 1768189505

#define PACKET_FORCE_SENT_MAGIC 1836017748

#define PACKET_PASS_FILTERS_MAGIC 20060704

session js_session_new(jsmi si, dpacket p);
session js_sc_session_new(jsmi si, dpacket p, xmlnode sc_session);
void js_session_end(session s, char *reason);
session js_session_get(udata user, char const* res);
session js_session_primary(udata user);
void js_session_to(session s, jpacket p);
void js_session_from(session s, jpacket p);
void js_session_free_aux_data(void* arg);

void js_server_main(void *arg);
void js_offline_main(void *arg);
result js_users_gc(void *arg);

typedef struct jpq_struct {
    jsmi si;            
    jpacket p;          
} _jpq, *jpq;

void js_psend(jsmi si, jpacket p, mtq_callback f); /* sends p to a function */

void js_bounce_xmpp(jsmi si, session s, xmlnode x, xterror xterr); /* logic to bounce packets w/o looping, eats x and delivers error */

void js_mapi_register(jsmi si, event e, mcall c, void *arg);
void js_mapi_session(event e, session s, mcall c, void *arg);
int js_mapi_call(jsmi si, event e, jpacket packet, udata user, session s);
int js_mapi_call2(jsmi si, event e, jpacket packet, udata user, session s, xmlnode serialization_node);
void js_mapi_create_additional_iq_result(mapi m, const char* name, const char *prefix, const char *ns_iri);

void js_authreg(void *arg);

/* we have acl.c now
int js_admin(udata u, int flag);
*/

result js_packet(instance i, dpacket p, void *arg);
int js_islocal(jsmi si, jid id);
int js_trust(udata u, jid id); /* checks if id is trusted by user u */
jid js_trustees(udata u); /* returns list of trusted jids */
jid js_seen_jids(udata u); /* returns list of trusted jids */
void js_remove_trustee(udata u, jid id); /* removes a user from the list of trustees */
int js_seen(udata u, jid id); /* checks if a ID is seen by user u */
void js_remove_seen(udata u, jid id); /* removes a user from the list of seen JIDs */
int js_online(mapi m); /* logic to tell if this is a go-online call */

void jsm_shutdown(void *arg);

void jsm_serialize(jsmi si);
void jsm_deserialize(jsmi si, const char *host);