1#!/usr/bin/env python 2# -*- coding: utf-8 -*- 3 4# 5# Copyright (c) 2020 Huawei Device Co., Ltd. 6# Licensed under the Apache License, Version 2.0 (the "License"); 7# you may not use this file except in compliance with the License. 8# You may obtain a copy of the License at 9# 10# http://www.apache.org/licenses/LICENSE-2.0 11# 12# Unless required by applicable law or agreed to in writing, software 13# distributed under the License is distributed on an "AS IS" BASIS, 14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15# See the License for the specific language governing permissions and 16# limitations under the License. 17 18import os 19import sys 20import platform 21from distutils.spawn import find_executable 22sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))) 23from hb_internal import CONFIG_JSON 24from hb_internal import CONFIG_STRUCT 25from hb_internal import BUILD_TOOLS_CFG 26from hb_internal.common.utils import read_json_file 27from hb_internal.common.utils import dump_json_file 28from hb_internal.common.utils import Singleton 29from hb_internal.common.utils import OHOSException 30from hb_internal.common.utils import download_tool 31from hb_internal.common.utils import makedirs 32 33 34class Config(metaclass=Singleton): 35 def __init__(self): 36 self.config_json = CONFIG_JSON 37 38 config_content = read_json_file(self.config_json) 39 self._root_path = config_content.get('root_path', None) 40 self._board = config_content.get('board', None) 41 self._kernel = config_content.get('kernel', None) 42 self._product = config_content.get('product', None) 43 self._product_path = config_content.get('product_path', None) 44 self._device_path = config_content.get('device_path', None) 45 self._device_company = config_content.get('device_company', None) 46 self._patch_cache = config_content.get('patch_cache', None) 47 self._version = config_content.get('version', '3.0') 48 self._os_level = config_content.get('os_level', 'small') 49 self._product_json = config_content.get('product_json', None) 50 self._target_cpu = config_content.get('target_cpu', None) 51 self._target_os = config_content.get('target_os', None) 52 self._out_path = config_content.get('out_path', None) 53 self._compile_config = config_content.get('compile_config', None) 54 self._component_type = config_content.get('component_type', None) 55 self._device_config_path = config_content.get('device_config_path', 56 None) 57 self._product_config_path = config_content.get('product_config_path', 58 None) 59 self._subsystem_config_json = config_content.get( 60 'subsystem_config_json', None) 61 self.fs_attr = set() 62 self.platform = platform.system() 63 64 @property 65 def component_type(self): 66 return self._component_type 67 68 @component_type.setter 69 def component_type(self, value): 70 self._component_type = value 71 self.config_update('component_type', self._component_type) 72 73 @property 74 def target_os(self): 75 return self._target_os 76 77 @target_os.setter 78 def target_os(self, value): 79 self._target_os = value 80 self.config_update('target_os', self._target_os) 81 82 @property 83 def target_cpu(self): 84 return self._target_cpu 85 86 @target_cpu.setter 87 def target_cpu(self, value): 88 self._target_cpu = value 89 self.config_update('target_cpu', self._target_cpu) 90 91 @property 92 def version(self): 93 return self._version 94 95 @version.setter 96 def version(self, value): 97 self._version = value 98 self.config_update('version', self._version) 99 100 @property 101 def compile_config(self): 102 return self._compile_config 103 104 @compile_config.setter 105 def compile_config(self, value): 106 self._compile_config = value 107 self.config_update('compile_config', self._compile_config) 108 109 @property 110 def os_level(self): 111 return self._os_level 112 113 @os_level.setter 114 def os_level(self, value): 115 self._os_level = value 116 self.config_update('os_level', self._os_level) 117 118 @property 119 def product_json(self): 120 return self._product_json 121 122 @product_json.setter 123 def product_json(self, value): 124 self._product_json = value 125 self.config_update('product_json', self._product_json) 126 127 @property 128 def root_path(self): 129 if self._root_path is None: 130 raise OHOSException('Failed to get root_path. ' 131 'Please run command "hb set" to ' 132 'init OHOS development environment') 133 134 return self._root_path 135 136 @root_path.setter 137 def root_path(self, value): 138 self._root_path = os.path.abspath(value) 139 if not os.path.isdir(self._root_path): 140 raise OHOSException(f'{self._root_path} is not a valid path') 141 142 config_path = os.path.join(self._root_path, 'ohos_config.json') 143 if not os.path.isfile(config_path): 144 self.config_create(config_path) 145 self.config_update('root_path', self._root_path) 146 147 @property 148 def board(self): 149 if self._board is None: 150 raise OHOSException('Failed to get board. ' 151 'Please run command "hb set" to ' 152 'init OHOS development environment') 153 return self._board 154 155 @board.setter 156 def board(self, value): 157 self._board = value 158 self.config_update('board', self._board) 159 160 @property 161 def device_company(self): 162 if self._device_company is None: 163 raise OHOSException('Failed to get device_company. ' 164 'Please run command "hb set" to ' 165 'init OHOS development environment') 166 return self._device_company 167 168 @device_company.setter 169 def device_company(self, value): 170 self._device_company = value 171 self.config_update('device_company', self._device_company) 172 173 @property 174 def kernel(self): 175 return self._kernel 176 177 @kernel.setter 178 def kernel(self, value): 179 self._kernel = value 180 self.config_update('kernel', self._kernel) 181 182 @property 183 def product(self): 184 if self._product is None: 185 raise OHOSException('Failed to get product. ' 186 'Please run command "hb set" to ' 187 'init OHOS development environment') 188 return self._product 189 190 @product.setter 191 def product(self, value): 192 self._product = value 193 self.config_update('product', self._product) 194 195 @property 196 def product_path(self): 197 if self._product_path is None: 198 raise OHOSException('Failed to get product_path. ' 199 'Please run command "hb set" to ' 200 'init OHOS development environment') 201 return self._product_path 202 203 @product_path.setter 204 def product_path(self, value): 205 self._product_path = value 206 self.config_update('product_path', self._product_path) 207 208 @property 209 def gn_product_path(self): 210 return self.product_path.replace(self.root_path, '/') 211 212 @property 213 def device_path(self): 214 if self._device_path is None: 215 raise OHOSException('Failed to get device_path. ' 216 'Please run command "hb set" to ' 217 'init OHOS development environment') 218 return self._device_path 219 220 @device_path.setter 221 def device_path(self, value): 222 self._device_path = value 223 self.config_update('device_path', self._device_path) 224 225 @property 226 def gn_device_path(self): 227 return self.device_path.replace(self.root_path, '/') 228 229 @property 230 def build_path(self): 231 _build_path = os.path.join(self.root_path, 'build', 'lite') 232 if not os.path.isdir(_build_path): 233 raise OHOSException(f'Invalid build path: {_build_path}') 234 return _build_path 235 236 @property 237 def out_path(self): 238 return self._out_path 239 240 @out_path.setter 241 def out_path(self, value): 242 self._out_path = value 243 self.config_update('out_path', self._out_path) 244 245 @property 246 def device_config_path(self): 247 return self._device_config_path 248 249 @device_config_path.setter 250 def device_config_path(self, value): 251 self._device_config_path = value 252 self.config_update('device_config_path', self._device_config_path) 253 254 @property 255 def product_config_path(self): 256 return self._product_config_path 257 258 @product_config_path.setter 259 def product_config_path(self, value): 260 self._product_config_path = value 261 self.config_update('product_config_path', self._product_config_path) 262 263 @property 264 def subsystem_config_json(self): 265 return self._subsystem_config_json 266 267 @subsystem_config_json.setter 268 def subsystem_config_json(self, value): 269 self._subsystem_config_json = value 270 self.config_update('subsystem_config_json', 271 self._subsystem_config_json) 272 273 @property 274 def log_path(self): 275 if self.out_path is not None: 276 return os.path.join(self.out_path, 'build.log') 277 else: 278 raise OHOSException(f'Failed to get log_path') 279 280 @property 281 def vendor_path(self): 282 _vendor_path = os.path.join(self.root_path, 'vendor') 283 if not os.path.isdir(_vendor_path): 284 raise OHOSException(f'Invalid vendor path: {_vendor_path}') 285 return _vendor_path 286 287 @property 288 def built_in_product_path(self): 289 _built_in_product_path = os.path.join(self.root_path, 290 'productdefine/common/products') 291 if not os.path.isdir(_built_in_product_path): 292 raise OHOSException( 293 f'Invalid built-in product path: {_built_in_product_path}') 294 return _built_in_product_path 295 296 @property 297 def built_in_device_path(self): 298 _built_in_device_path = os.path.join(self.root_path, 299 'productdefine/common/device') 300 if not os.path.isdir(_built_in_device_path): 301 raise OHOSException( 302 f'Invalid built-in product path: {_built_in_device_path}') 303 return _built_in_device_path 304 305 @property 306 def build_tools_path(self): 307 try: 308 tools_path = BUILD_TOOLS_CFG[self.platform]['build_tools_path'] 309 return os.path.join(self.root_path, tools_path) 310 except KeyError: 311 raise OHOSException(f'unidentified platform: {self.platform}') 312 313 @property 314 def gn_path(self): 315 repo_gn_path = os.path.join(self.build_tools_path, 'gn') 316 # gn exist. 317 if os.path.isfile(repo_gn_path): 318 return repo_gn_path 319 320 # gn not install, download and extract it. 321 makedirs(self.build_tools_path, exist_ok=True) 322 323 gn_url = BUILD_TOOLS_CFG[self.platform].get('gn') 324 gn_dst = os.path.join(self.build_tools_path, 'gn_pkg') 325 download_tool(gn_url, gn_dst, tgt_dir=self.build_tools_path) 326 327 return repo_gn_path 328 329 @property 330 def ninja_path(self): 331 repo_ninja_path = os.path.join(self.build_tools_path, 'ninja') 332 # ninja exist. 333 if os.path.isfile(repo_ninja_path): 334 return repo_ninja_path 335 336 # ninja not install, download and extract. 337 makedirs(self.build_tools_path, exist_ok=True) 338 339 ninja_url = BUILD_TOOLS_CFG[self.platform].get('ninja') 340 ninja_dst = os.path.join(self.build_tools_path, 'ninja_pkg') 341 download_tool(ninja_url, ninja_dst, tgt_dir=self.build_tools_path) 342 343 return repo_ninja_path 344 345 @property 346 def clang_path(self): 347 repo_clang_path = os.path.join('prebuilts', 'clang', 'ohos', 348 'linux-x86_64', 'llvm') 349 # clang exist 350 if os.path.isdir(repo_clang_path): 351 return f'//{repo_clang_path}' 352 # clang installed manually or auto download 353 else: 354 # already installed manually 355 env_clang_bin_path = find_executable('clang') 356 if env_clang_bin_path is not None: 357 env_clang_path = os.path.abspath( 358 os.path.join(env_clang_bin_path, os.pardir, os.pardir)) 359 360 if os.path.basename(env_clang_path) == 'llvm': 361 return env_clang_path 362 363 # need auto download and extract clang. 364 clang_path = os.path.abspath( 365 os.path.join(repo_clang_path, os.pardir)) 366 makedirs(clang_path, exist_ok=True) 367 368 clang_url = BUILD_TOOLS_CFG[self.platform].get('clang') 369 clang_dst = os.path.join(clang_path, 'clang_pkg') 370 download_tool(clang_url, clang_dst, tgt_dir=clang_path) 371 return f'//{repo_clang_path}' 372 373 @property 374 def patch_cache(self): 375 return self._patch_cache 376 377 @patch_cache.setter 378 def patch_cache(self, value): 379 self._patch_cache = value 380 self.config_update('patch_cache', self._patch_cache) 381 382 def config_create(self, config_path): 383 dump_json_file(config_path, CONFIG_STRUCT) 384 self.config_json = config_path 385 386 def config_update(self, key, value): 387 config_content = read_json_file(self.config_json) 388 config_content[key] = value 389 dump_json_file(self.config_json, config_content) 390