/* * Copyright (C) 2010 Vyatta, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace cstore { // begin namespace cstore namespace unionfs { // begin namespace unionfs ////// constants // environment vars defining root dirs const string UnionfsCstore::C_ENV_TMPL_ROOT = "VYATTA_CONFIG_TEMPLATE"; const string UnionfsCstore::C_ENV_WORK_ROOT = "VYATTA_TEMP_CONFIG_DIR"; const string UnionfsCstore::C_ENV_ACTIVE_ROOT = "VYATTA_ACTIVE_CONFIGURATION_DIR"; const string UnionfsCstore::C_ENV_CHANGE_ROOT = "VYATTA_CHANGES_ONLY_DIR"; const string UnionfsCstore::C_ENV_TMP_ROOT = "VYATTA_CONFIG_TMP"; // default root dirs/paths const string UnionfsCstore::C_DEF_TMPL_ROOT = "/opt/vyatta/share/vyatta-cfg/templates"; const string UnionfsCstore::C_DEF_CFG_ROOT = "/opt/vyatta/config"; const string UnionfsCstore::C_DEF_ACTIVE_ROOT = UnionfsCstore::C_DEF_CFG_ROOT + "/active"; const string UnionfsCstore::C_DEF_CHANGE_PREFIX = UnionfsCstore::C_DEF_CFG_ROOT + "/tmp/changes_only_"; const string UnionfsCstore::C_DEF_WORK_PREFIX = UnionfsCstore::C_DEF_CFG_ROOT + "/tmp/new_config_"; const string UnionfsCstore::C_DEF_TMP_PREFIX = UnionfsCstore::C_DEF_CFG_ROOT + "/tmp/tmp_"; // markers const string UnionfsCstore::C_MARKER_DEF_VALUE = "def"; const string UnionfsCstore::C_MARKER_DEACTIVATE = ".disable"; const string UnionfsCstore::C_MARKER_CHANGED = ".modified"; const string UnionfsCstore::C_MARKER_UNSAVED = ".unsaved"; const string UnionfsCstore::C_MARKER_UNIONFS = ".unionfs"; const string UnionfsCstore::C_COMMITTED_MARKER_FILE = ".changes"; const string UnionfsCstore::C_COMMENT_FILE = ".comment"; const string UnionfsCstore::C_TAG_NAME = "node.tag"; const string UnionfsCstore::C_VAL_NAME = "node.val"; const string UnionfsCstore::C_DEF_NAME = "node.def"; const string UnionfsCstore::C_COMMIT_LOCK_FILE = "/opt/vyatta/config/.lock"; pid_t pid; int status; int commpipe[2]; ////// static static MapT _fs_escape_chars; static MapT _fs_unescape_chars; static void _init_fs_escape_chars() { _fs_escape_chars[-1] = "\%\%\%"; _fs_escape_chars['%'] = "\%25"; _fs_escape_chars['/'] = "\%2F"; _fs_unescape_chars["\%\%\%"] = -1; _fs_unescape_chars["\%25"] = '%'; _fs_unescape_chars["\%2F"] = '/'; } static string _escape_char(char c) { MapT::iterator p = _fs_escape_chars.find(c); if (p != _fs_escape_chars.end()) { return p->second; } else { return string(1, c); } } static MapT _escape_path_name_cache; static string _escape_path_name(const string& path) { MapT::iterator p = _escape_path_name_cache.find(path); if (p != _escape_path_name_cache.end()) { // found escaped string in cache. just return it. return p->second; } // special case for empty string string npath = (path.size() == 0) ? _fs_escape_chars[-1] : ""; for (size_t i = 0; i < path.size(); i++) { npath += _escape_char(path[i]); } // cache it before return _escape_path_name_cache[path] = npath; return npath; } static MapT _unescape_path_name_cache; static string _unescape_path_name(const string& path) { MapT::iterator p = _unescape_path_name_cache.find(path); if (p != _unescape_path_name_cache.end()) { // found unescaped string in cache. just return it. return p->second; } // assume all escape patterns are 3-char string npath = ""; for (size_t i = 0; i < path.size(); i++) { if ((path.size() - i) < 3) { npath += path.substr(i); break; } string s = path.substr(i, 3); MapT::iterator p = _fs_unescape_chars.find(s); if (p != _fs_unescape_chars.end()) { char c = p->second; if (path.size() == 3 && c == -1) { // special case for empty string npath = ""; break; } npath += string(1, _fs_unescape_chars[s]); // skip the escape sequence i += 2; } else { npath += path.substr(i, 1); } } // cache it before return _unescape_path_name_cache[path] = npath; return npath; } vector getActiveCommits() { string process_name = "vbash"; vector pids; DIR *dp = opendir("/proc"); if (dp != NULL) { struct dirent *dirp; while ((dirp = readdir(dp))) { int pid = atoi(dirp->d_name); if (pid > 0) { string command_path = string("/proc/") + dirp->d_name + "/cmdline"; ifstream command_file(command_path.c_str()); string command_line; getline(command_file, command_line); if (!command_line.empty()) { size_t pos = command_line.find('\0'); if (pos != string::npos) { command_line = command_line.substr(0, pos); } pos = command_line.rfind('/'); if (pos != string::npos) { command_line = command_line.substr(pos + 1); } if (process_name == command_line) { pids.push_back(pid); } } } } } closedir(dp); return pids; } ////// constructor/destructor /* "current session" constructor. * this constructor sets up the object from environment. * used when environment is already set up, i.e., when operating on the * "current" config session. e.g., in the following scenarios * configure commands * perl module * shell "current session" api * * note: this also applies when using the cstore in operational mode, * in which case only the template root and the active root will be * valid. */ UnionfsCstore::UnionfsCstore(bool use_edit_level) { // set up root dir strings char *val; if ((val = getenv(C_ENV_TMPL_ROOT.c_str()))) { tmpl_path = val; } else { tmpl_path = C_DEF_TMPL_ROOT; } tmpl_root = tmpl_path; // save a copy of tmpl root if ((val = getenv(C_ENV_WORK_ROOT.c_str()))) { work_root = val; } if ((val = getenv(C_ENV_TMP_ROOT.c_str()))) { tmp_root = val; init_commit_data(); } if ((val = getenv(C_ENV_ACTIVE_ROOT.c_str()))) { active_root = val; } else { active_root = C_DEF_ACTIVE_ROOT; } if ((val = getenv(C_ENV_CHANGE_ROOT.c_str()))) { change_root = val; } /* note: the original perl API module does not use the edit levels * from environment. only the actual CLI operations use them. * so here make it an option. */ mutable_cfg_path = "/"; if (use_edit_level) { // set up path strings if ((val = getenv(C_ENV_EDIT_LEVEL.c_str()))) { mutable_cfg_path = val; } if ((val = getenv(C_ENV_TMPL_LEVEL.c_str())) && val[0] && val[1]) { /* no need to append root (i.e., "/"). level (if exists) always * starts with '/', so only append it if it is at least two chars * (i.e., it is not "/"). */ FsPath tlvl(val); tmpl_path /= tlvl; } } orig_mutable_cfg_path = mutable_cfg_path; orig_tmpl_path = tmpl_path; _init_fs_escape_chars(); } /* "specific session" constructor. * this constructor sets up the object for the specified session ID and * returns an environment string that can be "evaled" to set up the * shell environment. * * used when the session environment needs to be established. this is * mainly for the shell functions that set up configuration sessions. * i.e., the "vyatta-cfg-cmd-wrapper" (on boot or for GUI etc.) and * the cfg completion script (when entering configure mode). * * sid: session ID. * env: (output) environment string. * * note: this does NOT set up the session. caller needs to use the * explicit session setup/teardown functions as needed. */ UnionfsCstore::UnionfsCstore(const string& sid, string& env) : Cstore(env) { tmpl_root = C_DEF_TMPL_ROOT; tmpl_path = tmpl_root; active_root = C_DEF_ACTIVE_ROOT; work_root = (C_DEF_WORK_PREFIX + sid); change_root = (C_DEF_CHANGE_PREFIX + sid); tmp_root = (C_DEF_TMP_PREFIX + sid); init_commit_data(); string declr = " declare -x -r "; // readonly vars env += " umask 002; {"; env += (declr + C_ENV_ACTIVE_ROOT + "=" + active_root.path_cstr()); env += (declr + C_ENV_CHANGE_ROOT + "=" + change_root.path_cstr() + ";"); env += (declr + C_ENV_WORK_ROOT + "=" + work_root.path_cstr() + ";"); env += (declr + C_ENV_TMP_ROOT + "=" + tmp_root.path_cstr() + ";"); env += (declr + C_ENV_TMPL_ROOT + "=" + tmpl_root.path_cstr() + ";"); env += " } >&/dev/null || true"; // set up path strings using level vars char *val; mutable_cfg_path = "/"; if ((val = getenv(C_ENV_EDIT_LEVEL.c_str()))) { mutable_cfg_path = val; } if ((val = getenv(C_ENV_TMPL_LEVEL.c_str())) && val[0] && val[1]) { // see comment in the other constructor FsPath tlvl(val); tmpl_path /= tlvl; } orig_mutable_cfg_path = mutable_cfg_path; orig_tmpl_path = tmpl_path; _init_fs_escape_chars(); } UnionfsCstore::~UnionfsCstore() { } ////// public virtual functions declared in base class bool UnionfsCstore::markSessionUnsaved() { FsPath marker = work_root; marker.push(C_MARKER_UNSAVED); if (path_exists(marker)) { // already marked. treat as success. return true; } if (!create_file(marker)) { output_internal("failed to mark unsaved [%s]\n", marker.path_cstr()); return false; } return true; } bool UnionfsCstore::unmarkSessionUnsaved() { FsPath marker = work_root; marker.push(C_MARKER_UNSAVED); if (!path_exists(marker)) { // not marked. treat as success. return true; } try { b_fs::remove(marker.path_cstr()); } catch (...) { output_internal("failed to unmark unsaved [%s]\n", marker.path_cstr()); return false; } return true; } bool UnionfsCstore::sessionUnsaved() { FsPath marker = work_root; marker.push(C_MARKER_UNSAVED); return path_exists(marker); } bool UnionfsCstore::sessionChanged() { FsPath marker = work_root; marker.push(C_MARKER_CHANGED); return path_exists(marker); } /* set up the session associated with this object. * the session comes from either the environment or the session ID * (see the two different constructors). */ bool UnionfsCstore::setupSession() { vector directories; vector pids; vector old_pids; FsPath old_config; FsPath work_base; string work_string = work_root.path_cstr(); work_base = work_string.erase(work_string.find_last_of("/")); try { b_fs::directory_iterator di(work_base.path_cstr()); for (; di != b_fs::directory_iterator(); ++di) { old_config = di->path().file_string().c_str(); if (path_is_directory(old_config)) { directories.push_back(old_config); } } } catch (...) { if (path_exists(active_root)) { output_internal("no session directories found [%s]\n", work_root.path_cstr()); } } if (!path_exists(work_root)) { // session doesn't exist. create dirs. try { b_fs::create_directories(work_root.path_cstr()); b_fs::create_directories(change_root.path_cstr()); b_fs::create_directories(tmp_root.path_cstr()); if (!path_exists(active_root)) { // this should only be needed on boot b_fs::create_directories(active_root.path_cstr()); } } catch (...) { output_internal("setup session failed to create session directories\n"); return false; } // union mount if (!do_mount(change_root, active_root, work_root)) { return false; } } else if (!path_is_directory(work_root)) { output_internal("setup session not dir [%s]\n", work_root.path_cstr()); return false; } pids = getActiveCommits(); struct stat config_info; stat(work_root.path_cstr(), &config_info); int current_uid = (int) config_info.st_uid; bool failed = false; for (size_t i = 0; i < directories.size(); i++) { struct stat directory_info; int directory_uid; int current_pid = 0; // find uid for the current directory and the active config directory stat(directories[i].path_cstr(), &directory_info); directory_uid = (int) directory_info.st_uid; // remove old config session directories but only for the current user if (directory_uid == current_uid) { string config_match = work_base.path_cstr() + std::string("/new_config_"); string current_path = directories[i].path_cstr(); if (current_path.find(config_match) != std::string::npos) { current_pid = atoi(current_path.erase(current_path.find(config_match), config_match.length()).c_str()); // umount only inactive config session directory, don't touch active sessions if (std::find(pids.begin(), pids.end(), current_pid) == pids.end()) { old_pids.push_back(current_pid); output_internal("found inactive config [%d]\n", current_pid); output_internal("umount [%s]\n", directories[i].path_cstr()); if (!do_umount(directories[i])) { failed = true; } } } } } if (!old_pids.empty()) { for (size_t i = 0; i < directories.size(); i++) { int current_pid; string current_path; current_path = directories[i].path_cstr(); current_pid = atoi(current_path.erase(0, (current_path.find_last_of("_")) + 1).c_str()); if (std::find(old_pids.begin(), old_pids.end(), current_pid) != old_pids.end()) { try { if (b_fs::remove_all(directories[i].path_cstr()) == 0) { failed = true; } } catch (...) { failed = true; } } } } if (failed) { output_internal("failed to remove old config session directories\n"); } return true; } /* tear down the session associated with this object. * the session comes from either the environment or the session ID * (see the two different constructors). */ bool UnionfsCstore::teardownSession() { // check if session exists string wstr = work_root.path_cstr(); if (wstr.empty() || wstr.find(C_DEF_WORK_PREFIX) != 0 || !path_exists(work_root) || !path_is_directory(work_root)) { // no session output_internal("teardown invalid session [%s]\n", wstr.c_str()); return false; } // unmount the work root (union) if (!do_umount(work_root)) { return false; } // remove session directories bool ret = false; try { if (b_fs::remove_all(work_root.path_cstr()) != 0 && b_fs::remove_all(change_root.path_cstr()) != 0 && b_fs::remove_all(tmp_root.path_cstr()) != 0) { ret = true; } } catch (...) { } if (!ret) { output_internal("failed to remove session directories\n"); } return ret; } /* whether an actual config session is associated with this object. * the session comes from either the environment or the session ID * (see the two different constructors). */ bool UnionfsCstore::inSession() { string wstr = work_root.path_cstr(); return (!wstr.empty() && wstr.find(C_DEF_WORK_PREFIX) == 0 && path_exists(work_root) && path_is_directory(work_root)); } bool UnionfsCstore::clearCommittedMarkers() { try { b_fs::remove(commit_marker_file.path_cstr()); } catch (...) { output_internal("failed to clear committed markers\n"); return false; } return true; } bool UnionfsCstore::construct_commit_active(commit::PrioNode& node) { auto_ptr save(create_save_paths()); reset_paths(); append_cfg_path(node.getCommitPath()); FsPath ap(get_active_path()); FsPath wp(get_work_path()); FsPath tap(tmp_active_root); tap /= mutable_cfg_path; if (path_exists(tap)) { output_internal("rm[%s]\n", tap.path_cstr()); if (b_fs::remove_all(tap.path_cstr()) < 1) { output_internal("rm ta failed\n"); return false; } cnode::CfgNode *c = node.getCfgNode(); if (c && c->isTag()) { FsPath p(tap); p.pop(); if (is_directory_empty(p)) { output_internal("rm[%s]\n", p.path_cstr()); if (b_fs::remove_all(p.path_cstr()) < 1) { output_internal("rm tag failed\n"); return false; } } } } else { output_internal("no tap[%s]\n", tap.path_cstr()); } if (node.succeeded()) { // prio subtree succeeded if (path_exists(wp)) { output_internal("cp[%s]->[%s]\n", wp.path_cstr(), tap.path_cstr()); try { recursive_copy_dir(wp, tap, true); } catch (const b_fs::filesystem_error& e) { output_internal("cp w->ta failed[%s]\n", e.what()); return false; } catch (...) { output_internal("cp w->ta failed[unknown exception]\n"); return false; } } else { output_internal("no wp[%s]\n", wp.path_cstr()); } if (!node.hasSubtreeFailure()) { // whole subtree succeeded => stop recursion return true; } // failure present in subtree } else { // prio subtree failed if (path_exists(ap)) { output_internal("cp[%s]->[%s]\n", ap.path_cstr(), tap.path_cstr()); try { recursive_copy_dir(ap, tap, false); } catch (const b_fs::filesystem_error& e) { output_internal("cp a->ta failed[%s]\n", e.what()); return false; } catch (...) { output_internal("cp a->ta failed[unknown exception]\n"); return false; } } else { output_internal("no ap[%s]\n", ap.path_cstr()); } if (!node.hasSubtreeSuccess()) { // whole subtree failed => stop recursion return true; } // success present in subtree } for (size_t i = 0; i < node.numChildNodes(); i++) { if (!construct_commit_active(*(node.childAt(i)))) { return false; } } return true; } bool UnionfsCstore::mark_dir_changed(const FsPath& d, const FsPath& root) { if (!path_is_directory(d)) { output_internal("mark_dir_changed on non-directory [%s]\n", d.path_cstr()); return false; } FsPath marker(d); while (marker.size() >= root.size()) { marker.push(C_MARKER_CHANGED); if (path_exists(marker)) { // reached a node already marked => done break; } if (!create_file(marker)) { output_internal("failed to mark changed [%s]\n", marker.path_cstr()); return false; } marker.pop(); marker.pop(); } return true; } bool UnionfsCstore::sync_dir(const FsPath& src, const FsPath& dst, const FsPath& root) { if (!path_exists(src) || !path_exists(dst)) { output_user("sync_dir with non-existing dir(s)[%s][%s]\n", src.path_cstr(), dst.path_cstr()); return false; } MapT smap; MapT dmap; vector sentries; vector dentries; check_dir_entries(src, &sentries, false); check_dir_entries(dst, &dentries, false); for (size_t i = 0; i < sentries.size(); i++) { smap[sentries[i]] = true; } for (size_t i = 0; i < dentries.size(); i++) { dmap[dentries[i]] = true; if (smap.find(dentries[i]) == smap.end()) { // entry in dst but not in src => delete FsPath d(dst); if (!mark_dir_changed(d, root)) { return false; } push_path(d, dentries[i].c_str()); if (b_fs::remove_all(d.path_cstr()) < 1) { return false; } } else { // entry in both src and dst FsPath s(src); FsPath d(dst); push_path(s, dentries[i].c_str()); push_path(d, dentries[i].c_str()); if (path_is_regular(s) && path_is_regular(d)) { // it's file => compare and replace if necessary string ds, dd; if (!read_whole_file(s, ds) || !read_whole_file(d, dd)) { // error output_user("failed to replace file [%s][%s]\n", s.path_cstr(), d.path_cstr()); return false; } if (ds != dd) { // need to replace if (!write_file(d, ds)) { output_user("failed to write file [%s]\n", d.path_cstr()); return false; } d.pop(); if (!mark_dir_changed(d, root)) { return false; } } } else if (path_is_directory(s) && path_is_directory(d)) { // it's dir => recurse if (!sync_dir(s, d, root)) { return false; } } else { // something is wrong output_user("inconsistent config entry [%s][%s]\n", s.path_cstr(), d.path_cstr()); return false; } } } for (size_t i = 0; i < sentries.size(); i++) { if (dmap.find(sentries[i]) == dmap.end()) { // entry in src but not in dst => copy FsPath s(src); FsPath d(dst); push_path(s, sentries[i].c_str()); push_path(d, sentries[i].c_str()); try { if (path_is_regular(s)) { // it's file b_fs::copy_file(s.path_cstr(), d.path_cstr()); } else { // dir recursive_copy_dir(s, d, true); } d.pop(); if (!mark_dir_changed(d, root)) { return false; } } catch (...) { output_user("copy failed [%s][%s]\n", s.path_cstr(), d.path_cstr()); return false; } } } return true; } bool UnionfsCstore::commitConfig(commit::PrioNode& node) { FsPath active_unionfs = active_root; active_unionfs.push(C_MARKER_UNIONFS); // make a copy of current "work" dir try { if (path_exists(tmp_work_root)) { output_internal("rm[%s]\n", tmp_work_root.path_cstr()); if (b_fs::remove_all(tmp_work_root.path_cstr()) < 1) { output_internal("rm tw failed\n"); return false; } } output_internal("cp[%s]->[%s]\n", work_root.path_cstr(), tmp_work_root.path_cstr()); recursive_copy_dir(work_root, tmp_work_root, true); } catch (const b_fs::filesystem_error& e) { output_internal("cp w->tw failed[%s]\n", e.what()); return false; } catch (...) { output_internal("cp w->tw failed[unknown exception]\n"); return false; } if (!construct_commit_active(node)) { return false; } if (!do_umount(work_root)) { return false; } if (b_fs::remove_all(change_root.path_cstr()) < 1) { output_internal("failed to remove [%s]\n", change_root.path_cstr()); return false; } /* note: unionfs can't cope with whole directory being removed, so just * remove the content. */ if (!remove_dir_content(active_root.path_cstr())) { output_internal("failed to remove [%s] content\n", active_root.path_cstr()); return false; } try { b_fs::create_directories(change_root.path_cstr()); recursive_copy_dir(tmp_active_root, active_root, true); } catch (const b_fs::filesystem_error& e) { output_internal("cp ta->a failed[%s]\n", e.what()); return false; } catch (...) { output_internal("cp ta->a failed[unknown exception]\n"); return false; } if (!do_mount(change_root, active_root, work_root)) { return false; } if (!sync_dir(tmp_work_root, work_root, work_root)) { return false; } if (b_fs::remove_all(tmp_work_root.path_cstr()) < 1 || b_fs::remove_all(tmp_active_root.path_cstr()) < 1) { output_user("failed to remove temp directories\n"); return false; } try { b_fs::remove_all(active_unionfs.path_cstr()); } catch (const b_fs::filesystem_error& e) { output_internal("rm active unionfs failed[%s]\n", e.what()); return false; } catch (...) { output_internal("rm active unionfs[unknown exception]\n"); return false; } if (path_exists(active_unionfs)) { output_internal("failed to remove unionfs directories from active config\n"); } // all done return true; } bool UnionfsCstore::getCommitLock() { int fd; fd = open(C_COMMIT_LOCK_FILE.c_str(), O_WRONLY|O_CREAT|O_TRUNC|O_CLOEXEC, 0666); if (fd < 0) { // should not happen since all commit processes should have write access output_internal("getCommitLock() failed to open lock file\n"); return false; } if (lockf(fd, F_TLOCK, 0) < 0) { // locked by someone else return false; } // got the lock return true; } ////// virtual functions defined in base class /* check if current tmpl_path is a valid tmpl dir. * return true if valid. otherwise return false. */ bool UnionfsCstore::tmpl_node_exists() { return (path_exists(tmpl_path) && path_is_directory(tmpl_path)); } typedef MapT, FsPathHash> ParsedTmplCacheT; static ParsedTmplCacheT _parsed_tmpl_cache; /* parse template at current tmpl_path and return an allocated Ctemplate * pointer if successful. otherwise return 0. */ Ctemplate * UnionfsCstore::tmpl_parse() { FsPath tp = tmpl_path; tp.push(C_DEF_NAME); if (!path_exists(tp) || !path_is_regular(tp)) { // invalid return 0; } ParsedTmplCacheT::iterator p = _parsed_tmpl_cache.find(tp); if (p != _parsed_tmpl_cache.end()) { // found in cache return (new Ctemplate(p->second)); } // new template => parse tr1::shared_ptr def(new vtw_def); vtw_def *_def = def.get(); if (_def && parse_def(_def, tp.path_cstr(), 0) == 0) { // succes => cache and return _parsed_tmpl_cache[tp] = def; return (new Ctemplate(def)); } return 0; } bool UnionfsCstore::cfg_node_exists(bool active_cfg) { FsPath p = (active_cfg ? get_active_path() : get_work_path()); return (path_exists(p) && path_is_directory(p)); } bool UnionfsCstore::add_node() { bool ret = true; try { if (!b_fs::create_directory(get_work_path().path_cstr())) { // already exists. shouldn't call this function. ret = false; } } catch (...) { ret = false; } if (!ret) { output_internal("failed to add node [%s]\n", get_work_path().path_cstr()); } return ret; } bool UnionfsCstore::remove_node() { if (!path_exists(get_work_path()) || !path_is_directory(get_work_path())) { output_internal("remove non-existent node [%s]\n", get_work_path().path_cstr()); return false; } bool ret = false; try { if (b_fs::remove_all(get_work_path().path_cstr()) != 0) { ret = true; } } catch (...) { ret = false; } if (!ret) { output_internal("failed to remove node [%s]\n", get_work_path().path_cstr()); } return ret; } void UnionfsCstore::get_all_child_node_names_impl(vector& cnodes, bool active_cfg) { FsPath p = (active_cfg ? get_active_path() : get_work_path()); get_all_child_dir_names(p, cnodes); /* XXX special cases to emulate original perl API behavior. * original perl listNodes() and listOrigNodes() return everything * under a node (except for ".*"), including "node.val" and "def". * * perl API should operate at abstract level and should not access * such implementation-specific details. however, currently * things like config output depend on this behavior, so this * function needs to return them for now. * * use a whilelist-approach, i.e., only add the following: * node.val * def * * FIXED: perl scripts have been changed to eliminate the use of "def" * and "node.val", so they no longer need to be returned. */ } bool UnionfsCstore::read_value_vec(vector& vvec, bool active_cfg) { FsPath vpath = (active_cfg ? get_active_path() : get_work_path()); vpath.push(C_VAL_NAME); string ostr; if (!read_whole_file(vpath, ostr)) { return false; } /* XXX original implementation used to remove a trailing '\n' after * a read. it was only necessary because it was adding a '\n' when * writing the file. don't remove anything now since we shouldn't * be writing it any more. */ // separate values using newline as delimiter size_t start_idx = 0, idx = 0; for (; idx < ostr.size(); idx++) { if (ostr[idx] == '\n') { // got a value vvec.push_back(ostr.substr(start_idx, (idx - start_idx))); start_idx = idx + 1; } } if (start_idx < ostr.size()) { vvec.push_back(ostr.substr(start_idx, (idx - start_idx))); } else { // last char is a newline => another empty value vvec.push_back(""); } return true; } bool UnionfsCstore::write_value_vec(const vector& vvec, bool active_cfg) { FsPath wp = (active_cfg ? get_active_path() : get_work_path()); wp.push(C_VAL_NAME); if (path_exists(wp) && !path_is_regular(wp)) { // not a file output_internal("failed to write node value (file) [%s]\n", wp.path_cstr()); return false; } string ostr = ""; for (size_t i = 0; i < vvec.size(); i++) { if (i > 0) { // subsequent values require delimiter ostr += "\n"; } ostr += vvec[i]; } if (!write_file(wp, ostr)) { output_internal("failed to write node value (write) [%s]\n", wp.path_cstr()); return false; } return true; } bool UnionfsCstore::rename_child_node(const char *oname, const char *nname) { FsPath opath = get_work_path(); opath.push(oname); FsPath npath = get_work_path(); npath.push(nname); if (!path_exists(opath) || !path_is_directory(opath) || path_exists(npath)) { output_internal("cannot rename node [%s,%s,%s]\n", get_work_path().path_cstr(), oname, nname); return false; } bool ret = true; try { /* somehow b_fs::rename() can't be used here as it considers the operation * "Invalid cross-device link" and fails with an exception, probably due * to unionfs in some way. * do it the hard way. */ recursive_copy_dir(opath, npath); if (b_fs::remove_all(opath.path_cstr()) == 0) { ret = false; } } catch (...) { ret = false; } if (!ret) { output_internal("failed to rename node [%s,%s]\n", opath.path_cstr(), npath.path_cstr()); } return ret; } bool UnionfsCstore::copy_child_node(const char *oname, const char *nname) { FsPath opath = get_work_path(); opath.push(oname); FsPath npath = get_work_path(); npath.push(nname); if (!path_exists(opath) || !path_is_directory(opath) || path_exists(npath)) { output_internal("cannot copy node [%s,%s,%s]\n", get_work_path().path_cstr(), oname, nname); return false; } try { recursive_copy_dir(opath, npath); } catch (...) { output_internal("failed to copy node [%s,%s,%s]\n", get_work_path().path_cstr(), oname, nname); return false; } return true; } bool UnionfsCstore::mark_display_default() { FsPath marker = get_work_path(); marker.push(C_MARKER_DEF_VALUE); if (path_exists(marker)) { // already marked. treat as success. return true; } if (!create_file(marker)) { output_internal("failed to mark default [%s]\n", get_work_path().path_cstr()); return false; } return true; } bool UnionfsCstore::unmark_display_default() { FsPath marker = get_work_path(); marker.push(C_MARKER_DEF_VALUE); if (!path_exists(marker)) { // not marked. treat as success. return true; } try { b_fs::remove(marker.path_cstr()); } catch (...) { output_internal("failed to unmark default [%s]\n", get_work_path().path_cstr()); return false; } return true; } bool UnionfsCstore::marked_display_default(bool active_cfg) { FsPath marker = (active_cfg ? get_active_path() : get_work_path()); marker.push(C_MARKER_DEF_VALUE); return path_exists(marker); } bool UnionfsCstore::marked_deactivated(bool active_cfg) { FsPath marker = (active_cfg ? get_active_path() : get_work_path()); marker.push(C_MARKER_DEACTIVATE); return path_exists(marker); } bool UnionfsCstore::mark_deactivated() { FsPath marker = get_work_path(); marker.push(C_MARKER_DEACTIVATE); if (path_exists(marker)) { // already marked. treat as success. return true; } if (!create_file(marker)) { output_internal("failed to mark deactivated [%s]\n", get_work_path().path_cstr()); return false; } return true; } bool UnionfsCstore::unmark_deactivated() { FsPath marker = get_work_path(); marker.push(C_MARKER_DEACTIVATE); if (!path_exists(marker)) { // not deactivated. treat as success. return true; } try { b_fs::remove(marker.path_cstr()); } catch (...) { output_internal("failed to unmark deactivated [%s]\n", get_work_path().path_cstr()); return false; } return true; } bool UnionfsCstore::unmark_deactivated_descendants() { bool ret = false; do { // sanity check if (!path_is_directory(get_work_path())) { break; } try { vector markers; b_fs::recursive_directory_iterator di(get_work_path().path_cstr()); for (; di != b_fs::recursive_directory_iterator(); ++di) { if (!path_is_regular(di->path().file_string().c_str()) || di->path().filename() != C_MARKER_DEACTIVATE) { // not marker continue; } const char *ppath = di->path().parent_path().file_string().c_str(); if (strcmp(ppath, get_work_path().path_cstr()) == 0) { // don't unmark the node itself continue; } markers.push_back(di->path()); } for (size_t i = 0; i < markers.size(); i++) { b_fs::remove(markers[i]); } } catch (...) { break; } ret = true; } while (0); if (!ret) { output_internal("failed to unmark deactivated descendants [%s]\n", get_work_path().path_cstr()); } return ret; } // mark current work path and all ancestors as "changed" bool UnionfsCstore::mark_changed_with_ancestors() { FsPath opath = mutable_cfg_path; // use a copy bool done = false; while (!done) { FsPath marker = work_root; if (opath.has_parent_path()) { marker /= opath; pop_path(opath); } else { done = true; } if (!path_exists(marker) || !path_is_directory(marker)) { // don't do anything if the node is not there continue; } marker.push(C_MARKER_CHANGED); if (path_exists(marker)) { // reached a node already marked => done break; } if (!create_file(marker)) { output_internal("failed to mark changed [%s]\n", marker.path_cstr()); return false; } } return true; } /* remove all "changed" markers under the current work path. this is used, * e.g., at the end of "commit" to reset a subtree. */ bool UnionfsCstore::unmark_changed_with_descendants() { try { vector markers; b_fs::recursive_directory_iterator di(get_work_path().path_cstr()); for (; di != b_fs::recursive_directory_iterator(); ++di) { if (!path_is_regular(di->path().file_string().c_str()) || di->path().filename() != C_MARKER_CHANGED) { // not marker continue; } markers.push_back(di->path()); } for (size_t i = 0; i < markers.size(); i++) { b_fs::remove(markers[i]); } } catch (...) { output_internal("failed to unmark changed with descendants [%s]\n", get_work_path().path_cstr()); return false; } return true; } // remove the comment at the current work path bool UnionfsCstore::remove_comment() { FsPath cfile = get_work_path(); cfile.push(C_COMMENT_FILE); if (!path_exists(cfile)) { return false; } try { b_fs::remove(cfile.path_cstr()); } catch (...) { output_internal("failed to remove comment [%s]\n", cfile.path_cstr()); return false; } return true; } // set comment at the current work path bool UnionfsCstore::set_comment(const string& comment) { FsPath cfile = get_work_path(); cfile.push(C_COMMENT_FILE); return write_file(cfile, comment); } // discard all changes in working config bool UnionfsCstore::discard_changes(unsigned long long& num_removed) { // need to keep unsaved marker bool unsaved = sessionUnsaved(); bool ret = true; vector files; vector directories; try { // iterate through all entries in change root b_fs::directory_iterator di(change_root.path_cstr()); for (; di != b_fs::directory_iterator(); ++di) { if (path_is_directory(di->path().file_string().c_str())) { directories.push_back(di->path()); } else { files.push_back(di->path()); } } // remove and count num_removed = 0; for (size_t i = 0; i < files.size(); i++) { b_fs::remove(files[i]); num_removed++; } for (size_t i = 0; i < directories.size(); i++) { num_removed += b_fs::remove_all(directories[i]); } } catch (...) { output_internal("discard failed [%s]\n", change_root.path_cstr()); ret = false; } if (unsaved) { // restore unsaved marker num_removed--; markSessionUnsaved(); } return ret; } // get comment at the current work or active path bool UnionfsCstore::get_comment(string& comment, bool active_cfg) { FsPath cfile = (active_cfg ? get_active_path() : get_work_path()); cfile.push(C_COMMENT_FILE); return read_whole_file(cfile, comment); } // whether current work path is "changed" bool UnionfsCstore::cfg_node_changed() { FsPath marker = get_work_path(); marker.push(C_MARKER_CHANGED); return path_exists(marker); } void UnionfsCstore::get_edit_level(Cpath& pcomps) { FsPath opath = mutable_cfg_path; // use a copy vector tmp; while (opath.has_parent_path()) { string last; pop_path(opath, last); tmp.push_back(last); } while (tmp.size() > 0) { pcomps.push(tmp.back()); tmp.pop_back(); } } bool UnionfsCstore::marked_committed(bool is_delete) { string marker; get_committed_marker(is_delete, marker); return find_line_in_file(commit_marker_file, marker); } bool UnionfsCstore::mark_committed(bool is_delete) { string marker; get_committed_marker(is_delete, marker); // write one marker per line return write_file(commit_marker_file, marker + "\n", true); } string UnionfsCstore::cfg_path_to_str() { string cpath = mutable_cfg_path.path_cstr(); if (cpath.length() == 0) { cpath = "/"; } return cpath; } string UnionfsCstore::tmpl_path_to_str() { // return only the mutable part string tpath = tmpl_path.path_cstr(); tpath.erase(0, tmpl_root.length()); if (tpath.length() == 0) { tpath = "/"; } return tpath; } ////// private functions void UnionfsCstore::push_path(FsPath& old_path, const char *new_comp) { string comp = _escape_path_name(new_comp); old_path.push(comp); } void UnionfsCstore::pop_path(FsPath& path) { path.pop(); } void UnionfsCstore::pop_path(FsPath& path, string& last) { path.pop(last); last = _unescape_path_name(last); } bool UnionfsCstore::check_dir_entries(const FsPath& root, vector *cnodes, bool filter_nodes, bool empty_check) { if (!path_exists(root) || !path_is_directory(root)) { // not a valid root => treat as empty return false; } bool found = false; try { b_fs::directory_iterator di(root.path_cstr()); for (; di != b_fs::directory_iterator(); ++di) { string cname = di->path().filename(); if (filter_nodes) { // must be directory if (!path_is_directory(di->path().file_string().c_str())) { continue; } // name cannot start with "." if (cname.length() < 1 || cname[0] == '.') { continue; } } // found one if (empty_check) { // only checking and directory is not empty return true; } if (cnodes) { cnodes->push_back(_unescape_path_name(cname)); } else { found = true; } } } catch (...) { // skip the rest } return (cnodes ? (cnodes->size() > 0) : found); } bool UnionfsCstore::write_file(const char *file, const string& data, bool append) { if (data.size() > C_UNIONFS_MAX_FILE_SIZE) { output_internal("write_file too large\n"); return false; } try { // make sure the path exists FsPath ppath(file); ppath.pop(); b_fs::create_directories(ppath.path_cstr()); // write the file ofstream fout; fout.exceptions(ofstream::failbit | ofstream::badbit); ios_base::openmode mflags = ios_base::out; mflags |= ((!append || !path_exists(file)) ? ios_base::trunc : ios_base::app); // truncate or append fout.open(file, mflags); fout << data; fout.close(); } catch (...) { return false; } return true; } bool UnionfsCstore::read_whole_file(const FsPath& fpath, string& data) { /* must exist, be a regular file, and smaller than limit (we're going * to read the whole thing). */ if (!path_exists(fpath) || !path_is_regular(fpath)) { return false; } try { if (b_fs::file_size(fpath.path_cstr()) > C_UNIONFS_MAX_FILE_SIZE) { output_internal("read_whole_file too large\n"); return false; } stringbuf sbuf; ifstream fin(fpath.path_cstr()); fin >> &sbuf; fin.close(); /* note: if file contains just a newline => (eof() && fail()) * so only checking bad() and eof() (we want whole file). */ if (fin.bad() || !fin.eof()) { // read failed return false; } data = sbuf.str(); } catch (...) { return false; } return true; } /* recursively copy source directory to destination. * will throw exception (from b_fs) if fail. */ void UnionfsCstore::recursive_copy_dir(const FsPath& src, const FsPath& dst, bool filter_dot_entries) { string src_str = src.path_cstr(); string dst_str = dst.path_cstr(); b_fs::create_directories(dst.path_cstr()); b_fs::recursive_directory_iterator di(src_str); for (; di != b_fs::recursive_directory_iterator(); ++di) { const char *oname = di->path().file_string().c_str(); string nname = oname; nname.replace(0, src_str.length(), dst_str); if (path_is_directory(oname)) { b_fs::create_directory(nname); } else { if (filter_dot_entries) { string of = di->path().filename(); if (!of.empty() && of.at(0) == '.') { // filter dot files (with exceptions) if (of != C_COMMENT_FILE) { continue; } } } b_fs::copy_file(di->path(), nname); } } } void UnionfsCstore::get_committed_marker(bool is_delete, string& marker) { marker = (is_delete ? "-" : ""); marker += mutable_cfg_path.path_cstr(); } bool UnionfsCstore::find_line_in_file(const FsPath& file, const string& line) { bool ret = false; try { ifstream fin(file.path_cstr()); while (!fin.eof() && !fin.bad() && !fin.fail()) { string in; getline(fin, in); if (in == line) { ret = true; break; } } fin.close(); } catch (...) { ret = false; } return ret; } bool UnionfsCstore::do_mount(const FsPath& rwdir, const FsPath& rdir, const FsPath& mdir) { #ifdef USE_UNIONFSFUSE const char *fusepath, *fuseprog; const char *fuseoptinit; const char *fuseopt1, *fuseopt2; string mopts; fusepath = "/usr/bin/unionfs-fuse"; fuseprog = "unionfs-fuse"; fuseoptinit = "-o"; fuseopt1 = "cow"; fuseopt2 = "allow_other"; mopts = rwdir.path_cstr(); mopts += "=RW:"; mopts += rdir.path_cstr(); mopts += "=RO"; if(pipe(commpipe)){ output_internal("Pipe error!\n"); return false; } if((pid = fork()) == -1) { output_internal("*** ERROR: forking child process failed\n"); return false; } if(pid) { dup2(commpipe[1],1); close(commpipe[0]); setvbuf(stdout,(char*)NULL,_IONBF,0); wait(&status); } else { dup2(commpipe[0],0); close(commpipe[1]); if (execl(fusepath, fuseprog, fuseoptinit, fuseopt1, fuseoptinit, fuseopt2, mopts.c_str(), mdir.path_cstr(), NULL) != 0) { output_internal("union mount failed [%s][%s][%s]\n", strerror(errno), mdir.path_cstr(), mopts.c_str()); return false; } } #else string mopts = "dirs="; mopts += rwdir.path_cstr(); mopts += "=rw:"; mopts += rdir.path_cstr(); mopts += "=ro"; if (mount("unionfs", mdir.path_cstr(), "unionfs", 0, mopts.c_str()) != 0) { output_internal("union mount failed [%s][%s]\n", strerror(errno), mdir.path_cstr()); return false; } #endif return true; } bool UnionfsCstore::do_umount(const FsPath& mdir) { #ifdef USE_UNIONFSFUSE const char *fusermount_path, *fusermount_prog; const char *fusermount_umount; fusermount_path = "/usr/bin/fusermount"; fusermount_prog = "fusermount"; fusermount_umount = "-u"; if(pipe(commpipe)){ output_internal("Pipe error!\n"); return false; } if((pid = fork()) == -1) { output_internal("*** ERROR: forking child process failed\n"); return false; } if(pid) { dup2(commpipe[1],1); close(commpipe[0]); setvbuf(stdout,(char*)NULL,_IONBF,0); wait(&status); } else { dup2(commpipe[0],0); close(commpipe[1]); if (execl(fusermount_path, fusermount_prog, fusermount_umount, mdir.path_cstr(), NULL) != 0) { output_internal("union umount failed [%s][%s]\n", strerror(errno), mdir.path_cstr()); return false; } } #else if (umount(mdir.path_cstr()) != 0) { output_internal("union umount failed [%s][%s]\n", strerror(errno), mdir.path_cstr()); return false; } #endif return true; } bool UnionfsCstore::path_exists(const char *path) { b_fs::file_status result; if (!b_fs_get_file_status(path, result)) { return false; } return b_fs::exists(result); } bool UnionfsCstore::path_is_directory(const char *path) { b_fs::file_status result; if (!b_fs_get_file_status(path, result)) { return false; } return b_fs::is_directory(result); } bool UnionfsCstore::path_is_regular(const char *path) { b_fs::file_status result; if (!b_fs_get_file_status(path, result)) { return false; } return b_fs::is_regular(result); } bool UnionfsCstore::remove_dir_content(const char *path) { if (!path_is_directory(path)) { return false; } b_fs::directory_iterator di(path); for (; di != b_fs::directory_iterator(); ++di) { if (b_fs::remove_all(di->path()) < 1) { return false; } } return true; } } // end namespace unionfs } // end namespace cstore