Source code for qubesadmin.label

# -*- encoding: utf8 -*-
#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2017 Marek Marczykowski-Górecki
#                               <marmarek@invisiblethingslab.com>
#
# This program 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 program 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 program; if not, see <http://www.gnu.org/licenses/>.

'''VM Labels'''
from __future__ import annotations
from typing import TYPE_CHECKING

import qubesadmin.exc

if TYPE_CHECKING:
    from qubesadmin.app import QubesBase




class Label:
    '''Label definition for virtual machines

    Label specifies colour of the qube icon displayed next to VM's name.

    :param str color: colour specification as in HTML (``#abcdef``)
    :param str name: label's name like "red" or "green"
    '''

    def __init__(self, app: QubesBase, name: str):
        self.app = app
        self._name = name
        self._color: str | None = None
        self._index: int | None = None

    @property
    def color(self) -> str:
        '''color specification as in HTML (``#abcdef``)'''
        if self._color is None:
            try:
                qubesd_response = self.app.qubesd_call(
                    'dom0', 'admin.label.Get', self._name, None)
            except qubesadmin.exc.QubesDaemonNoResponseError:
                raise qubesadmin.exc.QubesPropertyAccessError('label.color')
            self._color = qubesd_response.decode()
        return self._color

    @property
    def name(self) -> str:
        '''label's name like "red" or "green"'''
        return self._name

    @property
    def icon(self) -> str:
        '''freedesktop icon name, suitable for use in
        :py:meth:`PyQt4.QtGui.QIcon.fromTheme`'''
        return 'appvm-' + self.name

    @property
    def index(self) -> int:
        '''label numeric identifier'''
        if self._index is None:
            try:
                qubesd_response = self.app.qubesd_call(
                    'dom0', 'admin.label.Index', self._name, None)
            except qubesadmin.exc.QubesDaemonNoResponseError:
                raise qubesadmin.exc.QubesPropertyAccessError('label.index')
            self._index = int(qubesd_response.decode())
        return self._index

    def __str__(self) -> str:
        return self._name

    def __eq__(self, other: object) -> bool:
        if isinstance(other, Label):
            return self.name == other.name
        return NotImplemented

    def __hash__(self) -> int:
        return hash(self.name)