From dc14453f342d5e2513df0e6758c82c48cd844144 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Thu, 22 Nov 2012 23:22:34 +0000 Subject: [PATCH] Update bbfreeze and nsis scripts for win32 packaging bbfreeze script: * Creates a VERSION.tmp file for use by nsis script * Includes all theme, icon and locale files. Closes #2096 & #2145 * Add email.mime.multipart and email.mime.text. Closes #2074 * deluged.exe and deluge-web.exe will no longer show a cmd window and created deluged-debug.exe and deluge-web-debug.exe as replacements if still needed * Overridden bbfreeze gtk recipe thus no longer requiring file editing. * Remove unnecessary python module includes nsis script: * Deluge version now based upon bbfreeze output * Installer will warn if deluge already running. Closes #1217 * Removed deluged and deluge-web shortcuts from start menu * Increased compression level for lzma --- win32/Win32 README.txt | 40 +------ win32/deluge-bbfreeze.py | 76 ++++++++++-- win32/deluge-win32-installer.nsi | 28 +++-- win32/icon.py | 191 +++++++++++++++++++++++++++++++ 4 files changed, 280 insertions(+), 55 deletions(-) create mode 100644 win32/icon.py diff --git a/win32/Win32 README.txt b/win32/Win32 README.txt index 6fc397b34..d74e02278 100644 --- a/win32/Win32 README.txt +++ b/win32/Win32 README.txt @@ -9,46 +9,14 @@ Instructions for building the Deluge NSIS Installer for Windows XP/Vista/7. == Build Steps == - 1. Build Deluge on Windows. + 1. Build and Install Deluge on Windows. - 2. Verify/update the Deluge version in the win32 packaging scripts. - - bbfreeze script - Edit 'build_version' variable in: - - win32/deluge-bbfreeze.py - - NSIS script - Edit 'PROGRAM_VERSION' variable in: - - win32/deluge-win32-installer.nsi - - 3. Modify bbfreeze program. - - We want to include all the gtk libraries in the installer so that users don't - require a separate GTK+ installation so we need to slightly modify bbfreeze. - - The modification is to add a line to bbfreeze\recipes.py, usually located here: - - C:\Python26\Lib\site-packages\bbfreeze-*-py2.6-win32.egg\bbfreeze\recipes.py - - Find the line containing 'def recipe_gtk_and_friends' and after it add: - - return True - - 4. Run the bbfreeze script from the win32 directory: + 2. Run the bbfreeze script from the win32 directory: python deluge-bbfreeze.py - The script places the bbfreeze'd version of Deluge in + The result is a bbfreeze'd version of Deluge in `build-win32/deluge-bbfreeze-build_version`. - build-win32/deluge-bbfreeze-build_version - - Note: The assumption for this script is that Python 2.6 is installed - in 'C:\Python26' otherwise the 'python_path' variable should be changed. - - 5. Run the NSIS script (right-click and choose `Compile with NSIS`) + 3. Run the NSIS script (right-click and choose `Compile with NSIS`) The result is a standalone installer in the `build-win32` directory. - -The Uninstaller will remove everything from the installation directory. The file -association for '.torrent' will also be removed but only if it's associated with Deluge - diff --git a/win32/deluge-bbfreeze.py b/win32/deluge-bbfreeze.py index acd13784f..e44cf0707 100644 --- a/win32/deluge-bbfreeze.py +++ b/win32/deluge-bbfreeze.py @@ -1,45 +1,101 @@ -build_version = "1.4.0-dev" -python_path = "C:\\Python26\\" - -import os, glob +import os, glob, sys import shutil +import deluge.common + +# Get build_version from installed deluge +build_version = deluge.common.get_version() +print "Deluge Version: %s" % build_version +python_path = os.path.dirname(sys.executable) + "\\" +print "Python Path: %s" % python_path +gtk_root = python_path + "Lib\\site-packages\\gtk-2.0\\runtime\\" + +# Copy entry scripts with new name, which represents final .exe filename shutil.copy(python_path + "Scripts\deluge-script.pyw", python_path + "Scripts\deluge.py") shutil.copy(python_path + "Scripts\deluge-script.pyw", python_path + "Scripts\deluge-debug.py") shutil.copy(python_path + "Scripts\deluged-script.py", python_path + "Scripts\deluged.py") +shutil.copy(python_path + "Scripts\deluged-script.py", python_path + "Scripts\deluged-debug.py") shutil.copy(python_path + "Scripts\deluge-web-script.py", python_path + "Scripts\deluge-web.py") +shutil.copy(python_path + "Scripts\deluge-web-script.py", python_path + "Scripts\deluge-web-debug.py") shutil.copy(python_path + "Scripts\deluge-gtk-script.pyw", python_path + "Scripts\deluge-gtk.py") shutil.copy(python_path + "Scripts\deluge-console-script.py", python_path + "Scripts\deluge-console.py") -includes=("libtorrent", "gzip", "zipfile", "re", "socket", "struct", "cairo", "pangocairo", "atk", "pango", "twisted.internet.utils", "gio", "gtk.glade", "email.mime") +# Include python modules not picked up automatically by bbfreeze +includes=( + "libtorrent", "cairo", "pangocairo", "atk", "pango", "twisted.internet.utils", + "gio", "gzip", "email.mime.multipart", "email.mime.text" + ) excludes=("numpy", "OpenGL", "psyco", "win32ui") dst = "..\\build-win32\\deluge-bbfreeze-" + build_version + "\\" +# Need to override bbfreeze function so that it includes all gtk libraries +# in the installer so users don't require a separate GTK+ installation. +import bbfreeze.recipes +def recipe_gtk_override(mf): + return True +bbfreeze.recipes.recipe_gtk_and_friends = recipe_gtk_override + from bbfreeze import Freezer f = Freezer(dst, includes=includes, excludes=excludes) f.include_py = False f.addScript(python_path + "Scripts\deluge.py", gui_only=True) f.addScript(python_path + "Scripts\deluge-debug.py", gui_only=False) -f.addScript(python_path + "Scripts\deluged.py", gui_only=False) -f.addScript(python_path + "Scripts\deluge-web.py", gui_only=False) +f.addScript(python_path + "Scripts\deluged.py", gui_only=True) +f.addScript(python_path + "Scripts\deluged-debug.py", gui_only=False) +f.addScript(python_path + "Scripts\deluge-web.py", gui_only=True) +f.addScript(python_path + "Scripts\deluge-web-debug.py", gui_only=False) f.addScript(python_path + "Scripts\deluge-gtk.py", gui_only=True) f.addScript(python_path + "Scripts\deluge-console.py", gui_only=False) f() # starts the freezing process # add icons to the exe files import icon - icon_path = os.path.join(os.path.dirname(__file__), "deluge.ico") icon.CopyIcons(dst+"deluge.exe", icon_path) icon.CopyIcons(dst+"deluge-debug.exe", icon_path) icon.CopyIcons(dst+"deluged.exe", icon_path) +icon.CopyIcons(dst+"deluged-debug.exe", icon_path) icon.CopyIcons(dst+"deluge-web.exe", icon_path) +icon.CopyIcons(dst+"deluge-web-debug.exe", icon_path) icon.CopyIcons(dst+"deluge-gtk.exe", icon_path) icon.CopyIcons(dst+"deluge-console.exe", icon_path) # exclude files which are already included in GTK or Windows -excludeFiles = ("MSIMG32.dll", "MSVCR90.dll", "MSVCP90.dll", "POWRPROF.dll", "DNSAPI.dll", "USP10.dll") -for file in excludeFiles: +excludeDlls = ("MSIMG32.dll", "MSVCR90.dll", "MSVCP90.dll", "POWRPROF.dll", "DNSAPI.dll", "USP10.dll") +for file in excludeDlls: for filename in glob.glob(dst + file): print "removing file:", filename os.remove(filename) + +# copy gtk locale files +gtk_locale = os.path.join(gtk_root, 'share/locale') +locale_include_list = ['gtk20.mo', 'locale.alias'] +def ignored_files(adir,filenames): + return [ + filename for filename in filenames + if not os.path.isdir(os.path.join(adir, filename)) + and filename not in locale_include_list + ] +shutil.copytree(gtk_locale, os.path.join(dst, 'share/locale'), ignore=ignored_files) + +# copy gtk theme files +theme_include_list = [ + "share/icons/hicolor/index.theme", + "lib/gtk-2.0/2.10.0/engines", + "share/themes/MS-Windows", + "etc/gtk-2.0/gtkrc"] +for path in theme_include_list: + full_path = os.path.join(gtk_root, path) + if os.path.isdir(full_path): + shutil.copytree(full_path, os.path.join(dst, path)) + else: + dst_dir = os.path.join(dst, os.path.dirname(path)) + try: + os.makedirs(dst_dir) + except: + pass + shutil.copy(full_path, dst_dir) + +file = open('VERSION.tmp', 'w') +file.write("build_version = \"%s\"" % build_version) +file.close() diff --git a/win32/deluge-win32-installer.nsi b/win32/deluge-win32-installer.nsi index 82a03094d..e4e0811d1 100644 --- a/win32/deluge-win32-installer.nsi +++ b/win32/deluge-win32-installer.nsi @@ -1,5 +1,5 @@ # Deluge Windows installer script -# Version 0.4 28-Apr-2009 +# Version 0.6 22-Nov-2012 # Copyright (C) 2009 by # Jesper Lund @@ -26,21 +26,26 @@ # # Set default compressor -SetCompressor lzma +SetCompressor /FINAL /SOLID lzma +SetCompressorDictSize 64 ### ### --- The PROGRAM_VERSION !define need to be updated with new Deluge versions --- ### # Script version; displayed when running the installer -!define DELUGE_INSTALLER_VERSION "0.5" +!define DELUGE_INSTALLER_VERSION "0.6" # Deluge program information !define PROGRAM_NAME "Deluge" -!define PROGRAM_VERSION "1.4.0-dev" +# Deluge program information +!searchparse /file VERSION.tmp `build_version = "` PROGRAM_VERSION `"` +!ifndef PROGRAM_VERSION + !error "Program Version Undefined" +!endif !define PROGRAM_WEB_SITE "http://deluge-torrent.org" -# Python files generated with bbfreeze (without DLLs from GTK+ runtime) +# Python files generated with bbfreeze !define DELUGE_PYTHON_BBFREEZE_OUTPUT_DIR "..\build-win32\deluge-bbfreeze-${PROGRAM_VERSION}" # --- Interface settings --- @@ -93,6 +98,15 @@ SetCompressor lzma # --- Functions --- +Function .onInit + System::Call 'kernel32::OpenMutex(i 0x100000, b 0, t "deluge") i .R0' + IntCmp $R0 0 notRunning + System::Call 'kernel32::CloseHandle(i $R0)' + MessageBox MB_OK|MB_ICONEXCLAMATION "Deluge is running. Please close it first" /SD IDOK + Abort + notRunning: +FunctionEnd + Function un.onUninstSuccess HideWindow MessageBox MB_ICONINFORMATION|MB_OK "$(^Name) was successfully removed from your computer." @@ -140,8 +154,6 @@ Section -StartMenu_Desktop_Links SetShellVarContext all CreateDirectory "$SMPROGRAMS\Deluge" CreateShortCut "$SMPROGRAMS\Deluge\Deluge.lnk" "$INSTDIR\deluge.exe" - CreateShortCut "$SMPROGRAMS\Deluge\Deluge daemon.lnk" "$INSTDIR\deluged.exe" - CreateShortCut "$SMPROGRAMS\Deluge\Deluge webUI.lnk" "$INSTDIR\deluge-web.exe" CreateShortCut "$SMPROGRAMS\Deluge\Project homepage.lnk" "$INSTDIR\Homepage.url" CreateShortCut "$SMPROGRAMS\Deluge\Uninstall Deluge.lnk" "$INSTDIR\Deluge-uninst.exe" CreateShortCut "$DESKTOP\Deluge.lnk" "$INSTDIR\deluge.exe" @@ -197,8 +209,6 @@ Section Uninstall SetShellVarContext all Delete "$SMPROGRAMS\Deluge\Deluge.lnk" - Delete "$SMPROGRAMS\Deluge\Deluge daemon.lnk" - Delete "$SMPROGRAMS\Deluge\Deluge webUI.lnk" Delete "$SMPROGRAMS\Deluge\Uninstall Deluge.lnk" Delete "$SMPROGRAMS\Deluge\Project homepage.lnk" Delete "$DESKTOP\Deluge.lnk" diff --git a/win32/icon.py b/win32/icon.py new file mode 100644 index 000000000..f7b7cea51 --- /dev/null +++ b/win32/icon.py @@ -0,0 +1,191 @@ +#! /usr/bin/env python +# Copyright (C) 2005, Giovanni Bajo +# Based on previous work under copyright (c) 2002 McMillan Enterprises, 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 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 + +# This code is courtesy of Thomas Heller, who +# has kindly donated it to this project. +RT_ICON = 3 +RT_GROUP_ICON = 14 +LOAD_LIBRARY_AS_DATAFILE = 2 + +import struct +import types +try: + StringTypes = types.StringTypes +except AttributeError: + StringTypes = [ type("") ] + +class Structure: + def __init__ (self): + size = self._sizeInBytes = struct.calcsize (self._format_) + self._fields_ = list (struct.unpack (self._format_, '\000' * size)) + indexes = self._indexes_ = {} + for i in range (len (self._names_)): + indexes[self._names_[i]] = i + def dump (self): + print "I: DUMP of", self + for name in self._names_: + if name[0] != '_': + print "I: %20s = %s" % (name, getattr (self, name)) + print + def __getattr__ (self, name): + if name in self._names_: + index = self._indexes_[name] + return self._fields_[index] + try: + return self.__dict__[name] + except KeyError: + raise AttributeError, name + def __setattr__ (self, name, value): + if name in self._names_: + index = self._indexes_[name] + self._fields_[index] = value + else: + self.__dict__[name] = value + def tostring (self): + return apply (struct.pack, [self._format_,] + self._fields_) + def fromfile (self, file): + data = file.read (self._sizeInBytes) + self._fields_ = list (struct.unpack (self._format_, data)) + +class ICONDIRHEADER (Structure): + _names_ = "idReserved", "idType", "idCount" + _format_ = "hhh" + +class ICONDIRENTRY (Structure): + _names_ = "bWidth", "bHeight", "bColorCount", "bReserved", "wPlanes", "wBitCount", "dwBytesInRes", "dwImageOffset" + _format_ = "bbbbhhii" + +class GRPICONDIR (Structure): + _names_ = "idReserved", "idType", "idCount" + _format_ = "hhh" + +class GRPICONDIRENTRY (Structure): + _names_ = "bWidth", "bHeight", "bColorCount", "bReserved", "wPlanes", "wBitCount", "dwBytesInRes", "nID" + _format_ = "bbbbhhih" + +class IconFile: + def __init__ (self, path): + self.path = path + file = open (path, "rb") + self.entries = [] + self.images = [] + header = self.header = ICONDIRHEADER() + header.fromfile (file) + for i in range (header.idCount): + entry = ICONDIRENTRY() + entry.fromfile (file) + self.entries.append (entry) + for e in self.entries: + file.seek (e.dwImageOffset, 0) + self.images.append (file.read (e.dwBytesInRes)) + + def grp_icon_dir (self): + return self.header.tostring() + + def grp_icondir_entries (self, id=1): + data = "" + for entry in self.entries: + e = GRPICONDIRENTRY() + for n in e._names_[:-1]: + setattr(e, n, getattr (entry, n)) + e.nID = id + id = id + 1 + data = data + e.tostring() + return data + + +def CopyIcons_FromIco (dstpath, srcpath, id=1): + import win32api #, win32con + icons = map(IconFile, srcpath) + print "I: Updating icons from", srcpath, "to", dstpath + + hdst = win32api.BeginUpdateResource (dstpath, 0) + + iconid = 1 + for i in range(len(icons)): + f = icons[i] + data = f.grp_icon_dir() + data = data + f.grp_icondir_entries(iconid) + win32api.UpdateResource (hdst, RT_GROUP_ICON, i, data) + print "I: Writing RT_GROUP_ICON %d resource with %d bytes" % (i, len(data)) + for data in f.images: + win32api.UpdateResource (hdst, RT_ICON, iconid, data) + print "I: Writing RT_ICON %d resource with %d bytes" % (iconid, len (data)) + iconid = iconid + 1 + + win32api.EndUpdateResource (hdst, 0) + +def CopyIcons (dstpath, srcpath): + import os.path, string + + if type(srcpath) in StringTypes: + srcpath = [ srcpath ] + + def splitter(s): + try: + srcpath, index = map(string.strip, string.split(s, ',')) + return srcpath, int(index) + except ValueError: + return s, None + + srcpath = map(splitter, srcpath) + print "I: SRCPATH", srcpath + + if len(srcpath) > 1: + # At the moment, we support multiple icons only from .ico files + srcs = [] + for s in srcpath: + e = os.path.splitext(s[0])[1] + if string.lower(e) != '.ico': + raise ValueError, "multiple icons supported only from .ico files" + if s[1] is not None: + raise ValueError, "index not allowed for .ico files" + srcs.append(s[0]) + return CopyIcons_FromIco(dstpath, srcs) + + srcpath,index = srcpath[0] + srcext = os.path.splitext(srcpath)[1] + if string.lower (srcext) == '.ico': + return CopyIcons_FromIco (dstpath, [srcpath]) + if index is not None: + print "I: Updating icons from", srcpath, ", %d to" % index, dstpath + else: + print "I: Updating icons from", srcpath, "to", dstpath + import win32api #, win32con + hdst = win32api.BeginUpdateResource (dstpath, 0) + hsrc = win32api.LoadLibraryEx (srcpath, 0, LOAD_LIBRARY_AS_DATAFILE) + if index is None: + grpname = win32api.EnumResourceNames (hsrc, RT_GROUP_ICON)[0] + elif index >= 0: + grpname = win32api.EnumResourceNames (hsrc, RT_GROUP_ICON)[index] + else: + grpname = -index + data = win32api.LoadResource (hsrc, RT_GROUP_ICON, grpname) + win32api.UpdateResource (hdst, RT_GROUP_ICON, grpname, data) + for iconname in win32api.EnumResourceNames (hsrc, RT_ICON): + data = win32api.LoadResource (hsrc, RT_ICON, iconname) + win32api.UpdateResource (hdst, RT_ICON, iconname, data) + win32api.FreeLibrary (hsrc) + win32api.EndUpdateResource (hdst, 0) + +if __name__ == "__main__": + import sys + + dstpath = sys.argv[1] + srcpath = sys.argv[2:] + CopyIcons(dstpath, srcpath)