├── .gitignore ├── LICENSE ├── README.md ├── app.yaml └── main.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 텔레그램 로봇, 공식 API로 만들기 2 | ==== 3 | 4 | ## About 5 | 6 | 이 프로그램은 제 블로그에 쓴 ["텔레그램 로봇, 공식 API로 만들기"](http://bakyeono.net/post/2015-08-24-using-telegram-bot-api.html) 글에 싣기 위해 만든 프로그램입니다. 해당 글에서 자세한 설명을 보실 수 있습니다. 7 | 8 | 이 프로그램은 [yukuku의 텔레그램 봇 스타터킷](https://github.com/yukuku/telebot)을 포크하여 만든 것입니다. 9 | 10 | This program is a part of my blog article ["Make Telegram robot with official API"(Korean)](http://bakyeono.net/post/2015-08-24-using-telegram-bot-api.html). You can read detailed descriptions in the article. 11 | 12 | This program is a fork of [yukuku's Telegram Bot Starterkit](https://github.com/yukuku/telebot). 13 | 14 | ## Author 15 | 16 | Bak Yeon O (bakyeono@gmail.com | bakyeono.net) 17 | 18 | ## GitHub Repository 19 | 20 | [https://github.com/bakyeono/using-telegram-bot-api](https://github.com/bakyeono/using-telegram-bot-api) 21 | 22 | ## References 23 | 24 | [Telegram Bot Document](https://core.telegram.org/bots) 25 | [Telegram Bot API Document](https://core.telegram.org/bots/api) 26 | [Google App Engine Document](https://cloud.google.com/appengine/docs/developers-console) 27 | 28 | -------------------------------------------------------------------------------- /app.yaml: -------------------------------------------------------------------------------- 1 | application: my-testing-bot 2 | version: 1 3 | runtime: python27 4 | api_version: 1 5 | threadsafe: yes 6 | 7 | handlers: 8 | - url: /set-webhook 9 | login: admin 10 | script: main.app 11 | - url: .* 12 | script: main.app 13 | 14 | libraries: 15 | - name: webapp2 16 | version: 2.5.2 17 | 18 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | #-*- coding: utf-8 -*- 2 | # 3 | # original: https://github.com/yukuku/telebot 4 | # modified by: Bak Yeon O @ http://bakyeono.net 5 | # description: http://bakyeono.net/post/2015-08-24-using-telegram-bot-api.html 6 | # github: https://github.com/bakyeono/using-telegram-bot-api 7 | # 8 | 9 | # 구글 앱 엔진 라이브러리 로드 10 | from google.appengine.api import urlfetch 11 | from google.appengine.ext import ndb 12 | import webapp2 13 | 14 | # URL, JSON, 로그, 정규표현식 관련 라이브러리 로드 15 | import urllib 16 | import urllib2 17 | import json 18 | import logging 19 | import re 20 | 21 | # 봇 토큰, 봇 API 주소 22 | TOKEN = '137007641:AAFVXObeODnKcyDrbcBfEAHzYFGhcFeVlVk' 23 | BASE_URL = 'https://api.telegram.org/bot' + TOKEN + '/' 24 | 25 | # 봇이 응답할 명령어 26 | CMD_START = '/start' 27 | CMD_STOP = '/stop' 28 | CMD_HELP = '/help' 29 | CMD_BROADCAST = '/broadcast' 30 | 31 | # 봇 사용법 & 메시지 32 | USAGE = u"""[사용법] 아래 명령어를 메시지로 보내거나 버튼을 누르시면 됩니다. 33 | /start - (로봇 활성화) 34 | /stop - (로봇 비활성화) 35 | /help - (이 도움말 보여주기) 36 | """ 37 | MSG_START = u'봇을 시작합니다.' 38 | MSG_STOP = u'봇을 정지합니다.' 39 | 40 | # 커스텀 키보드 41 | CUSTOM_KEYBOARD = [ 42 | [CMD_START], 43 | [CMD_STOP], 44 | [CMD_HELP], 45 | ] 46 | 47 | # 채팅별 로봇 활성화 상태 48 | # 구글 앱 엔진의 Datastore(NDB)에 상태를 저장하고 읽음 49 | # 사용자가 /start 누르면 활성화 50 | # 사용자가 /stop 누르면 비활성화 51 | class EnableStatus(ndb.Model): 52 | enabled = ndb.BooleanProperty(required=True, indexed=True, default=False,) 53 | 54 | def set_enabled(chat_id, enabled): 55 | u"""set_enabled: 봇 활성화/비활성화 상태 변경 56 | chat_id: (integer) 봇을 활성화/비활성화할 채팅 ID 57 | enabled: (boolean) 지정할 활성화/비활성화 상태 58 | """ 59 | es = EnableStatus.get_or_insert(str(chat_id)) 60 | es.enabled = enabled 61 | es.put() 62 | 63 | def get_enabled(chat_id): 64 | u"""get_enabled: 봇 활성화/비활성화 상태 반환 65 | return: (boolean) 66 | """ 67 | es = EnableStatus.get_by_id(str(chat_id)) 68 | if es: 69 | return es.enabled 70 | return False 71 | 72 | def get_enabled_chats(): 73 | u"""get_enabled: 봇이 활성화된 채팅 리스트 반환 74 | return: (list of EnableStatus) 75 | """ 76 | query = EnableStatus.query(EnableStatus.enabled == True) 77 | return query.fetch() 78 | 79 | # 메시지 발송 관련 함수들 80 | def send_msg(chat_id, text, reply_to=None, no_preview=True, keyboard=None): 81 | u"""send_msg: 메시지 발송 82 | chat_id: (integer) 메시지를 보낼 채팅 ID 83 | text: (string) 메시지 내용 84 | reply_to: (integer) ~메시지에 대한 답장 85 | no_preview: (boolean) URL 자동 링크(미리보기) 끄기 86 | keyboard: (list) 커스텀 키보드 지정 87 | """ 88 | params = { 89 | 'chat_id': str(chat_id), 90 | 'text': text.encode('utf-8'), 91 | } 92 | if reply_to: 93 | params['reply_to_message_id'] = reply_to 94 | if no_preview: 95 | params['disable_web_page_preview'] = no_preview 96 | if keyboard: 97 | reply_markup = json.dumps({ 98 | 'keyboard': keyboard, 99 | 'resize_keyboard': True, 100 | 'one_time_keyboard': False, 101 | 'selective': (reply_to == True), 102 | }) 103 | params['reply_markup'] = reply_markup 104 | try: 105 | urllib2.urlopen(BASE_URL + 'sendMessage', urllib.urlencode(params)).read() 106 | except Exception as e: 107 | logging.exception(e) 108 | 109 | def broadcast(text): 110 | u"""broadcast: 봇이 켜져 있는 모든 채팅에 메시지 발송 111 | text: (string) 메시지 내용 112 | """ 113 | for chat in get_enabled_chats(): 114 | send_msg(chat.key.string_id(), text) 115 | 116 | # 봇 명령 처리 함수들 117 | def cmd_start(chat_id): 118 | u"""cmd_start: 봇을 활성화하고, 활성화 메시지 발송 119 | chat_id: (integer) 채팅 ID 120 | """ 121 | set_enabled(chat_id, True) 122 | send_msg(chat_id, MSG_START, keyboard=CUSTOM_KEYBOARD) 123 | 124 | def cmd_stop(chat_id): 125 | u"""cmd_stop: 봇을 비활성화하고, 비활성화 메시지 발송 126 | chat_id: (integer) 채팅 ID 127 | """ 128 | set_enabled(chat_id, False) 129 | send_msg(chat_id, MSG_STOP) 130 | 131 | def cmd_help(chat_id): 132 | u"""cmd_help: 봇 사용법 메시지 발송 133 | chat_id: (integer) 채팅 ID 134 | """ 135 | send_msg(chat_id, USAGE, keyboard=CUSTOM_KEYBOARD) 136 | 137 | def cmd_broadcast(chat_id, text): 138 | u"""cmd_broadcast: 봇이 활성화된 모든 채팅에 메시지 방송 139 | chat_id: (integer) 채팅 ID 140 | text: (string) 방송할 메시지 141 | """ 142 | send_msg(chat_id, u'메시지를 방송합니다.', keyboard=CUSTOM_KEYBOARD) 143 | broadcast(text) 144 | 145 | def cmd_echo(chat_id, text, reply_to): 146 | u"""cmd_echo: 사용자의 메시지를 따라서 답장 147 | chat_id: (integer) 채팅 ID 148 | text: (string) 사용자가 보낸 메시지 내용 149 | reply_to: (integer) 답장할 메시지 ID 150 | """ 151 | send_msg(chat_id, text, reply_to=reply_to) 152 | 153 | def process_cmds(msg): 154 | u"""사용자 메시지를 분석해 봇 명령을 처리 155 | chat_id: (integer) 채팅 ID 156 | text: (string) 사용자가 보낸 메시지 내용 157 | """ 158 | msg_id = msg['message_id'] 159 | chat_id = msg['chat']['id'] 160 | text = msg.get('text') 161 | if (not text): 162 | return 163 | if CMD_START == text: 164 | cmd_start(chat_id) 165 | return 166 | if (not get_enabled(chat_id)): 167 | return 168 | if CMD_STOP == text: 169 | cmd_stop(chat_id) 170 | return 171 | if CMD_HELP == text: 172 | cmd_help(chat_id) 173 | return 174 | cmd_broadcast_match = re.match('^' + CMD_BROADCAST + ' (.*)', text) 175 | if cmd_broadcast_match: 176 | cmd_broadcast(chat_id, cmd_broadcast_match.group(1)) 177 | return 178 | cmd_echo(chat_id, text, reply_to=msg_id) 179 | return 180 | 181 | # 웹 요청에 대한 핸들러 정의 182 | # /me 요청시 183 | class MeHandler(webapp2.RequestHandler): 184 | def get(self): 185 | urlfetch.set_default_fetch_deadline(60) 186 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'getMe')))) 187 | 188 | # /updates 요청시 189 | class GetUpdatesHandler(webapp2.RequestHandler): 190 | def get(self): 191 | urlfetch.set_default_fetch_deadline(60) 192 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'getUpdates')))) 193 | 194 | # /set-wehook 요청시 195 | class SetWebhookHandler(webapp2.RequestHandler): 196 | def get(self): 197 | urlfetch.set_default_fetch_deadline(60) 198 | url = self.request.get('url') 199 | if url: 200 | self.response.write(json.dumps(json.load(urllib2.urlopen(BASE_URL + 'setWebhook', urllib.urlencode({'url': url}))))) 201 | 202 | # /webhook 요청시 (텔레그램 봇 API) 203 | class WebhookHandler(webapp2.RequestHandler): 204 | def post(self): 205 | urlfetch.set_default_fetch_deadline(60) 206 | body = json.loads(self.request.body) 207 | self.response.write(json.dumps(body)) 208 | process_cmds(body['message']) 209 | 210 | # 구글 앱 엔진에 웹 요청 핸들러 지정 211 | app = webapp2.WSGIApplication([ 212 | ('/me', MeHandler), 213 | ('/updates', GetUpdatesHandler), 214 | ('/set-webhook', SetWebhookHandler), 215 | ('/webhook', WebhookHandler), 216 | ], debug=True) 217 | 218 | --------------------------------------------------------------------------------