Merge pull request #87 from takluyver/applocal-msvcrt

Applocal msvcrt

doc/cfgfile.rst

@@ -152,13 +152,32 @@ Python section
   - ``bundled`` includes an embeddable Python build, which will be installed as
     part of your application. This is available for Python 3.5 and above.
 
+.. describe:: include_msvcrt (optional)
+
+  This option is only relevant with ``format = bundled``. The default is ``true``,
+  which will include an app-local copy of the Microsoft Visual C++ Runtime,
+  required for Python to run. The installer will only install this if it doesn't
+  detect a system installation of the runtime.
+
+  Setting this to ``false`` will not include the C++ Runtime. Your application may
+  not run for all users until they install it manually (`download from Microsoft
+  <https://www.microsoft.com/en-us/download/details.aspx?id=48145>`__). You may
+  prefer to do this for security reasons: the separately installed runtime will
+  get updates through Windows Update, but app-local copies will not.
+
+  Users on Windows 10 should already have the runtime installed systemwide, so
+  this does won't affect them. Users on Windows Vista, 7, 8 or 8.1 *may* already
+  have it, depending on what else is installed.
+
+  .. versionadded:: 1.9
+
 .. _python_bundled:
 
 Bundled Python
 ~~~~~~~~~~~~~~
 
 .. versionadded:: 1.6
-   Experimental support for bundling Python into the application.
+   Support for bundling Python into the application.
 
 Using ``format = bundled``, an embeddable Python build will be downloaded at
 build time and packaged along with the application. When the installer runs, it
@@ -172,9 +191,8 @@ limitations:
 - This option is only available for Python 3.5 and above. These versions of
   Python have dropped support for Windows XP, so your application will only work
   on Windows Vista and newer.
-- Installing in Windows Vista to 8.1 (inclusive) may need an internet connection
-  to download the necessary `Visual C++ runtime
-  <http://www.microsoft.com/en-us/download/details.aspx?id=48145>`__. This isn't
+- Installing in Windows Vista to 8.1 (inclusive) may install an app-local copy
+  of the Visual C++ runtime (see above). This isn't
   needed on Windows 10, which includes the necessary files.
 - The embeddable Python builds don't include ``tkinter``, to save space.
   Applications with a tkinter GUI can't easily use bundled Python. Workarounds

doc/releasenotes.rst

@@ -1,6 +1,16 @@
 Release notes
 =============
 
+Version 1.9
+-----------
+
+* The C Runtime needed for bundled Python is now installed 'app-local', rather
+  than downloading and installing Windows Update packages at install time. This
+  is considerably simpler, but the app-local runtime will not be updated by
+  Windows Update. A new ``include_msvcrt`` config option allows the developer to
+  exclude the app-local runtime - their applications will then depend on the
+  runtime being installed systemwide.
+
 Version 1.8
 -----------
 

nsist/__init__.py

@@ -84,6 +84,8 @@ class InstallerBuilder(object):
     :param str py_version: Full version of Python to bundle
     :param int py_bitness: Bitness of bundled Python (32 or 64)
     :param str py_format: 'installer' or 'bundled'
+    :param bool inc_msvcrt: True to include the Microsoft C runtime with 'bundled'
+            Python. Ignored when py_format='installer'.
     :param str build_dir: Directory to run the build in
     :param str installer_name: Filename of the installer to produce
     :param str nsi_template: Path to a template NSI file to use
@@ -91,7 +93,7 @@ class InstallerBuilder(object):
     def __init__(self, appname, version, shortcuts, icon=DEFAULT_ICON,
                 packages=None, extra_files=None, py_version=DEFAULT_PY_VERSION,
                 py_bitness=DEFAULT_BITNESS, py_format='installer',
-                build_dir=DEFAULT_BUILD_DIR,
+                inc_msvcrt=True, build_dir=DEFAULT_BUILD_DIR,
                 installer_name=None, nsi_template=None,
                 exclude=None, pypi_wheel_reqs=None, commands=None):
         self.appname = appname
@@ -123,6 +125,7 @@ class InstallerBuilder(object):
         else:
             if py_format != 'installer':
                 raise InputError('py_format', py_format, "installer (for Python < 3.5)")
+        self.inc_msvcrt = inc_msvcrt
 
         # Build details
         self.build_dir = build_dir
@@ -130,7 +133,10 @@ class InstallerBuilder(object):
         self.nsi_template = nsi_template
         if self.nsi_template is None:
             if self.py_format == 'bundled':
-                self.nsi_template = 'pyapp_msvcrt.nsi'
+                if self.inc_msvcrt:
+                    self.nsi_template = 'pyapp_msvcrt.nsi'
+                else:
+                    self.nsi_template = 'pyapp.nsi'
             elif self.py_version_tuple < (3, 3):
                 self.nsi_template = 'pyapp_w_pylauncher.nsi'
             else:
@@ -141,6 +147,7 @@ class InstallerBuilder(object):
         # To be filled later
         self.install_files = []
         self.install_dirs = []
+        self.msvcrt_files = []
     
     _py_version_pattern = re.compile(r'\d\.\d+\.\d+$')
 
@@ -212,6 +219,20 @@ class InstallerBuilder(object):
 
         self.install_dirs.append(('Python', '$INSTDIR'))
 
+    def prepare_msvcrt(self):
+        arch = 'x64' if self.py_bitness == 64 else 'x86'
+        src = pjoin(_PKGDIR, 'msvcrt', arch)
+        dst = pjoin(self.build_dir, 'msvcrt')
+        self.msvcrt_files = sorted(os.listdir(src))
+
+        try:
+            shutil.rmtree(dst)
+        except OSError as e:
+            if e.errno != errno.ENOENT:
+                raise
+
+        shutil.copytree(src, dst)
+
     def fetch_pylauncher(self):
         """Fetch the MSI for PyLauncher (required for Python2.x).
     
@@ -416,9 +437,6 @@ if __name__ == '__main__':
         self.install_files.sort(key=operator.itemgetter(1))
         nsis_writer.write(self.nsi_file)
 
-        if self.py_format == 'bundled':
-            shutil.copy2(pjoin(_PKGDIR, 'windowsversion.nsh'), self.build_dir)
-
     def run_nsis(self):
         """Runs makensis using the specified .nsi file
         
@@ -448,6 +466,8 @@ if __name__ == '__main__':
 
         if self.py_format == 'bundled':
             self.fetch_python_embeddable()
+            if self.inc_msvcrt:
+                self.prepare_msvcrt()
         else:
             self.fetch_python()
             if self.py_version < '3.3':
@@ -517,6 +537,7 @@ def main(argv=None):
             py_version = cfg.get('Python', 'version', fallback=DEFAULT_PY_VERSION),
             py_bitness = cfg.getint('Python', 'bitness', fallback=DEFAULT_BITNESS),
             py_format = cfg.get('Python', 'format', fallback='installer'),
+            inc_msvcrt = cfg.getboolean('Python', 'include_msvcrt', fallback=True),
             build_dir = cfg.get('Build', 'directory', fallback=DEFAULT_BUILD_DIR),
             installer_name = cfg.get('Build', 'installer_name', fallback=None),
             nsi_template = cfg.get('Build', 'nsi_template', fallback=None),

nsist/configreader.py

@@ -77,6 +77,7 @@ CONFIG_VALIDATORS = {
         ('version', False),
         ('bitness', False),
         ('format', False),
+        ('include_msvcrt', False),
     ]),
     'Shortcut': SectionValidator([
         ('entry_point', False),

nsist/pyapp.nsi

@@ -46,7 +46,8 @@ Section "!${PRODUCT_NAME}" sec_app
   SetOutPath "$INSTDIR\pkgs"
   File /r "pkgs\*.*"
   SetOutPath "$INSTDIR"
-  
+
+  [% block install_files %]
   ; Install files
   [% for destination, group in grouped_files %]
     SetOutPath "[[destination]]"
@@ -60,6 +61,7 @@ Section "!${PRODUCT_NAME}" sec_app
     SetOutPath "[[ pjoin(destination, dir) ]]"
     File /r "[[dir]]\*.*"
   [% endfor %]
+  [% endblock install_files %]
   
   [% block install_shortcuts %]
   ; Install shortcuts
@@ -127,6 +129,7 @@ Section "Uninstall"
   [% endif %]
   [% endblock uninstall_commands %]
 
+  [% block uninstall_files %]
   ; Uninstall files
   [% for file, destination in ib.install_files %]
     Delete "[[pjoin(destination, file)]]"
@@ -135,6 +138,8 @@ Section "Uninstall"
   [% for dir, destination in ib.install_dirs %]
     RMDir /r "[[pjoin(destination, dir)]]"
   [% endfor %]
+  [% endblock uninstall_files %]
+
   [% block uninstall_shortcuts %]
   ; Uninstall shortcuts
   [% if single_shortcut %]

nsist/pyapp_msvcrt.nsi

@@ -1,71 +1,14 @@
 [% extends "pyapp.nsi" %]
 
-[% block sections %]
-!addplugindir [[ pynsist_pkg_dir ]]
-!include windowsversion.nsh
-!include x64.nsh
-
-Section "-msvcrt"
-  ${GetWindowsVersion} $R0
-
-  StrCpy $0 "--"
-
-  ${If} ${RunningX64}
-    ${If} $R0 == "8.1"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x64/Windows8.1-KB2999226-x64.msu"
-    ${ElseIf} $R0 == "8"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x64/Windows8-RT-KB2999226-x64.msu"
-    ${ElseIf} $R0 == "7"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x64/Windows6.1-KB2999226-x64.msu"
-    ${ElseIf} $R0 == "Vista"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x64/Windows6.0-KB2999226-x64.msu"
-    ${EndIf}
-  ${Else}
-    ${If} $R0 == "8.1"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x86/Windows8.1-KB2999226-x86.msu"
-    ${ElseIf} $R0 == "8"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x86/Windows8-RT-KB2999226-x86.msu"
-    ${ElseIf} $R0 == "7"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x86/Windows6.1-KB2999226-x86.msu"
-    ${ElseIf} $R0 == "Vista"
-      StrCpy $0 "https://cdn.rawgit.com/takluyver/pynsist/msvcrt-tag1/x86/Windows6.0-KB2999226-x86.msu"
-    ${EndIf}
-  ${EndIf}
-
-  IfFileExists "$SYSDIR\ucrtbase.dll" skip_msvcrt
-  StrCmp $0 "--" skip_msvcrt
-
-  DetailPrint "Need to install MSVCRT 2015. This may take a few minutes."
-  DetailPrint "Downloading $0"
-  inetc::get /RESUME "" "$0" "$INSTDIR\msvcrt.msu"
-  Pop $2
-  DetailPrint "Download finished ($2)"
-  ${If} $2 == "OK"
-    DetailPrint "Running wusa to install update package"
-    ExecWait 'wusa "$INSTDIR\msvcrt.msu" /quiet /norestart' $1
-    Delete "$INSTDIR\msvcrt.msu"
-  ${Else}
-    MessageBox MB_OK "Failed to download important update! \
-            ${PRODUCT_NAME} will not run until you install the Visual C++ \
-            redistributable for Visual Studio 2015.\
-            $\n$\nhttp://www.microsoft.com/en-us/download/details.aspx?id=48145"
-  ${EndIf}
-
-  # This WUSA exit code means a reboot is needed.
-  ${If} $1 = 0x00240005
-    SetRebootFlag true
-  ${Else}
-    IntOp $0 $1 & 0x80000000
-    ${If} $0 <> 0
-      MessageBox MB_OK "Failed to install important update! \
-            ${PRODUCT_NAME} will not run until you install the Visual C++ \
-            redistributable for Visual Studio 2015.\
-            $\n$\nhttp://www.microsoft.com/en-us/download/details.aspx?id=48145"
-    ${EndIf}
-  ${EndIf}
-
-  skip_msvcrt:
-SectionEnd
-
-[[ super() ]]
-[% endblock sections %]
+[% block install_files %]
+    [[ super() ]]
+
+    ; Install MSVCRT if it's not already on the system
+    IfFileExists "$SYSDIR\ucrtbase.dll" skip_msvcrt
+    SetOutPath $INSTDIR\Python
+    [% for file in ib.msvcrt_files %]
+    File msvcrt\[[file]]
+    [% endfor %]
+    skip_msvcrt:
+
+[% endblock %]

nsist/windowsversion.nsh

@@ -1,119 +0,0 @@
-; GetWindowsVersion 4.1 (2014-10-01)
-;
-; Based on Yazno's function, http://yazno.tripod.com/powerpimpit/
-; Update by Joost Verburg
-; Update (Macro, Define, Windows 7 detection) - John T. Haller of PortableApps.com - 2008-01-07
-; Update (Windows 8 detection) - Marek Mizanin (Zanir) - 2013-02-07
-; Update (Windows 8.1 detection) - John T. Haller of PortableApps.com - 2014-04-04
-; Update (Windows 10 TP detection) - John T. Haller of PortableApps.com - 2014-10-01
-; Got from http://nsis.sourceforge.net/Get_Windows_version
-;
-; Usage: ${GetWindowsVersion} $R0
-;
-; $R0 contains: 95, 98, ME, NT x.x, 2000, XP, 2003, Vista, 7, 8, 8.1, 10.0 or '' (for unknown)
-
-Function GetWindowsVersion
-
-  Push $R0
-  Push $R1
-
-  ClearErrors
-
-  ReadRegStr $R0 HKLM \
-  "SOFTWARE\Microsoft\Windows NT\CurrentVersion" CurrentVersion
-
-  IfErrors 0 lbl_winnt
-
-  ; we are not NT
-  ReadRegStr $R0 HKLM \
-  "SOFTWARE\Microsoft\Windows\CurrentVersion" VersionNumber
-
-  StrCpy $R1 $R0 1
-  StrCmp $R1 '4' 0 lbl_error
-
-  StrCpy $R1 $R0 3
-
-  StrCmp $R1 '4.0' lbl_win32_95
-  StrCmp $R1 '4.9' lbl_win32_ME lbl_win32_98
-
-  lbl_win32_95:
-    StrCpy $R0 '95'
-  Goto lbl_done
-
-  lbl_win32_98:
-    StrCpy $R0 '98'
-  Goto lbl_done
-
-  lbl_win32_ME:
-    StrCpy $R0 'ME'
-  Goto lbl_done
-
-  lbl_winnt:
-
-  StrCpy $R1 $R0 1
-
-  StrCmp $R1 '3' lbl_winnt_x
-  StrCmp $R1 '4' lbl_winnt_x
-
-  StrCpy $R1 $R0 3
-
-  StrCmp $R1 '5.0' lbl_winnt_2000
-  StrCmp $R1 '5.1' lbl_winnt_XP
-  StrCmp $R1 '5.2' lbl_winnt_2003
-  StrCmp $R1 '6.0' lbl_winnt_vista
-  StrCmp $R1 '6.1' lbl_winnt_7
-  StrCmp $R1 '6.2' lbl_winnt_8
-  StrCmp $R1 '6.3' lbl_winnt_81
-  StrCmp $R1 '6.4' lbl_winnt_10 lbl_error
-
-  lbl_winnt_x:
-    StrCpy $R0 "NT $R0" 6
-  Goto lbl_done
-
-  lbl_winnt_2000:
-    Strcpy $R0 '2000'
-  Goto lbl_done
-
-  lbl_winnt_XP:
-    Strcpy $R0 'XP'
-  Goto lbl_done
-
-  lbl_winnt_2003:
-    Strcpy $R0 '2003'
-  Goto lbl_done
-
-  lbl_winnt_vista:
-    Strcpy $R0 'Vista'
-  Goto lbl_done
-
-  lbl_winnt_7:
-    Strcpy $R0 '7'
-  Goto lbl_done
-
-  lbl_winnt_8:
-    Strcpy $R0 '8'
-  Goto lbl_done
-
-  lbl_winnt_81:
-    Strcpy $R0 '8.1'
-  Goto lbl_done
-
-  lbl_winnt_10:
-    Strcpy $R0 '10.0'
-  Goto lbl_done
-
-  lbl_error:
-    Strcpy $R0 ''
-  lbl_done:
-
-  Pop $R1
-  Exch $R0
-
-FunctionEnd
-
-!macro GetWindowsVersion OUTPUT_VALUE
-	Call GetWindowsVersion
-	Pop `${OUTPUT_VALUE}`
-!macroend
-
-!define GetWindowsVersion '!insertmacro "GetWindowsVersion"'