summaryrefslogtreecommitdiffstats
path: root/src/software/lmi/software/yumdb/util.py
blob: 2c67a15847a1dcc42b94c40f4d4e0660c1a751d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# Software Management Providers
#
# Copyright (C) 2012-2014 Red Hat, Inc.  All rights reserved.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
#
# Authors: Michal Minar <miminar@redhat.com>
#

"""
Common utilities meant to be used only be ``yumdb`` subpackage.
"""

import logging
import yum

from lmi.providers import cmpi_logging
from lmi.software.util import Configuration

DEBUG_LOGGING_CONFIG = {
    "version" : 1,
    'disable_existing_loggers' : True,
    "formatters": {
        # this is a message format for logging function/method calls
        # it's manually set up in YumWorker's init method
        "default": {
            "()": "lmi.providers.cmpi_logging.DispatchingFormatter",
            "formatters" : {
                "lmi.providers.cmpi_logging.trace_function_or_method":
                    "%(asctime)s %(levelname)s:%(message)s"
                },
            "default" : "%(asctime)s %(levelname)s:%(module)s:"
                        "%(funcName)s:%(lineno)d - %(message)s"
            },
        },
    "handlers": {
        "file" : {
            "class" : "logging.FileHandler",
            "filename" : "/var/tmp/YumWorker.log",
            "level" : "DEBUG",
            "formatter": "default",
            },
        },
    "root": {
        "level": "DEBUG",
        "handlers" : ["file"]
        },
}

DISABLED_LOGGING_CONFIG = {
    'version' : 1,
    'disable_existing_loggers' : True,
    'handlers': {
        'null' : {
            'class': 'logging.FileHandler',
            'level': 'CRITICAL',
            'filename': '/dev/null'
            }
        },
    'root' : {
        'level': 'CRITICAL',
        'handlers' : ['null'],
        }
}

def setup_logging():
    """
    This is meant to be used by ``YumWorker`` process to setup logging
    independent of what providers are using. Unfortunately ``YumWorker``
    can not use the same facilities as the rest of program, because
    logging is done through *broker*.
    """
    config = Configuration.get_instance()
    cp = config.config
    logging_setup = False
    if cp.has_option('YumWorkerLog', 'FileConfig'):
        try:
            file_path = config.file_path('YumWorkerLog', 'FileConfig')
            logging.config.fileConfig(file_path)
            logging_setup = True
        except Exception:
            pass
    if logging_setup is False:
        out = config.get_safe('YumWorkerLog', 'OutputFile')
        if out is not None:
            try:
                defaults = DEBUG_LOGGING_CONFIG.copy()
                defaults["handlers"]["file"]["filename"] = out
                level = config.get_safe('YumWorkerLog', 'Level')
                level = cmpi_logging.LOGGING_LEVELS[level.lower()]
                defaults["handlers"]["file"]["level"] = level
                defaults["root"]["level"] = level
                logging.config.dictConfig(defaults)
                logging_setup = True
                # re-enable function tracing logger which has been disabled by
                # dictConfig() call
                logging.getLogger(cmpi_logging.__name__
                        + '.trace_function_or_method').disabled = False
            except Exception:
                pass
    if logging_setup is False:
        # disable logging completely
        logging.config.dictConfig(DISABLED_LOGGING_CONFIG)

def is_pkg_installed(pkg, rpmdb):
    """
    Returns ``True`` if the package is installed.

    :param pkg: Yum package object.
    :type pkg: :py:class:`yum.packages.PackageObject`
    :param rpmdb: Installed package sack.
    :type rpmdb: :py:class:`yum.rpmsack.RPMDBPackageSack`
    :returns: Whether the package is installed or not.
    :rtype: boolean
    """
    if not isinstance(pkg, yum.packages.PackageObject):
        raise TypeError("pkg must be a PackageObject")
    return (  isinstance(pkg, yum.rpmsack.RPMInstalledPackage)
           or pkg.pkgtup in rpmdb._tup2pkg)