/* Copyright (C) 2003-2016 J.F.Dockes
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifdef BUILDING_RECOLL
#include "autoconfig.h"
#else
#include "config.h"
#endif
#include "conftree.h"
#include <ctype.h>
#include <fnmatch.h>
#ifdef _WIN32
#include "safesysstat.h"
#else
#include <stdlib.h>
#include <sys/stat.h>
#include <unistd.h>
#include <pwd.h>
#endif
#include <algorithm>
#include <cstring>
#include <fstream>
#include <iostream>
#include <sstream>
#include <utility>
#include "pathut.h"
#include "smallut.h"
#include "log.h"
using namespace std;
#undef DEBUG_CONFTREE
#ifdef DEBUG_CONFTREE
#define CONFDEB LOGDEB
#else
#define CONFDEB LOGDEB2
#endif
static const SimpleRegexp varcomment_rx("[ \t]*#[ \t]*([a-zA-Z0-9]+)[ \t]*=",
0, 1);
void ConfSimple::parseinput(istream& input)
{
string submapkey;
string cline;
bool appending = false;
string line;
bool eof = false;
for (;;) {
cline.clear();
std::getline(input, cline);
CONFDEB("Parse:line: [" << cline << "] status " << status << "\n");
if (!input.good()) {
if (input.bad()) {
CONFDEB("Parse: input.bad()\n");
status = STATUS_ERROR;
return;
}
CONFDEB("Parse: eof\n");
// Must be eof ? But maybe we have a partial line which
// must be processed. This happens if the last line before
// eof ends with a backslash, or there is no final \n
eof = true;
}
{
string::size_type pos = cline.find_last_not_of("\n\r");
if (pos == string::npos) {
cline.clear();
} else if (pos != cline.length() - 1) {
cline.erase(pos + 1);
}
}
if (appending) {
line += cline;
} else {
line = cline;
}
// Note that we trim whitespace before checking for backslash-eol
// This avoids invisible whitespace problems.
if (trimvalues) {
trimstring(line);
} else {
ltrimstring(line);
}
if (line.empty() || line.at(0) == '#') {
if (eof) {
break;
}
if (varcomment_rx.simpleMatch(line)) {
m_order.push_back(ConfLine(ConfLine::CFL_VARCOMMENT, line,
varcomment_rx.getMatch(line, 1)));
} else {
m_order.push_back(ConfLine(ConfLine::CFL_COMMENT, line));
}
continue;
}
if (line[line.length() - 1] == '\\') {
line.erase(line.length() - 1);
appending = true;
continue;
}
appending = false;
if (line[0] == '[') {
trimstring(line, "[] \t");
if (dotildexpand) {
submapkey = path_tildexpand(line);
} else {
submapkey = line;
}
m_subkeys_unsorted.push_back(submapkey);
m_order.push_back(ConfLine(ConfLine::CFL_SK, submapkey));
continue;
}
// Look for first equal sign
string::size_type eqpos = line.find("=");
if (eqpos == string::npos) {
m_order.push_back(ConfLine(ConfLine::CFL_COMMENT, line));
continue;
}
// Compute name and value, trim white space
string nm, val;
nm = line.substr(0, eqpos);
trimstring(nm);
val = line.substr(eqpos + 1, string::npos);
if (trimvalues) {
trimstring(val);
}
if (nm.length() == 0) {
m_order.push_back(ConfLine(ConfLine::CFL_COMMENT, line));
continue;
}
i_set(nm, val, submapkey, true);
if (eof) {
break;
}
}
}
ConfSimple::ConfSimple(int readonly, bool tildexp, bool trimv)
: dotildexpand(tildexp), trimvalues(trimv), m_fmtime(0), m_holdWrites(false)
{
status = readonly ? STATUS_RO : STATUS_RW;
}
void ConfSimple::reparse(const string& d)
{
clear();
stringstream input(d, ios::in);
parseinput(input);
}
ConfSimple::ConfSimple(const string& d, int readonly, bool tildexp, bool trimv)
: dotildexpand(tildexp), trimvalues(trimv), m_fmtime(0), m_holdWrites(false)
{
status = readonly ? STATUS_RO : STATUS_RW;
stringstream input(d, ios::in);
parseinput(input);
}
ConfSimple::ConfSimple(const char *fname, int readonly, bool tildexp,
bool trimv)
: dotildexpand(tildexp), trimvalues(trimv), m_filename(fname),
m_fmtime(0), m_holdWrites(false)
{
status = readonly ? STATUS_RO : STATUS_RW;
ifstream input;
if (readonly) {
input.open(fname, ios::in);
} else {
ios::openmode mode = ios::in | ios::out;
// It seems that there is no separate 'create if not exists'
// open flag. Have to truncate to create, but dont want to do
// this to an existing file !
if (!path_exists(fname)) {
mode |= ios::trunc;
}
input.open(fname, mode);
if (input.is_open()) {
status = STATUS_RW;
} else {
input.clear();
input.open(fname, ios::in);
if (input.is_open()) {
status = STATUS_RO;
}
}
}
if (!input.is_open()) {
status = STATUS_ERROR;
return;
}
parseinput(input);
i_changed(true);
}
ConfSimple::StatusCode ConfSimple::getStatus() const
{
switch (status) {
case STATUS_RO:
return STATUS_RO;
case STATUS_RW:
return STATUS_RW;
default:
return STATUS_ERROR;
}
}
bool ConfSimple::sourceChanged() const
{
if (!m_filename.empty()) {
struct stat st;
if (stat(m_filename.c_str(), &st) == 0) {
if (m_fmtime != st.st_mtime) {
return true;
}
}
}
return false;
}
bool ConfSimple::i_changed(bool upd)
{
if (!m_filename.empty()) {
struct stat st;
if (stat(m_filename.c_str(), &st) == 0) {
if (m_fmtime != st.st_mtime) {
if (upd) {
m_fmtime = st.st_mtime;
}
return true;
}
}
}
return false;
}
int ConfSimple::get(const string& nm, string& value, const string& sk) const
{
if (!ok()) {
return 0;
}
// Find submap
map<string, map<string, string> >::const_iterator ss;
if ((ss = m_submaps.find(sk)) == m_submaps.end()) {
return 0;
}
// Find named value
map<string, string>::const_iterator s;
if ((s = ss->second.find(nm)) == ss->second.end()) {
return 0;
}
value = s->second;
return 1;
}
int ConfSimple::get(const string& nm, int *value, const string& sk) const
{
string sval;
if (!get(nm, sval, sk)) {
return 0;
}
*value = atoi(sval.c_str());
return 1;
}
// Appropriately output a subkey (nm=="") or variable line.
// We can't make any assumption about the data except that it does not
// contain line breaks.
// Avoid long lines if possible (for hand-editing)
// We used to break at arbitrary places, but this was ennoying for
// files with pure UTF-8 encoding (some files can be binary anyway),
// because it made later editing difficult, as the file would no
// longer have a valid encoding.
// Any ASCII byte would be a safe break point for utf-8, but could
// break some other encoding with, e.g. escape sequences? So break at
// whitespace (is this safe with all encodings?).
// Note that the choice of break point does not affect the validity of
// the file data (when read back by conftree), only its ease of
// editing with a normal editor.
static ConfSimple::WalkerCode varprinter(void *f, const string& nm,
const string& value)
{
ostream& output = *((ostream *)f);
if (nm.empty()) {
output << "\n[" << value << "]\n";
} else {
output << nm << " = ";
if (nm.length() + value.length() < 75) {
output << value;
} else {
string::size_type ll = 0;
for (string::size_type pos = 0; pos < value.length(); pos++) {
string::value_type c = value[pos];
output << c;
ll++;
// Break at whitespace if line too long and "a lot" of
// remaining data
if (ll > 50 && (value.length() - pos) > 10 &&
(c == ' ' || c == '\t')) {
ll = 0;
output << "\\\n";
}
}
}
output << "\n";
}
return ConfSimple::WALK_CONTINUE;
}
// Set variable and rewrite data
int ConfSimple::set(const std::string& nm, const std::string& value,
const string& sk)
{
if (status != STATUS_RW) {
return 0;
}
CONFDEB("ConfSimple::set ["<<sk<< "]:[" << nm << "] -> [" << value << "]\n");
if (!i_set(nm, value, sk)) {
return 0;
}
return write();
}
int ConfSimple::set(const string& nm, long long val,
const string& sk)
{
return this->set(nm, lltodecstr(val), sk);
}
// Internal set variable: no rw checking or file rewriting. If init is
// set, we're doing initial parsing, else we are changing a parsed
// tree (changes the way we update the order data)
int ConfSimple::i_set(const std::string& nm, const std::string& value,
const string& sk, bool init)
{
CONFDEB("ConfSimple::i_set: nm[" << nm << "] val[" << value <<
"] key[" << sk << "], init " << init << "\n");
// Values must not have embedded newlines
if (value.find_first_of("\n\r") != string::npos) {
CONFDEB("ConfSimple::i_set: LF in value\n");
return 0;
}
bool existing = false;
map<string, map<string, string> >::iterator ss;
// Test if submap already exists, else create it, and insert variable:
if ((ss = m_submaps.find(sk)) == m_submaps.end()) {
CONFDEB("ConfSimple::i_set: new submap\n");
map<string, string> submap;
submap[nm] = value;
m_submaps[sk] = submap;
// Maybe add sk entry to m_order data, if not already there.
if (!sk.empty()) {
ConfLine nl(ConfLine::CFL_SK, sk);
// Append SK entry only if it's not already there (erase
// does not remove entries from the order data, and it may
// be being recreated after deletion)
if (find(m_order.begin(), m_order.end(), nl) == m_order.end()) {
m_order.push_back(nl);
}
}
} else {
// Insert or update variable in existing map.
map<string, string>::iterator it;
it = ss->second.find(nm);
if (it == ss->second.end()) {
ss->second.insert(pair<string, string>(nm, value));
} else {
it->second = value;
existing = true;
}
}
// If the variable already existed, no need to change the m_order data
if (existing) {
CONFDEB("ConfSimple::i_set: existing var: no order update\n");
return 1;
}
// Add the new variable at the end of its submap in the order data.
if (init) {
// During the initial construction, just append:
CONFDEB("ConfSimple::i_set: init true: append\n");
m_order.push_back(ConfLine(ConfLine::CFL_VAR, nm));
m_order.back().m_value = value;
return 1;
}
// Look for the start and end of the subkey zone. Start is either
// at begin() for a null subkey, or just behind the subkey
// entry. End is either the next subkey entry, or the end of
// list. We insert the new entry just before end.
vector<ConfLine>::iterator start, fin;
if (sk.empty()) {
start = m_order.begin();
CONFDEB("ConfSimple::i_set: null sk, start at top of order\n");
} else {
start = find(m_order.begin(), m_order.end(),
ConfLine(ConfLine::CFL_SK, sk));
if (start == m_order.end()) {
// This is not logically possible. The subkey must
// exist. We're doomed
std::cerr << "Logical failure during configuration variable "
"insertion" << endl;
abort();
}
}
fin = m_order.end();
if (start != m_order.end()) {
// The null subkey has no entry (maybe it should)
if (!sk.empty()) {
start++;
}
for (vector<ConfLine>::iterator it = start; it != m_order.end(); it++) {
if (it->m_kind == ConfLine::CFL_SK) {
fin = it;
break;
}
}
}
// It may happen that the order entry already exists because erase doesnt
// update m_order
if (find(start, fin, ConfLine(ConfLine::CFL_VAR, nm)) == fin) {
// Look for a varcomment line, insert the value right after if
// it's there.
bool inserted(false);
vector<ConfLine>::iterator it;
for (it = start; it != fin; it++) {
if (it->m_kind == ConfLine::CFL_VARCOMMENT && it->m_aux == nm) {
it++;
m_order.insert(it, ConfLine(ConfLine::CFL_VAR, nm));
inserted = true;
break;
}
}
if (!inserted) {
m_order.insert(fin, ConfLine(ConfLine::CFL_VAR, nm));
}
}
return 1;
}
int ConfSimple::erase(const string& nm, const string& sk)
{
if (status != STATUS_RW) {
return 0;
}
map<string, map<string, string> >::iterator ss;
if ((ss = m_submaps.find(sk)) == m_submaps.end()) {
return 0;
}
ss->second.erase(nm);
if (ss->second.empty()) {
m_submaps.erase(ss);
}
return write();
}
int ConfSimple::eraseKey(const string& sk)
{
vector<string> nms = getNames(sk);
for (vector<string>::iterator it = nms.begin(); it != nms.end(); it++) {
erase(*it, sk);
}
return write();
}
// Walk the tree, calling user function at each node
ConfSimple::WalkerCode
ConfSimple::sortwalk(WalkerCode(*walker)(void *, const string&, const string&),
void *clidata) const
{
if (!ok()) {
return WALK_STOP;
}
// For all submaps:
for (map<string, map<string, string> >::const_iterator sit =
m_submaps.begin();
sit != m_submaps.end(); sit++) {
// Possibly emit submap name:
if (!sit->first.empty() && walker(clidata, string(), sit->first.c_str())
== WALK_STOP) {
return WALK_STOP;
}
// Walk submap
const map<string, string>& sm = sit->second;
for (map<string, string>::const_iterator it = sm.begin(); it != sm.end();
it++) {
if (walker(clidata, it->first, it->second) == WALK_STOP) {
return WALK_STOP;
}
}
}
return WALK_CONTINUE;
}
// Write to default output. This currently only does something if output is
// a file
bool ConfSimple::write()
{
if (!ok()) {
return false;
}
if (m_holdWrites) {
return true;
}
if (m_filename.length()) {
ofstream output(m_filename.c_str(), ios::out | ios::trunc);
if (!output.is_open()) {
return 0;
}
return write(output);
} else {
// No backing store, no writing. Maybe one day we'll need it with
// some kind of output string. This can't be the original string which
// is currently readonly.
//ostringstream output(m_ostring, ios::out | ios::trunc);
return 1;
}
}
// Write out the tree in configuration file format:
// This does not check holdWrites, this is done by write(void), which
// lets ie: showall work even when holdWrites is set
bool ConfSimple::write(ostream& out) const
{
if (!ok()) {
return false;
}
string sk;
for (vector<ConfLine>::const_iterator it = m_order.begin();
it != m_order.end(); it++) {
switch (it->m_kind) {
case ConfLine::CFL_COMMENT:
case ConfLine::CFL_VARCOMMENT:
out << it->m_data << endl;
if (!out.good()) {
return false;
}
break;
case ConfLine::CFL_SK:
sk = it->m_data;
CONFDEB("ConfSimple::write: SK [" << sk << "]\n");
// Check that the submap still exists, and only output it if it
// does
if (m_submaps.find(sk) != m_submaps.end()) {
out << "[" << it->m_data << "]" << endl;
if (!out.good()) {
return false;
}
}
break;
case ConfLine::CFL_VAR:
string nm = it->m_data;
CONFDEB("ConfSimple::write: VAR [" << nm << "], sk [" <<sk<< "]\n");
// As erase() doesnt update m_order we can find unexisting
// variables, and must not output anything for them. Have
// to use a ConfSimple::get() to check here, because
// ConfTree's could retrieve from an ancestor even if the
// local var is gone.
string value;
if (ConfSimple::get(nm, value, sk)) {
varprinter(&out, nm, value);
if (!out.good()) {
return false;
}
break;
}
CONFDEB("ConfSimple::write: no value: nm["<<nm<<"] sk["<<sk<< "]\n");
break;
}
}
return true;
}
void ConfSimple::showall() const
{
if (!ok()) {
return;
}
write(std::cout);
}
vector<string> ConfSimple::getNames(const string& sk, const char *pattern) const
{
vector<string> mylist;
if (!ok()) {
return mylist;
}
map<string, map<string, string> >::const_iterator ss;
if ((ss = m_submaps.find(sk)) == m_submaps.end()) {
return mylist;
}
mylist.reserve(ss->second.size());
map<string, string>::const_iterator it;
for (it = ss->second.begin(); it != ss->second.end(); it++) {
if (pattern && 0 != fnmatch(pattern, it->first.c_str(), 0)) {
continue;
}
mylist.push_back(it->first);
}
return mylist;
}
vector<string> ConfSimple::getSubKeys() const
{
vector<string> mylist;
if (!ok()) {
return mylist;
}
mylist.reserve(m_submaps.size());
map<string, map<string, string> >::const_iterator ss;
for (ss = m_submaps.begin(); ss != m_submaps.end(); ss++) {
mylist.push_back(ss->first);
}
return mylist;
}
bool ConfSimple::hasNameAnywhere(const string& nm) const
{
vector<string>keys = getSubKeys();
for (vector<string>::const_iterator it = keys.begin();
it != keys.end(); it++) {
string val;
if (get(nm, val, *it)) {
return true;
}
}
return false;
}
bool ConfSimple::commentsAsXML(ostream& out)
{
const vector<ConfLine>& lines = getlines();
out << "<confcomments>\n";
string sk;
for (vector<ConfLine>::const_iterator it = lines.begin();
it != lines.end(); it++) {
switch (it->m_kind) {
case ConfLine::CFL_COMMENT:
case ConfLine::CFL_VARCOMMENT:
{
string::size_type pos = it->m_data.find_first_not_of("# ");
if (pos != string::npos) {
out << it->m_data.substr(pos) << endl;
}
break;
}
default:
break;
}
}
out << "</confcomments>\n";
return true;
}
// //////////////////////////////////////////////////////////////////////////
// ConfTree Methods: conftree interpret keys like a hierarchical file tree
// //////////////////////////////////////////////////////////////////////////
int ConfTree::get(const std::string& name, string& value, const string& sk)
const
{
if (sk.empty() || !path_isabsolute(sk)) {
LOGDEB2("ConfTree::get: looking in global space for [" <<
sk << "]\n");
return ConfSimple::get(name, value, sk);
}
// Get writable copy of subkey path
string msk = sk;
// Handle the case where the config file path has an ending / and not
// the input sk
path_catslash(msk);
// Look in subkey and up its parents until root ('')
for (;;) {
LOGDEB2("ConfTree::get: looking for [" << name << "] in [" <<
msk << "]\n");
if (ConfSimple::get(name, value, msk)) {
return 1;
}
string::size_type pos = msk.rfind("/");
if (pos != string::npos) {
msk.replace(pos, string::npos, string());
} else {
#ifdef _WIN32
if (msk.size() == 2 && isalpha(msk[0]) && msk[1] == ':') {
msk.clear();
} else
#endif
break;
}
}
return 0;
}