src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php

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