GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[SensitiveContent] Fix plugin settings

Browse Source 
Also reformatted the code and minor bug fixed it
This commit is contained in:
Diogo Cordeiro
2020-04-07 02:02:21 +01:00
parent 63fd2c7037
commit bb32c0af3b
5 changed files with 460 additions and 415 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/SensitiveContent/README.md
View File

@@ -1,27 +1,21 @@
# "Sensitive" Content Plugin for GNU Social
# "Sensitive" Content Plugin for GNU social
## About
WARNING: THIS IS ALPHA CODE, IT IS PRERELEASE AND SHOULD ONLY BE INSTALLED TO
HELP TEST OR YOU ARE WILLING TO TAKE RISKS.
Create user option to allow a user to hide #NSFW-hashtagged notices behind a
Adds a setting to allow a user to hide #NSFW-hashtagged notices behind a
blocker image until clicked.
Works for both vanilla GNUSocial and with the Qvitter plugin.
Works for both vanilla GNU social and with the Qvitter plugin.
## Install
## Settings
- Move the project directory to ${GNU_SOCIAL}/plugins
- Add addPlugin('SensitiveContent'); to your config.php
If you want to customize the blocker image, add a line to your config.php:
if you want to customize the blocker image, add a line to your config.php:
$config['site']['sensitivecontent']['blockerimage'] = "/path/to/image.jpg";
addPlugin('SensitiveContent', ['blockerimage' => '/path/to/image.jpg']);
if you want to activate the nsfw overlay for non-logged-in visitors add:
$config['site']['sensitivecontent']['hideforvisitors'] = true;
addPlugin('SensitiveContent', ['hideforvisitors' => true]);
## Usage
@@ -35,7 +29,7 @@ be hidden, it will not apply to notices retroactively unless you clear your brow
## License
GNU Affero License
GNU AGPL v3 or later
## Thanks

455
plugins/SensitiveContent/SensitiveContentPlugin.php
View File

@@ -1,76 +1,258 @@
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
if (!defined('GNUSOCIAL')) {
exit(1);
}
/**
* Adds a setting to allow a user to hide #NSFW-hashtagged notices behind a
* blocker image until clicked.
*
* @package GNUsocial
* @author MoonMan
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* Class SensitiveContentPlugin
* Handles the main UI stuff
*
* @package GNUsocial
* @author MoonMan
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class SensitiveContentPlugin extends Plugin
{
const PLUGIN_VERSION = '0.0.1';
public $blockerimage = 'img/blocker.png';
public $hideforvisitors = false;
const PLUGIN_VERSION = '0.1.0';
public function onPluginVersion(array &$versions): bool
{
$versions[] = array('name' => 'Sensitive Content',
'version' => self::PLUGIN_VERSION,
'author' => 'MoonMan',
'homepage' => 'https://gitgud.io/ShitposterClub/SensitiveContent/',
'description' =>
_m('Mark, hide/show sensitive notices like on Twitter.'));
return true;
}
public function onPluginVersion(array &$versions): bool
{
$versions[] = [
'name' => 'Sensitive Content',
'version' => self::PLUGIN_VERSION,
'author' => 'MoonMan',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/SensitiveContent/',
'description' => _m('Mark, hide/show sensitive notices like on Twitter.'),
];
return true;
}
static function settings($setting)
{
$settings['blockerimage'] = Plugin::staticPath('SensitiveContent', '').'img/blocker.png';
$settings['hideforvisitors'] = false;
/**
* What blocker image to use?
*
* @return string
*/
public function getBlockerImage(): string
{
return Plugin::staticPath('SensitiveContent', '') . $this->blockerimage;
}
$configphpsettings = common_config('site','sensitivecontent') ?: array();
foreach($configphpsettings as $configphpsetting=>$value) {
$settings[$configphpsetting] = $value;
}
/**
* @param $profile
* @return bool
*/
public function shouldHide($profile): bool
{
if (isset($profile) && $profile instanceof Profile) {
return $this->getHideSensitive($profile);
}
return $this->hideforvisitors;
}
if(isset($settings[$setting])) {
return $settings[$setting];
}
else FALSE;
}
public function getHideSensitive(Profile $profile): bool
{
$c = Cache::instance();
function onNoticeSimpleStatusArray($notice, &$twitter_status, $scoped)
{
$twitter_status['tags'] = $notice->getTags();
}
// if (!empty($c)) {
// $hidesensitive = $c->get(Cache::key('profile:hide_sensitive:'.$profile->id));
// if (is_numeric($hidesensitive)) {
// return (bool) $hidesensitive;
// } else {
// return false;
// }
// }
function onTwitterUserArray($profile, &$twitter_user, $scoped)
{
if ($scoped instanceof Profile && $scoped->sameAs($profile)) {
$twitter_user['hide_sensitive'] = $this->getHideSensitive($scoped);
}
}
$hidesensitive = $profile->getPref('MoonMan', 'hide_sensitive', '0');
public function onRouterInitialized(URLMapper $m)
{
$m->connect('settings/sensitivecontent',
['action' => 'sensitivecontentsettings']);
}
if (!empty($c)) {
//not using it yet.
$c->set(Cache::key('profile:hide_sensitive:' . $profile->id), $hidesensitive);
}
//common_log(LOG_DEBUG, "SENSITIVECONTENT hidesensitive? id " . $profile->id . " value " . (bool) $hidesensitive );
function onEndAccountSettingsNav($action)
{
$action->menuItem(common_local_url('sensitivecontentsettings'),
_m('MENU', 'Sensitive Content'),
_m('Settings for display of sensitive content.'));
if (is_null($hidesensitive)) {
return false;
}
if (is_numeric($hidesensitive)) {
return (bool)$hidesensitive;
}
return false;
}
return true;
}
/* GNU social EVENTS */
public function onNoticeSimpleStatusArray($notice, &$twitter_status, $scoped)
{
$twitter_status['tags'] = $notice->getTags();
}
public function onQvitterEndShowHeadElements(Action $action)
{
$blocker = static::settings('blockerimage');
common_log( LOG_DEBUG, "SENSITIVECONTENT " . $blocker );
public function onTwitterUserArray($profile, &$twitter_user, $scoped)
{
if ($scoped instanceof Profile && $scoped->sameAs($profile)) {
$twitter_user['hide_sensitive'] = $this->getHideSensitive($scoped);
}
}
public function onRouterInitialized(URLMapper $m)
{
$m->connect('settings/sensitivecontent',
['action' => 'sensitivecontentsettings']);
}
$styles = <<<EOB
public function onEndAccountSettingsNav($action)
{
$action->menuItem(common_local_url('sensitivecontentsettings'),
_m('MENU', 'Sensitive Content'),
_m('Settings for display of sensitive content.'));
return true;
}
public function onEndShowStyles(Action $action)
{
$blocker = $this->getBlockerImage();
$styles = <<<EOB
/* default no show */
html .tagcontainer > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker {
display: none;
}
html[data-hidesensitive='true'] .tagcontainer.data-tag-nsfw > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker {
display: block;
width: 100%;
height: 100%;
position: absolute;
z-index: 100;
/*background-color: #d4baba;*/
background-color: black;
background-image: url({$blocker});
background-repeat: no-repeat;
background-position: center center;
background-size: contain;
transition: opacity 1s ease-in-out;
}
html[data-hidesensitive='true'] .tagcontainer.data-tag-nsfw > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker.reveal {
opacity: 0;
}
EOB;
$action->style($styles);
}
public function onStartShowAttachmentRepresentation($out, $file)
{
$classes = 'sensitive-blocker'; //'sensitive-blocker';
$thumbnail = null;
try {
$thumbnail = $file->getThumbnail();
} catch (Exception $e) {
$thumbnail = null;
}
$thumb_width_css = $thumbnail ? $thumbnail->width . 'px' : '100%';
$thumb_height_css = $thumbnail ? $thumbnail->height . 'px' : '100%';
$out->elementStart('div', [
'class' => 'attachment-wrapper',
'style' => "height: {$thumb_height_css}; width: {$thumb_width_css};",
]); // needs height of thumb
$out->elementStart('div', [
'class' => $classes,
'onclick' => 'toggleSpoiler(event)',
'style' => "height: {$thumb_height_css}; width: {$thumb_width_css};",
]);
$out->raw('&nbsp;');
$out->elementEnd('div');
}
public function onEndShowAttachmentRepresentation($out, $file)
{
$out->elementEnd('div');
}
public function onEndShowScripts(Action $action)
{
$profile = $action->getScoped();
$hidesensitive = $this->shouldHide($profile);
$hidesensitive_string = $hidesensitive ? 'true' : 'false';
$inline = <<<EOB
window.hidesensitive = {$hidesensitive_string};
function toggleSpoiler(evt) {
if (window.hidesensitive) evt.target.classList.toggle('reveal');
}
EOB;
$action->inlineScript($inline);
}
public function onEndOpenNoticeListItemElement(NoticeListItem $nli)
{
$rawtags = $nli->getNotice()->getTags();
$classes = 'tagcontainer';
foreach ($rawtags as $tag) {
$classes = $classes . ' data-tag-' . $tag;
}
$nli->elementStart('span', ['class' => $classes]);
//$nli->elementEnd('span');
}
public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
{
$nli->elementEnd('span');
}
public function onStartHtmlElement($action, &$attrs)
{
$profile = Profile::current();
$hidesensitive = $this->shouldHide($profile);
$attrs = array_merge($attrs,
['data-hidesensitive' => ($hidesensitive ? 'true' : 'false')]
);
}
/* Qvitter's EVENTS */
public function onQvitterEndShowHeadElements(Action $action)
{
$blocker = $this->getBlockerImage();
common_log(LOG_DEBUG, 'SENSITIVECONTENT ' . $blocker);
$styles = <<<EOB
.sensitive-blocker {
display: none;
@@ -83,7 +265,7 @@ height: 100%;
position: absolute;
z-index: 100;
background-color: #d4baba;
background-image: url($blocker);
background-image: url({$blocker});
background-repeat: no-repeat;
background-position: center center;
background-size: contain;
@@ -102,162 +284,11 @@ background-image: none;
EOB;
$action->style($styles);
}
function onQvitterEndShowScripts(Action $action)
{
$action->script( Plugin::staticPath('SensitiveContent', '').'js/sensitivecontent.js' );
}
function onEndShowStyles(Action $action)
{
$blocker = static::settings('blockerimage');
$styles = <<<EOB
/* default no show */
html .tagcontainer > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker {
display: none;
}
html[data-hidesensitive='true'] .tagcontainer.data-tag-nsfw > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker {
display: block;
width: 100%;
height: 100%;
position: absolute;
z-index: 100;
/*background-color: #d4baba;*/
background-color: black;
background-image: url($blocker);
background-repeat: no-repeat;
background-position: center center;
background-size: contain;
transition: opacity 1s ease-in-out;
}
html[data-hidesensitive='true'] .tagcontainer.data-tag-nsfw > footer > .attachments > .inline-attachment > .attachment-wrapper > .sensitive-blocker.reveal {
opacity: 0;
}
EOB;
$action->style($styles);
}
function onStartShowAttachmentRepresentation($out, $file)
{
$classes = "sensitive-blocker"; //'sensitive-blocker';
$thumbnail = null;
try {
$thumbnail = $file->getThumbnail();
} catch (Exception $e) {
$thumbnail = null;
}
$thumb_width_css = $thumbnail ? $thumbnail->width . 'px' : '100%';
$thumb_height_css = $thumbnail ? $thumbnail->height . 'px' : '100%';
$out->elementStart('div', array(
'class' => 'attachment-wrapper',
'style' => "height: {$thumb_height_css}; width: {$thumb_width_css};",
)); /*needs height of thumb*/
$out->elementStart('div', array(
'class' => $classes,
'onclick' => 'toggleSpoiler(event)',
'style' => "height: {$thumb_height_css}; width: {$thumb_width_css};",
));
$out->raw('&nbsp;');
$out->elementEnd('div');
}
function onEndShowAttachmentRepresentation($out, $file)
{
$out->elementEnd('div');
}
function onEndShowScripts(Action $action)
{
$profile = $action->getScoped();
$hidesensitive = $this->getHideSetting($profile);
$hidesensitive_string = $hidesensitive ? "true" : "false";
$inline = <<<EOB
window.hidesensitive = $hidesensitive_string;
function toggleSpoiler(evt) {
if (window.hidesensitive) evt.target.classList.toggle('reveal');
}
EOB;
$action->inlineScript($inline);
}
function onEndOpenNoticeListItemElement(NoticeListItem $nli)
{
$rawtags = $nli->getNotice()->getTags();
$classes = "tagcontainer";
foreach($rawtags as $tag)
{
$classes = $classes . ' data-tag-' . $tag;
}
$nli->elementStart('span', array('class' => $classes));
//$nli->elementEnd('span');
}
function onStartCloseNoticeListItemElement(NoticeListItem $nli)
{
$nli->elementEnd('span');
}
function onStartHtmlElement($action, &$attrs) {
$profile = Profile::current();
$hidesensitive = $this->getHideSetting($profile);
$attrs = array_merge($attrs,
array('data-hidesensitive' => ($hidesensitive ? "true" : "false"))
);
}
function getHideSetting($profile) {
if (isset($profile) && $profile instanceof Profile) {
return $this->getHideSensitive($profile);
} else {
return static::settings('hideforvisitors');
}
}
function getHideSensitive($profile) {
$c = Cache::instance();
/*
if (!empty($c)) {
$hidesensitive = $c->get(Cache::key('profile:hide_sensitive:'.$profile->id));
if (is_numeric($hidesensitive)) {
return (boolean) $hidesensitive;
}
else return FALSE;
}
*/
$hidesensitive = $profile->getPref('MoonMan', 'hide_sensitive', '0');
if (!empty($c)) {
//not using it yet.
$c->set(Cache::key('profile:hide_sensitive:'.$profile->id), $hidesensitive);
}
//common_log(LOG_DEBUG, "SENSITIVECONTENT hidesensitive? id " . $profile->id . " value " . (boolean)$hidesensitive );
if (is_null($hidesensitive)) {
return FALSE;
} else
if (is_numeric($hidesensitive)) {
return (boolean) $hidesensitive;
}
else return FALSE;
}
$action->style($styles);
}
public function onQvitterEndShowScripts(Action $action)
{
$action->script(Plugin::staticPath('SensitiveContent', '') . 'js/sensitivecontent.js');
}
}

28
plugins/SensitiveContent/actions/sensitivecontentsettings.php
View File

@@ -14,8 +14,27 @@
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* Adds a setting to allow a user to hide #NSFW-hashtagged notices behind a
* blocker image until clicked.
*
* @package GNUsocial
* @author MoonMan
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* Class SensitiveContentSettingsAction
* Handles the settings action for this plugin
*
* @package GNUsocial
* @author MoonMan
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class SensitiveContentSettingsAction extends SettingsAction
{
public function title()
@@ -36,8 +55,8 @@ class SensitiveContentSettingsAction extends SettingsAction
'form',
[
'method' => 'post',
'id' => 'sensitivecontent',
'class' => 'form_settings',
'id' => 'sensitivecontent',
'class' => 'form_settings',
'action' => common_local_url('sensitivecontentsettings'),
]
);
@@ -51,11 +70,10 @@ class SensitiveContentSettingsAction extends SettingsAction
'hidesensitive',
_('Hide attachments in posts hashtagged #NSFW'),
($this->arg('hidesensitive') ?
$this->boolean('hidesensitive') : $this->scoped->getPref('MoonMan', 'hide_sensitive', 0))
$this->boolean('hidesensitive') : $this->scoped->getPref('MoonMan', 'hide_sensitive', 0))
);
$this->elementEnd('li');
$this->elementEnd('ul');
$this->submit('save', _m('BUTTON', 'Save'));
@@ -67,6 +85,6 @@ class SensitiveContentSettingsAction extends SettingsAction
{
$hidesensitive = $this->boolean('hidesensitive') ? '1' : '0';
$this->scoped->setPref('MoonMan', 'hide_sensitive', $hidesensitive);
return _('Settings saved.');
return _m('Settings saved.');
}
}

18
plugins/SensitiveContent/locale/SensitiveContent.pot
View File

@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-08-14 14:51+0100\n"
"POT-Creation-Date: 2020-04-07 01:53+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,28 +17,32 @@ msgstr ""
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"
#: SensitiveContentPlugin.php:18
#: SensitiveContentPlugin.php:53
msgid "Mark, hide/show sensitive notices like on Twitter."
msgstr ""
#: SensitiveContentPlugin.php:59
#: SensitiveContentPlugin.php:135
msgctxt "MENU"
msgid "Sensitive Content"
msgstr ""
#: SensitiveContentPlugin.php:60
#: SensitiveContentPlugin.php:136
msgid "Settings for display of sensitive content."
msgstr ""
#: actions/sensitivecontentsettings.php:9
#: actions/sensitivecontentsettings.php:44
msgid "Sensitive content settings"
msgstr ""
#: actions/sensitivecontentsettings.php:14
#: actions/sensitivecontentsettings.php:49
msgid "Set preferences for display of \"sensitive\" content"
msgstr ""
#: actions/sensitivecontentsettings.php:39
#: actions/sensitivecontentsettings.php:80
msgctxt "BUTTON"
msgid "Save"
msgstr ""
#: actions/sensitivecontentsettings.php:90
msgid "Settings saved."
msgstr ""