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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
<?php
/*
Copyright 2001 - 2007 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 v2
as published by the Free Software Foundation.
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.
*/
/**
* AmpacheHttpQ Class
* This is the class for the HttpQ localplay method to remote control
* a WinAmp Instance
*/
class AmpacheHttpq extends localplay_controller {
/* Variables */
/* Constructed variables */
private $_httpq;
/**
* Constructor
* This returns the array map for the localplay object
* REQUIRED for Localplay
*/
public function __construct() {
/* Do a Require Once On the needed Libraries */
require_once Config::get('prefix') . '/modules/httpq/httpqplayer.class.php';
} // Constructor
/**
* get_description
* This returns the description of this localplay method
*/
public function get_description() {
return 'Connects to a remote Winamp instance';
} // get_description
/**
* get_version
* This returns the current version
*/
public function get_version() {
return '000001';
} // get_version
/**
* is_installed
* This returns true or false if MPD controller is installed
*/
public function is_installed() {
} // is_installed
/**
* install
* This function installs the MPD localplay controller
*/
public function install() {
} // install
/**
* uninstall
* This removes the localplay controller
*/
public function uninstall() {
} // uninstall
/**
* add_instance
* This takes key'd data and inserts a new MPD instance
*/
public function add_instance($data) {
} // add_instance
/**
* delete_instance
* This takes a UID and deletes the instance in question
*/
public function delete_instance($uid) {
} // delete_instance
/**
* get_instances
* This returns a key'd array of the instance information with
* [UID]=>[NAME]
*/
public function get_instances() {
} // get_instances
/**
* instance_fields
* This returns a key'd array of [NAME]=>array([DESCRIPTION]=>VALUE,[TYPE]=>VALUE) for the
* fields so that we can on-the-fly generate a form
*/
public function instance_fields() {
} // instance_fields
/**
* set_active_instance
* This sets the specified instance as the 'active' one
*/
public function set_active_instance($uid) {
} // set_active_instance
/**
* get_active_instance
* This returns the UID of the current active instance
* false if none are active
*/
public function get_active_instance() {
} // get_active_instance
/**
* add
* This must take an array of URL's from Ampache
* and then add them to HttpQ
*/
public function add($objects) {
foreach ($songs as $song_id) {
$song = new Song($song_id);
$url = $song->get_url(0,1);
if (is_null($this->_httpq->add($song->title,$url))) {
debug_event('httpq_add',"Error: Unable to add $url to Httpq",'1');
}
} // end foreach
return true;
} // add
/**
* delete_track
* This must take an array of ID's (as passed by get function) from Ampache
* and delete them from Httpq
*/
public function delete_track($object_id) {
/* Default to true */
$return = true;
/* This should be an array of UID's as returned by
* the get function so that we can just call the class based
* functions to remove them or if there isn't a uid for
* the songs, then however ya'll have stored them
* in this controller
*/
foreach ($songs as $uid) {
if (is_null($this->_httpq->delete_pos($uid))) { $return = false; }
} // foreach of songs
return $return;
} // delete_track
/**
* clear_playlist
* This deletes the entire Httpq playlist... nuff said
*/
function clear_playlist() {
if (is_null($this->_httpq->clear())) { return false; }
// If the clear worked we should stop it!
$this->stop();
return true;
} // clear_playlist
/**
* play
* This just tells HttpQ to start playing, it does not
* take any arguments
*/
public function play() {
/* A play when it's already playing causes a track restart
* which we don't want to doublecheck its state
*/
if ($this->_httpq->state() == 'play') {
return true;
}
if (is_null($this->_httpq->play())) { return false; }
return true;
} // play
/**
* stop
* This just tells HttpQ to stop playing, it does not take
* any arguments
*/
public function stop() {
if (is_null($this->_httpq->stop())) { return false; }
return true;
} // stop
/**
* skip
* This tells HttpQ to skip to the specified song
*/
function skip($song) {
if (is_null($this->_httpq->skip($song))) { return false; }
return true;
} // skip
/**
* This tells Httpq to increase the volume by WinAmps default amount
*/
function volume_up() {
if (is_null($this->_httpq->volume_up())) { return false; }
return true;
} // volume_up
/**
* This tells HttpQ to decrease the volume by Winamps default amount
*/
function volume_down() {
if (is_null($this->_httpq->volume_down())) { return false; }
return true;
} // volume_down
/**
* next
* This just tells MPD to skip to the next song
*/
function next() {
if (is_null($this->_httpq->next())) { return false; }
return true;
} // next
/**
* prev
* This just tells MPD to skip to the prev song
*/
function prev() {
if (is_null($this->_httpq->prev())) { return false; }
return true;
} // prev
/**
* pause
* This tells MPD to pause the current song
*/
function pause() {
if (is_null($this->_httpq->pause())) { return false; }
return true;
} // pause
/**
* volume
* This tells HttpQ to set the volume to the specified amount this
* is 0-100
*/
function volume($volume) {
if (is_null($this->_httpq->set_volume($volume))) { return false; }
return true;
} // volume
/**
* loop
* This tells HttpQ to set the repeating the playlist (i.e. loop) to either on or off
*/
function loop($state) {
if (is_null($this->_httpq->repeat($state))) { return false; }
return true;
} // loop
/**
* random
* This tells HttpQ to turn on or off the playing of songs from the playlist in random order
*/
function random($onoff) {
if (is_null($this->_httpq->random($onoff))) { return false; }
return true;
} // random
/**
* get
* This functions returns an array containing information about
* The songs that HttpQ currently has in it's playlist. This must be
* done in a standardized fashion
*/
public function get() {
/* Get the Current Playlist */
$list = $this->_httpq->get_tracks();
$songs = explode("::",$list);
foreach ($songs as $key=>$entry) {
$data = array();
/* Required Elements */
$data['id'] = $key;
$data['raw'] = $entry;
/* Parse out the song ID and then create the song object */
preg_match("/song=(\d+)\&/",$entry,$matches);
/* Attempt to build the new song */
$song = new Song($matches['1']);
/* If we don't know it, look up by filename */
if (!$song->title) {
$filename = sql_escape($entry);
$sql = "SELECT id FROM song WHERE file LIKE '%$filename'";
$db_results = mysql_query($sql, dbh());
if ($r = mysql_fetch_assoc($db_results)) {
$song = new Song($r['id']);
}
else {
$song->title = _('Unknown');
}
}
/* Make the name pretty */
$song->format_song();
$data['name'] = $song->f_title . ' - ' . $song->f_album . ' - ' . $song->f_artist;
/* Optional Elements */
$data['link'] = '';
$data['track'] = $key+1;
$results[] = $data;
} // foreach playlist items
return $results;
} // get
/**
* status
* This returns bool/int values for features, loop, repeat and any other features
* That this localplay method supports. required function
*/
public function status() {
/* Construct the Array */
$array['state'] = $this->_httpq->state();
$array['volume'] = $this->_httpq->get_volume();
$array['repeat'] = $this->_httpq->get_repeat();
$array['random'] = $this->_httpq->get_random();
$array['track'] = $this->_httpq->get_now_playing();
preg_match("/song=(\d+)\&/",$array['track'],$matches);
$song_id = $matches['1'];
$song = new Song($song_id);
$array['track_title'] = $song->title;
$array['track_artist'] = $song->get_artist_name();
$array['track_album'] = $song->get_album_name();
return $array;
} // status
/**
* connect
* This functions creates the connection to HttpQ and returns
* a boolean value for the status, to save time this handle
* is stored in this class
*/
public function connect() {
$this->_httpq = new HttpQPlayer(conf('localplay_httpq_hostname'),conf('localplay_httpq_password'),conf('localplay_httpq_port'));
// Test our connection by retriving the version
if (!is_null($this->_httpq->version())) { return true; }
return false;
} // connect
} //end of AmpacheHttpq
?>
|
