muzich/src/Muzich/CoreBundle/Mining/Tag/TagMiner.php

<?php
namespace Muzich\CoreBundle\Mining\Tag;

use Doctrine\ORM\EntityManager;
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry as MongoManagerRegistry;
use Muzich\CoreBundle\Document\EntityTags;
use Muzich\CoreBundle\Document\UserTags;
use Muzich\CoreBundle\Document\GroupTags;
use Muzich\CoreBundle\Document\PlaylistTags;
use Doctrine\ORM\QueryBuilder;
use Muzich\CoreBundle\lib\Tag as TagOrderer;
use Muzich\CoreBundle\lib\TagScorer;
use Muzich\CoreBundle\Entity\User;
use Muzich\CoreBundle\Managers\PlaylistManager;

use Muzich\CoreBundle\Mining\Tag\Tag as Base;

class TagMiner extends Base
{
  
  protected $tag_scorer;
  protected $tag_orderer;
  protected $logger_parent;
  
  public function __construct(EntityManager $doctrine_entity_manager, MongoManagerRegistry $mongo_manager_registry)
  {
    parent::__construct($doctrine_entity_manager, $mongo_manager_registry);
    $this->tag_scorer = new TagScorer();
    $this->tag_orderer = new TagOrderer();
  }
  
  /** @return TagScorer */
  protected function getTagsScorer()
  {
    return $this->tag_scorer;
  }
  
  /** @return TagOrderer */
  protected function getTagOrderer()
  {
    return $this->tag_orderer;
  }
  
  // Experimental
  public function setLogger($parent)
  {
    $this->logger_parent = $parent;
  }
  
  // Experimental
  protected function log($action_name)
  {
    $action_name_complete = 'log'.ucfirst($action_name);
    
    if ($this->logger_parent)
      $this->logger_parent->$action_name_complete();
  }
  
  /** 
   * @param QueryBuilder $query_builder
   * @param string $user_alias
   */
  public function adaptQueryBuilderSelectorsForUser(QueryBuilder $query_builder, $user_alias = 'user')
  {
    // Adapt query builder to necessary data in mining
    $query_builder->leftJoin($user_alias.'.elements', 'element_owned');
    $query_builder->leftJoin('element_owned.tags', 'element_owned_tags');
    
    $query_builder->leftJoin($user_alias.'.elements_favorites', 'element_favorite');
    $query_builder->leftJoin('element_favorite.element', 'element_favorite_element');
    
    $query_builder->select($user_alias.', element_owned, element_owned_tags, element_favorite');
    
  }
  
  /**
   * @param array $users
   */
  public function mineForUsers($users, $mining_action, $user_action = null)
  {
    if (count($users))
    {
      foreach ($users as $user)
      {
        $user_tags = $this->getEntityTagsDocument($user->getId(), EntityTags::TYPE_USER);

        $this->log('userProceed');
        $this->$mining_action($user_tags, $user);
        if ($user_action)
          $user->$user_action();

        $this->getMongoManager()->persist($user_tags);
        $this->getDoctrineEntityManager()->persist($user);
      }
      
      $this->log('savingInDatabase');
      $this->getMongoManager()->flush();
      $this->getDoctrineEntityManager()->flush();
    }
  }
  
  public function mineDiffusionTagsForUsers($users)
  {
    $this->mineForUsers($users, 'orderUserDiffusionsTags', 'setDataDiffusionsNoMoreUpdated');
  }
  
  public function mineFavoriteTagsForUsers($users)
  {
    $this->mineForUsers($users, 'orderUserFavoritesTags', 'setDataFavoriteNoMoreUpdated');
  }
  
  public function minePlaylistTagsForUsers($users)
  {
    $this->mineForUsers($users, 'orderUserPlaylistsTags', 'setDataPlaylistNoMoreUpdated');
  }
  
  public function mineTagsForUsers($users)
  {
    $this->mineForUsers($users, 'orderUserTags');
  }
  
  public function mineTopTagsForUsers($users)
  {
    $this->mineForUsers($users, 'determineTagsTops');
  }
  
  /** @return EntityTags */
  protected function getEntityTagsDocument($ref, $type)
  {
    if (!($user_tags = $this->getMongoManager()->createQueryBuilder('MuzichCoreBundle:'.$type.'Tags')
      ->field('ref')->equals((int)$ref)
      ->getQuery()->getSingleResult()
    ))
    {
      $user_tags = $this->getObjectTypeTags($type);
      $user_tags->setRef($ref);
    }
    
    return $user_tags;
  }
  
  /** @return EntityTags */
  protected function getObjectTypeTags($type)
  {
    switch ($type)
    {
      case EntityTags::TYPE_USER:
        return new UserTags();
      break;
      case EntityTags::TYPE_GROUP:
        return new GroupTags();
      break;
      case EntityTags::TYPE_PLAYLIST:
        return new PlaylistTags();
      break;
    }
  }
  
  protected function orderUserDiffusionsTags(EntityTags $user_tags, User $user)
  {
    $tags_ids_ordereds = $this->getTagOrderer()->getOrderedTagsWithElements($user->getElements());
    $user_tags->setElementDiffusionTags($tags_ids_ordereds);
  }
  
  protected function orderUserFavoritesTags(EntityTags $user_tags, User $user)
  {
    $tags_ids_ordereds = $this->getTagOrderer()->getOrderedTagsWithElements($user->getElementsFavoritesElements());
    $user_tags->setElementFavoriteTags($tags_ids_ordereds);
  }
  
  protected function orderUserPlaylistsTags(EntityTags $user_tags, User $user)
  {
    $playlist_manager = new PlaylistManager($this->getDoctrineEntityManager());
    $tags_ids_ordereds = $this->getTagOrderer()->getOrderedTagsWithElements($playlist_manager->getElementsOfPlaylists($this->getUserPlaylists($user)));
    $user_tags->setElementPlaylistTags($tags_ids_ordereds);
  }
  
  protected function getUserPlaylists(User $user)
  {
    $playlists = $user->getPlaylistsOwneds();
    foreach ($user->getPickedsPlaylists() as $picked_playlist)
    {
      $found = false;
      foreach ($playlists as $playlist)
      {
        if ($playlist->getId() == $picked_playlist->getId())
        {
          $found = true;
        }
      }
      
      if (!$found)
        $playlists[] = $picked_playlist;
    }
    
    return $playlists;
  }
  
  protected function orderUserTags(EntityTags $user_tags, User $user)
  {
    $all_tags_ordered = $this->getTagsScorer()->scoreEntireOrderedTagsIds(array(
      $user_tags->getElementDiffusionTags(),
      $user_tags->getElementFavoriteTags(),
      $user_tags->getElementPlaylistTags()
    ), $user->getTagsFavoritesQuickIds());
    
    $user_tags->setTagsAll($all_tags_ordered);
  }
  
  protected function determineTagsTops(EntityTags $user_tags, User $user)
  {
    $user_tags->setTagsTop1($this->getTopTagsRange($user_tags->getTagsAll(), 1));
    $user_tags->setTagsTop2($this->getTopTagsRange($user_tags->getTagsAll(), 2));
    $user_tags->setTagsTop3($this->getTopTagsRange($user_tags->getTagsAll(), 3));
    $user_tags->setTagsTop5($this->getTopTagsRange($user_tags->getTagsAll(), 5));
    $user_tags->setTagsTop10($this->getTopTagsRange($user_tags->getTagsAll(), 10));
    $user_tags->setTagsTop25($this->getTopTagsRange($user_tags->getTagsAll(), 25));
  }
  
  protected function getTopTagsRange($tags, $range_end)
  {
    $tags_top = array();
    if ($range_end <= count($tags))
    {
      $max = $range_end;
    }
    else
    {
      $max = count($tags);
    }
      
    for ($index = 0; $index <= $max-1; $index++)
    {
      $tags_top[] = $tags[$index];
    }
    
    
    return $tags_top;
  }
  
}