Implement #124 - Add sdk-build support

Support added for SDK builds by adding a checkbox in Download Settings.
This setting will download the SDK build if NW.js version is greater
than or equal to 0.13.0.

Author: jyapayne

command_line.py

@@ -164,7 +164,7 @@ def get_file_information_from_url(self):
                 self.extract_class = TarFile.open
                 self.extract_args = ('r:gz',)
 
-    def save_file_path(self, version, location=None):
+    def save_file_path(self, version, location=None, sdk_build=False):
         if location:
             self.save_path = location
         else:
@@ -185,6 +185,9 @@ def save_file_path(self, version, location=None):
             if minor >= 12 or major > 0:
                 path = path.replace('node-webkit', 'nwjs')
 
+            if sdk_build:
+                path = utils.replace_right(path, 'nwjs', 'nwjs-sdk', 1)
+
             return path
 
         return ''
@@ -193,11 +196,11 @@ def set_extra_attributes_from_keyword_args(self, **kwargs):
         for undefined_key, undefined_value in kwargs.items():
             setattr(self, undefined_key, undefined_value)
 
-    def extract(self, ex_path, version):
+    def extract(self, ex_path, version, sdk_build=False):
         if os.path.exists(ex_path):
             utils.rmtree(ex_path, ignore_errors=True)
 
-        path = self.save_file_path(version)
+        path = self.save_file_path(version, sdk_build=sdk_build)
 
         file = self.extract_class(path,
                                   *self.extract_args)
@@ -400,11 +403,17 @@ def download_file_with_error_handling(self):
         path = setting.url.format(version, version)
         versions = re.findall('(\d+)\.(\d+)\.(\d+)', version)[0]
 
+        sdk_build_setting = self.get_setting('sdk_build')
+        sdk_build = sdk_build_setting.value
+
         minor = int(versions[1])
         major = int(versions[0])
         if minor >= 12 or major > 0:
             path = path.replace('node-webkit', 'nwjs')
 
+        if minor >= 13 and sdk_build:
+            path = utils.replace_right(path, 'nwjs', 'nwjs-sdk', 1)
+
         try:
             return self.download_file(setting.url.format(version, version),
                                       setting)
@@ -576,15 +585,18 @@ def extract_files(self):
         self.extract_error = None
         location = self.get_setting('download_dir').value
 
+        sdk_build_setting = self.get_setting('sdk_build')
+        sdk_build = sdk_build_setting.value
         version = self.selected_version()
 
         for setting_name, setting in self.settings['export_settings'].items():
             save_file_path = setting.save_file_path(version,
-                                                    location)
+                                                    location,
+                                                    sdk_build)
             try:
                 if setting.value:
                     extract_path = get_data_path('files/'+setting.name)
-                    setting.extract(extract_path, version)
+                    setting.extract(extract_path, version, sdk_build)
 
                     self.progress_text += '.'
 
@@ -1202,14 +1214,20 @@ def download_file(self, path, setting):
 
         location = self.get_setting('download_dir').value
 
+        sdk_build_setting = self.get_setting('sdk_build')
+        sdk_build = sdk_build_setting.value
+
         versions = self.get_version_tuple()
         major, minor, _ = versions
 
         if minor >= 12 or major > 0:
             path = path.replace('node-webkit', 'nwjs')
 
+        if minor >= 13 and sdk_build:
+            path = utils.replace_right(path, 'nwjs', 'nwjs-sdk', 1)
+
         url = path
-        file_name = setting.save_file_path(self.selected_version(), location)
+        file_name = setting.save_file_path(self.selected_version(), location, sdk_build)
         tmp_file = list(os.path.split(file_name))
         tmp_file[-1] = '.tmp.' + tmp_file[-1]
         tmp_file = os.sep.join(tmp_file)

files/settings.cfg

@@ -50,7 +50,7 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
             display_name='Single Instance'
             default_value=True
             type='check'
-            description='Restrict the app to run with only a single instance allowed at a time.'
+            description='Restrict the app to run with only a single instance\nallowed at a time. Deprecated in NW.js >= 0.13.0'
         [[[user-agent]]]
             display_name='User Agent'
             default_value=''
@@ -60,39 +60,39 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
             display_name='Node Remote'
             default_value=''
             type='string'
-            description='Enable calling node in remote pages. See the node-webkit manifest format for more info.'
+            description='Enable calling node in remote pages. See the node-webkit\nmanifest format for more info.'
         [[[chromium-args]]]
             display_name='Chromium Args'
             default_value=''
             type='string'
-            description='Specify chromium command line arguments. Example value: "--disable-accelerated-video --force-cpu-draw"'
+            description='Specify chromium command line arguments.\nExample value: "--disable-accelerated-video --force-cpu-draw"'
         [[[js-flags]]]
             display_name='JS Flags'
             default_value=''
             type='string'
-            description='Specify flags passed to the js engine. Example value: "--harmony_proxies --harmony_collecions"'
+            description='Specify flags passed to the js engine.\nExample value: "--harmony_proxies --harmony_collecions"'
         [[[inject-js-start]]]
             display_name='Inject JS Start'
             default_value=''
             type='file'
             file_types='*.js'
-            description='A path to a js file that will be executed before any other script is run.'
+            description='A path to a js file that will be executed before any\nother script is run.'
         [[[inject-js-end]]]
             display_name='Inject JS End'
             default_value=''
             type='file'
             file_types='*.js'
-            description='A path to a js file that will be executed after the DOM is loaded.'
+            description='A path to a js file that will be executed after the\nDOM is loaded.'
         [[[snapshot]]]
             default_value=''
             type='file'
             file_types='*.bin'
-            description='A path to a binary file compiled with snapshot. Used if you don\'t want your code to be exposed.'
+            description='A path to a binary file compiled with snapshot. Used if you\ndon\'t want your code to be exposed.'
         [[[additional_trust_anchors]]]
             display_name='Trust Anchors'
             default_value=''
             type='strings'
-            description='A list of PEM-encoded certificates. Used as additional root certificates for validation to allow connecting to services using a self-signed certificate.'
+            description='A list of PEM-encoded certificates. Used as additional root\ncertificates for validation to allow connecting to services using a self-signed certificate.'
 
     [[webkit_settings]]
         [[[plugin]]]
@@ -132,13 +132,13 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
             type='file'
             action='set_mac_icon'
             file_types='*.png *.jpg *.jpeg *.icns'
-            description='This icon to be displayed for the Mac Application. Defaults to Window Icon'
+            description='This icon to be displayed for the Mac Application.\nDefaults to Window Icon'
         [[[exe_icon]]]
             default_value=''
             type='file'
             action='set_exe_icon'
             file_types='*.png *.jpg *.jpeg'
-            description='This icon to be displayed for the windows exe of the app. Defaults to Window icon.'
+            description='This icon to be displayed for the windows exe of the app.\nDefaults to Window icon.'
         [[[width]]]
             default_value='640'
             type='string'
@@ -161,12 +161,12 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
             display_name='Show Toolbar'
             default_value=False
             type='check'
-            description=''
+            description='Shows the browser toolbar. Deprecated in NW.js >= 0.13.0.'
         [[[always-on-top]]]
             display_name='Keep on Top'
             default_value=False
             type='check'
-            description=''
+            description='Makes the window always on top of other windows.'
         [[[frame]]]
             display_name='Window Frame'
             default_value=True
@@ -215,7 +215,7 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
         [[[kiosk_emulation]]]
             default_value=False
             type='check'
-            description='Puts the application is kiosk emulation mode. Will automatically check off required settings that will emulate kiosk.'
+            description='Puts the application is kiosk emulation mode. Will\nautomatically check off required settings that will emulate kiosk.'
             check_action='set_kiosk_emulation_options'
 
     [[download_settings]]
@@ -226,6 +226,11 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
             type='list'
             button='Update'
             button_callback='update_nw_versions'
+        [[[sdk_build]]]
+            display_name='SDK build'
+            default_value=False
+            type='check'
+            description='Downloads the SDK version of NW.js to support devtools by\npressing F12 or ⌘+⌥+i. (Only works on NW.js >= 0.13.0)'
         [[[force_download]]]
             default_value=False
             type='check'
@@ -273,12 +278,12 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
         min=0
         max=9
         type='range'
-        description='Compression to be applied to the executable\'s nwjs binary. 0 is no compression, 9 is maximum. They all use lzma.'
+        description='Compression to be applied to the executable\'s nwjs binary.\n0 is no compression, 9 is maximum. They all use lzma.'
     [[uncompressed_folder]]
         display_name='Uncompressed Folder'
         type='check'
         default_value=False
-        description='Mac OSX Only! This option makes the resulting app.nw inside the app just a plain folder. This is useful to mitigate startup times and to modify files.'
+        description='This option makes the resulting app.nw inside the app just a\nplain folder. This is useful to mitigate startup\ntimes and to modify files. (Works on NW.js >= 0.13.0)'
 
 
 [order]
@@ -296,7 +301,7 @@ linux_64_dir_prefix = 'node-webkit-v{}-linux-x64'
     export_setting_order = """['windows-x32', 'windows-x64', 'mac-x32', 'mac-x64', 'linux-x64', 'linux-x32']"""
     compression_setting_order = """['nw_compression_level', 'uncompressed_folder']"""
 
-    download_setting_order = """['nw_version', 'download_dir',
+    download_setting_order = """['nw_version', 'sdk_build', 'download_dir',
                                  'force_download']"""
 
 [version_info]

main.py

@@ -211,8 +211,6 @@ def __init__(self, width, height, app, parent=None):
         self.setStatusBar(status_bar)
 
         self.project_path = ''
-        #if platform.system() == 'Darwin':
-        #    self.menuBar().setNativeMenuBar(False)
         self.project_menu = self.menuBar().addMenu('File')
         browse_action = QtGui.QAction('Open Project', self.project_menu,
                                       shortcut=QtGui.QKeySequence.Open,
@@ -692,6 +690,9 @@ def update_progress_bar(self, bytes_read, total_bytes):
     def download_file(self, path, setting):
         version_file = self.settings['base_url'].format(self.selected_version())
 
+        sdk_build_setting = self.get_setting('sdk_build')
+        sdk_build = sdk_build_setting.value
+
         location = self.get_setting('download_dir').value
 
         versions = re.findall('v(\d+)\.(\d+)\.(\d+)', path)[0]
@@ -700,19 +701,16 @@ def download_file(self, path, setting):
         if minor >= 12:
             path = path.replace('node-webkit', 'nwjs')
 
+        if minor >= 13 and sdk_build:
+            path = utils.replace_right(path, 'nwjs', 'nwjs-sdk', 1)
+
         self.progress_text = u'Downloading {}'.format(path.replace(version_file, ''))
 
         url = QUrl(path)
-        file_name = setting.save_file_path(self.selected_version(), location)
+        file_name = setting.save_file_path(self.selected_version(), location, sdk_build)
 
         archive_exists = QFile.exists(file_name)
 
-        #dest_files_exist = False
-
-        # for dest_file in setting.dest_files:
-        #    dest_file_path = utils.path_join('files', setting.name, dest_file)
-        #    dest_files_exist &= QFile.exists(dest_file_path)
-
         forced = self.get_setting('force_download').value
 
         if archive_exists and not forced:
@@ -793,8 +791,6 @@ def create_directory_choose(self):
         vlayout.setContentsMargins(10, 5, 10, 5)
 
         vlayout.addLayout(title_hbox)
-        #vlayout.addLayout(input_layout)
-        #vlayout.addLayout(output_layout)
 
         group_box.setLayout(vlayout)
 
@@ -883,8 +879,6 @@ def load_project(self, directory):
         self.save_project_path(directory)
         self.update_recent_files()
         self.reset_settings()
-        #self.input_line.setText(directory)
-
 
         proj_name = os.path.basename(directory)
         self.title_label.setText(proj_name)

utils.py

@@ -13,6 +13,9 @@
 
 DEBUG = False
 
+def replace_right(source, target, replacement, replacements=None):
+    return replacement.join(source.rsplit(target, replacements))
+
 def is_windows():
     return platform.system() == 'Windows'