# -*- coding: utf-8 -*-

# organization: Logilab

# copyright 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.

# contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr

# Licensed under the GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

.. _ResourceMode:

Resource mode

-------------

A resource *mode* is a predifined set of settings for various resources

directories, such as cubes, instances, etc. to ease development with the

framework. There are two running modes with *CubicWeb*:

* 'user', resources are searched / created in the user home directory:

  - instances are stored in :file:`~/etc/cubicweb.d`

  - temporary files (such as pid file) in :file:`/tmp`

* 'system', resources are searched / created in the system directories (eg

  usually requiring root access):

  - instances are stored in :file:`<INSTALL_PREFIX>/etc/cubicweb.d`

  - temporary files (such as pid file) in :file:`/var/run/cubicweb`

  where `<INSTALL_PREFIX>` is the detected installation prefix ('/usr/local' for

  instance).

Notice that each resource path may be explicitly set using an environment

variable if the default doesn't suit your needs. Here are the default resource

directories that are affected according to mode:

* 'system': ::

        CW_INSTANCES_DIR = <INSTALL_PREFIX>/etc/cubicweb.d/

        CW_INSTANCES_DATA_DIR = /var/lib/cubicweb/instances/

        CW_RUNTIME_DIR = /var/run/cubicweb/

 * 'user': ::

        CW_INSTANCES_DIR = ~/etc/cubicweb.d/

        CW_INSTANCES_DATA_DIR = ~/etc/cubicweb.d/

        CW_RUNTIME_DIR = /tmp

Cubes search path is also affected, see the :ref:Cube section.

By default, the mode automatically set to 'user' if a :file:`.hg` directory is found

in the cubicweb package, else it's set to 'system'. You can force this by setting

the :envvar:`CW_MODE` environment variable to either 'user' or 'system' so you can

easily:

* use system wide installation but user specific instances and all, without root

  privileges on the system (`export CW_MODE=user`)

* use local checkout of cubicweb on system wide instances (requires root

  privileges on the system (`export CW_MODE=system`)

If you've a doubt about the mode you're currently running, check the first line

outputed by the :command:`cubicweb-ctl list` command.

Also, if cubicweb is a mercurial checkout located in `<CW_SOFTWARE_ROOT>`:

* main cubes directory is `<CW_SOFTWARE_ROOT>/../cubes`. You can specify

  another one with :envvar:`CW_INSTANCES_DIR` environment variable or simply

  add some other directories by using :envvar:`CW_CUBES_PATH`

* cubicweb migration files are searched in `<CW_SOFTWARE_ROOT>/misc/migration`

  instead of `<INSTALL_PREFIX>/share/cubicweb/migration/`.

.. _ConfigurationEnv:

Environment configuration

-------------------------

Python

``````

If you installed *CubicWeb* by cloning the Mercurial forest or from source

distribution, then you will need to update the environment variable PYTHONPATH by

adding the path to the forest `cubicweb`:

Add the following lines to either :file:`.bashrc` or :file:`.bash_profile` to

configure your development environment ::

    export PYTHONPATH=/full/path/to/cubicweb-forest

If you installed *CubicWeb* with packages, no configuration is required and your

new cubes will be placed in `/usr/share/cubicweb/cubes` and your instances will

be placed in `/etc/cubicweb.d`.

CubicWeb

````````

Here are all environment variables that may be used to configure *CubicWeb*:

.. envvar:: CW_MODE

   Resource mode: user or system, as explained in :ref:`ResourceMode`.

.. envvar:: CW_CUBES_PATH

   Augments the default search path for cubes. You may specify several

   directories using ':' as separator (';' under windows environment).

.. envvar:: CW_INSTANCES_DIR

   Directory where cubicweb instances will be found.

.. envvar:: CW_INSTANCES_DATA_DIR

   Directory where cubicweb instances data will be written (backup file...)

.. envvar:: CW_RUNTIME_DIR

   Directory where pid files will be written

"""

__docformat__ = "restructuredtext en"

_ = unicode

import sys

import os

import logging

import tempfile

from smtplib import SMTP

from threading import Lock

from os.path import exists, join, expanduser, abspath, normpath, basename, isdir

from warnings import warn

from logilab.common.decorators import cached, classproperty

from logilab.common.deprecation import deprecated

from logilab.common.logging_ext import set_log_methods, init_log

from logilab.common.configuration import (Configuration, Method,

                                          ConfigurationMixIn, merge_options)

from cubicweb import (CW_SOFTWARE_ROOT, CW_MIGRATION_MAP,

                      ConfigurationError, Binary)

from cubicweb.toolsutils import env_path, create_dir

CONFIGURATIONS = []

SMTP_LOCK = Lock()

class metaconfiguration(type):

    """metaclass to automaticaly register configuration"""

    def __new__(mcs, name, bases, classdict):

        cls = super(metaconfiguration, mcs).__new__(mcs, name, bases, classdict)

        if classdict.get('name'):

            CONFIGURATIONS.append(cls)

        return cls

def configuration_cls(name):

    """return the configuration class registered with the given name"""

    try:

        return [c for c in CONFIGURATIONS if c.name == name][0]

    except IndexError:

        raise ConfigurationError('no such config %r (check it exists with "cubicweb-ctl list")' % name)

def possible_configurations(directory):

    """return a list of installed configurations in a directory

    according to \*-ctl files

    """

    return [name for name in ('repository', 'twisted', 'all-in-one')

            if exists(join(directory, '%s.conf' % name))]

def guess_configuration(directory):

    """try to guess the configuration to use for a directory. If multiple

    configurations are found, ConfigurationError is raised

    """

    modes = possible_configurations(directory)

    if len(modes) != 1:

        raise ConfigurationError('unable to guess configuration from %r %s'

                                 % (directory, modes))

    return modes[0]

# persistent options definition

PERSISTENT_OPTIONS = (

    ('encoding',

     {'type' : 'string',

      'default': 'UTF-8',

      'help': _('user interface encoding'),

      'group': 'ui', 'sitewide': True,

      }),

    ('language',

     {'type' : 'string',

      'default': 'en',

      'vocabulary': Method('available_languages'),

      'help': _('language of the user interface'),

      'group': 'ui',

      }),

    ('date-format',

     {'type' : 'string',

      'default': '%Y/%m/%d',

      'help': _('how to format date in the ui ("man strftime" for format description)'),

      'group': 'ui',

      }),

    ('datetime-format',

     {'type' : 'string',

      'default': '%Y/%m/%d %H:%M',

      'help': _('how to format date and time in the ui ("man strftime" for format description)'),

      'group': 'ui',

      }),

    ('time-format',

     {'type' : 'string',

      'default': '%H:%M',

      'help': _('how to format time in the ui ("man strftime" for format description)'),

      'group': 'ui',

      }),

    ('float-format',

     {'type' : 'string',

      'default': '%.3f',

      'help': _('how to format float numbers in the ui'),

      'group': 'ui',

      }),

    ('default-text-format',

     {'type' : 'choice',

      'choices': ('text/plain', 'text/rest', 'text/html'),

      'default': 'text/html', # use fckeditor in the web ui

      'help': _('default text format for rich text fields.'),

      'group': 'ui',

      }),

    ('short-line-size',

     {'type' : 'int',

      'default': 40,

      'help': _('maximum number of characters in short description'),

      'group': 'navigation',

      }),

    )

def register_persistent_options(options):

    global PERSISTENT_OPTIONS

    PERSISTENT_OPTIONS = merge_options(PERSISTENT_OPTIONS + options)

CFGTYPE2ETYPE_MAP = {

    'string': 'String',

    'choice': 'String',

    'yn':     'Boolean',

    'int':    'Int',

    'float' : 'Float',

    }

_forced_mode = os.environ.get('CW_MODE')

assert _forced_mode in (None, 'system', 'user')

CWDEV = exists(join(CW_SOFTWARE_ROOT, '.hg'))

class CubicWebNoAppConfiguration(ConfigurationMixIn):

    """base class for cubicweb configuration without a specific instance directory

    """

    __metaclass__ = metaconfiguration

    # to set in concrete configuration

    name = None

    # log messages format (see logging module documentation for available keys)

    log_format = '%(asctime)s - (%(name)s) %(levelname)s: %(message)s'

    # nor remove appobjects based on unused interface

    cleanup_interface_sobjects = True

    # debug mode

    debugmode = False

    if os.environ.get('APYCOT_ROOT'):

        mode = 'test'

        # allow to test cubes within apycot using cubicweb not installed by

        # apycot

        if __file__.startswith(os.environ['APYCOT_ROOT']):

            CUBES_DIR = '%(APYCOT_ROOT)s/local/share/cubicweb/cubes/' % os.environ

            # create __init__ file

            file(join(CUBES_DIR, '__init__.py'), 'w').close()

        else:

            CUBES_DIR = '/usr/share/cubicweb/cubes/'

    elif (CWDEV and _forced_mode != 'system'):

        mode = 'user'

        CUBES_DIR = abspath(normpath(join(CW_SOFTWARE_ROOT, '../cubes')))

    else:

        if _forced_mode == 'user':

            mode = 'user'

        else:

            mode = 'system'

        CUBES_DIR = '/usr/share/cubicweb/cubes/'

    options = (

       ('log-threshold',

         {'type' : 'string', # XXX use a dedicated type?

          'default': 'WARNING',

          'help': 'server\'s log level',

          'group': 'main', 'inputlevel': 1,

          }),

        # pyro options

        ('pyro-instance-id',

         {'type' : 'string',

          'default': Method('default_instance_id'),

          'help': 'identifier of the CubicWeb instance in the Pyro name server',

          'group': 'pyro', 'inputlevel': 1,

          }),

        ('pyro-ns-host',

         {'type' : 'string',

          'default': '',

          'help': 'Pyro name server\'s host. If not set, will be detected by a \

broadcast query. It may contains port information using <host>:<port> notation.',

          'group': 'pyro', 'inputlevel': 1,

          }),

        ('pyro-ns-group',

         {'type' : 'string',

          'default': 'cubicweb',

          'help': 'Pyro name server\'s group where the repository will be \

registered.',

          'group': 'pyro', 'inputlevel': 1,

          }),

        # common configuration options which are potentially required as soon as

        # you're using "base" application objects (ie to really server/web

        # specific)

        ('base-url',

         {'type' : 'string',

          'default': None,

          'help': 'web server root url',

          'group': 'main', 'inputlevel': 1,

          }),

        ('allow-email-login',

         {'type' : 'yn',

          'default': False,

          'help': 'allow users to login with their primary email if set',

          'group': 'main', 'inputlevel': 2,

          }),

        ('use-request-subdomain',

         {'type' : 'yn',

          'default': None,

          'help': ('if set, base-url subdomain is replaced by the request\'s '

                   'host, to help managing sites with several subdomains in a '

                   'single cubicweb instance'),

          'group': 'main', 'inputlevel': 1,

          }),

        ('mangle-emails',

         {'type' : 'yn',

          'default': False,

          'help': "don't display actual email addresses but mangle them if \

this option is set to yes",

          'group': 'email', 'inputlevel': 2,

          }),

        )

    # static and class methods used to get instance independant resources ##

    @staticmethod

    def cubicweb_version():

        """return installed cubicweb version"""

        from logilab.common.changelog import Version

        from cubicweb import __pkginfo__

        version = __pkginfo__.numversion

        assert len(version) == 3, version

        return Version(version)

    @staticmethod

    def persistent_options_configuration():

        return Configuration(options=PERSISTENT_OPTIONS)

    @classmethod

    def shared_dir(cls):

        """return the shared data directory (i.e. directory where standard

        library views and data may be found)

        """

        if CWDEV:

            return join(CW_SOFTWARE_ROOT, 'web')

        return cls.cube_dir('shared')

    @classmethod

    def i18n_lib_dir(cls):

        """return instance's i18n directory"""

        if CWDEV:

            return join(CW_SOFTWARE_ROOT, 'i18n')

        return join(cls.shared_dir(), 'i18n')

    @classmethod

    def available_cubes(cls):

        cubes = set()

        for directory in cls.cubes_search_path():

            if not exists(directory):

                cls.error('unexistant directory in cubes search path: %s'

                           % directory)

                continue

            for cube in os.listdir(directory):

                if isdir(join(directory, cube)) and not cube == 'shared':

                    cubes.add(cube)

        return sorted(cubes)

    @classmethod

    def cubes_search_path(cls):

        """return the path of directories where cubes should be searched"""

        path = []

        try:

            for directory in os.environ['CW_CUBES_PATH'].split(os.pathsep):

                directory = abspath(normpath(directory))

                if exists(directory) and not directory in path:

                    path.append(directory)

        except KeyError:

            pass

        if not cls.CUBES_DIR in path and exists(cls.CUBES_DIR):

            path.append(cls.CUBES_DIR)

        return path

    @classproperty

    def extrapath(cls):

        extrapath = {}

        for cubesdir in cls.cubes_search_path():

            if cubesdir != cls.CUBES_DIR:

                extrapath[cubesdir] = 'cubes'

        return extrapath

    @classmethod

    def cube_dir(cls, cube):

        """return the cube directory for the given cube id,

        raise ConfigurationError if it doesn't exists

        """

        for directory in cls.cubes_search_path():

            cubedir = join(directory, cube)

            if exists(cubedir):