001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.shell.automation.cmds;
020
021import org.nuxeo.ecm.automation.client.model.Document;
022import org.nuxeo.shell.Argument;
023import org.nuxeo.shell.Command;
024import org.nuxeo.shell.Context;
025import org.nuxeo.shell.ShellConsole;
026import org.nuxeo.shell.ShellException;
027import org.nuxeo.shell.automation.DocRefCompletor;
028import org.nuxeo.shell.automation.DocumentHelper;
029import org.nuxeo.shell.automation.RemoteContext;
030
031/**
032 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
033 */
034@Command(name = "tree", help = "List a subtree")
035public class Tree implements Runnable {
036
037    @Context
038    protected RemoteContext ctx;
039
040    @Argument(name = "doc", index = 0, required = false, completor = DocRefCompletor.class, help = "A document to list its subtree. If not specified list the current document subtree. To use UID references prefix them with 'doc:'.")
041    protected String path;
042
043    public void run() {
044        ShellConsole console = ctx.getShell().getConsole();
045        Document root = ctx.resolveDocument(path);
046        printTree(console, root, "");
047    }
048
049    protected void printTree(ShellConsole console, Document root, String prefix) {
050        try {
051            DocumentHelper.printName(console, root, prefix.length() == 0 ? prefix : prefix + "+- ");
052            prefix += "|  ";
053            for (Document doc : ctx.getDocumentService().getChildren(root)) {
054                printTree(console, doc, prefix);
055            }
056        } catch (Exception e) {
057            throw new ShellException("Failed to list document " + path, e);
058        }
059    }
060}