-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAdminToolsPlugin.php
357 lines (323 loc) · 14.2 KB
/
AdminToolsPlugin.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
<?php
/**
* AdminTools plugin
*
* @package AdminTools
* @copyright Copyright 2022 Daniele Binaghi et al.
* @license https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html CeCILL v2.1
*/
/**
* AdminTools plugin class
*
* @package AdminTools
*/
define('ADMIN_TOOLS_BACKUP_FILENAME', '../files/DatabaseBackup.sql');
// Helper functions for database backup
require_once 'views/helpers/Mysqldump.php';
class AdminToolsPlugin extends Omeka_Plugin_AbstractPlugin
{
protected $_hooks = array(
'install',
'uninstall',
'initialize',
'config',
'config_form',
'admin_footer',
'public_head',
'public_footer',
'neatline_public_static',
'define_acl'
);
protected $_filters = array(
'items_browse_params',
'collections_browse_params',
'exhibits_browse_params',
'admin_navigation_global',
'admin_navigation_main',
'public_navigation_admin_bar'
);
public function hookInstall()
{
set_option('admin_tools_maintenance_active', 0);
set_option('admin_tools_maintenance_title', 'Site under maintenance');
set_option('admin_tools_maintenance_message',
'<p>Sorry for the inconvenience, but we’re performing some maintenance at the moment. We’ll be back online shortly!</p>
<br>
<p>- the Team -</p>'
);
set_option('admin_tools_maintenance_scope_extended', 0);
set_option('admin_tools_usermanual_url', '');
set_option('admin_tools_usermanual_label', 'User manual');
set_option('admin_tools_usermanual_link_positions', '');
set_option('admin_tools_cookiebar_active', 0);
set_option('admin_tools_cookiebar_text', 'We use cookies to track usage of this project.');
set_option('admin_tools_cookiebar_position', 'top');
set_option('admin_tools_cookiebar_policy_url', '');
set_option('admin_tools_limit_visibility_to_own_items_roles', '');
set_option('admin_tools_limit_visibility_to_own_collections_roles', '');
set_option('admin_tools_limit_visibility_to_own_exhibits_roles', '');
set_option('admin_tools_public_edit_link_types', '');
set_option('admin_tools_public_edit_link_blank', 1);
set_option('admin_tools_backup_sessions_ignore', 1);
set_option('admin_tools_backup_compress', 0);
set_option('admin_tools_backup_download', 1);
set_option('admin_tools_sessions_count', 0);
}
public function hookUninstall()
{
delete_option('admin_tools_maintenance_active');
delete_option('admin_tools_maintenance_title');
delete_option('admin_tools_maintenance_message');
delete_option('admin_tools_maintenance_scope_extended');
delete_option('admin_tools_usermanual_url');
delete_option('admin_tools_usermanual_label');
delete_option('admin_tools_usermanual_link_positions');
delete_option('admin_tools_cookiebar_active');
delete_option('admin_tools_cookiebar_text');
delete_option('admin_tools_cookiebar_position');
delete_option('admin_tools_cookiebar_policy_url');
delete_option('admin_tools_limit_visibility_to_own_items_roles');
delete_option('admin_tools_limit_visibility_to_own_collections_roles');
delete_option('admin_tools_limit_visibility_to_own_exhibits_roles');
delete_option('admin_tools_public_edit_link_types');
delete_option('admin_tools_public_edit_link_blank');
delete_option('admin_tools_backup_sessions_ignore');
delete_option('admin_tools_backup_compress');
delete_option('admin_tools_backup_download');
delete_option('admin_tools_sessions_count');
}
public function hookInitialize()
{
add_translation_source(dirname(__FILE__) . '/languages');
$front = Zend_Controller_Front::getInstance();
$front->registerPlugin(new AdminTools_Controller_Plugin_Maintenance);
}
public function hookConfig($args)
{
$post = $args['post'];
set_option('admin_tools_maintenance_title', $post['admin_tools_maintenance_title']);
set_option('admin_tools_maintenance_message', $post['admin_tools_maintenance_message']);
set_option('admin_tools_maintenance_scope_extended', $post['admin_tools_maintenance_scope_extended']);
set_option('admin_tools_usermanual_url', $post['admin_tools_usermanual_url']);
set_option('admin_tools_usermanual_label', $post['admin_tools_usermanual_label']);
set_option('admin_tools_usermanual_link_positions', (isset($post['admin_tools_usermanual_link_positions']) ? serialize($post['admin_tools_usermanual_link_positions']) : ''));
set_option('admin_tools_cookiebar_active', $post['admin_tools_cookiebar_active']);
set_option('admin_tools_cookiebar_text', $post['admin_tools_cookiebar_text']);
set_option('admin_tools_cookiebar_position', $post['admin_tools_cookiebar_position']);
set_option('admin_tools_cookiebar_policy_url', $post['admin_tools_cookiebar_policy_url']);
set_option('admin_tools_limit_visibility_to_own_items_roles', (isset($post['admin_tools_limit_visibility_to_own_items_roles']) ? serialize($post['admin_tools_limit_visibility_to_own_items_roles']) : ''));
set_option('admin_tools_limit_visibility_to_own_collections_roles', (isset($post['admin_tools_limit_visibility_to_own_collections_roles']) ? serialize($post['admin_tools_limit_visibility_to_own_collections_roles']) : ''));
set_option('admin_tools_limit_visibility_to_own_exhibits_roles', (isset($post['admin_tools_limit_visibility_to_own_exhibits_roles']) ? serialize($post['admin_tools_limit_visibility_to_own_exhibits_roles']) : ''));
set_option('admin_tools_public_edit_link_types', (isset($post['admin_tools_public_edit_link_types']) ? serialize($post['admin_tools_public_edit_link_types']) : ''));
set_option('admin_tools_public_edit_link_blank', $post['admin_tools_public_edit_link_blank']);
set_option('admin_tools_backup_sessions_ignore', $post['admin_tools_backup_sessions_ignore']);
set_option('admin_tools_backup_compress', $post['admin_tools_backup_compress']);
set_option('admin_tools_backup_download', $post['admin_tools_backup_download']);
set_option('admin_tools_sessions_count', $post['admin_tools_sessions_count']);
}
public function hookConfigForm()
{
include 'config_form.php';
}
public function hookAdminFooter()
{
if (null !== current_user() && get_option('admin_tools_usermanual_link_positions') != '') {
$positions = unserialize(get_option('admin_tools_usermanual_link_positions'));
if (!empty($positions) && in_array('Footer', $positions)) {
$url = get_option('admin_tools_usermanual_url');
$label = get_option('admin_tools_usermanual_label');
if ($url != '') {
echo '<p class=\'left\' style=\'margin-right: 20px\'><a href=\'' . $url . '\' target=\'_blank\'>' . ($label != '' ? $label : __('User Manual')) . '</a></p>';
}
}
}
}
public function hookPublicHead()
{
$user = current_user();
if (!isset($user) && (bool)get_option('admin_tools_cookiebar_active')) {
queue_js_file('jquery.cookiebar');
queue_css_file('jquery.cookiebar');
}
}
public function hookPublicFooter()
{
$user = current_user();
if (!isset($user) && (bool)get_option('admin_tools_cookiebar_active')) {
echo get_view()->partial('cookie_bar.php', array(
'message' => get_option('admin_tools_cookiebar_text'),
'policyButton' => (get_option('admin_tools_cookiebar_policy_url') != '' ? 1 : 0),
'policyURL' => get_option('admin_tools_cookiebar_policy_url'),
'bottom' => (get_option('admin_tools_cookiebar_position') == 'bottom' ? 1 : 0)
));
}
}
public function hookNeatlinePublicStatic($exhibit)
{
$user = current_user();
if (!isset($user) && (bool)get_option('admin_tools_cookiebar_active')) {
queue_js_file('jquery.cookiebar');
queue_css_file('jquery.cookiebar');
echo get_view()->partial('cookie_bar.php', array(
'message' => get_option('admin_tools_cookiebar_text'),
'policyButton' => (get_option('admin_tools_cookiebar_policy_url') != '' ? 1 : 0),
'policyURL' => get_option('admin_tools_cookiebar_policy_url'),
'bottom' => (get_option('admin_tools_cookiebar_position') == 'bottom' ? 1 : 0)
));
}
}
public function hookDefineAcl($args)
{
$acl = $args['acl']; // get the Zend_Acl
$indexResource = new Zend_Acl_Resource('AdminTools_Index');
$acl->add($indexResource);
$acl->allow(array('super'), array('AdminTools_Index'));
$acl->deny(array('admin'), array('AdminTools_Index'));
}
public function filterItemsBrowseParams($params)
{
if (!is_admin_theme()) return $params;
$user = current_user();
if (get_option('admin_tools_limit_visibility_to_own_items_roles') != '') {
$limitedRoles = unserialize(get_option('admin_tools_limit_visibility_to_own_items_roles'));
if ($user && !empty($limitedRoles) && in_array($user->role, $limitedRoles)) {
$params['user'] = $user->id;
}
}
return $params;
}
public function filterCollectionsBrowseParams($params)
{
if (!is_admin_theme()) return $params;
$user = current_user();
if (get_option('admin_tools_limit_visibility_to_own_collections_roles') != '') {
$limitedRoles = unserialize(get_option('admin_tools_limit_visibility_to_own_collections_roles'));
if ($user && !empty($limitedRoles) && in_array($user->role, $limitedRoles)) {
$params['user'] = $user->id;
}
}
return $params;
}
public function filterExhibitsBrowseParams($params)
{
if (!is_admin_theme() || !plugin_is_active('ExhibitBuilder')) return $params;
$user = current_user();
if (get_option('admin_tools_limit_visibility_to_own_exhibits_roles') <> '') {
$limitedRoles = unserialize(get_option('admin_tools_limit_visibility_to_own_exhibits_roles'));
if ($user && !empty($limitedRoles) && in_array($user->role, $limitedRoles)) {
$params['user'] = $user->id;
}
}
return $params;
}
/**
* Adds links to Admin Topbar
*/
public function filterAdminNavigationGlobal($nav)
{
if (get_option('admin_tools_usermanual_link_positions') != '') {
$positions = unserialize(get_option('admin_tools_usermanual_link_positions'));
if (!empty($positions) && in_array('Topbar', $positions)) {
$url = get_option('admin_tools_usermanual_url');
$label = get_option('admin_tools_usermanual_label');
if ($url != '') {
$nav[] = array(
'label' => ($label != '' ? $label : __('User Manual')),
'uri' => $url,
'target' => '_blank'
);
}
}
}
if ((bool)get_option('admin_tools_maintenance_active')) {
array_unshift($nav, array(
'label' => __('** Maintenance Mode Active **'),
'uri' => admin_url('/admin-tools'),
'id' => 'maintenance_alert'
));
}
return $nav;
}
/**
* Adds links to Admin sidebar
*/
public function filterAdminNavigationMain($nav)
{
$nav[] = array(
'label' => __('Admin Tools'),
'uri' => url('admin-tools'),
'resource' => 'AdminTools_Index',
'privilege' => 'index'
);
if (get_option('admin_tools_usermanual_link_positions') != '') {
$positions = unserialize(get_option('admin_tools_usermanual_link_positions'));
if (!empty($positions) && in_array('Sidebar', $positions)) {
$url = get_option('admin_tools_usermanual_url');
$label = get_option('admin_tools_usermanual_label');
if ($url != '') {
$nav[] = array(
'label' => ($label != '' ? $label : __('User Manual')),
'uri' => $url,
'target' => '_blank'
);
}
}
}
return $nav;
}
/**
* Adds links to Public top bar
*/
public function filterPublicNavigationAdminBar($navLinks)
{
$user = current_user();
$view = get_view();
$publicEditLinkTypes = unserialize(get_option('admin_tools_public_edit_link_types'));
if (isset($user) && !empty($publicEditLinkTypes)) {
$acl = get_acl();
if (isset(get_view()->item) && $acl->isAllowed($user, $view->item, 'edit') && in_array('Items', $publicEditLinkTypes)) {
$uri = admin_url('/items/edit/' . metadata('items', 'id'));
$navLinks = $this->updateNavlinks($navLinks, 'Item', $uri);
} elseif (isset(get_view()->collection) && $acl->isAllowed($user, $view->collection, 'edit') && in_array('Collections', $publicEditLinkTypes)) {
$uri = admin_url('/collections/edit/' . metadata('collections', 'id'));
$navLinks = $this->updateNavlinks($navLinks, 'Collection', $uri);
} elseif (isset(get_view()->file) && $acl->isAllowed($user, $view->file, 'edit') && in_array('Files', $publicEditLinkTypes)) {
$uri = admin_url('/files/edit/' . metadata('files', 'id'));
$navLinks = $this->updateNavlinks($navLinks, 'File', $uri);
} elseif (isset(get_view()->exhibit) && $acl->isAllowed($user, $view->exhibit, 'edit') && in_array('Exhibits', $publicEditLinkTypes)) {
$uri = admin_url('/exhibits/edit/' . metadata('exhibit', 'id'));
$navLinks = $this->updateNavlinks($navLinks, 'Exhibit', $uri);
} elseif (isset(get_view()->simple_pages_page) && $acl->isAllowed($user, $view->simple_pages_page, 'edit') && in_array('Simple Pages', $publicEditLinkTypes)) {
$record = $view->simple_pages_page;
$uri = admin_url('/simple-pages/index/edit/id/' . $record->id);
$navLinks = $this->updateNavlinks($navLinks, 'Simple Page', $uri);
}
}
if ((bool)get_option('admin_tools_maintenance_active')) {
array_unshift($navLinks, array(
'label' => __('** Maintenance Mode Active **'),
'uri' => admin_url('/admin-tools')
));
}
return $navLinks;
}
/**
* Creates link for editing record
*/
public function updateNavlinks($navLinks, $type, $uri)
{
// Saves copy of last menu item - normally, the logout one - then removes it
$lastLink = $navLinks;
array_splice($lastLink, 0, -1);
array_splice($navLinks, -1);
// Creates new menu item, then adds it and finalize with saved last one
$element = array(
'label' => __('Edit') . ' ' . __($type),
'uri' => $uri,
'target' => (get_option('admin_tools_public_edit_link_blank') ? '_blank' : '')
);
$navLinks[] = $element;
return array_merge($navLinks, $lastLink);
}
}
?>