view/theme/frio/theme.php

   1 <?php
   2 /*
   3  * Name: frio
   4  * Description: Bootstrap V3 theme. The theme is currently under construction, so it is far from finished. For further information have a look at the <a href="https://github.com/friendica/friendica/tree/develop/view/theme/frio/README.md">ReadMe</a>.
   5  * Version: V.0.8.5
   6  * Author: Rabuzarus <https://friendica.kommune4.de/profile/rabuzarus>
   7  *
   8  */
   9
  10 use Friendica\App;
  11 use Friendica\Content\Text\Plaintext;
  12 use Friendica\Content\Widget;
  13 use Friendica\Core\Hook;
  14 use Friendica\Core\Logger;
  15 use Friendica\Core\Renderer;
  16 use Friendica\Core\Session;
  17 use Friendica\Database\DBA;
  18 use Friendica\DI;
  19 use Friendica\Model;
  20 use Friendica\Module;
  21 use Friendica\Util\Strings;
  22
  23 function frio_init(App $a)
  24 {
  25         global $frio;
  26         $frio = 'view/theme/frio';
  27
  28         // disable the events module link in the profile tab
  29         $a->theme_events_in_profile = false;
  30         $a->videowidth = 622;
  31
  32         Renderer::setActiveTemplateEngine('smarty3');
  33
  34         // if the device is a mobile device set js is_mobile
  35         // variable so the js scripts can use this information
  36         if (DI::mode()->isMobile() || DI::mode()->isMobile()) {
  37                 DI::page()['htmlhead'] .= <<< EOT
  38                         <script type="text/javascript">
  39                                 var is_mobile = 1;
  40                         </script>
  41 EOT;
  42         }
  43 }
  44
  45 function frio_install()
  46 {
  47         Hook::register('prepare_body_final', 'view/theme/frio/theme.php', 'frio_item_photo_links');
  48         Hook::register('item_photo_menu', 'view/theme/frio/theme.php', 'frio_item_photo_menu');
  49         Hook::register('contact_photo_menu', 'view/theme/frio/theme.php', 'frio_contact_photo_menu');
  50         Hook::register('nav_info', 'view/theme/frio/theme.php', 'frio_remote_nav');
  51         Hook::register('acl_lookup_end', 'view/theme/frio/theme.php', 'frio_acl_lookup');
  52         Hook::register('display_item', 'view/theme/frio/theme.php', 'frio_display_item');
  53
  54         Logger::log('installed theme frio');
  55 }
  56
  57 function frio_uninstall()
  58 {
  59         Hook::unregister('prepare_body_final', 'view/theme/frio/theme.php', 'frio_item_photo_links');
  60         Hook::unregister('item_photo_menu', 'view/theme/frio/theme.php', 'frio_item_photo_menu');
  61         Hook::unregister('contact_photo_menu', 'view/theme/frio/theme.php', 'frio_contact_photo_menu');
  62         Hook::unregister('nav_info', 'view/theme/frio/theme.php', 'frio_remote_nav');
  63         Hook::unregister('acl_lookup_end', 'view/theme/frio/theme.php', 'frio_acl_lookup');
  64         Hook::unregister('display_item', 'view/theme/frio/theme.php', 'frio_display_item');
  65
  66         Logger::log('uninstalled theme frio');
  67 }
  68
  69 /**
  70  * Replace friendica photo links hook
  71  *
  72  *  This function does replace the links to photos
  73  *  of other friendica users. Original the photos are
  74  *  linked to the photo page. Now they will linked directly
  75  *  to the photo file. This function is nessesary to use colorbox
  76  *  in the network stream
  77  *
  78  * @param App $a Unused but required by hook definition
  79  * @param array $body_info The item and its html output
  80  */
  81 function frio_item_photo_links(App $a, &$body_info)
  82 {
  83         $occurence = 0;
  84         $p = Plaintext::getBoundariesPosition($body_info['html'], '<a', '>');
  85         while ($p !== false && ($occurence++ < 500)) {
  86                 $link = substr($body_info['html'], $p['start'], $p['end'] - $p['start']);
  87                 $matches = [];
  88
  89                 preg_match('/\/photos\/[\w]+\/image\/([\w]+)/', $link, $matches);
  90                 if ($matches) {
  91                         // Replace the link for the photo's page with a direct link to the photo itself
  92                         $newlink = str_replace($matches[0], "/photo/{$matches[1]}", $link);
  93
  94                         // Add a "quiet" parameter to any redir links to prevent the "XX welcomes YY" info boxes
  95                         $newlink = preg_replace('/href="([^"]+)\/redir\/([^"]+)&url=([^"]+)"/', 'href="$1/redir/$2&quiet=1&url=$3"', $newlink);
  96
  97                         // Having any arguments to the link for Colorbox causes it to fetch base64 code instead of the image
  98                         $newlink = preg_replace('/\/[?&]zrl=([^&"]+)/', '', $newlink);
  99
 100                         $body_info['html'] = str_replace($link, $newlink, $body_info['html']);
 101                 }
 102
 103                 $p = Plaintext::getBoundariesPosition($body_info['html'], '<a', '>', $occurence);
 104         }
 105 }
 106
 107 /**
 108  * Replace links of the item_photo_menu hook
 109  *
 110  *  This function replaces the original poke and the message links
 111  *  to call the addToModal javascript function so this pages can
 112  *  be loaded in a bootstrap modal
 113  *
 114  * @param App $a Unused but required by the hook definition
 115  * @param array $arr Contains item data and the original photo_menu
 116  */
 117 function frio_item_photo_menu(App $a, &$arr)
 118 {
 119         foreach ($arr['menu'] as $k => $v) {
 120                 if (strpos($v, '/poke') === 0 || strpos($v, 'message/new/') === 0) {
 121                         $v = 'javascript:addToModal(\'' . $v . '\'); return false;';
 122                         $arr['menu'][$k] = $v;
 123                 }
 124         }
 125 }
 126
 127 /**
 128  * Replace links of the contact_photo_menu
 129  *
 130  *  This function replaces the original poke and the message links
 131  *  to call the addToModal javascript function so this pages can
 132  *  be loaded in a bootstrap modal
 133  *  Additionally the profile, status and photo page links  will be changed
 134  *  to don't open in a new tab if the contact is a friendica contact.
 135  *
 136  * @param App $a The app data
 137  * @param array $args Contains contact data and the original photo_menu
 138  */
 139 function frio_contact_photo_menu(App $a, &$args)
 140 {
 141         $cid = $args['contact']['id'];
 142
 143         if (!empty($args['menu']['poke'])) {
 144                 $pokelink = $args['menu']['poke'][1];
 145         } else {
 146                 $pokelink = '';
 147         }
 148
 149         if (!empty($args['menu']['poke'])) {
 150                 $pmlink = $args['menu']['pm'][1];
 151         } else {
 152                 $pmlink = '';
 153         }
 154
 155         // Set the the indicator for opening the status, profile and photo pages
 156         // in a new tab to false if the contact a dfrn (friendica) contact
 157         // We do this because we can go back on foreign friendica pages throuhg
 158         // friendicas "magic-link" which indicates a friendica user on froreign
 159         // friendica servers as remote user or visitor
 160         //
 161         // The value for opening in a new tab is e.g. when
 162         // $args['menu']['status'][2] is true. If the value of the [2] key is true
 163         // and if it's a friendica contact we set it to false
 164         foreach ($args['menu'] as $k => $v) {
 165                 if ($k === 'status' || $k === 'profile' || $k === 'photos') {
 166                         $v[2] = (($args['contact']['network'] === 'dfrn') ? false : true);
 167                         $args['menu'][$k][2] = $v[2];
 168                 }
 169         }
 170
 171         // Add to pm and poke links a new key with the value 'modal'.
 172         // Later we can make conditions in the corresponing templates (e.g.
 173         // contact_template.tpl)
 174         if (strpos($pokelink, $cid . '/poke') !== false) {
 175                 $args['menu']['poke'][3] = 'modal';
 176         }
 177
 178         if (strpos($pmlink, 'message/new/' . $cid) !== false) {
 179                 $args['menu']['pm'][3] = 'modal';
 180         }
 181 }
 182
 183 /**
 184  * Construct remote nav menu
 185  *
 186  *  It creates a remote baseurl form $_SESSION for remote users and friendica
 187  *  visitors. This url will be added to some of the nav links. With this behaviour
 188  *  the user will come back to her/his own pages on his/her friendica server.
 189  *  Not all possible links are available (notifications, administrator, manage,
 190  *  notes aren't available because we have no way the check remote permissions)..
 191  *  Some links will point to the local pages because the user would expect
 192  *  local page (these pages are: search, community, help, apps, directory).
 193  *
 194  * @param App $a The App class
 195  * @param array $nav The original nav menu
 196  */
 197 function frio_remote_nav($a, &$nav)
 198 {
 199         // get the homelink from $_XSESSION
 200         $homelink = Model\Profile::getMyURL();
 201         if (!$homelink) {
 202                 $homelink = Session::get('visitor_home', '');
 203         }
 204
 205         // split up the url in it's parts (protocol,domain/directory, /profile/, nickname
 206         // I'm not familiar with regex, so someone might find a better solutionen
 207         //
 208         // E.g $homelink = 'https://friendica.domain.com/profile/mickey' should result in an array
 209         // with 0 => 'https://friendica.domain.com/profile/mickey' 1 => 'https://',
 210         // 2 => 'friendica.domain.com' 3 => '/profile/' 4 => 'mickey'
 211         //
 212         //$server_url = preg_match('/^(https?:\/\/.*?)\/profile\//2', $homelink);
 213         preg_match('/^(https?:\/\/)?(.*?)(\/profile\/)(.*)/', $homelink, $url_parts);
 214
 215         // Construct the server url of the visitor. So we could link back to his/her own menu.
 216         // And construct a webbie (e.g. mickey@friendica.domain.com for the search in gcontact
 217         // We use the webbie for search in gcontact because we don't know if gcontact table stores
 218         // the right value if its http or https protocol
 219         $webbie = '';
 220         if (count($url_parts)) {
 221                 $server_url = $url_parts[1] . $url_parts[2];
 222                 $webbie = $url_parts[4] . '@' . $url_parts[2];
 223         }
 224
 225         // since $userinfo isn't available for the hook we write it to the nav array
 226         // this isn't optimal because the contact query will be done now twice
 227         if (local_user()) {
 228                 // empty the server url for local user because we won't need it
 229                 $server_url = '';
 230                 // user info
 231                 $r = q("SELECT `micro` FROM `contact` WHERE `uid` = %d AND `self`", intval($a->user['uid']));
 232
 233                 $r[0]['photo'] = (DBA::isResult($r) ? DI::baseUrl()->remove($r[0]['micro']) : 'images/person-48.jpg');
 234                 $r[0]['name'] = $a->user['username'];
 235         } elseif (!local_user() && remote_user()) {
 236                 $r = q("SELECT `name`, `nick`, `micro` AS `photo` FROM `contact` WHERE `id` = %d", intval(remote_user()));
 237                 $nav['remote'] = DI::l10n()->t('Guest');
 238         } elseif (Model\Profile::getMyURL()) {
 239                 $r = q("SELECT `name`, `nick`, `photo` FROM `gcontact`
 240                                 WHERE `addr` = '%s' AND `network` = 'dfrn'",
 241                         DBA::escape($webbie));
 242                 $nav['remote'] = DI::l10n()->t('Visitor');
 243         } else {
 244                 $r = false;
 245         }
 246
 247         $remoteUser = null;
 248         if (DBA::isResult($r)) {
 249                 $nav['userinfo'] = [
 250                         'icon' => (DBA::isResult($r) ? $r[0]['photo'] : 'images/person-48.jpg'),
 251                         'name' => $r[0]['name'],
 252                 ];
 253                 $remoteUser = $r[0];
 254         }
 255
 256         if (!local_user() && !empty($server_url) && !is_null($remoteUser)) {
 257                 // user menu
 258                 $nav['usermenu'][] = [$server_url . '/profile/' . $remoteUser['nick'], DI::l10n()->t('Status'), '', DI::l10n()->t('Your posts and conversations')];
 259                 $nav['usermenu'][] = [$server_url . '/profile/' . $remoteUser['nick'] . '/profile', DI::l10n()->t('Profile'), '', DI::l10n()->t('Your profile page')];
 260                 $nav['usermenu'][] = [$server_url . '/photos/' . $remoteUser['nick'], DI::l10n()->t('Photos'), '', DI::l10n()->t('Your photos')];
 261                 $nav['usermenu'][] = [$server_url . '/videos/' . $remoteUser['nick'], DI::l10n()->t('Videos'), '', DI::l10n()->t('Your videos')];
 262                 $nav['usermenu'][] = [$server_url . '/events/', DI::l10n()->t('Events'), '', DI::l10n()->t('Your events')];
 263
 264                 // navbar links
 265                 $nav['network'] = [$server_url . '/network', DI::l10n()->t('Network'), '', DI::l10n()->t('Conversations from your friends')];
 266                 $nav['events'] = [$server_url . '/events', DI::l10n()->t('Events'), '', DI::l10n()->t('Events and Calendar')];
 267                 $nav['messages'] = [$server_url . '/message', DI::l10n()->t('Messages'), '', DI::l10n()->t('Private mail')];
 268                 $nav['settings'] = [$server_url . '/settings', DI::l10n()->t('Settings'), '', DI::l10n()->t('Account settings')];
 269                 $nav['contacts'] = [$server_url . '/contact', DI::l10n()->t('Contacts'), '', DI::l10n()->t('Manage/edit friends and contacts')];
 270                 $nav['sitename'] = DI::config()->get('config', 'sitename');
 271         }
 272 }
 273
 274 /**
 275  * Search for contacts
 276  *
 277  * This function search for a users contacts. The code is copied from contact search
 278  * in /src/Module/Contact.php. With this function the contacts will permitted to acl_lookup()
 279  * and can grabbed as json. For this we use the type="r". This is usful to to let js
 280  * grab the contact data.
 281  * We use this to give the data to textcomplete and have a filter function at the
 282  * contact page.
 283  *
 284  * @param App $a The app data @TODO Unused
 285  * @param array $results The array with the originals from acl_lookup()
 286  */
 287 function frio_acl_lookup(App $a, &$results)
 288 {
 289         $nets = !empty($_GET['nets']) ? Strings::escapeTags(trim($_GET['nets'])) : '';
 290
 291         // we introduce a new search type, r should do the same query like it's
 292         // done in /src/Module/Contact.php for connections
 293         if ($results['type'] !== 'r') {
 294                 return;
 295         }
 296
 297         $sql_extra = '';
 298         if ($results['search']) {
 299                 $search_txt = DBA::escape(Strings::protectSprintf(preg_quote($results['search'])));
 300                 $sql_extra .= " AND (`attag` LIKE '%%" . $search_txt . "%%' OR `name` LIKE '%%" . $search_txt . "%%' OR `nick` LIKE '%%" . $search_txt . "%%') ";
 301         }
 302
 303         if ($nets) {
 304                 $sql_extra .= sprintf(" AND network = '%s' ", DBA::escape($nets));
 305         }
 306
 307         $total = 0;
 308         $r = q("SELECT COUNT(*) AS `total` FROM `contact`
 309                 WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `pending` $sql_extra ", intval($_SESSION['uid']));
 310         if (DBA::isResult($r)) {
 311                 $total = $r[0]['total'];
 312         }
 313
 314         $sql_extra3 = Widget::unavailableNetworks();
 315
 316         $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `pending` $sql_extra $sql_extra3 ORDER BY `name` ASC LIMIT %d, %d ",
 317                 intval($_SESSION['uid']), intval($results['start']), intval($results['count'])
 318         );
 319
 320         $contacts = [];
 321
 322         if (DBA::isResult($r)) {
 323                 foreach ($r as $rr) {
 324                         $contacts[] = Module\Contact::getContactTemplateVars($rr);
 325                 }
 326         }
 327
 328         $results['items'] = $contacts;
 329         $results['tot'] = $total;
 330 }
 331
 332 /**
 333  * Manipulate the data of the item
 334  *
 335  * At the moment we use this function to add some own stuff to the item menu
 336  *
 337  * @param App $a App $a The app data
 338  * @param array $arr Array with the item and the item actions<br>
 339  *     'item' => Array with item data<br>
 340  *     'output' => Array with item actions<br>
 341  */
 342 function frio_display_item(App $a, &$arr)
 343 {
 344         // Add subthread to the item menu
 345         $subthread = [];
 346         if (
 347                 local_user()
 348                 && local_user() == $arr['item']['uid']
 349                 && $arr['item']['parent'] == $arr['item']['id']
 350                 && !$arr['item']['self'])
 351         {
 352                 $subthread = [
 353                         'menu'   => 'follow_thread',
 354                         'title'  => DI::l10n()->t('Follow Thread'),
 355                         'action' => 'dosubthread(' . $arr['item']['id'] . ');',
 356                         'href'   => '#'
 357                 ];
 358         }
 359         $arr['output']['subthread'] = $subthread;
 360 }
 361
 362 /**
 363  * @param int|null $uid
 364  * @return string
 365  * @see \Friendica\Core\Theme::getBackgroundColor()
 366  */
 367 function frio_get_background_color(int $uid = null)
 368 {
 369         $background_color = DI::config()->get('frio', 'background_color') ?: '#ededed';
 370
 371         if ($uid) {
 372                 $background_color = DI::pConfig()->get($uid, 'frio', 'background_color') ?: $background_color;
 373         }
 374
 375         $scheme = DI::config()->get('frio', 'scheme', DI::config()->get('frio', 'schema'));
 376         $scheme = Strings::sanitizeFilePathItem($scheme);
 377
 378         if ($scheme && ($scheme != '---') && file_exists('view/theme/frio/scheme/' . $scheme . '.php')) {
 379                 $schemefile = 'view/theme/frio/scheme/' . $scheme . '.php';
 380                 require_once $schemefile;
 381         }
 382
 383         return $background_color;
 384 }
 385
 386 /**
 387  * @param int|null $uid
 388  * @return string
 389  * @see \Friendica\Core\Theme::getThemeColor()
 390  */
 391 function frio_get_theme_color(int $uid = null)
 392 {
 393         $nav_bg = DI::config()->get('frio', 'nav_bg') ?: '#708fa0';
 394
 395         if ($uid) {
 396                 $nav_bg = DI::pConfig()->get($uid, 'frio', 'background_color') ?: $nav_bg;
 397         }
 398
 399         $scheme = DI::config()->get('frio', 'scheme', DI::config()->get('frio', 'schema'));
 400         $scheme = Strings::sanitizeFilePathItem($scheme);
 401
 402         if ($scheme && ($scheme != '---') && file_exists('view/theme/frio/scheme/' . $scheme . '.php')) {
 403                 $schemefile = 'view/theme/frio/scheme/' . $scheme . '.php';
 404                 require_once $schemefile;
 405         }
 406
 407         return $nav_bg;
 408 }