Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implements a Proxy Integration #217

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Implements a Proxy Integration #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
856c8d8
Added proxy support
jesstr Nov 4, 2019
fd3428a
Added plugin requirements
jesstr Nov 4, 2019
53b6d16
README.md updated: added proxy setup section
Nov 11, 2019
99f78e5
README.md updated: typo fixed.
Nov 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,20 @@ Congratulations! Your printer is now connected to your Telegram bot.

5. Now reopen octoprit settings and check/set the configurations for new users. (see [below](#users))

### Proxy setup

You can use HTTP or SOCKS5 proxies with this plugin. In *config.yaml* file under the `telegram:` section add the following lines (NOTE: use your own `user`, `pass`, proxy url and port):

Example 1: if you are using HTTP proxy:

'http_proxy: http://user:[email protected]:3128'
'https_proxy: http://user:[email protected]:3128'

Example 2: if you are using SOCKS5 proxy:

'http_proxy: socks5://user:[email protected]:3128'
'https_proxy: socks5://user:[email protected]:3128'

## Configuration

Configuration is done via the Octoprint settings dialog. Note that only admin users will be able to change user or token settings.
Expand Down
73 changes: 44 additions & 29 deletions octoprint_telegram/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def handleDocumentMessage(self, message, chat_id, from_id):
target_filename = "telegram_"+file_name
# for parameter no_markup see _send_edit_msg()
self.main.send_msg(self.gEmo('save') + gettext(" Saving file {}...".format(target_filename)), chatID=chat_id)
requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'})
requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'}, proxies=self.getProxies())
data = self.main.get_file(message['message']['document']['file_id'])
#giloser 09/05/2019 try to zip the gcode file to lower the size
if isZipFile:
Expand Down Expand Up @@ -353,7 +353,7 @@ def getUpdates(self):
if self.update_offset == 0 and self.first_contact:
res = ["0","0"]
while len(res) > 0:
req = requests.get(self.main.bot_url + "/getUpdates", params={'offset':self.update_offset, 'timeout':0}, allow_redirects=False, timeout=10)
req = requests.get(self.main.bot_url + "/getUpdates", params={'offset':self.update_offset, 'timeout':0}, allow_redirects=False, timeout=10, proxies=self.getProxies())
json = req.json()
if not json['ok']:
self.set_status(gettext("Response didn't include 'ok:true'. Waiting 2 minutes before trying again. Response was: %(response)s", json))
Expand All @@ -367,7 +367,7 @@ def getUpdates(self):
if self.update_offset == 0:
self.set_update_offset(0)
else:
req = requests.get(self.main.bot_url + "/getUpdates", params={'offset':self.update_offset, 'timeout':30}, allow_redirects=False, timeout=40)
req = requests.get(self.main.bot_url + "/getUpdates", params={'offset':self.update_offset, 'timeout':30}, allow_redirects=False, timeout=40, proxies=self.getProxies())
except requests.exceptions.Timeout:
# Just start the next loop.
raise ExitThisLoopException()
Expand Down Expand Up @@ -409,6 +409,13 @@ def set_status(self, status, ok=False):
self.connection_ok = ok
self.main.connection_state_str = status

def getProxies(self):
http_proxy = self.main._settings.get(["http_proxy"])
https_proxy = self.main._settings.get(["https_proxy"])
return {
'http': http_proxy,
'https': https_proxy
}

class TelegramPluginLoggingFilter(logging.Filter):
def filter(self, record):
Expand Down Expand Up @@ -710,7 +717,7 @@ def on_settings_migrate(self, target, current=None):
message['text'] = "The OctoPrint Plugin " + self._plugin_name + " has been updated to new Version "+self._plugin_version+ ".\n\nPlease open your " + self._plugin_name + " settings in OctoPrint and set configurations for this chat. Until then you are not able to send or receive anything useful with this Bot.\n\nMore informations on: https://github.com/fabianonline/OctoPrint-Telegram"
message['chat_id'] = chat
message['disable_web_page_preview'] = True
r = requests.post("https://api.telegram.org/bot" + self._settings.get(['token']) + "/sendMessage", data = message)
r = requests.post("https://api.telegram.org/bot" + self._settings.get(['token']) + "/sendMessage", data = message, proxies=self.getProxies())
r.raise_for_status()
if r.headers['content-type'] != 'application/json':
raise Exception("invalid content-type")
Expand Down Expand Up @@ -1065,7 +1072,7 @@ def _send_edit_msg(self,message="",msg_id="",chatID="", responses= None, inline=
keyboard = {'inline_keyboard':myArr}
data['reply_markup'] = json.dumps(keyboard)
self._logger.debug("SENDING UPDATE: " + str(data))
req = requests.post(self.bot_url + "/editMessageText", data=data)
req = requests.post(self.bot_url + "/editMessageText", data=data, proxies=self.getProxies())
if req.headers['content-type'] != 'application/json':
self._logger.debug(gettext("Unexpected Content-Type. Expected: application/json. Was: %(type)s. Waiting 2 minutes before trying again.", type=req.headers['content-type']))
return
Expand Down Expand Up @@ -1131,12 +1138,12 @@ def _send_msg(self, message="", with_image=False,with_gif=False,responses=None,
files = {'photo':("image.jpg", image_data)}
if message is not "":
data['caption'] = message
r = requests.post(self.bot_url + "/sendPhoto", files=files, data=data)
r = requests.post(self.bot_url + "/sendPhoto", files=files, data=data, proxies=self.getProxies())
self._logger.debug("Sending finished. " + str(r.status_code))
else:
self._logger.debug("Sending without image.. " + str(chatID))
data['text'] = message
r =requests.post(self.bot_url + "/sendMessage", data=data)
r =requests.post(self.bot_url + "/sendMessage", data=data, proxies=self.getProxies())
self._logger.debug("Sending finished. " + str(r.status_code))

if r is not None and inline:
Expand All @@ -1150,7 +1157,7 @@ def _send_msg(self, message="", with_image=False,with_gif=False,responses=None,
if with_gif : #giloser 05/05/19
try:
self._logger.info("Will try to create a gif ")
#requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'})
#requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'}, proxies=self.getProxies())
ret = self.create_gif_new(chatID,0)
if ret != "":
self.send_file(chatID, ret)
Expand All @@ -1166,25 +1173,25 @@ def send_file(self,chat_id,path):
return

try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'}, proxies=self.getProxies())
files = {'document': open(path, 'rb')}
r = requests.post(self.bot_url + "/sendDocument", files=files, data={'chat_id':chat_id})
r = requests.post(self.bot_url + "/sendDocument", files=files, data={'chat_id':chat_id}, proxies=self.getProxies())
except Exception as ex:
pass

def send_editMessageMedia(self,chat_id,path,message_id):
if not self.send_messages:
return
try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'}, proxies=self.getProxies())
files = {'document': open(path, 'rb')}
r = requests.post(self.bot_url + "/editMessageMedia", files=files, data={'chat_id':chat_id,'message_id':message_id})
r = requests.post(self.bot_url + "/editMessageMedia", files=files, data={'chat_id':chat_id,'message_id':message_id}, proxies=self.getProxies())
except Exception as ex:
pass

def delete_msg(self,chat_id,message_id):
try:
r = requests.post(self.bot_url + "/deleteMessage", data={'chat_id':chat_id,'message_id':message_id})
r = requests.post(self.bot_url + "/deleteMessage", data={'chat_id':chat_id,'message_id':message_id}, proxies=self.getProxies())
except Exception as ex:
pass

Expand All @@ -1193,23 +1200,23 @@ def send_video(self, message, video_file):
return

files = {'video': open(video_file, 'rb')}
#r = requests.post(self.bot_url + "/sendVideo", files=files, data={'chat_id':self._settings.get(["chat"]), 'caption':message})
#r = requests.post(self.bot_url + "/sendVideo", files=files, data={'chat_id':self._settings.get(["chat"]), 'caption':message}, proxies=self.getProxies())
self._logger.debug("Sending finished. " + str(r.status_code) + " " + str(r.content))

def get_file(self, file_id):
if not self.send_messages:
return

self._logger.debug("Requesting file with id %s.", file_id)
r = requests.get(self.bot_url + "/getFile", data={'file_id': file_id})
r = requests.get(self.bot_url + "/getFile", data={'file_id': file_id}, proxies=self.getProxies())
# {"ok":true,"result":{"file_id":"BQADAgADCgADrWJxCW_eFdzxDPpQAg","file_size":26,"file_path":"document\/file_3.gcode"}}
r.raise_for_status()
data = r.json()
if not "ok" in data:
raise Exception(_("Telegram didn't respond well to getFile. The response was: %(response)s", response=r.text))
url = self.bot_file_url + "/" + data['result']['file_path']
self._logger.debug("Downloading file: %s", url)
r = requests.get(url)
r = requests.get(url, proxies=self.getProxies())
r.raise_for_status()
return r.content

Expand All @@ -1224,7 +1231,7 @@ def get_usrPic(self,chat_id, file_id=""):
self._logger.debug("Not able to load group photos. "+ str(chat_id)+" EXIT")
return
self._logger.debug("requests.get("+self.bot_url + "/getUserProfilePhotos")
r = requests.get(self.bot_url + "/getUserProfilePhotos", params = {'limit': 1, "user_id": chat_id})
r = requests.get(self.bot_url + "/getUserProfilePhotos", params = {'limit': 1, "user_id": chat_id}, proxies=self.getProxies())
r.raise_for_status()
data = r.json()
if not "ok" in data:
Expand All @@ -1250,7 +1257,7 @@ def test_token(self, token=None):

if token is None:
token = self._settings.get(["token"])
response = requests.get("https://api.telegram.org/bot" + token + "/getMe")
response = requests.get("https://api.telegram.org/bot" + token + "/getMe", proxies=self.getProxies())
self._logger.debug("getMe returned: " + str(response.json()))
self._logger.debug("getMe status code: " + str(response.status_code))
json = response.json()
Expand All @@ -1272,6 +1279,14 @@ def str2bool(self,v):
def set_log_level(self):
self._logger.setLevel(logging.DEBUG if self._settings.get_boolean(["debug"]) else logging.NOTSET)

def getProxies(self):
http_proxy = self._settings.get(["http_proxy"])
https_proxy = self._settings.get(["https_proxy"])
return {
'http': http_proxy,
'https': https_proxy
}

# checks if the received command is allowed to execute by the user
def isCommandAllowed(self, chat_id, from_id, command):
if 'bind_none' in self.tcmd.commandDict[command]:
Expand Down Expand Up @@ -1356,7 +1371,7 @@ def create_gif_new(self,chatID,sec=7):
ret = ""

try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
# saveDir = os.getcwd()
# os.chdir(self.get_plugin_data_folder()+"/tmpgif")
outPath = self.get_plugin_data_folder()+"/tmpgif/gif.mp4"
Expand All @@ -1383,7 +1398,7 @@ def create_gif_new(self,chatID,sec=7):
self.send_msg(self.gEmo('dizzy face') + " Problem creating gif, please check log file, and make sure you have installed ffmpeg with following command : `sudo apt-get install ffmpeg`",chatID=chatID)
return ""

requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
os.nice(20) # force this to use less CPU


Expand Down Expand Up @@ -1438,17 +1453,17 @@ def create_gif_new(self,chatID,sec=7):
params.append( outPath)

self._logger.info("will now create the video " + str(params).strip('[]') )
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())

myproc = Popen(params, shell=False, stdout=PIPE, stderr=PIPE)
while True:
if myproc.poll() is not None:
break
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
time.sleep(0.5)

self._logger.info("Finish the video")
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
ret = outPath
except Exception as ex:
self._logger.info("Caught an exception trying create gif general error : " + str(ex))
Expand Down Expand Up @@ -1481,8 +1496,8 @@ def create_gif(self,chatID,nbImg = 0): #giloser 05/05/2019
wait_b_img = self._settings.get(["delay_img_gif"])

frame = self._settings.get(["frame_img_gif"]) #10
#requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
#requests.get(self.main.bot_url + "/sendChatAction", params = {'chat_id': chat_id, 'action': 'upload_document'}, proxies=self.getProxies())
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
os.nice(20) # force this to use less CPU
soft, hard = resource.getrlimit(resource.RLIMIT_CPU)
self._logger.info("RLIMIT_CPU soft " + str(soft) + " | hard "+ str(hard))
Expand Down Expand Up @@ -1510,7 +1525,7 @@ def create_gif(self,chatID,nbImg = 0): #giloser 05/05/2019
self._logger.info("image number " + str(i) + " of "+ str(nbImg))
data = self.take_image()
try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
#self._file_manager.add_file(self.get_plugin_data_folder() + "/tmpgif",'Test_Telegram_%02d.jpg' % i,data,allow_overwrite=True)
image = Image.open(StringIO.StringIO(data))
image.thumbnail((320, 240))
Expand Down Expand Up @@ -1543,20 +1558,20 @@ def create_gif(self,chatID,nbImg = 0): #giloser 05/05/2019
#params.append( self.get_plugin_data_folder() + '/tmpgif/gif.mp4')

#self._logger.info("finish the image will now create the video " + str(params).strip('[]') )# 'nice -n 20 cpulimit -l 50 -f -z -- ffmpeg -r 10 -y -i' +self.get_plugin_data_folder() + '/tmpgif/Gif_Telegram_%2d.jpg -crf 20 -g 15 ' +scale_opt+ ' ' +scale + ' ' + self.get_plugin_data_folder() + '/tmpgif/gif.mp4')
#requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
#requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
#subprocess.check_call(params)
# subprocess.check_call(['nice','-n','20','cpulimit','-l','50','-f','-z','--','ffmpeg', '-r', '10', '-y', '-i' ,self.get_plugin_data_folder() + '/tmpgif/Gif_Telegram_%2d.jpg', '-crf', '20', '-g' ,'15', self.get_plugin_data_folder() + '/tmpgif/gif.mp4'])
#self._logger.info("video created ")

except Exception as ex:
self._logger.info("Caught an exception trying create mp4 with ffmpeg : " + str(ex))
try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
subprocess.check_call(['nice','-n','20','cpulimit','-l','50','-f','-z','--','avconv', '-r', '10', '-y', '-i' ,self.get_plugin_data_folder() + '/tmpgif/Gif_Telegram_%2d.jpg', '-crf', '20', '-g' ,'15',scale_opt,scale, self.get_plugin_data_folder() + '/tmpgif/gif.mp4'])
except Exception as ex:
self._logger.info("Caught an exception trying create mp4 with ffmpeg : " + str(ex))
try:
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'})
requests.get(self.bot_url + "/sendChatAction", params = {'chat_id': chatID, 'action': 'record_video'}, proxies=self.getProxies())
subprocess.call(['nice','-n','20','cpulimit','-l','50','-f','-z','--','ffmpeg','-r 10','-y','-i',scale_opt,scale,self.get_plugin_data_folder() + '/tmpgif/Gif_Telegram_%02d.jpg',self.get_plugin_data_folder() + '/tmpgif/gif.mp4'])
except Exception as ex:
self._logger.info("Caught an exception trying create mp4 2 : " + str(ex))
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
plugin_license = "AGPLv3"

# Any additional requirements besides OctoPrint should be listed here
plugin_requires = ["pillow"]
plugin_requires = ["pillow", "requests[socks]"]

### --------------------------------------------------------------------------------------------------------------------
### More advanced options that you usually shouldn't have to touch follow after this point
Expand Down