[FEAT] Pinning and Tags

auth/lib/l10n/arb/app_en.arb

@@ -157,6 +157,7 @@
  }
  }
  },
+ "invalidQRCode": "Invalid QR code",
  "noRecoveryKeyTitle": "No recovery key?",
  "enterEmailHint": "Enter your email address",
  "invalidEmailTitle": "Invalid email address",
@@ -421,5 +422,7 @@
  "invalidEndpoint": "Invalid endpoint",
  "invalidEndpointMessage": "Sorry, the endpoint you entered is invalid. Please enter a valid endpoint and try again.",
  "endpointUpdatedMessage": "Endpoint updated successfully",
- "customEndpoint": "Connected to {endpoint}"
+ "customEndpoint": "Connected to {endpoint}",
+ "pinText": "Pin",
+ "unpinText": "Unpin"
 }

auth/lib/models/code.dart

@@ -1,4 +1,8 @@
+import 'dart:convert';
+
+import 'package:ente_auth/models/code_display.dart';
 import 'package:ente_auth/utils/totp_util.dart';
+import 'package:flutter/foundation.dart';
 
 class Code {
  static const defaultDigits = 6;
@@ -12,10 +16,16 @@ class Code {
  final String secret;
  final Algorithm algorithm;
  final Type type;
+
+ /// otpauth url in the code
  final String rawData;
  final int counter;
  bool? hasSynced;
 
+ final CodeDisplay? display;
+
+ bool get isPinned => display?.pinned ?? false;
+
  Code(
  this.account,
  this.issuer,
@@ -27,6 +37,7 @@ class Code {
  this.counter,
  this.rawData, {
  this.generatedID,
+ this.display,
  });
 
  Code copyWith({
@@ -38,6 +49,7 @@ class Code {
  Algorithm? algorithm,
  Type? type,
  int? counter,
+ CodeDisplay? display,
  }) {
  final String updateAccount = account ?? this.account;
  final String updateIssuer = issuer ?? this.issuer;
@@ -47,6 +59,7 @@ class Code {
  final Algorithm updatedAlgo = algorithm ?? this.algorithm;
  final Type updatedType = type ?? this.type;
  final int updatedCounter = counter ?? this.counter;
+ final CodeDisplay? updatedDisplay = display ?? this.display;
 
  return Code(
  updateAccount,
@@ -59,6 +72,7 @@ class Code {
  updatedCounter,
  "otpauth://${updatedType.name}/$updateIssuer:$updateAccount?algorithm=${updatedAlgo.name}&digits=$updatedDigits&issuer=$updateIssuer&period=$updatePeriod&secret=$updatedSecret${updatedType == Type.hotp ? "&counter=$updatedCounter" : ""}",
  generatedID: generatedID,
+ display: updatedDisplay,
  );
  }
 
@@ -80,7 +94,7 @@ class Code {
  );
  }
 
- static Code fromRawData(String rawData) {
+ static Code fromOTPAuthUrl(String rawData, {CodeDisplay? display}) {
  Uri uri = Uri.parse(rawData);
  try {
  return Code(
@@ -93,12 +107,13 @@ class Code {
  _getType(uri),
  _getCounter(uri),
  rawData,
+ display: CodeDisplay.fromUri(uri),
  );
  } catch (e) {
  // if account name contains # without encoding,
  // rest of the url are treated as url fragment
  if (rawData.contains("#")) {
- return Code.fromRawData(rawData.replaceAll("#", '%23'));
+ return Code.fromOTPAuthUrl(rawData.replaceAll("#", '%23'));
  } else {
  rethrow;
  }
@@ -122,6 +137,25 @@ class Code {
  }
  }
 
+ static Code fromExportJson(Map rawJson) {
+ try {
+ Code resultCode = Code.fromOTPAuthUrl(
+ rawJson['rawData'],
+ display: CodeDisplay.fromJson(rawJson['display']),
+ );
+ return resultCode;
+ } catch (e) {
+ debugPrint("Failed to parse code from export json $e");
+ rethrow;
+ }
+ }
+
+ String toExportFormat() {
+ return Uri.parse(
+ rawData + "&codeDisplay=" + jsonEncode(display ?? CodeDisplay()),
+ ).toString();
+ }
+
  static String _getIssuer(Uri uri) {
  try {
  if (uri.queryParameters.containsKey("issuer")) {
@@ -184,7 +218,7 @@ class Code {
  }
 
  static Type _getType(Uri uri) {
- if (uri.host == "totp") {
+ if (uri.host == "totp" || uri.host == "steam") {
  return Type.totp;
  } else if (uri.host == "hotp") {
  return Type.hotp;
@@ -204,7 +238,8 @@ class Code {
  other.secret == secret &&
  other.counter == counter &&
  other.type == type &&
- other.rawData == rawData;
+ other.rawData == rawData &&
+ other.display == display;
  }
 
  @override
@@ -216,7 +251,13 @@ class Code {
  secret.hashCode ^
  type.hashCode ^
  counter.hashCode ^
- rawData.hashCode;
+ rawData.hashCode ^
+ display.hashCode;
+ }
+
+ @override
+ String toString() {
+ return 'Code(account: $account, issuer: $issuer, digits: $digits, period: $period, secret: $secret, algorithm: $algorithm, type: $type, counter: $counter, rawData: $rawData, display: $display)';
  }
 }
 

auth/lib/models/code_display.dart

@@ -0,0 +1,70 @@
+import 'dart:convert';
+
+/// Used to store the display settings of a code.
+class CodeDisplay {
+ final bool pinned;
+ final bool trashed;
+ final int lastUsedAt;
+ final int tapCount;
+ final List<String> tags;
+
+ CodeDisplay({
+ this.pinned = false,
+ this.trashed = false,
+ this.lastUsedAt = 0,
+ this.tapCount = 0,
+ this.tags = const [],
+ });
+
+ // copyWith
+ CodeDisplay copyWith({
+ bool? pinned,
+ bool? trashed,
+ int? lastUsedAt,
+ int? tapCount,
+ List<String>? tags,
+ }) {
+ final bool updatedPinned = pinned ?? this.pinned;
+ final bool updatedTrashed = trashed ?? this.trashed;
+ final int updatedLastUsedAt = lastUsedAt ?? this.lastUsedAt;
+ final int updatedTapCount = tapCount ?? this.tapCount;
+ final List<String> updatedTags = tags ?? this.tags;
+
+ return CodeDisplay(
+ pinned: updatedPinned,
+ trashed: updatedTrashed,
+ lastUsedAt: updatedLastUsedAt,
+ tapCount: updatedTapCount,
+ tags: updatedTags,
+ );
+ }
+
+ factory CodeDisplay.fromJson(Map<String, dynamic>? json) {
+ if (json == null) {
+ return CodeDisplay();
+ }
+ return CodeDisplay(
+ pinned: json['pinned'] ?? false,
+ trashed: json['trashed'] ?? false,
+ lastUsedAt: json['lastUsedAt'] ?? 0,
+ tapCount: json['tapCount'] ?? 0,
+ );
+ }
+
+ static CodeDisplay? fromUri(Uri uri) {
+ if (!uri.queryParameters.containsKey("codeDisplay")) return null;
+ final String codeDisplay = uri.queryParameters['codeDisplay']!;
+ final decodedDisplay = jsonDecode(codeDisplay);
+
+ return CodeDisplay.fromJson(decodedDisplay);
+ }
+
+ Map<String, dynamic> toJson() {
+ return {
+ 'pinned': pinned,
+ 'trashed': trashed,
+ 'lastUsedAt': lastUsedAt,
+ 'tapCount': tapCount,
+ };
+ }
+}

auth/lib/store/code_store.dart

@@ -29,10 +29,17 @@ class CodeStore {
  final List<Code> codes = [];
  for (final entity in entities) {
  final decodeJson = jsonDecode(entity.rawData);
- final code = Code.fromRawData(decodeJson);
- code.generatedID = entity.generatedID;
- code.hasSynced = entity.hasSynced;
- codes.add(code);
+ if (decodeJson is String && decodeJson.startsWith('otpauth://')) {
+ final code = Code.fromOTPAuthUrl(decodeJson);
+ code.generatedID = entity.generatedID;
+ code.hasSynced = entity.hasSynced;
+ codes.add(code);
+ } else {
+ final code = Code.fromExportJson(decodeJson);
+ code.generatedID = entity.generatedID;
+ code.hasSynced = entity.hasSynced;
+ codes.add(code);
+ }
  }
 
  // sort codes by issuer,account
@@ -54,28 +61,33 @@ class CodeStore {
  final mode = accountMode ?? _authenticatorService.getAccountMode();
  final codes = await getAllCodes(accountMode: mode);
  bool isExistingCode = false;
+ bool hasSameCode = false;
  for (final existingCode in codes) {
- if (existingCode == code) {
- _logger.info("Found duplicate code, skipping add");
- return AddResult.duplicate;
- } else if (existingCode.generatedID == code.generatedID) {
+ if (code.generatedID != null &&
+ existingCode.generatedID == code.generatedID) {
  isExistingCode = true;
  break;
  }
+ if (existingCode == code) {
+ hasSameCode = true;
+ }
+ }
+ if (!isExistingCode && hasSameCode) {
+ return AddResult.duplicate;
  }
  late AddResult result;
  if (isExistingCode) {
  result = AddResult.updateCode;
  await _authenticatorService.updateEntry(
  code.generatedID!,
- jsonEncode(code.rawData),
+ code.toExportFormat(),
  shouldSync,
  mode,
  );
  } else {
  result = AddResult.newCode;
  code.generatedID = await _authenticatorService.addEntry(
- jsonEncode(code.rawData),
+ code.toExportFormat(),
  shouldSync,
  mode,
  );
@@ -93,7 +105,7 @@ class CodeStore {
  bool _isOfflineImportRunning = false;
 
  Future<void> importOfflineCodes() async {
- if(_isOfflineImportRunning) {
+ if (_isOfflineImportRunning) {
  return;
  }
  _isOfflineImportRunning = true;