Rework the way IDF's SCM interface provides downloadable snapshots.

Instead of returning a command which gets executed and which should pass through / stream its output data to the client, we're just returning an instance of Pluf_HTTP_Response. This is needed, because some SCMs, most noticable monotone, have no locally executable command to provide a snapshot archive (and probably never will for our kind of setup). We therefor added a little BSD-licensed class "ZipArchive" which allows the creation of pkzip-compatible archives on the fly by letting it eat the file contents directly feed from the (remote) stdio instance. Download performance is ok and lies between 15K/s and 110K/s, but at least we do no longer block the browser while we pre-generate the zip file server-side. Thanks to Patrick Georgi for all his work!
2010-10-30 21:52:40 +00:00
parent 8a55952204
commit fe001abd26
13 changed files with 3875 additions and 15 deletions
--- a/src/IDF/Scm/Monotone/ZipRender.php
+++ b/src/IDF/Scm/Monotone/ZipRender.php
@@ -0,0 +1,78 @@
+<?php
+/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+# ***** BEGIN LICENSE BLOCK *****
+# This file is part of InDefero, an open source project management application.
+# Copyright (C) 2010 Céondo Ltd and contributors.
+#
+# Plume Framework 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.1 of the License, or
+# (at your option) any later version.
+#
+# Plume Framework 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 Lesser General Public License for more details.
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# ***** END LICENSE BLOCK ***** */
+
+require_once(IDF_PATH.'/../contrib/zipstream-php-0.2.2/zipstream.php');
+
+/**
+ * Special response object to output 
+ *
+ * The Content-Length will not be set as it is not possible to predict it.
+ *
+ * Note: The ZipArchive version 0.2.2 has been patched in-tree with this
+ *       patch http://pastebin.ca/1977584 to avoid a couple of PHP notices
+ *
+ */
+class IDF_Scm_Monotone_ZipRender extends Pluf_HTTP_Response
+{
+    /**
+     * The revision argument must be a safe string!
+     *
+     * @param Object stdio context
+     * @param string revision
+     * @param string Mimetype (null)
+     */
+
+    private $stdio = null;
+    private $revision = null;
+
+    function __construct($stdio, $revision)
+    {
+        parent::__construct($revision, 'application/x-zip');
+        $this->stdio = $stdio;
+        $this->revision = $revision;
+    }
+
+    /**
+     * Render a response object.
+     */
+    function render($output_body=true)
+    {
+        $this->outputHeaders();
+
+        if ($output_body) {
+            $manifest = $this->stdio->exec(array('get_manifest_of', $this->revision));
+            $stanzas = IDF_Scm_Monotone_BasicIO::parse($manifest);
+
+            $zip = new ZipStream();
+
+            foreach ($stanzas as $stanza) {
+                if ($stanza[0]['key'] != 'file')
+                    continue;
+                $content = $this->stdio->exec(array('get_file', $stanza[1]['hash']));
+                $zip->add_file($stanza[0]['values'][0], $content);
+            }
+
+            $zip->finish();
+        }
+    }
+}