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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugin;
use Exception;
use Piwik\Piwik;
use Piwik\Url;
use Piwik\Version;
/**
* @see core/Version.php
*/
require_once PIWIK_INCLUDE_PATH . '/core/Version.php';
/**
* Loads plugin metadata found in the following files:
* - piwik.json
*/
class MetadataLoader
{
public const PLUGIN_JSON_FILENAME = 'plugin.json';
/**
* The name of the plugin whose metadata will be loaded.
*
* @var string
*/
private $pluginName;
/**
* Constructor.
*
* @param string $pluginName Name of the plugin to load metadata.
*/
public function __construct($pluginName)
{
$this->pluginName = $pluginName;
}
/**
* Loads plugin metadata. @see Plugin::getInformation.
*
* @return array
*/
public function load()
{
$defaults = $this->getDefaultPluginInformation();
$plugin = $this->loadPluginInfoJson();
// use translated plugin description if available
if ($defaults['description'] != Piwik::translate($defaults['description'])) {
unset($plugin['description']);
}
// look for a license file
$licenseFile = $this->getPathToLicenseFile();
if (!empty($licenseFile)) {
$plugin['license_file'] = $licenseFile;
}
return array_merge(
$defaults,
$plugin
);
}
public function hasPluginJson()
{
$hasJson = $this->loadPluginInfoJson();
return !empty($hasJson);
}
private function getDefaultPluginInformation()
{
$descriptionKey = $this->pluginName . '_PluginDescription';
return [
'description' => $descriptionKey,
'homepage' => Url::addCampaignParametersToMatomoLink('https://matomo.org/'),
'authors' => [['name' => 'Matomo', 'homepage' => Url::addCampaignParametersToMatomoLink('https://matomo.org/')]],
'license' => 'GPL v3+',
'version' => Version::VERSION,
'theme' => false,
'require' => [],
];
}
/**
* It is important that this method works without using anything from DI
* @return array|mixed
*/
public function loadPluginInfoJson()
{
$path = $this->getPathToPluginJson();
return $this->loadJsonMetadata($path);
}
public function getPathToPluginJson()
{
$path = $this->getPathToPluginFolder() . '/' . self::PLUGIN_JSON_FILENAME;
return $path;
}
private function loadJsonMetadata($path)
{
if (!file_exists($path)) {
return array();
}
$json = file_get_contents($path);
if (!$json) {
return array();
}
$info = json_decode($json, $assoc = true);
if (
!is_array($info)
|| empty($info)
) {
throw new Exception("Invalid JSON file: $path");
}
return $info;
}
/**
* @return string
*/
private function getPathToPluginFolder()
{
return \Piwik\Plugin\Manager::getPluginDirectory($this->pluginName);
}
/**
* @return null|string
*/
public function getPathToLicenseFile()
{
$prefixPath = $this->getPathToPluginFolder() . '/';
$licenseFiles = array(
'LICENSE',
'LICENSE.md',
'LICENSE.txt',
);
foreach ($licenseFiles as $licenseFile) {
$pathToLicense = $prefixPath . $licenseFile;
if (is_file($pathToLicense) && is_readable($pathToLicense)) {
return $pathToLicense;
}
}
return null;
}
}
|
