mirror of
https://github.com/Yetangitu/ampache
synced 2025-10-03 09:49:30 +02:00
589 lines
19 KiB
PHP
589 lines
19 KiB
PHP
<?php
|
|
/* vim:set softtabstop=4 shiftwidth=4 expandtab: */
|
|
/**
|
|
*
|
|
* LICENSE: GNU Affero General Public License, version 3 (AGPLv3)
|
|
* Copyright 2001 - 2016 Ampache.org
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Browse Class
|
|
*
|
|
* This handles all of the sql/filtering
|
|
* on the data before it's thrown out to the templates
|
|
* it also handles pulling back the object_ids and then
|
|
* calling the correct template for the object we are displaying
|
|
*
|
|
*/
|
|
class Browse extends Query
|
|
{
|
|
/**
|
|
* @var boolean $show_header
|
|
*/
|
|
public $show_header;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param int|null $id
|
|
* @param boolean $cached
|
|
*/
|
|
public function __construct($id = null, $cached = true)
|
|
{
|
|
parent::__construct($id, $cached);
|
|
|
|
if (!$id) {
|
|
$this->set_use_pages(true);
|
|
$this->set_use_alpha(false);
|
|
$this->set_grid_view(true);
|
|
}
|
|
$this->show_header = true;
|
|
}
|
|
|
|
/**
|
|
* set_simple_browse
|
|
* This sets the current browse object to a 'simple' browse method
|
|
* which means use the base query provided and expand from there
|
|
*
|
|
* @param boolean $value
|
|
*/
|
|
public function set_simple_browse($value)
|
|
{
|
|
$this->set_is_simple($value);
|
|
} // set_simple_browse
|
|
|
|
/**
|
|
* add_supplemental_object
|
|
* Legacy function, need to find a better way to do that
|
|
*
|
|
* @param string $class
|
|
* @param int $uid
|
|
*/
|
|
public function add_supplemental_object($class, $uid)
|
|
{
|
|
$_SESSION['browse']['supplemental'][$this->id][$class] = intval($uid);
|
|
|
|
return true;
|
|
} // add_supplemental_object
|
|
|
|
/**
|
|
* get_supplemental_objects
|
|
* This returns an array of 'class','id' for additional objects that
|
|
* need to be created before we start this whole browsing thing.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_supplemental_objects()
|
|
{
|
|
$objects = isset($_SESSION['browse']['supplemental'][$this->id]) ? $_SESSION['browse']['supplemental'][$this->id] : '';
|
|
|
|
if (!is_array($objects)) {
|
|
$objects = array();
|
|
}
|
|
|
|
return $objects;
|
|
} // get_supplemental_objects
|
|
|
|
/**
|
|
* update_browse_from_session
|
|
* Restore the previous start index from something saved into the current session.
|
|
*/
|
|
public function update_browse_from_session()
|
|
{
|
|
if ($this->is_simple() && $this->get_start() == 0) {
|
|
$name = 'browse_current_' . $this->get_type();
|
|
if (isset($_SESSION[$name]) && isset($_SESSION[$name]['start']) && $_SESSION[$name]['start'] > 0) {
|
|
|
|
// Checking if value is suitable
|
|
$start = $_SESSION[$name]['start'];
|
|
if ($this->get_offset() > 0) {
|
|
$set_page = floor($start / $this->get_offset());
|
|
if ($this->get_total() > $this->get_offset()) {
|
|
$total_pages = ceil($this->get_total() / $this->get_offset());
|
|
} else {
|
|
$total_pages = 0;
|
|
}
|
|
|
|
if ($set_page >= 0 && $set_page <= $total_pages) {
|
|
$this->set_start($start);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* show_objects
|
|
* This takes an array of objects
|
|
* and requires the correct template based on the
|
|
* type that we are currently browsing
|
|
*
|
|
* @param int[] $object_ids
|
|
*/
|
|
public function show_objects($object_ids = null, $argument = null)
|
|
{
|
|
if ($this->is_simple() || !is_array($object_ids)) {
|
|
$object_ids = $this->get_saved();
|
|
} else {
|
|
$this->save_objects($object_ids);
|
|
}
|
|
|
|
// Limit is based on the user's preferences if this is not a
|
|
// simple browse because we've got too much here
|
|
if ($this->get_start() >= 0 && (count($object_ids) > $this->get_start()) &&
|
|
! $this->is_simple()) {
|
|
$object_ids = array_slice(
|
|
$object_ids,
|
|
$this->get_start(),
|
|
$this->get_offset(),
|
|
true
|
|
);
|
|
} else {
|
|
if (!count($object_ids)) {
|
|
$this->set_total(0);
|
|
}
|
|
}
|
|
|
|
// Load any additional object we need for this
|
|
$extra_objects = $this->get_supplemental_objects();
|
|
$browse = $this;
|
|
|
|
foreach ($extra_objects as $class_name => $id) {
|
|
${$class_name} = new $class_name($id);
|
|
}
|
|
|
|
$match = '';
|
|
// Format any matches we have so we can show them to the masses
|
|
if ($filter_value = $this->get_filter('alpha_match')) {
|
|
$match = ' (' . $filter_value . ')';
|
|
} elseif ($filter_value = $this->get_filter('starts_with')) {
|
|
$match = ' (' . $filter_value . ')';
|
|
/*} elseif ($filter_value = $this->get_filter('regex_match')) {
|
|
$match = ' (' . $filter_value . ')';
|
|
} elseif ($filter_value = $this->get_filter('regex_not_match')) {
|
|
$match = ' (' . $filter_value . ')';*/
|
|
} elseif ($filter_value = $this->get_filter('catalog')) {
|
|
// Get the catalog title
|
|
$catalog = Catalog::create_from_id(intval($filter_value));
|
|
$match = ' (' . $catalog->name . ')';
|
|
}
|
|
|
|
$type = $this->get_type();
|
|
|
|
// Update the session value only if it's allowed on the current browser
|
|
if ($this->get_update_session()) {
|
|
$_SESSION['browse_current_' . $type]['start'] = $browse->get_start();
|
|
}
|
|
|
|
// Set the correct classes based on type
|
|
$class = "box browse_" . $type;
|
|
|
|
$argument_param = ($argument ? '&argument=' . scrub_in($argument) : '');
|
|
|
|
debug_event('browse', 'Show objects called for type {' . $type . '}', '5');
|
|
|
|
$limit_threshold = $this->get_threshold();
|
|
|
|
// Switch on the type of browsing we're doing
|
|
switch ($type) {
|
|
case 'song':
|
|
$box_title = T_('Songs') . $match;
|
|
Song::build_cache($object_ids, $limit_threshold);
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_songs.inc.php');
|
|
break;
|
|
case 'album':
|
|
Album::build_cache($object_ids);
|
|
$box_title = T_('Albums') . $match;
|
|
if (is_array($argument)) {
|
|
$allow_group_disks = $argument['group_disks'];
|
|
if ($argument['title']) {
|
|
$box_title = $argument['title'];
|
|
}
|
|
} else {
|
|
$allow_group_disks = false;
|
|
}
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_albums.inc.php');
|
|
break;
|
|
case 'user':
|
|
$box_title = T_('Users') . $match;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_users.inc.php');
|
|
break;
|
|
case 'artist':
|
|
$box_title = T_('Artists') . $match;
|
|
Artist::build_cache($object_ids, true, $limit_threshold);
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_artists.inc.php');
|
|
break;
|
|
case 'live_stream':
|
|
$box_title = T_('Radio Stations') . $match;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_live_streams.inc.php');
|
|
break;
|
|
case 'playlist':
|
|
Playlist::build_cache($object_ids);
|
|
$box_title = T_('Playlists') . $match;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_playlists.inc.php');
|
|
break;
|
|
case 'playlist_media':
|
|
$box_title = T_('Playlist Medias') . $match;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_playlist_medias.inc.php');
|
|
break;
|
|
case 'playlist_localplay':
|
|
$box_title = T_('Current Playlist');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_localplay_playlist.inc.php');
|
|
UI::show_box_bottom();
|
|
break;
|
|
case 'smartplaylist':
|
|
$box_title = T_('Smart Playlists') . $match;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_searches.inc.php');
|
|
break;
|
|
case 'catalog':
|
|
$box_title = T_('Catalogs');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_catalogs.inc.php');
|
|
break;
|
|
case 'shoutbox':
|
|
$box_title = T_('Shoutbox Records');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_manage_shoutbox.inc.php');
|
|
break;
|
|
case 'tag':
|
|
Tag::build_cache($object_ids);
|
|
$box_title = T_('Tag Cloud');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_tagcloud.inc.php');
|
|
break;
|
|
case 'video':
|
|
Video::build_cache($object_ids);
|
|
$video_type = 'video';
|
|
$box_title = T_('Videos');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_videos.inc.php');
|
|
break;
|
|
case 'democratic':
|
|
$box_title = T_('Democratic Playlist');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_democratic_playlist.inc.php');
|
|
break;
|
|
case 'wanted':
|
|
$box_title = T_('Wanted Albums');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_wanted_albums.inc.php');
|
|
break;
|
|
case 'share':
|
|
$box_title = T_('Shared Objects');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_shared_objects.inc.php');
|
|
break;
|
|
case 'song_preview':
|
|
$box_title = T_('Songs');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_song_previews.inc.php');
|
|
break;
|
|
case 'channel':
|
|
$box_title = T_('Channels');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_channels.inc.php');
|
|
break;
|
|
case 'broadcast':
|
|
$box_title = T_('Broadcasts');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_broadcasts.inc.php');
|
|
break;
|
|
case 'license':
|
|
$box_title = T_('Media Licenses');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_manage_license.inc.php');
|
|
break;
|
|
case 'tvshow':
|
|
$box_title = T_('TV Shows');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_tvshows.inc.php');
|
|
break;
|
|
case 'tvshow_season':
|
|
$box_title = T_('Seasons');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_tvshow_seasons.inc.php');
|
|
break;
|
|
case 'tvshow_episode':
|
|
$box_title = T_('Episodes');
|
|
$video_type = $type;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_videos.inc.php');
|
|
break;
|
|
case 'movie':
|
|
$box_title = T_('Movies');
|
|
$video_type = $type;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_videos.inc.php');
|
|
break;
|
|
case 'clip':
|
|
$box_title = T_('Clips');
|
|
$video_type = $type;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_videos.inc.php');
|
|
break;
|
|
case 'personal_video':
|
|
$box_title = T_('Personal Videos');
|
|
$video_type = $type;
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_videos.inc.php');
|
|
break;
|
|
case 'label':
|
|
$box_title = T_('Labels');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_labels.inc.php');
|
|
break;
|
|
case 'pvmsg':
|
|
$box_title = T_('Private Messages');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_pvmsgs.inc.php');
|
|
break;
|
|
case 'podcast':
|
|
$box_title = T_('Podcasts');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_podcasts.inc.php');
|
|
break;
|
|
case 'podcast_episode':
|
|
$box_title = T_('Podcast Episodes');
|
|
$box_req = AmpConfig::get('prefix') . UI::find_template('show_podcast_episodes.inc.php');
|
|
break;
|
|
default:
|
|
// Rien a faire
|
|
break;
|
|
} // end switch on type
|
|
|
|
Ajax::start_container($this->get_content_div(), 'browse_content');
|
|
if ($this->get_show_header()) {
|
|
if (isset($box_req) && isset($box_title)) {
|
|
UI::show_box_top($box_title, $class);
|
|
}
|
|
}
|
|
|
|
if (isset($box_req)) {
|
|
require $box_req;
|
|
}
|
|
|
|
if ($this->get_show_header()) {
|
|
if (isset($box_req)) {
|
|
UI::show_box_bottom();
|
|
}
|
|
echo '<script type="text/javascript">';
|
|
echo Ajax::action('?page=browse&action=get_filters&browse_id=' . $this->id . $argument_param, '');
|
|
echo ';</script>';
|
|
} else {
|
|
if (!$this->get_use_pages()) {
|
|
$this->show_next_link($argument);
|
|
}
|
|
}
|
|
Ajax::end_container();
|
|
} // show_object
|
|
|
|
public function show_next_link($argument = null)
|
|
{
|
|
$limit = $this->get_offset();
|
|
$start = $this->get_start();
|
|
$total = $this->get_total();
|
|
$next_offset = $start + $limit;
|
|
if ($next_offset <= $total) {
|
|
echo '<a class="jscroll-next" href="' . AmpConfig::get('ajax_url') . '?page=browse&action=page&browse_id=' . $this->id . '&start=' . $next_offset . '&xoutput=raw&xoutputnode=' . $this->get_content_div() . '&show_header=false' . $argument . '">' . T_('More') . '</a>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* set_filter_from_request
|
|
* //FIXME
|
|
* @param array $request
|
|
*/
|
|
public function set_filter_from_request($request)
|
|
{
|
|
foreach ($request as $key => $value) {
|
|
//reinterpret v as a list of int
|
|
$list = explode(',', $value);
|
|
$ok = true;
|
|
foreach ($list as $item) {
|
|
if (!is_numeric($item)) {
|
|
$ok = false;
|
|
break;
|
|
}
|
|
}
|
|
if ($ok) {
|
|
if (sizeof($list) == 1) {
|
|
$this->set_filter($key, $list[0]);
|
|
}
|
|
} else {
|
|
$this->set_filter($key, $list);
|
|
}
|
|
}
|
|
} // set_filter_from_request
|
|
|
|
/**
|
|
*
|
|
* @param string $type
|
|
* @param string $custom_base
|
|
*/
|
|
public function set_type($type, $custom_base = '')
|
|
{
|
|
$cn = 'browse_' . $type . '_pages';
|
|
if (isset($_COOKIE[$cn])) {
|
|
$this->set_use_pages($_COOKIE[$cn] == 'true');
|
|
}
|
|
$cn = 'browse_' . $type . '_alpha';
|
|
if (isset($_COOKIE[$cn])) {
|
|
$this->set_use_alpha($_COOKIE[$cn] == 'true');
|
|
} else {
|
|
$default_alpha = explode(",", AmpConfig::get('libitem_browse_alpha'));
|
|
if (in_array($type, $default_alpha)) {
|
|
$this->set_use_alpha(true, false);
|
|
}
|
|
}
|
|
$cn = 'browse_' . $type . '_grid_view';
|
|
if (isset($_COOKIE[$cn])) {
|
|
$this->set_grid_view($_COOKIE[$cn] == 'true');
|
|
}
|
|
|
|
parent::set_type($type, $custom_base);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $option
|
|
* @param string $value
|
|
*/
|
|
public function save_cookie_params($option, $value)
|
|
{
|
|
if ($this->get_type()) {
|
|
setcookie('browse_' . $this->get_type() . '_' . $option, $value, time() + 31536000, "/");
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param boolean $use_pages
|
|
*/
|
|
public function set_use_pages($use_pages, $savecookie = true)
|
|
{
|
|
if ($savecookie) {
|
|
$this->save_cookie_params('pages', $use_pages ? 'true' : 'false');
|
|
}
|
|
$this->_state['use_pages'] = $use_pages;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_use_pages()
|
|
{
|
|
return $this->_state['use_pages'];
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param boolean $grid_view
|
|
*/
|
|
public function set_grid_view($grid_view, $savecookie = true)
|
|
{
|
|
if ($savecookie) {
|
|
$this->save_cookie_params('grid_view', $grid_view ? 'true' : 'false');
|
|
}
|
|
$this->_state['grid_view'] = $grid_view;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_grid_view()
|
|
{
|
|
return $this->_state['grid_view'];
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param boolean $use_alpha
|
|
*/
|
|
public function set_use_alpha($use_alpha, $savecookie = true)
|
|
{
|
|
if ($savecookie) {
|
|
$this->save_cookie_params('alpha', $use_alpha ? 'true' : 'false');
|
|
}
|
|
$this->_state['use_alpha'] = $use_alpha;
|
|
|
|
if ($use_alpha) {
|
|
if (count($this->_state['filter']) == 0) {
|
|
$this->set_filter('regex_match', '^A');
|
|
}
|
|
} else {
|
|
$this->set_filter('regex_not_match', '');
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_use_alpha()
|
|
{
|
|
return $this->_state['use_alpha'];
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param boolean $show_header
|
|
*/
|
|
public function set_show_header($show_header)
|
|
{
|
|
$this->show_header = $show_header;
|
|
}
|
|
|
|
/**
|
|
* Allow the current page to be save into the current session
|
|
* @param boolean $update_session
|
|
*/
|
|
public function set_update_session($update_session)
|
|
{
|
|
$this->_state['update_session'] = $update_session;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_show_header()
|
|
{
|
|
return $this->show_header;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function get_update_session()
|
|
{
|
|
return $this->_state['update_session'];
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $threshold
|
|
*/
|
|
public function set_threshold($threshold)
|
|
{
|
|
$this->_state['threshold'] = $threshold;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_threshold()
|
|
{
|
|
return $this->_state['threshold'];
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_css_class()
|
|
{
|
|
$css = '';
|
|
if (!$this->_state['grid_view']) {
|
|
$css = 'disablegv';
|
|
}
|
|
return $css;
|
|
}
|
|
} // browse
|