src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Helper;
   4
   5 use RulerZ\RulerZ;
   6 use Wallabag\CoreBundle\Entity\Entry;
   7 use Wallabag\CoreBundle\Entity\Tag;
   8 use Wallabag\CoreBundle\Repository\EntryRepository;
   9 use Wallabag\CoreBundle\Repository\TagRepository;
  10 use Wallabag\UserBundle\Entity\User;
  11 use Psr\Log\LoggerInterface;
  12
  13 class RuleBasedTagger
  14 {
  15     private $rulerz;
  16     private $tagRepository;
  17     private $entryRepository;
  18
  19     public function __construct(RulerZ $rulerz, TagRepository $tagRepository, EntryRepository $entryRepository, LoggerInterface $logger)
  20     {
  21         $this->rulerz = $rulerz;
  22         $this->tagRepository = $tagRepository;
  23         $this->entryRepository = $entryRepository;
  24         $this->logger = $logger;
  25     }
  26
  27     /**
  28      * Add tags from rules defined by the user.
  29      *
  30      * @param Entry $entry Entry to tag
  31      */
  32     public function tag(Entry $entry)
  33     {
  34         $rules = $this->getRulesForUser($entry->getUser());
  35
  36         foreach ($rules as $rule) {
  37             if (!$this->rulerz->satisfies($entry, $rule->getRule())) {
  38                 continue;
  39             }
  40
  41             $this->logger->info('Matching rule.', [
  42                 'rule' => $rule->getRule(),
  43                 'tags' => $rule->getTags(),
  44             ]);
  45
  46             foreach ($rule->getTags() as $label) {
  47                 $tag = $this->getTag($label);
  48
  49                 $entry->addTag($tag);
  50             }
  51         }
  52     }
  53
  54     /**
  55      * Apply all the tagging rules defined by a user on its entries.
  56      *
  57      * @param User $user
  58      *
  59      * @return array<Entry> A list of modified entries
  60      */
  61     public function tagAllForUser(User $user)
  62     {
  63         $rules = $this->getRulesForUser($user);
  64         $entries = [];
  65         $tagsCache = [];
  66
  67         foreach ($rules as $rule) {
  68             $qb = $this->entryRepository->getBuilderForAllByUser($user->getId());
  69             $entries = $this->rulerz->filter($qb, $rule->getRule());
  70
  71             foreach ($entries as $entry) {
  72                 foreach ($rule->getTags() as $label) {
  73                     // avoid new tag duplicate by manually caching them
  74                     if (!isset($tagsCache[$label])) {
  75                         $tagsCache[$label] = $this->getTag($label);
  76                     }
  77
  78                     $tag = $tagsCache[$label];
  79
  80                     $entry->addTag($tag);
  81                 }
  82             }
  83         }
  84
  85         return $entries;
  86     }
  87
  88     /**
  89      * Fetch a tag.
  90      *
  91      * @param string $label The tag's label
  92      *
  93      * @return Tag
  94      */
  95     private function getTag($label)
  96     {
  97         $tag = $this->tagRepository->findOneByLabel($label);
  98
  99         if (!$tag) {
 100             $tag = new Tag();
 101             $tag->setLabel($label);
 102         }
 103
 104         return $tag;
 105     }
 106
 107     /**
 108      * Retrieves the tagging rules for a given user.
 109      *
 110      * @param User $user
 111      *
 112      * @return array<TaggingRule>
 113      */
 114     private function getRulesForUser(User $user)
 115     {
 116         return $user->getConfig()->getTaggingRules();
 117     }
 118 }