onionshare/desktop/onionshare/threads.py
2022-01-16 16:15:49 -08:00

271 lines
9.1 KiB
Python

# -*- coding: utf-8 -*-
"""
OnionShare | https://onionshare.org/
Copyright (C) 2014-2022 Micah Lee, et al. <micah@micahflee.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
import time
import json
import os
from PySide2 import QtCore
from onionshare_cli.onion import (
TorErrorInvalidSetting,
TorErrorAutomatic,
TorErrorSocketPort,
TorErrorSocketFile,
TorErrorMissingPassword,
TorErrorUnreadableCookieFile,
TorErrorAuthError,
TorErrorProtocolError,
BundledTorTimeout,
BundledTorBroken,
TorTooOldEphemeral,
TorTooOldStealth,
PortNotAvailable,
)
from . import strings
class OnionThread(QtCore.QThread):
"""
Starts the onion service, and waits for it to finish
"""
success = QtCore.Signal()
success_early = QtCore.Signal()
error = QtCore.Signal(str)
def __init__(self, mode):
super(OnionThread, self).__init__()
self.mode = mode
self.mode.common.log("OnionThread", "__init__")
# allow this thread to be terminated
self.setTerminationEnabled()
def run(self):
self.mode.common.log("OnionThread", "run")
# Make a new static URL path for each new share
self.mode.web.generate_static_url_path()
# Choose port early, because we need them to exist in advance for scheduled shares
if not self.mode.app.port:
self.mode.app.choose_port()
try:
if self.mode.obtain_onion_early:
self.mode.app.start_onion_service(
self.mode.get_type(), self.mode.settings, await_publication=False
)
# wait for modules in thread to load, preventing a thread-related cx_Freeze crash
time.sleep(0.2)
self.success_early.emit()
# Unregister the onion so we can use it in the next OnionThread
self.mode.app.stop_onion_service(self.mode.settings)
else:
self.mode.app.start_onion_service(
self.mode.get_type(), self.mode.settings, await_publication=True
)
# wait for modules in thread to load, preventing a thread-related cx_Freeze crash
time.sleep(0.2)
# start onionshare http service in new thread
self.mode.web_thread = WebThread(self.mode)
self.mode.web_thread.start()
self.success.emit()
except (
TorErrorInvalidSetting,
TorErrorAutomatic,
TorErrorSocketPort,
TorErrorSocketFile,
TorErrorMissingPassword,
TorErrorUnreadableCookieFile,
TorErrorAuthError,
TorErrorProtocolError,
BundledTorTimeout,
BundledTorBroken,
TorTooOldEphemeral,
TorTooOldStealth,
PortNotAvailable,
) as e:
message = self.mode.common.gui.get_translated_tor_error(e)
self.error.emit(message)
return
class WebThread(QtCore.QThread):
"""
Starts the web service
"""
success = QtCore.Signal()
error = QtCore.Signal(str)
def __init__(self, mode):
super(WebThread, self).__init__()
self.mode = mode
self.mode.common.log("WebThread", "__init__")
def run(self):
self.mode.common.log("WebThread", "run")
self.mode.web.start(self.mode.app.port)
self.success.emit()
class AutoStartTimer(QtCore.QThread):
"""
Waits for a prescribed time before allowing a share to start
"""
success = QtCore.Signal()
error = QtCore.Signal(str)
def __init__(self, mode, canceled=False):
super(AutoStartTimer, self).__init__()
self.mode = mode
self.canceled = canceled
self.mode.common.log("AutoStartTimer", "__init__")
# allow this thread to be terminated
self.setTerminationEnabled()
def run(self):
now = QtCore.QDateTime.currentDateTime()
autostart_timer_datetime_delta = now.secsTo(
self.mode.server_status.autostart_timer_datetime
)
try:
# Sleep until scheduled time
while autostart_timer_datetime_delta > 0 and self.canceled is False:
time.sleep(0.1)
now = QtCore.QDateTime.currentDateTime()
autostart_timer_datetime_delta = now.secsTo(
self.mode.server_status.autostart_timer_datetime
)
# Timer has now finished
if self.canceled is False:
self.mode.server_status.server_button.setText(
strings._("gui_please_wait")
)
self.mode.server_status_label.setText(
strings._("gui_status_indicator_share_working")
)
self.success.emit()
except ValueError as e:
self.error.emit(e.args[0])
return
class EventHandlerThread(QtCore.QThread):
"""
To trigger an event, write a JSON line to the events file. When that file changes,
each line will be handled as an event. Valid events are:
{"type": "new_tab"}
{"type": "new_share_tab", "filenames": ["file1", "file2"]}
"""
new_tab = QtCore.Signal()
new_share_tab = QtCore.Signal(list)
def __init__(self, common):
super(EventHandlerThread, self).__init__()
self.common = common
self.common.log("EventHandlerThread", "__init__")
self.should_quit = False
def run(self):
self.common.log("EventHandlerThread", "run")
mtime = 0
while True:
if os.path.exists(self.common.gui.events_filename):
# Events file exists
if os.stat(self.common.gui.events_filename).st_mtime != mtime:
# Events file has been modified, load events
try:
with open(self.common.gui.events_filename, "r") as f:
lines = f.readlines()
os.remove(self.common.gui.events_filename)
self.common.log(
"EventHandler", "run", f"processing {len(lines)} lines"
)
for line in lines:
try:
obj = json.loads(line)
if "type" not in obj:
self.common.log(
"EventHandler",
"run",
f"event does not have a type: {obj}",
)
continue
except json.decoder.JSONDecodeError:
self.common.log(
"EventHandler",
"run",
f"ignoring invalid line: {line}",
)
continue
if obj["type"] == "new_tab":
self.common.log("EventHandler", "run", "new_tab event")
self.new_tab.emit()
elif obj["type"] == "new_share_tab":
if (
"filenames" in obj
and type(obj["filenames"]) is list
):
self.new_share_tab.emit(obj["filenames"])
else:
self.common.log(
"EventHandler",
"run",
f"invalid new_share_tab event: {obj}",
)
else:
self.common.log(
"EventHandler", "run", f"invalid event type: {obj}"
)
except Exception:
pass
if self.should_quit:
break
time.sleep(0.2)
class OnionCleanupThread(QtCore.QThread):
"""
Wait for Tor rendezvous circuits to close in a separate thread
"""
def __init__(self, common):
super(OnionCleanupThread, self).__init__()
self.common = common
self.common.log("OnionCleanupThread", "__init__")
def run(self):
self.common.log("OnionCleanupThread", "run")
self.common.gui.onion.cleanup()