Solve the error that when building android project with Android SDK Tools 25.3.x. (#410)

Author: Bin Zhang

bin/strings.json

@@ -184,6 +184,8 @@
         "COMPILE_ERROR_LOW_VS_VER" : "Version of VS is too low.",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "MSBuild is not found.",
         "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "Unknown engine version!",
+        "COMPILE_ERROR_UNKNOWN_ANDROID_SDK_TOOLS_VERSION" : "Unknown Android SDK Tools version!",
+        "COMPILE_ERROR_ANT_NOT_SUPPORTED": "Ant (Eclipse project) is not supported from Android SDK Tools 25.3.0.",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "Find VS path : %s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "Not found devenv. Try to use msbuild instead.",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "Found msbuild path: %s",
@@ -527,7 +529,9 @@
         "COMPILE_ERROR_WRONG_VS_VER_FMT" : "不支持 VS %d。",
         "COMPILE_ERROR_LOW_VS_VER" : "VS 版本过低。",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "未找到 MSBuild 工具。",
-        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "無法識別引擎版本!",
+        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "无法识别引擎版本!",
+        "COMPILE_ERROR_UNKNOWN_ANDROID_SDK_TOOLS_VERSION" : "无法识别 Android SDK Tools 版本.",
+        "COMPILE_ERROR_ANT_NOT_SUPPORTED": "Android SDK Tools 25.3.0 版本开始, 不再支持 Ant (Eclipse 工程) 编译打包.",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "找到 VS 安装路径：%s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "未找到 devenv。尝试使用 msbuild 来代替。",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "找到 msbuild 安装路径：%s",
@@ -870,7 +874,9 @@
         "COMPILE_ERROR_WRONG_VS_VER_FMT" : "不支持 VS %d。",
         "COMPILE_ERROR_LOW_VS_VER" : "VS 版本過低。",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "未找到 MSBuild 工具。",
-        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "无法识别引擎版本!",
+        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "無法識別引擎版本!",
+        "COMPILE_ERROR_UNKNOWN_ANDROID_SDK_TOOLS_VERSION" : "無法識別 Android SDK Tools 版本!",
+        "COMPILE_ERROR_ANT_NOT_SUPPORTED": "Android SDK Tools 25.3.0 版本開始, 不再支持 Ant (Eclipse 工程) 編譯打包.",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "找到 VS 安裝路徑：%s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "未找到 devenv。嘗試使用 msbuild 來代替。",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "找到 msbuild 安裝路徑：%s",

plugins/plugin_compile/build_android.py

@@ -181,37 +181,95 @@ def remove_c_libs(self, libs_dir):
                 ext = os.path.splitext(lib_file)[1]
                 if ext == ".a" or ext == ".so":
                     os.remove(lib_file)
-                    
+
+    def _get_android_sdk_tools_ver(self, sdk_tools_path):
+        cfg_file = os.path.join(sdk_tools_path, 'source.properties')
+
+        if os.path.isfile(cfg_file):
+            f = open(cfg_file)
+            lines = f.readlines()
+            pattern = r'^Pkg\.Revision=(\d+)\.(\d+)'
+            for l in lines:
+                match = re.match(pattern, l.strip())
+                if match:
+                    return ((int)(match.group(1)), (int)(match.group(2)))
+
+        raise cocos.CCPluginError(MultiLanguage.get_string('COMPILE_ERROR_UNKNOWN_ANDROID_SDK_TOOLS_VERSION'),
+                                  cocos.CCPluginError.ERROR_PATH_NOT_FOUND)
+
+    def _update_project_properties(self, folder_path, target_str):
+        props_path = os.path.join(folder_path, 'project.properties')
+        f = open(props_path)
+        lines = f.readlines()
+        f.close()
+
+        pattern = r'^target=(.*)$'
+        matched = False
+        new_line = 'target=%s\n' % target_str
+        for i in range(0, len(lines)):
+            l = lines[i]
+            match = re.match(pattern, l.strip())
+            if match:
+                lines[i] = new_line
+                matched = True
+
+        if not matched:
+            lines.append('\n')
+            lines.append(new_line)
+
+        f = open(props_path, 'w')
+        f.writelines(lines)
+        f.close()
+
+    def _write_local_properties(self, folder_path):
+        local_porps_path = os.path.join(folder_path, 'local.properties')
+        lines = [
+            'sdk.dir=%s\n' % self.sdk_root,
+            'ndk.dir=%s\n' % cocos.check_environment_variable('NDK_ROOT')
+        ]
+        f = open(local_porps_path, 'w')
+        f.writelines(lines)
+        f.close()
+
     def update_project(self, android_platform):
         if self.gradle_support_ndk:
             # If gradle supports ndk build, should write local.properties manually
-            local_porps_path = os.path.join(self.app_android_root, 'local.properties')
-            lines = [
-                'sdk.dir=%s\n' % self.sdk_root,
-                'ndk.dir=%s\n' % cocos.check_environment_variable('NDK_ROOT')
-            ]
-            f = open(local_porps_path, 'w')
-            f.writelines(lines)
-            f.close()
+            self._write_local_properties(self.app_android_root)
             return
 
+        # Android SDK removed android command & ant support from SDK tools 25.3.0
+        # So, we should check the Android SDK tools version
+        sdk_tools_folder = os.path.join(self.sdk_root, 'tools')
+        main_ver, minor_ver = self._get_android_sdk_tools_ver(sdk_tools_folder)
+        no_ant = False
+        if main_ver > 25 or (main_ver == 25 and minor_ver >= 3):
+            no_ant = True
+
+        if not self.use_studio and no_ant:
+            # Tip the message that ant is not supported from Android SDK tools 25.3.0
+            raise cocos.CCPluginError(MultiLanguage.get_string('COMPILE_ERROR_ANT_NOT_SUPPORTED'),
+                                      cocos.CCPluginError.ERROR_OTHERS)
+
         if self.use_studio:
             manifest_path = os.path.join(self.app_android_root, 'app')
         else:
             manifest_path = self.app_android_root
 
-        sdk_tool_path = os.path.join(self.sdk_root, "tools", "android")
-
         # check the android platform
         target_str = self.check_android_platform(self.sdk_root, android_platform, manifest_path)
 
-        # update project
-        command = "%s update project -t %s -p %s" % (cocos.CMDRunner.convert_path_to_cmd(sdk_tool_path), target_str, manifest_path)
-        self._run_cmd(command)
+        if no_ant:
+            # should manually update the project
+            self._write_local_properties(manifest_path)
+            self._update_project_properties(manifest_path, target_str)
+        else:
+            # update project
+            sdk_tool_path = os.path.join(sdk_tools_folder, "android")
+            command = "%s update project -t %s -p %s" % (cocos.CMDRunner.convert_path_to_cmd(sdk_tool_path), target_str, manifest_path)
+            self._run_cmd(command)
 
-        # update lib-projects
-        property_path = manifest_path
-        self.update_lib_projects(self.sdk_root, sdk_tool_path, android_platform, property_path)
+            # update lib-projects
+            self.update_lib_projects(self.sdk_root, sdk_tool_path, android_platform, manifest_path)
 
         if self.use_studio:
             # copy the local.properties to the app_android_root

plugins/plugin_compile/project_compile.py

@@ -454,7 +454,7 @@ def get_engine_version_num(self):
         if engine_ver_str is None:
             return None
 
-        version_pattern = r'.*([\d]+)\.([\d]+)'
+        version_pattern = r'cocos2d-x-([\d]+)\.([\d]+)'
         match = re.match(version_pattern, engine_ver_str)
         if match:
             return ((int)(match.group(1)), (int)(match.group(2)))