CFURLAccess.h

   1 /*
   2  * Copyright (c) 2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFURLAccess.h
  24         Copyright (c) 1998-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFURLACCESS__)
  28 #define __COREFOUNDATION_CFURLACCESS__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31 #include <CoreFoundation/CFArray.h>
  32 #include <CoreFoundation/CFData.h>
  33 #include <CoreFoundation/CFDictionary.h>
  34 #include <CoreFoundation/CFString.h>
  35 #include <CoreFoundation/CFURL.h>
  36
  37 CF_EXTERN_C_BEGIN
  38
  39 /* Attempts to read the data and properties for the given URL.  If
  40 only interested in one of the resourceData and properties, pass NULL
  41 for the other.  If properties is non-NULL and desiredProperties is
  42 NULL, then all properties are fetched.  Returns success or failure;
  43 note that as much work as possible is done even if false is returned.
  44 So for instance if one property is not available, the others are
  45 fetched anyway. errorCode is set to 0 on success, and some other
  46 value on failure.  If non-NULL, it is the caller 's responsibility
  47 to release resourceData and properties.
  48
  49     Apple reserves for its use all negative error code values; these
  50 values represent errors common to any scheme.  Scheme-specific error
  51 codes should be positive, non-zero, and should be used only if one of
  52 the predefined Apple error codes does not apply.  Error codes should
  53 be publicized and documented with the scheme-specific properties.
  54
  55 NOTE: When asking for the resource data, this call will allocate the entire
  56 resource in memory. This can be very expensive, depending on the size of the
  57 resource (file). Please use CFStream or other techniques if you are downloading
  58 large files.
  59
  60 */
  61 CF_EXPORT
  62 Boolean CFURLCreateDataAndPropertiesFromResource(CFAllocatorRef alloc, CFURLRef url, CFDataRef *resourceData, CFDictionaryRef *properties, CFArrayRef desiredProperties, SInt32 *errorCode);
  63
  64 /* Attempts to write the given data and properties to the given URL.
  65 If dataToWrite is NULL, only properties are written out (use
  66 CFURLDestroyResource() to delete a resource).  Properties not present
  67 in propertiesToWrite are left unchanged, hence if propertiesToWrite
  68 is NULL or empty, the URL's properties are not changed at all.
  69 Returns success or failure; errorCode is set as for
  70 CFURLCreateDataAndPropertiesFromResource(), above.
  71 */
  72 CF_EXPORT
  73 Boolean CFURLWriteDataAndPropertiesToResource(CFURLRef url, CFDataRef dataToWrite, CFDictionaryRef propertiesToWrite, SInt32 *errorCode);
  74
  75 /* Destroys the resource indicated by url. */
  76 /* Returns success or failure; errorCode set as above. */
  77 CF_EXPORT
  78 Boolean CFURLDestroyResource(CFURLRef url, SInt32 *errorCode);
  79
  80 /* Convenience method which calls through to CFURLCreateDataAndPropertiesFromResource(). */
  81 /* Returns NULL on error and sets errorCode accordingly. */
  82 CF_EXPORT
  83 CFTypeRef CFURLCreatePropertyFromResource(CFAllocatorRef alloc, CFURLRef url, CFStringRef property, SInt32 *errorCode);
  84
  85 /* Common error codes; this list is expected to grow */
  86 enum {
  87     kCFURLUnknownError = -10,
  88     kCFURLUnknownSchemeError = -11,
  89     kCFURLResourceNotFoundError = -12,
  90     kCFURLResourceAccessViolationError = -13,
  91     kCFURLRemoteHostUnavailableError = -14,
  92     kCFURLImproperArgumentsError = -15,
  93     kCFURLUnknownPropertyKeyError = -16,
  94     kCFURLPropertyKeyUnavailableError = -17,
  95     kCFURLTimeoutError = -18
  96 };
  97 typedef CFIndex CFURLError;
  98
  99 /* Property keys */
 100
 101 CF_EXPORT
 102 const CFStringRef kCFURLFileExists;
 103 CF_EXPORT
 104 const CFStringRef kCFURLFileDirectoryContents;
 105 CF_EXPORT
 106 const CFStringRef kCFURLFileLength;
 107 CF_EXPORT
 108 const CFStringRef kCFURLFileLastModificationTime;
 109 CF_EXPORT
 110 const CFStringRef kCFURLFilePOSIXMode;
 111 CF_EXPORT
 112 const CFStringRef kCFURLFileOwnerID;
 113 CF_EXPORT
 114 const CFStringRef kCFURLHTTPStatusCode;
 115 CF_EXPORT
 116 const CFStringRef kCFURLHTTPStatusLine;
 117
 118 /* The value of kCFURLFileExists is a CFBoolean */
 119 /* The value of kCFURLFileDirectoryContents is a CFArray containing CFURLs.  An empty array means the directory exists, but is empty */
 120 /* The value of kCFURLFileLength is a CFNumber giving the file's length in bytes */
 121 /* The value of kCFURLFileLastModificationTime is a CFDate */
 122 /* The value of kCFURLFilePOSIXMode is a CFNumber as given in stat.h */
 123 /* The value of kCFURLFileOwnerID is a CFNumber representing the owner's uid */
 124
 125 /* Properties for the http: scheme.  Except for the common error codes, above, errorCode will be set to the HTTP response status code upon failure.  Any HTTP header name can also be used as a property */
 126 /* The value of kCFURLHTTPStatusCode is a CFNumber */
 127 /* The value of kCFURLHTTPStatusLine is a CFString */
 128
 129 CF_EXTERN_C_END
 130
 131 #endif /* ! __COREFOUNDATION_CFURLACCESS__ */
 132