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
/*
* PluginRepository.class.php - query plugin meta data
*
* Copyright (c) 2008 Elmar Ludwig
*
* This program 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; either version 2 of
* the License, or (at your option) any later version.
*/
/**
* Class used to locate plugins available from a plugin repository.
*/
class PluginRepository
{
/**
* list and meta data of available plugins
*/
private $plugins = [];
/**
* Initialize a new PluginRepository and read meta data from
* the given URL or the default list of URLs (if $url is null).
*/
public function __construct($url = null)
{
if (isset($url)) {
$this->readMetadata($url);
} else {
foreach ($GLOBALS['PLUGIN_REPOSITORIES'] as $url) {
$this->readMetadata($url);
}
}
}
/**
* Read plugin meta data from the given URL (using XML format).
* The structure of the XML is:
*
* <plugins>
* <plugin name="DummyPlugin"
* <release
* version="2.0"
* url="http://plugins.example.com/dummy-2.0.zip"
* studipMinVersion="1.4"
* studipMaxVersion="1.9">
* </plugin>
* [...]
* </plugins>
*
* @param string $url plugin repository url
*/
public function readMetadata($url)
{
$cache = StudipCacheFactory::getCache();
$cache_key = 'plugin_metadata/'.$url;
$metadata = $cache->read($cache_key);
if ($metadata === false) {
// Set small timeout for the rare case that the repository is not
// available
$context = get_default_http_stream_context($url);
stream_context_set_option($context, ['http' => [
'timeout' => 5,
]]);
$metadata = @file_get_contents($url, false, $context);
if ($metadata === false) {
throw new Exception(sprintf(_('Fehler beim Zugriff auf %s'), $url));
}
$cache->write($cache_key, $metadata, 3600);
}
$xml = new SimpleXMLElement($metadata);
if (!isset($xml->plugin)) {
$cache->expire($cache_key);
throw new Exception(_('Keine Plugin Meta-Daten gefunden'));
}
foreach ($xml->plugin as $plugin) {
foreach ($plugin->release as $release) {
$min_version = trim($release['studipMinVersion']);
$max_version = trim($release['studipMaxVersion']);
if (($min_version && StudipVersion::olderThan($min_version)) ||
($max_version && StudipVersion::newerThan($max_version))) {
// plugin is not compatible, so skip it
continue;
}
$meta_data = [
'version' => (string) $release['version'],
'url' => (string) $release['url'],
'description' => (string) $plugin['description'],
'plugin_url' => (string) $plugin['homepage'],
'image' => (string) $plugin['image'],
'score' => (float) $plugin['score'],
'marketplace_url' => (string) $plugin['marketplace_url'],
];
$this->registerPlugin((string) $plugin['name'], $meta_data);
}
}
}
/**
* Register a new plugin in this repository.
*
* @param string $name plugin name
* @param array $meta_data plugin meta data
*/
protected function registerPlugin($name, $meta_data)
{
$old_data = $this->plugins[$name];
if (!isset($old_data) ||
version_compare($meta_data['version'], $old_data['version']) > 0) {
$this->plugins[$name] = $meta_data;
}
}
/**
* Get meta data for the plugin with the given name (if available).
* Always chooses the newest compatible version of the plugin.
* @param string $name name of the plgin
* @return array meta data for plugin (or null)
*/
public function getPlugin($name)
{
return $this->plugins[$name];
}
/**
* Get meta data for all plugins whose names contain the given
* string. You may omit the search string to get a list of all
* available plugins. Returns the newest compatible version of
* each plugin.
* @param string $search search string
* @return array array of meta data for matching plugins
*/
public function getPlugins($search = null)
{
$result = [];
foreach ($this->plugins as $name => $data) {
if ($search === null || $search === '' ||
is_int(mb_stripos($name, $search)) ||
is_int(mb_stripos($data['description'], $search))) {
$result[$name] = $data;
}
}
return $result;
}
}
|
