1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
|
# -*- coding: utf-8 -*-
import atexit
import errno
import glob
import logging
import os
import platform
import socket
import subprocess as sp
import threading
import sys
from time import sleep
# Python version check
from DisplayCAL.meta import py_maxversion, py_minversion
pyver = sys.version_info[:2]
if pyver < py_minversion or pyver > py_maxversion:
raise RuntimeError(
"Need Python version >= %s <= %s, got %s"
% (
".".join(str(n) for n in py_minversion),
".".join(str(n) for n in py_maxversion),
sys.version.split()[0],
)
)
from DisplayCAL.config import (
appbasename,
autostart_home,
confighome,
datahome,
enc,
exe,
exe_ext,
exedir,
exename,
fs_enc,
get_data_path,
getcfg,
initcfg,
isapp,
isexe,
logdir,
pydir,
pyname,
pypath,
resfiles,
runtype,
)
from DisplayCAL.debughelpers import ResourceError, handle_error
from DisplayCAL.log import log
from DisplayCAL.meta import (
VERSION,
VERSION_BASE,
VERSION_STRING,
build,
name as appname,
)
from DisplayCAL.multiprocess import mp
from DisplayCAL.options import debug, verbose
from DisplayCAL.util_os import FileLock, LockingError, UnlockingError
import distro
if sys.platform == "win32":
from DisplayCAL.util_win import win_ver
import ctypes
elif sys.platform == "darwin":
from platform import mac_ver
import posix
def _excepthook(etype, value, tb):
handle_error((etype, value, tb))
sys.excepthook = _excepthook
def _main(module, name, app_lock_file_name, probe_ports=True):
# Allow multiple instances only for curve viewer, profile info,
# scripting client, synthetic profile creator and testchart editor
multi_instance = (
"curve-viewer",
"profile-info",
"scripting-client",
"synthprofile",
"testchart-editor",
)
lock = AppLock(app_lock_file_name, "a+", False, module in multi_instance)
if not lock:
# If a race condition occurs, do not start another instance
print("Not starting another instance.")
return
else:
print(f"Acquired lock file: {lock}")
log("=" * 80)
if verbose >= 1:
version = VERSION_STRING
if VERSION > VERSION_BASE:
version += " Beta"
print(pyname + runtype, version, build)
if sys.platform == "darwin":
# Python's platform.platform output is useless under Mac OS X
# (e.g. 'Darwin-15.0.0-x86_64-i386-64bit' for Mac OS X 10.11 El Capitan)
print(f"Mac OS X {mac_ver()[0]} {mac_ver()[-1]}")
elif sys.platform == "win32":
machine = platform.machine()
print(
*[v for v in win_ver() if v]
+ [
{"AMD64": "x86_64"}.get(machine, machine),
]
)
else:
# Linux
print(
" ".join([distro.id(), distro.version(), distro.codename()]),
platform.machine(),
)
print(f"Python {sys.version}")
cafile = os.getenv("SSL_CERT_FILE")
if cafile:
print("CA file", cafile)
# Enable faulthandler
try:
import faulthandler
except Exception as exception:
print(exception)
else:
try:
faulthandler.enable(open(os.path.join(logdir, pyname + "-fault.log"), "w"))
except Exception as exception:
print(exception)
else:
print("Faulthandler", getattr(faulthandler, "__version__", ""))
from DisplayCAL.wxaddons import wx
if "phoenix" in wx.PlatformInfo:
# py2exe helper so wx.xml gets picked up
from wx import xml
print(f"wxPython {wx.version()}")
print(f"Encoding: {enc}")
print(f"File system encoding: {fs_enc}")
if sys.platform == "win32" and sys.getwindowsversion() >= (6, 2):
# HighDPI support
try:
shcore = ctypes.windll.shcore
except Exception as exception:
print("Warning - could not load shcore:", exception)
else:
if hasattr(shcore, "SetProcessDpiAwareness"):
try:
# 1 = System DPI aware (wxWpython currently does not
# support per-monitor DPI)
shcore.SetProcessDpiAwareness(1)
except Exception as exception:
print("Warning - SetProcessDpiAwareness() failed:", exception)
else:
print("Warning - SetProcessDpiAwareness not found in shcore")
initcfg(module)
host = "127.0.0.1"
defaultport = getcfg("app.port")
lock2pids_ports = {}
opid = os.getpid()
if probe_ports:
# Check for currently used ports
lockfilenames = glob.glob(os.path.join(confighome, "*.lock"))
for lockfilename in lockfilenames:
try:
if lock and lockfilename == app_lock_file_name:
lockfile = lock
lock.seek(0)
else:
lockfile = AppLock(lockfilename, "r", False, True)
if lockfile:
if lockfilename not in lock2pids_ports:
lock2pids_ports[lockfilename] = []
for ln, line in enumerate(lockfile.read().splitlines(), 1):
if ":" in line:
# DisplayCAL >= 3.8.8.2 with localhost blocked
pid, port = line.split(":", 1)
if pid:
try:
pid = int(pid)
except ValueError:
# This shouldn't happen
print(
"Warning - couldn't parse PID as int: %r (%s line %i)"
% (pid, lockfilename, ln)
)
pid = None
else:
print("Existing client using PID", pid)
else:
# DisplayCAL <= 3.8.8.1 or localhost ok
pid = None
port = line
if port:
try:
port = int(port)
except ValueError:
# This shouldn't happen
print(
"Warning - couldn't parse port as int: %r (%s line %i)"
% (port, lockfilename, ln)
)
port = None
else:
print("Existing client using port", port)
if pid or port:
lock2pids_ports[lockfilename].append((pid, port))
if not lock or lockfilename != app_lock_file_name:
lockfile.unlock()
except EnvironmentError as exception:
# This shouldn't happen
print(f"Warning - could not read lockfile {lockfilename}:", exception)
if module not in multi_instance:
# Check lockfile(s) and probe port(s)
for lockfilename in [app_lock_file_name]:
incoming = None
pids_ports = lock2pids_ports.get(lockfilename)
if pids_ports:
pid, port = pids_ports[0]
appsocket = AppSocket()
if appsocket and port:
print(f"Connecting to {port}...")
if appsocket.connect(host, port):
print("Connected to", port)
# Other instance already running?
# Get appname to check if expected app is actually
# running under that port
print("Getting instance name")
if appsocket.send("getappname"):
print("Sent scripting request, awaiting response...")
data_read = appsocket.read()
incoming = data_read.rstrip("\4")
print("Got response: %r" % incoming)
if incoming:
if incoming != pyname:
incoming = None
else:
incoming = False
while incoming:
# Send args as UTF-8
if module == "apply-profiles":
# Always try to close currently running instance
print("Closing existing instance")
cmd = "exit" if incoming == pyname else "close"
data = [cmd]
lock.unlock()
else:
# Send module/appname to notify running app
print("Notifying existing instance")
data = [module or appname]
if module != "3DLUT-maker":
for arg in sys.argv[1:]:
data.append(str(arg))
data = sp.list2cmdline(data)
if appsocket.send(data):
print("Sent scripting request, awaiting response...")
data_read = appsocket.read()
incoming = data_read.rstrip("\4")
print(f"Got response: {repr(incoming)}")
if module == "apply-profiles":
if incoming == "":
# Successfully sent our close request.
incoming = "ok"
elif incoming == "invalid" and cmd == "exit":
# < 3.8.8.1 didn't have exit command
continue
break
appsocket.close()
else:
pid = None
if not incoming:
if sys.platform == "win32":
import pywintypes
import win32ts
try:
osid = win32ts.ProcessIdToSessionId(opid)
except pywintypes.error as exception:
print("Enumerating processes failed:", exception)
osid = None
try:
processes = win32ts.WTSEnumerateProcesses()
except pywintypes.error as exception:
print("Enumerating processes failed:", exception)
else:
appname_lower = appname.lower()
exename_lower = exename.lower()
if module:
pyexe_lower = appname_lower + "-" + module + exe_ext
else:
pyexe_lower = appname_lower + exe_ext
incoming = None
for sid, pid2, basename, usid in processes:
basename_lower = basename.lower()
if (
(
pid
and pid2 == pid
and basename_lower == exename_lower
)
or (
(osid is None or sid == osid)
and basename_lower == pyexe_lower
)
) and pid2 != opid:
# Other instance running
incoming = False
if module == "apply-profiles":
if not os.path.isfile(lockfilename):
# Create dummy lockfile
try:
with open(lockfilename, "w"):
pass
except EnvironmentError as exception:
print(
"Warning - could "
"not create dummy "
f"lockfile {lockfilename}: "
f"{repr(exception)}"
)
else:
print(
"Warning - had to "
"create dummy "
"lockfile",
lockfilename,
)
print(
"Closing existing instance with PID",
pid2,
)
startupinfo = sp.STARTUPINFO()
startupinfo.dwFlags |= sp.STARTF_USESHOWWINDOW
startupinfo.wShowWindow = sp.SW_HIDE
lock.unlock()
try:
p = sp.Popen(
["taskkill", "/PID", "%s" % pid2],
stdin=sp.PIPE,
stdout=sp.PIPE,
stderr=sp.STDOUT,
startupinfo=startupinfo,
)
stdout, stderr = p.communicate()
except Exception as exception:
print(exception)
else:
print(stdout)
if not p.returncode:
# Successfully sent our close
# request.
incoming = "ok"
if incoming == "ok":
# Successfully sent our request
if module == "apply-profiles":
# Wait for lockfile to be removed, in which case
# we know the running instance has successfully
# closed.
print(
"Waiting for existing instance to exit and delete lockfile",
lockfilename,
)
while os.path.isfile(lockfilename):
sleep(0.05)
lock.lock()
print("Existing instance exited.")
incoming = None
if lockfilename in lock2pids_ports:
del lock2pids_ports[lockfilename]
break
if incoming is not None:
# Other instance running?
from DisplayCAL import localization as lang
lang.init()
if incoming == "ok":
# Successfully sent our request
print(lang.getstr("app.otherinstance.notified"))
elif module == "apply-profiles":
print("Not starting another instance.")
else:
# Other instance busy?
handle_error(lang.getstr("app.otherinstance", name))
# Exit
return
lock.unlock()
# Use exclusive lock during app startup
with AppLock(app_lock_file_name, "a+", True, True) as lock:
# Create listening socket
appsocket = AppSocket()
if appsocket:
if sys.platform != "win32":
# https://docs.microsoft.com/de-de/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse#using-so_reuseaddr
# From the above link: "The SO_REUSEADDR socket option allows
# a socket to forcibly bind to a port in use by another socket".
# Note that this is different from the behavior under Linux/BSD,
# where a socket can only be (re-)bound if no active listening
# socket is already bound to the address.
# Consequently, we don't use SO_REUSEADDR under Windows.
appsocket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
sys._appsocket = appsocket.socket
if getcfg("app.allow_network_clients"):
host = ""
used_ports = [
pid_port[1]
for pids_ports in list(lock2pids_ports.values())
for pid_port in pids_ports
]
candidate_ports = [0]
if defaultport not in used_ports:
candidate_ports.insert(0, defaultport)
for port in candidate_ports:
try:
sys._appsocket.bind((host, port))
except socket.error as exception:
if port == 0:
print(
"Warning - could not bind to %s:%s:" % (host, port),
exception,
)
del sys._appsocket
break
else:
try:
sys._appsocket.settimeout(0.2)
except socket.error as exception:
print("Warning - could not set socket timeout:", exception)
del sys._appsocket
break
try:
print("listening")
sys._appsocket.listen(1)
except socket.error as exception:
print("Warning - could not listen on socket:", exception)
del sys._appsocket
break
try:
port = sys._appsocket.getsockname()[1]
except socket.error as exception:
print("Warning - could not get socket address:", exception)
del sys._appsocket
break
sys._appsocket_port = port
break
if not hasattr(sys, "_appsocket_port"):
port = ""
lock.seek(0)
if module not in multi_instance:
lock.truncate(0)
if not port:
print(f"writing to lock file: opid: {opid} port: {port}")
lock.write("%s:%s" % (opid, port))
else:
print(f"writing to lock file: port: {port}")
lock.write(port)
lock.flush()
atexit.register(lambda: print("Ran application exit handlers"))
from DisplayCAL.wxwindows import BaseApp
BaseApp.register_exitfunc(_exit, app_lock_file_name, port)
# Check for required resource files
mod2res = {
"3DLUT-maker": ["xrc/3dlut.xrc"],
"curve-viewer": [],
"profile-info": [],
"scripting-client": [],
"synthprofile": ["xrc/synthicc.xrc"],
"testchart-editor": [],
"VRML-to-X3D-converter": [],
}
for filename in mod2res.get(module, resfiles):
path = get_data_path(os.path.sep.join(filename.split("/")))
if not path or not os.path.isfile(path):
from DisplayCAL import localization as lang
lang.init()
raise ResourceError(
lang.getstr("resources.notfound.error") + "\n" + filename
)
# Create main data dir if it does not exist
if not os.path.exists(datahome):
try:
os.makedirs(datahome)
except Exception:
handle_error(
UserWarning(f"Warning - could not create directory '{datahome}'")
)
elif sys.platform == "darwin":
# Check & fix permissions if necessary
import getpass
user = getpass.getuser()
script = []
for directory in (confighome, datahome, logdir):
if os.path.isdir(directory) and not os.access(directory, os.W_OK):
script.append("chown -R '%s' '%s'" % (user, directory))
if script:
sp.call(
[
"osascript",
"-e",
'do shell script "%s" with administrator privileges'
% ";".join(script).encode(fs_enc),
]
)
# Initialize & run
if module == "3DLUT-maker":
from DisplayCAL.wxLUT3DFrame import main
elif module == "curve-viewer":
from DisplayCAL.wxLUTViewer import main
elif module == "profile-info":
from DisplayCAL.wxProfileInfo import main
elif module == "scripting-client":
from DisplayCAL.wxScriptingClient import main
elif module == "synthprofile":
from DisplayCAL.wxSynthICCFrame import main
elif module == "testchart-editor":
from DisplayCAL.wxTestchartEditor import main
elif module == "VRML-to-X3D-converter":
from DisplayCAL.wxVRML2X3D import main
elif module == "apply-profiles":
from DisplayCAL.profile_loader import main
else:
from DisplayCAL.display_cal import main
# Run main after releasing lock
main()
def main(module=None):
mp.freeze_support()
if mp.current_process().name != "MainProcess":
return
if module:
name = f"{appbasename}-{module}"
else:
name = appbasename
app_lock_file_name = os.path.join(confighome, f"{name}.lock")
try:
_main(module, name, app_lock_file_name)
except Exception as exception:
if isinstance(exception, ResourceError):
error = exception
else:
error = Error(f"Fatal error: {exception}")
handle_error(error)
_exit(app_lock_file_name, getattr(sys, "_appsocket_port", ""))
def _exit(lockfilename, oport):
for process in mp.active_children():
if "Manager" not in process.name:
print("Terminating zombie process", process.name)
process.terminate()
print(process.name, "terminated")
for thread in threading.enumerate():
if (
thread.is_alive()
and thread is not threading.currentThread()
and not thread.isDaemon()
):
print("Waiting for thread %s to exit" % thread.getName())
thread.join()
print(thread.getName(), "exited")
if lockfilename and os.path.isfile(lockfilename):
with AppLock(lockfilename, "r+", False, True) as lock:
_update_lockfile(lockfilename, oport, lock)
print("Exiting", pyname)
def _update_lockfile(lockfilename, oport, lock):
if lock:
# Each lockfile may contain multiple ports of running instances
try:
pids_ports = lock.read().splitlines()
except EnvironmentError as exception:
print(
"Warning - could not read lockfile %s: %r" % (lockfilename, exception)
)
filtered_pids_ports = []
else:
opid = os.getpid()
# Determine if instances still running. If not still running,
# remove from list of ports
for i in reversed(range(len(pids_ports))):
pid_port = pids_ports[i]
if ":" in pid_port:
# DisplayCAL >= 3.8.8.2 with localhost blocked
pid, port = pid_port.split(":", 1)
if pid:
try:
pid = int(pid)
except ValueError:
# This shouldn't happen
pid = None
else:
# DisplayCAL <= 3.8.8.1 or localhost ok
pid = None
port = pid_port
if port:
try:
port = int(port)
except ValueError:
# This shouldn't happen
continue
if (pid and pid == opid and not port) or (port and port == oport):
# Remove ourself
pids_ports[i] = ""
continue
if not port:
continue
appsocket = AppSocket()
if not appsocket:
break
if not appsocket.connect("127.0.0.1", port):
# Other instance probably died
pids_ports[i] = ""
appsocket.close()
# Filtered PIDs & ports (only used for checking)
filtered_pids_ports = [pid_port for pid_port in pids_ports if pid_port]
if filtered_pids_ports:
# Write updated lockfile
try:
lock.seek(0)
lock.truncate(0)
except EnvironmentError as exception:
print(
"Warning - could not update lockfile %s: %r"
% (lockfilename, exception)
)
else:
lock.write("\n".join(pids_ports))
else:
lock.close()
try:
os.remove(lockfilename)
except EnvironmentError as exception:
print(
"Warning - could not remove lockfile %s: %r"
% (lockfilename, exception)
)
def main_3dlut_maker():
main("3DLUT-maker")
def main_curve_viewer():
main("curve-viewer")
def main_profile_info():
main("profile-info")
def main_synthprofile():
main("synthprofile")
def main_testchart_editor():
main("testchart-editor")
class AppLock:
def __init__(self, lockfilename, mode, exclusive=False, blocking=False):
self._lockfilename = lockfilename
self._mode = mode
self._lockfile = None
self._lock = None
self._exclusive = exclusive
self._blocking = blocking
self.lock()
def __enter__(self):
return self
def __exit__(self, etype, value, traceback):
self.unlock()
def __getattr__(self, name):
return getattr(self._lockfile, name)
def __iter__(self):
return self._lockfile
def __bool__(self):
return bool(self._lock)
def lock(self):
lockdir = os.path.dirname(self._lockfilename)
try:
if not os.path.isdir(lockdir):
os.makedirs(lockdir)
# Create lockfile
self._lockfile = open(self._lockfilename, self._mode)
except EnvironmentError as exception:
# This shouldn't happen
print("Error - could not open lockfile %s:" % self._lockfilename, exception)
else:
try:
self._lock = FileLock(self._lockfile, self._exclusive, self._blocking)
except LockingError:
pass
except EnvironmentError as exception:
# This shouldn't happen
print(
"Error - could not lock lockfile %s:" % self._lockfile.name,
exception,
)
else:
return True
return False
def unlock(self):
if self._lockfile:
try:
self._lockfile.close()
except EnvironmentError as exception:
# This shouldn't happen
print(
"Error - could not close lockfile %s:" % self._lockfile.name,
exception,
)
if self._lock:
try:
self._lock.unlock()
except UnlockingError as exception:
# This shouldn't happen
print(
"Warning - could not unlock lockfile %s:" % self._lockfile.name,
exception,
)
def write(self, contents):
if self._lockfile:
try:
self._lockfile.write("%s\n" % contents)
except EnvironmentError as exception:
# This shouldn't happen
print(
"Error - could not write to lockfile %s:" % self._lockfile.name,
exception,
)
class AppSocket:
def __init__(self):
try:
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error as exception:
# This shouldn't happen
print("Warning - could not create TCP socket:", exception)
def __getattr__(self, name):
return getattr(self.socket, name)
def __bool__(self):
return hasattr(self, "socket")
def connect(self, host, port):
try:
self.socket.connect((host, port))
except socket.error as exception:
# Other instance probably died
print("Connection to %s:%s failed:" % (host, port), exception)
return False
return True
def read(self):
incoming = ""
while "\4" not in incoming:
try:
data = self.socket.recv(1024).decode("utf-8")
except socket.error as exception:
if exception.errno == errno.EWOULDBLOCK:
sleep(0.05)
continue
print("Warning - could not receive data:", exception)
break
if not data:
break
incoming += data
print("AppSocket.read() end")
return incoming
def send(self, data):
print("AppSocket.send start")
try:
# self.socket.send(("%s\n" % data).encode())
data_to_send = f"{data}\n".encode("utf-8")
print("data_to_send: %s" % data_to_send)
self.socket.sendall(data_to_send)
except socket.error as exception:
# Connection lost?
print("Warning - could not send data %r:" % data, exception)
return False
return True
class Error(Exception):
pass
if __name__ == "__main__":
main()
|