forked from platformio/platformio-core
119 lines
3.3 KiB
Python
119 lines
3.3 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import mimetypes
|
|
import socket
|
|
|
|
import click
|
|
|
|
from platformio.compat import IS_WINDOWS
|
|
from platformio.home.run import run_server
|
|
from platformio.package.manager.core import get_core_package_dir
|
|
|
|
|
|
@click.command("home", short_help="GUI to manage PlatformIO")
|
|
@click.option("--port", type=int, default=8008, help="HTTP port, default=8008")
|
|
@click.option(
|
|
"--host",
|
|
default="127.0.0.1",
|
|
help=(
|
|
"HTTP host, default=127.0.0.1. You can open PIO Home for inbound "
|
|
"connections with --host=0.0.0.0"
|
|
),
|
|
)
|
|
@click.option("--no-open", is_flag=True)
|
|
@click.option(
|
|
"--shutdown-timeout",
|
|
default=0,
|
|
type=int,
|
|
help=(
|
|
"Automatically shutdown server on timeout (in seconds) when no clients "
|
|
"are connected. Default is 0 which means never auto shutdown"
|
|
),
|
|
)
|
|
@click.option(
|
|
"--session-id",
|
|
help=(
|
|
"A unique session identifier to keep PIO Home isolated from other instances "
|
|
"and protect from 3rd party access"
|
|
),
|
|
)
|
|
def cli(port, host, no_open, shutdown_timeout, session_id):
|
|
# hook for `platformio-node-helpers`
|
|
if host == "__do_not_start__":
|
|
# download all dependent packages
|
|
get_core_package_dir("contrib-piohome")
|
|
return
|
|
|
|
# Ensure PIO Home mimetypes are known
|
|
mimetypes.add_type("text/html", ".html")
|
|
mimetypes.add_type("text/css", ".css")
|
|
mimetypes.add_type("application/javascript", ".js")
|
|
|
|
home_url = "http://%s:%d%s" % (
|
|
host,
|
|
port,
|
|
("/session/%s/" % session_id) if session_id else "/",
|
|
)
|
|
click.echo(
|
|
"\n".join(
|
|
[
|
|
"",
|
|
" ___I_",
|
|
" /\\-_--\\ PlatformIO Home",
|
|
"/ \\_-__\\",
|
|
"|[]| [] | %s" % home_url,
|
|
"|__|____|__%s" % ("_" * len(home_url)),
|
|
]
|
|
)
|
|
)
|
|
click.echo("")
|
|
click.echo("Open PlatformIO Home in your browser by this URL => %s" % home_url)
|
|
|
|
if is_port_used(host, port):
|
|
click.secho(
|
|
"PlatformIO Home server is already started in another process.", fg="yellow"
|
|
)
|
|
if not no_open:
|
|
click.launch(home_url)
|
|
return
|
|
|
|
run_server(
|
|
host=host,
|
|
port=port,
|
|
no_open=no_open,
|
|
shutdown_timeout=shutdown_timeout,
|
|
home_url=home_url,
|
|
)
|
|
|
|
|
|
def is_port_used(host, port):
|
|
socket.setdefaulttimeout(1)
|
|
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
if IS_WINDOWS:
|
|
try:
|
|
s.bind((host, port))
|
|
s.close()
|
|
return False
|
|
except (OSError, socket.error):
|
|
pass
|
|
else:
|
|
try:
|
|
s.connect((host, port))
|
|
s.close()
|
|
except socket.error:
|
|
return False
|
|
|
|
return True
|