Fixed Windows issue with the combination of Python 3.8, bcrypt 3.1.7, and Cryptography 3.0

2. Updated the create "pldbgapi" extension for the debugger.

refs #5343

.gitignore

@@ -41,6 +41,7 @@ web/config_local.py
 web/pgadmin/misc/themes/pgadmin.themes.json
 web/geckodriver.log
 web/regression/test_config.json
+web/regression/.coveragerc
 node_modules/
 web/pgAdmin/static/js/generated
 web/pgadmin/static/js/generated
@@ -48,3 +49,10 @@ web/yarn-error.log
 /web/cacert.pem
 auditjs.html
 auditpy.txt
+/venv/
+.scannerwork/
+web/coverage/
+web/.coverage
+web/regression/.coverage
+web/regression/covhtml/
+web/regression/htmlcov/

Dockerfile

@@ -12,7 +12,7 @@
 # and clean up the web/ source code
 #########################################################################
 
-FROM node:10-alpine AS app-builder
+FROM node:12-alpine3.11 AS app-builder
 
 RUN apk add --no-cache \
     autoconf \
@@ -45,12 +45,10 @@ RUN npm install && \
 	npm audit fix && \
 	rm -f yarn.lock && \
 	yarn import && \
-# Commented the below line to avoid vulnerability in decompress package and
-# audit only dependencies folder. Refer https://www.npmjs.com/advisories/1217.
-# Pull request is already been send https://github.com/kevva/decompress/pull/73,
-# once fixed we will uncomment it.
+# Commented the below line to avoid vulnerability in lodash package.
+# Refer https://www.npmjs.com/advisories/1523.
+# Once fixed we will uncomment it.
 #	yarn audit && \
-	yarn audit --groups dependencies && \
 	rm -f package-lock.json && \
     yarn run bundle && \
     rm -rf node_modules \
@@ -66,7 +64,7 @@ RUN npm install && \
 # Now, create a documentation build container for the Sphinx docs
 #########################################################################
 
-FROM python:3.7-alpine3.10 as docs-builder
+FROM python:3.8-alpine3.11 as docs-builder
 
 # Install only dependencies absolutely required for documentation building
 RUN apk add --no-cache \
@@ -98,21 +96,15 @@ RUN LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 make -C /pgadmin4/docs/en_US -f Makefile
 # Create additional builders to get all of the PostgreSQL utilities
 #########################################################################
 
-FROM postgres:9.4-alpine as pg94-builder
 FROM postgres:9.5-alpine as pg95-builder
 FROM postgres:9.6-alpine as pg96-builder
 FROM postgres:10-alpine as pg10-builder
 FROM postgres:11-alpine as pg11-builder
 FROM postgres:12-alpine as pg12-builder
 
-FROM alpine:3.10 as tool-builder
+FROM alpine:3.11 as tool-builder
 
 # Copy the PG binaries
-COPY --from=pg94-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-9.4/
-COPY --from=pg94-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-9.4/
-COPY --from=pg94-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-9.4/
-COPY --from=pg94-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-9.4/
-
 COPY --from=pg95-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-9.5/
 COPY --from=pg95-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-9.5/
 COPY --from=pg95-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-9.5/
@@ -142,7 +134,7 @@ COPY --from=pg12-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-12/
 # Assemble everything into the final container.
 #########################################################################
 
-FROM python:3.7-alpine3.10
+FROM python:3.8-alpine3.11
 
 COPY --from=tool-builder /usr/local/pgsql /usr/local/
 
@@ -154,6 +146,10 @@ COPY --from=app-builder /pgadmin4/web /pgadmin4
 COPY --from=docs-builder /pgadmin4/docs/en_US/_build/html/ /pgadmin4/docs
 COPY requirements.txt /pgadmin4/requirements.txt
 
+# License files
+COPY LICENSE /pgadmin4/LICENSE
+COPY DEPENDENCIES /pgadmin4/DEPENDENCIES
+
 # Install build-dependencies, build & install C extensions and purge deps in
 # one RUN step
 RUN apk add --no-cache --virtual \
@@ -181,6 +177,7 @@ RUN ln -sf /usr/lib/libpq.so.5.12 /usr/lib/libpq.so.5
 
 # Copy the runner script
 COPY pkg/docker/run_pgadmin.py /pgadmin4
+COPY pkg/docker/gunicorn_config.py /pgadmin4
 COPY pkg/docker/entrypoint.sh /entrypoint.sh
 
 # Precompile and optimize python code to save time and space on startup
@@ -194,7 +191,7 @@ RUN groupadd -g 5050 pgadmin && \
     chown pgadmin:pgadmin /var/log/pgadmin && \
     touch /pgadmin4/config_distro.py && \
     chown pgadmin:pgadmin /pgadmin4/config_distro.py && \
-    setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/python3.7
+    setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/python3.8
 USER pgadmin
 
 # Finish up

Make.bat

@@ -2,23 +2,26 @@
 SETLOCAL
 
 SET WD=%CD%
-SET "PGBUILDPATH=%WD%\win-build"
+SET "BUILDROOT=%WD%\win-build"
+SET "DISTROOT=%WD%\dist"
 
-SET CMDOPTION=""
-IF "%1" == "clean"  SET CMDOPTION="VALID"
-IF "%1" == "x86"    SET CMDOPTION="VALID"
+SET CMDOPTIONS=""
+IF "%1" == "clean" SET CMDOPTIONS="VALID"
+IF "%1" == ""      SET CMDOPTIONS="VALID"
 
-IF NOT %CMDOPTION%=="VALID" (
+IF NOT %CMDOPTIONS%=="VALID" (
     GOTO USAGE
 )
 
-SET ARCHITECTURE=%1
-
-IF "%ARCHITECTURE%"=="clean" (
+IF "%1" == "clean" (
     CALL :CLEAN
     EXIT /B %ERRORLEVEL%
 )
 
+set "ARCHITECTURE=x64"
+if "%Platform%" == "X86" (
+    set "ARCHITECTURE=x86"
+)
 
 REM Main build sequence
 CALL :SET_ENVIRONMENT
@@ -37,7 +40,7 @@ REM Main build sequence Ends
 
 :CLEAN
     ECHO Removing build directory...
-    IF EXIST "%PGBUILDPATH%" RD "%PGBUILDPATH%" /S /Q > nul || EXIT /B 1
+    IF EXIST "%BUILDROOT%" RD "%BUILDROOT%" /S /Q > nul || EXIT /B 1
 
     ECHO Removing temp build directory...
     IF EXIST "%WD%\pkg\win32\Output" rd "%WD%\pkg\win32\Output" /S /Q > nul || EXIT /B 1
@@ -50,40 +53,32 @@ REM Main build sequence Ends
 
 :SET_ENVIRONMENT
     ECHO Configuring the environment...
-    IF "%PYTHON_HOME%" == ""   SET "PYTHON_HOME=C:\Python27"
-    IF "%PYTHON_DLL%" == ""    SET "PYTHON_DLL=C:\Windows\SysWOW64\python27.dll"
-    IF "%QTDIR%" == ""         SET "QTDIR=C:\Qt\5.9.1\mingw53_32"
-    IF "%MAKE%" == ""          SET "MAKE=mingw32-make.exe"
-    IF "%PGDIR%" == ""         SET "PGDIR=C:\Program Files (x86)\PostgreSQL\10"
-    IF "%INNOTOOL%" == ""      SET "INNOTOOL=C:\Program Files (x86)\Inno Setup 5"
-    IF "%VCREDIST%" == ""      SET "VCREDIST=C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\redist\1033\vcredist_x86.exe"
-    IF "%SIGNTOOL%" == ""      SET "SIGNTOOL=C:\Program Files\Microsoft SDKs\Windows\v7.1A\Bin\signtool.exe"
+    IF "%PGADMIN_PYTHON_DIR%" == ""   SET "PGADMIN_PYTHON_DIR=C:\Python38"
+    IF "%PGADMIN_QT_DIR%" == ""       SET "PGADMIN_QT_DIR=C:\Qt\5.14.2\msvc2017_64"
+    IF "%PGADMIN_POSTGRES_DIR%" == "" SET "PGADMIN_POSTGRES_DIR=C:\Program Files (x86)\PostgreSQL\12"
+    IF "%PGADMIN_INNOTOOL_DIR%" == "" SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
+    IF "%PGADMIN_VCREDIST_DIR%" == "" SET "PGADMIN_VCREDIST_DIR=C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\14.16.27012"
+    IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.17763.0\x64"
 
-    REM Set VCREDISTNAME (the filename)
-    for /f "delims=" %%i in ("%VCREDIST%") do set "VCREDISTNAME=%%~nxi"
+    REM Set REDIST_NAME (the filename)
+    set "VCREDIST_FILE=vcredist_%ARCHITECTURE%.exe"
 
     REM Set additional variables we need
-    SET "QMAKE=%QTDIR%\bin\qmake.exe"
-    FOR /F "tokens=4,5 delims=. " %%a IN ('%QMAKE% -v ^| findstr /B /C:"Using Qt version "') DO SET QT_VERSION=%%a.%%b
-
-    SET "VIRTUALENV=venv"
-    SET "TARGET_DIR=%WD%\dist"
-
-    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_RELEASE =" %WD%\web\config.py')    DO SET APP_MAJOR=%%a
-    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_REVISION =" %WD%\web\config.py')   DO SET APP_MINOR=%%a
-    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_SUFFIX =" %WD%\web\config.py')     DO SET APP_VERSION_SUFFIX=%%a
+    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_RELEASE =" %WD%\web\config.py')  DO SET APP_MAJOR=%%a
+    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_REVISION =" %WD%\web\config.py') DO SET APP_MINOR=%%a
+    FOR /F "tokens=3" %%a IN ('findstr /C:"APP_SUFFIX =" %WD%\web\config.py')   DO SET APP_VERSION_SUFFIX=%%a
     REM remove single quote from the string
     SET APP_VERSION_SUFFIX=%APP_VERSION_SUFFIX:'=%
     SET APP_NAME=""
-    FOR /F "tokens=2* DELims='" %%a IN ('findstr /C:"APP_NAME =" web\config.py')   DO SET APP_NAME=%%a
-    FOR /f "tokens=1 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "print('%APP_NAME%'.lower().replace(' ', ''))"') DO SET APP_SHORTNAME=%%G
+    FOR /F "tokens=2* DELims='" %%a IN ('findstr /C:"APP_NAME =" web\config.py') DO SET APP_NAME=%%a
+    FOR /f "tokens=1 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "print('%APP_NAME%'.lower().replace(' ', ''))"') DO SET APP_SHORTNAME=%%G
     SET APP_VERSION=%APP_MAJOR%.%APP_MINOR%
     SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%APP_VERSION_SUFFIX%-%ARCHITECTURE%.exe
     IF "%APP_VERSION_SUFFIX%" == "" SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%ARCHITECTURE%.exe
 
     REM get Python version for the runtime build ex. 2.7.1 will be 27
-    FOR /f "tokens=1 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MAJOR=%%G
-    FOR /f "tokens=2 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MINOR=%%G
+    FOR /f "tokens=1 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MAJOR=%%G
+    FOR /f "tokens=2 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MINOR=%%G
     SET "PYTHON_VERSION=%PYTHON_MAJOR%%PYTHON_MINOR%"
 
     EXIT /B 0
@@ -91,32 +86,24 @@ REM Main build sequence Ends
 
 :VALIDATE_ENVIRONMENT
     ECHO ****************************************************************
-    ECHO                        S U M M A R Y
+    ECHO * Build summary
     ECHO ****************************************************************
-    ECHO Build path:                %PGBUILDPATH%
-    ECHO Output directory:          %TARGET_DIR%
+    ECHO Build path:                %BUILDROOT%
+    ECHO Output directory:          %DISTROOT%
     ECHO Installer name:            %INSTALLERNAME%
     ECHO.
-    ECHO Python home:               %PYTHON_HOME%
-    ECHO Python DLL:                %PYTHON_DLL%
-    ECHO Python version:            %PYTHON_VERSION%
-    ECHO Python major version:      %PYTHON_MAJOR%
-    ECHO Python minor version:      %PYTHON_MINOR%
+    ECHO Python directory:          %PGADMIN_PYTHON_DIR%
+    ECHO Python DLL:                %PGADMIN_PYTHON_DIR%\Python%PYTHON_VERSION%.dll
+    ECHO Python version:            %PYTHON_MAJOR%.%PYTHON_MINOR%
     ECHO.
-    ECHO Qt home:                   %QTDIR%
-    ECHO qmake executable:          %QMAKE%
-    ECHO Qt version:                %QT_VERSION%
+    ECHO Qt directory:              %PGADMIN_QT_DIR%
+    ECHO PostgreSQL directory:      %PGADMIN_POSTGRES_DIR%
     ECHO.
-    ECHO PostgreSQL home:           %PGDIR%
+    ECHO VC++ redist directory:     %PGADMIN_VCREDIST_DIR%
+    ECHO VC++ redist file:          %VCREDIST_FILE%
+    ECHO InnoTool directory:        %PGADMIN_INNOTOOL_DIR%
+    ECHO signtool directory:        %PGADMIN_SIGNTOOL_DIR%
     ECHO.
-    ECHO VC++ redistributable:      %VCREDIST%
-    ECHO VC++ redistributable file: %VCREDISTNAME%
-    ECHO.
-    ECHO innotool executable:       %INNOTOOL%
-    ECHO signtool executable:       %SIGNTOOL%
-    ECHO.
-    ECHO App major version:         %APP_MAJOR%
-    ECHO App minor version:         %APP_MINOR%
     ECHO App version:               %APP_VERSION%
     ECHO App version suffix:        %APP_VERSION_SUFFIX%
     ECHO App short name:            %APP_SHORTNAME%
@@ -124,88 +111,87 @@ REM Main build sequence Ends
     ECHO ****************************************************************
 
     ECHO Checking the environment...
-    IF NOT EXIST "%INNOTOOL%" (
-        ECHO !INNOTOOL! does not exist
-        ECHO Please install Innotool and set the INNOTOOL environment variable.
+    IF NOT EXIST "%PGADMIN_INNOTOOL_DIR%" (
+        ECHO !PGADMIN_INNOTOOL_DIR! does not exist
+        ECHO Please install InnoTool and set the PGADMIN_INNOTOOL_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%VCREDIST%" (
-        ECHO !VCREDIST! does not exist
-        ECHO Please install Microsoft Visual studio and set the VCREDIST environment variable.
+    IF NOT EXIST "%PGADMIN_VCREDIST_DIR%" (
+        ECHO !PGADMIN_VCREDIST_DIR! does not exist
+        ECHO Please install Microsoft Visual studio and set the PGADMIN_VCREDIST_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%QTDIR%" (
-        ECHO !QTDIR! does not exist.
-        ECHO Please install Qt and set the QTDIR environment variable.
+    IF NOT EXIST "%PGADMIN_QT_DIR%" (
+        ECHO !PGADMIN_QT_DIR! does not exist.
+        ECHO Please install Qt and set the PGADMIN_QT_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%QMAKE%" (
+    IF NOT EXIST "%PGADMIN_QT_DIR%\bin\qmake.exe" (
         ECHO !QMAKE! does not exist.
-        ECHO Please install Qt and set the QTDIR environment variable.
+        ECHO Please install Qt and set the PGADMIN_QT_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PYTHON_HOME%" (
-        ECHO !PYTHON_HOME! does not exist.
-        ECHO Please install Python and set the PYTHON_HOME environment variable.
+    IF NOT EXIST "%PGADMIN_PYTHON_DIR%" (
+        ECHO !PGADMIN_PYTHON_DIR! does not exist.
+        ECHO Please install Python and set the PGADMIN_PYTHON_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PYTHON_DLL%" (
-        ECHO !PYTHON_DLL! does not exist.
-        ECHO Please install Python and set the PYTHON_DLL environment variable.
+    IF NOT EXIST "%PGADMIN_PYTHON_DIR%\Python%PYTHON_VERSION%.dll" (
+        ECHO !PGADMIN_PYTHON_DIR!\Python!PYTHON_VERSION!.dll does not exist.
+        ECHO Please check your Python installation is complete.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PGDIR%" (
-        ECHO !PGDIR! does not exist.
-        ECHO Please install PostgreSQL and set the PGDIR environment variable.
+    IF NOT EXIST "%PGADMIN_POSTGRES_DIR%" (
+        ECHO !PGADMIN_POSTGRES_DIR! does not exist.
+        ECHO Please install PostgreSQL and set the PGADMIN_POSTGRES_DIR environment variable.
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PYTHON_HOME%\Scripts\virtualenv.exe" (
-        ECHO !PYTHON_HOME!\Scripts\virtualenv.exe does not exist.
+    IF NOT EXIST "%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" (
+        ECHO !PGADMIN_PYTHON_DIR!\Scripts\virtualenv.exe does not exist.
         ECHO Please install the virtualenv package in Python.
         EXIT /B 1
     )
 
-    SET "PATH=%PGDIR%\bin;%PATH%"
+    SET "PATH=%PGADMIN_POSTGRES_DIR%\bin;%PATH%"
 
     EXIT /B 0
 
 
 :CREATE_VIRTUAL_ENV
     ECHO Creating virtual environment...
-    IF NOT EXIST "%PGBUILDPATH%"  MKDIR "%PGBUILDPATH%"
+    IF NOT EXIST "%BUILDROOT%"  MKDIR "%BUILDROOT%"
     
-    CD "%PGBUILDPATH%"
-    "%PYTHON_HOME%\Scripts\virtualenv.exe" "%VIRTUALENV%"
+    CD "%BUILDROOT%"
 
-    XCOPY /S /I /E /H /Y "%PYTHON_HOME%\DLLs" "%PGBUILDPATH%\%VIRTUALENV%\DLLs" > nul || EXIT /B 1
-    XCOPY /S /I /E /H /Y "%PYTHON_HOME%\Lib" "%PGBUILDPATH%\%VIRTUALENV%\Lib" > nul || EXIT /B 1
+    REM Note that we must use virtualenv.exe here, as the venv module doesn't allow python.exe to relocate.
+    "%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" venv
 
-    ECHO Activating virtual environment -  %PGBUILDPATH%\%VIRTUALENV%...
-    CALL "%PGBUILDPATH%\%VIRTUALENV%\Scripts\activate" || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\DLLs" "%BUILDROOT%\venv\DLLs" > nul || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\Lib" "%BUILDROOT%\venv\Lib" > nul || EXIT /B 1
+
+    ECHO Activating virtual environment -  %BUILDROOT%\venv...
+    CALL "%BUILDROOT%\venv\Scripts\activate" || EXIT /B 1
 
     ECHO Installing dependencies...
     CALL pip install -r "%WD%\requirements.txt" || EXIT /B 1
     CALL pip install sphinx || EXIT /B 1
 
-    REM If we're using VC++, and this is Python 3.6+, we need to remove the hack
-    REM above or it will break qmake. Sigh.
-    IF "%MAKE%" == "nmake" (
-        IF %PYTHON_VERSION% GEQ 36 SET CL=
-    )
+    REM If this is Python 3.6+, we need to remove the hack above or it will break qmake. Sigh.
+    IF %PYTHON_VERSION% GEQ 36 SET CL=
 
     CD %WD%
     EXIT /B 0
 
 
 :CREATE_RUNTIME_ENV
-    MKDIR "%PGBUILDPATH%\runtime"
+    MKDIR "%BUILDROOT%\runtime"
 
     CD "%WD%\web"
 
@@ -219,33 +205,37 @@ REM Main build sequence Ends
     RD /Q /S "%WD%\web\pgadmin\static\js\generated\.cache" 1> nul 2>&1
 
     ECHO Copying web directory...
-    XCOPY /S /I /E /H /Y "%WD%\web" "%PGBUILDPATH%\web" > nul || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%WD%\web" "%BUILDROOT%\web" > nul || EXIT /B 1
 
     ECHO Cleaning up unnecessary .pyc and .pyo files...
-    FOR /R "%PGBUILDPATH%\web" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
+    FOR /R "%BUILDROOT%\web" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
     ECHO Removing tests, Python caches and node modules...
-    FOR /R "%PGBUILDPATH%\web" %%f in (tests feature_tests __pycache__ node_modules) do RD /Q /S "%%f" 1> nul 2>&1
+    FOR /R "%BUILDROOT%\web" %%f in (tests feature_tests __pycache__ node_modules) do RD /Q /S "%%f" 1> nul 2>&1
     ECHO Removing the test framework...
-    RD /Q /S "%PGBUILDPATH%\web\regression" 1> nul 2>&1
+    RD /Q /S "%BUILDROOT%\web\regression" 1> nul 2>&1
     ECHO Removing tools...
-    RD /Q /S "%PGBUILDPATH%\web\tools" 1> nul 2>&1
+    RD /Q /S "%BUILDROOT%\web\tools" 1> nul 2>&1
     ECHO Removing any existing configurations...
-    DEL /q "%PGBUILDPATH%\web\pgadmin4.db" 1> nul 2>&1
-    DEL /q "%PGBUILDPATH%\web\config_local.py" 1> nul 2>&1
-    
+    DEL /q "%BUILDROOT%\web\pgadmin4.db" 1> nul 2>&1
+    DEL /q "%BUILDROOT%\web\config_local.py" 1> nul 2>&1
+
+    ECHO Staging license files...
+    COPY "%WD%\LICENSE" "%BUILDROOT%\" > nul || EXIT /B 1
+    COPY "%WD%\DEPENDENCIES" "%BUILDROOT%\" > nul || EXIT /B 1
+
     ECHO Creating config_distro.py
-    ECHO SERVER_MODE = False > "%PGBUILDPATH%\web\config_distro.py"
-    ECHO HELP_PATH = '../../../docs/en_US/html/' >> "%PGBUILDPATH%\web\config_distro.py"
-    ECHO DEFAULT_BINARY_PATHS = { >> "%PGBUILDPATH%\web\config_distro.py"
-    ECHO     'pg':   '$DIR/../runtime', >> "%PGBUILDPATH%\web\config_distro.py"
-    ECHO     'ppas': '' >> "%PGBUILDPATH%\web\config_distro.py"
-    ECHO } >> "%PGBUILDPATH%\web\config_distro.py"
+    ECHO SERVER_MODE = False > "%BUILDROOT%\web\config_distro.py"
+    ECHO HELP_PATH = '../../../docs/en_US/html/' >> "%BUILDROOT%\web\config_distro.py"
+    ECHO DEFAULT_BINARY_PATHS = { >> "%BUILDROOT%\web\config_distro.py"
+    ECHO     'pg':   '$DIR/../runtime', >> "%BUILDROOT%\web\config_distro.py"
+    ECHO     'ppas': '' >> "%BUILDROOT%\web\config_distro.py"
+    ECHO } >> "%BUILDROOT%\web\config_distro.py"
 
     ECHO Building docs...
-    MKDIR "%PGBUILDPATH%\docs\en_US\html"
+    MKDIR "%BUILDROOT%\docs\en_US\html"
     CD "%WD%\docs\en_US"
-    CALL "%PGBUILDPATH%\%VIRTUALENV%\Scripts\python.exe" build_code_snippet.py || EXIT /B 1
-    CALL "%PGBUILDPATH%\%VIRTUALENV%\Scripts\sphinx-build.exe"   "%WD%\docs\en_US" "%PGBUILDPATH%\docs\en_US\html" || EXIT /B 1
+    CALL "%BUILDROOT%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1
+    CALL "%BUILDROOT%\venv\Scripts\sphinx-build.exe"   "%WD%\docs\en_US" "%BUILDROOT%\docs\en_US\html" || EXIT /B 1
 
     ECHO Removing Sphinx
     CALL pip uninstall -y sphinx Pygments alabaster colorama docutils imagesize requests snowballstemmer
@@ -254,53 +244,50 @@ REM Main build sequence Ends
     CD "%WD%\runtime"
 
     ECHO Running qmake...
-    CALL "%QMAKE%" || EXIT /B 1
+    CALL set "PGADMIN_PYTHON_DIR=%PGADMIN_PYTHON_DIR%" && "%PGADMIN_QT_DIR%\bin\qmake.exe" || EXIT /B 1
 
     ECHO Cleaning the build directory...
-    CALL %MAKE% clean || EXIT /B 1
+    CALL nmake clean || EXIT /B 1
 
     ECHO Running make...
-    CALL %MAKE% || EXIT /B 1
+    CALL nmake || EXIT /B 1
 
     ECHO Staging pgAdmin4.exe...
-    COPY "%WD%\runtime\release\pgAdmin4.exe" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
+    COPY "%WD%\runtime\release\pgAdmin4.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
 
     ECHO Staging Qt components...
-    COPY "%QTDIR%\bin\Qt5Core.dll"   "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY "%QTDIR%\bin\Qt5Gui.dll"    "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY "%QTDIR%\bin\Qt5Widgets.dll" "%PGBUILDPATH%\runtime" > nul  || EXIT /B 1
-    COPY "%QTDIR%\bin\Qt5Network.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%QTDIR%\bin\libgcc_s_dw2-1.dll" COPY "%QTDIR%\bin\libgcc_s_dw2-1.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%QTDIR%\bin\libstdc++-6.dll" COPY "%QTDIR%\bin\libstdc++-6.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%QTDIR%\bin\libwinpthread-1.dll" COPY "%QTDIR%\bin\libwinpthread-1.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    MKDIR "%PGBUILDPATH%\runtime\platforms" > nul || EXIT /B 1
-    COPY "%QTDIR%\plugins\platforms\qwindows.dll" "%PGBUILDPATH%\runtime\platforms" > nul || EXIT /B 1
-    ECHO [Paths] > "%PGBUILDPATH%\runtime\qt.conf"
-    ECHO Plugins=plugins >> "%PGBUILDPATH%\runtime\qt.conf"
+    COPY "%PGADMIN_QT_DIR%\bin\Qt5Core.dll"   "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\bin\Qt5Gui.dll"    "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\bin\Qt5Widgets.dll" "%BUILDROOT%\runtime" > nul  || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\bin\Qt5Network.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\bin\Qt5Svg.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    MKDIR "%BUILDROOT%\runtime\platforms" > nul || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\plugins\platforms\qwindows.dll" "%BUILDROOT%\runtime\platforms" > nul || EXIT /B 1
+    MKDIR "%BUILDROOT%\runtime\imageformats" > nul || EXIT /B 1
+    COPY "%PGADMIN_QT_DIR%\plugins\imageformats\qsvg.dll" "%BUILDROOT%\runtime\imageformats" > nul || EXIT /B 1
+    ECHO [Paths] > "%BUILDROOT%\runtime\qt.conf"
+    ECHO Plugins=plugins >> "%BUILDROOT%\runtime\qt.conf"
 
     ECHO Staging PostgreSQL components...
-    COPY "%PGDIR%\bin\libpq.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%PGDIR%\bin\libcrypto-1_1.dll" (
-        REM OpenSSL 1.1.1
-        COPY "%PGDIR%\bin\libcrypto-1_1.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-        COPY "%PGDIR%\bin\libssl-1_1.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\libpq.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    IF "%ARCHITECTURE%" == "x64" (
+        COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+        COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
     ) ELSE (
-        REM OpenSSL 1.0.2
-        COPY "%PGDIR%\bin\ssleay32.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-        COPY "%PGDIR%\bin\libeay32.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
+        COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-1_1.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+        COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-1_1.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
     )
-    IF EXIST "%PGDIR%\bin\libintl-*.dll" COPY "%PGDIR%\bin\libintl-*.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%PGDIR%\bin\libiconv-*.dll" COPY "%PGDIR%\bin\libiconv-*.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%PGDIR%\bin\zlib.dll" COPY "%PGDIR%\bin\zlib.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    IF EXIST "%PGDIR%\bin\zlib1.dll" COPY "%PGDIR%\bin\zlib1.dll" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY "%PGDIR%\bin\pg_dump.exe" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY "%PGDIR%\bin\pg_dumpall.exe" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1L%
-    COPY "%PGDIR%\bin\pg_restore.exe" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY "%PGDIR%\bin\psql.exe" "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
+    IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" "%BUILDROOT%\runtime" > nul
+    IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" "%BUILDROOT%\runtime" > nul
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\zlib.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_dump.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_dumpall.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1L%
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_restore.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\psql.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
 
     ECHO Staging VC++ runtime...
-    MKDIR "%PGBUILDPATH%\installer" || EXIT /B 1
-    COPY "%VCREDIST%" "%PGBUILDPATH%\installer" > nul || EXIT /B 1
+    MKDIR "%BUILDROOT%\installer" || EXIT /B 1
+    COPY "%PGADMIN_VCREDIST_DIR%\%VCREDIST_FILE%" "%BUILDROOT%\installer" > nul || EXIT /B 1
 
     CD %WD%
     EXIT /B 0
@@ -308,51 +295,51 @@ REM Main build sequence Ends
 
 :CREATE_PYTHON_ENV
     ECHO Staging Python...
-    COPY %PYTHON_DLL% "%PGBUILDPATH%\runtime"  > nul || EXIT /B 1
-    COPY %PYTHON_HOME%\python.exe "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
-    COPY %PYTHON_HOME%\pythonw.exe "%PGBUILDPATH%\runtime" > nul || EXIT /B 1
+    COPY %PGADMIN_PYTHON_DIR%\python%PYTHON_VERSION%.dll "%BUILDROOT%\runtime"  > nul || EXIT /B 1
+    COPY %PGADMIN_PYTHON_DIR%\python.exe "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY %PGADMIN_PYTHON_DIR%\pythonw.exe "%BUILDROOT%\runtime" > nul || EXIT /B 1
 
     ECHO Cleaning up unnecessary .pyc and .pyo files...
-    FOR /R "%PGBUILDPATH%\%VIRTUALENV%" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
+    FOR /R "%BUILDROOT%\venv" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
     ECHO Removing tests...
-    FOR /R "%PGBUILDPATH%\%VIRTUALENV%\Lib" %%f in (test tests) do RD /Q /S "%%f" 1> nul 2>&1
+    FOR /R "%BUILDROOT%\venv\Lib" %%f in (test tests) do RD /Q /S "%%f" 1> nul 2>&1
     ECHO Removing TCL...
-    RD /Q /S "%PGBUILDPATH%\%VIRTUALENV%\tcl" 1> nul 2>&1
+    RD /Q /S "%BUILDROOT%\venv\tcl" 1> nul 2>&1
 
     EXIT /B 0
 
 
 :CREATE_INSTALLER
     ECHO Preparing for creation of windows installer...
-    IF NOT EXIST "%TARGET_DIR%" MKDIR "%TARGET_DIR%"
+    IF NOT EXIST "%DISTROOT%" MKDIR "%DISTROOT%"
 
     ECHO Copying icon file...
-    COPY "%WD%\pkg\win32\Resources\pgAdmin4.ico" "%PGBUILDPATH%" > nul || EXIT /B 1
+    COPY "%WD%\pkg\win32\Resources\pgAdmin4.ico" "%BUILDROOT%" > nul || EXIT /B 1
 
     CD "%WD%\pkg\win32"
 
     ECHO Processing installer configuration script...
-    CALL "%PYTHON_HOME%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in" "-o" "%WD%\pkg\win32\installer.iss.in_stage1" "-s" MYAPP_NAME -r """%APP_NAME%"""
-    CALL "%PYTHON_HOME%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage1" "-o" "%WD%\pkg\win32\installer.iss.in_stage2" "-s" MYAPP_FULLVERSION -r """%APP_VERSION%"""
-    CALL "%PYTHON_HOME%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage2" "-o" "%WD%\pkg\win32\installer.iss.in_stage3" "-s" MYAPP_VERSION -r """v%APP_MAJOR%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in" "-o" "%WD%\pkg\win32\installer.iss.in_stage1" "-s" MYAPP_NAME -r """%APP_NAME%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage1" "-o" "%WD%\pkg\win32\installer.iss.in_stage2" "-s" MYAPP_FULLVERSION -r """%APP_VERSION%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage2" "-o" "%WD%\pkg\win32\installer.iss.in_stage3" "-s" MYAPP_VERSION -r """v%APP_MAJOR%"""
 
     SET ARCMODE=
-    IF "%ARCHITECTURE%"=="amd64" (
+    IF "%ARCHITECTURE%" == "x64" (
         set ARCMODE="x64"
     )
-    CALL "%PYTHON_HOME%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage3" "-o" "%WD%\pkg\win32\installer.iss.in_stage4" "-s" MYAPP_ARCHITECTURESMODE -r """%ARCMODE%"""
-    CALL "%PYTHON_HOME%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage4" "-o" "%WD%\pkg\win32\installer.iss" "-s" MYAPP_VCDIST -r """%VCREDISTNAME%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage3" "-o" "%WD%\pkg\win32\installer.iss.in_stage4" "-s" MYAPP_ARCHITECTURESMODE -r """%ARCMODE%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage4" "-o" "%WD%\pkg\win32\installer.iss" "-s" MYAPP_VCDIST -r """%PGADMIN_VCREDIST_DIRNAME%\%VCREDIST_FILE%"""
 
     ECHO Cleaning up...
     DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
 
     ECHO Creating windows installer using INNO tool...
-    CALL "%INNOTOOL%\ISCC.exe" /q "%WD%\pkg\win32\installer.iss" || EXIT /B 1
+    CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" /q "%WD%\pkg\win32\installer.iss" || EXIT /B 1
 
     ECHO Renaming installer...
-    MOVE "%WD%\pkg\win32\Output\Setup.exe" "%TARGET_DIR%\%INSTALLERNAME%" > nul || EXIT /B 1
+    MOVE "%WD%\pkg\win32\Output\Setup.exe" "%DISTROOT%\%INSTALLERNAME%" > nul || EXIT /B 1
 
-    ECHO Location - %TARGET_DIR%\%INSTALLERNAME%
+    ECHO Location - %DISTROOT%\%INSTALLERNAME%
     ECHO Installer generated successfully.
 
     CD %WD%
@@ -361,7 +348,7 @@ REM Main build sequence Ends
 
 :SIGN_INSTALLER
     ECHO Attempting to sign the installer...
-    CALL "%SIGNTOOL%" sign  /t http://timestamp.verisign.com/scripts/timstamp.dll "%TARGET_DIR%\%INSTALLERNAME%"
+    CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign  /t http://timestamp.verisign.com/scripts/timstamp.dll "%DISTROOT%\%INSTALLERNAME%"
     IF %ERRORLEVEL% NEQ 0 (
         ECHO.
         ECHO ************************************************************
@@ -375,15 +362,15 @@ REM Main build sequence Ends
 
 :CLEANUP_ENV
     ECHO Cleaning the build environment...
-    RD "%PGBUILDPATH%\%VIRTUALENV%\Include" /S /Q 1> nul 2>&1
-    DEL /s "%PGBUILDPATH%\%VIRTUALENV%\pip-selfcheck.json" 1> nul 2>&1
+    RD "%BUILDROOT%\venv\Include" /S /Q 1> nul 2>&1
+    DEL /s "%BUILDROOT%\venv\pip-selfcheck.json" 1> nul 2>&1
 
     EXIT /B 0
 
 
 :USAGE
     ECHO Invalid command line options.
-    ECHO Usage: "Make.bat <x86 | clean>"
+    ECHO Usage: "Make.bat [clean]"
     ECHO.
 
     EXIT /B 1

Makefile

@@ -28,12 +28,10 @@ install-node:
 	cd web && npm audit fix
 	rm -f web/yarn.lock
 	cd web && yarn import
-# Commented the below line to avoid vulnerability in decompress package and
-# audit only dependencies folder. Refer https://www.npmjs.com/advisories/1217.
-# Pull request is already been send https://github.com/kevva/decompress/pull/73,
-# once fixed we will uncomment it.
+# Commented the below line to avoid vulnerability in lodash package.
+# Refer https://www.npmjs.com/advisories/1523.
+# Once fixed we will uncomment it.
 #	cd web && yarn audit
-	cd web && yarn audit --groups dependencies
 	rm -f package-lock.json
 	rm -f web/package-lock.json
 
@@ -84,6 +82,9 @@ check-feature: install-node bundle
 check-js: install-node linter
 	cd web && yarn run karma start --single-run
 
+check-js-coverage:
+    cd web && yarn run test:karma-coverage
+
 runtime-debug:
 	cd runtime && qmake CONFIG+=debug && make
 

README

@@ -1,4 +1,4 @@
-pgAdmin 4
+pgAdmin 4 
 =========
 
 pgAdmin 4 is a rewrite of the popular pgAdmin3 management tool for the
@@ -26,42 +26,46 @@ Building the Runtime
 
 To build the runtime, the following packages must be installed:
 
-- QT 4.6 or above (Use the VC++ build on Windows, not MinGW).
-- Python 2.7 or 3.4+
+- QT 5 (Use the VC++ build on Windows, not MinGW).
+- Python 3.4+
 
-Assuming both qmake and python-config are in the path:
+An environment variable named PGADMIN_PYTHON_DIR must be set to the directory
+in which Python has been installed, for example:
 
-   $ cd $PGADMIN4_SRC/runtime
-    $ qmake
-    Project MESSAGE: Building for QT5+...
-    Project MESSAGE: Building for Linux/Mac...
-    Project MESSAGE: Using /usr/bin/python-config
-    Project MESSAGE: Python2 detected.
-    $ make
-    ...
+- /usr
+- /usr/local/python-3.8
+- C:\Python38
 
-To build the runtime in debug mode, use the option below with qmake
+Assuming both qmake is in the path:
+
+  dpage@hal:~/git/pgadmin4$ cd runtime
+  dpage@hal:~/git/pgadmin4/runtime$ export PGADMIN_PYTHON_DIR=/opt/local
+  dpage@hal:~/git/pgadmin4/runtime$ qmake
+  Project MESSAGE: ==================================
+  Project MESSAGE: Configuring the pgAdmin 4 runtime.
+  Project MESSAGE: ==================================
+  Project MESSAGE: Qt version: 5
+  Project MESSAGE: Platform: macOS
+  Project MESSAGE: Python executable: /opt/local/bin/python3
+  Project MESSAGE: Python version: 3.8 (38)
+  Project MESSAGE: Python config: /opt/local/bin/python3-config
+  Project MESSAGE: CXXFLAGS: -pipe -stdlib=libc++ -I/opt/local/Library/Frameworks/Python.framework/Versions/3.8/include/python3.8 -I/opt/local/Library/Frameworks/Python.framework/Versions/3.8/include/python3.8
+  Project MESSAGE: LDFLAGS: -stdlib=libc++ -L/opt/local/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/config-3.8-darwin -ldl -framework CoreFoundation
+  Project MESSAGE: LIBS: -lpython3.8 -ldl -framework CoreFoundation
+  dpage@hal:~/git/pgadmin4/runtime$ make
+  ...
+
+To build the runtime in debug mode, use the option below with qmake:
 $ qmake CONFIG+=debug
 
-To build the runtime in release mode, use the option below with qmake
+To build the runtime in release mode, use the option below with qmake:
 $ qmake CONFIG+=release
 
 By default, the runtime application will be built in release mode.
 
-On Linux, an executable called 'pgAdmin4' will be built, and on Mac OS X, an
-app bundle called pgAdmin4.app will be created.
-
-To build the runtime on a Windows system, export PYTHON_HOME and PYTHON_VERSION 
-variables in the System environment. Specify the PYTHON_VERSION with the major 
-and minor number. Do not specify micro level version.
-
-For example, given a Python version of A.B.C; A - Major number, B - Minor
-number, C - Micro level (Bug fix releases).
-
-If Python version is 2.7.12 than specify PYTHON_VERSION=27
-
- e.g. PYTHON_HOME=C:\Python27\
-      PYTHON_VERSION=27
+On Linux, an executable called 'pgAdmin4' will be built, on Windows,
+'pgAdmin4.exe', and on Mac OS X, an app bundle called pgAdmin4.app will be
+created.
 
 You can also use Qt Creator to build, develop and debug the runtime. Simply
 open the $PGADMIN4_SRC/runtime/pgAdmin4.pro project file in Qt Creator and
@@ -88,10 +92,10 @@ Configuring the Python Environment
 ----------------------------------
 
 In order to run the Python code, a suitable runtime environment is required.
-Python versions - Python 2.7 or 3.4+ are currently supported. It is
-recommended that a Python Virtual Environment is setup for this purpose,
-rather than using the system Python environment. On Linux and Mac systems, the
-process is fairly simple - adapt as required for your distribution:
+Python version 3.4 and later are currently supported. It is recommended that a
+Python Virtual Environment is setup for this purpose, rather than using the
+system Python environment. On Linux and Mac systems, the process is fairly
+simple - adapt as required for your distribution:
 
 1) Install the virtualenv packages into the system Python environment
 
@@ -181,16 +185,7 @@ server or desktop mode, and access it from a web browser using the URL shown in
 the terminal once pgAdmin has started up.
 
 Setup of an environment on Windows is somewhat more complicated unfortunately,
-largely due to the lack of a native compiler toolset. Thankfully, Microsoft
-supply a free compiler specifically for Python 2.7 users. Download and install
-it from:
-
-https://www.microsoft.com/en-gb/download/details.aspx?id=44266
-
-A blog detailing the setup of Virtual Environments on Windows can be found
-here:
-
-http://www.tylerbutler.com/2012/05/how-to-install-python-pip-and-virtualenv-on-windows-with-powershell/
+please see pkg/win32/README.txt for complete details.
 
 Once a virtual environment has been created and enabled, setup can continue
 from step 4 above.
@@ -252,7 +247,7 @@ icon and select the Configuration option to open the configuration dialogue.
 On a Linux/Mac system, the Python Path will typically consist of a single path
 to the virtual environment's site-packages directory, e.g.
 
-    /Users/<USERNAME>/.virtualenvs/pgadmin4/lib/python2.7/site-packages
+    /Users/<USERNAME>/.virtualenvs/pgadmin4/lib/python3.8/site-packages
 
 On Windows, multiple paths are likely to be required, e.g.
 
@@ -294,49 +289,9 @@ run:
 
     (pgadmin4) $ make pip
 
-On a Mac, build an application bundle in a disk image (DMG file) with:
+To build the macOS AppBundle, please see pkg/mac/README.
 
-    (pgadmin4) $ make appbundle
-
-Configure the framework.conf to match the QT and Python versions the app is
-being built with:
-
-    $ cp $PGADMIN4_SRC/pkg/mac/framework.conf.in $PGADMIN4_SRC/pkg/mac/framework.conf
-    $ vi $PGADMIN4_SRC/pkg/mac/framework.conf
-
-If you have an Apple code signing certificate, both the app bundle and disk
-image can be automatically signed by configuring signing:
-
-    $ cp $PGADMIN4_SRC/pkg/mac/codesign.conf.in $PGADMIN4_SRC/pkg/mac/codesign.conf
-    $ vi $PGADMIN4_SRC/pkg/mac/codesign.conf
-
-Edit the file as appropriate, ensuring the various version numbers are correct
-and that the appropriate developer ID is specified.
-
-On Windows, the InnoSetup tool is required to create an installer. Download the
-Unicode version from:
-
-http://www.jrsoftware.org/isdl.php
-
-A number of environment variables may need to be set to enable the build script
-to function. The defaults will usually work on a typical 64 bit system with
-Qt 5.5.1, Python 2.7 and Visual Studio 2013. The examples below are for a
-similar 32 bit system:
-
-INNOTOOL=C:\Program Files\Inno Setup 5
-PGDIR=C:\Program Files\PostgreSQL\10
-PYTHON_DLL=C:\Windows\System32\Python27.dll
-PYTHON_HOME=C:\Python27
-PYTHON_VERSION=27
-QTDIR=C:\Qt\5.9\msvc2013
-VCDIR=C:\Program Files\Microsoft Visual Studio 12.0\VC
-
-To build the installer:
-
-    C:\$PGADMIN4_SRC> make x86
-
-If you have a code signing certificate, this will automatically be used if
-found in the Windows Certificate Store to sign the installer.
+To build the Windows installer, please see pkg/win32/README.txt.
 
 Support
 -------

docs/en_US/backup_dialog.rst

@@ -4,7 +4,7 @@
 `Backup Dialog`:index:
 **********************
 
-Using the *pg_dump* utility, *pgAdmin* provides an easy way to create a backup
+*pgAdmin* uses the *pg_dump* utility to provide an easy way to create a backup
 in a plain-text or archived format.  You can then use a client application (like
 *psql* or the *Query Tool*) to restore a plain-text backup file, or use the
 Postgres *pg_restore* utility to restore an archived backup. The *pg_dump*
@@ -205,14 +205,15 @@ command:
 
 Use the **Stop Process** button to stop the Backup process.
 
-If the backup is successful, a popup window will confirm success. Click *Click
-here for details* on the popup window to launch the *Process Watcher*. The
-*Process Watcher* logs all the activity associated with the backup and provides
-additional information for troubleshooting.
+If the backup is successful, a popup window will confirm success. Click *More details* on the popup window to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the backup and provides additional information for troubleshooting.
 
 .. image:: images/backup_process_watcher.png
     :alt:  Backup process watcher
     :align: center
 
 If the backup is unsuccessful, you can review the error messages returned by the
-backup command on the *Process Watcher*.
+backup command on the *Process Watcher*.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/backup_globals_dialog.rst

@@ -50,4 +50,8 @@ additional information for troubleshooting.
     :align: center
 
 If the backup is unsuccessful, review the error message returned by the
-*Process Watcher* to resolve any issue.
+*Process Watcher* to resolve any issue.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/backup_server_dialog.rst

@@ -135,4 +135,8 @@ additional information for troubleshooting.
     :align: center
 
 If the backup is unsuccessful, review the error message returned by the
-*Process Watcher* to resolve any issue.
+*Process Watcher* to resolve any issue.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/build_code_snippet.py

@@ -1,11 +1,7 @@
 import os
 import sys
 import inspect
-
-if sys.version_info[0] >= 3:
-    import builtins
-else:
-    import __builtin__ as builtins
+import builtins
 
 # Ensure the global server mode is set.
 builtins.SERVER_MODE = None
@@ -63,7 +59,7 @@ def print_code(outstream, name, module, info=None):
 print_code(
     target, "PgAdminModule", PgAdminModule,
     """
-PgAdminModule is inherted from Flask.Blueprint module.
+PgAdminModule is inherited from Flask.Blueprint module.
 This module defines a set of methods, properties and attributes,
 that every module should implement.
 """)

docs/en_US/code_overview.rst

@@ -29,9 +29,10 @@ Configuration
 
 The core application configuration is found in **config.py**. This file includes
 all configurable settings for the application, along with descriptions of their
-use. It is essential that various settings are configured prior to deployent on
-a web server; these can be overriden in **config_local.py** to avoid modifying
-the main configuration file.
+use. It is essential that various settings are configured prior to deployment on
+a web server; these can be overridden in **config_local.py** or
+**config_system.py** (see the :ref:`config.py <config_py>` documentation) to
+avoid modifying the main configuration file.
 
 User Settings
 =============
@@ -108,7 +109,7 @@ PgAdminModule class. This is responsible for providing hook points to integrate
 the module into the rest of the application - for example, a hook might tell
 the caller what CSS files need to be included on the rendered page, or what menu
 options to include and what they should do. Hook points need not exist if they
-are not required. It is the responsiblity of the caller to ensure they are
+are not required. It is the responsibility of the caller to ensure they are
 present before attempting to utilise them.
 
 Hooks currently implemented are:
@@ -210,6 +211,6 @@ bootstrap for UI look and feel, Backbone for data manipulation of a node,
 Backform for generating properties/create dialog for selected node. We have
 divided each module in small chunks as much as possible. Not all javascript
 modules are required to be loaded (i.e. loading a javascript module for
-database will make sense only when a server node is loaded competely.) Please
+database will make sense only when a server node is loaded completely.) Please
 look at the the javascript files node.js, browser.js, menu.js, panel.js, etc for
 better understanding of the code.

docs/en_US/conf.py

@@ -14,11 +14,7 @@
 
 import os
 import sys
-
-if sys.version_info[0] >= 3:
-    import builtins
-else:
-    import __builtin__ as builtins
+import builtins
 
 # Ensure the global server mode is set.
 builtins.SERVER_MODE = None
@@ -212,8 +208,8 @@ htmlhelp_basename = 'pgadmin4'
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index', 'pgadmin4.tex', u'pgAdmin 4 Documentation',
-     u'The pgAdmin Development Team', 'manual'),
+    ('index', 'pgadmin4.tex', 'pgAdmin 4 Documentation',
+     'The pgAdmin Development Team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -251,6 +247,6 @@ latex_elements = {
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pgadmin4', u'pgAdmin 4 Documentation',
-     [u'The pgAdmin Development Team'], 1)
+    ('index', 'pgadmin4', 'pgAdmin 4 Documentation',
+     ['The pgAdmin Development Team'], 1)
 ]

docs/en_US/config_py.rst

@@ -23,10 +23,21 @@ are as follows:
   and may be created by users in the same directory as ``config.py`` if
   needed.
 
-.. note:: If the SERVER_MODE setting is changed in ``config_distro.py`` or ``config_local.py``,
-     you will most likely need to re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH
-     and STORAGE_DIR values as well as they will have been set based on the default
-     configuration or overridden by the runtime.
+* ``config_system.py``: This file is read after ``config_local.py`` and is
+  intended for system administrators to include settings that are configured
+  system-wide from a secure location that users cannot normally modify and that
+  is outside of the pgAdmin installation. The location for this file varies
+  based on the platform, and only needs to be created if desired:
+
+  * Linux: ``/etc/pgadmin/config_system.py``
+  * macOS: ``/Library/Preferences/pgadmin/config_system.py``
+  * Windows: ``%CommonProgramFiles%\pgadmin\config_system.py``
+
+.. note:: If the SERVER_MODE setting is changed in ``config_distro.py``,
+     ``config_local.py``, or ``config_system.py`` you will most likely need to
+     re-set the LOG_FILE, SQLITE_PATH, SESSION_DB_PATH and STORAGE_DIR values
+     as well as they will have been set based on the default configuration or
+     overridden by the runtime.
 
 The default ``config.py`` file is shown below for reference:
 

docs/en_US/container_deployment.rst

@@ -17,7 +17,6 @@ maintenance functions to be executed. Multiple versions are included in the
 following directories to allow use with different versions of the database
 server:
 
-* PostgreSQL 9.4: */usr/local/pgsql-9.4*
 * PostgreSQL 9.5: */usr/local/pgsql-9.5*
 * PostgreSQL 9.6: */usr/local/pgsql-9.6*
 * PostgreSQL 10: */usr/local/pgsql-10*
@@ -52,7 +51,7 @@ connections.
 
 When TLS is enabled, a certificate and key must be provided. Typically these
 should be stored on the host file system and mounted from the container. The
-expected paths are /certs/server.crt and /certs/server.key
+expected paths are /certs/server.cert and /certs/server.key
 
 **PGADMIN_LISTEN_ADDRESS**
 
@@ -60,7 +59,7 @@ expected paths are /certs/server.crt and /certs/server.key
 
 Specify the local address that the servers listens on. The default should work
 for most users - in IPv4-only environments, this may need to be set to
-127.0.0.1.
+0.0.0.0.
 
 **PGADMIN_LISTEN_PORT**
 
@@ -319,7 +318,7 @@ adjusted as appropriate to the specific deployment:
         listen 443;
         server_name _;
 
-        ssl_certificate /etc/nginx/server.crt;
+        ssl_certificate /etc/nginx/server.cert;
         ssl_certificate_key /etc/nginx/server.key;
 
         ssl on;

docs/en_US/database_dialog.rst

@@ -97,6 +97,19 @@ Follow these steps to add additional parameter value definitions; to discard a
 parameter, click the trash icon to the left of the row and confirm deletion in
 the *Delete Row* popup.
 
+Click the *Advanced* tab to continue.
+
+.. image:: images/database_advanced.png
+   :alt: Database dialog advanced tab
+   :align: center
+
+Use the *Advanced* tab to set advanced parameters for the database.
+
+* Use *Schema restriction* field to provide a SQL restriction that will be used
+  against the pg_namespace table to limit the schemas that you see.
+  For example, you might enter: *public* so that only *public* are shown in
+  the pgAdmin browser.Separate entries with a comma or tab as you type.
+
 Click the *SQL* tab to continue.
 
 Your entries in the *Database* dialog generate a SQL command (see an example

docs/en_US/debugger.rst

@@ -16,9 +16,9 @@ superuser privileges to use the debugger.
 
 Before using the debugger, you must modify the *postgresql.conf* file, adding
 the server-side debugger components to the the value of the
-*shared_preload_libraries* parameter:
+*shared_preload_libraries* parameter, for example:
 
-  shared_preload_libraries = '$libdir/*other_libraries*/plugin_debugger'
+  shared_preload_libraries = '$libdir/plugin_debugger'
 
 After modifying the *shared_preload_libraries* parameter, restart the server to
 apply the changes.

docs/en_US/desktop_deployment.rst

@@ -71,6 +71,12 @@ The configuration settings:
    +--------------------------+--------------------+---------------------------------------------------------------+
    | ConnectionTimeout        | Integer            | The number of seconds to wait for application server startup. |
    +--------------------------+--------------------+---------------------------------------------------------------+
+   | FixedPort                | Boolean            | Use a fixed network port number rather than a random one.     |
+   +--------------------------+--------------------+---------------------------------------------------------------+
+   | OpenTabAtStartup         | Boolean            | Open a browser tab at startup.                                |
+   +--------------------------+--------------------+---------------------------------------------------------------+
+   | PortNumber               | Integer            | The port number to use, if using a fixed port.                |
+   +--------------------------+--------------------+---------------------------------------------------------------+
    | PythonPath               | String             | The Python module search path                                 |
    +--------------------------+--------------------+---------------------------------------------------------------+
 

docs/en_US/enabling_ldap_authentication.rst

@@ -0,0 +1,105 @@
+.. _enabling_ldap_authentication:
+
+**************************************************
+`Enabling LDAP Authentication for pgAdmin`:index:
+**************************************************
+
+To enable LDAP authentication for pgAdmin, you must configure the LDAP
+settings in the *config_local.py* or *config_system.py* file (see the
+:ref:`config.py <config_py>` documentation) on the system where pgAdmin is
+installed in Server mode. You can copy these settings from *config.py* file
+and modify the values for the following parameters:
+
+There are 3 ways to configure LDAP:
+
+* Bind as pgAdmin user
+
+* Anonymous bind
+
+* Dedicated user bind
+
+
+.. csv-table::
+   :header: "**Parameter**", "**Description**"
+   :class: longtable
+   :widths: 35, 55
+
+   "AUTHENTICATION_SOURCES","The default value for this parameter is *internal*.
+   To enable LDAP authentication, you must include *ldap* in the list of values
+   for this parameter. you can modify the value as follows:
+
+   * [‘ldap’]: pgAdmin will use only LDAP authentication.
+
+   * [‘ldap’, ‘internal’]: pgAdmin will first try to authenticate the user through
+     LDAP. If that authentication fails, then internal user entries of pgAdmin
+     will be used for authentication.
+
+   * [‘internal’, ‘ldap’]: pgAdmin will first try to authenticate the user
+     through internal user entries. If that authentication fails, then LDAP
+     authentication will be used."
+   "LDAP_AUTO_CREATE_USER", "Specifies if you want to automatically create a pgAdmin
+   user corresponding to the LDAP user credentials. Please note that LDAP password
+   is not stored in the pgAdmin database."
+   "LDAP_CONNECTION_TIMEOUT","Specifies the connection timeout (in seconds) for LDAP
+   authentication."
+   "LDAP_SERVER_URI", "An LDAP URI is a combination of connection protocol
+   (ldap or ldaps), IP address/hostname and port of the directory server that you
+   want to connect to. For example, 'ldap://172.16.209.35:389' is a valid
+   LDAP_SERVER_URI where ldap is the connection protocol, 172.16.209.35 is the IP
+   address and 389 is the port. Port 636 is used for the ldaps communication protocol."
+   "LDAP_USERNAME_ATTRIBUTE","Specifies the LDAP attribute that contains the
+   usernames. For LDAP authentication, you need to enter the value of that
+   particular attribute as username. For example, if you set the value of
+   LDAP_USERNAME_ATTRIBUTE as ‘cn’ and you have defined 'cn=admin' in your LDAP server
+   entries, you should be able to authenticate by entering ‘admin’ in the 
+   *Email Address / Username* field and its corresponding password in the *Password* 
+   field."
+   "LDAP_SEARCH_BASE_DN","Specifies the distinguished name (DN) for the top-most user
+   directory that you want to search. You can use this parameter for limiting the search
+   request to a specific group of users. For example, if you want to search only within
+   the Organizational Unit named sales, you can define the value for LDAP_SEARCH_BASE_DN
+   parameter as following:
+   LDAP_SEARCH_BASE_DN = ‘ou=sales,dc=example,dc=com'
+
+   This is an optional parameter only while binding as pgAdmin user.
+   If you do not specify any value for LDAP_SEARCH_BASE_DN, then the value for
+   LDAP_BASE_DN will be considered for the same."
+   "LDAP_SEARCH_FILTER","Defines the criteria to retrieve matching entries in an
+   LDAP search request. For example, LDAP_SEARCH_FILTER = '(objectclass=HR)’ setting
+   searches only for users having HR as their objectClass attribute."
+   "LDAP_SEARCH_SCOPE","Indicates the set of entries at or below the Base DN that
+   maybe considered as potential matches for a search request. You can specify the
+   scope of a search as either a *base*, *level*, or *subtree* search. A *base* search
+   limits the search to the base object. A *level* search is restricted to the immediate
+   children of a base object, but excludes the base object itself. A *subtree* search
+   includes all child objects as well as the base object."
+   "LDAP_USE_STARTTLS","Specifies if you want to use Transport Layer Security (TLS)
+   for secure communication between LDAP clients and LDAP servers. If you specify
+   the connection protocol in *LDAP_SERVER_URI* as *ldaps*, this parameter is ignored."
+   "LDAP_CA_CERT_FILE","Specifies the path to the trusted CA certificate file. This
+   parameter is applicable only if you are using *ldaps* as connection protocol and
+   you have set *LDAP_USE_STARTTLS* parameter to *True*."
+   "LDAP_CERT_FILE","Specifies the path to the server certificate file. This parameter
+   is applicable only if you are using *ldaps* as connection protocol and you have
+   set *LDAP_USE_STARTTLS* parameter to *True*."
+   "LDAP_KEY_FILE","Specifies the path to the server private key file. This parameter
+   is applicable only if you are using *ldaps* as connection protocol and you have
+   set *LDAP_USE_STARTTLS* parameter to *True*."
+   "**Bind as pgAdmin user**"
+   "LDAP_BASE_DN","Specifies the base DN from where a server will start the search
+   for users. For example, an LDAP search for any user will be performed by the server
+   starting at the base DN (dc=example,dc=com). When the base DN matches, the full
+   DN (cn=admin,dc=example,dc=com) is used to bind with the supplied password."
+   "**Anonymous bind**"
+   "LDAP_ANONYMOUS_BIND","Set this parameter to *True* for anonymous binding.
+   After the connection is made, the pgadmin login user will be further authenticated
+   by the username and password provided at the login screen."
+   "**Dedicated user bind**"
+   "LDAP_BIND_USER", "The account of the user to log in for simple bind.
+   Set this parameter to allow the connection to bind using a dedicated user.
+   After the connection is made, the pgadmin login user will be further
+   authenticated by the username and password provided at the login screen.
+   at the login screen."
+   "LDAP_BIND_PASSWORD", "Password for simple bind.
+   Specify the value if you have set the LDAP_BIND_USER parameter."
+

docs/en_US/getting_started.rst

@@ -35,6 +35,7 @@ Mode is pre-configured for security.
    login
    user_management
    change_user_password
+   enabling_ldap_authentication
 
 
 .. note:: Pre-compiled and configured installation packages are available for
@@ -64,6 +65,8 @@ display.  To open the *Preferences* dialog, select *Preferences* from the *File*
 for the dialog.  You can access additional Postgres help by navigating through
 the *Help* menu, and selecting the name of the resource that you wish to open.
 
+You can search for objects in the database using the :ref:`Search objects <search_objects>`
+
 .. toctree::
    :maxdepth: 2
 
@@ -74,6 +77,7 @@ the *Help* menu, and selecting the name of the resource that you wish to open.
    tree_control
    preferences
    keyboard_shortcuts
+   search_objects
 
 Before using pgAdmin to manage objects that reside on a server, you must define a
 connection to the server; for more information please see *Connecting to a Server*