source: trunk/libtransmission/upnp.c @ 1420

Last change on this file since 1420 was 1420, checked in by titer, 15 years ago

Officially give up on making libT reentrant, and simplify our code instead

  • Property svn:keywords set to Date Rev Author Id
File size: 37.6 KB
Line 
1/******************************************************************************
2 * $Id: upnp.c 1420 2007-01-21 07:16:18Z titer $
3 *
4 * Copyright (c) 2006 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#include "transmission.h"
26
27#define SSDP_ADDR               "239.255.255.250"
28#define SSDP_PORT               1900
29#define SSDP_TYPE               "upnp:rootdevice"
30#define SSDP_SUBTYPE            "ssdp:alive"
31#define SSDP_FIRST_DELAY        3750    /* 3 3/4 seconds */
32#define SSDP_MAX_DELAY          1800000 /* 30 minutes */
33#define UPNP_SERVICE_TYPE       "urn:schemas-upnp-org:service:WANIPConnection:1"
34#define SOAP_ENVELOPE           "http://schemas.xmlsoap.org/soap/envelope/"
35#define LOOP_DETECT_THRESHOLD   10 /* error on 10 add/get/del state changes */
36#define MAPPING_CHECK_INTERVAL  900000 /* 15 minutes */
37#define HTTP_REQUEST_INTERVAL   500 /* half a second */
38#define SOAP_METHOD_NOT_ALLOWED 405
39#define IGD_GENERIC_ERROR       500
40#define IGD_GENERIC_FAILED      501
41#define IGD_NO_MAPPING_EXISTS   714
42#define IGD_ADD_CONFLICT        718
43#define IGD_NO_DYNAMIC_MAPPING  725
44
45typedef struct tr_upnp_action_s
46{
47    char * name;
48    char * action;
49    int    len;
50    struct { char * name; char * var; char dir; } * args;
51} tr_upnp_action_t;
52
53typedef struct tr_upnp_device_s
54{
55    char                    * id;
56    char                    * host;
57    char                    * root;
58    int                       port;
59    char                    * soap;
60    char                    * scpd;
61    int                       mappedport;
62    char                    * myaddr;
63#define UPNPDEV_STATE_ROOT              1
64#define UPNPDEV_STATE_SCPD              2
65#define UPNPDEV_STATE_READY             3
66#define UPNPDEV_STATE_ADD               4
67#define UPNPDEV_STATE_GET               5
68#define UPNPDEV_STATE_DEL               6
69#define UPNPDEV_STATE_MAPPED            7
70#define UPNPDEV_STATE_ERROR             8
71    uint8_t                   state;
72    uint8_t                   looping;
73    uint64_t                  lastrequest;
74    uint64_t                  lastcheck;
75    unsigned int              soapretry : 1;
76    tr_http_t               * http;
77    tr_upnp_action_t          getcmd;
78    tr_upnp_action_t          addcmd;
79    tr_upnp_action_t          delcmd;
80    struct tr_upnp_device_s * next;
81} tr_upnp_device_t;
82
83struct tr_upnp_s
84{
85    int                port;
86    int                infd;
87    int                outfd;
88    uint64_t           lastdiscover;
89    uint64_t           lastdelay;
90    unsigned int       active : 1;
91    unsigned int       discovering : 1;
92    tr_upnp_device_t * devices;
93    tr_lock_t          lock;
94};
95
96static int
97sendSSDP( int fd );
98static int
99mcastStart();
100static void
101killSock( int * sock );
102static void
103killHttp( tr_http_t ** http );
104static int
105watchSSDP( tr_upnp_device_t ** devices, int fd );
106static tr_tristate_t
107recvSSDP( int fd, char * buf, int * len );
108static int
109parseSSDP( char * buf, int len, tr_http_header_t * headers );
110static void
111deviceAdd( tr_upnp_device_t ** first, const char * id, int idLen,
112           const char * url, int urlLen );
113static void
114deviceRemove( tr_upnp_device_t ** prevptr );
115static int
116deviceStop( tr_upnp_device_t * dev );
117static int
118devicePulse( tr_upnp_device_t * dev, int port );
119static int
120devicePulseHttp( tr_upnp_device_t * dev,
121                 const char ** body, int * len );
122static tr_http_t *
123devicePulseGetHttp( tr_upnp_device_t * dev );
124static int
125parseRoot( const char *buf, int len, char ** soap, char ** scpd );
126static void
127addUrlbase( const char * base, char ** path );
128static int
129parseScpd( const char *buf, int len, tr_upnp_action_t * getcmd,
130           tr_upnp_action_t * addcmd, tr_upnp_action_t * delcmd );
131static int
132parseScpdArgs( const char * buf, const char * end,
133               tr_upnp_action_t * action, char dir );
134static int
135parseMapping( tr_upnp_device_t * dev, const char * buf, int len );
136static char *
137joinstrs( const char *, const char *, const char * );
138static tr_http_t *
139soapRequest( int retry, const char * host, int port, const char * path,
140             tr_upnp_action_t * action, ... );
141static void
142actionSetup( tr_upnp_action_t * action, const char * name, int prealloc );
143static void
144actionFree( tr_upnp_action_t * action );
145static int
146actionAdd( tr_upnp_action_t * action, char * name, char * var,
147                      char dir );
148#define actionLookupVar( act, nam, len, dir ) \
149    ( actionLookup( (act), (nam), (len), (dir), 0 ) )
150#define actionLookupName( act, var, len, dir ) \
151    ( actionLookup( (act), (var), (len), (dir), 1 ) )
152static const char *
153actionLookup( tr_upnp_action_t * action, const char * key, int len,
154              char dir, int getname );
155
156tr_upnp_t *
157tr_upnpInit()
158{
159    tr_upnp_t * upnp;
160
161    upnp = calloc( 1, sizeof( *upnp ) );
162    if( NULL == upnp )
163    {
164        return NULL;
165    }
166
167    upnp->infd     = -1;
168    upnp->outfd    = -1;
169
170    tr_lockInit( &upnp->lock );
171
172    return upnp;
173}
174
175void
176tr_upnpStart( tr_upnp_t * upnp )
177{
178    tr_lockLock( &upnp->lock );
179
180    if( !upnp->active )
181    {
182        tr_inf( "starting upnp" );
183        upnp->active = 1;
184        upnp->discovering = 1;
185        upnp->infd = mcastStart();
186        upnp->lastdiscover = 0;
187        upnp->lastdelay = SSDP_FIRST_DELAY / 2;
188    }
189
190    tr_lockUnlock( &upnp->lock );
191}
192
193void
194tr_upnpStop( tr_upnp_t * upnp )
195{
196    tr_lockLock( &upnp->lock );
197
198    if( upnp->active )
199    {
200        tr_inf( "stopping upnp" );
201        upnp->active = 0;
202        killSock( &upnp->infd );
203        killSock( &upnp->outfd );
204    }
205
206    tr_lockUnlock( &upnp->lock );
207}
208
209int
210tr_upnpStatus( tr_upnp_t * upnp )
211{
212    tr_upnp_device_t * ii;
213    int                ret;
214
215    tr_lockLock( &upnp->lock );
216
217    if( !upnp->active )
218    {
219        ret = ( NULL == upnp->devices ?
220                TR_NAT_TRAVERSAL_DISABLED : TR_NAT_TRAVERSAL_UNMAPPING );
221    }
222    else if( NULL == upnp->devices )
223    {
224        ret = TR_NAT_TRAVERSAL_NOTFOUND;
225    }
226    else
227    {
228        ret = TR_NAT_TRAVERSAL_MAPPING;
229        for( ii = upnp->devices; NULL != ii; ii = ii->next )
230        {
231            if( UPNPDEV_STATE_ERROR == ii->state )
232            {
233                ret = TR_NAT_TRAVERSAL_ERROR;
234            }
235            else if( 0 < ii->mappedport )
236            {
237                ret = TR_NAT_TRAVERSAL_MAPPED;
238                break;
239            }
240        }
241    }
242
243    tr_lockUnlock( &upnp->lock );
244
245    return ret;
246}
247
248void
249tr_upnpForwardPort( tr_upnp_t * upnp, int port )
250{
251    tr_lockLock( &upnp->lock );
252    tr_dbg( "upnp port changed from %i to %i", upnp->port, port );
253    upnp->port = port;
254    tr_lockUnlock( &upnp->lock );
255}
256
257void
258tr_upnpClose( tr_upnp_t * upnp )
259{
260    tr_upnpStop( upnp );
261
262    tr_lockLock( &upnp->lock );
263    while( NULL != upnp->devices )
264    {
265        deviceRemove( &upnp->devices );
266    }
267
268    tr_lockClose( &upnp->lock );
269    free( upnp );
270}
271
272void
273tr_upnpPulse( tr_upnp_t * upnp )
274{
275    tr_upnp_device_t ** ii;
276
277    tr_lockLock( &upnp->lock );
278
279    if( upnp->active )
280    {
281        /* pulse on all known devices */
282        upnp->discovering = 1;
283        for( ii = &upnp->devices; NULL != *ii; ii = &(*ii)->next )
284        {
285            if( devicePulse( *ii, upnp->port ) )
286            {
287                upnp->discovering = 0;
288            }
289        }
290
291        /* send an SSDP discover message */
292        if( upnp->discovering &&
293            upnp->lastdelay + upnp->lastdiscover < tr_date() )
294        {
295            upnp->outfd = sendSSDP( upnp->outfd );
296            upnp->lastdiscover = tr_date();
297            upnp->lastdelay = MIN( upnp->lastdelay * 2, SSDP_MAX_DELAY );
298        }
299
300        /* try to receive SSDP messages */
301        watchSSDP( &upnp->devices, upnp->infd );
302        if( watchSSDP( &upnp->devices, upnp->outfd ) )
303        {
304            killSock( &upnp->outfd );
305        }
306    }
307    else
308    {
309        /* delete all mappings then delete devices */
310        ii = &upnp->devices;
311        while( NULL != *ii )
312        {
313            if( deviceStop( *ii ) )
314            {
315                deviceRemove( ii );
316            }
317            else
318            {
319                devicePulse( *ii, 0 );
320                ii = &(*ii)->next;
321            }
322        }
323    }
324
325    tr_lockUnlock( &upnp->lock );
326}
327
328static int
329sendSSDP( int fd )
330{
331    char buf[102];
332    int  len;
333    struct sockaddr_in sin;
334
335    if( 0 > fd )
336    {
337        if( tr_fdSocketWillCreate( 0 ) )
338        {
339            return -1;
340        }
341        fd = tr_netBindUDP( 0 );
342        if( 0 > fd )
343        {
344            tr_fdSocketClosed( 0 );
345            return -1;
346        }
347    }
348
349    tr_dbg( "sending upnp ssdp discover message" );
350
351    len = snprintf( buf, sizeof( buf ),
352                    "M-SEARCH * HTTP/1.1\r\n"
353                    "Host: %s:%i\r\n"
354                    "Man: \"ssdp:discover\"\r\n"
355                    "ST: %s\r\n"
356                    "MX: 3\r\n"
357                    "\r\n",
358                    SSDP_ADDR, SSDP_PORT, SSDP_TYPE );
359
360    /* if this assertion ever fails then just increase the size of buf */
361    assert( (int) sizeof( buf ) > len );
362
363    memset( &sin, 0, sizeof( sin ) );
364    sin.sin_family      = AF_INET;
365    sin.sin_addr.s_addr = inet_addr( SSDP_ADDR );
366    sin.sin_port        = htons( SSDP_PORT );
367
368    if( 0 > sendto( fd, buf, len, 0,
369                    (struct sockaddr*) &sin, sizeof( sin ) ) )
370    {
371        if( EAGAIN != errno )
372        {
373            tr_err( "Could not send SSDP discover message (%s)",
374                    strerror( errno ) );
375        }
376        killSock( &fd );
377        return -1;
378    }
379
380    return fd;
381}
382
383static int
384mcastStart()
385{
386    int fd;
387    struct in_addr addr;
388
389    if( tr_fdSocketWillCreate( 0 ) )
390    {
391        return -1;
392    }
393
394    addr.s_addr = inet_addr( SSDP_ADDR );
395    fd = tr_netMcastOpen( SSDP_PORT, addr );
396    if( 0 > fd )
397    {
398        tr_fdSocketClosed( 0 );
399        return -1;
400    }
401
402    return fd;
403}
404
405static void
406killSock( int * sock )
407{
408    if( 0 <= *sock )
409    {
410        tr_netClose( *sock );
411        *sock = -1;
412        tr_fdSocketClosed( 0 );
413    }
414}
415
416static void
417killHttp( tr_http_t ** http )
418{
419    tr_httpClose( *http );
420    *http = NULL;
421    tr_fdSocketClosed( 0 );
422}
423
424static int
425watchSSDP( tr_upnp_device_t ** devices, int fd )
426{
427    /* XXX what if we get a huge SSDP packet? */
428    char buf[512];
429    int len;
430    tr_http_header_t hdr[] = {
431        /* first one must be type and second must be subtype */
432        { NULL,            NULL, 0 },
433        { "NTS",           NULL, 0 },
434        /* XXX should probably look at this
435           { "Cache-control", NULL, 0 }, */
436        { "Location",      NULL, 0 },
437        { "USN",           NULL, 0 },
438        { NULL,            NULL, 0 }
439    };
440    enum { OFF_TYPE = 0, OFF_SUBTYPE, OFF_LOC, OFF_ID };
441    int ret;
442
443    if( 0 > fd )
444    {
445        return 0;
446    }
447
448    ret = 0;
449    for(;;)
450    {
451        len = sizeof( buf );
452        switch( recvSSDP( fd, buf, &len ) )
453        {
454            case TR_NET_WAIT:
455                return ret;
456            case TR_NET_ERROR:
457                return 1;
458            case TR_NET_OK:
459                ret = 1;
460                if( parseSSDP( buf, len, hdr ) &&
461                    NULL != hdr[OFF_LOC].data &&
462                    NULL != hdr[OFF_ID].data )
463                {
464                    deviceAdd( devices, hdr[OFF_ID].data, hdr[OFF_ID].len,
465                               hdr[OFF_LOC].data, hdr[OFF_LOC].len );
466                }
467        }
468    }
469}
470
471static tr_tristate_t
472recvSSDP( int fd, char * buf, int * len )
473{
474    if( 0 > fd )
475    {
476        return TR_NET_ERROR;
477    }
478
479    *len = tr_netRecv( fd, ( uint8_t * ) buf, *len );
480    if( TR_NET_BLOCK & *len )
481    {
482        return TR_NET_WAIT;
483    }
484    else if( TR_NET_CLOSE & *len )
485    {
486        tr_err( "Could not receive SSDP message (%s)", strerror( errno ) );
487        return TR_NET_ERROR;
488    }
489    else
490    {
491        return TR_NET_OK;
492    }
493}
494
495static int
496parseSSDP( char * buf, int len, tr_http_header_t * hdr )
497{
498    char *method, *uri, *body;
499    int code;
500
501    body = NULL;
502    /* check for an HTTP NOTIFY request */
503    if( 0 <= tr_httpRequestType( buf, len, &method, &uri ) )
504    {
505        if( 0 == tr_strcasecmp( method, "NOTIFY" ) && 0 == strcmp( uri, "*" ) )
506        {
507            hdr[0].name = "NT";
508            body = tr_httpParse( buf, len, hdr );
509            if( NULL == hdr[1].name ||
510                0 != tr_strncasecmp( SSDP_SUBTYPE, hdr[1].data, hdr[1].len ) )
511            {
512                body = NULL;
513            }
514            else
515            {
516                tr_dbg( "found upnp ssdp notify request" );
517            }
518        }
519        free( method );
520        free( uri );
521    }
522    else
523    {
524        /* check for a response to our HTTP M-SEARCH request */
525        code = tr_httpResponseCode( buf, len );
526        if( TR_HTTP_STATUS_OK( code ) )
527        {
528            hdr[0].name = "ST";
529            body = tr_httpParse( buf, len, hdr );
530            if( NULL != body )
531            {
532                tr_dbg( "found upnp ssdp m-search response" );
533            }
534        }
535    }
536
537    /* did we find enough information to be useful? */
538    if( NULL != body )
539    {
540        /* the first header is the type */
541        if( NULL != hdr[0].data &&
542            0 == tr_strncasecmp( SSDP_TYPE, hdr[0].data, hdr[0].len ) )
543        {
544            return 1;
545        }
546    }
547
548    return 0;
549}
550
551static void
552deviceAdd( tr_upnp_device_t ** first, const char * id, int idLen,
553           const char * url, int urlLen )
554{
555    tr_upnp_device_t * ii;
556
557    for( ii = *first; NULL != ii; ii = ii->next )
558    {
559        if( 0 == tr_strncasecmp( ii->id, id, idLen ) )
560        {
561            /* this device may have gone away and came back, recheck it */
562            ii->lastcheck = 0;
563            return;
564        }
565    }
566
567    ii = malloc( sizeof( *ii ) );
568    if( NULL == ii )
569    {
570        return;
571    }
572    memset( ii, 0, sizeof( *ii ) );
573    if( tr_httpParseUrl( url, urlLen, &ii->host, &ii->port, &ii->root ) )
574    {
575        free( ii );
576        return;
577    }
578    ii->id = tr_dupstr( id, idLen );
579    ii->state = UPNPDEV_STATE_ROOT;
580    actionSetup( &ii->getcmd, "GetSpecificPortMappingEntry", 8 );
581    actionSetup( &ii->addcmd, "AddPortMapping", 8 );
582    actionSetup( &ii->delcmd, "DeletePortMapping", 3 );
583    ii->next = *first;
584    *first = ii;
585
586    tr_inf( "new upnp device %s, port %i, path %s",
587            ii->host, ii->port, ii->root );
588}
589
590static void
591deviceRemove( tr_upnp_device_t ** prevptr )
592{
593    tr_upnp_device_t * dead;
594
595    dead = *prevptr;
596    *prevptr = dead->next;
597
598    tr_inf( "forgetting upnp device %s", dead->host );
599
600    free( dead->id );
601    free( dead->host );
602    free( dead->root );
603    free( dead->soap );
604    free( dead->scpd );
605    free( dead->myaddr );
606    if( NULL != dead->http )
607    {
608        killHttp( &dead->http );
609    }
610    actionFree( &dead->getcmd );
611    actionFree( &dead->addcmd );
612    actionFree( &dead->delcmd );
613    free( dead );
614}
615
616static int
617deviceStop( tr_upnp_device_t * dev )
618{
619    switch( dev->state )
620    {
621        case UPNPDEV_STATE_READY:
622        case UPNPDEV_STATE_ERROR:
623            return 1;
624        case UPNPDEV_STATE_MAPPED:
625            tr_dbg( "upnp device %s: stopping upnp, state mapped -> delete",
626                dev->host );
627            dev->state = UPNPDEV_STATE_DEL;
628            return 0;
629        default:
630            return 0;
631    }
632}
633
634static int
635devicePulse( tr_upnp_device_t * dev, int port )
636{
637    const char * body;
638    int          len, code;
639    uint8_t      laststate;
640
641    switch( dev->state )
642    {
643        case UPNPDEV_STATE_READY:
644            if( 0 < port )
645            {
646                tr_dbg( "upnp device %s: want mapping, state ready -> get",
647                        dev->host );
648                dev->mappedport = port;
649                dev->state = UPNPDEV_STATE_GET;
650                break;
651            }
652            return 1;
653        case UPNPDEV_STATE_MAPPED:
654            if( port != dev->mappedport )
655            {
656                tr_dbg( "upnp device %s: change mapping, "
657                        "state mapped -> delete", dev->host );
658                dev->state = UPNPDEV_STATE_DEL;
659                break;
660            }
661            if( tr_date() > dev->lastcheck + MAPPING_CHECK_INTERVAL )
662            {
663                tr_dbg( "upnp device %s: check mapping, "
664                        "state mapped -> get", dev->host );
665                dev->state = UPNPDEV_STATE_GET;
666            }
667            return 1;
668        case UPNPDEV_STATE_ERROR:
669            return 0;
670    }
671
672    /* gcc can be pretty annoying about it's warnings sometimes */
673    len = 0;
674    body = NULL;
675
676    code = devicePulseHttp( dev, &body, &len );
677    if( 0 > code )
678    {
679        return 1;
680    }
681
682    if( LOOP_DETECT_THRESHOLD <= dev->looping )
683    {
684        tr_dbg( "upnp device %s: loop detected, state %hhu -> error",
685                dev->host, dev->state );
686        dev->state = UPNPDEV_STATE_ERROR;
687        dev->looping = 0;
688        killHttp( &dev->http );
689        return 1;
690    }
691
692    laststate = dev->state;
693    dev->state = UPNPDEV_STATE_ERROR;
694    switch( laststate ) 
695    {
696        case UPNPDEV_STATE_ROOT:
697            if( !TR_HTTP_STATUS_OK( code ) )
698            {
699                tr_dbg( "upnp device %s: fetch root failed with http code %i",
700                        dev->host, code );
701            }
702            else if( parseRoot( body, len, &dev->soap, &dev->scpd ) )
703            {
704                tr_dbg( "upnp device %s: parse root failed", dev->host );
705            }
706            else
707            {
708                tr_dbg( "upnp device %s: found scpd \"%s\" and soap \"%s\"",
709                        dev->root, dev->scpd, dev->soap );
710                tr_dbg( "upnp device %s: parsed root, state root -> scpd",
711                        dev->host );
712                dev->state = UPNPDEV_STATE_SCPD;
713            }
714            break;
715
716        case UPNPDEV_STATE_SCPD:
717            if( !TR_HTTP_STATUS_OK( code ) )
718            {
719                tr_dbg( "upnp device %s: fetch scpd failed with http code %i",
720                        dev->host, code );
721            }
722            else if( parseScpd( body, len, &dev->getcmd,
723                                &dev->addcmd, &dev->delcmd ) )
724            {
725                tr_dbg( "upnp device %s: parse scpd failed", dev->host );
726            }
727            else
728            {
729                tr_dbg( "upnp device %s: parsed scpd, state scpd -> ready",
730                        dev->host );
731                dev->state = UPNPDEV_STATE_READY;
732                dev->looping = 0;
733            }
734            break;
735
736        case UPNPDEV_STATE_ADD:
737            dev->looping++;
738            if( IGD_ADD_CONFLICT == code )
739            {
740                tr_dbg( "upnp device %s: add conflict, state add -> delete",
741                        dev->host );
742                dev->state = UPNPDEV_STATE_DEL;
743            }
744            else if( TR_HTTP_STATUS_OK( code ) ||
745                     IGD_GENERIC_ERROR == code || IGD_GENERIC_FAILED == code )
746            {
747                tr_dbg( "upnp device %s: add attempt, state add -> get",
748                        dev->host );
749                dev->state = UPNPDEV_STATE_GET;
750            }
751            else
752            {
753                tr_dbg( "upnp device %s: add failed with http code %i",
754                        dev->host, code );
755            }
756            break;
757
758        case UPNPDEV_STATE_GET:
759            dev->looping++;
760            if( TR_HTTP_STATUS_OK( code ) )
761            {
762                switch( parseMapping( dev, body, len ) )
763                {
764                    case -1:
765                        break;
766                    case 0:
767                        tr_dbg( "upnp device %s: invalid mapping, "
768                                "state get -> delete", dev->host );
769                        dev->state = UPNPDEV_STATE_DEL;
770                        break;
771                    case 1:
772                        tr_dbg( "upnp device %s: good mapping, "
773                                "state get -> mapped", dev->host );
774                        dev->state = UPNPDEV_STATE_MAPPED;
775                        dev->looping = 0;
776                        dev->lastcheck = tr_date();
777                        tr_inf( "upnp successful for port %i",
778                                dev->mappedport );
779                        break;
780                    default:
781                        assert( 0 );
782                        break;
783                }
784            }
785            else if( IGD_NO_MAPPING_EXISTS == code ||
786                     IGD_GENERIC_ERROR == code || IGD_GENERIC_FAILED == code )
787            {
788                tr_dbg( "upnp device %s: no mapping, state get -> add",
789                        dev->host );
790                dev->state = UPNPDEV_STATE_ADD;
791            }
792            else
793            {
794                tr_dbg( "upnp device %s: get failed with http code %i",
795                        dev->host, code );
796            }
797            break;
798
799        case UPNPDEV_STATE_DEL:
800            dev->looping++;
801            if( TR_HTTP_STATUS_OK( code ) || IGD_NO_MAPPING_EXISTS == code ||
802                IGD_GENERIC_ERROR == code || IGD_GENERIC_FAILED == code )
803            {
804                tr_dbg( "upnp device %s: deleted, state delete -> ready",
805                        dev->host );
806                dev->state = UPNPDEV_STATE_READY;
807                dev->looping = 0;
808            }
809            else
810            {
811                tr_dbg( "upnp device %s: del failed with http code %i",
812                        dev->host, code );
813            }
814            break;
815
816        default:
817            assert( 0 );
818            break;
819    }
820
821    dev->lastrequest = tr_date();
822    killHttp( &dev->http );
823
824    if( UPNPDEV_STATE_ERROR == dev->state )
825    {
826        tr_dbg( "upnp device %s: error, state %hhu -> error",
827                dev->host, laststate );
828        return 0;
829    }
830
831    return 1;
832}
833
834static tr_http_t *
835makeHttp( int method, const char * host, int port, const char * path )
836{
837    if( tr_httpIsUrl( path, -1 ) )
838    {
839        return tr_httpClientUrl( method, "%s", path );
840    }
841    else
842    {
843        return tr_httpClient( method, host, port, "%s", path );
844    }
845}
846
847static tr_http_t *
848devicePulseGetHttp( tr_upnp_device_t * dev )
849{
850    tr_http_t  * ret;
851    char numstr[6];
852
853    if( tr_fdSocketWillCreate( 0 ) )
854    {
855        return NULL;
856    }
857
858    ret = NULL;
859    switch( dev->state ) 
860    {
861        case UPNPDEV_STATE_ROOT:
862            if( !dev->soapretry )
863            {
864                ret = makeHttp( TR_HTTP_GET, dev->host, dev->port, dev->root );
865            }
866            break;
867        case UPNPDEV_STATE_SCPD:
868            if( !dev->soapretry )
869            {
870                ret = makeHttp( TR_HTTP_GET, dev->host, dev->port, dev->scpd );
871            }
872            break;
873        case UPNPDEV_STATE_ADD:
874            if( NULL == dev->myaddr )
875            {
876                ret = NULL;
877                break;
878            }
879            snprintf( numstr, sizeof( numstr ), "%i", dev->mappedport );
880            ret = soapRequest( dev->soapretry, dev->host, dev->port, dev->soap,
881                               &dev->addcmd,
882                               "PortMappingEnabled", "1",
883                               "PortMappingLeaseDuration", "0",
884                               "RemoteHost", "",
885                               "ExternalPort", numstr,
886                               "InternalPort", numstr,
887                               "PortMappingProtocol", "TCP",
888                               "InternalClient", dev->myaddr,
889                               "PortMappingDescription",
890                                   "Added by Transmission",
891                               NULL );
892            break;
893        case UPNPDEV_STATE_GET:
894            snprintf( numstr, sizeof( numstr ), "%i", dev->mappedport );
895            ret = soapRequest( dev->soapretry, dev->host, dev->port, dev->soap,
896                               &dev->getcmd,
897                               "RemoteHost", "",
898                               "ExternalPort", numstr,
899                               "PortMappingProtocol", "TCP",
900                               NULL );
901            break;
902        case UPNPDEV_STATE_DEL:
903            snprintf( numstr, sizeof( numstr ), "%i", dev->mappedport );
904            ret = soapRequest( dev->soapretry, dev->host, dev->port, dev->soap,
905                               &dev->delcmd,
906                               "RemoteHost", "",
907                               "ExternalPort", numstr,
908                               "PortMappingProtocol", "TCP",
909                               NULL );
910            break;
911        default:
912            assert( 0 );
913            break;
914    }
915
916    if( NULL == ret )
917    {
918        tr_fdSocketClosed( 0 );
919    }
920
921    return ret;
922}
923
924static int
925devicePulseHttp( tr_upnp_device_t * dev,
926                 const char ** body, int * len )
927{
928    const char * headers;
929    int          hlen, code;
930
931    if( NULL == dev->http )
932    {
933        if( tr_date() < dev->lastrequest + HTTP_REQUEST_INTERVAL )
934        {
935            return -1;
936        }
937        dev->lastrequest = tr_date();
938        dev->http = devicePulseGetHttp( dev );
939        if( NULL == dev->http )
940        {
941            tr_dbg( "upnp device %s: http init failed, state %hhu -> error",
942                    dev->host, dev->state );
943            dev->state = UPNPDEV_STATE_ERROR;
944            dev->soapretry = 0;
945            return -1;
946        }
947    }
948
949    if( NULL == dev->myaddr )
950    {
951        dev->myaddr = tr_httpWhatsMyAddress( dev->http );
952    }
953
954    switch( tr_httpPulse( dev->http, &headers, &hlen ) )
955    {
956        case TR_NET_OK:
957            code = tr_httpResponseCode( headers, hlen );
958            if( SOAP_METHOD_NOT_ALLOWED == code && !dev->soapretry )
959            {
960                dev->soapretry = 1;
961                killHttp( &dev->http );
962                break;
963            }
964            dev->soapretry = 0;
965            *body = tr_httpParse( headers, hlen, NULL );
966            *len = ( NULL == body ? 0 : hlen - ( *body - headers ) );
967            return code;
968        case TR_NET_ERROR:
969            killHttp( &dev->http );
970            if( dev->soapretry )
971            {
972                tr_dbg( "upnp device %s: http pulse failed, state %hhu -> error",
973                        dev->host, dev->state );
974                dev->state = UPNPDEV_STATE_ERROR;
975                dev->soapretry = 0;
976            }
977            else
978            {
979                dev->soapretry = 1;
980            }
981            break;
982        case TR_NET_WAIT:
983            break;
984    }
985
986    return -1;
987}
988
989static int
990parseRoot(const char *buf, int len, char ** soap, char ** scpd )
991{
992    const char * end, * ii, * jj, * kk, * urlbase;
993    char       * basedup;
994
995    *soap = NULL;
996    *scpd = NULL;
997    end = buf + len;
998
999    buf = tr_xmlFindTagContents( buf, end, "root" );
1000    urlbase = tr_xmlFindTag( buf, end, "urlBase" );
1001    urlbase = tr_xmlTagContents( urlbase, end );
1002    buf = tr_xmlFindTagContents( buf, end, "device" );
1003    if( tr_xmlFindTagVerifyContents( buf, end, "deviceType",
1004            "urn:schemas-upnp-org:device:InternetGatewayDevice:1", 1 ) )
1005    {
1006        return 1;
1007    }
1008    buf = tr_xmlFindTag( buf, end, "deviceList" );
1009    ii = tr_xmlTagContents( buf, end );
1010    for( ; NULL != ii; ii = tr_xmlSkipTag( ii, end ) )
1011    {
1012        ii = tr_xmlFindTag( ii, end, "device" );
1013        buf = tr_xmlTagContents( ii, end );
1014        if( tr_xmlFindTagVerifyContents( buf, end, "deviceType",
1015                "urn:schemas-upnp-org:device:WANDevice:1", 1 ) )
1016        {
1017            continue;
1018        }
1019        buf = tr_xmlFindTag( buf, end, "deviceList" );
1020        jj = tr_xmlTagContents( buf, end );
1021        for( ; NULL != jj; jj = tr_xmlSkipTag( jj, end ) )
1022        {
1023            jj = tr_xmlFindTag( jj, end, "device" );
1024            buf = tr_xmlTagContents( jj, end );
1025            if( tr_xmlFindTagVerifyContents( buf, end, "deviceType",
1026                    "urn:schemas-upnp-org:device:WANConnectionDevice:1", 1 ) )
1027            {
1028                continue;
1029            }
1030            buf = tr_xmlFindTag( buf, end, "serviceList" );
1031            kk = tr_xmlTagContents( buf, end );
1032            for( ; NULL != kk; kk = tr_xmlSkipTag( kk, end ) )
1033            {
1034                kk = tr_xmlFindTag( kk, end, "service" );
1035                buf = tr_xmlTagContents( kk, end );
1036                if( !tr_xmlFindTagVerifyContents( buf, end, "serviceType",
1037                                                  UPNP_SERVICE_TYPE, 1 ) )
1038                {
1039                    *soap = tr_xmlDupTagContents( buf, end, "controlURL");
1040                    *scpd = tr_xmlDupTagContents( buf, end, "SCPDURL");
1041                    break;
1042                }
1043            }
1044        }
1045    }
1046
1047    basedup = tr_xmlDupContents( urlbase, end );
1048    addUrlbase( basedup, soap );
1049    addUrlbase( basedup, scpd );
1050    free( basedup );
1051
1052    if( NULL != *soap && NULL != *scpd )
1053    {
1054        return 0;
1055    }
1056
1057    return 1;
1058}
1059
1060static void
1061addUrlbase( const char * base, char ** path )
1062{
1063    const char * middle;
1064    int          len;
1065    char       * joined;
1066
1067    if( NULL == base || NULL == *path ||
1068        '/' == **path || tr_httpIsUrl( *path, -1 ) )
1069    {
1070        return;
1071    }
1072
1073    len = strlen( base );
1074    middle = ( 0 >= len || '/' != base[len-1] ? "/" : "" );
1075    joined = joinstrs( base, middle, *path );
1076    free( *path );
1077    *path = joined;
1078}
1079
1080static int
1081parseScpd( const char * buf, int len, tr_upnp_action_t * getcmd,
1082           tr_upnp_action_t * addcmd, tr_upnp_action_t * delcmd )
1083{
1084    const char * end, * next, * sub, * name;
1085
1086    end = buf + len;
1087    next = buf;
1088
1089    next = tr_xmlFindTagContents( next, end, "scpd" );
1090    next = tr_xmlFindTagContents( next, end, "actionList" );
1091
1092    while( NULL != next )
1093    {
1094        next = tr_xmlFindTag( next, end, "action" );
1095        sub = tr_xmlTagContents( next, end );
1096        name = tr_xmlFindTagContents( sub, end, "name" );
1097        sub = tr_xmlFindTagContents( sub, end, "argumentList" );
1098        if( !tr_xmlVerifyContents( name, end, getcmd->name, 1 ) )
1099        {
1100            if( parseScpdArgs( sub, end, getcmd, 'i' ) ||
1101                parseScpdArgs( sub, end, getcmd, 'o' ) )
1102            {
1103                return 1;
1104            }
1105        }
1106        else if( !tr_xmlVerifyContents( name, end, addcmd->name, 1 ) )
1107        {
1108            if( parseScpdArgs( sub, end, addcmd, 'i' ) )
1109            {
1110                return 1;
1111            }
1112        }
1113        else if( !tr_xmlVerifyContents( name, end, delcmd->name, 1 ) )
1114        {
1115            if( parseScpdArgs( sub, end, delcmd, 'i' ) )
1116            {
1117                return 1;
1118            }
1119        }
1120        next = tr_xmlSkipTag( next, end );
1121    }
1122
1123    return 0;
1124}
1125
1126static int
1127parseScpdArgs( const char * buf, const char * end,
1128               tr_upnp_action_t * action, char dir )
1129{
1130    const char * sub, * which;
1131    char       * name, * var;
1132
1133    assert( 'i' == dir || 'o' == dir );
1134    which = ( 'i' == dir ? "in" : "out" );
1135
1136    while( NULL != buf )
1137    {
1138        sub = tr_xmlFindTagContents( buf, end, "argument" );
1139        if( !tr_xmlFindTagVerifyContents( sub, end, "direction", which, 1 ) )
1140        {
1141            name = tr_xmlDupTagContents( sub, end, "name" );
1142            var = tr_xmlDupTagContents( sub, end, "relatedStateVariable" );
1143            if( NULL == name || NULL == var )
1144            {
1145                free( name );
1146                free( var );
1147            }
1148            else if( actionAdd( action, name, var, dir ) )
1149            {
1150                return 1;
1151            }
1152        }
1153        buf = tr_xmlSkipTag( buf, end );
1154    }
1155
1156    return 0;
1157}
1158
1159static int
1160parseMapping( tr_upnp_device_t * dev, const char * buf, int len )
1161{
1162    const char * end, * down, * next, * var;
1163    int          varlen, pret, cret, eret;
1164    char       * val;
1165
1166    assert( 0 < dev->mappedport );
1167
1168    if( NULL == dev->myaddr )
1169    {
1170        return -1;
1171    }
1172
1173    pret = -1;
1174    cret = -1;
1175    eret = -1;
1176
1177    end = buf + len;
1178    down = buf;
1179    down = tr_xmlFindTagContents( down, end, "Envelope" );
1180    down = tr_xmlFindTagContents( down, end, "Body" );
1181    down = tr_xmlFindTagContents( down, end,
1182                                  "GetSpecificPortMappingEntryResponse" );
1183
1184    next = down;
1185    while( NULL != next )
1186    {
1187        var = tr_xmlTagName( next, end, &varlen );
1188        var = actionLookupVar( &dev->getcmd, var, varlen, 'o' );
1189        if( NULL != var )
1190        {
1191            val = tr_xmlDupContents( tr_xmlTagContents( next, end ), end );
1192            if( 0 == tr_strcasecmp( "InternalPort", var ) )
1193            {
1194                pret = ( strtol( val, NULL, 10 ) == dev->mappedport ? 1 : 0 );
1195            }
1196            else if( 0 == tr_strcasecmp( "InternalClient", var ) )
1197            {
1198                cret = ( 0 == strcmp( dev->myaddr, val ) ? 1 : 0 );
1199            }
1200            else if( 0 == tr_strcasecmp( "PortMappingEnabled", var ) )
1201            {
1202                eret = ( 0 == strcmp( "1", val ) ? 1 : 0 );
1203            }
1204            free( val );
1205        }
1206        next = tr_xmlSkipTag( next, end );
1207    }
1208
1209    return MIN( MIN( pret, cret), eret );
1210}
1211
1212static char *
1213joinstrs( const char * first, const char * delim, const char * second )
1214{
1215    char * ret;
1216    int    len1, len2, len3;
1217
1218    len1 = strlen( first );
1219    len2 = strlen( delim );
1220    len3 = strlen( second );
1221    ret = malloc( len1 + len2 + len3 + 1 );
1222    if( NULL == ret )
1223    {
1224        return NULL;
1225    }
1226
1227    memcpy( ret, first, len1 );
1228    memcpy( ret + len1, delim, len2 );
1229    memcpy( ret + len1 + len2, second, len3 );
1230    ret[len1 + len2 + len3] = '\0';
1231
1232    return ret;
1233}
1234
1235static tr_http_t *
1236soapRequest( int retry, const char * host, int port, const char * path,
1237             tr_upnp_action_t * action, ... )
1238{
1239    tr_http_t  * http;
1240    va_list      ap;
1241    const char * name, * value;
1242    int          method;
1243
1244    method = ( retry ? TR_HTTP_M_POST : TR_HTTP_POST );
1245    http = makeHttp( method, host, port, path );
1246    if( NULL != http )
1247    {
1248        tr_httpAddHeader( http, "Content-type",
1249                          "text/xml; encoding=\"utf-8\"" );
1250        tr_httpAddHeader( http, "SOAPAction", action->action );
1251        if( retry )
1252        {
1253            tr_httpAddHeader( http, "Man", "\"" SOAP_ENVELOPE "\"" );
1254        }
1255        tr_httpAddBody( http, 
1256"<?xml version=\"1.0\" encoding=\"utf-8\" ?>"
1257"<s:Envelope"
1258"    xmlns:s=\"" SOAP_ENVELOPE "\""
1259"    s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">"
1260"  <s:Body>"
1261"    <u:%s xmlns:u=\"" UPNP_SERVICE_TYPE "\">", action->name );
1262
1263        va_start( ap, action );
1264        do
1265        {
1266            name = va_arg( ap, const char * );
1267            value = NULL;
1268            name = actionLookupName( action, name, -1, 'i' );
1269            if( NULL != name )
1270            {
1271                value = va_arg( ap, const char * );
1272                if( NULL != value )
1273                {
1274                    tr_httpAddBody( http,
1275"      <%s>%s</%s>", name, value, name );
1276                }
1277                else 
1278                {
1279                    tr_httpAddBody( http,
1280"      <%s></%s>", name, name );
1281                }
1282            }
1283        }
1284        while( NULL != name && NULL != value );
1285        va_end( ap );
1286
1287        tr_httpAddBody( http,
1288"    </u:%s>"
1289"  </s:Body>"
1290"</s:Envelope>", action->name );
1291    }
1292
1293    return http;
1294}
1295
1296static void
1297actionSetup( tr_upnp_action_t * action, const char * name, int prealloc )
1298{
1299    action->name = strdup( name );
1300    action->action = NULL;
1301    asprintf( &action->action, "\"%s#%s\"", UPNP_SERVICE_TYPE, name );
1302    assert( NULL == action->args );
1303    action->args = malloc( sizeof( *action->args ) * prealloc );
1304    memset( action->args, 0, sizeof( *action->args ) * prealloc );
1305    action->len = prealloc;
1306}
1307
1308static void
1309actionFree( tr_upnp_action_t * act )
1310{
1311    free( act->name );
1312    free( act->action );
1313    while( 0 < act->len )
1314    {
1315        act->len--;
1316        free( act->args[act->len].name );
1317        free( act->args[act->len].var );
1318    }
1319    free( act->args );
1320}
1321
1322static int
1323actionAdd( tr_upnp_action_t * act, char * name, char * var, char dir )
1324{
1325    int    ii;
1326    void * newbuf;
1327
1328    assert( 'i' == dir || 'o' == dir );
1329
1330    ii = 0;
1331    while( ii < act->len && NULL != act->args[ii].name )
1332    {
1333        ii++;
1334    }
1335
1336    if( ii == act->len )
1337    {
1338        newbuf = realloc( act->args, sizeof( *act->args ) * ( act->len + 1 ) );
1339        if( NULL == newbuf )
1340        {
1341            return 1;
1342        }
1343        act->args = newbuf;
1344        act->len++;
1345    }
1346
1347    act->args[ii].name = name;
1348    act->args[ii].var = var;
1349    act->args[ii].dir = dir;
1350
1351    return 0;
1352}
1353
1354static const char *
1355actionLookup( tr_upnp_action_t * act, const char * key, int len,
1356              char dir, int getname )
1357{
1358    int ii;
1359
1360    assert( 'i' == dir || 'o' == dir );
1361
1362    if( NULL == key || 0 == len )
1363    {
1364        return NULL;
1365    }
1366    if( 0 > len )
1367    {
1368        len = strlen( key );
1369    }
1370
1371    for( ii = 0; ii < act->len; ii++ )
1372    {
1373        if( NULL != act->args[ii].name && dir == act->args[ii].dir )
1374        {
1375            if( !getname &&
1376                0 == tr_strncasecmp( act->args[ii].name, key, len ) )
1377            {
1378                return act->args[ii].var;
1379            }
1380            else if( getname &&
1381                     0 == tr_strncasecmp( act->args[ii].var, key, len ) )
1382            {
1383                return act->args[ii].name;
1384            }
1385        }
1386    }
1387
1388    return NULL;
1389}
Note: See TracBrowser for help on using the repository browser.