1: <?php
  2: /*
  3:  You may not change or alter any portion of this comment or credits
  4:  of supporting developers from this source code or any supporting source code
  5:  which is considered copyrighted (c) material of the original comment or credit authors.
  6: 
  7:  This program is distributed in the hope that it will be useful,
  8:  but WITHOUT ANY WARRANTY; without even the implied warranty of
  9:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 10: */
 11: 
 12: namespace Xoops\Core\Kernel\Handlers;
 13: 
 14: use Xoops\Core\Kernel\Dtype;
 15: use Xoops\Core\Kernel\XoopsObject;
 16: use \Xoops\Core\Text\Sanitizer;
 17: 
 18: /**
 19:  * XoopsBlock
 20:  *
 21:  * @category  Xoops\Core\Kernel\Handlers\XoopsBlock
 22:  * @package   Xoops\Core\Kernel
 23:  * @author    Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 24:  * @author    Gregory Mage (AKA Mage)
 25:  * @author    trabis <lusopoemas@gmail.com>
 26:  * @copyright 2000-2015 XOOPS Project (http://xoops.org)
 27:  * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 28:  * @link      http://xoops.org
 29:  */
 30: class XoopsBlock extends XoopsObject
 31: {
 32:     const CUSTOM_HTML   = 'H'; // custom HTML block
 33:     const CUSTOM_PHP    = 'P'; // custom PHP block
 34:     const CUSTOM_SMILIE = 'S'; // use text sanitizer (smilies enabled)
 35:     const CUSTOM_TEXT   = 'T'; // use text sanitizer (smilies disabled)
 36: 
 37:     const BLOCK_TYPE_SYSTEM = 'S'; // S - generated by system module
 38:     const BLOCK_TYPE_MODULE = 'M'; // M - generated by a non-system module
 39:     const BLOCK_TYPE_CUSTOM = 'C'; // C - Custom block
 40:     const BLOCK_TYPE_CLONED = 'D'; // D - cloned system/module block
 41:     // E - cloned custom block, DON'T use it
 42: 
 43:     /**
 44:      * Constructor
 45:      *
 46:      * @param int|array $id object id
 47:      */
 48:     public function __construct($id = null)
 49:     {
 50:         $this->initVar('bid', Dtype::TYPE_INTEGER, null, false);
 51:         $this->initVar('mid', Dtype::TYPE_INTEGER, 0, false);
 52:         $this->initVar('func_num', Dtype::TYPE_INTEGER, 0, false);
 53:         $this->initVar('options', Dtype::TYPE_TEXT_BOX, null, false, 255);
 54:         $this->initVar('name', Dtype::TYPE_TEXT_BOX, null, true, 150);
 55:         //$this->initVar('position', Dtype::TYPE_INTEGER, 0, false);
 56:         $this->initVar('title', Dtype::TYPE_TEXT_BOX, null, false, 150);
 57:         $this->initVar('content', Dtype::TYPE_TEXT_AREA, null, false);
 58:         $this->initVar('side', Dtype::TYPE_INTEGER, 0, false);
 59:         $this->initVar('weight', Dtype::TYPE_INTEGER, 0, false);
 60:         $this->initVar('visible', Dtype::TYPE_INTEGER, 0, false);
 61:         $this->initVar('block_type', Dtype::TYPE_OTHER, null, false);
 62:         $this->initVar('c_type', Dtype::TYPE_OTHER, null, false);
 63:         $this->initVar('isactive', Dtype::TYPE_INTEGER, null, false);
 64:         $this->initVar('dirname', Dtype::TYPE_TEXT_BOX, null, false, 50);
 65:         $this->initVar('func_file', Dtype::TYPE_TEXT_BOX, null, false, 50);
 66:         $this->initVar('show_func', Dtype::TYPE_TEXT_BOX, null, false, 50);
 67:         $this->initVar('edit_func', Dtype::TYPE_TEXT_BOX, null, false, 50);
 68:         $this->initVar('template', Dtype::TYPE_OTHER, null, false);
 69:         $this->initVar('bcachetime', Dtype::TYPE_INTEGER, 0, false);
 70:         $this->initVar('last_modified', Dtype::TYPE_INTEGER, 0, false);
 71: 
 72:         $xoops = \Xoops::getInstance();
 73: 
 74:         // for backward compatibility
 75:         if (isset($id)) {
 76:             if (is_array($id)) {
 77:                 $this->assignVars($id);
 78:             } else {
 79:                 $blockHandler = $xoops->getHandlerBlock();
 80:                 $obj = $blockHandler->get($id);
 81:                 foreach (array_keys($obj->getVars()) as $i) {
 82:                     $this->assignVar($i, $obj->getVar($i, 'n'));
 83:                 }
 84:             }
 85:         }
 86:     }
 87: 
 88: 
 89:     /**
 90:      * getter
 91:      *
 92:      * @param string $format Dtype::FORMAT_xxxx constant
 93:      *
 94:      * @return mixed
 95:      */
 96:     public function id($format = 'n')
 97:     {
 98:         return $this->getVar('bid', $format);
 99:     }
100: 
101:     /**
102:      * getter
103:      *
104:      * @param string $format Dtype::FORMAT_xxxx constant
105:      *
106:      * @return mixed
107:      */
108:     public function bid($format = '')
109:     {
110:         return $this->getVar('bid', $format);
111:     }
112: 
113:     /**
114:      * getter
115:      *
116:      * @param string $format Dtype::FORMAT_xxxx constant
117:      *
118:      * @return mixed
119:      */
120:     public function mid($format = '')
121:     {
122:         return $this->getVar('mid', $format);
123:     }
124: 
125:     /**
126:      * getter
127:      *
128:      * @param string $format Dtype::FORMAT_xxxx constant
129:      *
130:      * @return mixed
131:      */
132:     public function func_num($format = '')
133:     {
134:         return $this->getVar('func_num', $format);
135:     }
136: 
137:     /**
138:      * getter
139:      *
140:      * @param string $format Dtype::FORMAT_xxxx constant
141:      *
142:      * @return mixed
143:      */
144:     public function options($format = '')
145:     {
146:         return $this->getVar('options', $format);
147:     }
148: 
149:     /**
150:      * getter
151:      *
152:      * @param string $format Dtype::FORMAT_xxxx constant
153:      *
154:      * @return mixed
155:      */
156:     public function name($format = '')
157:     {
158:         return $this->getVar('name', $format);
159:     }
160: 
161:     /**
162:      * getter
163:      *
164:      * @param string $format Dtype::FORMAT_xxxx constant
165:      *
166:      * @return mixed
167:      */
168:     public function title($format = '')
169:     {
170:         return $this->getVar('title', $format);
171:     }
172: 
173:     /**
174:      * getter
175:      *
176:      * @param string $format Dtype::FORMAT_xxxx constant
177:      *
178:      * @return mixed
179:      */
180:     public function content($format = '')
181:     {
182:         return $this->getVar('content', $format);
183:     }
184: 
185:     /**
186:      * getter
187:      *
188:      * @param string $format Dtype::FORMAT_xxxx constant
189:      *
190:      * @return mixed
191:      */
192:     public function side($format = '')
193:     {
194:         return $this->getVar('side', $format);
195:     }
196: 
197:     /**
198:      * getter
199:      *
200:      * @param string $format Dtype::FORMAT_xxxx constant
201:      *
202:      * @return mixed
203:      */
204:     public function weight($format = '')
205:     {
206:         return $this->getVar('weight', $format);
207:     }
208: 
209:     /**
210:      * getter
211:      *
212:      * @param string $format Dtype::FORMAT_xxxx constant
213:      *
214:      * @return mixed
215:      */
216:     public function visible($format = '')
217:     {
218:         return $this->getVar('visible', $format);
219:     }
220: 
221:     /**
222:      * getter
223:      *
224:      * @param string $format Dtype::FORMAT_xxxx constant
225:      *
226:      * @return mixed
227:      */
228:     public function block_type($format = '')
229:     {
230:         return $this->getVar('block_type', $format);
231:     }
232: 
233:     /**
234:      * getter custom block type XoopsBlock::CUSTOM_xxxx constant
235:      *
236:      * @param string $format Dtype::FORMAT_xxxx constant
237:      *
238:      * @return mixed
239:      */
240:     public function c_type($format = '')
241:     {
242:         return $this->getVar('c_type', $format);
243:     }
244: 
245:     /**
246:      * getter
247:      *
248:      * @param string $format Dtype::FORMAT_xxxx constant
249:      *
250:      * @return mixed
251:      */
252:     public function isactive($format = '')
253:     {
254:         return $this->getVar('isactive', $format);
255:     }
256: 
257:     /**
258:      * getter
259:      *
260:      * @param string $format Dtype::FORMAT_xxxx constant
261:      *
262:      * @return mixed
263:      */
264:     public function dirname($format = '')
265:     {
266:         return $this->getVar('dirname', $format);
267:     }
268: 
269:     /**
270:      * getter
271:      *
272:      * @param string $format Dtype::FORMAT_xxxx constant
273:      *
274:      * @return mixed
275:      */
276:     public function func_file($format = '')
277:     {
278:         return $this->getVar('func_file', $format);
279:     }
280: 
281:     /**
282:      * getter
283:      *
284:      * @param string $format Dtype::FORMAT_xxxx constant
285:      *
286:      * @return mixed
287:      */
288:     public function show_func($format = '')
289:     {
290:         return $this->getVar('show_func', $format);
291:     }
292: 
293:     /**
294:      * getter
295:      *
296:      * @param string $format Dtype::FORMAT_xxxx constant
297:      *
298:      * @return mixed
299:      */
300:     public function edit_func($format = '')
301:     {
302:         return $this->getVar('edit_func', $format);
303:     }
304: 
305:     /**
306:      * getter
307:      *
308:      * @param string $format Dtype::FORMAT_xxxx constant
309:      *
310:      * @return mixed
311:      */
312:     public function template($format = '')
313:     {
314:         return $this->getVar('template', $format);
315:     }
316: 
317:     /**
318:      * getter
319:      *
320:      * @param string $format Dtype::FORMAT_xxxx constant
321:      *
322:      * @return mixed
323:      */
324:     public function bcachetime($format = '')
325:     {
326:         return $this->getVar('bcachetime', $format);
327:     }
328: 
329:     /**
330:      * getter
331:      *
332:      * @param string $format Dtype::FORMAT_xxxx constant
333:      *
334:      * @return mixed
335:      */
336:     public function last_modified($format = '')
337:     {
338:         return $this->getVar('last_modified', $format);
339:     }
340: 
341:     /**
342:      * return the content of the block for output
343:      *
344:      * @param string $format Dtype::FORMAT_xxxx constant
345:      * @param string $c_type type of custom content, a XoopsBlock::CUSTOM_xxxx constant
346:      *                            H : custom HTML block
347:      *                            P : custom PHP block
348:      *                            S : use text sanitizer (smilies enabled)
349:      *                            T : use text sanitizer (smilies disabled)
350:      *
351:      * @return string content for output
352:      */
353:     public function getContent($format = 's', $c_type = 'T')
354:     {
355:         $format = strtolower($format);
356:         $c_type = strtoupper($c_type);
357:         switch ($format) {
358:             case Dtype::FORMAT_SHOW:
359:             case 's':
360:                 // apply c_type rules for content display
361:                 $content = $this->getVar('content', Dtype::FORMAT_NONE);
362:                 switch ($c_type) {
363:                     case XoopsBlock::CUSTOM_HTML:
364:                         return $this->convertSiteURL($content);
365:                     case XoopsBlock::CUSTOM_PHP:
366:                         ob_start();
367:                         echo eval($content);
368:                         $content = ob_get_contents();
369:                         ob_end_clean();
370:                         return $this->convertSiteURL($content);
371:                     case XoopsBlock::CUSTOM_SMILIE:
372:                         $myts = Sanitizer::getInstance();
373:                         return $myts->filterForDisplay($this->convertSiteURL($content), 1, 1);
374:                     case XoopsBlock::CUSTOM_TEXT:
375:                     default:
376:                         $myts = Sanitizer::getInstance();
377:                         return $myts->filterForDisplay($this->convertSiteURL($content), 1, 0);
378:                 }
379:                 break;
380:             case Dtype::FORMAT_EDIT:
381:             case 'e':
382:                 return $this->getVar('content', Dtype::FORMAT_EDIT);
383:                 break;
384:             default:
385:                 return $this->getVar('content', Dtype::FORMAT_NONE);
386:                 break;
387:         }
388:     }
389: 
390:     /**
391:      * Convert {X_SITEURL} to actual site URL in content
392:      *
393:      * @param string $content content to convert
394:      *
395:      * @return string
396:      */
397:     protected function convertSiteURL($content)
398:     {
399:         $content = str_replace('{X_SITEURL}', \Xoops::getInstance()->url('/'), $content);
400:         return $content;
401:     }
402: 
403:     /**
404:      * (HTML-) form for setting the options of the block
405:      *
406:      * @return string|false HTML for the form, FALSE if not defined for this block
407:      */
408:     public function getOptions()
409:     {
410:         $xoops = \Xoops::getInstance();
411:         if (!$this->isCustom()) {
412:             $edit_func = (string)$this->getVar('edit_func');
413:             if (!$edit_func) {
414:                 return false;
415:             }
416:             $funcFile = $xoops->path(
417:                 'modules/' . $this->getVar('dirname') . '/blocks/' . $this->getVar('func_file')
418:             );
419:             if (\XoopsLoad::fileExists($funcFile)) {
420:                 $xoops->loadLanguage('blocks', $this->getVar('dirname'));
421:                 include_once $funcFile;
422:                 if (function_exists($edit_func)) {
423:                     // execute the function
424:                     $options = explode('|', $this->getVar('options'));
425:                     $edit_form = $edit_func($options);
426:                     if (!$edit_form) {
427:                         return false;
428:                     }
429:                 } else {
430:                     return false;
431:                 }
432:                 return $edit_form;
433:             } else {
434:                 return false;
435:             }
436:         } else {
437:             return false;
438:         }
439:     }
440: 
441:     /**
442:      * Determine if this is a custom block
443:      *
444:      * @return bool true if this is a custom block
445:      */
446:     public function isCustom()
447:     {
448:         return $this->getVar("block_type") === XoopsBlock::BLOCK_TYPE_CUSTOM;
449:     }
450: 
451:     /************ADDED**************/
452: 
453: 
454:     /**
455:      * Build Block
456:      *
457:      * @return array|bool
458:      */
459:     public function buildBlock()
460:     {
461:         $xoops = \Xoops::getInstance();
462:         $block = array();
463:         if (!$this->isCustom()) {
464:             // get block display function
465:             $show_func = (string)$this->getVar('show_func');
466:             if (!$show_func) {
467:                 return false;
468:             }
469:             if (!\XoopsLoad::fileExists(
470:                 $func_file = $xoops->path(
471:                     'modules/' . $this->getVar('dirname') . '/blocks/' . $this->getVar('func_file')
472:                 )
473:             )) {
474:                 return false;
475:             }
476:             // must get lang files b4 including the file
477:             // some modules require it for code that is outside the function
478:             $xoops->loadLanguage('blocks', $this->getVar('dirname'));
479:             $xoops->loadLocale($this->getVar('dirname'));
480:             include_once $func_file;
481: 
482:             if (function_exists($show_func)) {
483:                 // execute the function
484:                 $options = explode('|', $this->getVar('options'));
485:                 $block = $show_func($options);
486:                 if (!$block) {
487:                     return false;
488:                 }
489:             } else {
490:                 return false;
491:             }
492:         } else {
493:             // it is a custom block, so just return the contents
494:             $block['content'] = $this->getContent('s', $this->getVar('c_type'));
495:             if (empty($block['content'])) {
496:                 return false;
497:             }
498:         }
499:         return $block;
500:     }
501: }
502: