3 * Name: Advanced content Filter
4 * Description: Expression-based content filter
6 * Author: Hypolite Petovan <https://friendica.mrpetovan.com/profile/hypolite>
7 * Maintainer: Hypolite Petovan <https://friendica.mrpetovan.com/profile/hypolite>
9 * Copyright (c) 2018 Hypolite Petovan
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 * * Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * * Redistributions in binary form must reproduce the above
17 * * copyright notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the distribution.
19 * * Neither the name of Friendica nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL FRIENDICA BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
31 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
32 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 use Friendica\BaseModule;
38 use Friendica\Content\Text\Markdown;
39 use Friendica\Core\Hook;
40 use Friendica\Core\Logger;
41 use Friendica\Core\Renderer;
42 use Friendica\Database\DBA;
43 use Friendica\Database\DBStructure;
45 use Friendica\Model\Item;
46 use Friendica\Model\Post;
47 use Friendica\Model\Tag;
48 use Friendica\Module\Security\Login;
49 use Friendica\Network\HTTPException;
50 use Friendica\Util\DateTimeFormat;
51 use Psr\Http\Message\ResponseInterface;
52 use Psr\Http\Message\ServerRequestInterface;
53 use Symfony\Component\ExpressionLanguage;
55 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
57 function advancedcontentfilter_install(App $a)
59 Hook::register('dbstructure_definition' , __FILE__, 'advancedcontentfilter_dbstructure_definition');
60 Hook::register('prepare_body_content_filter', __FILE__, 'advancedcontentfilter_prepare_body_content_filter');
61 Hook::register('addon_settings' , __FILE__, 'advancedcontentfilter_addon_settings');
63 Hook::add('dbstructure_definition' , __FILE__, 'advancedcontentfilter_dbstructure_definition');
64 DBStructure::performUpdate();
66 Logger::log("installed advancedcontentfilter");
73 function advancedcontentfilter_dbstructure_definition(App $a, &$database)
75 $database["advancedcontentfilter_rules"] = [
76 "comment" => "Advancedcontentfilter addon rules",
78 "id" => ["type" => "int unsigned", "not null" => "1", "extra" => "auto_increment", "primary" => "1", "comment" => "Auto incremented rule id"],
79 "uid" => ["type" => "int unsigned", "not null" => "1", "comment" => "Owner user id"],
80 "name" => ["type" => "varchar(255)", "not null" => "1", "comment" => "Rule name"],
81 "expression" => ["type" => "mediumtext" , "not null" => "1", "comment" => "Expression text"],
82 "serialized" => ["type" => "mediumtext" , "not null" => "1", "comment" => "Serialized parsed expression"],
83 "active" => ["type" => "boolean" , "not null" => "1", "default" => "1", "comment" => "Whether the rule is active or not"],
84 "created" => ["type" => "datetime" , "not null" => "1", "default" => DBA::NULL_DATETIME, "comment" => "Creation date"],
88 "uid_active" => ["uid", "active"],
93 function advancedcontentfilter_get_filter_fields(array $item)
97 // Convert the language JSON text into a filterable format
98 if (!empty($item['language']) && ($languages = json_decode($item['language'], true))) {
99 foreach ($languages as $key => $value) {
100 $vars['language_' . strtolower($key)] = $value;
104 foreach ($item as $key => $value) {
105 $vars[str_replace('-', '_', $key)] = $value;
113 function advancedcontentfilter_prepare_body_content_filter(App $a, &$hook_data)
115 static $expressionLanguage;
117 if (is_null($expressionLanguage)) {
118 $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
125 $vars = advancedcontentfilter_get_filter_fields($hook_data['item']);
127 $rules = DI::cache()->get('rules_' . local_user());
128 if (!isset($rules)) {
129 $rules = DBA::toArray(DBA::select(
130 'advancedcontentfilter_rules',
131 ['name', 'expression', 'serialized'],
132 ['uid' => local_user(), 'active' => true]
135 DI::cache()->set('rules_' . local_user(), $rules);
139 foreach($rules as $rule) {
141 $serializedParsedExpression = new ExpressionLanguage\SerializedParsedExpression(
146 // The error suppression operator is used because of potentially broken user-supplied regular expressions
147 $found = (bool) @$expressionLanguage->evaluate($serializedParsedExpression, $vars);
148 } catch (Exception $e) {
153 $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered by rule: %s', $rule['name']);
161 function advancedcontentfilter_addon_settings(App $a, &$s)
167 $advancedcontentfilter = DI::l10n()->t('Advanced Content Filter');
170 <span class="settings-block fakelink" style="display: block;"><h3><a href="advancedcontentfilter">$advancedcontentfilter <i class="glyphicon glyphicon-share"></i></a></h3></span>
180 function advancedcontentfilter_module() {}
182 function advancedcontentfilter_init(App $a)
184 if (DI::args()->getArgc() > 1 && DI::args()->getArgv()[1] == 'api') {
185 $slim = new \Slim\App();
187 require __DIR__ . '/src/middlewares.php';
189 require __DIR__ . '/src/routes.php';
196 function advancedcontentfilter_content(App $a)
199 return Login::form('/' . implode('/', DI::args()->getArgv()));
202 if (DI::args()->getArgc() > 1 && DI::args()->getArgv()[1] == 'help') {
203 $lang = $a->getUserValue('language');
205 $default_dir = 'addon/advancedcontentfilter/doc/';
206 $help_file = 'advancedcontentfilter.md';
207 $help_path = $default_dir . $help_file;
208 if (file_exists($default_dir . $lang . '/' . $help_file)) {
209 $help_path = $default_dir . $lang . '/' . $help_file;
212 $content = file_get_contents($help_path);
214 $html = Markdown::convert($content, false);
216 $html = str_replace('code>', 'key>', $html);
220 $t = Renderer::getMarkupTemplate('settings.tpl', 'addon/advancedcontentfilter/');
221 return Renderer::replaceMacros($t, [
223 'backtosettings' => DI::l10n()->t('Back to Addon Settings'),
224 'title' => DI::l10n()->t('Advanced Content Filter'),
225 'add_a_rule' => DI::l10n()->t('Add a Rule'),
226 'help' => DI::l10n()->t('Help'),
227 '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.'),
228 'your_rules' => DI::l10n()->t('Your rules'),
229 'no_rules' => DI::l10n()->t('You have no rules yet! Start adding one by clicking on the button above next to the title.'),
230 'disabled' => DI::l10n()->t('Disabled'),
231 'enabled' => DI::l10n()->t('Enabled'),
232 'disable_this_rule' => DI::l10n()->t('Disable this rule'),
233 'enable_this_rule' => DI::l10n()->t('Enable this rule'),
234 'edit_this_rule' => DI::l10n()->t('Edit this rule'),
235 'edit_the_rule' => DI::l10n()->t('Edit the rule'),
236 'save_this_rule' => DI::l10n()->t('Save this rule'),
237 'delete_this_rule' => DI::l10n()->t('Delete this rule'),
238 'rule' => DI::l10n()->t('Rule'),
239 'close' => DI::l10n()->t('Close'),
240 'addtitle' => DI::l10n()->t('Add new rule'),
241 'rule_name' => DI::l10n()->t('Rule Name'),
242 'rule_expression' => DI::l10n()->t('Rule Expression'),
243 'cancel' => DI::l10n()->t('Cancel'),
245 '$current_theme' => $a->getCurrentTheme(),
246 '$rules' => advancedcontentfilter_get_rules(),
247 '$form_security_token' => BaseModule::getFormSecurityToken()
255 function advancedcontentfilter_build_fields($data)
259 if (!empty($data['name'])) {
260 $fields['name'] = $data['name'];
263 if (!empty($data['expression'])) {
265 'author_id', 'author_link', 'author_name', 'author_avatar',
266 'owner_id', 'owner_link', 'owner_name', 'owner_avatar',
267 'contact_id', 'uid', 'id', 'parent', 'uri',
268 'thr_parent', 'parent_uri',
270 'commented', 'created', 'edited', 'received',
271 'verb', 'object_type', 'postopts', 'plink', 'guid', 'wall', 'private', 'starred',
273 'file', 'event_id', 'location', 'coord', 'app', 'attach',
274 'rendered_hash', 'rendered_html', 'object',
275 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
276 'item_id', 'item_network', 'author_thumb', 'owner_thumb',
277 'network', 'url', 'name', 'writable', 'self',
279 'event_created', 'event_edited', 'event_start', 'event_finish', 'event_summary',
280 'event_desc', 'event_location', 'event_type', 'event_nofinish', 'event_adjust', 'event_ignore',
281 'children', 'pagedrop', 'tags', 'hashtags', 'mentions',
284 $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
286 $parsedExpression = $expressionLanguage->parse($data['expression'], $allowed_keys);
288 $serialized = serialize($parsedExpression->getNodes());
290 $fields['expression'] = $data['expression'];
291 $fields['serialized'] = $serialized;
294 if (isset($data['active'])) {
295 $fields['active'] = intval($data['active']);
297 $fields['active'] = 1;
307 function advancedcontentfilter_get_rules()
310 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
313 $rules = DBA::toArray(DBA::select('advancedcontentfilter_rules', [], ['uid' => local_user()]));
315 return json_encode($rules);
318 function advancedcontentfilter_get_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
321 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
324 $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => $args['id'], 'uid' => local_user()]);
326 return json_encode($rule);
329 function advancedcontentfilter_post_rules(ServerRequestInterface $request)
332 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
335 if (!BaseModule::checkFormSecurityToken()) {
336 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
339 $data = json_decode($request->getBody(), true);
342 $fields = advancedcontentfilter_build_fields($data);
343 } catch (Exception $e) {
344 throw new HTTPException\BadRequestException($e->getMessage(), $e);
347 if (empty($fields['name']) || empty($fields['expression'])) {
348 throw new HTTPException\BadRequestException(DI::l10n()->t('The rule name and expression are required.'));
351 $fields['uid'] = local_user();
352 $fields['created'] = DateTimeFormat::utcNow();
354 if (!DBA::insert('advancedcontentfilter_rules', $fields)) {
355 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
358 $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => DBA::lastInsertId()]);
360 return json_encode(['message' => DI::l10n()->t('Rule successfully added'), 'rule' => $rule]);
363 function advancedcontentfilter_put_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
366 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
369 if (!BaseModule::checkFormSecurityToken()) {
370 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
373 if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
374 throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
377 $data = json_decode($request->getBody(), true);
380 $fields = advancedcontentfilter_build_fields($data);
381 } catch (Exception $e) {
382 throw new HTTPException\BadRequestException($e->getMessage(), $e);
385 if (!DBA::update('advancedcontentfilter_rules', $fields, ['id' => $args['id']])) {
386 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
389 return json_encode(['message' => DI::l10n()->t('Rule successfully updated')]);
392 function advancedcontentfilter_delete_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
395 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
398 if (!BaseModule::checkFormSecurityToken()) {
399 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
402 if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
403 throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
406 if (!DBA::delete('advancedcontentfilter_rules', ['id' => $args['id']])) {
407 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
410 return json_encode(['message' => DI::l10n()->t('Rule successfully deleted')]);
413 function advancedcontentfilter_get_variables_guid(ServerRequestInterface $request, ResponseInterface $response, $args)
416 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
419 if (!isset($args['guid'])) {
420 throw new HTTPException\BadRequestException(DI::l10n()->t('Missing argument: guid.'));
423 $condition = ["`guid` = ? AND (`uid` = ? OR `uid` = 0)", $args['guid'], local_user()];
424 $params = ['order' => ['uid' => true]];
425 $item = Post::selectFirstForUser(local_user(), [], $condition, $params);
427 if (!DBA::isResult($item)) {
428 throw new HTTPException\NotFoundException(DI::l10n()->t('Unknown post with guid: %s', $args['guid']));
431 $tags = Tag::populateFromItem($item);
433 $item['tags'] = $tags['tags'];
434 $item['hashtags'] = $tags['hashtags'];
435 $item['mentions'] = $tags['mentions'];
437 $return = advancedcontentfilter_get_filter_fields($item);
439 return json_encode(['variables' => str_replace('\\\'', '\'', var_export($return, true))]);