Indefero Commit Details

Date:

2010-10-30 16:52:40 (14 years 1 month ago)

Author:

Thomas Keller

Branch:

develop, feature-issue_links, feature.better-home, feature.content-md5, feature.diff-whitespace, feature.download-md5, feature.issue-links, feature.issue-of-others, feature.issue-summary, feature.search-filter, feature.webrepos, feature.wiki-default-page, master, release-1.1, release-1.2, release-1.3

Commit:

fe001abd26ed59360b44e08d12605d35f141d8a0

Parents:

8a55952204ba29f0cab49b38cea79661d9d10cb8

Message:

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!

Changes:

File differences

-
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
+Copyright (C) 2007-2009 Paul Duncan <pabs@pablotron.org>␊
 ␊
Permission is hereby granted, free of charge, to any person obtaining a␊
copy of this software and associated documentation files (the␊
"Software"), to deal in the Software without restriction, including␊
without limitation the rights to use, copy, modify, merge, publish,␊
distribute, sublicense, and/or sell copies of the Software, and to␊
permit persons to whom the Software is furnished to do so, subject to␊
the following conditions:␊
  ␊
The above copyright notice and this permission notice shall be included␊
in all copies or substantial portions of the of the Software.␊
   ␊
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS␊
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF␊
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.␊
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER␊
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING␊
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER␊
DEALINGS IN THE SOFTWARE.  ␊
+Copyright (C) 2007-2009 Paul Duncan <pabs@pablotron.org>␊
+ ␊
+Permission is hereby granted, free of charge, to any person obtaining a␊
+copy of this software and associated documentation files (the␊
+"Software"), to deal in the Software without restriction, including␊
+without limitation the rights to use, copy, modify, merge, publish,␊
+distribute, sublicense, and/or sell copies of the Software, and to␊
+permit persons to whom the Software is furnished to do so, subject to␊
+the following conditions:␊
+  ␊
+The above copyright notice and this permission notice shall be included␊
+in all copies or substantial portions of the of the Software.␊
+   ␊
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS␊
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF␊
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.␊
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER␊
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING␊
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER␊
+DEALINGS IN THE SOFTWARE.  ␊

-393
394 394
395 395
396 
396
397 397
398 398
399 399
400 
400
401 401
402 
402
403 403
404 404
405 405
+    }␊
␊
    /**␊
     * Generate the command to create a zip archive at a given commit.␊
     * Generate a zip archive at a given commit, wrapped in a HTTP response, suitable for pushing to client.␊
     *␊
     * @param string Commit␊
     * @param string Prefix ('repository/')␊
     * @return string Command␊
     * @return Pluf_HTTP_Response The HTTP Response containing the zip archive␊
     */␊
    public function getArchiveCommand($commit, $prefix='repository/')␊
    public function getArchiveStream($commit, $prefix='repository/')␊
    {␊
        throw new Pluf_Exception_NotImplemented();␊
    }␊
     }␊
 ␊
     /**␊
-     * Generate the command to create a zip archive at a given commit.␊
+     * Generate a zip archive at a given commit, wrapped in a HTTP response, suitable for pushing to client.␊
      *␊
      * @param string Commit␊
      * @param string Prefix ('repository/')␊
-     * @return string Command␊
+     * @return Pluf_HTTP_Response The HTTP Response containing the zip archive␊
      */␊
-    public function getArchiveCommand($commit, $prefix='repository/')␊
+    public function getArchiveStream($commit, $prefix='repository/')␊
     {␊
         throw new Pluf_Exception_NotImplemented();␊
     }␊

-547
548 548
549 549
550 
550
551 551
552 
552
553 553
554 554
555 555
556 556
557
557 558
558 559
559 560
... ...
806 807
807 808
808 809
809 
810
+        return $res;␊
    }␊
␊
    public function getArchiveCommand($commit, $prefix='repository/')␊
    public function getArchiveStream($commit, $prefix='repository/')␊
    {␊
        return sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
        $cmd = sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
                       'GIT_DIR=%s '.Pluf::f('git_path', 'git').' archive --format=zip --prefix=%s %s',␊
                       escapeshellarg($this->repo),␊
                       escapeshellarg($prefix),␊
                       escapeshellarg($commit));␊
        return new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
    }␊
␊
    /*␊

        }␊
        return false;␊
    }␊
}
}␊
 ...
         return $res;␊
     }␊
 ␊
-    public function getArchiveCommand($commit, $prefix='repository/')␊
+    public function getArchiveStream($commit, $prefix='repository/')␊
     {␊
-        return sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
+        $cmd = sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
                        'GIT_DIR=%s '.Pluf::f('git_path', 'git').' archive --format=zip --prefix=%s %s',␊
                        escapeshellarg($this->repo),␊
                        escapeshellarg($prefix),␊
                        escapeshellarg($commit));␊
+        return new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
     }␊
 ␊
     /*␊
         }␊
         return false;␊
     }␊
-}
+}␊

-449
450 450
451 451
452 
452
453 453
454 454
455 455
456 
456
457 457
458 
458
459 459
460 
460
461 461
462 462
463 463
464
464 465
465 466
+    }␊
␊
    /**␊
     * Generate the command to create a zip archive at a given commit.␊
     * Generate a zip archive at a given commit.␊
     *␊
     * @param string Commit␊
     * @param string Prefix ('git-repo-dump')␊
     * @return string Command␊
     * @return Pluf_HTTP_Response The HTTP response containing the zip archive␊
     */␊
    public function getArchiveCommand($commit, $prefix='')␊
    protected function getArchiveStream($commit, $prefix='')␊
    {␊
        return sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
        $cmd = sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
                       Pluf::f('hg_path', 'hg').' archive --type=zip -R %s -r %s -',␊
                       escapeshellarg($this->repo),␊
                       escapeshellarg($commit));␊
        return new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
    }␊
}␊
     }␊
 ␊
     /**␊
-     * Generate the command to create a zip archive at a given commit.␊
+     * Generate a zip archive at a given commit.␊
      *␊
      * @param string Commit␊
      * @param string Prefix ('git-repo-dump')␊
-     * @return string Command␊
+     * @return Pluf_HTTP_Response The HTTP response containing the zip archive␊
      */␊
-    public function getArchiveCommand($commit, $prefix='')␊
+    protected function getArchiveStream($commit, $prefix='')␊
     {␊
-        return sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
+        $cmd = sprintf(Pluf::f('idf_exec_cmd_prefix', '').␊
                        Pluf::f('hg_path', 'hg').' archive --type=zip -R %s -r %s -',␊
                        escapeshellarg($this->repo),␊
                        escapeshellarg($commit));␊
+        return new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
     }␊
 }␊

-434
435 435
436 436
437 
438 
437
439 438
440 439
441 440
+        $commit = trim($match[2]);␊
        $scm = IDF_Scm::get($request->project);␊
        $base = $request->project->shortname.'-'.$commit;␊
        $cmd = $scm->getArchiveCommand($commit, $base.'/');␊
        $rep = new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
        $rep = $scm->getArchiveStream($commit, $base.'/');␊
        $rep->headers['Content-Transfer-Encoding'] = 'binary';␊
        $rep->headers['Content-Disposition'] = 'attachment; filename="'.$base.'.zip"';␊
        return $rep;␊
         $commit = trim($match[2]);␊
         $scm = IDF_Scm::get($request->project);␊
         $base = $request->project->shortname.'-'.$commit;␊
-        $cmd = $scm->getArchiveCommand($commit, $base.'/');␊
-        $rep = new Pluf_HTTP_Response_CommandPassThru($cmd, 'application/x-zip');␊
+        $rep = $scm->getArchiveStream($commit, $base.'/');␊
         $rep->headers['Content-Transfer-Encoding'] = 'binary';␊
         $rep->headers['Content-Disposition'] = 'attachment; filename="'.$base.'.zip"';␊
         return $rep;␊

-48
49 49
50 50
51 
51
52 52
53 53
54 54
+</table>␊
{aurl 'url', 'IDF_Views_Source::download', array($project.shortname, $commit)}␊
<p class="right soft">␊
{* <a href="{$url}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/package-grey.png'}" alt="{trans 'Archive'}" align="bottom" /></a> <a href="{$url}">{trans 'Download this version'}</a> {trans 'or'} *}␊
<a href="{$url}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/package-grey.png'}" alt="{trans 'Archive'}" align="bottom" /></a> <a href="{$url}">{trans 'Download this version'}</a> {trans 'or'}␊
<kbd>mtn clone {$project.getSourceAccessUrl($user, $commit)}</kbd> <a href="{url 'IDF_Views_Source::help', array($project.shortname)}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/help.png'}" alt="{trans 'Help'}" /></a>␊
</p>␊
␊
 </table>␊
 {aurl 'url', 'IDF_Views_Source::download', array($project.shortname, $commit)}␊
 <p class="right soft">␊
-{* <a href="{$url}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/package-grey.png'}" alt="{trans 'Archive'}" align="bottom" /></a> <a href="{$url}">{trans 'Download this version'}</a> {trans 'or'} *}␊
+<a href="{$url}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/package-grey.png'}" alt="{trans 'Archive'}" align="bottom" /></a> <a href="{$url}">{trans 'Download this version'}</a> {trans 'or'}␊
 <kbd>mtn clone {$project.getSourceAccessUrl($user, $commit)}</kbd> <a href="{url 'IDF_Views_Source::help', array($project.shortname)}"><img style="vertical-align: text-bottom;" src="{media '/idf/img/help.png'}" alt="{trans 'Help'}" /></a>␊
 </p>␊
 ␊

Download the corresponding diff file

Indefero

File differences

Branches

Tags