advancedcontentfilter/advancedcontentfilter.php

   1 <?php
   2 /**
   3  * Name: Advanced content Filter
   4  * Description: Expression-based content filter
   5  * Version: 1.0
   6  * Author: Hypolite Petovan <https://friendica.mrpetovan.com/profile/hypolite>
   7  * Maintainer: Hypolite Petovan <https://friendica.mrpetovan.com/profile/hypolite>
   8  *
   9  * Copyright (c) 2018 Hypolite Petovan
  10  * All rights reserved.
  11  *
  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.
  22  *
  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.
  33  *
  34  */
  35
  36 use Friendica\App;
  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;
  44 use Friendica\DI;
  45 use Friendica\Model\Item;
  46 use Friendica\Model\Tag;
  47 use Friendica\Module\Security\Login;
  48 use Friendica\Network\HTTPException;
  49 use Friendica\Util\DateTimeFormat;
  50 use Psr\Http\Message\ResponseInterface;
  51 use Psr\Http\Message\ServerRequestInterface;
  52 use Symfony\Component\ExpressionLanguage;
  53
  54 require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
  55
  56 function advancedcontentfilter_install(App $a)
  57 {
  58         Hook::register('dbstructure_definition'     , __FILE__, 'advancedcontentfilter_dbstructure_definition');
  59         Hook::register('prepare_body_content_filter', __FILE__, 'advancedcontentfilter_prepare_body_content_filter');
  60         Hook::register('addon_settings'             , __FILE__, 'advancedcontentfilter_addon_settings');
  61
  62         Hook::add('dbstructure_definition'          , __FILE__, 'advancedcontentfilter_dbstructure_definition');
  63         DBStructure::update($a->getBasePath(), false, true);
  64
  65         Logger::log("installed advancedcontentfilter");
  66 }
  67
  68 /*
  69  * Hooks
  70  */
  71
  72 function advancedcontentfilter_dbstructure_definition(App $a, &$database)
  73 {
  74         $database["advancedcontentfilter_rules"] = [
  75                 "comment" => "Advancedcontentfilter addon rules",
  76                 "fields" => [
  77                         "id"         => ["type" => "int unsigned", "not null" => "1", "extra" => "auto_increment", "primary" => "1", "comment" => "Auto incremented rule id"],
  78                         "uid"        => ["type" => "int unsigned", "not null" => "1", "comment" => "Owner user id"],
  79                         "name"       => ["type" => "varchar(255)", "not null" => "1", "comment" => "Rule name"],
  80                         "expression" => ["type" => "mediumtext"  , "not null" => "1", "comment" => "Expression text"],
  81                         "serialized" => ["type" => "mediumtext"  , "not null" => "1", "comment" => "Serialized parsed expression"],
  82                         "active"     => ["type" => "boolean"     , "not null" => "1", "default" => "1", "comment" => "Whether the rule is active or not"],
  83                         "created"    => ["type" => "datetime"    , "not null" => "1", "default" => DBA::NULL_DATETIME, "comment" => "Creation date"],
  84                 ],
  85                 "indexes" => [
  86                         "PRIMARY" => ["id"],
  87                         "uid_active" => ["uid", "active"],
  88                 ]
  89         ];
  90 }
  91
  92 function advancedcontentfilter_prepare_body_content_filter(App $a, &$hook_data)
  93 {
  94         static $expressionLanguage;
  95
  96         if (is_null($expressionLanguage)) {
  97                 $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
  98         }
  99
 100         if (!local_user()) {
 101                 return;
 102         }
 103
 104         $vars = [];
 105         foreach ($hook_data['item'] as $key => $value) {
 106                 $vars[str_replace('-', '_', $key)] = $value;
 107         }
 108
 109         $rules = DI::cache()->get('rules_' . local_user());
 110         if (!isset($rules)) {
 111                 $rules = DBA::toArray(DBA::select(
 112                         'advancedcontentfilter_rules',
 113                         ['name', 'expression', 'serialized'],
 114                         ['uid' => local_user(), 'active' => true]
 115                 ));
 116
 117                 DI::cache()->set('rules_' . local_user(), $rules);
 118         }
 119
 120         if ($rules) {
 121                 foreach($rules as $rule) {
 122                         try {
 123                                 $serializedParsedExpression = new ExpressionLanguage\SerializedParsedExpression(
 124                                         $rule['expression'],
 125                                         $rule['serialized']
 126                                 );
 127
 128                                 // The error suppression operator is used because of potentially broken user-supplied regular expressions
 129                                 $found = (bool) @$expressionLanguage->evaluate($serializedParsedExpression, $vars);
 130                         } catch (Exception $e) {
 131                                 $found = false;
 132                         }
 133
 134                         if ($found) {
 135                                 $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered by rule: %s', $rule['name']);
 136                                 break;
 137                         }
 138                 }
 139         }
 140 }
 141
 142
 143 function advancedcontentfilter_addon_settings(App $a, &$s)
 144 {
 145         if (!local_user()) {
 146                 return;
 147         }
 148
 149         $advancedcontentfilter = DI::l10n()->t('Advanced Content Filter');
 150
 151         $s .= <<<HTML
 152                 <span class="settings-block fakelink" style="display: block;"><h3><a href="advancedcontentfilter">$advancedcontentfilter <i class="glyphicon glyphicon-share"></i></a></h3></span>
 153 HTML;
 154
 155         return;
 156 }
 157
 158 /*
 159  * Module
 160  */
 161
 162 function advancedcontentfilter_module() {}
 163
 164 function advancedcontentfilter_init(App $a)
 165 {
 166         if ($a->argc > 1 && $a->argv[1] == 'api') {
 167                 $slim = new \Slim\App();
 168
 169                 require __DIR__ . '/src/middlewares.php';
 170
 171                 require __DIR__ . '/src/routes.php';
 172                 $slim->run();
 173
 174                 exit;
 175         }
 176 }
 177
 178 function advancedcontentfilter_content(App $a)
 179 {
 180         if (!local_user()) {
 181                 return Login::form('/' . implode('/', $a->argv));
 182         }
 183
 184         if ($a->argc > 1 && $a->argv[1] == 'help') {
 185                 $lang = $a->user['language'];
 186
 187                 $default_dir = 'addon/advancedcontentfilter/doc/';
 188                 $help_file = 'advancedcontentfilter.md';
 189                 $help_path = $default_dir . $help_file;
 190                 if (file_exists($default_dir . $lang . '/' . $help_file)) {
 191                         $help_path = $default_dir . $lang . '/' . $help_file;
 192                 }
 193
 194                 $content = file_get_contents($help_path);
 195
 196                 $html = Markdown::convert($content, false);
 197
 198                 $html = str_replace('code>', 'key>', $html);
 199
 200                 return $html;
 201         } else {
 202                 $t = Renderer::getMarkupTemplate('settings.tpl', 'addon/advancedcontentfilter/');
 203                 return Renderer::replaceMacros($t, [
 204                         '$messages' => [
 205                                 'backtosettings'    => DI::l10n()->t('Back to Addon Settings'),
 206                                 'title'             => DI::l10n()->t('Advanced Content Filter'),
 207                                 'add_a_rule'        => DI::l10n()->t('Add a Rule'),
 208                                 'help'              => DI::l10n()->t('Help'),
 209                                 '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.'),
 210                                 'your_rules'        => DI::l10n()->t('Your rules'),
 211                                 'no_rules'          => DI::l10n()->t('You have no rules yet! Start adding one by clicking on the button above next to the title.'),
 212                                 'disabled'          => DI::l10n()->t('Disabled'),
 213                                 'enabled'           => DI::l10n()->t('Enabled'),
 214                                 'disable_this_rule' => DI::l10n()->t('Disable this rule'),
 215                                 'enable_this_rule'  => DI::l10n()->t('Enable this rule'),
 216                                 'edit_this_rule'    => DI::l10n()->t('Edit this rule'),
 217                                 'edit_the_rule'     => DI::l10n()->t('Edit the rule'),
 218                                 'save_this_rule'    => DI::l10n()->t('Save this rule'),
 219                                 'delete_this_rule'  => DI::l10n()->t('Delete this rule'),
 220                                 'rule'              => DI::l10n()->t('Rule'),
 221                                 'close'             => DI::l10n()->t('Close'),
 222                                 'addtitle'          => DI::l10n()->t('Add new rule'),
 223                                 'rule_name'         => DI::l10n()->t('Rule Name'),
 224                                 'rule_expression'   => DI::l10n()->t('Rule Expression'),
 225                                 'cancel'            => DI::l10n()->t('Cancel'),
 226                         ],
 227                         '$current_theme' => $a->getCurrentTheme(),
 228                         '$rules' => advancedcontentfilter_get_rules(),
 229                         '$form_security_token' => BaseModule::getFormSecurityToken()
 230                 ]);
 231         }
 232 }
 233
 234 /*
 235  * Common functions
 236  */
 237 function advancedcontentfilter_build_fields($data)
 238 {
 239         $fields = [];
 240
 241         if (!empty($data['name'])) {
 242                 $fields['name'] = $data['name'];
 243         }
 244
 245         if (!empty($data['expression'])) {
 246                 $allowed_keys = [
 247                         'author_id', 'author_link', 'author_name', 'author_avatar',
 248                         'owner_id', 'owner_link', 'owner_name', 'owner_avatar',
 249                         'contact_id', 'uid', 'id', 'parent', 'uri',
 250                         'thr_parent', 'parent_uri',
 251                         'content_warning',
 252                         'commented', 'created', 'edited', 'received',
 253                         'verb', 'object_type', 'postopts', 'plink', 'guid', 'wall', 'private', 'starred',
 254                         'title', 'body',
 255                         'file', 'event_id', 'location', 'coord', 'app', 'attach',
 256                         'rendered_hash', 'rendered_html', 'object',
 257                         'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
 258                         'item_id', 'item_network', 'author_thumb', 'owner_thumb',
 259                         'network', 'url', 'name', 'writable', 'self',
 260                         'cid', 'alias',
 261                         'event_created', 'event_edited', 'event_start', 'event_finish', 'event_summary',
 262                         'event_desc', 'event_location', 'event_type', 'event_nofinish', 'event_adjust', 'event_ignore',
 263                         'children', 'pagedrop', 'tags', 'hashtags', 'mentions',
 264                 ];
 265
 266                 $expressionLanguage = new ExpressionLanguage\ExpressionLanguage();
 267
 268                 $parsedExpression = $expressionLanguage->parse($data['expression'], $allowed_keys);
 269
 270                 $serialized = serialize($parsedExpression->getNodes());
 271
 272                 $fields['expression'] = $data['expression'];
 273                 $fields['serialized'] = $serialized;
 274         }
 275
 276         if (isset($data['active'])) {
 277                 $fields['active'] = intval($data['active']);
 278         } else {
 279                 $fields['active'] = 1;
 280         }
 281
 282         return $fields;
 283 }
 284
 285 /*
 286  * API
 287  */
 288
 289 function advancedcontentfilter_get_rules()
 290 {
 291         if (!local_user()) {
 292                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 293         }
 294
 295         $rules = DBA::toArray(DBA::select('advancedcontentfilter_rules', [], ['uid' => local_user()]));
 296
 297         return json_encode($rules);
 298 }
 299
 300 function advancedcontentfilter_get_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
 301 {
 302         if (!local_user()) {
 303                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 304         }
 305
 306         $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => $args['id'], 'uid' => local_user()]);
 307
 308         return json_encode($rule);
 309 }
 310
 311 function advancedcontentfilter_post_rules(ServerRequestInterface $request)
 312 {
 313         if (!local_user()) {
 314                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 315         }
 316
 317         if (!BaseModule::checkFormSecurityToken()) {
 318                 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
 319         }
 320
 321         $data = json_decode($request->getBody(), true);
 322
 323         try {
 324                 $fields = advancedcontentfilter_build_fields($data);
 325         } catch (Exception $e) {
 326                 throw new HTTPException\BadRequestException($e->getMessage(), $e);
 327         }
 328
 329         if (empty($fields['name']) || empty($fields['expression'])) {
 330                 throw new HTTPException\BadRequestException(DI::l10n()->t('The rule name and expression are required.'));
 331         }
 332
 333         $fields['uid'] = local_user();
 334         $fields['created'] = DateTimeFormat::utcNow();
 335
 336         if (!DBA::insert('advancedcontentfilter_rules', $fields)) {
 337                 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
 338         }
 339
 340         $rule = DBA::selectFirst('advancedcontentfilter_rules', [], ['id' => DBA::lastInsertId()]);
 341
 342         return json_encode(['message' => DI::l10n()->t('Rule successfully added'), 'rule' => $rule]);
 343 }
 344
 345 function advancedcontentfilter_put_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
 346 {
 347         if (!local_user()) {
 348                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 349         }
 350
 351         if (!BaseModule::checkFormSecurityToken()) {
 352                 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
 353         }
 354
 355         if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
 356                 throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
 357         }
 358
 359         $data = json_decode($request->getBody(), true);
 360
 361         try {
 362                 $fields = advancedcontentfilter_build_fields($data);
 363         } catch (Exception $e) {
 364                 throw new HTTPException\BadRequestException($e->getMessage(), $e);
 365         }
 366
 367         if (!DBA::update('advancedcontentfilter_rules', $fields, ['id' => $args['id']])) {
 368                 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
 369         }
 370
 371         return json_encode(['message' => DI::l10n()->t('Rule successfully updated')]);
 372 }
 373
 374 function advancedcontentfilter_delete_rules_id(ServerRequestInterface $request, ResponseInterface $response, $args)
 375 {
 376         if (!local_user()) {
 377                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 378         }
 379
 380         if (!BaseModule::checkFormSecurityToken()) {
 381                 throw new HTTPException\BadRequestException(DI::l10n()->t('Invalid form security token, please refresh the page.'));
 382         }
 383
 384         if (!DBA::exists('advancedcontentfilter_rules', ['id' => $args['id'], 'uid' => local_user()])) {
 385                 throw new HTTPException\NotFoundException(DI::l10n()->t('Rule doesn\'t exist or doesn\'t belong to you.'));
 386         }
 387
 388         if (!DBA::delete('advancedcontentfilter_rules', ['id' => $args['id']])) {
 389                 throw new HTTPException\ServiceUnavailableException(DBA::errorMessage());
 390         }
 391
 392         return json_encode(['message' => DI::l10n()->t('Rule successfully deleted')]);
 393 }
 394
 395 function advancedcontentfilter_get_variables_guid(ServerRequestInterface $request, ResponseInterface $response, $args)
 396 {
 397         if (!local_user()) {
 398                 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this method'));
 399         }
 400
 401         if (!isset($args['guid'])) {
 402                 throw new HTTPException\BadRequestException(DI::l10n()->t('Missing argument: guid.'));
 403         }
 404
 405         $condition = ["`guid` = ? AND (`uid` = ? OR `uid` = 0)", $args['guid'], local_user()];
 406         $params = ['order' => ['uid' => true]];
 407         $item = Item::selectFirstForUser(local_user(), [], $condition, $params);
 408
 409         if (!DBA::isResult($item)) {
 410                 throw new HTTPException\NotFoundException(DI::l10n()->t('Unknown post with guid: %s', $args['guid']));
 411         }
 412
 413         $tags = Tag::populateFromItem($item);
 414
 415         $item['tags'] = $tags['tags'];
 416         $item['hashtags'] = $tags['hashtags'];
 417         $item['mentions'] = $tags['mentions'];
 418
 419         $return = [];
 420         foreach ($item as $key => $value) {
 421                 $return[str_replace('-', '_', $key)] = $value;
 422         }
 423
 424         return json_encode(['variables' => str_replace('\\\'', '\'', var_export($return, true))]);
 425 }