apotrophos search bug solved
[living-lab-site.git] / application / models / videos_model.php
index 223def7..46efd10 100644 (file)
@@ -7,7 +7,7 @@
  * @author             Călin-Andrei Burloiu
  */
 class Videos_model extends CI_Model {
-       private $db = NULL;
+       public $db = NULL;
        
        public function __construct()
        {
@@ -16,34 +16,67 @@ class Videos_model extends CI_Model {
                        $this->load->library('singleton_db');
                        $this->db = $this->singleton_db->connect();
                }
-               
-               $this->load->helper('url');
        }
        
        /**
         * Retrieves information about a set of videos which are going to be
         * displayed in the catalog.
         *
-        * TODO: filter, limit, ordering parameters
+        * @param               int $category_id        DB category ID
+        * @param               int $offset
+        * @param               int $count
+        * @param               string $ordering        control videos ording by these
+        * possibilities:
+        * <ul>
+        *   <li><strong>'hottest':</strong> newest most appreciated first. An
+        *   appreciated video is one which has a bigger
+        *   score = views + likes - dislikes.</li>
+        *   <li><strong>'newest':</strong> newest first.</li>
+        *   <li><strong>'alphabetically':</strong> sort alphabetically.</li>
+        * </ul>
         * @return              array   a list of videos, each one being an assoc array with:
-        *   * id, name, title, duration, thumbs_count, default_thumb, views => from DB
-        *   * shorted_title => ellipsized title
-        *   * video_url => P2P-Tube video URl
-        *   * TODO: user_id, user_name
-        *   * thumbs => thumbnail images' URLs
+        * <ul>
+        *   <li>id, name, title, duration, thumbs_count, default_thumb, views => from DB</li>
+        *   <li>shorted_title => ellipsized title</li>
+        *   <li>video_url => P2P-Tube video URl</li>
+        *   <li>TODO: user_id, user_name</li>
+        *   <li>thumbs => thumbnail images' URLs</li>
+        * </ul>
         */
-       public function get_videos_summary($category_id)
+       public function get_videos_summary($category_id, $offset, $count, $ordering = 'hottest')
        {
                $this->load->helper('text');
                
+               // Ordering
+               switch ($ordering)
+               {
+               case 'hottest':
+                       $order_statement = "ORDER BY date DESC, score DESC, RAND()";
+                       break;
+               case 'newest':
+                       $order_statement = "ORDER BY date DESC";
+                       break;
+               case 'alphabetically':
+                       $order_statement = "ORDER BY title";
+                       break;
+                       
+               default:
+                       $order_statement = "";
+               }
+               
                $query = $this->db->query(
-                       'SELECT id, name, title, duration, user_id, views, thumbs_count,
-                               default_thumb
+                       "SELECT id, name, title, duration, user_id, views, thumbs_count,
+                               default_thumb, (views + likes - dislikes) AS score
                        FROM `videos`
                        WHERE category_id = ?
-                       ORDER BY name', // TODO summary order 
-                       $category_id); 
-               $videos = $query->result_array();
+                       $order_statement
+                       LIMIT ?, ?", 
+                       array(intval($category_id), $offset, $count)); 
+               
+               if ($query->num_rows() > 0)
+                       $videos = $query->result_array();
+               else
+                       return NULL;
                
                foreach ($videos as & $video)
                {
@@ -57,12 +90,30 @@ class Videos_model extends CI_Model {
                                
                        // Ellipsized title
                        //$video['shorted_title'] = ellipsize($video['title'], 45, 0.75);
-                       $video['shorted_title'] = character_limiter($video['title'], 45);
+                       $video['shorted_title'] = character_limiter($video['title'], 50);
+                       
+                       // TODO: user information
+                       $video['user_name'] = 'TODO';
                }
                
                return $videos;
        }
        
+       public function get_videos_count($category_id)
+       {
+               $query = $this->db->query(
+                       'SELECT COUNT(*) count
+                       FROM `videos`
+                       WHERE category_id = ?',
+                       $category_id);
+               
+               if ($query->num_rows() > 0)
+                       return $query->row()->count;
+               
+               // Error
+               return NULL;
+       }
+       
        /**
         * Retrieves information about a video.
         *
@@ -75,18 +126,24 @@ class Videos_model extends CI_Model {
         * table. NULL means there is no name provided.
         * @return              array   an associative list with information about a video
         * with the following keys:
-        *   * all columns form DB with some exceptions that are overwritten or new
-        *   * torrents => list of torrent file names formated as
-        * {name}_{format}.{default_video_ext}.{default_torrent_ext}
-        *   * user_name => TODO: user name from `users` table
-        *   * formats => list of formats like 1080p
-        *   * category_name => TODO: human-friendly category name
-        *   * tags => associative list of "tag => score"
-        *   * date => date and time when the video was created
-        *   * thumbs => thumbnail images' URLs
+        * <ul>
+        *   <li>all columns form DB with some exceptions that are overwritten or new</li>
+        *   <li>content is moved in assets</li>
+        *   <li>assets => list of associative lists where each one represents a</li>
+        * video asset having keys: "src", "res", "par" and "ext". Value of key
+        * "src" is the video torrent formated as
+        * {name}_{format}.{video_ext}.{default_torrent_ext}</li>
+        *   <li>user_name => TODO: user name from `users` table</li>
+        *   <li>category_title => a human-friendly category name</li>
+        *   <li>tags => associative list of "tag => score"</li>
+        *   <li>date => date and time when the video was created</li>
+        *   <li>thumbs => thumbnail images' URLs</li>
+        * </ul>
         */
        public function get_video($id, $name = NULL)
        {
+               $this->load->helper('video');
+               
                $query = $this->db->query('SELECT * 
                                                                FROM `videos` 
                                                                WHERE id = ?', $id);
@@ -105,28 +162,58 @@ class Videos_model extends CI_Model {
                }
                
                // Convert JSON encoded string to arrays.
-               $video['formats'] = json_decode($video['formats'], TRUE);
+               $video['assets'] = json_decode($video['formats'], TRUE);
+               unset($video['formats']);
                $video['tags'] = json_decode($video['tags'], TRUE);
                asort($video['tags']);
-               $video['tags'] = array_reverse($video['tags'], true);
+               $video['tags'] = array_reverse($video['tags'], TRUE);
+               
+               // Sort assets by their megapixels number.
+               function access_function($a) { return $a['res']; }
+               function assets_cmp($a, $b) 
+                       { return megapixels_cmp($a, $b, "access_function"); }
+               usort($video['assets'], "assets_cmp");
                
                // Torrents
-               $video['torrents'] = array();
-               foreach ($video['formats'] as $format)
+               $video['url'] = array();
+               foreach ($video['assets'] as & $asset)
                {
-                       $ext = isset($format['ext']) ? 
-                               $format['ext'] : $this->config->item('default_video_ext');
-                       $video['torrents'][] = site_url('data/torrents/'. $video['name'] . '_'
-                               . $format['def'] . '.'. $ext
+                       $def = substr($asset['res'], strpos($asset['res'], 'x') + 1) . 'p';
+                       $asset['src'] = site_url('data/torrents/'. $video['name'] . '_'
+                               . $def . '.'. $asset['ext']
                                . '.'. $this->config->item('default_torrent_ext'));
                }
                
+               // Category title
+               $categories = $this->config->item('categories');
+               $category_name = $categories[ intval($video['category_id']) ];
+               $video['category_title'] = $category_name ?
+                       $this->lang->line("ui_categ_$category_name") : $category_name;
+               
                // Thumbnails
                $video['thumbs'] = $this->get_thumbs($video['name'], $video['thumbs_count']);
                
+               // TODO: user information
+               $video['user_name'] = 'TODO';
+               
                return $video;
        }
        
+       /**
+        * Increment a video parameter from DB: `views`, `likes` or `dislikes`.
+        * 
+        * @param int $id       DB video id
+        * @param string $param DB parameter column name.
+        * @return void
+        */
+       public function inc_video_var($id, $var)
+       {
+               // TODO error report if query returns FALSE
+               $this->db->query('UPDATE `videos` '
+                                               . 'SET `'. $var. '`=`'. $var. '`+1 '
+                                               . 'WHERE id='. $id); 
+       }
+       
        public function get_thumbs($name, $count)
        {
                $thumbs = array();
@@ -136,6 +223,158 @@ class Videos_model extends CI_Model {
                
                return $thumbs;
        }
+
+       /**
+        * Searches videos in DB based on a search query string and returns an
+        * associative array of results.
+        * If count is zero the function only return the number of results.
+        * @param string $search_query
+        * @param int $offset
+        * @param int $count
+        * @param int $category_id      if NULL, all categories are searched
+        * @return array        an associative array with the same keys as that from
+        * get_videos_summary's result, but with two additional keys: 
+        * description and date.
+        */
+       public function search_videos($search_query, $offset = 0, $count = 0, 
+                                                                       $category_id = NULL)
+       {
+               $search_query = trim($search_query);
+               $search_query = str_replace("'", " ", $search_query);
+               
+               // Search word fragments.
+               // sfc = search fragment condition
+               $sfc = "( ";
+               // sfr = serach fragment relevation
+               $sfr = "( ";
+               $sep = ' +-*<>()~"';
+               $fragm = strtok($search_query, $sep);
+               while ($fragm !== FALSE)
+               {
+                       $sfc .= "(title LIKE '%$fragm%'
+                                       OR description LIKE '%$fragm%'
+                                       OR tags LIKE '%$fragm%') OR ";
+                       
+                       // Frament relevations are half of boolean relevations such
+                       // that they will appear at the end of the results.
+                       $sfr .= "0.25 * (title LIKE '%$fragm%')
+                                       + 0.1 * (description LIKE '%$fragm%')
+                                       + 0.15 * (tags LIKE '%$fragm%') + ";
+                       
+                       $fragm = strtok($sep);
+               }
+               $sfc = substr($sfc, 0, -4) . " )";
+               $sfr = substr($sfr, 0, -3) . " )";
+               
+               if (! $this->is_advanced_search_query($search_query))
+               {
+                       $search_cond = "MATCH (title, description, tags)
+                                       AGAINST ('$search_query') OR $sfc";
+                       $relevance = "( MATCH (title, description, tags)
+                                       AGAINST ('$search_query') + $sfr ) AS relevance";
+               }
+               // boolean mode
+               else
+               {
+                       $against = "AGAINST ('$search_query' IN BOOLEAN MODE)";
+                       $search_cond = "( MATCH (title, description, tags)
+                                       $against) OR $sfc";
+                       $relevance = "( 0.5 * (MATCH(title) $against)
+                                       + 0.3 * (MATCH(tags) $against)
+                                       + 0.2 * (MATCH(description) $against)
+                                       + $sfr) AS relevance";
+               }
+               
+               if ($count === 0)
+               {
+                       $selected_columns = "COUNT(*) count";
+                       $order = "";
+                       $limit = "";
+               }
+               else
+               {
+                       // TODO select data, description if details are needed
+                       $selected_columns = "id, name, title, duration, user_id, views,
+                                       thumbs_count, default_thumb,
+                                       (views + likes - dislikes) AS score, 
+                                       $relevance";
+                       $order = "ORDER BY relevance DESC, score DESC";
+                       $limit = "LIMIT $offset, $count";
+               }
+               
+               if ($category_id !== NULL)
+                       $category_cond = "category_id = '$category_id' AND ";
+               else
+                       $category_cond = "";
+
+               $str_query = "SELECT $selected_columns
+                       FROM `videos`
+                       WHERE  $category_cond $search_cond
+                       $order
+                       $limit";
+               //echo "<p>$str_query</p>";
+               $query = $this->db->query($str_query);
+               
+               if ($query->num_rows() > 0)
+               {
+                       if ($count === 0)
+                               return $query->row()->count;
+                       else
+                               $videos = $query->result_array();
+               }
+               else
+                       return NULL;
+               
+               $this->load->helper('text');
+               
+               foreach ($videos as & $video)
+               {
+                       // P2P-Tube Video URL
+                       $video['video_url'] = site_url(sprintf("watch/%d/%s",
+                               $video['id'], $video['name']));
+                       
+                       // Thumbnails
+                       $video['thumbs'] = $this->get_thumbs($video['name'], 
+                               $video['thumbs_count']);
+                               
+                       // Ellipsized title
+                       //$video['shorted_title'] = ellipsize($video['title'], 45, 0.75);
+                       $video['shorted_title'] = character_limiter($video['title'], 50);
+                       
+                       // TODO: user information
+                       $video['user_name'] = 'TODO';
+               }
+               
+               return $videos;
+       }
+       
+       public function decode_search_query($search_query)
+       {
+               $search_query = urldecode($search_query);
+               
+               $search_query = str_replace('_AST_', '*', $search_query);
+               $search_query = str_replace('_AND_', '+', $search_query);
+               $search_query = str_replace('_GT_', '>', $search_query);
+               $search_query = str_replace('_LT_', '<', $search_query);
+               $search_query = str_replace('_PO_', '(', $search_query);
+               $search_query = str_replace('_PC_', ')', $search_query);
+               $search_query = str_replace('_LOW_', '~', $search_query);
+               $search_query = str_replace('_QUO_', '"', $search_query);
+               
+               return $search_query;
+       }
+       
+       /**
+        * Return TRUE if it contains any special caracter from an advanced search
+        * query.
+        * @param string $search_query
+        * @return boolean
+        */
+       public function is_advanced_search_query($search_query)
+       {
+               return (preg_match('/\*|\+|\-|>|\<|\(|\)|~|"/', $search_query) == 0
+                       ? FALSE : TRUE);
+       }
 }
 
 /* End of file videos_model.php */