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