forked from xwp/wp-plugin-dependencies
/
plugin-dependencies.php
369 lines (281 loc) · 9.78 KB
/
plugin-dependencies.php
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
<?php
/*
Plugin Name: Plugin Dependencies
Version: 1.2
Description: Prevent activating plugins that don't have all their dependencies satisfied
Author: scribu
Author URI: http://scribu.net/
Plugin URI: http://scribu.net/wordpress/plugin-dependencies
Text Domain: plugin-dependencies
Domain Path: /lang
*/
if ( !is_admin() )
return;
add_action( 'extra_plugin_headers', array( 'Plugin_Dependencies', 'extra_plugin_headers' ) );
class Plugin_Dependencies {
private static $dependencies = array();
private static $provides = array();
private static $active_plugins;
private static $deactivate_cascade;
private static $deactivate_conflicting;
function extra_plugin_headers( $headers ) {
$headers['Provides'] = 'Provides';
$headers['Depends'] = 'Depends';
return $headers;
}
function init() {
$all_plugins = get_plugins();
$plugins_by_name = array();
foreach ( $all_plugins as $plugin => $plugin_data )
$plugins_by_name[ $plugin_data['Name'] ] = $plugin;
foreach ( $all_plugins as $plugin => $plugin_data ) {
self::$provides[ $plugin ] = self::parse_field( $plugin_data['Provides'] );
self::$provides[ $plugin ][] = $plugin;
$deps = array();
foreach ( self::parse_field( $plugin_data['Depends'] ) as $dep ) {
if ( isset( $plugins_by_name[ $dep ] ) )
$dep = $plugins_by_name[ $dep ];
$deps[] = $dep;
}
self::$dependencies[ $plugin ] = $deps;
}
}
private function parse_field( $str ) {
return array_filter( preg_split( '/,\s*/', $str ) );
}
/**
* Get a list of real or virtual dependencies for a plugin
*
* @param string $plugin_id A plugin basename
* @return array List of dependencies
*/
public function get_dependencies( $plugin_id ) {
return self::$dependencies[ $plugin_id ];
}
/**
* Get a list of dependencies provided by a certain plugin
*
* @param string $plugin_id A plugin basename
* @return array List of dependencies
*/
public function get_provided( $plugin_id ) {
return self::$provides[ $plugin_id ];
}
/**
* Get a list of plugins that provide a certain dependency
*
* @param string $dep Real or virtual dependency
* @return array List of plugins
*/
public function get_providers( $dep ) {
$plugin_ids = array();
if ( isset( self::$provides[ $dep ] ) ) {
$plugin_ids = array( $dep );
} else {
// virtual dependency
foreach ( self::$provides as $plugin => $provides ) {
if ( in_array( $dep, $provides ) ) {
$plugin_ids[] = $plugin;
}
}
}
return $plugin_ids;
}
/**
* Deactivate plugins that would provide the same dependencies as the ones in the list
*
* @param array $plugin_ids A list of plugin basenames
* @return array List of deactivated plugins
*/
public function deactivate_conflicting( $to_activate ) {
$deps = array();
foreach ( $to_activate as $plugin_id ) {
$deps = array_merge( $deps, self::get_provided( $plugin_id ) );
}
$conflicting = array();
$to_check = array_diff( get_option( 'active_plugins', array() ), $to_activate ); // precaution
foreach ( $to_check as $active_plugin ) {
$common = array_intersect( $deps, self::get_provided( $active_plugin ) );
if ( !empty( $common ) )
$conflicting[] = $active_plugin;
}
// TODO: don't deactivate plugins that would still have all dependencies satisfied
$deactivated = self::deactivate_cascade( $conflicting );
deactivate_plugins( $conflicting );
return array_merge( $conflicting, $deactivated );
}
/**
* Deactivate plugins that would have unmet dependencies
*
* @param array $plugin_ids A list of plugin basenames
* @return array List of deactivated plugins
*/
public function deactivate_cascade( $to_deactivate ) {
if ( empty( $to_deactivate ) )
return array();
self::$active_plugins = get_option( 'active_plugins', array() );
if ( is_multisite() )
self::$active_plugins = array_merge( self::$active_plugins, get_site_option( 'active_sitewide_plugins', array() ) );
self::$deactivate_cascade = array();
self::_cascade( $to_deactivate );
return self::$deactivate_cascade;
}
private function _cascade( $to_deactivate ) {
$to_deactivate_deps = array();
foreach ( $to_deactivate as $plugin_id )
$to_deactivate_deps = array_merge( $to_deactivate_deps, self::get_provided( $plugin_id ) );
$found = array();
foreach ( self::$active_plugins as $dep ) {
$matching_deps = array_intersect( $to_deactivate_deps, self::get_dependencies( $dep ) );
if ( !empty( $matching_deps ) )
$found[] = $dep;
}
$found = array_diff( $found, self::$deactivate_cascade ); // prevent endless loop
if ( empty( $found ) )
return;
self::$deactivate_cascade = array_merge( self::$deactivate_cascade, $found );
self::_cascade( $found );
deactivate_plugins( $found );
}
}
add_action( 'load-plugins.php', array( 'Plugin_Dependencies_UI', 'init' ) );
class Plugin_Dependencies_UI {
private static $msg;
function init() {
add_action( 'admin_notices', array( __CLASS__, 'admin_notices' ) );
add_action( 'admin_print_styles', array( __CLASS__, 'admin_print_styles' ) );
add_action( 'admin_print_footer_scripts', array( __CLASS__, 'footer_script' ), 20 );
add_filter( 'plugin_action_links', array( __CLASS__, 'plugin_action_links' ), 10, 4 );
Plugin_Dependencies::init();
load_plugin_textdomain( 'plugin-dependencies', '', dirname( plugin_basename( __FILE__ ) ) . '/lang' );
self::$msg = array(
array( 'deactivate', 'cascade', __( 'The following plugins have also been deactivated:', 'plugin-dependencies' ) ),
array( 'activate', 'conflicting', __( 'The following plugins have been deactivated due to dependency conflicts:', 'plugin-dependencies' ) ),
);
if ( !isset( $_REQUEST['action'] ) )
return;
foreach ( self::$msg as $args ) {
list( $action, $type ) = $args;
if ( $action == $_REQUEST['action'] ) {
$deactivated = call_user_func( array( 'Plugin_Dependencies', "deactivate_$type" ), (array) $_REQUEST['plugin'] );
set_transient( "pd_deactivate_$type", $deactivated );
}
}
}
function admin_notices() {
foreach ( self::$msg as $args ) {
list( $action, $type, $text ) = $args;
if ( !isset( $_REQUEST[ $action ] ) )
continue;
$deactivated = get_transient( "pd_deactivate_$type" );
delete_transient( "pd_deactivate_$type" );
if ( empty( $deactivated ) )
continue;
echo
html( 'div', array( 'class' => 'updated' ),
html( 'p', $text, self::generate_dep_list( $deactivated ) )
);
}
}
function admin_print_styles() {
?>
<style type="text/css">
.dep-list li { list-style: disc inside none }
span.deps li.unsatisfied { color: red }
span.deps li.unsatisfied_network { color: orange }
span.deps li.satisfied { color: green }
</style>
<?php
}
function footer_script() {
$all_plugins = get_plugins();
$hash = array();
foreach ( $all_plugins as $file => $data ) {
$name = isset( $data['Name'] ) ? $data['Name'] : $file;
$hash[ $name ] = sanitize_title( $name );
}
?>
<script type="text/javascript">
jQuery(function($) {
var hash = <?php echo json_encode( $hash ); ?>
$('table.widefat tbody tr').not('.second').each(function() {
var $self = $(this), title = $self.find('.plugin-title').text();
$self.attr('id', hash[title]);
});
});
</script>
<?php
}
function plugin_action_links( $actions, $plugin_file, $plugin_data, $context ) {
$deps = Plugin_Dependencies::get_dependencies( $plugin_file );
$active_plugins = (array) get_option( 'active_plugins', array() );
$network_active_plugins = (array) get_site_option( 'active_sitewide_plugins' );
if ( empty( $deps ) )
return $actions;
$unsatisfied = $unsatisfied_network = array();
foreach ( $deps as $dep ) {
$plugin_ids = Plugin_Dependencies::get_providers( $dep );
if ( !count( array_intersect( $active_plugins, $plugin_ids ) ) )
$unsatisfied[] = $dep;
if ( is_multisite() && !count( array_intersect( $network_active_plugins, $plugin_ids ) ) )
$unsatisfied_network[] = $dep;
}
if ( !empty( $unsatisfied ) ) {
unset( $actions['activate'] );
}
if ( !empty( $unsatisfied_network ) ) {
unset( $actions['network_activate'] );
}
$actions['deps'] = __( 'Required plugins:', 'plugin-dependencies' ) . '<br>' . self::generate_dep_list( $deps, $unsatisfied, $unsatisfied_network );
return $actions;
}
private function generate_dep_list( $deps, $unsatisfied = array(), $unsatisfied_network = array() ) {
$all_plugins = get_plugins();
$dep_list = '';
foreach ( $deps as $dep ) {
$plugin_ids = Plugin_Dependencies::get_providers( $dep );
if ( in_array( $dep, $unsatisfied ) )
$class = 'unsatisfied';
elseif ( in_array( $dep, $unsatisfied_network ) )
$class = 'unsatisfied_network';
else
$class = 'satisfied';
if ( empty( $plugin_ids ) ) {
$name = html( 'span', esc_html( $dep ) );
} else {
$list = array();
foreach ( $plugin_ids as $plugin_id ) {
$name = isset( $all_plugins[ $plugin_id ]['Name'] ) ? $all_plugins[ $plugin_id ]['Name'] : $plugin_id;
$list[] = html( 'a', array( 'href' => '#' . sanitize_title( $name ) ), $name );
}
$name = implode( ' or ', $list );
}
$dep_list .= html( 'li', compact( 'class' ), $name );
}
return html( 'ul', array( 'class' => 'dep-list' ), $dep_list );
}
}
if ( ! function_exists( 'html' ) ):
function html( $tag ) {
$args = func_get_args();
$tag = array_shift( $args );
if ( is_array( $args[0] ) ) {
$closing = $tag;
$attributes = array_shift( $args );
foreach ( $attributes as $key => $value ) {
if ( false === $value )
continue;
if ( true === $value )
$value = $key;
$tag .= ' ' . $key . '="' . esc_attr( $value ) . '"';
}
} else {
list( $closing ) = explode( ' ', $tag, 2 );
}
if ( in_array( $closing, array( 'area', 'base', 'basefont', 'br', 'hr', 'input', 'img', 'link', 'meta' ) ) ) {
return "<{$tag} />";
}
$content = implode( '', $args );
return "<{$tag}>{$content}</{$closing}>";
}
endif;