IPAddress.m
author Dan Preston <danpreston@codechemistry.com>
Mon May 04 23:10:51 2009 -0700 (2009-05-04)
changeset 34 1fadc382ece2
parent 28 732576fa8a0d
child 35 a9dd5ac5ff11
permissions -rw-r--r--
Fixed dead assignment found by clang checker.
jens@0
     1
//
jens@0
     2
//  IPAddress.m
jens@0
     3
//  MYNetwork
jens@0
     4
//
jens@0
     5
//  Created by Jens Alfke on 1/4/08.
jens@0
     6
//  Copyright 2008 Jens Alfke. All rights reserved.
jens@0
     7
//
jens@0
     8
jens@0
     9
#import "IPAddress.h"
jens@1
    10
jens@1
    11
#import "Logging.h"
jens@1
    12
#import "Test.h"
jens@1
    13
jens@0
    14
#import <sys/types.h>
jens@0
    15
#import <sys/socket.h>
jens@0
    16
#import <net/if.h>
jens@0
    17
#import <netinet/in.h>
jens@0
    18
#import <ifaddrs.h>
jens@1
    19
#import <netdb.h>
jens@0
    20
jens@0
    21
jens@0
    22
@implementation IPAddress
jens@0
    23
jens@0
    24
jens@0
    25
+ (UInt32) IPv4FromDottedQuadString: (NSString*)str
jens@0
    26
{
jens@0
    27
    Assert(str);
jens@0
    28
    UInt32 ipv4 = 0;
jens@0
    29
    NSScanner *scanner = [NSScanner scannerWithString: str];
jens@0
    30
    for( int i=0; i<4; i++ ) {
jens@0
    31
        if( i>0 && ! [scanner scanString: @"." intoString: nil] )
jens@0
    32
            return 0;
jens@0
    33
        NSInteger octet;
jens@0
    34
        if( ! [scanner scanInteger: &octet] || octet<0 || octet>255 )
jens@0
    35
            return 0;
jens@0
    36
        ipv4 = (ipv4<<8) | octet;
jens@0
    37
    }
jens@0
    38
    if( ! [scanner isAtEnd] )
jens@0
    39
        return 0;
jens@0
    40
    return htonl(ipv4);
jens@0
    41
}
jens@0
    42
         
jens@0
    43
         
jens@0
    44
- (id) initWithHostname: (NSString*)hostname port: (UInt16)port
jens@0
    45
{
jens@0
    46
    Assert(hostname);
jens@0
    47
    self = [super init];
jens@0
    48
    if (self != nil) {
jens@0
    49
        _ipv4 = [[self class] IPv4FromDottedQuadString: hostname];
jens@0
    50
        if( ! _ipv4 ) {
jens@0
    51
            [self release];
jens@0
    52
            return [[HostAddress alloc] initWithHostname: hostname port: port];
jens@0
    53
        }
jens@0
    54
        _port = port;
jens@0
    55
    }
jens@0
    56
    return self;
jens@0
    57
}
jens@0
    58
jens@0
    59
jens@0
    60
- (id) initWithIPv4: (UInt32)ipv4 port: (UInt16)port
jens@0
    61
{
jens@0
    62
    self = [super init];
jens@0
    63
    if (self != nil) {
jens@0
    64
        _ipv4 = ipv4;
jens@0
    65
        _port = port;
jens@0
    66
    }
jens@0
    67
    return self;
jens@0
    68
}
jens@0
    69
jens@0
    70
- (id) initWithIPv4: (UInt32)ipv4
jens@0
    71
{
jens@0
    72
    return [self initWithIPv4: ipv4 port: 0];
jens@0
    73
}
jens@0
    74
jens@0
    75
- (id) initWithSockAddr: (const struct sockaddr*)sockaddr
jens@0
    76
{
jens@0
    77
    if( sockaddr->sa_family == AF_INET ) {
jens@0
    78
        const struct sockaddr_in *addr_in = (const struct sockaddr_in*)sockaddr;
jens@0
    79
        return [self initWithIPv4: addr_in->sin_addr.s_addr port: ntohs(addr_in->sin_port)];
jens@0
    80
    } else {
jens@0
    81
        [self release];
jens@0
    82
        return nil;
jens@0
    83
    }
jens@0
    84
}
jens@0
    85
jens@32
    86
- (id) initWithSockAddr: (const struct sockaddr*)sockaddr
jens@32
    87
                   port: (UInt16)port
jens@32
    88
{
jens@32
    89
    self = [self initWithSockAddr: sockaddr];
jens@32
    90
    if (self)
jens@32
    91
        _port = port;
jens@32
    92
    return self;
jens@32
    93
}
jens@32
    94
jens@0
    95
+ (IPAddress*) addressOfSocket: (CFSocketNativeHandle)socket
jens@0
    96
{
jens@0
    97
    uint8_t name[SOCK_MAXADDRLEN];
jens@0
    98
    socklen_t namelen = sizeof(name);
jens@0
    99
    struct sockaddr *addr = (struct sockaddr*)name;
jens@0
   100
    if (0 == getpeername(socket, addr, &namelen))
jens@0
   101
        return [[[self alloc] initWithSockAddr: addr] autorelease];
jens@0
   102
    else
jens@0
   103
        return nil;
jens@0
   104
}    
jens@0
   105
jens@0
   106
- (id) copyWithZone: (NSZone*)zone
jens@0
   107
{
jens@0
   108
    return [self retain];
jens@0
   109
}
jens@0
   110
jens@0
   111
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   112
{
jens@0
   113
    if( _ipv4 )
jens@0
   114
        [coder encodeInt32: _ipv4 forKey: @"ipv4"];
jens@0
   115
    if( _port )
jens@0
   116
        [coder encodeInt: _port forKey: @"port"];
jens@0
   117
}
jens@0
   118
jens@0
   119
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   120
{
jens@0
   121
    self = [super init];
jens@0
   122
    if( self ) {
jens@0
   123
        _ipv4 = [decoder decodeInt32ForKey: @"ipv4"];
jens@0
   124
        _port = [decoder decodeIntForKey: @"port"];
jens@0
   125
    }
jens@0
   126
    return self;
jens@0
   127
}
jens@0
   128
jens@0
   129
jens@0
   130
@synthesize ipv4=_ipv4, port=_port;
jens@0
   131
jens@0
   132
- (BOOL) isEqual: (IPAddress*)addr
jens@0
   133
{
jens@0
   134
    return [addr isKindOfClass: [IPAddress class]] && [self isSameHost: addr] && addr->_port==_port;
jens@0
   135
}
jens@0
   136
jens@0
   137
- (BOOL) isSameHost: (IPAddress*)addr
jens@0
   138
{
jens@0
   139
    return addr && _ipv4==addr->_ipv4;
jens@0
   140
}
jens@0
   141
jens@0
   142
- (NSUInteger) hash
jens@0
   143
{
jens@0
   144
    return _ipv4 ^ _port;
jens@0
   145
}
jens@0
   146
jens@0
   147
- (NSString*) ipv4name
jens@0
   148
{
jens@0
   149
    UInt32 ipv4 = self.ipv4;
jens@0
   150
    if( ipv4 != 0 ) {
jens@0
   151
        const UInt8* b = (const UInt8*)&ipv4;
jens@0
   152
        return [NSString stringWithFormat: @"%u.%u.%u.%u",
jens@0
   153
                (unsigned)b[0],(unsigned)b[1],(unsigned)b[2],(unsigned)b[3]];
jens@0
   154
    } else
jens@0
   155
        return nil;
jens@0
   156
}
jens@0
   157
jens@0
   158
- (NSString*) hostname
jens@0
   159
{
jens@0
   160
    return [self ipv4name];
jens@0
   161
}
jens@0
   162
jens@0
   163
- (NSString*) description
jens@0
   164
{
jens@0
   165
    NSString *name = self.hostname ?: @"0.0.0.0";
jens@0
   166
    if( _port )
jens@0
   167
        name = [name stringByAppendingFormat: @":%hu",_port];
jens@0
   168
    return name;
jens@0
   169
}
jens@0
   170
jens@0
   171
jens@26
   172
+ (IPAddress*) localAddressWithPort: (UInt16)port
jens@0
   173
{
jens@0
   174
    // getifaddrs returns a linked list of interface entries;
jens@0
   175
    // find the first active non-loopback interface with IPv4:
jens@0
   176
    UInt32 address = 0;
jens@0
   177
    struct ifaddrs *interfaces;
jens@0
   178
    if( getifaddrs(&interfaces) == 0 ) {
jens@0
   179
        struct ifaddrs *interface;
jens@0
   180
        for( interface=interfaces; interface; interface=interface->ifa_next ) {
jens@0
   181
            if( (interface->ifa_flags & IFF_UP) && ! (interface->ifa_flags & IFF_LOOPBACK) ) {
jens@0
   182
                const struct sockaddr_in *addr = (const struct sockaddr_in*) interface->ifa_addr;
jens@0
   183
                if( addr && addr->sin_family==AF_INET ) {
jens@0
   184
                    address = addr->sin_addr.s_addr;
jens@0
   185
                    break;
jens@0
   186
                }
jens@0
   187
            }
jens@0
   188
        }
jens@0
   189
        freeifaddrs(interfaces);
jens@0
   190
    }
jens@26
   191
    return [[[self alloc] initWithIPv4: address port: port] autorelease];
jens@26
   192
}
jens@26
   193
jens@26
   194
+ (IPAddress*) localAddress
jens@26
   195
{
jens@26
   196
    return [self localAddressWithPort: 0];
jens@0
   197
}
jens@0
   198
jens@0
   199
jens@0
   200
// Private IP address ranges. See RFC 3330.
jens@0
   201
static const struct {UInt32 mask, value;} const kPrivateRanges[] = {
jens@0
   202
    {0xFF000000, 0x00000000},       //   0.x.x.x (hosts on "this" network)
jens@0
   203
    {0xFF000000, 0x0A000000},       //  10.x.x.x (private address range)
jens@0
   204
    {0xFF000000, 0x7F000000},       // 127.x.x.x (loopback)
jens@0
   205
    {0xFFFF0000, 0xA9FE0000},       // 169.254.x.x (link-local self-configured addresses)
jens@0
   206
    {0xFFF00000, 0xAC100000},       // 172.(16-31).x.x (private address range)
jens@0
   207
    {0xFFFF0000, 0xC0A80000},       // 192.168.x.x (private address range)
jens@0
   208
    {0,0}
jens@0
   209
};
jens@0
   210
jens@0
   211
jens@0
   212
- (BOOL) isPrivate
jens@0
   213
{
jens@0
   214
    UInt32 address = ntohl(self.ipv4);
jens@0
   215
    int i;
jens@0
   216
    for( i=0; kPrivateRanges[i].mask; i++ )
jens@0
   217
        if( (address & kPrivateRanges[i].mask) == kPrivateRanges[i].value )
jens@0
   218
            return YES;
jens@0
   219
    return NO;
jens@0
   220
}
jens@0
   221
jens@0
   222
jens@0
   223
@end
jens@0
   224
jens@0
   225
jens@0
   226
jens@0
   227
jens@0
   228
jens@0
   229
@implementation HostAddress
jens@0
   230
jens@0
   231
jens@0
   232
- (id) initWithHostname: (NSString*)hostname port: (UInt16)port
jens@0
   233
{
jens@0
   234
    self = [super initWithIPv4: 0 port: port];
jens@0
   235
    if( self ) {
jens@0
   236
        if( [hostname length]==0 ) {
jens@0
   237
            [self release];
jens@0
   238
            return nil;
jens@0
   239
        }
jens@0
   240
        _hostname = [hostname copy];
jens@0
   241
    }
jens@0
   242
    return self;
jens@0
   243
}
jens@0
   244
jens@28
   245
- (id) initWithHostname: (NSString*)hostname
jens@28
   246
               sockaddr: (const struct sockaddr*)sockaddr
jens@28
   247
                   port: (UInt16)port;
jens@28
   248
{
jens@28
   249
    if( [hostname length]==0 ) {
jens@28
   250
        [self release];
jens@28
   251
        return nil;
jens@28
   252
    }
jens@32
   253
    self = [super initWithSockAddr: sockaddr port: port];
jens@28
   254
    if( self ) {
jens@28
   255
        _hostname = [hostname copy];
jens@28
   256
    }
jens@28
   257
    return self;
jens@28
   258
}    
jens@28
   259
jens@0
   260
jens@0
   261
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   262
{
jens@0
   263
    [super encodeWithCoder: coder];
jens@0
   264
    [coder encodeObject: _hostname forKey: @"host"];
jens@0
   265
}
jens@0
   266
jens@0
   267
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   268
{
jens@0
   269
    self = [super initWithCoder: decoder];
jens@0
   270
    if( self ) {
jens@0
   271
        _hostname = [[decoder decodeObjectForKey: @"host"] copy];
jens@0
   272
    }
jens@0
   273
    return self;
jens@0
   274
}
jens@0
   275
jens@24
   276
- (void)dealloc 
jens@24
   277
{
jens@24
   278
    [_hostname release];
jens@24
   279
    [super dealloc];
jens@24
   280
}
jens@24
   281
jens@24
   282
jens@28
   283
- (NSString*) description
jens@28
   284
{
jens@28
   285
    NSMutableString *desc = [_hostname mutableCopy];
jens@28
   286
    NSString *addr = self.ipv4name;
jens@28
   287
    if (addr)
jens@28
   288
        [desc appendFormat: @"(%@)", addr];
jens@32
   289
    if( self.port )
jens@32
   290
        [desc appendFormat: @":%hu",self.port];
jens@28
   291
    return desc;
jens@28
   292
}
jens@28
   293
jens@28
   294
jens@0
   295
- (NSUInteger) hash
jens@0
   296
{
jens@32
   297
    return [_hostname hash] ^ self.port;
jens@0
   298
}
jens@0
   299
jens@0
   300
jens@0
   301
- (NSString*) hostname  {return _hostname;}
jens@0
   302
jens@0
   303
jens@0
   304
- (UInt32) ipv4
jens@0
   305
{
jens@0
   306
    struct hostent *ent = gethostbyname(_hostname.UTF8String);
jens@0
   307
    if( ! ent ) {
jens@0
   308
        Log(@"HostAddress: DNS lookup failed for <%@>: %s", _hostname, hstrerror(h_errno));
jens@0
   309
        return 0;
jens@0
   310
    }
jens@0
   311
    return * (const in_addr_t*) ent->h_addr_list[0];
jens@0
   312
}
jens@0
   313
jens@0
   314
jens@0
   315
- (BOOL) isSameHost: (IPAddress*)addr
jens@0
   316
{
jens@0
   317
    return [addr isKindOfClass: [HostAddress class]] && [_hostname caseInsensitiveCompare: addr.hostname]==0;
jens@0
   318
}
jens@0
   319
jens@0
   320
jens@0
   321
@end
jens@0
   322
jens@0
   323
jens@0
   324
jens@0
   325
jens@0
   326
@implementation RecentAddress
jens@0
   327
jens@0
   328
jens@0
   329
- (id) initWithIPAddress: (IPAddress*)addr
jens@0
   330
{
jens@0
   331
    return [super initWithIPv4: addr.ipv4 port: addr.port];
jens@0
   332
}
jens@0
   333
jens@0
   334
jens@0
   335
@synthesize lastSuccess=_lastSuccess, successes=_successes;
jens@0
   336
jens@0
   337
- (BOOL) noteSuccess
jens@0
   338
{
jens@0
   339
    if( _successes < 0xFFFF )
jens@0
   340
        _successes++;
jens@0
   341
    _lastSuccess = CFAbsoluteTimeGetCurrent();
jens@0
   342
    return YES;
jens@0
   343
}
jens@0
   344
jens@0
   345
- (BOOL) noteSeen
jens@0
   346
{
jens@0
   347
    CFAbsoluteTime now = CFAbsoluteTimeGetCurrent();
jens@0
   348
    BOOL significant = ( now-_lastSuccess >= 18*60*60 );
jens@0
   349
    _lastSuccess = now;
jens@0
   350
    return significant;
jens@0
   351
}
jens@0
   352
jens@0
   353
jens@0
   354
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   355
{
jens@0
   356
    [super encodeWithCoder: coder];
jens@0
   357
    [coder encodeDouble: _lastSuccess forKey: @"last"];
jens@0
   358
    [coder encodeInt: _successes forKey: @"succ"];
jens@0
   359
}
jens@0
   360
jens@0
   361
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   362
{
jens@0
   363
    self = [super initWithCoder: decoder];
jens@0
   364
    if( self ) {
jens@0
   365
        _lastSuccess = [decoder decodeDoubleForKey: @"last"];
jens@0
   366
        _successes = [decoder decodeIntForKey: @"succ"];
jens@0
   367
    }
jens@0
   368
    return self;
jens@0
   369
}
jens@0
   370
jens@0
   371
jens@0
   372
@end
jens@0
   373
jens@0
   374
jens@0
   375
jens@0
   376
jens@0
   377
jens@0
   378
#import "Test.h"
jens@0
   379
jens@0
   380
TestCase(IPAddress) {
jens@0
   381
    RequireTestCase(CollectionUtils);
jens@0
   382
    IPAddress *addr = [[IPAddress alloc] initWithIPv4: htonl(0x0A0001FE) port: 8080];
jens@26
   383
    CAssertEq(addr.ipv4,(UInt32)htonl(0x0A0001FE));
jens@0
   384
    CAssertEq(addr.port,8080);
jens@0
   385
    CAssertEqual(addr.hostname,@"10.0.1.254");
jens@0
   386
    CAssertEqual(addr.description,@"10.0.1.254:8080");
jens@0
   387
    CAssert(addr.isPrivate);
jens@0
   388
    
jens@0
   389
    addr = [[IPAddress alloc] initWithHostname: @"66.66.0.255" port: 123];
jens@0
   390
    CAssertEq(addr.class,[IPAddress class]);
jens@26
   391
    CAssertEq(addr.ipv4,(UInt32)htonl(0x424200FF));
jens@0
   392
    CAssertEq(addr.port,123);
jens@0
   393
    CAssertEqual(addr.hostname,@"66.66.0.255");
jens@0
   394
    CAssertEqual(addr.description,@"66.66.0.255:123");
jens@0
   395
    CAssert(!addr.isPrivate);
jens@0
   396
    
jens@0
   397
    addr = [[IPAddress alloc] initWithHostname: @"www.apple.com" port: 80];
jens@0
   398
    CAssertEq(addr.class,[HostAddress class]);
jens@26
   399
    Log(@"www.apple.com = %@ [0x%08X]", addr.ipv4name, ntohl(addr.ipv4));
jens@26
   400
    CAssertEq(addr.ipv4,(UInt32)htonl(0x11FBC820));
jens@0
   401
    CAssertEq(addr.port,80);
jens@0
   402
    CAssertEqual(addr.hostname,@"www.apple.com");
jens@0
   403
    CAssertEqual(addr.description,@"www.apple.com:80");
jens@0
   404
    CAssert(!addr.isPrivate);
jens@0
   405
}
jens@0
   406
jens@0
   407
jens@0
   408
/*
jens@0
   409
 Copyright (c) 2008, Jens Alfke <jens@mooseyard.com>. All rights reserved.
jens@0
   410
 
jens@0
   411
 Redistribution and use in source and binary forms, with or without modification, are permitted
jens@0
   412
 provided that the following conditions are met:
jens@0
   413
 
jens@0
   414
 * Redistributions of source code must retain the above copyright notice, this list of conditions
jens@0
   415
 and the following disclaimer.
jens@0
   416
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
jens@0
   417
 and the following disclaimer in the documentation and/or other materials provided with the
jens@0
   418
 distribution.
jens@0
   419
 
jens@0
   420
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
jens@0
   421
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
jens@0
   422
 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
jens@0
   423
 BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jens@0
   424
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
jens@0
   425
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
jens@0
   426
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
jens@0
   427
 THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jens@0
   428
 */