Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

3084 rader
152 KiB

  1. # vim: fileencoding=utf-8
  2. #
  3. from pprint import pprint
  4. from ..utils.package import (
  5. PackageAtomParser,
  6. PackageCreator,
  7. Package,
  8. PackageNotFound,
  9. PackageAtomName,
  10. Version,
  11. NonePackage,
  12. )
  13. from ..utils.files import (
  14. join_paths,
  15. write_file,
  16. read_file_lines,
  17. FilesError,
  18. check_directory_link,
  19. read_link,
  20. Process,
  21. get_target_from_link,
  22. get_directory_contents,
  23. )
  24. from .template_engine import (
  25. TemplateEngine,
  26. Variables,
  27. ConditionFailed,
  28. ParametersProcessor,
  29. DIR, FILE,
  30. ParametersContainer,
  31. )
  32. from calculate.variables.datavars import (
  33. StringType,
  34. ListType,
  35. NamespaceNode,
  36. VariableNode,
  37. TableType,
  38. VariableNotFoundError
  39. )
  40. from typing import (
  41. Union,
  42. Dict,
  43. List,
  44. Tuple,
  45. Iterator,
  46. Optional,
  47. Callable
  48. )
  49. from calculate.variables.loader import Datavars
  50. from .format.base_format import Format, FormatError
  51. from ..utils.io_module import IOModule
  52. from collections import OrderedDict, abc
  53. from contextlib import contextmanager
  54. from ..utils.mount import Mounts
  55. import hashlib
  56. import fnmatch
  57. import shutil
  58. import errno
  59. import stat
  60. import glob
  61. import copy
  62. import os
  63. # Наверное временно.
  64. CALCULATE_VERSION = Version('4.0')
  65. class TemplateExecutorError(Exception):
  66. pass
  67. class TemplateTypeConflict(Exception):
  68. pass
  69. class TemplateCollisionError(Exception):
  70. pass
  71. class CalculateConfigFile:
  72. '''Класс для работы с файлом /var/lib/calculate/config.'''
  73. def __init__(self, cl_config_path: str = '/var/lib/calculate/config',
  74. cl_chroot_path: str = '/'):
  75. self.chroot_path: str = cl_chroot_path
  76. self.cl_config_path: str = cl_config_path
  77. self._config_dictionary: OrderedDict = self._get_cl_config_dictionary()
  78. self._unsaved_changes: bool = False
  79. def __contains__(self, file_path: str) -> bool:
  80. file_path = self._remove_chroot(file_path)
  81. return file_path in self._config_dictionary
  82. def _get_cl_config_dictionary(self) -> OrderedDict:
  83. '''Метод для загрузки словаря файла /var/lib/calculate/config.'''
  84. config_dictionary = OrderedDict()
  85. if os.path.exists(self.cl_config_path):
  86. if os.path.isdir(self.cl_config_path):
  87. raise TemplateExecutorError(
  88. "directory instead calculate config file in: {}".
  89. format(self.cl_config_path))
  90. else:
  91. write_file(self.cl_config_path).close()
  92. return config_dictionary
  93. try:
  94. config_file_lines = read_file_lines(self.cl_config_path)
  95. except FilesError as error:
  96. raise TemplateExecutorError(
  97. "cannot read calculate config file in: {0}. Reason: {1}".
  98. format(self.cl_config_path, str(error)))
  99. # TODO Продумать проверку корректности найденного файла.
  100. for file_line in config_file_lines:
  101. filename, md5_sum = file_line.split(' ')
  102. config_dictionary.update({filename: md5_sum})
  103. self._unsaved_changes = False
  104. return config_dictionary
  105. def set_files_md5(self, file_path: str, file_md5: str) -> None:
  106. '''Метод для установки в config соответствия файла некоторой
  107. контрольной сумме.'''
  108. file_path = self._remove_chroot(file_path)
  109. self._config_dictionary[file_path] = file_md5
  110. self._unsaved_changes = True
  111. def remove_file(self, file_path: str) -> None:
  112. '''Метод для удаления файла из config.'''
  113. file_path = self._remove_chroot(file_path)
  114. if file_path in self._config_dictionary:
  115. self._config_dictionary.pop(file_path)
  116. self._unsaved_changes = True
  117. def compare_md5(self, file_path: str, file_md5: str) -> None:
  118. '''Метод для сравнения хэш-суммы из config и некоторой заданной.'''
  119. file_path = self._remove_chroot(file_path)
  120. if file_path in self._config_dictionary:
  121. return self._config_dictionary[file_path] == file_md5
  122. else:
  123. return False
  124. def save_changes(self) -> None:
  125. '''Метод для записи изменений, внессенных в файл config.'''
  126. if not self._unsaved_changes:
  127. return
  128. config_file = write_file(self.cl_config_path)
  129. for file_name, file_md5 in self._config_dictionary.items():
  130. config_file.write('{} {}\n'.format(file_name, file_md5))
  131. config_file.close()
  132. self._unsaved_changes = False
  133. def _remove_chroot(self, file_path: str) -> str:
  134. '''Метод для удаления корневого пути из указанного пути.'''
  135. if self.chroot_path != '/' and file_path.startswith(self.chroot_path):
  136. file_path = file_path[len(self.chroot_path):]
  137. return file_path
  138. class TemplateWrapper:
  139. '''Класс связывающий шаблон с целевым файлом и определяющий параметры
  140. наложения шаблона, обусловленные состоянием целевого файла.'''
  141. type_checks: Dict[int,
  142. Callable[[str], bool]] = {DIR: os.path.isdir,
  143. FILE: os.path.isfile}
  144. _protected_is_set: bool = False
  145. _protected_set: set = set()
  146. _unprotected_set: set = set()
  147. def __new__(cls, *args, **kwargs):
  148. if not cls._protected_is_set:
  149. # Устанавливаем значения PROTECTED, если не заданы.
  150. if 'chroot_path' in kwargs:
  151. chroot_path = kwargs['chroot_path']
  152. else:
  153. chroot_path = '/'
  154. cls._set_protected(chroot_path)
  155. return super().__new__(cls)
  156. def __init__(
  157. self, target_file_path: str,
  158. parameters: ParametersContainer,
  159. template_type: int,
  160. template_path: str,
  161. template_text: str = '',
  162. target_package: Optional[Package] = None,
  163. chroot_path: str = '/',
  164. config_archive_path: str = '/var/lib/calculate/config-archive',
  165. dbpkg: bool = True,
  166. pkg_autosave: bool = False):
  167. self.target_path: str = target_file_path
  168. self.template_path: str = template_path
  169. self.chroot_path: str = chroot_path
  170. self.config_archive_path: str = config_archive_path
  171. self.target_package_name: Union[PackageAtomName, None] = None
  172. self.package_atom_parser: PackageAtomParser = PackageAtomParser(
  173. chroot_path=self.chroot_path)
  174. self._pkg_autosave: bool = pkg_autosave
  175. # Вспомогательный флаг, включается, если по целевому пути лежит файл,
  176. # для которого не определился никакой пакет.
  177. self.target_without_package: bool = False
  178. self.parameters: ParametersContainer = parameters
  179. self.output_path: str = self.target_path
  180. self.input_path: Union[str, None] = None
  181. self.template_type: int = template_type
  182. self.template_text: str = template_text
  183. self.contents_matching: bool = True
  184. self.ca_is_missed: bool = False
  185. # Флаг, указывающий, что нужно удалить файл из target_path перед
  186. # применением шаблона.
  187. self.remove_original: bool = False
  188. # Флаг, указывающий, что целевой путь был изменен.
  189. self.target_path_is_changed: bool = False
  190. # Флаг, указывающий, что файл по целевому пути является ссылкой.
  191. self.target_is_link: bool = False
  192. # Пакет, к которому относится файл.
  193. self.target_package: Package = target_package
  194. # Флаг, разрешающий работу с CONTENTS. Если False, то выключает
  195. # protected для всех файлов блокирует все операции с CONTENTS и ._cfg.
  196. self.dbpkg: bool = dbpkg
  197. # Флаг, указывающий, что файл является PROTECTED.
  198. self.protected: bool = False
  199. # Временный флаг для определения того, является ли шаблон userspace.
  200. self.is_userspace: bool = False
  201. self.format_class: Union[Format, None] = None
  202. if self.parameters.run or self.parameters.exec:
  203. # Если есть параметр run или exec, то кроме текста шаблона ничего
  204. # не нужно.
  205. return
  206. if self.parameters.append in {'join', 'before', 'after', 'replace'}:
  207. # Получаем класс соответствующего формата файла.
  208. if self.parameters.format:
  209. self.format_class = ParametersProcessor.\
  210. available_formats[self.parameters.format]
  211. elif self.template_type is FILE:
  212. # TODO Здесь будет детектор форматов. Когда-нибудь.
  213. raise TemplateExecutorError("'format' parameter is not set"
  214. " file template.")
  215. # Если по этому пути что-то есть -- проверяем тип этого.
  216. if os.path.exists(target_file_path):
  217. for file_type, checker in self.type_checks.items():
  218. if checker(target_file_path):
  219. self.target_type = file_type
  220. break
  221. self.target_is_link = os.path.islink(target_file_path)
  222. # Если установлен параметр mirror и есть параметр source,
  223. # содержащий несуществующий путь -- удаляем целевой файл.
  224. if (self.parameters.source is True and self.parameters.mirror and
  225. not self.format_class.EXECUTABLE):
  226. self.remove_original = True
  227. else:
  228. self.target_type = None
  229. if self.format_class is not None and self.format_class.EXECUTABLE:
  230. # Если формат исполняемый -- проверяем, существует ли директория,
  231. # из которой будет выполняться шаблон.
  232. if self.target_type is None:
  233. # Если не существует -- создаем ее.
  234. if not os.path.exists(os.path.dirname(self.target_path)):
  235. os.makedirs(os.path.dirname(self.target_path))
  236. # Если есть параметр package, определяем по нему пакет.
  237. if self.parameters.package:
  238. self.target_package_name = self.parameters.package
  239. if (self.target_package is None or
  240. self.target_package.package_name !=
  241. self.target_package_name):
  242. self.target_package = Package(self.parameters.package,
  243. chroot_path=self.chroot_path,
  244. autosave=self._pkg_autosave)
  245. return
  246. self._check_type_conflicts()
  247. self._check_package_collision()
  248. self._check_user_changes()
  249. # if self.target_type is not None and self.contents_matching:
  250. # # Удаляем целевой файл, если append = 'replace'
  251. # if (self.parameters.append and
  252. # self.parameters.append == "replace"):
  253. # self.remove_original = True
  254. def _check_type_conflicts(self) -> None:
  255. '''Метод для проверки конфликтов типов.'''
  256. if self.parameters.append == 'link':
  257. if self.parameters.force:
  258. if os.path.exists(self.parameters.source):
  259. self.remove_original = True
  260. elif self.target_is_link:
  261. if self.template_type != self.target_type:
  262. raise TemplateTypeConflict(
  263. "the target is a link to {} while the template"
  264. "is {} and has append = 'link'".
  265. format('directory' if self.template_type ==
  266. DIR else 'file',
  267. 'file' if self.template_type ==
  268. DIR else 'directory'))
  269. else:
  270. self.remove_original = True
  271. elif self.target_type == DIR:
  272. raise TemplateTypeConflict("the target is a directory while "
  273. "the template has append = 'link'")
  274. elif self.target_type == FILE:
  275. raise TemplateTypeConflict("the target is a file while the"
  276. " template has append = 'link'")
  277. elif self.template_type == DIR:
  278. if self.target_type == FILE:
  279. if self.parameters.force:
  280. self.remove_original = True
  281. else:
  282. raise TemplateTypeConflict("the target is a file while the"
  283. " template is a directory")
  284. elif self.target_is_link:
  285. if self.parameters.force:
  286. self.remove_original = True
  287. elif not self.parameters.append == "remove":
  288. try:
  289. link_source = check_directory_link(
  290. self.target_path,
  291. chroot_path=self.chroot_path)
  292. self.target_path = link_source
  293. self.target_path_is_changed = True
  294. except FilesError as error:
  295. raise TemplateExecutorError("files error: {}".
  296. format(str(error)))
  297. elif self.template_type == FILE:
  298. if self.parameters.force:
  299. if self.target_type == DIR:
  300. self.remove_original = True
  301. elif self.target_is_link and self.target_type == FILE:
  302. try:
  303. link_source = read_link(self.target_path)
  304. self.target_path = get_target_from_link(
  305. self.target_path,
  306. link_source,
  307. chroot_path=self.chroot_path)
  308. self.target_path_is_changed = True
  309. except FilesError as error:
  310. raise TemplateExecutorError("files error: {}".
  311. format(str(error)))
  312. elif self.target_is_link:
  313. if not self.parameters.append == "remove":
  314. if self.target_type == DIR:
  315. raise TemplateTypeConflict("the target file is a link"
  316. " to a directory while the"
  317. " template is a file")
  318. else:
  319. raise TemplateTypeConflict("the target file is a link"
  320. " to a file while the"
  321. " template is a file")
  322. elif self.target_type == DIR:
  323. raise TemplateTypeConflict("the target file is a directory"
  324. " while the template is a file")
  325. def _check_package_collision(self) -> None:
  326. '''Метод для проверки на предмет коллизии, то есть конфликта пакета
  327. шаблона и целевого файла.'''
  328. if self.parameters.package:
  329. parameter_package = self.parameters.package
  330. else:
  331. parameter_package = None
  332. if self.target_type is not None:
  333. try:
  334. file_package = self.package_atom_parser.get_file_package(
  335. self.target_path)
  336. except PackageNotFound:
  337. file_package = None
  338. self.target_without_package = True
  339. else:
  340. file_package = None
  341. # Если для шаблона и целевого файла никаким образом не удается
  342. # определить пакет и есть параметр append -- шаблон пропускаем.
  343. if parameter_package is None and file_package is None:
  344. if (self.parameters.append and self.parameters.append != 'skip'
  345. and not self.parameters.handler):
  346. raise TemplateCollisionError(
  347. "'package' parameter is not defined for"
  348. " template with 'append' parameter")
  349. else:
  350. return
  351. elif parameter_package is None:
  352. self.target_package_name = file_package
  353. elif file_package is None:
  354. if self.parameters.handler:
  355. raise TemplateCollisionError((
  356. "The template is a handler while target"
  357. " file belongs {} package").format(
  358. file_package.atom
  359. ))
  360. self.target_package_name = parameter_package
  361. elif file_package != parameter_package and self.template_type != DIR:
  362. target_name = self._compare_packages(parameter_package,
  363. file_package)
  364. if (target_name is not None and self.target_package is not None
  365. and self.target_package.package_name == target_name):
  366. target_name = self.target_package.package_name
  367. if target_name is None or target_name.slot_specified:
  368. raise TemplateCollisionError((
  369. "The template package is {0} while target"
  370. " file package is {1}").format(
  371. parameter_package.atom,
  372. file_package.atom
  373. ))
  374. if (self.target_package is None or
  375. self.target_package_name != self.target_package.package_name):
  376. self.target_package = Package(self.target_package_name,
  377. chroot_path=self.chroot_path,
  378. autosave=True)
  379. # Теперь перемещаем файл в пакет со старшей версией.
  380. self.source_package = Package(file_package,
  381. chroot_path=self.chroot_path,
  382. autosave=self._pkg_autosave)
  383. removed = self.source_package.remove_file(self.target_path)
  384. for file_path, file_info in removed.items():
  385. if file_info['type'] == 'dir':
  386. self.target_package.add_dir(file_path)
  387. elif file_info['type'] == 'obj':
  388. self.target_package.add_obj(file_path,
  389. file_md5=file_info['md5'],
  390. mtime=file_info['mtime'])
  391. elif file_info['type'] == 'sym':
  392. self.target_package.add_sym(
  393. file_path,
  394. target_path=file_info['target'],
  395. mtime=file_info['mtime'])
  396. else:
  397. self.target_package_name = parameter_package
  398. if (self.target_package is None or
  399. self.target_package_name != self.target_package.package_name):
  400. self.target_package = Package(self.target_package_name,
  401. chroot_path=self.chroot_path,
  402. autosave=self._pkg_autosave)
  403. def _compare_packages(self, lpackage: PackageAtomName,
  404. rpackage: PackageAtomName
  405. ) -> Union[None, PackageAtomName]:
  406. '''Метод, сравнивающий пакеты по их именам, возвращает старший, если
  407. пакеты с одинаковыми именами, но разными версиями, или None, если их
  408. имена и категории не равны.'''
  409. if lpackage.category != rpackage.category:
  410. return None
  411. if lpackage.name != rpackage.name:
  412. return None
  413. if lpackage.version > rpackage.version:
  414. return lpackage
  415. else:
  416. return rpackage
  417. def _check_user_changes(self) -> None:
  418. '''Метод для проверки наличия пользовательских изменений в
  419. конфигурационных файлах.'''
  420. # Эта проверка только для файлов.
  421. if self.template_type != FILE:
  422. return
  423. # Проверим, является ли файл защищенным.
  424. # Сначала проверяем по переменной CONFIG_PROTECT.
  425. if self.dbpkg and not self.parameters.handler:
  426. for protected_path in self._protected_set:
  427. if self.target_path.startswith(protected_path):
  428. self.protected = True
  429. break
  430. # Затем по переменной CONFIG_PROTECT_MASK.
  431. for unprotected_path in self._unprotected_set:
  432. if self.target_path.startswith(unprotected_path):
  433. self.protected = False
  434. break
  435. else:
  436. self.protected = False
  437. # Собираем список имеющихся ._cfg файлов.
  438. cfg_pattern = os.path.join(os.path.dirname(self.target_path),
  439. "._cfg????_{}".format(
  440. os.path.basename(self.target_path)))
  441. self.cfg_list = glob.glob(cfg_pattern)
  442. self.cfg_list.sort()
  443. # Путь к архивной версии файла.
  444. self.archive_path = self._get_archive_path(self.target_path)
  445. self.contents_matching = (self.parameters.autoupdate)
  446. if not self.protected:
  447. self.contents_matching = True
  448. elif self.parameters.unbound:
  449. # Если присутствует unbound, то просто модифицируем файл и
  450. # удаляем его из CONTENTS.
  451. self.contents_matching = True
  452. elif self.target_type is None:
  453. # Если целевой файл отсутствует.
  454. if (self.target_path in self.target_package and
  455. not self.parameters.autoupdate):
  456. # Проверка -- был ли файл удален.
  457. self.contents_matching = False
  458. pass
  459. else:
  460. self.contents_matching = True
  461. elif self.target_without_package:
  462. # Если файл по целевому пути не относится к какому-либо пакету.
  463. # self.contents_matching = False
  464. pass
  465. elif self.target_type is DIR and self.parameters.force:
  466. self.contents_matching = True
  467. elif not self.contents_matching:
  468. # Если файл есть и он относится к текущему пакету.
  469. # Если по каким-то причинам уже нужно считать, что хэш-суммы
  470. # совпадают -- в дальнейшей проверке нет необходимости.
  471. # target_md5 = self.target_package.get_md5(self.target_path)
  472. self.contents_matching = self.target_package.check_contents_data(
  473. self.target_path,
  474. symlink=self.target_is_link)
  475. # Если по целевому пути файл не относящийся к какому-либо пакету и
  476. # присутствует параметр autoupdate -- удаляем этот файл.
  477. if (self.target_without_package and
  478. (self.parameters.autoupdate or self.parameters.force)):
  479. self.remove_original = True
  480. # Определяем пути входных и выходных файлов.
  481. if self.contents_matching:
  482. # Приоритет отдаем пути из параметра source.
  483. if self.parameters.source:
  484. self.input_path = self.parameters.source
  485. elif self.cfg_list and not self.parameters.unbound:
  486. if os.path.exists(self.archive_path):
  487. self.input_path = self.archive_path
  488. else:
  489. self.input_path = self.target_path
  490. self.ca_is_missed = True
  491. else:
  492. self.input_path = self.target_path
  493. self.output_path = self.target_path
  494. else:
  495. # Приоритет отдаем пути из параметра source.
  496. if self.parameters.source:
  497. self.input_path = self.parameters.source
  498. else:
  499. if os.path.exists(self.archive_path):
  500. self.input_path = self.archive_path
  501. else:
  502. self.input_path = self.target_path
  503. self.ca_is_missed = True
  504. self.output_path = self._get_cfg_path(self.target_path)
  505. def _get_archive_path(self, file_path: str) -> str:
  506. '''Метод для получения пути к архивной версии указанного файла.'''
  507. if self.chroot_path != "/" and file_path.startswith(self.chroot_path):
  508. file_path = file_path[len(self.chroot_path):]
  509. return join_paths(self.config_archive_path, file_path)
  510. def _get_cfg_path(self, file_path: str) -> str:
  511. '''Метод для получения пути для создания нового ._cfg????_ файла.'''
  512. if self.cfg_list:
  513. last_cfg_name = os.path.basename(self.cfg_list[-1])
  514. slice_value = len('._cfg')
  515. cfg_number = int(last_cfg_name[slice_value: slice_value + 4]) + 1
  516. cfg_number = str(cfg_number)
  517. else:
  518. cfg_number = '0'
  519. if len(cfg_number) < 4:
  520. cfg_number = '0' * (4 - len(cfg_number)) + cfg_number
  521. new_cfg_name = "._cfg{}_{}".format(cfg_number,
  522. os.path.basename(file_path))
  523. new_cfg_path = os.path.join(os.path.dirname(file_path), new_cfg_name)
  524. return new_cfg_path
  525. def remove_from_contents(self) -> None:
  526. '''Метод для удаления целевого файла из CONTENTS.'''
  527. if self.target_package is None:
  528. return
  529. if self.template_type == DIR:
  530. self.target_package.remove_dir(self.target_path)
  531. elif self.template_type == FILE:
  532. self.target_package.remove_obj(self.target_path)
  533. def clear_dir_contents(self) -> None:
  534. '''Метод для удаления из CONTENTS всего содержимого директории после
  535. применения append = "clear".'''
  536. if self.template_type == DIR and self.target_package is not None:
  537. self.target_package.clear_dir(self.target_path)
  538. def add_to_contents(self, file_md5: Optional[str] = None) -> None:
  539. '''Метод для добавления целевого файла в CONTENTS.'''
  540. if self.target_package is None:
  541. return
  542. # В подавляющем большинстве случаев берем хэш-сумму из выходного файла,
  543. # но если по какой-то причине выходного файла нет -- пытаемся
  544. # по целевому. Такое поведение маловероятно, но, наверное, стоит
  545. # учесть возможность такой ситуации.
  546. if os.path.exists(self.output_path):
  547. source_path = self.output_path
  548. else:
  549. source_path = self.target_path
  550. if self.parameters.append == 'link':
  551. self.target_package.add_sym(source_path,
  552. self.parameters.source)
  553. elif self.template_type == DIR:
  554. self.target_package.add_dir(source_path)
  555. elif self.template_type == FILE:
  556. self.target_package.add_obj(source_path, file_md5=file_md5)
  557. def update_contents_from_list(self, changed_list: dict) -> None:
  558. '''Метод для изменения CONTENTS по списку измененных файлов.'''
  559. print("UPDATE CONTENTS FROM LIST")
  560. if self.target_package is None:
  561. return
  562. for file_path, mode in changed_list.items():
  563. if mode in {"M", "N"}:
  564. if os.path.islink(file_path):
  565. self.target_package.add_sym(file_path)
  566. elif os.path.isdir(file_path):
  567. self.target_package.add_dir(file_path)
  568. elif os.path.isfile(file_path):
  569. self.target_package.add_obj(file_path)
  570. elif mode == "D":
  571. if os.path.islink(file_path) or os.path.isfile(file_path):
  572. self.target_package.remove_obj(file_path)
  573. elif os.path.isdir(file_path):
  574. self.target_package.add_dir(file_path)
  575. @classmethod
  576. def _set_protected(cls, chroot_path: str) -> None:
  577. '''Метод для получения множества защищенных директорий.'''
  578. cls._protected_set = set()
  579. cls._unprotected_set = set()
  580. cls._protected_set.add(join_paths(chroot_path, '/etc'))
  581. config_protect_env = os.environ.get('CONFIG_PROTECT', False)
  582. if config_protect_env:
  583. for protected_path in config_protect_env.split():
  584. protected_path = join_paths(chroot_path,
  585. protected_path.strip())
  586. cls._protected_set.add(protected_path)
  587. config_protect_mask_env = os.environ.get('CONFIG_PROTECT_MASK', False)
  588. if config_protect_mask_env:
  589. for unprotected_path in config_protect_mask_env.split():
  590. unprotected_path = join_paths(chroot_path,
  591. unprotected_path.strip())
  592. cls._unprotected_set.add(unprotected_path)
  593. cls._protected_is_set = True
  594. def save_changes(self) -> None:
  595. '''Метод для сохранения изменений внесенных в CONTENTS.'''
  596. if self.target_package:
  597. self.target_package.remove_empty_directories()
  598. self.target_package.write_contents_file()
  599. class TemplateExecutor:
  600. '''Класс исполнительного модуля.'''
  601. def __init__(self,
  602. datavars_module: Union[Datavars, Variables] = Variables(),
  603. chroot_path: str = '/',
  604. cl_config_archive: str = '/var/lib/calculate/config-archive',
  605. cl_config_path: str = '/var/lib/calculate/config',
  606. execute_archive_path: str = '/var/lib/calculate/.execute/',
  607. dbpkg: bool = True,
  608. pkg_autosave: bool = False):
  609. # TODO добавить список измененных файлов.
  610. self.datavars_module: Union[Datavars, Variables] = datavars_module
  611. self.chroot_path: str = chroot_path
  612. # Объект для проверки файловых систем. Пока не инициализируем.
  613. self.mounts: Union[Mounts, None] = None
  614. # Директория для хранения полученных при обработке exec скриптов.
  615. self.execute_archive_path: str = execute_archive_path
  616. self.execute_files: OrderedDict = OrderedDict()
  617. self.dbpkg: bool = dbpkg
  618. self._pkg_autosave: bool = pkg_autosave
  619. # Словарь с измененными файлами и статусами их изменений.
  620. self.changed_files: dict = {}
  621. # Список целевых путей измененных файлов. Нужен для корректного
  622. # формирования calculate-заголовка.
  623. self.processed_targets: list = []
  624. # TODO разобраться с этим.
  625. # Значения параметров по умолчанию, пока не используются.
  626. self.directory_default_parameters: dict =\
  627. ParametersProcessor.directory_default_parameters
  628. self.file_default_parameters: dict =\
  629. ParametersProcessor.file_default_parameters
  630. # Отображение имен действий для директорий на методы их реализующие.
  631. self.directory_appends: dict = {
  632. 'join': self._append_join_directory,
  633. 'remove': self._append_remove_directory,
  634. 'skip': self._append_skip_directory,
  635. 'clear': self._append_clear_directory,
  636. 'link': self._append_link_directory,
  637. 'replace': self._append_replace_directory}
  638. # Отображение имен действий для файлов на методы их реализующие.
  639. self.file_appends: dict = {'join': self._append_join_file,
  640. 'after': self._append_after_file,
  641. 'before': self._append_before_file,
  642. 'replace': self._append_replace_file,
  643. 'remove': self._append_remove_file,
  644. 'skip': self._append_skip_file,
  645. 'clear': self._append_clear_file,
  646. 'link': self._append_link_file}
  647. self.formats_classes: set = ParametersProcessor.available_formats
  648. self.calculate_config_file: CalculateConfigFile = CalculateConfigFile(
  649. cl_config_path=cl_config_path,
  650. cl_chroot_path=chroot_path)
  651. self.cl_config_archive_path: str = cl_config_archive
  652. Format.CALCULATE_VERSION = CALCULATE_VERSION
  653. @property
  654. def available_appends(self) -> set:
  655. '''Метод для получения множества возможных значений append.'''
  656. appends_set = set(self.directory_appends.keys()).union(
  657. set(self.file_appends.keys()))
  658. return appends_set
  659. def execute_template(self, target_path: str,
  660. parameters: ParametersContainer, template_type: int,
  661. template_path: str, template_text: str = '',
  662. save_changes: bool = True,
  663. target_package: Optional[Package] = None) -> dict:
  664. '''Метод для запуска выполнения шаблонов.'''
  665. # Словарь с данными о результате работы исполнительного метода.
  666. self.executor_output = {'target_path': None,
  667. 'stdout': None,
  668. 'stderr': None,
  669. 'warnings': []}
  670. if parameters.append == 'skip':
  671. return self.executor_output
  672. try:
  673. template_object = TemplateWrapper(
  674. target_path, parameters,
  675. template_type,
  676. template_path,
  677. template_text=template_text,
  678. target_package=target_package,
  679. chroot_path=self.chroot_path,
  680. config_archive_path=self.cl_config_archive_path,
  681. dbpkg=self.dbpkg,
  682. pkg_autosave=self._pkg_autosave)
  683. except TemplateTypeConflict as error:
  684. raise TemplateExecutorError("type conflict: {}".format(str(error)))
  685. except TemplateCollisionError as error:
  686. raise TemplateExecutorError("collision: {}".format(str(error)))
  687. # Удаляем оригинал, если это необходимо из-за наличия force или по
  688. # другим причинам.
  689. if template_object.remove_original:
  690. if template_object.target_type == DIR:
  691. self._remove_directory(template_object.target_path)
  692. else:
  693. self._remove_file(template_object.target_path)
  694. if self.dbpkg:
  695. template_object.remove_from_contents()
  696. template_object.target_type = None
  697. # Если был включен mirror, то после удаления файла завершаем
  698. # выполнение шаблона.
  699. if template_object.parameters.mirror:
  700. # if save_changes:
  701. # template_object.save_changes()
  702. return self.executor_output
  703. template_object.target_type = None
  704. if template_object.parameters.run:
  705. # Если есть параметр run -- запускаем текст шаблона.
  706. self._run_template(template_object)
  707. elif template_object.parameters.exec:
  708. # Если есть параметр exec -- запускаем текст шаблона после
  709. # обработки всех шаблонов.
  710. self._exec_template(template_object)
  711. elif template_object.parameters.append:
  712. if template_object.template_type == DIR:
  713. self.directory_appends[template_object.parameters.append](
  714. template_object)
  715. elif template_object.template_type == FILE:
  716. self.file_appends[template_object.parameters.append](
  717. template_object)
  718. # Сохраняем изменения в CONTENTS внесенные согласно шаблону.
  719. # if save_changes:
  720. # template_object.save_changes()
  721. # Возвращаем целевой путь, если он был изменен, или
  722. # None если не был изменен.
  723. if template_object.target_path_is_changed:
  724. self.executor_output['target_path'] =\
  725. template_object.target_path
  726. if template_object.ca_is_missed:
  727. self.executor_output['warnings'].append(
  728. "archive file is missed,"
  729. " target file was used instead")
  730. return self.executor_output
  731. def save_changes(self) -> None:
  732. '''Метод для сохранения чего-нибудь после выполнения всех шаблонов.'''
  733. # Пока сохраняем только получившееся содержимое config-файла.
  734. self.calculate_config_file.save_changes()
  735. def _append_join_directory(self, template_object: TemplateWrapper) -> None:
  736. '''Метод описывающий действия для append = "join", если шаблон --
  737. директория. Создает директорию, если ее нет.'''
  738. if template_object.target_type is None:
  739. self._create_directory(template_object)
  740. # Корректируем список измененных файлов.
  741. if template_object.target_path in self.changed_files:
  742. self.changed_files[template_object.target_path] = 'M'
  743. else:
  744. self.changed_files[template_object.target_path] = 'N'
  745. else:
  746. if template_object.parameters.chmod:
  747. self._chmod_directory(template_object.target_path,
  748. template_object.parameters.chmod)
  749. if template_object.parameters.chown:
  750. self._chown_directory(template_object.target_path,
  751. template_object.parameters.chown)
  752. if self.dbpkg:
  753. template_object.add_to_contents()
  754. def _append_remove_directory(self, template_object: TemplateWrapper
  755. ) -> None:
  756. '''Метод описывающий действия для append = "remove", если шаблон --
  757. директория. Удаляет директорию со всем содержимым, если она есть.'''
  758. if template_object.target_type is not None:
  759. changed = [template_object.target_path]
  760. changed.extend(get_directory_contents(template_object.target_path))
  761. self._remove_directory(template_object.target_path)
  762. # Добавляем все содержимое директории в список измененных файлов.
  763. for file_path in changed:
  764. if file_path in self.changed_files:
  765. if self.changed_files[file_path] == 'N':
  766. self.changed_files.pop(file_path)
  767. else:
  768. self.changed_files[file_path] = 'D'
  769. else:
  770. self.changed_files[file_path] = 'D'
  771. if self.dbpkg:
  772. template_object.remove_from_contents()
  773. def _append_skip_directory(self,
  774. template_object: TemplateWrapper) -> None:
  775. pass
  776. def _append_clear_directory(self,
  777. template_object: TemplateWrapper) -> None:
  778. '''Метод описывающий действия для append = "clear", если шаблон --
  779. директория. Удаляет все содержимое директории, если она есть.'''
  780. if template_object.target_type is not None:
  781. dir_contents = get_directory_contents(template_object.target_path)
  782. self._clear_directory(template_object.target_path)
  783. # Добавляем все содержимое директории в список изменных файлов.
  784. for file_path in dir_contents:
  785. if file_path in self.changed_files:
  786. if self.changed_files[file_path] == 'N':
  787. self.changed_files.pop(file_path)
  788. else:
  789. self.changed_files[file_path] = 'D'
  790. else:
  791. self.changed_files[file_path] = 'D'
  792. # Меняем права и владельца очищенной директории, если это
  793. # необходимо.
  794. if template_object.parameters.chmod:
  795. self._chmod_directory(template_object.target_path,
  796. template_object.parameters.chmod)
  797. if template_object.parameters.chown:
  798. self._chown_directory(template_object.target_path,
  799. template_object.parameters.chown)
  800. if self.dbpkg:
  801. template_object.clear_dir_contents()
  802. def _append_link_directory(self, template_object: TemplateWrapper
  803. ) -> None:
  804. '''Метод описывающий действия для append = "link", если шаблон --
  805. директория. Создает ссылку на директорию, если она есть.'''
  806. self._link_directory(template_object.parameters.source,
  807. template_object.target_path)
  808. # Корректируем список измененных файлов.
  809. if template_object.target_path in self.changed_files:
  810. self.changed_files[template_object.target_path] = 'M'
  811. else:
  812. self.changed_files[template_object.target_path] = 'N'
  813. # Меняем права и владельца файла, на который указывает ссылка.
  814. if template_object.parameters.chmod:
  815. self._chmod_directory(template_object.parameters.source,
  816. template_object.parameters.chmod)
  817. if template_object.parameters.chown:
  818. self._chown_directory(template_object.parameters.source,
  819. template_object.parameters.chown)
  820. if self.dbpkg:
  821. template_object.add_to_contents()
  822. def _append_replace_directory(self, template_object: TemplateWrapper
  823. ) -> None:
  824. '''Метод описывающий действия для append = "replace", если шаблон --
  825. директория. Очищает директорию или создает, если ее нет.'''
  826. if template_object.target_type is None:
  827. self._create_directory(template_object)
  828. if self.dbpkg:
  829. template_object.add_to_contents()
  830. # Корректируем список измененных файлов.
  831. if template_object.target_path in self.changed_files:
  832. self.changed_files[template_object.target_path] = 'M'
  833. else:
  834. self.changed_files[template_object.target_path] = 'N'
  835. else:
  836. dir_contents = get_directory_contents(template_object.target_path)
  837. self._clear_directory(template_object.target_path)
  838. # Добавляем все содержимое директории в список измененных файлов.
  839. for file_path in dir_contents:
  840. if file_path in self.changed_files:
  841. if self.changed_files[file_path] == 'N':
  842. self.changed_files.pop(file_path)
  843. else:
  844. self.changed_files[file_path] = 'D'
  845. else:
  846. self.changed_files[file_path] = 'D'
  847. if self.dbpkg:
  848. template_object.clear_dir_contents()
  849. def _append_join_file(self, template_object: TemplateWrapper,
  850. join_before: bool = False, replace: bool = False
  851. ) -> None:
  852. '''Метод описывающий действия при append = "join", если шаблон -- файл.
  853. Объединяет шаблон с целевым файлом.'''
  854. output_path = template_object.output_path
  855. input_file_md5 = None
  856. output_file_md5 = None
  857. template_format = template_object.format_class
  858. # Задаемся значениями chmod и chown в зависимости от наличия или
  859. # отсутствия файла, принадлежности его пакету и наличия значений
  860. # параметров по умолчанию.
  861. chmod = self._get_chmod(template_object)
  862. chown = self._get_chown(template_object)
  863. if template_format.EXECUTABLE or template_object.contents_matching:
  864. # Действия, если целевой файл не имеет пользовательских изменений
  865. # или если он исполнительный.
  866. # Парсим текст шаблона используя его формат.
  867. if (not template_object.template_text.strip()
  868. and template_object.parameters.source
  869. and template_object.parameters.append == "replace"
  870. and template_object.parameters.format == "raw"):
  871. # Если шаблон пуст, параметром source задан входной файл,
  872. # и при этом формат шаблона raw и append = 'replace'
  873. # значит этот шаблон предназначен для копирования.
  874. if template_object.target_type is not None:
  875. self._remove_file(template_object.target_path)
  876. output_file_md5 = self._copy_from_source(template_object,
  877. chown=chown,
  878. chmod=chmod)
  879. elif not template_object.format_class.EXECUTABLE:
  880. parsed_template = template_format(
  881. template_object.template_text,
  882. template_object.template_path,
  883. ignore_comments=True,
  884. chroot_path=self.chroot_path)
  885. # Действия для шаблонов не являющихся исполнительными.
  886. output_paths = [output_path]
  887. # Если целевой файл защищен, а шаблон не userspace.
  888. if (template_object.protected
  889. and not template_object.is_userspace):
  890. # Тогда также обновляем архив.
  891. output_paths.append(template_object.archive_path)
  892. input_text = self._get_input_text(template_object,
  893. replace=replace)
  894. if (replace and template_object.target_type is not None and
  895. os.path.exists(output_path)):
  896. self._clear_file(output_path)
  897. # Если шаблон не исполнительный разбираем входной текст.
  898. parsed_input = template_format(
  899. input_text,
  900. template_object.template_path,
  901. add_header=True,
  902. join_before=join_before,
  903. already_changed=(template_object.target_path
  904. in self.processed_targets),
  905. parameters=template_object.parameters)
  906. parsed_input.join_template(parsed_template)
  907. # Результат наложения шаблона.
  908. output_text = parsed_input.document_text
  909. # Удаляем форматный объект входного файла.
  910. # del(parsed_input)
  911. output_file_md5 = hashlib.md5(output_text.encode()).hexdigest()
  912. if input_text:
  913. input_file_md5 = hashlib.md5(
  914. input_text.encode()).hexdigest()
  915. for save_path in output_paths:
  916. if not os.path.exists(os.path.dirname(save_path)):
  917. self._create_directory(
  918. template_object,
  919. path_to_create=os.path.dirname(save_path))
  920. with open(save_path, 'w') as output_file:
  921. output_file.write(output_text)
  922. # Меняем права доступа и владельца всех сохраняемых файлов,
  923. # если это необходимо.
  924. if chown:
  925. self._chown_file(save_path, chown)
  926. if chmod:
  927. self._chmod_file(save_path, chmod)
  928. elif template_object.format_class.EXECUTABLE:
  929. parsed_template = template_format(
  930. template_object.template_text,
  931. template_object.template_path,
  932. parameters=template_object.parameters,
  933. datavars=self.datavars_module)
  934. changed_files = parsed_template.execute_format(
  935. template_object.target_path,
  936. chroot_path=self.chroot_path)
  937. # Удаляем форматный объект входного файла.
  938. # del(parsed_template)
  939. # Если исполняемый формат выдал список измененных файлов для
  940. # изменения CONTENTS и при этом задан пакет -- обновляем
  941. # CONTENTS.
  942. for file_path, status in changed_files.items():
  943. if status == 'M':
  944. if file_path in self.changed_files:
  945. if self.changed_files[file_path] == 'D':
  946. self.changed_files[file_path] == 'N'
  947. else:
  948. self.changed_files[file_path] = 'M'
  949. elif status == 'D':
  950. if file_path in self.changed_files:
  951. if self.changed_files[file_path] == 'M':
  952. self.changed_files[file_path] == 'D'
  953. if self.changed_files[file_path] == 'N':
  954. self.changed_files.pop(file_path)
  955. else:
  956. self.changed_files[file_path] = 'D'
  957. # Если в ходе работы формат выкидывал предупреждения --
  958. # добавляем их в список предупреждений.
  959. if parsed_template.warnings:
  960. self.executor_output['warnings'].extend(
  961. parsed_template.warnings)
  962. if (self.dbpkg and changed_files and
  963. template_object.target_package and
  964. template_object.format_class.FORMAT != 'contents'):
  965. template_object.update_contents_from_list(changed_files)
  966. return
  967. if input_file_md5 != output_file_md5:
  968. if template_object.target_type is None:
  969. self.changed_files[
  970. template_object.target_path] = 'N'
  971. else:
  972. self.changed_files[
  973. template_object.target_path] = 'M'
  974. if self.dbpkg:
  975. self._remove_cfg_files(template_object)
  976. if template_object.parameters.unbound:
  977. template_object.remove_from_contents()
  978. else:
  979. template_object.add_to_contents(
  980. file_md5=output_file_md5)
  981. else:
  982. input_text = self._get_input_text(template_object,
  983. replace=replace)
  984. parsed_input = template_format(
  985. input_text,
  986. template_object.template_path,
  987. add_header=True,
  988. join_before=join_before,
  989. already_changed=False,
  990. parameters=template_object.parameters)
  991. parsed_template = template_format(template_object.template_text,
  992. template_object.template_path,
  993. ignore_comments=True)
  994. parsed_input.join_template(parsed_template)
  995. # Результат наложения шаблона.
  996. output_text = parsed_input.document_text
  997. # Удаляем форматный объект входного файла.
  998. del(parsed_input)
  999. output_file_md5 = hashlib.md5(output_text.encode()).hexdigest()
  1000. if not self.calculate_config_file.compare_md5(
  1001. template_object.target_path,
  1002. output_file_md5):
  1003. if not os.path.exists(os.path.dirname(output_path)):
  1004. self._create_directory(
  1005. template_object,
  1006. path_to_create=os.path.dirname(output_path))
  1007. with open(output_path, 'w') as output_file:
  1008. output_file.write(output_text)
  1009. # Меняем права доступа и владельца ._cfg????_ файлов, если
  1010. # это необходимо.
  1011. if chown:
  1012. self._chown_file(output_path, chown)
  1013. if chmod:
  1014. self._chmod_file(output_path, chmod)
  1015. # Обновляем CL.
  1016. self.calculate_config_file.set_files_md5(
  1017. template_object.target_path,
  1018. output_file_md5)
  1019. self.changed_files[template_object.target_path] = 'C'
  1020. # Обновляем CONTENTS.
  1021. template_object.add_to_contents(file_md5=output_file_md5)
  1022. else:
  1023. # Действия если CL совпало. Hичего не делаем.
  1024. pass
  1025. def _get_input_text(self, template_object: TemplateWrapper,
  1026. replace: bool = False) -> str:
  1027. '''Метод для получения текста входного файла.'''
  1028. # TODO Сделать это как-нибудь получше
  1029. input_path = template_object.input_path
  1030. if (not replace and (template_object.target_type is not None
  1031. or template_object.parameters.source)):
  1032. # Если целевой файл есть и нет параметра replace --
  1033. # используем текст целевого файла.
  1034. if (not input_path.startswith(self.cl_config_archive_path)
  1035. or os.path.exists(input_path)):
  1036. # Если входной файл просто не из архива, или из архива
  1037. # и при этом существует -- используем его
  1038. try:
  1039. with open(input_path, 'r') as input_file:
  1040. input_text = input_file.read()
  1041. return input_text
  1042. except UnicodeDecodeError:
  1043. raise TemplateExecutorError("can not join binary files.")
  1044. return ''
  1045. def _remove_cfg_files(self, template_object: TemplateWrapper) -> None:
  1046. '''Метод для удаления всех ._cfg-файлов и хэш-сумм добавленных в
  1047. config-файл.'''
  1048. # Убираем все ._cfg файлы.
  1049. if template_object.cfg_list:
  1050. for cfg_file_path in template_object.cfg_list:
  1051. self._remove_file(cfg_file_path)
  1052. # Убираем целевой файл из CL.
  1053. self.calculate_config_file.remove_file(template_object.target_path)
  1054. def _copy_from_source(self, template_object: TemplateWrapper,
  1055. chown: Optional[dict] = None,
  1056. chmod: Optional[int] = None) -> str:
  1057. '''Метод для копирования файла, указанного в source.'''
  1058. output_path = template_object.output_path
  1059. source_path = template_object.input_path
  1060. output_directory = os.path.dirname(output_path)
  1061. if not os.path.exists(output_directory):
  1062. self._create_directory(template_object,
  1063. path_to_create=output_directory)
  1064. shutil.copy(source_path, output_path)
  1065. if chown:
  1066. self._chown_file(template_object.output_path, chown)
  1067. if chmod:
  1068. self._chmod_file(template_object.output_path, chmod)
  1069. with open(output_path, "rb") as output_file:
  1070. output_file_data = output_file.read()
  1071. output_file_md5 = hashlib.md5(output_file_data).hexdigest()
  1072. return output_file_md5
  1073. def _get_chmod(self, template_object: TemplateWrapper) -> int:
  1074. chmod = template_object.parameters.chmod
  1075. if not chmod:
  1076. if (template_object.target_type is not None and
  1077. not template_object.target_without_package):
  1078. chmod = self._get_file_mode(template_object.target_path)
  1079. else:
  1080. chmod = self.file_default_parameters.get('chmod', False)
  1081. return chmod
  1082. def _get_chown(self, template_object: TemplateWrapper) -> dict:
  1083. chown = template_object.parameters.chown
  1084. if not chown:
  1085. if (template_object.target_type is not None and
  1086. not template_object.target_without_package):
  1087. chown = self._get_file_owner(template_object.target_path)
  1088. else:
  1089. chown = self.file_default_parameters.get('chown', False)
  1090. return chown
  1091. def _append_after_file(self, template_object: TemplateWrapper) -> None:
  1092. '''Метод описывающий действия при append = "after", если шаблон --
  1093. файл. Объединяет шаблон с целевым файлом так, чтобы текст добавлялся
  1094. в конец файла и в конец каждой секции файла.'''
  1095. self._append_join_file(template_object, join_before=False)
  1096. def _append_before_file(self, template_object: TemplateWrapper
  1097. ) -> None:
  1098. '''Метод описывающий действия при append = "after", если шаблон --
  1099. файл. Объединяет шаблон с целевым файлом так, чтобы текст добавлялся
  1100. в начало файла и в начало каждой секции файла.'''
  1101. self._append_join_file(template_object, join_before=True)
  1102. def _append_skip_file(self, template_object: TemplateWrapper) -> None:
  1103. '''Метод описывающий действия при append = "skip". Пока никаких
  1104. действий.'''
  1105. pass
  1106. def _append_replace_file(self, template_object: TemplateWrapper
  1107. ) -> None:
  1108. '''Метод описывающий действия при append = "replace", если шаблон --
  1109. файл. Очищает файл и затем накладывает на него шаблон.'''
  1110. self._append_join_file(template_object, replace=True)
  1111. def _append_remove_file(self, template_object: TemplateWrapper
  1112. ) -> None:
  1113. '''Метод описывающий действия при append = "remove", если шаблон --
  1114. файл. Удаляет файл.'''
  1115. if template_object.target_type is not None:
  1116. self._remove_file(template_object.target_path)
  1117. if template_object.target_path in self.changed_files:
  1118. if self.changed_files[template_object.target_path] == 'N':
  1119. self.changed_files.pop(template_object.target_path)
  1120. elif self.changed_files[template_object.target_path] == 'M':
  1121. self.changed_files[template_object.target_path] = 'D'
  1122. else:
  1123. self.changed_files[template_object.target_path] = 'D'
  1124. if self.dbpkg:
  1125. template_object.remove_from_contents()
  1126. def _append_clear_file(self, template_object: TemplateWrapper) -> None:
  1127. '''Метод описывающий действия при append = "clear", если шаблон --
  1128. файл. Очищает файл.'''
  1129. if template_object.target_type is not None:
  1130. self._clear_file(template_object.target_path)
  1131. # Меняем владельца и права доступа к очищенному файлу, если нужно.
  1132. if template_object.parameters.chown:
  1133. self._chown_file(template_object.target_path,
  1134. template_object.parameters.chown)
  1135. if template_object.parameters.chmod:
  1136. self._chmod_file(template_object.target_path,
  1137. template_object.parameters.chmod)
  1138. # Корректируем список измененных файлов.
  1139. if template_object.target_path not in self.changed_files:
  1140. self.changed_files[template_object.target_path] = 'M'
  1141. if self.dbpkg:
  1142. template_object.add_to_contents()
  1143. def _append_link_file(self, template_object: TemplateWrapper) -> None:
  1144. '''Метод описывающий действия при append = "link", если шаблон --
  1145. файл. Создает ссылку на файл, указанный в параметре source.'''
  1146. input_path = template_object.input_path
  1147. output_path = template_object.output_path
  1148. if template_object.contents_matching:
  1149. output_paths = [output_path]
  1150. # Если целевой файл защищен, а шаблон не userspace,
  1151. # тогда также обновляем архив.
  1152. if (template_object.protected
  1153. and not template_object.is_userspace):
  1154. output_paths.append(template_object.archive_path)
  1155. for link_path in output_paths:
  1156. if not os.path.exists(os.path.dirname(link_path)):
  1157. self._create_directory(
  1158. template_object,
  1159. path_to_create=os.path.dirname(link_path))
  1160. elif os.path.exists(link_path):
  1161. os.unlink(link_path)
  1162. self._link_file(input_path, link_path)
  1163. # Корректируем список измененных файлов.
  1164. if template_object.target_path not in self.changed_files:
  1165. self.changed_files[template_object.target_path] = 'N'
  1166. else:
  1167. self.changed_files[template_object.target_path] = 'M'
  1168. if self.dbpkg:
  1169. # Убираем целевой файл из CL.
  1170. self.calculate_config_file.remove_file(
  1171. template_object.target_path)
  1172. if template_object.parameters.unbound:
  1173. template_object.remove_from_contents()
  1174. else:
  1175. template_object.add_to_contents()
  1176. else:
  1177. source_path_md5 = self._get_source_hash(input_path)
  1178. if not self.calculate_config_file.compare_md5(
  1179. template_object.target_path,
  1180. source_path_md5
  1181. ):
  1182. if not os.path.exists(os.path.dirname(output_path)):
  1183. self._create_directory(
  1184. template_object,
  1185. path_to_create=os.path.dirname(output_path))
  1186. elif os.path.exists(output_path):
  1187. os.unlink(output_path)
  1188. self._link_file(input_path, output_path)
  1189. self.changed_files[template_object.target_path] = 'C'
  1190. if self.dbpkg:
  1191. template_object.add_to_contents()
  1192. # Обновляем CL.
  1193. self.calculate_config_file.set_files_md5(
  1194. template_object.target_path,
  1195. source_path_md5)
  1196. self.changed_files[template_object.target_path] = 'C'
  1197. # Обновляем CONTENTS.
  1198. template_object.add_to_contents()
  1199. else:
  1200. # Действия если CL совпало. Hичего не делаем.
  1201. pass
  1202. # Меняем права и владельца файла, на который указывает ссылка.
  1203. if template_object.parameters.chmod:
  1204. self._chmod_file(input_path, template_object.parameters.chmod)
  1205. if template_object.parameters.chown:
  1206. self._chown_file(input_path, template_object.parameters.chown)
  1207. def _get_source_hash(self, source_path: str) -> str:
  1208. if (self.chroot_path != "/" and
  1209. source_path.startswith(self.chroot_path)):
  1210. source_path = source_path[len(self.chroot_path):]
  1211. if not source_path.startswith("/"):
  1212. source_path = "/" + source_path
  1213. return hashlib.md5(source_path.encode()).hexdigest()
  1214. def _create_directory(self, template_object: TemplateWrapper,
  1215. path_to_create: Optional[str] = None) -> None:
  1216. '''Метод для создания директории и, при необходимости, изменения
  1217. владельца и доступа все директорий на пути к целевой.'''
  1218. if path_to_create is None:
  1219. target_path = template_object.target_path
  1220. else:
  1221. target_path = path_to_create
  1222. template_parameters = template_object.parameters
  1223. # Если файл есть, но указан chmod или chown -- используем их.
  1224. if os.access(target_path, os.F_OK):
  1225. if template_parameters.chmod:
  1226. self._chmod_directory(target_path, template_parameters.chmod)
  1227. if template_parameters.chown:
  1228. self._chown_directory(target_path, template_parameters.chown)
  1229. return
  1230. directories_to_create = [target_path]
  1231. directory_path = os.path.dirname(target_path)
  1232. # Составляем список путей к директориям, которые нужно создать.
  1233. while not os.access(directory_path, os.F_OK) and directory_path:
  1234. directories_to_create.append(directory_path)
  1235. directory_path = os.path.dirname(directory_path)
  1236. # получаем информацию о владельце и правах доступа ближайшей
  1237. # существующей директории.
  1238. chmod = template_parameters.chmod
  1239. if not chmod:
  1240. chmod = self._get_file_mode(directory_path)
  1241. chown = template_parameters.chown
  1242. if not chown:
  1243. chown = self._get_file_owner(directory_path)
  1244. directories_to_create.reverse()
  1245. # создаем директории.
  1246. for create_path in directories_to_create:
  1247. try:
  1248. os.mkdir(create_path)
  1249. # Для каждой созданной директории меняем права и владельца
  1250. # если это необходимо.
  1251. if chmod:
  1252. self._chmod_directory(create_path, chmod)
  1253. if chown:
  1254. self._chown_directory(create_path, chown)
  1255. except OSError as error:
  1256. raise TemplateExecutorError(
  1257. 'Failed to create directory: {}, reason: {}'.
  1258. format(create_path, str(error)))
  1259. def _remove_directory(self, target_path: str) -> None:
  1260. '''Метод для удаления директории.'''
  1261. if os.path.exists(target_path):
  1262. if os.path.isdir(target_path):
  1263. try:
  1264. if os.path.islink(target_path):
  1265. os.unlink(target_path)
  1266. else:
  1267. shutil.rmtree(target_path)
  1268. return
  1269. except Exception as error:
  1270. raise TemplateExecutorError(
  1271. ("Failed to delete the directory: {0},"
  1272. " reason: {1}").format(target_path,
  1273. str(error)))
  1274. else:
  1275. error_message = "target file is not directory"
  1276. else:
  1277. error_message = "target file does not exist"
  1278. raise TemplateExecutorError(("Failed to delete the directory: {0},"
  1279. "reason: {1}").format(target_path,
  1280. error_message))
  1281. def _clear_directory(self, target_path: str) -> None:
  1282. '''Метод для очистки содержимого целевой директории.'''
  1283. if os.path.exists(target_path):
  1284. if os.path.isdir(target_path):
  1285. # Удаляем все содержимое директории.
  1286. for node in os.scandir(target_path):
  1287. if node.is_dir():
  1288. self._remove_directory(node.path)
  1289. else:
  1290. self._remove_file(node.path)
  1291. return
  1292. else:
  1293. error_message = "target file is not directory"
  1294. else:
  1295. error_message = "target directory does not exist"
  1296. raise TemplateExecutorError(("failed to clear directory: {},"
  1297. " reason: {}").format(target_path,
  1298. error_message))
  1299. def _link_directory(self, source: str, target_path: str,
  1300. force: bool = False) -> None:
  1301. '''Метод для создания по целевому пути ссылки на директорию
  1302. расположенную на пути, указанном в source.'''
  1303. try:
  1304. os.symlink(source, target_path, target_is_directory=True)
  1305. except OSError as error:
  1306. raise TemplateExecutorError(
  1307. "failed to create symlink: {0} -> {1}, reason: {2}".
  1308. format(target_path, source, str(error)))
  1309. def _remove_file(self, target_path: str) -> None:
  1310. '''Метод для удаления файлов.'''
  1311. if os.path.exists(target_path):
  1312. if os.path.isfile(target_path):
  1313. if os.path.islink(target_path):
  1314. try:
  1315. os.unlink(target_path)
  1316. return
  1317. except OSError as error:
  1318. error_message = str(error)
  1319. try:
  1320. os.remove(target_path)
  1321. return
  1322. except OSError as error:
  1323. error_message = str(error)
  1324. else:
  1325. error_message = 'target is not a file'
  1326. elif os.path.islink(target_path):
  1327. try:
  1328. os.unlink(target_path)
  1329. return
  1330. except OSError as error:
  1331. error_message = str(error)
  1332. else:
  1333. error_message = 'target file does not exist'
  1334. raise TemplateExecutorError(("failed to remove the file: {0},"
  1335. "reason: {1}").format(target_path,
  1336. error_message))
  1337. def _clear_file(self, target_path: str) -> None:
  1338. '''Метод для очистки файлов.'''
  1339. if os.path.exists(target_path):
  1340. if os.path.isfile(target_path):
  1341. try:
  1342. with open(target_path, 'w') as f:
  1343. f.truncate(0)
  1344. return
  1345. except IOError as error:
  1346. error_message = str(error)
  1347. else:
  1348. error_message = 'target is not a file'
  1349. else:
  1350. error_message = 'target file does not exist'
  1351. raise TemplateExecutorError(("failed to clear the file: {0},"
  1352. "reason: {1}").format(target_path,
  1353. error_message))
  1354. def _link_file(self, source: str, target_path: str) -> None:
  1355. '''Метод для создания по целевому пути ссылки на файл расположенный на
  1356. пути, указанному в source.'''
  1357. try:
  1358. os.symlink(source, target_path)
  1359. except OSError as error:
  1360. raise TemplateExecutorError(
  1361. "failed to create symlink to the file: {0} -> {1}, reason: {2}".
  1362. format(target_path, source, str(error)))
  1363. def _run_template(self, template_object: TemplateWrapper) -> None:
  1364. '''Метод для сохранения текста шаблонов, который должен быть исполнен
  1365. интерпретатором указанным в run прямо во время обработки шаблонов.'''
  1366. text_to_run = template_object.template_text
  1367. interpreter = template_object.parameters.run
  1368. if template_object.template_type == FILE:
  1369. cwd_path = os.path.dirname(template_object.target_path)
  1370. else:
  1371. cwd_path = template_object.target_path
  1372. if not os.path.exists(cwd_path):
  1373. raise TemplateExecutorError(("can not run template, directory from"
  1374. " target path does not exist: {}").
  1375. format(template_object.target_path))
  1376. elif not os.path.isdir(cwd_path):
  1377. raise TemplateExecutorError(("can not exec template, {} is not a"
  1378. " directory.").format(cwd_path))
  1379. try:
  1380. run_process = Process(interpreter, cwd=cwd_path)
  1381. run_process.write(text_to_run)
  1382. if run_process.readable:
  1383. stdout = run_process.read()
  1384. if stdout:
  1385. self.executor_output['stdout'] = stdout
  1386. if run_process.readable_errors:
  1387. stderr = run_process.read_error()
  1388. if stderr:
  1389. self.executor_output['stderr'] = stderr
  1390. except FilesError as error:
  1391. raise TemplateExecutorError(("can not run template using the"
  1392. " interpreter '{}', reason: {}").
  1393. format(interpreter, str(error)))
  1394. def _exec_template(self, template_object: TemplateWrapper) -> None:
  1395. '''Метод для сохранения текста шаблонов, который должен быть исполнен
  1396. интерпретатором указанным в exec после выполнения всех прочих шаблонов.
  1397. '''
  1398. text_to_run = template_object.template_text
  1399. interpreter = template_object.parameters.exec
  1400. if template_object.template_type == FILE:
  1401. cwd_path = os.path.dirname(template_object.target_path)
  1402. else:
  1403. cwd_path = template_object.target_path
  1404. if not os.path.exists(cwd_path):
  1405. raise TemplateExecutorError(
  1406. ("can not exec template, directory from"
  1407. " target path does not exist: {}").
  1408. format(cwd_path))
  1409. elif not os.path.isdir(cwd_path):
  1410. raise TemplateExecutorError(("can not exec template, {} is not a"
  1411. " directory.").format(cwd_path))
  1412. # Получаем путь к директории для хранения файлов .execute.
  1413. if (self.chroot_path != '/' and not
  1414. self.execute_archive_path.startswith(self.chroot_path)):
  1415. self.execute_archive_path = join_paths(
  1416. self.chroot_path,
  1417. self.execute_archive_path)
  1418. # Если директория уже существует получаем номер очередного файла для
  1419. # exec по номеру последнего.
  1420. exec_number = 0
  1421. if not self.execute_files:
  1422. if os.path.exists(self.execute_archive_path):
  1423. exec_files_list = os.listdir(self.execute_archive_path)
  1424. if exec_files_list:
  1425. exec_number = int(exec_files_list[-1][-4:])
  1426. exec_number = str(exec_number + 1)
  1427. else:
  1428. exec_number = str(len(self.execute_files) + 1)
  1429. # Получаем название нового exec_???? файла.
  1430. if len(exec_number) < 4:
  1431. exec_number = '0' * (4 - len(exec_number)) + exec_number
  1432. exec_file_name = 'exec_{}'.format(exec_number)
  1433. exec_file_path = join_paths(self.execute_archive_path,
  1434. exec_file_name)
  1435. exec_file = write_file(exec_file_path)
  1436. exec_file.write(text_to_run)
  1437. exec_file.close()
  1438. self.execute_files[exec_file_path] = {'interpreter': interpreter,
  1439. 'cwd_path': cwd_path,
  1440. 'template_path':
  1441. template_object.template_path}
  1442. def execute_file(self, interpreter: str, exec_path: str,
  1443. cwd_path: str) -> dict:
  1444. """Метод для выполнения скриптов сохраненных в результате обработки
  1445. шаблонов с параметром exec. Скрипт всегда удаляется вне зависимости
  1446. от успешности его выполнения."""
  1447. exec_output = {'stdout': None, 'stderr': None}
  1448. with open(exec_path, 'r') as exec_file:
  1449. script_text = exec_file.read()
  1450. os.remove(exec_path)
  1451. try:
  1452. run_process = Process(interpreter, cwd=cwd_path)
  1453. run_process.write(script_text)
  1454. if run_process.readable:
  1455. stdout = run_process.read()
  1456. if stdout:
  1457. exec_output['stdout'] = stdout
  1458. if run_process.readable_errors:
  1459. stderr = run_process.read_error()
  1460. if stderr:
  1461. exec_output['stderr'] = stderr
  1462. return exec_output
  1463. except FilesError as error:
  1464. raise TemplateExecutorError(("can not run template using the"
  1465. " interpreter '{}', reason: {}").
  1466. format(interpreter, str(error)))
  1467. def _chown_directory(self, target_path: str, chown_value: dict
  1468. ) -> None:
  1469. """Метод для смены владельца директории."""
  1470. try:
  1471. if os.path.exists(target_path):
  1472. os.chown(target_path, chown_value['uid'], chown_value['gid'])
  1473. else:
  1474. raise TemplateExecutorError(
  1475. 'The target directory does not exist: {0}'.
  1476. format(target_path))
  1477. except (OSError, Exception) as error:
  1478. if not self._check_os_error(error, target_path):
  1479. raise TemplateExecutorError(
  1480. 'Can not chown file: {0} to {1}, reason: {2}'.
  1481. format(target_path, self._translate_uid_gid(
  1482. chown_value['uid'],
  1483. chown_value['gid']),
  1484. str(error)))
  1485. def _chmod_directory(self, target_path: str, chmod_value: int) -> None:
  1486. '''Метод для смены прав доступа к директории.'''
  1487. if isinstance(chmod_value, tuple) and not chmod_value[1]:
  1488. chmod_value = chmod_value[0]
  1489. try:
  1490. if os.path.exists(target_path):
  1491. if isinstance(chmod_value, int):
  1492. os.chmod(target_path, chmod_value)
  1493. else:
  1494. chmod_value = self._use_chmod_x_mask(chmod_value)
  1495. os.chmod(target_path, chmod_value)
  1496. else:
  1497. raise TemplateExecutorError(
  1498. 'The target directory does not exist: {0}'.
  1499. format(target_path))
  1500. except (OSError, Exception) as error:
  1501. if not self._check_os_error(error, target_path):
  1502. raise TemplateExecutorError(
  1503. 'Can not chmod directory: {0}, reason: {1}'.
  1504. format(target_path, str(error)))
  1505. def _chown_file(self, target_path: str, chown_value: dict) -> None:
  1506. '''Метод для смены владельца файла.'''
  1507. try:
  1508. if os.path.exists(target_path):
  1509. os.lchown(target_path, chown_value['uid'], chown_value['gid'])
  1510. else:
  1511. raise TemplateExecutorError(
  1512. 'The target file does not exist: {0}'.
  1513. format(target_path))
  1514. except (OSError, Exception) as error:
  1515. if not self._check_os_error(error, target_path):
  1516. raise TemplateExecutorError(
  1517. 'Can not chown file: {0} to {1}, reason: {2}'.
  1518. format(target_path, self._translate_uid_gid(
  1519. chown_value['uid'],
  1520. chown_value['gid']),
  1521. str(error)))
  1522. def _chmod_file(self, target_path: str, chmod_value: int) -> None:
  1523. '''Метод для смены прав доступа к директории.'''
  1524. try:
  1525. if not os.path.exists(target_path):
  1526. raise TemplateExecutorError(
  1527. 'The target file does not exist: {0}'.
  1528. format(target_path))
  1529. if isinstance(chmod_value, int):
  1530. os.chmod(target_path, chmod_value)
  1531. else:
  1532. chmod_value = self._use_chmod_x_mask(
  1533. chmod_value,
  1534. current_mode=self._get_file_mode(
  1535. target_path))
  1536. os.chmod(target_path, chmod_value)
  1537. except (OSError, Exception) as error:
  1538. if not self._check_os_error(error, target_path):
  1539. raise TemplateExecutorError(
  1540. 'Can not chmod file: {0}, reason: {1}'.
  1541. format(target_path, str(error)))
  1542. def _use_chmod_x_mask(self, chmod: Tuple[int, int],
  1543. current_mode: Optional[int] = None) -> int:
  1544. '''Метод для наложения X-маски, необходимой для получения значения
  1545. chmod, c учетом возможности наличия в нем значения "X".'''
  1546. chmod, x_mask = chmod
  1547. if not x_mask:
  1548. return chmod
  1549. if current_mode is None:
  1550. return chmod ^ x_mask
  1551. else:
  1552. return chmod ^ (current_mode & x_mask)
  1553. def _get_file_mode(self, file_path: str) -> int:
  1554. '''Метод для получения прав доступа для указанного файла.'''
  1555. if not os.path.exists(file_path):
  1556. raise TemplateExecutorError(
  1557. 'The file to get mode does not exist: {0}'.
  1558. format(file_path))
  1559. file_stat = os.stat(file_path)
  1560. return stat.S_IMODE(file_stat.st_mode)
  1561. def _get_file_owner(self, file_path: str) -> dict:
  1562. '''Метод для получения uid и gid значений для владельца указанного
  1563. файла.'''
  1564. if not os.path.exists(file_path):
  1565. raise TemplateExecutorError(
  1566. 'The file to get owner does not exist: {0}'.
  1567. format(file_path))
  1568. file_stat = os.stat(file_path)
  1569. return {'uid': file_stat.st_uid, 'gid': file_stat.st_gid}
  1570. def _translate_uid_gid(self, uid: int, gid: int) -> str:
  1571. '''Метод для получения из uid и gid имен пользователя и группы при,
  1572. необходимых для выдачи сообщения об ошибке при попытке chown.'''
  1573. import pwd
  1574. import grp
  1575. try:
  1576. if self.chroot_path == '/':
  1577. user_name = pwd.getpwuid(uid).pw_name
  1578. else:
  1579. user_name = self._get_user_name_from_uid(uid)
  1580. except (TypeError, KeyError):
  1581. user_name = str(uid)
  1582. try:
  1583. if self.chroot_path == '/':
  1584. group_name = grp.getgrgid(gid).gr_name
  1585. else:
  1586. group_name = self._get_group_name_from_gid(gid)
  1587. except (TypeError, KeyError):
  1588. group_name = str(gid)
  1589. return '{0}:{1}'.format(user_name, group_name)
  1590. def _get_user_name_from_uid(self, uid: int) -> str:
  1591. '''Метод для получения имени пользователя по его uid.'''
  1592. passwd_file_path = os.path.join(self.chroot_path, 'etc/passwd')
  1593. passwd_dictionary = dict()
  1594. if os.path.exists(passwd_file_path):
  1595. with open(passwd_file_path, 'r') as passwd_file:
  1596. for line in passwd_file:
  1597. if line.startswith('#'):
  1598. continue
  1599. passwd_line = line.split(':')
  1600. line_uid = int(passwd_line[2])
  1601. line_username = passwd_line[0]
  1602. if line_uid and line_username:
  1603. passwd_dictionary[line_uid] = line_username
  1604. if uid in passwd_dictionary:
  1605. return passwd_dictionary[uid]
  1606. else:
  1607. return str(uid)
  1608. def _get_group_name_from_gid(self, gid: int) -> str:
  1609. '''Метод для получения названия группы по его gid.'''
  1610. group_file_path = os.path.join(self.chroot_path, 'etc/group')
  1611. group_dictionary = dict()
  1612. if os.path.exists(group_file_path):
  1613. with open(group_file_path, 'r') as group_file:
  1614. for line in group_file:
  1615. if line.startswith('#'):
  1616. continue
  1617. group_line = line.split(':')
  1618. line_gid = int(group_line[2])
  1619. line_group = group_line[0]
  1620. if line_gid and line_group:
  1621. group_dictionary[line_gid] = line_group
  1622. if gid in group_dictionary:
  1623. return group_dictionary[gid]
  1624. else:
  1625. return str(gid)
  1626. def _check_os_error(self, error: Exception, path_to_check: str) -> bool:
  1627. '''Метод для проверки причины, по которой не удалось изменить владельца
  1628. или права доступа файла.'''
  1629. if hasattr(error, 'errno') and error.errno == errno.EPERM:
  1630. if self._is_vfat(path_to_check):
  1631. return True
  1632. return hasattr(error, 'errno') and error.errno == errno.EACCES and\
  1633. 'var/calculate/remote' in path_to_check
  1634. def _is_vfat(self, path_to_check: str) -> bool:
  1635. '''Метод, проверяющий является ли файловая система vfat. Нужно для того,
  1636. чтобы знать о возможности применения chown, chmod и т.д.'''
  1637. # Инициализируем объект для проверки примонтированных файловых систем.
  1638. if self.mounts is None:
  1639. self.mounts = Mounts()
  1640. # Проверяем файловую систему на пути.
  1641. fstab_info = self.mounts.get_from_fstab(what=self.mounts.TYPE,
  1642. where=self.mounts.DIR,
  1643. is_in=path_to_check)[0]
  1644. return fstab_info in {'vfat', 'ntfs-3g', 'ntfs'}
  1645. class DirectoryTree:
  1646. '''Класс реализующий дерево каталогов для пакета.'''
  1647. def __init__(self, base_directory: str):
  1648. self.base_directory = base_directory
  1649. self._tree = {}
  1650. def update_tree(self, tree: dict) -> None:
  1651. '''Метод, инициирующий наложение заданного дерева каталогов на данный
  1652. экземпляр дерева.'''
  1653. self._update(self._tree, tree)
  1654. def _update(self, original_tree: dict, tree: dict) -> dict:
  1655. '''Метод для рекурсивного наложения одного дерева на другое.'''
  1656. for parent, child in tree.items():
  1657. if isinstance(child, abc.Mapping):
  1658. original_tree[parent] = self._update(original_tree.get(parent,
  1659. dict()),
  1660. child)
  1661. else:
  1662. original_tree[parent] = child
  1663. return original_tree
  1664. def show_tree(self) -> None:
  1665. pprint(self._tree)
  1666. def get_directory_tree(self, directory: str) -> "DirectoryTree":
  1667. '''Метод для получения нового дерева из ветви данного дерева,
  1668. соответствующей некоторому каталогу, содержащемуся в корне данного
  1669. дерева.'''
  1670. directory_tree = DirectoryTree(os.path.join(self.base_directory,
  1671. directory))
  1672. if directory in self._tree:
  1673. directory_tree._tree = self._tree[directory]
  1674. return directory_tree
  1675. def __getitem__(self, name: str) -> Union[None, dict]:
  1676. if name in self._tree:
  1677. return self._tree[name]
  1678. else:
  1679. return None
  1680. def __setitem__(self, name: str, value: Union[None, dict]) -> None:
  1681. self._tree[name] = value
  1682. def __iter__(self) -> Iterator[str]:
  1683. if self._tree is not None:
  1684. return iter(self._tree.keys())
  1685. else:
  1686. return iter([])
  1687. def __repr__(self) -> str:
  1688. return '<DirectoryTree: {}>'.format(self._tree)
  1689. def __bool__(self) -> bool:
  1690. return bool(self._tree)
  1691. class DirectoryProcessor:
  1692. '''Класс обработчика директорий шаблонов.'''
  1693. def __init__(self, action: str,
  1694. datavars_module: Union[Datavars, Variables] = Variables(),
  1695. install: Union[str, PackageAtomName] = '',
  1696. output_module: IOModule = IOModule(),
  1697. dbpkg: bool = True, pkg_autosave: bool = True,
  1698. namespace: Optional[NamespaceNode] = None, **groups: dict):
  1699. if isinstance(action, list):
  1700. self.action = action
  1701. else:
  1702. self.action = [action]
  1703. self.output: IOModule = output_module
  1704. self.datavars_module: Variables = datavars_module
  1705. self._namespace: NamespaceNode = namespace
  1706. self._pkg_autosave: bool = pkg_autosave
  1707. # Корневая директория.
  1708. self.cl_chroot_path: str
  1709. if 'cl_chroot_path' in datavars_module.main:
  1710. self.cl_chroot_path = datavars_module.main.cl_chroot_path
  1711. else:
  1712. self.cl_chroot_path = '/'
  1713. # Корневой путь шаблонов.
  1714. self.templates_root: str
  1715. if 'cl_root_path' in datavars_module.main:
  1716. self.templates_root = join_paths(self.cl_chroot_path,
  1717. datavars_module.main.cl_root_path)
  1718. else:
  1719. self.templates_root = self.cl_chroot_path
  1720. self.cl_ignore_files: List[str] = self._get_cl_ignore_files()
  1721. # Путь к файлу config с хэш-суммами файлов, для которых уже
  1722. # предлагались изменения.
  1723. self.cl_config_path: str
  1724. if 'cl_config_path' in datavars_module.main:
  1725. self.cl_config_path = self._add_chroot_path(
  1726. self.datavars_module.main.cl_config_path)
  1727. else:
  1728. self.cl_config_path = self._add_chroot_path(
  1729. '/var/lib/calculate/config')
  1730. # Путь к директории config-archive для хранения оригинальной ветки
  1731. # конфигурационных файлов.
  1732. self.cl_config_archive: str
  1733. if 'cl_config_archive' in datavars_module.main:
  1734. self.cl_config_archive = self._add_chroot_path(
  1735. self.datavars_module.main.cl_config_archive)
  1736. else:
  1737. self.cl_config_archive = self._add_chroot_path(
  1738. '/var/lib/calculate/config-archive')
  1739. # Путь к директории .execute для хранения хранения файлов скриптов,
  1740. # полученных из шаблонов с параметром exec.
  1741. self.cl_exec_dir_path: str
  1742. if 'cl_exec_dir_path' in datavars_module.main:
  1743. self.cl_exec_dir_path = self._add_chroot_path(
  1744. self.datavars_module.main.cl_exec_dir_path)
  1745. else:
  1746. self.cl_exec_dir_path = self._add_chroot_path(
  1747. '/var/lib/calculate/.execute/')
  1748. # Инициализируем исполнительный модуль.
  1749. self.template_executor: TemplateExecutor = TemplateExecutor(
  1750. datavars_module=self.datavars_module,
  1751. chroot_path=self.cl_chroot_path,
  1752. cl_config_archive=self.cl_config_archive,
  1753. cl_config_path=self.cl_config_path,
  1754. execute_archive_path=self.cl_exec_dir_path,
  1755. dbpkg=dbpkg,
  1756. pkg_autosave=self._pkg_autosave)
  1757. # Разбираем atom имена пакетов, указанных для групп пакетов.
  1758. if groups:
  1759. for group_name, package_name in groups.items():
  1760. if isinstance(package_name, list):
  1761. for atom in package_name:
  1762. self._add_package_to_group(group_name, atom)
  1763. else:
  1764. self._add_package_to_group(group_name, package_name)
  1765. # Создаем переменную для указания текущих шаблонов, если ее еще нет.
  1766. self._make_current_template_var()
  1767. # Инициализируем шаблонизатор.
  1768. self.template_engine: TemplateEngine = TemplateEngine(
  1769. datavars_module=self.datavars_module,
  1770. chroot_path=self.cl_chroot_path,
  1771. appends_set=self.template_executor.available_appends)
  1772. # Разбираем atom имя пакета, для которого накладываем шаблоны.
  1773. self.for_package: Union[PackageAtomName, None] = None
  1774. if install:
  1775. if isinstance(install, PackageAtomName):
  1776. self.for_package = install
  1777. elif isinstance(install, str):
  1778. try:
  1779. self.for_package = self.template_engine.\
  1780. parameters_processor.check_postparse_package(
  1781. install)
  1782. except ConditionFailed as error:
  1783. # ConditionFailed потому что для проверки значения пакета,
  1784. # используется тот же метод, что проверяет параметр package
  1785. # в шаблонах, а в них этот параметр играет роль условия.
  1786. self.output.set_error(str(error))
  1787. return
  1788. self.template_engine.for_package = self.for_package
  1789. # Получаем список директорий шаблонов.
  1790. # TODO переменная список.
  1791. self.template_paths: List[str]
  1792. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  1793. var_type = self.datavars_module.main[
  1794. 'cl_template_path'].variable_type
  1795. else:
  1796. var_type = StringType
  1797. if var_type is StringType:
  1798. self.template_paths = (self.datavars_module.
  1799. main.cl_template_path.split(','))
  1800. elif var_type is ListType:
  1801. self.template_paths = self.datavars_module.main.cl_template_path
  1802. # Список обработанных пакетов.
  1803. self.processed_packages = set()
  1804. # Список пакетов, взятый из значений параметра merge.
  1805. self.packages_to_merge = set()
  1806. # Словарь для хранения деревьев директорий для различных пакетов.
  1807. self.packages_file_trees = OrderedDict()
  1808. # Список обработчиков.
  1809. self._handlers: Dict[tuple] = {}
  1810. self._handlers_queue: List[str] = []
  1811. self._handling: Union[str, None] = None
  1812. def _get_cl_ignore_files(self) -> List[str]:
  1813. '''Метод для получения из соответствующей переменной списка паттернов
  1814. для обнаружения игнорируемых в ходе обработки шаблонов файлов.'''
  1815. if 'cl_ignore_files' in self.datavars_module.main:
  1816. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  1817. var_type = self.datavars_module.main[
  1818. 'cl_ignore_files'].variable_type
  1819. else:
  1820. var_type = StringType
  1821. cl_ignore_files = self.datavars_module.main.cl_ignore_files
  1822. cl_ignore_files_list = []
  1823. if var_type is StringType:
  1824. for pattern in cl_ignore_files.split(','):
  1825. cl_ignore_files_list.append(pattern.strip())
  1826. elif var_type is ListType:
  1827. cl_ignore_files_list = cl_ignore_files
  1828. return cl_ignore_files_list
  1829. else:
  1830. return []
  1831. def _add_chroot_path(self, path_to_add: str) -> str:
  1832. '''Метод для добавления корневого пути к заданному пути, если таковой
  1833. задан и отсутствует в заданном пути.'''
  1834. if (self.cl_chroot_path != '/' and
  1835. not path_to_add.startswith(self.cl_chroot_path)):
  1836. return join_paths(self.cl_chroot_path, path_to_add)
  1837. else:
  1838. return path_to_add
  1839. def _add_package_to_group(self, group_name: str,
  1840. package_atom: str) -> None:
  1841. try:
  1842. groups_namespace = self.datavars_module.main.cl.groups
  1843. except (VariableNotFoundError, AttributeError):
  1844. namespaces = ['cl', 'groups']
  1845. groups_namespace = self.datavars_module.main
  1846. for namespace in namespaces:
  1847. if namespace in groups_namespace:
  1848. groups_namespace = groups_namespace[namespace]
  1849. else:
  1850. if isinstance(groups_namespace, NamespaceNode):
  1851. groups_namespace = NamespaceNode(
  1852. namespace,
  1853. parent=groups_namespace)
  1854. else:
  1855. groups_namespace[namespace] = Variables()
  1856. groups_namespace = groups_namespace[namespace]
  1857. atom_dict = PackageAtomParser.parse_atom_name(package_atom)
  1858. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  1859. if group_name not in groups_namespace:
  1860. VariableNode(group_name, groups_namespace,
  1861. variable_type=TableType,
  1862. source=[atom_dict])
  1863. else:
  1864. group_var = groups_namespace[group_name]
  1865. group_table = group_var.get_value().get_table()
  1866. check_result = self.check_existance_in_group(atom_dict,
  1867. group_table)
  1868. if check_result == -2:
  1869. group_table.append(atom_dict)
  1870. elif check_result >= 0:
  1871. group_table[check_result] = atom_dict
  1872. if check_result != -1:
  1873. group_var.source = group_table
  1874. else:
  1875. if group_name not in groups_namespace:
  1876. groups_namespace[group_name] = [atom_dict]
  1877. else:
  1878. group_table = groups_namespace[group_name]
  1879. check_result = self.check_existance_in_group(atom_dict,
  1880. group_table)
  1881. if check_result == -2:
  1882. group_table.append(atom_dict)
  1883. elif check_result >= 0:
  1884. group_table[check_result] = atom_dict
  1885. if check_result != -1:
  1886. groups_namespace[group_name] = group_table
  1887. def check_existance_in_group(self, atom_dict: dict, group: list) -> bool:
  1888. '''Метод для проверки наличия в таблице групп указанного пакета, а
  1889. также для сравнения данных о пакете из таблицы и из атом словаря.
  1890. Возвращает:
  1891. -2 -- если пакета нет;
  1892. -1 -- если присутствует и полностью совпадает;
  1893. >=0 -- если имеющиеся в таблице данные о пакете должены быть заменены
  1894. на указанные. В этом случае возвращается индекс старых данных в
  1895. таблице. '''
  1896. index = 0
  1897. for group_atom in group:
  1898. if (atom_dict['category'] != group_atom['category'] and
  1899. atom_dict['name'] != group_atom['name']):
  1900. index += 1
  1901. continue
  1902. if (atom_dict['slot'] is not None and
  1903. group_atom['slot'] is not None):
  1904. if atom_dict['slot'] != group_atom['slot']:
  1905. return -2
  1906. if atom_dict['version'] is not None:
  1907. if (group_atom['version'] is None or
  1908. atom_dict['version'] != group_atom['version']):
  1909. return index
  1910. return -1
  1911. return -2
  1912. def _make_current_template_var(self) -> None:
  1913. var_path = ['main', 'cl']
  1914. namespace = self.datavars_module
  1915. for field in var_path:
  1916. if field not in namespace:
  1917. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  1918. namespace = NamespaceNode(field, parent=namespace)
  1919. else:
  1920. namespace[field] = Variables()
  1921. namespace = namespace[field]
  1922. else:
  1923. namespace = namespace[field]
  1924. if 'current_template' not in namespace:
  1925. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  1926. VariableNode('current_template', namespace,
  1927. variable_type=StringType, source="")
  1928. else:
  1929. namespace['current_template'] = ""
  1930. def process_template_directories(self) -> None:
  1931. '''Метод для обхода шаблонов, содержащихся в каталогах из
  1932. main.cl_template.path.'''
  1933. # Режим заполнения очередей директорий пакетов, необходимых для более
  1934. # быстрой обработки параметра merge.
  1935. self.fill_trees = bool(self.for_package)
  1936. if self.for_package:
  1937. if self.for_package is NonePackage:
  1938. package = self.for_package
  1939. else:
  1940. package = Package(self.for_package,
  1941. chroot_path=self.cl_chroot_path,
  1942. autosave=self._pkg_autosave)
  1943. else:
  1944. package = None
  1945. self.base_directory: str
  1946. for directory_path in self.template_paths:
  1947. self.base_directory = directory_path.strip()
  1948. entries = os.scandir(self.base_directory)
  1949. files: list = []
  1950. directories: list = []
  1951. for node in entries:
  1952. if node.is_file():
  1953. if (node.name != ".calculate_directory" and
  1954. self._check_file_name(node.name)):
  1955. files.append(node.name)
  1956. elif node.is_dir():
  1957. directories.append(node.path)
  1958. self.directory_tree = {}
  1959. self._run_template_from_base_directory(
  1960. files, self.base_directory,
  1961. package=package,
  1962. directory_tree=self.directory_tree)
  1963. for directory_path in directories:
  1964. self.directory_tree = {}
  1965. parameters = ParametersContainer()
  1966. if self._namespace:
  1967. parameters.set_inheritable({'env': {self._namespace}})
  1968. self._walk_directory_tree(directory_path,
  1969. self.templates_root,
  1970. parameters,
  1971. directory_tree=self.directory_tree,
  1972. package=package)
  1973. # Теперь когда дерево заполнено, можно выключить этот режим.
  1974. self.fill_trees = False
  1975. if self.for_package:
  1976. self.output.set_info('Processing packages from merge parameter...')
  1977. self.processed_packages.add(self.for_package)
  1978. self._merge_packages()
  1979. if self._handlers_queue:
  1980. self._execute_handlers()
  1981. if self.template_executor.execute_files:
  1982. self._run_exec_files()
  1983. self.template_executor.save_changes()
  1984. PackageCreator.save_all()
  1985. return self.template_executor.changed_files
  1986. def _run_template_from_base_directory(self, template_names: List[str],
  1987. base_directory: str,
  1988. package: Optional[Package] = None,
  1989. directory_tree: Optional[dict] = None
  1990. ) -> None:
  1991. '''Метод для запуска шаблонов файлов находящихся в базовой директории.
  1992. '''
  1993. self.template_engine.change_directory(base_directory)
  1994. for template_name in template_names:
  1995. template_path = join_paths(base_directory, template_name)
  1996. target_path = join_paths(self.templates_root, template_name)
  1997. parameters = ParametersContainer()
  1998. if self._namespace:
  1999. parameters.set_inheritable({'env': {self._namespace}})
  2000. template_text = self._parse_template(parameters,
  2001. template_name,
  2002. FILE, base_directory)
  2003. if template_text is False:
  2004. continue
  2005. if not self._check_package_and_action(
  2006. parameters,
  2007. template_path,
  2008. directory_tree=directory_tree):
  2009. if parameters.handler:
  2010. # Если директория шаблонов является обработчиком --
  2011. # добавляем ее в словарь обработчиков и пропускаем ее.
  2012. self._handlers.update({parameters.handler:
  2013. (FILE, template_path)})
  2014. self._update_package_tree(parameters.package,
  2015. directory_tree)
  2016. continue
  2017. # Если есть параметр merge добавляем его содержимое в список
  2018. # пакетов для последующей обработки.
  2019. if self.for_package and parameters.merge:
  2020. for pkg in parameters.merge:
  2021. if pkg not in self.processed_packages:
  2022. self.packages_to_merge.add(pkg)
  2023. # Если присутствует параметр notify, в котором указаны хэндлеры для
  2024. # последующего выполнения -- добавляем их в очередь.
  2025. if parameters.notify:
  2026. for handler_id in parameters.notify:
  2027. if handler_id not in self._handlers_queue:
  2028. self._handlers_queue.append(handler_id)
  2029. # Корректируем путь к целевому файлу.
  2030. target_path = self._make_target_path(target_path,
  2031. template_name,
  2032. parameters)
  2033. if parameters.package:
  2034. template_package = Package(parameters.package,
  2035. chroot_path=self.cl_chroot_path,
  2036. autosave=self._pkg_autosave)
  2037. else:
  2038. template_package = package
  2039. # Дефолтные значения разные для упрощения написания шаблонов.
  2040. if not parameters.run and not parameters.exec:
  2041. if not parameters.format:
  2042. parameters.set_parameter({'format': 'raw'})
  2043. if not parameters.append:
  2044. if parameters.format == "raw":
  2045. parameters.set_parameter({'append': 'replace'})
  2046. else:
  2047. parameters.set_parameter({'append': 'join'})
  2048. if parameters.append != 'skip':
  2049. # Выполняем действия, указанные в шаблоне.
  2050. self._execute_template(target_path, parameters,
  2051. FILE, template_path,
  2052. template_text=template_text,
  2053. package=template_package)
  2054. def _execute_handlers(self) -> None:
  2055. '''Метод для запуска обработчиков добавленных в очередь обработчиков
  2056. с помощью параметра notify.'''
  2057. self.output.set_info('Processing handlers...')
  2058. index = 0
  2059. while index < len(self._handlers_queue):
  2060. handler = self._handlers_queue[index]
  2061. index += 1
  2062. if handler in self._handlers:
  2063. handler_type, handler_path = self._handlers[handler]
  2064. else:
  2065. self.output.set_warning(
  2066. f"Handler '{handler}' is not found.")
  2067. continue
  2068. with self._start_handling(handler):
  2069. if handler_type is DIR:
  2070. self.directory_tree = {}
  2071. parameters = ParametersContainer()
  2072. if self._namespace:
  2073. parameters.set_inheritable({'env': {self._namespace}})
  2074. self._walk_directory_tree(
  2075. handler_path,
  2076. self.templates_root,
  2077. parameters,
  2078. directory_tree=self.directory_tree)
  2079. elif handler_type is FILE:
  2080. handler_dir, handler_name = os.path.split(handler_path)
  2081. self.template_engine.change_directory(handler_dir)
  2082. parameters = ParametersContainer()
  2083. if self._namespace:
  2084. parameters.set_inheritable({'env': {self._namespace}})
  2085. handler_text = self._parse_template(parameters,
  2086. handler_name,
  2087. FILE, handler_dir)
  2088. if handler_text is False:
  2089. continue
  2090. if parameters.notify:
  2091. for handler_id in parameters.notify:
  2092. if handler_id not in self._handlers_queue:
  2093. self._handlers_queue.append(handler_id)
  2094. # Корректируем путь к целевому файлу.
  2095. target_file_path = self._make_target_path(
  2096. self.templates_root,
  2097. handler_name,
  2098. parameters)
  2099. if not parameters.run and not parameters.exec:
  2100. if not parameters.format:
  2101. parameters.set_parameter({'format': 'raw'})
  2102. if not parameters.append:
  2103. if parameters.format == "raw":
  2104. parameters.set_parameter({'append': 'replace'})
  2105. else:
  2106. parameters.set_parameter({'append': 'join'})
  2107. # Выполняем действия, указанные в обработчике.
  2108. self._execute_template(target_file_path, parameters,
  2109. FILE, handler_path,
  2110. template_text=handler_text)
  2111. def _merge_packages(self) -> None:
  2112. '''Метод для выполнения шаблонов относящихся к пакетам, указанным во
  2113. всех встреченных значениях параметра merge.'''
  2114. not_merged_packages = []
  2115. self.for_package = None
  2116. while self.packages_to_merge:
  2117. if self.for_package is None:
  2118. # Если список найденных пакетов пройден, но пакеты для
  2119. # настройки еще есть -- заново проходимся по списку.
  2120. for package in self.packages_to_merge.difference(
  2121. self.packages_file_trees):
  2122. self.output.set_warning(
  2123. ("Warning: package '{0}' not found for"
  2124. " action{1} '{2}'.").format(
  2125. str(package),
  2126. 's' if len(self.action) > 1 else '',
  2127. ', '.join(self.action)))
  2128. self.packages_to_merge.remove(package)
  2129. if not self.packages_to_merge:
  2130. break
  2131. founded_packages = iter(self.packages_file_trees.keys())
  2132. self.for_package = next(founded_packages, None)
  2133. if (self.for_package is None
  2134. or self.for_package not in self.packages_to_merge):
  2135. continue
  2136. self.template_engine.for_package = self.for_package
  2137. if self.for_package not in self.packages_file_trees:
  2138. self.output.set_error(
  2139. "Error: package '{0}' not found for action{1} '{2}'.".
  2140. format(self.for_package,
  2141. 's' if len(self.action) > 1 else '',
  2142. ', '.join(self.action)))
  2143. not_merged_packages.append(self.for_package)
  2144. continue
  2145. package = Package(self.for_package,
  2146. chroot_path=self.cl_chroot_path,
  2147. autosave=self._pkg_autosave)
  2148. for directory_name in self.packages_file_trees[self.for_package]:
  2149. directory_tree = self.packages_file_trees[self.for_package].\
  2150. get_directory_tree(directory_name)
  2151. parameters = ParametersContainer()
  2152. if self._namespace:
  2153. parameters.set_inheritable({'env': {self._namespace}})
  2154. self._walk_directory_tree(directory_tree.base_directory,
  2155. self.templates_root,
  2156. parameters,
  2157. directory_tree=directory_tree,
  2158. package=package)
  2159. self.processed_packages.add(self.for_package)
  2160. self.packages_to_merge.remove(self.for_package)
  2161. if not_merged_packages:
  2162. self.output.set_error('Packages {} is not merged.'.
  2163. format(','.join(not_merged_packages)))
  2164. else:
  2165. self.output.set_success('All packages are merged.')
  2166. def _run_exec_files(self) -> None:
  2167. '''Метод для выполнения скриптов, полученных в результате обработки
  2168. шаблонов с параметром exec.'''
  2169. for exec_file_path, exec_info in\
  2170. self.template_executor.execute_files.items():
  2171. try:
  2172. output = self.template_executor.execute_file(
  2173. exec_info['interpreter'],
  2174. exec_file_path,
  2175. exec_info['cwd_path'])
  2176. if output['stdout'] is not None:
  2177. self.output.set_info("stdout from template: {}:\n{}\n".
  2178. format(exec_info['template_path'],
  2179. output['stdout']))
  2180. if output['stderr'] is not None:
  2181. self.output.set_error("stderr from template: {}:\n{}\n".
  2182. format(exec_info['template_path'],
  2183. output['stderr']))
  2184. except TemplateExecutorError as error:
  2185. self.output.set_error(str(error))
  2186. def _walk_directory_tree(self, current_directory_path: str,
  2187. current_target_path: str,
  2188. directory_parameters: ParametersContainer,
  2189. directory_tree: Union[dict, DirectoryTree] = {},
  2190. package: Optional[Package] = None) -> None:
  2191. '''Метод для рекурсивного обхода директорий с шаблонами, а также, при
  2192. необходимости, заполнения деревьев директорий шаблонов, с помощью
  2193. которых далее выполняются шаблоны пакетов из merge.'''
  2194. directory_name = os.path.basename(current_directory_path)
  2195. # Если включено заполнение дерева создаем пустой словарь для сбора
  2196. # содержимого текущей директории.
  2197. if self.fill_trees:
  2198. directory_tree[directory_name] = {}
  2199. self.template_engine.change_directory(current_directory_path)
  2200. template_directories, template_files = self._scan_directory(
  2201. current_directory_path)
  2202. template_files = sorted(template_files)
  2203. # обрабатываем в первую очередь шаблон директории.
  2204. if '.calculate_directory' in template_files:
  2205. template_files.remove('.calculate_directory')
  2206. template_text = self._parse_template(directory_parameters,
  2207. '.calculate_directory',
  2208. DIR, current_directory_path)
  2209. if template_text is False:
  2210. directory_tree = {}
  2211. return
  2212. # directory_parameters.print_parameters_for_debug()
  2213. # Корректируем путь к целевой директории.
  2214. current_target_path = self._make_target_path(current_target_path,
  2215. directory_name,
  2216. directory_parameters)
  2217. # Если нужно заполнять дерево директорий, отправляем в метод для
  2218. # проверки параметров package и action текущее дерево.
  2219. if (self._handling is None
  2220. and not self._check_package_and_action(
  2221. directory_parameters,
  2222. current_directory_path,
  2223. directory_tree=(directory_tree if
  2224. self.fill_trees else None))):
  2225. if directory_parameters.handler:
  2226. # Если директория шаблонов является обработчиком и параметр
  2227. # handler -- не унаследован, что свидетельствует о том,
  2228. # что директория не расположена внутри другой
  2229. # директории-обработчика добавляем ее в словарь
  2230. # обработчиков и пропускаем ее.
  2231. self._handlers.update({directory_parameters.handler:
  2232. (DIR, current_directory_path)})
  2233. if self.fill_trees:
  2234. directory_tree = {}
  2235. elif self.fill_trees:
  2236. # Если проверка не пройдена и включено заполнение дерева,
  2237. # то, используя нынешнее состояние дерева директорий,
  2238. # обновляем дерево пакета текущего шаблона директории.
  2239. self._update_package_tree(directory_parameters.package,
  2240. directory_tree[directory_name])
  2241. # Перед выходом из директории очищаем текущий уровень
  2242. # дерева.
  2243. directory_tree = {}
  2244. return
  2245. # Хэндлеры, вложенные в другие хэндлеры не разрешены.
  2246. if self._handling is not None and directory_parameters.handler:
  2247. if directory_parameters.handler != self._handling:
  2248. self.output.set_error("'handler' parameter is not"
  2249. " available in other handler"
  2250. f" '{self._handling}'")
  2251. return
  2252. # Если есть параметр merge -- сохраняем присутствующие в нем пакеты
  2253. # для последующей обработки.
  2254. if self.for_package and directory_parameters.merge:
  2255. for pkg in directory_parameters.merge:
  2256. if pkg not in self.processed_packages:
  2257. self.packages_to_merge.add(pkg)
  2258. # Если присутствует параметр notify, в котором указаны хэндлеры для
  2259. # последующего выполнения -- добавляем их в очередь.
  2260. if directory_parameters.notify:
  2261. for handler_id in directory_parameters.notify:
  2262. if handler_id not in self._handlers_queue:
  2263. self._handlers_queue.append(handler_id)
  2264. # Если присутствует параметр package -- проверяем, изменился ли он
  2265. # и был ли задан до этого. Если не был задан или изменился, меняем
  2266. # текущий пакет ветки шаблонов на этот.
  2267. if directory_parameters.package:
  2268. if (package is None or
  2269. package.package_name != directory_parameters.package):
  2270. package = Package(directory_parameters.package,
  2271. chroot_path=self.cl_chroot_path,
  2272. autosave=self._pkg_autosave)
  2273. else:
  2274. # Если .calculate_directory отсутствует -- создаем директорию,
  2275. # используя унаследованные параметры и имя самой директории.
  2276. # Для того чтобы директория была создана, просто добавляем параметр
  2277. # append = join.
  2278. template_text = ''
  2279. current_target_path = os.path.join(current_target_path,
  2280. directory_name)
  2281. # Для директорий по умолчанию append = join.
  2282. if not directory_parameters.append:
  2283. directory_parameters.set_parameter({'append': 'join'})
  2284. # Выполняем наложение шаблона.
  2285. current_target_path = self._execute_template(
  2286. current_target_path,
  2287. directory_parameters, DIR,
  2288. current_directory_path,
  2289. template_text=template_text,
  2290. package=package)
  2291. if not current_target_path:
  2292. directory_tree = {}
  2293. return
  2294. # Далее обрабатываем файлы шаблонов хранящихся в директории.
  2295. # Если в данный момент обходим дерево -- берем список файлов и
  2296. # директорий из него.
  2297. if not self.fill_trees and directory_tree:
  2298. template_directories, template_files =\
  2299. self._get_files_and_dirs_from_tree(template_files,
  2300. template_directories,
  2301. directory_tree)
  2302. # Просто псевдоним, чтобы меньше путаницы было далее.
  2303. template_parameters = directory_parameters
  2304. # Обрабатываем файлы шаблонов.
  2305. for template_name in template_files:
  2306. # Удаляем все параметры, которые не наследуются и используем
  2307. # полученный контейнер для сбора параметров файлов шаблонов.
  2308. template_parameters.remove_not_inheritable()
  2309. template_path = os.path.join(current_directory_path,
  2310. template_name)
  2311. # Обрабатываем файл шаблона шаблонизатором.
  2312. template_text = self._parse_template(template_parameters,
  2313. template_name,
  2314. FILE, current_directory_path)
  2315. if template_text is False:
  2316. continue
  2317. # template_parameters.print_parameters_for_debug()
  2318. # Если находимся на стадии заполнения дерева директорий --
  2319. # проверяем параметры package и action с заполнением дерева.
  2320. if (self._handling is None
  2321. and not self._check_package_and_action(
  2322. template_parameters,
  2323. template_path,
  2324. directory_tree=(directory_tree[directory_name] if
  2325. self.fill_trees else None))):
  2326. if template_parameters.handler:
  2327. # Если директория шаблонов является обработчиком --
  2328. # добавляем ее в словарь обработчиков и пропускаем ее.
  2329. self._handlers.update({template_parameters.handler:
  2330. (FILE, template_path)})
  2331. # * * * ПРИДУМАТЬ ОПТИМИЗАЦИЮ * * *
  2332. # TODO Потому что накладывать дерево каждый раз, когда
  2333. # обнаружены файлы какого-то пакета не рационально.
  2334. # Обновляем дерево директорий для данного пакета, если
  2335. # происходит его заполнение.
  2336. if self.fill_trees:
  2337. self._update_package_tree(template_parameters.package,
  2338. directory_tree[directory_name])
  2339. directory_tree[directory_name] = {}
  2340. continue
  2341. if self._handling is not None and template_parameters.handler:
  2342. if template_parameters.handler != self._handling:
  2343. self.output.set_error("'handler' parameter is not"
  2344. " available in other handler"
  2345. f" '{self._handling}'")
  2346. continue
  2347. # Если есть параметр merge добавляем его содержимое в список
  2348. # пакетов для последующей обработки.
  2349. if self.for_package and template_parameters.merge:
  2350. for pkg in template_parameters.merge:
  2351. if pkg not in self.processed_packages:
  2352. self.packages_to_merge.add(pkg)
  2353. # Если присутствует параметр notify, в котором указаны хэндлеры для
  2354. # последующего выполнения -- добавляем их в очередь.
  2355. if template_parameters.notify:
  2356. for handler_id in template_parameters.notify:
  2357. if handler_id not in self._handlers_queue:
  2358. self._handlers_queue.append(handler_id)
  2359. # Корректируем путь к целевому файлу.
  2360. target_file_path = self._make_target_path(current_target_path,
  2361. template_name,
  2362. template_parameters)
  2363. # Создаем объект пакета для файлов шаблонов этой директории.
  2364. template_package = package
  2365. if template_parameters.package:
  2366. if (template_package is None or
  2367. package.package_name != template_parameters.package):
  2368. template_package = Package(template_parameters.package,
  2369. chroot_path=self.cl_chroot_path,
  2370. autosave=self._pkg_autosave)
  2371. if not template_parameters.run and not template_parameters.exec:
  2372. if not template_parameters.format:
  2373. template_parameters.set_parameter({'format': 'raw'})
  2374. if not template_parameters.append:
  2375. if template_parameters.format == "raw":
  2376. template_parameters.set_parameter(
  2377. {'append': 'replace'})
  2378. else:
  2379. template_parameters.set_parameter({'append': 'join'})
  2380. if template_parameters.append != 'skip':
  2381. # Выполняем действия, указанные в шаблоне.
  2382. target_file_path = self._execute_template(
  2383. target_file_path,
  2384. template_parameters,
  2385. FILE, template_path,
  2386. template_text=template_text,
  2387. package=template_package)
  2388. if not target_file_path:
  2389. continue
  2390. # Проходимся далее по директориям.
  2391. for directory in template_directories:
  2392. if self.fill_trees:
  2393. self._walk_directory_tree(
  2394. directory, current_target_path,
  2395. directory_parameters.get_inheritables(),
  2396. directory_tree=directory_tree[directory_name],
  2397. package=package)
  2398. directory_tree[directory_name] = {}
  2399. else:
  2400. if isinstance(directory, DirectoryTree):
  2401. # Если директории взяты из дерева -- путь к директории
  2402. # соответствует корню каждой взятой ветви дерева.
  2403. directory_path = directory.base_directory
  2404. else:
  2405. directory_path = directory
  2406. self._walk_directory_tree(
  2407. directory_path, current_target_path,
  2408. directory_parameters.get_inheritables(),
  2409. package=package)
  2410. if self.fill_trees:
  2411. directory_tree = {}
  2412. def _scan_directory(self, directory_path: str
  2413. ) -> Tuple[List[str], List[str]]:
  2414. '''Метод для получения и фильтрования списка файлов и директорий,
  2415. содержащихся в директории шаблонов.'''
  2416. template_files = []
  2417. template_directories = []
  2418. entries = os.scandir(directory_path)
  2419. for node in entries:
  2420. if not self._check_file_name(node.name):
  2421. continue
  2422. if node.is_symlink():
  2423. self.output.set_warning(
  2424. 'symlink: {0} is ignored in the template directory: {1}'.
  2425. format(node.path, directory_path))
  2426. continue
  2427. elif node.is_dir():
  2428. template_directories.append(node.path)
  2429. elif node.is_file():
  2430. template_files.append(node.name)
  2431. return template_directories, template_files
  2432. def _check_file_name(self, filename: str) -> bool:
  2433. '''Метод для проверки соответствия имени файла содержимому переменной
  2434. main.cl_ignore_files.'''
  2435. for pattern in self.cl_ignore_files:
  2436. if fnmatch.fnmatch(filename, pattern):
  2437. return False
  2438. return True
  2439. def _get_files_and_dirs_from_tree(self, template_files: List[str],
  2440. template_directories: List[str],
  2441. directory_tree: DirectoryTree
  2442. ) -> Tuple[List[str],
  2443. List[DirectoryTree]]:
  2444. '''Метод для получения списков файлов и директорий из дерева
  2445. директорий.'''
  2446. tree_files = []
  2447. tree_directories = []
  2448. for template in directory_tree:
  2449. if template in template_files:
  2450. tree_files.append(template)
  2451. else:
  2452. next_directory_tree =\
  2453. directory_tree.get_directory_tree(template)
  2454. tree_directories.append(next_directory_tree)
  2455. return tree_directories, tree_files
  2456. def _make_target_path(self, target_path: str, template_name: str,
  2457. parameters: ParametersContainer) -> str:
  2458. '''Метод для получения пути к целевому файлу с учетом наличия
  2459. параметров name, path и append = skip.'''
  2460. # Если есть непустой параметр name -- меняем имя шаблона.
  2461. if parameters.name is not False and parameters.name != '':
  2462. template_name = parameters.name
  2463. # Если для шаблона задан путь -- меняем путь к директории шаблона.
  2464. if parameters.path:
  2465. target_path = join_paths(self.templates_root,
  2466. parameters.path)
  2467. # Если параметр append не равен skip -- добавляем имя шаблона к
  2468. # целевому пути.
  2469. if not parameters.append == 'skip':
  2470. target_path = os.path.join(target_path,
  2471. template_name)
  2472. return target_path
  2473. def _parse_template(self, parameters: ParametersContainer,
  2474. template_name: str,
  2475. template_type: int,
  2476. template_directory: str) -> Union[str, bool]:
  2477. '''Метод для разбора шаблонов, получения значений их параметров и их
  2478. текста после отработки шаблонизитора.'''
  2479. if template_type == DIR:
  2480. template_path = template_directory
  2481. else:
  2482. template_path = join_paths(template_directory, template_name)
  2483. if isinstance(self.datavars_module, (Datavars, NamespaceNode)):
  2484. self.datavars_module.main.cl['current_template'].set(template_path)
  2485. else:
  2486. self.datavars_module.main.cl['current_template'] = template_path
  2487. try:
  2488. self.template_engine.process_template(template_name,
  2489. template_type,
  2490. parameters=parameters)
  2491. return self.template_engine.template_text
  2492. except ConditionFailed as error:
  2493. self.output.set_warning('{0}. Template: {1}'.
  2494. format(str(error),
  2495. template_path))
  2496. return False
  2497. except Exception as error:
  2498. self.output.set_error('Template error: {0}. Template: {1}'.
  2499. format(str(error),
  2500. template_path))
  2501. return False
  2502. def _execute_template(self, target_path: str,
  2503. parameters: ParametersContainer,
  2504. template_type: int,
  2505. template_path: str,
  2506. template_text: str = '',
  2507. package: Optional[Package] = None
  2508. ) -> Union[bool, str]:
  2509. '''Метод для наложения шаблонов и обработки информации полученной после
  2510. наложения.'''
  2511. try:
  2512. output = self.template_executor.execute_template(
  2513. target_path,
  2514. parameters,
  2515. template_type,
  2516. template_path,
  2517. template_text=template_text,
  2518. target_package=package)
  2519. # Если во время выполнения шаблона был изменен целевой путь,
  2520. # например, из-за ссылки на директорию в source -- обновляем
  2521. # целевой путь.
  2522. if output['target_path'] is not None:
  2523. target_path = output['target_path']
  2524. if output['warnings']:
  2525. if not isinstance(output['warnings'], list):
  2526. output['warnings'] = [output['warnings']]
  2527. for warning in output['warnings']:
  2528. self.output.set_warning(f"{warning}."
  2529. f" Template: {template_path}")
  2530. # Если есть вывод от параметра run -- выводим как info.
  2531. if output['stdout'] is not None:
  2532. self.output.set_info("stdout from template: {}:\n{}\n".format(
  2533. template_path,
  2534. output['stdout']))
  2535. # Если есть ошибки от параметра run -- выводим их как error.
  2536. if output['stderr'] is not None:
  2537. self.output.set_error("stderr from template: {}:\n{}\n".
  2538. format(template_path,
  2539. output['stderr']))
  2540. # Если run выполнен с ошибками -- пропускаем директорию.
  2541. return False
  2542. except TemplateExecutorError as error:
  2543. self.output.set_error('Template execution error: {}. Template: {}'.
  2544. format(str(error),
  2545. template_path))
  2546. return False
  2547. except FormatError as error:
  2548. if error.executable:
  2549. msg = 'Format execution error: {}. Template: {}'
  2550. else:
  2551. msg = 'Format joining error: {}. Template: {}'
  2552. self.output.set_error(msg.format(str(error), template_path))
  2553. return False
  2554. if template_type == DIR:
  2555. self.output.set_success('Processed directory: {}'.
  2556. format(template_path))
  2557. else:
  2558. self.output.set_success('Processed template: {}'.
  2559. format(template_path))
  2560. return target_path
  2561. def _update_package_tree(self, package: Package,
  2562. current_level_tree: Union[None, dict]) -> None:
  2563. '''Метод для обновления деревьев директорий пакетов, необходимых для
  2564. обработки шаблонов пакетов из значения параметра merge.'''
  2565. # Если текущему уровню соответствует заглушка None или он содержит
  2566. # файлы, то есть не пустой -- тогда есть смысл обновлять.
  2567. if current_level_tree is None or current_level_tree:
  2568. if package in self.packages_file_trees:
  2569. # Если для данного пакета уже есть дерево --
  2570. # накладываем на него текущее.
  2571. self.packages_file_trees[package].update_tree(
  2572. copy.deepcopy(self.directory_tree)
  2573. )
  2574. else:
  2575. # Если для данного пакета еще нет дерева --
  2576. # копируем для него текущее.
  2577. directory_tree = DirectoryTree(self.base_directory)
  2578. directory_tree.update_tree(copy.deepcopy(self.directory_tree))
  2579. self.packages_file_trees[package] = directory_tree
  2580. def _check_package_and_action(self, parameters: ParametersContainer,
  2581. template_path: str,
  2582. directory_tree: Optional[dict] = None
  2583. ) -> bool:
  2584. '''Метод для проверки параметров action и package во время обработки
  2585. каталогов с шаблонами. Если среди аргументов указано также
  2586. дерево каталогов, то в случае несовпадения значений package для файла
  2587. или директории, им в дереве присваивается значение None.'''
  2588. if parameters.handler:
  2589. return False
  2590. if parameters.append != 'skip' or parameters.action:
  2591. if not parameters.action:
  2592. self.output.set_warning(
  2593. ("Action parameter is not set for template:"
  2594. " {0}").format(template_path))
  2595. return False
  2596. elif parameters.action.startswith('!'):
  2597. action_matching = (parameters.action[1:].strip() not in
  2598. self.action)
  2599. elif parameters.action not in self.action:
  2600. action_matching = False
  2601. else:
  2602. action_matching = True
  2603. if not action_matching:
  2604. self.output.set_warning(
  2605. ("Action parameter value '{0}' does not match its"
  2606. " current value{1} '{2}'. Template: {3}").format(
  2607. parameters.action,
  2608. 's' if len(self.action) > 1
  2609. else '',
  2610. ', '.join(self.action),
  2611. template_path))
  2612. return False
  2613. if self.for_package:
  2614. # if not parameters.package:
  2615. # if self.for_package is not NonePackage:
  2616. # self.output.set_warning(
  2617. # "'package' parameter is not defined. Template: {}".
  2618. # format(template_path))
  2619. if parameters.package != self.for_package:
  2620. if directory_tree is not None:
  2621. # Если есть дерево, которое собирается для текущих шаблонов
  2622. # и параметр package шаблона не совпадает с текущим,
  2623. # ставим заглушку, в качестве которой используется None.
  2624. template_name = os.path.basename(template_path)
  2625. directory_tree[template_name] = None
  2626. self.output.set_warning(
  2627. ("'package' parameter value '{0}' does not "
  2628. "match its current target package '{1}'. "
  2629. "Template: {2}").
  2630. format(parameters.package.atom,
  2631. self.for_package.atom,
  2632. template_path)
  2633. )
  2634. return False
  2635. return True
  2636. @contextmanager
  2637. def _start_handling(self, handler_id: str):
  2638. '''Метод для перевода обработчика каталогов в режим обработки
  2639. хэндлеров.'''
  2640. try:
  2641. self._handling = handler_id
  2642. yield self
  2643. finally:
  2644. self._handling = None
  2645. @contextmanager
  2646. def _set_current_package(self, package: Package):
  2647. '''Метод для указания в шаблонизаторе пакета, для которого в данный
  2648. момент проводим настройку. Пока не используется.'''
  2649. try:
  2650. last_package = self.template_engine.for_package
  2651. self.template_engine.for_package = package
  2652. yield self
  2653. finally:
  2654. self.template_engine.for_package = last_package