├── .gitignore ├── renovate.json ├── .rustfmt.toml ├── Cargo.toml ├── src ├── utils.rs ├── response.rs ├── form.rs ├── lemmy_client_internal.rs ├── lemmy_client_trait.rs └── lib.rs ├── README.md ├── .woodpecker.yml ├── cliff.toml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": ["config:recommended"], 4 | "schedule": ["every weekend"], 5 | "automerge": true 6 | } 7 | -------------------------------------------------------------------------------- /.rustfmt.toml: -------------------------------------------------------------------------------- 1 | tab_spaces = 2 2 | edition = "2021" 3 | imports_layout = "HorizontalVertical" 4 | imports_granularity = "Crate" 5 | group_imports = "One" 6 | wrap_comments = true 7 | comment_width = 100 8 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "lemmy-client" 3 | version = "1.0.5" 4 | edition = "2021" 5 | license = "AGPL-3.0" 6 | authors = ["SleeplessOne1917"] 7 | description = "A Rust HTTP client for Lemmy." 8 | homepage = "https://join-lemmy.org" 9 | repository = "https://github.com/LemmyNet/lemmy-client-rs" 10 | keywords = ["Lemmy", "HTTP-client", "API-wrapper", "fediverse"] 11 | categories = ["api-bindings", "wasm"] 12 | 13 | [dependencies] 14 | cfg-if = "1" 15 | http = "1.1" 16 | lemmy_api_common = "=0.19.14" 17 | serde = "1.0" 18 | serde_json = "1.0" 19 | 20 | [features] 21 | default = ["default-tls"] 22 | default-tls = ["reqwest/default-tls"] 23 | native-tls = ["reqwest/native-tls"] 24 | rustls-tls = ["reqwest/rustls-tls"] 25 | 26 | [target.'cfg(target_family = "wasm")'.dependencies] 27 | gloo-net = { version = "0.6", features = ["http"] } 28 | serde_urlencoded = "0.7" 29 | web-sys = "0.3" 30 | 31 | [target.'cfg(not(target_family = "wasm"))'.dependencies] 32 | reqwest = { version = "0.12", features = ["json"], default-features = false } 33 | -------------------------------------------------------------------------------- /src/utils.rs: -------------------------------------------------------------------------------- 1 | macro_rules! impl_marker_trait { 2 | ($trait_name:ty, [$( $impler:ty ),+$(,)?]) => { 3 | $( 4 | impl $trait_name for $impler {} 5 | )* 6 | }; 7 | } 8 | 9 | pub(crate) use impl_marker_trait; 10 | 11 | #[derive(Debug, Clone, PartialEq, Eq)] 12 | /// Options for instantiating a `LemmyClient`. 13 | pub struct ClientOptions { 14 | /// Domain of the instance the client will send requests to. 15 | /// ``` 16 | /// use lemmy_client::ClientOptions; 17 | /// // ❌ You do not have to include the scheme for the domain. 18 | /// let options = ClientOptions { 19 | /// domain: String::from("https://lemmy.ml"), 20 | /// secure: true 21 | /// }; 22 | /// 23 | /// // ✅ All you need is the domain (including subdomain, if applicable). 24 | /// let options = ClientOptions { 25 | /// domain: String::from("lemmy.ml"), 26 | /// secure: true 27 | /// }; 28 | /// ``` 29 | pub domain: String, 30 | /// If true, use HTTPS. If false, use HTTP 31 | pub secure: bool, 32 | } 33 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | License 3 | Last commit 4 | Github stars 5 | Latest version 6 | Downloads for latest version 7 | Library size in bytes 8 |
9 |
10 | 11 | Lemmy logo 12 | 13 |

lemmy-client

14 |

A Rust HTTP client for Lemmy. Uses the browser's built-in fetch API when targeting WASM to keep the binary size small.

15 |
16 | 17 | ## IMPORTANT NOTICE 18 | 19 | This crate now uses a different versioning scheme than before so as not to be too tied down to Lemmy releases. For Lemmy versions 0.19.4 and up, use versions 1.x.x. For Lemmy versions 0.19.3 and under, use versions 0.19.5 and up. This is confusing, but should become a non issue as Lemmy accumulates versions and fewer servers use Lemmy versions use 0.19.3 and lower. 20 | -------------------------------------------------------------------------------- /src/response.rs: -------------------------------------------------------------------------------- 1 | use crate::utils::impl_marker_trait; 2 | use lemmy_api_common::{ 3 | comment::*, community::*, custom_emoji::*, lemmy_db_schema::source::login_token::LoginToken, 4 | person::*, post::*, private_message::*, site::*, LemmyErrorType, SuccessResponse, 5 | }; 6 | use serde::Deserialize; 7 | 8 | pub trait LemmyResponse: for<'de> Deserialize<'de> {} 9 | 10 | pub type LemmyResult = Result; 11 | 12 | impl_marker_trait!( 13 | LemmyResponse, 14 | [ 15 | String, 16 | SuccessResponse, 17 | // Comments 18 | CommentReportResponse, 19 | CommentResponse, 20 | CreateCommentReport, 21 | GetCommentsResponse, 22 | ListCommentLikesResponse, 23 | ListCommentReportsResponse, 24 | // Communities 25 | AddModToCommunityResponse, 26 | BanFromCommunityResponse, 27 | BlockCommunityResponse, 28 | CommunityResponse, 29 | GetCommunityResponse, 30 | ListCommunitiesResponse, 31 | // Custom Emojis 32 | CustomEmojiResponse, 33 | // Person 34 | AddAdminResponse, 35 | BanPersonResponse, 36 | BannedPersonsResponse, 37 | BlockPersonResponse, 38 | CaptchaResponse, 39 | CommentReplyResponse, 40 | GenerateTotpSecretResponse, 41 | GetCaptchaResponse, 42 | GetPersonDetailsResponse, 43 | GetPersonMentionsResponse, 44 | GetRepliesResponse, 45 | GetReportCountResponse, 46 | GetUnreadCountResponse, 47 | LoginResponse, 48 | PersonMentionResponse, 49 | UpdateTotpResponse, 50 | Vec, 51 | // Posts 52 | GetPostResponse, 53 | GetPostsResponse, 54 | GetSiteMetadataResponse, 55 | ListPostLikesResponse, 56 | ListPostReportsResponse, 57 | PostReportResponse, 58 | PostResponse, 59 | // Private Messages 60 | ListPrivateMessageReportsResponse, 61 | PrivateMessageReportResponse, 62 | PrivateMessageResponse, 63 | PrivateMessagesResponse, 64 | // Site 65 | BlockInstanceResponse, 66 | GetFederatedInstancesResponse, 67 | GetModlogResponse, 68 | GetSiteResponse, 69 | GetUnreadRegistrationApplicationCountResponse, 70 | ListRegistrationApplicationsResponse, 71 | RegistrationApplicationResponse, 72 | ResolveObjectResponse, 73 | SearchResponse, 74 | SiteResponse, 75 | // Media 76 | ListMediaResponse 77 | ] 78 | ); 79 | -------------------------------------------------------------------------------- /.woodpecker.yml: -------------------------------------------------------------------------------- 1 | variables: 2 | - &rust_image "rust:1.92-slim-bookworm" 3 | 4 | steps: 5 | toml_fmt: 6 | image: tamasfe/taplo:0.9.3 7 | commands: 8 | - taplo format --check 9 | when: 10 | - event: pull_request 11 | 12 | cargo_fmt: 13 | image: rustlang/rust:nightly-alpine 14 | commands: 15 | - rustup component add rustfmt 16 | - cargo +nightly fmt -- --check 17 | when: 18 | - event: pull_request 19 | 20 | cargo_machete: 21 | image: *rust_image 22 | commands: 23 | - apt update && apt -y install wget 24 | - wget -O- https://github.com/cargo-bins/cargo-binstall/releases/latest/download/cargo-binstall-x86_64-unknown-linux-musl.tgz | tar -xvz -C /usr/local/cargo/bin 25 | - cargo binstall -y cargo-machete 26 | - cargo machete 27 | when: 28 | - event: pull_request 29 | 30 | cargo_clippy: 31 | image: *rust_image 32 | commands: 33 | - apt update && apt install pkg-config libssl-dev -y 34 | - rustup component add clippy 35 | - cargo clippy --tests --all-targets -- -D warnings 36 | when: 37 | - event: pull_request 38 | 39 | cargo_build: 40 | image: *rust_image 41 | commands: 42 | - apt update && apt install pkg-config libssl-dev -y 43 | - cargo build 44 | when: 45 | - event: pull_request 46 | 47 | cargo_test: 48 | image: *rust_image 49 | environment: 50 | RUST_BACKTRACE: "1" 51 | commands: 52 | - apt update && apt install pkg-config libssl-dev -y 53 | - cargo test --no-fail-fast 54 | when: 55 | - event: pull_request 56 | 57 | publish_to_crates_io: 58 | image: *rust_image 59 | environment: 60 | CARGO_API_TOKEN: 61 | from_secret: cargo_api_token 62 | commands: 63 | - cargo publish --allow-dirty --no-verify --token "$CARGO_API_TOKEN" 64 | when: 65 | - event: tag 66 | 67 | notify_success: 68 | image: alpine:3 69 | commands: 70 | - apk add curl 71 | - "curl -H'Title: ✔️ ${CI_REPO_NAME}/${CI_COMMIT_SOURCE_BRANCH}' -d'${CI_PIPELINE_URL}' ntfy.sh/lemmy_drone_ci" 72 | when: 73 | - event: pull_request 74 | status: [success] 75 | 76 | notify_failure: 77 | image: alpine:3 78 | commands: 79 | - apk add curl 80 | - "curl -H'Title: ❌ ${CI_REPO_NAME}/${CI_COMMIT_SOURCE_BRANCH}' -d'${CI_PIPELINE_URL}' ntfy.sh/lemmy_drone_ci" 81 | when: 82 | - event: pull_request 83 | status: [failure] 84 | 85 | notify_on_tag_deploy: 86 | image: alpine:3 87 | commands: 88 | - apk add curl 89 | - "curl -H'Title: ${CI_REPO_NAME}:${CI_COMMIT_TAG} deployed' -d'${CI_PIPELINE_URL}' ntfy.sh/lemmy_drone_ci" 90 | when: 91 | event: tag 92 | -------------------------------------------------------------------------------- /cliff.toml: -------------------------------------------------------------------------------- 1 | # git-cliff ~ configuration file 2 | # https://git-cliff.org/docs/configuration 3 | 4 | [remote.github] 5 | owner = "LemmyNet" 6 | repo = "lemmy-client-rs" 7 | # token = "" 8 | 9 | [changelog] 10 | # A Tera template to be rendered for each release in the changelog. 11 | # See https://keats.github.io/tera/docs/#introduction 12 | body = """ 13 | ## What's Changed 14 | 15 | {%- if version %} in {{ version }}{%- endif -%} 16 | {% for commit in commits %} 17 | {% if commit.remote.pr_title -%} 18 | {%- set commit_message = commit.remote.pr_title -%} 19 | {%- else -%} 20 | {%- set commit_message = commit.message -%} 21 | {%- endif -%} 22 | * {{ commit_message | split(pat="\n") | first | trim }}\ 23 | {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%} 24 | {% if commit.remote.pr_number %} in \ 25 | [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \ 26 | {%- endif %} 27 | {%- endfor -%} 28 | 29 | {%- if github -%} 30 | {% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} 31 | {% raw %}\n{% endraw -%} 32 | ## New Contributors 33 | {%- endif %}\ 34 | {% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} 35 | * @{{ contributor.username }} made their first contribution 36 | {%- if contributor.pr_number %} in \ 37 | [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ 38 | {%- endif %} 39 | {%- endfor -%} 40 | {%- endif -%} 41 | 42 | {% if version %} 43 | {% if previous.version %} 44 | **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }} 45 | {% endif %} 46 | {% else -%} 47 | {% raw %}\n{% endraw %} 48 | {% endif %} 49 | 50 | {%- macro remote_url() -%} 51 | https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} 52 | {%- endmacro -%} 53 | """ 54 | # Remove leading and trailing whitespaces from the changelog's body. 55 | trim = true 56 | # A Tera template to be rendered as the changelog's footer. 57 | # See https://keats.github.io/tera/docs/#introduction 58 | footer = """ 59 | 60 | """ 61 | # An array of regex based postprocessors to modify the changelog. 62 | # Replace the placeholder `` with a URL. 63 | postprocessors = [] 64 | 65 | [git] 66 | # Parse commits according to the conventional commits specification. 67 | # See https://www.conventionalcommits.org 68 | conventional_commits = false 69 | # Exclude commits that do not match the conventional commits specification. 70 | filter_unconventional = true 71 | # Split commits on newlines, treating each line as an individual commit. 72 | split_commits = false 73 | # An array of regex based parsers to modify commit messages prior to further processing. 74 | commit_preprocessors = [{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }] 75 | # Exclude commits that are not matched by any commit parser. 76 | commit_parsers = [{ field = "author.name", pattern = "renovate", skip = true }] 77 | filter_commits = false 78 | # Order releases topologically instead of chronologically. 79 | topo_order = false 80 | # Order of commits in each group/release within the changelog. 81 | # Allowed values: newest, oldest 82 | sort_commits = "newest" 83 | -------------------------------------------------------------------------------- /src/form.rs: -------------------------------------------------------------------------------- 1 | use lemmy_api_common::{ 2 | comment::*, community::*, custom_emoji::*, person::*, post::*, private_message::*, site::*, 3 | }; 4 | use serde::Serialize; 5 | use std::fmt; 6 | 7 | use crate::utils::impl_marker_trait; 8 | 9 | pub trait LemmyForm: Serialize + Clone + fmt::Debug {} 10 | 11 | #[derive(Debug, Clone)] 12 | /// A request to send to lemmy. If you don't want to set the JWT for each request, you can set the Authorization header with [`LemmyClient::headers_mut`](lemmy_client::LemmyClient.headers_mut). 13 | pub struct LemmyRequest 14 | where 15 | Body: LemmyForm, 16 | { 17 | /// The body to send with the request. Uses [`unit`] for when a body is not required. 18 | pub body: Body, 19 | /// The JWT that is used when authorization is required. 20 | pub jwt: Option, 21 | } 22 | 23 | impl LemmyRequest<()> { 24 | /// Returns a request with no body or JWT. 25 | pub fn empty() -> Self { 26 | Self { 27 | body: (), 28 | jwt: None, 29 | } 30 | } 31 | 32 | /// Returns a request with no body and JWT if [`Some`]. 33 | pub fn from_jwt(jwt: Option) -> Self { 34 | Self { body: (), jwt } 35 | } 36 | } 37 | 38 | impl
From for LemmyRequest 39 | where 40 | Form: LemmyForm, 41 | { 42 | fn from(body: Form) -> Self { 43 | Self { body, jwt: None } 44 | } 45 | } 46 | 47 | impl_marker_trait!( 48 | LemmyForm, 49 | [ 50 | (), 51 | String, 52 | // Comments 53 | CreateComment, 54 | CreateCommentLike, 55 | CreateCommentReport, 56 | DeleteComment, 57 | DistinguishComment, 58 | EditComment, 59 | GetComment, 60 | GetComments, 61 | ListCommentLikes, 62 | ListCommentReports, 63 | RemoveComment, 64 | ResolveCommentReport, 65 | SaveComment, 66 | // Communities 67 | AddModToCommunity, 68 | BanFromCommunity, 69 | BlockCommunity, 70 | CreateCommunity, 71 | DeleteCommunity, 72 | EditCommunity, 73 | FollowCommunity, 74 | GetCommunity, 75 | HideCommunity, 76 | ListCommunities, 77 | RemoveCommunity, 78 | TransferCommunity, 79 | // Emojis 80 | CreateCustomEmoji, 81 | DeleteCustomEmoji, 82 | EditCustomEmoji, 83 | // Person 84 | AddAdmin, 85 | BanPerson, 86 | BlockPerson, 87 | ChangePassword, 88 | DeleteAccount, 89 | GetPersonDetails, 90 | GetPersonMentions, 91 | GetReplies, 92 | GetReportCount, 93 | Login, 94 | MarkCommentReplyAsRead, 95 | MarkPersonMentionAsRead, 96 | PasswordChangeAfterReset, 97 | PasswordReset, 98 | PersonMentionResponse, 99 | Register, 100 | SaveUserSettings, 101 | UpdateTotp, 102 | VerifyEmail, 103 | // Posts 104 | CreatePost, 105 | CreatePostLike, 106 | CreatePostReport, 107 | DeletePost, 108 | EditPost, 109 | FeaturePost, 110 | GetPost, 111 | GetPosts, 112 | GetSiteMetadata, 113 | ListPostLikes, 114 | ListPostReports, 115 | LockPost, 116 | MarkPostAsRead, 117 | RemovePost, 118 | ResolvePostReport, 119 | SavePost, 120 | HidePost, 121 | // Private Messages 122 | CreatePrivateMessage, 123 | CreatePrivateMessageReport, 124 | DeletePrivateMessage, 125 | EditPrivateMessage, 126 | GetPrivateMessages, 127 | ListPrivateMessageReports, 128 | MarkPrivateMessageAsRead, 129 | ResolvePrivateMessageReport, 130 | // Site 131 | ApproveRegistrationApplication, 132 | GetRegistrationApplication, 133 | BlockInstance, 134 | CreateSite, 135 | EditSite, 136 | FederatedInstances, 137 | GetModlog, 138 | InstanceWithFederationState, 139 | ListRegistrationApplications, 140 | PurgeComment, 141 | PurgeCommunity, 142 | PurgePerson, 143 | PurgePost, 144 | ResolveObject, 145 | Search, 146 | // Media 147 | ListMedia 148 | ] 149 | ); 150 | -------------------------------------------------------------------------------- /src/lemmy_client_internal.rs: -------------------------------------------------------------------------------- 1 | use crate::{ 2 | form::{LemmyForm, LemmyRequest}, 3 | lemmy_client_trait::{private_trait, LemmyClientInternal}, 4 | response::{LemmyResponse, LemmyResult}, 5 | utils::ClientOptions, 6 | }; 7 | use cfg_if::cfg_if; 8 | use http::Method; 9 | use lemmy_api_common::LemmyErrorType; 10 | use std::collections::HashMap; 11 | 12 | trait WithHeaders { 13 | fn with_headers(self, headers: &HashMap) -> Self; 14 | } 15 | 16 | trait MaybeWithJwt { 17 | fn maybe_with_jwt(self, jwt: Option) -> Self; 18 | } 19 | 20 | fn build_route(route: &str, ClientOptions { domain, secure }: &ClientOptions) -> String { 21 | format!( 22 | "http{}://{domain}/api/v3/{route}", 23 | if *secure { "s" } else { "" } 24 | ) 25 | } 26 | 27 | fn map_other_error(e: E) -> LemmyErrorType { 28 | LemmyErrorType::Unknown(e.to_string()) 29 | } 30 | 31 | fn deserialize_response(res: &str) -> Result { 32 | serde_json::from_str::(res) 33 | .map_err(|_| serde_json::from_str::(res).unwrap_or_else(map_other_error)) 34 | } 35 | 36 | cfg_if! { 37 | if #[cfg(target_family = "wasm")] { 38 | use gloo_net::http::{Request, RequestBuilder}; 39 | use web_sys::wasm_bindgen::UnwrapThrowExt; 40 | pub struct Fetch(pub ClientOptions); 41 | 42 | impl Fetch { 43 | pub fn new(options: ClientOptions) -> Self { 44 | Self(options) 45 | } 46 | 47 | fn build_fetch_query(&self, path: &str, form: &T) -> String { 48 | let form_str = serde_urlencoded::to_string(form).unwrap_or_else(|_| path.to_string()); 49 | format!("{}?{}", build_route(path, &self.0), form_str) 50 | } 51 | } 52 | 53 | impl WithHeaders for RequestBuilder { 54 | fn with_headers(self, headers: &HashMap) -> Self { 55 | headers.iter().fold(self, |acc, (header, value)| acc.header(header.as_str(), value.as_str())) 56 | } 57 | } 58 | 59 | impl MaybeWithJwt for RequestBuilder { 60 | fn maybe_with_jwt(self, jwt: Option) -> Self { 61 | if let Some(jwt) = jwt { 62 | self.header(http::header::AUTHORIZATION.as_str(), format!("Bearer {jwt}").as_str()) 63 | } else { 64 | self 65 | } 66 | } 67 | } 68 | 69 | impl private_trait::LemmyClientInternal for Fetch { 70 | async fn make_request( 71 | &self, 72 | method: Method, 73 | path: &str, 74 | request: LemmyRequest, 75 | headers: &HashMap 76 | ) -> LemmyResult 77 | where 78 | Response: LemmyResponse, 79 | Form: LemmyForm, 80 | { 81 | let route = &build_route(path, &self.0); 82 | let LemmyRequest { body, jwt } = request; 83 | 84 | #[allow(unused_mut)] 85 | let mut req = match method { 86 | Method::GET => Request::get(&self.build_fetch_query(path, &body)), 87 | Method::POST => Request::post(route), 88 | Method::PUT => Request::put(route), 89 | method => unreachable!("This crate only uses GET, POST, and PUT HTTP methods. Got {method:?}") 90 | }.with_headers(headers) 91 | .maybe_with_jwt(jwt); 92 | 93 | let res = match method { 94 | Method::GET => req.build().expect_throw("Could not parse query params"), 95 | Method::POST | Method::PUT => req.json(&body).expect_throw("Could not parse JSON body"), 96 | method => unreachable!("This crate only uses GET, POST, and PUT HTTP methods. Got {method:?}") 97 | }.send() 98 | .await 99 | .map_err(map_other_error)? 100 | .text() 101 | .await 102 | .map_err(map_other_error)?; 103 | 104 | deserialize_response(&res) 105 | } 106 | } 107 | 108 | impl LemmyClientInternal for Fetch {} 109 | } else { 110 | impl WithHeaders for reqwest::RequestBuilder { 111 | fn with_headers(self, headers: &HashMap) -> Self { 112 | let mut client = headers.iter().fold(self, |acc, (header, value)| acc.header(header, value)); 113 | 114 | if !headers.keys().any(|key| key.eq_ignore_ascii_case("user-agent")) { 115 | client = client.header("user-agent", "Lemmy-Client-rs/0.19.4-alpha.1"); 116 | } 117 | 118 | client 119 | } 120 | } 121 | 122 | impl MaybeWithJwt for reqwest::RequestBuilder { 123 | fn maybe_with_jwt(self, jwt: Option) -> Self { 124 | if let Some(jwt) = jwt { 125 | self.bearer_auth(jwt) 126 | } else { 127 | self 128 | } 129 | } 130 | } 131 | 132 | pub struct ClientWrapper { 133 | client: reqwest::Client, 134 | pub options: ClientOptions 135 | } 136 | 137 | impl ClientWrapper { 138 | pub fn new(options: ClientOptions) -> Self { 139 | Self { 140 | client: reqwest::Client::new(), 141 | options 142 | } 143 | } 144 | } 145 | 146 | impl private_trait::LemmyClientInternal for ClientWrapper { 147 | async fn make_request( 148 | &self, 149 | method: Method, 150 | path: &str, 151 | request: LemmyRequest, 152 | headers: &HashMap 153 | ) -> LemmyResult 154 | where 155 | Response: LemmyResponse, 156 | Form: LemmyForm, 157 | { 158 | let route = build_route(path, &self.options); 159 | let LemmyRequest { body, jwt } = request; 160 | 161 | let res = match method { 162 | Method::GET => 163 | self 164 | .client 165 | .get(route) 166 | .with_headers(headers) 167 | .maybe_with_jwt(jwt) 168 | .query(&body), 169 | Method::POST => 170 | self 171 | .client 172 | .post(route) 173 | .with_headers(headers) 174 | .maybe_with_jwt(jwt) 175 | .json(&body), 176 | Method::PUT => 177 | self 178 | .client 179 | .put(route) 180 | .with_headers(headers) 181 | .maybe_with_jwt(jwt) 182 | .json(&body), 183 | _ => unreachable!("This crate does not use other HTTP methods.") 184 | }.send() 185 | .await 186 | .map_err(map_other_error)? 187 | .text() 188 | .await 189 | .map_err(map_other_error)?; 190 | 191 | deserialize_response(&res) 192 | } 193 | } 194 | 195 | impl LemmyClientInternal for ClientWrapper {} 196 | } 197 | } 198 | -------------------------------------------------------------------------------- /src/lemmy_client_trait.rs: -------------------------------------------------------------------------------- 1 | use crate::{ 2 | form::{LemmyForm, LemmyRequest}, 3 | response::{LemmyResponse, LemmyResult}, 4 | }; 5 | use http::Method; 6 | use lemmy_api_common::{ 7 | comment::*, community::*, custom_emoji::*, lemmy_db_schema::source::login_token::LoginToken, 8 | person::*, post::*, private_message::*, site::*, SuccessResponse, 9 | }; 10 | use std::collections::HashMap; 11 | 12 | pub mod private_trait { 13 | use super::{HashMap, LemmyForm, LemmyRequest, LemmyResponse, LemmyResult, Method}; 14 | 15 | pub trait LemmyClientInternal { 16 | async fn make_request( 17 | &self, 18 | method: Method, 19 | path: &str, 20 | request: LemmyRequest, 21 | headers: &HashMap, 22 | ) -> LemmyResult 23 | where 24 | Response: LemmyResponse, 25 | Form: LemmyForm; 26 | } 27 | } 28 | 29 | macro_rules! client_fn { 30 | ($name:ident, $method:expr, $path:expr, $form:ty, $response:ty) => { 31 | async fn $name( 32 | &self, 33 | request: LemmyRequest<$form>, 34 | headers: &HashMap, 35 | ) -> LemmyResult<$response> { 36 | self.make_request($method, $path, request, headers).await 37 | } 38 | }; 39 | } 40 | 41 | pub trait LemmyClientInternal: private_trait::LemmyClientInternal { 42 | client_fn!(get_site, Method::GET, "site", (), GetSiteResponse); 43 | client_fn!(create_site, Method::POST, "site", CreateSite, SiteResponse); 44 | client_fn!(edit_site, Method::PUT, "site", EditSite, SiteResponse); 45 | client_fn!( 46 | block_instance, 47 | Method::POST, 48 | "site/block", 49 | BlockInstance, 50 | BlockInstanceResponse 51 | ); 52 | client_fn!( 53 | get_modlog, 54 | Method::GET, 55 | "modlog", 56 | GetModlog, 57 | GetModlogResponse 58 | ); 59 | client_fn!(search, Method::GET, "search", Search, SearchResponse); 60 | client_fn!( 61 | resolve_object, 62 | Method::GET, 63 | "resolve_object", 64 | ResolveObject, 65 | ResolveObjectResponse 66 | ); 67 | client_fn!( 68 | get_community, 69 | Method::GET, 70 | "community", 71 | GetCommunity, 72 | GetCommunityResponse 73 | ); 74 | client_fn!( 75 | create_community, 76 | Method::POST, 77 | "community", 78 | CreateCommunity, 79 | CommunityResponse 80 | ); 81 | client_fn!( 82 | edit_community, 83 | Method::PUT, 84 | "community", 85 | EditCommunity, 86 | CommunityResponse 87 | ); 88 | client_fn!( 89 | hide_community, 90 | Method::PUT, 91 | "community/hide", 92 | HideCommunity, 93 | SuccessResponse 94 | ); 95 | client_fn!( 96 | list_communities, 97 | Method::GET, 98 | "community/list", 99 | ListCommunities, 100 | ListCommunitiesResponse 101 | ); 102 | client_fn!( 103 | follow_community, 104 | Method::POST, 105 | "community/follow", 106 | FollowCommunity, 107 | CommunityResponse 108 | ); 109 | client_fn!( 110 | block_community, 111 | Method::POST, 112 | "community/block", 113 | BlockCommunity, 114 | BlockCommunityResponse 115 | ); 116 | client_fn!( 117 | delete_community, 118 | Method::POST, 119 | "community/delete", 120 | DeleteCommunity, 121 | CommunityResponse 122 | ); 123 | client_fn!( 124 | remove_community, 125 | Method::POST, 126 | "community/remove", 127 | RemoveCommunity, 128 | CommunityResponse 129 | ); 130 | client_fn!( 131 | transfer_community, 132 | Method::POST, 133 | "community/transfer", 134 | TransferCommunity, 135 | GetCommunityResponse 136 | ); 137 | client_fn!( 138 | ban_from_community, 139 | Method::POST, 140 | "community/ban_user", 141 | BanFromCommunity, 142 | BanFromCommunityResponse 143 | ); 144 | client_fn!( 145 | add_mod_to_community, 146 | Method::POST, 147 | "community/mod", 148 | AddModToCommunity, 149 | AddModToCommunityResponse 150 | ); 151 | client_fn!( 152 | get_federated_instances, 153 | Method::GET, 154 | "federated_instances", 155 | FederatedInstances, 156 | GetFederatedInstancesResponse 157 | ); 158 | client_fn!(get_post, Method::GET, "post", GetPost, GetPostResponse); 159 | client_fn!(create_post, Method::POST, "post", CreatePost, PostResponse); 160 | client_fn!(edit_post, Method::PUT, "post", EditPost, PostResponse); 161 | client_fn!( 162 | delete_post, 163 | Method::POST, 164 | "post/delete", 165 | DeletePost, 166 | PostResponse 167 | ); 168 | client_fn!( 169 | remove_post, 170 | Method::POST, 171 | "post/remove", 172 | RemovePost, 173 | PostResponse 174 | ); 175 | client_fn!( 176 | mark_post_as_read, 177 | Method::POST, 178 | "post/mark_as_read", 179 | MarkPostAsRead, 180 | SuccessResponse 181 | ); 182 | client_fn!(lock_post, Method::POST, "post/lock", LockPost, PostResponse); 183 | client_fn!( 184 | feature_post, 185 | Method::POST, 186 | "post/feature", 187 | FeaturePost, 188 | PostResponse 189 | ); 190 | client_fn!( 191 | list_posts, 192 | Method::GET, 193 | "post/list", 194 | GetPosts, 195 | GetPostsResponse 196 | ); 197 | client_fn!( 198 | like_post, 199 | Method::POST, 200 | "post/like", 201 | CreatePostLike, 202 | PostResponse 203 | ); 204 | client_fn!( 205 | list_post_likes, 206 | Method::GET, 207 | "post/like/list", 208 | ListPostLikes, 209 | ListPostLikesResponse 210 | ); 211 | client_fn!(save_post, Method::PUT, "post/save", SavePost, PostResponse); 212 | client_fn!( 213 | report_post, 214 | Method::POST, 215 | "post/report", 216 | CreatePostReport, 217 | PostReportResponse 218 | ); 219 | client_fn!( 220 | resolve_post_report, 221 | Method::PUT, 222 | "post/report/resolve", 223 | ResolvePostReport, 224 | PostReportResponse 225 | ); 226 | client_fn!( 227 | list_post_reports, 228 | Method::GET, 229 | "post/report/list", 230 | ListPostReports, 231 | ListPostReportsResponse 232 | ); 233 | client_fn!( 234 | get_post_url_metadata, 235 | Method::GET, 236 | "post/site_metadata", 237 | GetSiteMetadata, 238 | GetSiteMetadataResponse 239 | ); 240 | client_fn!( 241 | hide_post, 242 | Method::POST, 243 | "post/hide", 244 | HidePost, 245 | SuccessResponse 246 | ); 247 | client_fn!( 248 | get_comment, 249 | Method::GET, 250 | "comment", 251 | GetComment, 252 | CommentResponse 253 | ); 254 | client_fn!( 255 | create_comment, 256 | Method::POST, 257 | "comment", 258 | CreateComment, 259 | CommentResponse 260 | ); 261 | client_fn!( 262 | edit_comment, 263 | Method::PUT, 264 | "comment", 265 | EditComment, 266 | CommentResponse 267 | ); 268 | client_fn!( 269 | delete_comment, 270 | Method::POST, 271 | "comment/delete", 272 | DeleteComment, 273 | CommentResponse 274 | ); 275 | client_fn!( 276 | remove_comment, 277 | Method::POST, 278 | "comment/remove", 279 | RemoveComment, 280 | CommentResponse 281 | ); 282 | client_fn!( 283 | mark_reply_as_read, 284 | Method::POST, 285 | "comment/mark_as_read", 286 | MarkCommentReplyAsRead, 287 | CommentReplyResponse 288 | ); 289 | client_fn!( 290 | distinguish_comment, 291 | Method::POST, 292 | "comment/distinguish", 293 | DistinguishComment, 294 | CommentResponse 295 | ); 296 | client_fn!( 297 | like_comment, 298 | Method::POST, 299 | "comment/like", 300 | CreateCommentLike, 301 | CommentResponse 302 | ); 303 | client_fn!( 304 | list_comment_likes, 305 | Method::GET, 306 | "comment/like/list", 307 | ListCommentLikes, 308 | ListCommentLikesResponse 309 | ); 310 | client_fn!( 311 | save_comment, 312 | Method::PUT, 313 | "comment/save", 314 | SaveComment, 315 | CommentResponse 316 | ); 317 | client_fn!( 318 | list_comments, 319 | Method::GET, 320 | "comment/list", 321 | GetComments, 322 | GetCommentsResponse 323 | ); 324 | client_fn!( 325 | create_comment_report, 326 | Method::POST, 327 | "comment/report", 328 | CreateCommentReport, 329 | CommentResponse 330 | ); 331 | client_fn!( 332 | resolve_comment_report, 333 | Method::PUT, 334 | "comment/report/resolve", 335 | ResolveCommentReport, 336 | CommentReportResponse 337 | ); 338 | client_fn!( 339 | list_comment_reports, 340 | Method::GET, 341 | "comment/report/list", 342 | ListCommentReports, 343 | ListCommentReportsResponse 344 | ); 345 | client_fn!( 346 | create_private_message, 347 | Method::POST, 348 | "private_message", 349 | CreatePrivateMessage, 350 | PrivateMessageResponse 351 | ); 352 | client_fn!( 353 | edit_private_message, 354 | Method::PUT, 355 | "private_message", 356 | EditPrivateMessage, 357 | PrivateMessageResponse 358 | ); 359 | client_fn!( 360 | list_private_messages, 361 | Method::GET, 362 | "private_message/list", 363 | GetPrivateMessages, 364 | PrivateMessagesResponse 365 | ); 366 | client_fn!( 367 | delete_private_message, 368 | Method::POST, 369 | "private_message/delete", 370 | DeletePrivateMessage, 371 | PrivateMessageResponse 372 | ); 373 | client_fn!( 374 | mark_private_message_as_read, 375 | Method::POST, 376 | "private_message/mark_as_read", 377 | MarkPrivateMessageAsRead, 378 | PrivateMessageResponse 379 | ); 380 | client_fn!( 381 | create_private_message_report, 382 | Method::POST, 383 | "private_message/report", 384 | CreatePrivateMessageReport, 385 | PrivateMessageReportResponse 386 | ); 387 | client_fn!( 388 | resolve_private_message_report, 389 | Method::PUT, 390 | "private_message/report/resolve", 391 | ResolvePrivateMessageReport, 392 | PrivateMessageReportResponse 393 | ); 394 | client_fn!( 395 | list_private_message_reports, 396 | Method::GET, 397 | "private_message/report/list", 398 | ListPrivateMessageReports, 399 | ListPrivateMessageReportsResponse 400 | ); 401 | client_fn!( 402 | get_person, 403 | Method::GET, 404 | "user", 405 | GetPersonDetails, 406 | GetPersonDetailsResponse 407 | ); 408 | client_fn!( 409 | register_account, 410 | Method::POST, 411 | "user/register", 412 | Register, 413 | RegistrationApplicationResponse 414 | ); 415 | client_fn!( 416 | get_captcha, 417 | Method::GET, 418 | "user/get_captcha", 419 | (), 420 | GetCaptchaResponse 421 | ); 422 | client_fn!( 423 | export_settings, 424 | Method::GET, 425 | "user/export_settings", 426 | (), 427 | String 428 | ); 429 | client_fn!( 430 | import_settings, 431 | Method::POST, 432 | "user/import_settings", 433 | String, 434 | SuccessResponse 435 | ); 436 | client_fn!( 437 | list_mentions, 438 | Method::GET, 439 | "user/mention", 440 | GetPersonMentions, 441 | GetPersonMentionsResponse 442 | ); 443 | client_fn!( 444 | mark_mention_as_read, 445 | Method::POST, 446 | "user/mention/mark_as_read", 447 | MarkPersonMentionAsRead, 448 | PersonMentionResponse 449 | ); 450 | client_fn!( 451 | list_replies, 452 | Method::GET, 453 | "user/replies", 454 | GetReplies, 455 | GetRepliesResponse 456 | ); 457 | client_fn!( 458 | ban_from_site, 459 | Method::POST, 460 | "user/ban", 461 | BanPerson, 462 | BanPersonResponse 463 | ); 464 | client_fn!( 465 | list_banned_users, 466 | Method::GET, 467 | "user/banned", 468 | (), 469 | BannedPersonsResponse 470 | ); 471 | client_fn!( 472 | block_person, 473 | Method::POST, 474 | "user/block", 475 | BlockPerson, 476 | BlockPersonResponse 477 | ); 478 | client_fn!(login, Method::POST, "user/login", Login, LoginResponse); 479 | client_fn!(logout, Method::POST, "user/logout", (), SuccessResponse); 480 | client_fn!( 481 | delete_account, 482 | Method::POST, 483 | "user/delete_account", 484 | DeleteAccount, 485 | SuccessResponse 486 | ); 487 | client_fn!( 488 | reset_password, 489 | Method::POST, 490 | "user/password_reset", 491 | PasswordReset, 492 | SuccessResponse 493 | ); 494 | client_fn!( 495 | change_password_after_reset, 496 | Method::POST, 497 | "user/password_change", 498 | PasswordChangeAfterReset, 499 | SuccessResponse 500 | ); 501 | client_fn!( 502 | mark_all_notifications_as_read, 503 | Method::POST, 504 | "user/mark_all_as_read", 505 | (), 506 | GetRepliesResponse 507 | ); 508 | client_fn!( 509 | save_user_settings, 510 | Method::PUT, 511 | "user/save_user_settings", 512 | SaveUserSettings, 513 | SuccessResponse 514 | ); 515 | client_fn!( 516 | change_password, 517 | Method::PUT, 518 | "user/change_password", 519 | ChangePassword, 520 | LoginResponse 521 | ); 522 | client_fn!( 523 | report_count, 524 | Method::GET, 525 | "user/report_count", 526 | GetReportCount, 527 | GetReportCountResponse 528 | ); 529 | client_fn!( 530 | unread_count, 531 | Method::GET, 532 | "user/unread_count", 533 | (), 534 | GetUnreadCountResponse 535 | ); 536 | client_fn!( 537 | verify_email, 538 | Method::POST, 539 | "user/verify_email", 540 | VerifyEmail, 541 | SuccessResponse 542 | ); 543 | client_fn!( 544 | leave_admin, 545 | Method::POST, 546 | "user/verify_email", 547 | (), 548 | GetSiteResponse 549 | ); 550 | client_fn!( 551 | generate_totp_secret, 552 | Method::POST, 553 | "user/totp/generate", 554 | (), 555 | GenerateTotpSecretResponse 556 | ); 557 | client_fn!( 558 | update_totp, 559 | Method::POST, 560 | "user/totp/update", 561 | UpdateTotp, 562 | UpdateTotpResponse 563 | ); 564 | client_fn!( 565 | list_logins, 566 | Method::GET, 567 | "user/list_logins", 568 | (), 569 | Vec 570 | ); 571 | client_fn!( 572 | validate_auth, 573 | Method::GET, 574 | "user/validate_auth", 575 | (), 576 | SuccessResponse 577 | ); 578 | client_fn!( 579 | add_admin, 580 | Method::POST, 581 | "admin/add", 582 | AddAdmin, 583 | AddAdminResponse 584 | ); 585 | client_fn!( 586 | unread_registration_application_count, 587 | Method::GET, 588 | "admin/registration_application/count", 589 | (), 590 | GetUnreadRegistrationApplicationCountResponse 591 | ); 592 | client_fn!( 593 | get_registration_aplication, 594 | Method::GET, 595 | "admin/registration_application", 596 | GetRegistrationApplication, 597 | RegistrationApplicationResponse 598 | ); 599 | client_fn!( 600 | list_registration_applications, 601 | Method::GET, 602 | "admin/registration_application/list", 603 | ListRegistrationApplications, 604 | ListRegistrationApplicationsResponse 605 | ); 606 | client_fn!( 607 | approve_registration_application, 608 | Method::PUT, 609 | "admin/registration_application/approve", 610 | ApproveRegistrationApplication, 611 | RegistrationApplicationResponse 612 | ); 613 | client_fn!( 614 | purge_person, 615 | Method::POST, 616 | "admin/purge/person", 617 | PurgePerson, 618 | SuccessResponse 619 | ); 620 | client_fn!( 621 | purge_community, 622 | Method::POST, 623 | "admin/purge/community", 624 | PurgeCommunity, 625 | SuccessResponse 626 | ); 627 | client_fn!( 628 | purge_post, 629 | Method::POST, 630 | "admin/purge/post", 631 | PurgePost, 632 | SuccessResponse 633 | ); 634 | client_fn!( 635 | purge_comment, 636 | Method::POST, 637 | "admin/purge/comment", 638 | PurgeComment, 639 | SuccessResponse 640 | ); 641 | client_fn!( 642 | create_custom_emoji, 643 | Method::POST, 644 | "custom_emoji", 645 | CreateCustomEmoji, 646 | CustomEmojiResponse 647 | ); 648 | client_fn!( 649 | edit_custom_emoji, 650 | Method::PUT, 651 | "custom_emoji", 652 | EditCustomEmoji, 653 | CustomEmojiResponse 654 | ); 655 | client_fn!( 656 | delete_custom_emoji, 657 | Method::POST, 658 | "custom_emoji/delete", 659 | DeleteCustomEmoji, 660 | CustomEmojiResponse 661 | ); 662 | client_fn!( 663 | list_media, 664 | Method::GET, 665 | "account/list_media", 666 | ListMedia, 667 | ListMediaResponse 668 | ); 669 | client_fn!( 670 | list_all_media, 671 | Method::GET, 672 | "admin/list_all_media", 673 | ListMedia, 674 | ListMediaResponse 675 | ); 676 | } 677 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![warn(missing_docs)] 2 | #![doc( 3 | html_favicon_url = "https://raw.githubusercontent.com/LemmyNet/lemmy-ui/main/src/assets/icons/favicon.svg" 4 | )] 5 | #![doc( 6 | html_logo_url = "https://raw.githubusercontent.com/LemmyNet/lemmy-ui/main/src/assets/icons/favicon.svg" 7 | )] 8 | //! A Rust HTTP client for Lemmy. 9 | //! If used when targeting WASM, uses the browser's built-in fetch API to reduce bundle size. 10 | //! ## Example 11 | //! ``` 12 | //! use lemmy_client::{LemmyClient, ClientOptions}; 13 | //! 14 | //! async fn get_site_test() { 15 | //! let client = LemmyClient::new(ClientOptions { 16 | //! domain: String::from("lemmy.ml"), 17 | //! secure: true 18 | //! }); 19 | //! 20 | //! let res = client.get_site(()).await; 21 | //! 22 | //! assert!(res.is_ok()); 23 | //! } 24 | //! 25 | //! ``` 26 | //! //! ## IMPORTANT NOTICE 27 | //! This crate now uses a different versioning scheme than before so as not to be too tied down to Lemmy releases. For Lemmy versions 0.19.4 and up, use versions 1.x.x. For Lemmy versions 0.19.3 and under, use versions 0.19.5 and up. This is confusing, but should become a non issue as Lemmy accumulates versions and fewer servers use Lemmy versions use 0.19.3 and lower. 28 | 29 | use std::collections::HashMap; 30 | 31 | use crate::{lemmy_client_trait::LemmyClientInternal, response::LemmyResult}; 32 | use cfg_if::cfg_if; 33 | use lemmy_api_common::{ 34 | comment::*, community::*, custom_emoji::*, lemmy_db_schema::source::login_token::LoginToken, 35 | person::*, post::*, private_message::*, site::*, SuccessResponse, 36 | }; 37 | #[cfg(not(target_family = "wasm"))] 38 | use lemmy_client_internal::ClientWrapper; 39 | #[cfg(target_family = "wasm")] 40 | use lemmy_client_internal::Fetch; 41 | 42 | mod form; 43 | mod lemmy_client_internal; 44 | mod lemmy_client_trait; 45 | mod response; 46 | mod utils; 47 | 48 | pub use form::LemmyRequest; 49 | pub use lemmy_api_common; 50 | pub use utils::ClientOptions; 51 | 52 | /// API wrapper for lemmy 53 | pub struct LemmyClient { 54 | headers: HashMap, 55 | #[cfg(target_family = "wasm")] 56 | client: Fetch, 57 | #[cfg(not(target_family = "wasm"))] 58 | client: ClientWrapper, 59 | } 60 | 61 | impl LemmyClient { 62 | /// Get the options the client is using. 63 | pub fn options(&self) -> &ClientOptions { 64 | cfg_if! { 65 | if #[cfg(target_family = "wasm")] { 66 | &self.client.0 67 | } else { 68 | &self.client.options 69 | } 70 | } 71 | } 72 | } 73 | 74 | macro_rules! expose_wrapped_fn { 75 | ($name:ident, $form:ty, $response:ty, $doc:expr) => { 76 | #[doc = $doc] 77 | pub async fn $name(&self, request: Request) -> LemmyResult<$response> 78 | where 79 | Request: Into>, 80 | { 81 | self.client.$name(request.into(), &self.headers).await 82 | } 83 | }; 84 | } 85 | 86 | impl LemmyClient { 87 | /// Creates a new `LemmyClient`. 88 | /// # Examples 89 | /// ``` 90 | /// use lemmy_client::{LemmyClient, ClientOptions}; 91 | /// let client = LemmyClient::new(ClientOptions { 92 | /// domain: String::from("lemmy.ml"), 93 | /// secure: true 94 | /// }); 95 | /// ``` 96 | pub fn new(options: ClientOptions) -> Self { 97 | cfg_if! { 98 | if #[cfg(target_family = "wasm")] { 99 | Self { 100 | client: Fetch::new(options), 101 | headers: HashMap::new() 102 | } 103 | } else { 104 | Self { 105 | client: ClientWrapper::new(options), 106 | headers: HashMap::new() 107 | } 108 | } 109 | } 110 | } 111 | 112 | /// Map of headers that will be included with each request. 113 | pub fn headers(&self) -> &HashMap { 114 | &self.headers 115 | } 116 | 117 | /// Mutable map of headers that will be included with each request. Use this method if you want to add headers other than the JWT. 118 | pub fn headers_mut(&mut self) -> &mut HashMap { 119 | &mut self.headers 120 | } 121 | 122 | expose_wrapped_fn!( 123 | get_site, 124 | (), 125 | GetSiteResponse, 126 | r#"Gets the site and, if you pass an authorized JWT, information about the logged in user. 127 | 128 | HTTP GET /site"# 129 | ); 130 | expose_wrapped_fn!( 131 | create_site, 132 | CreateSite, 133 | SiteResponse, 134 | r#"Creates site during initial setup. 135 | 136 | HTTP POST /site"# 137 | ); 138 | expose_wrapped_fn!( 139 | edit_site, 140 | EditSite, 141 | SiteResponse, 142 | r#"Edits your site. 143 | 144 | HTTP PUT /site"# 145 | ); 146 | expose_wrapped_fn!( 147 | block_instance, 148 | BlockInstance, 149 | BlockInstanceResponse, 150 | r#"Blocks an instance. 151 | 152 | HTTP POST /site/block"# 153 | ); 154 | expose_wrapped_fn!( 155 | get_modlog, 156 | GetModlog, 157 | GetModlogResponse, 158 | r#"Gets the modlog. 159 | 160 | HTTP GET /modlog"# 161 | ); 162 | expose_wrapped_fn!( 163 | search, 164 | Search, 165 | SearchResponse, 166 | r#"Searches for content. 167 | 168 | HTTP GET /search"# 169 | ); 170 | expose_wrapped_fn!( 171 | resolve_object, 172 | ResolveObject, 173 | ResolveObjectResponse, 174 | r#"Fetches an object from a non-local instance. 175 | 176 | HTTP GET /resolve_object"# 177 | ); 178 | expose_wrapped_fn!( 179 | get_community, 180 | GetCommunity, 181 | GetCommunityResponse, 182 | r#"Gets a community. 183 | 184 | HTTP GET /community"# 185 | ); 186 | expose_wrapped_fn!( 187 | create_community, 188 | CreateCommunity, 189 | CommunityResponse, 190 | r#"Creates a new community. 191 | 192 | HTTP POST /community"# 193 | ); 194 | expose_wrapped_fn!( 195 | edit_community, 196 | EditCommunity, 197 | CommunityResponse, 198 | r#"Edits a community. 199 | 200 | HTTP PUT /community"# 201 | ); 202 | expose_wrapped_fn!( 203 | hide_community, 204 | HideCommunity, 205 | SuccessResponse, 206 | r#"Hides a community from public view. 207 | 208 | HTTP PUT /community_hide"# 209 | ); 210 | expose_wrapped_fn!( 211 | list_communities, 212 | ListCommunities, 213 | ListCommunitiesResponse, 214 | r#"Lists communities. 215 | 216 | HTTP GET /community/list"# 217 | ); 218 | expose_wrapped_fn!( 219 | follow_community, 220 | FollowCommunity, 221 | CommunityResponse, 222 | r#"Subscribes to a community. 223 | 224 | HTTP POST /community/follow"# 225 | ); 226 | expose_wrapped_fn!( 227 | block_community, 228 | BlockCommunity, 229 | BlockCommunityResponse, 230 | r#"Blocks a community. 231 | 232 | HTTP POST /community/block"# 233 | ); 234 | expose_wrapped_fn!( 235 | delete_community, 236 | DeleteCommunity, 237 | CommunityResponse, 238 | r#"Deletes a community. 239 | 240 | HTTP POST /community/delete"# 241 | ); 242 | expose_wrapped_fn!( 243 | remove_community, 244 | RemoveCommunity, 245 | CommunityResponse, 246 | r#"Removes a community (moderation action). 247 | 248 | HTTP POST /community/remove"# 249 | ); 250 | expose_wrapped_fn!( 251 | transfer_community, 252 | TransferCommunity, 253 | GetCommunityResponse, 254 | r#"Transfers a community you own to another user on that community's moderation team. 255 | 256 | HTTP POST community/transfer"# 257 | ); 258 | expose_wrapped_fn!( 259 | ban_from_community, 260 | BanFromCommunity, 261 | BanFromCommunityResponse, 262 | r#"Bans a user from a community. 263 | 264 | HTTP POST /community/ban_user"# 265 | ); 266 | expose_wrapped_fn!( 267 | add_mod_to_community, 268 | AddModToCommunity, 269 | AddModToCommunityResponse, 270 | r#"Adds a moderator to your community. 271 | 272 | HTTP POST /community/mod"# 273 | ); 274 | expose_wrapped_fn!( 275 | get_federated_instances, 276 | FederatedInstances, 277 | GetFederatedInstancesResponse, 278 | r#"Gets the instances that are federated with your instance. 279 | 280 | HTTP GET /federated_instances"# 281 | ); 282 | expose_wrapped_fn!( 283 | get_post, 284 | GetPost, 285 | GetPostResponse, 286 | r#"Gets post. 287 | 288 | HTTP GET /post"# 289 | ); 290 | expose_wrapped_fn!( 291 | create_post, 292 | CreatePost, 293 | PostResponse, 294 | r#"Creates a post. 295 | 296 | HTTP POST /post"# 297 | ); 298 | expose_wrapped_fn!( 299 | edit_post, 300 | EditPost, 301 | PostResponse, 302 | r#"Edits a post you have already created. 303 | 304 | HTTP PUT /post"# 305 | ); 306 | expose_wrapped_fn!( 307 | delete_post, 308 | DeletePost, 309 | PostResponse, 310 | r#"Deletes a post you have made. 311 | 312 | HTTP POST /post/delete"# 313 | ); 314 | expose_wrapped_fn!( 315 | remove_post, 316 | RemovePost, 317 | PostResponse, 318 | r#"Removes a post (moderator action). 319 | 320 | HTTP POST /post/remove"# 321 | ); 322 | expose_wrapped_fn!( 323 | mark_post_as_read, 324 | MarkPostAsRead, 325 | SuccessResponse, 326 | r#"Marks a post as read. 327 | 328 | HTTP POST /post/mark_as_read"# 329 | ); 330 | expose_wrapped_fn!( 331 | lock_post, 332 | LockPost, 333 | PostResponse, 334 | r#"Prevents users from commenting on the post (moderator action). 335 | 336 | HTTP POST /post/lock"# 337 | ); 338 | expose_wrapped_fn!( 339 | feature_post, 340 | FeaturePost, 341 | PostResponse, 342 | r#"Pins a post to the top of the community page (moderator action). 343 | 344 | HTTP POST /post/feature"# 345 | ); 346 | expose_wrapped_fn!( 347 | list_posts, 348 | GetPosts, 349 | GetPostsResponse, 350 | r#"Gets posts with a variety of filters. 351 | 352 | HTTP GET /post/list"# 353 | ); 354 | expose_wrapped_fn!( 355 | like_post, 356 | CreatePostLike, 357 | PostResponse, 358 | r#"Votes on a post. 359 | 360 | HTTP POST /post/like"# 361 | ); 362 | expose_wrapped_fn!( 363 | list_post_likes, 364 | ListPostLikes, 365 | ListPostLikesResponse, 366 | r#"Lists the likes for a post. 367 | 368 | HTTP GET /post/like/list"# 369 | ); 370 | expose_wrapped_fn!( 371 | save_post, 372 | SavePost, 373 | PostResponse, 374 | r#"Saves a post to your favorites list. 375 | 376 | HTTP PUT /post/save"# 377 | ); 378 | expose_wrapped_fn!( 379 | report_post, 380 | CreatePostReport, 381 | PostReportResponse, 382 | r#"Reports a post to the moderator team of the community the post is in, the admin team of your instance, and the admin team of the poster's instance. 383 | 384 | HTTP POST /post/report"# 385 | ); 386 | expose_wrapped_fn!( 387 | resolve_post_report, 388 | ResolvePostReport, 389 | PostReportResponse, 390 | r#"Resolves a post report (moderator action). 391 | 392 | HTTP PUT /post/report/resolve"# 393 | ); 394 | expose_wrapped_fn!( 395 | list_post_reports, 396 | ListPostReports, 397 | ListPostReportsResponse, 398 | r#"Gets reports of posts that you are able to moderate. 399 | 400 | HTTP GET /post/report/list"# 401 | ); 402 | expose_wrapped_fn!( 403 | get_post_url_metadata, 404 | GetSiteMetadata, 405 | GetSiteMetadataResponse, 406 | r#"Gets the metadata of a given site. 407 | 408 | HTTP POST /post/site_metadata"# 409 | ); 410 | expose_wrapped_fn!( 411 | hide_post, 412 | HidePost, 413 | SuccessResponse, 414 | r#"Hide a post from list views. 415 | 416 | HTTP POST /post/hide"# 417 | ); 418 | expose_wrapped_fn!( 419 | get_comment, 420 | GetComment, 421 | CommentResponse, 422 | r#"Gets a comment. 423 | 424 | HTTP GET /comment"# 425 | ); 426 | expose_wrapped_fn!( 427 | create_comment, 428 | CreateComment, 429 | CommentResponse, 430 | r#"Creates a new comment. 431 | 432 | HTTP POST /comment"# 433 | ); 434 | expose_wrapped_fn!( 435 | edit_comment, 436 | EditComment, 437 | CommentResponse, 438 | r#"Edits one of your already-created comments. 439 | 440 | HTTP PUT /comment"# 441 | ); 442 | expose_wrapped_fn!( 443 | delete_comment, 444 | DeleteComment, 445 | CommentResponse, 446 | r#"Deletes one of your already-existing comments. 447 | 448 | HTTP POST /comment/delete"# 449 | ); 450 | expose_wrapped_fn!( 451 | remove_comment, 452 | RemoveComment, 453 | CommentResponse, 454 | r#"Removes a post (moderator action). 455 | 456 | HTTP POST /comment/remove"# 457 | ); 458 | expose_wrapped_fn!( 459 | mark_reply_as_read, 460 | MarkCommentReplyAsRead, 461 | CommentReplyResponse, 462 | r#"Marks a reply to one of your posts or comments as read. 463 | 464 | HTTP POST /comment/mark_as_read"# 465 | ); 466 | expose_wrapped_fn!( 467 | distinguish_comment, 468 | DistinguishComment, 469 | CommentResponse, 470 | r#"Pins a comment to the top of a post's comment section (speak as moderator). 471 | 472 | HTTP POST /comment/distinguish"# 473 | ); 474 | expose_wrapped_fn!( 475 | like_comment, 476 | CreateCommentLike, 477 | CommentResponse, 478 | r#"Votes on a comment. 479 | 480 | HTTP POST /comment/like"# 481 | ); 482 | expose_wrapped_fn!( 483 | list_comment_likes, 484 | ListCommentLikes, 485 | ListCommentLikesResponse, 486 | r#"Gets the votes for a comment. 487 | 488 | HTTP GET /comment/like/list"# 489 | ); 490 | expose_wrapped_fn!( 491 | save_comment, 492 | SaveComment, 493 | CommentResponse, 494 | r#"Saves a comment to your favorites list. 495 | 496 | HTTP PUT /comment/save"# 497 | ); 498 | expose_wrapped_fn!( 499 | list_comments, 500 | GetComments, 501 | GetCommentsResponse, 502 | r#"Gets comments with various filters. 503 | 504 | HTTP GET /comment/list"# 505 | ); 506 | expose_wrapped_fn!( 507 | create_comment_report, 508 | CreateCommentReport, 509 | CommentResponse, 510 | r#"Reports a comment to the moderator team of the community the comment is in, your instance's admin team, and the commentor's instance's admin team. 511 | 512 | HTTP POST /comment/report"# 513 | ); 514 | expose_wrapped_fn!( 515 | resolve_comment_report, 516 | ResolveCommentReport, 517 | CommentReportResponse, 518 | r#"Resolves a report on a comment made in a community you moderate or instance you administrate. 519 | 520 | HTTP PUT /comment/report/resolve"# 521 | ); 522 | expose_wrapped_fn!( 523 | list_comment_reports, 524 | ListCommentReports, 525 | ListCommentReportsResponse, 526 | r#"Lists reports for comments in communities you moderate or instances you administrate. 527 | 528 | HTTP GET /comment/report/list"# 529 | ); 530 | expose_wrapped_fn!( 531 | create_private_message, 532 | CreatePrivateMessage, 533 | PrivateMessageResponse, 534 | r#"Creates and send a private message to another user. 535 | 536 | HTTP POST /private_message"# 537 | ); 538 | expose_wrapped_fn!( 539 | edit_private_message, 540 | EditPrivateMessage, 541 | PrivateMessageResponse, 542 | r#"Edits a private message you have already sent. 543 | 544 | HTTP PUT /private_message"# 545 | ); 546 | expose_wrapped_fn!( 547 | list_private_messages, 548 | GetPrivateMessages, 549 | PrivateMessagesResponse, 550 | r#"Lists private messages that have been sent to you. 551 | 552 | HTTP GET /private_message/list"# 553 | ); 554 | expose_wrapped_fn!( 555 | delete_private_message, 556 | DeletePrivateMessage, 557 | PrivateMessageResponse, 558 | r#"Deletes a private that you have already sent. 559 | 560 | HTTP POST /private_message/delete"# 561 | ); 562 | expose_wrapped_fn!( 563 | mark_private_message_as_read, 564 | MarkPrivateMessageAsRead, 565 | PrivateMessageResponse, 566 | r#"Marks a private message that was sent to you as read. 567 | 568 | HTTP POST /private_message/mark_as_read"# 569 | ); 570 | expose_wrapped_fn!( 571 | create_private_message_report, 572 | CreatePrivateMessageReport, 573 | PrivateMessageReportResponse, 574 | r#"Reports a private message that was sent to you to your instance's admin team and the sender's instance's admin team. 575 | 576 | HTTP POST /private_message/report"# 577 | ); 578 | expose_wrapped_fn!( 579 | resolve_private_message_report, 580 | ResolvePrivateMessageReport, 581 | PrivateMessageReportResponse, 582 | r#"Resolves a report of a private message sent to a user on the instance you administrate. 583 | 584 | HTTP PUT /private_message/report/resolve"# 585 | ); 586 | expose_wrapped_fn!( 587 | list_private_message_reports, 588 | ListPrivateMessageReports, 589 | ListPrivateMessageReportsResponse, 590 | r#"Lists reports of private messages received on the instance you administrate. 591 | 592 | HTTP GET /private_message/report/list"# 593 | ); 594 | expose_wrapped_fn!( 595 | get_person, 596 | GetPersonDetails, 597 | GetPersonDetailsResponse, 598 | r#"Gets the publicly viewable details of a user's account. 599 | 600 | HTTP GET /user"# 601 | ); 602 | expose_wrapped_fn!( 603 | register_account, 604 | Register, 605 | RegistrationApplicationResponse, 606 | r#"Registers a new account on an instance. 607 | 608 | HTTP POST /user/register"# 609 | ); 610 | expose_wrapped_fn!( 611 | get_captcha, 612 | (), 613 | GetCaptchaResponse, 614 | r#"Gets a captcha. 615 | 616 | HTTP GET /user/get_captcha"# 617 | ); 618 | expose_wrapped_fn!( 619 | export_settings, 620 | (), 621 | String, 622 | r#"Exports a backup of your user settings - including your saved content, followed communities, and blocks - as JSON. 623 | 624 | HTTP GET /user/export_settings"# 625 | ); 626 | expose_wrapped_fn!( 627 | import_settings, 628 | String, 629 | SuccessResponse, 630 | r#"Imports a backup of your user settings. 631 | 632 | HTTP POST /user/import_settings"# 633 | ); 634 | expose_wrapped_fn!( 635 | list_mentions, 636 | GetPersonMentions, 637 | GetPersonMentionsResponse, 638 | r#"Gets mentions of the authenticated user. 639 | 640 | HTTP GET /user/mention"# 641 | ); 642 | expose_wrapped_fn!( 643 | mark_mention_as_read, 644 | MarkPersonMentionAsRead, 645 | PersonMentionResponse, 646 | r#"Marks a mention as read. 647 | 648 | HTTP POST /user/mention/mark_as_read"# 649 | ); 650 | expose_wrapped_fn!( 651 | list_replies, 652 | GetReplies, 653 | GetRepliesResponse, 654 | r#"Gets replies to your posts and comments. 655 | 656 | HTTP GET /user/replies"# 657 | ); 658 | expose_wrapped_fn!( 659 | ban_from_site, 660 | BanPerson, 661 | BanPersonResponse, 662 | r#"Bans a person from your instance. 663 | 664 | HTTP POST /user/ban"# 665 | ); 666 | expose_wrapped_fn!( 667 | list_banned_users, 668 | (), 669 | BannedPersonsResponse, 670 | r#"Gets users who are banned from your instance. 671 | 672 | HTTP GET /user/banned"# 673 | ); 674 | expose_wrapped_fn!( 675 | block_person, 676 | BlockPerson, 677 | BlockPersonResponse, 678 | r#"Blocks a person. 679 | 680 | HTTP POST /user/block"# 681 | ); 682 | expose_wrapped_fn!( 683 | login, 684 | Login, 685 | LoginResponse, 686 | r#"Logs into the instance, giving you a JWT to use to make authorized requests. 687 | 688 | HTTP POST /user/login"# 689 | ); 690 | expose_wrapped_fn!( 691 | logout, 692 | (), 693 | SuccessResponse, 694 | r#"Deletes the active session associated with the JWT. 695 | 696 | HTTP POST /user/logout"# 697 | ); 698 | expose_wrapped_fn!( 699 | delete_account, 700 | DeleteAccount, 701 | SuccessResponse, 702 | r#"Deletes your account. 703 | 704 | HTTP POST /user/delete_account"# 705 | ); 706 | expose_wrapped_fn!( 707 | reset_password, 708 | PasswordReset, 709 | SuccessResponse, 710 | r#"Sends an email to your account (if you have one) with a one time link to change your password. Use this if you forgot your password. 711 | 712 | HTTP POST /user/password_reset"# 713 | ); 714 | expose_wrapped_fn!( 715 | change_password_after_reset, 716 | PasswordChangeAfterReset, 717 | SuccessResponse, 718 | r#"Follows through with one time link password reset request. 719 | 720 | HTTP POST /user/password_change"# 721 | ); 722 | expose_wrapped_fn!( 723 | mark_all_notifications_as_read, 724 | (), 725 | GetRepliesResponse, 726 | r#"Marks all notifications (replies, mentions, private messages) as read. 727 | 728 | HTTP POST /user/mark_all_as_read"# 729 | ); 730 | expose_wrapped_fn!( 731 | save_user_settings, 732 | SaveUserSettings, 733 | SuccessResponse, 734 | r#"Saves your account settings. 735 | 736 | HTTP PUT /user/save_user_settings"# 737 | ); 738 | expose_wrapped_fn!( 739 | change_password, 740 | ChangePassword, 741 | LoginResponse, 742 | r#"Changes your password if you are already logged in. 743 | 744 | HTTP PUT /user/change_password"# 745 | ); 746 | expose_wrapped_fn!( 747 | report_count, 748 | GetReportCount, 749 | GetReportCountResponse, 750 | r#"Gets number of reports you can resolve. 751 | 752 | HTTP GET /user/report_count"# 753 | ); 754 | expose_wrapped_fn!( 755 | unread_count, 756 | (), 757 | GetUnreadCountResponse, 758 | r#"Gets the number of unread notifications. 759 | 760 | HTTP GET /user/unread_count"# 761 | ); 762 | expose_wrapped_fn!( 763 | verify_email, 764 | VerifyEmail, 765 | SuccessResponse, 766 | r#"Verifies your email. Used when the instance you are registering an account on requires email verification. 767 | 768 | HTTP POST /user/verify_email"# 769 | ); 770 | expose_wrapped_fn!( 771 | leave_admin, 772 | (), 773 | GetSiteResponse, 774 | r#"Leave your instance's admin team. 775 | 776 | HTTP POST /user/leave_admin"# 777 | ); 778 | expose_wrapped_fn!( 779 | generate_totp_secret, 780 | (), 781 | GenerateTotpSecretResponse, 782 | r#"Generates a secret to enable time-based one time passwords for two-factor authentication. 783 | 784 | After this, you will need to call /user/totp/update with a valid token to enable it. 785 | 786 | HTTP POST /user/totp/generate"# 787 | ); 788 | expose_wrapped_fn!( 789 | update_totp, 790 | UpdateTotp, 791 | UpdateTotpResponse, 792 | r#"Enables/disables two-factor authentivation. 793 | 794 | To enable, you must first call /user/totp/generate to generate a token to pass to this. 795 | 796 | You can only disable this if it is already enabled. Again, you must pass a valid TOTP. 797 | 798 | HTTP POST /user/totp/update"# 799 | ); 800 | expose_wrapped_fn!( 801 | list_logins, 802 | (), 803 | Vec, 804 | r#"Lists login tokens for your user's active sessions. 805 | 806 | HTTP GET /user/list_logins"# 807 | ); 808 | expose_wrapped_fn!( 809 | validate_auth, 810 | (), 811 | SuccessResponse, 812 | r#"Returns an error message if your auth token is invalid. 813 | 814 | HTTP GET /user/validate_auth"# 815 | ); 816 | expose_wrapped_fn!( 817 | add_admin, 818 | AddAdmin, 819 | AddAdminResponse, 820 | r#"Adds a user to your instance's admin team. 821 | 822 | HTTP POST admin/add"# 823 | ); 824 | expose_wrapped_fn!( 825 | unread_registration_application_count, 826 | (), 827 | GetUnreadRegistrationApplicationCountResponse, 828 | r#"Gets the number of unread registration applications for the instance you administrate. 829 | 830 | HTTP GET /admin/registration_application/count"# 831 | ); 832 | expose_wrapped_fn!( 833 | get_registration_aplication, 834 | GetRegistrationApplication, 835 | RegistrationApplicationResponse, 836 | r#"Get the application a user submitted when they first registered their account 837 | 838 | HTTP GET /admin/registration_application"# 839 | ); 840 | expose_wrapped_fn!( 841 | list_registration_applications, 842 | ListRegistrationApplications, 843 | ListRegistrationApplicationsResponse, 844 | r#"Gets applications to register an account on the instance you administer. 845 | 846 | HTTP GET /admin/registration_application/list"# 847 | ); 848 | expose_wrapped_fn!( 849 | approve_registration_application, 850 | ApproveRegistrationApplication, 851 | RegistrationApplicationResponse, 852 | r#"Approves a pending registration application. 853 | 854 | HTTP PUT /admin/registration_application/approve"# 855 | ); 856 | expose_wrapped_fn!( 857 | purge_person, 858 | PurgePerson, 859 | SuccessResponse, 860 | r#"Purges a user from the database. 861 | 862 | HTTP POST /admin/purge/person"# 863 | ); 864 | expose_wrapped_fn!( 865 | purge_community, 866 | PurgeCommunity, 867 | SuccessResponse, 868 | r#"Purges a community from the database. 869 | 870 | HTTP POST /admin/purge/community"# 871 | ); 872 | expose_wrapped_fn!( 873 | purge_post, 874 | PurgePost, 875 | SuccessResponse, 876 | r#"Purges a post from the database. 877 | 878 | HTTP POST /admin/purge/post"# 879 | ); 880 | expose_wrapped_fn!( 881 | purge_comment, 882 | PurgeComment, 883 | SuccessResponse, 884 | r#"Purges a comment from the database. 885 | 886 | HTTP POST /admin/purge/comment"# 887 | ); 888 | expose_wrapped_fn!( 889 | create_custom_emoji, 890 | CreateCustomEmoji, 891 | CustomEmojiResponse, 892 | r#"Creates a custom emoji. 893 | 894 | HTTP POST /custom_emoji"# 895 | ); 896 | expose_wrapped_fn!( 897 | edit_custom_emoji, 898 | EditCustomEmoji, 899 | CustomEmojiResponse, 900 | r#"Edits an existing custom emoji. 901 | 902 | HTTP PUT /custom_emoji"# 903 | ); 904 | expose_wrapped_fn!( 905 | delete_custom_emoji, 906 | DeleteCustomEmoji, 907 | CustomEmojiResponse, 908 | r#"Deletes an existing custom emoji. 909 | 910 | HTTP POST /custom_emoji/delete"# 911 | ); 912 | expose_wrapped_fn!( 913 | list_media, 914 | ListMedia, 915 | ListMediaResponse, 916 | r#"Gets all media posted by the logged in user. 917 | 918 | HTTP GET /account/list_media"# 919 | ); 920 | expose_wrapped_fn!( 921 | list_all_media, 922 | ListMedia, 923 | ListMediaResponse, 924 | r#"Gets all media posted on an instance. Only usable by the instance's admins. 925 | 926 | HTTP GET /admin/list_all_media"# 927 | ); 928 | } 929 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------