source: sasview/sansview/installer_generator.py @ afb5080

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since afb5080 was 27b7acc, checked in by butler, 11 years ago

converted stored category file from pickle to json and a bit of cleanup
  • Property mode set to 100644
File size: 16.0 KB
Line 
1"""
2This module generates .iss file according to the local config of
3the current application. Please make sure a file named "local_config.py"
4exists in the current directory. Edit local_config.py according to your needs.
5"""
6import local_config
7import os 
8import string
9
10REG_PROGRAM = """{app}\MYPROG.EXE"" ""%1"""
11APPLICATION = str(local_config.__appname__ )+ '.exe'
12AppName = str(local_config.__appname__ )
13AppVerName = str(local_config.__appname__ )+'-'+ str(local_config.__version__)
14Dev = ''
15if AppVerName.lower().count('dev') > 0:
16    Dev = '-Dev'
17AppPublisher = local_config._copyright
18AppPublisherURL = local_config._homepage
19AppSupportURL = local_config._homepage
20AppUpdatesURL = local_config._homepage
21ChangesEnvironment = 'true'
22DefaultDirName = os.path.join("{pf}" , AppName+Dev) 
23DefaultGroupName = os.path.join(local_config.DefaultGroupName, AppVerName)
24                               
25OutputBaseFilename = local_config.OutputBaseFilename
26SetupIconFile = "images\\ball.ico"
27LicenseFile = 'license.txt'
28DisableProgramGroupPage = 'yes'
29Compression = 'lzma'
30SolidCompression = 'yes'
31PrivilegesRequired = 'none'
32INSTALLER_FILE = 'installer'
33
34icon_path =  local_config.icon_path
35media_path = local_config.media_path
36test_path = local_config.test_path
37
38def find_extension():
39    """
40    Describe the extensions that can be read by the current application
41    """
42    list_data = []
43    list_app =[]
44    try:
45       
46        #(ext, type, name, flags)
47        from sans.dataloader.loader import Loader
48        wild_cards = Loader().get_wildcards()
49        for item in wild_cards:
50            #['All (*.*)|*.*']
51            file_type, ext = string.split(item, "|*", 1)
52            if ext.strip() not in ['.*', ''] and ext.strip() not in list_data:
53                list_data.append((ext, 'string', file_type))
54    except:
55        pass
56    try:
57        file_type, ext = string.split(local_config.APPLICATION_WLIST, "|*", 1)
58        if ext.strip() not in ['.', ''] and ext.strip() not in list_app:
59            list_app.append((ext, 'string', file_type))
60    except:
61        pass
62    try:
63        for item in local_config.PLUGINS_WLIST:
64            file_type, ext = string.split(item, "|*", 1)
65            if ext.strip() not in ['.', ''] and ext.strip() not in list_app:
66                list_app.append((ext, 'string', file_type)) 
67    except:
68        pass
69    return list_data, list_app
70DATA_EXTENSION, APP_EXTENSION = find_extension()
71
72def write_registry(data_extension=None, app_extension=None):
73    """
74    create file association for windows.
75    Allow open file on double click
76    """
77    msg = ""
78    if data_extension is not None and data_extension:
79        openwithlist = "OpenWithList\%s" % str(APPLICATION)
80        msg = "\n\n[Registry]\n"
81        for (ext, type, _) in data_extension:
82            list = os.path.join(ext, openwithlist)
83            msg +=  """Root: HKCR;\tSubkey: "%s";\t""" % str(list)
84            msg += """ Flags: %s""" % str('uninsdeletekey noerror')
85            msg += "\n"
86        #list the file on right-click
87        msg += """Root: HKCR; Subkey: "applications\%s\shell\open\command";\t"""\
88                              %  str(APPLICATION)
89        msg += """ValueType: %s; """ % str('string')
90        msg += """ValueName: "%s";\t""" %str('') 
91        msg += """ValueData: \"""{app}\%s""  ""%s1\"""; \t"""% (str(APPLICATION),
92                                                          str('%'))   
93        msg += """ Flags: %s""" % str('uninsdeletevalue noerror')
94        msg += "\n"
95        user_list = "Software\Classes" 
96        for (ext, type, _) in data_extension:
97            list = os.path.join(user_list, ext, openwithlist)
98            msg +=  """Root: HKCU;\tSubkey: "%s";\t""" % str(list)
99            msg += """ Flags: %s""" % str('uninsdeletekey noerror')
100            msg += "\n"
101        #list the file on right-click
102        user_list = os.path.join("Software", "Classes", "applications")
103        msg += """Root: HKCU; Subkey: "%s\%s\shell\open\command";\t"""\
104                              %  (str(user_list), str(APPLICATION))
105        msg += """ValueType: %s; """ % str('string')
106        msg += """ValueName: "%s";\t""" %str('') 
107        msg += """ValueData: \"""{app}\%s""  ""%s1\"""; \t"""% (str(APPLICATION),
108                                                          str('%'))   
109        msg += """ Flags: %s""" % str('uninsdeletevalue noerror')
110        msg += "\n"       
111    if app_extension is not None and app_extension:
112        for (ext, type, _) in app_extension:
113            msg +=  """Root: HKCR;\tSubkey: "%s";\t""" % str(ext)
114            msg += """ValueType: %s;\t""" % str(type)
115            #file type empty set the current application as the default
116            #reader for this file. change the value of file_type to another
117            #string modify the default reader
118            file_type = ''
119            msg += """ValueName: "%s";\t""" % str('')
120            msg += """ValueData: "{app}\%s";\t""" % str(APPLICATION)
121            msg += """ Flags: %s""" % str('uninsdeletevalue  noerror')
122            msg += "\n"
123    msg += """Root: HKCR; Subkey: "{app}\%s";\t""" % str(APPLICATION)
124    msg += """ValueType: %s; """ % str('string')
125    msg += """ValueName: "%s";\t""" % str('') 
126    msg += """ValueData: "{app}\%s";\t""" % str("SasView File") 
127    msg += """ Flags: %s \t""" % str("uninsdeletekey  noerror")
128    msg += "\n"
129       
130    #execute the file on double-click
131    msg += """Root: HKCR; Subkey: "{app}\%s\shell\open\command";\t"""  %  str(APPLICATION)
132    msg += """ValueType: %s; """ % str('string')
133    msg += """ValueName: "%s";\t""" %str('') 
134    msg += """ValueData: \"""{app}\%s""  ""%s1\""";\t"""% (str(APPLICATION),
135                                                          str('%')) 
136    msg += """ Flags: %s \t""" % str("uninsdeletevalue noerror")
137    msg += "\n"                                                     
138    #create default icon
139    msg += """Root: HKCR; Subkey: "{app}\%s";\t""" % str(SetupIconFile)
140    msg += """ValueType: %s; """ % str('string')
141    msg += """ValueName: "%s";\t""" % str('') 
142    msg += """ValueData: "{app}\%s,0";\t""" % str(APPLICATION)
143    msg += """ Flags: %s \t""" % str("uninsdeletevalue noerror")
144    msg += "\n" 
145
146   
147    #SANSVIEWPATH
148    msg += """Root: HKLM; Subkey: "%s";\t"""  %  str('SYSTEM\CurrentControlSet\Control\Session Manager\Environment')
149    msg += """ValueType: %s; """ % str('expandsz')
150    msg += """ValueName: "%s";\t""" % str('SANSVIEWPATH') 
151    msg += """ValueData: "{app}";\t"""
152    msg += """ Flags: %s""" % str('uninsdeletevalue noerror')
153    msg += "\n"
154   
155    #PATH
156    msg += """; Write to PATH (below) is disabled; need more tests\n"""
157    msg += """;Root: HKCU; Subkey: "%s";\t"""  %  str('Environment')
158    msg += """ValueType: %s; """ % str('expandsz')
159    msg += """ValueName: "%s";\t""" % str('PATH') 
160    msg += """ValueData: "%s;{olddata}";\t""" % str('%SANSVIEWPATH%')
161    msg += """ Check: %s""" % str('NeedsAddPath()')
162    msg += "\n"
163       
164    return msg
165
166def write_language(language=['english'], msfile="compiler:Default.isl"): 
167    """
168    define the language of the application
169    """ 
170    msg = ''
171    if language:
172        msg = "\n\n[Languages]\n"
173        for lang in language:
174            msg += """Name: "%s";\tMessagesFile: "%s"\n""" % (str(lang), 
175                                                           str(msfile))
176    return msg
177
178def write_tasks():
179    """
180    create desktop icon
181    """
182    msg = """\n\n[Tasks]\n"""
183    msg += """Name: "desktopicon";\tDescription: "{cm:CreateDesktopIcon}";\t"""
184    msg += """GroupDescription: "{cm:AdditionalIcons}";\tFlags: unchecked\n"""
185    msg += """Name: "quicklaunchicon"; Description: "{cm:CreateQuickLaunchIcon}";\t"""
186    msg += """GroupDescription: "{cm:AdditionalIcons}";\n"""
187    return msg
188
189dist_path = "dist"
190def write_file():
191    """
192    copy some data files
193    """
194    msg = "\n\n[Files]\n"
195    msg += """Source: "%s\%s";\t""" % (dist_path, str(APPLICATION))
196    msg += """DestDir: "{app}";\tFlags: ignoreversion\n"""
197    msg += """Source: "dist\*";\tDestDir: "{app}";\t"""
198    msg += """Flags: ignoreversion recursesubdirs createallsubdirs\n"""
199    msg += """Source: "dist\plugin_models\*";\tDestDir: "{userdesktop}\..\.sasview\plugin_models";\t""" 
200    msg += """Flags: recursesubdirs createallsubdirs\n"""
201    msg += """Source: "dist\config\custom_config.py";\tDestDir: "{userdesktop}\..\.sasview\config";\t""" 
202    msg += """Flags: recursesubdirs createallsubdirs\n"""
203    msg += """Source: "dist\default_categories.json";    DestDir: "{userdesktop}\..\.sasview";\t""" 
204    msg += """DestName: "serialized_cat.json";\n"""
205    msg += """;\tNOTE: Don't use "Flags: ignoreversion" on any shared system files"""
206    return msg
207
208def write_icon():
209    """
210    Create application icon
211    """
212    msg = """\n\n[Icons]\n"""
213    msg += """Name: "{group}\%s";\t""" % str(AppName)
214    msg += """Filename: "{app}\%s";\t"""  % str(APPLICATION)
215    msg += """WorkingDir: "{app}"; IconFilename: "{app}\images\\ball.ico" \n"""
216    msg += """Name: "{group}\{cm:UninstallProgram, %s}";\t""" % str(AppName)
217    msg += """ Filename: "{uninstallexe}" \n"""
218    msg += """Name: "{commondesktop}\%s";\t""" % str(AppVerName)
219    msg += """Filename: "{app}\%s";\t""" % str(APPLICATION)
220    msg += """Tasks: desktopicon; WorkingDir: "{app}" ; IconFilename: "{app}\images\\ball.ico" \n"""
221    msg += """Name: "{userappdata}\Microsoft\Internet Explorer\Quick Launch\%s";\t""" % str(AppVerName)
222    msg += """Filename: "{app}\%s";\t""" % str(APPLICATION)
223    msg += """Tasks: quicklaunchicon; WorkingDir: "{app}"; IconFilename: "{app}\images\\ball.ico" \n"""
224    return msg
225
226def write_run():
227    """
228    execute some file
229    """
230    msg = """\n\n[Run]\n"""
231    msg += """Filename: "{app}\%s";\t""" % str(APPLICATION)
232    msg += """Description: "{cm:LaunchProgram, %s}";\t""" %str(AppName) 
233    msg += """Flags: nowait postinstall skipifsilent\n"""
234    msg += """; Install the Microsoft C++ DLL redistributable package if it is """
235    msg += """provided and the DLLs are not present on the target system.\n"""
236    msg += """; Note that the redistributable package is included if the app was """
237    msg += """built using Python 2.6 or 2.7, but not with 2.5.\n"""
238    msg += """; Parameter options:\n"""
239    msg += """; - for silent install use: "/q"\n"""
240    msg += """; - for silent install with progress bar use: "/qb"\n"""
241    msg += """; - for silent install with progress bar but disallow """
242    msg += """cancellation of operation use: "/qb!"\n"""
243    msg += """; Note that we do not use the postinstall flag as this would """
244    msg += """display a checkbox and thus require the user to decide what to do.\n"""
245    msg += """;Filename: "{app}\\vcredist_x86.exe"; Parameters: "/qb!"; """
246    msg += """WorkingDir: "{tmp}"; StatusMsg: "Installing Microsoft Visual """
247    msg += """C++ 2008 Redistributable Package ..."; Check: InstallVC90CRT(); """
248    msg += """Flags: skipifdoesntexist waituntilterminated\n"""
249    return msg
250
251def write_dirs():
252    """
253    Define Dir permission
254    """
255    msg = """\n\n[Dirs]\n"""
256    msg += """Name: "{app}\%s";\t""" % str('')
257    msg += """Permissions: everyone-modify\t""" 
258    msg += """\n""" 
259    return msg
260
261def write_code():
262    """
263    Code that checks the existing path and snaviewpath
264    in the environmental viriables/PATH
265    """
266    msg = """\n\n[Code]\n"""
267    msg += """function InstallVC90CRT(): Boolean;\n""" 
268    msg += """begin\n"""
269    msg += """    Result := not DirExists('C:\WINDOWS\WinSxS\\x86_Microsoft.VC90."""
270    msg += """CRT_1fc8b3b9a1e18e3b_9.0.21022.8_x-ww_d08d0375');\n"""
271    msg += """end;\n\n"""
272    msg += """function NeedsAddPath(): boolean;\n""" 
273    msg += """var\n""" 
274    msg += """  oldpath: string;\n"""
275    msg += """  newpath: string;\n""" 
276    msg += """  pathArr:    TArrayOfString;\n""" 
277    msg += """  i:        Integer;\n""" 
278    msg += """begin\n""" 
279    msg += """  RegQueryStringValue(HKEY_CURRENT_USER,'Environment',"""
280    msg += """'PATH', oldpath)\n"""
281    msg += """  oldpath := oldpath + ';';\n"""
282    msg += """  newpath := '%SANSVIEWPATH%';\n"""
283    msg += """  i := 0;\n"""
284    msg += """  while (Pos(';', oldpath) > 0) do begin\n"""
285    msg += """    SetArrayLength(pathArr, i+1);\n"""
286    msg += """    pathArr[i] := Copy(oldpath, 0, Pos(';', oldpath)-1);\n"""
287    msg += """    oldpath := Copy(oldpath, Pos(';', oldpath)+1,"""
288    msg += """ Length(oldpath));\n"""
289    msg += """    i := i + 1;\n"""
290    msg += """    // Check if current directory matches app dir\n"""
291    msg += """    if newpath = pathArr[i-1] \n"""
292    msg += """    then begin\n"""
293    msg += """      Result := False;\n"""
294    msg += """      exit;\n"""
295    msg += """    end;\n"""
296    msg += """  end;\n"""
297    msg += """  Result := True;\n"""
298    msg += """end;\n"""
299    msg += """\n"""
300    return msg
301
302def write_uninstalldelete():
303    """
304    Define uninstalldelete
305    """
306    msg = """\n[UninstallDelete]\n"""
307    msg += """; Delete directories and files that are dynamically created by """
308    msg += """the application (i.e. at runtime).\n"""
309    msg += """Type: filesandordirs; Name: "{app}\.matplotlib"\n"""
310    msg += """Type: files; Name: "{app}\*.*"\n"""
311    msg += """; The following is a workaround for the case where the """
312    msg += """application is installed and uninstalled but the\n"""
313    msg += """;{app} directory is not deleted because it has user files.  """
314    msg += """Then the application is installed into the\n"""
315    msg += """; existing directory, user files are deleted, and the """
316    msg += """application is un-installed again.  Without the\n"""
317    msg += """; directive below, {app} will not be deleted because Inno Setup """
318    msg += """did not create it during the previous\n"""
319    msg += """; installation.\n"""
320    msg += """Type: dirifempty; Name: "{app}"\n"""
321    msg += """\n""" 
322    return msg
323
324def generate_installer():
325    """
326    """
327    TEMPLATE = "\n; Script generated by the Inno Setup Script Wizard\n"
328    TEMPLATE += "\n; and local_config.py located in this directory.\n "
329    TEMPLATE += "; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!"
330    TEMPLATE += "\n[Setup]\n\n" 
331    TEMPLATE += "ChangesAssociations=%s\n" %str('yes')
332    TEMPLATE += "AppName=%s\n" % str(AppName)
333    TEMPLATE += "AppVerName=%s\n" % str(AppVerName)
334    TEMPLATE += "AppPublisher=%s\n" % str(AppPublisher)
335    TEMPLATE += "AppPublisherURL=%s\n" % str(AppPublisherURL)
336    TEMPLATE += "AppSupportURL=%s\n" % str(AppSupportURL)
337    TEMPLATE += "AppUpdatesURL=%s \n" % str(AppUpdatesURL)
338    TEMPLATE += "ChangesEnvironment=%s \n" % str(ChangesEnvironment)
339    TEMPLATE += "DefaultDirName=%s\n" % str(DefaultDirName)
340    TEMPLATE += "DefaultGroupName=%s\n" % str(DefaultGroupName)
341    TEMPLATE += "DisableProgramGroupPage=%s\n" % str(DisableProgramGroupPage)
342    TEMPLATE += "LicenseFile=%s\n" % str(LicenseFile)
343    TEMPLATE += "OutputBaseFilename=%s\n" % str(OutputBaseFilename)
344    TEMPLATE += "SetupIconFile=%s\n" % str(SetupIconFile)
345    TEMPLATE += "Compression=%s\n" % str(Compression)
346    TEMPLATE += "SolidCompression=%s\n" % str(SolidCompression)
347    TEMPLATE += "PrivilegesRequired=%s\n" % str(PrivilegesRequired)
348    TEMPLATE += "UsePreviousAppDir=no\n"
349   
350    TEMPLATE += write_registry(data_extension=DATA_EXTENSION,
351                                app_extension=APP_EXTENSION)
352    TEMPLATE += write_language()
353    TEMPLATE += write_tasks()
354    TEMPLATE += write_file()
355    TEMPLATE += write_icon()
356    TEMPLATE += write_run()
357    TEMPLATE += write_dirs()
358    TEMPLATE += write_code()
359    TEMPLATE += write_uninstalldelete()
360    path = '%s.iss' % str(INSTALLER_FILE)
361    f = open(path,'w') 
362    f.write(TEMPLATE)
363    f.close()
364    print "Generate Inno setup installer script complete"
365    print "A new file %s.iss should be created.Please refresh your directory" % str(INSTALLER_FILE)
366   
367if __name__ == "__main__":
368    generate_installer()
Note: See TracBrowser for help on using the repository browser.