code review 8676046: archive/zip: add docs on type of slashes in paths

archive/zip: add docs on type of slashes in paths

Fixes issue 5307

[bradfitz, 2013-04-17 19:57:05]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[r, 2013-04-17 20:02:38]

https://codereview.appspot.com/8676046/diff/3003/src/pkg/archive/zip/struct.go
File src/pkg/archive/zip/struct.go (right):

https://codereview.appspot.com/8676046/diff/3003/src/pkg/archive/zip/struct.g...
src/pkg/archive/zip/struct.go:72: // a drive letter, or a leading slash.
it can contain a drive letter, just not start with one, right? so maybe

It must be a relative path: it must not start with a drive letter (e.g. C:)
or leading slash, and it must not contain a backslash.

https://codereview.appspot.com/8676046/diff/3003/src/pkg/archive/zip/writer.go
File src/pkg/archive/zip/writer.go (right):

https://codereview.appspot.com/8676046/diff/3003/src/pkg/archive/zip/writer.g...
src/pkg/archive/zip/writer.go:1: // Copyright 2011 The Go Athors. All rights
reserved.
odd choice.

https://codereview.appspot.com/8676046/diff/3003/src/pkg/archive/zip/writer.g...
src/pkg/archive/zip/writer.go:165: // The name is  may not be an absolute path
or contain backslashes.
s/is  may/must/
or maybe use the text i wrote in the other file, including the drive letter
stuff

[bradfitz, 2013-04-17 20:03:10]

Ugh, I lost a word or something before mailing it.


On Wed, Apr 17, 2013 at 12:57 PM, <bradfitz@golang.org> wrote:

> Reviewers: golang-dev1,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> archive/zip: add docs on type of slashes in paths
>
> Fixes issue 5307
>
> Please review this at
https://codereview.appspot.**com/8676046/<https://codereview.appspot.com/8676...
>
> Affected files:
>   M src/pkg/archive/zip/struct.go
>   M src/pkg/archive/zip/writer.go
>
>
> Index: src/pkg/archive/zip/struct.go
> ==============================**==============================**=======
> --- a/src/pkg/archive/zip/struct.**go
> +++ b/src/pkg/archive/zip/struct.**go
> @@ -64,8 +64,14 @@
>         zip64ExtraId = 0x0001 // zip64 Extended Information Extra Field
>  )
>
> +// FileHeader describes a file within a zip file.
> +// See the zip spec for details.
>  type FileHeader struct {
> -       Name               string
> +       // Name is the name of the file.
> +       // It may be a relative path, but may not contain backslashes,
> +       // a drive letter, or a leading slash.
> +       Name string
> +
>         CreatorVersion     uint16
>         ReaderVersion      uint16
>         Flags              uint16
> Index: src/pkg/archive/zip/writer.go
> ==============================**==============================**=======
> --- a/src/pkg/archive/zip/writer.**go
> +++ b/src/pkg/archive/zip/writer.**go
> @@ -1,4 +1,4 @@
> -// Copyright 2011 The Go Authors. All rights reserved.
> +// Copyright 2011 The Go Athors. All rights reserved.
>  // Use of this source code is governed by a BSD-style
>  // license that can be found in the LICENSE file.
>
> @@ -162,6 +162,7 @@
>  }
>
>  // Create adds a file to the zip file using the provided name.
> +// The name is  may not be an absolute path or contain backslashes.
>  // It returns a Writer to which the file contents should be written.
>  // The file's contents must be written to the io.Writer before the next
>  // call to Create, CreateHeader, or Close.
>
>
>

[bradfitz, 2013-04-17 20:08:45]

Hello golang-dev@googlegroups.com, r@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[r, 2013-04-17 20:18:31]

LGTM

[bradfitz, 2013-04-17 20:25:18]

*** Submitted as https://code.google.com/p/go/source/detail?r=7ff8f1a4508b ***

archive/zip: add docs on type of slashes in paths

Fixes issue 5307

R=golang-dev, r
CC=golang-dev
https://codereview.appspot.com/8676046