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.DocRef;
022import org.nuxeo.ecm.automation.client.model.Document;
023import org.nuxeo.shell.Argument;
024import org.nuxeo.shell.Command;
025import org.nuxeo.shell.Context;
026import org.nuxeo.shell.Parameter;
027import org.nuxeo.shell.ShellConsole;
028import org.nuxeo.shell.ShellException;
029import org.nuxeo.shell.automation.DocRefCompletor;
030import org.nuxeo.shell.automation.DocumentHelper;
031import org.nuxeo.shell.automation.RemoteContext;
032
033/**
034 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
035 */
036@Command(name = "ls", help = "List children documents")
037public class Ls implements Runnable {
038
039    @Context
040    protected RemoteContext ctx;
041
042    @Argument(name = "doc", index = 0, required = false, completor = DocRefCompletor.class, help = "A document to list its content. If not specified list the current document content. To use UID references prefix them with 'doc:'.")
043    protected DocRef root;
044
045    @Parameter(name = "-uid", hasValue = false, help = "If used the documents will be printed using the document UID.")
046    protected boolean uid = false;
047
048    @Parameter(name = "-title", hasValue = false, help = "If used the documents will be printed using their dublincore title.")
049    protected boolean title = false;
050
051    public void run() {
052        ShellConsole console = ctx.getShell().getConsole();
053        if (root == null) {
054            // get the current document if target doc was not specified.
055            root = ctx.getDocument();
056        }
057        try {
058            for (Document doc : ctx.getDocumentService().getChildren(root)) {
059                if (uid) {
060                    console.println(doc.getId());
061                } else if (title) {
062                    console.println(doc.getTitle());
063                } else {
064                    DocumentHelper.printName(console, doc);
065                }
066            }
067        } catch (Exception e) {
068            throw new ShellException("Failed to list document " + root, e);
069        }
070
071    }
072}