Merge lp:~a1s/brz/3.2-windows-installer into lp:brz/3.2

[Aleksandr Smyshliaev]

Make "make installer" pass on Windows

With these changes, I was able to build Breezy installer package on Windows.

Many commands still don't work, and I wasn't able to compile subvertpy, so the built-in plugin for Subversion is only added when subvertpy exists on the system.

Also, it would be nice to have an icon to pack with Windows executables.

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'Makefile'
--- Makefile	2021-02-19 02:53:40 +0000
+++ Makefile	2021-11-16 15:36:22 +0000
@@ -253,7 +253,7 @@
 	$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
 	$(PYTHON) setup.py py2exe > py2exe.log
 	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_brz.bat win32_brz.exe
-	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/bazaar.url win32_brz.exe
+	$(PYTHON) tools/win32/ostools.py copytodir tools/win32/breezy.url win32_brz.exe
 
 # win32 installer for brz.exe
 installer: exe copy-docs
@@ -268,7 +268,8 @@
 
 copy-docs: docs
 	$(PYTHON) tools/win32/ostools.py copytodir README win32_brz.exe/doc
-	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) win32_brz.exe
+	$(PYTHON) tools/win32/ostools.py copydir doc/en/_build/html win32_brz.exe/doc
+	$(PYTHON) tools/win32/ostools.py copydir doc/developers/_build/html win32_brz.exe/doc/developers
 
 # clean on win32 all installer-related files and directories
 clean-win32: clean-docs

=== modified file 'setup.py'
--- setup.py	2021-08-18 22:38:08 +0000
+++ setup.py	2021-11-16 15:36:22 +0000
@@ -366,7 +366,8 @@
     ico_root = os.path.join(tbzr_root, 'tbreezy', 'resources')
     icos = [] # list of (path_root, relative_ico_path)
     # First always brz's icon and its in the root of the brz tree.
-    icos.append(('', 'brz.ico'))
+    # FIXME: There's no such thing as brz.ico
+    #icos.append(('', 'brz.ico'))
     for root, dirs, files in os.walk(ico_root):
         icos.extend([(ico_root, os.path.join(root, f)[len(ico_root) + 1:])
                      for f in files if f.endswith('.ico')])
@@ -524,7 +525,7 @@
 
 elif 'py2exe' in sys.argv:
     # py2exe setup
-    import py2exe
+    from py2exe import distutils_buildexe as py2exe
 
     # pick real brz version
     import breezy
@@ -568,15 +569,17 @@
             self.outfiles.extend([f + 'o' for f in compile_names])
     # end of class install_data_with_bytecompile
 
-    target = py2exe.build_exe.Target(
+    target = py2exe.runtime.Target(
         script="brz",
         dest_base="brz",
-        icon_resources=[(0, 'brz.ico')],
+        # FIXME: There's no such thing as brz.ico
+        #icon_resources=[(0, 'brz.ico')],
         name=META_INFO['name'],
         version=version_str,
         description=META_INFO['description'],
-        author=META_INFO['author'],
-        copyright="(c) Canonical Ltd, 2005-2010",
+        maintainer=META_INFO['maintainer'],
+        copyright="Copyright 2005-2012 Canonical Ltd.\n"
+            "Copyright 2017-2021 Breezy developers",
         company_name="Canonical Ltd.",
         comments=META_INFO['description'],
     )
@@ -637,6 +640,14 @@
             # rest of the svn plugin wasn't. So we tell py2exe to leave the
             # plugins out of the .zip file
             excludes.extend(["breezy.plugins." + d for d in dirs])
+            # svn plugin requires subvertpy,
+            # and pip cannot install it on Windows.
+            # When subvertpy is not available, remove svn from plugins
+            if "svn" in dirs:
+                try:
+                    import subvertpy
+                except ImportError:
+                    dirs.remove("svn")
         x = []
         for i in files:
             # Throw away files we don't want packaged. Note that plugins may
@@ -651,16 +662,20 @@
         if x:
             target_dir = root[len('breezy/'):]  # install to 'plugins/...'
             plugins_files.append((target_dir, x))
-    # find modules for built-in plugins
+    # find modules required by built-in plugins
     import tools.package_mf
-    mf = tools.package_mf.CustomModuleFinder()
-    mf.run_package('breezy/plugins')
-    packs, mods = mf.get_result()
-    additional_packages.update(packs)
-    includes.extend(mods)
+    mf = tools.package_mf.CustomModuleFinder('.')
+    mf.load_package_recursive('breezy.plugins')
+    (packs, mods) = mf.get_result()
+    # Don't add the plugins packages and modules,
+    # as they are listed in excluded
+    additional_packages.update(pack for pack in packs
+        if not (pack.startswith('breezy.plugins.') or pack in excludes))
+    includes.extend(mod for mod in mods
+        if not (mod.startswith('breezy.plugins.') or mod in excludes))
 
     console_targets = [target,
-                       'tools/win32/bzr_postinstall.py',
+                       'tools/win32/brz_postinstall.py',
                        ]
     gui_targets = [gui_target]
     data_files = topics_files + plugins_files + I18N_FILES
@@ -715,7 +730,7 @@
                                "includes": includes,
                                "excludes": excludes,
                                "dll_excludes": dll_excludes,
-                               "dist_dir": "win32_bzr.exe",
+                               "dist_dir": "win32_brz.exe",
                                "optimize": 2,
                                "custom_boot_script":
                                    "tools/win32/py2exe_boot_common.py",
@@ -725,10 +740,10 @@
     # We want the libaray.zip to have optimize = 2, but the exe to have
     # optimize = 1, so that .py files that get compilied at run time
     # (e.g. user installed plugins) dont have their doc strings removed.
-    class py2exe_no_oo_exe(py2exe.build_exe.py2exe):
-        def build_executable(self, *args, **kwargs):
+    class py2exe_no_oo_exe(py2exe.py2exe):
+        def run(self, *args, **kwargs):
             self.optimize = 1
-            py2exe.build_exe.py2exe.build_executable(self, *args, **kwargs)
+            super(py2exe_no_oo_exe, self).run(*args, **kwargs)
             self.optimize = 2
 
     if __name__ == '__main__':

=== modified file 'tools/package_mf.py'
--- tools/package_mf.py	2018-11-16 12:25:18 +0000
+++ tools/package_mf.py	2021-11-16 15:36:22 +0000
@@ -16,10 +16,12 @@
 
 """Custom module finder for entire package"""
 
-import modulefinder
 import os
 import sys
 
+# At present, this is only used on Windows (see setup.py)
+from py2exe import mf310 as modulefinder
+
 
 class CustomModuleFinder(modulefinder.ModuleFinder):
     """Custom module finder for processing python packages,
@@ -35,27 +37,54 @@
         modulefinder.ModuleFinder.__init__(
             self, path, debug, excludes, replace_paths)
 
-    def run_package(self, package_path):
-        """Recursively process each module in package with run_script method.
+    def load_package_recursive(self, fqname):
+        """Recursively process each module in package
 
-        :param  package_path:   path to package directory.
+        :param  fqname:   name of the package.
         """
-        stack = [package_path]
+        # Load all the parents
+        parent = None
+        path = []
+        for partname in fqname.split("."):
+            parent_path = ".".join(path)
+            path.append(partname)
+            # import_module works recursively,
+            # and some of the dependencies may try
+            # to import modules not present on the system.
+            # (The actual error is
+            # AttributeError: 'NoneType' object has no attribute 'is_package')
+            # Ignore errors here and bail out in the collection loop.
+            try:
+                self.import_module(partname, ".".join(path),
+                    self.modules.get(parent_path, None))
+            except:
+                pass
+        stack = [(fqname, parent_path)]
         while stack:
-            curdir = stack.pop(0)
-            py = os.listdir(curdir)
-            for i in py:
-                full = os.path.join(curdir, i)
+            (package, parent_path) = stack.pop(0)
+            # Here we assume that all parents have already been imported.
+            # Abort when a parent is missing.
+            parent = self.modules[parent_path]
+            pkg_module = self.import_module(package, package, parent)
+            curdir = pkg_module.__file__
+            dirlist = os.listdir(curdir)
+            for filename in dirlist:
+                full = os.path.join(curdir, filename)
                 if os.path.isdir(full):
+                    if filename == "tests":
+                        continue
                     init = os.path.join(full, '__init__.py')
                     if os.path.isfile(init):
-                        stack.append(full)
-                    continue
-                if not i.endswith('.py'):
-                    continue
-                if i == 'setup.py':     # skip
-                    continue
-                self.run_script(full)
+                        stack.append((".".join((package, filename)), package))
+                    continue
+                if not filename.endswith('.py'):
+                    continue
+                if filename == 'setup.py':     # skip
+                    continue
+                # We only accept .py files, so could use [:-3] too - faster...
+                partname = os.path.splitext(filename)[0]
+                self.import_module(partname,
+                    ".".join((package, partname)), pkg_module)
 
     def get_result(self):
         """Return 2-tuple: (list of packages, list of modules)"""

=== modified file 'tools/win32/brz.iss.cog'
--- tools/win32/brz.iss.cog	2017-06-02 21:28:05 +0000
+++ tools/win32/brz.iss.cog	2021-11-16 15:36:22 +0000
@@ -78,6 +78,14 @@
 ; [[[cog cog.outl('AppVersion=%s' % VERSION) ]]]
 ; [[[end]]]
 
+; [[[cog
+; import platform
+;
+; if platform.machine().endswith("64"):
+;     cog.outl('ArchitecturesAllowed=x64')
+;     cog.outl('ArchitecturesInstallIn64BitMode=x64')
+; ]]]
+; [[[end]]]
 ChangesEnvironment=yes
 ; MARKH: PrivilegesRequired=none means it can't be installed by a non-admin
 ; user - but sadly we still need admin - eg, tortoise overlays, installing
@@ -115,8 +123,12 @@
 Source: "plugins\*.*"; DestDir: "{app}\\plugins"; Flags: createallsubdirs ignoreversion recursesubdirs restartreplace uninsrestartdelete; Components: plugins
 Source: "*.bat"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
 Source: "*.url"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
-Source: "msvc*.dll"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
-Source: "bz*.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
+; Python3 includes vcruntime*.dll which is not packed in by py2exe.
+; I'm not sure if the installer has to contain it.
+; It looks like the binaries work OK without vcruntime dll.
+; Delete this dll line when we're sure.
+;Source: "msvc*.dll"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
+Source: "brz*.exe"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
 Source: "Python*.dll"; DestDir: "{app}"; Flags: ignoreversion restartreplace uninsrestartdelete;
 Source: "lib\*.*"; DestDir: "{app}\lib"; Flags: createallsubdirs ignoreversion recursesubdirs restartreplace uninsrestartdelete;
 Source: "doc\*.*"; DestDir: "{app}\doc"; Flags: createallsubdirs ignoreversion recursesubdirs restartreplace uninsrestartdelete;
@@ -141,7 +153,7 @@
 ; imageformats plugins for PyQt4
 ; [[[cog
 ; plug_dir = os.path.join(os.path.dirname(cog.inFile), # $(bzr_src_root)/tools/win32
-;                         '..', '..', 'win32_bzr.exe', 'imageformats')
+;                         '..', '..', 'win32_brz.exe', 'imageformats')
 ; if os.path.isdir(plug_dir):
 ;     cog.outl('Source: "imageformats\\*.*"; DestDir: "{app}\\imageformats"; '
 ;              'Flags: createallsubdirs ignoreversion recursesubdirs restartreplace uninsrestartdelete;')
@@ -179,9 +191,9 @@
 [Icons]
 Name: "{group}\Documentation index"; Filename: "{app}\doc\index.html"; WorkingDir: "{app}\doc";
 Name: "{group}\Breezy Home Page"; Filename: "{app}\breezy.url"; Comment: "https://www.breezy-vcs.org/";
-Name: "{group}\Start Bzr in cmd shell"; Filename: "{cmd}"; Parameters: "/K start_bzr.bat"; WorkingDir: "{app}"; IconFilename: "{app}\bzr.exe"; Comment: "Open new Bzr session";
+Name: "{group}\Start Bzr in cmd shell"; Filename: "{cmd}"; Parameters: "/K start_brz.bat"; WorkingDir: "{app}"; IconFilename: "{app}\brz.exe"; Comment: "Open new Bzr session";
 ; NOTE: Intent is to change the log file location - the line below will need to change to reflect that.
-Name: "{group}\Open Bzr log file"; Filename: "notepad.exe"; Parameters: "{userdocs}\.bzr.log"; Comment: "Launch notepad to view the bzr log file";
+Name: "{group}\Open Bzr log file"; Filename: "notepad.exe"; Parameters: "{userdocs}\.brz.log"; Comment: "Launch notepad to view the brz log file";
 
 ; [[[cog
 ; if "TBZR" in os.environ:
@@ -224,7 +236,7 @@
 
 
 [UninstallRun]
-Filename: "{app}\bzr_postinstall.exe"; Parameters: "--delete-path --delete-shell-menu --silent"; Flags: skipifdoesntexist runhidden;
+Filename: "{app}\brz_postinstall.exe"; Parameters: "--delete-path --delete-shell-menu --silent"; Flags: skipifdoesntexist runhidden;
 ; [[[cog
 ; if "TBZR" in os.environ:
 ;     cog.outl('Filename: "regsvr32.exe"; Parameters: "/u /s /i: tbzrshellext_x86.dll"; WorkingDir: "{app}"; Components: tortoise; StatusMsg: "Unregistering Tortoise"; Flags: skipifdoesntexist')
@@ -320,7 +332,7 @@
                              ewWaitUntilTerminated, ErrorCode) then
                 MsgBox('Failed to install TortoiseOverlays: ' + SysErrorMessage(ErrorCode),
                         mbInformation, MB_OK);
-            // Ideally we could be bzr_postinstall.exe this way too, but
+            // Ideally we could be brz_postinstall.exe this way too, but
             // its needed at uninstall time.
         end;
         // cause explorer to re-fetch handlers.

=== modified file 'tools/win32/info.txt'
--- tools/win32/info.txt	2010-03-30 20:13:52 +0000
+++ tools/win32/info.txt	2021-11-16 15:36:22 +0000
@@ -1,6 +1,6 @@
-Bazaar is free software; you can redistribute and/or modify it under
-the terms of the GNU General Public License version 2. 
+Breezy is free software; you can redistribute and/or modify it
+under the terms of the GNU General Public License version 2. 
 
 See: http://www.gnu.org/copyleft/gpl.html
 
-Managing source code in Bazaar does not make it subject to the GPL.
+Managing source code in Breezy does not make it subject to the GPL.

=== modified file 'tools/win32/ostools.py'
--- tools/win32/ostools.py	2020-01-31 17:43:44 +0000
+++ tools/win32/ostools.py	2021-11-16 15:36:22 +0000
@@ -12,6 +12,9 @@
     ostools.py copytree FILES... DIR
                     copy files to specified directory keeping relative paths
 
+    ostools.py copydir SOURCE TARGET
+                    recursively copy SOURCE directory tree to TARGET directory
+
     ostools.py remove [FILES...] [DIRS...]
                     remove files or directories (recursive)
 """
@@ -89,6 +92,19 @@
 
         return 0
 
+    if cmd == 'copydir':
+        if len(argv) != 2:
+            print("Usage:  ostools.py copydir SOURCE TARGET")
+            return 1
+
+        def _copy(src, dest, follow_symlinks=True):
+            shutil.copy(src, dest, follow_symlinks=follow_symlinks)
+            print("Copied:", src, "=>", dest)
+        shutil.copytree(argv[0], argv[1],
+            copy_function=_copy, dirs_exist_ok=True)
+
+        return 0
+
     if cmd == 'remove':
         if len(argv) == 0:
             print("Usage:  ostools.py remove [FILES...] [DIRS...]")

=== modified file 'tools/win32/start_brz.bat'
--- tools/win32/start_brz.bat	2017-05-21 14:47:52 +0000
+++ tools/win32/start_brz.bat	2021-11-16 15:36:22 +0000
@@ -6,7 +6,7 @@
 REM    ******************************************************
 
 REM Add the Brz directory to system-wide PATH environment variable
-SET PATH=C:\Program Files\Bazaar;%PATH%
+SET PATH=C:\Program Files\Breezy;%PATH%
 
 REM Change next line to set-up e-mail to identify yourself in brz
 REM SET BZREMAIL=