refactor: Add Details To User Accounts

vkhitrin · vkhitrin · commit a7941ce89de6 · 2024-10-25T21:22:20.000+03:00
Leverage `/api/user/profile` endpoint to fetch crucial information
regarding the user.
Individual users control if they support sharing bookmarks, we should respect
this option, and act accordingly.

Add database migrations that add new columns.

Update accounts, and bookmarks forms to indicate wether sharing
bookmarks is possible.
diff --git a/README.md b/README.md
@@ -21,6 +21,8 @@ Features:
 - Add/Edit/Remove bookmarks.
 - Search bookmarks based on title, URL, tags, desscription, and notes.
 
+cosmicding was tested against linkding releases `1.31.0`, and `1.36.0`.
+
 ## Dependencies
 
 - `cargo`
@@ -60,6 +62,7 @@ Potential improvements:
 - [Application] Allow user-provided TLS certificate.
 - [UI] Visual indicator for last sync status.
 - [UI] Indicators for `archived`, `unread`, `shared` bookmarks.
+- [UI] Display account information in accounts page.
 - [Distribution] Flatpack release.
 - [Distribution] compiled binary in GitHub release.
 - [UI] Sort bookmarks.
diff --git a/i18n/en/cosmicding.ftl b/i18n/en/cosmicding.ftl
@@ -19,6 +19,10 @@ display-name = Display Name
 edit = Edit
 edit-account = Edit Account
 edit-bookmark = Edit Bookmark
+disabled-public-sharing = Public bookmarks sharing disabled
+disabled-sharing = Bookmarks sharing disabled
+enabled-public-sharing = Public bookmarks sharing enabled
+enabled-sharing = Bookmarks sharing enabled
 failed-to-find-linkding-api-endpoint = Failed to find linkding API endpoint
 failed-to-parse-response = Failed to parse response
 file = File
@@ -46,8 +50,10 @@ removed-account = Removed account {$acc}
 removed-bookmark-from-account = Removed bookmark from account {$acc}
 save = Save
 search = Search
+setting-managed-externally = This setting can only be managed from Linkding web UI
 settings = Settings
 shared = Shared
+shared-disabled = Shared (Disabled)
 tags = Tags
 tags-helper = Enter any number of tags separated by space.
 theme = Theme
diff --git a/migrations/20241025005828_UserAccounts_Sharing.sql b/migrations/20241025005828_UserAccounts_Sharing.sql
@@ -0,0 +1,2 @@
+ALTER TABLE UserAccounts ADD COLUMN enable_sharing INTEGER default 0;
+ALTER TABLE UserAccounts ADD COLUMN enable_public_sharing INTEGER default 0;
diff --git a/src/app.rs b/src/app.rs
@@ -3,7 +3,7 @@ use crate::db::{self, SqliteDatabase};
 use crate::fl;
 use crate::http::{self};
 use crate::key_binds::key_binds;
-use crate::models::account::Account;
+use crate::models::account::{Account, AccountApiResponse};
 use crate::models::bookmarks::Bookmark;
 use crate::nav::NavPage;
 use crate::pages::accounts::{add_account, edit_account, AccountsMessage, AccountsView};
@@ -73,6 +73,7 @@ pub enum Message {
     CompleteRemoveDialog(Account, Option<Bookmark>),
     DialogCancel,
     DialogUpdate(DialogPage),
+    DoneRefreshAccountProfile(Account, AccountApiResponse),
     DoneRefreshBookmarksForAccount(Account, Vec<Bookmark>),
     DoneRefreshBookmarksForAllAccounts(Vec<Bookmark>),
     EditAccount(Account),
@@ -101,6 +102,7 @@ pub enum Message {
     SetBookmarkTitle(String),
     SetBookmarkURL(String),
     SetBookmarkUnread(bool),
+    StartRefreshAccountProfile(Account),
     StartRefreshBookmarksForAccount(Account),
     StartRefreshBookmarksForAllAccounts,
     StartupCompleted,
@@ -420,11 +422,13 @@ impl Application for Cosmicding {
                         .map(cosmic::app::Message::App),
                 );
             }
-            Message::CompleteAddAccount(account) => {
+            Message::CompleteAddAccount(mut account) => {
                 let mut valid_account = false;
                 block_on(async {
-                    match http::check_instance(&account).await {
-                        Ok(()) => {
+                    match http::check_account_on_instance(&account).await {
+                        Ok(value) => {
+                            account.enable_sharing = value.enable_sharing;
+                            account.enable_public_sharing = value.enable_public_sharing;
                             valid_account = true;
                         }
                         Err(e) => {
@@ -465,11 +469,13 @@ impl Application for Cosmicding {
                 }
                 self.core.window.show_context = false;
             }
-            Message::UpdateAccount(account) => {
+            Message::UpdateAccount(mut account) => {
                 let mut valid_account = false;
                 block_on(async {
-                    match http::check_instance(&account).await {
-                        Ok(()) => {
+                    match http::check_account_on_instance(&account).await {
+                        Ok(value) => {
+                            account.enable_sharing = value.enable_sharing;
+                            account.enable_public_sharing = value.enable_public_sharing;
                             valid_account = true;
                         }
                         Err(e) => {
@@ -524,7 +530,7 @@ impl Application for Cosmicding {
                     };
                     if !self.accounts_view.accounts.is_empty() {
                         commands.push(Command::perform(
-                            http::fetch_all_bookmarks_from_accounts(
+                            http::fetch_bookmarks_from_all_accounts(
                                 self.accounts_view.accounts.clone(),
                             ),
                             message,
@@ -553,9 +559,10 @@ impl Application for Cosmicding {
                         x,
                     ))
                 };
+                commands.push(self.update(Message::StartRefreshAccountProfile(account.clone())));
                 if !self.accounts_view.accounts.is_empty() {
                     commands.push(Command::perform(
-                        http::fetch_all_bookmarks_from_accounts(acc_vec.clone()),
+                        http::fetch_bookmarks_from_all_accounts(acc_vec.clone()),
                         message,
                     ));
                     commands.push(
@@ -579,6 +586,27 @@ impl Application for Cosmicding {
                 });
                 commands.push(self.update(Message::LoadBookmarks));
             }
+            Message::StartRefreshAccountProfile(account) => {
+                let borrowed_acc = account.clone();
+                let message = |r: Option<AccountApiResponse>| {
+                    cosmic::app::Message::App(Message::DoneRefreshAccountProfile(
+                        borrowed_acc,
+                        r.unwrap(),
+                    ))
+                };
+                commands.push(Command::perform(
+                    http::fetch_account_details(account),
+                    message,
+                ));
+            }
+            Message::DoneRefreshAccountProfile(mut account, account_details) => {
+                account.enable_sharing = account_details.enable_sharing;
+                account.enable_public_sharing = account_details.enable_public_sharing;
+                block_on(async {
+                    db::SqliteDatabase::update_account(&mut self.db, &account).await
+                });
+                commands.push(self.update(Message::LoadAccounts));
+            }
             Message::AddBookmarkForm => {
                 self.placeholder_bookmark = Some(Bookmark::new(
                     None,
@@ -853,14 +881,17 @@ impl Application for Cosmicding {
                     block_on(async { db::SqliteDatabase::fetch_bookmarks(&mut self.db).await });
             }
             Message::StartupCompleted => {
-                self.startup_completed = true;
+                for account in self.accounts_view.accounts.clone() {
+                    commands.push(self.update(Message::StartRefreshAccountProfile(account)));
+                }
                 commands.push(Command::perform(
                     async {
                         tokio::time::sleep(Duration::from_secs(1)).await;
                         crate::app::Message::StartRefreshBookmarksForAllAccounts
                     },
                     |msg| cosmic::app::Message::App(msg),
-                ))
+                ));
+                self.startup_completed = true;
             }
             Message::EmpptyMessage => {
                 commands.push(Command::none());
diff --git a/src/db/mod.rs b/src/db/mod.rs
@@ -70,6 +70,8 @@ impl SqliteDatabase {
                 last_sync_status: row.get("last_sync_status"),
                 last_sync_timestamp: row.get("last_sync_timestamp"),
                 tls: row.get("tls"),
+                enable_sharing: row.get("enable_sharing"),
+                enable_public_sharing: row.get("enable_public_sharing"),
             })
             .collect();
         return data;
@@ -83,24 +85,28 @@ impl SqliteDatabase {
             .unwrap();
     }
     pub async fn update_account(&mut self, account: &Account) {
-        let query: &str = "UPDATE UserAccounts SET display_name=$2, instance=$3, api_token=$4, tls=$5 WHERE id=$1;";
+        let query: &str = "UPDATE UserAccounts SET display_name=$2, instance=$3, api_token=$4, tls=$5, enable_sharing=$6, enable_public_sharing=$7 WHERE id=$1;";
         sqlx::query(query)
             .bind(&account.id)
             .bind(&account.display_name)
             .bind(&account.instance)
             .bind(&account.api_token)
             .bind(&account.tls)
+            .bind(&account.enable_sharing)
+            .bind(&account.enable_public_sharing)
             .execute(&mut self.conn)
             .await
             .unwrap();
     }
     pub async fn create_account(&mut self, account: &Account) {
-        let query: &str = "INSERT INTO UserAccounts (display_name, instance, api_token, last_sync_status, last_sync_timestamp, tls) VALUES ($1, $2, $3, 0, 0, $4);";
+        let query: &str = "INSERT INTO UserAccounts (display_name, instance, api_token, last_sync_status, last_sync_timestamp, tls, enable_sharing, enable_public_sharing) VALUES ($1, $2, $3, 0, 0, $4, $5, $6);";
         sqlx::query(query)
             .bind(&account.display_name)
             .bind(&account.instance)
             .bind(&account.api_token)
             .bind(&account.tls)
+            .bind(&account.enable_sharing)
+            .bind(&account.enable_public_sharing)
             .execute(&mut self.conn)
             .await
             .unwrap();
diff --git a/src/http/mod.rs b/src/http/mod.rs
@@ -1,5 +1,5 @@
 use crate::fl;
-use crate::models::account::Account;
+use crate::models::account::{Account, AccountApiResponse};
 use crate::models::bookmarks::{Bookmark, BookmarksApiResponse};
 use anyhow::Result;
 use reqwest::{
@@ -9,7 +9,7 @@ use reqwest::{
 use serde_json::Value;
 use std::fmt::Write;
 
-pub async fn fetch_all_bookmarks_from_accounts(accounts: Vec<Account>) -> Vec<Bookmark> {
+pub async fn fetch_bookmarks_from_all_accounts(accounts: Vec<Account>) -> Vec<Bookmark> {
     let mut all_bookmarks: Vec<Bookmark> = Vec::new();
     for account in accounts {
         match fetch_bookmarks_for_account(&account).await {
@@ -251,14 +251,28 @@ pub async fn edit_bookmark(
     }
 }
 
-pub async fn check_instance(account: &Account) -> Result<(), Box<dyn std::error::Error>> {
+pub async fn fetch_account_details(account: Account) -> Option<AccountApiResponse> {
+    let mut account_details: Option<AccountApiResponse> = None;
+    match check_account_on_instance(&account).await {
+        Ok(details) => {
+            account_details = Some(details);
+        }
+        Err(e) => {
+            log::error!(
+                "Error fetching account {} details: {}",
+                account.display_name,
+                e
+            );
+        }
+    }
+    return account_details;
+}
+
+pub async fn check_account_on_instance(
+    account: &Account,
+) -> Result<AccountApiResponse, Box<dyn std::error::Error>> {
     let mut rest_api_url: String = "".to_owned();
-    write!(
-        &mut rest_api_url,
-        "{}/api/bookmarks/?limit=1",
-        account.instance,
-    )
-    .unwrap();
+    write!(&mut rest_api_url, "{}/api/user/profile/", account.instance).unwrap();
     let mut headers = HeaderMap::new();
     let http_client = ClientBuilder::new()
         .danger_accept_invalid_certs(account.tls)
@@ -273,8 +287,8 @@ pub async fn check_instance(account: &Account) -> Result<(), Box<dyn std::error:
         .send()
         .await?;
     match response.status() {
-        StatusCode::OK => match response.json::<BookmarksApiResponse>().await {
-            Ok(_value) => Ok(()),
+        StatusCode::OK => match response.json::<AccountApiResponse>().await {
+            Ok(_value) => Ok(_value),
             Err(_e) => Err(Box::new(std::io::Error::new(
                 std::io::ErrorKind::Other,
                 fl!("failed-to-find-linkding-api-endpoint"),
diff --git a/src/models/account.rs b/src/models/account.rs
@@ -1,5 +1,6 @@
+use serde::{Deserialize, Serialize};
 use sqlx::FromRow;
-#[derive(Debug, Clone, FromRow, Eq, PartialEq)]
+#[derive(Serialize, Deserialize, Debug, Clone, FromRow, Eq, PartialEq)]
 pub struct Account {
     pub id: Option<i64>,
     pub api_token: String,
@@ -8,6 +9,8 @@ pub struct Account {
     pub last_sync_status: bool,
     pub last_sync_timestamp: i64,
     pub tls: bool,
+    pub enable_sharing: bool,
+    pub enable_public_sharing: bool,
 }
 
 impl AsRef<str> for Account {
@@ -26,6 +29,30 @@ impl Account {
             last_sync_status: false,
             last_sync_timestamp: 0,
             tls: true,
+            enable_sharing: false,
+            enable_public_sharing: false,
         }
     }
 }
+
+// NOTE: (vkhitrin) we do not use these preferences as part of the application
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct SearchPreferences {
+    pub sort: Option<String>,
+    pub shared: Option<String>,
+    pub unread: Option<String>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct AccountApiResponse {
+    pub theme: String,
+    pub bookmark_date_display: String,
+    pub web_archive_integration: String,
+    pub tag_search: String,
+    pub enable_sharing: bool,
+    pub enable_public_sharing: bool,
+    pub enable_favicons: bool,
+    pub display_url: bool,
+    pub permanent_notes: bool,
+    pub search_preferences: SearchPreferences,
+}
diff --git a/src/pages/accounts.rs b/src/pages/accounts.rs
@@ -2,6 +2,7 @@ use crate::app::Message;
 use crate::fl;
 use crate::models::account::Account;
 use cosmic::iced::Length;
+use cosmic::iced_widget::tooltip;
 use cosmic::{
     cosmic_theme,
     iced::{self, Alignment},
@@ -223,6 +224,7 @@ pub fn add_account<'a>(account: Account) -> Element<'a, Message> {
 }
 
 pub fn edit_account<'a>(account: Account) -> Element<'a, Message> {
+    let spacing = theme::active().cosmic().spacing;
     let cosmic_theme::Spacing { space_xxs, .. } = theme::active().cosmic().spacing;
     let display_name_widget_title = widget::text::body(fl!("display-name"));
     let display_name_widget_text_input = widget::text_input("Name", account.display_name.clone())
@@ -235,6 +237,49 @@ pub fn edit_account<'a>(account: Account) -> Element<'a, Message> {
         widget::secure_input("Token", account.api_token.clone(), None, true)
             .on_input(Message::SetAccountAPIKey);
     let tls_widget_checkbox = widget::checkbox(fl!("tls"), account.tls, Message::SetAccountTLS);
+    //let enable_shared_widget_text = widget::text(if account.enable_sharing {
+    //    fl!("enabled-sharing")
+    //} else {
+    //    "".to_owned()
+    //});
+    let enable_shared_widget_text = if account.enable_sharing {
+        widget::tooltip(
+            widget::row::with_capacity(2)
+                .spacing(spacing.space_xxs)
+                .push(widget::text::body(fl!("enabled-sharing")))
+                .push(widget::icon::from_name("dialog-information-symbolic").size(18)),
+            fl!("setting-managed-externally"),
+            tooltip::Position::Top,
+        )
+    } else {
+        widget::tooltip(
+            widget::row::with_capacity(2)
+                .spacing(spacing.space_xxs)
+                .push(widget::text::body(fl!("disabled-sharing")))
+                .push(widget::icon::from_name("dialog-information-symbolic").size(18)),
+            fl!("setting-managed-externally"),
+            tooltip::Position::Top,
+        )
+    };
+    let enable_public_shared_widget_text = if account.enable_sharing {
+        widget::tooltip(
+            widget::row::with_capacity(2)
+                .spacing(spacing.space_xxs)
+                .push(widget::text::body(fl!("enabled-public-sharing")))
+                .push(widget::icon::from_name("dialog-information-symbolic").size(18)),
+            fl!("setting-managed-externally"),
+            tooltip::Position::Top,
+        )
+    } else {
+        widget::tooltip(
+            widget::row::with_capacity(2)
+                .spacing(spacing.space_xxs)
+                .push(widget::text::body(fl!("disabled-public-sharing")))
+                .push(widget::icon::from_name("dialog-information-symbolic").size(18)),
+            fl!("setting-managed-externally"),
+            tooltip::Position::Top,
+        )
+    };
     let buttons_widget_container = widget::container(
         widget::button::text(fl!("save"))
             .style(widget::button::Style::Standard)
@@ -254,6 +299,9 @@ pub fn edit_account<'a>(account: Account) -> Element<'a, Message> {
         .push(widget::vertical_space(Length::from(10)))
         .push(tls_widget_checkbox)
         .push(widget::vertical_space(Length::from(10)))
+        .push(enable_shared_widget_text)
+        .push(enable_public_shared_widget_text)
+        .push(widget::vertical_space(Length::from(10)))
         .push(buttons_widget_container)
         .into()
 }
diff --git a/src/pages/bookmarks.rs b/src/pages/bookmarks.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE UserAccounts ADD COLUMN enable_sharing INTEGER default 0;`
	`2`	`+ALTER TABLE UserAccounts ADD COLUMN enable_public_sharing INTEGER default 0;`