1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
# This file is part of Gajim.
#
# Gajim is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# Gajim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Gajim. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import Any
import json
import sys
from dataclasses import dataclass
from pathlib import Path
from packaging.requirements import Requirement
from packaging.version import Version as V
import gajim
from .helpers import is_shipped_plugin
from .plugins_i18n import _ as p_
BLOCKED_PLUGINS = [
'appindicator_integration',
'omemo',
'plugin_installer',
'syntax_highlight',
'url_image_preview'
]
GAJIM_VERSION = V(gajim.__version__.split('+', 1)[0]).base_version
@dataclass(frozen=True, eq=True)
class PluginManifest:
name: str
short_name: str
description: str
authors: list[str]
homepage: str
config_dialog: bool
version: V
requirements: list[Requirement]
platforms: list[str]
path: Path | None = None
def __hash__(self):
return hash(f'{self.short_name}_{self.version}')
@property
def is_usable(self) -> bool:
if self.short_name in BLOCKED_PLUGINS:
return False
if not self._check_requirements():
return False
platform = sys.platform
if platform not in ('win32', 'darwin', 'linux'):
# sys.platform can return an unknown amount of unix/linux derivates
platform = 'others'
return platform in self.platforms
@property
def is_shipped(self) -> bool:
if self.path is None:
return False
return is_shipped_plugin(self.path)
def get_remote_url(self, repository_url: str) -> str:
filename = f'{self.short_name}_{self.version}.zip'
return f'{repository_url}/{self.short_name}/{filename}'
@classmethod
def from_path(cls, path: Path) -> PluginManifest:
manifest_path = path / 'plugin-manifest.json'
if not manifest_path.exists():
raise ValueError(f'Not a plugin path: {path}')
if manifest_path.is_dir():
raise ValueError(f'Not a plugin path: {path}')
with manifest_path.open(encoding='utf8') as f:
try:
manifest = json.load(f)
except Exception as error:
raise ValueError(f'Error while parsing manifest: '
f'{path}, {error}')
return cls.from_manifest_json(manifest, manifest_path)
def _check_requirements(self) -> bool:
return any(GAJIM_VERSION in req.specifier for req in self.requirements)
@classmethod
def from_manifest_json(cls,
manifest: dict[str, Any],
path: Path | None = None) -> PluginManifest:
return cls(
name=manifest['name'],
short_name=manifest['short_name'],
description=p_(manifest['description']),
authors=manifest['authors'],
homepage=manifest['homepage'],
config_dialog=manifest['config_dialog'],
version=V(manifest['version']),
requirements=[Requirement(r) for r in manifest['requirements']],
platforms=manifest['platforms'],
path=path.parent if path is not None else path)
|
