Merge #162: 76 add tags to torrents

4730afd chore: clippy errors (Warm Beer)
a6cf184 chore: cargo fmt (Warm Beer)
4286ba9 feat: added filtering torrents on tags (Warm Beer)
a1bd92f fix: sql queries (Warm Beer)
7ce3d5e feat: torrent tags (Warm Beer)

Pull request description:

Author: mickvandijke

migrations/mysql/20230321122049_torrust_torrent_tags.sql

@@ -0,0 +1,5 @@
+CREATE TABLE IF NOT EXISTS torrust_torrent_tags (
+    tag_id INTEGER NOT NULL PRIMARY KEY AUTO_INCREMENT,
+    name VARCHAR(255) NOT NULL,
+    date_created TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);

migrations/mysql/20230321122825_torrust_torrent_tag_links.sql

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS torrust_torrent_tag_links (
+    torrent_id INTEGER NOT NULL,
+    tag_id INTEGER NOT NULL,
+    FOREIGN KEY (torrent_id) REFERENCES torrust_torrents(torrent_id) ON DELETE CASCADE,
+    FOREIGN KEY (tag_id) REFERENCES torrust_torrent_tags(tag_id) ON DELETE CASCADE,
+    PRIMARY KEY (torrent_id, tag_id)
+);

migrations/sqlite3/20230321122049_torrust_torrent_tags.sql

@@ -0,0 +1,5 @@
+CREATE TABLE IF NOT EXISTS torrust_torrent_tags (
+    tag_id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    name VARCHAR(255) NOT NULL,
+    date_created TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);

migrations/sqlite3/20230321122825_torrust_torrent_tag_links.sql

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS torrust_torrent_tag_links (
+    torrent_id INTEGER NOT NULL,
+    tag_id INTEGER NOT NULL,
+    FOREIGN KEY (torrent_id) REFERENCES torrust_torrents(torrent_id) ON DELETE CASCADE,
+    FOREIGN KEY (tag_id) REFERENCES torrust_torrent_tags(tag_id) ON DELETE CASCADE,
+    PRIMARY KEY (torrent_id, tag_id)
+);

src/app.rs

@@ -13,7 +13,7 @@ use crate::services::authentication::{DbUserAuthenticationRepository, JsonWebTok
 use crate::services::category::{self, DbCategoryRepository};
 use crate::services::torrent::{
     DbTorrentAnnounceUrlRepository, DbTorrentFileRepository, DbTorrentInfoRepository, DbTorrentListingGenerator,
-    DbTorrentRepository,
+    DbTorrentRepository, DbTorrentTagRepository,
 };
 use crate::services::user::{self, DbBannedUserList, DbUserProfileRepository, DbUserRepository};
 use crate::services::{proxy, settings, torrent};
@@ -65,6 +65,7 @@ pub async fn run(configuration: Configuration, api_implementation: &Implementati
     let torrent_info_repository = Arc::new(DbTorrentInfoRepository::new(database.clone()));
     let torrent_file_repository = Arc::new(DbTorrentFileRepository::new(database.clone()));
     let torrent_announce_url_repository = Arc::new(DbTorrentAnnounceUrlRepository::new(database.clone()));
+    let torrent_tag_repository = Arc::new(DbTorrentTagRepository::new(database.clone()));
     let torrent_listing_generator = Arc::new(DbTorrentListingGenerator::new(database.clone()));
     let banned_user_list = Arc::new(DbBannedUserList::new(database.clone()));
 
@@ -87,6 +88,7 @@ pub async fn run(configuration: Configuration, api_implementation: &Implementati
         torrent_info_repository.clone(),
         torrent_file_repository.clone(),
         torrent_announce_url_repository.clone(),
+        torrent_tag_repository.clone(),
         torrent_listing_generator.clone(),
     ));
     let registration_service = Arc::new(user::RegistrationService::new(
@@ -128,6 +130,7 @@ pub async fn run(configuration: Configuration, api_implementation: &Implementati
         torrent_info_repository,
         torrent_file_repository,
         torrent_announce_url_repository,
+        torrent_tag_repository,
         torrent_listing_generator,
         banned_user_list,
         category_service,

src/common.rs

@@ -8,7 +8,7 @@ use crate::services::authentication::{DbUserAuthenticationRepository, JsonWebTok
 use crate::services::category::{self, DbCategoryRepository};
 use crate::services::torrent::{
     DbTorrentAnnounceUrlRepository, DbTorrentFileRepository, DbTorrentInfoRepository, DbTorrentListingGenerator,
-    DbTorrentRepository,
+    DbTorrentRepository, DbTorrentTagRepository,
 };
 use crate::services::user::{self, DbBannedUserList, DbUserProfileRepository, DbUserRepository};
 use crate::services::{proxy, settings, torrent};
@@ -37,6 +37,7 @@ pub struct AppData {
     pub torrent_info_repository: Arc<DbTorrentInfoRepository>,
     pub torrent_file_repository: Arc<DbTorrentFileRepository>,
     pub torrent_announce_url_repository: Arc<DbTorrentAnnounceUrlRepository>,
+    pub torrent_tag_repository: Arc<DbTorrentTagRepository>,
     pub torrent_listing_generator: Arc<DbTorrentListingGenerator>,
     pub banned_user_list: Arc<DbBannedUserList>,
     // Services
@@ -69,6 +70,7 @@ impl AppData {
         torrent_info_repository: Arc<DbTorrentInfoRepository>,
         torrent_file_repository: Arc<DbTorrentFileRepository>,
         torrent_announce_url_repository: Arc<DbTorrentAnnounceUrlRepository>,
+        torrent_tag_repository: Arc<DbTorrentTagRepository>,
         torrent_listing_generator: Arc<DbTorrentListingGenerator>,
         banned_user_list: Arc<DbBannedUserList>,
         // Services
@@ -98,6 +100,7 @@ impl AppData {
             torrent_info_repository,
             torrent_file_repository,
             torrent_announce_url_repository,
+            torrent_tag_repository,
             torrent_listing_generator,
             banned_user_list,
             // Services

src/databases/database.rs

@@ -8,6 +8,7 @@ use crate::models::info_hash::InfoHash;
 use crate::models::response::TorrentsResponse;
 use crate::models::torrent::TorrentListing;
 use crate::models::torrent_file::{DbTorrentInfo, Torrent, TorrentFile};
+use crate::models::torrent_tag::{TagId, TorrentTag};
 use crate::models::tracker_key::TrackerKey;
 use crate::models::user::{User, UserAuthentication, UserCompact, UserId, UserProfile};
 
@@ -52,12 +53,15 @@ pub enum Sorting {
 #[derive(Debug)]
 pub enum Error {
     Error,
+    ErrorWithText(String),
     UnrecognizedDatabaseDriver, // when the db path does not start with sqlite or mysql
     UsernameTaken,
     EmailTaken,
     UserNotFound,
     CategoryAlreadyExists,
     CategoryNotFound,
+    TagAlreadyExists,
+    TagNotFound,
     TorrentNotFound,
     TorrentAlreadyExists, // when uploading an already uploaded info_hash
     TorrentTitleAlreadyExists,
@@ -156,6 +160,7 @@ pub trait Database: Sync + Send {
         &self,
         search: &Option<String>,
         categories: &Option<Vec<String>>,
+        tags: &Option<Vec<String>>,
         sort: &Sorting,
         offset: u64,
         page_size: u8,
@@ -228,6 +233,33 @@ pub trait Database: Sync + Send {
     /// Update a torrent's description with `torrent_id` and `description`.
     async fn update_torrent_description(&self, torrent_id: i64, description: &str) -> Result<(), Error>;
 
+    /// Add a new tag.
+    async fn add_tag(&self, name: &str) -> Result<(), Error>;
+
+    /// Delete a tag.
+    async fn delete_tag(&self, tag_id: TagId) -> Result<(), Error>;
+
+    /// Add a tag to torrent.
+    async fn add_torrent_tag_link(&self, torrent_id: i64, tag_id: TagId) -> Result<(), Error>;
+
+    /// Add multiple tags to a torrent at once.
+    async fn add_torrent_tag_links(&self, torrent_id: i64, tag_ids: &Vec<TagId>) -> Result<(), Error>;
+
+    /// Remove a tag from torrent.
+    async fn delete_torrent_tag_link(&self, torrent_id: i64, tag_id: TagId) -> Result<(), Error>;
+
+    /// Remove all tags from torrent.
+    async fn delete_all_torrent_tag_links(&self, torrent_id: i64) -> Result<(), Error>;
+
+    /// Get tag from name.
+    async fn get_tag_from_name(&self, name: &str) -> Result<TorrentTag, Error>;
+
+    /// Get all tags as `Vec<TorrentTag>`.
+    async fn get_tags(&self) -> Result<Vec<TorrentTag>, Error>;
+
+    /// Get tags for `torrent_id`.
+    async fn get_tags_for_torrent_id(&self, torrent_id: i64) -> Result<Vec<TorrentTag>, Error>;
+
     /// Update the seeders and leechers info for a torrent with `torrent_id`, `tracker_url`, `seeders` and `leechers`.
     async fn update_tracker_info(&self, torrent_id: i64, tracker_url: &str, seeders: i64, leechers: i64) -> Result<(), Error>;
 

src/databases/mysql.rs

@@ -12,6 +12,7 @@ use crate::models::info_hash::InfoHash;
 use crate::models::response::TorrentsResponse;
 use crate::models::torrent::TorrentListing;
 use crate::models::torrent_file::{DbTorrentAnnounceUrl, DbTorrentFile, DbTorrentInfo, Torrent, TorrentFile};
+use crate::models::torrent_tag::{TagId, TorrentTag};
 use crate::models::tracker_key::TrackerKey;
 use crate::models::user::{User, UserAuthentication, UserCompact, UserId, UserProfile};
 use crate::utils::clock;
@@ -300,6 +301,7 @@ impl Database for Mysql {
         &self,
         search: &Option<String>,
         categories: &Option<Vec<String>>,
+        tags: &Option<Vec<String>>,
         sort: &Sorting,
         offset: u64,
         limit: u8,
@@ -345,11 +347,36 @@ impl Database for Mysql {
             String::new()
         };
 
+        let tag_filter_query = if let Some(t) = tags {
+            let mut i = 0;
+            let mut tag_filters = String::new();
+            for tag in t.iter() {
+                // don't take user input in the db query
+                if let Ok(sanitized_tag) = self.get_tag_from_name(tag).await {
+                    let mut str = format!("tl.tag_id = '{}'", sanitized_tag.tag_id);
+                    if i > 0 {
+                        str = format!(" OR {str}");
+                    }
+                    tag_filters.push_str(&str);
+                    i += 1;
+                }
+            }
+            if tag_filters.is_empty() {
+                String::new()
+            } else {
+                format!("INNER JOIN torrust_torrent_tag_links tl ON tt.torrent_id = tl.torrent_id AND ({tag_filters}) ")
+            }
+        } else {
+            String::new()
+        };
+
         let mut query_string = format!(
             "SELECT tt.torrent_id, tp.username AS uploader, tt.info_hash, ti.title, ti.description, tt.category_id, DATE_FORMAT(tt.date_uploaded, '%Y-%m-%d %H:%i:%s') AS date_uploaded, tt.size AS file_size,
             CAST(COALESCE(sum(ts.seeders),0) as signed) as seeders,
             CAST(COALESCE(sum(ts.leechers),0) as signed) as leechers
-            FROM torrust_torrents tt {category_filter_query}
+            FROM torrust_torrents tt
+            {category_filter_query}
+            {tag_filter_query}
             INNER JOIN torrust_user_profiles tp ON tt.uploader_id = tp.user_id
             INNER JOIN torrust_torrent_info ti ON tt.torrent_id = ti.torrent_id
             LEFT JOIN torrust_torrent_tracker_stats ts ON tt.torrent_id = ts.torrent_id
@@ -677,6 +704,103 @@ impl Database for Mysql {
             })
     }
 
+    async fn add_tag(&self, name: &str) -> Result<(), database::Error> {
+        query("INSERT INTO torrust_torrent_tags (name) VALUES (?)")
+            .bind(name)
+            .execute(&self.pool)
+            .await
+            .map(|_| ())
+            .map_err(|err| database::Error::ErrorWithText(err.to_string()))
+    }
+
+    async fn delete_tag(&self, tag_id: TagId) -> Result<(), database::Error> {
+        query("DELETE FROM torrust_torrent_tags WHERE tag_id = ?")
+            .bind(tag_id)
+            .execute(&self.pool)
+            .await
+            .map(|_| ())
+            .map_err(|err| database::Error::ErrorWithText(err.to_string()))
+    }
+
+    async fn add_torrent_tag_link(&self, torrent_id: i64, tag_id: TagId) -> Result<(), database::Error> {
+        query("INSERT INTO torrust_torrent_tag_links (torrent_id, tag_id) VALUES (?, ?)")
+            .bind(torrent_id)
+            .bind(tag_id)
+            .execute(&self.pool)
+            .await
+            .map(|_| ())
+            .map_err(|_| database::Error::Error)
+    }
+
+    async fn add_torrent_tag_links(&self, torrent_id: i64, tag_ids: &Vec<TagId>) -> Result<(), database::Error> {
+        let mut transaction = self
+            .pool
+            .begin()
+            .await
+            .map_err(|err| database::Error::ErrorWithText(err.to_string()))?;
+
+        for tag_id in tag_ids {
+            query("INSERT INTO torrust_torrent_tag_links (torrent_id, tag_id) VALUES (?, ?)")
+                .bind(torrent_id)
+                .bind(tag_id)
+                .execute(&mut transaction)
+                .await
+                .map_err(|err| database::Error::ErrorWithText(err.to_string()))?;
+        }
+
+        transaction
+            .commit()
+            .await
+            .map_err(|err| database::Error::ErrorWithText(err.to_string()))
+    }
+
+    async fn delete_torrent_tag_link(&self, torrent_id: i64, tag_id: TagId) -> Result<(), database::Error> {
+        query("DELETE FROM torrust_torrent_tag_links WHERE torrent_id = ? AND tag_id = ?")
+            .bind(torrent_id)
+            .bind(tag_id)
+            .execute(&self.pool)
+            .await
+            .map(|_| ())
+            .map_err(|_| database::Error::Error)
+    }
+
+    async fn delete_all_torrent_tag_links(&self, torrent_id: i64) -> Result<(), database::Error> {
+        query("DELETE FROM torrust_torrent_tag_links WHERE torrent_id = ?")
+            .bind(torrent_id)
+            .execute(&self.pool)
+            .await
+            .map(|_| ())
+            .map_err(|err| database::Error::ErrorWithText(err.to_string()))
+    }
+
+    async fn get_tag_from_name(&self, name: &str) -> Result<TorrentTag, database::Error> {
+        query_as::<_, TorrentTag>("SELECT tag_id, name FROM torrust_torrent_tags WHERE name = ?")
+            .bind(name)
+            .fetch_one(&self.pool)
+            .await
+            .map_err(|err| database::Error::TagNotFound)
+    }
+
+    async fn get_tags(&self) -> Result<Vec<TorrentTag>, database::Error> {
+        query_as::<_, TorrentTag>("SELECT tag_id, name FROM torrust_torrent_tags")
+            .fetch_all(&self.pool)
+            .await
+            .map_err(|_| database::Error::Error)
+    }
+
+    async fn get_tags_for_torrent_id(&self, torrent_id: i64) -> Result<Vec<TorrentTag>, database::Error> {
+        query_as::<_, TorrentTag>(
+            "SELECT torrust_torrent_tags.tag_id, torrust_torrent_tags.name
+            FROM torrust_torrent_tags
+            JOIN torrust_torrent_tag_links ON torrust_torrent_tags.tag_id = torrust_torrent_tag_links.tag_id
+            WHERE torrust_torrent_tag_links.torrent_id = ?",
+        )
+        .bind(torrent_id)
+        .fetch_all(&self.pool)
+        .await
+        .map_err(|_| database::Error::Error)
+    }
+
     async fn update_tracker_info(
         &self,
         torrent_id: i64,