firebase-ios-sdk/FirebaseStorage/Sources/FIRStorageErrors.m

// Copyright 2017 Google
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#import "FirebaseStorage/Sources/FIRStorageErrors.h"

#import "FirebaseStorage/Sources/Public/FirebaseStorage/FIRStorageReference.h"

#import "FirebaseStorage/Sources/FIRStorageConstants_Private.h"
#import "FirebaseStorage/Sources/FIRStorageReference_Private.h"

@implementation FIRStorageErrors

+ (NSError *)errorWithCode:(FIRStorageErrorCode)code {
  return [FIRStorageErrors errorWithCode:code infoDictionary:nil];
}

+ (NSError *)errorWithCode:(FIRStorageErrorCode)code
            infoDictionary:(nullable NSDictionary *)dictionary {
  NSMutableDictionary *errorDictionary;
  if (dictionary) {
    errorDictionary = [dictionary mutableCopy];
  } else {
    errorDictionary = [[NSMutableDictionary alloc] init];
  }

  NSString *errorMessage;
  switch (code) {
    case FIRStorageErrorCodeObjectNotFound:
      errorMessage =
          [NSString stringWithFormat:@"Object %@ does not exist.", errorDictionary[@"object"]];
      break;

    case FIRStorageErrorCodeBucketNotFound:
      errorMessage =
          [NSString stringWithFormat:@"Bucket %@ does not exist.", errorDictionary[@"bucket"]];
      break;

    case FIRStorageErrorCodeProjectNotFound:
      errorMessage =
          [NSString stringWithFormat:@"Project %@ does not exist.", errorDictionary[@"project"]];
      break;

    case FIRStorageErrorCodeQuotaExceeded: {
      NSString *const kQuotaExceededFormat =
          @"Quota for bucket %@ exceeded, please view quota on firebase.google.com.";
      errorMessage = [NSString stringWithFormat:kQuotaExceededFormat, errorDictionary[@"bucket"]];
      break;
    }

    case FIRStorageErrorCodeDownloadSizeExceeded: {
      int64_t total = [errorDictionary[@"totalSize"] longLongValue];
      int64_t size = [errorDictionary[@"maxAllowedSize"] longLongValue];
      NSString *totalString = total ? @(total).stringValue : @"unknown";
      NSString *sizeString = total ? @(size).stringValue : @"unknown";
      NSString *const kSizeExceededErrorFormat =
          @"Attempted to download object with size of %@ bytes, "
          @"which exceeds the maximum size of %@ bytes. "
          @"Consider raising the maximum download size, or using "
          @"[FIRStorageReference writeToFile:]";
      errorMessage = [NSString stringWithFormat:kSizeExceededErrorFormat, totalString, sizeString];
      break;
    }

    case FIRStorageErrorCodeUnauthenticated:
      errorMessage = @"User is not authenticated, please authenticate using Firebase "
                     @"Authentication and try again.";
      break;

    case FIRStorageErrorCodeUnauthorized: {
      NSString *bucket = errorDictionary[@"bucket"];
      NSString *object = errorDictionary[@"object"];
      NSString *const kUnauthorizedFormat = @"User does not have permission to access gs://%@/%@.";
      errorMessage = [NSString stringWithFormat:kUnauthorizedFormat, bucket, object];
      break;
    }

    case FIRStorageErrorCodeRetryLimitExceeded:
      errorMessage = @"Max retry time for operation exceeded, please try again.";
      break;

    case FIRStorageErrorCodeNonMatchingChecksum: {
      // TODO: replace with actual checksum strings when we choose to implement.
      NSString *const kChecksumFailedErrorFormat =
          @"Uploaded/downloaded object %@ has checksum: %@ "
          @"which does not match server checksum: %@. Please retry the upload/download.";
      errorMessage = [NSString stringWithFormat:kChecksumFailedErrorFormat, @"object",
                                                @"client checksum", @"server checksum"];
      break;
    }

    case FIRStorageErrorCodeCancelled:
      errorMessage = @"User cancelled the upload/download.";
      break;

    case FIRStorageErrorCodeUnknown:
      /* Fall through to default case for unknown errors */

    default:
      errorMessage = @"An unknown error occurred, please check the server response.";
      break;
  }

  errorDictionary[NSLocalizedDescriptionKey] = errorMessage;

  NSError *err = [NSError errorWithDomain:FIRStorageErrorDomain code:code userInfo:errorDictionary];
  return err;
}

+ (nullable NSError *)errorWithServerError:(nullable NSError *)error
                                 reference:(nullable FIRStorageReference *)reference {
  if (error == nil) {
    return nil;
  }

  FIRStorageErrorCode errorCode;
  switch (error.code) {
    case 400:
      errorCode = FIRStorageErrorCodeUnknown;
      break;

    case 401:
      errorCode = FIRStorageErrorCodeUnauthenticated;
      break;

    case 402:
      errorCode = FIRStorageErrorCodeQuotaExceeded;
      break;

    case 403:
      errorCode = FIRStorageErrorCodeUnauthorized;
      break;

    case 404:
      errorCode = FIRStorageErrorCodeObjectNotFound;
      break;

    default:
      errorCode = FIRStorageErrorCodeUnknown;
      break;
  }

  NSMutableDictionary *errorDictionary =
      [[[NSDictionary alloc] initWithDictionary:error.userInfo] mutableCopy];
  errorDictionary[kFIRStorageResponseErrorDomain] = error.domain;
  errorDictionary[kFIRStorageResponseErrorCode] = @(error.code);

  // Turn raw response into a string
  NSData *responseData = errorDictionary[@"data"];
  if (responseData) {
    NSString *errorString = [[NSString alloc] initWithData:responseData
                                                  encoding:NSUTF8StringEncoding];
    errorDictionary[kFIRStorageResponseBody] = errorString ?: @"No Response from Server.";
  }

  errorDictionary[@"bucket"] = reference.path.bucket;
  errorDictionary[@"object"] = reference.path.object;

  NSError *clientError = [FIRStorageErrors errorWithCode:errorCode infoDictionary:errorDictionary];
  return clientError;
}

+ (NSError *)errorWithInvalidRequest:(NSData *)request {
  NSString *requestString = [[NSString alloc] initWithData:request encoding:NSUTF8StringEncoding];
  NSString *invalidDataString =
      [NSString stringWithFormat:kFIRStorageInvalidDataFormat, requestString];
  NSDictionary *dict;
  if (invalidDataString.length > 0) {
    dict = @{NSLocalizedFailureReasonErrorKey : invalidDataString};
  }
  return [FIRStorageErrors errorWithCode:FIRStorageErrorCodeUnknown infoDictionary:dict];
}

+ (NSError *)errorWithCustomMessage:(NSString *)errorMessage {
  return [NSError errorWithDomain:FIRStorageErrorDomain
                             code:FIRStorageErrorCodeUnknown
                         userInfo:@{NSLocalizedDescriptionKey : errorMessage}];
}

@end