├── .cargo
└── config.toml
├── .gitignore
├── Cargo.toml
├── src
├── lib.rs
├── tgext.rs
├── markdown.rs
└── tgbot.rs
├── README.md
└── LICENSE
/.cargo/config.toml:
--------------------------------------------------------------------------------
1 | [build]
2 | target = "wasm32-wasi"
3 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Generated by Cargo
2 | # will have compiled files and executables
3 | /target/
4 |
5 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
6 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
7 | Cargo.lock
8 |
9 | # These are backup files generated by rustfmt
10 | **/*.rs.bk
11 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "telegram-gpt"
3 | version = "0.1.0"
4 | edition = "2021"
5 |
6 | [lib]
7 | path = "src/lib.rs"
8 | crate-type = ["cdylib"]
9 |
10 | [build]
11 | target = "wasm32-wasi"
12 |
13 | [dependencies]
14 | nom = "7.1.3"
15 | openai-flows = "0.9.0"
16 | tg-flows = "0.3"
17 | store-flows = "0.3"
18 | serde_json = "1.0"
19 | dotenv = "0.15.0"
20 | flowsnet-platform-sdk = "0.1"
21 | log = "0.4"
22 | tokio_wasi = { version = "1.25.1", features = ["macros", "rt"] }
23 | anyhow = "1"
24 | serde = { version = "1.0.190", features = ["derive"] }
25 |
--------------------------------------------------------------------------------
/src/lib.rs:
--------------------------------------------------------------------------------
1 | mod markdown;
2 | mod tgbot;
3 | mod tgext;
4 | use flowsnet_platform_sdk::logger;
5 |
6 | use tg_flows::{listen_to_update, update_handler, Update};
7 |
8 | use tgbot::TgBot;
9 |
10 | #[no_mangle]
11 | #[tokio::main(flavor = "current_thread")]
12 | pub async fn on_deploy() {
13 | logger::init();
14 | let res = TgBot::default().set_bot_commands();
15 | if res.is_err() {
16 | log::error!("failed to set bot commands: {:?}", res.err())
17 | }
18 |
19 | let telegram_token = std::env::var("telegram_token").unwrap();
20 | listen_to_update(telegram_token).await;
21 | }
22 |
23 | #[update_handler]
24 | async fn handler(update: Update) {
25 | TgBot::default().handle_update(update).await.unwrap();
26 | }
27 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # A Telegram ChatGPT bot
2 |
3 |
4 | 
5 |
6 |
7 | 
8 |
9 |
10 | 
11 |
12 |
13 |
14 | [Deploy this function on flows.network](https://flows.network/flow/createByTemplate/Telegram-ChatGPT), and you will get a Telegram bot that uses ChatGPT to respond to every question in your Telegram DM or channel/group automatically.
15 |
16 | Try a couple of Telegram bots on flows.network yourself!
17 |
18 | * This is a [simple ChatGPT bot](https://t.me/flows_network_gpt_bot) that is created directly from the template.
19 | * The [multimodal assistant bot](https://t.me/flows_english_assistant_bot) is based on this template. It can recognize text on uploaded pictures using flows.network's built in OCR service. It also has several task prompts already set up as slash commands.
20 |
21 |
22 | ## Prerequisites
23 |
24 | * You will need to bring your own [OpenAI API key](https://openai.com/blog/openai-api). If you do not already have one, [sign up here](https://platform.openai.com/signup).
25 |
26 | * You also need a bot token to access the Telegram API. If you don't already have one, go to Telegram to get a bot token from [@botfather](https://telegram.me/BotFather).
27 |
28 |
29 | ## Deploy your Telegram ChatGPT bot in 3 steps
30 |
31 | 1. Create a bot from a template
32 | 2. Add your ChatGPT API key
33 | 3. Add the telegram bot token
34 |
35 | ### 1 Create a bot from a template
36 |
37 |
38 | [**Just click here**](https://flows.network/flow/createByTemplate/Telegram-ChatGPT)
39 |
40 | 
41 |
42 |
43 | Here you can see three variables. You can customize the `system_prompt` variable to prompt ChatGPT.
44 |
45 | Click on the **Create and Build** button.
46 |
47 | ### 2 Add your OpenAI API key
48 |
49 | You will now set up OpenAI integration. Click on **Connect**, and enter your key.
50 |
51 | [
](https://user-images.githubusercontent.com/45785633/226564674-902933b5-8ff3-4724-93e3-2b2f67dc0b9a.png)
52 |
53 | Close the tab and go back to the flow.network page once you are done. Click on **Continue**.
54 |
55 | ### 3 Add the Telegram bot token
56 |
57 | You will now set up Telegram integration. Enter your Telegram token here.
58 |
59 | [
](https://github.com/flows-network/telegram-claude/assets/45785633/805f78b0-ca9b-476d-8ec2-1e5763c0edf5)
60 |
61 | Click on **Deploy** button.
62 |
63 | ## Give it a try.
64 |
65 | As soon as the flow function's status becomes `ready` and the flow's status becomes `running`, the Telegram Telegram bot goes live. Go ahead and send a private message to the bot! You can also invite this bot to your channel/group.
66 |
67 |
--------------------------------------------------------------------------------
/src/tgext.rs:
--------------------------------------------------------------------------------
1 | use crate::markdown::escape_markdown;
2 | use tg_flows::{BotCommand, ChatId, Message, MessageId, ReplyMarkup, Telegram};
3 |
4 | pub trait TgExt {
5 | fn reply_to_message(&self, msg: &Message, text: T) -> anyhow::Result
6 | where
7 | T: Into;
8 |
9 | fn set_my_commands(&self, cmds: T) -> anyhow::Result
10 | where
11 | T: IntoIterator,
12 | T::Item: Into;
13 |
14 | fn send_message_ext(
15 | &self,
16 | chat_id: ChatId,
17 | reploy_to: Option<&MessageId>,
18 | text: T,
19 | reply_markup: Option,
20 | ) -> anyhow::Result
21 | where
22 | T: Into;
23 |
24 | fn edit_message_text_ext(
25 | &self,
26 | chat_id: ChatId,
27 | message_id: MessageId,
28 | text: T,
29 | reply_markup: Option,
30 | ) -> anyhow::Result
31 | where
32 | T: Into;
33 | }
34 |
35 | impl TgExt for Telegram {
36 | fn reply_to_message(&self, msg: &Message, text: T) -> anyhow::Result
37 | where
38 | T: Into,
39 | {
40 | let text: String = text.into();
41 | let body = serde_json::json!({
42 | "chat_id": msg.chat.id,
43 | "reply_to_message_id": msg.id.0,
44 | "text": text,
45 | });
46 | log::info!("reply message: {}", body);
47 | self.request(tg_flows::Method::SendMessage, body.to_string().as_bytes())
48 | }
49 |
50 | fn set_my_commands(&self, cmds: T) -> anyhow::Result
51 | where
52 | T: IntoIterator,
53 | T::Item: Into,
54 | {
55 | let commands: Vec = cmds.into_iter().map(|cmd| cmd.into()).collect();
56 | let body = serde_json::json!({
57 | "commands": commands,
58 | });
59 | log::info!("set bot command: {}", body);
60 | self.request(tg_flows::Method::SetMyCommands, body.to_string().as_bytes())
61 | }
62 |
63 | fn send_message_ext(
64 | &self,
65 | chat_id: ChatId,
66 | reply_to: Option<&MessageId>,
67 | text: T,
68 | reply_markup: Option,
69 | ) -> anyhow::Result
70 | where
71 | T: Into,
72 | {
73 | let markup_value = match reply_markup {
74 | Some(markup) => serde_json::to_value(markup)?,
75 | _ => serde_json::Value::Null,
76 | };
77 | let message_id = match reply_to {
78 | Some(id) => serde_json::to_value(id)?,
79 | _ => serde_json::Value::Null,
80 | };
81 | let body = serde_json::json!({
82 | "chat_id": chat_id,
83 | "reply_to_message_id": message_id,
84 | "parse_mode": "MarkdownV2",
85 | "text": escape_markdown(text.into())?,
86 | "reply_markup": markup_value,
87 | });
88 | log::info!("send message ext: {}", &body);
89 | self.request(tg_flows::Method::SendMessage, body.to_string().as_bytes())
90 | }
91 |
92 | fn edit_message_text_ext(
93 | &self,
94 | chat_id: ChatId,
95 | message_id: MessageId,
96 | text: T,
97 | reply_markup: Option,
98 | ) -> anyhow::Result
99 | where
100 | T: Into,
101 | {
102 | let text: String = text.into();
103 | let body = match reply_markup {
104 | Some(markup) => serde_json::json!({
105 | "chat_id": chat_id,
106 | "message_id": message_id.0,
107 | "parse_mode": "MarkdownV2",
108 | "text": escape_markdown(&text)?,
109 | "reply_markup": serde_json::to_value(markup)?,
110 | }),
111 | _ => serde_json::json!({
112 | "chat_id": chat_id,
113 | "message_id": message_id.0,
114 | "parse_mode": "MarkdownV2",
115 | "text": escape_markdown(&text)?,
116 | }),
117 | };
118 | match self.request(
119 | tg_flows::Method::EditMessageText,
120 | body.to_string().as_bytes(),
121 | ) {
122 | Err(_) => {
123 | log::error!("wrong escape_markdown: {}", body);
124 | self.edit_message_text(chat_id, message_id, text)
125 | }
126 | res => res,
127 | }
128 | }
129 | }
130 |
--------------------------------------------------------------------------------
/src/markdown.rs:
--------------------------------------------------------------------------------
1 | use anyhow::bail;
2 | use nom::{
3 | branch::alt,
4 | bytes::complete::{escaped_transform, tag, take_till, take_till1, take_until, take_while1},
5 | character::{
6 | complete::{anychar, char, multispace0, none_of, space1},
7 | is_newline,
8 | },
9 | combinator::value,
10 | multi::many1,
11 | sequence::{delimited, preceded},
12 | IResult,
13 | };
14 |
15 | fn is_special_char(c: char) -> bool {
16 | matches!(
17 | c,
18 | '_' | '*'
19 | | '['
20 | | ']'
21 | | '('
22 | | ')'
23 | | '~'
24 | | '`'
25 | | '>'
26 | | '#'
27 | | '+'
28 | | '-'
29 | | '='
30 | | '|'
31 | | '{'
32 | | '}'
33 | | '.'
34 | | '!'
35 | | '\\'
36 | )
37 | }
38 |
39 | fn escaped_for_tg(text: impl AsRef) -> String {
40 | let mut escaped_string = String::new();
41 | for c in text.as_ref().chars() {
42 | if is_special_char(c) {
43 | escaped_string.push('\\');
44 | }
45 | escaped_string.push(c);
46 | }
47 |
48 | escaped_string
49 | }
50 |
51 | fn parse_escaped_chars(paren: char) -> impl Fn(&str) -> IResult<&str, String> {
52 | move |input: &str| {
53 | escaped_transform(
54 | take_till1(|c| c == paren || c == '\\' || is_newline(c as u8)),
55 | '\\',
56 | alt((
57 | value("_", tag("\\_")),
58 | value("*", tag("\\*")),
59 | value("[", tag("\\[")),
60 | value("]", tag("\\]")),
61 | value("(", tag("\\(")),
62 | value(")", tag("\\)")),
63 | value("~", tag("\\~")),
64 | value("`", tag("\\`")),
65 | value(">", tag("\\>")),
66 | value("#", tag("\\#")),
67 | value("+", tag("\\+")),
68 | value("-", tag("\\-")),
69 | value("=", tag("\\=")),
70 | value("|", tag("\\|")),
71 | value("{", tag("\\{")),
72 | value("}", tag("\\}")),
73 | value(".", tag("\\.")),
74 | value("!", tag("\\!")),
75 | value("\\", tag("\\\\")),
76 | )),
77 | )(input)
78 | }
79 | }
80 |
81 | fn parse_emphasize(input: &str) -> IResult<&str, String> {
82 | let (input, content) = alt((
83 | delimited(tag("__"), parse_escaped_chars('_'), tag("__")),
84 | delimited(char('_'), parse_escaped_chars('_'), char('_')),
85 | ))(input)?;
86 | Ok((input, format!("_{}_", escaped_for_tg(content))))
87 | }
88 |
89 | fn parse_bold(input: &str) -> IResult<&str, String> {
90 | let (input, content) = alt((
91 | delimited(tag("**"), parse_escaped_chars('*'), tag("**")),
92 | delimited(char('*'), parse_escaped_chars('*'), char('*')),
93 | ))(input)?;
94 | Ok((input, format!("*{}*", escaped_for_tg(content))))
95 | }
96 |
97 | fn parse_code(input: &str) -> IResult<&str, String> {
98 | let (input, content) = delimited(char('`'), parse_escaped_chars('`'), char('`'))(input)?;
99 | Ok((input, format!("`{}`", escaped_for_tg(content))))
100 | }
101 |
102 | fn parse_link(input: &str) -> IResult<&str, String> {
103 | let (input, text) = delimited(char('['), parse_escaped_chars(']'), char(']'))(input)?;
104 | let (input, link) = delimited(char('('), parse_escaped_chars(')'), char(')'))(input)?;
105 | Ok((
106 | input,
107 | format!("[{}]({})", escaped_for_tg(text), escaped_for_tg(link)),
108 | ))
109 | }
110 |
111 | fn parse_plaintext(input: &str) -> IResult<&str, String> {
112 | let (input, content) = take_till1(|c| is_special_char(c) || is_newline(c as u8))(input)?;
113 | Ok((input, escaped_for_tg(content)))
114 | }
115 |
116 | fn parse_special_chars(input: &str) -> IResult<&str, String> {
117 | let (input, content) = take_while1(is_special_char)(input)?;
118 | Ok((input, escaped_for_tg(content)))
119 | }
120 |
121 | fn parse_header(input: &str) -> IResult<&str, String> {
122 | let (input, htag) = many1(char('#'))(input)?;
123 | let (input, _) = space1(input)?;
124 | let (input, title) = parse_plaintext(input)?;
125 | Ok((
126 | input,
127 | format!(
128 | "`{}` *{}*",
129 | escaped_for_tg(htag.into_iter().collect::()),
130 | title
131 | ),
132 | ))
133 | }
134 |
135 | fn parse_paragraph(input: &str) -> IResult<&str, String> {
136 | let (input, components) = many1(alt((
137 | parse_emphasize,
138 | parse_bold,
139 | parse_code,
140 | parse_link,
141 | parse_plaintext,
142 | parse_special_chars,
143 | )))(input)?;
144 | Ok((input, components.join("")))
145 | }
146 |
147 | fn parse_codeblock(input: &str) -> IResult<&str, String> {
148 | let (input, content) = delimited(tag("```"), take_until("```"), tag("```"))(input)?;
149 | Ok((input, format!("```{}```", escaped_for_tg(content))))
150 | }
151 |
152 | pub fn parse_markdown(input: &str) -> IResult<&str, String> {
153 | let (input, lines) = many1(preceded(
154 | multispace0,
155 | alt((parse_codeblock, parse_header, parse_paragraph)),
156 | ))(input)?;
157 | Ok((input, lines.join("\n\n")))
158 | }
159 |
160 | pub fn escape_markdown(text: impl AsRef) -> anyhow::Result {
161 | if let Ok((_, content)) = parse_markdown(text.as_ref()) {
162 | Ok(content)
163 | } else {
164 | bail!("unable to correctly escape markdown")
165 | }
166 | }
167 |
--------------------------------------------------------------------------------
/src/tgbot.rs:
--------------------------------------------------------------------------------
1 | use std::fmt;
2 |
3 | use crate::tgext::TgExt;
4 | use anyhow::bail;
5 | use flowsnet_platform_sdk::logger;
6 | use openai_flows::{
7 | chat::{ChatModel, ChatOptions},
8 | OpenAIFlows,
9 | };
10 | use serde::{Deserialize, Serialize};
11 | use tg_flows::{
12 | BotCommand, CallbackQuery, ChatId, ForceReply, InlineKeyboardButton, InlineKeyboardMarkup,
13 | Message, ReplyMarkup, Telegram, Update, UpdateKind,
14 | };
15 |
16 | const DEFAULT_PROMPT: &str = r#"
17 | Your name is "Cheese" and you are working as a jotting pal to help on Telegram.
18 | You can answer questions, help clients learn japanese and show a help message.
19 | your creator is Chase Zhang, you are based on OpenAI's ChatGPT.
20 | You should double check the fact of your answer carefully before replying a message
21 | and make sure it is acurate.
22 | You should format your answers into markdown format if necessary.
23 | If you answer includes codeblocks, please make sure you will specify the name
24 | of the programming language with proper syntax in markdown format.
25 | "#;
26 |
27 | const NIHONGO_TRANSLATE_PROMPT: &str = r#"
28 | You are now helping the user to learn Japanese.
29 | You should act as a translate machine and please translate everything the user sent to you into Japanese direcly.
30 | You can provide explanation on keywords in the Japanese translation provide pronunciation in hiragana.
31 | If the user sent you Japanese, you should translate them into English and correct the user if there is any obvious mistake.
32 | When providing pronunciation of Japanese, please use hiragana or katakana instead of romaji.
33 | "#;
34 |
35 | const NIHONGO_EXPLAIN_PROMPT: &str = r#"
36 | You are now helping the user to learn Japanese.
37 | If the user sent you a piece of text in Japanese, you should explain the grammar and keywords.
38 | You can explain by break down the sentences and provide pronounce annotation in hiragana.
39 | If the user ask you a question in English, you should translate it into Japanese and explain your translation.
40 | You can also answer the user's chat from your own knowledge.
41 | You are encouraged to provide background information of a famous historical place.
42 | If you feel there is a better way to say something, feel free to correct the user.
43 | "#;
44 |
45 | const NIHONGO_MOCK_SCENE_PROMPT: &str = r#"
46 | You are now helping the users to learn Japanese.
47 | You should always speak Japanese in the conversation.
48 | You are now in mock conversation mode, in this mode, you should act as a role in a conversation scene.
49 | When the user send you a message, you should reply based on your role.
50 | If what the user has sent you is obviously not correct in terms of grammar or usage of words, you can first correct the users and provide an explanation.
51 | If you are replying to the user with some rarely used words, please provide the translation of them after the reply.
52 | If the user send you a message in English, please tell the user how to express the same meaning in Japanese before replying under your role.
53 | "#;
54 |
55 | const NIHONGO_MOCK_SCENE_CAFE_PROMPT: &str = r#"
56 | Your role is defined as follow:
57 | You are a waiter in a cafe.
58 | The cafe provide all kinds of coffee from espresso to pour over.
59 | The cafe also sell baked whole beans.
60 | You should help the user to order a cup of coffee.
61 | When you are using any Japanese words about origins of coffee, flaver, and other technique about coffee, please emphasize the word with markdown.
62 | "#;
63 |
64 | const NIHONGO_MOCK_SCENE_RESTAURANT_PROMPT: &str = r#"
65 | Your role is defined as follow:
66 | You are a waiter in a restaurant.
67 | You are helping the user to order a dish.
68 | You can recommend some dishes to the user.
69 | When you are using any Japanese words about food, vegetables, fruit, dishes, spice, flavor and drinks, please semphasize the word with markdown.
70 | "#;
71 |
72 | const NIHONGO_MOCK_SCENE_CLOTHES_SHOP_PROMPT: &str = r#"
73 | Your role is defined as follow:
74 | You are a shopping guide in a clothes shop.
75 | The clothes shop sells all kinds of clothes and shoes.
76 | You can guide the user per your understanding of the fashion in Japan.
77 | You can pretend the shop has a fitting room and let the user try the clothes or shoes.
78 | When you are using any Japanese words about clothes, style, and other fashion related words, please emphasize the word with markdown.
79 | "#;
80 |
81 | const NIHONGO_MOCK_SCENE_STREET_PROMPT: &str = r#"
82 | Your role is defined as follow:
83 | You are a passers-by on the street who have just met the user.
84 | You want to help the user know about the city, street and nearby.
85 | You can first ask the user about where the user is at and where the user want to go.
86 | When you are using any Japanese words about location, direction and other motion related words, please emphasize the word with markdown.
87 | "#;
88 |
89 | const NIHONGO_MOCK_SCENE_SMALL_TALK_PROMPT: &str = r#"
90 | Your role is defined as follow:
91 | You are a passers-by who have just met the user.
92 | You and the user are going to have a random small talk.
93 | The topic can vary from weather to habbit.
94 | You can start by picking a random topic.
95 | "#;
96 |
97 | #[derive(Clone, Serialize, Deserialize)]
98 | enum TgBotPrompt {
99 | Default,
100 | NihongoTranslate,
101 | NihongoExplain,
102 | NihongoSceneMockCafe,
103 | NihongoSceneMockRestaurant,
104 | NihongoSceneMockClothesShop,
105 | NihongoSceneMockStreet,
106 | NihongoSceneMockSmallTalk,
107 | }
108 |
109 | impl TgBotPrompt {
110 | fn id(&self) -> &'static str {
111 | match self {
112 | TgBotPrompt::NihongoTranslate => "nihongo-translate",
113 | TgBotPrompt::NihongoExplain => "nihongo-explain",
114 | TgBotPrompt::NihongoSceneMockCafe => "nihongo-scene-mock-cafe",
115 | TgBotPrompt::NihongoSceneMockRestaurant => "nihongo-scene-mock-restaurant",
116 | TgBotPrompt::NihongoSceneMockClothesShop => "nihongo-scene-mock-clothes-shop",
117 | TgBotPrompt::NihongoSceneMockStreet => "nihongo-scene-mock-street",
118 | TgBotPrompt::NihongoSceneMockSmallTalk => "nihongo-scene-mock-small-talk",
119 | _ => "default",
120 | }
121 | }
122 |
123 | fn prompt(&self) -> String {
124 | match self {
125 | TgBotPrompt::NihongoTranslate => [DEFAULT_PROMPT, NIHONGO_TRANSLATE_PROMPT].join("\n"),
126 | TgBotPrompt::NihongoExplain => [DEFAULT_PROMPT, NIHONGO_EXPLAIN_PROMPT].join("\n"),
127 | TgBotPrompt::NihongoSceneMockCafe => [
128 | DEFAULT_PROMPT,
129 | NIHONGO_MOCK_SCENE_PROMPT,
130 | NIHONGO_MOCK_SCENE_CAFE_PROMPT,
131 | ]
132 | .join("\n"),
133 | TgBotPrompt::NihongoSceneMockRestaurant => [
134 | DEFAULT_PROMPT,
135 | NIHONGO_MOCK_SCENE_PROMPT,
136 | NIHONGO_MOCK_SCENE_RESTAURANT_PROMPT,
137 | ]
138 | .join("\n"),
139 | TgBotPrompt::NihongoSceneMockClothesShop => [
140 | DEFAULT_PROMPT,
141 | NIHONGO_MOCK_SCENE_PROMPT,
142 | NIHONGO_MOCK_SCENE_CLOTHES_SHOP_PROMPT,
143 | ]
144 | .join("\n"),
145 | TgBotPrompt::NihongoSceneMockStreet => [
146 | DEFAULT_PROMPT,
147 | NIHONGO_MOCK_SCENE_PROMPT,
148 | NIHONGO_MOCK_SCENE_STREET_PROMPT,
149 | ]
150 | .join("\n"),
151 | TgBotPrompt::NihongoSceneMockSmallTalk => [
152 | DEFAULT_PROMPT,
153 | NIHONGO_MOCK_SCENE_PROMPT,
154 | NIHONGO_MOCK_SCENE_SMALL_TALK_PROMPT,
155 | ]
156 | .join("\n"),
157 | _ => DEFAULT_PROMPT.to_owned(),
158 | }
159 | }
160 | }
161 |
162 | impl From<&str> for TgBotPrompt {
163 | fn from(value: &str) -> Self {
164 | match value {
165 | "nihongo-translate" => TgBotPrompt::NihongoTranslate,
166 | "nihongo-explain" => TgBotPrompt::NihongoExplain,
167 | "nihongo-scene-mock-cafe" => TgBotPrompt::NihongoSceneMockCafe,
168 | "nihongo-scene-mock-restaurant" => TgBotPrompt::NihongoSceneMockRestaurant,
169 | "nihongo-scene-mock-clothes-shop" => TgBotPrompt::NihongoSceneMockClothesShop,
170 | "nihongo-scene-mock-street" => TgBotPrompt::NihongoSceneMockStreet,
171 | "nihongo-scene-mock-small-talk" => TgBotPrompt::NihongoSceneMockSmallTalk,
172 | _ => TgBotPrompt::Default,
173 | }
174 | }
175 | }
176 |
177 | #[derive(Clone)]
178 | enum TgBotCommand {
179 | Ask,
180 | Nihongo,
181 | Settings,
182 | Help,
183 | }
184 |
185 | #[derive(Clone, Debug)]
186 | enum TgBotInlineButton {
187 | // nihongo
188 | NihongoTranslate,
189 | NihongoExplain,
190 | NihongoSceneMock,
191 | NihongoSceneMockRestaurant,
192 | NihongoSceneMockCafe,
193 | NihongoSceneMockClothesShop,
194 | NihongoSceneMockStreet,
195 | NihongoSceneMockSmallTalk,
196 | NihongoSceneMockGoBack,
197 | // settings
198 | SettingsLMGPT35Turbo,
199 | SettingsLMGPT35Turbo16K,
200 | SettingsLMGPT4,
201 | }
202 |
203 | impl TgBotInlineButton {
204 | fn id(&self) -> String {
205 | // nihongo
206 | match self {
207 | TgBotInlineButton::NihongoTranslate => "NihongoTranslate",
208 | TgBotInlineButton::NihongoExplain => "NihongoExplain",
209 | TgBotInlineButton::NihongoSceneMock => "NihongoSceneMock",
210 | TgBotInlineButton::NihongoSceneMockRestaurant => "NihongoSceneMockRestaurant",
211 | TgBotInlineButton::NihongoSceneMockCafe => "NihongoSceneMockCafe",
212 | TgBotInlineButton::NihongoSceneMockClothesShop => "NihongoSceneMockClothesShop",
213 | TgBotInlineButton::NihongoSceneMockStreet => "NihongoSceneMockStreet",
214 | TgBotInlineButton::NihongoSceneMockSmallTalk => "NihongoSceneMockSmallTalk",
215 | TgBotInlineButton::NihongoSceneMockGoBack => "NihongoSceneMockGoBack",
216 | // settings
217 | TgBotInlineButton::SettingsLMGPT35Turbo => "SettingsLMGPT35Turbo",
218 | TgBotInlineButton::SettingsLMGPT35Turbo16K => "SettingsLMGPT35Turbo16K",
219 | TgBotInlineButton::SettingsLMGPT4 => "SettingsLMGPT4",
220 | }
221 | .to_owned()
222 | }
223 |
224 | fn title(&self) -> String {
225 | match self {
226 | TgBotInlineButton::NihongoTranslate => "翻訳",
227 | TgBotInlineButton::NihongoExplain => "説明",
228 | TgBotInlineButton::NihongoSceneMock => "模擬会話",
229 | TgBotInlineButton::NihongoSceneMockRestaurant => "レストラン",
230 | TgBotInlineButton::NihongoSceneMockCafe => "カフェ",
231 | TgBotInlineButton::NihongoSceneMockClothesShop => "服屋",
232 | TgBotInlineButton::NihongoSceneMockStreet => "街",
233 | TgBotInlineButton::NihongoSceneMockSmallTalk => "自由",
234 | TgBotInlineButton::NihongoSceneMockGoBack => "戻る",
235 | TgBotInlineButton::SettingsLMGPT35Turbo => "gpt3.5-turbo",
236 | TgBotInlineButton::SettingsLMGPT35Turbo16K => "gpt3.5-turbo-16k",
237 | TgBotInlineButton::SettingsLMGPT4 => "gpt4",
238 | }
239 | .to_string()
240 | }
241 | }
242 |
243 | impl TryFrom<&str> for TgBotInlineButton {
244 | type Error = anyhow::Error;
245 |
246 | fn try_from(value: &str) -> anyhow::Result {
247 | match value {
248 | // nihongo
249 | "NihongoTranslate" => Ok(Self::NihongoTranslate),
250 | "NihongoExplain" => Ok(Self::NihongoExplain),
251 | "NihongoSceneMock" => Ok(Self::NihongoSceneMock),
252 | "NihongoSceneMockCafe" => Ok(Self::NihongoSceneMockCafe),
253 | "NihongoSceneMockRestaurant" => Ok(Self::NihongoSceneMockRestaurant),
254 | "NihongoSceneMockClothesShop" => Ok(Self::NihongoSceneMockClothesShop),
255 | "NihongoSceneMockStreet" => Ok(Self::NihongoSceneMockStreet),
256 | "NihongoSceneMockSmallTalk" => Ok(Self::NihongoSceneMockSmallTalk),
257 | "NihongoSceneMockGoBack" => Ok(Self::NihongoSceneMockGoBack),
258 | // settings
259 | "SettingsLMGPT35Turbo" => Ok(Self::SettingsLMGPT35Turbo),
260 | "SettingsLMGPT35Turbo16K" => Ok(Self::SettingsLMGPT35Turbo16K),
261 | "SettingsLMGPT4" => Ok(Self::SettingsLMGPT4),
262 | // unknown
263 | unknown => anyhow::bail!("unknown id: {}", unknown),
264 | }
265 | }
266 | }
267 |
268 | impl From for InlineKeyboardButton {
269 | fn from(tg_kb: TgBotInlineButton) -> Self {
270 | InlineKeyboardButton::new(
271 | tg_kb.title(),
272 | tg_flows::InlineKeyboardButtonKind::CallbackData(tg_kb.id()),
273 | )
274 | }
275 | }
276 |
277 | impl TgBotCommand {
278 | fn root_commands() -> Vec {
279 | vec![
280 | TgBotCommand::Ask,
281 | TgBotCommand::Nihongo,
282 | TgBotCommand::Settings,
283 | TgBotCommand::Help,
284 | ]
285 | }
286 | }
287 |
288 | impl From for BotCommand {
289 | fn from(val: TgBotCommand) -> Self {
290 | match val {
291 | TgBotCommand::Ask => BotCommand::new("ask", "ask any questions"),
292 | TgBotCommand::Nihongo => {
293 | BotCommand::new("nihongo", "learn japanese by sentences and questions")
294 | }
295 | TgBotCommand::Settings => BotCommand::new("settings", "adjust settings of the bot"),
296 | TgBotCommand::Help => BotCommand::new("help", "show help messages"),
297 | }
298 | }
299 | }
300 |
301 | impl fmt::Display for TgBotCommand {
302 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
303 | let cmd: BotCommand = self.clone().into();
304 | write!(f, "/{} {}", cmd.command, cmd.description)
305 | }
306 | }
307 |
308 | #[derive(Clone, Serialize, Deserialize)]
309 | struct TgBotContext {
310 | id: String,
311 | prompt: TgBotPrompt,
312 | }
313 |
314 | pub struct TgBot {
315 | tg: Telegram,
316 | openai: OpenAIFlows,
317 | help_msg: String,
318 | }
319 |
320 | impl Default for TgBot {
321 | fn default() -> Self {
322 | let telegram_token = std::env::var("telegram_token").unwrap();
323 | let mut openai = OpenAIFlows::new();
324 | openai.set_retry_times(3);
325 |
326 | Self {
327 | tg: Telegram::new(telegram_token),
328 | openai,
329 | help_msg: "Hi! I'm you jotting pal.".into(),
330 | }
331 | }
332 | }
333 |
334 | impl TgBot {
335 | pub async fn handle_update(&self, update: Update) -> anyhow::Result<()> {
336 | logger::init();
337 | match update.kind {
338 | UpdateKind::Message(msg) => {
339 | let chat_id = msg.chat.id;
340 | match msg.text() {
341 | Some(_) if msg.reply_to_message().is_some() => self.handle_ask(&msg).await,
342 | Some(text) if text.starts_with("/ask") => self.handle_ask(&msg).await,
343 | Some(text) if text.starts_with("/nihongo") => self.handle_nihongo(&msg, false),
344 | Some(text) if text.starts_with("/settings") => self.handle_settings(&msg),
345 | _ => self.show_help_message(chat_id),
346 | }
347 | .map(|_| ())
348 | }
349 | UpdateKind::CallbackQuery(cq) => self.handle_callback_query(&cq).map(|_| ()),
350 | _ => Ok(()),
351 | }
352 | }
353 |
354 | fn set_typing(&self, chat_id: ChatId) -> anyhow::Result {
355 | self.tg.send_chat_action(chat_id, "typing".to_string())
356 | }
357 |
358 | fn show_help_message(&self, chat_id: ChatId) -> anyhow::Result {
359 | self.tg.send_message(
360 | chat_id,
361 | format!(
362 | "{} Available commands:\n{}",
363 | self.help_msg,
364 | TgBotCommand::root_commands()
365 | .iter()
366 | .map(|cmd| cmd.to_string())
367 | .collect::>()
368 | .join("\n")
369 | ),
370 | )
371 | }
372 |
373 | pub fn set_bot_commands(&self) -> anyhow::Result {
374 | self.tg.set_my_commands(TgBotCommand::root_commands())
375 | }
376 |
377 | async fn handle_ask(&self, msg: &Message) -> anyhow::Result {
378 | let text = msg.text().unwrap();
379 | log::info!("handle ask: {}", text);
380 |
381 | if msg.reply_to_message().is_some() || text.starts_with("/ask ") {
382 | let question = text.strip_prefix("/ask ").unwrap_or(text);
383 |
384 | log::info!("reply to message: {}", msg.id);
385 | let placeholder = self.tg.reply_to_message(msg, "typing...")?;
386 |
387 | log::info!("set to typing, chat id: {}", msg.chat.id);
388 | // ignore callback result
389 | let _ = self.set_typing(msg.chat.id);
390 |
391 | let root = TgBot::get_root_message(msg);
392 | let root_ptr = TgBot::get_message_ptr(root);
393 | let chat_ctx = store_flows::get(&root_ptr)
394 | .and_then(|v| serde_json::from_value(v).ok())
395 | .unwrap_or(TgBotContext {
396 | id: root_ptr,
397 | prompt: TgBotPrompt::Default,
398 | });
399 |
400 | TgBot::set_message_context(&placeholder, &serde_json::to_value(&chat_ctx).unwrap());
401 |
402 | let chat_ptr = chat_ctx.id.as_str();
403 | let chat_ctx_id = format!("ctx--{}", chat_ptr);
404 | log::info!(
405 | "placeholder: {} root: {}, chat_ctx_id: {}, chat_prompt: {}, chat_ctx: {}",
406 | placeholder.id,
407 | root.id,
408 | chat_ctx_id,
409 | chat_ctx.prompt.id(),
410 | store_flows::get(&chat_ctx_id).unwrap_or("None".into())
411 | );
412 |
413 | let mut copt = ChatOptions::default();
414 |
415 | let lm = store_flows::get("settings.language.model")
416 | .unwrap_or(serde_json::Value::String("gpt4".to_string()));
417 |
418 | match lm.as_str() {
419 | Some("gpt4") => copt.model = ChatModel::GPT4,
420 | Some("gpt3.5-turbo") => copt.model = ChatModel::GPT35Turbo,
421 | _ => copt.model = ChatModel::GPT35Turbo16K,
422 | }
423 |
424 | let prompt = chat_ctx.prompt.prompt();
425 | copt.restart = false;
426 | copt.system_prompt = Some(prompt.as_str());
427 |
428 | match self
429 | .openai
430 | .chat_completion(&chat_ctx_id, question, &copt)
431 | .await
432 | {
433 | Ok(resp) => {
434 | self.tg
435 | .edit_message_text_ext(msg.chat.id, placeholder.id, resp.choice, None)
436 | }
437 | Err(_) => self.tg.edit_message_text(
438 | msg.chat.id,
439 | placeholder.id,
440 | "Sorry, an error has occured. Please try again later.",
441 | ),
442 | }
443 | } else {
444 | log::info!("force reply: {}", msg.chat.id);
445 | self.tg.send_message_ext(
446 | msg.chat.id,
447 | None,
448 | "How can I help you?",
449 | Some(tg_flows::ReplyMarkup::ForceReply(ForceReply::new())),
450 | )
451 | }
452 | }
453 |
454 | fn handle_nihongo(&self, msg: &Message, edit: bool) -> anyhow::Result {
455 | let keyboard = tg_flows::InlineKeyboardMarkup::default()
456 | .append_row(vec![
457 | TgBotInlineButton::NihongoTranslate.into(),
458 | TgBotInlineButton::NihongoExplain.into(),
459 | ])
460 | .append_row(vec![TgBotInlineButton::NihongoSceneMock.into()]);
461 |
462 | if edit {
463 | self.tg.edit_message_text_ext(
464 | msg.chat.id,
465 | msg.id,
466 | "どのようにおてつだいでくますか？",
467 | Some(tg_flows::ReplyMarkup::InlineKeyboard(keyboard)),
468 | )
469 | } else {
470 | self.tg.send_message_ext(
471 | msg.chat.id,
472 | Some(&msg.id),
473 | "どのようにおてつだいでくますか？",
474 | Some(tg_flows::ReplyMarkup::InlineKeyboard(keyboard)),
475 | )
476 | }
477 | }
478 |
479 | fn handle_settings(&self, msg: &Message) -> anyhow::Result {
480 | self.tg.send_message_ext(
481 | msg.chat.id,
482 | Some(&msg.id),
483 | "Choose your language model.",
484 | Some(ReplyMarkup::InlineKeyboard(
485 | InlineKeyboardMarkup::default()
486 | .append_row(vec![TgBotInlineButton::SettingsLMGPT35Turbo.into()])
487 | .append_row(vec![TgBotInlineButton::SettingsLMGPT35Turbo16K.into()])
488 | .append_row(vec![TgBotInlineButton::SettingsLMGPT4.into()]),
489 | )),
490 | )
491 | }
492 |
493 | fn handle_callback_query(&self, cq: &CallbackQuery) -> anyhow::Result {
494 | if let Some(ref data) = cq.data {
495 | let button: TgBotInlineButton = data.as_str().try_into()?;
496 | match button {
497 | TgBotInlineButton::NihongoTranslate
498 | | TgBotInlineButton::NihongoExplain
499 | | TgBotInlineButton::NihongoSceneMock => {
500 | self.handle_nihongo_button(cq.message.as_ref().unwrap(), &button)
501 | }
502 | TgBotInlineButton::NihongoSceneMockRestaurant
503 | | TgBotInlineButton::NihongoSceneMockCafe
504 | | TgBotInlineButton::NihongoSceneMockClothesShop
505 | | TgBotInlineButton::NihongoSceneMockStreet
506 | | TgBotInlineButton::NihongoSceneMockSmallTalk
507 | | TgBotInlineButton::NihongoSceneMockGoBack => {
508 | self.handle_nihongo_scene_mock_button(cq.message.as_ref().unwrap(), &button)
509 | }
510 | TgBotInlineButton::SettingsLMGPT35Turbo
511 | | TgBotInlineButton::SettingsLMGPT35Turbo16K
512 | | TgBotInlineButton::SettingsLMGPT4 => {
513 | self.handle_settings_button(cq.message.as_ref().unwrap(), &button)
514 | }
515 | }
516 | } else {
517 | bail!("can't handle callback query without data")
518 | }
519 | }
520 |
521 | fn handle_nihongo_button(
522 | &self,
523 | msg: &Message,
524 | button: &TgBotInlineButton,
525 | ) -> anyhow::Result {
526 | match button {
527 | TgBotInlineButton::NihongoTranslate => self
528 | .tg
529 | .send_message_ext(
530 | msg.chat.id,
531 | Some(&msg.id),
532 | "日本語に翻訳しています",
533 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
534 | )
535 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoTranslate)),
536 | TgBotInlineButton::NihongoExplain => self
537 | .tg
538 | .send_message_ext(
539 | msg.chat.id,
540 | Some(&msg.id),
541 | "日本語の言葉を説明しています",
542 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
543 | )
544 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoExplain)),
545 | TgBotInlineButton::NihongoSceneMock => self.tg.send_message_ext(
546 | msg.chat.id,
547 | Some(&msg.id),
548 | "モック会話しています、何な場面をほしいですか",
549 | Some(ReplyMarkup::InlineKeyboard(
550 | InlineKeyboardMarkup::default()
551 | .append_row(vec![TgBotInlineButton::NihongoSceneMockCafe.into()])
552 | .append_row(vec![TgBotInlineButton::NihongoSceneMockRestaurant.into()])
553 | .append_row(vec![TgBotInlineButton::NihongoSceneMockClothesShop.into()])
554 | .append_row(vec![TgBotInlineButton::NihongoSceneMockStreet.into()])
555 | .append_row(vec![TgBotInlineButton::NihongoSceneMockSmallTalk.into()])
556 | .append_row(vec![TgBotInlineButton::NihongoSceneMockGoBack.into()]),
557 | )),
558 | ),
559 | _ => bail!("wrong button"),
560 | }
561 | }
562 |
563 | fn handle_nihongo_scene_mock_button(
564 | &self,
565 | msg: &Message,
566 | button: &TgBotInlineButton,
567 | ) -> anyhow::Result {
568 | match button {
569 | TgBotInlineButton::NihongoSceneMockCafe => self
570 | .tg
571 | .send_message_ext(
572 | msg.chat.id,
573 | Some(&msg.id),
574 | "カフェでいます",
575 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
576 | )
577 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoSceneMockCafe)),
578 | TgBotInlineButton::NihongoSceneMockRestaurant => self
579 | .tg
580 | .send_message_ext(
581 | msg.chat.id,
582 | Some(&msg.id),
583 | "レストランでいます",
584 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
585 | )
586 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoSceneMockRestaurant)),
587 | TgBotInlineButton::NihongoSceneMockClothesShop => self
588 | .tg
589 | .send_message_ext(
590 | msg.chat.id,
591 | Some(&msg.id),
592 | "服屋でいます",
593 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
594 | )
595 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoSceneMockClothesShop)),
596 | TgBotInlineButton::NihongoSceneMockStreet => self
597 | .tg
598 | .send_message_ext(
599 | msg.chat.id,
600 | Some(&msg.id),
601 | "街でいます",
602 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
603 | )
604 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoSceneMockStreet)),
605 | TgBotInlineButton::NihongoSceneMockSmallTalk => self
606 | .tg
607 | .send_message_ext(
608 | msg.chat.id,
609 | Some(&msg.id),
610 | "雑談しています",
611 | Some(ReplyMarkup::ForceReply(ForceReply::default())),
612 | )
613 | .map(|msg| self.init_message_prompt(msg, TgBotPrompt::NihongoSceneMockSmallTalk)),
614 | TgBotInlineButton::NihongoSceneMockGoBack => self.handle_nihongo(msg, true),
615 | _ => bail!("wrong button"),
616 | }
617 | }
618 |
619 | fn handle_settings_button(
620 | &self,
621 | msg: &Message,
622 | button: &TgBotInlineButton,
623 | ) -> anyhow::Result {
624 | let lm = match button {
625 | TgBotInlineButton::SettingsLMGPT35Turbo => "gpt3.5-turbo",
626 | TgBotInlineButton::SettingsLMGPT35Turbo16K => "gpt3.5-turbo-16k",
627 | TgBotInlineButton::SettingsLMGPT4 => "gpt4",
628 | _ => bail!("wrong button"),
629 | };
630 |
631 | store_flows::set(
632 | "settings.language.model",
633 | serde_json::Value::String(lm.to_string()),
634 | None,
635 | );
636 |
637 | self.tg
638 | .edit_message_text(msg.chat.id, msg.id, format!("Using language model: {}", lm))
639 | }
640 |
641 | fn get_message_ptr(msg: &Message) -> String {
642 | format!("ptr--{}-{}", msg.chat.id, msg.id)
643 | }
644 |
645 | fn get_root_message(msg: &Message) -> &Message {
646 | let mut root = msg;
647 | while root.reply_to_message().is_some() {
648 | root = root.reply_to_message().unwrap();
649 | }
650 | root
651 | }
652 |
653 | fn set_message_context(msg: &Message, ctx: &serde_json::Value) {
654 | let mut root = msg;
655 | loop {
656 | let key = &TgBot::get_message_ptr(root);
657 | log::info!("set context, key: {}, value: {}", key, ctx);
658 | store_flows::set(key, ctx.clone(), None);
659 | if let Some(reply) = root.reply_to_message() {
660 | root = reply;
661 | } else {
662 | return;
663 | }
664 | }
665 | }
666 |
667 | fn init_message_prompt(&self, msg: Message, prompt: TgBotPrompt) -> Message {
668 | let ctx = serde_json::to_value(TgBotContext {
669 | id: Self::get_message_ptr(&msg),
670 | prompt,
671 | })
672 | .unwrap();
673 | Self::set_message_context(&msg, &ctx);
674 | msg
675 | }
676 | }
677 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 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 General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------