~nataliabidart/magicicada-client/fix-travis-ubuntuone-clientdefs

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
# -*- coding: utf-8 *-*
#
# Copyright 2011-2012 Canonical Ltd.
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
# PURPOSE.  See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the
# OpenSSL library under certain conditions as described in each
# individual source file, and distribute linked combinations
# including the two.
# You must obey the GNU General Public License in all respects
# for all of the code used other than OpenSSL.  If you modify
# file(s) with this exception, you may extend this exception to your
# version of the file(s), but you are not obligated to do so.  If you
# do not wish to do so, delete this exception statement from your
# version.  If you delete this exception statement from all source
# files in the program, then also delete it here.
"""Filesystem monitors per platform."""

import logging
import sys

from twisted.internet import defer

DEFAULT_MONITOR = 'default'
logger = logging.getLogger(
    'ubuntuone.SyncDaemon.platform.filesystem_notifications.monitor')


class NoAvailableMonitorError(Exception):
    """Raised if there are no available monitors in the system."""


if sys.platform == 'win32':
    from magicicadaclient.platform.filesystem_notifications.monitor import (
        common,
        windows,
    )

    FILEMONITOR_IDS = {
        DEFAULT_MONITOR: common.FilesystemMonitor,
    }
    ACTIONS = windows.ACTIONS

elif sys.platform == 'darwin':
    from magicicadaclient.platform.filesystem_notifications.monitor import darwin
    from magicicadaclient.platform.filesystem_notifications.monitor import (
        common,
    )

    FILEMONITOR_IDS = {
        DEFAULT_MONITOR: darwin.fsevents_daemon.FilesystemMonitor,
        'macfsevents': common.FilesystemMonitor,
    }
    ACTIONS = darwin.fsevents_client.ACTIONS
else:
    from magicicadaclient.platform.filesystem_notifications.monitor import (
        linux,
    )

    FILEMONITOR_IDS = {
        DEFAULT_MONITOR: linux.FilesystemMonitor,
    }


# mantain old API
FilesystemMonitor = FILEMONITOR_IDS[DEFAULT_MONITOR]


@defer.inlineCallbacks
def get_filemonitor_class(monitor_id=None):
    """Return the class to be used."""
    logger.debug('File monitor ids for platform "%s" are "%s"', sys.platform,
                 FILEMONITOR_IDS)

    if monitor_id is None:
        logger.debug('monitor_id is None, using default.')
        monitor_id = 'default'

    if monitor_id not in FILEMONITOR_IDS:
        msg = 'No available monitor with id %r could be found.'
        raise NoAvailableMonitorError(msg % monitor_id)

    # retrieve the correct class and assert it can be used
    cls = FILEMONITOR_IDS[monitor_id]
    logger.debug('Checking availability of monitor class %s', cls)
    is_available = yield cls.is_available_monitor()

    if is_available:
        logger.debug('Monitor is available, returning monitor with id "%s"',
                     monitor_id)
        defer.returnValue(cls)
    elif not is_available and monitor_id != DEFAULT_MONITOR:
        logger.debug('Monitor is NOT available, returning default monitor.')
        cls = yield get_filemonitor_class(DEFAULT_MONITOR)
        defer.returnValue(cls)
    else:
        raise NoAvailableMonitorError('No available monitor could be found.')