Merge pull request #1478 from K-Phoen/rule-based-tags

Rule based tags

2 files changed, 124 insertions, 2 deletions

diff --git a/src/Wallabag/CoreBundle/Helper/ContentProxy.php b/src/Wallabag/CoreBundle/Helper/ContentProxy.php
index 7fb41393..3d585e61 100644
--- a/src/Wallabag/CoreBundle/Helper/ContentProxy.php
+++ b/src/Wallabag/CoreBundle/Helper/ContentProxy.php
@@ -3,6 +3,7 @@
 namespace Wallabag\CoreBundle\Helper;
 
 use Graby\Graby;
+use Psr\Log\LoggerInterface as Logger;
 use Wallabag\CoreBundle\Entity\Entry;
 use Wallabag\CoreBundle\Tools\Utils;
 
@@ -13,10 +14,14 @@ use Wallabag\CoreBundle\Tools\Utils;
 class ContentProxy
 {
     protected $graby;
+    protected $tagger;
+    protected $logger;
 
-    public function __construct(Graby $graby)
+    public function __construct(Graby $graby, RuleBasedTagger $tagger, Logger $logger)
     {
-        $this->graby = $graby;
+        $this->graby  = $graby;
+        $this->tagger = $tagger;
+        $this->logger = $logger;
     }
 
     /**
@@ -59,6 +64,15 @@ class ContentProxy
             $entry->setPreviewPicture($content['open_graph']['og_image']);
         }
 
+        try {
+            $this->tagger->tag($entry);
+        } catch (\Exception $e) {
+            $this->logger->error('Error while trying to automatically tag an entry.', array(
+                'entry_url' => $url,
+                'error_msg' => $e->getMessage(),
+            ));
+        }
+
         return $entry;
     }
 }
diff --git a/src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php b/src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php
new file mode 100644
index 00000000..3f9953c0
--- /dev/null
+++ b/src/Wallabag/CoreBundle/Helper/RuleBasedTagger.php
@@ -0,0 +1,108 @@
+<?php
+
+namespace Wallabag\CoreBundle\Helper;
+
+use RulerZ\RulerZ;
+
+use Wallabag\CoreBundle\Entity\Entry;
+use Wallabag\CoreBundle\Entity\Tag;
+use Wallabag\CoreBundle\Repository\EntryRepository;
+use Wallabag\CoreBundle\Repository\TagRepository;
+use Wallabag\UserBundle\Entity\User;
+
+class RuleBasedTagger
+{
+    private $rulerz;
+    private $tagRepository;
+    private $entryRepository;
+
+    public function __construct(RulerZ $rulerz, TagRepository $tagRepository, EntryRepository $entryRepository)
+    {
+        $this->rulerz          = $rulerz;
+        $this->tagRepository   = $tagRepository;
+        $this->entryRepository = $entryRepository;
+    }
+
+    /**
+     * Add tags from rules defined by the user.
+     *
+     * @param Entry $entry Entry to tag.
+     */
+    public function tag(Entry $entry)
+    {
+        $rules = $this->getRulesForUser($entry->getUser());
+
+        foreach ($rules as $rule) {
+            if (!$this->rulerz->satisfies($entry, $rule->getRule())) {
+                continue;
+            }
+
+            foreach ($rule->getTags() as $label) {
+                $tag = $this->getTag($entry->getUser(), $label);
+
+                $entry->addTag($tag);
+            }
+        }
+    }
+
+    /**
+     * Apply all the tagging rules defined by a user on its entries.
+     *
+     * @param User $user
+     *
+     * @return array<Entry> A list of modified entries.
+     */
+    public function tagAllForUser(User $user)
+    {
+        $rules   = $this->getRulesForUser($user);
+        $entries = array();
+
+        foreach ($rules as $rule) {
+            $qb      = $this->entryRepository->getBuilderForAllByUser($user->getId());
+            $entries = $this->rulerz->filter($qb, $rule->getRule());
+
+            foreach ($entries as $entry) {
+                foreach ($rule->getTags() as $label) {
+                    $tag = $this->getTag($user, $label);
+
+                    $entry->addTag($tag);
+                    $entries[] = $entry;
+                }
+            }
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Fetch a tag for a user.
+     *
+     * @param User   $user
+     * @param string $label The tag's label.
+     *
+     * @return Tag
+     */
+    private function getTag(User $user, $label)
+    {
+        $tag = $this->tagRepository->findOneByLabelAndUserId($label, $user->getId());
+
+        if (!$tag) {
+            $tag = new Tag($user);
+            $tag->setLabel($label);
+        }
+
+        return $tag;
+    }
+
+    /**
+     * Retrieves the tagging rules for a given user.
+     *
+     * @param User $user
+     *
+     * @return array<TaggingRule>
+     */
+    private function getRulesForUser(User $user)
+    {
+        return $user->getConfig()->getTaggingRules();
+    }
+}