Merge pull request #3591 from GNS3/feature/keep-compute-ids

Option to keep the compute IDs unchanged when exporting a project
GNS3 · Jul 6, 2024 · d963dd4 · d963dd4
2 parents 80b654b + 60addcc
commit d963dd4
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 62 deletions.
diff --git a/gns3/dialogs/project_export_wizard.py b/gns3/dialogs/project_export_wizard.py
@@ -126,20 +126,18 @@ def done(self, result):
         """
 
         if result:
+            include_images = include_snapshots = reset_mac_addresses = keep_compute_ids = "no"
             if self.uiIncludeImagesCheckBox.isChecked():
                 include_images = "yes"
-            else:
-                include_images = "no"
             if self.uiIncludeSnapshotsCheckBox.isChecked():
                 include_snapshots = "yes"
-            else:
-                include_snapshots = "no"
             if self.uiResetMacAddressesCheckBox.isChecked():
                 reset_mac_addresses = "yes"
-            else:
-                reset_mac_addresses = "no"
+            if self.uiKeepComputeIdsCheckBox.isChecked():
+                keep_compute_ids = "yes"
+
             compression = self.uiCompressionComboBox.currentData()
-            export_worker = ExportProjectWorker(self._project, self._path, include_images, include_snapshots, reset_mac_addresses, compression)
+            export_worker = ExportProjectWorker(self._project, self._path, include_images, include_snapshots, reset_mac_addresses, keep_compute_ids, compression)
             progress_dialog = ProgressDialog(export_worker, "Exporting project", "Exporting portable project files...", "Cancel", parent=self, create_thread=False)
             progress_dialog.show()
             progress_dialog.exec_()

diff --git a/gns3/ui/export_project_wizard.ui b/gns3/ui/export_project_wizard.ui
@@ -9,8 +9,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>900</width>
-    <height>600</height>
+    <width>602</width>
+    <height>367</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -27,19 +27,6 @@
     <string>Please select the location, whether to include base images or not and the compression type.</string>
    </property>
    <layout class="QGridLayout" name="gridLayout">
-    <item row="0" column="0">
-     <widget class="QLabel" name="uiPathLabel">
-      <property name="sizePolicy">
-       <sizepolicy hsizetype="Fixed" vsizetype="Preferred">
-        <horstretch>0</horstretch>
-        <verstretch>0</verstretch>
-       </sizepolicy>
-      </property>
-      <property name="text">
-       <string>Path:</string>
-      </property>
-     </widget>
-    </item>
     <item row="0" column="1" colspan="2">
      <layout class="QHBoxLayout" name="horizontalLayout_3">
       <item>
@@ -54,31 +41,34 @@
       </item>
      </layout>
     </item>
-    <item row="1" column="0">
-     <widget class="QLabel" name="uiCompressionLabel">
+    <item row="5" column="0" colspan="2">
+     <widget class="QCheckBox" name="uiResetMacAddressesCheckBox">
       <property name="text">
-       <string>Compression:</string>
+       <string>&amp;Reset MAC addresses</string>
       </property>
      </widget>
     </item>
-    <item row="1" column="1" colspan="2">
-     <widget class="QComboBox" name="uiCompressionComboBox"/>
-    </item>
-    <item row="3" column="0" colspan="3">
-     <widget class="QCheckBox" name="uiIncludeImagesCheckBox">
+    <item row="0" column="0">
+     <widget class="QLabel" name="uiPathLabel">
+      <property name="sizePolicy">
+       <sizepolicy hsizetype="Fixed" vsizetype="Preferred">
+        <horstretch>0</horstretch>
+        <verstretch>0</verstretch>
+       </sizepolicy>
+      </property>
       <property name="text">
-       <string>&amp;Include base images</string>
+       <string>Path:</string>
       </property>
      </widget>
     </item>
-    <item row="4" column="0" colspan="2">
-     <widget class="QCheckBox" name="uiIncludeSnapshotsCheckBox">
+    <item row="1" column="0">
+     <widget class="QLabel" name="uiCompressionLabel">
       <property name="text">
-       <string>&amp;Include snapshots</string>
+       <string>Compression:</string>
       </property>
      </widget>
     </item>
-    <item row="6" column="2">
+    <item row="7" column="2">
      <spacer name="verticalSpacer">
       <property name="orientation">
        <enum>Qt::Vertical</enum>
@@ -91,10 +81,27 @@
       </property>
      </spacer>
     </item>
-    <item row="5" column="0" colspan="2">
-     <widget class="QCheckBox" name="uiResetMacAddressesCheckBox">
+    <item row="1" column="1" colspan="2">
+     <widget class="QComboBox" name="uiCompressionComboBox"/>
+    </item>
+    <item row="3" column="0" colspan="3">
+     <widget class="QCheckBox" name="uiIncludeImagesCheckBox">
       <property name="text">
-       <string>&amp;Reset MAC addresses</string>
+       <string>&amp;Include base images</string>
+      </property>
+     </widget>
+    </item>
+    <item row="4" column="0" colspan="2">
+     <widget class="QCheckBox" name="uiIncludeSnapshotsCheckBox">
+      <property name="text">
+       <string>&amp;Include snapshots</string>
+      </property>
+     </widget>
+    </item>
+    <item row="6" column="0" colspan="3">
+     <widget class="QCheckBox" name="uiKeepComputeIdsCheckBox">
+      <property name="text">
+       <string>&amp;Keep the original compute IDs</string>
       </property>
      </widget>
     </item>

diff --git a/gns3/ui/export_project_wizard_ui.py b/gns3/ui/export_project_wizard_ui.py
@@ -2,9 +2,10 @@
 
 # Form implementation generated from reading ui file '/home/grossmj/PycharmProjects/gns3-gui/gns3/ui/export_project_wizard.ui'
 #
-# Created by: PyQt5 UI code generator 5.13.2
+# Created by: PyQt5 UI code generator 5.15.6
 #
-# WARNING! All changes made in this file will be lost!
+# WARNING: Any manual changes made to this file will be lost when pyuic5 is
+# run again.  Do not edit this file unless you know what you are doing.
 
 
 from PyQt5 import QtCore, QtGui, QtWidgets
@@ -14,20 +15,12 @@ class Ui_ExportProjectWizard(object):
     def setupUi(self, ExportProjectWizard):
         ExportProjectWizard.setObjectName("ExportProjectWizard")
         ExportProjectWizard.setWindowModality(QtCore.Qt.ApplicationModal)
-        ExportProjectWizard.resize(900, 600)
+        ExportProjectWizard.resize(602, 367)
         ExportProjectWizard.setOptions(QtWidgets.QWizard.HaveHelpButton)
         self.uiExportOptionsWizardPage = QtWidgets.QWizardPage()
         self.uiExportOptionsWizardPage.setObjectName("uiExportOptionsWizardPage")
         self.gridLayout = QtWidgets.QGridLayout(self.uiExportOptionsWizardPage)
         self.gridLayout.setObjectName("gridLayout")
-        self.uiPathLabel = QtWidgets.QLabel(self.uiExportOptionsWizardPage)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Preferred)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.uiPathLabel.sizePolicy().hasHeightForWidth())
-        self.uiPathLabel.setSizePolicy(sizePolicy)
-        self.uiPathLabel.setObjectName("uiPathLabel")
-        self.gridLayout.addWidget(self.uiPathLabel, 0, 0, 1, 1)
         self.horizontalLayout_3 = QtWidgets.QHBoxLayout()
         self.horizontalLayout_3.setObjectName("horizontalLayout_3")
         self.uiPathLineEdit = QtWidgets.QLineEdit(self.uiExportOptionsWizardPage)
@@ -37,9 +30,22 @@ def setupUi(self, ExportProjectWizard):
         self.uiPathBrowserToolButton.setObjectName("uiPathBrowserToolButton")
         self.horizontalLayout_3.addWidget(self.uiPathBrowserToolButton)
         self.gridLayout.addLayout(self.horizontalLayout_3, 0, 1, 1, 2)
+        self.uiResetMacAddressesCheckBox = QtWidgets.QCheckBox(self.uiExportOptionsWizardPage)
+        self.uiResetMacAddressesCheckBox.setObjectName("uiResetMacAddressesCheckBox")
+        self.gridLayout.addWidget(self.uiResetMacAddressesCheckBox, 5, 0, 1, 2)
+        self.uiPathLabel = QtWidgets.QLabel(self.uiExportOptionsWizardPage)
+        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Preferred)
+        sizePolicy.setHorizontalStretch(0)
+        sizePolicy.setVerticalStretch(0)
+        sizePolicy.setHeightForWidth(self.uiPathLabel.sizePolicy().hasHeightForWidth())
+        self.uiPathLabel.setSizePolicy(sizePolicy)
+        self.uiPathLabel.setObjectName("uiPathLabel")
+        self.gridLayout.addWidget(self.uiPathLabel, 0, 0, 1, 1)
         self.uiCompressionLabel = QtWidgets.QLabel(self.uiExportOptionsWizardPage)
         self.uiCompressionLabel.setObjectName("uiCompressionLabel")
         self.gridLayout.addWidget(self.uiCompressionLabel, 1, 0, 1, 1)
+        spacerItem = QtWidgets.QSpacerItem(20, 247, QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Expanding)
+        self.gridLayout.addItem(spacerItem, 7, 2, 1, 1)
         self.uiCompressionComboBox = QtWidgets.QComboBox(self.uiExportOptionsWizardPage)
         self.uiCompressionComboBox.setObjectName("uiCompressionComboBox")
         self.gridLayout.addWidget(self.uiCompressionComboBox, 1, 1, 1, 2)
@@ -49,11 +55,9 @@ def setupUi(self, ExportProjectWizard):
         self.uiIncludeSnapshotsCheckBox = QtWidgets.QCheckBox(self.uiExportOptionsWizardPage)
         self.uiIncludeSnapshotsCheckBox.setObjectName("uiIncludeSnapshotsCheckBox")
         self.gridLayout.addWidget(self.uiIncludeSnapshotsCheckBox, 4, 0, 1, 2)
-        spacerItem = QtWidgets.QSpacerItem(20, 247, QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Expanding)
-        self.gridLayout.addItem(spacerItem, 6, 2, 1, 1)
-        self.uiResetMacAddressesCheckBox = QtWidgets.QCheckBox(self.uiExportOptionsWizardPage)
-        self.uiResetMacAddressesCheckBox.setObjectName("uiResetMacAddressesCheckBox")
-        self.gridLayout.addWidget(self.uiResetMacAddressesCheckBox, 5, 0, 1, 2)
+        self.uiKeepComputeIdsCheckBox = QtWidgets.QCheckBox(self.uiExportOptionsWizardPage)
+        self.uiKeepComputeIdsCheckBox.setObjectName("uiKeepComputeIdsCheckBox")
+        self.gridLayout.addWidget(self.uiKeepComputeIdsCheckBox, 6, 0, 1, 3)
         ExportProjectWizard.addPage(self.uiExportOptionsWizardPage)
         self.uiProjectReadmeWizardPage = QtWidgets.QWizardPage()
         self.uiProjectReadmeWizardPage.setObjectName("uiProjectReadmeWizardPage")
@@ -72,12 +76,13 @@ def retranslateUi(self, ExportProjectWizard):
         ExportProjectWizard.setWindowTitle(_translate("ExportProjectWizard", "Export project"))
         self.uiExportOptionsWizardPage.setTitle(_translate("ExportProjectWizard", "Export project"))
         self.uiExportOptionsWizardPage.setSubTitle(_translate("ExportProjectWizard", "Please select the location, whether to include base images or not and the compression type."))
-        self.uiPathLabel.setText(_translate("ExportProjectWizard", "Path:"))
         self.uiPathBrowserToolButton.setText(_translate("ExportProjectWizard", "Browse..."))
+        self.uiResetMacAddressesCheckBox.setText(_translate("ExportProjectWizard", "&Reset MAC addresses"))
+        self.uiPathLabel.setText(_translate("ExportProjectWizard", "Path:"))
         self.uiCompressionLabel.setText(_translate("ExportProjectWizard", "Compression:"))
         self.uiIncludeImagesCheckBox.setText(_translate("ExportProjectWizard", "&Include base images"))
         self.uiIncludeSnapshotsCheckBox.setText(_translate("ExportProjectWizard", "&Include snapshots"))
-        self.uiResetMacAddressesCheckBox.setText(_translate("ExportProjectWizard", "&Reset MAC addresses"))
+        self.uiKeepComputeIdsCheckBox.setText(_translate("ExportProjectWizard", "&Keep the original compute IDs"))
         self.uiProjectReadmeWizardPage.setTitle(_translate("ExportProjectWizard", "Readme file"))
         self.uiProjectReadmeWizardPage.setSubTitle(_translate("ExportProjectWizard", "Write a summary of the project."))
         self.uiReadmeTextEdit.setHtml(_translate("ExportProjectWizard", "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0//EN\" \"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"

diff --git a/gns3/utils/export_project_worker.py b/gns3/utils/export_project_worker.py
@@ -28,21 +28,24 @@ class ExportProjectWorker(QtCore.QObject):
     finished = QtCore.pyqtSignal()
     updated = QtCore.pyqtSignal(int)
 
-    def __init__(self, project, path, include_images, include_snapshots, reset_mac_addresses, compression):
+    def __init__(self, project, path, include_images, include_snapshots, reset_mac_addresses, keep_compute_ids, compression):
         super().__init__()
         self._project = project
+        self._path = path
         self._include_images = include_images
         self._include_snapshots = include_snapshots
         self._reset_mac_addresses = reset_mac_addresses
-        self._path = path
+        self._keep_compute_ids = keep_compute_ids
         self._compression = compression
 
     def run(self):
         if self._project:
-            self._project.get("/export?include_images={}&include_snapshots={}&reset_mac_addresses={}&compression={}".format(self._include_images, self._include_snapshots, self._reset_mac_addresses, self._compression),
-                              self._exportReceived,
-                              downloadProgressCallback=self._downloadFileProgress,
-                              timeout=None)
+            self._project.get(
+                "/export?include_images={}&include_snapshots={}&reset_mac_addresses={}&keep_compute_ids={}&compression={}".format(self._include_images, self._include_snapshots, self._reset_mac_addresses, self._keep_compute_ids, self._compression),
+                self._exportReceived,
+                downloadProgressCallback=self._downloadFileProgress,
+                timeout=None
+            )
 
     def _exportReceived(self, content, error=False, server=None, context={}, **kwargs):
         if error: