# coding:utf-8
# Copyright (c) 2020  PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
'''
This module is used to store environmental variables in PaddleHub.


HUB_HOME              -->  the root directory for storing PaddleHub related data. Default to ~/.paddlehub. Users can change the
├                          default value through the HUB_HOME environment variable.
├── MODULE_HOME       -->  Store the installed PaddleHub Module.
├── CACHE_HOME        -->  Store the cached data.
├── DATA_HOME         -->  Store the automatically downloaded datasets.
├── CONF_HOME         -->  Store the default configuration files.
├── THIRD_PARTY_HOME  -->  Store third-party libraries.
├── TMP_HOME          -->  Store temporary files generated during running, such as intermediate products of installing modules,
├                          files in this directory will generally be automatically cleared.
├── SOURCES_HOME      -->  Store the installed code sources.
└── LOG_HOME          -->  Store log files generated during operation, including some non-fatal errors. The log will be stored
                           daily.
'''

import os


def _get_user_home():
    return os.path.expanduser('~')


def _get_hub_home():
    if 'HUB_HOME' in os.environ:
        home_path = os.environ['HUB_HOME']
        if os.path.exists(home_path):
            if os.path.isdir(home_path):
                return home_path
            else:
                raise RuntimeError('The environment variable HUB_HOME {} is not a directory.'.format(home_path))
        else:
            return home_path
    return os.path.join(_get_user_home(), '.paddlehub')


def _get_sub_home(directory):
    home = os.path.join(_get_hub_home(), directory)
    os.makedirs(home, exist_ok=True)
    return home


USER_HOME = _get_user_home()
HUB_HOME = _get_hub_home()
MODULE_HOME = _get_sub_home('modules')
CACHE_HOME = _get_sub_home('cache')
DATA_HOME = _get_sub_home('dataset')
CONF_HOME = _get_sub_home('conf')
THIRD_PARTY_HOME = _get_sub_home('thirdparty')
TMP_HOME = _get_sub_home('tmp')
SOURCES_HOME = _get_sub_home('sources')
LOG_HOME = _get_sub_home('log')
