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