code cleanup and comments

whyrusleeping · whyrusleeping · commit 0580639bcc44 · 2015-08-08T22:20:28.000-07:00
License: MIT
Signed-off-by: Jeromy &lt;jeromyj@gmail.com&gt;
diff --git a/core/commands/mfs.go b/core/commands/mfs.go
@@ -243,10 +243,12 @@ var MfsLsCmd = &cmds.Command{
 		Tagline:          "List directories inside a filesystem",
 		ShortDescription: ``,
 	},
-
 	Arguments: []cmds.Argument{
 		cmds.StringArg("path", true, false, "path to show listing for"),
 	},
+	Options: []cmds.Option{
+		cmds.BoolOption("l", "use long listing format"),
+	},
 	Run: func(req cmds.Request, res cmds.Response) {
 		node, err := req.InvocContext().GetNode()
 		if err != nil {
@@ -323,8 +325,14 @@ var MfsLsCmd = &cmds.Command{
 		cmds.Text: func(res cmds.Response) (io.Reader, error) {
 			out := res.Output().(*MfsLsOutput)
 			buf := new(bytes.Buffer)
+			long, _, _ := res.Request().Option("l").Bool()
+
 			for _, o := range out.Entries {
-				fmt.Fprintf(buf, "%s\n", o.Name)
+				if long {
+					fmt.Fprintf(buf, "%s\t%s\t%d\n", o.Name, o.Hash, o.Size)
+				} else {
+					fmt.Fprintf(buf, "%s\n", o.Name)
+				}
 			}
 			return buf, nil
 		},
diff --git a/mfs/dir.go b/mfs/dir.go
@@ -4,7 +4,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"strings"
 	"sync"
 	"time"
 
@@ -17,6 +16,7 @@ import (
 
 var ErrNotYetImplemented = errors.New("not yet implemented")
 var ErrInvalidChild = errors.New("invalid child node")
+var ErrDirExists = errors.New("directory already has entry by that name")
 
 type Directory struct {
 	fs     *Filesystem
@@ -277,7 +277,7 @@ func (d *Directory) AddChild(name string, nd *dag.Node) error {
 
 	_, err = d.childUnsync(name)
 	if err == nil {
-		return errors.New("directory already has entry by that name")
+		return ErrDirExists
 	}
 
 	err = d.node.AddNodeLinkClean(name, nd)
@@ -311,28 +311,3 @@ func (d *Directory) Lock() {
 func (d *Directory) Unlock() {
 	d.lock.Unlock()
 }
-
-func DirLookup(d *Directory, path string) (FSNode, error) {
-	path = strings.Trim(path, "/")
-	parts := strings.Split(path, "/")
-	if len(parts) == 1 && parts[0] == "" {
-		return d, nil
-	}
-
-	var cur FSNode
-	cur = d
-	for i, p := range parts {
-		chdir, ok := cur.(*Directory)
-		if !ok {
-			return nil, fmt.Errorf("cannot access %s: Not a directory", strings.Join(parts[:i+1], "/"))
-		}
-
-		child, err := chdir.Child(p)
-		if err != nil {
-			return nil, err
-		}
-
-		cur = child
-	}
-	return cur, nil
-}
diff --git a/mfs/ops.go b/mfs/ops.go
@@ -10,6 +10,7 @@ import (
 	dag "github.com/ipfs/go-ipfs/merkledag"
 )
 
+// Mv moves the file or directory at 'src' to 'dst'
 func Mv(rootd *Directory, src, dst string) error {
 	srcDir, srcFname := gopath.Split(src)
 
@@ -57,6 +58,7 @@ func Mv(rootd *Directory, src, dst string) error {
 	return nil
 }
 
+// PutNodeUnderRoot inserts 'nd' at 'ipath' under the given filesystem root
 func PutNodeUnderRoot(root *Root, ipath string, nd *dag.Node) error {
 	dir, ok := root.GetValue().(*Directory)
 	if !ok {
@@ -77,6 +79,8 @@ func PutNodeUnderRoot(root *Root, ipath string, nd *dag.Node) error {
 	return pdir.AddChild(filename, nd)
 }
 
+// Mkdir creates a directory at 'path' under the directory 'd', creating
+// intermediary directories as needed if 'parents' is set to true
 func Mkdir(rootd *Directory, path string, parents bool) error {
 	parts := strings.Split(path, "/")
 	if parts[0] == "" {
@@ -112,3 +116,30 @@ func Mkdir(rootd *Directory, path string, parents bool) error {
 
 	return nil
 }
+
+// DirLookup will look up a file or directory at the given path
+// under the directory 'd'
+func DirLookup(d *Directory, path string) (FSNode, error) {
+	path = strings.Trim(path, "/")
+	parts := strings.Split(path, "/")
+	if len(parts) == 1 && parts[0] == "" {
+		return d, nil
+	}
+
+	var cur FSNode
+	cur = d
+	for i, p := range parts {
+		chdir, ok := cur.(*Directory)
+		if !ok {
+			return nil, fmt.Errorf("cannot access %s: Not a directory", strings.Join(parts[:i+1], "/"))
+		}
+
+		child, err := chdir.Child(p)
+		if err != nil {
+			return nil, err
+		}
+
+		cur = child
+	}
+	return cur, nil
+}
