crates/api_common/src/site.rs

   1 use lemmy_db_schema::{CommunityId, PersonId};
   2 use lemmy_db_views::{
   3   comment_view::CommentView,
   4   local_user_view::LocalUserSettingsView,
   5   post_view::PostView,
   6   site_view::SiteView,
   7 };
   8 use lemmy_db_views_actor::{community_view::CommunityView, person_view::PersonViewSafe};
   9 use lemmy_db_views_moderator::{
  10   mod_add_community_view::ModAddCommunityView,
  11   mod_add_view::ModAddView,
  12   mod_ban_from_community_view::ModBanFromCommunityView,
  13   mod_ban_view::ModBanView,
  14   mod_lock_post_view::ModLockPostView,
  15   mod_remove_comment_view::ModRemoveCommentView,
  16   mod_remove_community_view::ModRemoveCommunityView,
  17   mod_remove_post_view::ModRemovePostView,
  18   mod_sticky_post_view::ModStickyPostView,
  19   mod_transfer_community_view::ModTransferCommunityView,
  20 };
  21 use serde::{Deserialize, Serialize};
  22
  23 #[derive(Deserialize, Debug)]
  24 pub struct Search {
  25   pub q: String,
  26   pub community_id: Option<CommunityId>,
  27   pub community_name: Option<String>,
  28   pub creator_id: Option<PersonId>,
  29   pub type_: Option<String>,
  30   pub sort: Option<String>,
  31   pub listing_type: Option<String>,
  32   pub page: Option<i64>,
  33   pub limit: Option<i64>,
  34   pub auth: Option<String>,
  35 }
  36
  37 #[derive(Serialize, Debug)]
  38 pub struct SearchResponse {
  39   pub type_: String,
  40   pub comments: Vec<CommentView>,
  41   pub posts: Vec<PostView>,
  42   pub communities: Vec<CommunityView>,
  43   pub users: Vec<PersonViewSafe>,
  44 }
  45
  46 #[derive(Deserialize)]
  47 pub struct GetModlog {
  48   pub mod_person_id: Option<PersonId>,
  49   pub community_id: Option<CommunityId>,
  50   pub page: Option<i64>,
  51   pub limit: Option<i64>,
  52 }
  53
  54 #[derive(Serialize)]
  55 pub struct GetModlogResponse {
  56   pub removed_posts: Vec<ModRemovePostView>,
  57   pub locked_posts: Vec<ModLockPostView>,
  58   pub stickied_posts: Vec<ModStickyPostView>,
  59   pub removed_comments: Vec<ModRemoveCommentView>,
  60   pub removed_communities: Vec<ModRemoveCommunityView>,
  61   pub banned_from_community: Vec<ModBanFromCommunityView>,
  62   pub banned: Vec<ModBanView>,
  63   pub added_to_community: Vec<ModAddCommunityView>,
  64   pub transferred_to_community: Vec<ModTransferCommunityView>,
  65   pub added: Vec<ModAddView>,
  66 }
  67
  68 #[derive(Deserialize)]
  69 pub struct CreateSite {
  70   pub name: String,
  71   pub sidebar: Option<String>,
  72   pub description: Option<String>,
  73   pub icon: Option<String>,
  74   pub banner: Option<String>,
  75   pub enable_downvotes: Option<bool>,
  76   pub open_registration: Option<bool>,
  77   pub enable_nsfw: Option<bool>,
  78   pub community_creation_admin_only: Option<bool>,
  79   pub auth: String,
  80 }
  81
  82 #[derive(Deserialize)]
  83 pub struct EditSite {
  84   pub name: Option<String>,
  85   pub sidebar: Option<String>,
  86   pub description: Option<String>,
  87   pub icon: Option<String>,
  88   pub banner: Option<String>,
  89   pub enable_downvotes: Option<bool>,
  90   pub open_registration: Option<bool>,
  91   pub enable_nsfw: Option<bool>,
  92   pub community_creation_admin_only: Option<bool>,
  93   pub auth: String,
  94 }
  95
  96 #[derive(Deserialize)]
  97 pub struct GetSite {
  98   pub auth: Option<String>,
  99 }
 100
 101 #[derive(Serialize, Clone)]
 102 pub struct SiteResponse {
 103   pub site_view: SiteView,
 104 }
 105
 106 #[derive(Serialize)]
 107 pub struct GetSiteResponse {
 108   pub site_view: Option<SiteView>, // Because the site might not be set up yet
 109   pub admins: Vec<PersonViewSafe>,
 110   pub banned: Vec<PersonViewSafe>,
 111   pub online: usize,
 112   pub version: String,
 113   pub my_user: Option<LocalUserSettingsView>,
 114   pub federated_instances: Option<FederatedInstances>, // Federation may be disabled
 115 }
 116
 117 #[derive(Deserialize)]
 118 pub struct TransferSite {
 119   pub person_id: PersonId,
 120   pub auth: String,
 121 }
 122
 123 #[derive(Deserialize)]
 124 pub struct GetSiteConfig {
 125   pub auth: String,
 126 }
 127
 128 #[derive(Serialize)]
 129 pub struct GetSiteConfigResponse {
 130   pub config_hjson: String,
 131 }
 132
 133 #[derive(Deserialize)]
 134 pub struct SaveSiteConfig {
 135   pub config_hjson: String,
 136   pub auth: String,
 137 }
 138
 139 #[derive(Serialize)]
 140 pub struct FederatedInstances {
 141   pub linked: Vec<String>,
 142   pub allowed: Option<Vec<String>>,
 143   pub blocked: Option<Vec<String>>,
 144 }