parse_base.dart

part of flutter_parse_sdk;

abstract class ParseBase {
  String parseClassName;
  Type type;
  bool _dirty = false; // reserved property
  final Map<String, dynamic> _unsavedChanges = Map<String, dynamic>();
  final Map<String, dynamic> _savingChanges = Map<String, dynamic>();

  /// Stores all the values of a class
  Map<String, dynamic> _objectData = Map<String, dynamic>();

  /// Returns [String] objectId
  String get objectId => get<String>(keyVarObjectId);

  set objectId(String objectId) => set<String>(keyVarObjectId, objectId);

  bool isDirty({String key}) {
    if (key != null) {
      return _unsavedChanges[key] != null;
    }
    return _isDirty(true);
  }

  bool _isDirty(bool considerChildren) {
    if (_dirty || _unsavedChanges.isNotEmpty) {
      return true;
    }

    if (considerChildren) {
      return _areChildrenDirty(Set<dynamic>());
    }
    return false;
  }

  bool _areChildrenDirty(Set<dynamic> seenObjects) {
    if (seenObjects.contains(this)) {
      return false;
    }
    seenObjects.add(this);
    if (_dirty || _unsavedChanges.isNotEmpty) {
      return true;
    }
    _getObjectData().forEach((String key, dynamic value) {
      if (value is ParseObject && value._areChildrenDirty(seenObjects)) {
        return true;
      }
    });
    return false;
  }

  /// Returns [DateTime] createdAt
  DateTime get createdAt {
    if (get<dynamic>(keyVarCreatedAt) is String) {
      final String dateAsString = get<String>(keyVarCreatedAt);
      return _parseDateFormat.parse(dateAsString);
    } else {
      return get<DateTime>(keyVarCreatedAt);
    }
  }

  /// Returns [DateTime] updatedAt
  DateTime get updatedAt {
    if (get<dynamic>(keyVarUpdatedAt) is String) {
      final String dateAsString = get<String>(keyVarUpdatedAt);
      return _parseDateFormat.parse(dateAsString);
    } else {
      return get<DateTime>(keyVarUpdatedAt);
    }
  }

  /// Converts object to [String] in JSON format
  @protected
  Map<String, dynamic> toJson({bool full, bool forApiRQ = false}) {
    final Map<String, dynamic> map = <String, dynamic>{
      keyVarClassName: parseClassName,
    };

    if (objectId != null) {
      map[keyVarObjectId] = objectId;
    }

    if (createdAt != null) {
      map[keyVarCreatedAt] = _parseDateFormat.format(createdAt);
    }

    if (updatedAt != null) {
      map[keyVarUpdatedAt] = _parseDateFormat.format(updatedAt);
    }

    final Map<String, dynamic> target = forApiRQ
        ? _unsavedChanges
        : _getObjectData();
    target.forEach((String key, dynamic value) {
      if (!map.containsKey(key)) {
        map[key] = parseEncode(value, full: full);
      }
    });

    if (forApiRQ) {
      map.remove(keyVarCreatedAt);
      map.remove(keyVarUpdatedAt);
      map.remove(keyVarClassName);
      //map.remove(keyVarAcl);
      map.remove(keyParamSessionToken);
    }

    return map;
  }

  @override
  String toString() => json.encode(toJson());

  dynamic fromJson(Map<String, dynamic> objectData) {
    if (objectData == null) {
      return this;
    }

    objectData.forEach((String key, dynamic value) {
      if (key == parseClassName || key == '__type') {
        // NO OP
      } else if (key == keyVarObjectId) {
        objectId = value;
      } else if (key == keyVarCreatedAt) {
        if (keyVarCreatedAt is String) {
          set<DateTime>(keyVarCreatedAt, _parseDateFormat.parse(value));
        } else {
          set<DateTime>(keyVarCreatedAt, value);
        }
      } else if (key == keyVarUpdatedAt) {
        if (keyVarUpdatedAt is String) {
          set<DateTime>(keyVarUpdatedAt, _parseDateFormat.parse(value));
        } else {
          set<DateTime>(keyVarUpdatedAt, value);
        }
      } else if (key == keyVarAcl) {
        this[keyVarAcl] = ParseACL().fromJson(value);
      } else {
        this[key] = parseDecode(value);
      }
    });

    return this;
  }

  /// Creates a copy of this class
  @protected
  dynamic copy() => fromJson(toJson());

  /// Sets all the objects variables
  @protected
  void _setObjectData(Map<String, dynamic> objectData) =>
      _objectData = objectData;

  /// Returns the objects variables
  @protected
  Map<String, dynamic> _getObjectData() =>
      _objectData ?? Map<String, dynamic>();

  bool containsValue(Object value) {
    return _getObjectData().containsValue(value);
  }

  bool containsKey(Object key) {
    return _getObjectData().containsKey(key);
  }

  dynamic operator [](Object key) {
    get<dynamic>(key);
  }

  void operator []=(String key, dynamic value) {
    set<dynamic>(key, value);
  }
  /// Saves in storage
  Future<void> saveInStorage(String key) async {
    final String objectJson = json.encode(toJson(full: true));
    ParseCoreData().getStore()
      ..setString(key, objectJson);
  }

  /// Sets type [T] from objectData
  ///
  /// To set an int, call setType<int> and an int will be saved
  /// [bool] forceUpdate is always true, if unsure as to whether an item is
  /// needed or not, set to false
  void set<T>(String key, T value, {bool forceUpdate = true}) {
    if (value != null) {
      if (_getObjectData().containsKey(key)) {
        if (_getObjectData()[key] == value) {
          return;
        }
        if (forceUpdate) {
          _getObjectData()[key] = value;
        }
      } else {
        _getObjectData()[key] = value;
      }
      _unsavedChanges[key] = value;
    }
  }

  ///Set the [ParseACL] governing this object.
  void setACL<ParseACL>(ParseACL acl) {
    _getObjectData()[keyVarAcl] = acl;
  }

  ///Access the [ParseACL] governing this object.
  ParseACL getACL() {
    if (_getObjectData().containsKey(keyVarAcl)) {
      return _getObjectData()[keyVarAcl];
    } else {
      return ParseACL();
    }
  }

  /// Gets type [T] from objectData
  ///
  /// Returns null or [defaultValue] if provided. To get an int, call
  /// getType<int> and an int will be returned, null, or a defaultValue if
  /// provided
  dynamic get<T>(String key, {T defaultValue}) {
    if (_getObjectData().containsKey(key)) {
      if (T != null && _getObjectData()[key] is T) {
        final T data = _getObjectData()[key];
        return data;
      } else {
        return _getObjectData()[key];
      }
    } else {
      return defaultValue;
    }
  }

  /// Saves item to simple key pair value storage
  ///
  /// Replicates Android SDK pin process and saves object to storage
  Future<bool> pin() async {
    if (objectId != null) {
      await unpin();
      final Map<String, dynamic> objectMap = parseEncode(this, full: true);
      final String json = jsonEncode(objectMap);
      ParseCoreData().getStore()
        ..setString(objectId, json);
      return true;
    } else {
      return false;
    }
  }

  /// Saves item to simple key pair value storage
  ///
  /// Replicates Android SDK pin process and saves object to storage
  Future<bool> unpin({String key}) async {
    if (objectId != null) {
      ParseCoreData().getStore()
        ..remove(key ?? objectId);
      return true;
    }

    return false;
  }

  /// Saves item to simple key pair value storage
  ///
  /// Replicates Android SDK pin process and saves object to storage
  dynamic fromPin(String objectId) async {
    if (objectId != null) {
      final CoreStore coreStore = ParseCoreData().getStore();
      final String itemFromStore = await coreStore.getString(objectId);

      if (itemFromStore != null) {
        return fromJson(json.decode(itemFromStore));
      }
    }
    return null;
  }

  Map<String, dynamic> toPointer() => encodeObject(parseClassName, objectId);

  /// Deprecated
  @Deprecated('Prefer to use parseClassName')
  String className;

  @Deprecated('Prefer to use parseClassName')
  String getClassName() => parseClassName;

  @Deprecated('Prefer to use parseClassName')
  String setClassName(String className) => parseClassName = className;

  @protected
  @Deprecated(
      'Prefer to use _getObjectData method, or operator [] for certain key.')
  Map<String, dynamic> getObjectData() => _getObjectData();

  @protected
  @Deprecated(
      'Prefer to use _setObjectData method, or operator [] for certain key.')
  void setObjectData(Map<String, dynamic> objectData) =>
      _setObjectData(objectData);
}