crates/api_common/src/site.rs

   1 use crate::sensitive::Sensitive;
   2 use lemmy_db_schema::{
   3   newtypes::{CommentId, CommunityId, LanguageId, PersonId, PostId},
   4   source::{language::Language, tagline::Tagline},
   5   ListingType,
   6   ModlogActionType,
   7   SearchType,
   8   SortType,
   9 };
  10 use lemmy_db_views::structs::{
  11   CommentView,
  12   LocalUserSettingsView,
  13   PostView,
  14   RegistrationApplicationView,
  15   SiteView,
  16 };
  17 use lemmy_db_views_actor::structs::{
  18   CommunityBlockView,
  19   CommunityFollowerView,
  20   CommunityModeratorView,
  21   CommunityView,
  22   PersonBlockView,
  23   PersonViewSafe,
  24 };
  25 use lemmy_db_views_moderator::structs::{
  26   AdminPurgeCommentView,
  27   AdminPurgeCommunityView,
  28   AdminPurgePersonView,
  29   AdminPurgePostView,
  30   ModAddCommunityView,
  31   ModAddView,
  32   ModBanFromCommunityView,
  33   ModBanView,
  34   ModHideCommunityView,
  35   ModLockPostView,
  36   ModRemoveCommentView,
  37   ModRemoveCommunityView,
  38   ModRemovePostView,
  39   ModStickyPostView,
  40   ModTransferCommunityView,
  41 };
  42 use serde::{Deserialize, Serialize};
  43
  44 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
  45 pub struct Search {
  46   pub q: String,
  47   pub community_id: Option<CommunityId>,
  48   pub community_name: Option<String>,
  49   pub creator_id: Option<PersonId>,
  50   pub type_: Option<SearchType>,
  51   pub sort: Option<SortType>,
  52   pub listing_type: Option<ListingType>,
  53   pub page: Option<i64>,
  54   pub limit: Option<i64>,
  55   pub auth: Option<Sensitive<String>>,
  56 }
  57
  58 #[derive(Debug, Serialize, Deserialize, Clone)]
  59 pub struct SearchResponse {
  60   pub type_: String,
  61   pub comments: Vec<CommentView>,
  62   pub posts: Vec<PostView>,
  63   pub communities: Vec<CommunityView>,
  64   pub users: Vec<PersonViewSafe>,
  65 }
  66
  67 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
  68 pub struct ResolveObject {
  69   pub q: String,
  70   pub auth: Option<Sensitive<String>>,
  71 }
  72
  73 #[derive(Debug, Serialize, Deserialize, Default)]
  74 pub struct ResolveObjectResponse {
  75   pub comment: Option<CommentView>,
  76   pub post: Option<PostView>,
  77   pub community: Option<CommunityView>,
  78   pub person: Option<PersonViewSafe>,
  79 }
  80
  81 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
  82 pub struct GetModlog {
  83   pub mod_person_id: Option<PersonId>,
  84   pub community_id: Option<CommunityId>,
  85   pub page: Option<i64>,
  86   pub limit: Option<i64>,
  87   pub auth: Option<Sensitive<String>>,
  88   pub type_: Option<ModlogActionType>,
  89   pub other_person_id: Option<PersonId>,
  90 }
  91
  92 #[derive(Debug, Serialize, Deserialize, Clone)]
  93 pub struct GetModlogResponse {
  94   pub removed_posts: Vec<ModRemovePostView>,
  95   pub locked_posts: Vec<ModLockPostView>,
  96   pub stickied_posts: Vec<ModStickyPostView>,
  97   pub removed_comments: Vec<ModRemoveCommentView>,
  98   pub removed_communities: Vec<ModRemoveCommunityView>,
  99   pub banned_from_community: Vec<ModBanFromCommunityView>,
 100   pub banned: Vec<ModBanView>,
 101   pub added_to_community: Vec<ModAddCommunityView>,
 102   pub transferred_to_community: Vec<ModTransferCommunityView>,
 103   pub added: Vec<ModAddView>,
 104   pub admin_purged_persons: Vec<AdminPurgePersonView>,
 105   pub admin_purged_communities: Vec<AdminPurgeCommunityView>,
 106   pub admin_purged_posts: Vec<AdminPurgePostView>,
 107   pub admin_purged_comments: Vec<AdminPurgeCommentView>,
 108   pub hidden_communities: Vec<ModHideCommunityView>,
 109 }
 110
 111 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 112 pub struct CreateSite {
 113   pub name: String,
 114   pub sidebar: Option<String>,
 115   pub description: Option<String>,
 116   pub icon: Option<String>,
 117   pub banner: Option<String>,
 118   pub enable_downvotes: Option<bool>,
 119   pub open_registration: Option<bool>,
 120   pub enable_nsfw: Option<bool>,
 121   pub community_creation_admin_only: Option<bool>,
 122   pub require_email_verification: Option<bool>,
 123   pub require_application: Option<bool>,
 124   pub application_question: Option<String>,
 125   pub private_instance: Option<bool>,
 126   pub default_theme: Option<String>,
 127   pub default_post_listing_type: Option<String>,
 128   pub legal_information: Option<String>,
 129   pub application_email_admins: Option<bool>,
 130   pub hide_modlog_mod_names: Option<bool>,
 131   pub discussion_languages: Option<Vec<LanguageId>>,
 132   pub slur_filter_regex: Option<String>,
 133   pub actor_name_max_length: Option<i32>,
 134   pub rate_limit_message: Option<i32>,
 135   pub rate_limit_message_per_second: Option<i32>,
 136   pub rate_limit_post: Option<i32>,
 137   pub rate_limit_post_per_second: Option<i32>,
 138   pub rate_limit_register: Option<i32>,
 139   pub rate_limit_register_per_second: Option<i32>,
 140   pub rate_limit_image: Option<i32>,
 141   pub rate_limit_image_per_second: Option<i32>,
 142   pub rate_limit_comment: Option<i32>,
 143   pub rate_limit_comment_per_second: Option<i32>,
 144   pub rate_limit_search: Option<i32>,
 145   pub rate_limit_search_per_second: Option<i32>,
 146   pub federation_enabled: Option<bool>,
 147   pub federation_debug: Option<bool>,
 148   pub federation_strict_allowlist: Option<bool>,
 149   pub federation_http_fetch_retry_limit: Option<i32>,
 150   pub federation_worker_count: Option<i32>,
 151   pub captcha_enabled: Option<bool>,
 152   pub captcha_difficulty: Option<String>,
 153   pub allowed_instances: Option<Vec<String>>,
 154   pub blocked_instances: Option<Vec<String>>,
 155   pub auth: Sensitive<String>,
 156 }
 157
 158 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 159 pub struct EditSite {
 160   pub name: Option<String>,
 161   pub sidebar: Option<String>,
 162   pub description: Option<String>,
 163   pub icon: Option<String>,
 164   pub banner: Option<String>,
 165   pub enable_downvotes: Option<bool>,
 166   pub open_registration: Option<bool>,
 167   pub enable_nsfw: Option<bool>,
 168   pub community_creation_admin_only: Option<bool>,
 169   pub require_email_verification: Option<bool>,
 170   pub require_application: Option<bool>,
 171   pub application_question: Option<String>,
 172   pub private_instance: Option<bool>,
 173   pub default_theme: Option<String>,
 174   pub default_post_listing_type: Option<String>,
 175   pub legal_information: Option<String>,
 176   pub application_email_admins: Option<bool>,
 177   pub hide_modlog_mod_names: Option<bool>,
 178   pub discussion_languages: Option<Vec<LanguageId>>,
 179   pub slur_filter_regex: Option<String>,
 180   pub actor_name_max_length: Option<i32>,
 181   pub rate_limit_message: Option<i32>,
 182   pub rate_limit_message_per_second: Option<i32>,
 183   pub rate_limit_post: Option<i32>,
 184   pub rate_limit_post_per_second: Option<i32>,
 185   pub rate_limit_register: Option<i32>,
 186   pub rate_limit_register_per_second: Option<i32>,
 187   pub rate_limit_image: Option<i32>,
 188   pub rate_limit_image_per_second: Option<i32>,
 189   pub rate_limit_comment: Option<i32>,
 190   pub rate_limit_comment_per_second: Option<i32>,
 191   pub rate_limit_search: Option<i32>,
 192   pub rate_limit_search_per_second: Option<i32>,
 193   pub federation_enabled: Option<bool>,
 194   pub federation_debug: Option<bool>,
 195   pub federation_strict_allowlist: Option<bool>,
 196   pub federation_http_fetch_retry_limit: Option<i32>,
 197   pub federation_worker_count: Option<i32>,
 198   pub captcha_enabled: Option<bool>,
 199   pub captcha_difficulty: Option<String>,
 200   pub allowed_instances: Option<Vec<String>>,
 201   pub blocked_instances: Option<Vec<String>>,
 202   pub taglines: Option<Vec<String>>,
 203   pub auth: Sensitive<String>,
 204 }
 205
 206 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 207 pub struct GetSite {
 208   pub auth: Option<Sensitive<String>>,
 209 }
 210
 211 #[derive(Debug, Serialize, Deserialize, Clone)]
 212 pub struct SiteResponse {
 213   pub site_view: SiteView,
 214 }
 215
 216 #[derive(Debug, Serialize, Deserialize, Clone)]
 217 pub struct GetSiteResponse {
 218   pub site_view: SiteView,
 219   pub admins: Vec<PersonViewSafe>,
 220   pub online: usize,
 221   pub version: String,
 222   pub my_user: Option<MyUserInfo>,
 223   pub federated_instances: Option<FederatedInstances>, // Federation may be disabled
 224   pub all_languages: Vec<Language>,
 225   pub discussion_languages: Vec<LanguageId>,
 226   pub taglines: Option<Vec<Tagline>>,
 227 }
 228
 229 #[derive(Debug, Serialize, Deserialize, Clone)]
 230 pub struct MyUserInfo {
 231   pub local_user_view: LocalUserSettingsView,
 232   pub follows: Vec<CommunityFollowerView>,
 233   pub moderates: Vec<CommunityModeratorView>,
 234   pub community_blocks: Vec<CommunityBlockView>,
 235   pub person_blocks: Vec<PersonBlockView>,
 236   pub discussion_languages: Vec<Language>,
 237 }
 238
 239 #[derive(Debug, Serialize, Deserialize, Clone)]
 240 pub struct LeaveAdmin {
 241   pub auth: Sensitive<String>,
 242 }
 243
 244 #[derive(Debug, Serialize, Deserialize, Clone)]
 245 pub struct FederatedInstances {
 246   pub linked: Vec<String>,
 247   pub allowed: Option<Vec<String>>,
 248   pub blocked: Option<Vec<String>>,
 249 }
 250
 251 #[derive(Debug, Serialize, Deserialize, Clone)]
 252 pub struct PurgePerson {
 253   pub person_id: PersonId,
 254   pub reason: Option<String>,
 255   pub auth: String,
 256 }
 257
 258 #[derive(Debug, Serialize, Deserialize, Clone)]
 259 pub struct PurgeCommunity {
 260   pub community_id: CommunityId,
 261   pub reason: Option<String>,
 262   pub auth: String,
 263 }
 264
 265 #[derive(Debug, Serialize, Deserialize, Clone)]
 266 pub struct PurgePost {
 267   pub post_id: PostId,
 268   pub reason: Option<String>,
 269   pub auth: String,
 270 }
 271
 272 #[derive(Debug, Serialize, Deserialize, Clone)]
 273 pub struct PurgeComment {
 274   pub comment_id: CommentId,
 275   pub reason: Option<String>,
 276   pub auth: String,
 277 }
 278
 279 #[derive(Serialize, Deserialize)]
 280 pub struct PurgeItemResponse {
 281   pub success: bool,
 282 }
 283
 284 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 285 pub struct ListRegistrationApplications {
 286   /// Only shows the unread applications (IE those without an admin actor)
 287   pub unread_only: Option<bool>,
 288   pub page: Option<i64>,
 289   pub limit: Option<i64>,
 290   pub auth: String,
 291 }
 292
 293 #[derive(Debug, Serialize, Deserialize, Clone)]
 294 pub struct ListRegistrationApplicationsResponse {
 295   pub registration_applications: Vec<RegistrationApplicationView>,
 296 }
 297
 298 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 299 pub struct ApproveRegistrationApplication {
 300   pub id: i32,
 301   pub approve: bool,
 302   pub deny_reason: Option<String>,
 303   pub auth: String,
 304 }
 305
 306 #[derive(Debug, Serialize, Deserialize, Clone)]
 307 pub struct RegistrationApplicationResponse {
 308   pub registration_application: RegistrationApplicationView,
 309 }
 310
 311 #[derive(Debug, Serialize, Deserialize, Clone)]
 312 pub struct GetUnreadRegistrationApplicationCount {
 313   pub auth: String,
 314 }
 315
 316 #[derive(Debug, Serialize, Deserialize, Clone)]
 317 pub struct GetUnreadRegistrationApplicationCountResponse {
 318   pub registration_applications: i64,
 319 }