Merge pull request #2185 from floccusaddon/dropbox

Dropbox integration

Author: marcelklehr

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -36,6 +36,7 @@ body:
         - Linkwarden
         - WebDAV
         - Google Drive
+        - Dropbox
         - Git
     validations:
       required: true

.github/workflows/tests.yml

@@ -100,6 +100,8 @@ jobs:
           - git-html
           - google-drive
           - google-drive-encrypted
+          - dropbox
+          - dropbox-encrypted
           - linkwarden
           - karakeep
         test-name:
@@ -284,6 +286,7 @@ jobs:
           FLOCCUS_TEST_SEED: ${{ github.sha }}
           GIST_TOKEN: ${{ secrets.GIST_TOKEN }}
           GOOGLE_API_REFRESH_TOKEN: ${{ secrets.GOOGLE_API_REFRESH_TOKEN }}
+          DROPBOX_API_REFRESH_TOKEN: ${{ secrets.DROPBOX_API_REFRESH_TOKEN }}
           LINKWARDEN_TOKEN: ${{ secrets.LINKWARDEN_TOKEN }}
           APP_VERSION: ${{ matrix.app-version }}
           KARAKEEP_TEST_HOST: 172.17.0.1:3000

README.md

@@ -6,7 +6,7 @@
 [![Tests](https://github.com/marcelklehr/floccus/workflows/Tests/badge.svg)](https://github.com/marcelklehr/floccus/actions?query=workflow%3ATests) <img src="https://img.shields.io/chrome-web-store/users/fnaicdffflnofjppbagibeoednhnbjhg.svg"> <img src="https://img.shields.io/amo/users/floccus.svg">
 
 - 🔖 Syncs your real, native browser bookmarks directly
-- ☸ Sync via [Nextcloud Bookmarks](https://github.com/nextcloud/bookmarks), [Linkwarden](https://linkwarden.app/), [KaraKeep](https://karakeep.app/), Google Drive, any Git server (like GitHub, Gitlab, Gitea, etc.) or [any WebDAV-compatible service](https://community.cryptomator.org/t/webdav-urls-of-common-cloud-storage-services/75)
+- ☸ Sync via [Nextcloud Bookmarks](https://github.com/nextcloud/bookmarks), [Linkwarden](https://linkwarden.app/), [KaraKeep](https://karakeep.app/), Google Drive, Dropbox, any Git server (like GitHub, Gitlab, Gitea, etc.) or [any WebDAV-compatible service](https://community.cryptomator.org/t/webdav-urls-of-common-cloud-storage-services/75)
 - ⚛ Use any browser that supports Web extensions (e.g. Firefox, Chrome, Edge, Opera, Brave, Vivaldi, ...; Safari [not yet](https://github.com/floccusaddon/floccus/issues/23))
 - 📲 Install the floccus Android/iOS app to access your bookmarks on your phone (Most mobile browsers do not support floccus, sadly)
 - 💼 Create as many sync profiles as you need

_locales/en/messages.json

@@ -146,6 +146,18 @@
   "Error050": {
     "message": "E050: Failsafe: The current sync run would delete {0}% of your local links in this profile. Refusing to execute. Disable this failsafe in the profile settings if you want to proceed anyway. If you didn't cause this, you can use the manual sync buttons to override the server state with the local state on this device. If you believe this is a bug, please reach out to the developers with the debug log of this run."
   },
+  "Error051": {
+    "message": "E051: Could not authenticate with Dropbox. Please connect floccus with your Dropbox account again."
+  },
+  "Error052": {
+    "message": "E052: OAuth error. Token validation error. Please reconnect your Dropbox Account."
+  },
+  "Error053": {
+    "message": "E053: Could not search for your file name in your Dropbox"
+  },
+  "Error054": {
+    "message": "E054: Could not get template for Dropbox"
+  },
   "LabelWebdavurl": {
     "message": "WebDAV URL"
   },
@@ -169,6 +181,9 @@
   },
  "DescriptionBookmarksfilegoogle": {
    "message": "the file name of the bookmarks file that will reside in your Google Drive. Do not enter the full file path, only the file name. Make sure this name is unique in your Drive. e.g. mybookmarks.xbel"
+ },
+ "DescriptionBookmarksfiledropbox": {
+   "message": "the file name of the bookmarks file that will reside in your Dropbox. Do not enter the full file path, only the file name. Make sure this name is unique in your Dropbox. e.g. mybookmarks.xbel"
  },
   "DescriptionBookmarksfilegit": {
     "message": "a path to the bookmarks file relative to your Git repository root (all folders in the path must already exist). e.g. personal_stuff/bookmarks.xbel"
@@ -567,6 +582,21 @@
   "DescriptionLoggedingoogle": {
     "message": "You have connected your Google account to store the bookmark sync file in your Google Drive."
   },
+  "LabelAdapterdropbox": {
+    "message": "Dropbox"
+  },
+  "DescriptionAdapterdropbox": {
+    "message": "Sync bookmarks via an (optionally encrypted) file that is stored in your Dropbox. It can sync http, ftp, data, file and javascript bookmarks. You can choose to use end-to-end encryption when using this option."
+  },
+  "LabelLogindropbox": {
+    "message": "Login with Dropbox"
+  },
+  "DescriptionLogindropbox": {
+    "message": "Connect your Dropbox account to store the bookmark sync file in your Dropbox."
+  },
+  "DescriptionLoggedindropbox": {
+    "message": "You have connected your Dropbox account to store the bookmark sync file in your Dropbox."
+  },
   "LabelPassphrase": {
     "message": "Passphrase"
   },
@@ -699,6 +729,9 @@
   "LabelGoogledrivesetup": {
     "message": "Login to Google Drive"
   },
+  "LabelDropboxsetup": {
+    "message": "Login to Dropbox"
+  },
   "LabelSyncfoldersetup": {
     "message": "Which Folders do you want to sync?"
   },

dropbox-api.credentials.json

@@ -0,0 +1,27 @@
+{
+  "web": {
+    "client_id": "apzybhhq0x0o0gk",
+    "project_id": "apzybhhq0x0o0gk",
+    "auth_uri": "https://www.dropbox.com/oauth2/authorize",
+    "token_uri": "https://www.dropbox.com/oauth2/token",
+    "client_secret": "5p9q884v8vd69sw",
+    "redirect_uris": [
+      "https://mbepccofdnoepgicagpchfmafecckdam.chromiumapp.org/",
+      "https://76a380c4950986998208e7bb9dbd8fea94c91504.extensions.allizom.org/",
+      "https://fnaicdffflnofjppbagibeoednhnbjhg.chromiumapp.org/",
+      "https://gjkddcofhiifldbllobcamllmanombji.chromiumapp.org/",
+      "https://djejpebekaoommcjfeaiipdikmdjkblg.chromiumapp.org/"
+    ]
+  },
+  "android": {
+    "client_id": "apzybhhq0x0o0gk",
+    "project_id": "apzybhhq0x0o0gk",
+    "auth_uri": "https://www.dropbox.com/oauth2/authorize",
+    "token_uri": "https://www.dropbox.com/oauth2/token",
+    "redirect_uri": "org.handmadeideas.floccus://auth"
+  },
+  "ios": {
+    "client_id": "apzybhhq0x0o0gk",
+    "redirect_uri": "org.handmadeideas.floccus://auth"
+  }
+}

fastlane/metadata/android/en-US/full_description.txt

@@ -1,4 +1,4 @@
-Manage and synchronize your bookmarks via Nextcloud, or any WebDAV service, or any Git service, or Google Drive, end-to-end encrypted, if you want.
+Manage and synchronize your bookmarks via Nextcloud, or any WebDAV service, or any Git service, or Google Drive, or Dropbox, end-to-end encrypted, if you want.
 
 This is the standalone bookmarks manager android app variant of floccus. You can also install floccus on your Desktop browsers to sync bookmarks with them. This App, due to technical reasons, cannot access bookmarks in your mobile browser apps directly, which is why you can only view them in the app or import and export them as a html file.
 

gulpfile.js

@@ -13,20 +13,13 @@ var path = require('path')
 try {
   fs.accessSync('./google-api.credentials.json')
 } catch (e) {
-  fs.writeFileSync('./google-api.credentials.json', JSON.stringify({
-    'web': {
-      'client_id': 'yourappidhere.apps.googleusercontent.com',
-      'project_id': 'YOUR PROJECT ID HERE',
-      'auth_uri': 'https://accounts.google.com/o/oauth2/auth',
-      'token_uri': 'https://oauth2.googleapis.com/token',
-      'auth_provider_x509_cert_url': 'https://www.googleapis.com/oauth2/v1/certs',
-      'client_secret': 'YOUR CLIENT SECRET HERE',
-      'redirect_uris': [
-        'https://yourappidhere.chromiumapp.org/',
-        'https://yourappidhere.extensions.allizom.org/'
-      ]
-    }
-  }))
+  console.log(`error loading google api credentials: ${e.message}`)
+}
+
+try {
+  fs.accessSync('./dropbox-api.credentials.json')
+} catch (e) {
+  console.log(`error loading dropbox api credentials: ${e.message}`)
 }
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires

manifest.firefox.json

@@ -25,13 +25,11 @@
 
   "options_ui": {
     "page": "dist/html/options.html",
-    "browser_style": false,
-    "chrome_style": false
+    "browser_style": false
   },
 
   "browser_action": {
     "browser_style": false,
-    "chrome_style": false,
     "default_icon": {
       "48": "icons/logo.png"
     },

src/errors/Error.ts

@@ -287,11 +287,11 @@ export class GoogleDriveAuthenticationError extends FloccusError {
   }
 }
 
-export class OAuthTokenError extends FloccusError {
+export class GoogleOAuthTokenError extends FloccusError {
   public readonly code = 32
   constructor() {
     super('E032: OAuth error. Token validation error. Please reconnect your Google Account.')
-    Object.setPrototypeOf(this, OAuthTokenError.prototype)
+    Object.setPrototypeOf(this, GoogleOAuthTokenError.prototype)
   }
 }
 
@@ -466,4 +466,36 @@ export class ClientsideDeletionFailsafeError extends FloccusError {
     this.percent = percent
     Object.setPrototypeOf(this, ClientsideDeletionFailsafeError.prototype)
   }
+}
+
+export class DropboxAuthenticationError extends FloccusError {
+  public readonly code = 51
+  constructor() {
+    super('E051: Could not authenticate with Dropbox. Please connect floccus with your Dropbox account again.')
+    Object.setPrototypeOf(this, DropboxAuthenticationError.prototype)
+  }
+}
+
+export class DropboxOAuthTokenError extends FloccusError {
+  public readonly code = 52
+  constructor() {
+    super('E052: OAuth error. Token validation error. Please reconnect your Dropbox Account.')
+    Object.setPrototypeOf(this, DropboxOAuthTokenError.prototype)
+  }
+}
+
+export class DropboxSearchError extends FloccusError {
+  public readonly code = 53
+  constructor() {
+    super('E053: Could not search for your file name in your Dropbox')
+    Object.setPrototypeOf(this, DropboxSearchError.prototype)
+  }
+}
+
+export class DropboxTemplateError extends FloccusError {
+  public readonly code = 54
+  constructor() {
+    super('E054: Could not get template for Dropbox')
+    Object.setPrototypeOf(this, DropboxTemplateError.prototype)
+  }
 }

src/lib/Account.ts

@@ -31,6 +31,7 @@ AdapterFactory.register('nextcloud-bookmarks', async() => (await import('./adapt
 AdapterFactory.register('webdav', async() => (await import('./adapters/WebDav')).default)
 AdapterFactory.register('git', async() => (await import('./adapters/Git')).default)
 AdapterFactory.register('google-drive', async() => (await import('./adapters/GoogleDrive')).default)
+AdapterFactory.register('dropbox', async() => (await import('./adapters/Dropbox')).default)
 AdapterFactory.register('fake', async() => (await import('./adapters/Fake')).default)
 
 // 2h