]> git.mxchange.org Git - friendica-addons.git/blobdiff - nsfw/nsfw.php
Improved logging message
[friendica-addons.git] / nsfw / nsfw.php
old mode 100755 (executable)
new mode 100644 (file)
index af383d2..4a54d89
 <?php
 
-
 /**
  * Name: NSFW
  * Description: Collapse posts with inappropriate content
  * Version: 1.0
  * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
- * 
+ *
  */
 
-function nsfw_install() {
-       register_hook('prepare_body', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body', 10);
-       register_hook('plugin_settings', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings');
-       register_hook('plugin_settings_post', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings_post');
-
-}
-
-
-function nsfw_uninstall() {
-       unregister_hook('prepare_body', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body');
-       unregister_hook('plugin_settings', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings');
-       unregister_hook('plugin_settings_post', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings_post');
+use Friendica\App;
+use Friendica\Core\Hook;
+use Friendica\Core\Renderer;
+use Friendica\DI;
 
+function nsfw_install()
+{
+       Hook::register('prepare_body_content_filter', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body_content_filter', 10);
+       Hook::register('addon_settings', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings');
+       Hook::register('addon_settings_post', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings_post');
 }
 
-// This function isn't perfect and isn't trying to preserve the html structure - it's just a 
-// quick and dirty filter to pull out embedded photo blobs because 'nsfw' seems to come up 
+// This function isn't perfect and isn't trying to preserve the html structure - it's just a
+// quick and dirty filter to pull out embedded photo blobs because 'nsfw' seems to come up
 // inside them quite often. We don't need anything fancy, just pull out the data blob so we can
-// check against the rest of the body. 
-function nsfw_extract_photos($body) {
+// check against the rest of the body.
 
+function nsfw_extract_photos($body)
+{
        $new_body = '';
-       
-       $img_start = strpos($body,'src="data:');
-       $img_end = (($img_start !== false) ? strpos(substr($body,$img_start),'>') : false);
+
+       $img_start = strpos($body, 'src="data:');
+       $img_end = (($img_start !== false) ? strpos(substr($body, $img_start), '>') : false);
 
        $cnt = 0;
 
-       while($img_end !== false) {
+       while ($img_end !== false) {
                $img_end += $img_start;
-               $new_body = $new_body . substr($body,0,$img_start);
-       
-               $cnt ++;
-               $body = substr($body,0,$img_end);
+               $new_body = $new_body . substr($body, 0, $img_start);
 
-               $img_start = strpos($body,'src="data:');
-               $img_end = (($img_start !== false) ? strpos(substr($body,$img_start),'>') : false);
+               $cnt ++;
+               $body = substr($body, 0, $img_end);
 
+               $img_start = strpos($body, 'src="data:');
+               $img_end = (($img_start !== false) ? strpos(substr($body, $img_start), '>') : false);
        }
 
-       if(! $cnt)
+       if (!$cnt) {
                return $body;
-
+       }
        return $new_body;
 }
 
-
-
-
-function nsfw_addon_settings(&$a,&$s) {
-
-
-       if(! local_user())
+function nsfw_addon_settings(array &$data)
+{
+       if (!DI::userSession()->getLocalUserId()) {
                return;
+       }
 
-    /* Add our stylesheet to the page so we can make our settings look nice */
-
-    $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/nsfw/nsfw.css' . '" media="all" />' . "\r\n";
-
-       $enable_checked = (intval(get_pconfig(local_user(),'nsfw','disable')) ? '' : ' checked="checked" ');
-       $words = get_pconfig(local_user(),'nsfw','words');
-       if(! $words)
-               $words = 'nsfw,';
-
-    $s .= '<span id="settings_nsfw_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_nsfw_expanded\'); openClose(\'settings_nsfw_inflated\');">';
-    $s .= '<h3>' . t('Not Safe For Work (General Purpose Content Filter)') . '</h3>';
-    $s .= '</span>';
-    $s .= '<div id="settings_nsfw_expanded" class="settings-block" style="display: none;">';
-    $s .= '<span class="fakelink" onclick="openClose(\'settings_nsfw_expanded\'); openClose(\'settings_nsfw_inflated\');">';
-    $s .= '<h3>' . t('Not Safe For Work (General Purpose Content Filter)') . '</h3>';
-    $s .= '</span>';
-
-    $s .= '<div id="nsfw-wrapper">';
-    $s .= '<p>' . t ('This plugin looks in posts for the words/text you specify below, and collapses any content containing those keywords so it is not displayed at inappropriate times, such as sexual innuendo that may be improper in a work setting. It is polite and recommended to tag any content containing nudity with #NSFW.  This filter can also match any other word/text you specify, and can thereby be used as a general purpose content filter.') . '</p>';
-    $s .= '<label id="nsfw-enable-label" for="nsfw-enable">' . t('Enable Content filter') . ' </label>';
-    $s .= '<input id="nsfw-enable" type="checkbox" name="nsfw-enable" value="1"' . $enable_checked . ' />';
-       $s .= '<div class="clear"></div>';
-    $s .= '<label id="nsfw-label" for="nsfw-words">' . t('Comma separated list of keywords to hide') . ' </label>';
-    $s .= '<textarea id="nsfw-words" type="text" name="nsfw-words">' . $words .'</textarea>';
-    $s .= '</div><div class="clear"></div>';
+       $enabled = !DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'nsfw', 'disable');
+       $words   = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'nsfw', 'words', 'nsfw,');
+
+       $t    = Renderer::getMarkupTemplate('settings.tpl', 'addon/nsfw/');
+       $html = Renderer::replaceMacros($t, [
+               '$info'    => DI::l10n()->t('This addon searches for specified words/text in posts and collapses them. It can be used to filter content tagged with for instance #NSFW that may be deemed inappropriate at certain times or places, such as being at work. It is also useful for hiding irrelevant or annoying content from direct view.'),
+               '$enabled' => ['nsfw-enable', DI::l10n()->t('Enable Content filter'), $enabled],
+               '$words'   => ['nsfw-words', DI::l10n()->t('Comma separated list of keywords to hide'), $words, DI::l10n()->t('Use /expression/ to provide regular expressions, #tag to specfically match hashtags (case-insensitive), or regular words (case-sensitive)')],
+       ]);
+
+       $data = [
+               'addon' => 'nsfw',
+               'title' => DI::l10n()->t('Content Filter (NSFW and more)'),
+               'html'  => $html,
+       ];
+}
 
-    $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="nsfw-submit" name="nsfw-submit" class="settings-submit" value="' . t('Save Settings') . '" /></div>';
-       $s .= '<div class="nsfw-desc">' . t('Use /expression/ to provide regular expressions') . '</div></div>';
+function nsfw_addon_settings_post(array &$b)
+{
+       if (!DI::userSession()->getLocalUserId()) {
+               return;
+       }
 
-       return;
+       if (!empty($_POST['nsfw-submit'])) {
+               $enable = !empty($_POST['nsfw-enable']) ? intval($_POST['nsfw-enable']) : 0;
+               $disable = 1 - $enable;
 
-}
-
-function nsfw_addon_settings_post(&$a,&$b) {
+               $words = trim($_POST['nsfw-words']);
+               $word_list = explode(',', $words);
+               foreach ($word_list as $word) {
+                       $word = trim($word);
+                       if (!$words || strpos($word, '/') !== 0) {
+                               continue;
+                       }
 
-       if(! local_user())
-               return;
+                       if (@preg_match($word, '') === false) {
+                               DI::sysmsg()->addNotice(DI::l10n()->t('Regular expression "%s" fails to compile', $word));
+                       };
+               }
 
-       if($_POST['nsfw-submit']) {
-               set_pconfig(local_user(),'nsfw','words',trim($_POST['nsfw-words']));
-               $enable = ((x($_POST,'nsfw-enable')) ? intval($_POST['nsfw-enable']) : 0);
-               $disable = 1-$enable;
-               set_pconfig(local_user(),'nsfw','disable', $disable);
-               info( t('NSFW Settings saved.') . EOL);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'nsfw', 'words', $words);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'nsfw', 'disable', $disable);
        }
 }
 
-function nsfw_prepare_body(&$a,&$b) {
-
-
+function nsfw_prepare_body_content_filter(&$hook_data)
+{
        $words = null;
-       if(get_pconfig(local_user(),'nsfw','disable'))
+       if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'nsfw', 'disable')) {
                return;
-
-       if(local_user()) {
-               $words = get_pconfig(local_user(),'nsfw','words');
        }
-       if($words) {
-               $arr = explode(',',$words);
+
+       if (DI::userSession()->getLocalUserId()) {
+               $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'nsfw', 'words');
        }
-       else {
-               $arr = array('nsfw');
+
+       if ($words) {
+               $word_list = explode(',', $words);
+       } else {
+               $word_list = ['nsfw'];
        }
 
        $found = false;
-       if(count($arr)) {
-
-               $body = $b['item']['title'] . "\n" . nsfw_extract_photos($b['html']);
+       if (count($word_list)) {
+               $body = $hook_data['item']['title'] . "\n" . nsfw_extract_photos($hook_data['item']['body']);
 
-               foreach($arr as $word) {
+               foreach ($word_list as $word) {
                        $word = trim($word);
-                       if(! strlen($word)) {
+                       if (!strlen($word)) {
                                continue;
                        }
-                       if(strpos($word,'/') === 0) {
-                               if(preg_match($word,$body)) {
-                                       $found = true;
+
+                       $tag_search = false;
+                       switch ($word[0]) {
+                               case '/'; // Regular expression
+                                       $found = @preg_match($word, $body);
                                        break;
-                               }
-                       }
-                       else {
-                               if(stristr($body,$word)) {
-                                       $found = true;
+                               case '#': // Hashtag-only search
+                                       $tag_search = true;
+                                       $found = nsfw_find_word_in_item_tags($hook_data['item']['hashtags'], substr($word, 1));
+                                       break;
+                               default:
+                                       $found = strpos($body, $word) !== false || nsfw_find_word_in_item_tags($hook_data['item']['tags'], $word);
                                        break;
-                               }
-                               if(is_array($b['item']['tags']) && count($b['item']['tags'])) {
-                                       foreach($b['item']['tags'] as $t) {
-                                               if(stristr($t, '>' . $word . '<' )) {
-                                                       $found = true;
-                                                       break;
-                                               }
-                                       }
-                               }
-                       } 
-               }               
+                       }
+
+                       if ($found) {
+                               break;
+                       }
+               }
        }
-       if($found) {
-               $rnd = random_string(8);
-               $b['html'] = '<div id="nsfw-wrap-' . $rnd . '" class="fakelink" onclick=openClose(\'nsfw-' . $rnd . '\'); >' . sprintf( t('%s - Click to open/close'),$word ) . '</div><div id="nsfw-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';  
+
+       if ($found) {
+               if ($tag_search) {
+                       $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered tag: %s', $word);
+               } else {
+                       $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered word: %s', $word);
+               }
        }
 }
+
+function nsfw_find_word_in_item_tags($item_tags, $word)
+{
+       if (is_array($item_tags)) {
+               foreach ($item_tags as $tag) {
+                       if (stripos($tag, '>' . $word . '<') !== false) {
+                               return true;
+                       }
+               }
+       }
+
+       return false;
+}