You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1783 lines
78 KiB

  1. # vim: fileencoding=utf-8
  2. #
  3. from jinja2.ext import Extension
  4. from jinja2.lexer import Token
  5. from jinja2.parser import Parser
  6. from jinja2 import (
  7. Environment,
  8. FileSystemLoader,
  9. TemplateSyntaxError,
  10. nodes,
  11. contextfunction,
  12. Template,
  13. )
  14. from jinja2.utils import missing
  15. from jinja2.runtime import Context, Undefined
  16. from collections.abc import MutableMapping
  17. from collections import OrderedDict
  18. from importlib import import_module
  19. from pprint import pprint
  20. import copy
  21. import re
  22. import os
  23. import stat
  24. from typing import (
  25. Union,
  26. Any,
  27. List,
  28. Tuple,
  29. NoReturn,
  30. Optional,
  31. Iterator,
  32. )
  33. from ..utils.package import (
  34. PackageAtomName,
  35. PackageAtomParser,
  36. PackageAtomError,
  37. Package,
  38. NOTEXIST,
  39. Version
  40. )
  41. from ..utils.files import (
  42. join_paths,
  43. check_directory_link,
  44. check_command,
  45. FilesError
  46. )
  47. from calculate.variables.datavars import (
  48. VariableNotFoundError,
  49. HashType,
  50. NamespaceNode,
  51. VariableNode,
  52. IniType,
  53. IntegerType,
  54. FloatType,
  55. ListType
  56. )
  57. from calculate.utils.fs import readFile
  58. from calculate.variables.loader import Datavars
  59. import calculate.templates.template_filters as template_filters
  60. # Типы шаблона: директория или файл.
  61. DIR, FILE, LINK = range(3)
  62. # Словарь, в котором можно регистрировать фильтры.
  63. CALCULATE_FILTERS = {"cut": template_filters.cut}
  64. class IncorrectParameter(Exception):
  65. pass
  66. class DefaultParameterError(Exception):
  67. pass
  68. class SaveError(Exception):
  69. pass
  70. class ConditionFailed(TemplateSyntaxError):
  71. pass
  72. class Variables(MutableMapping):
  73. '''Класс-заглушка вместо модуля переменных для тестов.'''
  74. def __init__(self, *args, **kwargs):
  75. self.__attrs: dict = dict(*args, **kwargs)
  76. self.__iter: Union[Iterator, None] = None
  77. def __next__(self) -> Any:
  78. if self._iter is None:
  79. self._iter = iter(self.__attrs)
  80. return next(self._iter)
  81. def __getattribute__(self, name: str) -> Any:
  82. if name == '_Variables__attrs':
  83. return super().__getattribute__(name)
  84. if name == 'available_packages':
  85. return super().__getattribute__(name)
  86. if name == '_variables':
  87. return self.__attrs
  88. if name == '_iter':
  89. return self._iter
  90. try:
  91. return self.__attrs[name]
  92. except KeyError:
  93. raise AttributeError(name)
  94. @property
  95. def available_packages(self) -> set:
  96. packages = set(self.__attrs.keys())
  97. packages.update({'custom'})
  98. return packages
  99. def __getitem__(self, name: str) -> Any:
  100. return self.__attrs[name]
  101. def __setitem__(self, name: str, value: Any) -> NoReturn:
  102. self.__attrs[name] = value
  103. def __delitem__(self, name: str) -> NoReturn:
  104. del self.__attrs[name]
  105. def __iter__(self) -> Iterator:
  106. return iter(self.__attrs)
  107. def __len__(self) -> int:
  108. return len(self.__attrs)
  109. def __repr__(self) -> str:
  110. return '<Variables {}>'.format(self.__attrs)
  111. def __contains__(self, name: str) -> bool:
  112. return name in self.__attrs
  113. def __hash__(self) -> int:
  114. return hash(id(self))
  115. class ParametersProcessor:
  116. '''Класс для проверки и разбора параметров шаблона.'''
  117. available_parameters: set = {'name', 'path', 'append', 'chmod', 'chown',
  118. 'autoupdate', 'env', 'force', 'source',
  119. 'format', 'unbound', 'mirror', 'run', 'exec',
  120. 'env', 'package', 'merge', 'postmerge',
  121. 'action', 'rebuild', 'restart', 'stop',
  122. 'start', 'handler', 'notify', 'group',
  123. 'convert', 'stretch'}
  124. inheritable_parameters: set = {'chmod', 'chown', 'autoupdate', 'env',
  125. 'package', 'action', 'handler', 'group'}
  126. # Параметры по умолчанию для файлов --
  127. # будут заполняться из __datavars__
  128. file_default_parameters: dict = {}
  129. # Параметры по умолчанию для директорий --
  130. # будут заполняться из __datavars__
  131. directory_default_parameters: dict = {}
  132. available_appends: set = set()
  133. available_formats: dict = dict()
  134. format_is_inspected: bool = False
  135. chmod_value_regular = re.compile(
  136. r'([r-][w-][Xx-])([r-][w-][Xx-])([r-][w-][Xx-])')
  137. def __init__(self,
  138. parameters_container: Optional["ParametersContainer"] = None,
  139. chroot_path: str = '/',
  140. datavars_module: Union[Datavars,
  141. NamespaceNode,
  142. Variables] = Variables(),
  143. for_package: Optional[Package] = None):
  144. self.chroot_path: str = chroot_path
  145. self.template_type: int = DIR
  146. self.datavars_module: Union[Datavars,
  147. NamespaceNode,
  148. Variables] = datavars_module
  149. self._parameters_container: ParametersContainer = parameters_container
  150. self.package_atom_parser: PackageAtomParser = PackageAtomParser(
  151. chroot_path=chroot_path)
  152. self._groups: dict = {}
  153. try:
  154. groups = list(datavars_module.main.cl.groups._variables.keys())
  155. for group in groups:
  156. if isinstance(datavars_module, (Datavars, NamespaceNode)):
  157. packages = datavars_module.main.cl.groups[group].get_value(
  158. ).get_table()
  159. else:
  160. packages = datavars_module.main.cl.groups[group]
  161. self._groups.update({group: packages})
  162. except Exception:
  163. pass
  164. self._inspect_formats_package()
  165. self._for_package: Union[Package, None] = for_package
  166. # Если добавляемый параметр нуждается в проверке -- добавляем сюда
  167. # метод для проверки.
  168. self.checkers_list = OrderedDict({
  169. 'package': self.check_package_parameter,
  170. 'group': self.check_group_parameter,
  171. 'append': self.check_append_parameter,
  172. 'rebuild': self.check_rebuild_parameter,
  173. 'restart': self.check_restart_parameter,
  174. 'run': self.check_run_parameter,
  175. 'exec': self.check_exec_parameter,
  176. 'stop': self.check_stop_parameter,
  177. 'start': self.check_start_parameter,
  178. 'chown': self.check_chown_parameter,
  179. 'chmod': self.check_chmod_parameter,
  180. 'autoupdate': self.check_autoupdate_parameter,
  181. 'source': self.check_source_parameter,
  182. 'force': self.check_force_parameter,
  183. 'env': self.check_env_parameter,
  184. 'merge': self.check_merge_parameter,
  185. 'format': self.check_format_parameter,
  186. 'handler': self.check_handler_parameter,
  187. 'notify': self.check_notify_parameter,
  188. 'convert': self.check_convert_parameter,
  189. 'stretch': self.check_stretch_parameter,
  190. })
  191. # Если добавляемый параметр должен быть проверен после того, как
  192. # будет закончен парсинг всех других параметров -- добавляем сюда метод
  193. # для проверки.
  194. self.postparse_checkers_list = OrderedDict({
  195. 'package': self.check_postparse_package,
  196. 'append': self.check_postparse_append,
  197. 'source': self.check_postparse_source,
  198. 'autoupdate': self.check_postparse_autoupdate,
  199. 'run': self.check_postparse_run,
  200. 'exec': self.check_postparse_exec,
  201. 'handler': self.check_postparse_handler,
  202. 'convert': self.check_postparse_convert,
  203. 'stretch': self.check_postparse_stretch,
  204. })
  205. # Если параметр является наследуемым только при некоторых условиях --
  206. # указываем здесь эти условия.
  207. self.inherit_conditions = {'chmod': self.is_chmod_inheritable}
  208. def set_parameters_container(self,
  209. parameters_container: "ParametersContainer"
  210. ) -> NoReturn:
  211. '''Метод для установки текущего контейнера параметров.'''
  212. self._parameters_container = parameters_container
  213. self._added_parameters = set()
  214. @property
  215. def for_package(self) -> Union[Package, None]:
  216. return self._for_package
  217. @for_package.setter
  218. def for_package(self, package: Package) -> NoReturn:
  219. self._for_package = package
  220. def __getattr__(self, parameter_name: str) -> Any:
  221. if parameter_name not in self.available_parameters:
  222. raise IncorrectParameter("Unknown parameter: '{}'".
  223. format(parameter_name))
  224. elif parameter_name not in self._parameters_container:
  225. return False
  226. else:
  227. return self._parameters_container[parameter_name]
  228. def check_template_parameter(self, parameter_name: str,
  229. parameter_value: Any,
  230. template_type: int, lineno: int) -> NoReturn:
  231. '''Метод, проверяющий указанный параметр.'''
  232. self.lineno = lineno
  233. self.template_type = template_type
  234. if parameter_name not in self.available_parameters:
  235. raise IncorrectParameter("Unknown parameter '{0}'".
  236. format(parameter_name))
  237. elif parameter_name in self.checkers_list:
  238. checked_value = self.checkers_list[parameter_name](parameter_value)
  239. else:
  240. checked_value = parameter_value
  241. # Способ пропустить параметр, если он корректен, но добавлять не нужно
  242. if checked_value is None:
  243. return
  244. self._added_parameters.add(parameter_name)
  245. if (parameter_name in self.inheritable_parameters and
  246. self.template_type == DIR):
  247. if parameter_name in self.inherit_conditions:
  248. if self.inherit_conditions[parameter_name](
  249. parameter_value):
  250. self._parameters_container.set_inheritable(
  251. {parameter_name: checked_value})
  252. return
  253. else:
  254. self._parameters_container.set_inheritable(
  255. {parameter_name: checked_value})
  256. return
  257. self._parameters_container.set_parameter({parameter_name:
  258. checked_value})
  259. def check_postparse_parameters(self) -> NoReturn:
  260. '''Метод, запускающий проверку параметров после их разбора.'''
  261. for parameter, parameter_checker in\
  262. self.postparse_checkers_list.items():
  263. if parameter not in self._added_parameters:
  264. continue
  265. parameter_value = self._parameters_container[parameter]
  266. result = parameter_checker(parameter_value)
  267. if result is not None:
  268. self._parameters_container.change_parameter(parameter,
  269. result)
  270. def check_template_parameters(self, parameters: dict,
  271. template_type: int, lineno: int) -> NoReturn:
  272. '''Метод, запускающий проверку указанных параметров.'''
  273. self.template_type = template_type
  274. self.lineno = lineno
  275. for parameter_name in parameters:
  276. if parameter_name not in self.available_parameters:
  277. raise IncorrectParameter("Unknown parameter '{0}'".
  278. format(parameter_name))
  279. elif parameter_name in self.checkers_list:
  280. checked_value = self.checkers_list[parameter_name](
  281. parameters[parameter_name]
  282. )
  283. else:
  284. checked_value = parameters[parameter_name]
  285. if (template_type == DIR and
  286. parameter_name in self.inheritable_parameters):
  287. if parameter_name in self.inherit_conditions:
  288. if self.inherit_conditions[parameter_name](
  289. parameters[parameter_name]):
  290. self._parameters_container.set_inheritable(
  291. parameter_name=checked_value)
  292. continue
  293. else:
  294. self._parameters_container.set_inheritable(
  295. parameter_name=checked_value)
  296. continue
  297. self._parameters_container.set_parameter(
  298. parameter_name=checked_value)
  299. # Методы для проверки параметров во время разбора шаблона.
  300. def check_package_parameter(self, parameter_value: Any) -> str:
  301. if not isinstance(parameter_value, str):
  302. raise IncorrectParameter("'package' parameter must have value of"
  303. " the 'str' type, not"
  304. f" {type(parameter_value)}")
  305. return parameter_value
  306. def check_group_parameter(self, parameter_value: Any) -> List[str]:
  307. if isinstance(parameter_value, str):
  308. result = [group.strip() for group in parameter_value.split(',')]
  309. elif isinstance(parameter_value, (list, tuple)):
  310. result = parameter_value if isinstance(parameter_value, list) else\
  311. list(parameter_value)
  312. else:
  313. raise IncorrectParameter("'package' parameter must have value of"
  314. " the 'str', 'list' or 'tuple' type, not"
  315. f" {type(parameter_value)}")
  316. for group in result:
  317. if group != "install" and group not in self._groups:
  318. raise IncorrectParameter(f"'group' parameter value '{group}'"
  319. " is not available. Available values:"
  320. f" {', '.join(self._groups.keys())}")
  321. return result
  322. def check_append_parameter(self, parameter_value: Any) -> str:
  323. if parameter_value not in self.available_appends:
  324. raise IncorrectParameter("Unacceptable value '{}' of parameter"
  325. " 'append'".format(parameter_value))
  326. return parameter_value
  327. def check_merge_parameter(self, parameter_value: Any
  328. ) -> List[PackageAtomName]:
  329. packages_list = []
  330. packages_names = parameter_value.split(',')
  331. for package_name in packages_names:
  332. package_name = package_name.strip()
  333. try:
  334. atom_object = self.package_atom_parser.\
  335. parse_package_parameter(package_name)
  336. packages_list.append(atom_object)
  337. except PackageAtomError:
  338. continue
  339. return packages_list
  340. def check_rebuild_parameter(self, parameter_value: Any) -> bool:
  341. if not isinstance(parameter_value, bool):
  342. raise IncorrectParameter("'rebuild' parameter value is not bool")
  343. elif 'package' not in self._parameters_container:
  344. raise IncorrectParameter(("'rebuild' parameter is set without "
  345. "'package' parameter"))
  346. return parameter_value
  347. def check_restart_parameter(self, parameter_value: Any) -> str:
  348. if parameter_value and isinstance(parameter_value, str):
  349. return parameter_value
  350. else:
  351. raise IncorrectParameter(
  352. "'restart' parameter value is not correct")
  353. def check_stop_parameter(self, parameter_value: Any) -> str:
  354. if not parameter_value and isinstance(parameter_value, bool):
  355. raise IncorrectParameter("'stop' parameter value is empty")
  356. return parameter_value
  357. def check_start_parameter(self, parameter_value: Any) -> str:
  358. if not parameter_value and isinstance(parameter_value, bool):
  359. raise IncorrectParameter("'start' parameter value is empty")
  360. return parameter_value
  361. def check_run_parameter(self, parameter_value: Any) -> str:
  362. if self.template_type == DIR:
  363. raise IncorrectParameter("'run' parameter is not available in"
  364. " directory templates")
  365. if not parameter_value and isinstance(parameter_value, bool):
  366. raise IncorrectParameter("'run' parameter value is empty")
  367. try:
  368. interpreter_path = check_command(parameter_value)
  369. except FilesError:
  370. raise IncorrectParameter("interpreter from 'run' parameter not"
  371. " found")
  372. return interpreter_path
  373. def check_exec_parameter(self, parameter_value: Any) -> str:
  374. if self.template_type == DIR:
  375. raise IncorrectParameter("'exec' parameter is not available in"
  376. " directory templates")
  377. if not parameter_value and isinstance(parameter_value, bool):
  378. raise IncorrectParameter("'exec' parameter value is empty")
  379. try:
  380. interpreter_path = check_command(parameter_value)
  381. except FilesError:
  382. raise IncorrectParameter("interpreter from 'exec' parameter is not"
  383. " found")
  384. return interpreter_path
  385. def check_chown_parameter(self, parameter_value: Any) -> dict:
  386. if not parameter_value or isinstance(parameter_value, bool):
  387. raise IncorrectParameter("'chown' parameter value is empty.")
  388. parameter_value = self.get_chown_values(parameter_value)
  389. return parameter_value
  390. def check_chmod_parameter(self, parameter_value: Any) -> Union[int, tuple]:
  391. result = self.chmod_value_regular.search(parameter_value)
  392. if result:
  393. return self._translate_symbol_chmod(result)
  394. elif parameter_value.isdigit():
  395. parameter_value = int(parameter_value, 8)
  396. return parameter_value
  397. else:
  398. raise IncorrectParameter("'chmod' parameter value is not correct")
  399. def _translate_symbol_chmod(self, result) -> Tuple[int, int]:
  400. '''Метод для перевода буквенного значения chmod в числовое.
  401. Возвращает кортеж (chmod, x_mask):
  402. chmod -- число, полученное из последовательности битов, где
  403. "r", "w" и "x" -> 1, "-" и "X" -> 0;
  404. x_mask -- маска, полученная из последовательности битов, где
  405. "X" -> 1, "r", "w", "-" и "x" -> 0. Она необходима для получения
  406. значения chmod для файлов.'''
  407. chmod = ''
  408. x_mask = ''
  409. for group_index in range(3):
  410. group = result.groups()[group_index]
  411. for sym_index in range(3):
  412. if group[sym_index] in {'-', 'X'}:
  413. chmod = chmod + '0'
  414. else:
  415. chmod = chmod + '1'
  416. if group[sym_index] == 'X':
  417. x_mask = x_mask + "1"
  418. else:
  419. x_mask = x_mask + "0"
  420. return (int(chmod, 2), int(x_mask, 2))
  421. def check_source_parameter(self, parameter_value: Any
  422. ) -> Union[str, Tuple[bool, str]]:
  423. if not parameter_value or isinstance(parameter_value, bool):
  424. raise IncorrectParameter("'source' parameter value is empty")
  425. if self.chroot_path != '/':
  426. real_path = join_paths(self.chroot_path, parameter_value)
  427. else:
  428. real_path = parameter_value
  429. # Ставим True, чтобы потом проверить этот параметр в postparse
  430. if not os.path.exists(real_path):
  431. return (False, real_path)
  432. source_file_type = DIR if os.path.isdir(real_path) else FILE
  433. # Проверяем, совпадают ли типы шаблона и файла, указанного в source
  434. if (self.template_type != source_file_type):
  435. raise IncorrectParameter(
  436. "the type of the 'source' file does not match"
  437. " the type of the template file")
  438. # Проверяем, не является ли файл из source зацикленной ссылкой.
  439. if (source_file_type == DIR and os.path.islink(real_path)):
  440. try:
  441. check_directory_link(real_path, chroot_path=self.chroot_path)
  442. except FilesError as error:
  443. raise IncorrectParameter(
  444. "the link from 'source' is not correct: {}".
  445. format(str(error)))
  446. return os.path.normpath(real_path)
  447. def check_env_parameter(self, parameter_value: Any) -> Union[None, set]:
  448. env_set = set()
  449. for env_value in parameter_value.split(','):
  450. env_value = env_value.strip()
  451. name_parts = env_value.split('.')
  452. namespace = self.datavars_module
  453. for name in name_parts:
  454. if name not in namespace:
  455. raise ConditionFailed(
  456. (f"Namespace '{env_value}' from 'env' parameter"
  457. " does not exist."),
  458. self.lineno)
  459. namespace = namespace[name]
  460. env_set.add(namespace)
  461. CalculateContext._env_set.add(namespace)
  462. # Если шаблон файла -- не добавляем env в контейнер,
  463. # а только используем для рендеринга шаблона.
  464. if self.template_type is None:
  465. return None
  466. if self._parameters_container.env:
  467. env_set.union(self._parameters_container.env)
  468. return env_set
  469. def check_force_parameter(self, parameter_value: Any) -> bool:
  470. if isinstance(parameter_value, bool):
  471. return parameter_value
  472. else:
  473. raise IncorrectParameter("'force' parameter value is not bool")
  474. def check_autoupdate_parameter(self, parameter_value: Any) -> bool:
  475. if isinstance(parameter_value, bool):
  476. return parameter_value
  477. else:
  478. raise IncorrectParameter(
  479. "'autoupdate' parameter value is not bool.")
  480. def check_format_parameter(self, parameter_value: Any) -> str:
  481. if self.template_type == DIR:
  482. raise IncorrectParameter("'format' parameter is redundant for"
  483. " directory templates.")
  484. if isinstance(parameter_value, str):
  485. if parameter_value not in self.available_formats:
  486. raise IncorrectParameter(f"'{parameter_value}' value of the"
  487. " 'format' parameter is not"
  488. " available.")
  489. return parameter_value
  490. raise IncorrectParameter("'format' parameter must be string value not"
  491. f" {type(parameter_value)}.")
  492. def check_handler_parameter(self, parameter_value: Any) -> str:
  493. if not isinstance(parameter_value, str):
  494. raise IncorrectParameter("'handler' parameter must be string"
  495. f" value not {type(parameter_value)}.")
  496. return parameter_value
  497. def check_notify_parameter(self, parameter_value: Any) -> List[str]:
  498. if isinstance(parameter_value, list):
  499. return parameter_value
  500. elif isinstance(parameter_value, str):
  501. return [parameter.strip() for parameter in
  502. parameter_value.split(',')]
  503. raise IncorrectParameter("'notify' parameter must be string or list"
  504. f" value not {type(parameter_value)}.")
  505. def check_convert_parameter(self, parameter_value: Any) -> str:
  506. if not isinstance(parameter_value, str):
  507. raise IncorrectParameter("'convert' parameter value must be string"
  508. f" not '{type(parameter_value)}'.")
  509. parameter_value = parameter_value.strip().upper()
  510. try:
  511. available_image_formats =\
  512. self.datavars_module.main.cl_image_formats
  513. except VariableNotFoundError:
  514. # TODO возможно стоит кидать ошибку.
  515. available_image_formats = ["JPEG", "PNG", "GIF", "JPG"]
  516. if parameter_value not in available_image_formats:
  517. raise IncorrectParameter(f"'{parameter_value}' image format is "
  518. "not available. Available image formats: "
  519. f"'{', '.join(available_image_formats)}.'"
  520. )
  521. return parameter_value
  522. def check_stretch_parameter(self, parameter_value: Any) -> bool:
  523. if not isinstance(parameter_value, bool):
  524. raise IncorrectParameter("'stretch' parameter value should be bool"
  525. f" value not '{type(parameter_value)}'")
  526. return parameter_value
  527. # Методы для проверки параметров после разбора всего шаблона.
  528. def check_postparse_append(self, parameter_value: str) -> NoReturn:
  529. if parameter_value == 'link':
  530. if 'source' not in self._parameters_container:
  531. raise IncorrectParameter("append = 'link' without source "
  532. "parameter.")
  533. if self._parameters_container.run:
  534. raise IncorrectParameter("'append' parameter is not 'compatible' "
  535. "with the 'run' parameter")
  536. if self._parameters_container.exec:
  537. raise IncorrectParameter("'append' parameter is not 'compatible' "
  538. "with the 'exec' parameter")
  539. def check_postparse_run(self, parameter_value: str) -> NoReturn:
  540. if self._parameters_container.append:
  541. raise IncorrectParameter("'run' parameter is not 'compatible' "
  542. "with the 'append' parameter")
  543. if self._parameters_container.exec:
  544. raise IncorrectParameter("'run' parameter is not 'compatible' "
  545. "with the 'exec' parameter")
  546. def check_postparse_exec(self, parameter_value: str) -> NoReturn:
  547. if self._parameters_container.append:
  548. raise IncorrectParameter("'exec' parameter is not 'compatible' "
  549. "with the 'append' parameter")
  550. if self._parameters_container.run:
  551. raise IncorrectParameter("'exec' parameter is not 'compatible' "
  552. "with the 'run' parameter")
  553. def check_postparse_source(self,
  554. parameter_value: Union[str, Tuple[bool, str]]
  555. ) -> NoReturn:
  556. # Если файл по пути source не существует, но присутствует параметр
  557. # mirror -- пропускаем шаблон для того, чтобы целевой файл мог быть
  558. # удален в исполнительном модуле.
  559. if isinstance(parameter_value, tuple):
  560. if ((self._parameters_container.append == "link" and
  561. self._parameters_container.force)
  562. or self._parameters_container.format == "backgrounds"):
  563. self._parameters_container['source'] = parameter_value[1]
  564. elif not self._parameters_container.mirror:
  565. raise IncorrectParameter(
  566. "File from 'source' parameter does not exist")
  567. elif (self.template_type == DIR and
  568. ('append' not in self._parameters_container or
  569. self._parameters_container['append'] != 'link')):
  570. raise IncorrectParameter(
  571. ("'source' parameter is set without "
  572. "append = 'link' for directory template")
  573. )
  574. def check_postparse_autoupdate(self, parameter_value: bool) -> NoReturn:
  575. if self._parameters_container.unbound:
  576. raise IncorrectParameter("'unbound' parameter is incompatible"
  577. " with 'autoupdate' parameter")
  578. def check_postparse_handler(self, parameter_value: bool) -> NoReturn:
  579. if self._parameters_container.merge:
  580. raise IncorrectParameter("'merge' parameter is not available"
  581. " in handler templates")
  582. elif (self._parameters_container.package and
  583. not self._parameters_container.is_inherited('package')):
  584. raise IncorrectParameter("'package' parameter is not available"
  585. " in handler templates")
  586. def check_postparse_package(self, parameter_value: str) -> NoReturn:
  587. groups = []
  588. package_atom = PackageAtomParser.parse_atom_name(parameter_value)
  589. if (self._parameters_container is None
  590. or not self._parameters_container.group):
  591. # Если параметр group не задан или метод используется для проверки
  592. # отдельного параметра package -- делаем только проверку install.
  593. # Предполагающую проверку существования пакета.
  594. groups.append('install')
  595. else:
  596. groups = self._parameters_container.group
  597. for group in groups:
  598. if group == 'install':
  599. try:
  600. result = self.package_atom_parser.parse_package_parameter(
  601. package_atom)
  602. return result
  603. except PackageAtomError as error:
  604. if error.errno != NOTEXIST:
  605. raise IncorrectParameter(error.message)
  606. elif self._check_package_group(package_atom,
  607. self._groups[group]):
  608. if (self._parameters_container is not None
  609. and self._parameters_container.package):
  610. self._parameters_container.remove_parameter('package')
  611. return
  612. raise ConditionFailed(f"package '{parameter_value}'"
  613. " does not match the template condition",
  614. self.lineno if hasattr(self, 'lineno') else 0)
  615. def _check_package_group(self, package: dict, group_packages: list
  616. ) -> bool:
  617. '''Метод для проверки соответствия описания пакета, заданного словарем,
  618. какому-либо описанию пакета, заданного в переменных groups.'''
  619. for group_package in group_packages:
  620. for parameter in ['category', 'name', 'version', 'slot']:
  621. if package[parameter] is not None:
  622. if (group_package[parameter] is None
  623. or group_package[parameter] != package[parameter]):
  624. break
  625. else:
  626. if package['use_flags'] is not None:
  627. if group_package['use_flags'] is None:
  628. continue
  629. else:
  630. for use_flag in package['use_flags']:
  631. if use_flag not in group_package['use_flags']:
  632. continue
  633. return True
  634. return False
  635. def check_postparse_convert(self, parameter_value: str) -> NoReturn:
  636. template_format = self._parameters_container.format
  637. if not template_format or template_format != "backgrounds":
  638. raise IncorrectParameter("'convert' parameter available for"
  639. " 'backgrounds' format only.")
  640. def check_postparse_stretch(self, parameter_value: str) -> NoReturn:
  641. template_format = self._parameters_container.format
  642. if not template_format or template_format != "backgrounds":
  643. raise IncorrectParameter("'stretch' parameter available for"
  644. " 'backgrounds' format only.")
  645. # Методы для проверки того, являются ли параметры наследуемыми.
  646. def is_chmod_inheritable(self, parameter_value: str) -> bool:
  647. chmod_regex = re.compile(r'\d+')
  648. if chmod_regex.search(parameter_value):
  649. return False
  650. return True
  651. def get_chown_values(self, chown: str) -> dict:
  652. """Получить значения uid и gid из параметра chown."""
  653. if chown and ':' in chown:
  654. user_name, group_name = chown.split(':')
  655. if user_name.isdigit():
  656. uid = int(user_name)
  657. else:
  658. import pwd
  659. try:
  660. if self.chroot_path == '/':
  661. uid = pwd.getpwnam(user_name).pw_uid
  662. else:
  663. uid = self.get_uid_from_passwd(user_name)
  664. except (FilesError, KeyError, TypeError) as error:
  665. raise IncorrectParameter(
  666. "'chown = {}' parameter check is failed: {}".
  667. format(chown, str(error)))
  668. if group_name.isdigit():
  669. gid = int(group_name)
  670. else:
  671. import grp
  672. try:
  673. if self.chroot_path == '/':
  674. gid = grp.getgrnam(group_name).gr_gid
  675. else:
  676. gid = self.get_gid_from_group(group_name)
  677. except (FilesError, KeyError, TypeError) as error:
  678. raise IncorrectParameter(
  679. "'chown = {}' parameter check is failed: {}".
  680. format(chown, str(error)))
  681. return {'uid': uid, 'gid': gid}
  682. else:
  683. raise IncorrectParameter("'chown' value '{0}' is not correct".
  684. format(chown))
  685. def get_uid_from_passwd(self, user_name: str) -> int:
  686. """Функция для получения uid из chroot passwd файла."""
  687. passwd_file_path = os.path.join(self.chroot_path, 'etc/passwd')
  688. passwd_dictionary = dict()
  689. if os.path.exists(passwd_file_path):
  690. with open(passwd_file_path, 'r') as passwd_file:
  691. for line in passwd_file:
  692. if line.startswith('#'):
  693. continue
  694. passwd_item = tuple(line.split(':')[0:3:2])
  695. if (len(passwd_item) > 1 and passwd_item[0]):
  696. passwd_dictionary[passwd_item[0]] = passwd_item[1]
  697. if user_name in passwd_dictionary:
  698. return int(passwd_dictionary[user_name])
  699. else:
  700. raise FilesError("'{0}' uid was not found in {1}".
  701. format(user_name, passwd_file_path))
  702. else:
  703. raise FilesError("passwd file was not found in {}".
  704. format(passwd_file_path))
  705. def get_gid_from_group(self, group_name: str) -> int:
  706. """Функция для получения gid из chroot group файла."""
  707. group_file_path = os.path.join(self.chroot_path, 'etc/group')
  708. group_dictionary = dict()
  709. if os.path.exists(group_file_path):
  710. with open(group_file_path, 'r') as group_file:
  711. for line in group_file:
  712. if line.startswith('#'):
  713. continue
  714. group_item = tuple(line.split(':')[0:3:2])
  715. if len(group_item) > 1 and group_item[0] and group_item[1]:
  716. group_dictionary[group_item[0]] = group_item[1]
  717. if group_name in group_dictionary:
  718. return int(group_dictionary[group_name])
  719. else:
  720. raise FilesError("'{0}' gid was not found in {1}".
  721. format(group_name, group_file_path))
  722. else:
  723. raise FilesError("group file was not found in {}".
  724. format(group_file_path))
  725. @classmethod
  726. def _inspect_formats_package(cls) -> NoReturn:
  727. '''Метод для определения множества доступных форматов и
  728. предоставляемых ими параметров.'''
  729. if cls.format_is_inspected:
  730. return
  731. parameters_set = set()
  732. available_formats = dict()
  733. format_directory_path = os.path.join(os.path.dirname(__file__),
  734. 'format')
  735. for module_name in os.listdir(format_directory_path):
  736. if (os.path.isdir(os.path.join(format_directory_path,
  737. module_name)) or
  738. module_name == '__init__.py'):
  739. continue
  740. if module_name.endswith('.py'):
  741. module_name = module_name[:-3]
  742. try:
  743. module = import_module('calculate.templates.format.{}'.
  744. format(module_name))
  745. for obj in dir(module):
  746. if obj.endswith('Format') and obj != 'BaseFormat':
  747. format_class = getattr(module, obj, False)
  748. if format_class:
  749. format_name = getattr(format_class,
  750. 'FORMAT', False)
  751. if not format_name:
  752. continue
  753. available_formats.update(
  754. {format_name: format_class})
  755. format_parameters = getattr(format_class,
  756. 'FORMAT_PARAMETERS',
  757. set())
  758. parameters_set.update(format_parameters)
  759. except Exception:
  760. continue
  761. cls.available_formats = available_formats
  762. cls.available_parameters.update(parameters_set)
  763. cls.formats_inspected = True
  764. def resolve_or_missing(context: "CalculateContext",
  765. key: str, missing=missing,
  766. env: Optional[set] = None) -> Any:
  767. '''Переопределение функции из для поиска значений переменных из jinja2.
  768. Ищет переменные в datavars.'''
  769. if env is None:
  770. env = {}
  771. datavars = context.parent['__datavars__']
  772. if key in context.vars:
  773. return context.vars[key]
  774. if key in context.parent:
  775. return context.parent[key]
  776. if key in datavars:
  777. return datavars[key]
  778. for namespace in env:
  779. if key in namespace:
  780. return namespace[key]
  781. return missing
  782. class CalculateContext(Context):
  783. '''Класс контекста позволяющий использовать значения datavars и
  784. сохранять их.'''
  785. _env_set = set()
  786. def resolve(self, key: str) -> Any:
  787. if self._legacy_resolve_mode:
  788. rv = resolve_or_missing(self, key,
  789. env=self._env_set)
  790. else:
  791. rv = self.resolve_or_missing(key)
  792. if rv is missing:
  793. return self.environment.undefined(name=key)
  794. return rv
  795. def resolve_or_missing(self, key: str) -> Any:
  796. if self._legacy_resolve_mode:
  797. rv = self.resolve(key)
  798. if isinstance(rv, Undefined):
  799. rv = missing
  800. return rv
  801. return resolve_or_missing(self, key,
  802. env=self._env_set)
  803. class ParametersContainer(MutableMapping):
  804. '''Класс для хранения параметров, взятых из шаблона, и передачи
  805. их шаблонизатору.'''
  806. def __init__(self, parameters_dictionary: Optional[dict] = None):
  807. # Слой ненаследуемых параметров.
  808. self.__parameters: dict = {}
  809. # Слой наследуемых параметров.
  810. if parameters_dictionary is not None:
  811. self.__inheritable: dict = parameters_dictionary
  812. else:
  813. self.__inheritable: dict = {}
  814. def set_parameter(self, item_to_add: dict) -> NoReturn:
  815. self.__parameters.update(item_to_add)
  816. def set_inheritable(self, item_to_add: dict) -> NoReturn:
  817. self.__inheritable.update(item_to_add)
  818. def get_inheritables(self) -> "ParametersContainer":
  819. return ParametersContainer(copy.deepcopy(self.__inheritable))
  820. def remove_not_inheritable(self) -> NoReturn:
  821. self.__parameters.clear()
  822. def print_parameters_for_debug(self) -> NoReturn:
  823. print('Parameters:')
  824. pprint(self.__parameters)
  825. print('Inherited:')
  826. pprint(self.__inheritable)
  827. def is_inherited(self, parameter_name: str) -> bool:
  828. return (parameter_name not in self.__parameters
  829. and parameter_name in self.__inheritable)
  830. def remove_parameter(self, parameter_name: str) -> NoReturn:
  831. if parameter_name in self.__parameters:
  832. self.__parameters.pop(parameter_name)
  833. elif parameter_name in self.__inheritable:
  834. self.__inheritable.pop(parameter_name)
  835. def change_parameter(self, parameter: str, value: Any) -> NoReturn:
  836. if parameter in self.__parameters:
  837. self.__parameters.update({parameter: value})
  838. elif parameter in self.__inheritable:
  839. self.__inheritable.update({parameter: value})
  840. def _clear_container(self) -> NoReturn:
  841. self.__parameters.clear()
  842. self.__inheritable.clear()
  843. def __getattr__(self, parameter_name: str) -> Any:
  844. if (parameter_name not in
  845. ParametersProcessor.available_parameters):
  846. raise IncorrectParameter("Unknown parameter: '{}'".
  847. format(parameter_name))
  848. if parameter_name in self.__parameters:
  849. return self.__parameters[parameter_name]
  850. elif parameter_name in self.__inheritable:
  851. return self.__inheritable[parameter_name]
  852. else:
  853. return False
  854. def __getitem__(self, name: str) -> Any:
  855. if name in self.__parameters:
  856. return self.__parameters[name]
  857. elif name in self.__inheritable:
  858. return self.__inheritable[name]
  859. else:
  860. return False
  861. def __setitem__(self, name: str, value: Any) -> NoReturn:
  862. self.__parameters[name] = value
  863. def __delitem__(self, name: str) -> NoReturn:
  864. if name in self.__parameters:
  865. del self.__parameters[name]
  866. if name in self.__inheritable:
  867. del self.__inheritable[name]
  868. def __iter__(self) -> Iterator[str]:
  869. return iter(set(self.__parameters).union(self.__inheritable))
  870. def __len__(self) -> int:
  871. return len(set(self.__parameters).union(self.__inheritable))
  872. def __repr__(self) -> str:
  873. return '<ParametersContainer: parameters={0}, inheritables={1}>'.\
  874. format(self.__parameters, self.__inheritable)
  875. def __contains__(self, name: str) -> bool:
  876. return name in self.__parameters or name in self.__inheritable
  877. @property
  878. def parameters(self) -> dict:
  879. return self.__parameters
  880. class CalculateExtension(Extension):
  881. '''Класс расширения для jinja2, поддерживающий теги calculate-шаблонов.'''
  882. _parameters_set = set()
  883. # Виды операций в теге save.
  884. ASSIGN, APPEND, REMOVE = range(3)
  885. def __init__(self, environment: Environment,
  886. parameters_processor: ParametersProcessor,
  887. datavars_module: Union[Datavars,
  888. NamespaceNode,
  889. Variables] = Variables(),
  890. chroot_path: str = "/"):
  891. super().__init__(environment)
  892. self.environment: Environment = environment
  893. self.package_atom_parser = PackageAtomParser(chroot_path=chroot_path)
  894. self.environment.globals.update({'pkg': self.pkg})
  895. self.environment.globals.update({'grep': self.grep})
  896. self.environment.globals.update({'exists': self.exists})
  897. self._datavars = datavars_module
  898. self.parameters_processor = parameters_processor
  899. self.template_type: int = DIR
  900. # Флаг, указывающий, что тег calculate уже был разобран. Нужен для
  901. # того, чтобы проверять единственность тега calculate.
  902. self.calculate_parsed: bool = False
  903. self.tags = {'calculate', 'save', 'set_var'}
  904. self.CONDITION_TOKENS_TYPES = {'eq', 'ne', 'lt', 'gt', 'lteq', 'gteq'}
  905. self.CONDITION_NAME_TOKENS = {'not'}
  906. self.LITERAL_TOKENS_TYPES = {'string', 'integer', 'float'}
  907. if hasattr(self._datavars, 'variables_to_save'):
  908. self.TARGET_FILES_SET =\
  909. set(self._datavars.variables_to_save.keys())
  910. else:
  911. self.TARGET_FILES_SET = set()
  912. self.parse_methods = {'calculate': self.parse_calculate,
  913. 'save': self.parse_save}
  914. def __call__(self, env: Environment) -> "CalculateExtension":
  915. # Необходимо для обеспечения возможности передать готовый объект
  916. # расширения, а не его класс.
  917. return self
  918. def parse(self, parser: Parser) -> List[nodes.Output]:
  919. self.parser = parser
  920. self.stream = parser.stream
  921. tag_token = self.stream.current.value
  922. return [self.parse_methods[tag_token]()]
  923. def parse_save(self) -> nodes.Output:
  924. '''Метод для разбора тега save, сохраняющего значение указанной
  925. переменной datavars.'''
  926. lineno = next(self.stream).lineno
  927. target_file = nodes.Const('', lineno=lineno)
  928. # Получаем имя целевого файла.
  929. if self.stream.skip_if('dot'):
  930. target_file_name = self.stream.expect('name').value
  931. if target_file_name in self.TARGET_FILES_SET:
  932. target_file = nodes.Const(target_file_name)
  933. else:
  934. raise TemplateSyntaxError("Unknown target file '{}'".
  935. format(target_file_name),
  936. lineno=lineno)
  937. # получаем список из имени переменной.
  938. module_name = self.stream.expect('name').value
  939. variable_name = [nodes.Const(module_name, lineno=lineno)]
  940. while self.stream.skip_if('dot'):
  941. name = self.stream.expect('name').value
  942. variable_name.append(nodes.Const(name, lineno=lineno))
  943. variable_name = nodes.List(variable_name, lineno=lineno)
  944. if self.stream.skip_if('assign'):
  945. return self._make_save_node(variable_name,
  946. target_file,
  947. self.ASSIGN,
  948. lineno)
  949. elif self.stream.skip_if('add') and self.stream.skip_if('assign'):
  950. return self._make_save_node(variable_name,
  951. target_file,
  952. self.APPEND,
  953. lineno)
  954. elif self.stream.skip_if('sub') and self.stream.skip_if('assign'):
  955. return self._make_save_node(variable_name,
  956. target_file,
  957. self.REMOVE,
  958. lineno)
  959. raise TemplateSyntaxError("'=' is expected in 'save' tag",
  960. lineno=lineno)
  961. def parse_calculate(self) -> nodes.Output:
  962. '''Метод для разбора тега calculate, содержащего значения параметров и
  963. условия выполнения шаблона.'''
  964. lineno = next(self.stream).lineno
  965. if self.calculate_parsed:
  966. raise TemplateSyntaxError(
  967. "template can only have one calculate tag.",
  968. lineno=lineno)
  969. expect_comma_flag = False
  970. conditions = []
  971. while self.stream.current.type != 'block_end':
  972. if expect_comma_flag:
  973. self.stream.expect('comma')
  974. if (self.stream.current.type == 'name'
  975. and self.stream.current.value in self._parameters_set
  976. and self.stream.look().type != 'dot'
  977. and self.stream.look().type not in
  978. self.CONDITION_TOKENS_TYPES
  979. and self.stream.current.value not in
  980. self.CONDITION_NAME_TOKENS):
  981. # разбираем параметр.
  982. # pairs_list.append(self.get_parameter_node())
  983. name_node, value_node = self._get_parameter()
  984. check_node = self.call_method('check_parameter',
  985. [name_node,
  986. value_node,
  987. nodes.ContextReference()],
  988. lineno=lineno)
  989. check_template_node = nodes.Template(
  990. [nodes.Output([check_node])])
  991. check_template_node = check_template_node.set_environment(
  992. self.environment)
  993. check_template = self.environment.from_string(
  994. check_template_node)
  995. check_template.render(__datavars__=self._datavars)
  996. elif (self._is_variable_name(self.stream.current)
  997. or self.stream.current.type in {'lparen', 'integer',
  998. 'float', 'string'}
  999. or self.stream.current.value in self.CONDITION_NAME_TOKENS):
  1000. # разбираем условие. Если условие False -- кидаем исключение.
  1001. # condition_result = self.get_condition_result()
  1002. # if not condition_result:
  1003. # raise ConditionFailed('Condition is failed',
  1004. # lineno=self.stream.current.lineno)
  1005. conditions.append(self.parse_condition())
  1006. elif self.stream.current.type == 'name':
  1007. raise TemplateSyntaxError(
  1008. f"Unknown identifier '{self.stream.current.value}'"
  1009. " in calculate tag.",
  1010. lineno=self.stream.current.lineno)
  1011. else:
  1012. raise TemplateSyntaxError(
  1013. f"Can not parse token '{self.stream.current.value}'"
  1014. " in caluculate tag.",
  1015. lineno=self.stream.current.lineno)
  1016. expect_comma_flag = True
  1017. self.parameters_processor.check_postparse_parameters()
  1018. self.check_conditions(conditions)
  1019. self.calculate_parsed = True
  1020. return nodes.Output([nodes.Const('')], lineno=lineno)
  1021. def _is_variable_name(self, token: Token) -> bool:
  1022. '''Метод для проверки токена на предмет того, что он является частью
  1023. имени переменной.'''
  1024. if not token.type == 'name':
  1025. return False
  1026. if (token.value in self._datavars.available_packages or
  1027. token.value in self.environment.globals):
  1028. return True
  1029. for namespace in self.environment.context_class._env_set:
  1030. if token.value in namespace:
  1031. return True
  1032. return False
  1033. def check_parameter(self, parameter_name: str, parameter_value: Any,
  1034. context: CalculateContext) -> str:
  1035. self.parameters_processor.check_template_parameter(
  1036. parameter_name,
  1037. parameter_value,
  1038. self.template_type,
  1039. self.stream.current.lineno)
  1040. return ''
  1041. def parse_condition(self) -> Template:
  1042. try:
  1043. condition_node = self.parser.parse_expression(with_condexpr=True)
  1044. condition_node = self.call_method(
  1045. 'set_condition_result',
  1046. [condition_node],
  1047. lineno=self.stream.current.lineno)
  1048. condition_template = nodes.Template(
  1049. [nodes.Output([condition_node])])
  1050. condition_template = condition_template.set_environment(
  1051. self.environment)
  1052. template = self.environment.from_string(condition_template)
  1053. return template
  1054. except Exception as error:
  1055. raise ConditionFailed('Error during parsing condition:{}'
  1056. .format(str(error)),
  1057. lineno=self.stream.current.lineno)
  1058. def check_conditions(self, conditions: List[Template]) -> NoReturn:
  1059. for condition in conditions:
  1060. self.condition_result = False
  1061. try:
  1062. condition.render(__datavars__=self._datavars)
  1063. except Exception as error:
  1064. raise ConditionFailed('Error during handling condition: {}'
  1065. .format(str(error)),
  1066. lineno=self.stream.current.lineno)
  1067. if not self.condition_result:
  1068. raise ConditionFailed('Condition is failed',
  1069. lineno=self.stream.current.lineno)
  1070. # DEPRECATED
  1071. def get_condition_result(self) -> bool:
  1072. '''Метод для разбора условий из тега calculate.'''
  1073. self.condition_result = False
  1074. try:
  1075. condition_node = self.parser.parse_expression(with_condexpr=True)
  1076. condition_node = self.call_method(
  1077. 'set_condition_result',
  1078. [condition_node],
  1079. lineno=self.stream.current.lineno)
  1080. condition_template = nodes.Template(
  1081. [nodes.Output([condition_node])])
  1082. condition_template = condition_template.set_environment(
  1083. self.environment)
  1084. template = self.environment.from_string(condition_template)
  1085. template.render(__datavars__=self._datavars)
  1086. except Exception:
  1087. return False
  1088. return self.condition_result
  1089. def set_condition_result(self, condition_result: Any) -> str:
  1090. '''Метод для сохранения результата вычисления условия.'''
  1091. self.condition_result = condition_result
  1092. return ''
  1093. def _make_save_node(self, variable_name_node: nodes.List,
  1094. target_file_node: nodes.Const, optype: int,
  1095. lineno: int) -> nodes.Output:
  1096. '''Метод для создания ноды, сохраняющей переменные.'''
  1097. right_value = self.parser.parse_expression(with_condexpr=True)
  1098. optype_node = nodes.Const(optype, lineno=lineno)
  1099. save_variable_node = self.call_method('save_variable',
  1100. [variable_name_node,
  1101. right_value,
  1102. target_file_node,
  1103. optype_node,
  1104. nodes.ContextReference()],
  1105. lineno=lineno)
  1106. return nodes.Output([save_variable_node], lineno=lineno)
  1107. def save_variable(self, variable: List[str], right_value: Any,
  1108. target_file: str, optype: int,
  1109. context: CalculateContext) -> str:
  1110. '''Метод для сохранения значений переменных указанных в теге save.'''
  1111. datavars = context.parent['__datavars__']
  1112. if variable[0] not in datavars:
  1113. raise SaveError("can not save variable '{}'. The variable's"
  1114. " package '{}' is not found".format(
  1115. '.'.join(variable),
  1116. variable[0]))
  1117. modify_only = (variable[0] != 'custom')
  1118. package = datavars[variable[0]]
  1119. variable_name = variable[-1]
  1120. value_container = self._find_value_container(variable, package,
  1121. modify_only=modify_only)
  1122. # Теперь меняем знaчение переменной.
  1123. if isinstance(value_container, NamespaceNode):
  1124. self._modify_variables(variable, value_container, right_value,
  1125. optype, target_file=target_file,
  1126. modify_only=modify_only)
  1127. elif isinstance(value_container, VariableNode):
  1128. hash_value = value_container.get_value().get_hash()
  1129. if variable_name in hash_value:
  1130. if optype == self.ASSIGN:
  1131. new_value = right_value
  1132. elif optype == self.APPEND:
  1133. new_value = new_value + right_value
  1134. elif optype == self.REMOVE:
  1135. new_value = new_value - right_value
  1136. else:
  1137. new_value = right_value
  1138. hash_value.update({variable_name: new_value})
  1139. value_container.set(hash_value)
  1140. if target_file:
  1141. self._save_to_target(variable[:-1], variable_name,
  1142. new_value, target_file)
  1143. return ''
  1144. def _find_value_container(self, variable: List[str],
  1145. vars_package: NamespaceNode,
  1146. modify_only: bool = True
  1147. ) -> Union[NamespaceNode, VariableNode]:
  1148. '''Метод для поиска контейнера, путь к которому указан в аргументе.
  1149. Этим контейнером может быть пространство имен или хэш.'''
  1150. current_container = vars_package
  1151. variable_path = variable[1:-1]
  1152. for section in variable_path:
  1153. if section in current_container._namespaces:
  1154. current_container = current_container._namespaces[section]
  1155. elif (section in current_container._variables
  1156. and current_container._variables[section].variable_type
  1157. is HashType):
  1158. current_container = current_container._variables[section]
  1159. if section != variable_path[-1]:
  1160. # Если обнаружен хэш, но в пути к переменной кроме ключа
  1161. # хэша есть еще что-то далее -- значит путь к переменной
  1162. # ошибочен.
  1163. raise SaveError("can not save variable '{}'. Other"
  1164. " variable '{}' on the path".format(
  1165. '.'.join(variable),
  1166. current_container.get_fullname()))
  1167. elif not modify_only:
  1168. new_namespace = NamespaceNode(section)
  1169. current_container.add_namespace(new_namespace)
  1170. current_container = new_namespace
  1171. else:
  1172. raise SaveError("can not save variable '{}'. Namespace '{}'"
  1173. " is not found in '{}'".format(
  1174. '.'.join(variable),
  1175. section,
  1176. current_container.get_fullname()))
  1177. return current_container
  1178. def _modify_variables(self, variable: List[str], namespace: NamespaceNode,
  1179. new_value: Any, optype: int,
  1180. target_file: Optional[str] = None,
  1181. modify_only: bool = True) -> NoReturn:
  1182. '''Метод для модификации значения переменной.'''
  1183. variable_name = variable[-1]
  1184. if variable_name in namespace._variables:
  1185. variable_node = namespace[variable_name]
  1186. if optype == self.ASSIGN:
  1187. variable_node.set(new_value)
  1188. elif optype == self.APPEND:
  1189. new_value = self._append_variable_value(variable_node,
  1190. new_value)
  1191. variable_node.set(new_value)
  1192. elif optype == self.REMOVE:
  1193. new_value = self._remove_variable_value(variable_node,
  1194. new_value)
  1195. variable_node.set(new_value)
  1196. elif not modify_only:
  1197. VariableNode(variable_name, namespace,
  1198. variable_type=IniType, source=str(new_value))
  1199. else:
  1200. raise SaveError("can not create variable '{}' in not 'custom'"
  1201. " namespace".format('.'.join(variable)))
  1202. if target_file:
  1203. if namespace._variables[variable_name].variable_type is HashType:
  1204. for key, value in new_value.items():
  1205. self._save_to_target(variable, key, value, target_file)
  1206. else:
  1207. self._save_to_target(variable[:-1], variable_name,
  1208. new_value, target_file)
  1209. # DEPRECATED
  1210. def _modify_hash(self, variable_name: List[str],
  1211. hash_variable: VariableNode, new_value, optype,
  1212. target_file: Optional[str] = None) -> NoReturn:
  1213. '''Метод для модификации значения в переменной-хэше.'''
  1214. value_name = variable_name[-1]
  1215. hash_value = hash_variable.get_value().get_hash()
  1216. if value_name in hash_value:
  1217. if optype == self.APPEND:
  1218. new_value = hash_value[value_name] + new_value
  1219. elif optype == self.REMOVE:
  1220. new_value = hash_value[value_name] - new_value
  1221. hash_value.update({value_name: new_value})
  1222. hash_variable.set(hash_value)
  1223. if target_file:
  1224. self._save_to_target(variable_name[:-1], value_name,
  1225. new_value, target_file)
  1226. def _save_to_target(self, namespace_name: List[str],
  1227. variable_name: str, value: Any, target_file: str
  1228. ) -> NoReturn:
  1229. '''Метод для добавления переменной в список переменных, значение
  1230. которых было установлено через тег save и при этом должно быть
  1231. сохранено в указанном файле: save.target_file.'''
  1232. namespace_name = tuple(namespace_name)
  1233. target_file_dict = self._datavars.variables_to_save[target_file]
  1234. if namespace_name not in target_file_dict:
  1235. target_file_dict.update({namespace_name: dict()})
  1236. target_file_dict[namespace_name].update(
  1237. {variable_name: ('=', str(value))})
  1238. def _append_variable_value(self, variable: VariableNode,
  1239. value: Any) -> Any:
  1240. '''Метод описывающий операцию += в теге save.'''
  1241. variable_value = variable.get_value()
  1242. if (variable.variable_type is IntegerType or
  1243. variable.variable_type is FloatType):
  1244. variable_value += value
  1245. return variable_value
  1246. elif variable.variable_type is ListType:
  1247. if isinstance(value, str):
  1248. value = value.split(',')
  1249. if isinstance(value, list):
  1250. for item in value:
  1251. if item not in variable_value:
  1252. variable_value.append(item)
  1253. else:
  1254. variable_value.append(value)
  1255. return variable_value
  1256. elif variable.variable_type is IniType:
  1257. if not isinstance(variable_value, str):
  1258. variable_value = str(variable_value)
  1259. variable_value = variable_value.split(',')
  1260. if not isinstance(value, list):
  1261. if isinstance(value, str):
  1262. value = value.split(',')
  1263. else:
  1264. value = str(value).split(',')
  1265. for item in value:
  1266. if item not in variable_value:
  1267. variable_value.append(item)
  1268. return ','.join(variable_value)
  1269. # Пока что во всех остальных случаях будем просто возвращать исходное
  1270. # значение.
  1271. return variable_value
  1272. def _remove_variable_value(self, variable: VariableNode, value: Any
  1273. ) -> Any:
  1274. '''Метод описывающий операцию -= в теге save.'''
  1275. variable_value = variable.get_value()
  1276. if (variable.variable_type is IntegerType or
  1277. variable.variable_type is FloatType):
  1278. variable_value -= value
  1279. return variable_value
  1280. elif variable.variable_type is ListType:
  1281. if isinstance(value, str):
  1282. value = value.split(',')
  1283. if isinstance(value, list):
  1284. for item in value:
  1285. if item in variable_value:
  1286. variable_value.remove(item)
  1287. elif value in variable_value:
  1288. variable_value.remove(value)
  1289. return variable_value
  1290. elif variable.variable_type is IniType:
  1291. if not isinstance(variable_value, list):
  1292. if not isinstance(variable_value, str):
  1293. variable_value = str(variable_value)
  1294. variable_value = variable_value.split(',')
  1295. if not isinstance(value, list):
  1296. if isinstance(value, str):
  1297. value = value.split(',')
  1298. else:
  1299. value = str(value).split(',')
  1300. for item in value:
  1301. if item in variable_value:
  1302. variable_value.remove(item)
  1303. return ','.join(variable_value)
  1304. # Пока что во всех остальных случаях будем просто возвращать исходное
  1305. # значение.
  1306. return variable_value
  1307. def _get_parameter(self) -> Tuple[nodes.Const, nodes.Node]:
  1308. '''Метод для разбора параметров, содержащихся в теге calculate.'''
  1309. lineno = self.stream.current.lineno
  1310. parameter_name = self.stream.expect('name').value
  1311. parameter_name_node = nodes.Const(parameter_name, lineno=lineno)
  1312. if self.stream.skip_if('assign'):
  1313. # parameter_value = self.stream.current.value
  1314. parameter_rvalue = self.parser.parse_expression(with_condexpr=True)
  1315. # if parameter_name == 'env':
  1316. # # если параметр env -- обновляем множество значений env
  1317. # # контекста вo время парсинга.
  1318. # env_names = parameter_value.split(',')
  1319. # for name in env_names:
  1320. # self.environment.context_class._env_set.add(name.strip())
  1321. else:
  1322. parameter_rvalue = nodes.Const(True, lineno=lineno)
  1323. # parameter_value = True
  1324. return (parameter_name_node, parameter_rvalue)
  1325. def save_parameters(cls, parameters_dictionary: dict,
  1326. context: CalculateContext) -> str:
  1327. '''Метод для сохранения значений параметров.'''
  1328. context.parent['__parameters__'].set_parameter(parameters_dictionary)
  1329. return ''
  1330. @contextfunction
  1331. def pkg(self, context: CalculateContext, *args: dict) -> Version:
  1332. '''Метод, реализующий функцию pkg() шаблонов. Функция предназначена для
  1333. получения версии пакета, к которому уже привязан шаблон, если
  1334. аргументов нет, или версию пакета в аргументе функции. Если аргументов
  1335. нет, а шаблон не привязан к какому-либо пакету, или если указанного в
  1336. аргументе пакета нет -- функция возвращает пустой объект Version().'''
  1337. if args:
  1338. package_atom = args[0]
  1339. try:
  1340. atom_name = self.package_atom_parser.parse_package_parameter(
  1341. package_atom)
  1342. return atom_name.version
  1343. except PackageAtomError:
  1344. return Version()
  1345. else:
  1346. # package = context.parent['__parameters__'].package
  1347. package = self.parameters_processor._parameters_container.package
  1348. if not package:
  1349. return Version()
  1350. return package.version
  1351. def get_full_filepath(self, fname: str) -> str:
  1352. # TODO: добавить получение домашней директории пользователя
  1353. # if fname[0] == "~":
  1354. # # Получаем директорию пользователя
  1355. # fname = os.path.join(self.homeDir,
  1356. # fname.partition("/")[2], "")[:-1]
  1357. # TODO: учитывать также root_path
  1358. fname = os.path.join(
  1359. self.parameters_processor.chroot_path,
  1360. fname.lstrip("/"))
  1361. return fname
  1362. @contextfunction
  1363. def grep(self, context: CalculateContext, fname: str,
  1364. regpattern: str) -> str:
  1365. '''Метод реализующий функцию grep.'''
  1366. fname = self.get_full_filepath(fname)
  1367. try:
  1368. reg = re.compile(regpattern, re.MULTILINE)
  1369. except re.error:
  1370. raise TemplateSyntaxError("Wrong regular expression")
  1371. fileContent = readFile(fname)
  1372. if not fileContent:
  1373. return ""
  1374. match_data = reg.search(fileContent)
  1375. if match_data:
  1376. md_groups = match_data.groups()
  1377. if md_groups:
  1378. return md_groups[0] or ""
  1379. else:
  1380. return match_data.group()
  1381. else:
  1382. return ""
  1383. @contextfunction
  1384. def exists(self, context: CalculateContext, fname: str) -> str:
  1385. '''Метод реализующий функцию exists.'''
  1386. fname = self.get_full_filepath(fname)
  1387. try:
  1388. check_map = (
  1389. ('f', stat.S_ISREG),
  1390. ('d', stat.S_ISDIR),
  1391. ('l', stat.S_ISLNK),
  1392. ('b', stat.S_ISBLK),
  1393. ('c', stat.S_ISCHR),
  1394. ('p', stat.S_ISFIFO),
  1395. ('s', stat.S_ISSOCK))
  1396. fmode = os.lstat(fname)
  1397. for t, func in check_map:
  1398. if func(fmode.st_mode):
  1399. return t
  1400. else:
  1401. return 'f'
  1402. except OSError:
  1403. return ""
  1404. class TemplateEngine:
  1405. def __init__(self, directory_path: Union[str, None] = None,
  1406. datavars_module: Union[Datavars,
  1407. NamespaceNode,
  1408. Variables] = Variables(),
  1409. appends_set: set = set(),
  1410. chroot_path: str = '/',
  1411. for_package: Union[Package, None] = None,
  1412. pkg_autosave: bool = False):
  1413. ParametersProcessor._inspect_formats_package()
  1414. CalculateExtension._parameters_set =\
  1415. ParametersProcessor.available_parameters
  1416. ParametersProcessor.available_appends = appends_set
  1417. self._datavars_module = datavars_module
  1418. self._template_text = ''
  1419. self._pkg_autosave: bool = pkg_autosave
  1420. self._parameters_object = ParametersContainer()
  1421. self.parameters_processor = ParametersProcessor(
  1422. chroot_path=chroot_path,
  1423. datavars_module=datavars_module,
  1424. for_package=for_package)
  1425. if directory_path is not None:
  1426. self.environment = Environment(
  1427. loader=FileSystemLoader(directory_path),
  1428. trim_blocks=True,
  1429. lstrip_blocks=True)
  1430. else:
  1431. self.environment = Environment(trim_blocks=True,
  1432. lstrip_blocks=True)
  1433. self.environment.filters.update(CALCULATE_FILTERS)
  1434. self.calculate_extension = CalculateExtension(
  1435. self.environment,
  1436. self.parameters_processor,
  1437. datavars_module=datavars_module,
  1438. chroot_path=chroot_path)
  1439. self.environment.add_extension(self.calculate_extension)
  1440. self.environment.context_class = CalculateContext
  1441. @property
  1442. def for_package(self) -> Package:
  1443. return self.parameters_processor.for_package
  1444. @for_package.setter
  1445. def for_package(self, package: Package) -> NoReturn:
  1446. self.parameters_processor.for_package = package
  1447. def change_directory(self, directory_path: str) -> NoReturn:
  1448. '''Метод для смены директории в загрузчике.'''
  1449. self.environment.loader = FileSystemLoader(directory_path)
  1450. def process_template(self, template_path: str, template_type: str,
  1451. parameters: Optional[ParametersContainer] = None
  1452. ) -> NoReturn:
  1453. '''Метод для обработки файла шаблона, расположенного по указанному
  1454. пути.'''
  1455. if parameters is not None:
  1456. self._parameters_object = parameters
  1457. else:
  1458. self._parameters_object = ParametersContainer()
  1459. if self._parameters_object.env:
  1460. CalculateContext._env_set = self._parameters_object.env.copy()
  1461. else:
  1462. CalculateContext._env_set = set()
  1463. self.parameters_processor.set_parameters_container(
  1464. self._parameters_object)
  1465. self.calculate_extension.template_type = template_type
  1466. self.calculate_extension.calculate_parsed = False
  1467. template = self.environment.get_template(template_path)
  1468. self._template_text = template.render(
  1469. __datavars__=self._datavars_module,
  1470. __parameters__=self._parameters_object,
  1471. Version=Version
  1472. )
  1473. def process_template_from_string(
  1474. self, string: str, template_type: int,
  1475. parameters: Optional[ParametersContainer] = None
  1476. ) -> NoReturn:
  1477. '''Метод для обработки текста шаблона.'''
  1478. if parameters is not None:
  1479. self._parameters_object = parameters
  1480. else:
  1481. self._parameters_object = ParametersContainer()
  1482. if self._parameters_object.env:
  1483. CalculateContext._env_set = self._parameters_object.env.copy()
  1484. else:
  1485. CalculateContext._env_set = set()
  1486. self.parameters_processor.set_parameters_container(
  1487. self._parameters_object)
  1488. self.calculate_extension.template_type = template_type
  1489. self.calculate_extension.calculate_parsed = False
  1490. template = self.environment.from_string(string)
  1491. self._template_text = template.render(
  1492. __datavars__=self._datavars_module,
  1493. __parameters__=self._parameters_object,
  1494. Version=Version
  1495. )
  1496. @property
  1497. def parameters(self) -> ParametersContainer:
  1498. return self._parameters_object
  1499. @property
  1500. def template_text(self) -> str:
  1501. text, self._template_text = self._template_text, ''
  1502. return text