File: symlink.cpp

package info (click to toggle)
watchman 4.9.0-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,992 kB
  • sloc: cpp: 27,459; python: 6,538; java: 3,404; php: 3,257; ansic: 2,803; javascript: 1,116; makefile: 671; ruby: 364; sh: 124; xml: 102; lisp: 4
file content (175 lines) | stat: -rw-r--r-- 4,921 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/* Copyright 2016-present Facebook, Inc.
 * Licensed under the Apache License, Version 2.0 */

#include "watchman_system.h"
#include <memory>
#include "FileSystem.h"
#include "watchman.h"
#include "watchman_error_category.h"
#include "watchman_scopeguard.h"

using watchman::realPath;
using watchman::readSymbolicLink;

// Given a target of the form "absolute_path/filename", return
// realpath(absolute_path) + filename, where realpath(absolute_path) resolves
// all the symlinks in absolute_path.
static w_string get_normalized_target(const w_string& target) {
  int err;

  w_assert(
      w_string_path_is_absolute(target),
      "get_normalized_target: path %s is not absolute\n",
      target.asNullTerminated().c_str());

  auto dir_name = target.dirName().asNullTerminated();
  auto dir_name_real = realPath(dir_name.c_str());
  err = errno;

  if (dir_name_real) {
    auto file_name = target.baseName();
    return w_string::pathCat({dir_name_real, file_name});
  }

  errno = err;
  return nullptr;
}

// Requires target to be an absolute path
static void watch_symlink_target(const w_string& target, json_t* root_files) {

  w_assert(
      w_string_path_is_absolute(target),
      "watch_symlink_target: path %s is not absolute\n",
      target.c_str());

  w_string normalized_target;
  try {
    normalized_target = get_normalized_target(target);
  } catch (const std::system_error& exc) {
    watchman::log(
        watchman::ERR,
        "watch_symlink_target: unable to get normalized version of target `",
        target,
        "`; realpath ",
        exc.what(),
        "\n");
    return;
  }

  char *relpath = nullptr;
  auto watched_root =
      w_find_enclosing_root(normalized_target.c_str(), &relpath);
  SCOPE_EXIT {
    free(watched_root);
  };
  if (!watched_root) {
    char *errmsg = NULL;
    auto resolved = w_string_dup_buf(normalized_target);
    SCOPE_EXIT {
      free(resolved);
    };
    if (!find_project_root(root_files, resolved, &relpath)) {
      w_log(
          W_LOG_ERR,
          "watch_symlink_target: No watchable root for %s\n",
          resolved);
    } else {
      auto root = w_root_resolve(resolved, true, &errmsg);

      if (!root) {
        w_log(
            W_LOG_ERR,
            "watch_symlink_target: unable to watch %s: %s\n",
            resolved,
            errmsg);
      }
      free(errmsg);
    }
  }
}

/** Given an absolute path, watch all symbolic links associated with the path.
 * Since the target of a symbolic link might contain several components that
 * are themselves symlinks, this function gets called recursively on all the
 * components of path. */
static void watch_symlinks(const w_string& inputPath, json_t* root_files) {
  w_string_piece pathPiece(inputPath);
  auto parentPiece = pathPiece.dirName();

  if (parentPiece == pathPiece) {
    // We've reached the root of the VFS; we're either "/" on unix,
    // or something like "C:\" on windows
    return;
  }
  if (!pathPiece.pathIsAbsolute()) {
    return;
  }

  // ensure that buffer is null-terminated
  auto path = inputPath.asNullTerminated();

  auto dir_name = path.dirName();
  auto file_name = path.baseName();

  try {
    auto target = readSymbolicLink(path.c_str());

    if (w_string_piece(target).pathIsAbsolute()) {
      watch_symlink_target(target, root_files);
      watch_symlinks(target, root_files);
      watch_symlinks(dir_name, root_files);
    } else {
      auto absolute_target = w_string::pathCat({dir_name, target});

      watch_symlink_target(absolute_target, root_files);
      watch_symlinks(absolute_target, root_files);
      // No need to watch_symlinks(dir_name), since
      // watch_symlinks(absolute_target) will eventually have the same effect
    }
  } catch (const std::system_error& exc) {
    if (exc.code() == watchman::error_code::not_a_symlink) {
      // The final component of path is not a symbolic link, but other
      // components in the path might be symbolic links
      watch_symlinks(dir_name, root_files);
    } else {
      watchman::log(
          watchman::ERR,
          "watch_symlinks: readSymbolicLink(",
          path,
          ") ",
          exc.what(),
          "\n");
    }
  }
}

/** Process the list of observed changed symlinks and arrange to establish
 * watches for their new targets */
void watchman_root::processPendingSymlinkTargets() {
  bool enforcing;

  auto pendingLock = inner.pending_symlink_targets.wlock();

  if (!pendingLock->size()) {
    return;
  }

  auto root_files = cfg_compute_root_files(&enforcing);
  if (!root_files) {
    w_log(W_LOG_ERR,
          "watch_symlink_target: error computing root_files configuration "
          "value, consult your log file at %s for more details\n", log_name);
    return;
  }

  auto p = pendingLock->stealItems();
  while (p) {
    watch_symlinks(p->path, root_files);
    p = std::move(p->next);
  }
}


/* vim:ts=2:sw=2:et:
 */