Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • cUriBuilderMR
  • ModRewrite
  • ModRewrite_ContentController
  • ModRewrite_ContentExpertController
  • ModRewrite_ContentTestController
  • ModRewrite_ControllerAbstract
  • ModRewriteBase
  • ModRewriteController
  • ModRewriteDebugger
  • ModRewriteTest
  • ModRewriteUrlStack
  • ModRewriteUrlUtil

Functions

  • mr_arrayValue
  • mr_buildGeneratedCode
  • mr_buildNewUrl
  • mr_conCopyArtLang
  • mr_conMoveArticles
  • mr_conSaveArticle
  • mr_conSyncArticle
  • mr_debugOutput
  • mr_getConfiguration
  • mr_getRequest
  • mr_header
  • mr_i18n
  • mr_loadConfiguration
  • mr_queryAndNextRecord
  • mr_removeMultipleChars
  • mr_requestCleanup
  • mr_runFrontendController
  • mr_setClientLanguageId
  • mr_setConfiguration
  • mr_strCopyCategory
  • mr_strMovedownCategory
  • mr_strMoveSubtree
  • mr_strMoveUpCategory
  • mr_strNewCategory
  • mr_strNewTree
  • mr_strRenameCategory
  • mr_strSyncCategory
  • Overview
  • Package
  • Function
  • Tree
  • Deprecated
  • Todo
  1: <?php
  2: /**
  3:  * Mod Rewrite front_content.php controller. Does some preprocessing jobs, tries
  4:  * to set following variables, depending on mod rewrite configuration and if
  5:  * request part exists:
  6:  * - $client
  7:  * - $changeclient
  8:  * - $lang
  9:  * - $changelang
 10:  * - $idart
 11:  * - $idcat
 12:  *
 13:  * @package     Plugin
 14:  * @subpackage  ModRewrite
 15:  * @id          $Id$:
 16:  * @author      Stefan Seifarth / stese
 17:  * @author      Murat Purc <murat@purc.de>
 18:  * @copyright   www.polycoder.de
 19:  * @copyright   four for business AG <www.4fb.de>
 20:  * @license     http://www.contenido.org/license/LIZENZ.txt
 21:  * @link        http://www.4fb.de
 22:  * @link        http://www.contenido.org
 23:  */
 24: 
 25: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 26: 
 27: /**
 28:  * Processes mod_rewrite related job for created new tree.
 29:  *
 30:  * Will be called by chain 'Contenido.Action.str_newtree.AfterCall'.
 31:  *
 32:  * @param   array  $data  Assoziative array with some values
 33:  * @return  array  Passed parameter
 34:  */
 35: function mr_strNewTree(array $data) {
 36:     global $lang;
 37: 
 38:     ModRewriteDebugger::log($data, 'mr_strNewTree $data');
 39: 
 40:     if ((int) $data['newcategoryid'] > 0) {
 41:         $mrCatAlias = (trim($data['categoryalias']) !== '') ? trim($data['categoryalias']) : trim($data['categoryname']);
 42:         // set new urlname - because original set urlname isn''t validated for double entries in same parent category
 43:         ModRewrite::setCatWebsafeName($mrCatAlias, $data['newcategoryid'], $lang);
 44:         ModRewrite::setCatUrlPath($data['newcategoryid'], $lang);
 45:     }
 46: 
 47:     return $data;
 48: }
 49: 
 50: /**
 51:  * Processes mod_rewrite related job for created new category.
 52:  *
 53:  * Will be called by chain 'Contenido.Action.str_newcat.AfterCall'.
 54:  *
 55:  * @param   array  $data  Assoziative array with some values
 56:  * @return  array  Passed parameter
 57:  */
 58: function mr_strNewCategory(array $data) {
 59:     global $lang;
 60: 
 61:     ModRewriteDebugger::log($data, 'mr_strNewCategory $data');
 62: 
 63:     if ((int) $data['newcategoryid'] > 0) {
 64:         $mrCatAlias = (trim($data['categoryalias']) !== '') ? trim($data['categoryalias']) : trim($data['categoryname']);
 65:         // set new urlname - because original set urlname isn''t validated for double entries in same parent category
 66:         ModRewrite::setCatWebsafeName($mrCatAlias, $data['newcategoryid'], $lang);
 67:         ModRewrite::setCatUrlPath($data['newcategoryid'], $lang);
 68:     }
 69: 
 70:     return $data;
 71: }
 72: 
 73: /**
 74:  * Processes mod_rewrite related job for renamed category
 75:  * 2010-02-01: and now all existing subcategories and modify their paths too...
 76:  * 2010-02-01: max 50 recursion level
 77:  *
 78:  * Will be called by chain 'Contenido.Action.str_renamecat.AfterCall'.
 79:  *
 80:  * @param   array  $data  Assoziative array with some values
 81:  * @return  array  Passed parameter
 82:  */
 83: function mr_strRenameCategory(array $data) {
 84:     ModRewriteDebugger::log($data, 'mr_strRenameCategory $data');
 85: 
 86:     // hes 20100102
 87:     // maximal 50 recursion level
 88:     $recursion = (is_int($data['recursion'])) ? $data['recursion'] : 1;
 89:     if ($recursion > 50) {
 90:         exit("#20100201-1503: sorry - maximum function nesting level of " . $recursion . " reached");
 91:     }
 92: 
 93:     $mrCatAlias = (trim($data['newcategoryalias']) !== '') ? trim($data['newcategoryalias']) : trim($data['newcategoryname']);
 94:     if ($mrCatAlias != '') {
 95:         // set new urlname - because original set urlname isn''t validated for double entries in same parent category
 96:         ModRewrite::setCatWebsafeName($mrCatAlias, $data['idcat'], $data['lang']);
 97:         ModRewrite::setCatUrlPath($data['idcat'], $data['lang']);
 98:     }
 99: 
100:     // hes 20100102
101:     // now dive into all existing subcategories and modify their paths too...
102:     $str = 'parentid=' . $data['idcat'];
103:     $oCatColl = new cApiCategoryCollection($str);
104: 
105:     while ($oCat = $oCatColl->next()) {
106:         // hes 20100102
107:         $str = 'idcat=' . $oCat->get('idcat') . ' AND idlang=' . (int) $data['lang'];
108:         $oCatLanColl = new cApiCategoryLanguageCollection($str);
109:         if ($oCatLan = $oCatLanColl->next()) {
110:             // hes 20100102
111:             $childData = array(
112:                 'idcat' => $oCat->get('idcat'),
113:                 'lang' => (int) $data['lang'],
114:                 'newcategoryname' => $oCatLan->get('name'),
115:                 'newcategoryalias' => $oCatLan->get('urlname'),
116:                 'recursion' => $recursion + 1
117:             );
118: 
119:             $resData = mr_strRenameCategory($childData);
120:         }
121:     }
122: 
123:     return $data;
124: }
125: 
126: /**
127:  * Processes mod_rewrite related job after moving a category up.
128:  *
129:  * Will be called by chain 'Contenido.Action.str_moveupcat.AfterCall'.
130:  *
131:  * @todo  do we really need processing of the category? there is no mr relevant data
132:  *        changes while moving the category on same level, level and name won't change
133:  *
134:  * @param   int  $idcat  Category id
135:  * @return  int  Category id
136:  */
137: function mr_strMoveUpCategory($idcat) {
138:     ModRewriteDebugger::log($idcat, 'mr_strMoveUpCategory $idcat');
139: 
140:     // category check
141:     $cat = new cApiCategory((int) $idcat);
142:     if (!$cat->get('preid')) {
143:         return;
144:     }
145: 
146:     // get all cat languages
147:     $aIdLang = ModRewrite::getCatLanguages($idcat);
148: 
149:     // update ...
150:     foreach ($aIdLang as $iIdLang) {
151:         // get urlname
152:         $sCatname = ModRewrite::getCatName($idcat, $iIdLang);
153:         // set new urlname - because original set urlname isn't validated for double entries in same parent category
154:         ModRewrite::setCatWebsafeName($sCatname, $idcat, $iIdLang);
155:     }
156: 
157:     return $idcat;
158: }
159: 
160: /**
161:  * Processes mod_rewrite related job after moving a category down.
162:  *
163:  * Will be called by chain 'Contenido.Action.str_movedowncat.AfterCall'.
164:  *
165:  * @todo  do we really need processing of the category? there is no mr relevant data
166:  *        changes while moving the category on same level, level and name won't change
167:  *
168:  * @param   int  $idcat  Id of category beeing moved down
169:  * @return  int  Category id
170:  */
171: function mr_strMovedownCategory($idcat) {
172:     ModRewriteDebugger::log($idcat, 'mr_strMovedownCategory $idcat');
173: 
174:     // category check
175:     $cat = new cApiCategory((int) $idcat);
176:     if (!$cat->get('id')) {
177:         return;
178:     }
179: 
180:     // get all cat languages
181:     $aIdLang = ModRewrite::getCatLanguages($idcat);
182:     // update ...
183:     foreach ($aIdLang as $iIdLang) {
184:         // get urlname
185:         $sCatname = ModRewrite::getCatName($idcat, $iIdLang);
186:         // set new urlname - because original set urlname isn't validated for double entries in same parent category
187:         ModRewrite::setCatWebsafeName($sCatname, $idcat, $iIdLang);
188:     }
189: 
190:     return $idcat;
191: }
192: 
193: /**
194:  * Processes mod_rewrite related job after moving a category subtree.
195:  *
196:  * Will be called by chain 'Contenido.Action.str_movesubtree.AfterCall'.
197:  *
198:  * @param   array  $data  Assoziative array with some values
199:  * @return  array  Passed parameter
200:  */
201: function mr_strMoveSubtree(array $data) {
202:     ModRewriteDebugger::log($data, 'mr_strMoveSubtree $data');
203: 
204:     // category check
205:     if ((int) $data['idcat'] <= 0) {
206:         return;
207:     }
208: 
209:     // next category check
210:     $cat = new cApiCategory($data['idcat']);
211:     if (!$cat->get('idcat')) {
212:         return;
213:     }
214: 
215:     // get all cat languages
216:     $aIdLang = ModRewrite::getCatLanguages($data['idcat']);
217:     // update all languages
218:     foreach ($aIdLang as $iIdLang) {
219:         // get urlname
220:         $sCatname = ModRewrite::getCatName($data['idcat'], $iIdLang);
221:         // set new urlname - because original set urlname isn't validated for double entries in same parent category
222:         ModRewrite::setCatWebsafeName($sCatname, $data['idcat'], $iIdLang);
223:         ModRewrite::setCatUrlPath($data['idcat'], $iIdLang);
224:     }
225: 
226:     // now dive into all existing subcategories and modify their paths too...
227:     $oCatColl = new cApiCategoryCollection('parentid=' . $data['idcat']);
228:     while ($oCat = $oCatColl->next()) {
229:         mr_strMoveSubtree(array('idcat' => $oCat->get('idcat')));
230:     }
231: 
232:     return $data;
233: }
234: 
235: /**
236:  * Processes mod_rewrite related job after copying a category subtree.
237:  *
238:  * Will be called by chain 'Contenido.Category.strCopyCategory'.
239:  *
240:  * @param   array  $data  Assoziative array with some values
241:  * @return  array  Passed parameter
242:  */
243: function mr_strCopyCategory(array $data) {
244:     ModRewriteDebugger::log($data, 'mr_strCopyCategory $data');
245: 
246:     $idcat = (int) $data['newcat']->get('idcat');
247:     if ($idcat <= 0) {
248:         return $data;
249:     }
250: 
251:     // get all cat languages
252:     $aIdLang = ModRewrite::getCatLanguages($idcat);
253:     // update ...
254:     foreach ($aIdLang as $iIdLang) {
255:         // get urlname
256:         $sCatname = ModRewrite::getCatName($idcat, $iIdLang);
257:         // set new urlname - because original set urlname isn't validated for double entries in same parent category
258:         ModRewrite::setCatWebsafeName($sCatname, $idcat, $iIdLang);
259:         ModRewrite::setCatUrlPath($idcat, $iIdLang);
260:     }
261: }
262: 
263: /**
264:  * Processes mod_rewrite related job during structure synchronisation process,
265:  * sets the urlpath of current category.
266:  *
267:  * Will be called by chain 'Contenido.Category.strSyncCategory_Loop'.
268:  *
269:  * @param   array  $data  Assoziative array with some values
270:  * @return  array  Passed parameter
271:  */
272: function mr_strSyncCategory(array $data) {
273:     ModRewriteDebugger::log($data, 'mr_strSyncCategory $data');
274:     ModRewrite::setCatUrlPath($data['idcat'], $data['idlang']);
275:     return $data;
276: }
277: 
278: /**
279:  * Processes mod_rewrite related job for saved articles (new or modified article).
280:  *
281:  * Will be called by chain 'Contenido.Action.con_saveart.AfterCall'.
282:  *
283:  * @param   array  $data  Assoziative array with some article properties
284:  * @return  array  Passed parameter
285:  */
286: function mr_conSaveArticle(array $data) {
287:     global $tmp_firstedit, $client;
288: 
289:     ModRewriteDebugger::log($data, 'mr_conSaveArticle $data');
290: 
291:     if ((int) $data['idart'] == 0) {
292:         return $data;
293:     }
294: 
295:     if (strlen(trim($data['urlname'])) == 0) {
296:         $data['urlname'] = $data['title'];
297:     }
298: 
299:     if (1 == $tmp_firstedit) {
300:         // new article
301:         $aLanguages = getLanguagesByClient($client);
302: 
303:         foreach ($aLanguages as $iLang) {
304:             ModRewrite::setArtWebsafeName($data['urlname'], $data['idart'], $iLang, $data['idcat']);
305:         }
306:     } else {
307:         // modified article
308:         $aArticle = ModRewrite::getArtIdByArtlangId($data['idartlang']);
309: 
310:         if (isset($aArticle['idart']) && isset($aArticle['idlang'])) {
311:             ModRewrite::setArtWebsafeName($data['urlname'], $aArticle['idart'], $aArticle['idlang'], $data['idcat']);
312:         }
313:     }
314: 
315:     return $data;
316: }
317: 
318: /**
319:  * Processes mod_rewrite related job for articles beeing moved.
320:  *
321:  * Will be called by chain 'Contenido.Article.conMoveArticles_Loop'.
322:  *
323:  * @param   array  $data  Assoziative array with record entries
324:  * @return  array  Loop through of arguments
325:  */
326: function mr_conMoveArticles($data) {
327:     ModRewriteDebugger::log($data, 'mr_conMoveArticles $data');
328: 
329:     // too defensive but secure way
330:     if (!is_array($data)) {
331:         return $data;
332:     } elseif (!isset($data['idartlang'])) {
333:         return $data;
334:     } elseif (!isset($data['idart'])) {
335:         return $data;
336:     }
337: 
338:     $arr_art = ModRewrite::getArtIds($data['idartlang']);
339:     if (count($arr_art) == 2) {
340:         ModRewrite::setArtWebsafeName($arr_art["urlname"], $data['idart'], $arr_art["idlang"]);
341:     }
342: 
343:     return $data;
344: }
345: 
346: /**
347:  * Processes mod_rewrite related job for duplicated articles.
348:  *
349:  * Will be called by chain 'Contenido.Article.conCopyArtLang_AfterInsert'.
350:  *
351:  * @param   array  $data  Assoziative array with record entries
352:  * @return  array  Loop through of arguments
353:  */
354: function mr_conCopyArtLang($data) {
355:     ModRewriteDebugger::log($data, 'mr_conCopyArtLang $data');
356: 
357:     // too defensive but secure way
358:     if (!is_array($data)) {
359:         return $data;
360:     } elseif (!isset($data['title'])) {
361:         return $data;
362:     } elseif (!isset($data['idart'])) {
363:         return $data;
364:     } elseif (!isset($data['idlang'])) {
365:         return $data;
366:     }
367: 
368:     ModRewrite::setArtWebsafeName($data['title'], $data['idart'], $data['idlang']);
369: 
370:     return $data;
371: }
372: 
373: /**
374:  * Processes mod_rewrite related job for synchronized articles.
375:  *
376:  * Will be called by chain 'Contenido.Article.conSyncArticle_AfterInsert'.
377:  *
378:  * @param   array  $data  Assoziative array with record entries as follows:
379:  * <code>
380:  * array(
381:  *     'src_art_lang'  => Recordset (assoziative array) of source item from con_art_lang table
382:  *     'dest_art_lang' => Recordset (assoziative array) of inserted destination item from con_art_lang table
383:  * );
384:  * </code>
385:  *
386:  * @return  array  Loop through of argument
387:  */
388: function mr_conSyncArticle($data) {
389:     ModRewriteDebugger::log($data, 'mr_conSyncArticle $data');
390: 
391:     // too defensive but secure way
392:     if (!is_array($data)) {
393:         return $data;
394:     } elseif (!isset($data['src_art_lang']) || !is_array($data['src_art_lang'])) {
395:         return $data;
396:     } elseif (!isset($data['dest_art_lang']) || !is_array($data['dest_art_lang'])) {
397:         return $data;
398:     } elseif (!isset($data['dest_art_lang']['idart'])) {
399:         return $data;
400:     } elseif (!isset($data['dest_art_lang']['idlang'])) {
401:         return $data;
402:     }
403: 
404:     if (!isset($data['src_art_lang']['urlname'])) {
405:         $artLang = new cApiArticleLanguage($data['src_art_lang']['idartlang']);
406:         $urlname = $artLang->get('urlname');
407:     } else {
408:         $urlname = $data['src_art_lang']['urlname'];
409:     }
410: 
411:     if ($urlname) {
412:         ModRewrite::setArtWebsafeName($urlname, $data['dest_art_lang']['idart'], $data['dest_art_lang']['idlang']);
413:     }
414: 
415:     return $data;
416: }
417: 
418: /**
419:  * Works as a wrapper for Contenido_Url.
420:  *
421:  * Will also be called by chain 'Contenido.Frontend.CreateURL'.
422:  *
423:  * @todo: Still exists bcause of downwards compatibility (some other modules/plugins are using it)
424:  *
425:  * @param   string  $url  URL to rebuild
426:  * @return  string        New URL
427:  */
428: function mr_buildNewUrl($url) {
429:     global $lang;
430: 
431:     ModRewriteDebugger::add($url, 'mr_buildNewUrl() in -> $url');
432: 
433:     $oUrl = cUri::getInstance();
434:     $aUrl = $oUrl->parse($url);
435: 
436:     // add language, if not exists
437:     if (!isset($aUrl['params']['lang'])) {
438:         $aUrl['params']['lang'] = $lang;
439:     }
440: 
441:     // build url
442:     $newUrl = $oUrl->build($aUrl['params']);
443: 
444:     // add existing fragment
445:     if (isset($aUrl['fragment'])) {
446:         $newUrl .= '#' . $aUrl['fragment'];
447:     }
448: 
449:     $arr = array(
450:         'in' => $url,
451:         'out' => $newUrl,
452:     );
453:     ModRewriteDebugger::add($arr, 'mr_buildNewUrl() in -> out');
454: 
455:     return $newUrl;
456: }
457: 
458: /**
459:  * Replaces existing ancors inside passed code, while rebuilding the urls.
460:  *
461:  * Will be called by chain 'Contenido.Content.conGenerateCode' or
462:  * 'Contenido.Frontend.HTMLCodeOutput' depening on mod_rewrite settings.
463:  *
464:  * @param   string  $code   Code to prepare
465:  * @return  string          New code
466:  */
467: function mr_buildGeneratedCode($code) {
468:     global $client, $cfgClient;
469: 
470:     ModRewriteDebugger::add($code, 'mr_buildGeneratedCode() in');
471: 
472:     // mod rewrite is activated
473:     if (ModRewrite::isEnabled()) {
474:         $sseStarttime = getmicrotime();
475: 
476:         // anchor hack
477:         $code = preg_replace_callback(
478:                 "/<a([^>]*)href\s*=\s*[\"|\'][\/]#(.?|.+?)[\"|\']([^>]*)>/i", create_function('$arr_matches', 'return ModRewrite::rewriteHtmlAnchor($arr_matches);'), $code
479:         );
480: 
481:         // remove fucking tinymce single quote entities:
482:         $code = str_replace("&#39;", "'", $code);
483: 
484:         // == IE hack with wrong base href interpretation
485:         // get base uri
486: //         $sBaseUri = cRegistry::getFrontendUrl();
487: //         $sBaseUri = cApiCecHook::execute("Contenido.Frontend.BaseHrefGeneration", $sBaseUri);
488: //         $code = preg_replace("/([\"|\'|=])upload\/(.?|.+?)([\"|\'|>])/ie", "stripslashes('\\1{$sBaseUri}upload/\\2\\3')", $code);
489: 
490:         $baseUri = cRegistry::getFrontendUrl();
491:         $baseUri = cApiCecHook::execute("Contenido.Frontend.BaseHrefGeneration", $baseUri);
492: 
493:         // CON-1389 modifier /e is deprecated as of PHP 5.5
494:         $code = preg_replace_callback("/([\"|\'|=])upload\/(.?|.+?)([\"|\'|>])/i", create_function('$m', '
495:                 return stripslashes($m[1] . "' . $baseUri . 'upload/" . $m[2] . $m[3]);'), $code);
496: 
497:         // define some preparations to replace /front_content.php & ./front_content.php
498:         // against front_content.php, because urls should start with front_content.php
499:         $aPattern = array(
500:             '/([\"|\'|=])\/front_content\.php(.?|.+?)([\"|\'|>])/i',
501:             '/([\"|\'|=])\.\/front_content\.php(.?|.+?)([\"|\'|>])/i'
502:         );
503: 
504:         $aReplace = array(
505:             '\1front_content.php\2\3',
506:             '\1front_content.php\2\3'
507:         );
508: 
509:         // perform the pre replacements
510:         $code = preg_replace($aPattern, $aReplace, $code);
511: 
512:         // create url stack object and fill it with found urls...
513:         $oMRUrlStack = ModRewriteUrlStack::getInstance();
514:         $oMRUrlStack->add('front_content.php');
515: 
516:         $matches = NULL;
517:         preg_match_all("/([\"|\'|=])front_content\.php(.?|.+?)([\"|\'|>])/i", $code, $matches, PREG_SET_ORDER);
518:         foreach ($matches as $val) {
519:             $oMRUrlStack->add('front_content.php' . $val[2]);
520:         }
521: 
522:         // ok let it beginn, start mod rewrite class
523:         $code = str_replace('"front_content.php"', '"' . mr_buildNewUrl('front_content.php') . '"', $code);
524:         $code = str_replace("'front_content.php'", "'" . mr_buildNewUrl('front_content.php') . "'", $code);
525:         $code = preg_replace_callback(
526:                 "/([\"|\'|=])front_content\.php(.?|.+?)([\"|\'|>])/i", create_function('$aMatches', 'return $aMatches[1] . mr_buildNewUrl("front_content.php" . $aMatches[2]) . $aMatches[3];'), $code
527:         );
528: 
529:         ModRewriteDebugger::add($code, 'mr_buildGeneratedCode() out');
530: 
531:         $sseEndtime = getmicrotime();
532:     } else {
533:         // anchor hack for non modrewrite websites
534:         $code = preg_replace_callback(
535:                 "/<a([^>]*)href\s*=\s*[\"|\'][\/]#(.?|.+?)[\"|\']([^>]*)>/i", create_function('$arr_matches', 'return ModRewrite::contenidoHtmlAnchor($arr_matches, $GLOBALS["is_XHTML"]);'), $code
536:         );
537:     }
538: 
539:     ModRewriteDebugger::add(($sseEndtime - $sseStarttime), 'mr_buildGeneratedCode() total spend time');
540: 
541:     if ($debug = mr_debugOutput(false)) {
542:         $code = cString::iReplaceOnce("</body>", $debug . "\n</body>", $code);
543:     }
544: 
545:     return $code;
546:     // print "\n\n<!-- modrewrite generation time: " . ($sseEndtime - $sseStarttime) . " seconds -->";
547: }
548: 
549: /**
550:  * Sets language of client, like done in front_content.php
551:  *
552:  * @param  int  $client  Client id
553:  */
554: function mr_setClientLanguageId($client) {
555:     global $lang, $load_lang, $cfg;
556: 
557:     if ((int) $lang > 0) {
558:         // there is nothing to do
559:         return;
560:     } elseif ($load_lang) {
561:         // use the first language of this client, load_client is set in __FRONTEND_PATH__/data/config/config.php
562:         $lang = $load_lang;
563:         return;
564:     }
565: 
566:     // try to get clients language from table
567:     $sql = "SELECT B.idlang FROM "
568:             . $cfg['tab']['clients_lang'] . " AS A, "
569:             . $cfg['tab']['lang'] . " AS B "
570:             . "WHERE "
571:             . "A.idclient='" . ((int) $client) . "' AND A.idlang=B.idlang"
572:             . "LIMIT 0,1";
573: 
574:     if ($aData = mr_queryAndNextRecord($sql)) {
575:         $lang = $aData['idlang'];
576:     }
577: }
578: 
579: /**
580:  * Loads Advanced Mod Rewrite configuration for passed client using serialized
581:  * file containing the settings.
582:  *
583:  * File is placed in /contenido/mod_rewrite/includes/and is named like
584:  * config.mod_rewrite_{client_id}.php.
585:  *
586:  * @param  int   $clientId     Id of client
587:  * @param  bool  $forceReload  Flag to force to reload configuration, e. g. after
588:  *                             done changes on it
589:  */
590: function mr_loadConfiguration($clientId, $forceReload = false) {
591:     global $cfg;
592:     static $aLoaded;
593: 
594:     $clientId = (int) $clientId;
595:     if (!isset($aLoaded)) {
596:         $aLoaded = array();
597:     } elseif (isset($aLoaded[$clientId]) && $forceReload == false) {
598:         return;
599:     }
600: 
601:     $mrConfig = mr_getConfiguration($clientId);
602: 
603:     if (is_array($mrConfig)) {
604:         // merge mod rewrite configuration with global cfg array
605:         $cfg = array_merge($cfg, $mrConfig);
606:     } else {
607:         // couldn't load configuration, set defaults
608:         $backendPath = cRegistry::getBackendPath();
609:         include_once($backendPath . $cfg['path']['plugins'] . 'mod_rewrite/includes/config.mod_rewrite_default.php');
610:     }
611: 
612:     $aLoaded[$clientId] = true;
613: }
614: 
615: /**
616:  * Returns the mod rewrite configuration array of an client.
617:  *
618:  * File is placed in /contenido/mod_rewrite/includes/and is named like
619:  * config.mod_rewrite_{client_id}.php.
620:  *
621:  * @param   int   $clientId     Id of client
622:  * @return  array|NULL
623:  */
624: function mr_getConfiguration($clientId) {
625:     global $cfg;
626: 
627:     $clientId = (int) $clientId;
628: 
629:     $backendPath = cRegistry::getBackendPath();
630: 
631:     $clientConfig = cRegistry::getClientConfig($clientId);
632:     $fePath = $clientConfig['path']['frontend'];
633: 
634:     $file = $fePath . 'data/config/' . CON_ENVIRONMENT . '/config.mod_rewrite.php';
635: 
636:     if (!is_file($file) || !is_readable($file)) {
637:         $file = $backendPath . $cfg['path']['plugins'] . 'mod_rewrite/includes/config.mod_rewrite_' . $clientId . '.php';
638:     }
639: 
640:     if (!is_file($file) || !is_readable($file)) {
641:         return NULL;
642:     }
643:     if ($content = cFileHandler::read($file)) {
644:         return unserialize($content);
645:     } else {
646:         return NULL;
647:     }
648: }
649: 
650: /**
651:  * Saves the mod rewrite configuration array of an client.
652:  *
653:  * File is placed in /contenido/mod_rewrite/includes/and is named like
654:  * config.mod_rewrite_{client_id}.php.
655:  *
656:  * @param   int    $clientId     Id of client
657:  * @param   array  $config       Configuration to save
658:  * @return  bool
659:  */
660: function mr_setConfiguration($clientId, array $config) {
661:     global $cfg;
662: 
663:     $clientId = (int) $clientId;
664: 
665:     $clientConfig = cRegistry::getClientConfig($clientId);
666:     $fePath = $clientConfig['path']['frontend'];
667: 
668:     $file = $fePath . 'data/config/' . CON_ENVIRONMENT . '/config.mod_rewrite.php';
669:     $result = cFileHandler::write($file, serialize($config));
670: 
671:     $file = $backendPath . $cfg['path']['plugins'] . 'mod_rewrite/includes/config.mod_rewrite_' . $clientId . '.php';
672:     if (is_file($file) && is_writeable($file)) {
673:         cFileHandler::remove($file, serialize($config));
674:     }
675: 
676:     return ($result) ? true : false;
677: }
678: 
679: /**
680:  * Includes the frontend controller script which parses the url and extacts
681:  * needed data like idcat, idart, lang and client from it.
682:  *
683:  * Will be called by chain 'Contenido.Frontend.AfterLoadPlugins' at front_content.php.
684:  *
685:  * @return  bool  Just a return value
686:  */
687: function mr_runFrontendController() {
688:     $iStartTime = getmicrotime();
689: 
690:     plugin_include('mod_rewrite', 'includes/config.plugin.php');
691: 
692:     if (ModRewrite::isEnabled() == true) {
693:         plugin_include('mod_rewrite', 'includes/front_content_controller.php');
694: 
695:         $totalTime = sprintf('%.4f', (getmicrotime() - $iStartTime));
696:         ModRewriteDebugger::add($totalTime, 'mr_runFrontendController() total time');
697:     }
698: 
699:     return true;
700: }
701: 
702: /**
703:  * Cleanups passed string from characters beeing repeated two or more times
704:  *
705:  * @param   string  $char    Character to remove
706:  * @param   string  $string  String to clean from character
707:  * @return  string  Cleaned string
708:  */
709: function mr_removeMultipleChars($char, $string) {
710:     while (strpos($string, $char . $char) !== false) {
711:         $string = str_replace($char . $char, $char, $string);
712:     }
713:     return $string;
714: }
715: 
716: /**
717:  * Returns amr related translation text
718:  *
719:  * @param   string  $key    The message id as string
720:  * @return  string  Related message
721:  */
722: function mr_i18n($key) {
723:     global $lngAMR;
724:     return (is_array($lngAMR) && isset($lngAMR[$key])) ? $lngAMR[$key] : 'n. a.';
725: }
726: 
727: ################################################################################
728: ### Some helper functions, which are not plugin specific
729: 
730: /**
731:  * Database query helper. Used to execute a select statement and to return the
732:  * result of first recordset.
733:  *
734:  * Minimizes following code:
735:  * <code>
736:  * // default way
737:  * $db  = cRegistry::getDb();
738:  * $sql = "SELECT * FROM foo WHERE bar='foobar'";
739:  * $db->query($sql);
740:  * $db->nextRecord();
741:  * $data = $db->getRecord();
742:  *
743:  * // new way
744:  * $sql  = "SELECT * FROM foo WHERE bar='foobar'";
745:  * $data = mr_queryAndNextRecord($sql);
746:  * </code>
747:  *
748:  * @param   string  $query  Query to execute
749:  * @return  mixed   Assoziative array including recordset or NULL
750:  */
751: function mr_queryAndNextRecord($query) {
752:     static $db;
753:     if (!isset($db)) {
754:         $db = cRegistry::getDb();
755:     }
756:     if (!$db->query($query)) {
757:         return NULL;
758:     }
759:     return ($db->nextRecord()) ? $db->getRecord() : NULL;
760: }
761: 
762: /**
763:  * Returns value of an array key (assoziative or indexed).
764:  *
765:  * Shortcut function for some ways to access to arrays:
766:  * <code>
767:  * // old way
768:  * if (is_array($foo) && isset($foo['bar']) && $foo['bar'] == 'yieeha') {
769:  *     // do something
770:  * }
771:  *
772:  * // new, more readable way:
773:  * if (mr_arrayValue($foo, 'bar') == 'yieeha') {
774:  *     // do something
775:  * }
776:  *
777:  * // old way
778:  * if (is_array($foo) && isset($foo['bar'])) {
779:  *     $jep = $foo['bar'];
780:  * } else {
781:  *     $jep = 'yummy';
782:  * }
783:  *
784:  * // new way
785:  * $jep = mr_arrayValue($foo, 'bar', 'yummy');
786:  * </code>
787:  *
788:  * @param   array  $array    The array
789:  * @param   mixed  $key      Position of an indexed array or key of an assoziative array
790:  * @param   mixed  $default  Default value to return
791:  * @return  mixed  Either the found value or the default value
792:  */
793: function mr_arrayValue($array, $key, $default = NULL) {
794:     if (!is_array($array)) {
795:         return $default;
796:     } elseif (!isset($array[$key])) {
797:         return $default;
798:     } else {
799:         return $array[$key];
800:     }
801: }
802: 
803: /**
804:  * Request cleanup function. Request data is allways tainted and must be filtered.
805:  * Pass the array to cleanup using several options.
806:  * Emulates array_walk_recursive().
807:  *
808:  * @param   mixed  $data     Data to cleanup
809:  * @param   array  $options  Default options array, provides only 'filter' key with several
810:  *                           filter functions which are to execute as follows:
811:  * <code>
812:  * $options['filter'] = array('trim', 'myFilterFunc');
813:  * </code>
814:  *                           If no filter functions are set, 'trim', 'strip_tags' and 'stripslashes'
815:  *                           will be used by default.
816:  *                           A userdefined function must accept the value as a parameter and must return
817:  *                           the filtered parameter, e. g.
818:  * <code>
819:  * function myFilter($data) {
820:  *    // do what you want with the data, e. g. cleanup of xss content
821:  *    return $data;
822:  * }
823:  * </code>
824:  *
825:  * @return  mixed  Cleaned data
826:  */
827: function mr_requestCleanup(&$data, $options = NULL) {
828:     if (!mr_arrayValue($options, 'filter')) {
829:         $options['filter'] = array('trim', 'strip_tags', 'stripslashes');
830:     }
831: 
832:     if (is_array($data)) {
833:         foreach ($data as $p => $v) {
834:             $data[$p] = mr_requestCleanup($v, $options);
835:         }
836:     } else {
837:         foreach ($options['filter'] as $filter) {
838:             if ($filter == 'trim') {
839:                 $data = trim($data);
840:             } elseif ($filter == 'strip_tags') {
841:                 $data = strip_tags($data);
842:             } elseif ($filter == 'stripslashes') {
843:                 $data = stripslashes($data);
844:             } elseif (function_exists($filter)) {
845:                 $data = call_user_func($filter, $data);
846:             }
847:         }
848:     }
849:     return $data;
850: }
851: 
852: /**
853:  * Minimalistic'n simple way to get request variables.
854:  *
855:  * Checks occurance in $_GET, then in $_POST. Uses trim() and strip_tags() to preclean data.
856:  *
857:  * @param   string  $key      Name of var to get
858:  * @param   mixed   $default  Default value to return
859:  * @return  mixed   The value
860:  */
861: function mr_getRequest($key, $default = NULL) {
862:     static $cache;
863:     if (!isset($cache)) {
864:         $cache = array();
865:     }
866:     if (isset($cache[$key])) {
867:         return $cache[$key];
868:     }
869:     if (isset($_GET[$key])) {
870:         $val = $_GET[$key];
871:     } elseif (isset($_POST[$key])) {
872:         $val = $_POST[$key];
873:     } else {
874:         $val = $default;
875:     }
876:     $cache[$key] = strip_tags(trim($val));
877:     return $cache[$key];
878: }
879: 
880: /**
881:  * Replaces calling of header method for redirects in front_content.php,
882:  * used during development.
883:  *
884:  * @param  $header  string Header value for redirect
885:  */
886: function mr_header($header) {
887:     header($header);
888:     return;
889: 
890:     $header = str_replace('Location: ', '', $header);
891:     echo '<html>
892:         <head></head>
893:         <body>
894:         <p><a href="' . $header . '">' . $header . '</a></p>';
895:     mr_debugOutput();
896:     echo '</body></html>';
897:     exit();
898: }
899: 
900: /**
901:  * Debug output only during development
902:  *
903:  * @param   bool  $print  Flag to echo the debug data
904:  * @return  mixed  Either the debug data, if parameter $print is set to true, or nothing
905:  */
906: function mr_debugOutput($print = true) {
907:     global $DB_Contenido_QueryCache;
908:     if (isset($DB_Contenido_QueryCache) && is_array($DB_Contenido_QueryCache) &&
909:             count($DB_Contenido_QueryCache) > 0) {
910:         ModRewriteDebugger::add($DB_Contenido_QueryCache, 'sql statements');
911: 
912:         // calculate total time consumption of queries
913:         $timeTotal = 0;
914:         foreach ($DB_Contenido_QueryCache as $pos => $item) {
915:             $timeTotal += $item['time'];
916:         }
917:         ModRewriteDebugger::add($timeTotal, 'sql total time');
918:     }
919: 
920:     $sOutput = ModRewriteDebugger::getAll();
921:     if ($print == true) {
922:         echo $sOutput;
923:     } else {
924:         return $sOutput;
925:     }
926: }
927: 
CMS CONTENIDO 4.9.11 API documentation generated by ApiGen 2.8.0