root/apps/iphone/superbook/trunk/DotTel_SDK/Classes/DnsResolver.h @ 719

//
//  DnsResolver.h
//  DotTel SDK
//
//  Created by Henri Asseily on 9/14/08.
/*
 Copyright (c) 2008-2009, Telnic Ltd. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
 Redistributions of source code must retain the above copyright notice, this list of conditions
 and the following disclaimer. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the documentation and/or other
 materials provided with the distribution.
 Neither the name of the Telnic Ltd. nor the names of its contributors may be used to endorse or
 promote products derived from this software without specific prior written permission.
 THIS DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
//
// 
//  This class is the entry point for handling the .tel DNS record classes
//  (RecordNatpr, RecordTxt and RecordLoc).
//  Simply allocate and initialize an instance of DnsResolver, and
//  call the get[Type]ForTel methods to populate your arrays.
//  Then iterate through those arrays, and ensure you check the isValid property
//  of each record.
//  Note that getNAPTRForTel, getTXTForTel and getLocForTel have different return
//  value types and are thus used in slightly different manners.

#import <UIKit/UIKit.h>
#import <ldns/ldns.h>
#import "NetworkUtility.h"
#import "idna.h"
#import "RecordNaptr.h"
#import "RecordTxt.h"
#import "RecordLoc.h"


// Shorthand for getting localized strings
#define LocTelStr(key) [[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:@"DotTel"]

// Error Codes

enum dns_resolver_enum_status {
        RESOLVER_STATUS_OK,     
        RESOLVER_STATUS_NO_CONNECTION,
        RESOLVER_STATUS_INVALID_ANSWER,
        RESOLVER_STATUS_NXDOMAIN,
        RESOLVER_STATUS_BAD_DATA,
        RESOLVER_STATUS_NO_NAME
};
typedef enum dns_resolver_enum_status dns_resolver_status;

@interface DnsResolver : NSObject {

        ldns_resolver *res;

}

/**
 * Retrieves all NAPTR records in a domain and adds them to the provided
 * array. NAPTR records are encapsulated in the RecordNaptr class.
 * 
 * @param aDom       the domain to query
 * @param naptrArray the array to add the naptrs to
 *
 * @return           the number of NAPTR records in the domain. 0 should mean error
 *
 */
- (NSUInteger)getNAPTRForTel:(NSString *)aDom inArray:(NSMutableArray *)naptrArray withError:(NSError **)error;

/**
 * Retrieves all TXT records in a domain and adds them to the provided
 * array. TXT records are encapsulated in the RecordTxt class.
 * Also note that TXT records are returned in random order.
 * 
 * @param domain     the domain to query
 * @param txtArray   the array to add the txt records to
 * 
 * @return         the number of TXT records in the domain. 0 should mean error
 *
 */
- (NSUInteger)getTXTForTel:(NSString *)domain inArray:(NSMutableArray *)txtArray withError:(NSError **)error;

/**
 * Retrieves a single LOC record in a domain and adds it to the provided
 * array. The LOC record is converted to a standard CLLocation object.
 * .tel specifications prohibit more than a single LOC record per (sub)domain
 * Returns the actual count of LOC records in the domain, for the caller to
 * catch counts over 1.
 * 
 * @param domain     the domain to query
 * @param locArray   the array to add the single loc record to
 *
 * @return           the number of LOC records in the domain
 *
 */
- (NSUInteger)getLOCForTel:(NSString *)domain inArray:(NSMutableArray *)locArray withError:(NSError **)error;

/**
 * Updates naptr records given an array of txt records
 * At this time the only items that this method will use are labels (.tlb)
 * .tlb records will be matched to their respective naptr records and will be
 * used to modify the naptr records' label property
 * Returns an array of int indexes of all modified naptr records in naptrArray
 * 
 * @param naptrArray    the array of naptrs to be updated
 * @param txtArray              the array of txt records from which to extract the additional info
 *
 * @return           a set of indexes of NAPTR records modified
 *
 */
- (NSIndexSet *)updateNaptrArray:(NSMutableArray *)naptrArray withTxtArray:(NSArray *)txtArray;

/**
 * Converts a fully qualified domain name into its IDN equivalent
 * The output may be an unmodified string
 * On error, returns the unmodified string (i.e. silently discards errors)
 *
 * @param domain        the domain to convert
 *
 * @return          the IDN string
 *
 */
- (NSString *)idnStringFromDomain:(NSString *)domain;
@end