summaryrefslogtreecommitdiffstats
path: root/lib/class/ampacherss.class.php
blob: 69684f82363c3daa197900a9afe7a1f168d87844 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?php
/*

 Copyright Ampache.org
 All Rights Reserved

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; version 2
 of the License.

 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 

*/

/**
 * AmpacheRSS Class
 * This is not currently used by the stable version of ampache, really here for future use and
 * due to the fact it was back-ported from /trunk
 */
class AmpacheRSS {

	private $type; 
	public $data; 

	/**
	 * Constructor
	 * This takes a flagged.id and then pulls in the information for said flag entry
	 */
	public function __construct($type) { 	

		$this->type = self::validate_type($type); 
		
	} // constructor

	/**
	 * get_xml
	 * This returns the xmldocument for the current rss type, it calls a sub function that gathers the data
	 * and then uses the xmlDATA class to build the document
	 */
	public function get_xml() { 

		// Function call name
		$data_function = 'load_' . $this->type; 
		$pub_date_function = 'pubdate_' . $this->type; 

		$data = call_user_func(array('AmpacheRSS',$data_function)); 
		$pub_date = call_user_func(array('AmpacheRSS',$pub_date_function)); 

		xmlData::set_type('rss'); 
		$xml_document = xmlData::rss_feed($data,$this->get_title(),$this->get_description(),$pub_date); 

		return $xml_document; 

	} // get_xml

	/**
	 * get_title
	 * This returns the standardized title for the rss feed based on this->type
	 */
	public function get_title() { 

		$titles = array('now_playing'=>_('Now Playing'),
				'recently_played'=>_('Recently Played'),
				'latest_album'=>_('Newest Albums'),
				'latest_artist'=>_('Newest Artists')); 

		return $titles[$this->type]; 

	} // get_title

	/**
	 * get_description
	 * This returns the standardized description for the rss feed based on this->type
	 */
	public function get_description() { 

		//FIXME: For now don't do any kind of translating
		return 'Ampache RSS Feeds'; 

	} // get_description

	/**
	 * validate_type
	 * this returns a valid type for an rss feed, if the specified type is invalid it returns a default value
	 */
	public static function validate_type($type) { 

		$valid_types = array('now_playing','recently_played','latest_album','latest_artist','latest_song',
				'popular_song','popular_album','popular_artist'); 
		
		if (!in_array($type,$valid_types)) { 
			return 'now_playing'; 
		} 

		return $type; 

	} // validate_type

	/**
 	 * get_display
	 * This dumps out some html and an icon for the type of rss that we specify
	 */
	public static function get_display($type='nowplaying') { 

		// Default to now playing
		$type = self::validate_type($type); 

		$string = '<a href="' . Config::get('web_path') . '/rss.php?type=' . $type . '">' . get_user_icon('feed',_('RSS Feed')) . '</a>';  

		return $string; 

	} // get_display

	// type specific functions below, these are called semi-dynamically based on the current type //

	/**
	 * load_now_playing
	 * This loads in the now playing information. This is just the raw data with key=>value pairs that could be turned
	 * into an xml document if we so wished
	 */
	public static function load_now_playing() { 

		$data = get_now_playing(); 

		$results = array(); 

		foreach ($data as $element) { 
			$song = $element['song']; 
			$client = $element['user']; 
			$xml_array = array('title'=>$song->f_title . ' - ' . $song->f_artist . ' - ' . $song->f_album,
					'link'=>$song->link, 
					'description'=>$song->title . ' - ' . $song->f_artist_full . ' - ' . $song->f_album_full,
					'comments'=>$client->fullname . ' - ' . $element['agent'],
					'pubDate'=>date("r",$element['expire'])
					); 
			$results[] = $xml_array; 
		} // end foreach 

		return $results; 

	} // load_now_playing

	/**
	 * pubdate_now_playing
	 * this is the pub date we should use for the now playing information, 
	 * this is a little specific as it uses the 'newest' expire we can find
	 */
	public static function pubdate_now_playing() { 

		// Little redundent, should be fixed by an improvement in the get_now_playing stuff
		$data = get_now_playing(); 

		$element = array_shift($data); 

		return $element['expire']; 

	} // pubdate_now_playing	

} // end AmpacheRSS class