2019-01-14 09:09:06 +00:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# Copyright (C) 2019 GNS3 Technologies Inc.
|
|
|
|
#
|
|
|
|
# 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 os
|
|
|
|
import json
|
|
|
|
import uuid
|
|
|
|
import asyncio
|
2021-10-10 07:05:11 +00:00
|
|
|
import aiofiles
|
|
|
|
|
|
|
|
from aiohttp.client_exceptions import ClientError
|
2019-01-14 09:09:06 +00:00
|
|
|
|
|
|
|
from .appliance import Appliance
|
|
|
|
from ..config import Config
|
|
|
|
from ..utils.asyncio import locking
|
|
|
|
from ..utils.get_resource import get_resource
|
2020-10-22 05:49:44 +00:00
|
|
|
from ..utils.http_client import HTTPClient
|
2020-10-02 06:37:50 +00:00
|
|
|
from .controller_error import ControllerError
|
2021-10-10 07:05:11 +00:00
|
|
|
from .appliance_to_template import ApplianceToTemplate
|
|
|
|
from ..utils.images import InvalidImageError, write_image, md5sum
|
|
|
|
from ..utils.asyncio import wait_run_in_executor
|
2019-01-14 09:09:06 +00:00
|
|
|
|
|
|
|
import logging
|
2021-04-13 09:16:50 +00:00
|
|
|
|
2019-01-14 09:09:06 +00:00
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class ApplianceManager:
|
|
|
|
"""
|
|
|
|
Manages appliances
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
|
|
|
|
self._appliances = {}
|
|
|
|
self._appliances_etag = None
|
|
|
|
|
|
|
|
@property
|
|
|
|
def appliances_etag(self):
|
|
|
|
"""
|
|
|
|
:returns: ETag for downloaded appliances
|
|
|
|
"""
|
|
|
|
|
|
|
|
return self._appliances_etag
|
|
|
|
|
|
|
|
@appliances_etag.setter
|
|
|
|
def appliances_etag(self, etag):
|
|
|
|
"""
|
|
|
|
:param etag: ETag for downloaded appliances
|
|
|
|
"""
|
|
|
|
|
|
|
|
self._appliances_etag = etag
|
|
|
|
|
|
|
|
@property
|
|
|
|
def appliances(self):
|
|
|
|
"""
|
|
|
|
:returns: The dictionary of appliances managed by GNS3
|
|
|
|
"""
|
|
|
|
|
|
|
|
return self._appliances
|
|
|
|
|
|
|
|
def appliances_path(self):
|
|
|
|
"""
|
|
|
|
Get the image storage directory
|
|
|
|
"""
|
|
|
|
|
2021-04-12 07:32:23 +00:00
|
|
|
server_config = Config.instance().settings.Server
|
|
|
|
appliances_path = os.path.expanduser(server_config.appliances_path)
|
2019-01-14 09:09:06 +00:00
|
|
|
os.makedirs(appliances_path, exist_ok=True)
|
|
|
|
return appliances_path
|
|
|
|
|
2021-10-10 07:05:11 +00:00
|
|
|
def _find_appliance_from_image_checksum(self, image_checksum):
|
|
|
|
"""
|
|
|
|
Find an appliance and version that matches an image checksum.
|
|
|
|
"""
|
2021-08-11 07:28:23 +00:00
|
|
|
|
|
|
|
for appliance in self._appliances.values():
|
|
|
|
if appliance.images:
|
|
|
|
for image in appliance.images:
|
2021-10-10 07:05:11 +00:00
|
|
|
if image.get("md5sum") == image_checksum:
|
|
|
|
return appliance, image.get("version")
|
|
|
|
|
|
|
|
async def _download_image(self, image_dir, image_name, image_type, image_url, images_repo):
|
|
|
|
"""
|
|
|
|
Download an image.
|
|
|
|
"""
|
|
|
|
|
|
|
|
log.info(f"Downloading image '{image_name}' from '{image_url}'")
|
|
|
|
image_path = os.path.join(image_dir, image_name)
|
|
|
|
try:
|
|
|
|
async with HTTPClient.get(image_url) as response:
|
|
|
|
if response.status != 200:
|
|
|
|
raise ControllerError(f"Could not download '{image_name}' due to HTTP error code {response.status}")
|
|
|
|
await write_image(image_name, image_type, image_path, response.content.iter_any(), images_repo)
|
|
|
|
except (OSError, InvalidImageError) as e:
|
|
|
|
raise ControllerError(f"Could not save {image_type} image '{image_path}': {e}")
|
|
|
|
except ClientError as e:
|
|
|
|
raise ControllerError(f"Could not connect to download '{image_name}': {e}")
|
|
|
|
except asyncio.TimeoutError:
|
|
|
|
raise ControllerError(f"Timeout while downloading '{image_name}' from '{image_url}'")
|
|
|
|
|
|
|
|
async def _find_appliance_version_images(self, appliance, version, images_repo, image_dir):
|
|
|
|
"""
|
|
|
|
Find all the images belonging to a specific appliance version.
|
|
|
|
"""
|
|
|
|
|
|
|
|
version_images = version.get("images")
|
|
|
|
if version_images:
|
|
|
|
for appliance_key, appliance_file in version_images.items():
|
|
|
|
for image in appliance.images:
|
|
|
|
if appliance_file == image.get("filename"):
|
|
|
|
image_checksum = image.get("md5sum")
|
|
|
|
image_in_db = await images_repo.get_image_by_checksum(image_checksum)
|
|
|
|
if image_in_db:
|
|
|
|
version_images[appliance_key] = image_in_db.filename
|
|
|
|
else:
|
|
|
|
# check if the image is on disk
|
|
|
|
image_path = os.path.join(image_dir, appliance_file)
|
|
|
|
if os.path.exists(image_path) and await wait_run_in_executor(md5sum, image_path) == image_checksum:
|
|
|
|
async with aiofiles.open(image_path, "rb") as f:
|
|
|
|
await write_image(appliance_file, appliance.type, image_path, f, images_repo)
|
|
|
|
else:
|
|
|
|
# download the image if there is a direct download URL
|
|
|
|
direct_download_url = image.get("direct_download_url")
|
|
|
|
if direct_download_url:
|
|
|
|
await self._download_image(
|
|
|
|
image_dir,
|
|
|
|
appliance_file,
|
|
|
|
appliance.type,
|
|
|
|
direct_download_url,
|
|
|
|
images_repo)
|
|
|
|
else:
|
|
|
|
raise ControllerError(f"Could not find '{appliance_file}'")
|
|
|
|
|
|
|
|
async def install_appliance_from_image(self, image_checksum, images_repo, image_dir):
|
|
|
|
"""
|
|
|
|
Find the image checksum in appliance files
|
|
|
|
"""
|
|
|
|
|
|
|
|
from . import Controller
|
|
|
|
|
|
|
|
appliance_info = self._find_appliance_from_image_checksum(image_checksum)
|
|
|
|
if appliance_info:
|
|
|
|
appliance, image_version = appliance_info
|
|
|
|
if appliance.versions:
|
|
|
|
for version in appliance.versions:
|
|
|
|
if version.get("name") == image_version:
|
|
|
|
await self._find_appliance_version_images(appliance, version, images_repo, image_dir)
|
|
|
|
# downloading missing custom symbol for this appliance
|
|
|
|
if appliance.symbol and not appliance.symbol.startswith(":/symbols/"):
|
|
|
|
destination_path = os.path.join(Controller.instance().symbols.symbols_path(), appliance.symbol)
|
|
|
|
if not os.path.exists(destination_path):
|
|
|
|
await self._download_symbol(appliance.symbol, destination_path)
|
|
|
|
return ApplianceToTemplate().new_template(appliance.asdict(), version, "local") # FIXME: "local"
|
2021-08-11 07:28:23 +00:00
|
|
|
|
2019-03-12 11:13:33 +00:00
|
|
|
def load_appliances(self, symbol_theme="Classic"):
|
2019-01-14 09:09:06 +00:00
|
|
|
"""
|
|
|
|
Loads appliance files from disk.
|
|
|
|
"""
|
|
|
|
|
|
|
|
self._appliances = {}
|
2021-04-13 09:16:50 +00:00
|
|
|
for directory, builtin in (
|
|
|
|
(
|
|
|
|
get_resource("appliances"),
|
|
|
|
True,
|
|
|
|
),
|
|
|
|
(
|
|
|
|
self.appliances_path(),
|
|
|
|
False,
|
|
|
|
),
|
|
|
|
):
|
2019-01-14 09:09:06 +00:00
|
|
|
if directory and os.path.isdir(directory):
|
|
|
|
for file in os.listdir(directory):
|
2021-04-13 09:16:50 +00:00
|
|
|
if not file.endswith(".gns3a") and not file.endswith(".gns3appliance"):
|
2019-01-14 09:09:06 +00:00
|
|
|
continue
|
|
|
|
path = os.path.join(directory, file)
|
2021-10-10 07:05:11 +00:00
|
|
|
# Generate UUID from path to avoid change between reboots
|
|
|
|
appliance_id = uuid.uuid5(
|
|
|
|
uuid.NAMESPACE_X500,
|
|
|
|
path
|
|
|
|
)
|
2019-01-14 09:09:06 +00:00
|
|
|
try:
|
2021-04-13 09:16:50 +00:00
|
|
|
with open(path, encoding="utf-8") as f:
|
2019-01-14 09:09:06 +00:00
|
|
|
appliance = Appliance(appliance_id, json.load(f), builtin=builtin)
|
2021-04-17 14:04:28 +00:00
|
|
|
json_data = appliance.asdict() # Check if loaded without error
|
2021-04-13 09:16:50 +00:00
|
|
|
if appliance.status != "broken":
|
2021-10-10 07:05:11 +00:00
|
|
|
self._appliances[appliance.id] = appliance
|
2019-03-12 11:13:33 +00:00
|
|
|
if not appliance.symbol or appliance.symbol.startswith(":/symbols/"):
|
|
|
|
# apply a default symbol if the appliance has none or a default symbol
|
|
|
|
default_symbol = self._get_default_symbol(json_data, symbol_theme)
|
|
|
|
if default_symbol:
|
|
|
|
appliance.symbol = default_symbol
|
2019-01-14 09:09:06 +00:00
|
|
|
except (ValueError, OSError, KeyError) as e:
|
|
|
|
log.warning("Cannot load appliance file '%s': %s", path, str(e))
|
|
|
|
continue
|
|
|
|
|
2019-03-12 11:13:33 +00:00
|
|
|
def _get_default_symbol(self, appliance, symbol_theme):
|
|
|
|
"""
|
|
|
|
Returns the default symbol for a given appliance.
|
|
|
|
"""
|
|
|
|
|
|
|
|
from . import Controller
|
2021-04-13 09:16:50 +00:00
|
|
|
|
2019-03-12 11:13:33 +00:00
|
|
|
controller = Controller.instance()
|
|
|
|
category = appliance["category"]
|
|
|
|
if category == "guest":
|
|
|
|
if "docker" in appliance:
|
|
|
|
return controller.symbols.get_default_symbol("docker_guest", symbol_theme)
|
|
|
|
elif "qemu" in appliance:
|
|
|
|
return controller.symbols.get_default_symbol("qemu_guest", symbol_theme)
|
|
|
|
return controller.symbols.get_default_symbol(category, symbol_theme)
|
|
|
|
|
2019-03-11 09:55:16 +00:00
|
|
|
async def download_custom_symbols(self):
|
|
|
|
"""
|
|
|
|
Download custom appliance symbols from our GitHub registry repository.
|
|
|
|
"""
|
|
|
|
|
|
|
|
from . import Controller
|
2021-04-13 09:16:50 +00:00
|
|
|
|
2019-03-11 09:55:16 +00:00
|
|
|
symbol_dir = Controller.instance().symbols.symbols_path()
|
|
|
|
self.load_appliances()
|
|
|
|
for appliance in self._appliances.values():
|
|
|
|
symbol = appliance.symbol
|
|
|
|
if symbol and not symbol.startswith(":/symbols/"):
|
|
|
|
destination_path = os.path.join(symbol_dir, symbol)
|
|
|
|
if not os.path.exists(destination_path):
|
|
|
|
await self._download_symbol(symbol, destination_path)
|
|
|
|
|
|
|
|
# refresh the symbol cache
|
|
|
|
Controller.instance().symbols.list()
|
|
|
|
|
|
|
|
async def _download_symbol(self, symbol, destination_path):
|
|
|
|
"""
|
|
|
|
Download a custom appliance symbol from our GitHub registry repository.
|
|
|
|
"""
|
|
|
|
|
2021-04-13 09:07:58 +00:00
|
|
|
symbol_url = f"https://raw.githubusercontent.com/GNS3/gns3-registry/master/symbols/{symbol}"
|
2021-10-10 07:05:11 +00:00
|
|
|
log.info(f"Downloading symbol '{symbol}'")
|
2020-10-22 05:49:44 +00:00
|
|
|
async with HTTPClient.get(symbol_url) as response:
|
|
|
|
if response.status != 200:
|
2021-04-13 09:16:50 +00:00
|
|
|
log.warning(
|
|
|
|
f"Could not retrieve appliance symbol {symbol} from GitHub due to HTTP error code {response.status}"
|
|
|
|
)
|
2020-10-22 05:49:44 +00:00
|
|
|
else:
|
|
|
|
try:
|
|
|
|
symbol_data = await response.read()
|
2021-04-13 09:07:58 +00:00
|
|
|
log.info(f"Saving {symbol} symbol to {destination_path}")
|
2021-04-13 09:16:50 +00:00
|
|
|
with open(destination_path, "wb") as f:
|
2020-10-22 05:49:44 +00:00
|
|
|
f.write(symbol_data)
|
|
|
|
except asyncio.TimeoutError:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.warning(f"Timeout while downloading '{symbol_url}'")
|
2020-10-22 05:49:44 +00:00
|
|
|
except OSError as e:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.warning(f"Could not write appliance symbol '{destination_path}': {e}")
|
2019-03-11 09:55:16 +00:00
|
|
|
|
2019-01-14 09:09:06 +00:00
|
|
|
@locking
|
|
|
|
async def download_appliances(self):
|
|
|
|
"""
|
|
|
|
Downloads appliance files from GitHub registry repository.
|
|
|
|
"""
|
|
|
|
|
|
|
|
try:
|
|
|
|
headers = {}
|
|
|
|
if self._appliances_etag:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.info(f"Checking if appliances are up-to-date (ETag {self._appliances_etag})")
|
2019-01-14 09:09:06 +00:00
|
|
|
headers["If-None-Match"] = self._appliances_etag
|
2020-10-22 05:49:44 +00:00
|
|
|
|
2021-04-13 09:16:50 +00:00
|
|
|
async with HTTPClient.get(
|
|
|
|
"https://api.github.com/repos/GNS3/gns3-registry/contents/appliances", headers=headers
|
|
|
|
) as response:
|
2020-10-22 05:49:44 +00:00
|
|
|
if response.status == 304:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.info(f"Appliances are already up-to-date (ETag {self._appliances_etag})")
|
2020-10-22 05:49:44 +00:00
|
|
|
return
|
|
|
|
elif response.status != 200:
|
2021-04-13 09:16:50 +00:00
|
|
|
raise ControllerError(
|
|
|
|
f"Could not retrieve appliances from GitHub due to HTTP error code {response.status}"
|
|
|
|
)
|
2020-10-22 05:49:44 +00:00
|
|
|
etag = response.headers.get("ETag")
|
|
|
|
if etag:
|
|
|
|
self._appliances_etag = etag
|
|
|
|
from . import Controller
|
2021-04-13 09:16:50 +00:00
|
|
|
|
2020-10-22 05:49:44 +00:00
|
|
|
Controller.instance().save()
|
|
|
|
json_data = await response.json()
|
2021-04-13 09:16:50 +00:00
|
|
|
appliances_dir = get_resource("appliances")
|
2021-04-10 03:16:40 +00:00
|
|
|
downloaded_appliance_files = []
|
2020-10-22 05:49:44 +00:00
|
|
|
for appliance in json_data:
|
|
|
|
if appliance["type"] == "file":
|
|
|
|
appliance_name = appliance["name"]
|
|
|
|
log.info("Download appliance file from '{}'".format(appliance["download_url"]))
|
|
|
|
async with HTTPClient.get(appliance["download_url"]) as response:
|
|
|
|
if response.status != 200:
|
2021-04-13 09:16:50 +00:00
|
|
|
log.warning(
|
|
|
|
"Could not download '{}' due to HTTP error code {}".format(
|
|
|
|
appliance["download_url"], response.status
|
|
|
|
)
|
|
|
|
)
|
2020-10-22 05:49:44 +00:00
|
|
|
continue
|
|
|
|
try:
|
|
|
|
appliance_data = await response.read()
|
|
|
|
except asyncio.TimeoutError:
|
|
|
|
log.warning("Timeout while downloading '{}'".format(appliance["download_url"]))
|
|
|
|
continue
|
|
|
|
path = os.path.join(appliances_dir, appliance_name)
|
|
|
|
try:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.info(f"Saving {appliance_name} file to {path}")
|
2021-04-13 09:16:50 +00:00
|
|
|
with open(path, "wb") as f:
|
2020-10-22 05:49:44 +00:00
|
|
|
f.write(appliance_data)
|
|
|
|
except OSError as e:
|
2021-04-13 09:07:58 +00:00
|
|
|
raise ControllerError(f"Could not write appliance file '{path}': {e}")
|
2021-04-06 08:08:11 +00:00
|
|
|
downloaded_appliance_files.append(appliance_name)
|
|
|
|
|
2021-04-10 03:16:40 +00:00
|
|
|
# delete old appliance files
|
|
|
|
for filename in os.listdir(appliances_dir):
|
|
|
|
file_path = os.path.join(appliances_dir, filename)
|
|
|
|
if filename in downloaded_appliance_files:
|
|
|
|
continue
|
|
|
|
try:
|
|
|
|
if os.path.isfile(file_path) or os.path.islink(file_path):
|
2021-04-13 09:07:58 +00:00
|
|
|
log.info(f"Deleting old appliance file {file_path}")
|
2021-04-10 03:16:40 +00:00
|
|
|
os.unlink(file_path)
|
|
|
|
except OSError as e:
|
2021-04-13 09:07:58 +00:00
|
|
|
log.warning(f"Could not delete old appliance file '{file_path}': {e}")
|
2021-04-10 03:16:40 +00:00
|
|
|
continue
|
2021-04-06 08:08:11 +00:00
|
|
|
|
2019-01-14 09:09:06 +00:00
|
|
|
except ValueError as e:
|
2021-04-13 09:07:58 +00:00
|
|
|
raise ControllerError(f"Could not read appliances information from GitHub: {e}")
|
2019-03-11 09:55:16 +00:00
|
|
|
|
|
|
|
# download the custom symbols
|
|
|
|
await self.download_custom_symbols()
|