Skip to content

Commit

Permalink
Fix to access resources_path and install_builtin_appliances settings
Browse files Browse the repository at this point in the history
  • Loading branch information
grossmj committed Jul 9, 2024
1 parent 59ad5c5 commit 3f7f5a3
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 14 deletions.
9 changes: 6 additions & 3 deletions gns3server/compute/docker/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,12 @@ def resources_path():
Get the Docker resources storage directory
"""

server_config = Config.instance().get_section_config("Server")
appname = vendor = "GNS3"
resources_path = os.path.expanduser(server_config.get("resources_path", platformdirs.user_data_dir(appname, vendor, roaming=True)))
resources_path = Config.instance().settings.Server.resources_path
if not resources_path:
appname = vendor = "GNS3"
resources_path = platformdirs.user_data_dir(appname, vendor, roaming=True)
else:
resources_path = os.path.expanduser(resources_path)
docker_resources_dir = os.path.join(resources_path, "docker")
os.makedirs(docker_resources_dir, exist_ok=True)
return docker_resources_dir
Expand Down
10 changes: 5 additions & 5 deletions gns3server/config_samples/gns3_server.conf
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ symbols_path = /home/gns3/GNS3/symbols
; Path where custom configs are stored
configs_path = /home/gns3/GNS3/configs

; Path where files like built-in appliances and Docker resources are stored
; The default path is the local user data directory
; (Linux: "~/.local/share/GNS3", macOS: "~/Library/Application Support/GNS3", Windows: "%APPDATA%\GNS3")
; resources_path = /home/gns3/GNS3/resources

; Default symbol theme
; Currently available themes are "Classic", Affinity-square-blue", "Affinity-square-red"
; "Affinity-square-gray", "Affinity-circle-blue", "Affinity-circle-red" and "Affinity-circle-gray"
Expand All @@ -63,11 +68,6 @@ allow_raw_images = True
; Option to automatically discover images in the images directory
auto_discover_images = True

; Path where files like built-in appliances and Docker resources are stored
; The default path is the local user data directory
; (Linux: "~/.local/share/GNS3", macOS: "~/Library/Application Support/GNS3", Windows: "%APPDATA%\GNS3")
; resources_path = /home/gns3/GNS3/resources

; Option to automatically send crash reports to the GNS3 team
report_errors = True

Expand Down
4 changes: 1 addition & 3 deletions gns3server/controller/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,9 +271,7 @@ def _load_controller_vars(self):
self._iou_license_settings["license_check"] = iou_config.license_check

# install the built-in appliances if needed
# FIXME
server_config = Config.instance().get_section_config("Server")
if server_config.getboolean("install_builtin_appliances", True):
if Config.instance().settings.Server.install_builtin_appliances:
previous_version = controller_vars.get("version")
log.info("Comparing controller version {} with config version {}".format(__version__, previous_version))
builtin_appliances_path = self._appliance_manager.builtin_appliances_path()
Expand Down
9 changes: 6 additions & 3 deletions gns3server/controller/appliance_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,12 @@ def builtin_appliances_path(self, delete_first=False):
Get the built-in appliance storage directory
"""

server_config = Config.instance().get_section_config("Server")
appname = vendor = "GNS3"
resources_path = os.path.expanduser(server_config.get("resources_path", platformdirs.user_data_dir(appname, vendor, roaming=True)))
resources_path = Config.instance().settings.Server.resources_path
if not resources_path:
appname = vendor = "GNS3"
resources_path = platformdirs.user_data_dir(appname, vendor, roaming=True)
else:
resources_path = os.path.expanduser(resources_path)
appliances_dir = os.path.join(resources_path, "appliances")
if delete_first:
shutil.rmtree(appliances_dir, ignore_errors=True)
Expand Down
2 changes: 2 additions & 0 deletions gns3server/schemas/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ class ServerSettings(BaseModel):
appliances_path: str = "~/GNS3/appliances"
symbols_path: str = "~/GNS3/symbols"
configs_path: str = "~/GNS3/configs"
resources_path: str = None
default_symbol_theme: BuiltinSymbolTheme = BuiltinSymbolTheme.affinity_square_blue
allow_raw_images: bool = True
auto_discover_images: bool = True
Expand All @@ -145,6 +146,7 @@ class ServerSettings(BaseModel):
default_nat_interface: str = None
allow_remote_console: bool = False
enable_builtin_templates: bool = True
install_builtin_appliances: bool = True
model_config = ConfigDict(validate_assignment=True, str_strip_whitespace=True, use_enum_values=True)

@field_validator("additional_images_paths", mode="before")
Expand Down

0 comments on commit 3f7f5a3

Please sign in to comment.