]> git.mxchange.org Git - friendica.git/blobdiff - include/text.php
Create Core\Renderer Class
[friendica.git] / include / text.php
index 97baee7f60b551a76089ba31efbd66e573bb3412..0c2ea61de9b9f298f4f2d18d24503aef71dcf5ae 100644 (file)
@@ -23,6 +23,10 @@ use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Map;
 use Friendica\Util\Proxy as ProxyUtils;
 
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\Model\FileTag;
+
 require_once "include/conversation.php";
 
 /**
@@ -33,26 +37,21 @@ require_once "include/conversation.php";
  * @param array $r key value pairs (search => replace)
  * @return string substituted string
  */
-function replace_macros($s, $r) {
-
-       $stamp1 = microtime(true);
-
-       $a = get_app();
-
-       // pass $baseurl to all templates
-       $r['$baseurl'] = System::baseUrl();
-
-       $t = $a->template_engine();
-       try {
-               $output = $t->replaceMacros($s, $r);
-       } catch (Exception $e) {
-               echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
-               killme();
-       }
-
-       $a->save_timestamp($stamp1, "rendering");
+function replace_macros($s, $r)
+{
+       return Renderer::replaceMacros($s, $r);
+}
 
-       return $output;
+/**
+ * load template $s
+ *
+ * @param string $s
+ * @param string $root
+ * @return string
+ */
+function get_markup_template($s, $root = '')
+{
+       return Renderer::getMarkupTemplate($s, $root);
 }
 
 /**
@@ -262,132 +261,6 @@ function unxmlify($s) {
        return $ret;
 }
 
-
-/**
- * @brief Paginator function. Pushes relevant links in a pager array structure.
- *
- * Links are generated depending on the current page and the total number of items.
- * Inactive links (like "first" and "prev" on page 1) are given the "disabled" class.
- * Current page link is given the "active" CSS class
- *
- * @param App $a App instance
- * @param int $count [optional] item count (used with minimal pager)
- * @return Array data for pagination template
- */
-function paginate_data(App $a, $count = null) {
-       $stripped = preg_replace('/([&?]page=[0-9]*)/', '', $a->query_string);
-
-       $stripped = str_replace('q=', '', $stripped);
-       $stripped = trim($stripped, '/');
-       $pagenum = $a->pager['page'];
-
-       if (($a->page_offset != '') && !preg_match('/[?&].offset=/', $stripped)) {
-               $stripped .= '&offset=' . urlencode($a->page_offset);
-       }
-
-       $url = $stripped;
-       $data = [];
-
-       function _l(&$d, $name, $url, $text, $class = '') {
-               if (strpos($url, '?') === false && ($pos = strpos($url, '&')) !== false) {
-                       $url = substr($url, 0, $pos) . '?' . substr($url, $pos + 1);
-               }
-
-               $d[$name] = ['url' => $url, 'text' => $text, 'class' => $class];
-       }
-
-       if (!is_null($count)) {
-               // minimal pager (newer / older)
-               $data['class'] = 'pager';
-               _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('newer'), 'previous' . ($a->pager['page'] == 1 ? ' disabled' : ''));
-               _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('older'), 'next' . ($count <= 0 ? ' disabled' : ''));
-       } else {
-               // full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
-               $data['class'] = 'pagination';
-               if ($a->pager['total'] > $a->pager['itemspage']) {
-                       _l($data, 'first', $url . '&page=1', L10n::t('first'), $a->pager['page'] == 1 ? 'disabled' : '');
-                       _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('prev'), $a->pager['page'] == 1 ? 'disabled' : '');
-
-                       $numpages = $a->pager['total'] / $a->pager['itemspage'];
-
-                       $numstart = 1;
-                       $numstop = $numpages;
-
-                       // Limit the number of displayed page number buttons.
-                       if ($numpages > 8) {
-                               $numstart = (($pagenum > 4) ? ($pagenum - 4) : 1);
-                               $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 8));
-                       }
-
-                       $pages = [];
-
-                       for ($i = $numstart; $i <= $numstop; $i++) {
-                               if ($i == $a->pager['page']) {
-                                       _l($pages, $i, '#',  $i, 'current active');
-                               } else {
-                                       _l($pages, $i, $url . '&page='. $i, $i, 'n');
-                               }
-                       }
-
-                       if (($a->pager['total'] % $a->pager['itemspage']) != 0) {
-                               if ($i == $a->pager['page']) {
-                                       _l($pages, $i, '#',  $i, 'current active');
-                               } else {
-                                       _l($pages, $i, $url . '&page=' . $i, $i, 'n');
-                               }
-                       }
-
-                       $data['pages'] = $pages;
-
-                       $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
-                       _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('next'), $a->pager['page'] == $lastpage ? 'disabled' : '');
-                       _l($data, 'last', $url . '&page=' . $lastpage, L10n::t('last'), $a->pager['page'] == $lastpage ? 'disabled' : '');
-               }
-       }
-
-       return $data;
-}
-
-
-/**
- * Automatic pagination.
- *
- *  To use, get the count of total items.
- * Then call $a->set_pager_total($number_items);
- * Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
- * Then call paginate($a) after the end of the display loop to insert the pager block on the page
- * (assuming there are enough items to paginate).
- * When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
- * will limit the results to the correct items for the current page.
- * The actual page handling is then accomplished at the application layer.
- *
- * @param App $a App instance
- * @return string html for pagination #FIXME remove html
- */
-function paginate(App $a) {
-
-       $data = paginate_data($a);
-       $tpl = get_markup_template("paginate.tpl");
-       return replace_macros($tpl, ["pager" => $data]);
-
-}
-
-
-/**
- * Alternative pager
- * @param App $a App instance
- * @param int $i
- * @return string html for pagination #FIXME remove html
- */
-function alt_pager(App $a, $i) {
-
-       $data = paginate_data($a, $i);
-       $tpl = get_markup_template("paginate.tpl");
-       return replace_macros($tpl, ['pager' => $data]);
-
-}
-
-
 /**
  * Loader for infinite scrolling
  * @return string html for loader
@@ -462,30 +335,6 @@ function perms2str($p) {
        return $ret;
 }
 
-/**
- * load template $s
- *
- * @param string $s
- * @param string $root
- * @return string
- */
-function get_markup_template($s, $root = '') {
-       $stamp1 = microtime(true);
-
-       $a = get_app();
-       $t = $a->template_engine();
-       try {
-               $template = $t->getTemplateFile($s, $root);
-       } catch (Exception $e) {
-               echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
-               killme();
-       }
-
-       $a->save_timestamp($stamp1, "file");
-
-       return $template;
-}
-
 /**
  *  for html,xml parsing - let's say you've got
  *  an attribute foobar="class1 class2 class3"
@@ -505,139 +354,6 @@ function attribute_contains($attr, $s) {
        return (count($a) && in_array($s,$a));
 }
 
-
-/* setup int->string log level map */
-$LOGGER_LEVELS = [];
-
-/**
- * @brief Logs the given message at the given log level
- *
- * log levels:
- * LOGGER_WARNING
- * LOGGER_INFO (default)
- * LOGGER_TRACE
- * LOGGER_DEBUG
- * LOGGER_DATA
- * LOGGER_ALL
- *
- * @global array $LOGGER_LEVELS
- * @param string $msg
- * @param int $level
- */
-function logger($msg, $level = LOGGER_INFO) {
-       $a = get_app();
-       global $LOGGER_LEVELS;
-
-       $debugging = Config::get('system', 'debugging');
-       $logfile   = Config::get('system', 'logfile');
-       $loglevel = intval(Config::get('system', 'loglevel'));
-
-       if (
-               !$debugging
-               || !$logfile
-               || $level > $loglevel
-       ) {
-               return;
-       }
-
-       if (count($LOGGER_LEVELS) == 0) {
-               foreach (get_defined_constants() as $k => $v) {
-                       if (substr($k, 0, 7) == "LOGGER_") {
-                               $LOGGER_LEVELS[$v] = substr($k, 7, 7);
-                       }
-               }
-       }
-
-       $process_id = session_id();
-
-       if ($process_id == '') {
-               $process_id = get_app()->process_id;
-       }
-
-       $callers = debug_backtrace();
-
-       if (count($callers) > 1) {
-               $function = $callers[1]['function'];
-       } else {
-               $function = '';
-       }
-
-       $logline = sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
-                       DateTimeFormat::utcNow(DateTimeFormat::ATOM),
-                       $process_id,
-                       $LOGGER_LEVELS[$level],
-                       basename($callers[0]['file']),
-                       $callers[0]['line'],
-                       $function,
-                       $msg
-               );
-
-       $stamp1 = microtime(true);
-       @file_put_contents($logfile, $logline, FILE_APPEND);
-       $a->save_timestamp($stamp1, "file");
-}
-
-/**
- * @brief An alternative logger for development.
- * Works largely as logger() but allows developers
- * to isolate particular elements they are targetting
- * personally without background noise
- *
- * log levels:
- * LOGGER_WARNING
- * LOGGER_INFO (default)
- * LOGGER_TRACE
- * LOGGER_DEBUG
- * LOGGER_DATA
- * LOGGER_ALL
- *
- * @global array $LOGGER_LEVELS
- * @param string $msg
- * @param int $level
- */
-function dlogger($msg, $level = LOGGER_INFO) {
-       $a = get_app();
-
-       $logfile = Config::get('system', 'dlogfile');
-       if (!$logfile) {
-               return;
-       }
-
-       $dlogip = Config::get('system', 'dlogip');
-       if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip) {
-               return;
-       }
-
-       if (count($LOGGER_LEVELS) == 0) {
-               foreach (get_defined_constants() as $k => $v) {
-                       if (substr($k, 0, 7) == "LOGGER_") {
-                               $LOGGER_LEVELS[$v] = substr($k, 7, 7);
-                       }
-               }
-       }
-
-       $process_id = session_id();
-
-       if ($process_id == '') {
-               $process_id = $a->process_id;
-       }
-
-       $callers = debug_backtrace();
-       $logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n",
-                       DateTimeFormat::utcNow(),
-                       $process_id,
-                       basename($callers[0]['file']),
-                       $callers[0]['line'],
-                       $callers[1]['function'],
-                       $msg
-               );
-
-       $stamp1 = microtime(true);
-       @file_put_contents($logfile, $logline, FILE_APPEND);
-       $a->save_timestamp($stamp1, "file");
-}
-
-
 /**
  * Compare activity uri. Knows about activity namespace.
  *
@@ -1191,9 +907,6 @@ function prepare_body(array &$item, $attach = false, $is_preview = false)
                                $a->page['htmlhead'] .= replace_macros(get_markup_template('videos_head.tpl'), [
                                        '$baseurl' => System::baseUrl(),
                                ]);
-                               $a->page['end'] .= replace_macros(get_markup_template('videos_end.tpl'), [
-                                       '$baseurl' => System::baseUrl(),
-                               ]);
                        }
 
                        $url_parts = explode('/', $the_url);
@@ -1359,9 +1072,9 @@ function get_cats_and_terms($item)
        if ($cnt) {
                foreach ($matches as $mtch) {
                        $categories[] = [
-                               'name' => xmlify(file_tag_decode($mtch[1])),
+                               'name' => xmlify(FileTag::decode($mtch[1])),
                                'url' =>  "#",
-                               'removeurl' => ((local_user() == $item['uid'])?'filerm/' . $item['id'] . '?f=&cat=' . xmlify(file_tag_decode($mtch[1])):""),
+                               'removeurl' => ((local_user() == $item['uid'])?'filerm/' . $item['id'] . '?f=&cat=' . xmlify(FileTag::decode($mtch[1])):""),
                                'first' => $first,
                                'last' => false
                        ];
@@ -1380,9 +1093,9 @@ function get_cats_and_terms($item)
                if ($cnt) {
                        foreach ($matches as $mtch) {
                                $folders[] = [
-                                       'name' => xmlify(file_tag_decode($mtch[1])),
+                                       'name' => xmlify(FileTag::decode($mtch[1])),
                                        'url' =>  "#",
-                                       'removeurl' => ((local_user() == $item['uid']) ? 'filerm/' . $item['id'] . '?f=&term=' . xmlify(file_tag_decode($mtch[1])) : ""),
+                                       'removeurl' => ((local_user() == $item['uid']) ? 'filerm/' . $item['id'] . '?f=&term=' . xmlify(FileTag::decode($mtch[1])) : ""),
                                        'first' => $first,
                                        'last' => false
                                ];
@@ -1417,7 +1130,7 @@ function get_plink($item) {
                        ];
 
                if (x($item, 'plink')) {
-                       $ret["href"] = $a->remove_baseurl($item['plink']);
+                       $ret["href"] = $a->removeBaseURL($item['plink']);
                        $ret["title"] = L10n::t('link to source');
                }
 
@@ -1482,7 +1195,7 @@ function base64url_encode($s, $strip_padding = false) {
 function base64url_decode($s) {
 
        if (is_array($s)) {
-               logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
+               Logger::log('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
                return $s;
        }
 
@@ -1620,199 +1333,6 @@ function item_post_type($item) {
        return L10n::t('post');
 }
 
-// post categories and "save to file" use the same item.file table for storage.
-// We will differentiate the different uses by wrapping categories in angle brackets
-// and save to file categories in square brackets.
-// To do this we need to escape these characters if they appear in our tag.
-
-function file_tag_encode($s) {
-       return str_replace(['<','>','[',']'],['%3c','%3e','%5b','%5d'],$s);
-}
-
-function file_tag_decode($s) {
-       return str_replace(['%3c', '%3e', '%5b', '%5d'], ['<', '>', '[', ']'], $s);
-}
-
-function file_tag_file_query($table,$s,$type = 'file') {
-
-       if ($type == 'file') {
-               $str = preg_quote('[' . str_replace('%', '%%', file_tag_encode($s)) . ']');
-       } else {
-               $str = preg_quote('<' . str_replace('%', '%%', file_tag_encode($s)) . '>');
-       }
-       return " AND " . (($table) ? DBA::escape($table) . '.' : '') . "file regexp '" . DBA::escape($str) . "' ";
-}
-
-// ex. given music,video return <music><video> or [music][video]
-function file_tag_list_to_file($list, $type = 'file') {
-       $tag_list = '';
-       if (strlen($list)) {
-               $list_array = explode(",",$list);
-               if ($type == 'file') {
-                       $lbracket = '[';
-                       $rbracket = ']';
-               } else {
-                       $lbracket = '<';
-                       $rbracket = '>';
-               }
-
-               foreach ($list_array as $item) {
-                       if (strlen($item)) {
-                               $tag_list .= $lbracket . file_tag_encode(trim($item))  . $rbracket;
-                       }
-               }
-       }
-       return $tag_list;
-}
-
-// ex. given <music><video>[friends], return music,video or friends
-function file_tag_file_to_list($file, $type = 'file') {
-       $matches = false;
-       $list = '';
-       if ($type == 'file') {
-               $cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
-       } else {
-               $cnt = preg_match_all('/<(.*?)>/', $file, $matches, PREG_SET_ORDER);
-       }
-       if ($cnt) {
-               foreach ($matches as $mtch) {
-                       if (strlen($list)) {
-                               $list .= ',';
-                       }
-                       $list .= file_tag_decode($mtch[1]);
-               }
-       }
-
-       return $list;
-}
-
-function file_tag_update_pconfig($uid, $file_old, $file_new, $type = 'file') {
-       // $file_old - categories previously associated with an item
-       // $file_new - new list of categories for an item
-
-       if (!intval($uid)) {
-               return false;
-       } elseif ($file_old == $file_new) {
-               return true;
-       }
-
-       $saved = PConfig::get($uid, 'system', 'filetags');
-       if (strlen($saved)) {
-               if ($type == 'file') {
-                       $lbracket = '[';
-                       $rbracket = ']';
-                       $termtype = TERM_FILE;
-               } else {
-                       $lbracket = '<';
-                       $rbracket = '>';
-                       $termtype = TERM_CATEGORY;
-               }
-
-               $filetags_updated = $saved;
-
-               // check for new tags to be added as filetags in pconfig
-               $new_tags = [];
-               $check_new_tags = explode(",",file_tag_file_to_list($file_new,$type));
-
-               foreach ($check_new_tags as $tag) {
-                       if (!stristr($saved,$lbracket . file_tag_encode($tag) . $rbracket)) {
-                               $new_tags[] = $tag;
-                       }
-               }
-
-               $filetags_updated .= file_tag_list_to_file(implode(",",$new_tags),$type);
-
-               // check for deleted tags to be removed from filetags in pconfig
-               $deleted_tags = [];
-               $check_deleted_tags = explode(",",file_tag_file_to_list($file_old,$type));
-
-               foreach ($check_deleted_tags as $tag) {
-                       if (!stristr($file_new,$lbracket . file_tag_encode($tag) . $rbracket)) {
-                               $deleted_tags[] = $tag;
-                       }
-               }
-
-               foreach ($deleted_tags as $key => $tag) {
-                       $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
-                               DBA::escape($tag),
-                               intval(TERM_OBJ_POST),
-                               intval($termtype),
-                               intval($uid));
-
-                       if (DBA::isResult($r)) {
-                               unset($deleted_tags[$key]);
-                       } else {
-                               $filetags_updated = str_replace($lbracket . file_tag_encode($tag) . $rbracket,'',$filetags_updated);
-                       }
-               }
-
-               if ($saved != $filetags_updated) {
-                       PConfig::set($uid, 'system', 'filetags', $filetags_updated);
-               }
-               return true;
-       } elseif (strlen($file_new)) {
-               PConfig::set($uid, 'system', 'filetags', $file_new);
-       }
-       return true;
-}
-
-function file_tag_save_file($uid, $item_id, $file)
-{
-       if (!intval($uid)) {
-               return false;
-       }
-
-       $item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
-       if (DBA::isResult($item)) {
-               if (!stristr($item['file'],'[' . file_tag_encode($file) . ']')) {
-                       $fields = ['file' => $item['file'] . '[' . file_tag_encode($file) . ']'];
-                       Item::update($fields, ['id' => $item_id]);
-               }
-               $saved = PConfig::get($uid, 'system', 'filetags');
-               if (!strlen($saved) || !stristr($saved, '[' . file_tag_encode($file) . ']')) {
-                       PConfig::set($uid, 'system', 'filetags', $saved . '[' . file_tag_encode($file) . ']');
-               }
-               info(L10n::t('Item filed'));
-       }
-       return true;
-}
-
-function file_tag_unsave_file($uid, $item_id, $file, $cat = false)
-{
-       if (!intval($uid)) {
-               return false;
-       }
-
-       if ($cat == true) {
-               $pattern = '<' . file_tag_encode($file) . '>' ;
-               $termtype = TERM_CATEGORY;
-       } else {
-               $pattern = '[' . file_tag_encode($file) . ']' ;
-               $termtype = TERM_FILE;
-       }
-
-       $item = Item::selectFirst(['file'], ['id' => $item_id, 'uid' => $uid]);
-       if (!DBA::isResult($item)) {
-               return false;
-       }
-
-       $fields = ['file' => str_replace($pattern,'',$item['file'])];
-       Item::update($fields, ['id' => $item_id]);
-
-       $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
-               DBA::escape($file),
-               intval(TERM_OBJ_POST),
-               intval($termtype),
-               intval($uid)
-       );
-       if (!DBA::isResult($r)) {
-               $saved = PConfig::get($uid, 'system', 'filetags');
-               PConfig::set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
-       }
-
-       return true;
-}
-
 function normalise_openid($s) {
        return trim(str_replace(['http://', 'https://'], ['', ''], $s), '/');
 }