utils.py 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. #
  2. # The Qubes OS Project, https://www.qubes-os.org
  3. #
  4. # Copyright (C) 2012 Agnieszka Kostrzewa <agnieszka.kostrzewa@gmail.com>
  5. # Copyright (C) 2012 Marek Marczykowski-Górecki
  6. # <marmarek@invisiblethingslab.com>
  7. # Copyright (C) 2017 Wojtek Porczyk <woju@invisiblethingslab.com>
  8. #
  9. # This program is free software: you can redistribute it and/or modify
  10. # it under the terms of the GNU General Public License as published by
  11. # the Free Software Foundation, either version 2 of the License, or
  12. # (at your option) any later version.
  13. #
  14. # This program is distributed in the hope that it will be useful,
  15. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. # GNU General Public License for more details.
  18. #
  19. # You should have received a copy of the GNU General Public License
  20. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. #
  22. import os
  23. import re
  24. import qubesadmin
  25. from PyQt4.QtGui import QIcon # pylint: disable=import-error
  26. def _filter_internal(vm):
  27. return (not vm.klass == 'AdminVM'
  28. and not vm.features.get('internal', False))
  29. def prepare_choice(widget, holder, propname, choice, default,
  30. filter_function=None, *,
  31. icon_getter=None, allow_internal=None, allow_default=False,
  32. allow_none=False, transform=None):
  33. # for newly created vms, set propname to None
  34. debug(
  35. 'prepare_choice(widget={widget!r}, '
  36. 'holder={holder!r}, '
  37. 'propname={propname!r}, '
  38. 'choice={choice!r}, '
  39. 'default={default!r}, '
  40. 'filter_function={filter_function!r}, '
  41. 'icon_getter={icon_getter!r}, '
  42. 'allow_internal={allow_internal!r}, '
  43. 'allow_default={allow_default!r}, '
  44. 'allow_none={allow_none!r})'.format(**locals()))
  45. if propname is not None and allow_default:
  46. default = holder.property_get_default(propname)
  47. if allow_internal is None:
  48. allow_internal = propname is None or not propname.endswith('vm')
  49. if propname is not None:
  50. if holder.property_is_default(propname):
  51. oldvalue = qubesadmin.DEFAULT
  52. else:
  53. oldvalue = getattr(holder, propname)
  54. if transform is not None and oldvalue is not None:
  55. oldvalue = transform(oldvalue)
  56. else:
  57. oldvalue = object() # won't match for identity
  58. idx = 0
  59. choice_list = list(choice)[:]
  60. if not allow_internal:
  61. choice_list = filter(_filter_internal, choice_list)
  62. if filter_function is not None:
  63. choice_list = filter(filter_function, choice_list)
  64. choice_list = list(choice_list)
  65. if allow_default:
  66. choice_list.insert(0, qubesadmin.DEFAULT)
  67. if allow_none:
  68. choice_list.append(None)
  69. for i, item in enumerate(choice_list):
  70. debug('i={} item={}'.format(i, item))
  71. # 0: default (unset)
  72. if item is qubesadmin.DEFAULT:
  73. default_string = str(default) if default is not None else 'none'
  74. if transform is not None:
  75. default_string = transform(default_string)
  76. text = 'default ({})'.format(default_string)
  77. # N+1: explicit None
  78. elif item is None:
  79. text = '(none)'
  80. # 1..N: choices
  81. else:
  82. text = str(item)
  83. if transform is not None:
  84. text = transform(text)
  85. if item == oldvalue:
  86. text += ' (current)'
  87. idx = i
  88. widget.insertItem(i, text)
  89. if icon_getter is not None:
  90. icon = icon_getter(item)
  91. if icon is not None:
  92. widget.setItemIcon(i, icon)
  93. widget.setCurrentIndex(idx)
  94. return choice_list, idx
  95. def prepare_kernel_choice(widget, holder, propname, default, *args, **kwargs):
  96. # TODO get from storage API (pool 'linux-kernel') (suggested by @marmarta)
  97. return prepare_choice(widget, holder, propname,
  98. os.listdir('/var/lib/qubes/vm-kernels'), default, *args, **kwargs)
  99. def prepare_label_choice(widget, holder, propname, default, *args, **kwargs):
  100. try:
  101. app = holder.app
  102. except AttributeError:
  103. app = holder
  104. return prepare_choice(widget, holder, propname,
  105. sorted(app.labels.values(), key=lambda l: l.index),
  106. default, *args,
  107. icon_getter=(lambda label: QIcon.fromTheme(label.icon)),
  108. **kwargs)
  109. def prepare_vm_choice(widget, holder, propname, default, *args, **kwargs):
  110. try:
  111. app = holder.app
  112. except AttributeError:
  113. app = holder
  114. return prepare_choice(widget, holder, propname, app.domains, default,
  115. *args, **kwargs)
  116. def is_debug():
  117. return os.getenv('QUBES_MANAGER_DEBUG', '') not in ('', '0')
  118. def debug(*args, **kwargs):
  119. if not is_debug():
  120. return
  121. print(*args, **kwargs)
  122. def get_path_from_vm(vm, service_name):
  123. """
  124. Displays a file/directory selection window for the given VM.
  125. :param vm: vm from which to select path
  126. :param service_name: qubes.SelectFile or qubes.SelectDirectory
  127. :return: path to file, checked for validity
  128. """
  129. path_re = re.compile(r"[a-zA-Z0-9/:.,_+=() -]*")
  130. path_max_len = 512
  131. if not vm:
  132. return None
  133. stdout, _stderr = vm.run_service_for_stdio(service_name)
  134. untrusted_path = stdout.decode(encoding='ascii')[:path_max_len]
  135. if not untrusted_path:
  136. return None
  137. if path_re.match(untrusted_path):
  138. assert '../' not in untrusted_path
  139. assert '\0' not in untrusted_path
  140. return untrusted_path.strip()
  141. else:
  142. raise ValueError('Unexpected characters in path.')