IPAddress.m
author Jens Alfke <jens@mooseyard.com>
Sun Jul 13 10:52:48 2008 -0700 (2008-07-13)
changeset 20 02224e981209
parent 0 9d67172bb323
child 24 ab88e3ee5726
permissions -rw-r--r--
* Fixed link error in BLIPClient target.
* Fixed *Ph*n* #ifdef issue (thanks, Jimmy)
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@0
    86
+ (IPAddress*) addressOfSocket: (CFSocketNativeHandle)socket
jens@0
    87
{
jens@0
    88
    uint8_t name[SOCK_MAXADDRLEN];
jens@0
    89
    socklen_t namelen = sizeof(name);
jens@0
    90
    struct sockaddr *addr = (struct sockaddr*)name;
jens@0
    91
    if (0 == getpeername(socket, addr, &namelen))
jens@0
    92
        return [[[self alloc] initWithSockAddr: addr] autorelease];
jens@0
    93
    else
jens@0
    94
        return nil;
jens@0
    95
}    
jens@0
    96
jens@0
    97
- (id) copyWithZone: (NSZone*)zone
jens@0
    98
{
jens@0
    99
    return [self retain];
jens@0
   100
}
jens@0
   101
jens@0
   102
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   103
{
jens@0
   104
    if( _ipv4 )
jens@0
   105
        [coder encodeInt32: _ipv4 forKey: @"ipv4"];
jens@0
   106
    if( _port )
jens@0
   107
        [coder encodeInt: _port forKey: @"port"];
jens@0
   108
}
jens@0
   109
jens@0
   110
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   111
{
jens@0
   112
    self = [super init];
jens@0
   113
    if( self ) {
jens@0
   114
        _ipv4 = [decoder decodeInt32ForKey: @"ipv4"];
jens@0
   115
        _port = [decoder decodeIntForKey: @"port"];
jens@0
   116
    }
jens@0
   117
    return self;
jens@0
   118
}
jens@0
   119
jens@0
   120
jens@0
   121
@synthesize ipv4=_ipv4, port=_port;
jens@0
   122
jens@0
   123
- (BOOL) isEqual: (IPAddress*)addr
jens@0
   124
{
jens@0
   125
    return [addr isKindOfClass: [IPAddress class]] && [self isSameHost: addr] && addr->_port==_port;
jens@0
   126
}
jens@0
   127
jens@0
   128
- (BOOL) isSameHost: (IPAddress*)addr
jens@0
   129
{
jens@0
   130
    return addr && _ipv4==addr->_ipv4;
jens@0
   131
}
jens@0
   132
jens@0
   133
- (NSUInteger) hash
jens@0
   134
{
jens@0
   135
    return _ipv4 ^ _port;
jens@0
   136
}
jens@0
   137
jens@0
   138
- (NSString*) ipv4name
jens@0
   139
{
jens@0
   140
    UInt32 ipv4 = self.ipv4;
jens@0
   141
    if( ipv4 != 0 ) {
jens@0
   142
        const UInt8* b = (const UInt8*)&ipv4;
jens@0
   143
        return [NSString stringWithFormat: @"%u.%u.%u.%u",
jens@0
   144
                (unsigned)b[0],(unsigned)b[1],(unsigned)b[2],(unsigned)b[3]];
jens@0
   145
    } else
jens@0
   146
        return nil;
jens@0
   147
}
jens@0
   148
jens@0
   149
- (NSString*) hostname
jens@0
   150
{
jens@0
   151
    return [self ipv4name];
jens@0
   152
}
jens@0
   153
jens@0
   154
- (NSString*) description
jens@0
   155
{
jens@0
   156
    NSString *name = self.hostname ?: @"0.0.0.0";
jens@0
   157
    if( _port )
jens@0
   158
        name = [name stringByAppendingFormat: @":%hu",_port];
jens@0
   159
    return name;
jens@0
   160
}
jens@0
   161
jens@0
   162
jens@0
   163
+ (IPAddress*) localAddress
jens@0
   164
{
jens@0
   165
    // getifaddrs returns a linked list of interface entries;
jens@0
   166
    // find the first active non-loopback interface with IPv4:
jens@0
   167
    UInt32 address = 0;
jens@0
   168
    struct ifaddrs *interfaces;
jens@0
   169
    if( getifaddrs(&interfaces) == 0 ) {
jens@0
   170
        struct ifaddrs *interface;
jens@0
   171
        for( interface=interfaces; interface; interface=interface->ifa_next ) {
jens@0
   172
            if( (interface->ifa_flags & IFF_UP) && ! (interface->ifa_flags & IFF_LOOPBACK) ) {
jens@0
   173
                const struct sockaddr_in *addr = (const struct sockaddr_in*) interface->ifa_addr;
jens@0
   174
                if( addr && addr->sin_family==AF_INET ) {
jens@0
   175
                    address = addr->sin_addr.s_addr;
jens@0
   176
                    break;
jens@0
   177
                }
jens@0
   178
            }
jens@0
   179
        }
jens@0
   180
        freeifaddrs(interfaces);
jens@0
   181
    }
jens@0
   182
    return [[[self alloc] initWithIPv4: address] autorelease];
jens@0
   183
}
jens@0
   184
jens@0
   185
jens@0
   186
// Private IP address ranges. See RFC 3330.
jens@0
   187
static const struct {UInt32 mask, value;} const kPrivateRanges[] = {
jens@0
   188
    {0xFF000000, 0x00000000},       //   0.x.x.x (hosts on "this" network)
jens@0
   189
    {0xFF000000, 0x0A000000},       //  10.x.x.x (private address range)
jens@0
   190
    {0xFF000000, 0x7F000000},       // 127.x.x.x (loopback)
jens@0
   191
    {0xFFFF0000, 0xA9FE0000},       // 169.254.x.x (link-local self-configured addresses)
jens@0
   192
    {0xFFF00000, 0xAC100000},       // 172.(16-31).x.x (private address range)
jens@0
   193
    {0xFFFF0000, 0xC0A80000},       // 192.168.x.x (private address range)
jens@0
   194
    {0,0}
jens@0
   195
};
jens@0
   196
jens@0
   197
jens@0
   198
- (BOOL) isPrivate
jens@0
   199
{
jens@0
   200
    UInt32 address = ntohl(self.ipv4);
jens@0
   201
    int i;
jens@0
   202
    for( i=0; kPrivateRanges[i].mask; i++ )
jens@0
   203
        if( (address & kPrivateRanges[i].mask) == kPrivateRanges[i].value )
jens@0
   204
            return YES;
jens@0
   205
    return NO;
jens@0
   206
}
jens@0
   207
jens@0
   208
jens@0
   209
@end
jens@0
   210
jens@0
   211
jens@0
   212
jens@0
   213
jens@0
   214
jens@0
   215
@implementation HostAddress
jens@0
   216
jens@0
   217
jens@0
   218
- (id) initWithHostname: (NSString*)hostname port: (UInt16)port
jens@0
   219
{
jens@0
   220
    self = [super initWithIPv4: 0 port: port];
jens@0
   221
    if( self ) {
jens@0
   222
        if( [hostname length]==0 ) {
jens@0
   223
            [self release];
jens@0
   224
            return nil;
jens@0
   225
        }
jens@0
   226
        _hostname = [hostname copy];
jens@0
   227
    }
jens@0
   228
    return self;
jens@0
   229
}
jens@0
   230
jens@0
   231
jens@0
   232
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   233
{
jens@0
   234
    [super encodeWithCoder: coder];
jens@0
   235
    [coder encodeObject: _hostname forKey: @"host"];
jens@0
   236
}
jens@0
   237
jens@0
   238
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   239
{
jens@0
   240
    self = [super initWithCoder: decoder];
jens@0
   241
    if( self ) {
jens@0
   242
        _hostname = [[decoder decodeObjectForKey: @"host"] copy];
jens@0
   243
    }
jens@0
   244
    return self;
jens@0
   245
}
jens@0
   246
jens@0
   247
- (NSUInteger) hash
jens@0
   248
{
jens@0
   249
    return [_hostname hash] ^ _port;
jens@0
   250
}
jens@0
   251
jens@0
   252
jens@0
   253
- (NSString*) hostname  {return _hostname;}
jens@0
   254
jens@0
   255
jens@0
   256
- (UInt32) ipv4
jens@0
   257
{
jens@0
   258
    struct hostent *ent = gethostbyname(_hostname.UTF8String);
jens@0
   259
    if( ! ent ) {
jens@0
   260
        Log(@"HostAddress: DNS lookup failed for <%@>: %s", _hostname, hstrerror(h_errno));
jens@0
   261
        return 0;
jens@0
   262
    }
jens@0
   263
    return * (const in_addr_t*) ent->h_addr_list[0];
jens@0
   264
}
jens@0
   265
jens@0
   266
jens@0
   267
- (BOOL) isSameHost: (IPAddress*)addr
jens@0
   268
{
jens@0
   269
    return [addr isKindOfClass: [HostAddress class]] && [_hostname caseInsensitiveCompare: addr.hostname]==0;
jens@0
   270
}
jens@0
   271
jens@0
   272
jens@0
   273
@end
jens@0
   274
jens@0
   275
jens@0
   276
jens@0
   277
jens@0
   278
@implementation RecentAddress
jens@0
   279
jens@0
   280
jens@0
   281
- (id) initWithIPAddress: (IPAddress*)addr
jens@0
   282
{
jens@0
   283
    return [super initWithIPv4: addr.ipv4 port: addr.port];
jens@0
   284
}
jens@0
   285
jens@0
   286
jens@0
   287
@synthesize lastSuccess=_lastSuccess, successes=_successes;
jens@0
   288
jens@0
   289
- (BOOL) noteSuccess
jens@0
   290
{
jens@0
   291
    if( _successes < 0xFFFF )
jens@0
   292
        _successes++;
jens@0
   293
    _lastSuccess = CFAbsoluteTimeGetCurrent();
jens@0
   294
    return YES;
jens@0
   295
}
jens@0
   296
jens@0
   297
- (BOOL) noteSeen
jens@0
   298
{
jens@0
   299
    CFAbsoluteTime now = CFAbsoluteTimeGetCurrent();
jens@0
   300
    BOOL significant = ( now-_lastSuccess >= 18*60*60 );
jens@0
   301
    _lastSuccess = now;
jens@0
   302
    return significant;
jens@0
   303
}
jens@0
   304
jens@0
   305
jens@0
   306
- (void)encodeWithCoder:(NSCoder *)coder
jens@0
   307
{
jens@0
   308
    [super encodeWithCoder: coder];
jens@0
   309
    [coder encodeDouble: _lastSuccess forKey: @"last"];
jens@0
   310
    [coder encodeInt: _successes forKey: @"succ"];
jens@0
   311
}
jens@0
   312
jens@0
   313
- (id)initWithCoder:(NSCoder *)decoder
jens@0
   314
{
jens@0
   315
    self = [super initWithCoder: decoder];
jens@0
   316
    if( self ) {
jens@0
   317
        _lastSuccess = [decoder decodeDoubleForKey: @"last"];
jens@0
   318
        _successes = [decoder decodeIntForKey: @"succ"];
jens@0
   319
    }
jens@0
   320
    return self;
jens@0
   321
}
jens@0
   322
jens@0
   323
jens@0
   324
@end
jens@0
   325
jens@0
   326
jens@0
   327
jens@0
   328
jens@0
   329
jens@0
   330
#import "Test.h"
jens@0
   331
jens@0
   332
TestCase(IPAddress) {
jens@0
   333
    RequireTestCase(CollectionUtils);
jens@0
   334
    IPAddress *addr = [[IPAddress alloc] initWithIPv4: htonl(0x0A0001FE) port: 8080];
jens@0
   335
    CAssertEq(addr.ipv4,htonl(0x0A0001FE));
jens@0
   336
    CAssertEq(addr.port,8080);
jens@0
   337
    CAssertEqual(addr.hostname,@"10.0.1.254");
jens@0
   338
    CAssertEqual(addr.description,@"10.0.1.254:8080");
jens@0
   339
    CAssert(addr.isPrivate);
jens@0
   340
    
jens@0
   341
    addr = [[IPAddress alloc] initWithHostname: @"66.66.0.255" port: 123];
jens@0
   342
    CAssertEq(addr.class,[IPAddress class]);
jens@0
   343
    CAssertEq(addr.ipv4,htonl(0x424200FF));
jens@0
   344
    CAssertEq(addr.port,123);
jens@0
   345
    CAssertEqual(addr.hostname,@"66.66.0.255");
jens@0
   346
    CAssertEqual(addr.description,@"66.66.0.255:123");
jens@0
   347
    CAssert(!addr.isPrivate);
jens@0
   348
    
jens@0
   349
    addr = [[IPAddress alloc] initWithHostname: @"www.apple.com" port: 80];
jens@0
   350
    CAssertEq(addr.class,[HostAddress class]);
jens@0
   351
    Log(@"www.apple.com = 0x%08X", addr.ipv4);
jens@0
   352
    CAssertEq(addr.ipv4,htonl(0x1195A00A));
jens@0
   353
    CAssertEq(addr.port,80);
jens@0
   354
    CAssertEqual(addr.hostname,@"www.apple.com");
jens@0
   355
    CAssertEqual(addr.description,@"www.apple.com:80");
jens@0
   356
    CAssert(!addr.isPrivate);
jens@0
   357
}
jens@0
   358
jens@0
   359
jens@0
   360
/*
jens@0
   361
 Copyright (c) 2008, Jens Alfke <jens@mooseyard.com>. All rights reserved.
jens@0
   362
 
jens@0
   363
 Redistribution and use in source and binary forms, with or without modification, are permitted
jens@0
   364
 provided that the following conditions are met:
jens@0
   365
 
jens@0
   366
 * Redistributions of source code must retain the above copyright notice, this list of conditions
jens@0
   367
 and the following disclaimer.
jens@0
   368
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
jens@0
   369
 and the following disclaimer in the documentation and/or other materials provided with the
jens@0
   370
 distribution.
jens@0
   371
 
jens@0
   372
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
jens@0
   373
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
jens@0
   374
 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
jens@0
   375
 BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jens@0
   376
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
jens@0
   377
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
jens@0
   378
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
jens@0
   379
 THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jens@0
   380
 */