5 * Does all this gloriously nifty connection handling stuff...
14 #include <sys/socket.h>
15 #include <netinet/in.h>
19 * aim_connrst - Clears out connection list, killing remaining connections.
20 * @sess: Session to be cleared
22 * Clears out the connection list and kills any connections left.
25 faim_internal void aim_connrst(struct aim_session_t *sess)
27 faim_mutex_init(&sess->connlistlock);
29 struct aim_conn_t *cur = sess->connlist, *tmp;
38 sess->connlist = NULL;
43 * aim_conn_init - Reset a connection to default values.
44 * @deadconn: Connection to be reset
46 * Initializes and/or resets a connection structure.
49 static void aim_conn_init(struct aim_conn_t *deadconn)
55 deadconn->subtype = -1;
58 deadconn->lastactivity = 0;
59 deadconn->forcedlatency = 0;
60 deadconn->handlerlist = NULL;
61 deadconn->priv = NULL;
62 faim_mutex_init(&deadconn->active);
63 faim_mutex_init(&deadconn->seqnum_lock);
69 * aim_conn_getnext - Gets a new connection structure.
72 * Allocate a new empty connection structure.
75 faim_internal struct aim_conn_t *aim_conn_getnext(struct aim_session_t *sess)
77 struct aim_conn_t *newconn, *cur;
79 if (!(newconn = malloc(sizeof(struct aim_conn_t))))
82 memset(newconn, 0, sizeof(struct aim_conn_t));
83 aim_conn_init(newconn);
86 faim_mutex_lock(&sess->connlistlock);
87 if (sess->connlist == NULL)
88 sess->connlist = newconn;
90 for (cur = sess->connlist; cur->next; cur = cur->next)
94 faim_mutex_unlock(&sess->connlistlock);
100 * aim_conn_kill - Close and free a connection.
101 * @sess: Session for the connection
102 * @deadconn: Connection to be freed
104 * Close, clear, and free a connection structure. Should never be
105 * called from within libfaim.
108 faim_export void aim_conn_kill(struct aim_session_t *sess, struct aim_conn_t **deadconn)
110 struct aim_conn_t *cur;
112 if (!deadconn || !*deadconn)
115 aim_tx_cleanqueue(sess, *deadconn);
117 faim_mutex_lock(&sess->connlistlock);
118 if (sess->connlist == NULL)
120 else if (sess->connlist->next == NULL) {
121 if (sess->connlist == *deadconn)
122 sess->connlist = NULL;
124 cur = sess->connlist;
126 if (cur->next == *deadconn) {
127 cur->next = cur->next->next;
133 faim_mutex_unlock(&sess->connlistlock);
135 /* XXX: do we need this for txqueue too? */
136 aim_rxqueue_cleanbyconn(sess, *deadconn);
138 if ((*deadconn)->fd != -1)
139 aim_conn_close(*deadconn);
140 if ((*deadconn)->priv)
141 free((*deadconn)->priv);
149 * aim_conn_close - Close a connection
150 * @deadconn: Connection to close
152 * Close (but not free) a connection.
154 * This leaves everything untouched except for clearing the
155 * handler list and setting the fd to -1 (used to recognize
159 faim_export void aim_conn_close(struct aim_conn_t *deadconn)
162 faim_mutex_destroy(&deadconn->active);
163 faim_mutex_destroy(&deadconn->seqnum_lock);
164 if (deadconn->fd >= 3)
167 if (deadconn->handlerlist)
168 aim_clearhandlers(deadconn);
174 * aim_getconn_type - Find a connection of a specific type
175 * @sess: Session to search
176 * @type: Type of connection to look for
178 * Searches for a connection of the specified type in the
179 * specified session. Returns the first connection of that
183 faim_export struct aim_conn_t *aim_getconn_type(struct aim_session_t *sess,
186 struct aim_conn_t *cur;
188 faim_mutex_lock(&sess->connlistlock);
189 for (cur = sess->connlist; cur; cur = cur->next) {
190 if ((cur->type == type) && !(cur->status & AIM_CONN_STATUS_INPROGRESS))
193 faim_mutex_unlock(&sess->connlistlock);
198 * aim_proxyconnect - An extrememly quick and dirty SOCKS5 interface.
199 * @sess: Session to connect
200 * @host: Host to connect to
201 * @port: Port to connect to
202 * @statusret: Return value of the connection
204 * Attempts to connect to the specified host via the configured
205 * proxy settings, if present. If no proxy is configured for
206 * this session, the connection is done directly.
209 static int aim_proxyconnect(struct aim_session_t *sess,
210 char *host, unsigned short port,
215 if (strlen(sess->socksproxy.server)) { /* connecting via proxy */
217 unsigned char buf[512];
218 struct sockaddr_in sa;
221 unsigned short proxyport = 1080;
223 for(i=0;i<(int)strlen(sess->socksproxy.server);i++) {
224 if (sess->socksproxy.server[i] == ':') {
225 proxyport = atoi(&(sess->socksproxy.server[i+1]));
229 proxy = (char *)malloc(i+1);
230 strncpy(proxy, sess->socksproxy.server, i);
233 if (!(hp = gethostbyname(proxy))) {
234 faimdprintf(sess, 0, "proxyconnect: unable to resolve proxy name\n");
235 *statusret = (h_errno | AIM_CONN_STATUS_RESOLVERR);
240 memset(&sa.sin_zero, 0, 8);
241 sa.sin_port = htons(proxyport);
242 memcpy(&sa.sin_addr, hp->h_addr, hp->h_length);
243 sa.sin_family = hp->h_addrtype;
245 fd = socket(hp->h_addrtype, SOCK_STREAM, 0);
246 if (connect(fd, (struct sockaddr *)&sa, sizeof(struct sockaddr_in)) < 0) {
247 faimdprintf(sess, 0, "proxyconnect: unable to connect to proxy\n");
253 buf[0] = 0x05; /* SOCKS version 5 */
254 if (strlen(sess->socksproxy.username)) {
255 buf[1] = 0x02; /* two methods */
256 buf[2] = 0x00; /* no authentication */
257 buf[3] = 0x02; /* username/password authentication */
265 if (write(fd, buf, i) < i) {
271 if (read(fd, buf, 2) < 2) {
277 if ((buf[0] != 0x05) || (buf[1] == 0xff)) {
283 /* check if we're doing username authentication */
284 if (buf[1] == 0x02) {
285 i = aimutil_put8(buf, 0x01); /* version 1 */
286 i += aimutil_put8(buf+i, strlen(sess->socksproxy.username));
287 i += aimutil_putstr(buf+i, sess->socksproxy.username, strlen(sess->socksproxy.username));
288 i += aimutil_put8(buf+i, strlen(sess->socksproxy.password));
289 i += aimutil_putstr(buf+i, sess->socksproxy.password, strlen(sess->socksproxy.password));
290 if (write(fd, buf, i) < i) {
295 if (read(fd, buf, 2) < 2) {
300 if ((buf[0] != 0x01) || (buf[1] != 0x00)) {
307 i = aimutil_put8(buf, 0x05);
308 i += aimutil_put8(buf+i, 0x01); /* CONNECT */
309 i += aimutil_put8(buf+i, 0x00); /* reserved */
310 i += aimutil_put8(buf+i, 0x03); /* address type: host name */
311 i += aimutil_put8(buf+i, strlen(host));
312 i += aimutil_putstr(buf+i, host, strlen(host));
313 i += aimutil_put16(buf+i, port);
315 if (write(fd, buf, i) < i) {
320 if (read(fd, buf, 10) < 10) {
325 if ((buf[0] != 0x05) || (buf[1] != 0x00)) {
331 } else { /* connecting directly */
332 struct sockaddr_in sa;
335 if (!(hp = gethostbyname(host))) {
336 *statusret = (h_errno | AIM_CONN_STATUS_RESOLVERR);
340 memset(&sa, 0, sizeof(struct sockaddr_in));
341 sa.sin_port = htons(port);
342 memcpy(&sa.sin_addr, hp->h_addr, hp->h_length);
343 sa.sin_family = hp->h_addrtype;
345 fd = socket(hp->h_addrtype, SOCK_STREAM, 0);
347 if (sess->flags & AIM_SESS_FLAGS_NONBLOCKCONNECT)
348 fcntl(fd, F_SETFL, O_NONBLOCK); /* XXX save flags */
350 if (connect(fd, (struct sockaddr *)&sa, sizeof(struct sockaddr_in)) < 0) {
351 if (sess->flags & AIM_SESS_FLAGS_NONBLOCKCONNECT) {
352 if ((errno == EINPROGRESS) || (errno == EINTR)) {
354 *statusret |= AIM_CONN_STATUS_INPROGRESS;
366 * aim_cloneconn - clone an aim_conn_t
367 * @sess: session containing parent
368 * @src: connection to clone
370 * A new connection is allocated, and the values are filled in
371 * appropriately. Note that this function sets the new connnection's
372 * ->priv pointer to be equal to that of its parent: only the pointer
373 * is copied, not the data it points to.
375 * This function returns a pointer to the new aim_conn_t, or %NULL on
378 faim_internal struct aim_conn_t *aim_cloneconn(struct aim_session_t *sess,
379 struct aim_conn_t *src)
381 struct aim_conn_t *conn;
382 struct aim_rxcblist_t *cur;
384 if (!(conn = aim_conn_getnext(sess)))
387 faim_mutex_lock(&conn->active);
390 conn->type = src->type;
391 conn->subtype = src->subtype;
392 conn->seqnum = src->seqnum;
393 conn->priv = src->priv;
394 conn->lastactivity = src->lastactivity;
395 conn->forcedlatency = src->forcedlatency;
397 /* clone handler list */
398 for (cur = src->handlerlist; cur; cur = cur->next) {
399 aim_conn_addhandler(sess, conn, cur->family, cur->type,
400 cur->handler, cur->flags);
403 faim_mutex_unlock(&conn->active);
409 * aim_newconn - Open a new connection
410 * @sess: Session to create connection in
411 * @type: Type of connection to create
412 * @dest: Host to connect to (in "host:port" syntax)
414 * Opens a new connection to the specified dest host of specified
415 * type, using the proxy settings if available. If @host is %NULL,
416 * the connection is allocated and returned, but no connection
419 * FIXME: Return errors in a more sane way.
422 faim_export struct aim_conn_t *aim_newconn(struct aim_session_t *sess,
423 int type, char *dest)
425 struct aim_conn_t *connstruct;
427 u_short port = FAIM_LOGIN_PORT;
431 if ((connstruct=aim_conn_getnext(sess))==NULL)
434 faim_mutex_lock(&connstruct->active);
436 connstruct->type = type;
438 if (!dest) { /* just allocate a struct */
440 connstruct->status = 0;
441 faim_mutex_unlock(&connstruct->active);
446 * As of 23 Jul 1999, AOL now sends the port number, preceded by a
447 * colon, in the BOS redirect. This fatally breaks all previous
448 * libfaims. Bad, bad AOL.
450 * We put this here to catch every case.
454 for(i=0;i<(int)strlen(dest);i++) {
455 if (dest[i] == ':') {
456 port = atoi(&(dest[i+1]));
460 host = (char *)malloc(i+1);
461 strncpy(host, dest, i);
464 if ((ret = aim_proxyconnect(sess, host, port, &connstruct->status)) < 0) {
466 connstruct->status = (errno | AIM_CONN_STATUS_CONNERR);
468 faim_mutex_unlock(&connstruct->active);
471 connstruct->fd = ret;
473 faim_mutex_unlock(&connstruct->active);
481 * aim_conngetmaxfd - Return the highest valued file discriptor in session
482 * @sess: Session to search
484 * Returns the highest valued filed descriptor of all open
485 * connections in @sess.
488 faim_export int aim_conngetmaxfd(struct aim_session_t *sess)
491 struct aim_conn_t *cur;
493 faim_mutex_lock(&sess->connlistlock);
494 for (cur = sess->connlist; cur; cur = cur->next) {
498 faim_mutex_unlock(&sess->connlistlock);
504 * aim_conn_in_sess - Predicate to test the precense of a connection in a sess
505 * @sess: Session to look in
506 * @conn: Connection to look for
508 * Searches @sess for the passed connection. Returns 1 if its present,
512 faim_export int aim_conn_in_sess(struct aim_session_t *sess, struct aim_conn_t *conn)
514 struct aim_conn_t *cur;
516 faim_mutex_lock(&sess->connlistlock);
517 for(cur = sess->connlist; cur; cur = cur->next)
519 faim_mutex_unlock(&sess->connlistlock);
522 faim_mutex_unlock(&sess->connlistlock);
527 * aim_select - Wait for a socket with data or timeout
528 * @sess: Session to wait on
529 * @timeout: How long to wait
530 * @status: Return status
532 * Waits for a socket with data or for timeout, whichever comes first.
535 * Return codes in *status:
536 * -1 error in select() (%NULL returned)
537 * 0 no events pending (%NULL returned)
538 * 1 outgoing data pending (%NULL returned)
539 * 2 incoming data pending (connection with pending data returned)
541 * XXX: we could probably stand to do a little courser locking here.
544 faim_export struct aim_conn_t *aim_select(struct aim_session_t *sess,
545 struct timeval *timeout,
548 struct aim_conn_t *cur;
551 int i, haveconnecting = 0;
553 faim_mutex_lock(&sess->connlistlock);
554 if (sess->connlist == NULL) {
555 faim_mutex_unlock(&sess->connlistlock);
559 faim_mutex_unlock(&sess->connlistlock);
565 faim_mutex_lock(&sess->connlistlock);
566 for (cur = sess->connlist; cur; cur = cur->next) {
568 /* don't let invalid/dead connections sit around */
570 faim_mutex_unlock(&sess->connlistlock);
572 } else if (cur->status & AIM_CONN_STATUS_INPROGRESS) {
573 FD_SET(cur->fd, &wfds);
577 FD_SET(cur->fd, &fds);
581 faim_mutex_unlock(&sess->connlistlock);
584 * If we have data waiting to be sent, return
586 * We have to not do this if theres at least one
587 * connection thats still connecting, since that connection
588 * may have queued data and this return would prevent
589 * the connection from ever completing! This is a major
590 * inadequacy of the libfaim way of doing things. It means
591 * that nothing can transmit as long as there's connecting
594 * But its still better than having blocking connects.
597 if (!haveconnecting && (sess->queue_outgoing != NULL)) {
602 if ((i = select(maxfd+1, &fds, &wfds, NULL, timeout))>=1) {
603 faim_mutex_lock(&sess->connlistlock);
604 for (cur = sess->connlist; cur; cur = cur->next) {
605 if ((FD_ISSET(cur->fd, &fds)) ||
606 ((cur->status & AIM_CONN_STATUS_INPROGRESS) &&
607 FD_ISSET(cur->fd, &wfds))) {
609 faim_mutex_unlock(&sess->connlistlock);
610 return cur; /* XXX race condition here -- shouldnt unlock connlist */
613 *status = 0; /* shouldn't happen */
614 } else if ((i == -1) && (errno == EINTR)) /* treat interrupts as a timeout */
617 *status = i; /* can be 0 or -1 */
619 faim_mutex_unlock(&sess->connlistlock);
621 return NULL; /* no waiting or error, return */
625 * aim_conn_isready - Test if a connection is marked ready
626 * @conn: Connection to test
628 * Returns true if the connection is ready, false otherwise.
629 * Returns -1 if the connection is invalid.
631 * XXX: This is deprecated.
634 faim_export int aim_conn_isready(struct aim_conn_t *conn)
637 return (conn->status & 0x0001);
642 * aim_conn_setstatus - Set the status of a connection
644 * @status: New status
646 * @newstatus is %XOR'd with the previous value of the connection
647 * status and returned. Returns -1 if the connection is invalid.
649 * This isn't real useful.
652 faim_export int aim_conn_setstatus(struct aim_conn_t *conn, int status)
659 faim_mutex_lock(&conn->active);
660 val = conn->status ^= status;
661 faim_mutex_unlock(&conn->active);
667 * aim_conn_setlatency - Set a forced latency value for connection
668 * @conn: Conn to set latency for
669 * @newval: Number of seconds to force between transmits
671 * Causes @newval seconds to be spent between transmits on a connection.
673 * This is my lame attempt at overcoming not understanding the rate
676 * XXX: This should really be replaced with something that scales and
677 * backs off like the real rate limiting does.
680 faim_export int aim_conn_setlatency(struct aim_conn_t *conn, int newval)
685 faim_mutex_lock(&conn->active);
686 conn->forcedlatency = newval;
687 conn->lastactivity = 0; /* reset this just to make sure */
688 faim_mutex_unlock(&conn->active);
694 * aim_setupproxy - Configure a proxy for this session
695 * @sess: Session to set proxy for
696 * @server: SOCKS server
697 * @username: SOCKS username
698 * @password: SOCKS password
700 * Call this with your SOCKS5 proxy server parameters before
701 * the first call to aim_newconn(). If called with all %NULL
702 * args, it will clear out a previously set proxy.
704 * Set username and password to %NULL if not applicable.
707 faim_export void aim_setupproxy(struct aim_session_t *sess, char *server, char *username, char *password)
709 /* clear out the proxy info */
710 if (!server || !strlen(server)) {
711 memset(sess->socksproxy.server, 0, sizeof(sess->socksproxy.server));
712 memset(sess->socksproxy.username, 0, sizeof(sess->socksproxy.username));
713 memset(sess->socksproxy.password, 0, sizeof(sess->socksproxy.password));
717 strncpy(sess->socksproxy.server, server, sizeof(sess->socksproxy.server));
718 if (username && strlen(username))
719 strncpy(sess->socksproxy.username, username, sizeof(sess->socksproxy.username));
720 if (password && strlen(password))
721 strncpy(sess->socksproxy.password, password, sizeof(sess->socksproxy.password));
725 static void defaultdebugcb(struct aim_session_t *sess, int level, const char *format, va_list va)
727 vfprintf(stderr, format, va);
731 * aim_session_init - Initializes a session structure
732 * @sess: Session to initialize
733 * @flags: Flags to use. Any of %AIM_SESS_FLAGS %OR'd together.
734 * @debuglevel: Level of debugging output (zero is least)
736 * Sets up the initial values for a session.
739 faim_export void aim_session_init(struct aim_session_t *sess, unsigned long flags, int debuglevel)
744 memset(sess, 0, sizeof(struct aim_session_t));
746 sess->queue_outgoing = NULL;
747 sess->queue_incoming = NULL;
748 sess->pendingjoin = NULL;
749 sess->pendingjoinexchange = 0;
750 aim_initsnachash(sess);
751 sess->msgcookies = NULL;
752 sess->snac_nextid = 0x00000001;
755 sess->debug = debuglevel;
756 sess->debugcb = defaultdebugcb;
758 sess->modlistv = NULL;
761 * Default to SNAC login unless XORLOGIN is explicitly set.
763 if (!(flags & AIM_SESS_FLAGS_XORLOGIN))
764 sess->flags |= AIM_SESS_FLAGS_SNACLOGIN;
765 sess->flags |= flags;
768 * This must always be set. Default to the queue-based
769 * version for back-compatibility.
771 aim_tx_setenqueue(sess, AIM_TX_QUEUED, NULL);
775 * Register all the modules for this session...
777 aim__registermodule(sess, misc_modfirst); /* load the catch-all first */
778 aim__registermodule(sess, buddylist_modfirst);
779 aim__registermodule(sess, admin_modfirst);
780 aim__registermodule(sess, bos_modfirst);
781 aim__registermodule(sess, search_modfirst);
782 aim__registermodule(sess, stats_modfirst);
783 aim__registermodule(sess, auth_modfirst);
784 aim__registermodule(sess, msg_modfirst);
785 aim__registermodule(sess, chatnav_modfirst);
786 aim__registermodule(sess, chat_modfirst);
787 aim__registermodule(sess, locate_modfirst);
788 aim__registermodule(sess, general_modfirst);
794 * aim_session_kill - Deallocate a session
795 * @sess: Session to kill
799 faim_export void aim_session_kill(struct aim_session_t *sess)
804 aim__shutdownmodules(sess);
810 * aim_setdebuggingcb - Set the function to call when outputting debugging info
811 * @sess: Session to change
812 * @cb: Function to call
814 * The function specified is called whenever faimdprintf() is used within
815 * libfaim, and the session's debugging level is greater tha nor equal to
816 * the value faimdprintf was called with.
819 faim_export int aim_setdebuggingcb(struct aim_session_t *sess, faim_debugging_callback_t cb)
831 * aim_conn_isconnecting - Determine if a connection is connecting
832 * @conn: Connection to examine
834 * Returns nonzero if the connection is in the process of
835 * connecting (or if it just completed and aim_conn_completeconnect()
836 * has yet to be called on it).
839 faim_export int aim_conn_isconnecting(struct aim_conn_t *conn)
843 return (conn->status & AIM_CONN_STATUS_INPROGRESS)?1:0;
846 faim_export int aim_conn_completeconnect(struct aim_session_t *sess, struct aim_conn_t *conn)
850 int res, error = ETIMEDOUT;
851 aim_rxcallback_t userfunc;
853 if (!conn || (conn->fd == -1))
856 if (!(conn->status & AIM_CONN_STATUS_INPROGRESS))
860 FD_SET(conn->fd, &fds);
862 FD_SET(conn->fd, &wfds);
866 if ((res = select(conn->fd+1, &fds, &wfds, NULL, &tv)) == -1) {
868 aim_conn_close(conn);
871 } else if (res == 0) {
872 faimdprintf(sess, 0, "aim_conn_completeconnect: false alarm on %d\n", conn->fd);
873 return 0; /* hasn't really completed yet... */
876 if (FD_ISSET(conn->fd, &fds) || FD_ISSET(conn->fd, &wfds)) {
877 int len = sizeof(error);
879 if (getsockopt(conn->fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
884 aim_conn_close(conn);
889 fcntl(conn->fd, F_SETFL, 0); /* XXX should restore original flags */
891 conn->status &= ~AIM_CONN_STATUS_INPROGRESS;
893 if ((userfunc = aim_callhandler(sess, conn, AIM_CB_FAM_SPECIAL, AIM_CB_SPECIAL_CONNCOMPLETE)))
894 userfunc(sess, NULL, conn);
896 /* Flush out the queues if there was something waiting for this conn */
897 aim_tx_flushqueue(sess);
905 * Closes -ALL- open connections.
908 faim_export int aim_logoff(struct aim_session_t *sess)
911 aim_connrst(sess); /* in case we want to connect again */