use Friendica\App;
use Friendica\BaseModule;
use Friendica\Content\Text\Markdown;
-use Friendica\Core\Cache;
use Friendica\Core\Hook;
-use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
use Friendica\Model\Item;
-use Friendica\Model\Term;
-use Friendica\Module\Login;
+use Friendica\Model\Post;
+use Friendica\Model\Tag;
+use Friendica\Model\User;
+use Friendica\Module\Security\Login;
use Friendica\Network\HTTPException;
use Friendica\Util\DateTimeFormat;
use Psr\Http\Message\ResponseInterface;
Hook::register('prepare_body_content_filter', __FILE__, 'advancedcontentfilter_prepare_body_content_filter');
Hook::register('addon_settings' , __FILE__, 'advancedcontentfilter_addon_settings');
- DBStructure::update(false, true);
+ Hook::add('dbstructure_definition' , __FILE__, 'advancedcontentfilter_dbstructure_definition');
+ DBStructure::performUpdate();
- Logger::log("installed advancedcontentfilter");
-}
-
-function advancedcontentfilter_uninstall()
-{
- Hook::unregister('dbstructure_definition' , __FILE__, 'advancedcontentfilter_dbstructure_definition');
- Hook::unregister('prepare_body_content_filter', __FILE__, 'advancedcontentfilter_prepare_body_content_filter');
- Hook::unregister('addon_settings' , __FILE__, 'advancedcontentfilter_addon_settings');
+ Logger::notice('installed advancedcontentfilter');
}
/*
* Hooks
*/
-function advancedcontentfilter_dbstructure_definition(App $a, &$database)
+function advancedcontentfilter_dbstructure_definition(&$database)
{
- $database["advancedcontentfilter_rules"] = [
- "comment" => "Advancedcontentfilter addon rules",
- "fields" => [
- "id" => ["type" => "int unsigned", "not null" => "1", "extra" => "auto_increment", "primary" => "1", "comment" => "Auto incremented rule id"],
- "uid" => ["type" => "int unsigned", "not null" => "1", "comment" => "Owner user id"],
- "name" => ["type" => "varchar(255)", "not null" => "1", "comment" => "Rule name"],
- "expression" => ["type" => "mediumtext" , "not null" => "1", "comment" => "Expression text"],
- "serialized" => ["type" => "mediumtext" , "not null" => "1", "comment" => "Serialized parsed expression"],
- "active" => ["type" => "boolean" , "not null" => "1", "default" => "1", "comment" => "Whether the rule is active or not"],
- "created" => ["type" => "datetime" , "not null" => "1", "default" => DBA::NULL_DATETIME, "comment" => "Creation date"],
+ $database['advancedcontentfilter_rules'] = [
+ 'comment' => 'Advancedcontentfilter addon rules',
+ 'fields' => [
+ 'id' => ['type' => 'int unsigned', 'not null' => '1', 'extra' => 'auto_increment', 'primary' => '1', 'comment' => 'Auto incremented rule id'],
+ 'uid' => ['type' => 'int unsigned', 'not null' => '1', 'comment' => 'Owner user id'],
+ 'name' => ['type' => 'varchar(255)', 'not null' => '1', 'comment' => 'Rule name'],
+ 'expression' => ['type' => 'mediumtext' , 'not null' => '1', 'comment' => 'Expression text'],
+ 'serialized' => ['type' => 'mediumtext' , 'not null' => '1', 'comment' => 'Serialized parsed expression'],
+ 'active' => ['type' => 'boolean' , 'not null' => '1', 'default' => '1', 'comment' => 'Whether the rule is active or not'],
+ 'created' => ['type' => 'datetime' , 'not null' => '1', 'default' => DBA::NULL_DATETIME, 'comment' => 'Creation date'],
],
- "indexes" => [
- "PRIMARY" => ["id"],
- "uid_active" => ["uid", "active"],
+ 'indexes' => [
+ 'PRIMARY' => ['id'],
+ 'uid_active' => ['uid', 'active'],
]
];
}
-function advancedcontentfilter_prepare_body_content_filter(App $a, &$hook_data)
+/**
+ * @param array $item Prepared by either Model\Item::prepareBody or advancedcontentfilter_prepare_item_row
+ * @return array
+ */
+function advancedcontentfilter_get_filter_fields(array $item)
+{
+ $vars = [];
+
+ // Convert the language JSON text into a filterable format
+ if (!empty($item['language']) && ($languages = json_decode($item['language'], true))) {
+ foreach ($languages as $key => $value) {
+ $vars['language_' . strtolower($key)] = $value;
+ }
+ }
+
+ foreach ($item as $key => $value) {
+ $vars[str_replace('-', '_', $key)] = $value;
+ }
+
+ ksort($vars);
+
+ return $vars;
+}
+
+function advancedcontentfilter_prepare_body_content_filter(&$hook_data)
{
static $expressionLanguage;
$expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
}
- if (!local_user()) {
+ if (!DI::userSession()->getLocalUserId()) {
return;
}
- $vars = [];
- foreach ($hook_data['item'] as $key => $value) {
- $vars[str_replace('-', '_', $key)] = $value;
- }
+ $vars = advancedcontentfilter_get_filter_fields($hook_data['item']);
- $rules = Cache::get('rules_' . local_user());
+ $rules = DI::cache()->get('rules_' . DI::userSession()->getLocalUserId());
if (!isset($rules)) {
$rules = DBA::toArray(DBA::select(
'advancedcontentfilter_rules',
['name', 'expression', 'serialized'],
- ['uid' => local_user(), 'active' => true]
+ ['uid' => DI::userSession()->getLocalUserId(), 'active' => true]
));
+
+ DI::cache()->set('rules_' . DI::userSession()->getLocalUserId(), $rules);
}
if ($rules) {
}
if ($found) {
- $hook_data['filter_reasons'][] = L10n::t('Filtered by rule: %s', $rule['name']);
+ $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered by rule: %s', $rule['name']);
break;
}
}
}
-function advancedcontentfilter_addon_settings(App $a, &$s)
+function advancedcontentfilter_addon_settings(array &$data)
{
- if (!local_user()) {
+ if (!DI::userSession()->getLocalUserId()) {
return;
}
- $advancedcontentfilter = L10n::t('Advanced Content Filter');
-
- $s .= <<<HTML
- <span class="settings-block fakelink" style="display: block;"><h3><a href="advancedcontentfilter">$advancedcontentfilter <i class="glyphicon glyphicon-share"></i></a></h3></span>
-HTML;
-
- return;
+ $data = [
+ 'addon' => 'advancedcontentfilter',
+ 'title' => DI::l10n()->t('Advanced Content Filter'),
+ 'href' => 'advancedcontentfilter',
+ ];
}
/*
* Module
*/
+/**
+ * This is a statement rather than an actual function definition. The simple
+ * existence of this method is checked to figure out if the addon offers a
+ * module.
+ */
function advancedcontentfilter_module() {}
-function advancedcontentfilter_init(App $a)
+function advancedcontentfilter_init()
{
- if ($a->argc > 1 && $a->argv[1] == 'api') {
- $slim = new \Slim\App();
+ if (DI::args()->getArgc() > 1 && DI::args()->getArgv()[1] == 'api') {
+ $slim = \Slim\Factory\AppFactory::create();
require __DIR__ . '/src/middlewares.php';
}
}
-function advancedcontentfilter_content(App $a)
+function advancedcontentfilter_content()
{
- if (!local_user()) {
- return Login::form('/' . implode('/', $a->argv));
+ if (!DI::userSession()->getLocalUserId()) {
+ return Login::form('/' . implode('/', DI::args()->getArgv()));
}
- if ($a->argc > 1 && $a->argv[1] == 'help') {
- $lang = $a->user['language'];
+ if (DI::args()->getArgc() > 1 && DI::args()->getArgv()[1] == 'help') {
+ $user = User::getById(DI::userSession()->getLocalUserId());
+
+ $lang = $user['language'];
$default_dir = 'addon/advancedcontentfilter/doc/';
$help_file = 'advancedcontentfilter.md';
$t = Renderer::getMarkupTemplate('settings.tpl', 'addon/advancedcontentfilter/');
return Renderer::replaceMacros($t, [
'$messages' => [
- 'backtosettings' => L10n::t('Back to Addon Settings'),
- 'title' => L10n::t('Advanced Content Filter'),
- 'add_a_rule' => L10n::t('Add a Rule'),
- 'help' => L10n::t('Help'),
- 'intro' => L10n::t('Add and manage your personal content filter rules in this screen. Rules have a name and an arbitrary expression that will be matched against post data. For a complete reference of the available operations and variables, check the help page.'),
- 'your_rules' => L10n::t('Your rules'),
- 'no_rules' => L10n::t('You have no rules yet! Start adding one by clicking on the button above next to the title.'),
- 'disabled' => L10n::t('Disabled'),
- 'enabled' => L10n::t('Enabled'),
- 'disable_this_rule' => L10n::t('Disable this rule'),
- 'enable_this_rule' => L10n::t('Enable this rule'),
- 'edit_this_rule' => L10n::t('Edit this rule'),
- 'edit_the_rule' => L10n::t('Edit the rule'),
- 'save_this_rule' => L10n::t('Save this rule'),
- 'delete_this_rule' => L10n::t('Delete this rule'),
- 'rule' => L10n::t('Rule'),
- 'close' => L10n::t('Close'),
- 'addtitle' => L10n::t('Add new rule'),
- 'rule_name' => L10n::t('Rule Name'),
- 'rule_expression' => L10n::t('Rule Expression'),
- 'cancel' => L10n::t('Cancel'),
+ 'backtosettings' => DI::l10n()->t('Back to Addon Settings'),
+ 'title' => DI::l10n()->t('Advanced Content Filter'),
+ 'add_a_rule' => DI::l10n()->t('Add a Rule'),
+ 'help' => DI::l10n()->t('Help'),
+ 'intro' => DI::l10n()->t('Add and manage your personal content filter rules in this screen. Rules have a name and an arbitrary expression that will be matched against post data. For a complete reference of the available operations and variables, check the help page.'),
+ 'your_rules' => DI::l10n()->t('Your rules'),
+ 'no_rules' => DI::l10n()->t('You have no rules yet! Start adding one by clicking on the button above next to the title.'),
+ 'disabled' => DI::l10n()->t('Disabled'),
+ 'enabled' => DI::l10n()->t('Enabled'),
+ 'disable_this_rule' => DI::l10n()->t('Disable this rule'),
+ 'enable_this_rule' => DI::l10n()->t('Enable this rule'),
+ 'edit_this_rule' => DI::l10n()->t('Edit this rule'),
+ 'edit_the_rule' => DI::l10n()->t('Edit the rule'),
+ 'save_this_rule' => DI::l10n()->t('Save this rule'),
+ 'delete_this_rule' => DI::l10n()->t('Delete this rule'),
+ 'rule' => DI::l10n()->t('Rule'),
+ 'close' => DI::l10n()->t('Close'),
+ 'addtitle' => DI::l10n()->t('Add new rule'),
+ 'rule_name' => DI::l10n()->t('Rule Name'),
+ 'rule_expression' => DI::l10n()->t('Rule Expression'),
+ 'cancel' => DI::l10n()->t('Cancel'),
],
- '$current_theme' => $a->getCurrentTheme(),
- '$rules' => advancedcontentfilter_get_rules(),
+ '$current_theme' => DI::app()->getCurrentTheme(),
+ '$rules' => DBA::toArray(DBA::select('advancedcontentfilter_rules', [], ['uid' => DI::userSession()->getLocalUserId()])),
'$form_security_token' => BaseModule::getFormSecurityToken()
]);
}
}
if (!empty($data['expression'])) {
- $allowed_keys = [
- 'author_id', 'author_link', 'author_name', 'author_avatar',
- 'owner_id', 'owner_link', 'owner_name', 'owner_avatar',
- 'contact_id', 'uid', 'id', 'parent', 'uri',
- 'thr_parent', 'parent_uri',
- 'content_warning',
- 'commented', 'created', 'edited', 'received',
- 'verb', 'object_type', 'postopts', 'plink', 'guid', 'wall', 'private', 'starred',
- 'title', 'body',
- 'file', 'event_id', 'location', 'coord', 'app', 'attach',
- 'rendered_hash', 'rendered_html', 'object',
- 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
- 'item_id', 'item_network', 'author_thumb', 'owner_thumb',
- 'network', 'url', 'name', 'writable', 'self',
- 'cid', 'alias',
- 'event_created', 'event_edited', 'event_start', 'event_finish', 'event_summary',
- 'event_desc', 'event_location', 'event_type', 'event_nofinish', 'event_adjust', 'event_ignore',
- 'children', 'pagedrop', 'tags', 'hashtags', 'mentions',
- ];
+ // Using a dummy item to validate the field existence
+ $condition = ["(`uid` = ? OR `uid` = 0)", DI::userSession()->getLocalUserId()];
+ $params = ['order' => ['uid' => true]];
+ $item_row = Post::selectFirstForUser(DI::userSession()->getLocalUserId(), [], $condition, $params);
- $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
+ if (!DBA::isResult($item_row)) {
+ throw new HTTPException\NotFoundException(DI::l10n()->t('This addon requires this node having at least one post'));
+ }
- $parsedExpression = $expressionLanguage->parse($data['expression'], $allowed_keys);
+ $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
+ $parsedExpression = $expressionLanguage->parse(
+ $data['expression'],
+ array_keys(advancedcontentfilter_get_filter_fields(advancedcontentfilter_prepare_item_row($item_row)))
+ );
$serialized = serialize($parsedExpression->getNodes());
* API
*/
-function advancedcontentfilter_get_rules()
+function advancedcontentfilter_get_rules(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
- $rules = DBA::toArray(DBA::select('advancedcontentfilter_rules', [], ['uid' => local_user()]));
+ $rules = DBA::toArray(DBA::select('advancedcontentfilter_rules', [], ['uid' => DI::userSession()->getLocalUserId()]));
- return json_encode($rules);
+ $response->getBody()->write(json_encode($rules));
+ return $response->withHeader('Content-Type', 'application/json');
}
function advancedcontentfilter_get_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
- $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => $args['id'], 'uid' => local_user()]);
+ $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => $args['id'], 'uid' => DI::userSession()->getLocalUserId()]);
- return json_encode($rule);
+ $response->getBody()->write(json_encode($rule));
+ return $response->withHeader('Content-Type', 'application/json');
}
-function advancedcontentfilter_post_rules(ServerRequestInterface $request)
+function advancedcontentfilter_post_rules(ServerRequestInterface $request, ResponseInterface $response)
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
if (!BaseModule::checkFormSecurityToken()) {
- throw new HTTPException\BadRequestException(L10n::t('Invalid form security token, please refresh the page.'));
+ throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
}
$data = json_decode($request->getBody(), true);
try {
$fields = advancedcontentfilter_build_fields($data);
} catch (Exception $e) {
- throw new HTTPException\BadRequestException($e->getMessage(), 0, $e);
+ throw new HTTPException\BadRequestException($e->getMessage(), $e);
}
if (empty($fields['name']) || empty($fields['expression'])) {
- throw new HTTPException\BadRequestException(L10n::t('The rule name and expression are required.'));
+ throw new HTTPException\BadRequestException(DI::l10n()->t('The rule name and expression are required.'));
}
- $fields['uid'] = local_user();
+ $fields['uid'] = DI::userSession()->getLocalUserId();
$fields['created'] = DateTimeFormat::utcNow();
if (!DBA::insert('advancedcontentfilter_rules', $fields)) {
- throw new HTTPException\ServiceUnavaiableException(DBA::errorMessage());
+ throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
}
$rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => DBA::lastInsertId()]);
- return json_encode(['message' => L10n::t('Rule successfully added'), 'rule' => $rule]);
+ DI::cache()->delete('rules_' . DI::userSession()->getLocalUserId());
+
+ $response->getBody()->write(json_encode(['message' => DI::l10n()->t('Rule successfully added'), 'rule' => $rule]));
+ return $response->withHeader('Content-Type', 'application/json');
}
function advancedcontentfilter_put_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
if (!BaseModule::checkFormSecurityToken()) {
- throw new HTTPException\BadRequestException(L10n::t('Invalid form security token, please refresh the page.'));
+ throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
}
- if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
- throw new HTTPException\NotFoundException(L10n::t('Rule doesn\'t exist or doesn\'t belong to you.'));
+ if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => DI::userSession()->getLocalUserId()])) {
+ throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
}
$data = json_decode($request->getBody(), true);
try {
$fields = advancedcontentfilter_build_fields($data);
} catch (Exception $e) {
- throw new HTTPException\BadRequestException($e->getMessage(), 0, $e);
+ throw new HTTPException\BadRequestException($e->getMessage(), $e);
}
if (!DBA::update('advancedcontentfilter_rules', $fields, ['id' => $args['id']])) {
- throw new HTTPException\ServiceUnavaiableException(DBA::errorMessage());
+ throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
}
- return json_encode(['message' => L10n::t('Rule successfully updated')]);
+ DI::cache()->delete('rules_' . DI::userSession()->getLocalUserId());
+
+ $response->getBody()->write(json_encode(['message' => DI::l10n()->t('Rule successfully updated')]));
+ return $response->withHeader('Content-Type', 'application/json');
}
function advancedcontentfilter_delete_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
if (!BaseModule::checkFormSecurityToken()) {
- throw new HTTPException\BadRequestException(L10n::t('Invalid form security token, please refresh the page.'));
+ throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
}
- if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
- throw new HTTPException\NotFoundException(L10n::t('Rule doesn\'t exist or doesn\'t belong to you.'));
+ if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => DI::userSession()->getLocalUserId()])) {
+ throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
}
if (!DBA::delete('advancedcontentfilter_rules', ['id' => $args['id']])) {
- throw new HTTPException\ServiceUnavaiableException(DBA::errorMessage());
+ throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
}
- return json_encode(['message' => L10n::t('Rule successfully deleted')]);
+ DI::cache()->delete('rules_' . DI::userSession()->getLocalUserId());
+
+ $response->getBody()->write(json_encode(['message' => DI::l10n()->t('Rule successfully deleted')]));
+ return $response->withHeader('Content-Type', 'application/json');
}
function advancedcontentfilter_get_variables_guid(ServerRequestInterface $request, ResponseInterface $response, $args)
{
- if (!local_user()) {
- throw new HTTPException\UnauthorizedException(L10n::t('You must be logged in to use this method'));
+ if (!DI::userSession()->getLocalUserId()) {
+ throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
}
if (!isset($args['guid'])) {
- throw new HTTPException\BadRequestException(L10n::t('Missing argument: guid.'));
+ throw new HTTPException\BadRequestException(DI::l10n()->t('Missing argument: guid.'));
}
- $condition = ["`guid` = ? AND (`uid` = ? OR `uid` = 0)", $args['guid'], local_user()];
+ $condition = ["`guid` = ? AND (`uid` = ? OR `uid` = 0)", $args['guid'], DI::userSession()->getLocalUserId()];
$params = ['order' => ['uid' => true]];
- $item = Item::selectFirstForUser(local_user(), [], $condition, $params);
+ $item_row = Post::selectFirstForUser(DI::userSession()->getLocalUserId(), [], $condition, $params);
- if (!DBA::isResult($item)) {
- throw new HTTPException\NotFoundException(L10n::t('Unknown post with guid: %s', $args['guid']));
+ if (!DBA::isResult($item_row)) {
+ throw new HTTPException\NotFoundException(DI::l10n()->t('Unknown post with guid: %s', $args['guid']));
}
- $tags = Term::populateTagsFromItem($item);
+ $return = advancedcontentfilter_get_filter_fields(advancedcontentfilter_prepare_item_row($item_row));
- $item['tags'] = $tags['tags'];
- $item['hashtags'] = $tags['hashtags'];
- $item['mentions'] = $tags['mentions'];
+ $response->getBody()->write(json_encode(['variables' => str_replace('\\\'', '\'', var_export($return, true))]));
+ return $response->withHeader('Content-Type', 'application/json');
+}
- $return = [];
- foreach ($item as $key => $value) {
- $return[str_replace('-', '_', $key)] = $value;
- }
+/**
+ * This mimimcs the processing performed in Model\Item::prepareBody
+ *
+ * @param array $item_row
+ * @return array
+ * @throws HTTPException\InternalServerErrorException
+ * @throws ImagickException
+ */
+function advancedcontentfilter_prepare_item_row(array $item_row): array
+{
+ $tags = Tag::populateFromItem($item_row);
+
+ $item_row['tags'] = $tags['tags'];
+ $item_row['hashtags'] = $tags['hashtags'];
+ $item_row['mentions'] = $tags['mentions'];
+ $item_row['attachments'] = DI::postMediaRepository()->splitAttachments($item_row['uri-id']);
- return json_encode(['variables' => str_replace('\\\'', '\'', var_export($return, true))]);
+ return $item_row;
}
https://reisub.nsupdate.info/git / friendica-addons.git / .git / blobdiff