pathutil: hint if a path is root relative instead of cwd relative (issue4663)

Given that this path is going to abort, it seems OK to spend the time to do an
alternate lookup to better inform the user.  The path returned by util.pathto()
ends with '/' at least in some cases, so os.path.relpath() is used instead,
which requires python 2.6.

mercurial/pathutil.py

@@ -1,177 +1,187 b''
 import os, errno, stat
 
 import encoding
 import util
 from i18n import _
 
 def _lowerclean(s):
     return encoding.hfsignoreclean(s.lower())
 
 class pathauditor(object):
     '''ensure that a filesystem path contains no banned components.
     the following properties of a path are checked:
 
     - ends with a directory separator
     - under top-level .hg
     - starts at the root of a windows drive
     - contains ".."
     - traverses a symlink (e.g. a/symlink_here/b)
     - inside a nested repository (a callback can be used to approve
       some nested repositories, e.g., subrepositories)
     '''
 
     def __init__(self, root, callback=None):
         self.audited = set()
         self.auditeddir = set()
         self.root = root
         self.callback = callback
         if os.path.lexists(root) and not util.checkcase(root):
             self.normcase = util.normcase
         else:
             self.normcase = lambda x: x
 
     def __call__(self, path):
         '''Check the relative path.
         path may contain a pattern (e.g. foodir/**.txt)'''
 
         path = util.localpath(path)
         normpath = self.normcase(path)
         if normpath in self.audited:
             return
         # AIX ignores "/" at end of path, others raise EISDIR.
         if util.endswithsep(path):
             raise util.Abort(_("path ends in directory separator: %s") % path)
         parts = util.splitpath(path)
         if (os.path.splitdrive(path)[0]
             or _lowerclean(parts[0]) in ('.hg', '.hg.', '')
             or os.pardir in parts):
             raise util.Abort(_("path contains illegal component: %s") % path)
         # Windows shortname aliases
         for p in parts:
             if "~" in p:
                 first, last = p.split("~", 1)
                 if last.isdigit() and first.upper() in ["HG", "HG8B6C"]:
                     raise util.Abort(_("path contains illegal component: %s")
                                      % path)
         if '.hg' in _lowerclean(path):
             lparts = [_lowerclean(p.lower()) for p in parts]
             for p in '.hg', '.hg.':
                 if p in lparts[1:]:
                     pos = lparts.index(p)
                     base = os.path.join(*parts[:pos])
                     raise util.Abort(_("path '%s' is inside nested repo %r")
                                      % (path, base))
 
         normparts = util.splitpath(normpath)
         assert len(parts) == len(normparts)
 
         parts.pop()
         normparts.pop()
         prefixes = []
         while parts:
             prefix = os.sep.join(parts)
             normprefix = os.sep.join(normparts)
             if normprefix in self.auditeddir:
                 break
             curpath = os.path.join(self.root, prefix)
             try:
                 st = os.lstat(curpath)
             except OSError, err:
                 # EINVAL can be raised as invalid path syntax under win32.
                 # They must be ignored for patterns can be checked too.
                 if err.errno not in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
                     raise
             else:
                 if stat.S_ISLNK(st.st_mode):
                     raise util.Abort(
                         _('path %r traverses symbolic link %r')
                         % (path, prefix))
                 elif (stat.S_ISDIR(st.st_mode) and
                       os.path.isdir(os.path.join(curpath, '.hg'))):
                     if not self.callback or not self.callback(curpath):
                         raise util.Abort(_("path '%s' is inside nested "
                                            "repo %r")
                                          % (path, prefix))
             prefixes.append(normprefix)
             parts.pop()
             normparts.pop()
 
         self.audited.add(normpath)
         # only add prefixes to the cache after checking everything: we don't
         # want to add "foo/bar/baz" before checking if there's a "foo/.hg"
         self.auditeddir.update(prefixes)
 
     def check(self, path):
         try:
             self(path)
             return True
         except (OSError, util.Abort):
             return False
 
 def canonpath(root, cwd, myname, auditor=None):
     '''return the canonical path of myname, given cwd and root'''
     if util.endswithsep(root):
         rootsep = root
     else:
         rootsep = root + os.sep
     name = myname
     if not os.path.isabs(name):
         name = os.path.join(root, cwd, name)
     name = os.path.normpath(name)
     if auditor is None:
         auditor = pathauditor(root)
     if name != rootsep and name.startswith(rootsep):
         name = name[len(rootsep):]
         auditor(name)
         return util.pconvert(name)
     elif name == root:
         return ''
     else:
         # Determine whether `name' is in the hierarchy at or beneath `root',
         # by iterating name=dirname(name) until that causes no change (can't
         # check name == '/', because that doesn't work on windows). The list
         # `rel' holds the reversed list of components making up the relative
         # file name we want.
         rel = []
         while True:
             try:
                 s = util.samefile(name, root)
             except OSError:
                 s = False
             if s:
                 if not rel:
                     # name was actually the same as root (maybe a symlink)
                     return ''
                 rel.reverse()
                 name = os.path.join(*rel)
                 auditor(name)
                 return util.pconvert(name)
             dirname, basename = util.split(name)
             rel.append(basename)
             if dirname == name:
                 break
             name = dirname
 
-        raise util.Abort(_("%s not under root '%s'") % (myname, root))
+        # A common mistake is to use -R, but specify a file relative to the repo
+        # instead of cwd.  Detect that case, and provide a hint to the user.
+        hint = None
+        try:
+            canonpath(root, root, myname, auditor)
+            hint = _("consider using '--cwd %s'") % os.path.relpath(root, cwd)
+        except util.Abort:
+            pass
+
+        raise util.Abort(_("%s not under root '%s'") % (myname, root),
+                         hint=hint)
 
 def normasprefix(path):
     '''normalize the specified path as path prefix
 
     Returned value can be used safely for "p.startswith(prefix)",
     "p[len(prefix):]", and so on.
 
     For efficiency, this expects "path" argument to be already
     normalized by "os.path.normpath", "os.path.realpath", and so on.
 
     See also issue3033 for detail about need of this function.
 
     >>> normasprefix('/foo/bar').replace(os.sep, '/')
     '/foo/bar/'
     >>> normasprefix('/').replace(os.sep, '/')
     '/'
     '''
     d, p = os.path.splitdrive(path)
     if len(p) != len(os.sep):
         return path + os.sep
     else:
         return path

tests/test-globalopts.t

@@ -1,445 +1,446 b''
   $ hg init a
   $ cd a
   $ echo a > a
   $ hg ci -A -d'1 0' -m a
   adding a
 
   $ cd ..
 
   $ hg init b
   $ cd b
   $ echo b > b
   $ hg ci -A -d'1 0' -m b
   adding b
 
   $ cd ..
 
   $ hg clone a c
   updating to branch default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cd c
   $ cat >> .hg/hgrc <<EOF
   > [paths]
   > relative = ../a
   > EOF
   $ hg pull -f ../b
   pulling from ../b
   searching for changes
   warning: repository is unrelated
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg merge
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (branch merge, don't forget to commit)
 
   $ cd ..
 
 Testing -R/--repository:
 
   $ hg -R a tip
   changeset:   0:8580ff50825a
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     a
   
   $ hg --repository b tip
   changeset:   0:b6c483daf290
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     b
   
 
 -R with a URL:
 
   $ hg -R file:a identify
   8580ff50825a tip
   $ hg -R file://localhost/`pwd`/a/ identify
   8580ff50825a tip
 
 -R with path aliases:
 
   $ cd c
   $ hg -R default identify
   8580ff50825a tip
   $ hg -R relative identify
   8580ff50825a tip
   $ echo '[paths]' >> $HGRCPATH
   $ echo 'relativetohome = a' >> $HGRCPATH
   $ HOME=`pwd`/../ hg -R relativetohome identify
   8580ff50825a tip
   $ cd ..
 
 #if no-outer-repo
 
 Implicit -R:
 
   $ hg ann a/a
   0: a
   $ hg ann a/a a/a
   0: a
   $ hg ann a/a b/b
   abort: no repository found in '$TESTTMP' (.hg not found)!
   [255]
   $ hg -R b ann a/a
   abort: a/a not under root '$TESTTMP/b' (glob)
+  (consider using '--cwd b')
   [255]
   $ hg log
   abort: no repository found in '$TESTTMP' (.hg not found)!
   [255]
 
 #endif
 
 Abbreviation of long option:
 
   $ hg --repo c tip
   changeset:   1:b6c483daf290
   tag:         tip
   parent:      -1:000000000000
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     b
   
 
 earlygetopt with duplicate options (36d23de02da1):
 
   $ hg --cwd a --cwd b --cwd c tip
   changeset:   1:b6c483daf290
   tag:         tip
   parent:      -1:000000000000
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     b
   
   $ hg --repo c --repository b -R a tip
   changeset:   0:8580ff50825a
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     a
   
 
 earlygetopt short option without following space:
 
   $ hg -q -Rb tip
   0:b6c483daf290
 
 earlygetopt with illegal abbreviations:
 
   $ hg --confi "foo.bar=baz"
   abort: option --config may not be abbreviated!
   [255]
   $ hg --cw a tip
   abort: option --cwd may not be abbreviated!
   [255]
   $ hg --rep a tip
   abort: option -R has to be separated from other options (e.g. not -qR) and --repository may only be abbreviated as --repo!
   [255]
   $ hg --repositor a tip
   abort: option -R has to be separated from other options (e.g. not -qR) and --repository may only be abbreviated as --repo!
   [255]
   $ hg -qR a tip
   abort: option -R has to be separated from other options (e.g. not -qR) and --repository may only be abbreviated as --repo!
   [255]
   $ hg -qRa tip
   abort: option -R has to be separated from other options (e.g. not -qR) and --repository may only be abbreviated as --repo!
   [255]
 
 Testing --cwd:
 
   $ hg --cwd a parents
   changeset:   0:8580ff50825a
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     a
   
 
 Testing -y/--noninteractive - just be sure it is parsed:
 
   $ hg --cwd a tip -q --noninteractive
   0:8580ff50825a
   $ hg --cwd a tip -q -y
   0:8580ff50825a
 
 Testing -q/--quiet:
 
   $ hg -R a -q tip
   0:8580ff50825a
   $ hg -R b -q tip
   0:b6c483daf290
   $ hg -R c --quiet parents
   0:8580ff50825a
   1:b6c483daf290
 
 Testing -v/--verbose:
 
   $ hg --cwd c head -v
   changeset:   1:b6c483daf290
   tag:         tip
   parent:      -1:000000000000
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   files:       b
   description:
   b
   
   
   changeset:   0:8580ff50825a
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   files:       a
   description:
   a
   
   
   $ hg --cwd b tip --verbose
   changeset:   0:b6c483daf290
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   files:       b
   description:
   b
   
   
 
 Testing --config:
 
   $ hg --cwd c --config paths.quuxfoo=bar paths | grep quuxfoo > /dev/null && echo quuxfoo
   quuxfoo
   $ hg --cwd c --config '' tip -q
   abort: malformed --config option: '' (use --config section.name=value)
   [255]
   $ hg --cwd c --config a.b tip -q
   abort: malformed --config option: 'a.b' (use --config section.name=value)
   [255]
   $ hg --cwd c --config a tip -q
   abort: malformed --config option: 'a' (use --config section.name=value)
   [255]
   $ hg --cwd c --config a.= tip -q
   abort: malformed --config option: 'a.=' (use --config section.name=value)
   [255]
   $ hg --cwd c --config .b= tip -q
   abort: malformed --config option: '.b=' (use --config section.name=value)
   [255]
 
 Testing --debug:
 
   $ hg --cwd c log --debug
   changeset:   1:b6c483daf2907ce5825c0bb50f5716226281cc1a
   tag:         tip
   phase:       public
   parent:      -1:0000000000000000000000000000000000000000
   parent:      -1:0000000000000000000000000000000000000000
   manifest:    1:23226e7a252cacdc2d99e4fbdc3653441056de49
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   files+:      b
   extra:       branch=default
   description:
   b
   
   
   changeset:   0:8580ff50825a50c8f716709acdf8de0deddcd6ab
   phase:       public
   parent:      -1:0000000000000000000000000000000000000000
   parent:      -1:0000000000000000000000000000000000000000
   manifest:    0:a0c8bcbbb45c63b90b70ad007bf38961f64f2af0
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   files+:      a
   extra:       branch=default
   description:
   a
   
   
 
 Testing --traceback:
 
   $ hg --cwd c --config x --traceback id 2>&1 | grep -i 'traceback'
   Traceback (most recent call last):
 
 Testing --time:
 
   $ hg --cwd a --time id
   8580ff50825a tip
   time: real * (glob)
 
 Testing --version:
 
   $ hg --version -q
   Mercurial Distributed SCM * (glob)
 
 hide outer repo
   $ hg init
 
 Testing -h/--help:
 
   $ hg -h
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a changegroup file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    config        show combined config settings from all hgrc files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    files         list tracked files
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search for a pattern in specified files and revisions
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working directory or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge another revision into working directory
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more changegroup files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    multirevs     Specifying Multiple Revisions
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Single Revisions
    revsets       Specifying Revision Sets
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   (use "hg help -v" to show built-in aliases and global options)
 
 
 
   $ hg --help
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a changegroup file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    config        show combined config settings from all hgrc files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    files         list tracked files
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search for a pattern in specified files and revisions
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working directory or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge another revision into working directory
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more changegroup files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    multirevs     Specifying Multiple Revisions
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Single Revisions
    revsets       Specifying Revision Sets
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   (use "hg help -v" to show built-in aliases and global options)
 
 Not tested: --debugger