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