5 * Description: Collapse posts with inappropriate content
7 * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
10 use Friendica\Core\Hook;
11 use Friendica\Core\L10n;
12 use Friendica\Core\PConfig;
14 function nsfw_install()
16 Hook::register('prepare_body_content_filter', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body_content_filter', 10);
17 Hook::register('addon_settings', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings');
18 Hook::register('addon_settings_post', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings_post');
21 function nsfw_uninstall()
23 Hook::unregister('prepare_body_content_filter', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body_content_filter');
24 Hook::unregister('prepare_body', 'addon/nsfw/nsfw.php', 'nsfw_prepare_body');
25 Hook::unregister('addon_settings', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings');
26 Hook::unregister('addon_settings_post', 'addon/nsfw/nsfw.php', 'nsfw_addon_settings_post');
29 // This function isn't perfect and isn't trying to preserve the html structure - it's just a
30 // quick and dirty filter to pull out embedded photo blobs because 'nsfw' seems to come up
31 // inside them quite often. We don't need anything fancy, just pull out the data blob so we can
32 // check against the rest of the body.
34 function nsfw_extract_photos($body)
38 $img_start = strpos($body, 'src="data:');
39 $img_end = (($img_start !== false) ? strpos(substr($body, $img_start), '>') : false);
43 while ($img_end !== false) {
44 $img_end += $img_start;
45 $new_body = $new_body . substr($body, 0, $img_start);
48 $body = substr($body, 0, $img_end);
50 $img_start = strpos($body, 'src="data:');
51 $img_end = (($img_start !== false) ? strpos(substr($body, $img_start), '>') : false);
60 function nsfw_addon_settings(&$a, &$s)
66 /* Add our stylesheet to the page so we can make our settings look nice */
68 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->getBaseURL() . '/addon/nsfw/nsfw.css' . '" media="all" />' . "\r\n";
70 $enable_checked = (intval(PConfig::get(local_user(), 'nsfw', 'disable')) ? '' : ' checked="checked" ');
71 $words = PConfig::get(local_user(), 'nsfw', 'words');
76 $s .= '<span id="settings_nsfw_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_nsfw_expanded\'); openClose(\'settings_nsfw_inflated\');">';
77 $s .= '<h3>' . L10n::t('Content Filter (NSFW and more)') . '</h3>';
79 $s .= '<div id="settings_nsfw_expanded" class="settings-block" style="display: none;">';
80 $s .= '<span class="fakelink" onclick="openClose(\'settings_nsfw_expanded\'); openClose(\'settings_nsfw_inflated\');">';
81 $s .= '<h3>' . L10n::t('Content Filter (NSFW and more)') . '</h3>';
84 $s .= '<div id="nsfw-wrapper">';
85 $s .= '<p>' . 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.') . '</p>';
86 $s .= '<label id="nsfw-enable-label" for="nsfw-enable">' . L10n::t('Enable Content filter') . ' </label>';
87 $s .= '<input id="nsfw-enable" type="checkbox" name="nsfw-enable" value="1"' . $enable_checked . ' />';
88 $s .= '<div class="clear"></div>';
89 $s .= '<label id="nsfw-label" for="nsfw-words">' . L10n::t('Comma separated list of keywords to hide') . ' </label>';
90 $s .= '<textarea id="nsfw-words" type="text" name="nsfw-words">' . $words . '</textarea>';
91 $s .= '</div><div class="clear"></div>';
93 $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="nsfw-submit" name="nsfw-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div>';
94 $s .= '<div class="nsfw-desc">' . L10n::t('Use /expression/ to provide regular expressions') . '</div></div>';
98 function nsfw_addon_settings_post(&$a, &$b)
104 if (!empty($_POST['nsfw-submit'])) {
105 PConfig::set(local_user(), 'nsfw', 'words', trim($_POST['nsfw-words']));
106 $enable = (!empty($_POST['nsfw-enable']) ? intval($_POST['nsfw-enable']) : 0);
107 $disable = 1 - $enable;
108 PConfig::set(local_user(), 'nsfw', 'disable', $disable);
109 info(L10n::t('NSFW Settings saved.') . EOL);
113 function nsfw_prepare_body_content_filter(\Friendica\App $a, &$hook_data)
116 if (PConfig::get(local_user(), 'nsfw', 'disable')) {
121 $words = PConfig::get(local_user(), 'nsfw', 'words');
125 $word_list = explode(',', $words);
127 $word_list = ['nsfw'];
131 if (count($word_list)) {
132 $body = $hook_data['item']['title'] . "\n" . nsfw_extract_photos($hook_data['item']['body']);
134 foreach ($word_list as $word) {
136 if (!strlen($word)) {
142 case '/'; // Regular expression
143 $found = preg_match($word, $body);
145 case '#': // Hashtag-only search
147 $found = nsfw_find_word_in_item_tags($hook_data['item']['hashtags'], substr($word, 1));
150 $found = stripos($body, $word) !== false || nsfw_find_word_in_item_tags($hook_data['item']['tags'], $word);
162 $hook_data['filter_reasons'][] = L10n::t('Filtered tag: %s', $word);
164 $hook_data['filter_reasons'][] = L10n::t('Filtered word: %s', $word);
169 function nsfw_find_word_in_item_tags($item_tags, $word)
171 if (is_array($item_tags)) {
172 foreach ($item_tags as $tag) {
173 if (stripos($tag, '>' . $word . '<') !== false) {