-
Notifications
You must be signed in to change notification settings - Fork 67
/
BlockUtil.php
509 lines (438 loc) · 17 KB
/
BlockUtil.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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
<?php
/**
* Copyright Zikula Foundation 2009 - Zikula Application Framework
*
* This work is contributed to the Zikula Foundation under one or more
* Contributor Agreements and licensed to You under the following license:
*
* @license GNU/LGPLv3 (or at your option, any later version).
* @package Util
*
* Please see the NOTICE file distributed with this source code for further
* information regarding copyright and licensing.
*/
/**
* Block util.
*/
class BlockUtil
{
/**
* Display all blocks in a block position.
*
* @param string $side Block position to render.
* @param boolean $echo Whether or not to echo output directly.
* @param boolean $implode Whether or not to implode lines by \n.
*
* @return void|string The rendered output.
*/
public static function displayPosition($side, $echo = true, $implode = true)
{
static $blockplacements = array();
static $positions = array();
static $modname;
static $currentlang;
static $func;
static $type;
static $customargs;
if (!isset($side)) {
return null;
}
$request = ServiceUtil::get('request');
// get the block position
if (empty($positions)) {
$positions = ModUtil::apiFunc('Blocks', 'user', 'getallpositions');
}
if (!isset($positions[$side])) {
return;
}
if (!isset($modname)) {
$modname = filter_var($request->get('module', '_homepage_', FILTER_SANITIZE_STRING));
}
// get all block placements
if (empty($blockplacements)) {
$blockplacements = ModUtil::apiFunc('Blocks', 'user', 'getallplacements');
}
// get variables from input
if (!isset($func)) {
$func = FormUtil::getPassedValue('func', 'main', 'GETPOST');
}
if (!isset($type)) {
$type = FormUtil::getPassedValue('type', 'user', 'GETPOST');
}
if (!isset($customargs)) {
$customargs = array();
$filtervars = array('module', 'name', 'type', 'func', 'theme', 'authid', 'csrftoken');
foreach ($_GET as $var => $value) {
if (is_array($value)) {
$arguments = explode('&', urldecode(http_build_query(array($var => $value))));
foreach ($arguments as $argument) {
$args = explode('=', $argument);
if (!in_array($args[0], $filtervars)) {
$customargs[] = DataUtil::formatForOS(strip_tags($args[0])) . '=' . DataUtil::formatForOS(strip_tags($args[1]));
}
}
} else {
if (!in_array($var, $filtervars)) {
$customargs[] = DataUtil::formatForOS(strip_tags($var)) . '=' . DataUtil::formatForOS(strip_tags($value));
}
}
}
}
// current language
if (!isset($currentlang)) {
$currentlang = ZLanguage::getLanguageCode();
}
// loop around the blocks and display only the ones we need
$blockoutput = array();
foreach ($blockplacements as $blockplacement) {
// don't display a block if it's not in this block position
if ($blockplacement['pid'] != $positions[$side]['pid']) {
continue;
}
// get the full block info
$blockinfo = self::getBlockInfo($blockplacement['bid']);
// dont display the block if it's not active or not in matching langauge
if (!$blockinfo['active'] || (!empty($blockinfo['language']) && $blockinfo['language'] != $currentlang)) {
continue;
}
// block filtering
if (!empty($blockinfo['filter'])) {
$showblock = false;
// loop for each filter
foreach ($blockinfo['filter'] as $filter) {
// filter must be an array of values
if (!is_array($filter)) {
continue;
}
$rule1 = $filter['module'] == $modname;
$rule2 = empty($filter['ftype']) ? true : ($filter['ftype'] == $type);
$rule3 = empty($filter['fname']) ? true : ($filter['fname'] == $func);
$rule4 = empty($filter['fargs']) ? true : array_search($filter['fargs'], $customargs);
if ($rule1 == true && $rule2 == true && $rule3 == true && $rule4 !== false) {
$showblock = true;
break;
}
}
if (!$showblock) {
continue;
}
}
$blockinfo['position'] = $positions[$side]['name'];
// get the module info and display the block
$modinfo = ModUtil::getInfo($blockinfo['mid']);
if ($echo) {
echo self::show($modinfo['name'], $blockinfo['bkey'], $blockinfo);
} else {
$blockoutput[$blockinfo['bid']] = self::show($modinfo['name'], $blockinfo['bkey'], $blockinfo);
}
}
if ($echo) {
return;
} else {
if ($implode) {
return implode("\n", $blockoutput);
} else {
return $blockoutput;
}
}
}
/**
* Show a block.
*
* @param string $modname Module name.
* @param string $blockname Name of the block.
* @param array $blockinfo Information parameters.
*
* @return mixed Blockinfo array or null.
*/
public static function show($modname, $blockname, $blockinfo = array())
{
global $blocks_modules;
$blockInstance = self::load($modname, $blockname);
if (!$blockInstance instanceof \Zikula\Framework\Controller\AbstractBlock) {
throw new \RuntimeException(sprintf('BlockInstance %s::%s must an instance of AbstractBlock', $modname, $block));
}
$displayfunc = array($blockInstance, 'display');
if (is_callable($displayfunc)) {
if (is_array($displayfunc)) {
return call_user_func($displayfunc, $blockinfo);
}
} else {
if (SecurityUtil::checkPermission('.*', '.*', ACCESS_ADMIN)) {
$blockinfo['title'] = __f("Block type '%s' not found", $block);
$blockinfo['content'] = __f("Error! The '%s' block type was not found. Please check the corresponding blocks directory.", $block);
return self::themeBlock($blockinfo);
}
}
}
/**
* Display a block based on the current theme.
*
* @param array $blockinfo Block info.
*
* @return string The rendered output.
*/
public static function themeBlock($blockinfo)
{
static $themeinfo, $themedir, $upb, $downb;
if (!isset($blockinfo['bid'])) {
$blockinfo['bid'] = '';
}
if (!isset($blockinfo['title'])) {
$blockinfo['title'] = '';
}
if (UserUtil::isLoggedIn() && ModUtil::getVar('Blocks', 'collapseable') == 1 && isset($blockinfo['collapsable']) && ($blockinfo['collapsable'] == '1')) {
if (!isset($themeinfo)) {
$themeinfo = ThemeUtil::getInfo(ThemeUtil::getIDFromName(UserUtil::getTheme()));
$themedir = DataUtil::formatForOS($themeinfo['directory']);
}
// check for collapsable menus being enabled, and setup the collapsable menu image.
if (!isset($upb)) {
if (file_exists('themes/' . $themedir . '/Resources/public/images/upb.png')) {
$upb = '<img src="themes/' . $themedir . '/Resources/public/images/upb.png" alt="-" />';
} elseif (file_exists('themes/' . $themedir . '/Resources/public/images/14_layer_raiselayer.png')) {
$upb = '<img src="themes/' . $themedir . '/Resources/public/images/14_layer_raiselayer.png" alt="-" />';
} else {
$upb = '<img src="images/icons/extrasmall/14_layer_raiselayer.png" alt="-" />';
}
}
if (!isset($downb)) {
if (file_exists('themes/' . $themedir . '/Resources/public/images/downb.png')) {
$downb = '<img src="themes/' . $themedir . '/Resources/public/images/downb.png" alt="+" />';
} elseif (file_exists('themes/' . $themedir . '/Resources/public/images/14_layer_lowerlayer.png')) {
$downb = '<img src="themes/' . $themedir . '/Resources/public/images/14_layer_lowerlayer.png" alt="+" />';
} else {
$downb = '<img src="images/icons/extrasmall/14_layer_lowerlayer.png" alt="+" />';
}
}
$checkUserBlock = self::checkUserBlock($blockinfo);
if ($checkUserBlock) {
if (!empty($blockinfo['title'])) {
$blockinfo['minbox'] = '<a href="' . DataUtil::formatForDisplay(ModUtil::url('Blocks', 'user', 'changestatus', array('bid' => $blockinfo['bid']))) . '">' . $upb . '</a>';
}
} else {
$blockinfo['content'] = '';
if (!empty($blockinfo['title'])) {
$blockinfo['minbox'] = '<a href="' . DataUtil::formatForDisplay(ModUtil::url('Blocks', 'user', 'changestatus', array('bid' => $blockinfo['bid']))) . '">' . $downb . '</a>';
}
}
// end collapseable menu config
} else {
$blockinfo['minbox'] = '';
}
return Zikula_View_Theme::getInstance()->themesidebox($blockinfo);
}
/**
* Load a block.
*
* @param string $modname Module name.
* @param string $block Name of the block.
*
* @throws LogicException Uf OO-Block is not a Zikula_Controller_AbstractBlock object.
* @return bool True on successful load, false otherwise.
*/
public static function load($modname, $block)
{
$sm = ServiceUtil::getManager();
$modinfo = ModUtil::getInfoFromName($modname);
$serviceId = strtolower('block.' . $modinfo['name'] . '_' . 'Block_' . $block.'Block');
if ($sm->has($serviceId)) {
return $sm->get($serviceId);
}
if ($modinfo['type'] == ModUtil::TYPE_MODULE) {
ZLanguage::bindModuleDomain($modinfo['name']);
}
ModUtil::load($modname);
// get the block info
$className = ucwords($modinfo['name']) . '_Block_' . ucwords($block) . 'Block';
$r = new ReflectionClass($className);
$blockInstance = $r->newInstanceArgs(array($sm));
$sm->set($serviceId, $blockInstance);
$result = $blockInstance;
$blocks_modules[$block] = call_user_func(array($blockInstance, 'info'));
// set the module and keys for the new block
$blocks_modules[$block]['bkey'] = $block;
$blocks_modules[$block]['module'] = $modname;
$blocks_modules[$block]['mid'] = ModUtil::getIdFromName($modname);
// merge the blockinfo in the global list of blocks
if (!isset($GLOBALS['blocks_modules'])) {
$GLOBALS['blocks_modules'] = array();
}
$GLOBALS['blocks_modules'][$blocks_modules[$block]['mid']][$block] = $blocks_modules[$block];
// Initialise block if required (new-style)
call_user_func(array($blockInstance, 'init'));
// add stylesheet to the page vars, this makes manual loading obsolete
PageUtil::addVar('stylesheet', ThemeUtil::getModuleStylesheet($modname));
return $result;
}
/**
* Load all blocks.
*
* @return array Array of blocks.
*/
public static function loadAll()
{
static $blockdirs = array();
// Load new-style blocks from system and modules tree
$mods = ModUtil::getAllMods();
foreach ($mods as $mod) {
$modname = $mod['name'];
$moddir = DataUtil::formatForOS($mod['directory']);
if (!isset($blockdirs[$modname])) {
$blockdirs[$modname] = array();
$blockdirs[$modname][] = ZIKULA_ROOT."/system/$moddir/Block";
$blockdirs[$modname][] = ZIKULA_ROOT."/modules/$moddir/Block";
foreach ($blockdirs[$modname] as $dir) {
if (is_dir($dir) && is_readable($dir)) {
$dh = opendir($dir);
while (($f = readdir($dh)) !== false) {
if (substr($f, -4) == '.php') {
$block = substr($f, 0, -4);
self::load($modname, $block);
}
}
closedir($dh);
}
}
}
}
// Return information gathered
return $GLOBALS['blocks_modules'];
}
/**
* Extract an array of config variables out of the content field of a block.
*
* @param string $content The content from the db.
*
* @return array
*/
public static function varsFromContent($content)
{
// Assume serialized content ends in a ";" followed by some curly-end-braces
if (preg_match('/;}*$/', $content)) {
// Serialised content
$vars = unserialize($content);
return $vars;
}
// Unserialised content
$links = explode("\n", $content);
$vars = array();
foreach ($links as $link) {
$link = trim($link);
if ($link) {
$var = explode(':=', $link);
if (isset($var[1])) {
$vars[$var[0]] = $var[1];
}
}
}
return $vars;
}
/**
* Put an array of config variables in the content field of a block.
*
* @param array $vars The config vars array, in key->value form.
*
* @return string The config var string.
*/
public static function varsToContent($vars)
{
return (serialize($vars));
}
/**
* Checks if user controlled block state.
*
* Checks if the user has a state set for a current block.
* Sets the default state for that block if not present.
*
* @param array $blockinfo Block info.
*
* @return boolean
*/
public static function checkUserBlock($blockinfo)
{
if (UserUtil::isLoggedIn()) {
$uid = UserUtil::getVar('uid');
$sm = ServiceUtil::getManager();
$entityManager = $sm->get('doctrine.entitymanager');
$entity = 'Blocks_Entity_UserBlock';
$item = $entityManager->getRepository($entity)->findOneBy(array('uid' => $uid, 'bid' => $blockinfo['bid']));
if (!$item) {
$item = new $entity;
$item['uid'] = (int)$uid;
$item['bid'] = $blockinfo['bid'];
$item['active'] = $blockinfo['defaultstate'];
$entityManager->persist($item);
$entityManager->flush();
}
return (boolean)$item['active'];
}
return false;
}
/**
* Get block information.
*
* @return array Array of block information.
*/
public static function getBlocksInfo()
{
return ModUtil::apiFunc('Blocks', 'user', 'getall');
}
/**
* Get block information.
*
* @param string $value The value to search for.
* @param string $assocKey The field in which we look for the value (optional) (default='bid').
*
* @return array Array of block information.
*/
public static function getBlockInfo($value, $assocKey = 'bid')
{
static $blockinfo = array();
if (!isset($blockinfo[$assocKey]) || empty($blockinfo[$assocKey])) {
$blockinfo[$assocKey] = array();
$blocks = self::getBlocksInfo();
foreach ($blocks as $block) {
$key = $block[$assocKey];
$blockinfo[$assocKey][$key] = $block->toArray();
}
}
if (isset($blockinfo[$assocKey][$value])) {
return $blockinfo[$assocKey][$value];
}
return false;
}
/**
* Get block information.
*
* @param string $title The block title.
*
* @return array Array of block information.
*/
public static function getInfoByTitle($title)
{
return self::getBlockInfo($title, 'title');
}
/**
* Alias to pnBlockDisplayPosition.
*
* @param string $side Block position to render.
*
* @return string The rendered output.
*/
public static function blocks($side)
{
return self::displayPosition($side);
}
/**
* Alias to pnBlockDisplayPosition.
*
* @param array $blockinfo Block info.
*
* @return string The rendered output.
*/
public static function themesideblock($blockinfo)
{
return self::themeBlock($blockinfo);
}
}