links are already followed by default about opengrok

[kahatlen]

I haven't tested recently, but I think the default behaviour is to follow symlinks only if they are direct children of the source root directory. Symlinks further down in the directory structure are not followed.

[jelinson]

👍

[tarzanek]

is this somehow related to #689 ?

[vladak]

@kahatlen : yep, this is the case, index/Indexer.java:main() contains:

524                // automatically allow symlinks that are directly in source root
525                String file = cfg.getSourceRoot();
526                if (file != null) {
527                    File sourceRootFile = new File(file);
528                    File[] projectDirs = sourceRootFile.listFiles();
529                    if (projectDirs != null) {
530                        for (File projectDir : projectDirs) {
531                            if (!projectDir.getCanonicalPath().equals(projectDir.getAbsolutePath())) {
532                                allowedSymlinks.add(projectDir.getAbsolutePath());
533                            }
534                        }
535                    }
536                }

So I guess this is just a matter of adjusting the usage message for -N.

[vladak]

One example of how this works currently. Say we have the following under source root:

another/
foo/
bar -> foo
dir/
dir/one/
dir/two -> one

All of the directories (designated by / suffix) are repositories. The contents of all of the above should be indexed by default except the 'two' entry. For this, one would have to add -N /dir/two to the options.

However, even though the two is not recognized as allowedSymlinks it is indexed.

[vladak]

This behavior is because of:

746    private boolean acceptSymlink(String absolutePath, String canonicalPath) throws IOException {
747        // Always accept local symlinks
748        if (isLocal(canonicalPath)) {
749            return true;
750        }
...

for the two symlink above it returns true thanks to line 749. This has been last changed in cset 9239606 ( authored by @kahatlen ) with fix for #159.

[vladak]

isLocal() returns true because of line 787 below:

771    private boolean isLocal(String path) {
772        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
773        String srcRoot = env.getSourceRootPath();
774
775        boolean local = false;
776
777        if (path.startsWith(srcRoot)) {
778            if (env.hasProjects()) {
779                String relPath = path.substring(srcRoot.length());
780                if (project.equals(Project.getProject(relPath))) {
781                    // File is under the current project, so it's local.
782                    local = true;
783                }
784            } else {
785                // File is under source root, and we don't have projects, so
786                // consider it local.
787                local = true;
788            }
789        }
790
791        return local;
792    }

This is because path is /var/opengrok/src/dir/one (which is the canonical path for var/opengrok/src/dir/two starts with srcRoot (which is /var/opengrok/src-symlinks).