Release v2.2.47

Drop Python 3.7

.gitattributes

@@ -0,0 +1,2 @@
+gns3/version.py merge=ours
+

.github/ISSUE_TEMPLATE/gns3-bug-report.md

@@ -0,0 +1,34 @@
+---
+name: GNS3 bug report
+about: Create a report to help us fix a bug
+title: 'Short description of the bug'
+labels: Bug
+assignees: ''
+
+---
+
+**Before you start**
+Please open an issue only if you suspect there is a bug or any problem with GNS3. Go to https://gns3.com/community for any other questions or for requesting help with GNS3.
+
+You may also post this issue directly on the GNS3 server repository if you know the bug comes from the server: https://github.com/GNS3/gns3-server/issues/new
+
+**Describe the bug**
+Please provide a clear and detailed description of what the bug is.
+
+**GNS3 version and operating system (please complete the following information):**
+ - OS: [e.g. Windows, Linux or macOS]
+ - GNS3 version [e.g. 2.1.14]
+ - Any use of the GNS3 VM or remote server (ESXi, bare metal etc.)
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Screenshots or videos**
+If applicable, add screenshots (e.g. of the topology and/or error message) or links to videos to help explain the problem. This will help us a lot to quickly find the bug and fix it.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/gns3-development.md

@@ -0,0 +1,10 @@
+---
+name: GNS3 development
+about: Any question or discussion regarding GNS3 development
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/gns3-feature-request.md

@@ -0,0 +1,25 @@
+---
+name: GNS3 feature request
+about: Suggest an idea for GNS3
+title: 'Short description of the feature request'
+labels: Enhancement
+assignees: ''
+
+---
+
+**Before you start**
+Please check if a similar feature request has already been submitted.
+
+You may also post this issue directly on the GNS3 server repository if you know the feature request only applies to the server: https://github.com/GNS3/gns3-server/issues/new
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen. If applicable, please provide screenshots
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/add-new-issues-to-project.yml

@@ -0,0 +1,16 @@
+name: Add new issues to GNS3 project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.4.0
+        with:
+          project-url: https://github.com/orgs/GNS3/projects/3
+          github-token: ${{ secrets.ADD_NEW_ISSUES_TO_PROJECT }}

.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '27 6 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/testing.yml

@@ -0,0 +1,19 @@
+name: testing
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build and run Docker image
+      run: |
+        docker build -t gns3-gui-test .
+        docker run gns3-gui-test

.gitignore

@@ -37,6 +37,7 @@ nosetests.xml
 
 # PyCharm
 .idea
+/.eggs
 
 # OSX
 .DS_Store
@@ -45,3 +46,21 @@ nosetests.xml
 *_log.txt
 *.log
 
+# Gedit Temp Files
+*~
+
+# Qt creator
+*.autosave
+
+# Licence keys
+keys
+
+# Custom config
+/gns3_server.ini
+updates
+.cache
+__pycache__
+
+# Virtualenv
+env
+venv

.travis.yml

@@ -1,24 +0,0 @@
-language: python
-
-python:
-  - "2.7"
-  - "3.3"
-
-install:
-  - "pip install -r requirements.txt --use-mirrors"
-  - "pip install tox"
-
-script: "python setup.py test"
-
-branches:
-  only:
-    - master
-
-notifications:
-  email: false
-  irc:
-    channels:
-      - "chat.freenode.net#gns3"
-    on_success: change
-    on_failure: always
-

.whitesource

@@ -0,0 +1,14 @@
+{
+  "scanSettings": {
+    "configMode": "AUTO",
+    "configExternalURL": "",
+    "projectToken" : "",
+    "baseBranches": ["master", "2.2", "3.0"]
+  },
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

AUTHORS

@@ -1 +1,2 @@
-Jeremy Grossmann
+Jeremy Grossmann
+Julien Duponchelle

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing to GNS3
+
+We welcome contributions and bugs reports from everyone.
+We are friendly so don't be afraid to ask questions.
+
+## Bug reports
+
+Before reporting an issue:
+* check our website over at https://gns3.com
+* check if an issue already exists on https://github.com/GNS3/gns3-gui
+* check if an issue already exists on https://github.com/GNS3/gns3-server
+
+Please post on our community website if you are unsure you found a bug,
+you will get faster support and be able to exchange with more users.
+
+If you are unsure which project you should create an issue for, just do 
+it on https://github.com/GNS3/gns3-gui we will take care of the triage.
+
+For bugs specific to the GNS3 VM, please report on https://github.com/GNS3/gns3-vm
+
+## Security issues
+
+For security issues please keep it private and send an email to developers@gns3.net
+
+## Asking for new features
+
+The best is to start a discussion on the community website in order to get feedback
+from the whole community.
+
+
+## Contributing code
+
+We welcome code contribution from everyone including beginners.
+Don't be afraid to submit a half finished or mediocre contribution and we will help you.
+
+Don't hesitate to share your plans before starting working on a contribution, we can help
+you to find the best approach.
+
+### Contributors License Agreements
+
+We at GNS3 are eager to work with you. For small changes — little bugfixes, correcting typos, and the like — please just submit pull requests to any of our projects. For larger changes, though, we have to ask you to jump through a little hoop.
+
+In particular, in order for us to accept any major patches from you, you will have to electronically sign a statement that indicates two things:
+
+- You are willingly licensing your contributions under the terms of the open source license of the project that you’re contributing to.
+- You are legally able to license your contributions as stated.
+
+The reason we do this is to ensure, to the extent possible, that we don’t “taint” the projects we manage with contributions that turn out to be improper. This protects everyone who wants to use the projects, including you!
+
+More information there: https://github.com/GNS3/cla
+
+### Pull requests
+
+Creating a pull request is the easiest way to contribute code. Do not hesitate to create one early when  contributing for new feature in order to get our feedback.

COPYING

@@ -0,0 +1,504 @@
+GNU Public License (GPL)
+------------------------
+
+  GNS3 is released under the GPLv3 (see LICENSE) with the additional
+  exemption that compiling, linking, and/or using OpenSSL is allowed.
+
+GNS3 trademark
+--------------
+
+  "GNS3" is a trademark of GNS3 Technologies, Inc.
+
+Windows Driver Kit
+------------------
+
+  The Windows binary distribution includes devcon.exe, a Microsoft(R)
+  Windows Driver Kit (WDK) sample in object code form which is
+  redistributed under the terms of the WDK License terms.
+
+  With respect to binaries built using the Microsoft(R) Windows
+  Driver Kit (WDK), GPLv3 does not extend to any WDK Distributable Code.
+  All WDK Distributable Code is considered by the licensors of GNS3
+  to constitute, or be equivalent to, "System Libraries" as defined in
+  section 1 of GPLv3.
+
+OpenSSL License
+---------------
+
+  The OpenSSL toolkit stays under a dual license, i.e. both the conditions of
+  the OpenSSL License and the original SSLeay license apply to the toolkit.
+  See below for the actual license texts. Actually both licenses are BSD-style
+  Open Source licenses. In case of any license issues related to OpenSSL
+  please contact openssl-core@openssl.org.
+
+/* ====================================================================
+ * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this
+ *    software must display the following acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please contact
+ *    openssl-core@openssl.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ *    nor may "OpenSSL" appear in their names without prior written
+ *    permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com).  This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
+ *
+ */
+
+ Original SSLeay License
+ -----------------------
+
+/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
+ * All rights reserved.
+ *
+ * This package is an SSL implementation written
+ * by Eric Young (eay@cryptsoft.com).
+ * The implementation was written so as to conform with Netscapes SSL.
+ *
+ * This library is free for commercial and non-commercial use as long as
+ * the following conditions are aheared to.  The following conditions
+ * apply to all code found in this distribution, be it the RC4, RSA,
+ * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
+ * included with this distribution is covered by the same copyright terms
+ * except that the holder is Tim Hudson (tjh@cryptsoft.com).
+ *
+ * Copyright remains Eric Young's, and as such any Copyright notices in
+ * the code are not to be removed.
+ * If this package is used in a product, Eric Young should be given attribution
+ * as the author of the parts of the library used.
+ * This can be in the form of a textual message at program startup or
+ * in documentation (online or textual) provided with the package.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *    "This product includes cryptographic software written by
+ *     Eric Young (eay@cryptsoft.com)"
+ *    The word 'cryptographic' can be left out if the rouines from the library
+ *    being used are not cryptographic related :-).
+ * 4. If you include any Windows specific code (or a derivative thereof) from
+ *    the apps directory (application code) you must include an acknowledgement:
+ *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * The licence and distribution terms for any publically available version or
+ * derivative of this code cannot be changed.  i.e. this code cannot simply be
+ * copied and put under another distribution licence
+ * [including the GNU Public Licence.]
+ */
+
+=====================================================================================================
+Several fantastic pieces of free and open-source software have really get GNS3 to  where it is today.
+A few require that we include their license agreements within our software.
+=====================================================================================================
+
+License notice for Qt
+---------------------
+http://doc.qt.io/qt-4.8/gpl.html
+
+License notice for PyQt
+-----------------------
+http://www.gnu.org/licenses/gpl.html
+
+License notice for jsonschema
+-----------------------------
+https://github.com/Julian/jsonschema/blob/master/COPYING
+
+Copyright (c) 2013 Julian Berman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+License notice for aiohttp
+--------------------------
+https://github.com/KeepSafe/aiohttp/blob/master/LICENSE.txt
+
+Copyright (c) 2013, 2014, 2015 Nikolay Kim and Andrew Svetlov
+
+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.
+
+License notice for Jinja
+------------------------
+https://github.com/KeepSafe/aiohttp/blob/master/LICENSE.txt
+
+Copyright (c) 2009 by the Jinja Team, see AUTHORS for more details.
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * The names of the contributors may not be used to endorse or
+      promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License notice for raven
+------------------------
+https://github.com/getsentry/raven-python/blob/master/LICENSE
+
+Copyright (c) 2015 Functional Software, Inc and individual contributors.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * The names of the contributors may not be used to endorse or
+      promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License notice for pywin32
+--------------------------
+https://github.com/SublimeText/Pywin32/blob/master/License.txt
+
+Unless stated in the specfic source file, this work is
+Copyright (c) 1996-2008, Greg Stein and Mark Hammond.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the distribution.
+
+Neither names of Greg Stein, Mark Hammond nor the name of contributors may be used
+to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License notice for Winpcap
+--------------------------
+https://www.winpcap.org/misc/copyright.htm
+
+Copyright (c) 1999 - 2005 NetGroup, Politecnico di Torino (Italy).
+Copyright (c) 2005 - 2010 CACE Technologies, Davis (California).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * The names of the contributors may not be used to endorse or
+      promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+
+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 2
+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, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License notice for cpulimit
+---------------------------
+https://github.com/opsengine/cpulimit/blob/master/LICENSE
+
+Copyright (C) 2005-2012, by:  Angelo Marletta <angelo dot marletta at gmail dot com>
+
+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 2
+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, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+License notice for Cygwin
+-------------------------
+https://cygwin.com/licensing.html
+
+License notice for SuperPutty
+-----------------------------
+https://github.com/jimradford/superputty/blob/master/License.txt
+
+Copyright (c) 2009 Jim Radford http://www.jimradford.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+License notice for Putty
+------------------------
+http://www.chiark.greenend.org.uk/~sgtatham/putty/licence.html
+
+PuTTY is copyright 1997-2015 Simon Tatham.
+
+Portions copyright Robert de Bath, Joris van Rantwijk, Delian Delchev, Andreas Schultz, Jeroen Massar,
+Wez Furlong, Nicolas Barry, Justin Bradford, Ben Harris, Malcolm Smith, Ahmad Khalifa, Markus Kuhn,
+Colin Watson, Christopher Staite, and CORE SDI S.A.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+License notice for iouyap
+-------------------------
+https://github.com/GNS3/iouyap/blob/master/LICENSE
+
+License notice for Dynamips
+---------------------------
+https://github.com/GNS3/dynamips/blob/master/COPYING
+
+License notice for Qemu
+-----------------------
+http://wiki.qemu.org/License
+
+License notice for VPCS
+-----------------------
+
+Copyright (c) 2007-2013, Paul Meng (mirnshi@gmail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+
+License notice for Python
+-------------------------
+https://www.python.org/download/releases/3.4.2/license/
+
+License notice for BusyBox
+---------------------------
+BusyBox is distributed under version 2 of the General Public License
+https://busybox.net/license.html
+
+Source code is available here:
+https://github.com/GNS3/busybox
+
+
+Licence notice for zipstream
+-----------------------------
+zipstream is distributed under version 3 of the General Public License
+https://github.com/allanlei/python-zipstream/blob/master/LICENSE
+
+Source code is available here:
+https://pypi.python.org/pypi/zipstream
+
+
+Licence notice for aiohttp_cors
+-------------------------------
+Copyright 2015 Vladimir Rutsky <vladimir@rutsky.org>.
+
+Licensed under the Apache License, Version 2.0, see LICENSE file for details.
+
+https://github.com/aio-libs/aiohttp_cors

Dockerfile

@@ -0,0 +1,16 @@
+# Run tests inside a container
+FROM ubuntu:18.04
+MAINTAINER GNS3 Team
+
+RUN apt-get update
+RUN apt-get install -y --force-yes python3.6 python3-pyqt5 python3-pip python3-pyqt5.qtsvg python3-pyqt5.qtwebsockets python3.6-dev xvfb
+RUN apt-get clean
+
+ADD dev-requirements.txt /dev-requirements.txt
+ADD requirements.txt /requirements.txt
+RUN pip3 install --no-cache-dir -r /dev-requirements.txt
+
+ADD . /src
+WORKDIR /src
+
+CMD xvfb-run python3.6 -m pytest -vv

MANIFEST.in

@@ -1,11 +1,10 @@
-include README.rst
+include README.md
 include AUTHORS
-include INSTALL
 include LICENSE
 include MANIFEST.in
-include tox.ini
+include requirements.txt
 recursive-include tests *
-recursive-include docs *
 recursive-include gns3 *
+recursive-include resources *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.md

@@ -0,0 +1,62 @@
+GNS3-gui
+========
+
+[![image](https://github.com/GNS3/gns3-gui/workflows/testing/badge.svg)](https://github.com/GNS3/gns3-gui/actions?query=workflow%3Atesting)
+
+[![image](https://img.shields.io/pypi/v/gns3-gui.svg)](https://pypi.python.org/pypi/gns3-gui)
+
+[![image](https://snyk.io/test/github/GNS3/gns3-gui/badge.svg)](https://snyk.io/test/github/GNS3/gns3-gui)
+
+GNS3 GUI repository.
+
+Installation
+------------
+
+Please see <https://docs.gns3.com/>
+
+Software dependencies
+---------------------
+
+PyQt5 which is either part of the Linux distribution or installable from
+PyPi. The other Python dependencies are automatically installed during
+the GNS3 GUI installation and are listed
+[here](https://github.com/GNS3/gns3-gui/blob/master/requirements.txt)
+
+For connecting to nodes using Telnet, a Telnet client is required. On
+Linux that's a terminal emulator like xterm, gnome-terminal, konsole
+plus the telnet program. For connecting to nodes with a GUI, a VNC
+client is required, optionally a SPICE client can be used for Qemu
+nodes.
+
+For using packet captures within GNS3, Wireshark should be installed.
+It's recommended, but if you don't need that functionality you can go
+without it.
+
+Development
+-----------
+
+If you want to update the interface, modify the .ui files using QT
+tools. And:
+
+``` {.bash}
+cd scripts
+python build_pyqt.py
+```
+
+### Debug
+
+If you want to see the full logs in the internal shell you can type:
+
+``` {.bash}
+debug 2
+```
+
+Or start the app with --debug flag.
+
+Due to the fact PyQT intercept you can use a web debugger for inspecting
+stuff: <https://github.com/Kozea/wdb>
+
+Security issues
+---------------
+
+Please contact us at <security@gns3.net>

README.rst

@@ -1,35 +0,0 @@
-GNS3-gui
-========
-
-New GNS3 GUI repository (alpha stage).
-
-Warning: this is not the repository for the stable version of GNS3 (0.8.6), please go to the gns3-legacy repository for it.
-
-Linux/Unix
-----------
-
-Dependencies:
-
-- Python version 3.3 or above
-- pip & setuptools must be installed, please see http://pip.readthedocs.org/en/latest/installing.html
-  (or sudo apt-get install python3-pip but install more packages)
-- PyQt must be installed, to install on Debian-like Linux: sudo apt-get install python3-pyqt4
-- Dynamips version 0.2.11 or above (http://github.com/GNS3/dynamips)
-
-.. code:: bash
-
-   cd gns3-gui-master
-   sudo python3 setup.py install
-   gns3
-
-`Detailed instructions for Debian Jesse <http://forum.gns3.net/topic8988.html>`_. 
-
-Windows
--------
-
-Please use our all-in-one installer.
-
-Mac OS X
---------
-
-DMG package is not available yet.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please use GitHub's report a vulnerability feature. More information can be found in https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability

appveyor.yml

@@ -0,0 +1,20 @@
+version: '{build}-{branch}'
+
+image: Visual Studio 2022
+
+platform: x64
+
+environment:
+    PYTHON: "C:\\Python38-x64"
+    DISTUTILS_USE_SDK: "1"
+
+install:
+   - cinst nmap
+   - "%PYTHON%\\python.exe -m pip install -U pip setuptools"  # upgrade pip & setuptools first
+   - "%PYTHON%\\python.exe -m pip install -r dev-requirements.txt"
+   - "%PYTHON%\\python.exe -m pip install -r win-requirements.txt"
+
+build: off
+
+test_script:
+   - "%PYTHON%\\python.exe -m pytest -v"

dev-requirements.txt

@@ -1,4 +1,5 @@
 -rrequirements.txt
 
-pytest
-pytest-pythonpath # useful for running tests outside tox
+pytest==7.2.0
+flake8==5.0.4
+pytest-timeout==2.1.0

fake_frozen_gns3.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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/>.
+
+"""
+This script fake GNS3 run as a frozen app.
+
+Use it for testing stuff like self update.
+"""
+
+import os
+import sys
+import importlib
+
+# Fake GNS3 run from a binary
+sys.executable = os.path.realpath(__file__)
+
+# Add site-package directory before cx_freeze directory
+sys.path.insert(0, os.path.dirname(sys.executable))
+sys.path.insert(0, os.path.join(os.path.dirname(sys.executable), 'site-packages'))
+
+sys.frozen = True
+sys.executable = "/Applications/GNS3.app/Contents/MacOS/gns3"
+os.environ["_"] = "/Applications/GNS3.app/Contents/MacOS/gns3"
+
+module = importlib.import_module("gns3.main")
+module.main()

gns3-gui.appdata.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Copyright 2016 Athmane Madjoudj <athmane@fedoraproject.org> -->
+<component type="desktop">
+  <id>gns3-gui.desktop</id>
+  <metadata_license>CC0-1.0</metadata_license>
+  <project_license>GPL-3.0+</project_license>
+  <name>GNS3</name>
+  <summary>Graphical Network Simulator 3</summary>
+  <description>
+  <p>
+        GNS3 is a graphical network simulator that allows you to design complex network
+        topologies. You may run simulations or configure devices ranging from simple
+        workstations to powerful routers.
+  </p>
+  </description>
+  <screenshots>
+    <screenshot type="default">
+      <image>https://a.fsdn.com/con/app/proj/gns-3/screenshots/127765.jpg</image>
+    </screenshot>
+    <screenshot>
+      <image>https://a.fsdn.com/con/app/proj/gns-3/screenshots/127755.jpg</image>
+    </screenshot>
+    <screenshot>
+      <image>https://a.fsdn.com/con/app/proj/gns-3/screenshots/127755.jpg</image>
+    </screenshot>
+  </screenshots>
+  <url type="homepage">http://gns3.com/</url>
+  <update_contact>athmane_at_fedoraproject.org</update_contact>
+</component>

gns3-gui.desktop

@@ -0,0 +1,9 @@
+[Desktop Entry]
+Name=GNS3
+GenericName=Graphical Network Simulator 3
+Comment=Graphical Network Simulator 3
+Exec=gns3
+Icon=gns3
+Terminal=false
+Type=Application
+Categories=Application;Network;Qt;

gns3/__main__.py

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
 #
-# Copyright (C) 2014 GNS3 Technologies Inc.
+# Copyright (C) 2015 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
@@ -15,13 +15,6 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-Base class for NIOs (Network Input/Output).
-"""
+from .main import main
 
-
-class NIO(object):
-
-    def __init__(self):
-
-        pass
+main()

gns3/appliance_manager.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+from .qt import QtCore
+from .controller import Controller
+from .local_config import LocalConfig
+from .settings import GENERAL_SETTINGS
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ApplianceManager(QtCore.QObject):
+    """
+    Manager for appliances.
+    """
+
+    appliances_changed_signal = QtCore.Signal()
+
+    def __init__(self):
+
+        super().__init__()
+        self._appliances = []
+        self._controller = Controller.instance()
+        self._controller.connected_signal.connect(self.refresh)
+        self._controller.disconnected_signal.connect(self._controllerDisconnectedSlot)
+
+    def refresh(self, update=False):
+        """
+        Gets the appliances from the controller.
+        """
+
+        if self._controller.connected():
+            settings = LocalConfig.instance().loadSectionSettings("MainWindow", GENERAL_SETTINGS)
+            symbol_theme = settings["symbol_theme"]
+            if update is True:
+                self._controller.get("/appliances?update=yes&symbol_theme={}".format(symbol_theme), self._listAppliancesCallback, progressText="Downloading appliances from online registry...")
+            else:
+                self._controller.get("/appliances?symbol_theme={}".format(symbol_theme), self._listAppliancesCallback)
+
+    def _controllerDisconnectedSlot(self):
+        """
+        Called when the controller has been disconnected.
+        """
+
+        self._appliances = []
+        self.appliances_changed_signal.emit()
+
+    def appliances(self):
+        """
+        Returns the appliances.
+
+        :returns: array of appliances
+        """
+
+        return self._appliances
+
+    def _listAppliancesCallback(self, result, error=False, **kwargs):
+        """
+        Callback to get the appliances.
+        """
+
+        if error is True:
+            log.error("Error while getting appliances list: {}".format(result.get("message", "unknown")))
+            return
+        self._appliances = result
+        self.appliances_changed_signal.emit()
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of ApplianceManager.
+        :returns: instance of ApplianceManager
+        """
+
+        if not hasattr(ApplianceManager, '_instance') or ApplianceManager._instance is None:
+            ApplianceManager._instance = ApplianceManager()
+        return ApplianceManager._instance

gns3/application.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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 sys
+
+from .qt import QtWidgets, QtGui, QtCore
+from gns3.utils import parse_version
+from .version import __version__
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class Application(QtWidgets.QApplication):
+    file_open_signal = QtCore.pyqtSignal(str)
+
+    def __init__(self, argv, hdpi=True):
+
+        self.setStyle(QtWidgets.QStyleFactory.create("Fusion"))
+        # both Qt and PyQt must be version >= 5.6 in order to enable high DPI scaling
+        if parse_version(QtCore.QT_VERSION_STR) >= parse_version("5.6") and parse_version(QtCore.PYQT_VERSION_STR) >= parse_version("5.6"):
+            # only available starting Qt version 5.6
+            if hdpi:
+                if sys.platform.startswith("linux"):
+                    log.warning("HDPI mode is enabled. HDPI support on Linux is not fully stable and GNS3 may crash depending of your version of Linux. To disabled HDPI mode please edit ~/.config/GNS3/gns3_gui.conf and set 'hdpi' to 'false'")
+                self.setAttribute(QtCore.Qt.AA_EnableHighDpiScaling)
+                self.setAttribute(QtCore.Qt.AA_UseHighDpiPixmaps)
+            else:
+                log.info("HDPI mode is disabled")
+                self.setAttribute(QtCore.Qt.AA_DisableHighDpiScaling)
+
+        super().__init__(argv)
+
+        # this is tell Wayland what is the name of the desktop file (gns3.desktop)
+        self.setDesktopFileName("gns3")
+
+        # this info is necessary for QSettings
+        self.setOrganizationName("GNS3")
+        self.setOrganizationDomain("gns3.net")
+        self.setApplicationName("GNS3")
+        self.setApplicationVersion(__version__)
+
+        # File path if we have received the path to
+        # a file on system via an OSX event
+        self.open_file_at_startup = None
+
+    def event(self, event):
+        # When you double click file you receive an event
+        # and not the file as command line parameter
+        if sys.platform.startswith("darwin"):
+            if isinstance(event, QtGui.QFileOpenEvent):
+                self.open_file_at_startup = str(event.file())
+                self.file_open_signal.emit(str(event.file()))
+        return super().event(event)

gns3/base_node.py

@@ -0,0 +1,342 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Base class for node classes.
+"""
+
+from .qt import QtCore
+from .ports.port import Port
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class BaseNode(QtCore.QObject):
+    """
+    BaseNode implementation.
+
+    :param module: Module instance
+    :param server: client connection to a server
+    :param project: Project instance
+    """
+
+    # signals used to let the GUI know about some events.
+    created_signal = QtCore.Signal(int)
+    started_signal = QtCore.Signal()
+    stopped_signal = QtCore.Signal()
+    suspended_signal = QtCore.Signal()
+    updated_signal = QtCore.Signal()
+    loaded_signal = QtCore.Signal()
+    deleted_signal = QtCore.Signal()
+    error_signal = QtCore.Signal(int, str)
+    server_error_signal = QtCore.Signal(int, str)
+
+    _instance_count = 1
+
+    # node statuses
+    stopped = 0
+    started = 1
+    suspended = 2
+
+    # node categories
+    routers = "router"
+    switches = "switch"
+    end_devices = "guest"
+    security_devices = "firewall"
+
+    def __init__(self, module, compute, project):
+
+        super().__init__()
+
+        # create an unique ID
+        self._id = BaseNode._instance_count
+        BaseNode._instance_count += 1
+
+        self._module = module
+        self._compute = compute
+        assert project is not None
+        self._project = project
+        self._initialized = False
+        self._loading = False
+        self._status = BaseNode.stopped
+        self._ports = []
+        self._links = set()
+
+    def links(self):
+        """
+        Links connected to this node
+        """
+
+        return self._links
+
+    def addLink(self, link):
+        """
+        Add a link connected to this node
+
+        :param link: link object
+        """
+
+        self._links.add(link)
+
+    def deleteLink(self, link):
+        """
+        Delete a link connected to this node
+
+        :param link: link object
+        """
+
+        try:
+            self._links.remove(link)
+        except KeyError:
+            pass
+
+    def state(self):
+        """
+        Returns a human readable status of this node.
+
+        :returns: string
+        """
+
+        status = self.status()
+        if status == self.started:
+            return "started"
+        elif status == self.stopped:
+            return "stopped"
+        elif status == self.suspended:
+            return "suspended"
+        return "unknown"
+
+    @classmethod
+    def reset(cls):
+        """
+        Reset the instance count.
+        """
+
+        cls._instance_count = 1
+
+    def module(self):
+        """
+        Returns this node module.
+
+        :returns: Module instance
+        """
+
+        return self._module
+
+    def compute(self):
+        """
+        Returns this node compute.
+
+        :returns: Compute instance
+        """
+        return self._compute
+
+    def project(self):
+        """
+        Returns this node project.
+
+        :returns: Project instance
+        """
+
+        return self._project
+
+    def id(self):
+        """
+        Returns this node identifier.
+
+        :returns: node identifier (integer)
+        """
+
+        return self._id
+
+    def setId(self, new_id):
+        """
+        Sets an identifier for this node.
+
+        :param new_id: node identifier (integer)
+        """
+
+        self._id = new_id
+
+        # update the instance count to avoid conflicts
+        if new_id >= BaseNode._instance_count:
+            BaseNode._instance_count = new_id + 1
+
+    def status(self):
+        """
+        Returns the status of this node.
+        0 = stopped, 1 = started, 2 = suspended.
+
+        :returns: node status (integer)
+        """
+
+        return self._status
+
+    def setStatus(self, status):
+        """
+        Sets a status for this node.
+        0 = stopped, 1 = started, 2 = suspended.
+
+        :param status: node status (integer)
+        """
+
+        if status == self._status:
+            return
+        self._status = status
+        if status == self.started:
+            for port in self._ports:
+                # set ports as started
+                port.setStatus(Port.started)
+            self.started_signal.emit()
+        elif status == self.stopped:
+            for port in self._ports:
+                # set ports as stopped
+                port.setStatus(Port.stopped)
+            self.stopped_signal.emit()
+        elif status == self.suspended:
+            for port in self._ports:
+                # set ports as suspended
+                port.setStatus(Port.suspended)
+            self.suspended_signal.emit()
+
+    def initialized(self):
+        """
+        Returns if the node has been initialized
+
+        :returns: boolean
+        """
+
+        return self._initialized
+
+    def setInitialized(self, initialized):
+        """
+        Sets if the node has been initialized
+
+        :param initialized: boolean
+        """
+
+        self._initialized = initialized
+
+    def update(self, new_settings):
+        """
+        Updates the settings for this node.
+        Must be overloaded.
+
+        :param new_settings: settings dictionary
+        """
+
+        raise NotImplementedError()
+
+    def ports(self):
+        """
+        Returns all the ports for this node.
+
+        :returns: list of Port instances
+        """
+
+        return self._ports
+
+    def controllerHttpPost(self, path, callback, body={}, context={}, **kwargs):
+        """
+        POST on current server / project
+
+        :param path: Remote path
+        :param callback: callback method to call when the server replies
+        :param body: params to send (dictionary)
+        :param context: Pass a context to the response callback
+        """
+
+        self._project.post(path, callback, body=body, context=context, **kwargs)
+
+    def controllerHttpPut(self, path, callback, body={}, context={}, **kwargs):
+        """
+        PUT on current server / project
+
+        :param path: Remote path
+        :param callback: callback method to call when the server replies
+        :param body: params to send (dictionary)
+        :param context: Pass a context to the response callback
+        """
+
+        self._project.put(path, callback, body=body, context=context, **kwargs)
+
+    def controllerHttpGet(self, path, callback, context={}, **kwargs):
+        """
+        Get on current server / project
+
+        :param path: Remote path
+        :param callback: callback method to call when the server replies
+        :param body: params to send (dictionary)
+        :param context: Pass a context to the response callback
+        """
+
+        self._project.get(path, callback, context=context, **kwargs)
+
+    def controllerHttpDelete(self, path, callback, context={}, **kwargs):
+        """
+        Delete on current server / project
+
+        :param path: Remote path
+        :param callback: callback method to call when the server replies
+        :param context: Pass a context to the response callback
+        """
+
+        self._project.delete(path, callback, context=context, **kwargs)
+
+    @staticmethod
+    def defaultCategories():
+        """
+        Returns the default categories.
+
+        :returns: dict
+        """
+
+        categories = {"Routers": BaseNode.routers,
+                      "Switches": BaseNode.switches,
+                      "End devices": BaseNode.end_devices,
+                      "Security devices": BaseNode.security_devices}
+
+        return categories
+
+    @staticmethod
+    def defaultSymbol():
+        """
+        Returns the default symbol path for this node.
+        Must be overloaded.
+
+        :returns: symbol path (or resource).
+        """
+
+        raise NotImplementedError()
+
+    @staticmethod
+    def categories(self):
+        """
+        Returns the node categories the node is part of (used by the device panel).
+
+        :returns: list of node category (integer)
+        """
+
+        raise NotImplementedError()
+
+    def __str__(self):
+        """
+        Must be overloaded.
+        """
+
+        raise NotImplementedError()

gns3/base_private-config.txt

@@ -1,21 +0,0 @@
-!
-
-kerberos password 
-crypto RSA-key-pair %h.mydomain.com 0 1014940935
- 30820155 02010030 0D06092A 864886F7 0D010101 05000482 013F3082 013B0201 
- 00024100 A7EA2920 73033037 689F8166 B6AEA7FF 91015466 7379FA4F D7B175C3 
- 8D5D1E56 89B00E73 D5553491 06D651DA 71213D18 3E4EAF44 8C5F05F1 E8C1FE47 
- B07D5A1B 02030100 01024049 FE964106 6DD14199 8930ACE2 B3F4B45A 620B9F5A 
- 23D67A78 C26AF2D1 C8C72504 987ADD3E 2755DCC4 70AADB86 679171D7 54A9038F 
- 0EB080E7 8B514EB8 8A038102 2100D588 DF0A6D31 AEF5C231 5A4A3459 5D3FD973 
- F1A13EA8 2C25D210 6ACD4733 39AF0221 00C94EC2 9428B371 2599E7EA 8C89E86C 
- E188F689 3AFCFE7A 59B42810 E83DABBD 55022100 944FB792 D75ACDC9 96328F22 
- C10F5CAC 2F4DCF83 0E30E250 F6813E9D 0B99F1B3 02204863 D126D428 0B05197E 
- 4362FC68 9F56CF18 D0AA6CB5 DA2B8DD4 66980D2D 47ED0221 00991914 B6CDC66E 
- 60AF0332 D5FB2771 B9F0317B 886E6E48 B86CDFDF 3FC1D48E CA
- quit
- 305C300D 06092A86 4886F70D 01010105 00034B00 30480241 00A7EA29 20730330 
- 37689F81 66B6AEA7 FF910154 667379FA 4FD7B175 C38D5D1E 5689B00E 73D55534 
- 9106D651 DA71213D 183E4EAF 448C5F05 F1E8C1FE 47B07D5A 1B020301 0001
- quit
-end

gns3/base_startup-config.txt

@@ -1,21 +0,0 @@
-!
-hostname %h
-!
-no ip domain lookup
-no ip icmp rate-limit unreachable
-ip tcp synwait 5
-no cdp log mismatch duplex
-!
-line con 0
- exec-timeout 0 0
- logging synchronous
- privilege level 15
- no login
-line aux 0
- exec-timeout 0 0
- logging synchronous
- privilege level 15
- no login
-!
-!
-end

gns3/compute.py

@@ -0,0 +1,247 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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 uuid
+
+
+class Compute:
+    """
+    An instance of a compute.
+    """
+
+    def __init__(self, compute_id=None):
+
+        if compute_id is None:
+            compute_id = str(uuid.uuid4())
+        self._compute_id = compute_id
+        self._name = compute_id
+        self._connected = False
+        self._protocol = "http"
+        self._host = None
+        self._port = 3080
+        self._user = None
+        self._password = None
+        self._cpu_usage_percent = None
+        self._memory_usage_percent = None
+        self._capabilities = {"node_types": []}
+        self._last_error = None
+
+    def id(self):
+        """
+        Returns the compute ID.
+
+        :returns: compute identifier
+        """
+
+        return self._compute_id
+
+    def name(self):
+        """
+        Returns the compute name.
+
+        :returns: compute name
+        """
+
+        return self._name
+
+    def setName(self, name):
+        """
+        Sets the compute name.
+
+        :param name: compute name
+        """
+
+        self._name = name
+
+    def connected(self):
+        """
+        Returns whether or not there is a connection to the compute.
+
+        :returns: boolean
+        """
+
+        return self._connected
+
+    def setConnected(self, value):
+        """
+        Sets whether or not there is a connection to the compute.
+
+        :param value: boolean
+        """
+
+        self._connected = value
+
+    def host(self):
+        """
+        Returns the compute host.
+
+        :returns: host (string)
+        """
+
+        return self._host
+
+    def setHost(self, host):
+        """
+        Sets the compute host.
+
+        :param host: host (string)
+        """
+
+        self._host = host
+
+    def port(self):
+        """
+        Returns the compute port number.
+
+        :returns: port number (integer)
+        """
+
+        return self._port
+
+    def setPort(self, port):
+        """
+        Sets the compute port number.
+
+        :param port: port number (integer)
+        """
+
+        self._port = port
+
+    def user(self):
+        """
+        Returns the compute user for HTTP authentication.
+
+        :returns: user (string)
+        """
+
+        return self._user
+
+    def setUser(self, user):
+        """
+        Sets the compute user for HTTP authentication.
+
+        :param user: user (string)
+        """
+
+        self._user = user
+
+    def setPassword(self, password):
+        """
+        Returns the compute password for HTTP authentication.
+
+        :returns: password (string)
+        """
+
+        self._password = password
+
+    def protocol(self):
+        """
+        Returns the compute protocol.
+
+        :returns: protocol (string)
+        """
+
+        return self._protocol
+
+    def setProtocol(self, protocol):
+        """
+        Sets the compute protocol.
+
+        :param protocol: protocol (string)
+        """
+
+        self._protocol = protocol
+
+    def cpuUsagePercent(self):
+        """
+        Returns the compute CPU usage.
+
+        :returns: CPU usage (integer)
+        """
+
+        return self._cpu_usage_percent
+
+    def setCpuUsagePercent(self, usage):
+        """
+        Sets the compute CPU usage.
+
+        :param usage: CPU usage (integer)
+        """
+
+        self._cpu_usage_percent = usage
+
+    def setMemoryUsagePercent(self, usage):
+        """
+        Returns the compute memory usage.
+
+        :returns: memory usage (integer)
+        """
+
+        self._memory_usage_percent = usage
+
+    def memoryUsagePercent(self):
+        """
+        Sets the compute memory usage.
+
+        :param usage: memory usage (integer)
+        """
+
+        return self._memory_usage_percent
+
+    def capabilities(self):
+        """
+        Returns the compute capabilities
+
+        :returns: capabilities (dictionary)
+        """
+
+        return self._capabilities
+
+    def setCapabilities(self, value):
+        """
+        Sets the compute capabilities
+
+        :param value: capabilities (dictionary)
+        """
+
+        self._capabilities = value
+
+    def setLastError(self, last_error):
+        self._last_error = last_error
+
+    def lastError(self):
+        return self._last_error
+
+    def __str__(self):
+
+        return self._compute_id
+
+    def __json__(self):
+
+        return {"host": self._host,
+                "port": self._port,
+                "protocol": self._protocol,
+                "user": self._user,
+                "password": self._password,
+                "name": self._name,
+                "compute_id": self._compute_id}
+
+    def __eq__(self, v):
+
+        if isinstance(v, Compute):
+            return self.__json__() == v.__json__()
+        return False

gns3/compute_manager.py

@@ -0,0 +1,265 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+from .qt import QtCore
+from .compute import Compute
+from .controller import Controller
+
+import sys
+import copy
+import urllib
+import datetime
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ComputeManager(QtCore.QObject):
+    """
+    Manager for computes.
+    """
+
+    created_signal = QtCore.Signal(str)
+    updated_signal = QtCore.Signal(str)
+    deleted_signal = QtCore.Signal(str)
+
+    def __init__(self):
+
+        super().__init__()
+        self._computes = {}
+        self._controller = Controller.instance()
+        self._controller.connected_signal.connect(self._controllerConnectedSlot)
+        self._controller.disconnected_signal.connect(self._controllerDisconnectedSlot)
+        self._controllerConnectedSlot()
+
+        # No need to refresh via an API call if we received fresh data from the notification feed
+        self._last_computes_refresh = datetime.datetime.now().timestamp()
+
+        self._timer = QtCore.QTimer()
+        self._timer.setInterval(1000)
+        self._refreshingComputes = False
+        self._timer.timeout.connect(self._refreshComputesSlot)
+        self._timer.start()
+
+    def _refreshComputesSlot(self):
+        """
+        Called when computes are refreshed.
+        """
+
+        if self._refreshingComputes:
+            return
+        if self._controller.connected() and datetime.datetime.now().timestamp() - self._last_computes_refresh > 1:
+            self._last_computes_refresh = datetime.datetime.now().timestamp()
+            self._refreshingComputes = True
+            self._controller.get("/computes", self._listComputesCallback, showProgress=False, timeout=30)
+
+    def _controllerConnectedSlot(self):
+        """
+        Called when connected to a compute.
+        """
+
+        if self._controller.connected():
+            self._refreshingComputes = True
+            self._controller.get("/computes", self._listComputesCallback, showProgress=False, timeout=30)
+
+    def _controllerDisconnectedSlot(self):
+        """
+        Called when disconnected from a compute.
+        """
+
+        for compute_id in list(self._computes):
+            del self._computes[compute_id]
+            self.deleted_signal.emit(compute_id)
+
+    def _listComputesCallback(self, result, error=False, **kwargs):
+        """
+        Callback to list computes.
+        """
+
+        self._refreshingComputes = False
+        if error is True:
+            log.error("Error while getting compute list: {}".format(result["message"]))
+            return
+
+        for compute in result:
+            self.computeDataReceivedCallback(compute)
+
+    def computeDataReceivedCallback(self, compute):
+        """
+        Called when we received data from a compute node.
+        """
+
+        self._last_computes_refresh = datetime.datetime.now().timestamp()
+
+        new_node = False
+        compute_id = compute["compute_id"]
+        if compute_id not in self._computes:
+            new_node = True
+            self._computes[compute_id] = Compute(compute_id)
+
+        self._computes[compute_id].setName(compute["name"])
+        self._computes[compute_id].setConnected(compute["connected"])
+        self._computes[compute_id].setProtocol(compute["protocol"])
+        self._computes[compute_id].setHost(compute["host"])
+        self._computes[compute_id].setPort(compute["port"])
+        self._computes[compute_id].setUser(compute["user"])
+        self._computes[compute_id].setCpuUsagePercent(compute["cpu_usage_percent"])
+        self._computes[compute_id].setMemoryUsagePercent(compute["memory_usage_percent"])
+        self._computes[compute_id].setCapabilities(compute["capabilities"])
+        self._computes[compute_id].setLastError(compute.get("last_error"))
+
+        if new_node:
+            self.created_signal.emit(compute_id)
+        else:
+            self.updated_signal.emit(compute_id)
+
+    def computeIsTheRemoteGNS3VM(self, compute):
+        """
+        :returns: boolean True if the remote server is the remote GNS3 VM
+        """
+
+        if compute.id() != "local" and compute.id() != "vm":
+            if self.vmCompute() and "GNS3 VM ({})".format(compute.name()) == self.vmCompute().name():
+                return True
+        return False
+
+    def computes(self):
+        """
+        :returns: List of computes nodes
+        """
+
+        computes = []
+        for compute in self._computes.values():
+            # We filter the remote GNS3 VM compute from the computes list
+            if not self.computeIsTheRemoteGNS3VM(compute):
+                computes.append(compute)
+        return computes
+
+    def vmCompute(self):
+        """
+        :returns: The GNS3 VM compute node or None
+        """
+
+        try:
+            return self._computes["vm"]
+        except KeyError:
+            return None
+
+    def localCompute(self):
+        """
+        :returns: The local compute node or None
+        """
+
+        try:
+            return self._computes["local"]
+        except KeyError:
+            return None
+
+    def localPlatform(self):
+        """
+        Return the platform of the local compute.
+
+        With a remote controller it could be different of our local platform
+        """
+
+        c = self.localCompute()
+        if c is None:
+            return sys.platform
+        return c.capabilities().get("platform", sys.platform)
+
+    def remoteComputes(self):
+        """
+        :returns: List of non local and non VM computes
+        """
+
+        return [c for c in self._computes.values() if c.id() != "local" and c.id() != "vm"]
+
+    def getCompute(self, compute_id):
+        """
+        Gets a compute by ID
+
+        :param compute_id: compute identifier
+        :returns: compute
+        """
+
+        if compute_id.startswith("http:") or compute_id.startswith("https:"):
+            u = urllib.parse.urlsplit(compute_id)
+            for compute in self._computes.values():
+                if "{}:{}".format(compute.host(), compute.port()) == u.netloc:
+                    return compute
+            raise KeyError("Compute ID {} is missing.".format(compute_id))
+        if compute_id not in self._computes:
+            self._computes[compute_id] = Compute(compute_id)
+            self.created_signal.emit(compute_id)
+        return self._computes[compute_id]
+
+    def deleteCompute(self, compute_id):
+        """
+        Deletes a compute by ID
+
+        :param compute_id: compute identifier
+        """
+
+        if compute_id in self._computes:
+            del self._computes[compute_id]
+            self._controller.delete("/computes/{compute_id}".format(compute_id=compute_id), None)
+            self.deleted_signal.emit(compute_id)
+
+    def updateList(self, computes):
+        """
+        Sync an array of compute with remote
+        """
+
+        for compute_id in copy.copy(self._computes):
+            # Delete compute on controller not in the new computes
+            if compute_id in ["local", "vm"]:
+                continue
+
+            if compute_id not in [c.id() for c in computes]:
+                log.debug("Delete compute %s", compute_id)
+                self.deleteCompute(compute_id)
+            else:
+                # Update the changed nodes
+                for c in computes:
+                    if c.id() == compute_id and c != self._computes[compute_id]:
+                        log.debug("Update compute %s", compute_id)
+                        self._controller.put("/computes/" + compute_id, None, body=c.__json__())
+                        self._computes[compute_id] = c
+                        self.updated_signal.emit(compute_id)
+        # Create the new nodes
+        for compute in computes:
+            if compute.id() not in self._computes:
+                log.debug("Create compute %s", compute.id())
+                self._controller.post("/computes", None, body=compute.__json__())
+                self._computes[compute.id()] = compute
+                self.created_signal.emit(compute.id())
+
+    @staticmethod
+    def reset():
+        ComputeManager._instance = None
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of ComputeManager.
+        :returns: instance of ComputeManager
+        """
+
+        if not hasattr(ComputeManager, '_instance') or ComputeManager._instance is None:
+            ComputeManager._instance = ComputeManager()
+        return ComputeManager._instance

gns3/compute_summary_view.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Compute summary view that list all the compute, their status.
+"""
+
+from .qt import QtGui, QtCore, QtWidgets
+from .compute_manager import ComputeManager
+from .topology import Topology
+from .node import Node
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ComputeItem(QtWidgets.QTreeWidgetItem):
+    """
+    Custom item for the QTreeWidget instance
+    (topology summary view).
+
+    :param parent: parent widget
+    :param compute: Compute instance
+    """
+
+    def __init__(self, parent, compute):
+
+        super().__init__(parent)
+        self._compute = compute
+        self._parent = parent
+        self._status = "unknown"
+
+        self._refreshStatusSlot()
+
+    def _refreshStatusSlot(self):
+        """
+        Changes the icon to show the node status (started, stopped etc.)
+        """
+
+        if self is None:
+            return
+
+        usage = None
+        text = self._compute.name()
+
+        if self._compute.cpuUsagePercent() is not None:
+            text = "{} CPU {}%, RAM {}%".format(text, self._compute.cpuUsagePercent(), self._compute.memoryUsagePercent())
+
+        self.setText(0, text)
+        if self._compute.connected():
+            self._status = "connected"
+            self.setToolTip(0, "Server {} version {} running on {}".format(self._compute.name(),
+                                                                           self._compute.capabilities().get("version", "n/a"),
+                                                                           self._compute.capabilities().get("platform", "")))
+            if usage is None or (self._compute.cpuUsagePercent() < 90 and self._compute.memoryUsagePercent() < 90):
+                self.setIcon(0, QtGui.QIcon(':/icons/led_green.svg'))
+            else:
+                self.setIcon(0, QtGui.QIcon(':/icons/led_yellow.svg'))
+        else:
+            last_error = self._compute.lastError()
+            if last_error:
+                self.setToolTip(0, "Failed to connect to {}: {}".format(self._compute.name(), last_error))
+                self.setIcon(0, QtGui.QIcon(':/icons/led_red.svg'))
+            elif self._status == "unknown":
+                self.setToolTip(0, "Discovering or connecting to {}...".format(self._compute.name()))
+                self.setIcon(0, QtGui.QIcon(':/icons/led_gray.svg'))
+            else:
+                self._status = "stopped"
+                self.setToolTip(0, "{} is stopped or cannot be reached".format(self._compute.name()))
+                self.setIcon(0, QtGui.QIcon(':/icons/led_red.svg'))
+        self._parent.sortItems(0, QtCore.Qt.AscendingOrder)
+
+        # add nodes belonging to this compute
+        self.takeChildren()
+        nodes = Topology.instance().nodes()
+        for node in nodes:
+            if node.compute().id() == self._compute.id():
+                item = QtWidgets.QTreeWidgetItem()
+                item.setText(0, node.name())
+                if node.status() == Node.started:
+                    item.setIcon(0, QtGui.QIcon(':/icons/led_green.svg'))
+                elif node.status() == Node.suspended:
+                    item.setIcon(0, QtGui.QIcon(':/icons/led_yellow.svg'))
+                else:
+                    item.setIcon(0, QtGui.QIcon(':/icons/led_red.svg'))
+                self.addChild(item)
+        self.sortChildren(0, QtCore.Qt.AscendingOrder)
+
+
+class ComputeSummaryView(QtWidgets.QTreeWidget):
+    """
+    Compute summary view implementation.
+
+    :param parent: parent widget
+    """
+
+    def __init__(self, parent):
+
+        super().__init__(parent)
+        self._computes = {}
+        ComputeManager.instance().created_signal.connect(self._computeAddedSlot)
+        ComputeManager.instance().updated_signal.connect(self._computeUpdatedSlot)
+        ComputeManager.instance().deleted_signal.connect(self._computeRemovedSlot)
+        for compute in ComputeManager.instance().computes():
+            self._computeAddedSlot(compute.id())
+
+    def _computeAddedSlot(self, compute_id):
+        """
+        Called when a compute is added to the list of computes
+
+        :params url: URL of the compute
+        """
+
+        compute = ComputeManager.instance().getCompute(compute_id)
+        if ComputeManager.instance().computeIsTheRemoteGNS3VM(compute):
+            return
+        self._computes[compute_id] = ComputeItem(self, compute)
+
+    def _computeUpdatedSlot(self, compute_id):
+        """
+        Called when a compute is updated
+
+        :params url: URL of the compute
+        """
+
+        if compute_id in self._computes:
+            compute = ComputeManager.instance().getCompute(compute_id)
+            # We hide the remote GNS3 VM
+            if ComputeManager.instance().computeIsTheRemoteGNS3VM(compute):
+                self._computeRemovedSlot(compute_id)
+            else:
+                self._computes[compute_id]._refreshStatusSlot()
+        else:
+            self._computeAddedSlot(compute_id)
+
+    def _computeRemovedSlot(self, compute_id):
+        """
+        Called when a compute is removed to the list of computes
+
+        :params url: URL of the compute
+        """
+
+        if compute_id in self._computes:
+            self.takeTopLevelItem(self.indexOfTopLevelItem(self._computes[compute_id]))
+            del self._computes[compute_id]

gns3/console_cmd.py

@@ -19,40 +19,281 @@
 Handles commands typed in the GNS3 console.
 """
 
+import os
 import sys
 import cmd
-import logging
+import struct
+from .qt import sip
+
+from .node import Node
+from .qt import QtCore
 from .version import __version__
 
+import logging
+log = logging.getLogger(__name__)
+
 
 class ConsoleCmd(cmd.Cmd):
 
-    def __init__(self):
+    def do_env(self, args):
+        """
+        Show the environment variables used by GNS3.
+        """
 
-        cmd.Cmd.__init__(self)
+        for key, val in os.environ.items():
+            print("{}={}".format(key, val))
 
     def do_version(self, args):
+        """
+        Show the version of GNS3 and its dependencies.
+        """
 
-        print("GNS3 version {}".format(__version__))
+        compiled = ""
+        if hasattr(sys, "frozen"):
+            compiled = "(compiled)"
+        print("GNS3 version is {} {}".format(__version__, compiled))
+        print("Python version is {}.{}.{} ({}-bit) with {} encoding".format(sys.version_info[0],
+                                                                            sys.version_info[1],
+                                                                            sys.version_info[2],
+                                                                            struct.calcsize("P") * 8,
+                                                                            sys.getdefaultencoding()))
+        print("Qt version is {}".format(QtCore.QT_VERSION_STR))
+
+        print("PyQt version is {}".format(QtCore.PYQT_VERSION_STR))
+        print("SIP version is {}".format(sip.SIP_VERSION_STR))
+
+    def do_start(self, args):
+        """
+        Start all or a specific device(s)
+        start {/all | device1 [device2] ...}
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_start.__doc__)
+            return
+
+        devices = args.split()
+        if '/all' in devices:
+            for node in self._topology.nodes():
+                if hasattr(node, "start") and node.initialized():
+                    node.start()
+        else:
+            for device in devices:
+                for node in self._topology.nodes():
+                    if node.name() == device:
+                        if hasattr(node, "start") and node.initialized():
+                            node.start()
+                        else:
+                            print("{} cannot be started".format(device))
+                        break
+
+    def do_stop(self, args):
+        """
+        Stop all or a specific device(s)
+        stop {/all | device1 [device2] ...}
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_stop.__doc__)
+            return
+
+        devices = args.split()
+        if '/all' in devices:
+            for node in self._topology.nodes():
+                if hasattr(node, "stop") and node.initialized():
+                    node.stop()
+        else:
+            for device in devices:
+                for node in self._topology.nodes():
+                    if node.name() == device:
+                        if hasattr(node, "stop") and node.initialized():
+                            node.stop()
+                        else:
+                            print("{} cannot be stopped".format(device))
+                        break
+
+    def do_suspend(self, args):
+        """
+        Suspend all or a specific device(s)
+        suspend {/all | device1 [device2] ...}
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_suspend.__doc__)
+            return
+
+        devices = args.split()
+        if '/all' in devices:
+            for node in self._topology.nodes():
+                if hasattr(node, "suspend") and node.initialized():
+                    node.suspend()
+        else:
+            for device in devices:
+                for node in self._topology.nodes():
+                    if node.name() == device:
+                        if hasattr(node, "suspend") and node.initialized():
+                            node.suspend()
+                        else:
+                            print("{} cannot be suspended".format(device))
+                        break
+
+    def do_reload(self, args):
+        """
+        Reload all or a specific device(s)
+        reload {/all | device1 [device2] ...}
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_reload.__doc__)
+            return
+
+        devices = args.split()
+        if '/all' in devices:
+            for node in self._topology.nodes():
+                if hasattr(node, "reload") and node.initialized():
+                    node.reload()
+        else:
+            for device in devices:
+                for node in self._topology.nodes():
+                    if node.name() == device:
+                        if hasattr(node, "reload") and node.initialized():
+                            node.reload()
+                        else:
+                            print("{} cannot be reloaded".format(device))
+                        break
+
+    def do_console(self, args):
+        """
+        Console to all or a specific device(s)
+        console {/all | device1 [device2] ...}
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_console.__doc__)
+            return
+
+        devices = args.split()
+        if '/all' in devices:
+            for node in self._topology.nodes():
+                if hasattr(node, "console") and node.initialized() and node.status() == Node.started:
+                    self._start_console(node)
+        else:
+            for device in devices:
+                for node in self._topology.nodes():
+                    if node.name() == device:
+                        if hasattr(node, "console") and node.initialized() and node.status() == Node.started:
+                            self._start_console(node)
+                        else:
+                            print("Cannot console to {}".format(device))
+                        break
+
+    def do_log(self, args):
+        """
+        Log a message
+
+        log level message
+        """
+
+        args = args.split()
+        if len(args) == 0:
+            return
+        level = args.pop(0)
+        if level == "info":
+            log.info(" ".join(args))
+        elif level == "warning":
+            log.warning(" ".join(args))
+        else:
+            log.error(" ".join(args))
+
+    def _start_console(self, node):
+        """
+        Starts a console application for a specific node.
+
+        :param node: Node instance
+        """
+
+        console_port = node.console()
+        from .telnet_console import nodeTelnetConsole
+        nodeTelnetConsole(node, console_port)
 
     def do_debug(self, args):
         """
-        debug [level] (0 or 1).
+        Activate or deactivate debugging messages
+        debug [level] (0, 1 or 2).
         """
 
+        if '?' in args or args.strip() == "":
+            print(self.do_debug.__doc__)
+            return
+
         root = logging.getLogger()
-        ch = logging.StreamHandler(sys.stdout)
 
         if len(args) == 1:
-            try:
-                level = int(args[0])
-                if level == 0:
-                    print("Deactivating debugging")
-                    root.removeHandler(ch)
-                else:
-                    print("Activating debugging")
-                    root.addHandler(ch)
-            except:
-                print(self.do_debug.__doc__)
+            level = int(args[0])
+            if level == 0:
+                print("Deactivating debugging")
+                root.setLevel(logging.INFO)
+            else:
+                print("Activating debugging")
+                root.setLevel(logging.DEBUG)
+            from .main_window import MainWindow
+            MainWindow.instance().setSettings({"debug_level": level})
         else:
             print(self.do_debug.__doc__)
+
+    def _show_device(self, params):
+        """
+        Handles the 'show device' command.
+
+        :param params: list of parameters
+        """
+
+        if len(params) == 1:
+            # print out all the device info
+            for node in self._topology.nodes():
+                if hasattr(node, "info"):
+                    print(node.info())
+
+        elif len(params) >= 2:
+            # this is a 'show device <device_name>'
+            params.pop(0)
+            for param in params:
+                node_name = param
+                found = False
+                for node in self._topology.nodes():
+                    if hasattr(node, "info") and node.name() == node_name:
+                        print(node.info())
+                        found = True
+                        break
+
+                if found is False:
+                    print("{}: no such device".format(node_name))
+                    continue
+
+    def do_show(self, args):
+        """
+        Show detail information about every device in current lab:
+        show device
+
+        Show detail information about a device:
+        show device <device_name>
+        """
+
+        if '?' in args or args.strip() == "":
+            print(self.do_show.__doc__)
+            return
+
+        params = args.split()
+        if params[0] == "device":
+            self._show_device(params)
+        else:
+            print(self.do_show.__doc__)
+
+    def do_help(self, args):
+        """
+        Get help on commands
+        'help' or '?' with no arguments prints a list of commands for which help is available
+        'help <command>' or '? <command>' gives help on <command>
+        """
+
+        cmd.Cmd.do_help(self, args)

gns3/console_view.py

@@ -15,43 +15,53 @@
 # 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 sys
+from .qt import sip
+import struct
+import inspect
+import datetime
+import platform
+
+from .qt import QtCore, QtWidgets
 from .topology import Topology
 from .version import __version__
 from .console_cmd import ConsoleCmd
 from .pycutext import PyCutExt
 from .modules import MODULES
+from .local_config import LocalConfig
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ConsoleLogHandler(logging.StreamHandler):
+    """
+    Display log event to the console
+    """
+
+    def emit(self, record):
+        if sip.isdeleted(self._console_view):
+            return
+
+        message = self.format(record)
+        level_no = record.levelno
+        if level_no >= logging.ERROR:
+            self._console_view.write_message_signal.emit("{}\n".format(message), "error")
+        elif level_no >= logging.WARNING:
+            self._console_view.write_message_signal.emit("{}\n".format(message), "warning")
+        elif level_no >= logging.INFO:
+            # To avoid noise on console we display all event only if log level is debug
+            # or if we force the display in the log record
+            if "show" in record.__dict__ or logging.getLogger().getEffectiveLevel() == logging.DEBUG:
+                self._console_view.write_message_signal.emit("{}\n".format(message), "debug")
+        elif level_no >= logging.DEBUG:
+            self._console_view.write_message_signal.emit("{}\n".format(message), "debug")
 
 
 class ConsoleView(PyCutExt, ConsoleCmd):
 
-    # list of keywords to color
-    keywords = set(["aux",
-                    "capture",
-                    "clear",
-                    "console",
-                    "export",
-                    "filter",
-                    "help",
-                    "hist",
-                    "idlepc",
-                    "import",
-                    "list",
-                    "no",
-                    "push",
-                    "reload",
-                    "resume",
-                    "save",
-                    "send",
-                    "show",
-                    "start",
-                    "stop",
-                    "suspend",
-                    "telnet",
-                    "vboxexec",
-                    "qmonitor",
-                    "ver"])
+    # Emit this signal to write a message on console
+    write_message_signal = QtCore.Signal(str, str)
 
     def __init__(self, parent):
 
@@ -60,21 +70,97 @@ class ConsoleView(PyCutExt, ConsoleCmd):
         sys.ps1 = '=> '
 
         # Set introduction message
-        self.intro = "GNS3 management console. Running GNS3 Early Release (ER) version %s.\nCopyright (c) 2006-2014 GNS3 Project." % __version__
+        bitness = struct.calcsize("P") * 8
+        current_year = datetime.date.today().year
+        self.intro = "GNS3 management console.\nRunning GNS3 version {} on {} ({}-bit) with Python {} Qt {} and PyQt {}.\n" \
+                     "Copyright (c) 2006-{} GNS3 Technologies.\n" \
+                     "Use Help -> GNS3 Doctor to detect common issues." \
+                     "".format(__version__, platform.system(), bitness, platform.python_version(), QtCore.QT_VERSION_STR, QtCore.PYQT_VERSION_STR, current_year)
 
         # Parent class initialization
         try:
-            PyCutExt.__init__(self, None, self.intro, parent=parent)
+            super().__init__(None, self.intro, parent=parent)
+
+            # dynamically get all the available commands so we can color them
+            methods = inspect.getmembers(self, predicate=inspect.ismethod)
+            commands = []
+            for method in methods:
+                method_name = method[0]
+                if method_name.startswith("do_"):
+                    commands.append(method_name[3:])
+
             # put our own keywords list
-            self.colorizer.keywords = self.keywords
-            #self._Dynagen_Console_init()
+            self.colorizer.keywords = commands
         except Exception as e:
             sys.stderr.write(e)
 
+        self._handleLogs()
+
+        if LocalConfig.instance().experimental():
+            log.warning("WARNING: Experimental features enable. You can use some unfinished features and lost data.")
+
         for module in MODULES:
             instance = module.instance()
             instance.notification_signal.connect(self.writeNotification)
 
+        self.write_message_signal.connect(self._writeMessageSlot)
+
+        # required for Cmd module (do_help etc.)
+        self.stdout = sys.stdout
+        self._topology = Topology.instance()
+
+    def contextMenuEvent(self, event):
+        """
+        Handles all context menu events.
+
+        :param event: QContextMenuEvent instance
+        """
+
+        menu = self.createStandardContextMenu()
+        delete_all_action = QtWidgets.QAction("Delete All", menu)
+        delete_all_action.triggered.connect(self._deleteAllActionSlot)
+        menu.addAction(delete_all_action)
+        menu.exec_(event.globalPos());
+
+    def _deleteAllActionSlot(self):
+        """
+        Delete all action slot
+        """
+
+        self.clear()
+        self.write(self.prompt)
+        self.lines = []
+        self._clearLine()
+
+    def _writeMessageSlot(self, message, level):
+        """
+        Write a message in the console.
+        """
+        if level == "error":
+            self.write(message, error=True)
+        elif level == "warning":
+            self.write(message, warning=True)
+        else:
+            self.write(message)
+
+    def _handleLogs(self):
+        """
+        Catch log message and display them
+        """
+
+        log = logging.getLogger()
+        log_handler = ConsoleLogHandler()
+        log_handler._console_view = self
+        log.addHandler(log_handler)
+
+    def isatty(self):
+        """
+        For exception handling purposes
+        (see exception hook in the program entry point).
+        """
+
+        return False
+
     def onKeyPress_Tab(self):
         """
         Imitate cmd.Cmd.complete(self, text, state) function.
@@ -86,7 +172,7 @@ class ConsoleView(PyCutExt, ConsoleCmd):
 
         if len(self.line) > 0:
             cmd, args, _ = self.parseline(line)
-            if cmd == '':
+            if cmd is None or cmd == '':
                 compfunc = self.completedefault
             else:
                 try:
@@ -115,9 +201,9 @@ class ConsoleView(PyCutExt, ConsoleCmd):
                 self.line = newLine
                 self.point = len(newLine)
             # Else, display possible values
-            else:
+            elif self.completion_matches:
                 self.write("\n")
-                self.columnize(self.completion_matches)
+                print(" ".join(self.completion_matches))
 
         # In any case, reprint prompt + line
         self.write("\n" + sys.ps1 + str(self.line))
@@ -131,70 +217,64 @@ class ConsoleView(PyCutExt, ConsoleCmd):
         """
 
         text = "Server notification: {}".format(message)
-        self.write(text, error=True)
-        self.write("\n")
         if details:
-            self.write(details)
-            self.write("\n")
+            text += "\n" + details
+        self.write_message_signal.emit(text, "info")
 
-    def writeError(self, node_id, message):
+    def writeError(self, base_node_id, message):
         """
         Write error messages.
 
-        :param node_id: node identifier
+        :param base_node_id: base node identifier
         :param message: error message
         """
 
-        node = Topology.instance().getNode(node_id)
+        node = Topology.instance().getNode(base_node_id)
         name = ""
         if node and node.name():
             name = " {}:".format(node.name())
 
         text = "Error:{name} {message}".format(name=name,
                                                message=message)
-        self.write(text, error=True)
-        self.write("\n")
+        self.write_message_signal.emit(text, "error")
 
-    def writeWarning(self, node_id, message):
+    def writeWarning(self, base_node_id, message):
         """
         Write warning messages.
 
-        :param node_id: node identifier
+        :param base_node_id: base node identifier
         :param message: warning message
         """
 
-        node = Topology.instance().getNode(node_id)
+        node = Topology.instance().getNode(base_node_id)
         name = ""
         if node and node.name():
             name = " {}:".format(node.name())
 
         text = "Warning:{name} {message}".format(name=name,
                                                  message=message)
-        self.write(text, warning=True)
-        self.write("\n")
+        self.write_message_signal.emit(text, "warning")
 
-    def writeServerError(self, node_id, code, message):
+    def writeServerError(self, base_node_id, message):
         """
         Write server error messages coming from the server.
 
-        :param node_id: node identifier
+        :param base_node_id: Base node identifier
         :param code: error code
         :param message: error message
         """
 
-        node = Topology.instance().getNode(node_id)
+        node = Topology.instance().getNode(base_node_id)
         server = name = ""
-        if node and node.name():
-            name = " {}:".format(node.name())
-            server = "from {}:{}".format(node.server().host,
-                                    node.server().port)
+        if node:
+            if node.name():
+                name = " {}:".format(node.name())
+            server = "from {}".format(node.compute().name())
 
-        text = "Server error [{code}] {server}:{name} {message}".format(code=code,
-                                                                        server=server,
-                                                                        name=name,
-                                                                        message=message)
-        self.write(text, error=True)
-        self.write("\n")
+        text = "Server error {server}:{name} {message}".format(server=server,
+                                                               name=name,
+                                                               message=message)
+        self.write_message_signal.emit(text.strip(), "error")
 
     def _run(self):
         """
@@ -206,13 +286,12 @@ class ConsoleView(PyCutExt, ConsoleCmd):
         self.pointer = 0
         if len(self.line):
             self.history.append(self.line)
-        try:
-            self.lines.append(self.line)
-            source = "\n".join(self.lines)
-            self.more = self.onecmd(source)
-        except Exception as e:
-            print("Unknown command")
-            #print(str(e))
+            try:
+                self.lines.append(self.line)
+                source = "\n".join(self.lines)
+                self.more = self.onecmd(source)
+            except Exception as e:
+                print("Unknown error: {}".format(e))
 
         self.write(self.prompt)
         self.lines = []

gns3/controller.py

@@ -0,0 +1,499 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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 hashlib
+import tempfile
+import json
+import pathlib
+
+from .qt import QtCore, QtNetwork, QtGui, QtWidgets, QtWebSockets, qpartial, qslot
+from .symbol import Symbol
+from .local_server_config import LocalServerConfig
+from .settings import LOCAL_SERVER_SETTINGS
+from gns3.utils import parse_version
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class Controller(QtCore.QObject):
+    """
+    An instance of the server controller.
+    """
+
+    connected_signal = QtCore.Signal()
+    disconnected_signal = QtCore.Signal()
+    connection_failed_signal = QtCore.Signal()
+    project_list_updated_signal = QtCore.Signal()
+
+    def __init__(self):
+
+        super().__init__()
+        self._connected = False
+        self._connecting = False
+        self._notification_stream = None
+        self._version = None
+        self._cache_directory = tempfile.TemporaryDirectory(suffix="-gns3")
+        self._http_client = None
+        self._first_error = True
+        self._error_dialog = None
+        self._display_error = True
+        self._projects = []
+        self._websocket = QtWebSockets.QWebSocket()
+
+        # If we do multiple call in order to download the same symbol we queue them
+        self._static_asset_download_queue = {}
+
+    def host(self):
+
+        return self._http_client.host()
+
+    def version(self):
+        return self._version
+
+    def isRemote(self):
+        """
+        :returns Boolean: True if the controller is remote
+        """
+
+        settings = LocalServerConfig.instance().loadSettings("Server", LOCAL_SERVER_SETTINGS)
+        return not settings["auto_start"]
+
+    def connecting(self):
+        """
+        :returns: True if connection is in progress
+        """
+
+        return self._connecting
+
+    def connected(self):
+        """
+        Is the controller connected
+        """
+
+        return self._connected
+
+    def httpClient(self):
+        """
+        :returns: HTTP client to connect to the controller
+        """
+
+        return self._http_client
+
+    def setHttpClient(self, http_client):
+        """
+        :param http_client: Instance of HTTP client to communicate with the server
+        """
+
+        self._http_client = http_client
+        if self._http_client:
+            if self.isRemote():
+                self._http_client.setMaxTimeDifferenceBetweenQueries(120)
+            self._http_client.connection_connected_signal.connect(self._httpClientConnectedSlot)
+            self._http_client.connection_disconnected_signal.connect(self._httpClientDisconnectedSlot)
+            self._connectingToServer()
+
+    def getHttpClient(self):
+        """
+        :return: Instance of HTTP client to communicate with the server
+        """
+
+        return self._http_client
+
+    def setDisplayError(self, val):
+        """
+        Allow error to be visible or not
+        """
+
+        self._display_error = val
+        self._first_error = True
+
+    def _connectingToServer(self):
+        """
+        Connection process as started
+        """
+
+        self._connected = False
+        self._connecting = True
+        status, json_data = self.httpClient().getSynchronous('GET', '/version', timeout=60)
+        self._versionGetSlot(json_data, status is None or status >= 300)
+
+    def _httpClientDisconnectedSlot(self):
+        if self._connected:
+            self._connected = False
+            self.disconnected_signal.emit()
+            self._connectingToServer()
+            self.stopListenNotifications()
+
+    def _versionGetSlot(self, result, error=False, **kwargs):
+        """
+        Called after the initial version get
+        """
+
+        if error:
+            if self._first_error:
+                self._connecting = False
+                self.connection_failed_signal.emit()
+                if self._display_error:
+                    self._error_dialog = QtWidgets.QMessageBox(self.parent())
+                    self._error_dialog.setWindowModality(QtCore.Qt.ApplicationModal)
+                    self._error_dialog.setWindowTitle("Connection to server")
+                    if result and "message" in result:
+                        self._error_dialog.setText("Error when connecting to the GNS3 server:\n{}".format(result["message"]))
+                    else:
+                        self._error_dialog.setText("Cannot connect to the GNS3 server")
+                    self._error_dialog.setIcon(QtWidgets.QMessageBox.Critical)
+                    self._error_dialog.show()
+            # Try to connect again in 5 seconds
+            QtCore.QTimer.singleShot(5000, qpartial(self.get, '/version', self._versionGetSlot, showProgress=self._first_error))
+            self._first_error = False
+        else:
+            self._first_error = True
+            if self._error_dialog:
+                self._error_dialog.reject()
+                self._error_dialog = None
+            self._version = result.get("version")
+            self._http_client.connection_connected_signal.emit()
+
+    def _httpClientConnectedSlot(self):
+
+        if not self._connected:
+            self._connected = True
+            self._connecting = False
+            self.connected_signal.emit()
+            self.refreshProjectList()
+            self._startListenNotifications()
+
+    def post(self, *args, **kwargs):
+        return self.createHTTPQuery("POST", *args, **kwargs)
+
+    def get(self, *args, **kwargs):
+        return self.createHTTPQuery("GET", *args, **kwargs)
+
+    def put(self, *args, **kwargs):
+        return self.createHTTPQuery("PUT", *args, **kwargs)
+
+    def delete(self, *args, **kwargs):
+        return self.createHTTPQuery("DELETE", *args, **kwargs)
+
+    def getCompute(self, path, compute_id, *args, **kwargs):
+        """
+        API get on a specific compute
+        """
+
+        compute_id = self.__fix_compute_id(compute_id)
+        path = "/computes/{}{}".format(compute_id, path)
+        return self.get(path, *args, **kwargs)
+
+    def postCompute(self, path, compute_id, *args, **kwargs):
+        """
+        API post on a specific compute
+        """
+
+        compute_id = self.__fix_compute_id(compute_id)
+        path = "/computes/{}{}".format(compute_id, path)
+        return self.post(path, *args, **kwargs)
+
+    def __fix_compute_id(self, compute_id):
+        """
+        Support for remote server <= 1.5
+        This fix should be not require after the 2.1
+        when all the templates will be managed on server
+        """
+
+        #FIXME: remove this?
+        if compute_id.startswith("http:") or compute_id.startswith("https:"):
+            from .compute_manager import ComputeManager
+            try:
+                return ComputeManager.instance().getCompute(compute_id).id()
+            except KeyError:
+                return compute_id
+        return compute_id
+
+    def getEndpoint(self, path, compute_id, *args, **kwargs):
+        """
+        API post on a specific compute
+        """
+
+        compute_id = self.__fix_compute_id(compute_id)
+        path = "/computes/endpoint/{}{}".format(compute_id, path)
+        return self.get(path, *args, **kwargs)
+
+    def putCompute(self, path, compute_id, *args, **kwargs):
+        """
+        API put on a specific compute
+        """
+
+        compute_id = self.__fix_compute_id(compute_id)
+        path = "/computes/{}{}".format(compute_id, path)
+        return self.put(path, *args, **kwargs)
+
+    def createHTTPQuery(self, method, path, *args, **kwargs):
+        """
+        Forward the query to the HTTP client or controller depending of the path
+        """
+
+        if self._http_client:
+            return self._http_client.createHTTPQuery(method, path, *args, **kwargs)
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of Controller.
+        :returns: instance of Controller
+        """
+
+        if not hasattr(Controller, '_instance') or Controller._instance is None:
+            Controller._instance = Controller()
+        return Controller._instance
+
+    def getStatic(self, url, callback, fallback=None):
+        """
+        Get a URL from the /static on controller and cache it on disk
+
+        :param url: URL without the protocol and host part
+        :param callback: Callback to call when file is ready
+        :param fallback: Fallback url in case of error
+        """
+
+        if not self._http_client:
+            return
+
+        path = self.getStaticCachedPath(url)
+
+        if os.path.exists(path):
+            callback(path)
+        elif path in self._static_asset_download_queue:
+            self._static_asset_download_queue[path].append((callback, fallback, ))
+        else:
+            self._static_asset_download_queue[path] = [(callback, fallback, )]
+            self._http_client.createHTTPQuery("GET", url, qpartial(self._getStaticCallback, url, path))
+
+    def _getStaticCallback(self, url, path, result, error=False, raw_body=None, **kwargs):
+        if path not in self._static_asset_download_queue:
+            return
+
+        if error:
+            fallback_used = False
+            for callback, fallback in self._static_asset_download_queue[path]:
+                if fallback:
+                    self.getStatic(fallback, callback)
+                fallback_used = True
+            if fallback_used:
+                log.debug("Error while downloading file: {}".format(url))
+            del self._static_asset_download_queue[path]
+            return
+        try:
+            with open(path, "wb+") as f:
+                f.write(raw_body)
+        except OSError as e:
+            log.error("Can't write to {}: {}".format(path, str(e)))
+            return
+        log.debug("File stored {} for {}".format(path, url))
+        for callback, fallback in self._static_asset_download_queue[path]:
+            callback(path)
+        del self._static_asset_download_queue[path]
+
+    def getStaticCachedPath(self, url):
+        """
+        Returns static cached (hashed) path
+
+        :param url:
+        """
+        m = hashlib.md5()
+        m.update(url.encode())
+        if ".svg" in url:
+            extension = ".svg"
+        else:
+            extension = ".png"
+        path = os.path.join(self._cache_directory.name, m.hexdigest() + extension)
+        return path
+
+    def clearStaticCache(self):
+        """
+        Clear the cache directory.
+        """
+
+        for filename in os.listdir(self._cache_directory.name):
+            if filename.endswith(".svg") or filename.endswith(".png"):
+                try:
+                    os.remove(os.path.join(self._cache_directory.name, filename))
+                except OSError as e:
+                    log.debug("Error deleting cached symbol '{}':{}".format(filename, e))
+                    continue
+
+    def getSymbolIcon(self, symbol_id, callback, fallback=None):
+        """
+        Get a QIcon for a symbol from the controller
+
+        :param symbol_id: Symbol id
+        :param callback: Callback to call when file is ready
+        :param fallback: Fallback symbol if not found
+        """
+        if symbol_id is None:
+            self.getStatic(Symbol(fallback).url(), qpartial(self._getIconCallback, callback))
+        else:
+            if fallback:
+                fallback = Symbol(fallback).url()
+            self.getStatic(Symbol(symbol_id).url(), qpartial(self._getIconCallback, callback), fallback=fallback)
+
+    def _getIconCallback(self, callback, path):
+
+        pixmap = QtGui.QPixmap(path)
+        if pixmap.isNull():
+            log.debug("Invalid symbol {}".format(path))
+            path = ":/icons/cancel.svg"
+        icon = QtGui.QIcon()
+        icon.addFile(path)
+        callback(icon)
+
+    def uploadSymbol(self, symbol_id, path):
+
+        self.post("/symbols/" + symbol_id + "/raw",
+                  qpartial(self._finishSymbolUpload, path),
+                  body=pathlib.Path(path), progressText="Uploading {}".format(symbol_id), timeout=None)
+
+    def _finishSymbolUpload(self, path, result, error=False, **kwargs):
+
+        if error:
+            log.error("Error while uploading symbol: {}: {}".format(path, result.get("message", "unknown")))
+            return
+
+        # Refresh the templates list
+        from .template_manager import TemplateManager
+        TemplateManager.instance().templates_changed_signal.emit()
+
+    def getSymbols(self, callback):
+        self.get('/symbols', callback=callback)
+
+    def deleteProject(self, project_id, callback=None):
+        Controller.instance().delete("/projects/{}".format(project_id), qpartial(self._deleteProjectCallback, callback=callback, project_id=project_id))
+
+    def _deleteProjectCallback(self, result, error=False, project_id=None, callback=None, **kwargs):
+        if error:
+            log.error("Error while deleting project: {}".format(result["message"]))
+        else:
+            self.refreshProjectList()
+
+        self._projects = [p for p in self._projects if p["project_id"] != project_id]
+
+        if callback:
+            callback(result, error=error, **kwargs)
+
+    @qslot
+    def refreshProjectList(self, *args):
+        self.get("/projects", self._projectListCallback)
+
+    def _projectListCallback(self, result, error=False, **kwargs):
+        if not error:
+            self._projects = result
+        self.project_list_updated_signal.emit()
+
+    def projects(self):
+        return self._projects
+
+    def _startListenNotifications(self):
+        if not self.connected():
+            return
+
+        # Due to bug in Qt on some version we need a dedicated network manager
+        self._notification_network_manager = QtNetwork.QNetworkAccessManager()
+        self._notification_stream = None
+
+        # Qt websocket before Qt 5.6 doesn't support auth
+        if parse_version(QtCore.QT_VERSION_STR) < parse_version("5.6.0") or parse_version(QtCore.PYQT_VERSION_STR) < parse_version("5.6.0"):
+            self._notification_stream = Controller.instance().createHTTPQuery("GET", "/notifications", self._endListenNotificationCallback,
+                                                                              downloadProgressCallback=self._event_received,
+                                                                              networkManager=self._notification_network_manager,
+                                                                              timeout=None,
+                                                                              showProgress=False,
+                                                                              ignoreErrors=True)
+
+        else:
+            self._notification_stream = self._http_client.connectWebSocket(self._websocket, "/notifications/ws")
+            self._notification_stream.textMessageReceived.connect(self._websocket_event_received)
+            self._notification_stream.error.connect(self._websocket_error)
+            self._notification_stream.sslErrors.connect(self._sslErrorsSlot)
+
+    def stopListenNotifications(self):
+        if self._notification_stream:
+            log.debug("Stop listening for notifications from controller")
+            stream = self._notification_stream
+            self._notification_stream = None
+            stream.abort()
+            self._notification_network_manager = None
+
+    def _endListenNotificationCallback(self, result, error=False, **kwargs):
+        """
+        If notification stream disconnect we reconnect to it
+        """
+        if self._notification_stream:
+            self._notification_stream = None
+            self._startListenNotifications()
+
+    @qslot
+    def _websocket_error(self, error):
+        if self._notification_stream:
+            log.error("Websocket controller notification stream error: {}".format(self._notification_stream.errorString()))
+            self._notification_stream = None
+            self._startListenNotifications()
+
+    @qslot
+    def _sslErrorsSlot(self, ssl_errors):
+
+        self._http_client.handleSslError(self._notification_stream, ssl_errors)
+
+    @qslot
+    def _websocket_event_received(self, event):
+        try:
+            self._event_received(json.loads(event))
+        except ValueError as e:
+            log.error("Invalid event received: {}".format(e))
+
+    def _event_received(self, result, *args, **kwargs):
+
+        # Log only relevant events
+        if result["action"] not in ("ping", "compute.updated"):
+            log.debug("Event received from controller stream: {}".format(result))
+        if result["action"] == "template.created" or result["action"] == "template.updated":
+            from gns3.template_manager import TemplateManager
+            TemplateManager.instance().templateDataReceivedCallback(result["event"])
+        elif result["action"] == "template.deleted":
+            from gns3.template_manager import TemplateManager
+            TemplateManager.instance().deleteTemplateCallback(result["event"])
+        elif result["action"] == "compute.created" or result["action"] == "compute.updated":
+            from .compute_manager import ComputeManager
+            ComputeManager.instance().computeDataReceivedCallback(result["event"])
+        elif result["action"] == "project.closed":
+            from .topology import Topology
+            project = Topology.instance().project()
+            if project and project.id() == result["event"]["project_id"]:
+                Topology.instance().setProject(None)
+        elif result["action"] == "project.updated":
+            from .topology import Topology
+            project = Topology.instance().project()
+            if project and project.id() == result["event"]["project_id"]:
+                project.projectUpdatedCallback(result["event"])
+        elif result["action"] == "log.error" and result["event"].get("message"):
+            log.error(result["event"].get("message"))
+        elif result["action"] == "log.warning" and result["event"].get("message"):
+            log.warning(result["event"].get("message"))
+        elif result["action"] == "log.info" and result["event"].get("message"):
+            log.info(result["event"].get("message"), extra={"show": True})
+        elif result["action"] == "ping":
+            pass

gns3/crash_report.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+try:
+    import sentry_sdk
+    from sentry_sdk.integrations.logging import LoggingIntegration
+    SENTRY_SDK_AVAILABLE = True
+except ImportError:
+    # Sentry SDK is not installed with deb package in order to simplify packaging
+    SENTRY_SDK_AVAILABLE = False
+
+import sys
+import os
+import platform
+import struct
+import distro
+
+from .version import __version__, __version_info__
+
+import logging
+log = logging.getLogger(__name__)
+
+
+# Dev build
+if __version_info__[3] != 0:
+    import faulthandler
+    # Display a traceback in case of segfault crash. Usefull when frozen
+    # Not enabled by default for security reason
+    log.debug("Enable catching segfault")
+    faulthandler.enable()
+
+
+class CrashReport:
+
+    """
+    Report crash to a third party service
+    """
+
+    DSN = "https://235ecbc961abe34327a4a397d8ce427a@o19455.ingest.us.sentry.io/38506"
+    _instance = None
+
+    def __init__(self):
+        # We don't want sentry making noise if an error is caught when we don't have internet
+        sentry_errors = logging.getLogger('sentry.errors')
+        sentry_errors.disabled = True
+
+        sentry_uncaught = logging.getLogger('sentry.errors.uncaught')
+        sentry_uncaught.disabled = True
+        self._sentry_initialized = False
+
+        if SENTRY_SDK_AVAILABLE:
+            # Don't send log records as events.
+            sentry_logging = LoggingIntegration(level=logging.INFO, event_level=None)
+            try:
+                sentry_sdk.init(dsn=CrashReport.DSN,
+                                release=__version__,
+                                default_integrations=False,
+                                integrations=[sentry_logging])
+            except Exception as e:
+                log.error("Crash report could not be sent: {}".format(e))
+                return
+
+            tags = {
+                "os:name": platform.system(),
+                "os:release": platform.release(),
+                "os:win_32": " ".join(platform.win32_ver()),
+                "os:mac": "{} {}".format(platform.mac_ver()[0], platform.mac_ver()[2]),
+                "os:linux": distro.name(pretty=True),
+
+            }
+
+            self._add_qt_information(tags)
+
+            with sentry_sdk.configure_scope() as scope:
+                for key, value in tags.items():
+                    scope.set_tag(key, value)
+
+            extra_context = {
+                "python:version": "{}.{}.{}".format(sys.version_info[0],
+                                                    sys.version_info[1],
+                                                    sys.version_info[2]),
+                "python:bit": struct.calcsize("P") * 8,
+                "python:encoding": sys.getdefaultencoding(),
+                "python:frozen": "{}".format(hasattr(sys, "frozen"))
+            }
+
+            # extra controller and compute information
+            from .controller import Controller
+            from .compute_manager import ComputeManager
+            extra_context["controller:version"] = Controller.instance().version()
+            extra_context["controller:host"] = Controller.instance().host()
+            extra_context["controller:connected"] = Controller.instance().connected()
+
+            for index, compute in enumerate(ComputeManager.instance().computes()):
+                extra_context["compute{}:id".format(index)] = compute.id()
+                extra_context["compute{}:name".format(index)] = compute.name(),
+                extra_context["compute{}:host".format(index)] = compute.host(),
+                extra_context["compute{}:connected".format(index)] = compute.connected()
+                extra_context["compute{}:platform".format(index)] = compute.capabilities().get("platform")
+                extra_context["compute{}:version".format(index)] = compute.capabilities().get("version")
+
+            with sentry_sdk.configure_scope() as scope:
+                for key, value in extra_context.items():
+                    scope.set_extra(key, value)
+
+    def captureException(self, exception, value, tb):
+
+        from .local_server import LocalServer
+        from .local_config import LocalConfig
+
+        local_server = LocalServer.instance().localServerSettings()
+        if local_server["report_errors"]:
+
+            if not SENTRY_SDK_AVAILABLE:
+                log.warning("Cannot capture exception: Sentry SDK is not available")
+                return
+
+            if os.path.exists(LocalConfig.instance().runAsRootPath()):
+                log.warning("User is running application as root. Crash reports disabled.")
+                return
+
+            if not hasattr(sys, "frozen") and os.path.exists(os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", ".git")):
+                log.warning(".git directory detected, crash reporting is turned off for developers.")
+                return
+
+            try:
+                error = (exception, value, tb)
+                sentry_sdk.capture_exception(error=error)
+                log.info("Crash report sent with event ID: {}".format(sentry_sdk.last_event_id()))
+            except Exception as e:
+                log.warning("Can't send crash report to Sentry: {}".format(e))
+
+    def _add_qt_information(self, tags):
+
+        try:
+            from .qt import QtCore
+            from .qt import sip
+        except ImportError:
+            return tags
+        tags["pyqt:version"] = QtCore.PYQT_VERSION_STR
+        tags["qt:version"] = QtCore.QT_VERSION_STR
+        tags["sip:version"] = sip.SIP_VERSION_STR
+        return tags
+
+    @classmethod
+    def instance(cls):
+        if cls._instance is None:
+            cls._instance = CrashReport()
+        return cls._instance

gns3/dialogs/about_dialog.py

@@ -15,19 +15,20 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from .qt import QtGui
-from .version import __version__
-from .ui.about_dialog_ui import Ui_AboutDialog
+from ..qt import QtWidgets
+from ..version import __version__
+from ..ui.about_dialog_ui import Ui_AboutDialog
 
 
-class AboutDialog(QtGui.QDialog, Ui_AboutDialog):
+class AboutDialog(QtWidgets.QDialog, Ui_AboutDialog):
+
     """
     About dialog.
     """
 
     def __init__(self, parent):
 
-        QtGui.QDialog.__init__(self, parent)
+        super().__init__(parent)
         self.setupUi(self)
 
         # dynamically add the current version number

gns3/dialogs/appliance_wizard.py

@@ -0,0 +1,818 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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
+from ..qt import sip
+import shutil
+
+from ..qt import QtWidgets, QtCore, QtGui, qpartial, qslot
+from ..ui.appliance_wizard_ui import Ui_ApplianceWizard
+from ..template_manager import TemplateManager
+from ..template import Template
+from ..modules import Qemu
+from ..registry.appliance import Appliance, ApplianceError
+from ..registry.registry import Registry
+from ..registry.config import Config
+from ..registry.appliance_to_template import ApplianceToTemplate
+from ..registry.image import Image
+from ..utils import human_filesize
+from ..utils.wait_for_lambda_worker import WaitForLambdaWorker
+from ..utils.progress_dialog import ProgressDialog
+from ..compute_manager import ComputeManager
+from ..controller import Controller
+from ..local_config import LocalConfig
+from ..image_upload_manager import ImageUploadManager
+from ..image_manager import ImageManager
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ApplianceWizard(QtWidgets.QWizard, Ui_ApplianceWizard):
+
+    images_changed_signal = QtCore.Signal()
+    versions_changed_signal = QtCore.Signal()
+
+    def __init__(self, parent, path):
+        super().__init__(parent)
+
+        self.setupUi(self)
+        self._refreshing = False
+        self._server_check = False
+        self._template_created = False
+        self._path = path
+
+        # count how many images are being uploaded
+        self._image_uploading_count = 0
+
+        # symbols loaded from controller
+        self._symbols = []
+
+        # connect slots
+        self.images_changed_signal.connect(self._refreshVersions)
+        self.versions_changed_signal.connect(self._versionRefreshedSlot)
+        self.uiRefreshPushButton.clicked.connect(self.images_changed_signal.emit)
+        self.uiDownloadPushButton.clicked.connect(self._downloadPushButtonClickedSlot)
+        self.uiImportPushButton.clicked.connect(self._importPushButtonClickedSlot)
+        self.uiApplianceVersionTreeWidget.currentItemChanged.connect(self._applianceVersionCurrentItemChangedSlot)
+        self.uiCreateVersionPushButton.clicked.connect(self._createVersionPushButtonClickedSlot)
+        self.allowCustomFiles.clicked.connect(self._allowCustomFilesChangedSlot)
+
+        # directories where to search for images
+        images_directories = list()
+
+        for emulator in ("QEMU", "IOU", "DYNAMIPS"):
+            emulator_images_dir = ImageManager.instance().getDirectoryForType(emulator)
+            if os.path.exists(emulator_images_dir):
+                images_directories.append(emulator_images_dir)
+
+        images_directories.append(os.path.dirname(self._path))
+        download_directory = QtCore.QStandardPaths.writableLocation(QtCore.QStandardPaths.DownloadLocation)
+        if download_directory != "" and download_directory != os.path.dirname(self._path):
+            images_directories.append(download_directory)
+
+        # registry to search for images
+        self._registry = Registry(images_directories)
+        self._registry.image_list_changed_signal.connect(self.images_changed_signal.emit)
+
+        # appliance object
+        self._appliance = Appliance(self._registry, self._path)
+        self.setWindowTitle("Install {} appliance".format(self._appliance["name"]))
+
+        # add a custom button to show appliance information
+        if self._appliance["registry_version"] < 8:
+            # FIXME: show appliance info for v8
+            self.setButtonText(QtWidgets.QWizard.CustomButton1, "&Appliance info")
+            self.setOption(QtWidgets.QWizard.HaveCustomButton1, True)
+            self.customButtonClicked.connect(self._showApplianceInfoSlot)
+
+        # customize the server selection
+        self.uiRemoteRadioButton.toggled.connect(self._remoteServerToggledSlot)
+        if hasattr(self, "uiVMRadioButton"):
+            self.uiVMRadioButton.toggled.connect(self._vmToggledSlot)
+
+        self.uiLocalRadioButton.toggled.connect(self._localToggledSlot)
+        if Controller.instance().isRemote():
+            self.uiLocalRadioButton.setText("Install the appliance on the main server")
+        else:
+            if not path.endswith('.builtin.gns3a'):
+                destination = None
+                try:
+                    destination = Config().appliances_dir
+                except OSError as e:
+                    QtWidgets.QMessageBox.critical(self.parent(), "Add appliance", "Could not find configuration file: {}".format(e))
+                except ValueError as e:
+                    QtWidgets.QMessageBox.critical(self.parent(), "Add appliance", "Invalid configuration file: {}".format(e))
+                if destination:
+                    try:
+                        os.makedirs(destination, exist_ok=True)
+                        destination = os.path.join(destination, os.path.basename(path))
+                        shutil.copy(path, destination)
+                    except OSError as e:
+                        QtWidgets.QMessageBox.warning(self.parent(), "Cannot copy {} to {}".format(path, destination), str(e))
+
+        self.uiServerWizardPage.isComplete = self._uiServerWizardPage_isComplete
+
+    def initializePage(self, page_id):
+        """
+        Initialize wizard pages.
+
+        :param page_id: page identifier
+        """
+
+        super().initializePage(page_id)
+
+        # add symbol
+        if self._appliance["category"] == "guest":
+            symbol = ":/symbols/computer.svg"
+        else:
+            symbol = ":/symbols/{}.svg".format(self._appliance["category"])
+        self.page(page_id).setPixmap(QtWidgets.QWizard.LogoPixmap, QtGui.QPixmap(symbol))
+
+        if self.page(page_id) == self.uiServerWizardPage:
+
+            Controller.instance().getSymbols(self._getSymbolsCallback)
+            template_type = self._appliance.template_type()
+            if not template_type:
+                raise ApplianceError("No template type found for appliance {}".format(self._appliance["name"]))
+            is_mac = ComputeManager.instance().localPlatform().startswith("darwin")
+            is_win = ComputeManager.instance().localPlatform().startswith("win")
+
+            self.uiRemoteServersComboBox.clear()
+            if len(ComputeManager.instance().remoteComputes()) == 0:
+                self.uiRemoteRadioButton.setEnabled(False)
+            else:
+                self.uiRemoteRadioButton.setEnabled(True)
+                for compute in ComputeManager.instance().remoteComputes():
+                    self.uiRemoteServersComboBox.addItem(compute.name(), compute)
+
+            if not ComputeManager.instance().vmCompute():
+                self.uiVMRadioButton.setEnabled(False)
+
+            if ComputeManager.instance().localPlatform() is None:
+                self.uiLocalRadioButton.setEnabled(False)
+            elif is_mac or is_win:
+                if template_type == "qemu":
+                    # disallow usage of the local server because Qemu has issues on OSX and Windows
+                    if not LocalConfig.instance().experimental():
+                        self.uiLocalRadioButton.setEnabled(False)
+                elif template_type != "dynamips":
+                    self.uiLocalRadioButton.setEnabled(False)
+
+            if ComputeManager.instance().vmCompute():
+                self.uiVMRadioButton.setChecked(True)
+            elif ComputeManager.instance().localCompute() and self.uiLocalRadioButton.isEnabled():
+                self.uiLocalRadioButton.setChecked(True)
+            elif self.uiRemoteRadioButton.isEnabled():
+                self.uiRemoteRadioButton.setChecked(True)
+            else:
+                self.uiRemoteRadioButton.setChecked(False)
+
+            if is_mac or is_win:
+                if not self.uiRemoteRadioButton.isEnabled() and not self.uiVMRadioButton.isEnabled() and not self.uiLocalRadioButton.isEnabled():
+                    QtWidgets.QMessageBox.warning(self, "GNS3 VM", "The GNS3 VM is not available, please configure the GNS3 VM before adding a new appliance.")
+
+        elif self.page(page_id) == self.uiFilesWizardPage:
+            if Controller.instance().isRemote() or self._compute_id != "local":
+                self._registry.getRemoteImageList(self._appliance.template_type(), self._compute_id)
+            else:
+                self.images_changed_signal.emit()
+
+        elif self.page(page_id) == self.uiQemuWizardPage:
+            if self._appliance.template_properties().get('kvm', 'require') == 'require':
+                self._server_check = False
+                Qemu.instance().getQemuCapabilitiesFromServer(self._compute_id, qpartial(self._qemuServerCapabilitiesCallback))
+            else:
+                self._server_check = True
+            if self._appliance["registry_version"] >= 8:
+                qemu_platform = self._appliance.template_properties()["platform"]
+            else:
+                qemu_platform = self._appliance.template_properties()["arch"]
+            Qemu.instance().getQemuBinariesFromServer(self._compute_id, qpartial(self._getQemuBinariesFromServerCallback), [qemu_platform])
+
+        elif self.page(page_id) == self.uiInstructionsPage:
+
+            installation_instructions = self._appliance.get("installation_instructions", "No installation instructions available")
+            self.uiInstructionsTextEdit.setText(installation_instructions.strip())
+
+        elif self.page(page_id) == self.uiUsageWizardPage:
+            # TODO: allow taking these info fields at the version level in v8
+            category = self._appliance["category"].replace("_", " ")
+            usage = self._appliance.get("usage", "No usage information available")
+            if self._appliance["registry_version"] >= 8:
+                default_username = self._appliance.get("default_username")
+                default_password = self._appliance.get("default_password")
+                if default_username and default_password:
+                    usage += "\n\nDefault username: {}\nDefault password: {}".format(default_username, default_password)
+
+            usage_info = """
+The template will be available in the {} category.
+            
+Usage: {}
+""".format(category, usage)
+
+            self.uiUsageTextEdit.setText(usage_info.strip())
+
+    def _qemuServerCapabilitiesCallback(self, result, error=None, *args, **kwargs):
+        """
+        Check if the server supports KVM or not
+        """
+
+        if self._appliance["registry_version"] >= 8:
+            qemu_platform = self._appliance.template_properties()["platform"]
+        else:
+            qemu_platform = self._appliance.template_properties()["arch"]
+        if error is None and "kvm" in result and qemu_platform in result["kvm"]:
+            self._server_check = True
+        else:
+            if error:
+                msg = result["message"]
+            else:
+                msg = "The selected server does not support KVM. A Linux server or the GNS3 VM running in VMware is required."
+            QtWidgets.QMessageBox.critical(self, "KVM support", msg)
+            self._server_check = False
+
+    def _uiServerWizardPage_isComplete(self):
+        return self.uiRemoteRadioButton.isEnabled() or self.uiVMRadioButton.isEnabled() or self.uiLocalRadioButton.isEnabled()
+
+    def _imageUploadedCallback(self, result, error=False, context=None, **kwargs):
+        if context is None:
+            context = {}
+        image_path = context.get("image_path", "unknown")
+        if error:
+            log.error("Error while uploading image '{}': {}".format(image_path, result["message"]))
+        else:
+            log.info("Image '{}' has been successfully uploaded".format(image_path))
+            self._registry.getRemoteImageList(self._appliance.template_type(), self._compute_id)
+
+    def _showApplianceInfoSlot(self):
+        """
+        Shows appliance information.
+        """
+
+        info = (("Product", "product_name"),
+                ("Vendor", "vendor_name"),
+                ("Availability", "availability"),
+                ("Status", "status"),
+                ("Maintainer", "maintainer"))
+
+        if "qemu" in self._appliance:
+            qemu_info = (("vCPUs", "qemu/cpus"),
+                         ("RAM", "qemu/ram"),
+                         ("Adapters", "qemu/adapters"),
+                         ("Adapter type", "qemu/adapter_type"),
+                         ("Console type", "qemu/console_type"),
+                         ("Architecture", "qemu/arch"),
+                         ("Console type", "qemu/console_type"),
+                         ("KVM", "qemu/kvm"))
+            info = info + qemu_info
+
+        elif "docker" in self._appliance:
+            docker_info = (("Image", "docker/image"),
+                           ("Adapters", "docker/adapters"),
+                           ("Console type", "docker/console_type"))
+            info = info + docker_info
+
+        elif "iou" in self._appliance:
+            iou_info = (("RAM", "iou/ram"),
+                        ("NVRAM", "iou/nvram"),
+                        ("Ethernet adapters", "iou/ethernet_adapters"),
+                        ("Serial adapters", "iou/serial_adapters"))
+            info = info + iou_info
+
+        elif "dynamips" in self._appliance:
+            dynamips_info = (("Platform", "dynamips/platform"),
+                             ("Chassis", "dynamips/chassis"),
+                             ("Midplane", "dynamips/midplane"),
+                             ("NPE", "dynamips/npe"),
+                             ("RAM", "dynamips/ram"),
+                             ("NVRAM", "dynamips/nvram"),
+                             ("slot0", "dynamips/slot0"),
+                             ("slot1", "dynamips/slot1"),
+                             ("slot2", "dynamips/slot2"),
+                             ("slot3", "dynamips/slot3"),
+                             ("slot4", "dynamips/slot4"),
+                             ("slot5", "dynamips/slot5"),
+                             ("slot6", "dynamips/slot6"),
+                             ("wic0", "dynamips/wic0"),
+                             ("wic1", "dynamips/wic1"),
+                             ("wic2", "dynamips/wic2"))
+            info = info + dynamips_info
+
+        text_info = ""
+        for (name, key) in info:
+            if "/" in key:
+                key, subkey = key.split("/")
+                value = self._appliance.get(key, {}).get(subkey, None)
+            else:
+                value = self._appliance.get(key, None)
+            if value is None:
+                continue
+            text_info += "<span style='font-weight:bold;'>{}</span>: {}<br>".format(name, value)
+
+        msgbox = QtWidgets.QMessageBox(self)
+        msgbox.setWindowTitle("Appliance information")
+        msgbox.setStyleSheet("QLabel{min-width: 600px;}") # TODO: resize details box QTextEdit{min-height: 500px;}
+        msgbox.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+        msgbox.setText(text_info)
+        msgbox.setDetailedText(self._appliance["description"])
+        msgbox.exec_()
+
+    @qslot
+    def _refreshVersions(self, *args):
+        """
+        Refresh the list of files for different versions of the appliance
+        """
+
+        if self._refreshing:
+            return
+        self._refreshing = True
+
+        self.uiFilesWizardPage.setSubTitle("Please select one version of " + self._appliance["product_name"] + " and import the required files. Files are searched in your downloads and GNS3 images directories by default")
+        worker = WaitForLambdaWorker(lambda: self._refreshDialogWorker())
+        progress_dialog = ProgressDialog(worker, "Add appliance", "Scanning directories for files...", None, busy=True, parent=self)
+        progress_dialog.show()
+
+    @qslot
+    def _versionRefreshedSlot(self, *args):
+        """
+        Called when we finish to scan the disk for new versions
+        """
+
+        if self._refreshing or self.currentPage() != self.uiFilesWizardPage:
+            return
+        self._refreshing = True
+        self.uiApplianceVersionTreeWidget.clear()
+
+        for version in self._appliance["versions"]:
+            top = QtWidgets.QTreeWidgetItem(self.uiApplianceVersionTreeWidget, ["{} version {}".format(self._appliance["product_name"], version["name"])])
+            size = 0
+            status = "Ready to install"
+            for image in version["images"].values():
+                if image["status"] == "Missing":
+                    status = "Missing files"
+
+                size += image.get("filesize", 0)
+                image_widget = QtWidgets.QTreeWidgetItem([image["filename"],
+                                                          human_filesize(image.get("filesize", 0)),
+                                                          image["status"]])
+                if image["status"] == "Missing":
+                    image_widget.setForeground(2, QtGui.QBrush(QtGui.QColor("red")))
+                else:
+                    image_widget.setForeground(2, QtGui.QBrush(QtGui.QColor("green")))
+                    image_widget.setToolTip(2, image["path"])
+
+                # Associated data stored are col 0: version, col 1: image
+                image_widget.setData(0, QtCore.Qt.UserRole, version)
+                image_widget.setData(1, QtCore.Qt.UserRole, image)
+                image_widget.setData(2, QtCore.Qt.UserRole, self._appliance)
+                top.addChild(image_widget)
+
+            font = top.font(0)
+            font.setBold(True)
+            top.setFont(0, font)
+
+            expand = True
+            if status == "Missing files":
+                top.setForeground(2, QtGui.QBrush(QtGui.QColor("red")))
+            else:
+                expand = False
+                top.setForeground(2, QtGui.QBrush(QtGui.QColor("green")))
+
+            top.setData(1, QtCore.Qt.DisplayRole, human_filesize(size))
+            top.setData(2, QtCore.Qt.DisplayRole, status)
+            top.setData(0, QtCore.Qt.UserRole, version)
+            top.setData(2, QtCore.Qt.UserRole, self._appliance)
+            self.uiApplianceVersionTreeWidget.addTopLevelItem(top)
+            if expand:
+                top.setExpanded(True)
+
+        if len(self._appliance["versions"]) > 0:
+            for column in range(self.uiApplianceVersionTreeWidget.columnCount()):
+                self.uiApplianceVersionTreeWidget.resizeColumnToContents(column)
+
+        self._refreshing = False
+
+    def _getSymbolsCallback(self, result, error=False, **kwargs):
+        """
+        Callback to retrieve the appliance symbols.
+        """
+
+        if error:
+            log.warning("Cannot load symbols from controller")
+        else:
+            self._symbols = result
+
+    def _refreshDialogWorker(self):
+        """
+        Scan local directory in order to find images on the disk
+        """
+
+        # Docker do not have versions
+        if "versions" not in self._appliance:
+            return
+
+        for version in self._appliance["versions"]:
+            for image in version["images"].values():
+                img = self._registry.search_image_file(self._appliance.template_type(),
+                                                       image["filename"],
+                                                       image.get("md5sum"),
+                                                       image.get("filesize"),
+                                                       strict_md5_check=not self.allowCustomFiles.isChecked())
+                if img:
+                    if img.location == "local":
+                        image["status"] = "Found locally"
+                    else:
+                        compute = ComputeManager.instance().getCompute(self._compute_id)
+                        image["status"] = "Found on {}".format(compute.name())
+                    image["md5sum"] = img.md5sum
+                    image["filesize"] = img.filesize
+                    image["path"] = img.path
+                else:
+                    image["status"] = "Missing"
+        self._refreshing = False
+        self.versions_changed_signal.emit()
+
+    @qslot
+    def _applianceVersionCurrentItemChangedSlot(self, current, previous):
+        """
+        Called when user select a different item in the list of appliance files
+        """
+
+        self.uiDownloadPushButton.hide()
+        self.uiImportPushButton.hide()
+
+        if current is None or sip.isdeleted(current):
+            return
+
+        image = current.data(1, QtCore.Qt.UserRole)
+        if image is not None:
+            if "direct_download_url" in image or "download_url" in image:
+                self.uiDownloadPushButton.show()
+            self.uiImportPushButton.show()
+
+    @qslot
+    def _downloadPushButtonClickedSlot(self, *args):
+        """
+        Called when user wants to download an appliance image.
+        The file should be selected first.
+        """
+
+        if self._refreshing:
+            return False
+
+        current = self.uiApplianceVersionTreeWidget.currentItem()
+
+        if current is None or sip.isdeleted(current):
+            return
+
+        data = current.data(1, QtCore.Qt.UserRole)
+        if data is not None:
+            if "direct_download_url" in data:
+                QtGui.QDesktopServices.openUrl(QtCore.QUrl(data["direct_download_url"]))
+                if "compression" in data:
+                    QtWidgets.QMessageBox.warning(self, "Add appliance", "The file is compressed with '{}', it must be uncompressed first".format(data["compression"]))
+            else:
+                QtWidgets.QMessageBox.warning(self, "Add appliance", "Download will redirect you where the required file can be downloaded, you may have to be registered with the vendor in order to download the file.")
+                QtGui.QDesktopServices.openUrl(QtCore.QUrl(data["download_url"]))
+
+    @qslot
+    def _createVersionPushButtonClickedSlot(self, *args):
+        """
+        Allow user to create a new version of an appliance
+        """
+
+        current = self.uiApplianceVersionTreeWidget.currentItem()
+        if current is None:
+            QtWidgets.QMessageBox.critical(self.parent(), "Base version", "Please select a base version")
+            return
+        base_version = current.data(0, QtCore.Qt.UserRole)
+
+        new_version_name, ok = QtWidgets.QInputDialog.getText(self, "Creating a new version", "Create a new version for this appliance.\nPlease share your experience on the GNS3 community if this version works.\n\nVersion name:", QtWidgets.QLineEdit.Normal, base_version.get("name"))
+        if ok:
+            new_version = {"name": new_version_name}
+            new_version["images"] = {}
+
+            for disk_type in base_version["images"]:
+                base_filename = base_version["images"][disk_type]["filename"]
+                filename, ok = QtWidgets.QInputDialog.getText(self, "Image", "Disk image filename for {}".format(disk_type), QtWidgets.QLineEdit.Normal, base_filename)
+                if not ok:
+                    filename = base_filename
+                new_version["images"][disk_type] = {"filename": filename, "version": new_version_name}
+
+            try:
+                self._appliance.create_new_version(new_version)
+            except ApplianceError as e:
+                QtWidgets.QMessageBox.critical(self.parent(), "Create new version", str(e))
+                return
+            self.images_changed_signal.emit()
+
+    @qslot
+    def _importPushButtonClickedSlot(self, *args):
+        """
+        Called when user wants to import an appliance images.
+        The file should be selected first.
+        """
+
+        if self._refreshing:
+            return False
+
+        current = self.uiApplianceVersionTreeWidget.currentItem()
+        if not current:
+            return
+        disk = current.data(1, QtCore.Qt.UserRole)
+
+        path, _ = QtWidgets.QFileDialog.getOpenFileName()
+        if len(path) == 0:
+            return
+
+        image = Image(self._appliance.template_type(), path, filename=disk["filename"])
+        try:
+            if "md5sum" in disk and image.md5sum != disk["md5sum"]:
+                reply = QtWidgets.QMessageBox.question(self, "Add appliance",
+                                                       "This is not the correct file. The MD5 sum is {} and should be {}.\nDo you want to accept it at your own risks?".format(image.md5sum, disk["md5sum"]),
+                                                       QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No)
+                if reply == QtWidgets.QMessageBox.No:
+                    return
+        except OSError as e:
+            QtWidgets.QMessageBox.warning(self.parent(), "Add appliance", "Can't access to the image file {}: {}.".format(path, str(e)))
+            return
+
+        image_upload_manger = ImageUploadManager(image, Controller.instance(), self._compute_id, self._imageUploadedCallback, LocalConfig.instance().directFileUpload())
+        image_upload_manger.upload()
+
+    def _getQemuBinariesFromServerCallback(self, result, error=False, **kwargs):
+        """
+        Callback for getQemuBinariesFromServer.
+
+        :param result: server response
+        :param error: indicates an error (boolean)
+        """
+
+        if error:
+            QtWidgets.QMessageBox.critical(self, "Qemu binaries", "{}".format(result["message"]))
+        else:
+            self.uiQemuListComboBox.clear()
+            for qemu in result:
+                if qemu["version"]:
+                    self.uiQemuListComboBox.addItem("{path} (v{version})".format(path=qemu["path"], version=qemu["version"]), qemu["path"])
+                else:
+                    self.uiQemuListComboBox.addItem("{path}".format(path=qemu["path"]), qemu["path"])
+            if self.uiQemuListComboBox.count() == 1:
+                self.next()
+            else:
+                if self._appliance["registry_version"] >= 8:
+                    qemu_platform = self._appliance.template_properties()["platform"]
+                else:
+                    qemu_platform = self._appliance.template_properties()["arch"]
+                i = self.uiQemuListComboBox.findData(qemu_platform, flags=QtCore.Qt.MatchEndsWith)
+                if i != -1:
+                    self.uiQemuListComboBox.setCurrentIndex(i)
+
+    def _install(self, version):
+        """
+        Install the appliance in GNS3
+
+        :params version: appliance version name
+        """
+
+        if version is None:
+            appliance_configuration = self._appliance.copy()
+            if self._appliance.template_type() != "docker":
+                # only Docker do not have versions
+                return False
+        else:
+            try:
+                appliance_configuration = self._appliance.search_images_for_version(version)
+            except ApplianceError as e:
+                QtWidgets.QMessageBox.critical(self.parent(), "Add appliance", str(e))
+                return False
+
+        template_manager = TemplateManager().instance()
+        while len(appliance_configuration["name"]) == 0 or not template_manager.is_name_available(appliance_configuration["name"]):
+            QtWidgets.QMessageBox.warning(self.parent(), "Add template", "The name \"{}\" is already used by another template".format(appliance_configuration["name"]))
+            appliance_configuration["name"], ok = QtWidgets.QInputDialog.getText(self.parent(), "Add template", "New name:", QtWidgets.QLineEdit.Normal, appliance_configuration["name"])
+            if not ok:
+                return False
+            appliance_configuration["name"] = appliance_configuration["name"].strip()
+
+        if self._appliance["registry_version"] >= 8:
+            if "settings" in appliance_configuration:
+                for settings in appliance_configuration["settings"]:
+                    if settings["template_type"] == "qemu":
+                        settings["template_properties"]["path"] = self.uiQemuListComboBox.currentData()
+        elif "qemu" in appliance_configuration:
+            appliance_configuration["qemu"]["path"] = self.uiQemuListComboBox.currentData()
+
+        new_template = ApplianceToTemplate().new_template(appliance_configuration, self._compute_id, version, self._symbols, parent=self)
+        TemplateManager.instance().createTemplate(Template(new_template), callback=self._templateCreatedCallback)
+        return False
+
+        #worker = WaitForLambdaWorker(lambda: self._create_template(appliance_configuration, self._compute_id), allowed_exceptions=[ConfigException, OSError])
+        #progress_dialog = ProgressDialog(worker, "Add template", "Installing a new template...", None, busy=True, parent=self)
+        #progress_dialog.show()
+        #if progress_dialog.exec_():
+        #    QtWidgets.QMessageBox.information(self.parent(), "Add template", "{} template has been installed!".format(appliance_configuration["name"]))
+        #    return True
+        #return False
+
+        # worker = WaitForLambdaWorker(lambda: config.save(), allowed_exceptions=[ConfigException, OSError])
+        # progress_dialog = ProgressDialog(worker, "Add appliance", "Install the appliance...", None, busy=True, parent=self)
+        # progress_dialog.show()
+        # if progress_dialog.exec_():
+        #     QtWidgets.QMessageBox.information(self.parent(), "Add appliance", "{} installed!".format(appliance_configuration["name"]))
+        #     return True
+
+    def _templateCreatedCallback(self, result, error=False, **kwargs):
+
+        if error is True:
+            QtWidgets.QMessageBox.critical(self.parent(), "Add template", "The template cannot be created: {}".format(result.get("message", "unknown")))
+            return
+
+        QtWidgets.QMessageBox.information(self.parent(), "Add template", "The appliance has been installed and a template named '{}' has been successfully created!".format(result["name"]))
+        self._template_created = True
+        self.done(True)
+
+    def _uploadImages(self, name, version):
+        """
+        Upload an image the compute.
+        """
+
+        try:
+            appliance_configuration = self._appliance.search_images_for_version(version)
+        except ApplianceError as e:
+            QtWidgets.QMessageBox.critical(self, "Appliance","Cannot install {} version {}: {}".format(name, version, e))
+            return
+        for image in appliance_configuration["images"]:
+            if image["location"] == "local":
+                if not Controller.instance().isRemote() and self._compute_id == "local" and image["path"].startswith(ImageManager.instance().getDirectory()):
+                    log.debug("{} is already on the local server".format(image["path"]))
+                    return
+                image = Image(self._appliance.template_type(), image["path"], filename=image["filename"])
+                image_upload_manager = ImageUploadManager(image, Controller.instance(), self._compute_id, self._applianceImageUploadedCallback, LocalConfig.instance().directFileUpload())
+                image_upload_manager.upload()
+                self._image_uploading_count += 1
+
+    def _applianceImageUploadedCallback(self, result, error=False, context=None, **kwargs):
+        if context is None:
+            context = {}
+        image_path = context.get("image_path", "unknown")
+        if error:
+            log.error("Error while uploading image '{}': {}".format(image_path, result["message"]))
+        else:
+            log.info("Image '{}' has been successfully uploaded".format(image_path))
+            self._image_uploading_count -= 1
+
+    def nextId(self):
+        if self.currentPage() == self.uiServerWizardPage:
+            if self._appliance.template_type() == "docker":
+                # skip Qemu binary selection and files pages if this is a Docker appliance
+                return super().nextId() + 3
+            elif self._appliance.template_type() != "qemu":
+                # skip the Qemu binary selection page if not a Qemu appliance
+                return super().nextId() + 1
+        if self.currentPage() == self.uiQemuWizardPage:
+            if not self._appliance.get("installation_instructions"):
+                # skip the installation instructions page if there are no instructions
+                return super().nextId() + 1
+        return super().nextId()
+
+    def validateCurrentPage(self):
+        """
+        Validates the settings.
+        """
+
+        if self.currentPage() == self.uiFilesWizardPage:
+            # validate the files page
+
+            if self._refreshing:
+                return False
+            current = self.uiApplianceVersionTreeWidget.currentItem()
+            if current is None or sip.isdeleted(current):
+                return False
+            version = current.data(0, QtCore.Qt.UserRole)
+            if version is None:
+                return False
+            appliance = current.data(2, QtCore.Qt.UserRole)
+            try:
+                self._appliance.search_images_for_version(version["name"])
+            except ApplianceError as e:
+                QtWidgets.QMessageBox.critical(self, "Appliance", "Cannot install {} version {}: {}".format(appliance["name"], version["name"], e))
+                return False
+            reply = QtWidgets.QMessageBox.question(self, "Appliance", "Would you like to install {} version {}?".format(appliance["name"], version["name"]),
+                                                   QtWidgets.QMessageBox.Yes, QtWidgets.QMessageBox.No)
+            if reply == QtWidgets.QMessageBox.No:
+                return False
+
+            self._uploadImages(appliance["name"], version["name"])
+
+        elif self.currentPage() == self.uiUsageWizardPage:
+            # validate the usage page
+
+            if self._template_created:
+                return True
+            if self._image_uploading_count > 0:
+                QtWidgets.QMessageBox.critical(self, "Add appliance", "Please wait for appliance files to be uploaded")
+                return False
+            current = self.uiApplianceVersionTreeWidget.currentItem()
+            if current:
+                version = current.data(0, QtCore.Qt.UserRole)
+                return self._install(version["name"])
+            else:
+                return self._install(None)
+
+        elif self.currentPage() == self.uiServerWizardPage:
+            # validate the server page
+
+            if self.uiRemoteRadioButton.isChecked():
+                if len(ComputeManager.instance().remoteComputes()) == 0:
+                    QtWidgets.QMessageBox.critical(self, "Remote server", "There is no remote servers configured in your preferences")
+                    return False
+                self._compute_id = self.uiRemoteServersComboBox.itemData(self.uiRemoteServersComboBox.currentIndex()).id()
+            elif hasattr(self, "uiVMRadioButton") and self.uiVMRadioButton.isChecked():
+                self._compute_id = "vm"
+            else:
+                if ComputeManager.instance().localPlatform():
+                    if (ComputeManager.instance().localPlatform().startswith("darwin") or ComputeManager.instance().localPlatform().startswith("win")):
+                        if "qemu" in self._appliance:
+                            reply = QtWidgets.QMessageBox.question(self, "Appliance", "Qemu on Windows and macOS is not supported by the GNS3 team. Do you want to continue?", QtWidgets.QMessageBox.Yes, QtWidgets.QMessageBox.No)
+                            if reply == QtWidgets.QMessageBox.No:
+                                return False
+                self._compute_id = "local"
+
+        elif self.currentPage() == self.uiQemuWizardPage:
+            # validate the Qemu
+            if self._server_check is False:
+                QtWidgets.QMessageBox.critical(self, "Checking for KVM support", "Please wait for the server to reply...")
+                return False
+            if self.uiQemuListComboBox.currentIndex() == -1:
+                QtWidgets.QMessageBox.critical(self, "Qemu binary", "No compatible Qemu binary selected")
+                return False
+        return True
+
+    @qslot
+    def _vmToggledSlot(self, checked):
+        """
+        Slot for when the VM radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(False)
+            self.uiRemoteServersGroupBox.hide()
+
+    @qslot
+    def _remoteServerToggledSlot(self, checked):
+        """
+        Slot for when the remote server radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(True)
+            self.uiRemoteServersGroupBox.show()
+
+    @qslot
+    def _localToggledSlot(self, checked):
+        """
+        Slot for when the local server radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(False)
+            self.uiRemoteServersGroupBox.hide()
+
+    @qslot
+    def _allowCustomFilesChangedSlot(self, checked):
+        """
+        Slot for when user want to upload images which don't match md5
+
+        :param checked: if allows or doesn't allow custom files
+        :return:
+        """
+        if checked:
+            reply = QtWidgets.QMessageBox.question(self, "Custom files",
+                "This option allows files with different MD5 checksums. This feature is only for advanced users and can lead "
+                "to unexpected problems. Do you want to proceed?",
+                QtWidgets.QMessageBox.Yes, QtWidgets.QMessageBox.No)
+
+            if reply == QtWidgets.QMessageBox.No:
+                self.allowCustomFiles.setChecked(False)
+                return False

gns3/dialogs/capture_dialog.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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/>.
+
+from gns3.qt import QtWidgets
+from gns3.ui.capture_dialog_ui import Ui_CaptureDialog
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class CaptureDialog(QtWidgets.QDialog, Ui_CaptureDialog):
+    """
+    This dialog allow configure the packet capture
+    """
+
+    def __init__(self, parent, file_name, auto_start, ethernet_link=True):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Ok).clicked.connect(self._okButtonClickedSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Cancel).clicked.connect(self.reject)
+
+        if ethernet_link:
+            self.uiDataLinkTypeComboBox.addItem("Ethernet", "DLT_EN10MB")
+        else:
+            self.uiDataLinkTypeComboBox.addItem("Cisco HDLC", "DLT_C_HDLC")
+            self.uiDataLinkTypeComboBox.addItem("Cisco PPP", "DLT_PPP_SERIAL")
+            self.uiDataLinkTypeComboBox.addItem("Frame Relay", "DLT_FRELAY")
+            self.uiDataLinkTypeComboBox.addItem("ATM", "DLT_ATM_RFC1483")
+
+        self.uiCaptureFileNameLineEdit.setText(file_name)
+        self.uiStartCommandCheckBox.setChecked(auto_start)
+
+    def _okButtonClickedSlot(self):
+        if len(self.fileName()) == 0:
+            QtWidgets.QMessageBox.warning(self.parent(), "Packet capture", "Please provide a file name for the capture")
+            return
+        self.accept()
+
+    def fileName(self):
+        return self.uiCaptureFileNameLineEdit.text()
+
+    def dataLink(self):
+        """
+        Type of link for capture
+        """
+        return self.uiDataLinkTypeComboBox.currentData()
+
+    def commandAutoStart(self):
+        return self.uiStartCommandCheckBox.isChecked()
+
+
+if __name__ == '__main__':
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    main = QtWidgets.QMainWindow()
+    dialog = CaptureDialog(main, "test.pcap")
+    dialog.show()
+    exit_code = app.exec_()
+    print(dialog.dataLink())
+    print(dialog.fileName())

gns3/dialogs/configuration_dialog.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Dialog to configure and update node settings using widget pages.
+"""
+
+from ..qt import QtWidgets
+from ..ui.configuration_dialog_ui import Ui_configurationDialog
+from .node_properties_dialog import ConfigurationError
+
+
+class ConfigurationDialog(QtWidgets.QDialog, Ui_configurationDialog):
+
+    """
+    Configuration dialog implementation.
+
+    :param name: node template name
+    :param settings: node template settings
+    :param configuration_page: QWidget page
+    :param parent: parent widget
+    """
+
+    def __init__(self, name, settings, configuration_page, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self.uiTitleLabel.setText(name)
+        self.setWindowTitle(configuration_page.windowTitle())
+        self.uiConfigStackedWidget.addWidget(configuration_page)
+        self.uiConfigStackedWidget.setCurrentWidget(configuration_page)
+        self.setModal(True)
+        configuration_page.loadSettings(settings)
+        self._settings = settings
+        self._configuration_page = configuration_page
+
+    def settings(self):
+        return self._settings
+
+    def on_uiButtonBox_clicked(self, button):
+        """
+        Slot called when a button of the uiButtonBox is clicked.
+
+        :param button: button that was clicked (QAbstractButton)
+        """
+
+        if button == self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Cancel):
+            QtWidgets.QDialog.reject(self)
+        else:
+            try:
+                self._configuration_page.saveSettings(self._settings)
+            except ConfigurationError:
+                return
+            QtWidgets.QDialog.accept(self)

gns3/dialogs/console_command_dialog.py

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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 sys
+import copy
+
+from gns3.qt import QtWidgets
+from gns3.local_config import LocalConfig
+from gns3.ui.console_command_dialog_ui import Ui_uiConsoleCommandDialog
+from gns3.settings import PRECONFIGURED_TELNET_CONSOLE_COMMANDS, \
+        PRECONFIGURED_VNC_CONSOLE_COMMANDS,                      \
+        PRECONFIGURED_SPICE_CONSOLE_COMMANDS,                    \
+        CUSTOM_CONSOLE_COMMANDS_SETTINGS
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ConsoleCommandDialog(QtWidgets.QDialog, Ui_uiConsoleCommandDialog):
+    """
+    This dialog allow user to select the command used to start a
+    console.
+    """
+
+    def __init__(self, parent, console_type="telnet", current=None):
+        """
+        :params console_type: telnet, serial, vnc or spice
+        :params current: Current console command
+        """
+        super().__init__(parent)
+        self.setupUi(self)
+        if console_type == "spice+agent":
+            # special case for spice+agent, use the spice console type
+            console_type = "spice"
+        self._console_type = console_type
+        self._current = current
+
+        self._settings = LocalConfig.instance().loadSectionSettings("CustomConsoleCommands", CUSTOM_CONSOLE_COMMANDS_SETTINGS)
+
+        self.uiCommandComboBox.currentIndexChanged.connect(self.commandComboBoxCurrentIndexChangedSlot)
+        self.uiCommandPlainTextEdit.textChanged.connect(self.textChangedSlot)
+        self.uiSavePushButton.clicked.connect(self.savePushButtonClickedSlot)
+        self.uiRemovePushButton.clicked.connect(self.removePushButtonClickedSlot)
+
+        self._refreshList()
+
+    def _refreshList(self):
+        if self._console_type == "telnet":
+            self._consoles = copy.copy(PRECONFIGURED_TELNET_CONSOLE_COMMANDS)
+            self._consoles.update(self._settings[self._console_type])
+        elif self._console_type == "vnc":
+            self._consoles = copy.copy(PRECONFIGURED_VNC_CONSOLE_COMMANDS)
+            self._consoles.update(self._settings[self._console_type])
+        elif self._console_type == "spice":
+            self._consoles = copy.copy(PRECONFIGURED_SPICE_CONSOLE_COMMANDS)
+            self._consoles.update(self._settings[self._console_type])
+
+        self.uiCommandComboBox.clear()
+        self.uiCommandComboBox.addItem("Custom", "")
+        for name, cmd in sorted(self._consoles.items(), key=(lambda item: item[0].lower())):
+            self.uiCommandComboBox.addItem(name, cmd)
+
+        if self._current:
+            self.uiCommandPlainTextEdit.setPlainText(self._current)
+        else:
+            self.uiCommandComboBox.setCurrentIndex(1)
+
+    def removePushButtonClickedSlot(self):
+        """
+        Remove the custom command from the custom list
+        """
+        self._settings[self._console_type].pop(self.uiCommandComboBox.currentText())
+        LocalConfig.instance().saveSectionSettings("CustomConsoleCommands", self._settings)
+        self._current = None
+        self._refreshList()
+
+    def savePushButtonClickedSlot(self):
+        """
+        Save a custom command to the list
+        """
+        name, ok = QtWidgets.QInputDialog.getText(self, "Add a command", "Command name:", QtWidgets.QLineEdit.Normal)
+        command = self.uiCommandPlainTextEdit.toPlainText().strip()
+        if ok and len(command) > 0:
+            if command not in self._consoles.values():
+                self._settings[self._console_type][name] = command
+                self._current = command
+                LocalConfig.instance().saveSectionSettings("CustomConsoleCommands", self._settings)
+                self._refreshList()
+
+    def textChangedSlot(self):
+        index = self.uiCommandComboBox.findData(self.uiCommandPlainTextEdit.toPlainText())
+        if index == -1:
+            index = 0
+        self.uiCommandComboBox.setCurrentIndex(index)
+
+    def commandComboBoxCurrentIndexChangedSlot(self, index):
+        self.uiRemovePushButton.hide()
+        # Ignore custom command
+        if index != 0:
+            self.uiCommandPlainTextEdit.setPlainText(self.uiCommandComboBox.currentData())
+            self.uiSavePushButton.hide()
+            if self.uiCommandComboBox.currentText() in self._settings[self._console_type].keys():
+                self.uiRemovePushButton.show()
+        else:
+            self.uiSavePushButton.show()
+
+    @staticmethod
+    def getCommand(parent, console_type="telnet", current=None):
+        dialog = ConsoleCommandDialog(parent, console_type=console_type, current=current)
+        dialog.show()
+        if dialog.exec_():
+            return True, dialog.uiCommandPlainTextEdit.toPlainText().replace("\n", " ")
+        return False, None
+
+
+if __name__ == '__main__':
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    main = QtWidgets.QMainWindow()
+    (ok, command) = ConsoleCommandDialog.getCommand(main, console_type="telnet", current=list(PRECONFIGURED_TELNET_CONSOLE_COMMANDS.items())[0][1])
+    print(ok)
+    print(command)
+

gns3/dialogs/custom_adapters_configuration_dialog.py

@@ -0,0 +1,205 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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/>.
+
+"""
+Custom adapters configuration.
+"""
+
+import textwrap
+import re
+
+from ..qt import QtCore, QtWidgets
+from ..ui.custom_adapters_configuration_dialog_ui import Ui_CustomAdaptersConfigurationDialog
+
+
+class NoEditDelegate(QtWidgets.QStyledItemDelegate):
+
+    def __init__(self, parent=None):
+        QtWidgets.QStyledItemDelegate.__init__(self, parent=parent)
+
+    def createEditor(self, parent, option, index):
+        return None
+
+
+class TreeWidgetItem(QtWidgets.QTreeWidgetItem):
+
+    def __lt__(self, other):
+        column = self.treeWidget().sortColumn()
+        key1 = self.text(column)
+        key2 = other.text(column)
+        return self.natural_sort_key(key1) < self.natural_sort_key(key2)
+
+    @staticmethod
+    def natural_sort_key(key):
+        regex = r'(\d*\.\d+|\d+)'
+        parts = re.split(regex, key)
+        return tuple((e if i % 2 == 0 else float(e)) for i, e in enumerate(parts))
+
+
+class CustomAdaptersConfigurationDialog(QtWidgets.QDialog, Ui_CustomAdaptersConfigurationDialog):
+    """
+    Custom adapters configuration dialog.
+
+    :param parent: parent widget
+    """
+
+    def __init__(self, ports, custom_adapters, default_adapter_type=None, adapter_types=None, base_mac_address=None, parent=None):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self._ports = ports
+        self._default_adapter_type = default_adapter_type
+        self._adapter_types = adapter_types
+        self._custom_adapters = custom_adapters
+        self._base_mac_address = base_mac_address
+
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset).clicked.connect(self._resetSlot)
+
+        if self._default_adapter_type and self._adapter_types:
+            self.uiAdaptersTreeWidget.setColumnCount(3)
+            self.uiAdaptersTreeWidget.headerItem().setText(2, "Adapter type")
+
+        if self._base_mac_address:
+            self.uiAdaptersTreeWidget.setColumnCount(4)
+            self.uiAdaptersTreeWidget.headerItem().setText(3, "MAC address")
+
+        self._populateWidgets()
+
+        # resize to fit the tree widget
+        width = 0
+        for column in range(self.uiAdaptersTreeWidget.columnCount()):
+            width += 20 + self.uiAdaptersTreeWidget.columnWidth(column)
+        self.resize(QtCore.QSize(width, self.height()))
+
+    def _getCustomAdapterSettings(self, adapter_number):
+
+        for custom_adapter in self._custom_adapters:
+            if custom_adapter["adapter_number"] == adapter_number:
+                return custom_adapter
+        return {}
+
+    def _MacToInteger(self, mac_address):
+        """
+        Convert a macaddress with the format 00:0c:29:11:b0:0a to a int
+
+        :param mac_address: The mac address
+
+        :returns: Integer
+        """
+
+        return int(mac_address.replace(":", ""), 16)
+
+    def _IntegerToMac(self, integer):
+        """
+        Convert an integer to a mac address
+        """
+
+        return ":".join(textwrap.wrap("%012x" % (integer), width=2))
+
+    def _populateWidgets(self):
+
+        adapter_number = 0
+        for port_name in self._ports:
+            item = TreeWidgetItem(self.uiAdaptersTreeWidget)
+            item.setFlags(item.flags() | QtCore.Qt.ItemIsEditable)
+            item.setText(0, "Adapter {}".format(adapter_number))
+            item.setData(0, QtCore.Qt.UserRole, adapter_number)
+            item.setData(1, QtCore.Qt.UserRole, port_name)
+            custom_adapter = self._getCustomAdapterSettings(adapter_number)
+            item.setText(1, custom_adapter.get("port_name", port_name))
+
+            if self._default_adapter_type and self._adapter_types:
+                combobox = QtWidgets.QComboBox(self)
+                if type(self._adapter_types) == list:
+                    for adapter_type in self._adapter_types:
+                        combobox.addItem("{}".format(adapter_type))
+                else:
+                    index = 0
+                    for adapter_type, adapter_description in self._adapter_types.items():
+                        combobox.addItem("{}".format(adapter_type))
+                        combobox.setItemData(index, adapter_description, QtCore.Qt.ToolTipRole)
+                        index += 1
+                adapter_type_index = combobox.findText(custom_adapter.get("adapter_type", self._default_adapter_type))
+                combobox.setCurrentIndex(adapter_type_index)
+                self.uiAdaptersTreeWidget.setItemWidget(item, 2, combobox)
+
+            if self._base_mac_address:
+                self.uiAdaptersTreeWidget.addTopLevelItem(item)
+                line_edit = QtWidgets.QLineEdit(self)
+                line_edit.setInputMask("HH:HH:HH:HH:HH:HH;_")
+                mac_address = self._IntegerToMac(self._MacToInteger(self._base_mac_address) + adapter_number)
+                line_edit.setText(custom_adapter.get("mac_address", mac_address))
+                self.uiAdaptersTreeWidget.setItemWidget(item, 3, line_edit)
+            adapter_number += 1
+
+        self.uiAdaptersTreeWidget.setItemDelegateForColumn(0, NoEditDelegate(self))
+        self.uiAdaptersTreeWidget.sortByColumn(0, QtCore.Qt.AscendingOrder)
+        self.uiAdaptersTreeWidget.setSortingEnabled(True)
+
+        for column in range(self.uiAdaptersTreeWidget.columnCount()):
+            self.uiAdaptersTreeWidget.resizeColumnToContents(column)
+
+    def _resetSlot(self):
+
+        self.uiAdaptersTreeWidget.clear()
+        self._custom_adapters.clear()
+        self._populateWidgets()
+
+    def _updateCustomAdapters(self):
+
+        self._custom_adapters.clear()
+        for row in range(self.uiAdaptersTreeWidget.topLevelItemCount()):
+            custom_adapter_settings = {}
+            item = self.uiAdaptersTreeWidget.topLevelItem(row)
+            port_name = item.text(1)
+            adapter_number = item.data(0, QtCore.Qt.UserRole)
+            custom_adapter_settings["adapter_number"] = adapter_number
+            original_port_name = item.data(1, QtCore.Qt.UserRole)
+            if not port_name:
+                QtWidgets.QMessageBox.critical(self, "Port name", "Port name cannot be empty for adapter {}".format(adapter_number))
+                return False
+            if original_port_name != port_name:
+                custom_adapter_settings["port_name"] = port_name
+            if self._default_adapter_type and self._adapter_types:
+                adapter_type = self.uiAdaptersTreeWidget.itemWidget(item, 2).currentText()
+                if self._default_adapter_type != adapter_type:
+                    custom_adapter_settings["adapter_type"] = adapter_type
+            if self._base_mac_address:
+                mac_address = self.uiAdaptersTreeWidget.itemWidget(item, 3).text()
+                if mac_address and mac_address != ":::::":
+                    if not re.search(r"""^([0-9a-fA-F]{2}[:]){5}[0-9a-fA-F]{2}$""", mac_address):
+                        QtWidgets.QMessageBox.critical(self, "MAC address", "Invalid MAC address (format required: hh:hh:hh:hh:hh:hh)")
+                        return False
+                    default_mac_address = self._IntegerToMac(self._MacToInteger(self._base_mac_address) + adapter_number)
+                    if mac_address != default_mac_address:
+                        custom_adapter_settings["mac_address"] = mac_address
+            if len(custom_adapter_settings) > 1:
+                # only save if there is more than the adapter_number key
+                self._custom_adapters.append(custom_adapter_settings.copy())
+        return True
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            if not self._updateCustomAdapters():
+                return
+        super().done(result)

gns3/dialogs/doctor_dialog.py

@@ -0,0 +1,226 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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 psutil
+import platform
+import os
+import stat
+import sys
+import struct
+
+from gns3.qt import QtWidgets
+from gns3.ui.doctor_dialog_ui import Ui_DoctorDialog
+from gns3.local_server import LocalServer
+from gns3.local_config import LocalConfig
+from gns3 import version
+from gns3.modules.vmware import VMware
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class DoctorDialog(QtWidgets.QDialog, Ui_DoctorDialog):
+    """
+    This dialog allow user to detect error in his GNS3 installation.
+
+    If you want to add a test add a method starting by check. The
+    check return a tuple result and a message in case of failure.
+    """
+
+    def __init__(self, parent, console=False):
+
+        super().__init__(parent)
+        self._console = console
+        self.setupUi(self)
+        self.uiOkButton.clicked.connect(self._okButtonClickedSlot)
+        for method in sorted(dir(self)):
+            if method.startswith('check'):
+                try:
+                    self.write(getattr(self, method).__doc__ + "...")
+                    (res, msg) = getattr(self, method)()
+                    if res == 0:
+                        self.write('<span style="color: green"><strong>OK</strong></span>')
+                    elif res == 1:
+                        self.write('<span style="color: orange"><strong>WARNING</strong> {}</span>'.format(msg))
+                    elif res == 2:
+                        self.write('<span style="color: red"><strong>ERROR</strong> {}</span>'.format(msg))
+                except Exception as e:
+                    log.error("GNS3 doctor exception detected: {}".format(e), exc_info=1)
+                    self.write('<span style="color: red"><strong>FAIL</strong> The doctor failed during this test with error: {} Please check on the forum.</span>'.format(str(e)))
+                self.write("<br/>")
+
+    def write(self, text):
+        """
+        Add text to the text windows
+        """
+        if self._console:
+            print(text)
+        self.uiDoctorResultTextEdit.setHtml(self.uiDoctorResultTextEdit.toHtml() + text)
+
+    def _okButtonClickedSlot(self):
+        self.accept()
+
+    def checkLocalServerEnabled(self):
+        """Checking if the local server is enabled"""
+        if LocalServer.instance().shouldLocalServerAutoStart() is False:
+            return (2, "The local server is disabled. Go to Preferences -> Server -> Local Server and enable the local server.")
+        return (0, None)
+
+    def checkDevVersionOfGNS3(self):
+        """Checking for stable GNS3 version"""
+        if version.__version_info__[3] != 0:
+            return (1, "You are using a unstable version of GNS3.")
+        return (0, None)
+
+    def checkExperimentalFeaturesEnabled(self):
+        """Checking if experimental features are not enabled"""
+        if LocalConfig.instance().experimental():
+            return (1, "Experimental features are enabled. Turn them off by going to Preferences -> General -> Miscellaneous.")
+        return (0, None)
+
+    def checkAVGInstalled(self):
+        """Checking if AVG software is not installed"""
+
+        if sys.platform.startswith("win32"):
+            for proc in psutil.process_iter():
+                try:
+                    psinfo = proc.as_dict(["exe"])
+                    if psinfo["exe"] and "AVG\\" in psinfo["exe"]:
+                        return (2, "AVG has known issues with GNS3, even after you disable it. You must whitelist dynamips.exe in the AVG preferences.")
+                except psutil.NoSuchProcess:
+                    pass
+        return (0, None)
+
+    def checkFreeRam(self):
+        """Checking for amount of free virtual memory"""
+
+        if int(psutil.virtual_memory().available / (1024 * 1024)) < 600:
+            return (2, "You have less than 600MB of available virtual memory, this could prevent nodes to start")
+        return (0, None)
+
+    def checkVmrun(self):
+        """Checking if vmrun is installed"""
+        vmrun = VMware.instance().findVmrun()
+        if len(vmrun) == 0:
+            return (1, "The vmrun executable could not be found, VMware VMs cannot be used")
+        return (0, None)
+
+    def check64Bit(self):
+        """Check if processor is 64 bit"""
+        if platform.architecture()[0] != "64bit":
+            return (2, "The architecture {} is not supported.".format(platform.architecture()[0]))
+        return (0, None)
+
+    def checkUbridgePermission(self):
+        """Check if ubridge has the correct permission"""
+        if not sys.platform.startswith("win") and os.geteuid() == 0:
+            # we are root, so we should have privileged access.
+            return (0, None)
+
+        path = LocalServer.instance().localServerSettings().get("ubridge_path")
+        if path is None:
+            return (0, None)
+        if not os.path.exists(path):
+            return (2, "Ubridge path {path} doesn't exists".format(path=path))
+
+        if sys.platform.startswith("linux"):
+            try:
+                if "security.capability" not in os.listxattr(path) or not struct.unpack("<IIIII", os.getxattr(path, "security.capability"))[1] & 1 << 13:
+                    return (2, "Ubridge requires CAP_NET_RAW. Run sudo setcap cap_net_admin,cap_net_raw=ep {path}".format(path=path))
+            except (OSError, AttributeError) as e:
+                # Due to a Python bug, os.listxattr could be missing: https://github.com/GNS3/gns3-gui/issues/2010
+                return (1, "Could not determine if CAP_NET_RAW capability is set for uBridge: {}".format(e))
+
+        if sys.platform.startswith("darwin"):
+            if os.stat(path).st_uid != 0 or not os.stat(path).st_mode & stat.S_ISUID:
+                return (2, "Ubridge should be setuid. Run sudo chown root:admin {path} and sudo chmod 4750 {path}".format(path=path))
+        return (0, None)
+
+    def checkDynamipsPermission(self):
+        """Check if dynamips has the correct permission"""
+        if not sys.platform.startswith("win") and os.geteuid() == 0:
+            # we are root, so we should have privileged access.
+            return (0, None)
+
+        path = LocalServer.instance().localServerSettings().get("dynamips_path")
+        if path is None:
+            return (0, None)
+        if not os.path.exists(path):
+            return (2, "Dynamips path {path} doesn't exists".format(path=path))
+
+        try:
+            if sys.platform.startswith("linux") and "security.capability" in os.listxattr(path):
+                caps = os.getxattr(path, "security.capability")
+                # test the 2nd byte and check if the 13th bit (CAP_NET_RAW) is set
+                if not struct.unpack("<IIIII", caps)[1] & 1 << 13:
+                    return (2, "Dynamips requires CAP_NET_RAW. Run sudo setcap cap_net_raw,cap_net_admin+eip {path}".format(path=path))
+        except AttributeError:
+            # Due to a Python bug, os.listxattr could be missing: https://github.com/GNS3/gns3-gui/issues/2010
+            return (1, "Could not determine if CAP_NET_RAW capability is set for Dynamips (Python bug)".format(path=path))
+        return (0, None)
+
+    def checkGNS3InstalledTwice(self):
+        """Check if gns3 is not installed twice"""
+
+        if not sys.platform.startswith("win"):
+            return (0, None)
+
+        try:
+            if os.path.exists("/usr/local/bin/gns3server") and os.path.exists("/usr/bin/gns3server"):
+                return (2, "GNS3 is installed twice please remove it from /usr/local/bin")
+        except OSError:
+            pass
+        return (0, None)
+
+    def _checkWindowsService(self, service_name):
+
+        import pywintypes
+        import win32service
+        import win32serviceutil
+
+        try:
+            if win32serviceutil.QueryServiceStatus(service_name, None)[1] != win32service.SERVICE_RUNNING:
+                return False
+        except pywintypes.error as e:
+            if e.winerror == 1060:
+                return False
+            else:
+                raise
+        return True
+
+    def checkRPFServiceIsRunning(self):
+        """Check if the RPF service is running (required to use Ethernet NIOs)"""
+
+        if not sys.platform.startswith("win"):
+            return (0, None)
+
+        import pywintypes
+        try:
+            if not self._checkWindowsService("npf") and not self._checkWindowsService("npcap"):
+                return (2, "The NPF or NPCAP service is not installed, please install Winpcap or Npcap and reboot")
+        except pywintypes.error as e:
+            return (2, "Could not check if the NPF or Npcap service is running: {}".format(e.strerror))
+
+        return (0, None)
+
+if __name__ == '__main__':
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    main = QtWidgets.QMainWindow()
+    dialog = DoctorDialog(main, console=True)
+    # dialog.show()
+    #exit_code = app.exec_()

gns3/dialogs/edit_compute_dialog.py

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 re
+
+from gns3.qt import QtWidgets
+from gns3.compute import Compute
+from gns3.ui.edit_compute_dialog_ui import Ui_EditComputeDialog
+
+
+class EditComputeDialog(QtWidgets.QDialog, Ui_EditComputeDialog):
+
+    """
+    New compute dialog.
+
+    :param parent: parent widget.
+    """
+
+    def __init__(self, parent, compute=None):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self.uiEnableAuthenticationCheckBox.toggled.connect(self._enableAuthenticationSlot)
+        self._compute = compute
+        if self._compute:
+            self.uiServerNameLineEdit.setText(self._compute.name())
+            self.uiServerHostLineEdit.setText(self._compute.host())
+            self.uiServerPortSpinBox.setValue(self._compute.port())
+
+            index = self.uiServerProtocolComboBox.findText(self._compute.protocol().upper())
+            self.uiServerProtocolComboBox.setCurrentIndex(index)
+
+            if self._compute.user():
+                self.uiEnableAuthenticationCheckBox.setChecked(True)
+                self.uiServerUserLineEdit.setText(self._compute.user())
+            else:
+                self.uiEnableAuthenticationCheckBox.setChecked(False)
+                self.uiWarningLabel.setVisible(False)
+        else:
+            self.uiEnableAuthenticationCheckBox.setChecked(False)
+            self.uiWarningLabel.setVisible(False)
+        self._enableAuthenticationSlot(self.uiEnableAuthenticationCheckBox.isChecked())
+
+    def _enableAuthenticationSlot(self, state):
+        """
+        Slot to enable or not the authentication.
+        """
+
+        if self.uiEnableAuthenticationCheckBox.isChecked():
+            self.uiServerUserLineEdit.setVisible(True)
+            self.uiServerPasswordLineEdit.setVisible(True)
+            self.uiServerUserLabel.setVisible(True)
+            self.uiServerPasswordLabel.setVisible(True)
+        else:
+            self.uiServerUserLineEdit.setVisible(False)
+            self.uiServerPasswordLineEdit.setVisible(False)
+            self.uiServerUserLabel.setVisible(False)
+            self.uiServerPasswordLabel.setVisible(False)
+
+    def compute(self):
+        return self._compute
+
+    def accept(self):
+        """
+        Adds a new remote compute.
+        """
+
+        host = self.uiServerHostLineEdit.text().strip()
+        name = self.uiServerNameLineEdit.text().strip()
+        protocol = self.uiServerProtocolComboBox.currentText().lower()
+        port = self.uiServerPortSpinBox.value()
+        user = self.uiServerUserLineEdit.text().strip()
+        password = self.uiServerPasswordLineEdit.text().strip()
+
+        if not re.match(r"^[a-zA-Z0-9\.{}-]+$".format("\u0370-\u1CDF\u2C00-\u30FF\u4E00-\u9FBF"), host):
+            QtWidgets.QMessageBox.critical(self, "Remote compute", "Invalid remote server hostname {}".format(host))
+            return
+        if name == "gns3vm":
+            QtWidgets.QMessageBox.critical(self, "Remote compute", "{} is a reserved name".format(name))
+            return
+        if len(name) == 0:
+            QtWidgets.QMessageBox.critical(self, "Remote compute", "Invalid remote server name {}".format(name))
+            return
+        if port is None or port < 1:
+            QtWidgets.QMessageBox.critical(self, "Remote compute", "Invalid remote server port {}".format(port))
+            return
+
+        if not self._compute:
+            self._compute = Compute()
+        self._compute.setName(name)
+        self._compute.setProtocol(protocol)
+        self._compute.setHost(host)
+        self._compute.setPort(port)
+        if self.uiEnableAuthenticationCheckBox.isChecked():
+            self._compute.setUser(user)
+            self._compute.setPassword(password)
+        else:
+            self._compute.setUser(None)
+            self._compute.setPassword(None)
+
+        super().accept()
+
+
+if __name__ == '__main__':
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    main = QtWidgets.QMainWindow()
+    dialog = EditComputeDialog(main)
+    dialog.show()
+    exit_code = app.exec_()

gns3/dialogs/edit_project_dialog.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+from ..qt import QtWidgets, QtCore, qslot, qpartial
+from ..topology import Topology
+from ..ui.edit_project_dialog_ui import Ui_EditProjectDialog
+
+
+class EditProjectDialog(QtWidgets.QDialog, Ui_EditProjectDialog):
+    """
+    Edit current project settings
+    """
+
+    def __init__(self, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self._project = Topology.instance().project()
+        self.uiProjectNameLineEdit.setText(self._project.name())
+        self.uiProjectAutoOpenCheckBox.setChecked(self._project.autoOpen())
+        self.uiProjectAutoCloseCheckBox.setChecked(not self._project.autoClose())
+        self.uiProjectAutoStartCheckBox.setChecked(self._project.autoStart())
+        self.uiSceneWidthSpinBox.setValue(self._project.sceneWidth())
+        self.uiSceneHeightSpinBox.setValue(self._project.sceneHeight())
+        self.uiNodeGridSizeSpinBox.setValue(self._project.nodeGridSize())
+        self.uiDrawingGridSizeSpinBox.setValue(self._project.drawingGridSize())
+
+        self.uiGlobalVariablesGrid.setAlignment(QtCore.Qt.AlignTop)
+
+        self.uiNewVarButton = QtWidgets.QPushButton('Add new variable', self)
+        self.uiNewVarButton.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Fixed)
+        self.uiNewVarButton.clicked.connect(self.onAddNewVariable)
+        self.uiGlobalVariablesGrid.addWidget(self.uiNewVarButton, 0, 3, QtCore.Qt.AlignRight)
+
+        self._variables = self._project.variables()
+        if not self._variables:
+            self._variables = [{"name": "", "value": ""}]
+        self.updateGlobalVariables()
+
+    def updateGlobalVariables(self):
+        while True:
+            item = self.uiGlobalVariablesGrid.takeAt(1)
+            if item is None:
+                break
+            elif item.widget():
+                item.widget().deleteLater()
+
+        for i, variable in enumerate(self._variables, start=1):
+            nameLabel = QtWidgets.QLabel()
+            nameLabel.setText("Name:")
+            self.uiGlobalVariablesGrid.addWidget(nameLabel, i, 0)
+
+            nameEdit = QtWidgets.QLineEdit()
+            nameEdit.setText(variable.get("name", ""))
+            nameEdit.textChanged.connect(qpartial(self.onNameChange, variable))
+            self.uiGlobalVariablesGrid.addWidget(nameEdit, i, 1)
+
+            valueLabel = QtWidgets.QLabel()
+            valueLabel.setText("Value:")
+            self.uiGlobalVariablesGrid.addWidget(valueLabel, i, 2)
+
+            valueEdit = QtWidgets.QLineEdit()
+            valueEdit.setText(variable.get("value", ""))
+            valueEdit.textChanged.connect(qpartial(self.onValueChange, variable))
+            self.uiGlobalVariablesGrid.addWidget(valueEdit, i, 3)
+
+    @qslot
+    def onAddNewVariable(self, event):
+        self._variables += [{"name": "", "value": ""}]
+        self.updateGlobalVariables()
+
+    def onNameChange(self, variable, text):
+        variable["name"] = text
+
+    def onValueChange(self, variable, text):
+        variable["value"] = text
+
+    def _cleanVariables(self):
+        return [v for v in self._variables if v.get("name").strip() != ""]
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            node_grid_size = self.uiNodeGridSizeSpinBox.value()
+            drawing_grid_size = self.uiDrawingGridSizeSpinBox.value()
+            if node_grid_size % drawing_grid_size != 0:
+                QtWidgets.QMessageBox.critical(self, "Grid sizes", "Invalid grid sizes which will create overlapping lines")
+            else:
+                self._project.setNodeGridSize(node_grid_size)
+                self._project.setDrawingGridSize(drawing_grid_size)
+                self._project.setName(self.uiProjectNameLineEdit.text())
+                self._project.setAutoOpen(self.uiProjectAutoOpenCheckBox.isChecked())
+                self._project.setAutoClose(not self.uiProjectAutoCloseCheckBox.isChecked())
+                self._project.setAutoStart(self.uiProjectAutoStartCheckBox.isChecked())
+                self._project.setSceneHeight(self.uiSceneHeightSpinBox.value())
+                self._project.setSceneWidth(self.uiSceneWidthSpinBox.value())
+                self._project.setVariables(self._cleanVariables())
+                self._project.update()
+        super().done(result)

gns3/dialogs/exec_command_dialog.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+from ..qt import QtCore, QtWidgets
+from ..ui.exec_command_dialog_ui import Ui_ExecCommandDialog
+
+
+class ExecCommandDialog(QtWidgets.QDialog, Ui_ExecCommandDialog):
+
+    """
+    Execute a command and display its output.
+    """
+
+    def __init__(self, parent, command, params):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self.setWindowTitle("Executing {}".format(command))
+        self._process = QtCore.QProcess(self)
+        self._process.readyRead.connect(self._dataReadySlot)
+        self._process.start(command, params, QtCore.QProcess.Unbuffered | QtCore.QProcess.ReadWrite)
+
+    def _dataReadySlot(self):
+        """
+        Display the command output when data is ready.
+        """
+
+        cursor = self.uiOutputTextEdit.textCursor()
+        cursor.movePosition(cursor.End)
+        for line in self._process.readAll():
+            cursor.insertText(line)
+        for line in self._process.readAllStandardError():
+            cursor.insertText(line)
+        self.uiOutputTextEdit.ensureCursorVisible()
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        self._process.kill()
+        self._process.waitForFinished()
+        super().done(result)

gns3/dialogs/export_debug_dialog.py

@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2015 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/>.
+
+
+from zipfile import ZipFile
+import platform
+import psutil
+import os
+
+from gns3.version import __version__
+from gns3.qt import QtWidgets, QtCore
+from gns3.ui.export_debug_dialog_ui import Ui_ExportDebugDialog
+from gns3.local_config import LocalConfig
+from gns3.controller import Controller
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ExportDebugDialog(QtWidgets.QDialog, Ui_ExportDebugDialog):
+    """
+    This dialog allow user to export useful information
+    for remote debugging by a GNS3 developers.
+    """
+
+    def __init__(self, parent, project):
+
+        super().__init__(parent)
+        self._project = project
+        self.setupUi(self)
+        self.uiOkButton.clicked.connect(self._okButtonClickedSlot)
+
+    def _okButtonClickedSlot(self):
+        if Controller.instance().isRemote():
+            QtWidgets.QMessageBox.critical(self, "Debug", "Export debug information from a remote server is not supported")
+            self.reject()
+            return
+
+        self._path, _ = QtWidgets.QFileDialog.getSaveFileName(self, "Export debug file", None, "Zip file (*.zip)", "Zip file (*.zip)")
+
+        if len(self._path) == 0:
+            self.reject()
+            return
+
+        if Controller.instance().connected():
+            Controller.instance().post("/debug", self._exportDebugCallback)
+        else:
+            self._exportDebugCallback({}, error=True)
+
+    def _exportDebugCallback(self, result, error=False, **kwargs):
+        log.debug("Export debug information to %s", self._path)
+
+        try:
+            with ZipFile(self._path, 'w') as zip:
+                zip.writestr("debug.txt", self._getDebugData())
+                dir = LocalConfig.instance().configDirectory()
+                for filename in os.listdir(dir):
+                    path = os.path.join(dir, filename)
+                    if os.path.isfile(path):
+                        zip.write(path, filename)
+
+                dir = os.path.join(LocalConfig.instance().configDirectory(), "debug")
+                if os.path.exists(dir):
+                    for filename in os.listdir(dir):
+                        path = os.path.join(dir, filename)
+                        if os.path.isfile(path):
+                            zip.write(path, filename)
+
+                if self._project:
+                    dir = self._project.filesDir()
+                    if dir:
+                        for filename in os.listdir(dir):
+                            path = os.path.join(dir, filename)
+                            if os.path.isfile(path):
+                                zip.write(path, filename)
+        except OSError as e:
+            QtWidgets.QMessageBox.critical(self, "Debug", "Can't export debug information: {}".format(str(e)))
+        self.accept()
+
+    def _getDebugData(self):
+        try:
+            connections = psutil.net_connections()
+        # You need to be root for OSX
+        except psutil.AccessDenied:
+            connections = None
+
+        try:
+            addrs = ["* {}: {}".format(key, val) for key, val in psutil.net_if_addrs().items()]
+        except UnicodeDecodeError:
+            addrs = ["INVALID ADDR WITH UNICODE CHARACTERS"]
+
+        data = """Version: {version}
+OS: {os}
+Python: {python}
+Qt: {qt}
+PyQt: {pyqt}
+CPU: {cpu}
+Memory: {memory}
+
+Networks:
+{addrs}
+
+Open connections:
+{connections}
+
+Processus:
+""".format(
+            version=__version__,
+            qt=QtCore.QT_VERSION_STR,
+            pyqt=QtCore.PYQT_VERSION_STR,
+            os=platform.platform(),
+            python=platform.python_version(),
+            memory=psutil.virtual_memory(),
+            cpu=psutil.cpu_times(),
+            connections=connections,
+            addrs="\n".join(addrs)
+        )
+        for proc in psutil.process_iter():
+            try:
+                psinfo = proc.as_dict(attrs=["name", "exe"])
+                data += "* {} {}\n".format(psinfo["name"], psinfo["exe"])
+            except psutil.NoSuchProcess:
+                pass
+        return data
+
+if __name__ == '__main__':
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    print(ExportDebugDialog(None)._getDebugData())

gns3/dialogs/file_editor_dialog.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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
+
+from gns3.qt import QtWidgets
+from gns3.ui.file_editor_dialog_ui import Ui_FileEditorDialog
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class FileEditorDialog(QtWidgets.QDialog, Ui_FileEditorDialog):
+    """
+    This dialog allow user to detect error in his GNS3 installation.
+
+    If you want to add a test add a method starting by check. The
+    check return a tuple result and a message in case of failure.
+    """
+
+    def __init__(self, target, path, parent=None, default=""):
+
+        if parent is None:
+            from gns3.main_window import MainWindow
+            parent = MainWindow.instance()
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._target = target
+        self._path = path
+        self._default = default
+
+        self.setWindowTitle(target.name() + " " + os.path.basename(path))
+
+        self.uiRefreshButton.pressed.connect(self._refreshSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Save).clicked.connect(self._okButtonClickedSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Cancel).clicked.connect(self.reject)
+
+        self._refreshSlot()
+
+    def _okButtonClickedSlot(self):
+        text = self.uiFileTextEdit.toPlainText()
+        self._target.post("/files/" + self._path, self._saveCallback, body=text)
+
+    def _saveCallback(self, result, error=False, **kwargs):
+        if not error:
+            self.accept()
+
+    def _refreshSlot(self):
+        self._target.get("/files/" + self._path, self._getCallback)
+
+    def _getCallback(self, result, error=False, raw_body=None, **kwargs):
+        if not error:
+            self.uiFileTextEdit.setText(raw_body.decode("utf-8", errors="ignore"))
+        elif result.get("status") == 404:
+            if self._default:
+                self.uiFileTextEdit.setText(self._default)

gns3/dialogs/filter_dialog.py

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+from ..qt import QtGui, QtWidgets, qslot
+from ..ui.filter_dialog_ui import Ui_FilterDialog
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class FilterDialog(QtWidgets.QDialog, Ui_FilterDialog):
+
+    """
+    Filter dialog.
+    """
+
+    def __init__(self, parent, link):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self._link = link
+        self._filters = {}
+        self._link.updated_link_signal.connect(self._updateUiSlot)
+        self._link.listAvailableFilters(self._listAvailableFiltersCallback)
+        self._initialized = False
+        self._filter_items = {}
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applyPreferencesSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).clicked.connect(self._helpSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset).clicked.connect(self._resetSlot)
+
+    def _listAvailableFiltersCallback(self, result, error=False, *args, **kwargs):
+        if error:
+            log.warning("Error while listing information about the link: {}".format(result["message"]))
+            return
+        self._filters = result
+        self._initialized = True
+        self._updateUiSlot()
+
+    @qslot
+    def _updateUiSlot(self, *args):
+
+        # Empty the main layout
+        while True:
+            item = self.uiVerticalLayout.takeAt(0)
+            if item is None:
+                break
+            elif item.widget():
+                item.widget().deleteLater()
+
+        if len(self._filters) == 0:
+            QtWidgets.QMessageBox.critical(self, "Link", "No filter available for this link. Try with a different node type.")
+            self.reject()
+
+        self._tabWidget = QtWidgets.QTabWidget(self)
+        for i, filter in enumerate(self._filters):
+            tab = QtWidgets.QWidget()
+            self._tabWidget.addTab(tab, filter['name'])
+            self._tabWidget.setTabToolTip(i, filter['description'])
+            self._tabWidget.setTabIcon(i, QtGui.QIcon(':/icons/led_red.svg'))
+            vlayout = QtWidgets.QVBoxLayout()
+
+            gridLayout = QtWidgets.QGridLayout()
+            line = 0
+            filter["spinBoxes"] = []
+            filter["textEdits"] = []
+
+            nb_spin = 0
+
+            for param in filter["parameters"]:
+                label = QtWidgets.QLabel()
+                label.setText(param["name"] + ":")
+                gridLayout.addWidget(label, line, 0, 1, 1)
+
+                if param["type"] == "int":
+                    spinBox = QtWidgets.QSpinBox()
+                    filter["spinBoxes"].append(spinBox)
+                    spinBox.setMinimum(param["minimum"])
+                    spinBox.setMaximum(param["maximum"])
+
+                    sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Fixed)
+                    sizePolicy.setHorizontalStretch(0)
+                    sizePolicy.setVerticalStretch(0)
+                    sizePolicy.setHeightForWidth(spinBox.sizePolicy().hasHeightForWidth())
+                    spinBox.setSizePolicy(sizePolicy)
+                    try:
+                        value = self._link.filters()[filter["type"]][nb_spin]
+                        spinBox.setValue(value)
+                        if value != 0:
+                            self._tabWidget.setTabIcon(i, QtGui.QIcon(':/icons/led_green.svg'))
+                    except(KeyError, IndexError):
+                        pass
+                    nb_spin += 1
+                    gridLayout.addWidget(spinBox, line, 1, 1, 1)
+                    unit = QtWidgets.QLabel()
+                    unit.setText(param["unit"])
+                    gridLayout.addWidget(unit, line, 2, 1, 1)
+                elif param["type"] == "text":
+                    textEdit = QtWidgets.QTextEdit()
+                    textEdit.setAcceptRichText(False)
+                    filter["textEdits"].append(textEdit)
+                    sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+                    sizePolicy.setHorizontalStretch(0)
+                    sizePolicy.setVerticalStretch(0)
+                    textEdit.setMinimumWidth(300)
+                    textEdit.setSizePolicy(sizePolicy)
+                    try:
+                        text = self._link.filters()[filter["type"]][0]
+                        textEdit.setPlainText(text)
+                        if text:
+                            self._tabWidget.setTabIcon(i, QtGui.QIcon(':/icons/led_green.svg'))
+                    except(KeyError, IndexError):
+                        pass
+                    gridLayout.addWidget(textEdit, line, 1, 1, 1)
+
+                line += 1
+
+            spacerItem = QtWidgets.QSpacerItem(1, 1, QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Expanding)
+            gridLayout.addItem(spacerItem, line, 0, 1, 1)
+            vlayout.addLayout(gridLayout)
+            tab.setLayout(vlayout)
+
+        self.uiVerticalLayout.addWidget(self._tabWidget)
+
+    @qslot
+    def _applyPreferencesSlot(self, *args):
+        new_filters = {}
+        for filter in self._filters:
+            new_filters[filter["type"]] = []
+            for spinBox in filter["spinBoxes"]:
+                new_filters[filter["type"]].append(spinBox.value())
+            for spinBox in filter["textEdits"]:
+                new_filters[filter["type"]].append(spinBox.toPlainText())
+        self._link.setFilters(new_filters)
+        self._link.update()
+
+    @qslot
+    def _helpSlot(self, *args):
+        help_text = "Filters are applied to packets in both direction.\n\n"
+
+        filter_nb = 0
+        for filter in self._filters:
+            help_text += "{}: {}".format(filter["name"], filter["description"])
+            filter_nb += 1
+            if len(self._filters) != filter_nb:
+                help_text += "\n\n"
+
+        QtWidgets.QMessageBox.information(self, "Help for filters", help_text)
+
+    @qslot
+    def _resetSlot(self, *args):
+
+        filters = {}
+        self._link.setFilters(filters)
+        self._link.update()
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+        if result and self._initialized:
+            self._applyPreferencesSlot()
+        super().done(result)

gns3/dialogs/idlepc_dialog.py

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 re
+
+from ..qt import QtWidgets
+from ..topology import Topology
+from ..ui.idlepc_dialog_ui import Ui_IdlePCDialog
+
+
+class IdlePCDialog(QtWidgets.QDialog, Ui_IdlePCDialog):
+
+    """
+    Idle-PC dialog.
+    """
+
+    def __init__(self, router, idlepcs, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applySlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).clicked.connect(self._helpSlot)
+
+        self._router = router
+        self._idlepcs = idlepcs
+
+        for value in self._idlepcs:
+            # validate idle-pc format, e.g. 0x60c09aa0
+            match = re.search(r"^(0x[0-9a-f]{8})\s+\[(\d+)\]$", value)
+            if match:
+                idlepc = match.group(1)
+                count = int(match.group(2))
+                if 50 <= count <= 60:
+                    value += "*"
+                self.uiComboBox.addItem(value, idlepc)
+
+    def _helpSlot(self):
+        """
+        Shows the help for Idle-PC.
+        """
+
+        help_text = """Best Idle-PC values are obtained when IOS is in idle state, after the "Press RETURN to get started" message has appeared on the console, messages have finished displaying on the console and you have have actually pressed the RETURN key.
+
+Finding the right idle-pc value is a trial and error process, consisting of applying different Idle-PC values and monitoring the CPU usage.
+
+Select each value that appears in the list and click Apply, and note the CPU usage a few moments later. When you have found the value that minimises the CPU usage, apply that value.
+"""
+        QtWidgets.QMessageBox.information(self, "Hints for Idle-PC", help_text)
+
+    def _applySlot(self, update_template=False):
+        """
+        Applies an Idle-PC value.
+        """
+
+        if not self.uiComboBox.count():
+            QtWidgets.QMessageBox.critical(self, "Idle-PC", "Sorry could not find a valid Idle-PC value, please check again with Cisco IOS in a different state")
+            return
+
+        idlepc = self.uiComboBox.itemData(self.uiComboBox.currentIndex())
+        # apply Idle-PC to all routers with the same IOS image
+        ios_image = os.path.basename(self._router.settings()["image"])
+        for node in Topology.instance().nodes():
+            if hasattr(node, "idlepc") and node.settings()["image"] == ios_image:
+                node.setIdlepc(idlepc)
+
+        if update_template:
+            # apply the idle-pc to templates with the same IOS image
+            self._router.module().updateImageIdlepc(ios_image, idlepc)
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            self._applySlot(update_template=True)
+        super().done(result)

gns3/dialogs/new_template_wizard.py

@@ -0,0 +1,288 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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 sys
+import tempfile
+import json
+import sip
+import os
+
+from gns3.qt import QtCore, QtWidgets, qpartial
+from gns3.controller import Controller
+from gns3.appliance_manager import ApplianceManager
+
+from ..ui.new_template_wizard_ui import Ui_NewTemplateWizard
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class NewTemplateWizard(QtWidgets.QWizard, Ui_NewTemplateWizard):
+    """
+    New template wizard.
+    """
+
+    def __init__(self, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self.setWizardStyle(QtWidgets.QWizard.ModernStyle)
+        if sys.platform.startswith("darwin"):
+            # we want to see the cancel button on OSX
+            self.setOptions(QtWidgets.QWizard.NoDefaultButton)
+
+        # add a custom button to show appliance information
+        self.setButtonText(QtWidgets.QWizard.CustomButton1, "&Update from online registry")
+        self.setOption(QtWidgets.QWizard.HaveCustomButton1, True)
+        self.customButtonClicked.connect(self._downloadAppliancesSlot)
+        self.button(QtWidgets.QWizard.CustomButton1).hide()
+        self.uiFilterLineEdit.textChanged.connect(self._filterTextChangedSlot)
+        ApplianceManager.instance().appliances_changed_signal.connect(self._appliancesChangedSlot)
+
+    def _downloadAppliancesSlot(self):
+        """
+        Request server to update appliances from online registry.
+        """
+
+        ApplianceManager.instance().refresh(update=True)
+        Controller.instance().clearStaticCache()
+
+    def _appliancesChangedSlot(self):
+        """
+        Called when the appliances have been updated.
+        """
+
+        self._get_appliances_from_server()
+        QtWidgets.QMessageBox.information(self, "Appliances", "Appliances are up-to-date!")
+
+    def _filterTextChangedSlot(self, text):
+        self._get_appliances_from_server(appliance_filter=text)
+
+    def _setItemIcon(self, item, icon):
+
+        if item is None or sip.isdeleted(item):
+            return
+        item.setIcon(0, icon)
+
+    def _get_tooltip_text(self, appliance):
+        """
+        Gets the appliance information to be displayed in the tooltip.
+        """
+
+        info = (("Product", "product_name"),
+                ("Vendor", "vendor_name"),
+                ("Availability", "availability"),
+                ("Status", "status"),
+                ("Maintainer", "maintainer"))
+
+        if "qemu" in appliance:
+            qemu_info = (("vCPUs", "qemu/cpus"),
+                         ("RAM", "qemu/ram"),
+                         ("Adapters", "qemu/adapters"),
+                         ("Adapter type", "qemu/adapter_type"),
+                         ("Console type", "qemu/console_type"),
+                         ("Architecture", "qemu/arch"),
+                         ("Console type", "qemu/console_type"),
+                         ("KVM", "qemu/kvm"))
+            info = info + qemu_info
+
+        elif "docker" in appliance:
+            docker_info = (("Image", "docker/image"),
+                           ("Adapters", "docker/adapters"),
+                           ("Console type", "docker/console_type"))
+            info = info + docker_info
+
+        elif "iou" in appliance:
+            iou_info = (("RAM", "iou/ram"),
+                        ("NVRAM", "iou/nvram"),
+                        ("Ethernet adapters", "iou/ethernet_adapters"),
+                        ("Serial adapters", "iou/serial_adapters"))
+            info = info + iou_info
+
+        elif "dynamips" in appliance:
+            dynamips_info = (("Platform", "dynamips/platform"),
+                             ("Chassis", "dynamips/chassis"),
+                             ("Midplane", "dynamips/midplane"),
+                             ("NPE", "dynamips/npe"),
+                             ("RAM", "dynamips/ram"),
+                             ("NVRAM", "dynamips/nvram"),
+                             ("slot0", "dynamips/slot0"),
+                             ("slot1", "dynamips/slot1"),
+                             ("slot2", "dynamips/slot2"),
+                             ("slot3", "dynamips/slot3"),
+                             ("slot4", "dynamips/slot4"),
+                             ("slot5", "dynamips/slot5"),
+                             ("slot6", "dynamips/slot6"),
+                             ("wic0", "dynamips/wic0"),
+                             ("wic1", "dynamips/wic1"),
+                             ("wic2", "dynamips/wic2"))
+            info = info + dynamips_info
+
+        text_info = ""
+        for (name, key) in info:
+            if "/" in key:
+                key, subkey = key.split("/")
+                value = appliance.get(key, {}).get(subkey, None)
+            else:
+                value = appliance.get(key, None)
+            if value is None:
+                continue
+            text_info += "<span style='font-weight:bold;'>{}</span>: {}<br>".format(name, value)
+
+        return text_info
+
+    def _get_appliances_from_server(self, appliance_filter=None):
+        """
+        Gets the appliances from the server and display them.
+        """
+
+        self.uiAppliancesTreeWidget.clear()
+        parent_routers = QtWidgets.QTreeWidgetItem(self.uiAppliancesTreeWidget)
+        parent_routers.setText(0, "Routers")
+        parent_routers.setFlags(parent_routers.flags() & ~QtCore.Qt.ItemIsSelectable)
+        parent_switches = QtWidgets.QTreeWidgetItem(self.uiAppliancesTreeWidget)
+        parent_switches.setText(0, "Switches")
+        parent_switches.setFlags(parent_switches.flags() & ~QtCore.Qt.ItemIsSelectable)
+        parent_guests = QtWidgets.QTreeWidgetItem(self.uiAppliancesTreeWidget)
+        parent_guests.setText(0, "Guests")
+        parent_guests.setFlags(parent_guests.flags() & ~QtCore.Qt.ItemIsSelectable)
+        parent_firewalls = QtWidgets.QTreeWidgetItem(self.uiAppliancesTreeWidget)
+        parent_firewalls.setText(0, "Firewalls")
+        parent_firewalls.setFlags(parent_firewalls.flags() & ~QtCore.Qt.ItemIsSelectable)
+        self.uiAppliancesTreeWidget.expandAll()
+
+        for appliance in ApplianceManager.instance().appliances():
+            if appliance_filter is None:
+                appliance_filter = self.uiFilterLineEdit.text().strip()
+            if appliance_filter and appliance_filter.lower() not in appliance["name"].lower():
+                continue
+
+            if appliance["category"] == "router":
+                item = QtWidgets.QTreeWidgetItem(parent_routers)
+            elif appliance["category"].endswith("switch"):
+                item = QtWidgets.QTreeWidgetItem(parent_switches)
+            elif appliance["category"] == "firewall":
+                item = QtWidgets.QTreeWidgetItem(parent_firewalls)
+            elif appliance["category"] == "guest":
+                item = QtWidgets.QTreeWidgetItem(parent_guests)
+            if appliance["builtin"]:
+                appliance_name = appliance["name"]
+            else:
+                appliance_name = "{} (custom)".format(appliance["name"])
+
+            item.setText(0, appliance_name)
+            #item.setText(1, appliance["category"].capitalize().replace("_", " "))
+
+            if "qemu" in appliance:
+                item.setText(1, "Qemu")
+            elif "iou" in appliance:
+                item.setText(1, "IOU")
+            elif "dynamips" in appliance:
+                item.setText(1, "Dynamips")
+            elif "docker" in appliance:
+                item.setText(1, "Docker")
+            else:
+                item.setText(1, "N/A")
+
+            item.setText(2, appliance["vendor_name"])
+            item.setData(0, QtCore.Qt.UserRole, appliance)
+
+            #item.setSizeHint(0, QtCore.QSize(32, 32))
+            item.setToolTip(0, self._get_tooltip_text(appliance))
+            Controller.instance().getSymbolIcon(appliance.get("symbol"), qpartial(self._setItemIcon, item),
+                                                fallback=":/symbols/" + appliance["category"] + ".svg")
+
+        self.uiAppliancesTreeWidget.sortByColumn(0, QtCore.Qt.AscendingOrder)
+        self.uiAppliancesTreeWidget.resizeColumnToContents(0)
+        if not appliance_filter:
+            self.uiAppliancesTreeWidget.collapseAll()
+
+    def initializePage(self, page_id):
+        """
+        Initialize Wizard pages.
+
+        :param page_id: page identifier
+        """
+
+        super().initializePage(page_id)
+        if self.page(page_id) == self.uiApplianceFromServerWizardPage:
+            self.button(QtWidgets.QWizard.CustomButton1).show()
+            self.setButtonText(QtWidgets.QWizard.FinishButton, "&Install")
+            self._get_appliances_from_server()
+        else:
+            self.button(QtWidgets.QWizard.CustomButton1).hide()
+
+    def cleanupPage(self, page_id):
+        """
+        Restore button default settings on the first page.
+        """
+
+        self.button(QtWidgets.QWizard.CustomButton1).hide()
+        self.setButtonText(QtWidgets.QWizard.FinishButton, "&Finish")
+        super().cleanupPage(page_id)
+
+    def validateCurrentPage(self):
+        """
+        Validates if an appliance can be installed.
+        """
+
+        if self.currentPage() == self.uiSelectTemplateSourceWizardPage and not Controller.instance().connected():
+            QtWidgets.QMessageBox.critical(self, "New template", "There is no connection to the server")
+            return False
+        elif self.currentPage() == self.uiApplianceFromServerWizardPage:
+            if not self.uiAppliancesTreeWidget.selectedItems():
+                QtWidgets.QMessageBox.critical(self, "New template", "Please select an appliance to install!")
+                return False
+        return True
+
+    def nextId(self):
+        """
+        Wizard rules!
+        """
+
+        current_id = self.currentId()
+        if self.page(current_id) == self.uiSelectTemplateSourceWizardPage and \
+                (self.uiImportApplianceFromFileRadioButton.isChecked() or self.uiCreateTemplateManuallyRadioButton.isChecked()):
+            self.done(True)
+        return super().nextId()
+
+    def done(self, result):
+        """
+        This dialog is closed.
+        """
+
+        super().done(result)
+        if result:
+            #ApplianceManager.instance().appliances_changed_signal.disconnect(self._appliancesChangedSlot)
+            from gns3.main_window import MainWindow
+            if self.currentPage() == self.uiApplianceFromServerWizardPage:
+                items = self.uiAppliancesTreeWidget.selectedItems()
+                for item in items:
+                    f = tempfile.NamedTemporaryFile(mode="w+", suffix=".builtin.gns3a", delete=False)
+                    json.dump(item.data(0, QtCore.Qt.UserRole), f)
+                    f.close()
+                    MainWindow.instance().loadPath(f.name)
+                    try:
+                        os.remove(f.name)
+                    except OSError:
+                        pass
+            elif self.uiCreateTemplateManuallyRadioButton.isChecked():
+                MainWindow.instance().preferencesActionSlot()
+            elif self.uiImportApplianceFromFileRadioButton.isChecked():
+                from gns3.main_window import MainWindow
+                MainWindow.instance().openApplianceActionSlot()

gns3/dialogs/node_info_dialog.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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/>.
+
+"""
+Dialog to show node information.
+"""
+
+from ..qt import QtWidgets
+from ..ui.node_info_dialog_ui import Ui_NodeInfoDialog
+
+
+class NodeInfoDialog(QtWidgets.QDialog, Ui_NodeInfoDialog):
+
+    """
+    Node information dialog.
+
+    :param parent: parent widget
+    """
+
+    def __init__(self, node, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        general_info = node.info()
+        usage_info = node.usage()
+        command_line_info = node.commandLine()
+        self.setWindowTitle(node.name())
+
+        # General tab
+        self.uiGeneralTextBrowser.setPlainText(general_info)
+
+        # Usage tab
+        if not usage_info:
+            usage_info = "No usage information has been provided for this node."
+        self.uiUsageTextBrowser.setPlainText(usage_info)
+
+        # Command line tab
+        if command_line_info is None:
+            command_line_info = "Command line information is not supported for this type of node."
+        elif len(command_line_info) == 0:
+            command_line_info = "Please start the node in order to get the command line information."
+        self.uiCommandLineTextBrowser.setPlainText(command_line_info)

gns3/dialogs/node_properties_dialog.py

@@ -19,13 +19,14 @@
 Dialog to configure and update node settings using widget pages.
 """
 
-from .qt import QtCore, QtGui
-from .ui.node_configurator_ui import Ui_NodeConfiguratorDialog
+from ..qt import QtCore, QtGui, QtWidgets
+from ..ui.node_properties_dialog_ui import Ui_NodePropertiesDialog
 
 
-class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
+class NodePropertiesDialog(QtWidgets.QDialog, Ui_NodePropertiesDialog):
+
     """
-    Node configurator implementation.
+    Node properties implementation.
 
     :param node_items: list of NodeItem instances
     :param parent: parent widget
@@ -33,40 +34,44 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
 
     def __init__(self, node_items, parent):
 
-        QtGui.QDialog.__init__(self, parent)
+        super().__init__(parent)
         self.setupUi(self)
 
         self._node_items = node_items
         self._parent_items = {}
 
-        self.uiButtonBox.button(QtGui.QDialogButtonBox.Apply).setEnabled(False)
-        self.uiButtonBox.button(QtGui.QDialogButtonBox.Reset).setEnabled(False)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).setEnabled(False)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset).setEnabled(False)
 
         self.previousItem = None
         self.previousPage = None
 
         # load the empty page widget by default
-        self.uiEmptyPageWidget = self.uiConfigStackedWidget.findChildren(QtGui.QWidget, "uiEmptyPageWidget")[0]
+        self.uiEmptyPageWidget = self.uiConfigStackedWidget.findChildren(QtWidgets.QWidget, "uiEmptyPageWidget")[0]
         self.uiConfigStackedWidget.setCurrentWidget(self.uiEmptyPageWidget)
 
-        self._loadNodeItems()
         self.splitter.setSizes([250, 600])
+        self._loadNodeItems()
 
         self.uiNodesTreeWidget.itemClicked.connect(self.showConfigurationPageSlot)
 
     def _loadNodeItems(self):
         """
-        Loads the nodes into the Node configurator QTreeWidget
+        Loads the nodes into the Node properties QTreeWidget
         """
 
         # create the parent (group) items
         for node_item in self._node_items:
             if not node_item.node().initialized():
                 continue
+
+            # If something of one of the displayed nodes we reload everything
+            node_item.node().updated_signal.connect(self.resetSettings)
+
             group_name = " {} group".format(str(node_item.node()))
             parent = group_name
-            if not parent in self._parent_items:
-                item = QtGui.QTreeWidgetItem(self.uiNodesTreeWidget, [group_name])
+            if parent not in self._parent_items:
+                item = QtWidgets.QTreeWidgetItem(self.uiNodesTreeWidget, [group_name])
                 item.setIcon(0, QtGui.QIcon(node_item.node().defaultSymbol()))
                 item.setExpanded(True)
                 self._parent_items[parent] = item
@@ -76,11 +81,24 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
             if not node_item.node().initialized():
                 continue
             parent = " {} group".format(str(node_item.node()))
-            item = ConfigurationPageItem(self._parent_items[parent], node_item)
+            ConfigurationPageItem(self._parent_items[parent], node_item)
 
         # sort the tree
         self.uiNodesTreeWidget.sortByColumn(0, QtCore.Qt.AscendingOrder)
 
+        if len(self._node_items) == 1:
+            parent = " {} group".format(str(node_item.node()))
+            item = self._parent_items[parent].child(0)
+            item.setSelected(True)
+            self.uiNodesTreeWidget.setCurrentItem(item)
+            self.showConfigurationPageSlot(item, 0)
+            self.splitter.setSizes([0, 600])
+        elif len(self._parent_items) > 0:
+            # We have multiple node we select the first group
+            item = next(iter(self._parent_items.values()))
+            self.uiNodesTreeWidget.setCurrentItem(item)
+            self.showConfigurationPageSlot(item, 0)
+
     def showConfigurationPageSlot(self, item, column):
         """
         Shows a configuration page widget.
@@ -117,11 +135,19 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
         self.uiConfigStackedWidget.setCurrentWidget(page)
 
         if page != self.uiEmptyPageWidget:
-            self.uiButtonBox.button(QtGui.QDialogButtonBox.Apply).setEnabled(True)
-            self.uiButtonBox.button(QtGui.QDialogButtonBox.Reset).setEnabled(True)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).setEnabled(True)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset).setEnabled(True)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).setEnabled(True)
         else:
-            self.uiButtonBox.button(QtGui.QDialogButtonBox.Apply).setEnabled(False)
-            self.uiButtonBox.button(QtGui.QDialogButtonBox.Reset).setEnabled(False)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).setEnabled(False)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset).setEnabled(False)
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).setEnabled(False)
+
+        # hide the contextual help button if there is no help text
+        if page.whatsThis():
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).show()
+        else:
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help).hide()
 
     def on_uiButtonBox_clicked(self, button):
         """
@@ -131,15 +157,17 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
         """
 
         try:
-            if button == self.uiButtonBox.button(QtGui.QDialogButtonBox.Apply):
+            if button == self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply):
                 self.applySettings()
-            elif button == self.uiButtonBox.button(QtGui.QDialogButtonBox.Reset):
+            elif button == self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Reset):
                 self.resetSettings()
-            elif button == self.uiButtonBox.button(QtGui.QDialogButtonBox.Cancel):
-                QtGui.QDialog.reject(self)
+            elif button == self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Help):
+                self.showHelp()
+            elif button == self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Cancel):
+                QtWidgets.QDialog.reject(self)
             else:
                 self.applySettings()
-                QtGui.QDialog.accept(self)
+                QtWidgets.QDialog.accept(self)
         except ConfigurationError:
             pass
 
@@ -160,12 +188,10 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
                 # all children for that group
                 self.previousItem = None
                 self.previousNode = None
-                settings = item.child(0).settings().copy()
                 node = item.child(0).node()
-                page.saveSettings(settings, node, group=True)
+                settings = page.saveSettings({}, node, group=True)
                 for index in range(0, item.childCount()):
                     child = item.child(index)
-                    #child.node().update(settings)  #TODO: delete
                     child.settings().update(settings)
 
         # update the nodes with the settings
@@ -199,8 +225,17 @@ class NodeConfigurator(QtGui.QDialog, Ui_NodeConfiguratorDialog):
                 child = item.child(index)
                 child.setSettings(child.node().settings().copy())
 
+    def showHelp(self):
+        """
+        Show contextual help for the current page.
+        """
+
+        page = self.uiConfigStackedWidget.currentWidget()
+        if page != self.uiEmptyPageWidget and page.whatsThis():
+            QtWidgets.QMessageBox.information(self, "{} help".format(page.windowTitle()), page.whatsThis().strip())
+
+class ConfigurationPageItem(QtWidgets.QTreeWidgetItem):
 
-class ConfigurationPageItem(QtGui.QTreeWidgetItem):
     """
     Item for the QTreeWidget instance.
     Store temporary node settings configured in a page widget.
@@ -212,7 +247,7 @@ class ConfigurationPageItem(QtGui.QTreeWidgetItem):
     def __init__(self, parent, node_item):
 
         self._node = node_item.node()
-        QtGui.QTreeWidgetItem.__init__(self, parent, [self._node.name()])
+        super().__init__(parent, [self._node.name()])
 
         # return the configuration page widget used to configure the node.
         self._page = self._node.configPage()
@@ -233,7 +268,7 @@ class ConfigurationPageItem(QtGui.QTreeWidgetItem):
 
     def page(self):
         """
-        Returns the page widget to be displayed by the node configurator.
+        Returns the page widget to be displayed by the node properties dialog.
 
         :returns: QWidget instance
         """
@@ -269,10 +304,11 @@ class ConfigurationPageItem(QtGui.QTreeWidgetItem):
 
 
 class ConfigurationError(Exception):
+
     """
     Exception to be raised when a configuration error occurs.
     """
 
     def __init__(self):
 
-        Exception.__init__(self)
+        super().__init__()

gns3/dialogs/notif_dialog.py

@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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/>.
+
+"""
+Display error to the user in an overlay popup
+"""
+
+import time
+
+from gns3.qt import QtWidgets, QtCore, qslot
+
+import logging
+log = logging.getLogger(__name__)
+
+
+MAX_ELEMENTS = 3
+DISPLAY_DURATION = {
+    "CRITICAL": 120,
+    "ERROR": 120,
+    "WARNING": 20,
+    "INFO": 5
+}
+
+
+class NotifDialogHandler(logging.StreamHandler):
+
+    def __init__(self, dialog):
+        super().__init__()
+        self._dialog = dialog
+        self.setLevel(logging.INFO)
+        self._dialog.show()
+
+    def emit(self, record):
+        self._dialog.addNotif(record.levelname, record.getMessage())
+
+
+class NotifDialog(QtWidgets.QWidget):
+
+    def __init__(self, parent):
+        super().__init__(parent)
+        self._notifs = []
+
+        self.setWindowFlags(QtCore.Qt.FramelessWindowHint |
+                            QtCore.Qt.WindowDoesNotAcceptFocus |
+                            QtCore.Qt.SubWindow)
+        # QtCore.Qt.Tool)
+        # QtCore.Qt.WindowStaysOnTopHint)
+        self.setAttribute(QtCore.Qt.WA_ShowWithoutActivating)  # | QtCore.Qt.WA_TranslucentBackground)
+
+        self._layout = QtWidgets.QVBoxLayout()
+
+        self._timer = QtCore.QTimer()
+        self._timer.setInterval(1000)
+        self._timer.timeout.connect(self._refreshSlot)
+        self._timer.start()
+
+        for i in range(0, MAX_ELEMENTS):
+            l = QtWidgets.QLabel()
+            l.setAlignment(QtCore.Qt.AlignTop)
+            l.setWordWrap(True)
+            l.hide()
+            self._layout.addWidget(l)
+        self.setLayout(self._layout)
+
+    @qslot
+    def addNotif(self, level, message):
+        if not self.parent().settings().get("overlay_notifications", True):
+            return
+
+        # This unicode char prevent the wordwrap at /
+        message = message.replace("/", "\u2060/\u2060")
+        if len(self._notifs) == MAX_ELEMENTS:
+            self._notifs.pop(0)
+        self._notifs.append((level, message, time.time()))
+        self.update()
+
+    @qslot
+    def _refreshSlot(self):
+        """
+        Hide the notifs after some delay
+        """
+        notifs = []
+        for (i, (level, message, when)) in enumerate(self._notifs):
+            if when + DISPLAY_DURATION[level] > time.time():
+                notifs.append((level, message, when))
+        if notifs != self._notifs:
+            self._notifs = notifs
+            self.update()
+        elif len(notifs) > 0:
+            self.resize()
+
+    def update(self):
+        if len(self._notifs) == 0:
+            self.hide()
+        else:
+            for (i, (level, message, when)) in enumerate(self._notifs):
+                w = self._layout.itemAt(i).widget()
+                w.setText(message)
+                if level == "ERROR" or level == "CRITICAL":
+                    w.setStyleSheet("""
+                        color: black;
+                        padding-left: 12px;
+                        background-color: rgb(247, 205, 198);
+                        border-left: 10px solid red;
+                    """)
+                elif level == "WARNING":
+                    w.setStyleSheet("""
+                        color: black;
+                        padding-left: 12px;
+                        background-color: #f4f2b5;
+                        border-left: 10px solid orange;
+                    """)
+                elif level == "INFO":
+                    w.setStyleSheet("""
+                        color: black;
+                        padding-left: 12px;
+                        background-color: #cfffc9;
+                        border-left: 10px solid green;
+                    """)
+
+                w.show()
+            for i in range(i + 1, MAX_ELEMENTS):
+                w = self._layout.itemAt(i).widget()
+                w.hide()
+
+            self.resize()
+            self.show()
+
+    def resize(self):
+        x = self.parent().width() - self.width() - 10
+        y = 10
+        self.setGeometry(x, y, self.sizeHint().width(), self.sizeHint().height())
+
+    @qslot
+    def mousePressEvent(self, event):
+        self._notifs.clear()
+        self.update()
+
+
+if __name__ == '__main__':
+    """
+    A demo main for testing the features
+    """
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    logging.basicConfig(level=logging.INFO)
+
+    class MainWindow(QtWidgets.QWidget):
+
+        def __init__(self):
+            super().__init__()
+            l1 = QtWidgets.QLabel()
+            l1.setText("Hello World")
+
+            vbox = QtWidgets.QVBoxLayout()
+            vbox.addWidget(l1)
+            self.setLayout(vbox)
+            self.setStyleSheet("background-color:blue;")
+            self._dialog = NotifDialog(self)
+            log.addHandler(NotifDialogHandler(self._dialog))
+            log.info("test")
+
+        def moveEvent(self, event):
+            log.error("An error")
+            log.info("An info with an url http://test")
+            log.warning("A warning with a long long long longlong longlong longlong longlong longlong longlong longlong long message")
+            self._dialog.update()
+
+        def resizeEvent(self, event):
+            self._dialog.update()
+
+    main = MainWindow()
+    main.setMinimumWidth(600)
+    main.setMinimumHeight(600)
+    main.show()
+    exit_code = app.exec_()

gns3/dialogs/preferences_dialog.py

@@ -0,0 +1,238 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Dialog to load module and built-in preference pages.
+"""
+
+from ..qt import QtCore, QtWidgets
+from ..ui.preferences_dialog_ui import Ui_PreferencesDialog
+from ..pages.server_preferences_page import ServerPreferencesPage
+from ..pages.general_preferences_page import GeneralPreferencesPage
+from ..pages.packet_capture_preferences_page import PacketCapturePreferencesPage
+from ..pages.gns3_vm_preferences_page import GNS3VMPreferencesPage
+from ..modules import MODULES
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class PreferencesDialog(QtWidgets.QDialog, Ui_PreferencesDialog):
+
+    """
+    Preferences dialog implementation.
+
+    :param parent: parent widget
+    """
+
+    def __init__(self, parent):
+
+        super().__init__(parent)
+
+        self.setupUi(self)
+        self._modified_pages = set()
+
+        # We adapt the max size to the screen resolution
+        # We need to manually do that otherwise on small screen the windows
+        # could be bigger than the screen instead of displaying scrollbars
+        height = QtWidgets.QDesktopWidget().screenGeometry().height() - 100
+        width = QtWidgets.QDesktopWidget().screenGeometry().width() - 100
+
+        # 980 is the default width
+        if self.width() > width:
+            self.resize(width, self.height())
+        # 680 is the default height
+        if self.height() > height:
+            self.resize(self.width(), height)
+
+        self.uiTreeWidget.currentItemChanged.connect(self._showPreferencesPageSlot)
+        self._applyButton = self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply)
+        self._applyButton.clicked.connect(self._applyPreferences)
+        self._applyButton.setEnabled(False)
+        self._applyButton.setStyleSheet("QPushButton:disabled {color: gray}")
+        self._items = []
+        self._loadPreferencePages()
+
+        # select the first available page
+        self.uiTreeWidget.setCurrentItem(self._items[0])
+
+        # set the maximum width based on the content of column 0
+        self.uiTreeWidget.setMaximumWidth(self.uiTreeWidget.sizeHintForColumn(0) + 10)
+
+        # Something has change?
+        self._modified_pages = set()
+
+    def _loadPreferencePages(self):
+        """
+        Loads all preference pages (built-ins and from modules).
+        """
+
+        # load built-in preference pages
+        pages = [
+            GeneralPreferencesPage,
+            ServerPreferencesPage,
+            GNS3VMPreferencesPage,
+            PacketCapturePreferencesPage,
+        ]
+
+        for page in pages:
+            preferences_page = page(self)
+            preferences_page.loadPreferences()
+            name = preferences_page.windowTitle()
+            item = QtWidgets.QTreeWidgetItem(self.uiTreeWidget)
+            item.setText(0, name)
+            item.setData(0, QtCore.Qt.UserRole, preferences_page)
+            self.uiStackedWidget.addWidget(preferences_page)
+            self._items.append(item)
+            self._watchForChanges(preferences_page)
+
+        # load module preference pages
+        for module in MODULES:
+            preference_pages = module.preferencePages()
+            parent = self.uiTreeWidget
+            for cls in preference_pages:
+                preferences_page = cls()
+                preferences_page.setParent(self)
+                preferences_page.loadPreferences()
+                name = preferences_page.windowTitle()
+                item = QtWidgets.QTreeWidgetItem(parent)
+                item.setText(0, name)
+                item.setData(0, QtCore.Qt.UserRole, preferences_page)
+                self.uiStackedWidget.addWidget(preferences_page)
+                self._items.append(item)
+                if cls is preference_pages[0]:
+                    parent = item
+                self._watchForChanges(preferences_page)
+
+        # expand all items by default
+        self.uiTreeWidget.expandAll()
+
+    def _watchForChanges(self, preferences_page):
+        """
+        Connect all the widget of a page to check if something has change
+        """
+
+        # Class name, changed signal
+        widget_to_watch = {
+            QtWidgets.QLineEdit: "textChanged",
+            QtWidgets.QPlainTextEdit: "textChanged",
+            # QtWidgets.QTreeWidget: "itemChanged",
+            QtWidgets.QTreeWidget: "itemDoubleClicked",
+            QtWidgets.QComboBox: "currentIndexChanged",
+            QtWidgets.QSpinBox: "valueChanged",
+            QtWidgets.QAbstractButton: "pressed"
+        }
+
+        for widget, signal in widget_to_watch.items():
+            for children in preferences_page.findChildren(widget):
+                getattr(children, signal).connect(self._preferenceChangeSlot)
+
+    def _preferenceChangeSlot(self, *args):
+        """
+        Called when something change in the preference dialog
+        """
+
+        # Found the page with the change
+        widget = sender = self.sender()
+        while widget.parent() != self.uiStackedWidget:
+            widget = widget.parent()
+
+        if self.addModifiedPage(widget):
+            log.debug("%s value has changed", sender.objectName())
+
+    def addModifiedPage(self, widget):
+        """
+        :returns: True is the page is initialized and element added
+        """
+        # The widget can trigger signal before the end of init due to async api call
+        if not hasattr(widget, 'pageInitialized') or widget.pageInitialized():
+            self._applyButton.setEnabled(True)
+            self._modified_pages.add(widget)
+            return True
+        return False
+
+    def _showPreferencesPageSlot(self, current, previous):
+        """
+        Shows a preference page in the current dialog.
+
+        :param current: current preference page widget
+        :param previous: ignored
+        """
+
+        if current is None:
+            current = previous
+
+        preferences_page = current.data(0, QtCore.Qt.UserRole)
+        accessible_name = preferences_page.accessibleName()
+        if accessible_name:
+            self.uiTitleLabel.setText(accessible_name)
+        else:
+            name = preferences_page.windowTitle()
+            self.uiTitleLabel.setText("{} preferences".format(name))
+        index = self.uiStackedWidget.indexOf(preferences_page)
+        widget = self.uiStackedWidget.widget(index)
+        #self.uiStackedWidget.setMinimumSize(widget.size())  # FIXME: this seems to not work on Windows and OSX
+        #self.uiStackedWidget.resize(widget.size())
+        self.uiStackedWidget.setCurrentIndex(index)
+
+        for index in range(0, self.uiStackedWidget.count()):
+            page = self.uiStackedWidget.widget(index)
+            if self.uiStackedWidget.currentIndex() == index:
+                page.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+            else:
+                page.setSizePolicy(QtWidgets.QSizePolicy.Ignored, QtWidgets.QSizePolicy.Ignored)
+
+    def _applyPreferences(self):
+        """
+        Saves all the preferences.
+        """
+
+        success = True
+        for preferences_page in list(self._modified_pages):
+            ok = preferences_page.savePreferences()
+            # if page.savePreferences() returns None, assume success
+            if ok is not None and not ok:
+                success = False
+        if success:
+            self._applyButton.setEnabled(False)
+            self._modified_pages = set()
+        return success
+
+    def reject(self):
+        """
+        Closes this dialog.
+        """
+
+        if len(self._modified_pages) > 0:
+            # Get the title of pages with modifications
+            pages_title = ', '.join([page.windowTitle() for page in self._modified_pages])
+            reply = QtWidgets.QMessageBox.warning(self,
+                                                  "Preferences",
+                                                  "You have unsaved preferences in {}.\n\nContinue without saving?".format(pages_title),
+                                                  QtWidgets.QMessageBox.Yes,
+                                                  QtWidgets.QMessageBox.No)
+            if reply == QtWidgets.QMessageBox.No:
+                return
+        QtWidgets.QDialog.reject(self)
+
+    def accept(self):
+        """
+        Saves the preferences and closes this dialog.
+        """
+
+        if self._applyPreferences():
+            QtWidgets.QDialog.accept(self)

gns3/dialogs/profile_select.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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 sys
+import shutil
+
+from gns3.qt import QtWidgets
+from gns3.local_config import LocalConfig
+from gns3.ui.profile_select_dialog_ui import Ui_ProfileSelectDialog
+from gns3.version import __version_info__
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ProfileSelectDialog(QtWidgets.QDialog, Ui_ProfileSelectDialog):
+    """
+    This dialog allow user to choose a profile of settings
+    """
+
+    def __init__(self, parent=None):
+
+        if parent is None:
+            self._main = QtWidgets.QMainWindow()
+            self._main.hide()
+            parent = self._main
+        super().__init__(parent)
+
+        self.setupUi(self)
+        self.uiNewPushButton.clicked.connect(self._newPushButtonSlot)
+        self.uiDeletePushButton.clicked.connect(self._deletePushButtonSlot)
+
+        # Center on screen
+        screen = QtWidgets.QApplication.desktop().screenGeometry()
+        self.move(screen.center() - self.rect().center())
+
+        version = "{}.{}".format(__version_info__[0], __version_info__[1])
+        if sys.platform.startswith("win"):
+            appdata = os.path.expandvars("%APPDATA%")
+            path = os.path.join(appdata, "GNS3", version)
+        else:
+            home = os.path.expanduser("~")
+            path = os.path.join(home, ".config", "GNS3", version)
+        self.profiles_path = os.path.join(path, "profiles")
+
+        self.uiShowAtStartupCheckBox.setChecked(LocalConfig.instance().multiProfiles())
+        self._refresh()
+
+    def _refresh(self):
+        self.uiProfileSelectComboBox.clear()
+        self.uiProfileSelectComboBox.addItem("default")
+
+        try:
+            if os.path.exists(self.profiles_path):
+                for profile in sorted(os.listdir(self.profiles_path)):
+                    if not profile.startswith("."):
+                        self.uiProfileSelectComboBox.addItem(profile)
+        except OSError:
+            pass
+
+    def profile(self):
+        return self.uiProfileSelectComboBox.currentText()
+
+    def accept(self):
+        LocalConfig.instance().setMultiProfiles(self.uiShowAtStartupCheckBox.isChecked())
+        super().accept()
+
+    def _newPushButtonSlot(self):
+        profile, ok = QtWidgets.QInputDialog.getText(self, "New profile", "Profile name:")
+        if ok:
+            self.uiProfileSelectComboBox.addItem(profile)
+            self.uiProfileSelectComboBox.setCurrentText(profile)
+            self.accept()
+
+    def _deletePushButtonSlot(self):
+        profile = self.uiProfileSelectComboBox.currentText()
+        if profile == "default":
+            QtWidgets.QMessageBox.critical(self, "Delete profile", "The default profile cannot be deleted")
+        else:
+            try:
+                shutil.rmtree(os.path.join(self.profiles_path, profile))
+                self._refresh()
+            except (OSError, PermissionError) as e:
+                QtWidgets.QMessageBox.critical(self, "Cannot delete profile", str(e))
+
+
+if __name__ == '__main__':
+    app = QtWidgets.QApplication(sys.argv)
+    dialog = ProfileSelectDialog()
+    dialog.show()
+    exit_code = app.exec_()

gns3/dialogs/project_dialog.py

@@ -0,0 +1,318 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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
+from ..qt import QtCore, QtGui, QtWidgets, qslot, sip_is_deleted
+from ..ui.project_dialog_ui import Ui_ProjectDialog
+from ..controller import Controller
+from ..topology import Topology
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ProjectDialog(QtWidgets.QDialog, Ui_ProjectDialog):
+
+    """
+    New project dialog.
+    """
+
+    def __init__(self, parent, default_project_name="untitled", show_open_options=True):
+        """
+        :param parent: parent widget.
+        :param default_project_name: Project name by default
+        :param show_open_options: If true allow to open a project from the dialog
+        otherwise it's just for create a project
+        """
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._main_window = parent
+        self._project_settings = {}
+        self.uiNameLineEdit.setText(default_project_name)
+        self.uiLocationLineEdit.setText(os.path.join(Topology.instance().projectsDirPath(), default_project_name))
+
+        self.uiNameLineEdit.textEdited.connect(self._projectNameSlot)
+        self.uiLocationBrowserToolButton.clicked.connect(self._projectPathSlot)
+        self.uiSettingsPushButton.clicked.connect(self._settingsClickedSlot)
+
+        if show_open_options:
+            self.uiOpenProjectPushButton.clicked.connect(self._openProjectActionSlot)
+            self._addRecentFilesMenu()
+        else:
+            self.uiOpenProjectGroupBox.hide()
+            self.uiProjectTabWidget.removeTab(1)
+
+        # If the controller is remote we hide option for local file system
+        if Controller.instance().isRemote():
+            self.uiLocationLabel.setVisible(False)
+            self.uiLocationLineEdit.setVisible(False)
+            self.uiLocationBrowserToolButton.setVisible(False)
+            self.uiOpenProjectPushButton.setVisible(False)
+
+        self.uiProjectsTreeWidget.itemDoubleClicked.connect(self._projectsTreeWidgetDoubleClickedSlot)
+        self.uiDeleteProjectButton.clicked.connect(self._deleteProjectSlot)
+        self.uiDuplicateProjectPushButton.clicked.connect(self._duplicateProjectSlot)
+        self.uiRefreshProjectsPushButton.clicked.connect(Controller.instance().refreshProjectList)
+        Controller.instance().project_list_updated_signal.connect(self._updateProjectListSlot)
+        self._updateProjectListSlot()
+        Controller.instance().refreshProjectList()
+
+    def _settingsClickedSlot(self):
+        """
+        When the user click on the settings button
+        """
+        self.reject()
+        self._main_window.preferencesActionSlot()
+
+    def _projectsTreeWidgetDoubleClickedSlot(self, item, column):
+        self.done(True)
+
+    @qslot
+    def _deleteProjectSlot(self, *args):
+        if len(self.uiProjectsTreeWidget.selectedItems()) == 0:
+            QtWidgets.QMessageBox.critical(self, "Delete project", "No project selected")
+            return
+
+        projects_to_delete = set()
+        for project in self.uiProjectsTreeWidget.selectedItems():
+            if sip_is_deleted(project):
+                continue
+            project_id = project.data(0, QtCore.Qt.UserRole)
+            project_name = project.data(1, QtCore.Qt.UserRole)
+
+            reply = QtWidgets.QMessageBox.warning(self,
+                                                  "Delete project",
+                                                  'Delete project "{}"?\nThis cannot be reverted.'.format(project_name),
+                                                  QtWidgets.QMessageBox.Yes,
+                                                  QtWidgets.QMessageBox.No)
+            if reply == QtWidgets.QMessageBox.Yes:
+                projects_to_delete.add(project_id)
+
+        for project_id in projects_to_delete:
+            Controller.instance().deleteProject(project_id)
+
+    def _duplicateProjectSlot(self):
+
+        if len(self.uiProjectsTreeWidget.selectedItems()) == 0:
+            QtWidgets.QMessageBox.critical(self, "Duplicate project", "No project selected")
+            return
+
+        if len(self.uiProjectsTreeWidget.selectedItems()) > 1:
+            QtWidgets.QMessageBox.critical(self, "Duplicate project", "Please select only one project to duplicate")
+            return
+
+        for project in self.uiProjectsTreeWidget.selectedItems():
+            project_id = project.data(0, QtCore.Qt.UserRole)
+            project_name = project.data(1, QtCore.Qt.UserRole)
+
+            new_project_name = project_name + "-1"
+            existing_project_name = [p["name"] for p in Controller.instance().projects()]
+            i = 1
+            while new_project_name in existing_project_name:
+                new_project_name = "{}-{}".format(project_name, i)
+                i += 1
+
+            name, reply = QtWidgets.QInputDialog.getText(self,
+                                                         "Duplicate project",
+                                                         'Duplicate project "{}"?.'.format(project_name),
+                                                         QtWidgets.QLineEdit.Normal,
+                                                         new_project_name)
+            name = name.strip()
+            if reply and len(name) > 0:
+
+                reset_mac_addresses = self.uiResetMacAddressesCheckBox.isChecked()
+
+                if Controller.instance().isRemote():
+                    Controller.instance().post("/projects/{project_id}/duplicate".format(project_id=project_id),
+                                               self._duplicateCallback,
+                                               body={"name": name, "reset_mac_addresses": reset_mac_addresses},
+                                               progressText="Duplicating project '{}'...".format(name),
+                                               timeout=None)
+                else:
+                    project_location = os.path.join(Topology.instance().projectsDirPath(), name)
+                    Controller.instance().post("/projects/{project_id}/duplicate".format(project_id=project_id),
+                                               self._duplicateCallback,
+                                               body={"name": name, "path": project_location, "reset_mac_addresses": reset_mac_addresses},
+                                               progressText="Duplicating project '{}'...".format(name),
+                                               timeout=None)
+
+    def _duplicateCallback(self, result, error=False, **kwargs):
+        if error:
+            log.error("Error while duplicating project: {}".format(result["message"]))
+            return
+        Controller.instance().refreshProjectList()
+
+    @qslot
+    def _updateProjectListSlot(self, *args):
+        self.uiProjectsTreeWidget.clear()
+        self.uiDeleteProjectButton.setEnabled(False)
+        self.uiProjectsTreeWidget.setUpdatesEnabled(False)
+        items = []
+        for project in Controller.instance().projects():
+            path = os.path.join(project["path"], project["filename"])
+            item = QtWidgets.QTreeWidgetItem([project["name"], project["status"], path])
+            item.setData(0, QtCore.Qt.UserRole, project["project_id"])
+            item.setData(1, QtCore.Qt.UserRole, project["name"])
+            item.setData(2, QtCore.Qt.UserRole, path)
+            items.append(item)
+        self.uiProjectsTreeWidget.addTopLevelItems(items)
+
+        if len(Controller.instance().projects()):
+            self.uiDeleteProjectButton.setEnabled(True)
+
+        self.uiProjectsTreeWidget.header().setResizeContentsPrecision(100)  # How many row is checked for the resize for performance reason
+        self.uiProjectsTreeWidget.resizeColumnToContents(0)
+        self.uiProjectsTreeWidget.resizeColumnToContents(1)
+        self.uiProjectsTreeWidget.resizeColumnToContents(2)
+        self.uiProjectsTreeWidget.sortItems(0, QtCore.Qt.AscendingOrder)
+        self.uiProjectsTreeWidget.setUpdatesEnabled(True)
+
+    def keyPressEvent(self, e):
+        """
+        Event handler in order to properly handle escape.
+        """
+
+        if e.key() == QtCore.Qt.Key_Escape:
+            self.close()
+
+    def _projectNameSlot(self, text):
+
+        project_dir = Topology.instance().projectsDirPath()
+        if os.path.dirname(self.uiLocationLineEdit.text()) == project_dir:
+            self.uiLocationLineEdit.setText(os.path.join(project_dir, text))
+
+    def _projectPathSlot(self):
+        """
+        Slot to select the a new project location.
+        """
+
+        path, _ = QtWidgets.QFileDialog.getSaveFileName(self, "Project location", os.path.join(Topology.instance().projectsDirPath(),
+                                                                                               self.uiNameLineEdit.text()))
+
+        if path:
+            self.uiNameLineEdit.setText(os.path.basename(path))
+            self.uiLocationLineEdit.setText(path)
+
+    def getProjectSettings(self):
+
+        return self._project_settings
+
+    def _menuTriggeredSlot(self, action):
+        """
+        Closes this dialog when a recent project
+        has been opened.
+
+        :param action: ignored.
+        """
+
+        self.reject()
+
+    def _openProjectActionSlot(self):
+        """
+        Opens a project and closes this dialog.
+        """
+
+        self._main_window.openProjectActionSlot()
+        self.reject()
+
+    def _addRecentFilesMenu(self):
+        """
+        Add recent projects in a menu.
+        """
+
+        menu = QtWidgets.QMenu(parent=self)
+        if Controller.instance().isRemote():
+            for action in self._main_window.recent_project_actions:
+                menu.addAction(action)
+        else:
+            for action in self._main_window.recent_file_actions:
+                menu.addAction(action)
+        menu.triggered.connect(self._menuTriggeredSlot)
+        self.uiRecentProjectsPushButton.setMenu(menu)
+
+    def _overwriteProjectCallback(self, result, error=False, **kwargs):
+        if error:
+            # A 404 could arrive if someone else as deleted the project
+            if "status" not in result or result["status"] != 404:
+                return
+            elif "message" in result:
+                QtWidgets.QMessageBox.critical(self,
+                                               "New Project",
+                                               "Error while overwrite project: {}".format(result["message"]))
+        Controller.instance().refreshProjectList()
+        self.done(True)
+
+    def _newProject(self):
+        self._project_settings["project_name"] = self.uiNameLineEdit.text().strip()
+        if Controller.instance().isRemote():
+            self._project_settings.pop("project_path", None)
+            self._project_settings.pop("project_files_dir", None)
+        else:
+            project_location = self.uiLocationLineEdit.text().strip()
+            if not project_location:
+                QtWidgets.QMessageBox.critical(self, "New project", "Project location is empty")
+                return False
+
+            self._project_settings["project_path"] = os.path.join(project_location, self._project_settings["project_name"] + ".gns3")
+            self._project_settings["project_files_dir"] = project_location
+
+        if len(self._project_settings["project_name"]) == 0:
+            QtWidgets.QMessageBox.critical(self, "New project", "Project name is empty")
+            return False
+
+        for existing_project in Controller.instance().projects():
+            if self._project_settings["project_name"] == existing_project["name"] \
+               and ("project_files_dir" in self._project_settings and self._project_settings["project_files_dir"] == existing_project["path"]):
+
+                if existing_project["status"] == "opened":
+                    QtWidgets.QMessageBox.critical(self,
+                                                   "New project",
+                                                   'Project "{}" is opened, it cannot be overwritten'.format(self._project_settings["project_name"]))
+                    return False
+
+                reply = QtWidgets.QMessageBox.warning(self,
+                                                      "New project",
+                                                      'Project "{}" already exists in location "{}", overwrite it?'.format(existing_project["name"], existing_project["path"]),
+                                                      QtWidgets.QMessageBox.Yes,
+                                                      QtWidgets.QMessageBox.No)
+
+                if reply == QtWidgets.QMessageBox.Yes:
+                    Controller.instance().deleteProject(existing_project["project_id"], self._overwriteProjectCallback)
+
+                # In all cases we cancel the new project and if project success to delete
+                # we will call done again
+                return False
+
+        return True
+
+    def done(self, result):
+
+        if result:
+            if self.uiProjectTabWidget.currentIndex() == 0:
+                if not self._newProject():
+                    return
+            else:
+                current = self.uiProjectsTreeWidget.currentItem()
+                if current is None:
+                    QtWidgets.QMessageBox.critical(self, "Open project", "No project selected")
+                    return
+
+                self._project_settings["project_id"] = current.data(0, QtCore.Qt.UserRole)
+                self._project_settings["project_name"] = current.data(1, QtCore.Qt.UserRole)
+        super().done(result)

gns3/dialogs/project_export_wizard.py

@@ -0,0 +1,146 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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 sys
+import os
+import datetime
+
+from gns3.qt import QtCore, QtWidgets
+from ..local_server import LocalServer
+from ..utils.progress_dialog import ProgressDialog
+from ..utils.export_project_worker import ExportProjectWorker
+from ..ui.export_project_wizard_ui import Ui_ExportProjectWizard
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ExportProjectWizard(QtWidgets.QWizard, Ui_ExportProjectWizard):
+    """
+    Export project wizard.
+    """
+
+    def __init__(self, project, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._project = project
+        self._path = None
+        self.setWizardStyle(QtWidgets.QWizard.ModernStyle)
+        if sys.platform.startswith("darwin"):
+            # we want to see the cancel button on OSX
+            self.setOptions(QtWidgets.QWizard.NoDefaultButton)
+
+        self.uiCompressionComboBox.addItem("None", "none")
+        self.uiCompressionComboBox.addItem("Zip compression (deflate)", "zip")
+        self.uiCompressionComboBox.addItem("Bzip2 compression", "bzip2")
+        self.uiCompressionComboBox.addItem("Lzma compression", "lzma")
+
+        # set zip compression by default
+        self.uiCompressionComboBox.setCurrentIndex(1)
+        self.helpRequested.connect(self._showHelpSlot)
+        self.uiPathBrowserToolButton.clicked.connect(self._pathBrowserSlot)
+        self._loadReadme()
+
+    def _loadReadme(self):
+
+        self._project.get("/files/README.txt", self._loadedReadme)
+
+    def _loadedReadme(self, result, error=False, raw_body=None, context={}, **kwargs):
+
+        if not error:
+            self.uiReadmeTextEdit.setPlainText(raw_body.decode("utf-8", errors="replace"))
+        else:
+            readme_text = "Project: '{}' created on {}\nAuthor: John Doe <john.doe@example.com>\n\nNo project description was given".format(self._project.name(), datetime.date.today())
+            self.uiReadmeTextEdit.setPlainText(readme_text)
+
+    def _pathBrowserSlot(self):
+
+        directory = QtCore.QStandardPaths.writableLocation(QtCore.QStandardPaths.DocumentsLocation)
+        if len(directory) == 0:
+            directory = LocalServer.instance().localServerSettings()["projects_path"]
+
+        path, _ = QtWidgets.QFileDialog.getSaveFileName(self, "Export portable project", directory,
+                                                        "GNS3 Portable Project (*.gns3project *.gns3p)",
+                                                        "GNS3 Portable Project (*.gns3project *.gns3p)")
+        if path is None or len(path) == 0:
+            return
+
+        self.uiPathLineEdit.setText(path)
+
+    def _showHelpSlot(self):
+
+        include_image_help = """Including base images means additional images will not be requested to
+        import the project on another computer, however the resulting file will be much bigger.
+        Also, you are responsible to check if you have the right to distribute the image(s) as part of the project.
+        """
+        QtWidgets.QMessageBox.information(self, "Help about export a project", include_image_help)
+
+    def validateCurrentPage(self):
+        """
+        Validates if the project can be exported.
+        """
+
+        if self.currentPage() == self.uiExportOptionsWizardPage:
+            path = self.uiPathLineEdit.text().strip()
+            if not path:
+                QtWidgets.QMessageBox.critical(self, "Export project", "Please select a path where to export the project")
+                return False
+
+            if not path.endswith(".gns3project") and not path.endswith(".gns3p"):
+                path += ".gns3project"
+            try:
+                open(path, 'wb+').close()
+            except OSError as e:
+                QtWidgets.QMessageBox.critical(self, "Export project", "Cannot export project to '{}': {}".format(path, e))
+                return False
+            self._path = path
+        elif self.currentPage() == self.uiProjectReadmeWizardPage:
+            text = self.uiReadmeTextEdit.toPlainText().strip()
+            if text:
+                self._project.post("/files/README.txt", self._saveReadmeCallback, body=text)
+        return True
+
+    def _saveReadmeCallback(self, result, error=False, **kwargs):
+        if error:
+            QtWidgets.QMessageBox.critical(self, "Export project", "Could not created readme file")
+
+    def done(self, result):
+        """
+        This dialog is closed.
+        """
+
+        if result:
+            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"
+            compression = self.uiCompressionComboBox.currentData()
+            export_worker = ExportProjectWorker(self._project, self._path, include_images, include_snapshots, reset_mac_addresses, compression)
+            progress_dialog = ProgressDialog(export_worker, "Exporting project", "Exporting portable project files...", "Cancel", parent=self, create_thread=False)
+            progress_dialog.show()
+            progress_dialog.exec_()
+        super().done(result)

gns3/dialogs/project_welcome_dialog.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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 copy
+
+from gns3.qt import QtWidgets, QtCore, qpartial
+from gns3.ui.project_welcome_dialog_ui import Ui_ProjectWelcomeDialog
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ProjectWelcomeDialog(QtWidgets.QDialog, Ui_ProjectWelcomeDialog):
+    """
+    This dialog shows when project is imported and global variables assigned to the project are missing.
+    """
+
+    def __init__(self, parent, project):
+
+        super().__init__(parent)
+        self._project = project
+        self.setupUi(self)
+        self.uiOkButton.clicked.connect(self._okButtonClickedSlot)
+        self.gridLayout.setAlignment(QtCore.Qt.AlignTop)
+        self.label.setOpenExternalLinks(True)
+        self._variables = self._getVariables(project)
+        self._loadReadme()
+        self._addMisingVariablesEdits()
+
+    def _getVariables(self, project):
+        variables = copy.copy(self._project.variables())
+        if variables is None:
+            variables = []
+        return variables
+
+    def _addMisingVariablesEdits(self):
+        #TODO: refactor this to use a QListWidget
+        missing = [v for v in self._variables if v.get("name") and v.get("value", "").strip() == ""]
+        for i, variable in enumerate(missing, start=0):
+            nameLabel = QtWidgets.QLabel()
+            nameLabel.setText(variable.get("name") + ":")
+            self.gridLayout.addWidget(nameLabel, i, 0)
+
+            valueEdit = QtWidgets.QLineEdit()
+            valueEdit.setText(variable.get("value", ""))
+            valueEdit.textChanged.connect(qpartial(self.onValueChange, variable))
+            self.gridLayout.addWidget(valueEdit, i, 1)
+
+    def _loadReadme(self):
+        self._project.get("/files/README.txt", self._loadedReadme)
+
+    def _loadedReadme(self, result, error=False, raw_body=None, context={}, **kwargs):
+        if not error:
+            self.label.setText(raw_body.decode("utf-8"))
+
+    def onValueChange(self, variable, text):
+        variable["value"] = text
+
+    def _okButtonClickedSlot(self):
+        missing = [v for v in self._variables if v.get("name") and v.get("value", "").strip() == ""]
+        if len(missing) > 0:
+            reply = QtWidgets.QMessageBox.warning(self,
+                                                  "Missing values",
+                                                  "Are you sure you want to continue without providing missing values?",
+                                                  QtWidgets.QMessageBox.Yes,
+                                                  QtWidgets.QMessageBox.No)
+            if reply == QtWidgets.QMessageBox.No:
+                return
+
+        self._project.setVariables(self._variables)
+        self._project.update()
+        self.accept()
+

gns3/dialogs/setup_wizard.py

@@ -0,0 +1,439 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 sys
+import os
+import shutil
+
+from gns3.qt import QtCore, QtWidgets, QtGui, QtNetwork, qslot
+from gns3.controller import Controller
+from gns3.local_server import LocalServer
+from gns3.utils.interfaces import interfaces
+
+from ..settings import DEFAULT_LOCAL_SERVER_HOST
+from ..ui.setup_wizard_ui import Ui_SetupWizard
+from ..version import __version__
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class SetupWizard(QtWidgets.QWizard, Ui_SetupWizard):
+
+    """
+    Base class for VM wizard.
+    """
+
+    def __init__(self, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+        self.adjustSize()
+
+        self._gns3_vm_settings = {
+            "enable": True,
+            "headless": False,
+            "when_exit": "stop",
+            "engine": "vmware",
+            "allocate_vcpus_ram": True,
+            "vcpus": 1,
+            "ram": 2048,
+            "vmname": "GNS3 VM",
+            "port": 80
+        }
+
+        self.setWizardStyle(QtWidgets.QWizard.ModernStyle)
+        if sys.platform.startswith("darwin"):
+            # we want to see the cancel button on OSX
+            self.setOptions(QtWidgets.QWizard.NoDefaultButton)
+
+        self.uiLocalServerToolButton.clicked.connect(self._localServerBrowserSlot)
+
+        self.uiGNS3VMDownloadLinkUrlLabel.setText("")
+        self.uiRefreshPushButton.clicked.connect(self._refreshVMListSlot)
+        self.uiVmwareRadioButton.clicked.connect(self._listVMwareVMsSlot)
+        self.uiVirtualBoxRadioButton.clicked.connect(self._listVirtualBoxVMsSlot)
+        settings = parent.settings()
+        self.uiShowCheckBox.setChecked(settings["hide_setup_wizard"])
+
+        # by default all radio buttons are unchecked
+        self.uiVmwareRadioButton.setAutoExclusive(False)
+        self.uiVirtualBoxRadioButton.setAutoExclusive(False)
+        self.uiVmwareRadioButton.setChecked(False)
+        self.uiVirtualBoxRadioButton.setChecked(False)
+
+        # Mandatory fields
+        self.uiLocalServerWizardPage.registerField("path*", self.uiLocalServerPathLineEdit)
+
+        # load all available addresses
+        for address in QtNetwork.QNetworkInterface.allAddresses():
+            if address.protocol() in [QtNetwork.QAbstractSocket.IPv4Protocol, QtNetwork.QAbstractSocket.IPv6Protocol]:
+                address_string = address.toString()
+                if address_string.startswith("169.254") or address_string.startswith("fe80"):
+                    # ignore link-local addresses, could not use https://doc.qt.io/qt-5/qhostaddress.html#isLinkLocal
+                    # because it was introduced in Qt 5.11
+                    continue
+                self.uiLocalServerHostComboBox.addItem(address_string, address_string)
+
+        self.uiLocalServerHostComboBox.addItem("localhost", "localhost")  # local host
+        self.uiLocalServerHostComboBox.addItem("::", "::")  # all IPv6 addresses
+        self.uiLocalServerHostComboBox.addItem("0.0.0.0", "0.0.0.0")  # all IPv4 addresses
+
+        if sys.platform.startswith("linux"):
+            self.uiLocalRadioButton.setChecked(True)
+            self.uiLocalLabel.setText("Dependencies like Dynamips and Qemu must be manually installed")
+
+        Controller.instance().connected_signal.connect(self._refreshLocalServerStatusSlot)
+        Controller.instance().connection_failed_signal.connect(self._refreshLocalServerStatusSlot)
+
+    def _localServerBrowserSlot(self):
+        """
+        Slot to open a file browser and select a local server.
+        """
+
+        filter = ""
+        if sys.platform.startswith("win"):
+            filter = "Executable (*.exe);;All files (*.*)"
+        server_path = shutil.which("gns3server")
+        path, _ = QtWidgets.QFileDialog.getOpenFileName(self, "Select the local server", server_path, filter)
+        if not path:
+            return
+
+        self.uiLocalServerPathLineEdit.setText(path)
+
+    def _listVMwareVMsSlot(self):
+        """
+        Slot to refresh the VMware VMs list.
+        """
+
+        download_url = "https://github.com/GNS3/gns3-gui/releases/download/v{version}/GNS3.VM.VMware.Workstation.{version}.zip".format(version=__version__)
+        self.uiGNS3VMDownloadLinkUrlLabel.setText('The GNS3 VM can <a href="{download_url}">downloaded here</a>.<br>Import the VM in your virtualization software and hit refresh.'.format(download_url=download_url))
+        self.uiVirtualBoxRadioButton.setChecked(False)
+        from gns3.modules import VMware
+        settings = VMware.instance().settings()
+        if not os.path.exists(settings["vmrun_path"]):
+            QtWidgets.QMessageBox.critical(self, "VMware", "VMware vmrun tool could not be found, VMware or the VIX API (required for VMware player) is probably not installed. You can download it from https://customerconnect.vmware.com/downloads/details?downloadGroup=PLAYER-1400-VIX1170&productId=687. After installation you need to restart GNS3.")
+            return
+        self._refreshVMListSlot()
+
+    def _listVirtualBoxVMsSlot(self):
+        """
+        Slot to refresh the VirtualBox VMs list.
+        """
+
+        download_url = "https://github.com/GNS3/gns3-gui/releases/download/v{version}/GNS3.VM.VirtualBox.{version}.zip".format(version=__version__)
+        self.uiGNS3VMDownloadLinkUrlLabel.setText('If you don\'t have the GNS3 Virtual Machine you can <a href="{download_url}">download it here</a>.<br>And import the VM in the virtualization software and hit refresh.'.format(download_url=download_url))
+        self.uiVmwareRadioButton.setChecked(False)
+        from gns3.modules import VirtualBox
+        settings = VirtualBox.instance().settings()
+        if not os.path.exists(settings["vboxmanage_path"]):
+            QtWidgets.QMessageBox.critical(self, "VirtualBox", "VBoxManage could not be found, VirtualBox is probably not installed. After installation you need to restart GNS3.")
+            return
+        self._refreshVMListSlot()
+
+    def _setPreferencesPane(self, dialog, name):
+        """
+        Finds the first child of the QTreeWidgetItem name.
+
+        :param dialog: PreferencesDialog instance
+        :param name: QTreeWidgetItem name
+
+        :returns: current QWidget
+        """
+
+        pane = dialog.uiTreeWidget.findItems(name, QtCore.Qt.MatchFixedString)[0]
+        child_pane = pane.child(0)
+        dialog.uiTreeWidget.setCurrentItem(child_pane)
+        return dialog.uiStackedWidget.currentWidget()
+
+    def _getSettingsCallback(self, result, error=False, **kwargs):
+        if error:
+            if "message" in result:
+                log.error("Error while get gettings: {}".format(result["message"]))
+            return
+        self._gns3_vm_settings = result
+
+    def initializePage(self, page_id):
+        """
+        Initialize Wizard pages.
+
+        :param page_id: page identifier
+        """
+
+        super().initializePage(page_id)
+        if self.page(page_id) == self.uiServerWizardPage:
+            Controller.instance().setDisplayError(False)
+            Controller.instance().get("/gns3vm", self._getSettingsCallback)
+        elif self.page(page_id) == self.uiVMWizardPage:
+            if self._GNS3VMSettings()["engine"] == "vmware":
+                self.uiVmwareRadioButton.setChecked(True)
+                self._listVMwareVMsSlot()
+            elif self._GNS3VMSettings()["engine"] == "virtualbox":
+                self.uiVirtualBoxRadioButton.setChecked(True)
+                self._listVirtualBoxVMsSlot()
+            self.uiCPUSpinBox.setValue(self._GNS3VMSettings()["vcpus"])
+            self.uiRAMSpinBox.setValue(self._GNS3VMSettings()["ram"])
+
+        elif self.page(page_id) == self.uiLocalServerWizardPage:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            self.uiLocalServerPathLineEdit.setText(local_server_settings["path"])
+            index = self.uiLocalServerHostComboBox.findData(local_server_settings["host"])
+            if index != -1:
+                self.uiLocalServerHostComboBox.setCurrentIndex(index)
+            else:
+                if self.uiVMRadioButton.isChecked():
+                    # Try to bind with the IP address allocated for VMnet1
+                    for interface in interfaces():
+                        if "vmnet1" in interface["name"].lower():
+                            index = self.uiLocalServerHostComboBox.findText(interface["ip_address"])
+                            break
+                else:
+                    index = self.uiLocalServerHostComboBox.findText(DEFAULT_LOCAL_SERVER_HOST)
+
+                if index != -1:
+                    self.uiLocalServerHostComboBox.setCurrentIndex(index)
+
+            self.uiLocalServerPortSpinBox.setValue(local_server_settings["port"])
+
+        elif self.page(page_id) == self.uiRemoteControllerWizardPage:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            if local_server_settings["host"] is None:
+                self.uiRemoteMainServerHostLineEdit.setText(DEFAULT_LOCAL_SERVER_HOST)
+                self.uiRemoteMainServerAuthCheckBox.setChecked(False)
+                self.uiRemoteMainServerUserLineEdit.setText("")
+                self.uiRemoteMainServerPasswordLineEdit.setText("")
+            else:
+                self.uiRemoteMainServerHostLineEdit.setText(local_server_settings["host"])
+                self.uiRemoteMainServerAuthCheckBox.setChecked(local_server_settings["auth"])
+                self.uiRemoteMainServerUserLineEdit.setText(local_server_settings["user"])
+                self.uiRemoteMainServerPasswordLineEdit.setText(local_server_settings["password"])
+            self.uiRemoteMainServerPortSpinBox.setValue(local_server_settings["port"])
+        elif self.page(page_id) == self.uiLocalServerStatusWizardPage:
+            self._refreshLocalServerStatusSlot()
+
+        elif self.page(page_id) == self.uiSummaryWizardPage:
+            self.uiSummaryTreeWidget.clear()
+            if self.uiLocalRadioButton.isChecked():
+                local_server_settings = LocalServer.instance().localServerSettings()
+                self._addSummaryEntry("Server type:", "Local")
+                self._addSummaryEntry("Path:", local_server_settings["path"])
+                self._addSummaryEntry("Host:", local_server_settings["host"])
+                self._addSummaryEntry("Port:", str(local_server_settings["port"]))
+            elif self.uiRemoteControllerRadioButton.isChecked():
+                local_server_settings = LocalServer.instance().localServerSettings()
+                self._addSummaryEntry("Server type:", "Remote")
+                self._addSummaryEntry("Host:", local_server_settings["host"])
+                self._addSummaryEntry("Port:", str(local_server_settings["port"]))
+                self._addSummaryEntry("User:", local_server_settings["user"])
+            else:
+                self._addSummaryEntry("Server type:", "GNS3 Virtual Machine")
+                self._addSummaryEntry("VM engine:", self._GNS3VMSettings()["engine"].capitalize())
+                self._addSummaryEntry("VM name:", self._GNS3VMSettings()["vmname"])
+                self._addSummaryEntry("VM vCPUs:", str(self._GNS3VMSettings()["vcpus"]))
+                self._addSummaryEntry("VM RAM:", str(self._GNS3VMSettings()["ram"]) + " MB")
+
+    @qslot
+    def _refreshLocalServerStatusSlot(self):
+        """
+        Refresh the local server status page
+        """
+
+        self.uiLocalServerTextEdit.clear()
+        if Controller.instance().connected():
+            self.uiLocalServerTextEdit.setText("Connection to the local GNS3 server has been successful!")
+            Controller.instance().get("/gns3vm", self._getSettingsCallback)
+        elif Controller.instance().connecting():
+            self.uiLocalServerTextEdit.setText("Please wait connection to the GNS3 server...")
+        else:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            self.uiLocalServerTextEdit.setText("Connection to local server failed. Please try one of the following:\n\n- Make sure GNS3 is allowed to run by your firewall.\n- Go back and try to change the server host binding and/or the port\n- Check with a browser if you can connect to {protocol}://{host}:{port}.\n- Try to run {path} in a terminal to see if you have an error.".format(protocol=local_server_settings["protocol"], host=local_server_settings["host"], port=local_server_settings["port"], path=local_server_settings["path"]))
+
+    def _GNS3VMSettings(self):
+        return self._gns3_vm_settings
+
+    def _setGNS3VMSettings(self, settings):
+        Controller.instance().put("/gns3vm", self._saveSettingsCallback, settings, timeout=60 * 5)
+
+    def _saveSettingsCallback(self, result, error=False, **kwargs):
+        if error:
+            if "message" in result:
+                QtWidgets.QMessageBox.critical(self, "Save settings", "Error while saving settings: {}".format(result["message"]))
+            return
+
+    def _addSummaryEntry(self, name, value):
+
+        item = QtWidgets.QTreeWidgetItem(self.uiSummaryTreeWidget, [name, value])
+        item.setText(0, name)
+        font = item.font(0)
+        font.setBold(True)
+        item.setFont(0, font)
+
+    def validateCurrentPage(self):
+        """
+        Validates the settings.
+        """
+
+        Controller.instance().setDisplayError(True)
+        if self.currentPage() == self.uiVMWizardPage:
+            vmname = self.uiVMListComboBox.currentText()
+            if vmname:
+                # save the GNS3 VM settings
+                vm_settings = self._GNS3VMSettings()
+                vm_settings["enable"] = True
+                vm_settings["vmname"] = vmname
+
+                if self.uiVmwareRadioButton.isChecked():
+                    vm_settings["engine"] = "vmware"
+                elif self.uiVirtualBoxRadioButton.isChecked():
+                    vm_settings["engine"] = "virtualbox"
+
+                # set the vCPU count and RAM
+                vpcus = self.uiCPUSpinBox.value()
+                ram = self.uiRAMSpinBox.value()
+                if ram < 1024:
+                    QtWidgets.QMessageBox.warning(self, "GNS3 VM memory", "It is recommended to allocate a minimum of 1024 MB of memory to the GNS3 VM")
+                vm_settings["vcpus"] = vpcus
+                vm_settings["ram"] = ram
+
+                self._setGNS3VMSettings(vm_settings)
+            else:
+                if not self.uiVmwareRadioButton.isChecked() and not self.uiVirtualBoxRadioButton.isChecked():
+                    QtWidgets.QMessageBox.warning(self, "GNS3 VM", "Please select VMware or VirtualBox")
+                else:
+                    QtWidgets.QMessageBox.warning(self, "GNS3 VM", "Please select a VM. If no VM is listed, check if the GNS3 VM is correctly imported and press refresh.")
+                return False
+        elif self.currentPage() == self.uiLocalServerWizardPage:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            local_server_settings["auto_start"] = True
+            local_server_settings["path"] = self.uiLocalServerPathLineEdit.text().strip()
+            local_server_settings["host"] = self.uiLocalServerHostComboBox.itemData(self.uiLocalServerHostComboBox.currentIndex())
+            local_server_settings["port"] = self.uiLocalServerPortSpinBox.value()
+
+            if not os.path.isfile(local_server_settings["path"]):
+                QtWidgets.QMessageBox.critical(self, "Local server", "Could not find local server {}".format(local_server_settings["path"]))
+                return False
+            if not os.access(local_server_settings["path"], os.X_OK):
+                QtWidgets.QMessageBox.critical(self, "Local server", "{} is not an executable".format(local_server_settings["path"]))
+                return False
+
+            LocalServer.instance().updateLocalServerSettings(local_server_settings)
+            if not LocalServer.instance().localServerAutoStartIfRequired():
+                return False
+
+        elif self.currentPage() == self.uiRemoteControllerWizardPage:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            local_server_settings["auto_start"] = False
+            local_server_settings["host"] = self.uiRemoteMainServerHostLineEdit.text()
+            local_server_settings["port"] = self.uiRemoteMainServerPortSpinBox.value()
+            local_server_settings["protocol"] = "http"
+            local_server_settings["user"] = self.uiRemoteMainServerUserLineEdit.text()
+            local_server_settings["password"] = self.uiRemoteMainServerPasswordLineEdit.text()
+            local_server_settings["auth"] = self.uiRemoteMainServerAuthCheckBox.isChecked()
+            LocalServer.instance().updateLocalServerSettings(local_server_settings)
+
+        elif self.currentPage() == self.uiSummaryWizardPage:
+            if self.uiLocalRadioButton.isChecked():
+                # deactivate the GNS3 VM if using the local server
+                vm_settings = self._GNS3VMSettings()
+                vm_settings["enable"] = False
+                self._setGNS3VMSettings(vm_settings)
+
+        elif self.currentPage() == self.uiLocalServerStatusWizardPage:
+            if not Controller.instance().connected():
+                return False
+
+        return True
+
+    def _refreshVMListSlot(self):
+        """
+        Refresh the list of VM available in VMware or VirtualBox.
+        """
+
+        if self.uiVmwareRadioButton.isChecked():
+            Controller.instance().get("/gns3vm/engines/vmware/vms", self._getVMsFromServerCallback, progressText="Retrieving VMware VM list from server...")
+        elif self.uiVirtualBoxRadioButton.isChecked():
+            Controller.instance().get("/gns3vm/engines/virtualbox/vms", self._getVMsFromServerCallback, progressText="Retrieving VirtualBox VM list from server...")
+
+    def _getVMsFromServerCallback(self, result, error=False, **kwargs):
+        """
+        Callback for getVMsFromServer.
+
+        :param progress_dialog: QProgressDialog instance
+        :param result: server response
+        :param error: indicates an error (boolean)
+        """
+
+        if error:
+            QtWidgets.QMessageBox.critical(self, "VM List", "{}".format(result["message"]))
+        else:
+            self.uiVMListComboBox.clear()
+            for vm in result:
+                self.uiVMListComboBox.addItem(vm["vmname"])
+
+            index = self.uiVMListComboBox.findText(self._GNS3VMSettings()["vmname"])
+            if index != -1:
+                self.uiVMListComboBox.setCurrentIndex(index)
+            else:
+                index = self.uiVMListComboBox.findText("GNS3 VM")
+                if index != -1:
+                    self.uiVMListComboBox.setCurrentIndex(index)
+                else:
+                    QtWidgets.QMessageBox.critical(self, "GNS3 VM", "Could not find a VM named 'GNS3 VM', is it imported in VMware or VirtualBox?")
+
+    def done(self, result):
+        """
+        This dialog is closed.
+
+        :param result: ignored
+        """
+
+        Controller.instance().setDisplayError(True)
+        settings = self.parentWidget().settings()
+        if result:
+            settings["hide_setup_wizard"] = True
+        else:
+            local_server_settings = LocalServer.instance().localServerSettings()
+            LocalServer.instance().updateLocalServerSettings(local_server_settings)
+            settings["hide_setup_wizard"] = not self.uiShowCheckBox.isChecked()
+        self.parentWidget().setSettings(settings)
+        super().done(result)
+
+    def nextId(self):
+        """
+        Wizard rules!
+        """
+
+        current_id = self.currentId()
+        if self.page(current_id) == self.uiLocalServerStatusWizardPage and not self.uiVMRadioButton.isChecked():
+            return self._pageId(self.uiSummaryWizardPage)
+
+        if self.page(current_id) == self.uiServerWizardPage and self.uiRemoteControllerRadioButton.isChecked():
+            return self._pageId(self.uiRemoteControllerWizardPage)
+
+        if self.page(current_id) == self.uiVMWizardPage:
+            return self._pageId(self.uiSummaryWizardPage)
+        return QtWidgets.QWizard.nextId(self)
+
+    def _pageId(self, page):
+        """
+        Return id of the page
+        """
+        for id in self.pageIds():
+            if self.page(id) == page:
+                return id
+        raise KeyError

gns3/dialogs/snapshots_dialog.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Dialog to manage the snapshots.
+"""
+
+from ..qt import QtCore, QtWidgets
+from ..ui.snapshots_dialog_ui import Ui_SnapshotsDialog
+from ..controller import Controller
+
+from datetime import datetime
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class SnapshotsDialog(QtWidgets.QDialog, Ui_SnapshotsDialog):
+
+    """
+    Snapshots dialog implementation.
+
+    :param parent: parent widget
+    """
+
+    def __init__(self, parent, project):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._project = project
+
+        self.uiCreatePushButton.clicked.connect(self._createSnapshotSlot)
+        self.uiDeletePushButton.clicked.connect(self._deleteSnapshotSlot)
+        self.uiRestorePushButton.clicked.connect(self._restoreSnapshotSlot)
+        self.uiSnapshotsList.itemDoubleClicked.connect(self._snapshotDoubleClickedSlot)
+        self._listSnapshots()
+
+    def _listSnapshots(self):
+        """
+        Lists all available snapshots.
+        """
+
+        self.uiSnapshotsList.clear()
+        if self._project:
+            Controller.instance().get("/projects/{}/snapshots".format(self._project.id()), self._listSnapshotsCallback)
+
+    def _listSnapshotsCallback(self, result, error=False, server=None, context={}, **kwargs):
+        if error:
+            if result:
+                log.error(result["message"])
+            return
+
+        for snapshot in result:
+            item = QtWidgets.QListWidgetItem(self.uiSnapshotsList)
+            item.setText("{} on {}".format(snapshot["name"], datetime.fromtimestamp(snapshot["created_at"]).strftime("%d/%m/%y at %H:%M:%S")))
+            item.setData(QtCore.Qt.UserRole, snapshot["snapshot_id"])
+
+        if self.uiSnapshotsList.count():
+            self.uiSnapshotsList.setCurrentRow(0)
+            self.uiDeletePushButton.setEnabled(True)
+            self.uiRestorePushButton.setEnabled(True)
+        else:
+            self.uiDeletePushButton.setEnabled(False)
+            self.uiRestorePushButton.setEnabled(False)
+
+    def _createSnapshotSlot(self):
+        """
+        Slot to create a snapshot.
+        """
+
+        snapshot_name, ok = QtWidgets.QInputDialog.getText(self, "Snapshot", "Snapshot name:", QtWidgets.QLineEdit.Normal, "Unnamed")
+        if ok and snapshot_name and self._project:
+            Controller.instance().post("/projects/{}/snapshots".format(self._project.id()),
+                                       self._createSnapshotsCallback,
+                                       {"name": snapshot_name},
+                                       progressText="Creation of snapshot '{}' in progress...".format(snapshot_name),
+                                       timeout=None)
+
+    def _createSnapshotsCallback(self, result, error=False, server=None, context={}, **kwargs):
+        if error:
+            if result:
+                log.error(result["message"])
+            else:
+                log.error("Cannot create snapshot of project")
+            return
+        self._listSnapshots()
+
+    def _deleteSnapshotSlot(self):
+        """
+        Slot to delete a snapshot.
+        """
+
+        item = self.uiSnapshotsList.currentItem()
+        if item:
+            snapshot_id = item.data(QtCore.Qt.UserRole)
+            Controller.instance().delete("/projects/{}/snapshots/{}".format(self._project.id(), snapshot_id), self._deleteSnapshotsCallback)
+
+    def _deleteSnapshotsCallback(self, result, error=False, server=None, context={}, **kwargs):
+
+        if error:
+            if result:
+                log.error(result["message"])
+            return
+        self._listSnapshots()
+
+    def _restoreSnapshotSlot(self):
+        """
+        Slot to restore a snapshot.
+        """
+
+        item = self.uiSnapshotsList.currentItem()
+        if item:
+            snapshot_id = item.data(QtCore.Qt.UserRole)
+            self._restoreSnapshot(snapshot_id)
+
+    def _restoreSnapshot(self, snapshot_id):
+        """
+        Restores a snapshot.
+
+        :param snapshot_id: id of the snapshot
+        """
+
+        reply = QtWidgets.QMessageBox.question(self, "Snapshots", "This will discard any changes made to your project since the snapshot was taken, would you like to proceed?", QtWidgets.QMessageBox.Ok, QtWidgets.QMessageBox.Cancel)
+        if reply == QtWidgets.QMessageBox.Cancel:
+            return
+
+        Controller.instance().post("/projects/{}/snapshots/{}/restore".format(self._project.id(), snapshot_id),
+                                   self._restoreSnapshotsCallback, progressText="Restoring snapshot...", timeout=None)
+
+    def _restoreSnapshotsCallback(self, result, error=False, server=None, context={}, **kwargs):
+
+        if error:
+            if result:
+                log.error(result["message"])
+            return
+        self.accept()
+
+    def _snapshotDoubleClickedSlot(self, item):
+        """
+        Slot to restore a snapshot when it is double clicked.
+        """
+
+        snapshot_id = item.data(QtCore.Qt.UserRole)
+        self._restoreSnapshot(snapshot_id)

gns3/dialogs/style_editor_dialog.py

@@ -0,0 +1,162 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Style editor to edit Shape items.
+"""
+
+from ..qt import QtCore, QtWidgets, QtGui
+from ..ui.style_editor_dialog_ui import Ui_StyleEditorDialog
+from ..items.shape_item import ShapeItem
+from ..items.rectangle_item import RectangleItem
+
+
+class StyleEditorDialog(QtWidgets.QDialog, Ui_StyleEditorDialog):
+
+    """
+    Style editor dialog.
+
+    :param parent: parent widget
+    :param items: list of items
+    """
+
+    def __init__(self, parent, items):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._items = items
+        self.uiColorPushButton.clicked.connect(self._setColorSlot)
+        self.uiBorderColorPushButton.clicked.connect(self._setBorderColorSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applyPreferencesSlot)
+
+        self.uiBorderStyleComboBox.addItem("Solid", QtCore.Qt.SolidLine)
+        self.uiBorderStyleComboBox.addItem("Dash", QtCore.Qt.DashLine)
+        self.uiBorderStyleComboBox.addItem("Dot", QtCore.Qt.DotLine)
+        self.uiBorderStyleComboBox.addItem("Dash Dot", QtCore.Qt.DashDotLine)
+        self.uiBorderStyleComboBox.addItem("Dash Dot Dot", QtCore.Qt.DashDotDotLine)
+        self.uiBorderStyleComboBox.addItem("No border", QtCore.Qt.NoPen)
+
+        # use the first item in the list as the model
+        first_item = items[0]
+        pen = first_item.pen()
+        if hasattr(first_item, "brush"):  # Line don't have brush
+            brush = first_item.brush()
+            self._color = brush.color()
+            self.uiColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._color.red(),
+                                                                                                  self._color.green(),
+                                                                                                  self._color.blue(),
+                                                                                                  self._color.alpha()))
+        else:
+            self.uiColorLabel.hide()
+            self.uiColorPushButton.hide()
+            self._color = None
+
+        self._border_color = pen.color()
+        self.uiBorderColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._border_color.red(),
+                                                                                                    self._border_color.green(),
+                                                                                                    self._border_color.blue(),
+                                                                                                    self._border_color.alpha()))
+        if isinstance(first_item, RectangleItem):
+            # use the horizontal corner radius first and then the vertical one if it's not set
+            # maybe we allow configuring them separately in the future
+            corner_radius = first_item.horizontalCornerRadius()
+            if not corner_radius:
+                corner_radius = first_item.verticalCornerRadius()
+            self.uiCornerRadiusSpinBox.setValue(corner_radius)
+        else:
+            self.uiCornerRadiusLabel.hide()
+            self.uiCornerRadiusSpinBox.hide()
+        self.uiRotationSpinBox.setValue(int(first_item.rotation()))
+        self.uiBorderWidthSpinBox.setValue(pen.width())
+        if isinstance(first_item, ShapeItem):
+            rect = first_item.rect()
+            self.uiWidthSpinBox.setValue(int(rect.width()))
+            self.uiHeightSpinBox.setValue(int(rect.height()))
+        else:
+            self.uiWidthSpinBox.hide()
+            self.uiWidthLabel.hide()
+            self.uiHeightSpinBox.hide()
+            self.uiHeightLabel.hide()
+        index = self.uiBorderStyleComboBox.findData(pen.style())
+        if index != -1:
+            self.uiBorderStyleComboBox.setCurrentIndex(index)
+
+    def _setColorSlot(self):
+        """
+        Slot to select the filling color.
+        """
+
+        color = QtWidgets.QColorDialog.getColor(self._color, self, "Select Color", QtWidgets.QColorDialog.ShowAlphaChannel)
+        if color.isValid():
+            self._color = color
+            self.uiColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._color.red(),
+                                                                                                  self._color.green(),
+                                                                                                  self._color.blue(),
+                                                                                                  self._color.alpha()))
+
+    def _setBorderColorSlot(self):
+        """
+        Slot to select the border color.
+        """
+
+        color = QtWidgets.QColorDialog.getColor(self._border_color, self, "Select Color", QtWidgets.QColorDialog.ShowAlphaChannel)
+        if color.isValid():
+            self._border_color = color
+            self.uiBorderColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._border_color.red(),
+                                                                                                        self._border_color.green(),
+                                                                                                        self._border_color.blue(),
+                                                                                                        self._border_color.alpha()))
+
+    def _applyPreferencesSlot(self):
+        """
+        Applies the new style settings.
+        """
+
+        border_style = QtCore.Qt.PenStyle(self.uiBorderStyleComboBox.itemData(self.uiBorderStyleComboBox.currentIndex()))
+        pen = QtGui.QPen(self._border_color, self.uiBorderWidthSpinBox.value(), border_style, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin)
+        if self._color:
+            brush = QtGui.QBrush(self._color)
+        else:
+            brush = None
+
+        for item in self._items:
+            item.setPen(pen)
+            # on multi-selection it's possible to select many type of items
+            # but brush can be applied only on ShapeItem,
+            if brush and isinstance(item, ShapeItem):
+                item.setBrush(brush)
+            if isinstance(item, RectangleItem):
+                corner_radius = self.uiCornerRadiusSpinBox.value()
+                # use the corner radius for both horizontal (rx) and vertical (ry)
+                # maybe we support setting them separately in the future
+                item.setHorizontalCornerRadius(corner_radius)
+                item.setVerticalCornerRadius(corner_radius)
+            if isinstance(item, ShapeItem):
+                item.setWidthAndHeight(self.uiWidthSpinBox.value(), self.uiHeightSpinBox.value())
+            item.setRotation(self.uiRotationSpinBox.value())
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            self._applyPreferencesSlot()
+        super().done(result)

gns3/dialogs/style_editor_dialog_link.py

@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Pekka Helenius
+# Copyright (C) 2014 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/>.
+
+"""
+Style editor to edit Link items.
+"""
+
+from ..qt import QtCore, QtWidgets, QtGui
+from ..ui.style_editor_dialog_ui import Ui_StyleEditorDialog
+
+
+class StyleEditorDialogLink(QtWidgets.QDialog, Ui_StyleEditorDialog):
+
+    """
+    Style editor dialog.
+
+    :param parent: parent widget
+    :param link: selected link
+    """
+
+    def __init__(self, link, parent):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._link = link
+        self._link_style = {}
+
+        self.uiBorderColorPushButton.clicked.connect(self._setBorderColorSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applyPreferencesSlot)
+
+        self.uiBorderStyleComboBox.addItem("Solid", QtCore.Qt.SolidLine)
+        self.uiBorderStyleComboBox.addItem("Dash", QtCore.Qt.DashLine)
+        self.uiBorderStyleComboBox.addItem("Dot", QtCore.Qt.DotLine)
+        self.uiBorderStyleComboBox.addItem("Dash Dot", QtCore.Qt.DashDotLine)
+        self.uiBorderStyleComboBox.addItem("Dash Dot Dot", QtCore.Qt.DashDotDotLine)
+        self.uiBorderStyleComboBox.addItem("Invisible", QtCore.Qt.NoPen)
+
+        self.uiColorLabel.hide()
+        self.uiColorPushButton.hide()
+        self._color = None
+
+        self.uiCornerRadiusLabel.hide()
+        self.uiCornerRadiusSpinBox.hide()
+        self.uiRotationLabel.hide()
+        self.uiRotationSpinBox.hide()
+
+        link.setHovered(False)  # make sure we use the right style
+        pen = link.pen()
+        link.setHovered(True)
+
+        self._border_color = pen.color()
+        self.uiBorderColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._border_color.red(),
+                                                                                                    self._border_color.green(),
+                                                                                                    self._border_color.blue(),
+                                                                                                    self._border_color.alpha()))
+        self.uiBorderWidthSpinBox.setValue(pen.width())
+        index = self.uiBorderStyleComboBox.findData(pen.style())
+        if index != -1:
+            self.uiBorderStyleComboBox.setCurrentIndex(index)
+
+        self.adjustSize()
+
+    def _setBorderColorSlot(self):
+        """
+        Slot to select the border color.
+        """
+
+        color = QtWidgets.QColorDialog.getColor(self._border_color, self, "Select Color", QtWidgets.QColorDialog.ShowAlphaChannel)
+        if color.isValid():
+            self._border_color = color
+            self.uiBorderColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(self._border_color.red(),
+                                                                                                        self._border_color.green(),
+                                                                                                        self._border_color.blue(),
+                                                                                                        self._border_color.alpha()))
+
+    def _applyPreferencesSlot(self):
+        """
+        Applies the new style settings.
+        """
+
+        border_style = QtCore.Qt.PenStyle(self.uiBorderStyleComboBox.itemData(self.uiBorderStyleComboBox.currentIndex()))
+        pen = QtGui.QPen(self._border_color, self.uiBorderWidthSpinBox.value(), border_style, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin)
+
+        self._link.setPen(pen)
+
+        new_link_style = {}
+        new_link_style["color"] = self._border_color.name()
+        new_link_style["width"] = self.uiBorderWidthSpinBox.value()
+        new_link_style["type"]  = border_style
+        
+        # Store values
+        self._link.setLinkStyle(new_link_style)
+        self._link.setHovered(False)  # allow to see the new style
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            self._applyPreferencesSlot()
+        super().done(result)

gns3/dialogs/symbol_selection_dialog.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Dialog to change node symbols.
+"""
+
+import os
+import pathlib
+
+from ..qt import QtCore, QtGui, QtWidgets, qpartial, sip_is_deleted
+from ..qt.qimage_svg_renderer import QImageSvgRenderer
+from ..ui.symbol_selection_dialog_ui import Ui_SymbolSelectionDialog
+from ..controller import Controller
+from ..symbol import Symbol
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class SymbolSelectionDialog(QtWidgets.QDialog, Ui_SymbolSelectionDialog):
+
+    """
+    Symbol selection dialog.
+
+    :param parent: parent widget
+    :param items: list of items
+    """
+
+    _symbols_dir = None
+
+    def __init__(self, parent, items=None, symbol=None):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._items = items
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applyPreferencesSlot)
+        self.uiSymbolToolButton.clicked.connect(self._symbolBrowserSlot)
+        self.uiCustomSymbolRadioButton.toggled.connect(self._customSymbolToggledSlot)
+        self.uiBuiltInSymbolRadioButton.toggled.connect(self._builtInSymbolToggledSlot)
+        self.uiSearchLineEdit.textChanged.connect(self._searchTextChangedSlot)
+        if not SymbolSelectionDialog._symbols_dir:
+            SymbolSelectionDialog._symbols_dir = QtCore.QStandardPaths.writableLocation(QtCore.QStandardPaths.PicturesLocation)
+
+        if not self._items:
+            self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).hide()
+
+        self.uiBuiltInSymbolRadioButton.setChecked(True)
+        self.uiSymbolTreeWidget.setFocus()
+        self.uiSymbolTreeWidget.setIconSize(QtCore.QSize(64, 64))
+        self._symbol_items = []
+        self._parents = {}
+
+        Controller.instance().clearStaticCache()  # TODO: use etag to know when to refresh the cache
+        Controller.instance().get("/symbols", self._listSymbolsCallback)
+
+    def _listSymbolsCallback(self, result, error=False, **kwargs):
+        if error:
+            log.error("Error while listing symbols: {}".format(result["message"]))
+            return
+
+        self._symbol_items = []
+        for symbol in result:
+            symbol = Symbol(**symbol)
+            theme = symbol.theme()
+            if theme not in self._parents:
+                parent = QtWidgets.QTreeWidgetItem(self.uiSymbolTreeWidget)
+                parent.setText(0, theme)
+                font = parent.font(0)
+                font.setBold(True)
+                parent.setFont(0, font)
+                parent.setFlags(parent.flags() & ~QtCore.Qt.ItemIsSelectable)
+                self._parents[theme] = parent
+            else:
+                parent = self._parents[theme]
+
+            name = os.path.splitext(symbol.filename())[0]
+            item = QtWidgets.QTreeWidgetItem(parent)
+            item.setData(0, QtCore.Qt.UserRole, symbol)
+            item.setToolTip(0, symbol.id())
+            self._symbol_items.append(item)
+            item.setText(0, name)
+
+            def render(item, path):
+                if sip_is_deleted(item):
+                    return
+                svg_renderer = QImageSvgRenderer(path)
+                image = QtGui.QImage(64, 64, QtGui.QImage.Format_ARGB32)
+                # Set the ARGB to 0 to prevent rendering artifacts
+                image.fill(0x00000000)
+                svg_renderer.render(QtGui.QPainter(image))
+                icon = QtGui.QIcon(QtGui.QPixmap.fromImage(image))
+                item.setIcon(0, icon)
+
+            Controller.instance().getStatic(symbol.url(), qpartial(render, item))
+
+        for parent in self._parents.values():
+            parent.sortChildren(0, QtCore.Qt.AscendingOrder)
+        self.adjustSize()
+
+    def _searchTextChangedSlot(self, text):
+        self._filter()
+
+    def _filter(self):
+        """
+        Hide element not matching the search
+        """
+        text = self.uiSearchLineEdit.text()
+        for item in self._symbol_items:
+            # if not item.data(0, QtCore.Qt.UserRole).builtin():
+            #     item.setHidden(True)
+            # else:
+            if not text.strip() or text.strip().lower() in item.text(0).lower():
+                item.setHidden(False)
+            else:
+                item.setHidden(True)
+
+    def _customSymbolToggledSlot(self, checked):
+        """
+        Slot for when the custom symbol radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+
+        if checked:
+            self.uiCustomSymbolGroupBox.setEnabled(True)
+            self.uiCustomSymbolGroupBox.show()
+            self.uiBuiltInGroupBox.setEnabled(False)
+            self.uiBuiltInGroupBox.hide()
+            self.adjustSize()
+
+    def _builtInSymbolToggledSlot(self, checked):
+        """
+        Slot for when the built-in symbol radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+
+        if checked:
+            self.uiCustomSymbolGroupBox.setEnabled(False)
+            self.uiCustomSymbolGroupBox.hide()
+            self.uiBuiltInGroupBox.setEnabled(True)
+            self.uiBuiltInGroupBox.show()
+            self.adjustSize()
+
+    def _applyPreferencesSlot(self):
+        """
+        Applies the selected symbol to the items.
+        """
+
+        symbol_path = self.getSymbol()
+        if not symbol_path:
+            return False
+        for item in self._items:
+            item.setSymbol(symbol_path)
+        return True
+
+    def getSymbol(self):
+
+        if self.uiSymbolTreeWidget.isEnabled():
+            current = self.uiSymbolTreeWidget.currentItem()
+            if current and current.parent():
+                return current.data(0, QtCore.Qt.UserRole).id()
+        else:
+            return os.path.basename(self.uiSymbolLineEdit.text())
+        return None
+
+    def _symbolBrowserSlot(self):
+
+        # supported image file formats
+        file_formats = "Image files (*.svg *.bmp *.jpeg *.jpg *.pbm *.pgm *.png *.ppm *.xbm *.xpm *.gif);;All files (*.*)"
+        path, _ = QtWidgets.QFileDialog.getOpenFileName(self, "Image", SymbolSelectionDialog._symbols_dir, file_formats)
+        if not path:
+            return
+        SymbolSelectionDialog._symbols_dir = os.path.dirname(path)
+
+        symbol_id = os.path.basename(path)
+        Controller.instance().post("/symbols/" + symbol_id + "/raw", qpartial(self._finishSymbolUpload, path), body=pathlib.Path(path), progressText="Uploading {}".format(symbol_id), timeout=None)
+
+    def _finishSymbolUpload(self, path, result, error=False, **kwargs):
+        if error:
+            log.error("Error while uploading symbol: {}: {}".format(path, result.get("message", "unknown")))
+            return
+        self.uiSymbolLineEdit.clear()
+        self.uiSymbolLineEdit.setText(path)
+        self.uiSymbolLineEdit.setToolTip('<img src="{}"/>'.format(path))
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result and self._items and not self._applyPreferencesSlot():
+            result = 0
+        super().done(result)
+
+
+

gns3/dialogs/text_editor_dialog.py

@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Text editor to edit Note items.
+"""
+
+from ..qt import QtCore, QtWidgets, qslot, sip_is_deleted
+from ..ui.text_editor_dialog_ui import Ui_TextEditorDialog
+
+
+class TextEditorDialog(QtWidgets.QDialog, Ui_TextEditorDialog):
+    """
+    Text editor dialog.
+
+    :param parent: parent widget
+    :param items: list of items
+    """
+
+    def __init__(self, parent, items):
+
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self._items = items
+        self.uiFontPushButton.clicked.connect(self._setFontSlot)
+        self.uiColorPushButton.clicked.connect(self._setColorSlot)
+        self.uiButtonBox.button(QtWidgets.QDialogButtonBox.Apply).clicked.connect(self._applyPreferencesSlot)
+
+        # use the first item in the list as the model
+        first_item = items[0]
+        self._setColor(first_item.defaultTextColor())
+        self.uiRotationSpinBox.setValue(int(first_item.rotation()))
+        self.uiPlainTextEdit.setPlainText(first_item.toPlainText())
+        self.uiPlainTextEdit.setFont(first_item.font())
+
+        if not first_item.editable():
+            self.uiPlainTextEdit.setTextInteractionFlags(QtCore.Qt.NoTextInteraction)
+
+        if len(self._items) == 1:
+            self.uiApplyColorToAllItemsCheckBox.setChecked(True)
+            self.uiApplyColorToAllItemsCheckBox.hide()
+            self.uiApplyRotationToAllItemsCheckBox.setChecked(True)
+            self.uiApplyRotationToAllItemsCheckBox.hide()
+            self.uiApplyTextToAllItemsCheckBox.setChecked(True)
+            self.uiApplyTextToAllItemsCheckBox.hide()
+
+    def _setColor(self, color):
+        self._color = color
+        self.uiColorPushButton.setStyleSheet("background-color: rgba({}, {}, {}, {});".format(color.red(),
+                                                                                              color.green(),
+                                                                                              color.blue(),
+                                                                                              color.alpha()))
+        self.uiPlainTextEdit.setStyleSheet("color: rgba({}, {}, {}, {});".format(color.red(),
+                                                                                 color.green(),
+                                                                                 color.blue(),
+                                                                                 color.alpha()))
+
+    @qslot
+    def _setFontSlot(self, *args):
+        """
+        Slot to select the font.
+        """
+
+        selected_font, ok = QtWidgets.QFontDialog.getFont(self.uiPlainTextEdit.font(), self,
+                                                          options=QtWidgets.QFontDialog.DontUseNativeDialog)
+        if ok:
+            self.uiPlainTextEdit.setFont(selected_font)
+
+    @qslot
+    def _setColorSlot(self, *args):
+        """
+        Slot to select the color.
+        """
+
+        color = QtWidgets.QColorDialog.getColor(self._color, self, None, QtWidgets.QColorDialog.ShowAlphaChannel)
+        if color.isValid():
+            self._setColor(color)
+
+    @qslot
+    def _applyPreferencesSlot(self, *args):
+        """
+        Applies the new text settings.
+        """
+
+        for item in self._items:
+            if sip_is_deleted(item):
+                continue
+            item.setFont(self.uiPlainTextEdit.font())
+            if self.uiApplyColorToAllItemsCheckBox.isChecked():
+                item.setDefaultTextColor(self._color)
+            if self.uiApplyRotationToAllItemsCheckBox.isChecked():
+                item.setRotation(self.uiRotationSpinBox.value())
+            if item.editable() and self.uiApplyTextToAllItemsCheckBox.isChecked():
+                item.setPlainText(self.uiPlainTextEdit.toPlainText())
+
+    def done(self, result):
+        """
+        Called when the dialog is closed.
+
+        :param result: boolean (accepted or rejected)
+        """
+
+        if result:
+            self._applyPreferencesSlot()
+        super().done(result)

gns3/dialogs/vm_with_images_wizard.py

@@ -0,0 +1,188 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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/>.
+
+
+from .vm_wizard import VMWizard
+from gns3.qt import QtWidgets
+from gns3.controller import Controller
+
+
+class VMWithImagesWizard(VMWizard):
+    """
+    Base class for VM wizard with image management (Qemu, IOU...)
+
+    :param devices: List of existing device for this type
+    :param parent: parent widget
+    """
+
+    def __init__(self, devices, parent):
+        # The list of images combo box (Qemu support multiple images)
+        self._images_combo_boxes = set()
+
+        # The list of radio button for existing image or new images
+        self._radio_existing_images_buttons = set()
+
+        super().__init__(devices, parent)
+
+    def refreshImageStepsButtons(self):
+        """
+        When changing the server type (remote or local)
+        Refresh all the image selectors
+        """
+        for radio_button in self._radio_existing_images_buttons:
+            radio_button.setChecked(radio_button.isChecked())
+
+    def _vmToggledSlot(self, checked):
+        super()._vmToggledSlot(checked)
+        if checked:
+            self.refreshImageStepsButtons()
+
+    def _remoteServerToggledSlot(self, checked):
+        super()._remoteServerToggledSlot(checked)
+        if checked:
+            self.refreshImageStepsButtons()
+
+    def _localToggledSlot(self, checked):
+        super()._localToggledSlot(checked)
+        if checked:
+            self.refreshImageStepsButtons()
+
+    def addImageSelector(self, radio_button, combo_box, line_edit, browser, image_selector, create_button=None, create_image_wizard=None, image_suffix=""):
+        """
+        Add a remote image selector
+
+        :param radio_button: Radio button which toggle display of the listbox
+        :param combo_box: The image choice combo box
+        :param line_edit: The edit for the image
+        :param browser: file upload browser button
+        :param image_selector: function which display an image selector and return path
+        :param create_button: Image create button None if you don't need one
+        :param create_image_wizard: Wizard Class for creating a new image
+        """
+
+        combo_box.currentIndexChanged.connect(lambda index: self._imageListIndexChangedSlot(index, combo_box, line_edit))
+        self._images_combo_boxes.add(combo_box)
+
+        browser.clicked.connect(lambda: self._imageBrowserSlot(line_edit, image_selector))
+
+        if create_button:
+            assert create_image_wizard is not None
+            create_button.clicked.connect(lambda: self._imageCreateSlot(line_edit, create_image_wizard, image_suffix))
+
+        self._existingImageToggledSlot(True, combo_box, line_edit, browser, create_button)
+        radio_button.toggled.connect(lambda checked: self._existingImageToggledSlot(checked, combo_box, line_edit, browser, create_button))
+        self._radio_existing_images_buttons.add(radio_button)
+
+    def _imageCreateSlot(self, line_edit, create_image_wizard, image_suffix):
+        create_dialog = create_image_wizard(self, self.getSettings()["compute_id"], self.uiNameLineEdit.text() + image_suffix)
+        if QtWidgets.QDialog.Accepted == create_dialog.exec_():
+            line_edit.setText(create_dialog.uiLocationLineEdit.text())
+
+    def _imageBrowserSlot(self, line_edit, image_selector):
+        """
+        Slot to open a file browser and select an image.
+        """
+
+        path = image_selector(self, self._compute_id)
+        if not path:
+            return
+        line_edit.clear()
+        line_edit.setText(path)
+
+    def _imageListIndexChangedSlot(self, index, combo_box, line_edit):
+        """
+        User select a different image in the combo box
+        """
+        item = combo_box.itemData(index)
+        if item and item["path"]:
+            line_edit.setText(item["path"])
+        else:
+            line_edit.setText("")
+
+    def _existingImageToggledSlot(self, checked, combo_box, line_edit, browser, create_button):
+        """
+        User select the option of using an existing image
+        """
+
+        if create_button:
+            create_button.hide()
+
+        if checked:
+            combo_box.show()
+            browser.hide()
+            line_edit.hide()
+            if combo_box.count() > 0:
+                line_edit.setText(combo_box.itemData(combo_box.currentIndex())["path"])
+        else:
+            combo_box.hide()
+            line_edit.setText("")
+            line_edit.show()
+            browser.show()
+            if create_button:
+                create_button.show()
+
+    def loadImagesList(self, endpoint):
+        """
+        Fill the list box with available Images"
+
+        :param endpoint: server endpoint with the list of Images
+        """
+
+        Controller.instance().getCompute(endpoint, self._compute_id, self._getImagesFromServerCallback)
+
+    def _getImagesFromServerCallback(self, result, error=False, **kwargs):
+        """
+        Callback for loadImagesList.
+
+        :param result: server response
+        :param error: indicates an error (boolean)
+        """
+
+        if error:
+            QtWidgets.QMessageBox.critical(self, "Images", "Error while getting the VMs: {}".format(result["message"]))
+            return
+
+        # Wizard is closed
+        if self.currentPage() is None:
+            return
+
+        if len(result) == 0:
+            for radio_button in self._radio_existing_images_buttons:
+                if radio_button.isChecked() and self._widgetOnCurrentPage(radio_button):
+                    for button in radio_button.parent().findChildren(QtWidgets.QRadioButton):
+                        if button != radio_button:
+                            button.setChecked(True)
+                        button.hide()
+        else:
+            for radio_button in self._radio_existing_images_buttons:
+                if self._widgetOnCurrentPage(radio_button):
+                    for button in radio_button.parent().findChildren(QtWidgets.QRadioButton):
+                        if button == radio_button:
+                            button.setChecked(True)
+                        button.show()
+
+        for combo_box in self._images_combo_boxes:
+            if self._widgetOnCurrentPage(combo_box):
+                combo_box.clear()
+                for vm in result:
+                    combo_box.addItem(vm["path"], vm)
+
+    def _widgetOnCurrentPage(self, widget):
+        """
+        :returns Boolean True if widget is current active Wizard page
+        """
+        return self.currentPage().findChild(widget.__class__, widget.objectName()) is not None

gns3/dialogs/vm_wizard.py

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 sys
+
+from gns3.qt import QtWidgets
+from gns3.compute_manager import ComputeManager
+from gns3.controller import Controller
+
+
+class VMWizard(QtWidgets.QWizard):
+    """
+    Base class for VM wizard.
+
+    :param devices: List of existing device for this type
+    :param parent: parent widget
+    """
+
+    def __init__(self, devices, parent):
+        super().__init__(parent)
+        self.setupUi(self)
+
+        self.setModal(True)
+
+        self._devices = devices
+        self._local_server_disable = False
+
+        self.setWizardStyle(QtWidgets.QWizard.ModernStyle)
+        if sys.platform.startswith("darwin"):
+            # we want to see the cancel button on OSX
+            self.setOptions(QtWidgets.QWizard.NoDefaultButton)
+
+        self.uiRemoteRadioButton.toggled.connect(self._remoteServerToggledSlot)
+        if hasattr(self, "uiVMRadioButton"):
+            self.uiVMRadioButton.toggled.connect(self._vmToggledSlot)
+
+        self.uiLocalRadioButton.toggled.connect(self._localToggledSlot)
+        if Controller.instance().isRemote():
+            self.uiLocalRadioButton.setText("Run device on the main server")
+
+        # By default we use the local server
+        self._compute_id = "local"
+        self.uiLocalRadioButton.setChecked(True)
+        self._localToggledSlot(True)
+
+        if len(ComputeManager.instance().computes()) == 1:
+            # skip the server page if we use the first server
+            self.setStartId(1)
+
+    def _vmToggledSlot(self, checked):
+        """
+        Slot for when the VM radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(False)
+            self.uiRemoteServersGroupBox.hide()
+
+    def _remoteServerToggledSlot(self, checked):
+        """
+        Slot for when the remote server radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(True)
+            self.uiRemoteServersComboBox.setEnabled(True)
+            self.uiRemoteServersGroupBox.show()
+
+    def _localToggledSlot(self, checked):
+        """
+        Slot for when the local server radio button is toggled.
+
+        :param checked: either the button is checked or not
+        """
+        if checked:
+            self.uiRemoteServersGroupBox.setEnabled(False)
+            self.uiRemoteServersGroupBox.hide()
+
+    def initializePage(self, page_id):
+
+        if self.page(page_id) == self.uiServerWizardPage:
+            self.uiRemoteServersComboBox.clear()
+
+            self.uiRemoteRadioButton.setEnabled(False)
+            if hasattr(self, "uiVMRadioButton"):
+                self.uiVMRadioButton.setEnabled(False)
+            self.uiLocalRadioButton.setEnabled(False)
+            for compute in ComputeManager.instance().computes():
+                if compute.id() == "local":
+                    self.uiLocalRadioButton.setEnabled(True)
+                elif compute.id() == "vm":
+                    if hasattr(self, "uiVMRadioButton"):
+                        self.uiVMRadioButton.setEnabled(True)
+                else:
+                    self.uiRemoteRadioButton.setEnabled(True)
+                    self.uiRemoteServersComboBox.addItem(compute.name(), compute.id())
+
+            if self.uiLocalRadioButton.isEnabled() and not self._local_server_disable:
+                self.uiLocalRadioButton.setChecked(True)
+            elif hasattr(self, "uiVMRadioButton") and self.uiVMRadioButton.isEnabled():
+                self.uiVMRadioButton.setChecked(True)
+            else:
+                if self.uiRemoteRadioButton.isEnabled():
+                    self.uiRemoteRadioButton.setChecked(True)
+                else:
+                    self.uiLocalRadioButton.setChecked(True)
+
+    def _disableLocalServer(self):
+        """
+        Turn off the local server
+        """
+        self._local_server_disable = True
+        self.uiLocalRadioButton.hide()
+        self.uiLocalRadioButton.setEnabled(False)
+        self.setStartId(0)
+
+    def validateCurrentPage(self):
+        if hasattr(self, "uiNameWizardPage") and self.currentPage() == self.uiNameWizardPage:
+            name = self.uiNameLineEdit.text()
+            for device in self._devices.values():
+                if device["name"] == name:
+                    QtWidgets.QMessageBox.critical(self, "Name", "{} is already used, please choose another name".format(name))
+                    return False
+        elif self.currentPage() == self.uiServerWizardPage:
+            # If the local button is not visible it's because it's not supported
+            if self.uiLocalRadioButton.isChecked() and self.uiLocalRadioButton.isHidden():
+                QtWidgets.QMessageBox.critical(self, "New device", "Please configure before the GNS3 VM in order to use this device.")
+                return False
+
+            if self.uiRemoteRadioButton.isChecked():
+                if self.uiRemoteServersComboBox.count() == 0:
+                    QtWidgets.QMessageBox.critical(self, "Remote server", "There is no remote server registered in your preferences")
+                    return False
+                self._compute_id = self.uiRemoteServersComboBox.itemData(self.uiRemoteServersComboBox.currentIndex())
+            elif hasattr(self, "uiVMRadioButton") and self.uiVMRadioButton.isChecked():
+                self._compute_id = "vm"
+            else:
+                if self.uiLocalRadioButton.isEnabled():
+                    self._compute_id = "local"
+                else:
+                    QtWidgets.QMessageBox.critical(self, "Server", "No available server support this type of node. You probably need to setup the GNS3 VM")
+                    return False
+        return True

gns3/early_release_dialog.py

@@ -1,61 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2014 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 re
-from .qt import QtGui
-from .ui.early_release_dialog_ui import Ui_EarlyReleaseDialog
-
-
-class EarlyReleaseDialog(QtGui.QDialog, Ui_EarlyReleaseDialog):
-    """
-    Early release dialog.
-    """
-
-    def __init__(self, parent):
-
-        QtGui.QDialog.__init__(self, parent)
-        self.setupUi(self)
-
-    def isEmail(self, email):
-
-        if re.match("([\w\-\.]+@(\w[\w\-]+\.)+[\w\-]+)", email):
-            return True
-        else:
-            return False
-
-    def done(self, result):
-
-        if not result:  # cancelled
-            QtGui.QApplication.quit()
-        else:
-            username = self.uiUsernameLineEdit.text().strip()
-            if not username:
-                QtGui.QMessageBox.critical(self, "Username", "Please provide an username")
-                return
-            email = self.uiEmailLineEdit.text().strip()
-            if not email:
-                QtGui.QMessageBox.critical(self, "Email", "Please provide an email address")
-                return
-            if not re.search(r"""^GNS[34]{1}[0-9]{4}$""", username) or not self.isEmail(email):
-                QtGui.QMessageBox.critical(self, "Invalid membership", "Sorry this is an invalid membership")
-                return
-            if not self.uiDisclaimerCheckBox.isChecked():
-                QtGui.QMessageBox.critical(self, "Disclaimer", "Please read the disclaimer!")
-                return
-            # Congratulations, you have found where we check for a GNS3 membership! and yes, it is very simple ;)
-            # Since you were smart enough to get here, you deserve to use GNS3 without a membership...
-        QtGui.QDialog.done(self, result)

gns3/http_client.py

@@ -0,0 +1,862 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2015 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/>.
+
+from .qt import sip
+import json
+import copy
+import uuid
+import pathlib
+import base64
+import ipaddress
+import urllib.request
+import urllib.parse
+
+from .version import __version__, __version_info__
+from .qt import QtCore, QtNetwork, QtWidgets, qpartial, sip_is_deleted
+from .utils import parse_version
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class HttpBadRequest(Exception):
+
+    """We raise bad request exception for logging them in Sentry"""
+    pass
+
+
+class HTTPClient(QtCore.QObject):
+
+    """
+    HTTP client.
+
+    :param settings: Dictionary with connection information to the server
+    :param network_manager: A QT network manager
+    """
+
+    # Callback class used for displaying progress
+    _progress_callback = None
+
+    connection_connected_signal = QtCore.Signal()
+    connection_disconnected_signal = QtCore.Signal()
+
+    def __init__(self, settings, network_manager=None, max_retry_connection=5):
+        super().__init__()
+
+        self._protocol = settings.get("protocol", "http")
+        self._host = settings["host"]
+        try:
+            if self._host is None or self._host == "0.0.0.0":
+                self._host = "127.0.0.1"
+            elif ":" in self._host and ipaddress.IPv6Address(self._host) and str(ipaddress.IPv6Address(self._host)) == "::":
+                self._host = "::1"
+        except ipaddress.AddressValueError:
+            log.error("Invalid host name %s", self._host)
+        self._port = int(settings["port"])
+        self._user = settings.get("user", None)
+        self._password = settings.get("password", None)
+        # How many time we have already retried connection
+        self._retry = 0
+        self._max_retry_connection = max_retry_connection
+        self._connected = False
+        self._shutdown = False  # Shutdown in progress
+        self._accept_insecure_certificate = settings.get("accept_insecure_certificate", None)
+
+        # Add custom CA
+        # ssl_config = QtNetwork.QSslConfiguration.defaultConfiguration()
+        # if ssl_config.addCaCertificates("/path/to/rootCA.crt"):
+        #     log.debug("CA certificate added")
+        # QtNetwork.QSslConfiguration.setDefaultConfiguration(ssl_config)
+
+        if self._protocol == "https":
+            if not QtNetwork.QSslSocket.supportsSsl():
+                log.error("SSL is not supported")
+            else:
+                log.debug(f"SSL is supported, version: {QtNetwork.QSslSocket().sslLibraryBuildVersionString()}")
+
+        # In order to detect computer hibernation we detect the date of the last
+        # query and disconnect if time is too long between two query
+        self._last_query_timestamp = None
+        self._max_time_difference_between_queries = None
+        if network_manager:
+            self._network_manager = network_manager
+        else:
+            self._network_manager = QtNetwork.QNetworkAccessManager()
+        # A buffer used by progress download
+        self._buffer = {}
+
+        # List of query waiting for the connection
+        self._query_waiting_connections = []
+
+        # To catch SSL errors
+        self._network_manager.sslErrors.connect(self._sslErrorsSlot)
+
+        # Store SSL error exceptions
+        self._ssl_exceptions = {}
+
+    def setMaxTimeDifferenceBetweenQueries(self, value):
+        self._max_time_difference_between_queries = value
+
+    def host(self):
+        """
+        Host display to user
+        """
+        return self._host
+
+    def setHost(self, host):
+        self._host = host
+
+    def port(self):
+        """
+        Port display to user
+        """
+        return self._port
+
+    def setPort(self, port):
+        self._port = port
+
+    def protocol(self):
+        """
+        Transport protocol
+        """
+        return self._protocol
+
+    def setAcceptInsecureCertificate(self, certificate):
+        """
+        Does the server accept this insecure SSL certificate digest
+
+        :param: Certificate digest
+        """
+        self._accept_insecure_certificate = certificate
+
+    def user(self):
+        """
+        User login display to GNS3 user
+        """
+        return self._user
+
+    def url(self):
+        """Returns current server url"""
+
+        if ":" in self.host():
+            return "{}://[{}]:{}".format(self.protocol(), self.host(), self.port())
+        return "{}://{}:{}".format(self.protocol(), self.host(), self.port())
+
+    def fullUrl(self):
+        """Returns current server url including user and password"""
+        host = self.host()
+        if ":" in self.host():
+            host = "[{}]".format(host)
+
+        if self._user:
+            return "{}://{}:{}@{}:{}".format(self.protocol(), self._user, self._password, host, self.port())
+        else:
+            return "{}://{}:{}".format(self.protocol(), host, self.port())
+
+    def password(self):
+        return self._password
+
+    def setPassword(self, password):
+        self._password = password
+
+    def shutdown(self):
+        """
+        Stop the server and stop to accept queries
+        """
+        self.createHTTPQuery("POST", "/shutdown", None, showProgress=False)
+        self._shutdown = True
+
+    def getNetworkManager(self):
+        """
+        :return: instance of NetworkManager
+        """
+        return self._network_manager
+
+    def setMaxRetryConnection(self, retries):
+        """
+        Sets how many times we need to retry a connection
+        :param retries: integer
+        """
+        self._max_retry_connection = retries
+
+    def getMaxRetryConnection(self):
+        """
+        Returns how many times we need to retry a connection
+        """
+        return self._max_retry_connection
+
+    def _notify_progress_start_query(self, query_id, progress_text, response):
+        """
+        Called when a query start
+        """
+        if not sip_is_deleted(HTTPClient._progress_callback):
+            if progress_text:
+                HTTPClient._progress_callback.add_query_signal.emit(query_id, progress_text, response)
+            else:
+                HTTPClient._progress_callback.add_query_signal.emit(query_id, "Waiting for {}".format(self.url()), response)
+
+    def _notify_progress_end_query(cls, query_id):
+        """
+        Called when a query is over
+        """
+
+        if not sip_is_deleted(HTTPClient._progress_callback):
+            HTTPClient._progress_callback.remove_query_signal.emit(query_id)
+
+    def _notify_progress_upload(self, query_id, sent, total):
+        """
+        Called when a query upload progress
+        """
+        if not sip_is_deleted(HTTPClient._progress_callback):
+            HTTPClient._progress_callback.progress_signal.emit(query_id, str(abs(sent)), str(abs(total)))
+
+    def _notify_progress_download(self, query_id, sent, total):
+        """
+        Called when a query download progress
+        """
+        if not sip_is_deleted(HTTPClient._progress_callback):
+            # abs() for maximum because sometimes the system send negative
+            # values
+            HTTPClient._progress_callback.progress_signal.emit(query_id, str(abs(sent)), str(abs(total)))
+
+    @classmethod
+    def setProgressCallback(cls, progress_callback):
+        """
+        :param progress_callback: A progress callback instance
+        """
+
+        cls._progress_callback = progress_callback
+
+    def connected(self):
+        """
+        Returns if the client is connected.
+        :returns: True or False
+        """
+
+        return self._connected
+
+    def close(self):
+        """
+        Closes the connection with the server.
+        """
+        self._connected = False
+        self._progress_callback.reset()
+
+    def _request(self, url):
+        """
+        Get a QNetworkRequest object. You can mock this
+        if you want low level mocking.
+
+        :param url: Url of remote ressource (QtCore.QUrl)
+        :returns: QT Network request (QtNetwork.QNetworkRequest)
+        """
+
+        return QtNetwork.QNetworkRequest(url)
+
+    def _connect(self, query, server):
+        """
+        Initialize the connection
+
+        :param query: The query to execute when all network stack is ready
+        :param query: The Server to connect
+        """
+
+    def createHTTPQuery(self, method, path, callback, body={}, context={},
+                        downloadProgressCallback=None,
+                        showProgress=True,
+                        ignoreErrors=False,
+                        progressText=None,
+                        timeout=120,
+                        server=None,
+                        prefix="/v2",
+                        params={},
+                        networkManager=None,
+                        eventsHandler=None,
+                        **kwargs):
+        """
+        Call the remote server, if not connected, check connection before
+
+        :param method: HTTP method
+        :param path: Remote path
+        :param body: params to send (dictionary or pathlib.Path)
+        :param callback: callback method to call when the server replies
+        :param context: Pass a context to the response callback
+        :param downloadProgressCallback: Callback called when received something, it can be an incomplete response
+        :param showProgress: Display progress to the user
+        :param progressText: Text display to user in the progress dialog. None for auto generated
+        :param ignoreErrors: Ignore connection error (usefull to not closing a connection when notification feed is broken)
+        :param server: The server where the query will run
+        :param timeout: Delay in seconds before raising a timeout
+        :param prefix: Prefix to the path
+        :param networkManager: QNetworkAccessManager None use the default
+        :param eventsHandler: Handler receiving and triggering events like `updated`, `cancelled`.
+                              If not specified and showProgress is `True` then `ProgressDialog` receives them.
+        :param params: Query arguments parameters
+        :returns: QNetworkReply
+        """
+
+        if "dev" in __version__:
+            assert QtCore.QThread.currentThread() == self.thread(), "HTTP request not started from the main thread"
+
+        # Shutdown in progress do not execute the query
+        if self._shutdown:
+            return
+
+        # TODO: clean this
+        # We try to detect computer hibernation
+        # if time between two query is too long we trigger a disconnect
+        # if self._max_time_difference_between_queries:
+        #     now = datetime.datetime.now().timestamp()
+        #     if self._last_query_timestamp is not None and now > self._last_query_timestamp + self._max_time_difference_between_queries:
+        #         log.warning("Synchronisation lost with the server.")
+        #         self.disconnect()
+        #         self._last_query_timestamp = None
+        #         return
+        #     self._last_query_timestamp = now
+
+        request = qpartial(self._executeHTTPQuery, method, path, qpartial(callback), body, context,
+                           downloadProgressCallback=downloadProgressCallback,
+                           showProgress=showProgress,
+                           ignoreErrors=ignoreErrors,
+                           progressText=progressText,
+                           networkManager=networkManager,
+                           server=server,
+                           timeout=timeout,
+                           prefix=prefix,
+                           eventsHandler=eventsHandler,
+                           params=params)
+
+        if self._connected:
+            return request()
+        else:
+            self._query_waiting_connections.append((request, callback))
+            # enqueue the first query and open the connection if we are not connected
+            if len(self._query_waiting_connections) == 1:
+                log.debug("Connection to {}".format(self.url()))
+                self._executeHTTPQuery("GET", "/version", self._callbackConnect, {}, server=server, timeout=10, showProgress=False)
+
+    def _connectionError(self, callback, msg="", server=None):
+        """
+        Return an error to user if connection failed
+
+        :param callback: User callback
+        :param msg: An optional additional message for the callback
+        :param server: Server where the query is execute
+        """
+
+        if len(msg) > 0:
+            msg = "Cannot connect to server {}: {}".format(self.url(), msg)
+        else:
+            msg = "Cannot connect to {}. Please check if GNS3 is allowed in your antivirus and firewall. And that server version is {}.".format(self.url(), __version__)
+        for request, callback in self._query_waiting_connections:
+            if callback is not None:
+                callback({"message": msg}, error=True, server=server, connection_error=True)
+        self._query_waiting_connections = []
+
+    def _retryConnection(self, server=None):
+        log.debug("Retry connection to {}".format(self.url()))
+        self._retry += 1
+        QtCore.QTimer.singleShot(1000, qpartial(self._executeHTTPQuery, "GET", "/version", self._callbackConnect, {}, server=server, timeout=5))
+
+    def _callbackConnect(self, params, error=False, server=None, **kwargs):
+        """
+        Callback after /version response. Continue execution of query
+
+        :param method: HTTP method
+        :param path: Remote path
+        :param body: params to send (dictionary or pathlib.Path)
+        :param original_context: Original context
+        :param callback: callback method to call when the server replies
+        """
+
+        if error is not False:
+            if self._retry < self.getMaxRetryConnection():
+                self._retryConnection(server=server)
+                return
+            for request, callback in self._query_waiting_connections:
+                if callback is not None:
+                    self._connectionError(callback)
+            return
+
+        if "version" not in params or "local" not in params:
+            if self._retry < self.getMaxRetryConnection():
+                self._retryConnection(server=server)
+                return
+            msg = "The remote server {} is not a GNS3 server".format(self.url())
+            log.error(msg)
+            for request, callback in self._query_waiting_connections:
+                if callback is not None:
+                    callback({"message": msg}, error=True, server=server)
+            self._query_waiting_connections = []
+            return
+
+        if params["version"].split("+")[0] != __version__.split("+")[0]:
+            msg = "Client version {} is not the same as server (controller) version {}".format(__version__, params["version"])
+            # We don't allow different versions to interact even with dev build
+            # (excepting post release corrections e.g 2.2.32.1, occassionally done when fixing a packaging problem)
+            # TODO: we should probably follow this standard starting with v3.0: https://semver.org/
+            if parse_version(__version__)[:3] != parse_version(params["version"])[:3]:
+                log.error(msg)
+                for request, callback in self._query_waiting_connections:
+                    if callback is not None:
+                        callback({"message": msg}, error=True, server=server)
+                return
+            log.warning("{}\nUsing different versions may result in unexpected problems. Please upgrade or use at your own risk.".format(msg))
+
+        self._connected = True
+        self._retry = 0
+        self.connection_connected_signal.emit()
+        for request, callback in self._query_waiting_connections:
+            if request:
+                request()
+        self._query_waiting_connections = []
+
+    def _addBodyToRequest(self, body, request):
+        """
+        Add the require headers for sending the body.
+        It detect the type of body for sending the corresponding headers
+        and methods.
+
+        :param body: The body
+        :returns: The body compatible with Qt
+        """
+
+        if body is None:
+            return None
+
+        if isinstance(body, dict):
+            body = json.dumps(body)
+            request.setRawHeader(b"Content-Type", b"application/json")
+            request.setRawHeader(b"Content-Length", str(len(body)).encode())
+            data = QtCore.QByteArray(body.encode())
+            body = QtCore.QBuffer(self)
+            body.setData(data)
+            body.open(QtCore.QIODevice.ReadOnly)
+            return body
+        elif isinstance(body, pathlib.Path):
+            body = QtCore.QFile(str(body), self)
+            body.open(QtCore.QFile.ReadOnly)
+            request.setRawHeader(b"Content-Type", b"application/octet-stream")
+            # QT is smart and will compute the Content-Lenght for us
+            return body
+        elif isinstance(body, str):
+            request.setRawHeader(b"Content-Type", b"application/octet-stream")
+            data = QtCore.QByteArray(body.encode())
+            body = QtCore.QBuffer(self)
+            body.setData(data)
+            body.open(QtCore.QIODevice.ReadOnly)
+            return body
+        else:
+            return None
+
+    def _addAuth(self, request):
+        """
+        If require add basic auth header
+        """
+        if self._user:
+            auth_string = "{}:{}".format(self._user, self._password)
+            auth_string = base64.b64encode(auth_string.encode("utf-8"))
+            auth_string = "Basic {}".format(auth_string.decode())
+            request.setRawHeader(b"Authorization", auth_string.encode())
+        return request
+
+    def connectWebSocket(self, websocket, path, prefix="/v2"):
+        """
+        Path of the websocket endpoint
+        """
+        host = self._getHostForQuery()
+        request = websocket.request()
+        ws_protocol = "ws"
+        if self._protocol == "https":
+            ws_protocol = "wss"
+        ws_url = "{protocol}://{host}:{port}{prefix}{path}".format(protocol=ws_protocol,
+                                                                   host=host,
+                                                                   port=self._port,
+                                                                   path=path,
+                                                                   prefix=prefix)
+        log.debug("Connecting to WebSocket endpoint: {}".format(ws_url))
+        request.setUrl(QtCore.QUrl(ws_url))
+        self._addAuth(request)
+        websocket.open(request)
+        return websocket
+
+    def _getHostForQuery(self):
+        """
+        Get hostname that could be use by Qt
+        """
+        try:
+            ip = self._host.rsplit('%', 1)[0]
+            ipaddress.IPv6Address(ip)  # remove any scope ID
+            # this is an IPv6 address, we must surround it with brackets to be used with QUrl.
+            host = "[{}]".format(ip)
+        except ipaddress.AddressValueError:
+            host = self._host
+        return host
+
+    def _paramsToQueryString(self, params):
+        """
+        :param params: Dictionary of query string parameters
+        :returns: String of the query string
+        """
+        if params == {}:
+            query_string = ""
+        else:
+            query_string = "?"
+            params = params.copy()
+            for key, value in params.copy().items():
+                if value is None:
+                    del params[key]
+            query_string += urllib.parse.urlencode(params)
+        return query_string
+
+    def _executeHTTPQuery(self, method, path, callback, body, context={}, downloadProgressCallback=None, showProgress=True, ignoreErrors=False, progressText=None, server=None, timeout=120, prefix="/v2", params={}, networkManager=None, eventsHandler=None, **kwargs):
+        """
+        Call the remote server
+
+        :param method: HTTP method
+        :param path: Remote path
+        :param body: params to send (dictionary)
+        :param callback: callback method to call when the server replies
+        :param context: Pass a context to the response callback
+        :param downloadProgressCallback: Callback called when received something, it can be an incomplete response
+        :param showProgress: Display progress to the user
+        :param networkManager: The network manager to use. If None use default
+        :param progressText: Text display to user in progress dialog. None for auto generated
+        :param ignoreErrors: Ignore connection error (usefull to not closing a connection when notification feed is broken)
+        :param server: The server where the query is executed
+        :param timeout: Delay in seconds before raising a timeout
+        :param eventsHandler: Handler receiving and triggering events like `updated`, `cancelled`.
+                      If not specified and showProgress is `True` then `ProgressDialog` receives them.
+        :param params: Query arguments parameters
+        :returns: QNetworkReply
+        """
+
+        host = self._getHostForQuery()
+        query_string = self._paramsToQueryString(params)
+
+        log.debug("{method} {protocol}://{host}:{port}{prefix}{path} {body}{query_string}".format(method=method, protocol=self._protocol, host=host, port=self._port, path=path, body=body, prefix=prefix, query_string=query_string))
+        url = QtCore.QUrl("{protocol}://{host}:{port}{prefix}{path}{query_string}".format(protocol=self._protocol, host=host, port=self._port, path=path, prefix=prefix, query_string=query_string))
+
+        if self._user:
+            url.setUserName(self._user)
+
+        request = self._request(url)
+        request = self._addAuth(request)
+        request.setRawHeader(b"User-Agent", "GNS3 QT Client v{version}".format(version=__version__).encode())
+
+        # By default QT doesn't support GET with body even if it's in the RFC that's why we need to use sendCustomRequest
+        body = self._addBodyToRequest(body, request)
+
+        if not networkManager:
+            networkManager = self._network_manager
+
+        try:
+            response = networkManager.sendCustomRequest(request, method.encode(), body)
+        except SystemError as e:
+            log.error("Can't send query: {}".format(str(e)))
+            return
+
+        context = copy.copy(context)
+        context["query_id"] = str(uuid.uuid4())
+
+        response.finished.connect(qpartial(self._processResponse, response, server, callback, context, body, ignoreErrors))
+        response.error.connect(qpartial(self._processError, response, server, callback, context, body, ignoreErrors))
+
+        if downloadProgressCallback is not None:
+            response.readyRead.connect(qpartial(self._readyReadySlot, response, downloadProgressCallback, context, server))
+
+        request_canceled = qpartial(self._requestCanceled, response, context)
+
+        if eventsHandler is not None:
+            eventsHandler.canceled.connect(request_canceled)
+        elif not sip_is_deleted(HTTPClient._progress_callback) and HTTPClient._progress_callback.progress_dialog():
+            HTTPClient._progress_callback.progress_dialog().canceled.connect(request_canceled)
+
+        if showProgress:
+            response.uploadProgress.connect(qpartial(self._notify_progress_upload, context["query_id"]))
+            response.downloadProgress.connect(qpartial(self._notify_progress_download, context["query_id"]))
+            # Should be the last operation otherwise we have race condition in Qt
+            # where query start before finishing connect to everything
+            self._notify_progress_start_query(context["query_id"], progressText, response)
+
+        if timeout is not None:
+            QtCore.QTimer.singleShot(timeout * 1000, qpartial(self._timeoutSlot, response, timeout))
+
+        return response
+
+    def _readyReadySlot(self, response, callback, context, server, *args):
+        """
+        Process a packet receive on the notification feed.
+        The feed can contains qpartial JSON. If we found a
+        part of a JSON we keep it for the next packet
+        """
+        if response.error() != QtNetwork.QNetworkReply.NoError:
+            return
+
+        # HTTP error
+        status = response.attribute(QtNetwork.QNetworkRequest.HttpStatusCodeAttribute)
+        if status >= 300:
+            return
+
+        content = bytes(response.readAll())
+        content_type = response.header(QtNetwork.QNetworkRequest.ContentTypeHeader)
+        if content_type == "application/json":
+            content = content.decode("utf-8")
+            if context["query_id"] in self._buffer:
+                content = self._buffer[context["query_id"]] + content
+            try:
+                while True:
+                    content = content.lstrip(" \r\n\t")
+                    answer, index = json.JSONDecoder().raw_decode(content)
+                    callback(answer, server=server, context=context)
+                    content = content[index:]
+            except ValueError:  # Partial JSON
+                self._buffer[context["query_id"]] = content
+        else:
+            callback(content, server=server, context=context)
+
+    def _timeoutSlot(self, response, timeout):
+        """
+        Beware it's call for all request you need to check the status of the response
+        """
+        # We check if we received HTTP headers
+        if not sip.isdeleted(response) and response.isRunning() and not len(response.rawHeaderList()) > 0:
+            if not response.error() != QtNetwork.QNetworkReply.NoError:
+                log.warning("Timeout after {} seconds for request {}. Please check the connection is not blocked by a firewall or an anti-virus.".format(timeout, response.url().toString()))
+                response.abort()
+
+    def disconnect(self):
+        """
+        Disconnect from the remote server
+        """
+        self.connection_disconnected_signal.emit()
+        self.close()
+
+    def _requestCanceled(self, response, context):
+
+        if response.isRunning() and not response.error() != QtNetwork.QNetworkReply.NoError:
+            log.warning("Aborting request for {}".format(response.url().toString()))
+            response.abort()
+        if "query_id" in context:
+            self._notify_progress_end_query(context["query_id"])
+
+    def _processError(self, response, server, callback, context, request_body, ignore_errors, error_code):
+        if error_code != QtNetwork.QNetworkReply.NoError:
+            error_message = "{} ({}:{})".format(response.errorString(), self._host, self._port)
+
+            if not ignore_errors:
+                log.debug("Response error: %s for %s (error: %d)", error_message, response.url().toString(), error_code)
+
+            if "query_id" in context:
+                self._notify_progress_end_query(context["query_id"])
+
+            if error_code < 200 or error_code == 403:
+                if error_code == QtNetwork.QNetworkReply.OperationCanceledError:  # It's legit to cancel do not disconnect
+                    error_message = "Operation timeout"  # It's clearer than cancel because cancel is triggered by us when we timeout
+                elif error_code == QtNetwork.QNetworkReply.NetworkSessionFailedError:
+                    # ignore the network session failed error to let the network manager recover from it
+                    return
+                elif not ignore_errors:
+                    self.disconnect()
+                if callback is not None:
+                    callback({"message": error_message}, error=True, server=server, context=context)
+                return
+            else:
+                status = response.attribute(QtNetwork.QNetworkRequest.HttpStatusCodeAttribute)
+                if status == 401:
+                    log.error(error_message)
+
+            try:
+                body = bytes(response.readAll()).decode("utf-8").strip("\0")
+                # Some time antivirus intercept our query and reply with garbage content
+            except UnicodeError:
+                body = None
+            content_type = response.header(QtNetwork.QNetworkRequest.ContentTypeHeader)
+            if callback is not None:
+                if not body or content_type != "application/json":
+                    callback({"message": error_message}, error=True, server=server, context=context)
+                else:
+                    # log.debug(body)
+                    try:
+                        callback(json.loads(body), error=True, server=server, context=context)
+                    except ValueError:
+                        # It happens when an antivirus catch the communication and send is error page without changing the Content Type
+                        callback({"message": error_message}, error=True, server=server, context=context)
+            else:
+                # Because nothing is configured to handle the error we display it to the user
+                try:
+                    log.error(json.loads(body)["message"])
+                except (ValueError, KeyError):
+                    log.error(error_message)
+
+    def _processResponse(self, response, server, callback, context, request_body, ignore_errors):
+        if request_body is not None:
+            request_body.close()
+
+        if "query_id" in context:
+            self._notify_progress_end_query(context["query_id"])
+
+        if response.error() == QtNetwork.QNetworkReply.NoError:
+            status = response.attribute(QtNetwork.QNetworkRequest.HttpStatusCodeAttribute)
+            log.debug("Decoding response from {} response {}".format(response.url().toString(), status))
+            try:
+                raw_body = bytes(response.readAll())
+                body = raw_body.decode("utf-8").strip("\0")
+            # Some time anti-virus intercept our query and reply with garbage content
+            except UnicodeDecodeError:
+                body = None
+            content_type = response.header(QtNetwork.QNetworkRequest.ContentTypeHeader)
+            if body and len(body.strip(" \n\t")) > 0 and content_type == "application/json":
+                try:
+                    params = json.loads(body)
+                except ValueError:  # Partial JSON
+                    params = {}
+                    status = 504
+            else:
+                params = {}
+            if callback is not None:
+                if status >= 400:
+                    callback(params, error=True, server=server, context=context)
+                else:
+                    callback(params, server=server, context=context, raw_body=raw_body)
+            if status == 400:
+                try:
+                    params = json.loads(body)
+                    e = HttpBadRequest(body)
+                    e.fingerprint = params["path"]
+                # If something goes wrong for a any reason just raise the bad request
+                except Exception:
+                    e = HttpBadRequest(body)
+                raise e
+
+    def getSynchronous(self, method, endpoint, prefix="/v2", timeout=5):
+        """
+        Synchronous check if a server is running
+
+        :returns: Tuple (Status code, json of answer). Status 0 is a non HTTP error
+        """
+
+        host = self._getHostForQuery()
+
+        log.debug("{method} {protocol}://{host}:{port}{prefix}{endpoint}".format(method=method, protocol=self._protocol, host=host, port=self._port, prefix=prefix, endpoint=endpoint))
+        url = QtCore.QUrl("{protocol}://{host}:{port}{prefix}{endpoint}".format(protocol=self._protocol, host=host, port=self._port, prefix=prefix, endpoint=endpoint))
+
+        if self._user:
+            url.setUserName(self._user)
+
+        request = self._request(url)
+        request = self._addAuth(request)
+        request.setRawHeader(b"User-Agent", "GNS3 QT Client v{version}".format(version=__version__).encode())
+
+        try:
+            response = self._network_manager.sendCustomRequest(request, method.encode())
+        except SystemError as e:
+            log.error("Can't send query: {}".format(str(e)))
+            return
+
+        loop = QtCore.QEventLoop()
+        response.finished.connect(loop.quit)
+
+        if timeout is not None:
+            QtCore.QTimer.singleShot(timeout * 1000, qpartial(self._timeoutSlot, response, timeout))
+
+        if not loop.isRunning():
+            loop.exec_()
+
+        status = response.attribute(QtNetwork.QNetworkRequest.HttpStatusCodeAttribute)
+        if response.error() != QtNetwork.QNetworkReply.NoError:
+            log.debug("Error while connecting to local server {}".format(response.errorString()))
+        else:
+            content_type = response.header(QtNetwork.QNetworkRequest.ContentTypeHeader)
+            if status == 200 and content_type == "application/json":
+                content = bytes(response.readAll())
+                try:
+                    json_data = json.loads(content.decode("utf-8"))
+                except (UnicodeEncodeError, ValueError) as e:
+                    log.warning("Could not read JSON data returned from {}: {}".format(url, e))
+                else:
+                    return status, json_data
+        return status, None
+
+    def _sslErrorsSlot(self, response, ssl_errors):
+
+        self.handleSslError(response, ssl_errors)
+
+    def handleSslError(self, response, ssl_errors):
+
+        if self._accept_insecure_certificate:
+            response.ignoreSslErrors()
+            return
+
+        url = response.request().url()
+        host_port_key = f"{url.host()}:{url.port()}"
+
+        # get the certificate digest
+        ssl_config = response.sslConfiguration()
+        peer_cert = ssl_config.peerCertificate()
+        digest = peer_cert.digest()
+
+        if host_port_key in self._ssl_exceptions:
+
+            if self._ssl_exceptions[host_port_key] == digest:
+                response.ignoreSslErrors()
+                return
+
+        from gns3.main_window import MainWindow
+        main_window = MainWindow.instance()
+
+        msgbox = QtWidgets.QMessageBox(main_window)
+        msgbox.setWindowTitle("SSL error detected")
+        msgbox.setText(f"This server could not prove that it is {url.host()}:{url.port()}. Please carefully examine the certificate to make sure the server can be trusted.")
+        msgbox.setInformativeText(f"{ssl_errors[0].errorString()}")
+        msgbox.setDetailedText(peer_cert.toText())
+        msgbox.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+        connect_button = QtWidgets.QPushButton(f"&Connect to {url.host()}:{url.port()}", msgbox)
+        msgbox.addButton(connect_button, QtWidgets.QMessageBox.YesRole)
+        abort_button = QtWidgets.QPushButton("&Abort", msgbox)
+        msgbox.addButton(abort_button, QtWidgets.QMessageBox.RejectRole)
+        msgbox.setDefaultButton(abort_button)
+        msgbox.setIcon(QtWidgets.QMessageBox.Critical)
+        msgbox.exec_()
+
+        if msgbox.clickedButton() == connect_button:
+            self._ssl_exceptions[host_port_key] = digest
+            response.ignoreSslErrors()
+        else:
+            for error in ssl_errors:
+                log.error(f"SSL error detected: {error.errorString()}")
+            main_window.close()
+
+    @classmethod
+    def fromUrl(cls, url, network_manager=None, base_settings=None):
+        """
+        Returns HttpClient instance based on the url
+        :param url: Url to parse
+        :param network_manager: Optional network_manager
+        :param base_settings: Source of the settings, if necessary
+        :return: HttpClient
+        """
+        settings = {}
+        if base_settings is not None:
+            settings.update(**base_settings)
+        parse_results = urllib.parse.urlparse(url)
+        settings['protocol'] = parse_results.scheme
+        settings['host'] = parse_results.hostname
+        settings['port'] = parse_results.port
+        settings['user'] = parse_results.username
+        settings['password'] = parse_results.password
+        return cls(settings, network_manager)

gns3/image_manager.py

@@ -0,0 +1,191 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 copy
+import pathlib
+
+from gns3.qt import QtWidgets
+from gns3.local_server_config import LocalServerConfig
+from gns3.settings import LOCAL_SERVER_SETTINGS
+from gns3.controller import Controller
+from gns3.utils.file_copy_worker import FileCopyWorker
+from gns3.utils.progress_dialog import ProgressDialog
+from gns3.registry.image import Image
+
+
+class ImageManager:
+
+    def __init__(self):
+        # Remember if we already ask the user about this image for this server
+        self._asked_for_this_image = {}
+
+    def _getUniqueDestinationPath(self, source_image, node_type, path):
+        """
+        Get a unique destination path (with counter).
+        """
+
+        if not os.path.exists(path):
+            return path
+        path, extension = os.path.splitext(path)
+        counter = 1
+        new_path = "{}-{}{}".format(path, counter, extension)
+        while os.path.exists(new_path):
+            destination_image = Image(node_type, new_path, filename=os.path.basename(new_path))
+            try:
+                if source_image.md5sum == destination_image.md5sum:
+                    # the source and destination images are identical
+                    return new_path
+            except OSError:
+                continue
+            counter += 1
+            new_path = "{}-{}{}".format(path, counter, extension)
+        return new_path
+
+    def askCopyUploadImage(self, parent, source_path, server, node_type):
+        """
+        Ask user for copying the image to the default directory or upload
+        it to remote server.
+
+        :param parent: Parent window
+        :param path: File path on computer
+        :param server: The server where the images should be located
+        :param node_type: Remote upload endpoint
+        :returns path: Final path
+        """
+
+        if (server and server != "local") or Controller.instance().isRemote():
+            return self._uploadImageToRemoteServer(source_path, server, node_type)
+        else:
+            destination_directory = self.getDirectoryForType(node_type)
+            destination_path = os.path.join(destination_directory, os.path.basename(source_path))
+            source_filename = os.path.basename(source_path)
+            destination_filename = os.path.basename(destination_path)
+            if os.path.normpath(os.path.dirname(source_path)) != destination_directory:
+                # the image is not in the default images directory
+                if source_filename == destination_filename:
+                    # the filename already exists in the default images directory
+                    source_image = Image(node_type, source_path, filename=source_filename)
+                    destination_image = Image(node_type, destination_path, filename=destination_filename)
+                    try:
+                        if source_image.md5sum == destination_image.md5sum:
+                            # the source and destination images are identical
+                            return source_path
+                    except OSError as e:
+                        QtWidgets.QMessageBox.critical(parent, 'Image', 'Cannot compare image file {} with {}: {}.'.format(source_path, destination_path, str(e)))
+                        return source_path
+                    # find a new unique path to avoid overwriting existing destination file
+                    destination_path = self._getUniqueDestinationPath(source_image, node_type, destination_path)
+
+                reply = QtWidgets.QMessageBox.question(parent,
+                                                       'Image',
+                                                       'Would you like to copy {} to the default images directory'.format(source_filename),
+                                                       QtWidgets.QMessageBox.Yes,
+                                                       QtWidgets.QMessageBox.No)
+                if reply == QtWidgets.QMessageBox.Yes:
+                    try:
+                        os.makedirs(destination_directory, exist_ok=True)
+                    except OSError as e:
+                        QtWidgets.QMessageBox.critical(parent, 'Image', 'Could not create destination directory {}: {}'.format(destination_directory, str(e)))
+                        return source_path
+
+                    worker = FileCopyWorker(source_path, destination_path)
+                    progress_dialog = ProgressDialog(worker, 'Image', 'Copying {}'.format(source_filename), 'Cancel', busy=True, parent=parent)
+                    progress_dialog.show()
+                    progress_dialog.exec_()
+                    errors = progress_dialog.errors()
+                    if errors:
+                        QtWidgets.QMessageBox.critical(parent, 'Image', '{}'.format(''.join(errors)))
+                        return source_path
+                    else:
+                        source_path = destination_path
+            return source_path
+
+    def _uploadImageToRemoteServer(self, path, server, node_type):
+        """
+        Upload image to remote server
+
+        :param path: File path on computer
+        :param server: The server where the images should be located
+        :param node_type: Image node_type
+        :returns path: Final path
+        """
+
+        if node_type == 'QEMU':
+            upload_endpoint = '/qemu/images'
+        elif node_type == 'IOU':
+            upload_endpoint = '/iou/images'
+        elif node_type == 'DYNAMIPS':
+            upload_endpoint = '/dynamips/images'
+        else:
+            raise Exception('Invalid node type')
+
+        filename = self._getRelativeImagePath(path, node_type).replace("\\", "/")
+        Controller.instance().postCompute('{}/{}'.format(upload_endpoint, filename), server, None, body=pathlib.Path(path), progressText="Uploading {}".format(filename), timeout=None)
+        return filename
+
+    def _getRelativeImagePath(self, path, node_type):
+        """
+        Get a path relative to images directory path
+        or just filename if the path is not located inside
+        image directory
+
+        :param path: file path
+        :param node_type: Type of vm
+        :return: file path
+        """
+
+        if not path:
+            return ""
+        img_directory = self.getDirectoryForType(node_type)
+        path = os.path.abspath(path)
+        if os.path.commonprefix([img_directory, path]) == img_directory:
+            return os.path.relpath(path, img_directory)
+        return os.path.basename(path)
+
+    def getDirectory(self):
+        """
+        Returns the images directory path.
+
+        :returns: path to the default images directory
+        """
+
+        return copy.copy(LocalServerConfig.instance().loadSettings("Server", LOCAL_SERVER_SETTINGS)['images_path'])
+
+    def getDirectoryForType(self, node_type):
+        """
+        Return the path of local directory of the images
+        of a specific node_type
+
+        :param node_type: Type of vm
+        """
+        if node_type == 'DYNAMIPS':
+            return os.path.join(self.getDirectory(), 'IOS')
+        else:
+            return os.path.join(self.getDirectory(), node_type.upper())
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of ImageManager.
+
+        :returns: instance of ImageManager
+        """
+
+        if not hasattr(ImageManager, '_instance') or ImageManager._instance is None:
+            ImageManager._instance = ImageManager()
+        return ImageManager._instance

gns3/image_upload_manager.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017 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 pathlib
+import urllib.parse
+
+from gns3.http_client import HTTPClient
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ImageUploadManager(object):
+    """
+    Manager over the image upload. Encapsulates file uploads to computes or via controller.
+    """
+
+    def __init__(self, image, controller, compute_id, callback=None, directFileUpload=False):
+        self._image = image
+        self._compute_id = compute_id
+        self._callback = callback
+        self._directFileUpload = directFileUpload
+        self._controller = controller
+
+    def upload(self):
+        if not os.path.exists(self._image.path):
+            log.error("Image '{}' could not be found".format(self._image.path))
+            return
+        if self._directFileUpload:
+            # first obtain endpoint and know when target request
+            self._controller.getEndpoint(self._getComputePath(), self._compute_id, self._onLoadEndpointCallback, showProgress=False)
+        else:
+            self._fileUploadToController()
+
+    def _getComputePath(self):
+        return '/{emulator}/images/{filename}'.format(emulator=self._image.emulator, filename=self._image.filename)
+
+    def _onLoadEndpointCallback(self, result, error=False, **kwargs):
+        if error:
+            if "message" in result:
+                log.error("Error while getting endpoint: {}".format(result["message"]))
+            return
+
+        # we know where is the endpoint and we trying to post there a file
+        endpoint = result['endpoint']
+        self._fileUploadToCompute(endpoint)
+
+    def _checkIfSuccessfulCallback(self, result, error=False, **kwargs):
+        if error:
+            connection_error = kwargs.get('connection_error', False)
+            if connection_error:
+                log.debug("During direct file upload compute is not visible. Fallback to upload via controller.")
+                # there was an issue with connection, probably we don't have a direct access to compute
+                # we need to fallback to uploading files via controller
+                self._fileUploadToController()
+            else:
+                if "message" in result:
+                    log.error("Error while direct file upload: {}".format(result["message"]))
+            return
+        self._callback(result, error, **kwargs)
+
+    def _fileUploadToCompute(self, endpoint):
+        log.debug("Uploading image '{}' to compute".format(self._image.path))
+        parse_results = urllib.parse.urlparse(endpoint)
+        network_manager = self._controller.getHttpClient().getNetworkManager()
+        client = HTTPClient.fromUrl(endpoint, network_manager=network_manager)
+        # We don't retry connection as in case of fail we try direct file upload
+        client.setMaxRetryConnection(0)
+        client.createHTTPQuery('POST', parse_results.path, self._checkIfSuccessfulCallback, body=pathlib.Path(self._image.path),
+                               context={"image_path": self._image.path}, progressText="Uploading {}".format(self._image.filename), timeout=None, prefix="")
+
+    def _fileUploadToController(self):
+        log.debug("Uploading image '{}' to controller".format(self._image.path))
+        self._controller.postCompute(self._getComputePath(), self._compute_id, self._callback, body=pathlib.Path(self._image.path),
+                                     context={"image_path": self._image.path}, progressText="Uploading {}".format(self._image.filename), timeout=None)

gns3/items/drawing_item.py

@@ -0,0 +1,311 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+from ..qt import QtCore, QtWidgets, qslot, QtGui
+from .utils import colorFromSvg
+
+import uuid
+import logging
+import binascii
+log = logging.getLogger(__name__)
+
+
+class DrawingItem:
+    # Map QT stroke to SVG style
+    QT_DASH_TO_SVG = {
+        QtCore.Qt.SolidLine: "",
+        QtCore.Qt.NoPen: None,
+        QtCore.Qt.DashLine: "25, 25",
+        QtCore.Qt.DotLine: "5, 25",
+        QtCore.Qt.DashDotLine: "5, 25, 25",
+        QtCore.Qt.DashDotDotLine: "25, 25, 5, 25, 5"
+    }
+
+    show_layer = False
+
+    """
+    Base class for non emulation item
+    """
+
+    def __init__(self, project=None, pos=None, drawing_id=None, svg=None, z=0, locked=False, rotation=0, **kws):
+        self._id = drawing_id
+        self._deleting = False
+        self._allow_snap_to_grid = True
+        self._locked = locked
+        if self._id is None:
+            self._id = str(uuid.uuid4())
+        self.setFlags(QtWidgets.QGraphicsItem.ItemIsMovable | QtWidgets.QGraphicsItem.ItemIsFocusable | QtWidgets.QGraphicsItem.ItemIsSelectable | QtWidgets.QGraphicsItem.ItemSendsGeometryChanges)
+
+        from ..main_window import MainWindow
+        self._graphics_view = MainWindow.instance().uiGraphicsView
+        self._main_window = MainWindow.instance()
+
+        self._project = project
+
+        # Store a hash of the SVG to avoid him
+        # to be send if he doesn't change
+        self._hash_svg = None
+
+        if pos:
+            self.setPos(pos)
+        if z:
+            self.setZValue(z)
+        if rotation:
+            self.setRotation(rotation)
+
+        self.setLocked(locked)
+
+    def drawing_id(self):
+        return self._id
+
+    def create(self):
+        if self._project:
+            self._project.post("/drawings", self._createDrawingCallback, body=self.__json__())
+
+    def _createDrawingCallback(self, result, error=False, **kwargs):
+        """
+        Callback for create.
+
+        :param result: server response
+        :param error: indicates an error (boolean)
+        :returns: Boolean success or not
+        """
+
+        if error:
+            log.error("Error while creating drawing: {}".format(result["message"]))
+            return False
+        self._id = result["drawing_id"]
+        self.updateDrawingCallback(result)
+
+    def updateDrawing(self):
+        if self._id and not self.deleting() and self._project:
+            self._project.put("/drawings/" + self._id, self.updateDrawingCallback, body=self.__json__(), showProgress=False)
+
+    @qslot
+    def updateDrawingCallback(self, result, error=False, **kwargs):
+        """
+        Callback for update.
+
+        :param result: server response
+        :param error: indicates an error (boolean)
+        :returns: Boolean success or not
+        """
+
+        if error:
+            log.error("Error while updating drawing: {}".format(result["message"]))
+            return False
+        self.setPos(QtCore.QPoint(result["x"], result["y"]))
+        self.setZValue(result["z"])
+        self.setLocked(result["locked"])
+        self.setRotation(result["rotation"])
+        if "svg" in result:
+            self.fromSvg(result["svg"])
+
+    def handleKeyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        :return: Boolean True the event has been captured
+        """
+        key = event.key()
+        modifiers = event.modifiers()
+        if key in (QtCore.Qt.Key_P, QtCore.Qt.Key_Plus, QtCore.Qt.Key_Equal) and modifiers & QtCore.Qt.AltModifier \
+                or key == QtCore.Qt.Key_Plus and modifiers & QtCore.Qt.AltModifier and modifiers & QtCore.Qt.KeypadModifier:
+            if self.rotation() == 0:
+                self.setRotation(359)
+            else:
+                self.setRotation(self.rotation() - 1)
+            return True
+        elif key in (QtCore.Qt.Key_M, QtCore.Qt.Key_Minus) and modifiers & QtCore.Qt.AltModifier \
+                or key == QtCore.Qt.Key_Minus and modifiers & QtCore.Qt.AltModifier and modifiers & QtCore.Qt.KeypadModifier:
+            if self.rotation() < 360.0:
+                self.setRotation(self.rotation() + 1)
+                return True
+        elif modifiers & QtCore.Qt.AltModifier:
+            self._allow_snap_to_grid = False
+            return True
+        return False
+
+    def keyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        """
+
+        if not self.handleKeyPressEvent(event):
+            QtWidgets.QGraphicsItem.keyPressEvent(self, event)
+
+    def keyReleaseEvent(self, event):
+        """
+        Handles all key release events
+
+        :param event: QKeyEvent
+        """
+
+        self._allow_snap_to_grid = True
+
+    def __json__(self):
+        data = {
+            "drawing_id": self._id,
+            "x": int(self.pos().x()),
+            "y": int(self.pos().y()),
+            "z": int(self.zValue()),
+            "locked": self._locked,
+            "rotation": int(self.rotation())
+        }
+        svg = self.toSvg()
+        hash_svg = binascii.crc32(svg.encode())
+        if hash_svg != self._hash_svg:
+            data["svg"] = svg
+            self._hash_svg = hash_svg
+        return data
+
+    def locked(self):
+        """
+        Is the drawing locked
+        """
+
+        return self._locked
+
+    def setLocked(self, locked):
+        """
+        Sets the locked value.
+
+        :param value: Z value
+        """
+
+        if locked is True:
+            self.setFlag(self.ItemIsMovable, False)
+        else:
+            self.setFlag(self.ItemIsMovable, True)
+        self._locked = locked
+
+    def deleting(self):
+        """
+        Is the drawing being deleted
+        """
+
+        return self._deleting
+
+    def setDeleting(self):
+        """
+        Mark this drawing as being deleted
+        """
+
+        self._deleting = True
+
+    def delete(self, skip_controller=False):
+        """
+        Deletes this drawing.
+
+        :param skip_controller: Do not replicate change on the controller (usefull when it's already deleted on controller)
+        """
+
+        self.setDeleting()
+        self.scene().removeItem(self)
+        from ..topology import Topology
+        Topology.instance().removeDrawing(self)
+        if self._id and not skip_controller:
+            self._project.delete("/drawings/" + self._id, None, body=self.__json__())
+
+    def itemChange(self, change, value):
+
+        if change == QtWidgets.QGraphicsItem.ItemPositionChange and self._main_window.uiSnapToGridAction.isChecked() \
+                and self._allow_snap_to_grid:
+            grid_size = self._graphics_view.drawingGridSize()
+            mid_x = self.boundingRect().width() / 2
+            value.setX((grid_size * round((value.x() + mid_x) / grid_size)) - mid_x)
+            mid_y = self.boundingRect().height() / 2
+            value.setY((grid_size * round((value.y()+mid_y)/grid_size)) - mid_y)
+
+        if change == QtWidgets.QGraphicsItem.ItemSelectedChange:
+            if not value:
+                self.updateDrawing()
+        return QtWidgets.QGraphicsItem.itemChange(self, change, value)
+
+    def updateNode(self):
+        self.updateDrawing()
+
+    def drawLayerInfo(self, painter):
+        """
+        Draws the layer position.
+
+        :param painter: QPainter instance
+        """
+
+        if self.show_layer is False:
+            return
+
+        brect = self.boundingRect()
+        # don't draw anything if the object is too small
+        if brect.width() < 20 or brect.height() < 20:
+            return
+
+        center = self.mapFromItem(self, brect.width() / 2.0, brect.height() / 2.0)
+        painter.setBrush(QtCore.Qt.red)
+        painter.setPen(QtCore.Qt.red)
+        painter.drawRect(QtCore.QRectF((brect.width() / 2.0) - 10, (brect.height() / 2.0) - 10, 20, 20))
+        painter.setPen(QtCore.Qt.black)
+        zval = str(int(self.zValue()))
+        painter.drawText(QtCore.QPointF(center.x() - 4, center.y() + 4), zval)
+
+    def _styleSvg(self, element):
+        """
+        Add style from the shape item to the SVG element that we will
+        export
+        """
+        style = ""
+        pen = self.pen()
+        if hasattr(self, "brush"):  # Line don't have a brush
+            element.set("fill", "#{}".format(hex(self.brush().color().rgba())[4:]))
+            element.set("fill-opacity", str(self.brush().color().alphaF()))
+
+        dasharray = self.QT_DASH_TO_SVG[pen.style()]
+        if dasharray is None:  # No border to the element
+            return element
+        elif dasharray == "":
+            pass  # Solid line
+        else:
+            element.set("stroke-dasharray", dasharray)
+        element.set("stroke-width", str(pen.width()))
+        element.set("stroke", "#" + hex(pen.color().rgba())[4:])
+        return element
+
+    def _penFromSVGElement(self, svg):
+        """
+        Get a pen from a SVG element
+
+        :param svg:
+        """
+        pen = QtGui.QPen()
+        if svg.get("stroke-width"):
+            pen.setWidth(int(svg.get("stroke-width")))
+        if svg.get("stroke"):
+            pen.setColor(colorFromSvg(svg.get("stroke")))
+        # Map SVG stroke style (border of the element to the Qt version)
+        if not svg.get("stroke"):
+            pen.setStyle(QtCore.Qt.NoPen)
+        else:
+            pen.setStyle(QtCore.Qt.SolidLine)
+            stroke = svg.get("stroke-dasharray")
+            if stroke:
+                for (qt_stroke, svg_stroke) in self.QT_DASH_TO_SVG.items():
+                    if svg_stroke == stroke:
+                        pen.setStyle(qt_stroke)
+        return pen

gns3/items/ellipse_item.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Graphical representation of an ellipse on the QGraphicsScene.
+"""
+
+import math
+import xml.etree.ElementTree as ET
+
+from ..qt import QtWidgets
+from .shape_item import ShapeItem
+
+
+class EllipseItem(QtWidgets.QGraphicsEllipseItem, ShapeItem):
+
+    """
+    Class to draw an ellipse on the scene.
+    """
+
+    def __init__(self, width=200, height=200, **kws):
+        super().__init__(width=width, height=height, **kws)
+
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        super().paint(painter, option, widget)
+        self.drawLayerInfo(painter)
+
+    def toSvg(self):
+        """
+        Return an SVG version of the shape
+        """
+        svg = ET.Element("svg")
+        svg.set("width", str(self.rect().width()))
+        svg.set("height", str(self.rect().height()))
+
+        ellipse = ET.SubElement(svg, "ellipse")
+        ellipse.set("cx", str(math.floor(self.rect().width() / 2)))
+        ellipse.set("rx", str(math.ceil(self.rect().width() / 2)))
+        ellipse.set("cy", str(math.floor(self.rect().height() / 2)))
+        ellipse.set("ry", str(math.ceil(self.rect().height() / 2)))
+
+        ellipse = self._styleSvg(ellipse)
+
+        return ET.tostring(svg, encoding="utf-8").decode("utf-8")
+

gns3/items/ethernet_link_item.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 #
+# Copyright (C) 2019 Pekka Helenius
 # Copyright (C) 2014 GNS3 Technologies Inc.
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,12 +20,14 @@
 Graphical representation of an Ethernet link for QGraphicsScene.
 """
 
-from ..qt import QtCore, QtGui
+from ..qt import QtCore, QtGui, QtWidgets
 from .link_item import LinkItem
+from .label_item import LabelItem
 from ..ports.port import Port
 
 
 class EthernetLinkItem(LinkItem):
+
     """
     Ethernet link for the scene.
 
@@ -34,13 +37,11 @@ class EthernetLinkItem(LinkItem):
     :param destination_port: destination Port instance
     :param link: Link instance (contains back-end stuff for this link)
     :param adding_flag: indicates if this link is being added (no destination yet)
-    :param multilink: used to draw multiple link between the same source and destination
     """
 
-    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False, multilink=0):
+    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False):
 
-        LinkItem.__init__(self, source_item, source_port, destination_item, destination_port, link, adding_flag, multilink)
-        self.setPen(QtGui.QPen(QtCore.Qt.black, self._pen_width, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+        super().__init__(source_item, source_port, destination_item, destination_port, link, adding_flag)
         self._source_collision_offset = 0.0
         self._destination_collision_offset = 0.0
 
@@ -51,10 +52,21 @@ class EthernetLinkItem(LinkItem):
 
         LinkItem.adjust(self)
 
+        try:
+            if self._hovered:
+                self.setPen(QtGui.QPen(QtCore.Qt.red, self._link._link_style["width"] + 1, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+            else:
+                self.setPen(QtGui.QPen(QtGui.QColor(self._link._link_style["color"]), self._link._link_style["width"], self._link._link_style["type"], QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+        except:
+            if self._hovered:
+                self.setPen(QtGui.QPen(QtCore.Qt.red, self._pen_width + 1, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+            else:
+                self.setPen(QtGui.QPen(QtGui.QColor("#000000"), self._pen_width, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+
         # draw a line between nodes
-        self.path = QtGui.QPainterPath(self.source)
-        self.path.lineTo(self.destination)
-        self.setPath(self.path)
+        path = QtGui.QPainterPath(self.source)
+        path.lineTo(self.destination)
+        self.setPath(path)
 
         # offset on the line for status points
         if self.length == 0:
@@ -69,7 +81,7 @@ class EthernetLinkItem(LinkItem):
         :returns: QPainterPath instance
         """
 
-        path = QtGui.QGraphicsPathItem.shape(self)
+        path = QtWidgets.QGraphicsPathItem.shape(self)
         offset = self._point_size / 2
         if not self._adding_flag:
             if self.length:
@@ -100,24 +112,26 @@ class EthernetLinkItem(LinkItem):
         :param widget: QWidget instance.
         """
 
-        QtGui.QGraphicsPathItem.paint(self, painter, option, widget)
-
-        if not self._adding_flag and self._settings["draw_link_status_points"]:
+        QtWidgets.QGraphicsPathItem.paint(self, painter, option, widget)
+        if not self._adding_flag:
 
             # points disappears if nodes are too close to each others.
             if self.length < 100:
                 return
 
-            if self._source_port.status() == Port.started:
+            if self._link.suspended() or self._source_port.status() == Port.suspended:
+                # link or port is suspended
+                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
+            elif self._source_port.status() == Port.started:
                 # port is active
                 color = QtCore.Qt.green
-            elif self._source_port.status() == Port.suspended:
-                # port is suspended
-                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
             else:
                 color = QtCore.Qt.red
+                shape = QtCore.Qt.SquareCap
 
-            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.MiterJoin))
+            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, shape, QtCore.Qt.MiterJoin))
             point1 = QtCore.QPointF(self.source + self.edge_offset) + QtCore.QPointF((self.dx * self._source_collision_offset) / self.length, (self.dy * self._source_collision_offset) / self.length)
 
             # avoid any collision of the status point with the source node
@@ -131,49 +145,36 @@ class EthernetLinkItem(LinkItem):
                 if not self._source_item.contains(self.mapFromScene(self.mapToItem(self._source_item, check_point))) and self._source_collision_offset > 0:
                     self._source_collision_offset -= 10
 
-#TODO: draw port labels
-#             if self._show_port_names:
-#                 if self.labelSouceIf == None:
-#  
-#                     if globals.interfaceLabels.has_key(self.source.hostname + ' ' + self.srcIf):
-#                         self.labelSouceIf = Annotation(self.source)
-#                         annotation = globals.interfaceLabels[self.source.hostname + ' ' + self.srcIf]
-#                         self.labelSouceIf.setZValue(annotation.zValue())
-#                         self.labelSouceIf.setDefaultTextColor(annotation.defaultTextColor())
-#                         self.labelSouceIf.setFont(annotation.font())
-#                         self.labelSouceIf.setPlainText(annotation.toPlainText())
-#                         self.labelSouceIf.setPos(annotation.x(), annotation.y())
-#                         self.labelSouceIf.rotation = annotation.rotation
-#                         self.labelSouceIf.rotate(annotation.rotation)
-#                         del globals.interfaceLabels[self.source.hostname + ' ' + self.srcIf]
-#                     elif not globals.GApp.workspace.flg_showOnlySavedInterfaceNames:
-#                         self.labelSouceIf = Annotation(self.source)
-#                         self.labelSouceIf.setPlainText(self.srcIf)
-#                         self.labelSouceIf.setPos(self.mapToItem(self.source, point1))
-#                         #self.labelSouceIf.autoGenerated = True
-#  
-#                     if self.labelSouceIf:
-#                         self.labelSouceIf.deviceName = self.source.hostname
-#                         self.labelSouceIf.deviceIf = self.srcIf
-#  
-#                 if self.labelSouceIf and not self.labelSouceIf.isVisible():
-#                     self.labelSouceIf.show()
-#  
-#             elif self.labelSouceIf and globals.GApp.workspace.flg_showInterfaceNames == False:
-#                 self.labelSouceIf.hide()
+            source_port_label = self._source_port.label()
 
-            painter.drawPoint(point1)
+            if source_port_label is None:
+                source_port_label = LabelItem(self._source_item)
+                source_port_label.setPlainText(self._source_port.shortName())
+                source_port_label.setPos(self.mapToItem(self._source_item, point1))
+                self._source_port.setLabel(source_port_label)
 
-            if self._destination_port.status() == Port.started:
+            if self._draw_port_labels:
+                source_port_label.setFlag(source_port_label.ItemIsMovable, not self._source_item.locked())
+                source_port_label.show()
+            else:
+                source_port_label.hide()
+
+            if self._settings["draw_link_status_points"] and self.pen().style() != QtCore.Qt.NoPen:
+                painter.drawPoint(point1)
+
+            if self._link.suspended() or self._destination_port.status() == Port.suspended:
+                # link or port is suspended
+                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
+            elif self._destination_port.status() == Port.started:
                 # port is active
                 color = QtCore.Qt.green
-            elif self._destination_port.status() == Port.suspended:
-                # port is suspended
-                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
             else:
                 color = QtCore.Qt.red
+                shape = QtCore.Qt.SquareCap
 
-            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.MiterJoin))
+            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, shape, QtCore.Qt.MiterJoin))
             point2 = QtCore.QPointF(self.destination - self.edge_offset) - QtCore.QPointF((self.dx * self._destination_collision_offset) / self.length, (self.dy * self._destination_collision_offset) / self.length)
 
             # avoid any collision of the status point with the destination node
@@ -187,35 +188,21 @@ class EthernetLinkItem(LinkItem):
                 if not self._destination_item.contains(self.mapFromScene(self.mapToItem(self._destination_item, check_point))) and self._destination_collision_offset > 0:
                     self._destination_collision_offset -= 10
 
-#TODO: draw port labels
-#             if globals.GApp.workspace.flg_showInterfaceNames:
-#                 if self.labelDestIf == None:
-# 
-#                     if globals.interfaceLabels.has_key(self.dest.hostname + ' ' + self.destIf):
-#                         self.labelDestIf = Annotation(self.dest)
-#                         annotation = globals.interfaceLabels[self.dest.hostname + ' ' + self.destIf]
-#                         self.labelDestIf.setZValue(annotation.zValue())
-#                         self.labelDestIf.setDefaultTextColor(annotation.defaultTextColor())
-#                         self.labelDestIf.setFont(annotation.font())
-#                         self.labelDestIf.setPlainText(annotation.toPlainText())
-#                         self.labelDestIf.setPos(annotation.x(), annotation.y())
-#                         self.labelDestIf.rotation = annotation.rotation
-#                         self.labelDestIf.rotate(annotation.rotation)
-#                         del globals.interfaceLabels[self.dest.hostname + ' ' + self.destIf]
-#                     elif not globals.GApp.workspace.flg_showOnlySavedInterfaceNames:
-#                         self.labelDestIf = Annotation(self.dest)
-#                         self.labelDestIf.setPlainText(self.destIf)
-#                         self.labelDestIf.setPos(self.mapToItem(self.dest, point2))
-#                         #self.labelDestIf.autoGenerated = True
-# 
-#                     if self.labelDestIf:
-#                         self.labelDestIf.deviceName = self.dest.hostname
-#                         self.labelDestIf.deviceIf = self.destIf
-# 
-#                 if self.labelDestIf and not self.labelDestIf.isVisible():
-#                     self.labelDestIf.show()
-# 
-#             elif self.labelDestIf and globals.GApp.workspace.flg_showInterfaceNames == False:
-#                 self.labelDestIf.hide()
+            destination_port_label = self._destination_port.label()
 
-            painter.drawPoint(point2)
+            if destination_port_label is None:
+                destination_port_label = LabelItem(self._destination_item)
+                destination_port_label.setPlainText(self._destination_port.shortName())
+                destination_port_label.setPos(self.mapToItem(self._destination_item, point2))
+                self._destination_port.setLabel(destination_port_label)
+
+            if self._draw_port_labels:
+                destination_port_label.setFlag(destination_port_label.ItemIsMovable, not self._destination_item.locked())
+                destination_port_label.show()
+            else:
+                destination_port_label.hide()
+
+            if self._settings["draw_link_status_points"] and self.pen().style() != QtCore.Qt.NoPen:
+                painter.drawPoint(point2)
+
+        self._drawSymbol()

gns3/items/image_item.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Graphical representation of an image on the QGraphicsScene.
+"""
+
+from ..qt import QtSvg
+from ..qt.qimage_svg_renderer import QImageSvgRenderer
+from .drawing_item import DrawingItem
+
+
+class ImageItem(QtSvg.QGraphicsSvgItem, DrawingItem):
+
+    """
+    Class to insert an image on the scene.
+    """
+
+    def __init__(self, image_path=None, pos=None, svg=None, **kws):
+
+        self._image_path = image_path
+        # Because we call the Qt C++ code we need to handle the case of pos is None otherwise we will get a conversion error
+        if pos:
+            super().__init__(pos=pos, **kws)
+        else:
+            super().__init__(**kws)
+
+        if self._image_path:
+            renderer = QImageSvgRenderer(image_path)
+            self.setSharedRenderer(renderer)
+
+        # By default center the image
+        if pos is None:
+            x = self.pos().x() - (self.boundingRect().width() / 2)
+            y = self.pos().y() - (self.boundingRect().height() / 2)
+            self.setPos(x, y)
+
+        if svg:
+            svg = self.fromSvg(svg)
+
+        if 'z' in kws.keys():
+            self.setZValue(kws['z'])
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        super().paint(painter, option, widget)
+        self.drawLayerInfo(painter)
+
+    def fromSvg(self, svg):
+        renderer = QImageSvgRenderer(svg)
+        self.setSharedRenderer(renderer)
+
+    def toSvg(self):
+        """
+        Return an SVG version of the shape
+        """
+        return self.renderer().svg()

gns3/items/label_item.py

@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+from ..qt import QtCore, QtWidgets, QtGui
+from .utils import colorFromSvg
+
+
+class LabelItem(QtWidgets.QGraphicsTextItem):
+    """
+    Label for links and nodes.
+
+    :param parent: optional parent
+    """
+
+    item_unselected_signal = QtCore.Signal()
+
+    show_layer = False
+
+    def __init__(self, parent=None):
+
+        super().__init__(parent)
+
+        from ..main_window import MainWindow
+
+        main_window = MainWindow.instance()
+        view_settings = main_window.uiGraphicsView.settings()
+        qt_font = QtGui.QFont()
+        qt_font.fromString(view_settings["default_label_font"])
+        self.setDefaultTextColor(QtGui.QColor(view_settings["default_label_color"]))
+        self.setFont(qt_font)
+        self.setFlags(QtWidgets.QGraphicsItem.ItemIsMovable | QtWidgets.QGraphicsItem.ItemIsSelectable)
+        self.setZValue(2)
+        self._editable = True
+
+    def delete(self):
+        """
+        Deletes this note.
+        """
+
+        if not self.scene():
+            # object already deleted by its parent
+            return
+
+        self.scene().removeItem(self)
+        from ..topology import Topology
+
+        Topology.instance().removeNote(self)
+
+    def editable(self):
+        """
+        Returns either the note is editable or not.
+
+        :return: boolean
+        """
+
+        return self._editable
+
+    def setEditable(self, value):
+        """
+        Sets the note has editable or not.
+
+        :param value: boolean
+        """
+
+        self._editable = value
+        # if not self._editable:
+        #    self.setFlag(self.ItemIsSelectable, enabled=False)
+        # else:
+        #    self.setFlag(self.ItemIsSelectable)
+
+    def keyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        """
+
+        key = event.key()
+        modifiers = event.modifiers()
+        if key in (QtCore.Qt.Key_P, QtCore.Qt.Key_Plus, QtCore.Qt.Key_Equal) and modifiers & QtCore.Qt.AltModifier \
+                or key == QtCore.Qt.Key_Plus and modifiers & QtCore.Qt.AltModifier and modifiers & QtCore.Qt.KeypadModifier:
+            if self.rotation() > -360.0:
+                self.setRotation(self.rotation() - 1)
+        elif key in (QtCore.Qt.Key_M, QtCore.Qt.Key_Minus) and modifiers & QtCore.Qt.AltModifier \
+                or key == QtCore.Qt.Key_Minus and modifiers & QtCore.Qt.AltModifier and modifiers & QtCore.Qt.KeypadModifier:
+            if self.rotation() < 360.0:
+                self.setRotation(self.rotation() + 1)
+        else:
+            super().keyPressEvent(event)
+
+    def editText(self):
+        """
+        Edit mode for this note.
+        """
+
+        self.setTextInteractionFlags(QtCore.Qt.TextEditorInteraction)
+        self.setSelected(True)
+        self.setFocus()
+        cursor = self.textCursor()
+        cursor.select(QtGui.QTextCursor.Document)
+        self.setTextCursor(cursor)
+
+    def mouseDoubleClickEvent(self, event):
+        """
+        Handles all mouse double click events.
+
+        :param event: QMouseEvent instance
+        """
+
+        if self._editable:
+            self.editText()
+
+    def focusOutEvent(self, event):
+        """
+        Handles all focus out events.
+
+        :param event: QFocusEvent instance
+        """
+
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsFocusable, False)
+        cursor = self.textCursor()
+        if cursor.hasSelection():
+            cursor.clearSelection()
+            self.setTextCursor(cursor)
+        self.setTextInteractionFlags(QtCore.Qt.NoTextInteraction)
+        if not self.toPlainText():
+            # delete the note if empty
+            self.delete()
+            return
+        return super().focusOutEvent(event)
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        super().paint(painter, option, widget)
+
+        if self.show_layer is False or self.parentItem():
+            return
+
+        brect = self.boundingRect()
+        # don't draw anything if the object is too small
+        if brect.width() < 20 or brect.height() < 20:
+            return
+
+        center = self.mapFromItem(self, brect.width() / 2.0, brect.height() / 2.0)
+        painter.setBrush(QtCore.Qt.red)
+        painter.setPen(QtCore.Qt.red)
+        painter.drawRect(QtCore.QRectF((brect.width() / 2.0) - 10, (brect.height() / 2.0) - 10, 20, 20))
+        painter.setPen(QtCore.Qt.black)
+        zval = str(int(self.zValue()))
+        painter.drawText(QtCore.QPointF(center.x(), center.y()), zval)
+
+    def setStyle(self, new_style):
+        """
+        Set text style using a SVG style
+        """
+        font = QtGui.QFont()
+        for style in new_style.split(";"):
+            if ":" in style:
+                key, val = style.split(":")
+                key = key.strip()
+                val = val.strip()
+
+                if key == "font-size":
+                    font.setPointSizeF(float(val))
+                elif key == "font-family":
+                    font.setFamily(val)
+                elif key == "font-style" and val == "italic":
+                    font.setItalic(True)
+                elif key == "font-weight" and val == "bold":
+                    font.setBold(True)
+                elif key == "text-decoration" and val == "underline":
+                    font.setUnderline(True)
+                elif key == "text-decoration" and val == "line-through":
+                    font.setStrikeOut(True)
+                elif key == "fill":
+                    new_color = colorFromSvg(val)
+                    color = self.defaultTextColor()
+                    color.setBlue(new_color.blue())
+                    color.setRed(new_color.red())
+                    color.setGreen(new_color.green())
+                    self.setDefaultTextColor(color)
+                elif key == "fill-opacity":
+                    color = self.defaultTextColor()
+                    color.setAlphaF(float(val))
+                    self.setDefaultTextColor(color)
+        self.setFont(font)
+
+    def itemChange(self, change, value):
+        """
+        Notifies this node item that some part of the item's state changes.
+
+        :param change: GraphicsItemChange type
+        :param value: value of the change
+        """
+        if change == QtWidgets.QGraphicsItem.ItemSelectedChange:
+            if value == 0:
+                self.item_unselected_signal.emit()
+        return super().itemChange(change, value)
+
+    def dump(self):
+        """
+        Returns a representation of this note.
+
+        :returns: dictionary
+        """
+
+        note_info = {"text": self.toPlainText(),
+                     "x": int(self.x()),
+                     "y": int(self.y()),
+                     "rotation": int(self.rotation())}
+
+        style = ""
+
+        style += "font-family: {};".format(self.font().family())
+        style += "font-size: {};".format(self.font().pointSizeF())
+
+        if self.font().italic():
+            style += "font-style: italic;"
+
+        if self.font().bold():
+            style += "font-weight: bold;"
+
+        if self.font().strikeOut():
+            style += "text-decoration: line-through;"
+        elif self.font().underline():
+            style += "text-decoration: underline;"
+
+        style += "fill: {};".format("#" + hex(self.defaultTextColor().rgba())[4:])
+        style += "fill-opacity: {};".format(self.defaultTextColor().alphaF())
+
+        note_info["style"] = style
+
+        return note_info

gns3/items/line_item.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Graphical representation of a rectangle on the QGraphicsScene.
+"""
+
+import xml.etree.ElementTree as ET
+
+from ..qt import QtCore, QtGui, QtWidgets
+from .drawing_item import DrawingItem
+
+
+class LineItem(QtWidgets.QGraphicsLineItem, DrawingItem):
+
+    """
+    Class to draw a rectangle on the scene.
+    """
+
+    def __init__(self, dst=None, svg=None, **kws):
+        super().__init__(svg=svg, **kws)
+        self.setAcceptHoverEvents(True)
+
+        self._edge = None
+        self._border = 20
+
+        if svg is None:
+            if dst is not None:
+                self.setLine(0,
+                             0,
+                             dst.x(),
+                             dst.y())
+                pen = QtGui.QPen(QtCore.Qt.black, 2, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin)
+                self.setPen(pen)
+        else:
+            self.fromSvg(svg)
+        if self._id is None:
+            self.create()
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        super().paint(painter, option, widget)
+        self.drawLayerInfo(painter)
+
+    def toSvg(self):
+        """
+        Return an SVG version of the shape
+        """
+        svg = ET.Element("svg")
+        width = abs(self.line().x1() - self.line().x2())
+        height = abs(self.line().y1() - self.line().y2())
+        svg.set("width", str(int(width)))
+        svg.set("height", str(int(height)))
+
+        line = ET.SubElement(svg, "line")
+        line.set("x1", str(int(self.line().x1())))
+        line.set("x2", str(int(self.line().x2())))
+        line.set("y1", str(int(self.line().y1())))
+        line.set("y2", str(int(self.line().y2())))
+        line = self._styleSvg(line)
+
+        return ET.tostring(svg, encoding="utf-8").decode("utf-8")
+
+    def fromSvg(self, svg):
+        """
+        Import element informations from an SVG
+        """
+        svg = ET.fromstring(svg)
+        width = float(svg.get("width", 0))
+        height = float(svg.get("height", 0))
+
+        # Backup the pos and restore it
+        pos = self.pos()
+        y1 = self.line().y1()
+        self.setLine(0, 0, width, height)
+
+        pen = QtGui.QPen()
+
+        if len(svg):
+            pen = self._penFromSVGElement(svg[0])
+            self.setLine(
+                float(svg[0].get("x1")),
+                float(svg[0].get("y1")),
+                float(svg[0].get("x2")),
+                float(svg[0].get("y2"))
+            )
+        self.setPos(pos)
+        self.setPen(pen)
+        self.update()
+
+    def _isHorizontalLine(self):
+        return abs(self.line().x1() - self.line().x2()) > abs(self.line().y1() - self.line().y2())
+
+    def hoverMoveEvent(self, event):
+        """
+        Handles all hover move events.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        # locked objects don't need cursors
+        if not self.locked():
+
+            if self._isHorizontalLine():
+                if event.pos().x() > (self.line().x2() - self._border):
+                    self._graphics_view.setCursor(QtCore.Qt.SizeHorCursor)
+                elif event.pos().x() < self._border:
+                    self._graphics_view.setCursor(QtCore.Qt.SizeHorCursor)
+                else:
+                    self._graphics_view.setCursor(QtCore.Qt.SizeAllCursor)
+            # Vertical line
+            else:
+                if event.pos().y() > (self.line().y2() - self._border):
+                    self._graphics_view.setCursor(QtCore.Qt.SizeVerCursor)
+                elif event.pos().y() < self._border:
+                    self._graphics_view.setCursor(QtCore.Qt.SizeVerCursor)
+                else:
+                    self._graphics_view.setCursor(QtCore.Qt.SizeAllCursor)
+
+    def mouseMoveEvent(self, event):
+        """
+        Handles all mouse move events.
+
+        :param event: QMouseEvent instance
+        """
+
+        self.update()
+        if self._edge:
+            scenePos = event.scenePos()
+            if self._edge == "left" or self._edge == "bottom":
+                diff_x = self.x() - scenePos.x()
+                diff_y = self.y() - scenePos.y()
+                self.setPos(scenePos.x(), scenePos.y())
+                self.setLine(
+                    0,
+                    0,
+                    self.line().x2() + diff_x,
+                    self.line().y2() + diff_y)
+            elif self._edge == "right" or self._edge == "top":
+                pos = self.mapFromScene(scenePos)
+                self.setLine(
+                    0,
+                    0,
+                    pos.x(),
+                    pos.y())
+                self.setPos(self.x(), self.y())
+        super().mouseMoveEvent(event)
+
+    def mousePressEvent(self, event):
+        """
+        Handles all mouse press events.
+
+        :param event: QMouseEvent instance
+        """
+
+        self.update()
+        if self._isHorizontalLine():
+            if event.pos().x() > (self.line().x2() - self._border):
+                self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+                self._edge = "right"
+            elif event.pos().x() < (self.line().x1() + self._border):
+                self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+                self._edge = "left"
+        else:
+            if event.pos().y() > (self.line().y2() - self._border):
+                self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+                self._edge = "top"
+            elif event.pos().y() < (self.line().y1() + self._border):
+                self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+                self._edge = "bottom"
+        super().mousePressEvent(event)
+
+    def mouseReleaseEvent(self, event):
+        """
+        Handles all mouse release events.
+
+        :param: QMouseEvent instance
+        """
+
+        self.update()
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable)
+
+        self._edge = None
+        super().mouseReleaseEvent(event)
+
+    def hoverLeaveEvent(self, event):
+        """
+        Handles all hover leave events.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        # locked objects don't need cursors
+        if not self.locked():
+            self._graphics_view.setCursor(QtCore.Qt.ArrowCursor)

gns3/items/link_item.py

@@ -21,10 +21,29 @@ Link items are graphical representation of a link on the QGraphicsScene
 """
 
 import math
-from ..qt import QtCore, QtGui
+from ..qt import QtCore, QtGui, QtWidgets, QtSvg, qslot, sip_is_deleted
+
+from ..packet_capture import PacketCapture
+from ..dialogs.filter_dialog import FilterDialog
+from ..dialogs.style_editor_dialog_link import StyleEditorDialogLink
+from ..utils.get_icon import get_icon
 
 
-class LinkItem(QtGui.QGraphicsPathItem):
+class SvgIconItem(QtSvg.QGraphicsSvgItem):
+
+    def __init__(self, symbol, parent):
+
+        QtSvg.QGraphicsSvgItem.__init__(self, symbol, parent)
+
+    def mousePressEvent(self, event):
+
+        if self.parentItem():
+            self.parentItem().mousePressEvent(event)
+        event.accept()
+
+
+class LinkItem(QtWidgets.QGraphicsPathItem):
+
     """
     Base class for link items.
 
@@ -34,17 +53,21 @@ class LinkItem(QtGui.QGraphicsPathItem):
     :param destination_port: destination Port instance
     :param link: Link instance (contains back-end stuff for this link)
     :param adding_flag: indicates if this link is being added (no destination yet)
-    :param multilink: used to draw multiple link between the same source and destination
     """
 
-    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False, multilink=0):
+    _draw_port_labels = False
+    delete_link_item_signal = QtCore.pyqtSignal(str)
 
-        QtGui.QGraphicsPathItem.__init__(self)
-        self.setZValue(-1)
+    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False):
+
+        super().__init__()
+        self.setAcceptHoverEvents(True)
+        self.setZValue(-0.5)
         self._link = None
 
         from ..main_window import MainWindow
-        self._settings = MainWindow.instance().uiGraphicsView.settings()
+        self._main_window = MainWindow.instance()
+        self._settings = self._main_window.uiGraphicsView.settings()
 
         # indicates link is being added:
         # source has been chosen but not its destination yet
@@ -56,48 +79,33 @@ class LinkItem(QtGui.QGraphicsPathItem):
         # default pen size
         self._pen_width = 2.0
 
-        # indicates the link position when there are multiple links
-        # between the same source and destination
-        self._multilink = multilink
-
         # source & destination items and ports
         self._source_item = source_item
         self._destination_item = destination_item
         self._source_port = source_port
         self._destination_port = destination_port
 
+        # indicates if the link is being hovered
+        self._hovered = False
+
+        # QGraphicsSvgItem to indicate a capture
+        self._capturing_item = None
+        # QGraphicsSvgItem to indicate a filter is applied
+        self._filter_item = None
+        # QGraphicsSvgItem to indicate we suspend a link
+        self._suspend_item = None
+        # QGraphicsSvgItem to indicate a filter is applied and a capture is active
+        self._filter_capturing_item = None
+
         if not self._adding_flag:
             # there is a destination
-
             self._link = link
-
-            # links must always be below node items on the scene
-            min_zvalue = min([source_item.zValue(), destination_item.zValue()])
-            self.setZValue(min_zvalue - 1)
+            self._link.updated_link_signal.connect(self._drawSymbol)
+            self._link.delete_link_signal.connect(self._linkDeletedSlot)
             self.setFlag(self.ItemIsFocusable)
-
             source_item.addLink(self)
             destination_item.addLink(self)
-
-            #TODO: capture support
-
-#             source_item.node.nio_signal.connect(self.newNIOSlot)
-#             destination_item.node.nio_signal.connect(self.newNIOSlot)
-#             self._source_item.setCustomToolTip()
-#             self._destination_item.setCustomToolTip()
-#             self.capturing = False
-#             self.capfile = None
-#             self.captureInfo = None
-#             self.tailProcess = None
-#             self.capturePipeThread = None
-#             # Set default tooltip
-
-#             self.encapsulationTransform = { 'ETH': 'EN10MB',
-#                                             'FR': 'FRELAY',
-#                                             'HDLC': 'C_HDLC',
-#                                             'PPP': 'PPP_SERIAL'}
             self.setCustomToolTip()
-
         else:
             source_rect = self._source_item.boundingRect()
             self.source = self.mapFromItem(self._source_item, source_rect.width() / 2.0, source_rect.height() / 2.0)
@@ -105,16 +113,60 @@ class LinkItem(QtGui.QGraphicsPathItem):
 
         self.adjust()
 
+    @qslot
+    def _linkDeletedSlot(self, link_id, *args):
+        # first delete the port labels if any
+
+        if self._source_port.label():
+            self._source_port.label().setParentItem(None)
+            self.scene().removeItem(self._source_port.label())
+        if self._destination_port.label():
+            self._destination_port.label().setParentItem(None)
+            self.scene().removeItem(self._destination_port.label())
+
+        if self.scene():
+            if self in self.scene().items():
+                self.scene().removeItem(self)
+
+    @qslot
+    def _filterActionSlot(self, *args):
+        dialog = FilterDialog(self._main_window, self._link)
+        dialog.show()
+        dialog.exec_()
+
+    @qslot
+    def _suspendActionSlot(self, *args):
+        self._link.toggleSuspend()
+
+    @qslot
+    def _styleActionSlot(self, *args):
+        style_dialog = StyleEditorDialogLink(self, self._main_window)
+        style_dialog.show()
+        style_dialog.exec_()
+
+    def setLinkStyle(self, link_style):
+        self._link._link_style["color"] = link_style["color"]
+        self._link._link_style["width"] = link_style["width"]
+        self._link._link_style["type"]  = link_style["type"]
+
+        # This refers to functions in link.py!
+        self._link.setLinkStyle(link_style)
+        self._link.update()
+
     def delete(self):
         """
         Delete this link
         """
-
-        self._source_item.removeLink(self)
-        self._destination_item.removeLink(self)
         self._link.deleteLink()
-        if self in self.scene().items():
-            self.scene().removeItem(self)
+
+    def link(self):
+        """
+        Returns the link attached to this link item.
+
+        :returns: Link instance
+        """
+
+        return self._link
 
     def setCustomToolTip(self):
         """
@@ -122,7 +174,7 @@ class LinkItem(QtGui.QGraphicsPathItem):
         """
 
         if self._link:
-            self.setToolTip(self._link.description())
+            self.setToolTip(str(self._link))
 
     def sourceItem(self):
         """
@@ -160,6 +212,89 @@ class LinkItem(QtGui.QGraphicsPathItem):
 
         return self._destination_port
 
+    @classmethod
+    def showPortLabels(cls, state):
+        """
+        Shows or hides port labels.
+
+        :param state: boolean
+        """
+
+        cls._draw_port_labels = state
+
+    def resetPortLabels(self):
+        """
+        Resets the port label positions.
+        """
+
+        self._source_port.deleteLabel()
+        self._destination_port.deleteLabel()
+
+    def populateLinkContextualMenu(self, menu):
+        """
+        Adds device actions to the link contextual menu.
+
+        :param menu: QMenu instance
+        """
+
+        if not self._link.capturing():
+            # start capture
+            start_capture_action = QtWidgets.QAction("Start capture", menu)
+            start_capture_action.setIcon(get_icon('capture-start.svg'))
+            start_capture_action.triggered.connect(self._startCaptureActionSlot)
+            menu.addAction(start_capture_action)
+
+        if self._link.capturing():
+            # stop capture
+            stop_capture_action = QtWidgets.QAction("Stop capture", menu)
+            stop_capture_action.setIcon(get_icon('capture-stop.svg'))
+            stop_capture_action.triggered.connect(self._stopCaptureActionSlot)
+            menu.addAction(stop_capture_action)
+
+            # start wireshark
+            start_wireshark_action = QtWidgets.QAction("Start Wireshark", menu)
+            start_wireshark_action.setIcon(QtGui.QIcon(":/icons/wireshark.png"))
+            start_wireshark_action.triggered.connect(self._startWiresharkActionSlot)
+            menu.addAction(start_wireshark_action)
+
+            if PacketCapture.instance().packetAnalyzerAvailable():
+                analyze_action = QtWidgets.QAction("Analyze capture", menu)
+                analyze_action.setIcon(QtGui.QIcon(':/icons/rtv.png'))
+                analyze_action.triggered.connect(self._analyzeCaptureActionSlot)
+                menu.addAction(analyze_action)
+
+        if self._link.suspended() is False:
+            # Edit filters
+            filter_action = QtWidgets.QAction("Packet filters", menu)
+            filter_action.setIcon(get_icon('filter.svg'))
+            filter_action.triggered.connect(self._filterActionSlot)
+            menu.addAction(filter_action)
+
+            # Suspend link
+            suspend_action = QtWidgets.QAction("Suspend", menu)
+            suspend_action.setIcon(get_icon('pause.svg'))
+            suspend_action.triggered.connect(self._suspendActionSlot)
+            menu.addAction(suspend_action)
+        else:
+            # Resume link
+            resume_action = QtWidgets.QAction("Resume", menu)
+            resume_action.setIcon(get_icon('start.svg'))
+            resume_action.triggered.connect(self._suspendActionSlot)
+            menu.addAction(resume_action)
+
+        # style
+        style_action = QtWidgets.QAction("Style", menu)
+        style_action.setIcon(get_icon("node_conception.svg"))
+        style_action.triggered.connect(self._styleActionSlot)
+        menu.addAction(style_action)
+
+        # delete
+        delete_action = QtWidgets.QAction("Delete", menu)
+        delete_action.setIcon(get_icon('delete.svg'))
+        delete_action.triggered.connect(self._deleteActionSlot)
+        menu.addAction(delete_action)
+
+    @qslot
     def mousePressEvent(self, event):
         """
         Called when the link is clicked and shows a contextual menu.
@@ -167,21 +302,43 @@ class LinkItem(QtGui.QGraphicsPathItem):
         :param: QGraphicsSceneMouseEvent instance
         """
 
-        if (event.button() == QtCore.Qt.RightButton):
-            if self._adding_flag:
-                # send a escape key to the main window to cancel the link addition
-                from ..main_window import MainWindow
-                key = QtGui.QKeyEvent(QtCore.QEvent.KeyPress, QtCore.Qt.Key_Escape, QtCore.Qt.NoModifier)
-                QtGui.QApplication.sendEvent(MainWindow.instance(), key)
-                return
+        if event.button() == QtCore.Qt.RightButton and self._adding_flag:
+            # send a escape key to the main window to cancel the link addition
+            from ..main_window import MainWindow
+            key = QtGui.QKeyEvent(QtCore.QEvent.KeyPress, QtCore.Qt.Key_Escape, QtCore.Qt.NoModifier)
+            QtWidgets.QApplication.sendEvent(MainWindow.instance(), key)
+            return
+        else:
+            super().mousePressEvent(event)
 
+    def contextMenuEvent(self, event):
+        """
+        Handles all context menu events.
+
+        :param event: QContextMenuEvent instance
+        """
+
+        if not sip_is_deleted(self):
             # create the contextual menu
-            menu = QtGui.QMenu()
-            delete_action = QtGui.QAction("Delete", menu)
-            delete_action.setIcon(QtGui.QIcon(':/icons/delete.svg'))
-            delete_action.triggered.connect(self._deleteActionSlot)
-            menu.addAction(delete_action)
+            self.setHovered(True)
+            self.setAcceptHoverEvents(False)
+            menu = QtWidgets.QMenu()
+            self.populateLinkContextualMenu(menu)
             menu.exec_(QtGui.QCursor.pos())
+            self.setAcceptHoverEvents(True)
+            self.setHovered(False)
+
+    def keyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        """
+
+        # On pressing backspace or delete key, the selected link gets deleted
+        if event.key() == QtCore.Qt.Key_Delete or event.key() == QtCore.Qt.Key_Backspace:
+            self._deleteActionSlot()
+            return
 
     def _deleteActionSlot(self):
         """
@@ -191,12 +348,84 @@ class LinkItem(QtGui.QGraphicsPathItem):
 
         self.delete()
 
+    def _startCaptureActionSlot(self):
+        """
+        Slot to receive events from the start capture action in the
+        contextual menu.
+        """
+
+        PacketCapture.instance().startCapture(self._link)
+
+    def _stopCaptureActionSlot(self):
+        """
+        Slot to receive events from the stop capture action in the
+        contextual menu.
+        """
+
+        PacketCapture.instance().stopCapture(self._link)
+
+    def _startWiresharkActionSlot(self):
+        """
+        Slot to receive events from the start Wireshark action in the
+        contextual menu.
+        """
+
+        PacketCapture.instance().startPacketCaptureReader(self._link)
+
+    def _analyzeCaptureActionSlot(self):
+        """
+        Slot to receive events from the analyze capture action in the
+        contextual menu.
+        """
+
+        try:
+            PacketCapture.instance().startPacketCaptureAnalyzer(self._link)
+        except OSError as e:
+            QtWidgets.QMessageBox.critical(self._main_window, "Capture analyzer", "Cannot start the packet capture analyzer program: {}".format(e))
+
+    def setHovered(self, value):
+        """
+        Sets the link as hovered or not.
+
+        :param value: boolean
+        """
+
+        if value:
+            self._hovered = True
+        else:
+            self._hovered = False
+        self.adjust()
+
+    def hoverEnterEvent(self, event):
+        """
+        Handles all hover enter events for this item.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        self.setHovered(True)
+
+    def hoverLeaveEvent(self, event):
+        """
+        Handles all hover leave events for this item.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        self.setHovered(False)
+
+    @qslot
     def adjust(self):
         """
         Computes the source point and destination point.
         Must be overloaded.
         """
 
+        # links must always be below node items on the scene
+        if not self._adding_flag:
+            min_zvalue = min([self._source_item.zValue(), self._destination_item.zValue()])
+            self.setZValue(min_zvalue - 0.5)
+
         self.prepareGeometryChange()
         source_rect = self._source_item.boundingRect()
         self.source = self.mapFromItem(self._source_item, source_rect.width() / 2.0, source_rect.height() / 2.0)
@@ -213,15 +442,54 @@ class LinkItem(QtGui.QGraphicsPathItem):
         # compute the length of the line
         self.length = math.sqrt(self.dx * self.dx + self.dy * self.dy)
 
+        multilink = self._computeMultiLink()
+
         # multi-link management
-        if not self._adding_flag and self._multilink and self.length:
+        if not self._adding_flag and multilink and self.length:
             angle = math.radians(90)
             self.dxrot = math.cos(angle) * self.dx - math.sin(angle) * self.dy
             self.dyrot = math.sin(angle) * self.dx + math.cos(angle) * self.dy
-            offset = QtCore.QPointF((self.dxrot * (self._multilink * 5)) / self.length, (self.dyrot * (self._multilink * 5)) / self.length)
+            offset = QtCore.QPointF((self.dxrot * (multilink * 5)) / self.length, (self.dyrot * (multilink * 5)) / self.length)
             self.source = QtCore.QPointF(self.source + offset)
             self.destination = QtCore.QPointF(self.destination + offset)
 
+    def _computeMultiLink(self):
+        # Multi-link management
+        #
+        # multi is the offset of the link
+        # +------+       multi = -1    Link 2  +-------+
+        # |      +-----------------------------+       |
+        # |  R1  |                             |   R2  |
+        # |      |        multi = 0    Link 1  |       |
+        # |      +-----------------------------+       |
+        # |      |        multi = 1    Link 3  |       |
+        # +------+-----------------------------+-------+
+
+        if self._source_item == self._destination_item:
+            multi = 0
+        elif not hasattr(self._destination_item, "node"):  # Could be temporary a qpointf during link creation
+            multi = 0
+        else:
+            multi = 0
+            link_items = self._source_item.links()
+            for link_item in link_items:
+                if link_item == self:
+                    break
+                if link_item.destinationItem().node().id() == self._destination_item.node().id():
+                    multi += 1
+                if link_item.sourceItem().node().id() == self._destination_item.node().id():
+                    multi += 1
+
+        # MAX 7 links on the scene between 2 nodes
+        if multi > 7:
+            multi = 0
+        # Pair item represent the bottom links
+        elif multi % 2 == 0:
+            multi = multi // 2
+        else:
+            multi = -multi // 2
+        return multi
+
     def setMousePoint(self, scene_point):
         """
         Sets new mouse point coordinates.
@@ -233,3 +501,92 @@ class LinkItem(QtGui.QGraphicsPathItem):
         self.destination = scene_point
         self.adjust()
         self.update()
+
+    @qslot
+    def _drawSymbol(self, *args):
+        """
+        Draws a symbol in the middle of the link to indicate a capture, a suspend or a filter is active.
+        """
+
+        #FIXME: refactor ugly symbol management
+        if not self._adding_flag:
+
+            if self._link.suspended():
+                if self.length >= 150:
+                    link_center = QtCore.QPointF(self.source.x() + self.dx / 2.0 - 11, self.source.y() + self.dy / 2.0 - 11)
+                    if self._suspend_item is None:
+                        self._suspend_item = SvgIconItem(':/icons/pause.svg', self)
+                        self._suspend_item.setScale(0.6)
+                    if not self._suspend_item.isVisible():
+                        self._suspend_item.show()
+                    self._suspend_item.setPos(link_center)
+                    if self._filter_item:
+                        self._filter_item.hide()
+                elif self._suspend_item:
+                    self._suspend_item.hide()
+                if self._filter_capturing_item:
+                    self._filter_capturing_item.hide()
+                if self._capturing_item:
+                    self._capturing_item.hide()
+                if self._filter_item:
+                    self._filter_item.hide()
+
+            elif self._link.capturing() and len(self._link.filters()) > 0:
+                if self.length >= 150:
+                    link_center = QtCore.QPointF(self.source.x() + self.dx / 2.0 - 11, self.source.y() + self.dy / 2.0 - 11)
+                    if self._filter_capturing_item is None:
+                        self._filter_capturing_item = SvgIconItem(':/icons/filter-capture.svg', self)
+                        self._filter_capturing_item.setScale(0.6)
+                    if not self._filter_capturing_item.isVisible():
+                        self._filter_capturing_item.show()
+                    self._filter_capturing_item.setPos(link_center)
+                elif self._filter_capturing_item:
+                    self._filter_capturing_item.hide()
+                if self._capturing_item:
+                    self._capturing_item.hide()
+                if self._filter_item:
+                    self._filter_item.hide()
+                if self._suspend_item:
+                    self._suspend_item.hide()
+
+            elif self._link.capturing():
+                if self.length >= 150:
+                    link_center = QtCore.QPointF(self.source.x() + self.dx / 2.0 - 11, self.source.y() + self.dy / 2.0 - 11)
+                    if self._capturing_item is None:
+                        self._capturing_item = SvgIconItem(':/icons/inspect.svg', self)
+                        self._capturing_item.setScale(0.6)
+                    self._capturing_item.setPos(link_center)
+                    if not self._capturing_item.isVisible():
+                        self._capturing_item.show()
+                elif self._capturing_item:
+                    self._capturing_item.hide()
+                if self._filter_capturing_item:
+                    self._filter_capturing_item.hide()
+                if self._suspend_item:
+                    self._suspend_item.hide()
+
+            elif len(self._link.filters()) > 0:
+                if self.length >= 150:
+                    link_center = QtCore.QPointF(self.source.x() + self.dx / 2.0 - 11, self.source.y() + self.dy / 2.0 - 11)
+                    if self._filter_item is None:
+                        self._filter_item = SvgIconItem(':/icons/filter.svg', self)
+                        self._filter_item.setScale(0.6)
+                    if not self._filter_item.isVisible():
+                        self._filter_item.show()
+                    self._filter_item.setPos(link_center)
+                elif self._filter_item:
+                    self._filter_item.hide()
+                if self._filter_capturing_item:
+                    self._filter_capturing_item.hide()
+                if self._suspend_item:
+                    self._suspend_item.hide()
+
+            else:
+                if self._capturing_item:
+                    self._capturing_item.hide()
+                if self._suspend_item:
+                    self._suspend_item.hide()
+                if self._filter_item:
+                    self._filter_item.hide()
+                if self._filter_capturing_item:
+                    self._filter_capturing_item.hide()

gns3/items/logo_item.py

@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 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 urllib.parse
+
+from ..qt import QtCore, QtGui, QtWidgets, QtSvg
+from ..qt.qimage_svg_renderer import QImageSvgRenderer
+from ..controller import Controller
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class LogoItem(QtSvg.QGraphicsSvgItem):
+    """
+    Margin for the logo
+    """
+    MARGIN = 20
+
+    """
+    Logo for the scene.
+
+    :param logo_path: Path to the logo (remote)
+    :param logo_url: URL which needs to be open user clicks on the logo
+    :param project: Current project
+    """
+
+    def __init__(self, logo_path, logo_url, project):
+        super().__init__()
+
+        self._logo_path = logo_path
+        self._logo_url = logo_url
+        self._project = project
+
+        # Temporary symbol during loading
+        renderer = QImageSvgRenderer(":/icons/reload.svg")
+        renderer.setObjectName("symbol_loading")
+        self.setSharedRenderer(renderer)
+
+        effect = QtWidgets.QGraphicsColorizeEffect()
+        effect.setColor(QtGui.QColor("black"))
+        effect.setStrength(0.8)
+        self.setGraphicsEffect(effect)
+        self.graphicsEffect().setEnabled(False)
+
+        # set graphical settings for this item
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsFocusable)
+        self.setFlag(QtWidgets.QGraphicsItem.ItemSendsGeometryChanges)
+        self.setAcceptHoverEvents(True)
+
+        from ..main_window import MainWindow
+        self._main_window = MainWindow.instance()
+        self._settings = self._main_window.uiGraphicsView.settings()
+
+        self.updatePosition()
+
+        self._main_window.uiGraphicsView.viewport().installEventFilter(self)
+
+        remote_file = urllib.parse.quote('project-files/images/{}'.format(logo_path))
+
+        Controller.instance().getStatic(
+            '/projects/{}/files/{}'.format(project.id(), remote_file),
+            self.updateImage
+        )
+
+        # make it the last one
+        self.setZValue(-2)
+
+    def eventFilter(self, source, event):
+        if event.type() == QtCore.QEvent.Paint:
+            self.updatePosition()
+        return QtWidgets.QWidget.eventFilter(self, source, event)
+
+
+    def updateImage(self, local_path):
+        renderer = QImageSvgRenderer(local_path)
+        renderer.setObjectName("project_logo")
+        self.setSharedRenderer(renderer)
+
+
+    def updatePosition(self):
+        """
+        Updates position to be located in the right bottom corner
+        """
+        logo_rect = self.boundingRect()
+        width = self._main_window.uiGraphicsView.viewport().width()
+        height = self._main_window.uiGraphicsView.viewport().height()
+        rect = self._main_window.uiGraphicsView.mapToScene(QtCore.QRect(0, 0, width, height)).boundingRect()
+        x = rect.x() + rect.width() - self.MARGIN - logo_rect.width()
+        y = rect.y() + rect.height() - self.MARGIN - logo_rect.height()
+
+        # update only when changes
+        if [int(self.x()), int(self.y())] != [int(x), int(y)]:
+            self.setX(x)
+            self.setY(y)
+            self.update()
+
+    def hoverEnterEvent(self, event):
+        """
+        Handles all hover enter events for this item.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        if self._logo_url is not None:
+            self.graphicsEffect().setEnabled(True)
+
+    def hoverLeaveEvent(self, event):
+        """
+        Handles all hover leave events for this item.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        self.graphicsEffect().setEnabled(False)
+
+    def mousePressEvent(self, event):
+        url = QtCore.QUrl(self._logo_url)
+        if not QtGui.QDesktopServices.openUrl(url):
+            QtWidgets.QMessageBox.warning(self, 'Open Url', 'Could not open url')

gns3/items/node_item.py

@@ -19,35 +19,70 @@
 Graphical representation of a node on the QGraphicsScene.
 """
 
-from ..qt import QtCore, QtGui, QtSvg
+from ..qt import sip
+
+from ..qt import QtCore, QtGui, QtWidgets, QtSvg, qslot
+from ..qt.qimage_svg_renderer import QImageSvgRenderer
+from .label_item import LabelItem
+from ..symbol import Symbol
+from ..controller import Controller
+
+
+import logging
+log = logging.getLogger(__name__)
 
 
 class NodeItem(QtSvg.QGraphicsSvgItem):
+
     """
     Node for the scene.
 
-    :param node: Node instance.
+    :param node: Node instance
     """
 
-    def __init__(self, node):
+    show_layer = False
 
-        QtSvg.QGraphicsSvgItem.__init__(self)
+    def __init__(self, node):
+        super().__init__()
 
         # attached node
         self._node = node
+        # link items connected to this node item.
+        self._links = []
+        self._symbol = None
+        self._locked = False
+        self._allow_snap_to_grid = True
+
+        # says if the attached node has been initialized
+        # by the server.
+        self._initialized = False
+
+        # node label
+        self._node_label = None
+
+        self.setPos(QtCore.QPoint(self._node.x(), self._node.y()))
+
+        # Temporary symbol during loading
+        renderer = QImageSvgRenderer(":/icons/reload.svg")
+        renderer.setObjectName("symbol_loading")
+        self.setSharedRenderer(renderer)
+
+        effect = QtWidgets.QGraphicsColorizeEffect()
+        effect.setColor(QtGui.QColor("black"))
+        effect.setStrength(0.8)
+        self.setGraphicsEffect(effect)
+        self.graphicsEffect().setEnabled(False)
 
         # set graphical settings for this node
-        self.setFlag(QtSvg.QGraphicsSvgItem.ItemIsMovable)
-        self.setFlag(QtSvg.QGraphicsSvgItem.ItemIsSelectable)
-        self.setFlag(QtSvg.QGraphicsSvgItem.ItemIsFocusable)
-        self.setFlag(QtSvg.QGraphicsSvgItem.ItemSendsGeometryChanges)
-        self.setAcceptsHoverEvents(True)
-        self.setZValue(1)
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable)
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsSelectable)
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsFocusable)
+        self.setFlag(QtWidgets.QGraphicsItem.ItemSendsGeometryChanges)
+        self.setAcceptHoverEvents(True)
 
-        # create renderers using symbols paths/resources
-        self._default_renderer = QtSvg.QSvgRenderer(node.defaultSymbol())
-        self._hover_renderer = QtSvg.QSvgRenderer(node.hoverSymbol())
-        self.setSharedRenderer(self._default_renderer)
+        # update z value and locked state
+        self.setLocked(self._node.locked())
+        self.setZValue(self._node.z())
 
         # connect signals to know about some events
         # e.g. when the node has been started, stopped or suspended etc.
@@ -57,32 +92,70 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         node.suspended_signal.connect(self.suspendedSlot)
         node.updated_signal.connect(self.updatedSlot)
         node.deleted_signal.connect(self.deletedSlot)
-        node.delete_links_signal.connect(self.deleteLinksSlot)
         node.error_signal.connect(self.errorSlot)
         node.server_error_signal.connect(self.serverErrorSlot)
 
-        # link items connected to this node item.
-        self._links = []
-
         # used when a port has been selected from the contextual menu
         self._selected_port = None
 
-        # says if the attached node has been initialized
-        # by the server.
-        self._initialized = False
-
         # contains the last error message received
         # from the server.
         self._last_error = None
 
-    def setUnsavedState(self):
+        from ..main_window import MainWindow
+        self._main_window = MainWindow.instance()
+        self._settings = self._main_window.uiGraphicsView.settings()
+
+        if node.initialized():
+            self.createdSlot(node.id())
+
+        if self._main_window.uiSnapToGridAction.isChecked():
+            self.setPos(QtCore.QPointF(self._node.x() + 0.1, self._node.y()))
+
+    def updateNode(self):
         """
-        Indicates the project is in a unsaved state.
+        Sync change to the node
         """
 
-        from ..main_window import MainWindow
-        main_window = MainWindow.instance()
-        main_window.setUnsavedState()
+        self._node.setGraphics(self)
+
+    @qslot
+    def setSymbol(self, symbol):
+        """
+        :param symbol: Change the symbol path
+        """
+        # create renderer using symbols path/resource
+        if symbol is None:
+            symbol = self._node.defaultSymbol()
+        if self._symbol != symbol:
+            self._symbol = symbol
+
+            # Temporary symbol during loading
+            renderer = QImageSvgRenderer(":/icons/reload.svg")
+            renderer.setObjectName("symbol_loading")
+            self.setSharedRenderer(renderer)
+
+            Controller.instance().getStatic(Symbol(symbol_id=symbol).url(), self._symbolLoadedCallback)
+
+    def symbol(self):
+        return self._symbol
+
+    @qslot
+    def _symbolLoadedCallback(self, path, *args):
+
+        renderer = QImageSvgRenderer(path, fallback=":/icons/cancel.svg")
+        renderer.setObjectName(path)
+        self.setSharedRenderer(renderer)
+        if self._settings["limit_size_node_symbols"] is True and renderer.defaultSize().height() > 80:
+            # resize the SVG
+            renderer.resize(80)
+            self.setSharedRenderer(renderer)
+        if self._node.settings().get("symbol") != self._symbol:
+            self.updateNode()
+        if not self._initialized:
+            self._showLabel()
+            self._initialized = True
+            self.updateNode()
 
     def node(self):
         """
@@ -93,27 +166,44 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
 
         return self._node
 
-    def addLink(self, link):
+    def setPos(self, *args):
+        super().setPos(*args)
+        self._node.setSettingValue("x", int(self.x()))
+        self._node.setSettingValue("y", int(self.y()))
+
+    @qslot
+    def addLink(self, link_item, *args):
         """
         Adds a link items to this node item.
 
         :param link: LinkItem instance
         """
 
-        self._links.append(link)
-        self._node.updated_signal.emit()
-        self.setUnsavedState()
+        if not sip.isdeleted(link_item):
+            self._links.append(link_item)
+            link_item.link().delete_link_signal.connect(self._removeLink)
+            link_item.link().updated_link_signal.connect(self._linkUpdatedSlot)
+            self._node.updated_signal.emit()
 
-    def removeLink(self, link):
+    @qslot
+    def _linkUpdatedSlot(self, *args):
+        """
+        When a link change we also notify the listener of the node
+        """
+        self._node.updated_signal.emit()
+
+    @qslot
+    def _removeLink(self, link_id, *args):
         """
         Removes a link items from this node item.
 
         :param link: LinkItem instance
         """
 
-        if link in self._links:
-            self._links.remove(link)
-        self.setUnsavedState()
+        for link_item in self._links:
+            if link_item.link().id() == link_id:
+                self._links.remove(link_item)
+                return
 
     def links(self):
         """
@@ -124,19 +214,21 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
 
         return self._links
 
-    def createdSlot(self, node_id):
+    @qslot
+    def createdSlot(self, base_node_id, *args):
         """
         Slot to receive events from the attached Node instance
         when a the node has been created/initialized.
 
-        :param node_id: node identifier (integer)
+        :param base_node_id: base node identifier (integer)
         """
 
-        self._initialized = True
+        self.setPos(QtCore.QPoint(self._node.x(), self._node.y()))
+        self.setSymbol(self._node.symbol())
         self.update()
-        self.showName()
 
-    def startedSlot(self):
+    @qslot
+    def startedSlot(self, *args):
         """
         Slot to receive events from the attached Node instance
         when a the node has started.
@@ -145,7 +237,8 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         for link in self._links:
             link.update()
 
-    def stoppedSlot(self):
+    @qslot
+    def stoppedSlot(self, *args):
         """
         Slot to receive events from the attached Node instance
         when a the node has stopped.
@@ -154,7 +247,8 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         for link in self._links:
             link.update()
 
-    def suspendedSlot(self):
+    @qslot
+    def suspendedSlot(self, *args):
         """
         Slot to receive events from the attached Node instance
         when a the node has suspended.
@@ -163,48 +257,55 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         for link in self._links:
             link.update()
 
-    def updatedSlot(self):
-
-        self.textItem.setPlainText(self._node.name())
-        self.setUnsavedState()
-
-    def deleteLinksSlot(self):
+    @qslot
+    def updatedSlot(self, *args):
         """
         Slot to receive events from the attached Node instance
-        when a all the links must be deleted.
+        when a the node has been updated.
         """
 
-        for link in self._links.copy():
-            link.delete()
+        self.setSymbol(self._node.settings().get("symbol"))
+        self.setPos(self._node.settings().get("x", 0), self._node.settings().get("y", 0))
+        self.setZValue(self._node.settings().get("z", 0))
+        self.setLocked(self._node.settings().get("locked", False))
+        self._updateLabel()
 
-    def deletedSlot(self):
+        # update the link tooltips in case the
+        # node name has changed
+        for link in self._links:
+            link.setCustomToolTip()
+
+    @qslot
+    def deletedSlot(self, *args):
         """
         Slot to receive events from the attached Node instance
         when the node has been deleted.
         """
 
+        if not self.scene():
+            return
         if self in self.scene().items():
             self.scene().removeItem(self)
-        self.setUnsavedState()
 
-    def serverErrorSlot(self, node_id, code, message):
+    @qslot
+    def serverErrorSlot(self, base_node_id, message, *args):
         """
         Slot to receive events from the attached Node instance
         when the node has received an error from the server.
 
-        :param node_id: node identifier
-        :param code: error code
+        :param base_node_id: base node identifier
         :param message: error message
         """
 
         self._last_error = "{message}".format(message=message)
 
-    def errorSlot(self, node_id, message):
+    @qslot
+    def errorSlot(self, base_node_id, message, *args):
         """
         Slot to receive events from the attached Node instance
         when the node wants to report an error.
 
-        :param node_id: node identifier
+        :param base_node_id: base node identifier
         :param message: error message
         """
 
@@ -224,24 +325,74 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         else:
             self.setToolTip(self._node.info())
 
-    def showName(self):
+    def label(self):
         """
-        Shows the node name on the scene.
+        Returns the node label.
+
+        :return: NoteItem instance.
         """
 
-        #TODO: possibility to change the Font size etc.
-        self.textItem = QtGui.QGraphicsTextItem(self._node.name(), self)
-        self.textItem.setFont(QtGui.QFont("TypeWriter", 10, QtGui.QFont.Bold))
-        self.textItem.setFlag(self.textItem.ItemIsMovable)
-        textrect = self.textItem.boundingRect()
-        textmiddle = textrect.topRight() / 2
-        noderect = self.boundingRect()
-        nodemiddle = noderect.topRight() / 2
-        self.default_name_xpos = nodemiddle.x() - textmiddle.x()
-        self.default_name_ypos = -25
-        self.textItem.setPos(self.default_name_xpos, self.default_name_ypos)
+        return self._node_label
 
-    def connectToPort(self, unavailable_ports=[]):
+    def _labelUnselectedSlot(self):
+        """
+        Called when user unselect the label
+        """
+        self.updateNode()
+
+    def _centerLabel(self):
+        """
+        Centers the node label.
+        """
+
+        text_rect = self._node_label.boundingRect()
+        text_middle = text_rect.topRight() / 2
+        node_rect = self.boundingRect()
+        node_middle = node_rect.topRight() / 2
+        label_x_pos = node_middle.x() - text_middle.x()
+        label_y_pos = -25
+        self._node_label.setPos(label_x_pos, label_y_pos)
+        return
+
+    def _showLabel(self):
+        """
+        Shows the node label on the scene.
+        """
+
+        if not self._node_label:
+            self._node_label = LabelItem(self)
+            self._node_label.item_unselected_signal.connect(self._labelUnselectedSlot)
+            self._node_label.setEditable(False)
+            self._updateLabel()
+            self._node.setSettingValue("label", self._node_label.dump())
+
+    def _updateLabel(self):
+        """
+        Update the label using the information stored in the node
+        """
+        if not self._node_label:
+            return
+        self._node_label.setPlainText(self._node.name())
+        label_data = self._node.settings().get("label")
+
+        if self._node_label.toPlainText() != label_data["text"]:
+            self._node_label.setPlainText(label_data["text"])
+
+        style = label_data.get("style")
+        if style:
+            self._node_label.setStyle(style)
+        self._node_label.setRotation(label_data.get("rotation", 0))
+
+        if self._node.locked():
+            self._node_label.setFlag(self.ItemIsMovable, False)
+
+        if label_data["x"] is None:
+            self._centerLabel()
+            self.updateNode()
+        else:
+            self._node_label.setPos(label_data["x"], label_data["y"])
+
+    def connectToPort(self, pos, unavailable_ports=[]):
         """
         Shows a contextual menu for the user to choose port or auto-select one.
 
@@ -251,32 +402,48 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         """
 
         self._selected_port = None
-        menu = QtGui.QMenu()
+        menu = QtWidgets.QMenu()
         ports = self._node.ports()
         if not ports:
-            QtGui.QMessageBox.critical(self.scene().parent(), "Link", "No port available, please configure this device")
+            QtWidgets.QMessageBox.critical(self.scene().parent(), "Link", "No port available, please configure this device")
             return None
 
-        # sort by port name
-        port_names = {}
+        # sort the ports
+        ports_dict = {}
         for port in ports:
-            port_names[port.name()] = port
-        ports = sorted(port_names.keys())
+            if port.adapterNumber() is not None:
+                # make the port number unique (special case with WICs).
+                port_number = port.portNumber()
+                if port_number >= 16:
+                    port_number *= 8
+                ports_dict[(port.adapterNumber() * 16) + port_number] = port
+            elif port.portNumber()is not None:
+                ports_dict[port.portNumber()] = port
+            else:
+                ports_dict[port.name()] = port
+        try:
+            ports = sorted(ports_dict.keys(), key=int)
+        except ValueError:
+            ports = sorted(ports_dict.keys())
 
         # show a contextual menu for the user to choose a port
         for port in ports:
-            port_object = port_names[port]
+            port_object = ports_dict[port]
+            log.debug("Node '{}' Port {} Type {}".format(self.node(), port_object.name(), type(port_object.name())))
             if port in unavailable_ports:
                 # this port cannot be chosen by the user (grayed out)
-                action = menu.addAction(QtGui.QIcon(':/icons/led_green.svg'), port)
+                action = menu.addAction(QtGui.QIcon(':/icons/led_green.svg'), port_object.name())
                 action.setDisabled(True)
             elif port_object.isFree():
-                menu.addAction(QtGui.QIcon(':/icons/led_red.svg'), port)
+                menu.addAction(QtGui.QIcon(':/icons/led_red.svg'), port_object.name())
             else:
-                menu.addAction(QtGui.QIcon(':/icons/led_green.svg'), port)
+                menu.addAction(QtGui.QIcon(':/icons/led_green.svg'), port_object.name())
 
         menu.triggered.connect(self.selectedPortSlot)
-        menu.exec_(QtGui.QCursor.pos())
+        # add some delay before showing the menu
+        # https://github.com/GNS3/gns3-gui/issues/3169
+        QtCore.QThread.msleep(100)
+        menu.exec_(pos)
         return self._selected_port
 
     def selectedPortSlot(self, action):
@@ -303,52 +470,112 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         :param value: value of the change
         """
 
+        if change == QtWidgets.QGraphicsItem.ItemPositionChange and self._main_window.uiSnapToGridAction.isChecked() \
+                and self._allow_snap_to_grid:
+            grid_size = self._main_window.uiGraphicsView.nodeGridSize()
+            mid_x = self.boundingRect().width() / 2
+            value.setX((grid_size * round((value.x() + mid_x) / grid_size)) - mid_x)
+            mid_y = self.boundingRect().height() / 2
+            value.setY((grid_size * round((value.y() + mid_y) / grid_size)) - mid_y)
+
         # dynamically change the renderer when this node item is selected/unselected.
-        if change == QtSvg.QGraphicsSvgItem.ItemSelectedChange:
+        if change == QtWidgets.QGraphicsItem.ItemSelectedChange:
             if value:
-                self.setSharedRenderer(self._hover_renderer)
+                self.graphicsEffect().setEnabled(True)
             else:
-                self.setSharedRenderer(self._default_renderer)
+                self.graphicsEffect().setEnabled(False)
+                self.updateNode()
 
         # adjust link item positions when this node is moving or has changed.
-        if change == QtSvg.QGraphicsSvgItem.ItemPositionChange or change == QtSvg.QGraphicsSvgItem.ItemPositionHasChanged:
-            self.setUnsavedState()
+        if change == QtWidgets.QGraphicsItem.ItemPositionChange or change == QtWidgets.QGraphicsItem.ItemPositionHasChanged:
             for link in self._links:
                 link.adjust()
 
-        return QtGui.QGraphicsItem.itemChange(self, change, value)
+        return super().itemChange(change, value)
 
     def paint(self, painter, option, widget=None):
         """
         Paints the contents of an item in local coordinates.
 
-        :param painter: QPainter instance.
-        :param option: QStyleOptionGraphicsItem instance.
-        :param widget: QWidget instance.
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
         """
 
         # don't show the selection rectangle
-        option.state = QtGui.QStyle.State_None
-        QtSvg.QGraphicsSvgItem.paint(self, painter, option, widget)
+        if not self._settings["draw_rectangle_selected_item"]:
+            option.state = QtWidgets.QStyle.State_None
+        super().paint(painter, option, widget)
 
-#TODO: show layer position on the node
-#         # Don't draw if not activated
-#         if globals.GApp.workspace.flg_showLayerPos == False:
-#             return
-
-        if not self._initialized:
-            # Show layer level of this node
+        if not self._initialized or self.show_layer:
             brect = self.boundingRect()
-            # center = self.mapFromItem(self, brect.width() / 2.0, brect.height() / 2.0)
-
+            center = self.mapFromItem(self, brect.width() / 2.0, brect.height() / 2.0)
             painter.setBrush(QtCore.Qt.red)
             painter.setPen(QtCore.Qt.red)
-            painter.drawRect((brect.width() / 2.0) - 10, (brect.height() / 2.0) - 10, 20, 20)
+            painter.drawRect(QtCore.QRectF((brect.width() / 2.0) - 10, (brect.height() / 2.0) - 10, 20, 20))
+            painter.setPen(QtCore.Qt.black)
+            if self.show_layer:
+                text = str(int(self.zValue()))  # Z value
+            elif self._last_error:
+                text = "E"  # error
+            else:
+                text = "S"  # initialization
+            painter.drawText(QtCore.QPointF(center.x() - 4, center.y() + 4), text)
 
-            #painter.setPen(QtCore.Qt.black)
-            #painter.setFont(QtGui.QFont("TypeWriter", 14, QtGui.QFont.Bold))
-            #zval = str(int(self.zValue()))
-            #painter.drawText(QtCore.QPointF(center.x() - 4, center.y() + 4), zval)
+    def setZValue(self, value):
+        """
+        Sets a new Z value.
+
+        :param value: Z value
+        """
+
+        super().setZValue(value)
+        for link in self._links:
+            link.adjust()
+
+    def keyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        """
+
+        if event.modifiers() & QtCore.Qt.AltModifier:
+            self._allow_snap_to_grid = False
+        else:
+            super().keyPressEvent(event)
+
+    def keyReleaseEvent(self, event):
+        """
+        Handles all key release events
+
+        :param event: QKeyEvent
+        """
+
+        self._allow_snap_to_grid = True
+
+    def locked(self):
+
+        return self._locked
+
+    def setLocked(self, locked):
+        """
+        Sets the locked value.
+
+        :param value: Z value
+        """
+
+        if locked is True:
+            self.setFlag(self.ItemIsMovable, False)
+            if self._node_label:
+                self._node_label.setFlag(self.ItemIsMovable, False)
+        else:
+            self.setFlag(self.ItemIsMovable, True)
+            if self._node_label:
+                self._node_label.setFlag(self.ItemIsMovable, True)
+        for link in self._links:
+            link.adjust()
+        self._locked = locked
 
     def hoverEnterEvent(self, event):
         """
@@ -358,9 +585,8 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         """
 
         self.setCustomToolTip()
-        # dynamically change the renderer when this node item is hovered.
         if not self.isSelected():
-            self.setSharedRenderer(self._hover_renderer)
+            self.graphicsEffect().setEnabled(True)
 
     def hoverLeaveEvent(self, event):
         """
@@ -369,6 +595,13 @@ class NodeItem(QtSvg.QGraphicsSvgItem):
         :param event: QGraphicsSceneHoverEvent instance
         """
 
-        # dynamically change the renderer back to the default when this node item is not hovered anymore.
         if not self.isSelected():
-            self.setSharedRenderer(self._default_renderer)
+            self.graphicsEffect().setEnabled(False)
+
+    def mouseRelease(self):
+        """
+        Handle all mouse release for this item.
+        It the item is select but mouse is not on it the event
+        is send also
+        """
+        self.updateNode()

gns3/items/rectangle_item.py

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Graphical representation of a rectangle on the QGraphicsScene.
+"""
+
+import xml.etree.ElementTree as ET
+
+from ..qt import QtCore, QtGui, QtWidgets
+from .shape_item import ShapeItem
+
+
+class RectangleItem(QtWidgets.QGraphicsRectItem, ShapeItem):
+
+    """
+    Class to draw a rectangle on the scene.
+    """
+
+    def __init__(self, width=200, height=100, **kws):
+        self._rx = 0
+        self._ry = 0
+        super().__init__(width=width, height=height, **kws)
+
+    def setHorizontalCornerRadius(self, radius: int):
+        self._rx = radius
+
+    def horizontalCornerRadius(self):
+        return self._rx
+
+    def setVerticalCornerRadius(self, radius: int):
+        self._ry = radius
+
+    def verticalCornerRadius(self):
+        return self._ry
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        painter.setPen(self.pen())
+        painter.setBrush(self.brush())
+        painter.drawRoundedRect(self.rect(), self._rx, self._ry)
+        self.drawLayerInfo(painter)
+
+    def toSvg(self):
+        """
+        Return an SVG version of the shape
+        """
+        svg = ET.Element("svg")
+        svg.set("width", str(int(self.rect().width())))
+        svg.set("height", str(int(self.rect().height())))
+
+        rect = ET.SubElement(svg, "rect")
+        rect.set("width", str(int(self.rect().width())))
+        rect.set("height", str(int(self.rect().height())))
+        if self._rx:
+            rect.set("rx", str(self._rx))
+        if self._ry:
+            rect.set("ry", str(self._ry))
+
+        rect = self._styleSvg(rect)
+
+        return ET.tostring(svg, encoding="utf-8").decode("utf-8")
+
+    def fromSvg(self, svg):
+        svg_elem = ET.fromstring(svg)
+        if len(svg_elem):
+            # handle horizontal corner radius and vertical corner radius (specific to rectangles)
+            rx = svg_elem[0].get("rx")
+            ry = svg_elem[0].get("ry")
+            if rx:
+                self._rx = int(rx)
+            elif ry:
+                self._rx = int(ry)  # defaults to ry if it is specified
+            if ry:
+                self._ry = int(ry)
+            elif rx:
+                self._ry = int(rx)  # defaults to rx if it is specified
+        super().fromSvg(svg)

gns3/items/serial_link_item.py

@@ -20,12 +20,14 @@ Graphical representation of a Serial link on the QGraphicsScene.
 """
 
 import math
-from ..qt import QtCore, QtGui
+from ..qt import QtCore, QtGui, QtWidgets
 from .link_item import LinkItem
+from .label_item import LabelItem
 from ..ports.port import Port
 
 
 class SerialLinkItem(LinkItem):
+
     """
     Serial link for the scene.
 
@@ -35,13 +37,11 @@ class SerialLinkItem(LinkItem):
     :param destination_port: destination Port instance
     :param link: Link instance (contains back-end stuff for this link)
     :param adding_flag: indicates if this link is being added (no destination yet)
-    :param multilink: used to draw multiple link between the same source and destination
     """
 
-    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False, multilink=0):
+    def __init__(self, source_item, source_port, destination_item, destination_port, link=None, adding_flag=False):
 
-        LinkItem.__init__(self, source_item, source_port, destination_item, destination_port, link, adding_flag, multilink)
-        self.setPen(QtGui.QPen(QtCore.Qt.red, self._pen_width, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+        super().__init__(source_item, source_port, destination_item, destination_port, link, adding_flag)
 
     def adjust(self):
         """
@@ -50,6 +50,17 @@ class SerialLinkItem(LinkItem):
 
         LinkItem.adjust(self)
 
+        try:
+            if self._hovered:
+                self.setPen(QtGui.QPen(QtCore.Qt.red, self._link._link_style["width"] + 1, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+            else:
+                self.setPen(QtGui.QPen(QtGui.QColor(self._link._link_style["color"]), self._link._link_style["width"], self._link._link_style["type"], QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+        except:
+            if self._hovered:
+                self.setPen(QtGui.QPen(QtCore.Qt.red, self._pen_width + 1, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+            else:
+                self.setPen(QtGui.QPen(QtCore.Qt.darkRed, self._pen_width, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin))
+
         # get source to destination angle
         vector_angle = math.atan2(self.dy, self.dx)
 
@@ -73,8 +84,8 @@ class SerialLinkItem(LinkItem):
         scale_vect_diag = math.sqrt(scale_vect.x() ** 2 + scale_vect.y() ** 2)
         scale_coef = scale_vect_diag / 40.0
 
-        self.source = QtCore.QPointF(self.source.x() + scale_vect.x() / scale_coef, self.source.y() + scale_vect.y() / scale_coef)
-        self.destination = QtCore.QPointF(self.destination.x() - scale_vect.x() / scale_coef, self.destination.y() - scale_vect.y() / scale_coef)
+        self.source_point = QtCore.QPointF(self.source.x() + scale_vect.x() / scale_coef, self.source.y() + scale_vect.y() / scale_coef)
+        self.destination_point = QtCore.QPointF(self.destination.x() - scale_vect.x() / scale_coef, self.destination.y() - scale_vect.y() / scale_coef)
 
     def shape(self):
         """
@@ -83,11 +94,11 @@ class SerialLinkItem(LinkItem):
         :returns: QPainterPath instance
         """
 
-        path = QtGui.QGraphicsPathItem.shape(self)
+        path = QtWidgets.QGraphicsPathItem.shape(self)
         offset = self._point_size / 2
-        point = self.source
+        point = self.source_point
         path.addEllipse(point.x() - offset, point.y() - offset, self._point_size, self._point_size)
-        point = self.destination
+        point = self.destination_point
         path.addEllipse(point.x() - offset, point.y() - offset, self._point_size, self._point_size)
         return path
 
@@ -100,102 +111,75 @@ class SerialLinkItem(LinkItem):
         :param widget: QWidget instance.
         """
 
-        QtGui.QGraphicsPathItem.paint(self, painter, option, widget)
+        QtWidgets.QGraphicsPathItem.paint(self, painter, option, widget)
 
-        if not self._adding_flag and self._settings["draw_link_status_points"]:
+        if not self._adding_flag:
 
             # points disappears if nodes are too close to each others.
             if self.length < 80:
                 return
 
             # source point color
-            if self._source_port.status() == Port.started:
-                # port is active
-                color = QtCore.Qt.green
-            elif self._source_port.status() == Port.suspended:
-                # port is suspended
+            if self._link.suspended() or self._source_port.status() == Port.suspended:
+                # link or port is suspended
+                shape = QtCore.Qt.RoundCap
                 color = QtCore.Qt.yellow
+            elif self._source_port.status() == Port.started:
+                # port is active
+                shape = QtCore.Qt.RoundCap
+                color = QtCore.Qt.green
             else:
+                shape = QtCore.Qt.SquareCap
                 color = QtCore.Qt.red
 
-            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.MiterJoin))
+            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, shape, QtCore.Qt.MiterJoin))
 
-#TODO: draw port labels
-#             if globals.GApp.workspace.flg_showInterfaceNames:
-#                 if self.labelSouceIf == None:
-# 
-#                     if globals.interfaceLabels.has_key(self.source.hostname + ' ' + self.srcIf):
-#                         self.labelSouceIf = Annotation(self.source)
-#                         annotation = globals.interfaceLabels[self.source.hostname + ' ' + self.srcIf]
-#                         self.labelSouceIf.setZValue(annotation.zValue())
-#                         self.labelSouceIf.setDefaultTextColor(annotation.defaultTextColor())
-#                         self.labelSouceIf.setFont(annotation.font())
-#                         self.labelSouceIf.setPlainText(annotation.toPlainText())
-#                         self.labelSouceIf.setPos(annotation.x(), annotation.y())
-#                         self.labelSouceIf.rotation = annotation.rotation
-#                         self.labelSouceIf.rotate(annotation.rotation)
-#                         del globals.interfaceLabels[self.source.hostname + ' ' + self.srcIf]
-#                     elif not globals.GApp.workspace.flg_showOnlySavedInterfaceNames:
-#                         self.labelSouceIf = Annotation(self.source)
-#                         self.labelSouceIf.setPlainText(self.srcIf)
-#                         self.labelSouceIf.setPos(self.mapToItem(self.source, self.src))
-#                         #self.labelSouceIf.autoGenerated = True
-# 
-#                     if self.labelSouceIf:
-#                         self.labelSouceIf.deviceName = self.source.hostname
-#                         self.labelSouceIf.deviceIf = self.srcIf
-# 
-#                 if self.labelSouceIf and not self.labelSouceIf.isVisible():
-#                     self.labelSouceIf.show()
-# 
-#             elif self.labelSouceIf and globals.GApp.workspace.flg_showInterfaceNames == False:
-#                 self.labelSouceIf.hide()
+            source_port_label = self._source_port.label()
+            if source_port_label is None:
+                source_port_label = LabelItem(self._source_item)
+                source_port_label.setPlainText(self._source_port.shortName())
+                source_port_label.setPos(self.mapToItem(self._source_item, self.source))
+                self._source_port.setLabel(source_port_label)
 
-            painter.drawPoint(self.source)
-            #painter.drawPoint(self.source)
+            if self._draw_port_labels:
+                source_port_label.setFlag(source_port_label.ItemIsMovable, not self._source_item.locked())
+                source_port_label.show()
+            else:
+                source_port_label.hide()
+
+            if self._settings["draw_link_status_points"] and self.pen().style() != QtCore.Qt.NoPen:
+                painter.drawPoint(self.source_point)
 
             # destination point color
-            if self._destination_port.status() == Port.started:
+            if self._link.suspended() or self._destination_port.status() == Port.suspended:
+                # link or port is suspended
+                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
+            elif self._destination_port.status() == Port.started:
                 # port is active
                 color = QtCore.Qt.green
-            elif self._destination_port.status() == Port.suspended:
-                # port is suspended
-                color = QtCore.Qt.yellow
+                shape = QtCore.Qt.RoundCap
             else:
                 color = QtCore.Qt.red
+                shape = QtCore.Qt.SquareCap
 
-            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.MiterJoin))
+            painter.setPen(QtGui.QPen(color, self._point_size, QtCore.Qt.SolidLine, shape, QtCore.Qt.MiterJoin))
 
-#TODO: draw port labels
-#             if globals.GApp.workspace.flg_showInterfaceNames:
-#                 if self.labelDestIf  == None:
-# 
-#                     if globals.interfaceLabels.has_key(self.dest.hostname + ' ' + self.destIf):
-#                         self.labelDestIf = Annotation(self.dest)
-#                         annotation = globals.interfaceLabels[self.dest.hostname + ' ' + self.destIf]
-#                         self.labelDestIf.setZValue(annotation.zValue())
-#                         self.labelDestIf.setDefaultTextColor(annotation.defaultTextColor())
-#                         self.labelDestIf.setFont(annotation.font())
-#                         self.labelDestIf.setPlainText(annotation.toPlainText())
-#                         self.labelDestIf.setPos(annotation.x(), annotation.y())
-#                         self.labelDestIf.rotation = annotation.rotation
-#                         self.labelDestIf.rotate(annotation.rotation)
-#                         del globals.interfaceLabels[self.dest.hostname + ' ' + self.destIf]
-#                     elif not globals.GApp.workspace.flg_showOnlySavedInterfaceNames:
-#                         self.labelDestIf = Annotation(self.dest)
-#                         self.labelDestIf.setPlainText(self.destIf)
-#                         self.labelDestIf.setPos(self.mapToItem(self.dest, self.dst))
-#                         #self.labelDestIf.autoGenerated = True
-# 
-#                     if self.labelDestIf:
-#                         self.labelDestIf.deviceName = self.dest.hostname
-#                         self.labelDestIf.deviceIf = self.destIf
-# 
-#                 if self.labelDestIf and not self.labelDestIf.isVisible():
-#                     self.labelDestIf.show()
-# 
-# 
-#             elif self.labelDestIf and globals.GApp.workspace.flg_showInterfaceNames == False:
-#                 self.labelDestIf.hide()
+            destination_port_label = self._destination_port.label()
 
-            painter.drawPoint(self.destination)
+            if destination_port_label is None:
+                destination_port_label = LabelItem(self._destination_item)
+                destination_port_label.setPlainText(self._destination_port.shortName())
+                destination_port_label.setPos(self.mapToItem(self._destination_item, self.destination))
+                self._destination_port.setLabel(destination_port_label)
+
+            if self._draw_port_labels:
+                destination_port_label.setFlag(destination_port_label.ItemIsMovable, not self._destination_item.locked())
+                destination_port_label.show()
+            else:
+                destination_port_label.hide()
+
+            if self._settings["draw_link_status_points"] and self.pen().style() != QtCore.Qt.NoPen:
+                painter.drawPoint(self.destination_point)
+
+        self._drawSymbol()

gns3/items/shape_item.py

@@ -0,0 +1,205 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Base class for shape items (Rectangle, ellipse etc.).
+"""
+
+import xml.etree.ElementTree as ET
+from ..qt import QtCore, QtGui, QtWidgets
+from .drawing_item import DrawingItem
+from .utils import colorFromSvg
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ShapeItem(DrawingItem):
+
+    """
+    Base class to draw shapes on the scene.
+    """
+
+    def __init__(self, width=200, height=200, svg=None, **kws):
+
+        super().__init__(svg=svg, **kws)
+        self.setAcceptHoverEvents(True)
+        self._border = 5
+        self._edge = None
+        self._originally_movable = True
+
+        if svg is None:
+            self.setRect(0, 0, width, height)
+            pen = QtGui.QPen(QtCore.Qt.black, 2, QtCore.Qt.SolidLine, QtCore.Qt.RoundCap, QtCore.Qt.RoundJoin)
+            self.setPen(pen)
+            brush = QtGui.QBrush(QtGui.QColor(255, 255, 255, 255))  # default color is white and not transparent
+            self.setBrush(brush)
+        else:
+            self.fromSvg(svg)
+        if self._id is None:
+            self.create()
+
+    def mousePressEvent(self, event):
+        """
+        Handles all mouse press events.
+
+        :param event: QMouseEvent instance
+        """
+
+        self.update()
+        self._originally_movable = self.flags() & QtWidgets.QGraphicsItem.ItemIsMovable
+        if event.pos().x() > (self.rect().right() - self._border):
+            self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+            self._edge = "right"
+
+        elif event.pos().x() < (self.rect().left() + self._border):
+            self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+            self._edge = "left"
+
+        elif event.pos().y() < (self.rect().top() + self._border):
+            self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+            self._edge = "top"
+
+        elif event.pos().y() > (self.rect().bottom() - self._border):
+            self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, False)
+            self._edge = "bottom"
+        QtWidgets.QGraphicsItem.mousePressEvent(self, event)
+
+    def mouseReleaseEvent(self, event):
+        """
+        Handles all mouse release events.
+
+        :param: QMouseEvent instance
+        """
+
+        self.update()
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsMovable, self._originally_movable)
+        self._edge = None
+        QtWidgets.QGraphicsItem.mouseReleaseEvent(self, event)
+
+    def mouseMoveEvent(self, event):
+        """
+        Handles all mouse move events.
+
+        :param event: QMouseEvent instance
+        """
+
+        self.update()
+        if self._edge:
+            r = self.rect()
+            scenePos = event.scenePos()
+
+            if self._edge == "top":
+                diff = self.y() - scenePos.y()
+                if r.height() - diff > 0:
+                    self.setPos(self.x(), scenePos.y())
+                    self.setRect(0, 0, self.rect().width(), self.rect().height() + diff)
+                else:
+                    self._edge = "bottom"
+                    self.setPos(self.x(), self.y() + self.rect().height())
+                    self.setRect(0, 0, self.rect().width(), diff - self.rect().height())
+            elif self._edge == "left":
+                diff = self.x() - scenePos.x()
+                if r.width() - diff > 0:
+                    self.setPos(scenePos.x(), self.y())
+                    self.setRect(0, 0, r.width() + diff, self.rect().height())
+                else:
+                    self._edge = "right"
+                    self.setPos(self.x() + self.rect().width(), self.y())
+                    self.setRect(0, 0, diff - self.rect().width(), self.rect().height())
+            elif self._edge == "bottom":
+                if r.height() > 0:
+                    pos = self.mapFromScene(scenePos)
+                    self.setRect(0, 0, self.rect().width(), pos.y())
+                else:
+                    self.setRect(0, 0, self.rect().width(), abs(scenePos.y() - self.y()))
+                    self.setPos(self.x(), scenePos.y())
+                    self._edge = "top"
+            elif self._edge == "right":
+                if r.width() > 0:
+                    pos = self.mapFromScene(scenePos)
+                    self.setRect(0, 0, pos.x(), self.rect().height())
+                else:
+                    self.setRect(0, 0, abs(scenePos.x() - self.x()), self.rect().height())
+                    self.setPos(scenePos.x(), self.y())
+                    self._edge = "left"
+
+        QtWidgets.QGraphicsItem.mouseMoveEvent(self, event)
+
+    def hoverMoveEvent(self, event):
+        """
+        Handles all hover move events.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        # locked objects don't need cursors
+        if not self.locked():
+            if event.pos().x() > (self.rect().right() - self._border):
+                self._graphics_view.setCursor(QtCore.Qt.SizeHorCursor)
+            elif event.pos().x() < (self.rect().left() + self._border):
+                self._graphics_view.setCursor(QtCore.Qt.SizeHorCursor)
+            elif event.pos().y() < (self.rect().top() + self._border):
+                self._graphics_view.setCursor(QtCore.Qt.SizeVerCursor)
+            elif event.pos().y() > (self.rect().bottom() - self._border):
+                self._graphics_view.setCursor(QtCore.Qt.SizeVerCursor)
+            else:
+                self._graphics_view.setCursor(QtCore.Qt.SizeAllCursor)
+
+    def hoverLeaveEvent(self, event):
+        """
+        Handles all hover leave events.
+
+        :param event: QGraphicsSceneHoverEvent instance
+        """
+
+        # locked objects don't need cursors
+        if not self.locked():
+            self._graphics_view.setCursor(QtCore.Qt.ArrowCursor)
+
+    def setWidthAndHeight(self, width, height):
+        self.setRect(0, 0, width, height)
+
+    def fromSvg(self, svg):
+        """
+        Import element information from SVG
+        """
+        svg = ET.fromstring(svg)
+        width = float(svg.get("width", self.rect().width()))
+        height = float(svg.get("height", self.rect().height()))
+        self.setRect(0, 0, width, height)
+
+        pen = QtGui.QPen()
+        brush = QtGui.QBrush(QtCore.Qt.SolidPattern)
+
+        if len(svg):
+            pen = self._penFromSVGElement(svg[0])
+            if svg[0].get("fill"):
+                new_color = colorFromSvg(svg[0].get("fill"))
+                color = brush.color()
+                color.setBlue(new_color.blue())
+                color.setRed(new_color.red())
+                color.setGreen(new_color.green())
+                brush.setColor(color)
+            if svg[0].get("fill-opacity"):
+                color = brush.color()
+                color.setAlphaF(float(svg[0].get("fill-opacity")))
+                brush.setColor(color)
+
+        self.setPen(pen)
+        self.setBrush(brush)
+        self.update()

gns3/items/text_item.py

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 xml.etree.ElementTree as ET
+
+from ..qt import QtCore, QtWidgets, QtGui
+from .drawing_item import DrawingItem
+from .utils import colorFromSvg
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class TextItem(QtWidgets.QGraphicsTextItem, DrawingItem):
+    """
+    Text item for the QGraphicsView.
+    """
+
+    def __init__(self, svg=None, **kws):
+
+        super().__init__(**kws)
+
+        from ..main_window import MainWindow
+
+        main_window = MainWindow.instance()
+        view_settings = main_window.uiGraphicsView.settings()
+        qt_font = QtGui.QFont()
+        qt_font.fromString(view_settings["default_note_font"])
+        self.setDefaultTextColor(QtGui.QColor(view_settings["default_note_color"]))
+        self.setFont(qt_font)
+
+        if svg:
+            try:
+                svg = self.fromSvg(svg)
+            except ET.ParseError as e:
+                log.warning(str(e))
+
+        # re-evaluate `z` position after creation
+        if 'z' in kws.keys():
+            self.setZValue(kws['z'])
+
+        if self._id is None:
+            self.create()
+
+    def editText(self):
+        """
+        Edit mode for this note.
+        """
+
+        self.setTextInteractionFlags(QtCore.Qt.TextEditorInteraction)
+        self.setSelected(True)
+        self.setFocus()
+        cursor = self.textCursor()
+        cursor.select(QtGui.QTextCursor.Document)
+        self.setTextCursor(cursor)
+
+    def mouseDoubleClickEvent(self, event):
+        """
+        Handles all mouse double click events.
+
+        :param event: QMouseEvent instance
+        """
+
+        self.editText()
+
+    def focusOutEvent(self, event):
+        """
+        Handles all focus out events.
+
+        :param event: QFocusEvent instance
+        """
+
+        self.setFlag(QtWidgets.QGraphicsItem.ItemIsFocusable, False)
+        cursor = self.textCursor()
+        if cursor.hasSelection():
+            cursor.clearSelection()
+            self.setTextCursor(cursor)
+        self.setTextInteractionFlags(QtCore.Qt.NoTextInteraction)
+        if not self.toPlainText():
+            # delete the note if empty
+            self.delete()
+            return
+        else:
+            self.updateDrawing()
+        return super().focusOutEvent(event)
+
+    def paint(self, painter, option, widget=None):
+        """
+        Paints the contents of an item in local coordinates.
+
+        :param painter: QPainter instance
+        :param option: QStyleOptionGraphicsItem instance
+        :param widget: QWidget instance
+        """
+
+        super().paint(painter, option, widget)
+        self.drawLayerInfo(painter)
+
+    def toSvg(self):
+        """
+        Return an SVG version of the text
+        """
+        svg = ET.Element("svg")
+        svg.set("width", str(int(self.boundingRect().width())))
+        svg.set("height", str(int(self.boundingRect().height())))
+
+        text = ET.SubElement(svg, "text")
+        text.set("font-family", self.font().family())
+        text.set("font-size", str(self.font().pointSizeF()))
+        if self.font().italic():
+            text.set("font-style", "italic")
+        if self.font().bold():
+            text.set("font-weight", "bold")
+        if self.font().strikeOut():
+            text.set("text-decoration", "line-through")
+        elif self.font().underline():
+            text.set("text-decoration", "underline")
+        text.set("fill", "#" + hex(self.defaultTextColor().rgba())[4:])
+        text.set("fill-opacity", str(self.defaultTextColor().alphaF()))
+        text.text = self.toPlainText()
+
+        svg = ET.tostring(svg, encoding="utf-8").decode("utf-8")
+        return svg
+
+    def fromSvg(self, svg):
+
+        # sometimes we receive \0 at the end of string inside <svg> element
+        try:
+            svg = svg.replace("\u0000", "")
+        except AttributeError:
+            pass
+
+        try:
+            svg = ET.fromstring(svg)
+        except ET.ParseError:
+            self.setPlainText("Unable to parse `text_item`")
+            return
+
+        text = svg[0]
+
+        font = QtGui.QFont()
+        color = text.get("fill")
+        if color:
+            new_color = colorFromSvg(color)
+            color = self.defaultTextColor()
+            color.setBlue(new_color.blue())
+            color.setRed(new_color.red())
+            color.setGreen(new_color.green())
+            self.setDefaultTextColor(color)
+
+        opacity = text.get("fill-opacity")
+        if opacity:
+            color = self.defaultTextColor()
+            color.setAlphaF(float(opacity))
+            self.setDefaultTextColor(color)
+
+        font.setPointSizeF(float(text.get("font-size", self.font().pointSizeF())))
+        font.setFamily(text.get("font-family", self.font().family()))
+        if text.get("font-style") == "italic":
+            font.setItalic(True)
+        if text.get("font-weight") == "bold":
+            font.setBold(True)
+        if text.get("text-decoration") == "underline":
+            font.setUnderline(True)
+        if text.get("text-decoration") == "line-through":
+            font.setStrikeOut(True)
+
+        self.setFont(font)
+        self.setPlainText(text.text)
+
+    def editable(self):
+        """
+        Returns either the note is editable or not.
+
+        :return: boolean
+        """
+
+        return True
+
+    def keyPressEvent(self, event):
+        """
+        Handles all key press events
+
+        :param event: QKeyEvent
+        """
+
+        if not self.handleKeyPressEvent(event):
+            super().keyPressEvent(event)

gns3/items/utils.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+from ..qt import QtGui
+
+
+def colorFromSvg(value):
+    """
+    Transform a color coming from a SVG file to a Qcolor
+    """
+    value = value.strip('#')
+    if value == "":
+        value = "000000"
+    if len(value) == 6:  # If alpha channel is missing
+        value = "ff" + value
+    value = int(value, base=16)
+    return QtGui.QColor.fromRgba(value)

gns3/jsonrpc.py

@@ -1,184 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2013 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/>.
-
-"""
-JSON-RPC protocol implementation.
-http://www.jsonrpc.org/specification
-"""
-
-import json
-import uuid
-
-
-class JSONRPCObject(object):
-    """
-    Base object for JSON-RPC requests, responses,
-    notifications and errors.
-    """
-
-    def __init__(self):
-        return JSONRPCEncoder().default(self)
-
-    def __str__(self, *args, **kwargs):
-        return json.dumps(self, cls=JSONRPCEncoder)
-
-    def __call__(self):
-        return JSONRPCEncoder().default(self)
-
-
-class JSONRPCEncoder(json.JSONEncoder):
-    """
-    Creates the JSON-RPC message.
-    """
-
-    def default(self, obj):
-        """
-        Returns a Python dictionary corresponding to a JSON-RPC message.
-        """
-
-        if isinstance(obj, JSONRPCObject):
-            message = {"jsonrpc": 2.0}
-            for field in dir(obj):
-                if not field.startswith('_'):
-                    value = getattr(obj, field)
-                    message[field] = value
-            return message
-        return json.JSONEncoder.default(self, obj)
-
-
-class JSONRPCInvalidRequest(JSONRPCObject):
-    """
-    Error response for an invalid request.
-    """
-
-    def __init__(self):
-        JSONRPCObject.__init__(self)
-        self.id = None
-        self.error = {"code": -32600, "message": "Invalid Request"}
-
-
-class JSONRPCMethodNotFound(JSONRPCObject):
-    """
-    Error response for an method not found.
-
-    :param request_id: JSON-RPC identifier
-    """
-
-    def __init__(self, request_id):
-        JSONRPCObject.__init__(self)
-        self.id = request_id
-        self.error = {"code": -32601, "message": "Method not found"}
-
-
-class JSONRPCInvalidParams(JSONRPCObject):
-    """
-    Error response for invalid parameters.
-
-    :param request_id: JSON-RPC identifier
-    """
-
-    def __init__(self, request_id):
-        JSONRPCObject.__init__(self)
-        self.id = request_id
-        self.error = {"code": -32602, "message": "Invalid params"}
-
-
-class JSONRPCInternalError(JSONRPCObject):
-    """
-    Error response for an internal error.
-
-    :param request_id: JSON-RPC identifier (optional)
-    """
-
-    def __init__(self, request_id=None):
-        JSONRPCObject.__init__(self)
-        self.id = request_id
-        self.error = {"code": -32603, "message": "Internal error"}
-
-
-class JSONRPCParseError(JSONRPCObject):
-    """
-    Error response for parsing error.
-    """
-
-    def __init__(self):
-        JSONRPCObject.__init__(self)
-        self.id = None
-        self.error = {"code": -32700, "message": "Parse error"}
-
-
-class JSONRPCCustomError(JSONRPCObject):
-    """
-    Error response for an custom error.
-
-    :param code: JSON-RPC error code
-    :param message: JSON-RPC error message
-    :param request_id: JSON-RPC identifier (optional)
-    """
-
-    def __init__(self, code, message, request_id=None):
-        JSONRPCObject.__init__(self)
-        self.id = request_id
-        self.error = {"code": code, "message": message}
-
-
-class JSONRPCResponse(JSONRPCObject):
-    """
-    JSON-RPC successful response.
-
-    :param result: JSON-RPC result
-    :param request_id: JSON-RPC identifier
-    """
-
-    def __init__(self, result, request_id):
-        JSONRPCObject.__init__(self)
-        self.id = request_id
-        self.result = result
-
-
-class JSONRPCRequest(JSONRPCObject):
-    """
-    JSON-RPC request.
-
-    :param method: JSON-RPC destination method
-    :param params: JSON-RPC params for the corresponding method (optional)
-    :param request_id: JSON-RPC identifier (generated by default)
-    """
-
-    def __init__(self, method, params=None, request_id=None):
-        JSONRPCObject.__init__(self)
-        if request_id == None:
-            request_id = str(uuid.uuid4())
-        self.id = request_id
-        self.method = method
-        if params:
-            self.params = params
-
-
-class JSONRPCNotification(JSONRPCObject):
-    """
-    JSON-RPC notification.
-
-    :param method: JSON-RPC destination method
-    :param params: JSON-RPC params for the corresponding method (optional)
-    """
-
-    def __init__(self, method, params=None):
-        JSONRPCObject.__init__(self)
-        self.method = method
-        if params:
-            self.params = params

gns3/link.py

@@ -19,15 +19,20 @@
 Manages and stores everything needed for a connection between 2 devices.
 """
 
+import re
+from .qt import sip
+import uuid
 
 from .qt import QtCore
-from .nios.nio_udp import NIOUDP
+from .controller import Controller
+
 
 import logging
 log = logging.getLogger(__name__)
 
 
 class Link(QtCore.QObject):
+
     """
     Link implementation.
 
@@ -35,24 +40,28 @@ class Link(QtCore.QObject):
     :param source_port: source Port instance
     :param destination_node: destination Node instance
     :param destination_port: destination Port instance
-    :param stub: indicates if the link is connected to a stub device like a Cloud
     """
 
     # signals used to let the GUI view know about link
     # additions and deletions.
     add_link_signal = QtCore.Signal(int)
     delete_link_signal = QtCore.Signal(int)
+    updated_link_signal = QtCore.Signal(int)
+    error_link_signal = QtCore.Signal(int)
 
     _instance_count = 1
 
-    def __init__(self, source_node, source_port, destination_node, destination_port):
+    def __init__(self, source_node, source_port, destination_node, destination_port, link_id=None, **link_data):
+        """
+        :param link_data: Link information from the API
+        """
 
-        super(Link, self).__init__()
+        super().__init__()
 
-        log.info("adding link from {} {} to {} {}".format(source_node.name(),
-                                                          source_port.name(),
-                                                          destination_node.name(),
-                                                          destination_port.name()))
+        log.debug("adding link from {} {} to {} {}".format(source_node.name(),
+                                                           source_port.name(),
+                                                           destination_node.name(),
+                                                           destination_port.name()))
 
         # create an unique ID
         self._id = Link._instance_count
@@ -62,59 +71,212 @@ class Link(QtCore.QObject):
         self._source_port = source_port
         self._destination_node = destination_node
         self._destination_port = destination_port
-        self._source_nio = None
-        self._destination_nio = None
-        self._source_nio_active = False
-        self._destination_nio_active = False
+        self._source_label = None
+        self._destination_label = None
+        self._link_id = link_id
+        self._capturing = False
+        self._deleting = False
+        self._capture_file_path = None
+        self._capture_file = None
+        self._response_stream = None
+        self._capture_compute_id = None
+        self._initialized = False
+        self._filters = {}
+        self._suspend = False
 
-        # add a link description
-        self._description = "Link from {} port {} to {} port {}".format(self._source_node.name(),
-                                                                        self._source_port.name(),
-                                                                        self._destination_node.name(),
-                                                                        self._destination_port.name())
+        # Boolean if True we are creating the first instance of this node
+        # if false the node already exist in the topology
+        # use to avoid erasing information when reloading
+        self._creator = False
 
-        if source_port.isStub() or destination_port.isStub():
-            self._stub = True
+        self._nodes = []
+        self._link_style = {}
+
+        body = self._prepareParams()
+        if self._link_id:
+            link_data["link_id"] = self._link_id
+            self._linkCreatedCallback(link_data)
         else:
-            self._stub = False
+            self._link_id = str(uuid.uuid4())
+            self._creator = True
+            Controller.instance().post("/projects/{project_id}/links".format(project_id=source_node.project().id()), self._linkCreatedCallback, body=body)
 
-        # we must request UDP information if the NIO is a NIO UDP and before
-        # it can be created.
-        if not self._stub:
+    def _parseResponse(self, result):
 
-            # connect signals used when a NIO has been created by a node
-            # and this NIO need to be attached to a port connected to this link
-            source_node.nio_signal.connect(self.newNIOSlot)
-            destination_node.nio_signal.connect(self.newNIOSlot)
-
-            # currently, we support only NIO_UDP for normal connections (non-stub).
-            if not source_port.defaultNio() == NIOUDP:
-                raise NotImplementedError()
-
-            self._source_udp = None
-            self._destination_udp = None
-
-            # connect signals used to receive a UDP port and host allocated by a node
-            source_node.allocate_udp_nio_signal.connect(self.UDPPortAllocatedSlot)
-            destination_node.allocate_udp_nio_signal.connect(self.UDPPortAllocatedSlot)
-
-            # request the UDP info for each node
-            source_node.allocateUDPPort(self._source_port.id())
-            destination_node.allocateUDPPort(self._destination_port.id())
+        self._capturing = result.get("capturing", False)
+        if self._capturing:
+            self._capture_compute_id = result.get("capture_compute_id", None)
+            self._capture_file_path = result.get("capture_file_path", None)
+            if Controller.instance().isRemote() or (self._capture_compute_id and self._capture_compute_id != "local"):
+                # We need to stream the pcap file content if the controller or compute is remote
+                if Controller.instance().isRemote() or self._capture_file_path is None:
+                    self._capture_file = QtCore.QTemporaryFile()
+                    self._capture_file.open(QtCore.QFile.WriteOnly)
+                    self._capture_file.setAutoRemove(True)
+                    self._capture_file_path = self._capture_file.fileName()
+                else:
+                    self._capture_file = QtCore.QFile(self._capture_file_path)
+                    self._capture_file.open(QtCore.QFile.WriteOnly)
+                self._response_stream = Controller.instance().get("/projects/{project_id}/links/{link_id}/pcap".format(project_id=self.project().id(), link_id=self._link_id),
+                                                                  None,
+                                                                  showProgress=False,
+                                                                  downloadProgressCallback=self._downloadPcapProgress,
+                                                                  ignoreErrors=True,  # If something is wrong avoid disconnect us from server
+                                                                  timeout=None)
+            log.debug("Has successfully started capturing packets on link {} to '{}'".format(self._link_id, self._capture_file_path))
         else:
-            # handle stub connections (to a cloud for instance).
-            if not source_port.isStub() and destination_port.isStub():
-                source_node.nio_signal.connect(self.newNIOSlot)
-                self._source_nio = self._destination_port.defaultNio()
-                self._source_node.nio_cancel_signal.connect(self.cancelNIOSlot)
-                self._source_node.addNIO(self._source_port, self._source_nio)
-            elif not destination_port.isStub() and source_port.isStub():
-                destination_node.nio_signal.connect(self.newNIOSlot)
-                self._destination_nio = self._source_port.defaultNio()
-                self._destination_node.nio_cancel_signal.connect(self.cancelNIOSlot)
-                self._destination_node.addNIO(self._destination_port, self._destination_nio)
+            self._response_stream = None
+
+        if "nodes" in result:
+            self._nodes = result["nodes"]
+            self._updateLabels()
+        if "filters" in result:
+            self._filters = result["filters"]
+        if "link_style" in result:
+            self._link_style = result["link_style"]
+        if "suspend" in result:
+            self._suspend = result["suspend"]
+        self.updated_link_signal.emit(self._id)
+
+    def creator(self):
+        return self._creator
+
+    def suspended(self):
+        return self._suspend
+
+    def toggleSuspend(self):
+        self._suspend = not self._suspend
+        self.update()
+
+    def initialized(self):
+        return self._initialized
+
+    def addPortLabel(self, port, label):
+        if port.adapterNumber() == self._source_port.adapterNumber() and port.portNumber() == self._source_port.portNumber() and port.destinationNode() == self._destination_node:
+            self._source_label = label
+        else:
+            self._destination_label = label
+        label.item_unselected_signal.connect(self.update)
+        if self.creator():
+            self.update()
+        else:
+            self._updateLabels()
+
+    def update(self):
+        if not self._link_id or self.deleting():
+            return
+        body = self._prepareParams()
+        Controller.instance().put("/projects/{project_id}/links/{link_id}".format(project_id=self._source_node.project().id(), link_id=self._link_id), self.updateLinkCallback, body=body)
+
+    def listAvailableFilters(self, callback):
+        """
+        Get the list of available filters
+        """
+        Controller.instance().get("/projects/{project_id}/links/{link_id}/available_filters".format(project_id=self._source_node.project().id(), link_id=self._link_id), callback)
+
+    def updateLinkCallback(self, result, error=False, *args, **kwargs):
+        if error:
+            log.warning("Error while updating link: {}".format(result["message"]))
+            return
+        self._parseResponse(result)
+
+    def _updateLabels(self):
+        for node in self._nodes:
+            if node["node_id"] == self._source_node.node_id() and node["adapter_number"] == self._source_port.adapterNumber() and node["port_number"] == self._source_port.portNumber():
+                self._updateLabel(self._source_label, node["label"])
+            elif node["node_id"] == self._destination_node.node_id() and node["adapter_number"] == self._destination_port.adapterNumber() and node["port_number"] == self._destination_port.portNumber():
+                self._updateLabel(self._destination_label, node["label"])
             else:
-                log.error("both ports are stub!")
+                raise NotImplementedError
+
+    def _updateLabel(self, label, label_data):
+        if not label or sip.isdeleted(label):
+            return
+        if "text" in label_data:
+            label.setPlainText(label_data["text"])
+        if "x" in label_data and "y" in label_data:
+            label.setPos(label_data["x"], label_data["y"])
+        if "style" in label_data:
+            label.setStyle(label_data["style"])
+        if "rotation" in label_data:
+            label.setRotation(label_data["rotation"])
+
+    def _prepareParams(self):
+        body = {
+            "nodes": [
+                {
+                    "node_id": self._source_node.node_id(),
+                    "adapter_number": self._source_port.adapterNumber(),
+                    "port_number": self._source_port.portNumber(),
+                },
+                {
+                    "node_id": self._destination_node.node_id(),
+                    "adapter_number": self._destination_port.adapterNumber(),
+                    "port_number": self._destination_port.portNumber()
+                }
+            ],
+            "filters": self._filters,
+            "link_style": self._link_style,
+            "suspend": self._suspend
+        }
+        if self._source_port.label():
+            body["nodes"][0]["label"] = self._source_port.label().dump()
+        if self._destination_port.label():
+            body["nodes"][1]["label"] = self._destination_port.label().dump()
+        return body
+
+    def _linkCreatedCallback(self, result, error=False, **kwargs):
+        if error:
+            log.warning("Error while creating link: {}".format(result["message"]))
+            self.deleteLink(skip_controller=True)
+            return
+
+        self._initialized = True
+
+        # let the GUI know about this link has been created
+        self.add_link_signal.emit(self._id)
+        self._source_port.setLinkId(self._id)
+        self._source_port.setLink(self)
+        self._source_port.setDestinationNode(self._destination_node)
+        self._source_port.setDestinationPort(self._destination_port)
+        self._destination_port.setLinkId(self._id)
+        self._destination_port.setLink(self)
+        self._destination_port.setDestinationNode(self._source_node)
+        self._destination_port.setDestinationPort(self._source_port)
+
+        self._link_id = result["link_id"]
+        self._parseResponse(result)
+
+    def link_id(self):
+        return self._link_id
+
+    def deleting(self):
+        """
+        Is the link being deleted
+        """
+        return self._deleting
+
+    def setDeleting(self):
+        """
+        Mark this link as being deleted
+        """
+
+        self._deleting = True
+
+    def capturing(self):
+        """
+        Is a capture running on the link?
+        """
+        return self._capturing
+
+    def capture_file_path(self):
+        """
+        Path of the capture file
+        """
+        return self._capture_file_path
+
+    def project(self):
+        return self._source_node.project()
 
     @classmethod
     def reset(cls):
@@ -124,27 +286,125 @@ class Link(QtCore.QObject):
 
         cls._instance_count = 1
 
-    def deleteLink(self):
+    def __str__(self):
+
+        description = "Link from {} port {} to {} port {}".format(self._source_node.name(),
+                                                                  self._source_port.name(),
+                                                                  self._destination_node.name(),
+                                                                  self._destination_port.name())
+
+        if self.capturing():
+            description += "\nPacket capture is active"
+
+        for filter_type in self._filters.keys():
+            description += "\nPacket filter '{}' is active".format(filter_type)
+
+        return description
+
+    def capture_file_name(self):
+        """
+        :returns: File name for a capture on this link
+        """
+        capture_file_name = "{}_{}_to_{}_{}".format(
+            self._source_node.name(),
+            self._source_port.name(),
+            self._destination_node.name(),
+            self._destination_port.name())
+        return re.sub(r"[^0-9A-Za-z_-]", "", capture_file_name)
+
+    def deleteLink(self, skip_controller=False):
         """
         Deletes this link.
         """
 
-        log.info("deleting link from {} {} to {} {}".format(self._source_node.name(),
-                                                            self._source_port.name(),
-                                                            self._destination_node.name(),
-                                                            self._destination_port.name()))
+        log.debug("deleting link from {} {} to {} {}".format(self._source_node.name(),
+                                                             self._source_port.name(),
+                                                             self._destination_node.name(),
+                                                             self._destination_port.name()))
+
+        if skip_controller:
+            self._linkDeletedCallback({})
+        else:
+            self.setDeleting()
+            Controller.instance().delete("/projects/{project_id}/links/{link_id}".format(project_id=self.project().id(),
+                                                                                         link_id=self._link_id),
+                                                                                         self._linkDeletedCallback)
+
+    def _linkDeletedCallback(self, result, error=False, **kwargs):
+        """
+        Called after the link is remove from the topology
+        """
+        if error:
+            log.error("Error while deleting link: {}".format(result["message"]))
+            return
 
-        # delete the NIOs on both source and destination nodes
-        self._source_node.deleteNIO(self._source_port)
         self._source_port.setFree()
+        self._source_node.deleteLink(self)
         self._source_node.updated_signal.emit()
-        self._destination_node.deleteNIO(self._destination_port)
         self._destination_port.setFree()
+        self._destination_node.deleteLink(self)
         self._destination_node.updated_signal.emit()
 
         # let the GUI know about this link has been deleted
         self.delete_link_signal.emit(self._id)
 
+    def startCapture(self, data_link_type, capture_file_name):
+        data = {
+            "capture_file_name": capture_file_name,
+            "data_link_type": data_link_type
+        }
+        Controller.instance().post("/projects/{project_id}/links/{link_id}/start_capture".format(project_id=self.project().id(), link_id=self._link_id),
+                                   self._startCaptureCallback,
+                                   body=data)
+
+    def _startCaptureCallback(self, result, error=False, **kwargs):
+        if error:
+            log.error("Error while starting capture on link {}: {}".format(self._link_id, result["message"]))
+            return
+
+    def _downloadPcapProgress(self, content, server=None, context={}, **kwargs):
+        """
+        Called for each part of the file of the PCAP
+        """
+
+        if not self._capture_file_path:
+            return
+        self._capture_file.write(content)
+        self._capture_file.flush()
+
+    def stopCapture(self):
+
+        if Controller.instance().isRemote() or (self._capture_compute_id and self._capture_compute_id != "local"):
+            if self._capture_file:
+                self._capture_file.close()
+                self._capture_file = None
+            # if self._capture_file_path and os.path.exists(self._capture_file_path):
+            #     try:
+            #         os.remove(self._capture_file_path)
+            #     except OSError as e:
+            #         log.error("Cannot remove file {}: {}".format(self._capture_file_path, e))
+        self._capture_file_path = None
+        Controller.instance().post("/projects/{project_id}/links/{link_id}/stop_capture".format(project_id=self.project().id(),
+                                                                                                link_id=self._link_id),
+                                                                                                self._stopCaptureCallback)
+
+
+    def _stopCaptureCallback(self, result, error=False, **kwargs):
+        if error:
+            log.error("Error while stopping capture on link {}: {}".format(self._link_id, result["message"]))
+            return
+        log.debug("Has successfully stopped capturing packets on link {}".format(self._link_id))
+
+    def get(self, path, callback, **kwargs):
+        """
+        HTTP Get from a link
+        """
+        Controller.instance().get("/projects/{project_id}/links/{link_id}{path}".format(project_id=self.project().id(),
+                                                                                        link_id=self._link_id,
+                                                                                        path=path),
+                                  callback,
+                                  **kwargs)
+
     def id(self):
         """
         Returns this link identifier.
@@ -154,210 +414,66 @@ class Link(QtCore.QObject):
 
         return self._id
 
-    def UDPPortAllocatedSlot(self, node_id, port_id, lport):
+    def sourceNode(self):
         """
-        Slot to receive events from Node instances
-        when a UDP port has been allocated in order to create a NIO UDP.
+        Returns the source node for this link.
 
-        :param node_id: node identifier
-        :param port_id: port identifier
-        :param lport: local UDP port
+        :returns: Node instance
         """
 
-        # check that the node is connected to this link as a source
-        if node_id == self._source_node.id() and port_id == self._source_port.id():
-            laddr = self._source_node.server().host
-            self._source_udp = (lport, laddr)
-            # disconnect the signal has we don't expect new source UDP info for this link.
-            self._source_node.allocate_udp_nio_signal.disconnect(self.UDPPortAllocatedSlot)
+        return self._source_node
 
-            log.debug("{} has allocated UDP port {} for host {}".format(self._source_node.name(),
-                                                                        lport,
-                                                                        laddr))
-
-        # check that the node is connected to this link as a destination
-        elif node_id == self._destination_node.id() and port_id == self._destination_port.id():
-            laddr = self._destination_node.server().host
-            self._destination_udp = (lport, laddr)
-            # disconnect the signal has we don't expect new source UDP info for this link.
-            self._destination_node.allocate_udp_nio_signal.disconnect(self.UDPPortAllocatedSlot)
-
-            log.debug("{} has allocated UDP port {} for host {}".format(self._destination_node.name(),
-                                                                        lport,
-                                                                        laddr))
-
-        if self._source_udp and self._destination_udp:
-
-            # we got UDP info from both source and destination nodes
-            # meaning we can proceed with the creation of UDP NIOs
-            lport, laddr = self._source_udp
-            rport, raddr = self._destination_udp
-
-            #TODO: check address compatibility? for instance 127.0.0.1 <-> 83.15.12.2 isn't likely gonna work.
-            self._source_nio = NIOUDP(lport, raddr, rport)
-            self._destination_nio = NIOUDP(rport, laddr, lport)
-
-            self._source_udp = None
-            self._destination_udp = None
-
-            log.debug("creating UDP tunnel from {}:{} to {}:{} ".format(laddr, lport, raddr, rport))
-
-            # add the UDP NIOs to the nodes
-            self._source_node.nio_cancel_signal.connect(self.cancelNIOSlot)
-            self._source_node.addNIO(self._source_port, self._source_nio)
-            self._destination_node.nio_cancel_signal.connect(self.cancelNIOSlot)
-            self._destination_node.addNIO(self._destination_port, self._destination_nio)
-
-    def newNIOSlot(self, node_id, port_id):
+    def destinationNode(self):
         """
-        Slot to receive events from Node instances
-        when a NIO has been created on the server
-        and are active.
+        Returns the destination node for this link.
 
-        :param node_id: node identifier
-        :param port_id: port identifier
+        :returns: Node instance
         """
 
-        # check that the node is connected to this link as a source
-        if node_id == self._source_node.id() and port_id == self._source_port.id():
-            self._source_nio_active = True
-            # disconnect the signal has we don't expect new source NIO for this link.
-            self._source_node.nio_signal.disconnect(self.newNIOSlot)
+        return self._destination_node
 
-        # check that the node is connected to this link as a destination
-        elif node_id == self._destination_node.id() and port_id == self._destination_port.id():
-            self._destination_nio_active = True
-            # disconnect the signal has we don't expect new destination NIO for this link.
-            self._destination_node.nio_signal.disconnect(self.newNIOSlot)
-
-        if not self._stub and self._source_nio_active and self._destination_nio_active:
-            # both NIOs are active now.
-            self._addToSourcePort(self._source_nio)
-            self._addToDestinationPort(self._destination_nio)
-
-            self._source_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            self._destination_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            self._source_nio_active = False
-            self._destination_nio_active = False
-
-            # let the GUI know about this link has been created
-            self.add_link_signal.emit(self._id)
-        elif self._stub and self._source_nio_active:
-            self._addToSourcePort(self._source_nio)
-            # add the NIO to destination to show the port is not free.
-            self._addToDestinationPort(self._source_nio)
-            self._source_nio_active = False
-            self._source_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            self.add_link_signal.emit(self._id)
-        elif self._stub and self._destination_nio_active:
-            # add the NIO to source to show the port is not free.
-            self._addToSourcePort(self._destination_nio)
-            self._addToDestinationPort(self._destination_nio)
-            self._destination_nio_active = False
-            self._destination_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            self.add_link_signal.emit(self._id)
-
-    def _addToSourcePort(self, nio):
+    def sourcePort(self):
         """
-        Adds a NIO, a link id and a description to the source port.
+        Returns the source port for this link.
 
-        :param nio: NIO instance
+        :returns: Port instance
         """
 
-        self._source_port.setNio(nio)
-        self._source_port.setLinkId(self._id)
-        if not self._source_port.description():
-            self._source_port.setDescription("connected to {name} on port {port}".format(name=self._destination_node.name(),
-                                                                                         port=self._destination_port.name()))
-        log.debug("{} attached to {} on port {}".format(nio,
-                                                        self._source_node.name(),
-                                                        self._source_port.name()))
+        return self._source_port
 
-    def _addToDestinationPort(self, nio):
+    def destinationPort(self):
         """
-        Adds a NIO, a link id and a description to the destination port.
+        Returns the destination port for this link.
 
-        :param nio: NIO instance
+        :returns: Port instance
         """
 
-        self._destination_port.setNio(nio)
-        self._destination_port.setLinkId(self._id)
-        if not self._destination_port.description():
-            self._destination_port.setDescription("connected to {name} on port {port}".format(name=self._source_node.name(),
-                                                                                              port=self._source_port.name()))
+        return self._destination_port
 
-        log.debug("{} attached to {} on port {}".format(nio,
-                                                        self._destination_node.name(),
-                                                        self._destination_port.name()))
-
-    def cancelNIOSlot(self, node_id):
+    def getNodePort(self, node):
         """
-        Slot to receive events from Node instances
-        when a NIO has been canceled because of an
-        error returned by the server.
+        Search the port in the link corresponding to this node
 
-        :param node_id: node identifier
+        :returns: Node instance
         """
+        if self._destination_node == node:
+            return self._destination_port
+        return self._source_port
 
-        if not self._stub:
-            if self._source_node.id() != node_id:
-                # the destination node has canceled its NIO allocation
-                self._destination_node.nio_signal.disconnect(self.newNIOSlot)
-
-                self._source_node.deleteNIO(self._source_port)
-                self._source_port.setFree()
-                self._source_node.updated_signal.emit()
-
-            elif self._destination_node.id() != node_id:
-                # the source node has canceled its NIO allocation
-                self._source_node.nio_signal.disconnect(self.newNIOSlot)
-
-                self._destination_node.deleteNIO(self._destination_port)
-                self._destination_port.setFree()
-                self._destination_node.updated_signal.emit()
-
-            self._source_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            self._destination_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-        else:
-            if self._source_node.id() == node_id:
-                self._source_node.nio_signal.disconnect(self.newNIOSlot)
-                self._source_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-            else:
-                self._destination_node.nio_signal.disconnect(self.newNIOSlot)
-                self._destination_node.nio_cancel_signal.disconnect(self.cancelNIOSlot)
-
-        self._source_nio_active = False
-        self._destination_nio_active = False
-
-    def description(self):
+    def filters(self):
         """
-        Returns the text description of this link.
-
-        :returns: description
+        :returns: List the filters active on the node
         """
+        return self._filters
 
-        return self._description
-
-    def setDescription(self, description):
+    def setFilters(self, filters):
         """
-        Adds a text description to this link.
-
-        :param description: description
+        :params filters: List of filters
         """
+        self._filters = filters
 
-        self._description = description
-
-    def dump(self):
+    def setLinkStyle(self, link_style):
         """
-        Returns a representation of this link.
-
-        :returns: dictionary
+        :params _link_style: Set link style attributes
         """
-
-        return {"id": self.id(),
-                "description": self._description,
-                "source_node_id": self._source_node.id(),
-                "source_port_id": self._source_port.id(),
-                "destination_node_id": self._destination_node.id(),
-                "destination_port_id": self._destination_port.id(),
-                }
+        self._link_style = link_style

gns3/local_config.py

@@ -0,0 +1,511 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2015 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 sys
+import os
+import json
+import shutil
+import copy
+
+import psutil
+
+from .qt import QtCore, QtWidgets
+from .version import __version__, __version_info__
+from .utils import parse_version
+from .local_server_config import LocalServerConfig
+from .settings import LOCAL_SERVER_SETTINGS
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class LocalConfig(QtCore.QObject):
+
+    """
+    Handles the local GUI settings.
+    """
+
+    config_changed_signal = QtCore.Signal()
+
+    def __init__(self, config_file=None):
+        """
+        :param config_file: Path to the config file (override all other config, useful for tests)
+        """
+
+        super().__init__()
+        self._profile = None
+        self._config_file = config_file
+        self._migrateOldConfigPath()
+        self._resetLoadConfig()
+
+    def _resetLoadConfig(self):
+        """
+        Reload the config from scratch everything is clean
+
+        """
+        self._settings = {}
+        self._last_config_changed = None
+        if sys.platform.startswith("win"):
+            filename = "gns3_gui.ini"
+        else:
+            filename = "gns3_gui.conf"
+
+        appname = "GNS3"
+
+        if sys.platform.startswith("win"):
+            # On windows, the system wide configuration file location is %COMMON_APPDATA%/GNS3/gns3_gui.conf
+            common_appdata = os.path.expandvars("%COMMON_APPDATA%")
+            system_wide_config_file = os.path.join(common_appdata, appname, filename)
+        else:
+            # On UNIX-like platforms, the system wide configuration file location is /etc/xdg/GNS3/gns3_gui.conf
+            system_wide_config_file = os.path.join("/etc/xdg", appname, filename)
+
+        if not self._config_file:
+            self._config_file = os.path.join(self.configDirectory(), filename)
+
+        # First load system wide settings
+        if os.path.exists(system_wide_config_file):
+            self._readConfig(system_wide_config_file)
+
+        config_file_in_cwd = os.path.join(os.getcwd(), filename)
+        if os.path.exists(config_file_in_cwd):
+            # use any config file present in the current working directory
+            self._config_file = config_file_in_cwd
+        elif not os.path.exists(self._config_file):
+            try:
+                # create the config file if it doesn't exist
+                os.makedirs(os.path.dirname(self._config_file), exist_ok=True)
+
+                if sys.platform.startswith("win"):
+                    old_config_path = os.path.join(os.path.expandvars("%APPDATA%"), "GNS3", filename)
+                else:
+                    old_config_path = os.path.join(os.path.expanduser("~"), ".config", "GNS3", filename)
+
+                # TODO: migrate versioned config file from a previous version of GNS3 (for instance 2.2 -> 2.3) + support profiles
+                if os.path.exists(old_config_path):
+                    # migrate post version 2.2.0 configuration file
+                    shutil.copyfile(old_config_path, self._config_file)
+                    # reset the local server path and ubridge path
+                    settings = LocalServerConfig.instance().loadSettings("Server", LOCAL_SERVER_SETTINGS)
+                    settings["path"] = ""
+                    settings["ubridge_path"] = ""
+                    LocalServerConfig.instance().saveSettings("Server", settings)
+                else:
+                    # create a new config
+                    with open(self._config_file, "w", encoding="utf-8") as f:
+                        json.dump({"version": __version__, "type": "settings"}, f)
+            except OSError as e:
+                log.error("Could not create the config file {}: {}".format(self._config_file, e))
+
+        user_settings = self._readConfig(self._config_file)
+        # overwrite system wide settings with user specific ones
+        self._settings.update(user_settings)
+        self._migrateOldConfig()
+        self.writeConfig()
+
+    def profile(self):
+        """
+        :returns: Current settings profile
+        """
+        return self._profile
+
+    def setProfile(self, profile):
+        previous_profile = self._profile
+        if profile == "default":
+            self._profile = None
+        else:
+            self._profile = profile
+        if previous_profile != self._profile:
+            self._config_file = None
+            self._resetLoadConfig()
+
+    def configDirectory(self):
+        """
+        Get the configuration directory
+        """
+
+        version = "{}.{}".format(__version_info__[0], __version_info__[1])
+        if sys.platform.startswith("win"):
+            appdata = os.path.expandvars("%APPDATA%")
+            path = os.path.join(appdata, "GNS3", version)
+        else:
+            home = os.path.expanduser("~")
+            path = os.path.join(home, ".config", "GNS3", version)
+
+        if self._profile is not None:
+            path = os.path.join(path, "profiles", self._profile)
+
+        return os.path.normpath(path)
+
+    def runAsRootPath(self):
+        """
+        Gets run as root filename
+        :return: string
+        """
+        return os.path.join(self.configDirectory(), "run_as_root")
+
+    def _migrateOldConfigPath(self):
+        """
+        Migrate pre 1.4 config path
+        """
+
+        # In < 1.4 on Mac the config was in a gns3.net directory
+        # We have move to same location as Linux
+        if sys.platform.startswith("darwin"):
+            version = "{}.{}".format(__version_info__[0], __version_info__[1])
+            old_path = os.path.join(os.path.expanduser("~"), ".config", "gns3.net")
+            new_path = os.path.join(os.path.expanduser("~"), ".config", "GNS3", version)
+            if os.path.exists(old_path) and not os.path.exists(new_path):
+                try:
+                    shutil.copytree(old_path, new_path)
+                except OSError as e:
+                    log.error("Can't copy the old config: %s", str(e))
+
+    def _migrateOldConfig(self):
+        """
+        Migrate config from a previous version.
+        """
+
+        # Display an error if settings come from a more recent version of GNS3
+        # patch level version are compatible (ex 1.5.3 and 1.5.2). But if you open
+        # settings from 1.6.1 with 1.5.1 you will have an error
+        if "version" in self._settings:
+            if parse_version(self._settings["version"])[:2] > parse_version(__version__)[:2]:
+                app = QtWidgets.QApplication(sys.argv)  # We need to create an application because settings are loaded before Qt init
+                error_message = "Settings are for version {} of GNS3. It is not possible to use a previous version of GNS3 without risking losing data. Delete the settings in '{}' to start GNS3".format(self._settings["version"], self.configDirectory())
+                QtWidgets.QMessageBox.critical(False, "Version error", error_message)
+                # Exit immediately not clean but we want to avoid any side effect that could corrupt the file
+                QtCore.QTimer.singleShot(0, app.quit)
+                app.exec_()
+                sys.exit(1)
+
+        if "version" not in self._settings or parse_version(self._settings["version"]) < parse_version("1.4.0alpha1"):
+
+             servers = self._settings.get("Servers", {})
+
+             if "LocalServer" in self._settings:
+                servers["local_server"] = copy.copy(self._settings["LocalServer"])
+
+                 # We migrate the server binary for OSX due to the change from py2app to CX freeze
+                if servers["local_server"]["path"] == "/Applications/GNS3.app/Contents/Resources/server/Contents/MacOS/gns3server":
+                    servers["local_server"]["path"] = "gns3server"
+
+             if "RemoteServers" in self._settings:
+                servers["remote_servers"] = copy.copy(self._settings["RemoteServers"])
+
+             self._settings["Servers"] = servers
+
+             if "GUI" in self._settings:
+                main_window = self._settings.get("MainWindow", {})
+                main_window["hide_getting_started_dialog"] = self._settings["GUI"].get("hide_getting_started_dialog", False)
+                self._settings["MainWindow"] = main_window
+
+        if "version" not in self._settings or parse_version(self._settings["version"]) < parse_version("1.4.1dev2"):
+            if sys.platform.startswith("darwin"):
+                from .settings import PRECONFIGURED_TELNET_CONSOLE_COMMANDS, DEFAULT_TELNET_CONSOLE_COMMAND
+
+                if "MainWindow" in self._settings:
+                    if self._settings["MainWindow"].get("telnet_console_command") not in PRECONFIGURED_TELNET_CONSOLE_COMMANDS.values():
+                        self._settings["MainWindow"]["telnet_console_command"] = DEFAULT_TELNET_CONSOLE_COMMAND
+
+         # Migrate 1.X to 2.0
+        if "version" not in self._settings or parse_version(self._settings["version"]) < parse_version("2.0.0"):
+            if "Qemu" in self._settings:
+                # The internet VM is replaced by the nat Node
+                # we remove it from the list of available VM
+                vms = []
+                for vm in self._settings["Qemu"].get("vms", []):
+                    if vm.get("hda_disk_image") != "core-linux-6.4-internet-0.1.img":
+                        vms.append(vm)
+                self._settings["Qemu"]["vms"] = vms
+
+         # Starting with 2.0.0dev5 IOU licence is stored in the settings
+        if "version" not in self._settings or parse_version(self._settings["version"]) < parse_version("2.0.0"):
+            if "IOU" in self._settings and "iourc_path" in self._settings["IOU"] and "iourc_content" not in self._settings["IOU"]:
+                try:
+                    with open(self._settings["IOU"]["iourc_path"], "r", encoding="utf-8") as f:
+                        self._settings["IOU"]["iourc_content"] = f.read().replace("\r\n", "\n")
+                        del self._settings["IOU"]["iourc_path"]
+                except OSError as e:
+                    log.warning("Can't import IOU licence {}: {}".format(self._settings["IOU"]["iourc_path"], str(e)))
+                except UnicodeDecodeError as e:
+                    log.warning("Non ascii characters in iourc file {}, please remove them: {}".format(self._settings["IOU"]["iourc_path"], str(e)))
+
+    def _readConfig(self, config_path):
+        """
+        Read the configuration file.
+        """
+
+        log.debug("Load config from %s", config_path)
+        try:
+            with open(config_path, "r", encoding="utf-8") as f:
+                self._last_config_changed = os.stat(config_path).st_mtime
+                config = json.load(f)
+                self._settings.update(config)
+        except (ValueError, OSError) as e:
+            log.error("Could not read the config file {}: {}".format(self._config_file, e))
+
+        # Update already loaded section
+        for section in self._settings.keys():
+            if isinstance(self._settings[section], dict):
+                self.loadSectionSettings(section, self._settings[section])
+
+        return dict()
+
+    def writeConfig(self):
+        """
+        Write the configuration file.
+        """
+
+        self._settings["version"] = __version__
+        try:
+            temporary = os.path.join(os.path.dirname(self._config_file), "gns3_gui.tmp")
+            with open(temporary, "w", encoding="utf-8") as f:
+                json.dump(self._settings, f, sort_keys=True, indent=4)
+            shutil.move(temporary, self._config_file)
+            log.debug("Configuration save to %s", self._config_file)
+            self._last_config_changed = os.stat(self._config_file).st_mtime
+        except (ValueError, OSError) as e:
+            log.error("Could not write the config file {}: {}".format(self._config_file, e))
+
+    def checkConfigChanged(self):
+
+        try:
+            if self._last_config_changed and self._last_config_changed < os.stat(self._config_file).st_mtime:
+                log.debug("Client config has changed, reloading it...")
+                self._readConfig(self._config_file)
+                self.config_changed_signal.emit()
+        except OSError as e:
+            log.error("Error when checking for changes {}: {}".format(self._config_file, str(e)))
+
+    def configFilePath(self):
+        """
+        Returns the config file path.
+
+        :returns: path to the config file.
+        """
+
+        return self._config_file
+
+    def setConfigFilePath(self, config_file):
+        """
+        Set a new config file
+
+        :returns: path to the config file.
+        """
+
+        self._config_file = config_file
+        self._resetLoadConfig()
+
+    def settings(self):
+        """
+        Get the settings.
+
+        :returns: settings (dict)
+        """
+
+        return copy.deepcopy(self._settings)
+
+    def setSettings(self, settings):
+        """
+        Save the settings.
+
+        :param settings: settings to save (dict)
+        """
+
+        if self._settings != settings:
+            self._settings.update(settings)
+            self.writeConfig()
+            self.config_changed_signal.emit()
+
+    def loadSectionSettings(self, section, default_settings):
+        """
+        Get all the settings from a given section.
+
+        :param default_settings: setting names and default values (dict)
+
+        :returns: settings (dict)
+        """
+
+        settings = self.settings().get(section, dict())
+        changed = False
+
+        def _copySettings(local, default):
+            """
+            Copy only existing settings, ignore the other.
+            Add default values if require.
+            """
+            nonlocal changed
+
+            # use default values for missing settings
+            for name, value in default.items():
+                if name not in local:
+                    local[name] = value
+                    changed = True
+                elif isinstance(value, dict):
+                    local[name] = _copySettings(local[name], default[name])
+            return local
+
+        settings = _copySettings(settings, default_settings)
+        self._settings[section] = settings
+
+        if changed:
+            log.debug("Section %s has missing default values. Adding keys %s Saving configuration", section, ','.join(set(default_settings.keys()) - set(settings.keys())))
+            self.writeConfig()
+        return copy.deepcopy(settings)
+
+    def saveSectionSettings(self, section, settings):
+        """
+        Save all the settings in a given section.
+
+        :param section: section name
+        :param settings: settings to save (dict)
+        """
+
+        if section not in self._settings:
+            self._settings[section] = {}
+
+        if self._settings[section] != settings:
+            self._settings[section].update(copy.deepcopy(settings))
+            log.debug("Section %s has changed. Saving configuration", section)
+            self.writeConfig()
+        else:
+            log.debug("Section %s has not changed. Skip saving configuration", section)
+
+    def experimental(self):
+        """
+        :returns: Boolean. True if experimental features allowed
+        """
+
+        from gns3.settings import GENERAL_SETTINGS
+        return self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)["experimental_features"]
+
+    def hdpi(self):
+        """
+        :returns: Boolean. True if hdpi is allowed
+        """
+
+        from gns3.settings import GENERAL_SETTINGS
+        return self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)["hdpi"]
+
+    def multiProfiles(self):
+        """
+        :returns: Boolean. True if multi_profiles is enabled
+        """
+
+        from gns3.settings import GENERAL_SETTINGS
+        return self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)["multi_profiles"]
+
+    def setMultiProfiles(self, value):
+        from gns3.settings import GENERAL_SETTINGS
+        settings = self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)
+        settings["multi_profiles"] = value
+        self.saveSectionSettings("MainWindow", settings)
+
+    def directFileUpload(self):
+        """
+        :returns: Boolean. True if direct_file_upload is enabled
+        """
+
+        from gns3.settings import GENERAL_SETTINGS
+        return self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)["direct_file_upload"]
+
+    def setDirectFileUpload(self, value):
+        from gns3.settings import GENERAL_SETTINGS
+        settings = self.loadSectionSettings("MainWindow", GENERAL_SETTINGS)
+        settings["direct_file_upload"] = value
+        self.saveSectionSettings("MainWindow", settings)
+
+    def showInterfaceLabelsOnNewProject(self):
+        """
+        :returns: Boolean. True if show_interface_labels_on_new_project is enabled
+        """
+
+        from gns3.settings import GRAPHICS_VIEW_SETTINGS
+        return self.loadSectionSettings("GraphicsView", GRAPHICS_VIEW_SETTINGS).get("show_interface_labels_on_new_project", False)
+
+    def setShowInterfaceLabelsOnNewProject(self, value):
+        from gns3.settings import GRAPHICS_VIEW_SETTINGS
+        settings = self.loadSectionSettings("GraphicsView", GRAPHICS_VIEW_SETTINGS)
+        settings["show_interface_labels_on_new_project"] = value
+        self.saveSectionSettings("GraphicsView", settings)
+
+    def showGridOnNewProject(self):
+        """
+        :returns: Boolean. True if show_grid_on_new_project is enabled
+        """
+
+        from gns3.settings import GRAPHICS_VIEW_SETTINGS
+        return self.loadSectionSettings("GraphicsView", GRAPHICS_VIEW_SETTINGS).get("show_grid_on_new_project", False)
+
+    def snapToGridOnNewProject(self):
+        """
+        :returns: Boolean. True if snap_to_grid_on_new_project is enabled
+        """
+
+        from gns3.settings import GRAPHICS_VIEW_SETTINGS
+        return self.loadSectionSettings("GraphicsView", GRAPHICS_VIEW_SETTINGS).get("snap_to_grid_on_new_project", False)
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of LocalConfig.
+
+        :returns: instance of LocalConfig
+        """
+
+        if not hasattr(LocalConfig, "_instance") or LocalConfig._instance is None:
+            LocalConfig._instance = LocalConfig()
+        return LocalConfig._instance
+
+    @staticmethod
+    def isMainGui():
+        """
+        :returns: Return true if we are the main gui (first gui to start)
+        """
+
+        my_pid = os.getpid()
+        pid_path = os.path.join(LocalConfig.instance().configDirectory(), "gns3_gui.pid")
+
+        if os.path.exists(pid_path):
+            try:
+                with open(pid_path) as f:
+                    pid = int(f.read())
+                    if pid != my_pid:
+                        try:
+                            process = psutil.Process(pid=pid)
+                            ps_name = process.name().lower()
+                        except (OSError, psutil.NoSuchProcess, psutil.AccessDenied):
+                            pass
+                        else:
+                            if "gns3" in ps_name or "python" in ps_name:
+                                # Process run under the same user id
+                                if sys.platform.startswith("win") or process.uids()[0] == os.getuid():
+                                    return False
+                    else:
+                        return True
+            except (OSError, ValueError) as e:
+                log.critical("Can't read pid file %s: %s", pid_path, str(e))
+                return False
+
+        try:
+            with open(pid_path, 'w+') as f:
+                f.write(str(my_pid))
+        except OSError as e:
+            log.critical("Can't write pid file %s: %s", pid_path, str(e))
+            return False
+        return True

gns3/local_server.py

@@ -0,0 +1,616 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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 sys
+import copy
+import stat
+import shlex
+import socket
+import shutil
+import random
+import string
+import struct
+import psutil
+import signal
+import subprocess
+
+
+from gns3.qt import QtWidgets, QtCore, qslot
+from gns3.settings import LOCAL_SERVER_SETTINGS, DEFAULT_LOCAL_SERVER_HOST
+from gns3.local_config import LocalConfig
+from gns3.local_server_config import LocalServerConfig
+from gns3.utils.wait_for_connection_worker import WaitForConnectionWorker
+from gns3.utils.progress_dialog import ProgressDialog
+from gns3.utils.sudo import sudo
+from gns3.http_client import HTTPClient
+from gns3.controller import Controller
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class StopLocalServerWorker(QtCore.QObject):
+    """
+    Worker for displaying a progress dialog when closing
+    the server
+    """
+    # signals to update the progress dialog.
+    error = QtCore.pyqtSignal(str, bool)
+    finished = QtCore.pyqtSignal()
+    updated = QtCore.pyqtSignal(int)
+
+    def __init__(self, local_server_process):
+        super().__init__()
+        self._local_server_process = local_server_process
+        self._precision = 100  # In MS
+        self._remaining_trial = int(10 * (1000 / self._precision))
+
+    @qslot
+    def _callbackSlot(self, *params):
+        self._local_server_process.poll()
+        if self._local_server_process.returncode is None and self._remaining_trial > 0:
+            self._remaining_trial -= 1
+            QtCore.QTimer.singleShot(self._precision, self._callbackSlot)
+        else:
+            self.finished.emit()
+
+    def run(self):
+        QtCore.QTimer.singleShot(1000, self._callbackSlot)
+
+    def cancel(self):
+        return
+
+
+class LocalServer(QtCore.QObject):
+    """
+    Manage the local server process
+    """
+
+    def __init__(self, parent=None):
+        # Remember if the server was started by us or not
+        self._server_started_by_me = False
+        self._local_server_path = ""
+        self._local_server_process = None
+
+        super().__init__()
+        self._parent = parent
+        self._config_directory = LocalConfig.instance().configDirectory()
+        self._settings = {}
+        self.localServerSettings()
+        self._port = self._settings.get("port", 3080)
+        if not self._settings.get("auto_start", True):
+            if self._settings.get("host") is None:
+                self._http_client = HTTPClient(self._settings)
+                Controller.instance().setHttpClient(self._http_client)
+        else:
+            self._http_client = None
+
+        self._stopping = False
+        self._timer = QtCore.QTimer()
+        self._timer.setInterval(5000)
+        self._timer.timeout.connect(self._checkLocalServerRunningSlot)
+        self._timer.start()
+
+    def _pid_path(self):
+        """
+        :returns: Path of the PID file
+        """
+        return os.path.join(self._config_directory, "gns3_server.pid")
+
+    def parent(self):
+        """
+        Parent window
+        """
+        if self._parent is None:
+            from gns3.main_window import MainWindow
+            return MainWindow.instance()
+        return self._parent
+
+    def _checkWindowsService(self, service_name):
+
+        try:
+            import pywintypes
+            import win32service
+            import win32serviceutil
+        except ImportError as e:
+            log.error("Could not check if the {} service is running: {}".format(service_name, e))
+            return
+
+        try:
+            if win32serviceutil.QueryServiceStatus(service_name, None)[1] != win32service.SERVICE_RUNNING:
+                return False
+        except pywintypes.error as e:
+            if e.winerror == 1060:  # service is not installed
+                return False
+            else:
+                log.error("Could not check if the {} service is running: {}".format(service_name, e.strerror))
+
+        return True
+
+    def _checkUbridgePermissions(self):
+        """
+        Checks that uBridge can interact with network interfaces.
+        """
+
+        path = os.path.abspath(self._settings["ubridge_path"])
+
+        if not path or len(path) == 0 or not os.path.exists(path) or not os.path.isfile(path):
+            return False
+
+        if sys.platform.startswith("win"):
+            # do not check anything on Windows
+            return True
+
+        if os.geteuid() == 0:
+            # we are root, so we should have privileged access.
+            return True
+
+        request_setuid = False
+        if sys.platform.startswith("linux"):
+            # test if the executable has the CAP_NET_RAW capability (Linux only)
+            try:
+                # test the 2nd byte and check if the 13th bit (CAP_NET_RAW) is set
+                if "security.capability" not in os.listxattr(path) or not struct.unpack("<IIIII", os.getxattr(path, "security.capability"))[1] & 1 << 13:
+                    proceed = QtWidgets.QMessageBox.question(
+                        self.parent(),
+                        "uBridge",
+                        "uBridge requires CAP_NET_RAW capability to interact with network interfaces. Set the capability to uBridge? All users on the system will be able to read packet from the network interfaces.",
+                        QtWidgets.QMessageBox.Yes,
+                        QtWidgets.QMessageBox.No)
+                    if proceed == QtWidgets.QMessageBox.Yes:
+                        sudo(["setcap", "cap_net_admin,cap_net_raw=ep", path])
+            except AttributeError:
+                # Due to a Python bug, os.listxattr could be missing: https://github.com/GNS3/gns3-gui/issues/2010
+                log.warning("Could not determine if CAP_NET_RAW capability is set for uBridge (Python bug)")
+                return True
+            except OSError as e:
+                QtWidgets.QMessageBox.critical(self.parent(), "uBridge", "Can't set CAP_NET_RAW capability to uBridge {}: {}".format(path, str(e)))
+                request_setuid = True
+
+        if sys.platform.startswith("darwin") or request_setuid:
+            try:
+                if os.stat(path).st_uid != 0 or not os.stat(path).st_mode & stat.S_ISUID:
+                    proceed = QtWidgets.QMessageBox.question(
+                        self.parent(),
+                        "uBridge",
+                        "uBridge requires root permissions to interact with network interfaces. Set root permissions to uBridge? All admin users on the system will be able to read packet from the network interfaces.",
+                        QtWidgets.QMessageBox.Yes,
+                        QtWidgets.QMessageBox.No)
+                    if proceed == QtWidgets.QMessageBox.Yes:
+                        from gns3.utils.macos_ubridge_setuid import macos_ubridge_setuid
+                        if sys.platform.startswith("darwin") and hasattr(sys, "frozen"):
+                            macos_ubridge_setuid()
+                        else:
+                            sudo(["chown", "root:admin", path], ["chmod", "4750", path])
+            except OSError as e:
+                QtWidgets.QMessageBox.critical(self.parent(), "uBridge", "Can't set root permissions to uBridge {}: {}".format(path, str(e)))
+                return False
+        return True
+
+    def _passwordGenerate(self):
+        """
+        Generate a random password
+        """
+        return ''.join(random.choice(string.ascii_letters + string.digits) for _ in range(64))
+
+    def localServerSettings(self):
+        """
+        Returns the local server settings.
+
+        :returns: local server settings (dict)
+        """
+
+        settings = LocalServerConfig.instance().loadSettings("Server", LOCAL_SERVER_SETTINGS)
+        self._settings = copy.copy(settings)
+
+        # user & password
+        if settings["auth"] is True and not settings["user"].strip():
+            settings["user"] = "admin"
+            settings["password"] = self._passwordGenerate()
+
+        # local GNS3 server path
+        local_server_path = shutil.which(settings["path"].strip())
+        if local_server_path is None:
+            default_server_path = shutil.which("gns3server")
+            if default_server_path is not None:
+                settings["path"] = os.path.abspath(default_server_path)
+        else:
+            settings["path"] = os.path.abspath(local_server_path)
+
+        # uBridge path
+        ubridge_path = shutil.which(settings["ubridge_path"].strip())
+        if ubridge_path is None:
+            default_ubridge_path = shutil.which("ubridge")
+            if default_ubridge_path is not None:
+                settings["ubridge_path"] = os.path.abspath(default_ubridge_path)
+        else:
+            settings["ubridge_path"] = os.path.abspath(ubridge_path)
+
+        if self._settings != settings:
+            self.updateLocalServerSettings(settings)
+        return settings
+
+    def updateLocalServerSettings(self, new_settings):
+        """
+        Update the local server settings. Keep the key not in new_settings
+        """
+
+        if "host" in new_settings and new_settings["host"] is None:
+            new_settings["host"] = DEFAULT_LOCAL_SERVER_HOST
+        old_settings = copy.copy(self._settings)
+        if not self._settings:
+            self._settings = new_settings
+        else:
+            self._settings.update(new_settings)
+        self._port = self._settings["port"]
+        LocalServerConfig.instance().saveSettings("Server", self._settings)
+
+        # Settings have changed we need to restart the server
+        if old_settings != self._settings:
+            if self._settings["auto_start"]:
+                # We restart the local server only if we really need. Auth can be hot change
+                settings_require_restart = ('host', 'port', 'path')
+                need_restart = False
+                for s in settings_require_restart:
+                    if old_settings.get(s) != self._settings.get(s):
+                        need_restart = True
+
+                if need_restart:
+                    self.stopLocalServer(wait=True)
+
+                self.localServerAutoStartIfRequired()
+            # If the controller is remote:
+            else:
+                self.stopLocalServer(wait=True)
+
+            if self._settings.get("host") is None:
+                self._http_client = None
+            else:
+                self._http_client = HTTPClient(self._settings)
+            Controller.instance().setHttpClient(self._http_client)
+
+    def shouldLocalServerAutoStart(self):
+        """
+        Returns either the local server
+        is automatically started on startup.
+
+        :returns: boolean
+        """
+
+        return self._settings["auto_start"] and self._settings["host"] is not None
+
+    def localServerPath(self):
+        """
+        Returns the local server path.
+
+        :returns: path to local server program.
+        """
+
+        return self._settings["path"]
+
+    def _killAlreadyRunningServer(self):
+        """
+        Kill a running zombie server (started by a gui that no longer exists)
+        This will not kill server started by hand.
+        """
+        try:
+            if os.path.exists(self._pid_path()):
+                with open(self._pid_path()) as f:
+                    pid = int(f.read())
+                process = psutil.Process(pid=pid)
+                log.info("Kill already running server with PID %d", pid)
+                process.kill()
+        except (OSError, ValueError, psutil.NoSuchProcess, psutil.AccessDenied):
+            # Permission issue, or process no longer exists, or file is empty
+            return
+
+    def localServerAutoStartIfRequired(self):
+        """
+        Try to start the embedded gns3 server.
+        """
+
+        if not self.shouldLocalServerAutoStart():
+            self._http_client = HTTPClient(self._settings)
+            Controller.instance().setHttpClient(self._http_client)
+            return
+
+        if self.isLocalServerRunning() and self._server_started_by_me:
+            return True
+
+        # We check if two gui are not launched at the same time
+        # to avoid killing the server of the other GUI
+        if not LocalConfig.isMainGui():
+            log.info("Not the main GUI, will not auto start the server")
+            self._http_client = HTTPClient(self._settings)
+            Controller.instance().setHttpClient(self._http_client)
+            return True
+
+        if self.isLocalServerRunning():
+            log.debug("A local server already running on this host")
+            # Try to kill the server. The server can be still running after
+            # if the server was started by hand
+            self._killAlreadyRunningServer()
+
+        if not self.isLocalServerRunning():
+            if not self.initLocalServer():
+                QtWidgets.QMessageBox.critical(self.parent(), "Local server", "Could not start the local server process: {}".format(self._settings["path"]))
+                return False
+            if not self.startLocalServer():
+                QtWidgets.QMessageBox.critical(self.parent(), "Local server", "Could not start the local server process: {}".format(self._settings["path"]))
+                return False
+
+        if self.parent():
+            worker = WaitForConnectionWorker(self._settings["host"], self._port)
+            progress_dialog = ProgressDialog(worker,
+                                             "Local server",
+                                             "Connecting to server {} on port {}...".format(self._settings["host"], self._port),
+                                             "Cancel", busy=True, parent=self.parent())
+            progress_dialog.show()
+            if not progress_dialog.exec_():
+                return False
+        self._server_started_by_me = True
+        self._http_client = HTTPClient(self._settings)
+        Controller.instance().setHttpClient(self._http_client)
+        return True
+
+    def initLocalServer(self):
+        """
+        Initialize the local server.
+        """
+
+        self._checkUbridgePermissions()
+
+        if sys.platform.startswith("win"):
+            import pywintypes
+            try:
+                if not self._checkWindowsService("npf") and not self._checkWindowsService("npcap"):
+                    log.warning("The NPF or NPCAP service is not installed, please install Winpcap or Npcap and reboot.")
+            except pywintypes.error as e:
+                log.warning("Could not check if the NPF or Npcap service is running: {}".format(e.strerror))
+
+        self._port = self._settings["port"]
+        # check the local server path
+        local_server_path = self.localServerPath()
+        if not local_server_path:
+            log.warning("No local server is configured")
+            return False
+        if not os.path.isfile(local_server_path):
+            QtWidgets.QMessageBox.critical(self.parent(), "Local server", "Could not find local server {}".format(local_server_path))
+            return False
+        elif not os.access(local_server_path, os.X_OK):
+            QtWidgets.QMessageBox.critical(self.parent(), "Local server", "{} is not an executable".format(local_server_path))
+            return False
+
+        try:
+            # check if the local address still exists
+            for res in socket.getaddrinfo(self._settings["host"], 0, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
+                af, socktype, proto, _, sa = res
+                with socket.socket(af, socktype, proto) as sock:
+                    sock.bind(sa)
+                    break
+        except OSError as e:
+            QtWidgets.QMessageBox.critical(self.parent(), "Local server", "Could not bind with {}: {} (please check your host binding setting in the preferences)".format(self._settings["host"], e))
+            return False
+
+        try:
+            # check if the port is already taken
+            find_unused_port = False
+            for res in socket.getaddrinfo(self._settings["host"], self._port, socket.AF_UNSPEC, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
+                af, socktype, proto, _, sa = res
+                with socket.socket(af, socktype, proto) as sock:
+                    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+                    sock.bind(sa)
+                    break
+        except OSError as e:
+            log.warning("Could not use socket {}:{} {}".format(self._settings["host"], self._port, e))
+            find_unused_port = True
+
+        if find_unused_port:
+            # find an alternate port for the local server
+            old_port = self._port
+            try:
+                self._port = self._findUnusedLocalPort(self._settings["host"])
+            except OSError as e:
+                QtWidgets.QMessageBox.critical(self.parent(), "Local server", "Could not find an unused port for the local server: {}".format(e))
+                return False
+            log.warning("The server port {} is already in use, fallback to port {}".format(old_port, self._port))
+        return True
+
+    def _findUnusedLocalPort(self, host):
+        """
+        Find an unused port.
+
+        :param host: server hosts
+
+        :returns: port number
+        """
+
+        with socket.socket() as s:
+            s.bind((host, 0))
+            return s.getsockname()[1]
+
+    def startLocalServer(self):
+        """
+        Starts the local server process.
+        """
+
+        self._stopping = False
+        path = self.localServerPath()
+        command = '"{executable}" --local'.format(executable=path)
+
+        if LocalConfig.instance().profile():
+            command += " --profile {}".format(LocalConfig.instance().profile())
+
+        if self._settings["allow_console_from_anywhere"]:
+            # allow connections to console from remote addresses
+            command += " --allow"
+
+        if logging.getLogger().isEnabledFor(logging.DEBUG):
+            command += " --debug"
+
+        settings_dir = self._config_directory
+        if os.path.isdir(settings_dir):
+            # save server logging info to a file in the settings directory
+            logpath = os.path.join(settings_dir, "gns3_server.log")
+            if os.path.isfile(logpath):
+                # delete the previous log file
+                try:
+                    os.remove(logpath)
+                except FileNotFoundError:
+                    pass
+                except OSError as e:
+                    log.warning("could not delete server log file {}: {}".format(logpath, e))
+            command += ' --log="{}" --pid="{}"'.format(logpath, self._pid_path())
+
+        log.debug("Starting local server process with {}".format(command))
+        try:
+            if sys.platform.startswith("win"):
+                # use the string on Windows
+                self._local_server_process = subprocess.Popen(
+                    command,
+                    creationflags=subprocess.CREATE_NEW_PROCESS_GROUP,
+                    stderr=subprocess.PIPE,
+                    env=os.environ)
+            else:
+                # use arguments on other platforms
+                args = shlex.split(command)
+                self._local_server_process = subprocess.Popen(args, stderr=subprocess.PIPE, env=os.environ)
+        except (OSError, subprocess.SubprocessError) as e:
+            log.warning('Could not start local server "{}": {}'.format(command, e))
+            return False
+
+        log.debug("Local server process has started (PID={})".format(self._local_server_process.pid))
+        return True
+
+    def _checkLocalServerRunningSlot(self):
+        if self._local_server_process and not self._stopping:
+            if not self.localServerProcessIsRunning():
+                log.error("Local server process has stopped")
+                try:
+                    log.error(self._local_server_process.stderr.read().decode())
+                except (OSError, UnicodeDecodeError):
+                    pass
+                self._local_server_process = None
+
+    def localServerProcessIsRunning(self):
+        """
+        Returns either the local server is running.
+
+        :returns: boolean
+        """
+
+        try:
+            if self._local_server_process and self._local_server_process.poll() is None:
+                return True
+        except OSError:
+            pass
+        return False
+
+    def isLocalServerRunning(self):
+        """
+        Synchronous check if a server is already running on this host.
+
+        :returns: boolean
+        """
+
+        status, json_data = HTTPClient(self._settings).getSynchronous("GET", "/version")
+        if status == 401:  # Auth issue that need to be solved later
+            return True
+        elif json_data is None:
+            return False
+        elif status != 200:
+            return False
+        else:
+            version = json_data.get("version", None)
+            if version is None:
+                log.debug("Server is not a GNS3 server")
+                return False
+        return True
+
+    def stopLocalServer(self, wait=False):
+        """
+        Stops the local server.
+
+        :param wait: wait for the server to stop
+        """
+
+        if self.localServerProcessIsRunning():
+            self._stopping = True
+            log.debug("Stopping local server (PID={})".format(self._local_server_process.pid))
+            # local server is running, let's stop it
+            if self._http_client:
+                self._http_client.shutdown()
+            if wait:
+                worker = StopLocalServerWorker(self._local_server_process)
+                progress_dialog = ProgressDialog(worker, "Local server", "Waiting for the local server to stop...", None, busy=True, parent=self.parent())
+                progress_dialog.show()
+                progress_dialog.exec_()
+                if self._local_server_process.returncode is None:
+                    self._killLocalServer()
+            self._server_started_by_me = False
+
+    def _killLocalServer(self):
+        # the local server couldn't be stopped with the normal procedure
+        try:
+            if sys.platform.startswith("win"):
+                self._local_server_process.send_signal(signal.CTRL_BREAK_EVENT)
+            else:
+                self._local_server_process.send_signal(signal.SIGINT)
+        # If the process is already dead we received a permission error
+        # it's a race condition between the timeout and send signal
+        except (PermissionError, SystemError):
+            pass
+        try:
+            # wait for the server to stop for maximum x seconds
+            self._local_server_process.wait(timeout=60)
+        except subprocess.TimeoutExpired:
+            proceed = QtWidgets.QMessageBox.question(self.parent(),
+                                                     "Local server",
+                                                     "The Local server cannot be stopped, would you like to kill it?",
+                                                     QtWidgets.QMessageBox.Yes,
+                                                     QtWidgets.QMessageBox.No)
+
+            if proceed == QtWidgets.QMessageBox.Yes:
+                self._local_server_process.kill()
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of LocalServer.
+        :returns: instance of LocalServer
+        """
+
+        if not hasattr(LocalServer, '_instance') or LocalServer._instance is None:
+            LocalServer._instance = LocalServer()
+        return LocalServer._instance
+
+
+def main():
+    import pprint
+
+    pp = pprint.PrettyPrinter(indent=4)
+    print("Local server config")
+    local_server = LocalServer(False)
+    pp.pprint(local_server.localServerSettings())
+    local_server.localServerAutoStart()
+    local_server.stopLocalServer()
+
+
+if __name__ == '__main__':
+    main()

gns3/local_server_config.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2015 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 sys
+import configparser
+
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class LocalServerConfig:
+
+    """
+    Local server configuration.
+    """
+
+    def __init__(self, config_file=None):
+
+        appname = "GNS3"
+
+        self._config = configparser.RawConfigParser()
+
+        if config_file:
+            self._config_file = config_file
+        else:
+            if sys.platform.startswith("win"):
+                filename = "gns3_server.ini"
+            else:
+                filename = "gns3_server.conf"
+
+            from .local_config import LocalConfig
+            if sys.platform.startswith("win"):
+                self._config_file = os.path.join(LocalConfig.instance().configDirectory(), filename)
+            else:
+                self._config_file = os.path.join(LocalConfig.instance().configDirectory(), filename)
+
+        try:
+            # create the config file if it doesn't exist
+            open(self._config_file, "a").close()
+        except OSError as e:
+            log.error("Could not create the local server configuration {}: {}".format(self._config_file, e))
+        self.readConfig()
+
+    def setConfigFile(self, path):
+        """
+        Change the location of the server config (use for test)
+        """
+        self._config = configparser.RawConfigParser()
+        self._config_file = path
+        self.readConfig()
+
+    def readConfig(self):
+        """
+        Read the configuration file.
+        """
+
+        try:
+            self._config.read(self._config_file, encoding="utf-8")
+        except (OSError, configparser.Error, UnicodeEncodeError, UnicodeDecodeError) as e:
+            log.error("Could not read the local server configuration {}: {}".format(self._config_file, e))
+
+    def writeConfig(self):
+        """
+        Write the configuration file.
+        """
+
+        try:
+            log.debug("Write configuration file %s", self._config_file)
+            with open(self._config_file, "w", encoding="utf-8") as fp:
+                self._config.write(fp)
+        except (OSError, configparser.Error) as e:
+            log.error("Could not write the local server configuration {}: {}".format(self._config_file, e))
+
+    def loadSettings(self, section, default_settings):
+        """
+        Get all the settings from a given section.
+
+        :param section: section name
+        :param default_settings: setting names and default values (dict)
+
+        :returns: settings (dict)
+        """
+
+        if section not in self._config:
+            self._config[section] = {}
+
+        settings = {}
+        for name, default in default_settings.items():
+            if isinstance(default, bool):
+                settings[name] = self._config[section].getboolean(name, default)
+            elif isinstance(default, int):
+                settings[name] = self._config[section].getint(name, default)
+            elif isinstance(default, float):
+                settings[name] = self._config[section].getfloat(name, default)
+            else:
+                settings[name] = self._config[section].get(name, default)
+                if settings[name] == "None":
+                    settings[name] = None
+
+        # sync with the config file
+        self.saveSettings(section, settings)
+        return settings
+
+    def saveSettings(self, section, settings):
+        """
+        Save all the settings in a given section.
+
+        :param section: section name
+        :param settings: settings to save (dict)
+        """
+
+        changed = False
+        if section not in self._config:
+            self._config[section] = {}
+            changed = True
+
+        for name, value in settings.items():
+            if name not in self._config[section] or self._config[section][name] != str(value):
+                self._config[section][name] = str(value)
+                changed = True
+
+        if changed:
+            self.writeConfig()
+
+    def deleteSetting(self, section, name):
+        """
+        Delete a specific setting in a given section.
+
+        :param section: section name
+        :param name: setting name to delete
+        """
+
+        if section in self._config and name in self._config[section]:
+            del self._config[section][name]
+            self.writeConfig()
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of LocalServerConfig.
+
+        :returns: instance of Config
+        """
+
+        if not hasattr(LocalServerConfig, "_instance"):
+            LocalServerConfig._instance = LocalServerConfig()
+        return LocalServerConfig._instance

gns3/logger.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2015 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/>.
+
+"""Provide a pretty logging on console"""
+
+
+import logging
+import sys
+import os
+
+
+class ColouredFormatter(logging.Formatter):
+    RESET = '\x1B[0m'
+    RED = '\x1B[31m'
+    YELLOW = '\x1B[33m'
+    GREEN = '\x1B[32m'
+    PINK = '\x1b[35m'
+
+    def format(self, record, colour=False):
+
+        message = super().format(record)
+
+        if not colour or sys.platform.startswith("win"):
+            return message.replace("#RESET#", "")
+
+        level_no = record.levelno
+        if level_no >= logging.CRITICAL:
+            colour = self.RED
+        elif level_no >= logging.ERROR:
+            colour = self.RED
+        elif level_no >= logging.WARNING:
+            colour = self.YELLOW
+        elif level_no >= logging.INFO:
+            colour = self.GREEN
+        elif level_no >= logging.DEBUG:
+            colour = self.PINK
+        else:
+            colour = self.RESET
+
+        message = message.replace("#RESET#", self.RESET)
+        message = '{colour}{message}{reset}'.format(colour=colour, message=message, reset=self.RESET)
+
+        return message
+
+
+class ColouredStreamHandler(logging.StreamHandler):
+
+    def format(self, record, colour=False):
+
+        if not isinstance(self.formatter, ColouredFormatter):
+            self.formatter = ColouredFormatter()
+
+        return self.formatter.format(record, colour)
+
+    def emit(self, record):
+
+        stream = self.stream
+        try:
+            msg = self.format(record, stream.isatty())
+            stream.write(msg)
+            stream.write(self.terminator)
+            self.flush()
+        # On OSX when frozen flush raise a BrokenPipeError
+        except BrokenPipeError:
+            pass
+        except Exception:
+            self.handleError(record)
+
+
+def init_logger(level, logfile, quiet=False):
+    if sys.platform.startswith("win"):
+        stream_handler = logging.StreamHandler(sys.stdout)
+        stream_handler.formatter = ColouredFormatter("{asctime} {levelname} {name}:{lineno} {message}", "%Y-%m-%d %H:%M:%S", "{")
+    else:
+        stream_handler = ColouredStreamHandler(sys.stdout)
+        stream_handler.formatter = ColouredFormatter("{asctime} {levelname} {name}:{lineno}#RESET# {message}", "%Y-%m-%d %H:%M:%S", "{")
+    logging.basicConfig(level=level, handlers=[stream_handler])
+    log = logging.getLogger()
+    log.addHandler(stream_handler)
+
+    log_factory = logging.getLogRecordFactory()
+
+    def factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs):
+        """
+        Reformat the log message to get something more clean
+        """
+        # When qt message box is display the correct line number is a part of
+        # the name
+        if ":" in name:
+            name, lno = name.split(":")
+            lno = int(lno)
+        name = name.replace("gns3.", "")
+        try:
+            return log_factory(name, level, fn, lno, msg, args, exc_info, func=func, sinfo=sinfo, **kwargs)
+        except Exception as e:  # To avoid recursion we just print the message if something is wrong when logging
+            print(msg)
+            return
+    logging.setLogRecordFactory(factory)
+
+    try:
+        try:
+            os.makedirs(os.path.dirname(logfile))
+        except FileExistsError:
+            pass
+        handler = logging.FileHandler(logfile, "w")
+        handler.formatter = logging.Formatter("{asctime} {levelname} {filename}:{lineno} {message}", "%Y-%m-%d %H:%M:%S", "{")
+        log.addHandler(handler)
+    except OSError as e:
+        log.warning("could not log to {}: {}".format(logfile, e))
+
+    log.info('Log level: {}'.format(logging.getLevelName(level)))
+
+    return logging.getLogger()

gns3/main.py

@@ -16,25 +16,46 @@
 # 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 datetime
 import sys
 import os
+import faulthandler
+
+# Try to install updates & restart application if an update is installed
+try:
+    import gns3.update_manager
+    if gns3.update_manager.UpdateManager().installDownloadedUpdates():
+        print("Update installed restart the application")
+        python = sys.executable
+        os.execl(python, *sys.argv)
+except Exception as e:
+    print("Fail update installation: {}".format(str(e)))
+
+import datetime
 import traceback
 import time
 import locale
 import argparse
+import signal
+import psutil
+
+try:
+    from gns3.qt import QtCore, QtWidgets
+except ImportError:
+    raise SystemExit("Can't import Qt modules: Qt and/or PyQt is probably not installed correctly...")
+from gns3.main_window import MainWindow
+
+from gns3.logger import init_logger
+from gns3.crash_report import CrashReport
+from gns3.local_config import LocalConfig
+from gns3.application import Application
+from gns3.utils import parse_version
+from gns3.dialogs.profile_select import ProfileSelectDialog
+from gns3.version import __version__
+
 
 import logging
 log = logging.getLogger(__name__)
 
-try:
-    from gns3.qt import QtCore, QtGui, DEFAULT_BINDING
-except ImportError:
-    raise RuntimeError("Can't import Qt modules: Qt and/or PyQt is probably not installed correctly...")
-
-from gns3.main_window import MainWindow
-from gns3.version import __version__
-
 
 def locale_check():
     """
@@ -48,8 +69,8 @@ def locale_check():
     or there: http://robjwells.com/post/61198832297/get-your-us-ascii-out-of-my-face
     """
 
-    # no need to check on Windows
-    if sys.platform.startswith("win"):
+    # no need to check on Windows or when frozen
+    if sys.platform.startswith("win") or hasattr(sys, "frozen"):
         return
 
     language = encoding = None
@@ -59,17 +80,18 @@ def locale_check():
         log.error("could not determine the current locale: {}".format(e))
     if not language and not encoding:
         try:
-            log.warn("could not find a default locale, switching to C.UTF-8...")
+            log.warning("could not find a default locale, switching to C.UTF-8...")
             locale.setlocale(locale.LC_ALL, ("C", "UTF-8"))
         except locale.Error as e:
             log.error("could not switch to the C.UTF-8 locale: {}".format(e))
             raise SystemExit
     elif encoding != "UTF-8":
-        log.warn("your locale {}.{} encoding is not UTF-8, switching to the UTF-8 version...".format(language, encoding))
+        log.warning("your locale {}.{} encoding is not UTF-8, switching to the UTF-8 version...".format(language, encoding))
         try:
             locale.setlocale(locale.LC_ALL, (language, "UTF-8"))
         except locale.Error as e:
             log.error("could not set an UTF-8 encoding for the {} locale: {}".format(language, e))
+            raise SystemExit
     else:
         log.info("current locale is {}.{}".format(language, encoding))
 
@@ -79,10 +101,57 @@ def main():
     Entry point for GNS3 GUI.
     """
 
+    # Get Python tracebacks explicitly, on a fault like segfault
+    faulthandler.enable()
+
+    # Sometimes (for example at first launch) the OSX app service launcher add
+    # an extra argument starting with -psn_. We filter it
+    if sys.platform.startswith("darwin"):
+        sys.argv = [a for a in sys.argv if not a.startswith("-psn_")]
+        if parse_version(QtCore.QT_VERSION_STR) < parse_version("5.15.2"):
+            # Fixes issue on macOS Big Sur: https://github.com/GNS3/gns3-gui/issues/3037
+            os.environ["QT_MAC_WANTS_LAYER"] = "1"
+
     parser = argparse.ArgumentParser()
-    parser.add_argument('--version', help="show the version", action='version', version=__version__)
-    parser.parse_args()
-    exception_file_path = "exception.log"
+    parser.add_argument("project", help="load a GNS3 project (.gns3)", metavar="path", nargs="?")
+    parser.add_argument("--version", help="show the version", action="version", version=__version__)
+    parser.add_argument("--debug", help="print out debug messages", action="store_true", default=False)
+    parser.add_argument("-q", "--quiet", action="store_true", help="do not show logs on stdout")
+    parser.add_argument("--config", help="Configuration file")
+    parser.add_argument("--profile", help="Settings profile (blank will use default settings files)")
+    options = parser.parse_args()
+    exception_file_path = "exceptions.log"
+
+    if options.project:
+        options.project = os.path.abspath(options.project)
+
+    try:
+        import truststore
+        truststore.inject_into_ssl()
+        log.info("Using system certificate store for SSL connections")
+    except ImportError:
+        pass
+
+    if hasattr(sys, "frozen"):
+        # We add to the path where the OS search executable our binary location starting by GNS3
+        # packaged binary
+        frozen_dir = os.path.dirname(os.path.abspath(sys.executable))
+        if sys.platform.startswith("darwin"):
+            frozen_dirs = [frozen_dir]
+        elif sys.platform.startswith("win"):
+            frozen_dirs = [
+                frozen_dir,
+                os.path.normpath(os.path.join(frozen_dir, 'dynamips')),
+                os.path.normpath(os.path.join(frozen_dir, 'ubridge')),
+                os.path.normpath(os.path.join(frozen_dir, 'vpcs')),
+                os.path.normpath(os.path.join(frozen_dir, 'traceng'))
+            ]
+
+        os.environ["PATH"] = os.pathsep.join(frozen_dirs) + os.pathsep + os.environ.get("PATH", "")
+
+        if options.project:
+            os.chdir(frozen_dir)
+
 
     def exceptionHook(exception, value, tb):
 
@@ -91,93 +160,159 @@ def main():
 
         lines = traceback.format_exception(exception, value, tb)
         print("****** Exception detected, traceback information saved in {} ******".format(exception_file_path))
-        print("\n----> PLEASE REPORT ON http://forum.gns3.net/development-f14.html OR http://github.com/GNS3/gns3-gui/issues\n")
-        print("\n" . join(lines))
+        print("\nPLEASE REPORT ON https://www.gns3.com\n")
+        print("".join(lines))
         try:
             curdate = time.strftime("%d %b %Y %H:%M:%S")
-            logfile = open(exception_file_path, "a")
+            logfile = open(exception_file_path, "a", encoding="utf-8")
             logfile.write("=== GNS3 {} traceback on {} ===\n".format(__version__, curdate))
-            logfile.write("\n" . join(lines))
+            logfile.write("".join(lines))
             logfile.close()
         except OSError as e:
-            print("Could not save traceback to {}: {}".format(exception_file_path, e))
+            print("Could not save traceback to {}: {}".format(os.path.normpath(exception_file_path), e))
+
+        if not sys.stdout.isatty():
+            # if stdout is not a tty (redirected to the console view),
+            # then print the exception on stderr too.
+            print("".join(lines), file=sys.stderr)
+
+        if exception is MemoryError:
+            print("YOUR SYSTEM IS OUT OF MEMORY!")
+        else:
+            CrashReport.instance().captureException(exception, value, tb)
 
     # catch exceptions to write them in a file
     sys.excepthook = exceptionHook
 
-    current_year = datetime.date.today().year
-    print("GNS3 GUI version {}".format(__version__))
-    print("Copyright (c) 2007-{} GNS3 Technologies Inc.".format(current_year))
+    # we only support Python 3 version >= 3.8
+    if sys.version_info < (3, 8):
+        raise SystemExit("Python 3.8 or higher is required")
 
-    # we only support Python 2 version >= 2.7 and Python 3 version >= 3.3
-    if sys.version_info < (2, 7):
-        raise RuntimeError("Python 2.7 or higher is required")
-    elif sys.version_info[0] == 3 and sys.version_info < (3, 3):
-        raise RuntimeError("Python 3.3 or higher is required")
+    if parse_version(QtCore.QT_VERSION_STR) < parse_version("5.5.0"):
+        raise SystemExit("Requirement is PyQt5 version 5.5.0 or higher, got version {}".format(QtCore.QT_VERSION_STR))
 
-    version = lambda version_string: [int(i) for i in version_string.split('.')]
-
-    if version(QtCore.QT_VERSION_STR) < version("4.6"):
-        raise RuntimeError("Requirement is Qt version 4.6 or higher, got version {}".format(QtCore.QT_VERSION_STR))
-
-    # 4.8.3 because of QSettings (http://pyqt.sourceforge.net/Docs/PyQt4/pyqt_qsettings.html)
-    if DEFAULT_BINDING == "PyQt" and version(QtCore.BINDING_VERSION_STR) < version("4.8.3"):
-        raise RuntimeError("Requirement is PyQt version 4.8.3 or higher, got version {}".format(QtCore.BINDING_VERSION_STR))
-
-    if DEFAULT_BINDING == "PySide" and version(QtCore.BINDING_VERSION_STR) < version("1.0"):
-        raise RuntimeError("Requirement is PySide version 1.0 or higher, got version {}".format(QtCore.BINDING_VERSION_STR))
-
-    try:
-        # if tornado is present then enable pretty logging.
-        import tornado.log
-        tornado.log.enable_pretty_logging()
-    except ImportError:
-        pass
+    if parse_version(psutil.__version__) < parse_version("2.2.1"):
+        raise SystemExit("Requirement is psutil version 2.2.1 or higher, got version {}".format(psutil.__version__))
 
     # check for the correct locale
     # (UNIX/Linux only)
     locale_check()
 
-    # don't use the registry to store settings on Windows
-    # because we don't like it!
-    if sys.platform.startswith('win'):
+    try:
+        os.getcwd()
+    except FileNotFoundError:
+        log.critical("the current working directory doesn't exist")
+        return
+
+    # always use the INI format on Windows and OSX (because we don't like the registry and plist files)
+    if sys.platform.startswith('win') or sys.platform.startswith('darwin'):
         QtCore.QSettings.setDefaultFormat(QtCore.QSettings.IniFormat)
 
+    if sys.platform.startswith('win') and hasattr(sys, "frozen"):
         try:
             import win32console
             import win32con
             import win32gui
         except ImportError:
-            raise RuntimeError("Python for Windows extensions must be installed.")
+            raise SystemExit("Python for Windows extensions must be installed.")
 
-        try:
-            win32console.AllocConsole()
-            #FIXME: do not hide the console for alpha releases to help with debugging
-            #console_window = win32console.GetConsoleWindow()
-            #win32gui.ShowWindow(console_window, win32con.SW_HIDE)
-        except win32console.error as e:
-            print("warning: could not allocate console: {}".format(e))
+        if not options.debug:
+            try:
+                # hide the console
+                # win32console.AllocConsole()
+                console_window = win32console.GetConsoleWindow()
+                parent_window = win32gui.GetParent(console_window)
+                if not parent_window and console_window:
+                    win32gui.ShowWindow(console_window, win32con.SW_HIDE)
+                elif parent_window:
+                    win32gui.ShowWindow(parent_window, win32con.SW_HIDE)
+                else:
+                    log.warning("Could not get the console window")
+            except win32console.error as e:
+                log.warning("Could not allocate console: {}".format(e))
 
-    exit_code = MainWindow.exit_code_reboot
-    while exit_code == MainWindow.exit_code_reboot:
+    local_config = LocalConfig.instance()
 
-        exit_code = 0
-        app = QtGui.QApplication(sys.argv)
+    global app
+    app = Application(sys.argv, hdpi=local_config.hdpi())
 
-        # this info is necessary for QSettings
-        app.setOrganizationName("GNS3")
-        app.setOrganizationDomain("gns3.net")
-        app.setApplicationName("GNS3")
-        app.setApplicationVersion(__version__)
+    if local_config.multiProfiles() and not options.profile:
+        profile_select = ProfileSelectDialog()
+        profile_select.show()
+        if profile_select.exec_():
+            options.profile = profile_select.profile()
+        else:
+            sys.exit(0)
 
-        # update the exception file path to have it in the same directory as the settings file.
-        exception_file_path = os.path.join(os.path.dirname(QtCore.QSettings().fileName()), exception_file_path)
+    # Init the config
+    if options.config:
+        local_config.setConfigFilePath(options.config)
+    elif options.profile:
+        local_config.setProfile(options.profile)
 
-        mainwindow = MainWindow.instance()
-        mainwindow.show()
-        exit_code = app.exec_()
-        delattr(MainWindow, "_instance")
-        app.deleteLater()
+    # save client logging info to a file
+    logfile = os.path.join(LocalConfig.instance().configDirectory(), "gns3_gui.log")
+
+    # on debug enable logging to stdout
+    if options.debug:
+        init_logger(logging.DEBUG, logfile)
+    elif options.quiet:
+        init_logger(logging.ERROR, logfile)
+    else:
+        init_logger(logging.INFO, logfile)
+
+    current_year = datetime.date.today().year
+    log.info("GNS3 GUI version {}".format(__version__))
+    log.info("Copyright (c) 2007-{} GNS3 Technologies Inc.".format(current_year))
+    log.info("Application started with {}".format(" ".join(sys.argv)))
+    log.debug("PATH={}".format(os.environ["PATH"]))
+
+    # update the exception file path to have it in the same directory as the settings file.
+    exception_file_path = os.path.join(LocalConfig.instance().configDirectory(), exception_file_path)
+
+    # We disallow to run GNS3 from outside the /Applications folder to avoid
+    # issue when people run GNS3 from the .dmg
+    if sys.platform.startswith("darwin") and hasattr(sys, "frozen"):
+        if not os.path.realpath(sys.executable).startswith("/Applications"):
+            error_message = "GNS3.app must be moved to the '/Applications' folder before it can be used"
+            QtWidgets.QMessageBox.critical(False, "Loading error", error_message)
+            QtCore.QTimer.singleShot(0, app.quit)
+            app.exec_()
+            sys.exit(1)
+
+    global mainwindow
+    startup_file = app.open_file_at_startup
+    if not startup_file:
+        startup_file = options.project
+
+    mainwindow = MainWindow(open_file=startup_file)
+
+    # On OSX we can receive the file to open from a system event
+    # loadPath is smart and will load only if a path is present
+    app.file_open_signal.connect(lambda path: mainwindow.loadPath(path))
+
+    # Manage Ctrl + C or kill command
+    def sigint_handler(*args):
+        log.info("Signal received exiting the application")
+        app.closeAllWindows()
+    orig_sigint = signal.signal(signal.SIGINT, sigint_handler)
+    orig_sigterm = signal.signal(signal.SIGTERM, sigint_handler)
+
+    mainwindow.show()
+
+    exit_code = app.exec_()
+    signal.signal(signal.SIGINT, orig_sigint)
+    signal.signal(signal.SIGTERM, orig_sigterm)
+
+    delattr(MainWindow, "_instance")
+
+    # We force deleting the app object otherwise it's segfault on Fedora
+    del app
+    # We force a full garbage collect before exit
+    # for unknown reason otherwise Qt Segfault on OSX in some
+    # conditions
+    import gc
+    gc.collect()
 
     sys.exit(exit_code)
 

gns3/modules/__init__.py

@@ -15,7 +15,16 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from gns3.modules.builtin import Builtin
 from gns3.modules.dynamips import Dynamips
 from gns3.modules.iou import IOU
+from gns3.modules.vpcs import VPCS
+from gns3.modules.traceng import TraceNG
+from gns3.modules.virtualbox import VirtualBox
+from gns3.modules.qemu import Qemu
+from gns3.modules.vmware import VMware
+from gns3.modules.docker import Docker
 
-MODULES = [Dynamips, IOU]
+#MODULES = [Builtin, VPCS, Dynamips, IOU, Qemu, VirtualBox, VMware, Docker, TraceNG]
+#FIXME: deactivate TraceNG module
+MODULES = [Builtin, VPCS, Dynamips, IOU, Qemu, VirtualBox, VMware, Docker]

gns3/modules/builtin/__init__.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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/>.
+
+"""
+Built-in module implementation.
+"""
+
+from gns3.qt import QtWidgets
+from gns3.local_config import LocalConfig
+from gns3.local_server_config import LocalServerConfig
+
+from ..module import Module
+from .cloud import Cloud
+from .nat import Nat
+from .ethernet_hub import EthernetHub
+from .ethernet_switch import EthernetSwitch
+from .frame_relay_switch import FrameRelaySwitch
+from .atm_switch import ATMSwitch
+from .settings import BUILTIN_SETTINGS
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class Builtin(Module):
+
+    """
+    Built-in module.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self._loadSettings()
+
+    def _saveSettings(self):
+        """
+        Saves the settings to the persistent settings file.
+        """
+
+        LocalConfig.instance().saveSectionSettings(self.__class__.__name__, self._settings)
+
+        server_settings = {}
+        config = LocalServerConfig.instance()
+        if self._settings["default_nat_interface"]:
+            # save some settings to the local server config file
+            server_settings["default_nat_interface"] = self._settings["default_nat_interface"]
+            config.saveSettings(self.__class__.__name__, server_settings)
+        else:
+            config.deleteSetting(self.__class__.__name__, "default_nat_interface")
+
+    def _loadSettings(self):
+        """
+        Loads the settings from the persistent settings file.
+        """
+
+        local_config = LocalConfig.instance()
+        self._settings = local_config.loadSectionSettings(self.__class__.__name__, BUILTIN_SETTINGS)
+
+    @staticmethod
+    def configurationPage(node_type):
+        """
+        Returns the configuration page for this module.
+
+        :returns: QWidget object
+        """
+
+        from .pages.ethernet_hub_configuration_page import EthernetHubConfigurationPage
+        from .pages.ethernet_switch_configuration_page import EthernetSwitchConfigurationPage
+        from .pages.cloud_configuration_page import CloudConfigurationPage
+        if node_type == "ethernet_hub":
+            return EthernetHubConfigurationPage
+        elif node_type == "ethernet_switch":
+            return EthernetSwitchConfigurationPage
+        elif node_type == "cloud":
+            return CloudConfigurationPage
+        return None
+
+    @staticmethod
+    def getNodeClass(node_type, platform=None):
+        """
+        Returns the class corresponding to node type.
+
+        :param node_type: node type (string)
+        :param platform: not used
+
+        :returns: class or None
+        """
+
+        if node_type == "cloud":
+            return Cloud
+        elif node_type == "nat":
+            return Nat
+        elif node_type == "ethernet_hub":
+            return EthernetHub
+        elif node_type == "ethernet_switch":
+            return EthernetSwitch
+        elif node_type == "frame_relay_switch":
+            return FrameRelaySwitch
+        elif node_type == "atm_switch":
+            return ATMSwitch
+        return None
+
+    @staticmethod
+    def classes():
+        """
+        Returns all the node classes supported by this module.
+
+        :returns: list of classes
+        """
+
+        return [Nat, Cloud, EthernetHub, EthernetSwitch, FrameRelaySwitch, ATMSwitch]
+
+    @staticmethod
+    def preferencePages():
+        """
+        :returns: QWidget object list
+        """
+
+        from .pages.builtin_preferences_page import BuiltinPreferencesPage
+        from .pages.cloud_preferences_page import CloudPreferencesPage
+        from .pages.ethernet_hub_preferences_page import EthernetHubPreferencesPage
+        from .pages.ethernet_switch_preferences_page import EthernetSwitchPreferencesPage
+
+        return [BuiltinPreferencesPage, EthernetHubPreferencesPage, EthernetSwitchPreferencesPage, CloudPreferencesPage]
+
+    @staticmethod
+    def instance():
+        """
+        Singleton to return only on instance of built-in module.
+
+        :returns: instance of Builtin
+        """
+
+        if not hasattr(Builtin, "_instance"):
+            Builtin._instance = Builtin()
+        return Builtin._instance
+
+    def __str__(self):
+        """
+        Returns the module name.
+        """
+
+        return "builtin"

gns3/modules/builtin/atm_switch.py

@@ -0,0 +1,145 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014 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 re
+
+from gns3.node import Node
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class ATMSwitch(Node):
+
+    """
+    ATM switch.
+
+    :param module: parent module for this node
+    :param server: GNS3 server instance
+    :param project: Project instance
+    """
+
+    URL_PREFIX = "atm_switch"
+
+    def __init__(self, module, server, project):
+
+        super().__init__(module, server, project)
+        # this is an always-on node
+        self.setStatus(Node.started)
+        self._always_on = True
+        self.settings().update({"mappings": {}})
+
+    def info(self):
+        """
+        Returns information about this ATM switch.
+
+        :returns: formatted string
+        """
+
+        info = """ATM switch {name} is always-on
+  Running on server {host} with port {port}
+  Local ID is {id} and server ID is {node_id}
+  Hardware is Dynamips emulated simple ATM switch
+""".format(name=self.name(),
+           id=self.id(),
+           node_id=self._node_id,
+           host=self._compute.name(),
+           port=self._compute.port())
+
+        port_info = ""
+        mapping = re.compile(r"""^([0-9]*):([0-9]*):([0-9]*)$""")
+        for port in self._ports:
+            if port.isFree():
+                port_info += "   Port {} is empty\n".format(port.name())
+            else:
+                port_info += "   Port {name} {description}\n".format(name=port.name(),
+                                                                     description=port.description())
+
+            for source, destination in self._settings["mappings"].items():
+                match_source_mapping = mapping.search(source)
+                match_destination_mapping = mapping.search(destination)
+                if match_source_mapping and match_destination_mapping:
+                    source_port, source_vpi, source_vci = match_source_mapping.group(1, 2, 3)
+                    destination_port, destination_vpi, destination_vci = match_destination_mapping.group(1, 2, 3)
+                else:
+                    source_port, source_vpi = source.split(":")
+                    destination_port, destination_vpi = destination.split(":")
+                    source_vci = destination_vci = 0
+
+                if port.name() == source_port or port.name() == destination_port:
+                    if port.name() == source_port:
+                        vpi1 = source_vpi
+                        vci1 = source_vci
+                        port = destination_port
+                        vci2 = destination_vci
+                        vpi2 = destination_vpi
+                    else:
+                        vpi1 = destination_vpi
+                        vci1 = destination_vci
+                        port = source_port
+                        vci2 = source_vci
+                        vpi2 = source_vpi
+
+                    if vci1 and vci2:
+                        port_info += "      incoming VPI {vpi1} and VCI {vci1} is switched to port {port} outgoing VPI {vpi2} and VCI {vci2}\n".format(vpi1=vpi1,
+                                                                                                                                                       vci1=vci1,
+                                                                                                                                                       port=port,
+                                                                                                                                                       vpi2=vpi2,
+                                                                                                                                                       vci2=vci2)
+                    else:
+                        port_info += "      incoming VPI {vpi1} is switched to port {port} outgoing VPI {vpi2}\n".format(vpi1=vpi1,
+                                                                                                                         port=port,
+                                                                                                                         vpi2=vpi2)
+
+                    break
+
+        return info + port_info
+
+    def configPage(self):
+        """
+        Returns the configuration page widget to be used by the node properties dialog.
+
+        :returns: QWidget object
+        """
+
+        from .pages.atm_switch_configuration_page import ATMSwitchConfigurationPage
+        return ATMSwitchConfigurationPage
+
+    @staticmethod
+    def defaultSymbol():
+        """
+        Returns the default symbol path for this node.
+
+        :returns: symbol path (or resource).
+        """
+
+        return ":/symbols/atm_switch.svg"
+
+    @staticmethod
+    def categories():
+        """
+        Returns the node categories the node is part of (used by the device panel).
+
+        :returns: list of node categories
+        """
+
+        return [Node.switches]
+
+    def __str__(self):
+
+        return "ATM switch"

gns3/modules/builtin/cloud.py

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2016 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/>.
+
+from gns3.node import Node
+from .settings import CLOUD_SETTINGS
+
+import logging
+log = logging.getLogger(__name__)
+
+
+class Cloud(Node):
+
+    """
+    Cloud node
+
+    :param module: parent module for this node
+    :param server: GNS3 server instance
+    :param project: Project instance
+    """
+
+    URL_PREFIX = "cloud"
+
+    def __init__(self, module, server, project):
+
+        super().__init__(module, server, project)
+        # this is an always-on node
+        self.setStatus(Node.started)
+        self._always_on = True
+        self._interfaces = {}
+        self._cloud_settings = {"ports_mapping": [],
+                                "remote_console_host": CLOUD_SETTINGS["remote_console_host"],
+                                "remote_console_port": CLOUD_SETTINGS["remote_console_port"],
+                                "remote_console_type": CLOUD_SETTINGS["remote_console_type"],
+                                "remote_console_http_path": CLOUD_SETTINGS["remote_console_http_path"]
+                                }
+        self.settings().update(self._cloud_settings)
+
+    def interfaces(self):
+
+        return self._interfaces
+
+    def _createCallback(self, result):
+        """
+        Callback for create.
+
+        :param result: server response
+        """
+
+        if "interfaces" in result:
+            self._interfaces = result["interfaces"].copy()
+
+    def _updateCallback(self, result):
+        """
+        Callback for update.
+
+        :param result: server response
+        """
+
+        if "interfaces" in result:
+            self._interfaces = result["interfaces"].copy()
+
+    def consoleType(self):
+        """
+        Get the console type.
+        """
+
+        return self.settings()["remote_console_type"]
+
+    def consoleHost(self):
+        """
+        Returns the host to connect to the console.
+
+        :returns: host (string)
+        """
+
+        return self.settings()["remote_console_host"]
+
+    def console(self):
+        """
+        Returns the console port number of this node
+
+        :returns: port number
+        """
+
+        return self.settings()["remote_console_port"]
+
+    def consoleHttpPath(self):
+        """
+        Returns the path of the web ui
+
+        :returns: string
+        """
+        return self._settings["remote_console_http_path"]
+
+    def info(self):
+        """
+        Returns information about this cloud.
+
+        :returns: formatted string
+        """
+
+        info = """Cloud {name} is always-on
+  Running on server {host} with port {port}
+""".format(name=self.name(),
+           host=self.compute().name(),
+           port=self.compute().port())
+
+        if self.consoleType() != "none":
+            info += """   Remote console is {console_host} on port {console} and type is {console_type}
+""".format(console_host=self.consoleHost(),
+           console=self.console(),
+           console_type=self.consoleType())
+            if self.consoleType() in ("http", "https"):
+                info += """   Remote console HTTP path is '{console_http_path}'
+""".format(console_http_path=self.consoleHttpPath())
+        else:
+            info += """   No remote console configured
+"""
+
+        port_info = ""
+        for port in self._ports:
+            if port.isFree():
+                port_info += "   Port {} is empty\n".format(port.name())
+            else:
+                port_info += "   Port {name} {description}\n".format(name=port.name(),
+                                                                     description=port.description())
+
+        return info + port_info
+
+    def configPage(self):
+        """
+        Returns the configuration page widget to be used by the node properties dialog.
+
+        :returns: QWidget object
+        """
+
+        from .pages.cloud_configuration_page import CloudConfigurationPage
+        return CloudConfigurationPage
+
+    @staticmethod
+    def defaultSymbol():
+        """
+        Returns the default symbol path for this cloud.
+
+        :returns: symbol path (or resource).
+        """
+
+        return ":/symbols/cloud.svg"
+
+    @staticmethod
+    def categories():
+        """
+        Returns the node categories the node is part of (used by the device panel).
+
+        :returns: list of node categories
+        """
+
+        return [Node.end_devices]
+
+    def __str__(self):
+
+        return "Cloud"