application/models/videos_model.php

   1 <?php
   2
   3 /**
   4  * Class Videos_model models videos information from the DB
   5  *
   6  * @category    Model
   7  * @author              Călin-Andrei Burloiu
   8  */
   9 class Videos_model extends CI_Model {
  10         public $db = NULL;
  11
  12         public function __construct()
  13         {
  14                 parent::__construct();
  15
  16                 if ($this->db === NULL)
  17                 {
  18                         $this->load->library('singleton_db');
  19                         $this->db = $this->singleton_db->connect();
  20                 }
  21         }
  22
  23         /**
  24          * Retrieves a set of videos information which can be used for displaying
  25          * that videos as a list with few details.
  26          *
  27          * @param               int $category_id        DB category ID; pass NULL for all
  28          * categories
  29          * @param               mixed $user                     an user_id (as int) or an username
  30          * (as string); pass NULL for all users
  31          * @param               int $offset
  32          * @param               int $count
  33          * @param               string $ordering        control videos ording by these
  34          * possibilities:
  35          * <ul>
  36          *   <li><strong>'hottest':</strong> newest most appreciated first. An
  37          *   appreciated video is one which has a bigger
  38          *   score = views + likes - dislikes.</li>
  39          *   <li><strong>'newest':</strong> newest first.</li>
  40          *   <li><strong>'alphabetically':</strong> sort alphabetically.</li>
  41          * </ul>
  42          * @return              array   a list of videos, each one being an assoc array with:
  43          * <ul>
  44          *   <li>id, name, title, duration, thumbs_count, default_thumb, views => from DB</li>
  45          *   <li>shorted_title => ellipsized title</li>
  46          *   <li>video_url => P2P-Tube video URl</li>
  47          *   <li>user_id, user_name</li>
  48          *   <li>thumbs => thumbnail images' URLs</li>
  49          * </ul>
  50          */
  51         public function get_videos_summary($category_id, $user, $offset, $count,
  52                 $ordering = 'hottest')
  53         {
  54                 $this->load->helper('text');
  55
  56                 // Ordering
  57                 switch ($ordering)
  58                 {
  59                 case 'hottest':
  60                         $order_statement = "ORDER BY date DESC, score DESC, RAND()";
  61                         break;
  62                 case 'newest':
  63                         $order_statement = "ORDER BY date DESC";
  64                         break;
  65                 case 'alphabetically':
  66                         $order_statement = "ORDER BY title";
  67                         break;
  68
  69                 default:
  70                         $order_statement = "";
  71                 }
  72
  73                 // Category filtering
  74                 if ($category_id === NULL)
  75                         $cond_category = "1";
  76                 else
  77                 {
  78                         $category_id = intval($category_id);
  79                         $cond_category = "category_id = $category_id";
  80                 }
  81
  82                 // User filtering
  83                 if ($user === NULL)
  84                         $cond_user = "1";
  85                 else
  86                 {
  87                         if (is_int($user))
  88                                 $cond_user = "v.user_id = $user";
  89                         else if (is_string($user))
  90                                 $cond_user = "u.username = '$user'";
  91                 }
  92
  93                 $query = $this->db->query(
  94                         "SELECT v.id, name, title, duration, user_id, u.username, views,
  95                                 thumbs_count, default_thumb,
  96                                 (views + likes - dislikes) AS score
  97                         FROM `videos` v, `users` u
  98                         WHERE v.user_id = u.id AND $cond_category AND $cond_user
  99                         $order_statement
 100                         LIMIT $offset, $count");
 101
 102                 if ($query->num_rows() > 0)
 103                         $videos = $query->result_array();
 104                 else
 105                         return array();
 106
 107                 foreach ($videos as & $video)
 108                 {
 109                         // P2P-Tube Video URL
 110                         $video['video_url'] = site_url(sprintf("watch/%d/%s",
 111                                 $video['id'], $video['name']));
 112
 113                         // Thumbnails
 114                         $video['thumbs'] = $this->get_thumbs($video['name'],
 115                                 $video['thumbs_count']);
 116
 117                         // Ellipsized title
 118                         //$video['shorted_title'] = ellipsize($video['title'], 45, 0.75);
 119                         $video['shorted_title'] = character_limiter($video['title'], 50);
 120                 }
 121
 122                 return $videos;
 123         }
 124
 125         /**
 126          * Returns the number of videos from database from a specific category or
 127          * user.
 128          * NULL parameters count videos from all categories and / or all users.
 129          *
 130          * @param int $category_id
 131          * @param mixed $user   an user_id (as int) or an username (as string)
 132          * @return int  number of videos or FALSE if an error occured
 133          */
 134         public function get_videos_count($category_id = NULL, $user = NULL)
 135         {
 136                 if ($category_id === NULL)
 137                         $cond_category = "1";
 138                 else
 139                         $cond_category = "category_id = $category_id";
 140
 141                 if ($user === NULL)
 142                         $cond_user = "1";
 143                 else
 144                 {
 145                         if (is_int($user))
 146                                 $cond_user = "v.user_id = $user";
 147                         else if(is_string($user))
 148                                 $cond_user = "u.username = '$user'";
 149                 }
 150
 151                 $query = $this->db->query(
 152                         "SELECT COUNT(*) count
 153                         FROM `videos` v, `users` u
 154                         WHERE v.user_id = u.id AND $cond_category AND $cond_user");
 155
 156                 if ($query->num_rows() > 0)
 157                         return $query->row()->count;
 158
 159                 // Error
 160                 return FALSE;
 161         }
 162
 163         /**
 164          * Retrieves information about a video.
 165          *
 166          * If $name does not match with the video's `name` from the DB an error is
 167          * marked in the key 'err'. If it's NULL it is ignored.
 168          *
 169          * @access              public
 170          * @param               string $id      video's `id` column from `videos` DB table
 171          * @param               string $name    video's `name` column from `videos` DB
 172          * table. NULL means there is no name provided.
 173          * @return              array   an associative list with information about a video
 174          * with the following keys:
 175          * <ul>
 176          *   <li>all columns form DB with some exceptions that are overwritten or new</li>
 177          *   <li>content is moved in assets</li>
 178          *   <li>assets => list of associative lists where each one represents a</li>
 179          * video asset having keys: "src", "res", "par" and "ext". Value of key
 180          * "src" is the video torrent formated as
 181          * {name}_{format}.{video_ext}.{default_torrent_ext}</li>
 182          *   <li>username => user name from `users` table</li>
 183          *   <li>category_title => a human-friendly category name</li>
 184          *   <li>tags => associative list of "tag => score"</li>
 185          *   <li>date => date and time when the video was created</li>
 186          *   <li>thumbs => thumbnail images' URLs</li>
 187          * </ul>
 188          */
 189         public function get_video($id, $name = NULL)
 190         {
 191                 $this->load->helper('video');
 192
 193                 $query = $this->db->query("SELECT v.*, u.username
 194                                                                 FROM `videos` v, `users` u
 195                                                                 WHERE v.user_id = u.id AND v.id = $id");
 196                 $video = array();
 197
 198                 if ($query->num_rows() > 0)
 199                 {
 200                         $video = $query->row_array();
 201                         if ($name !== NULL && $video['name'] != $name)
 202                                 $video['err'] = 'INVALID_NAME';
 203                 }
 204                 else
 205                 {
 206                         $video['err'] = 'INVALID_ID';
 207                         return $video;
 208                 }
 209
 210                 // Convert JSON encoded string to arrays.
 211                 $video['assets'] = json_decode($video['formats'], TRUE);
 212                 unset($video['formats']);
 213                 $video['tags'] = json_decode($video['tags'], TRUE);
 214                 asort($video['tags']);
 215                 $video['tags'] = array_reverse($video['tags'], TRUE);
 216
 217                 // Sort assets by their megapixels number.
 218                 function access_function($a) { return $a['res']; }
 219                 function assets_cmp($a, $b)
 220                         { return megapixels_cmp($a, $b, "access_function"); }
 221                 usort($video['assets'], "assets_cmp");
 222
 223                 // Torrents
 224                 $video['url'] = array();
 225                 foreach ($video['assets'] as & $asset)
 226                 {
 227                         $def = substr($asset['res'], strpos($asset['res'], 'x') + 1) . 'p';
 228                         $asset['def'] = $def;
 229                         $asset['src'] = site_url('data/torrents/'. $video['name'] . '_'
 230                                 . $def . '.'. $asset['ext']
 231                                 . '.'. $this->config->item('default_torrent_ext'));
 232                 }
 233
 234                 // Category title
 235                 $categories = $this->config->item('categories');
 236                 $category_name = $categories[ intval($video['category_id']) ];
 237                 $video['category_title'] = $category_name ?
 238                         $this->lang->line("ui_categ_$category_name") : $category_name;
 239
 240                 // Thumbnails
 241                 $video['thumbs'] = $this->get_thumbs($video['name'], $video['thumbs_count']);
 242
 243                 return $video;
 244         }
 245
 246         /**
 247          * Retrieves comments for a video.
 248          *
 249          * @param int $video_id
 250          * @param int $offset
 251          * @param int $count
 252          * @param string $ordering      control comments ording by these possibilities:
 253          * <ul>
 254          *   <li><strong>'hottest':</strong> newest most appreciated first. An
 255          *   appreciated comment is one which has a bigger
 256          *   score = likes - dislikes.</li>
 257          *   <li><strong>'newest':</strong> newest first.</li>
 258          * </ul>
 259          * @return array        an array with comments
 260          */
 261         public function get_video_comments($video_id, $offset, $count,
 262                         $ordering = 'newest')
 263         {
 264                 $this->load->helper('date');
 265                 $cond_hottest = '';
 266
 267                 // Ordering
 268                 switch ($ordering)
 269                 {
 270                 case 'newest':
 271                         $order_statement = "ORDER BY time DESC";
 272                         break;
 273                 case 'hottest':
 274                         $order_statement = "ORDER BY score DESC, time DESC";
 275                         $cond_hottest = "AND c.likes + c.dislikes > 0";
 276                         break;
 277
 278                 default:
 279                         $order_statement = "";
 280                 }
 281
 282                 $query = $this->db->query(
 283                         "SELECT c.*, u.username, u.time_zone, (c.likes + c.dislikes) AS score
 284                                 FROM `videos_comments` c, `users` u
 285                                 WHERE c.user_id = u.id AND video_id = $video_id $cond_hottest
 286                                 $order_statement
 287                                 LIMIT $offset, $count");
 288
 289                 if ($query->num_rows() == 0)
 290                         return array();
 291
 292                 $comments = $query->result_array();
 293
 294                 foreach ($comments as & $comment)
 295                 {
 296                         $comment['local_time'] = human_gmt_to_human_local($comment['time'],
 297                                 $comment['time_zone']);
 298                 }
 299
 300                 return $comments;
 301         }
 302
 303         public function get_video_comments_count($video_id)
 304         {
 305                 $query = $this->db->query(
 306                                         "SELECT COUNT(*) count
 307                                                 FROM `videos_comments`
 308                                                 WHERE video_id = $video_id");
 309
 310                 if ($query->num_rows() == 0)
 311                         return FALSE;
 312
 313                 return $query->row()->count;
 314         }
 315
 316         /**
 317          * Insert in DB a comment for a video.
 318          *
 319          * @param int $video_id
 320          * @param int $user_id
 321          * @param string $content
 322          */
 323         public function comment_video($video_id, $user_id, $content)
 324         {
 325                 // Prepping content.
 326                 $content = substr($content, 0, 512);
 327                 $content = htmlspecialchars($content);
 328                 $content = nl2br($content);
 329
 330                 return $query = $this->db->query(
 331                         "INSERT INTO `videos_comments` (video_id, user_id, content, time)
 332                         VALUES ($video_id, $user_id, '$content', UTC_TIMESTAMP())");
 333         }
 334
 335         /**
 336          * Increments views count for a video.
 337          *
 338          * @param int $id       DB video id
 339          * @return void
 340          */
 341         public function inc_views($id)
 342         {
 343                 return $this->db->query('UPDATE `videos` '
 344                                                 . 'SET `views`=`views`+1 '
 345                                                 . 'WHERE id='. $id);
 346         }
 347
 348         public function vote($video_id, $user_id, $like = TRUE)
 349         {
 350                 if ($like)
 351                 {
 352                         $col = 'likes';
 353                         $action = 'like';
 354                 }
 355                 else
 356                 {
 357                         $col = 'dislikes';
 358                         $action = 'dislike';
 359                 }
 360
 361                 $query = $this->db->query("SELECT * FROM `users_actions`
 362                         WHERE user_id = $user_id
 363                                 AND target_id = $video_id
 364                                 AND target_type = 'video'
 365                                 AND action = '$action'
 366                                 AND date = CURDATE()");
 367                 // User already voted today
 368                 if ($query->num_rows() > 0)
 369                         return -1;
 370
 371                 $this->db->query("UPDATE `videos`
 372                         SET $col = $col + 1
 373                         WHERE id = $video_id");
 374
 375                 // Mark this action so that the user cannot repeat it today.
 376                 $this->db->query("INSERT INTO `users_actions`
 377                                 (user_id, action, target_type, target_id, date)
 378                         VALUES ( $user_id, '$action', 'video', $video_id, CURDATE() )");
 379
 380                 $query = $this->db->query("SELECT $col FROM `videos`
 381                         WHERE id = $video_id");
 382
 383                 if ($query->num_rows() === 1)
 384                 {
 385                         $row = $query->row_array();
 386                         return $row[ $col ];
 387                 }
 388
 389                 // Error
 390                 return FALSE;
 391         }
 392
 393         public function vote_comment($comment_id, $user_id, $like = TRUE)
 394         {
 395                 if ($like)
 396                 {
 397                         $col = 'likes';
 398                         $action = 'like';
 399                 }
 400                 else
 401                 {
 402                         $col = 'dislikes';
 403                         $action = 'dislike';
 404                 }
 405
 406                 $query = $this->db->query("SELECT * FROM `users_actions`
 407                                 WHERE user_id = $user_id
 408                                         AND target_id = $comment_id
 409                                         AND target_type = 'vcomment'
 410                                         AND action = '$action'
 411                                         AND date = CURDATE()");
 412                 // User already voted today
 413                 if ($query->num_rows() > 0)
 414                         return -1;
 415
 416                 $this->db->query("UPDATE `videos_comments`
 417                                 SET $col = $col + 1
 418                                 WHERE id = $comment_id");
 419
 420                 // Mark this action so that the user cannot repeat it today.
 421                 $this->db->query("INSERT INTO `users_actions`
 422                                         (user_id, action, target_type, target_id, date)
 423                                 VALUES ( $user_id, '$action', 'vcomment', $comment_id, CURDATE() )");
 424
 425                 $query = $this->db->query("SELECT $col FROM `videos_comments`
 426                                 WHERE id = $comment_id");
 427
 428                 if ($query->num_rows() === 1)
 429                 {
 430                         $row = $query->row_array();
 431                         return $row[ $col ];
 432                 }
 433
 434                 // Error
 435                 return FALSE;
 436         }
 437
 438         public function get_thumbs($name, $count)
 439         {
 440                 $thumbs = array();
 441
 442                 for ($i=0; $i < $count; $i++)
 443                         $thumbs[] = site_url(sprintf("data/thumbs/%s_t%02d.jpg", $name, $i));
 444
 445                 return $thumbs;
 446         }
 447
 448         /**
 449          * Searches videos in DB based on a search query string and returns an
 450          * associative array of results.
 451          * If count is zero the function only return the number of results.
 452          * @param string $search_query
 453          * @param int $offset
 454          * @param int $count
 455          * @param int $category_id      if NULL, all categories are searched
 456          * @return array        an associative array with the same keys as that from
 457          * get_videos_summary's result, but with two additional keys:
 458          * description and date.
 459          */
 460         public function search_videos($search_query, $offset = 0, $count = 0,
 461                                                                         $category_id = NULL)
 462         {
 463                 $search_query = trim($search_query);
 464                 $search_query = str_replace("'", " ", $search_query);
 465
 466                 // Search word fragments.
 467                 // sfc = search fragment condition
 468                 $sfc = "( ";
 469                 // sfr = serach fragment relevation
 470                 $sfr = "( ";
 471                 $sep = ' +-*<>()~"';
 472                 $fragm = strtok($search_query, $sep);
 473                 while ($fragm !== FALSE)
 474                 {
 475                         $sfc .= "(title LIKE '%$fragm%'
 476                                         OR description LIKE '%$fragm%'
 477                                         OR tags LIKE '%$fragm%') OR ";
 478
 479                         // Frament relevations are half of boolean relevations such
 480                         // that they will appear at the end of the results.
 481                         $sfr .= "0.25 * (title LIKE '%$fragm%')
 482                                         + 0.1 * (description LIKE '%$fragm%')
 483                                         + 0.15 * (tags LIKE '%$fragm%') + ";
 484
 485                         $fragm = strtok($sep);
 486                 }
 487                 $sfc = substr($sfc, 0, -4) . " )";
 488                 $sfr = substr($sfr, 0, -3) . " )";
 489
 490                 if (! $this->is_advanced_search_query($search_query))
 491                 {
 492                         $search_cond = "MATCH (title, description, tags)
 493                                         AGAINST ('$search_query') OR $sfc";
 494                         $relevance = "( MATCH (title, description, tags)
 495                                         AGAINST ('$search_query') + $sfr ) AS relevance";
 496                 }
 497                 // boolean mode
 498                 else
 499                 {
 500                         $against = "AGAINST ('$search_query' IN BOOLEAN MODE)";
 501                         $search_cond = "( MATCH (title, description, tags)
 502                                         $against) OR $sfc";
 503                         $relevance = "( 0.5 * (MATCH(title) $against)
 504                                         + 0.3 * (MATCH(tags) $against)
 505                                         + 0.2 * (MATCH(description) $against)
 506                                         + $sfr) AS relevance";
 507                 }
 508
 509                 if ($count === 0)
 510                 {
 511                         $selected_columns = "COUNT(*) count";
 512                         $order = "";
 513                         $limit = "";
 514                 }
 515                 else
 516                 {
 517                         // TODO select data, description if details are needed
 518                         $selected_columns = "id, name, title, duration, user_id, views,
 519                                         thumbs_count, default_thumb,
 520                                         (views + likes - dislikes) AS score,
 521                                         $relevance";
 522                         $order = "ORDER BY relevance DESC, score DESC";
 523                         $limit = "LIMIT $offset, $count";
 524                 }
 525
 526                 if ($category_id !== NULL)
 527                         $category_cond = "category_id = '$category_id' AND ";
 528                 else
 529                         $category_cond = "";
 530
 531                 $str_query = "SELECT $selected_columns
 532                         FROM `videos`
 533                         WHERE  $category_cond ( $search_cond )
 534                         $order
 535                         $limit";
 536 //              echo "<p>$str_query</p>";
 537                 $query = $this->db->query($str_query);
 538
 539                 if ($query->num_rows() > 0)
 540                 {
 541                         if ($count === 0)
 542                                 return $query->row()->count;
 543                         else
 544                                 $videos = $query->result_array();
 545                 }
 546                 else
 547                         return NULL;
 548
 549                 $this->load->helper('text');
 550
 551                 foreach ($videos as & $video)
 552                 {
 553                         // P2P-Tube Video URL
 554                         $video['video_url'] = site_url(sprintf("watch/%d/%s",
 555                                 $video['id'], $video['name']));
 556
 557                         // Thumbnails
 558                         $video['thumbs'] = $this->get_thumbs($video['name'],
 559                                 $video['thumbs_count']);
 560
 561                         // Ellipsized title
 562                         //$video['shorted_title'] = ellipsize($video['title'], 45, 0.75);
 563                         $video['shorted_title'] = character_limiter($video['title'], 50);
 564
 565                         // TODO: user information
 566                         $video['user_name'] = 'TODO';
 567                 }
 568
 569                 return $videos;
 570         }
 571
 572         public function decode_search_query($search_query)
 573         {
 574                 $search_query = urldecode($search_query);
 575
 576                 $search_query = str_replace('_AST_', '*', $search_query);
 577                 $search_query = str_replace('_AND_', '+', $search_query);
 578                 $search_query = str_replace('_GT_', '>', $search_query);
 579                 $search_query = str_replace('_LT_', '<', $search_query);
 580                 $search_query = str_replace('_PO_', '(', $search_query);
 581                 $search_query = str_replace('_PC_', ')', $search_query);
 582                 $search_query = str_replace('_LOW_', '~', $search_query);
 583                 $search_query = str_replace('_QUO_', '"', $search_query);
 584
 585                 return $search_query;
 586         }
 587
 588         public function encode_search_query($search_query)
 589         {
 590                 $search_query = str_replace('*', '_AST_', $search_query);
 591                 $search_query = str_replace('+', '_AND_', $search_query);
 592                 $search_query = str_replace('>', '_GT_', $search_query);
 593                 $search_query = str_replace('<', '_LT_', $search_query);
 594                 $search_query = str_replace('(', '_PO_', $search_query);
 595                 $search_query = str_replace(')', '_PC_', $search_query);
 596                 $search_query = str_replace('~', '_LOW_', $search_query);
 597                 $search_query = str_replace('"', '_QUO_', $search_query);
 598
 599                 $search_query = urlencode($search_query);
 600
 601                 return $search_query;
 602         }
 603
 604         /**
 605          * Return TRUE if it contains any special caracter from an advanced search
 606          * query.
 607          * @param string $search_query
 608          * @return boolean
 609          */
 610         public function is_advanced_search_query($search_query)
 611         {
 612                 return (preg_match('/\*|\+|\-|>|\<|\(|\)|~|"/', $search_query) == 0
 613                         ? FALSE : TRUE);
 614         }
 615 }
 616
 617 /* End of file videos_model.php */
 618 /* Location: ./application/models/videos_model.php */