[rygel] server: Add available seek range request

[Jens Georg <jensgeorg src gnome org>]

commit da1cea3246672706dcbe9a2e565d48ae2479fd91
Author: Jens Georg <mail jensge org>
Date:   Tue Feb 17 00:58:08 2015 +0100

    server: Add available seek range request
    
    Signed-off-by: Jens Georg <mail jensge org>

 src/librygel-server/filelist.am                    |    4 +-
 .../rygel-dlna-available-seek-request.vala         |   75 +++++++++++
 .../rygel-dlna-available-seek-response.vala        |  129 ++++++++++++++++++++
 3 files changed, 207 insertions(+), 1 deletions(-)
---
diff --git a/src/librygel-server/filelist.am b/src/librygel-server/filelist.am
index f46a0c2..516e635 100644
--- a/src/librygel-server/filelist.am
+++ b/src/librygel-server/filelist.am
@@ -86,4 +86,6 @@ LIBRYGEL_SERVER_NONVAPI_SOURCE_FILES = \
        rygel-playspeed-request.vala \
        rygel-playspeed-response.vala \
        rygel-dtcp-cleartext-request.vala \
-       rygel-dtcp-cleartext-response.vala
+       rygel-dtcp-cleartext-response.vala \
+       rygel-dlna-available-seek-request.vala \
+       rygel-dlna-available-seek-response.vala
diff --git a/src/librygel-server/rygel-dlna-available-seek-request.vala 
b/src/librygel-server/rygel-dlna-available-seek-request.vala
new file mode 100644
index 0000000..433bc57
--- /dev/null
+++ b/src/librygel-server/rygel-dlna-available-seek-request.vala
@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2014  Cable Television Laboratories, Inc.
+ * Contact: http://www.cablelabs.com/
+ *
+ * Author: Craig Pratt <craig ecaspia com>
+ *
+ * This file is part of Rygel.
+ *
+ * Rygel is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CABLE TELEVISION LABORATORIES
+ * INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+public static const string GET_AVAILABLE_SEEK_RANGE_HEADER = "getAvailableSeekRange.dlna.org";
+
+/**
+ * This class represents a DLNA getAvailableSeekRange request.
+ *
+ * A getAvailableSeekRange request can only have a single parameter: "1"
+ */
+public class Rygel.DLNAAvailableSeekRangeRequest : Rygel.HTTPSeekRequest {
+    /**
+     * Create a DLNAAvailableSeekRangeRequest corresponding with a HTTPGet that contains a
+     * getAvailableSeekRange.dlna.org header value.
+     *
+     * @param request The HTTP GET/HEAD request
+     */
+    internal DLNAAvailableSeekRangeRequest (HTTPGet request)
+            throws HTTPSeekRequestError {
+        base ();
+
+        var params = request.msg.request_headers.get_one (GET_AVAILABLE_SEEK_RANGE_HEADER);
+
+        if (params == null) {
+            throw new HTTPSeekRequestError.BAD_REQUEST ("%s not present",
+                                                        GET_AVAILABLE_SEEK_RANGE_HEADER);
+        }
+        if (params.strip () != "1") {
+            throw new HTTPSeekRequestError.BAD_REQUEST ("%s != 1 (found \"%s\")",
+                                                        GET_AVAILABLE_SEEK_RANGE_HEADER,
+                                                        params);
+        }
+    }
+
+    /**
+     * Return true if getAvailableSeekRange is supported.
+     */
+    public static bool supported (HTTPGet request) {
+        return true;
+    }
+
+    /**
+     * Return true of the HTTPGet contains a getAvailableSeekRange request.
+     */
+    public static bool requested (HTTPGet request) {
+        return (request.msg.request_headers.get_one (GET_AVAILABLE_SEEK_RANGE_HEADER) != null);
+    }
+}
diff --git a/src/librygel-server/rygel-dlna-available-seek-response.vala 
b/src/librygel-server/rygel-dlna-available-seek-response.vala
new file mode 100644
index 0000000..5c9dc8f
--- /dev/null
+++ b/src/librygel-server/rygel-dlna-available-seek-response.vala
@@ -0,0 +1,129 @@
+/*
+ * Copyright (C) 2014  Cable Television Laboratories, Inc.
+ * Contact: http://www.cablelabs.com/
+ *
+ * Author: Craig Pratt <craig ecaspia com>
+ *
+ * This file is part of Rygel.
+ *
+ * Rygel is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CABLE TELEVISION LABORATORIES
+ * INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+public static const string AVAILABLE_SEEK_RANGE_HEADER = "availableSeekRange.dlna.org";
+
+public class Rygel.DLNAAvailableSeekRangeResponse : Rygel.HTTPResponseElement {
+    /**
+     * The Limited Operation mode (0 or 1)
+     */
+    public int mode { get; private set; }
+
+    /**
+     * Available range start time, in microseconds
+     */
+    public int64 start_time { get; private set; }
+
+    /**
+     * Available range end time, in microseconds
+     */
+    public int64 end_time { get; private set; }
+
+    /**
+     * The start of the available range in bytes
+     */
+    public int64 start_byte { get; private set; }
+
+    /**
+     * The end of the available range in bytes (inclusive)
+     */
+    public int64 end_byte { get; private set; }
+
+    /**
+     * The length of the available range in bytes
+     */
+    public int64 range_length { get; private set; }
+
+    public DLNAAvailableSeekRangeResponse (int mode, int64 start_time, int64 end_time,
+                                           int64 start_byte, int64 end_byte) {
+        base ();
+        this.mode = mode;
+        this.start_time = start_time;
+        this.end_time = end_time;
+        this.start_byte = start_byte;
+        this.end_byte = end_byte;
+        this.range_length = end_byte - start_byte + 1;
+    }
+
+    public DLNAAvailableSeekRangeResponse.time_only (int mode, int64 start_time, int64 end_time) {
+        base ();
+        this.mode = mode;
+        this.start_time = start_time;
+        this.end_time = end_time;
+        this.start_byte = this.end_byte = this.range_length = UNSPECIFIED;
+    }
+
+    public override void add_response_headers (Rygel.HTTPRequest request) {
+        var response = get_response_string ();
+        if (response != null) {
+            request.msg.response_headers.append (AVAILABLE_SEEK_RANGE_HEADER, response);
+        }
+    }
+
+    private string? get_response_string () {
+        if (start_time == UNSPECIFIED) {
+            return null;
+        }
+
+        // The availableSeekRange format:
+        //
+        // availableSeekRange.dlna.org: MODE npt=START_TIME-END_TIME bytes=START_BYTE-END_BYTE
+        //
+        // The MODE can be either "0" or "1", indicating the limited operation mode being
+        //  used by the server.
+        //
+        // The "bytes=" field can be ommitted in some cases. (e.g. ORG_OP b-val==0 and
+        // lop-bytes is 0).
+
+        // It's not our job at this level to enforce all the semantics of the availableSeekRange
+        //  response, as we don't have enough context. Setting up the correct HTTPTimeSeekRequest
+        //  object is the responsibility of the object owner. To form the response, we just
+        //  use what is set.
+
+        var response = new StringBuilder ();
+        response.append (mode.to_string ());
+        response.append (" npt=");
+        response.append_printf ("%.3f-", (double) this.start_time / TimeSpan.SECOND);
+        response.append_printf ("%.3f", (double) this.end_time / TimeSpan.SECOND);
+
+        if (this.start_byte != UNSPECIFIED) {
+            response.append (" bytes=");
+            response.append (this.start_byte.to_string ());
+            response.append ("-");
+            response.append (this.end_byte.to_string ());
+        }
+
+        return response.str;
+   }
+
+    public override string to_string () {
+        return ("HTTPTimeSeekResponse (%s)".printf (get_response_string ()));
+    }
+}