<?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/>.
 *
 */

/*
 * localplay_controller Class
 *
 * This is the abstract class for any localplay controller
 *
 */
abstract class localplay_controller
{
    // Required Functions
    abstract public function add_url(Stream_URL $url); // Takes an array of song_ids
    abstract public function delete_track($object_id); // Takes a single object_id and removes it from the playlist
    abstract public function play();
    abstract public function stop();
    abstract public function get();
    abstract public function connect();
    abstract public function status();
    abstract public function get_version(); // Returns the version of this plugin
    abstract public function get_description(); // Returns the description
    abstract public function is_installed(); // Returns an boolean t/f
    abstract public function install();
    abstract public function uninstall();

    // For display we need the following 'instance' functions
    abstract public function add_instance($data);
    abstract public function delete_instance($id);
    abstract public function update_instance($id, $post);
    abstract public function get_instances();
    abstract public function instance_fields();
    abstract public function set_active_instance($uid);
    abstract public function get_active_instance();

    /**
     * get_url
     * This returns the URL for the passed object
     */
    public function get_url($object)
    {
        // This might not be an object!
        if (!is_object($object)) {
            // Stupiidly we'll just blindly add it for now
            return $object;
        }

        $class = get_class($object);

        $url = call_user_func(array($class, 'play_url'), $object->id);

        return $url;
    } // get_url

    /**
     * get_file
     * This returns the Filename for the passed object, not
     * always possible
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function get_file($object)
    {
    } // get_file

    /**
     * parse_url
     * This takes an Ampache URL and then returns the 'primary' part of it
     * So that it's easier for localplay modules to return valid song information
     */
    public function parse_url($url)
    {
        // Define possible 'primary' keys
        $primary_array = array('oid','demo_id','random');
        $data          = array();

        $variables = parse_url($url, PHP_URL_QUERY);
        if ($variables) {
            parse_str($variables, $data);

            foreach ($primary_array as $pkey) {
                if ($data[$pkey]) {
                    $data['primary_key'] = $pkey;
                    return $data;
                }
            } // end foreach
        }

        return $data;
    } // parse_url
} // end localplay_controller interface