InitConfigFileParser.cpp 16.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* Copyright (C) 2003 MySQL AB

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 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 General Public License for more details.

   You should have received a copy of the GNU 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 */

17 18
#include <ndb_global.h>

19 20 21 22 23
#include "InitConfigFileParser.hpp"
#include "Config.hpp"
#include "MgmtErrorReporter.hpp"
#include <NdbOut.hpp>
#include "ConfigInfo.hpp"
joreland@mysql.com's avatar
joreland@mysql.com committed
24
#include <m_string.h>
25

26
const int MAX_LINE_LENGTH = 1024;  // Max length of line of text in config file
27 28 29 30 31 32 33
static void trim(char *);

static void require(bool v) { if(!v) abort();}

//****************************************************************************
//  Ctor / Dtor
//****************************************************************************
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
34 35
InitConfigFileParser::InitConfigFileParser(FILE * out)
{
36
  m_info = new ConfigInfo();
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
37
  m_errstream = out ? out : stdout;
38 39 40 41 42 43 44 45 46
}

InitConfigFileParser::~InitConfigFileParser() {
  delete m_info;
}

//****************************************************************************
//  Read Config File
//****************************************************************************
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
47
InitConfigFileParser::Context::Context(const ConfigInfo * info, FILE * out)
48
  :  m_userProperties(true), m_configValues(1000, 20) {
49

50 51
  m_config = new Properties(true);
  m_defaults = new Properties(true);
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
52
  m_errstream = out;
53 54 55 56 57 58 59 60 61 62 63 64 65 66
}

InitConfigFileParser::Context::~Context(){
  if(m_config != 0)
    delete m_config;

  if(m_defaults != 0)
    delete m_defaults;
}

Config *
InitConfigFileParser::parseConfig(const char * filename) {
  FILE * file = fopen(filename, "r");
  if(file == 0){
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
67
    fprintf(m_errstream, "Error opening file: %s\n", filename);
68 69
    return 0;
  }
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
70
  
71 72 73 74 75 76 77
  Config * ret = parseConfig(file);
  fclose(file);
  return ret;
}

Config *
InitConfigFileParser::parseConfig(FILE * file) {
78 79 80

  char line[MAX_LINE_LENGTH];

jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
81
  Context ctx(m_info, m_errstream); 
82 83 84 85 86 87
  ctx.m_lineno = 0;
  ctx.m_currentSection = 0;

  /*************
   * Open file *
   *************/
88 89
  if (file == NULL) {
    return 0;
90 91 92 93 94
  }

  /***********************
   * While lines to read *
   ***********************/
95
  while (fgets(line, MAX_LINE_LENGTH, file)) {
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    ctx.m_lineno++;

    trim(line);

    if (isEmptyLine(line)) // Skip if line is empty or comment
      continue;   

    // End with NULL instead of newline
    if (line[strlen(line)-1] == '\n')
      line[strlen(line)-1] = '\0';
    
    /********************************
     * 1. Parse new default section *
     ********************************/
    if (char* section = parseDefaultSectionHeader(line)) {
      if(!storeSection(ctx)){
	free(section);
	ctx.reportError("Could not store previous default section "
			"of configuration file.");
115
	return 0;
116
      }
117
      BaseString::snprintf(ctx.fname, sizeof(ctx.fname), section); free(section);
118 119
      ctx.type             = InitConfigFileParser::DefaultSection;
      ctx.m_sectionLineno  = ctx.m_lineno;
120
      ctx.m_currentSection = new Properties(true);
121
      ctx.m_userDefaults   = NULL;
122 123
      require((ctx.m_currentInfo = m_info->getInfo(ctx.fname)) != 0);
      require((ctx.m_systemDefaults = m_info->getDefaults(ctx.fname)) != 0);
124 125 126 127 128 129 130 131 132 133 134
      continue;
    }
    
    /************************
     * 2. Parse new section *
     ************************/
    if (char* section = parseSectionHeader(line)) {
      if(!storeSection(ctx)){
	free(section);
	ctx.reportError("Could not store previous section "
			"of configuration file.");
135
	return 0;
136
      }
137
      BaseString::snprintf(ctx.fname, sizeof(ctx.fname), section);
138 139 140
      free(section);
      ctx.type             = InitConfigFileParser::Section;
      ctx.m_sectionLineno  = ctx.m_lineno;      
141
      ctx.m_currentSection = new Properties(true);
142
      ctx.m_userDefaults   = getSection(ctx.fname, ctx.m_defaults);
143 144
      require((ctx.m_currentInfo    = m_info->getInfo(ctx.fname)) != 0);
      require((ctx.m_systemDefaults = m_info->getDefaults(ctx.fname)) != 0);
145 146 147 148 149 150 151 152
      continue;
    }
    
    /****************************
     * 3. Parse name-value pair *
     ****************************/
    if (!parseNameValuePair(ctx, line)) {
      ctx.reportError("Could not parse name-value pair in config file.");
153
      return 0;
154 155 156
    }
  }
  
157 158 159 160 161
  if (ferror(file)){
    ctx.reportError("Failure in reading");
    return 0;
  } 

162 163
  if(!storeSection(ctx)) {
    ctx.reportError("Could not store section of configuration file.");
164
    return 0;
165
  }
166 167 168 169 170 171 172 173 174 175 176 177 178
  for(size_t i = 0; ConfigInfo::m_ConfigRules[i].m_configRule != 0; i++){
    ctx.type             = InitConfigFileParser::Undefined;
    ctx.m_currentSection = 0;
    ctx.m_userDefaults   = 0;
    ctx.m_currentInfo    = 0;
    ctx.m_systemDefaults = 0;
    
    Vector<ConfigInfo::ConfigRuleSection> tmp;
    if(!(* ConfigInfo::m_ConfigRules[i].m_configRule)(tmp, ctx,
						      ConfigInfo::m_ConfigRules[i].m_ruleData))
      return 0;

    for(size_t j = 0; j<tmp.size(); j++){
179
      BaseString::snprintf(ctx.fname, sizeof(ctx.fname), tmp[j].m_sectionType.c_str());
180 181 182
      ctx.type             = InitConfigFileParser::Section;
      ctx.m_currentSection = tmp[j].m_sectionData;
      ctx.m_userDefaults   = getSection(ctx.fname, ctx.m_defaults);
183 184
      require((ctx.m_currentInfo    = m_info->getInfo(ctx.fname)) != 0);
      require((ctx.m_systemDefaults = m_info->getDefaults(ctx.fname)) != 0);
185 186 187 188 189
      if(!storeSection(ctx))
	return 0;
    }
  }

190 191 192 193 194 195 196 197 198 199
  Uint32 nConnections = 0;
  Uint32 nComputers = 0;
  Uint32 nNodes = 0;
  Uint32 nExtConnections = 0;
  const char * system = "?";
  ctx.m_userProperties.get("NoOfConnections", &nConnections);
  ctx.m_userProperties.get("NoOfComputers", &nComputers);
  ctx.m_userProperties.get("NoOfNodes", &nNodes);
  ctx.m_userProperties.get("ExtNoOfConnections", &nExtConnections);
  ctx.m_userProperties.get("ExtSystem", &system);
200 201 202
  ctx.m_config->put("NoOfConnections", nConnections);
  ctx.m_config->put("NoOfComputers", nComputers);
  ctx.m_config->put("NoOfNodes", nNodes);
203 204

  char tmpLine[MAX_LINE_LENGTH];
205
  BaseString::snprintf(tmpLine, MAX_LINE_LENGTH, "EXTERNAL SYSTEM_");
206 207
  strncat(tmpLine, system, MAX_LINE_LENGTH);
  strncat(tmpLine, ":NoOfConnections", MAX_LINE_LENGTH);
208
  ctx.m_config->put(tmpLine, nExtConnections);
209
  
210 211 212 213
  Config * ret = new Config();
  ret->m_configValues = (struct ndb_mgm_configuration*)ctx.m_configValues.getConfigValues();
  ret->m_oldConfig = ctx.m_config; ctx.m_config = 0;
  return ret;
214 215 216 217 218 219
}

//****************************************************************************
//  Parse Name-Value Pair
//****************************************************************************

220 221
bool InitConfigFileParser::parseNameValuePair(Context& ctx, const char* line)
{
222 223 224 225 226 227
  if (ctx.m_currentSection == NULL){
    ctx.reportError("Value specified outside section");
    return false;
  }

  // *************************************
228 229
  //  Split string at first occurrence of 
  //  '=' or ':'
230
  // *************************************
231

232 233
  Vector<BaseString> tmp_string_split;
  if (BaseString(line).split(tmp_string_split,
234
			     "=:", 2) != 2)
235
  {
236 237 238 239
    ctx.reportError("Parse error");
    return false;
  }

240 241 242 243 244 245 246 247 248
  // *************************************
  //  Remove all after #
  // *************************************

  Vector<BaseString> tmp_string_split2;
  tmp_string_split[1].split(tmp_string_split2,
			    "#", 2);
  tmp_string_split[1]=tmp_string_split2[0];

249 250 251 252 253 254
  // *************************************
  // Remove leading and trailing chars
  // *************************************
  {
    for (int i = 0; i < 2; i++)
      tmp_string_split[i].trim("\r\n \t"); 
255
  }
256 257 258 259 260 261 262

  // *************************************
  // First in split is fname
  // *************************************

  const char *fname= tmp_string_split[0].c_str();

263 264 265 266 267
  if (!ctx.m_currentInfo->contains(fname)) {
    ctx.reportError("[%s] Unknown parameter: %s", ctx.fname, fname);
    return false;
  }
  ConfigInfo::Status status = m_info->getStatus(ctx.m_currentInfo, fname);
268
  if (status == ConfigInfo::CI_NOTIMPLEMENTED) {
269 270
    ctx.reportWarning("[%s] %s not yet implemented", ctx.fname, fname);
  }
271
  if (status == ConfigInfo::CI_DEPRICATED) {
272 273 274 275 276 277 278
    const char * desc = m_info->getDescription(ctx.m_currentInfo, fname);
    if(desc){
      ctx.reportWarning("[%s] %s is depricated, use %s instead", 
			ctx.fname, fname, desc);
    } else {
      ctx.reportWarning("[%s] %s is depricated", ctx.fname, fname);
    } 
279 280 281 282 283
  }

  // ***********************
  //  Store name-value pair
  // ***********************
284 285

  return storeNameValuePair(ctx, fname, tmp_string_split[1].c_str());
286 287 288 289 290 291 292 293 294 295 296 297
}


//****************************************************************************
//  STORE NAME-VALUE pair in properties section 
//****************************************************************************

bool 
InitConfigFileParser::storeNameValuePair(Context& ctx,
					 const char* fname, 
					 const char* value) {
  
298
  const char * pname = fname;
299 300 301 302 303 304 305 306 307 308

  if (ctx.m_currentSection->contains(pname)) {
    ctx.reportError("[%s] Parameter %s specified twice", ctx.fname, fname);
    return false;
  }
  
  // ***********************
  //  Store name-value pair
  // ***********************

309 310
  const ConfigInfo::Type type = m_info->getType(ctx.m_currentInfo, fname);
  switch(type){
311
  case ConfigInfo::CI_BOOL: {
312 313 314 315 316 317 318 319
    bool value_bool;
    if (!convertStringToBool(value, value_bool)) {
      ctx.reportError("Illegal boolean value for parameter %s", fname);
      return false;
    }
    MGM_REQUIRE(ctx.m_currentSection->put(pname, value_bool));
    break;
  }
320 321
  case ConfigInfo::CI_INT:
  case ConfigInfo::CI_INT64:{
322 323
    Uint64 value_int;
    if (!convertStringToUint64(value, value_int)) {
324 325 326 327 328
      ctx.reportError("Illegal integer value for parameter %s", fname);
      return false;
    }
    if (!m_info->verify(ctx.m_currentInfo, fname, value_int)) {
      ctx.reportError("Illegal value %s for parameter %s.\n"
329
		      "Legal values are between %Lu and %Lu", value, fname,
330 331 332 333
		      m_info->getMin(ctx.m_currentInfo, fname), 
		      m_info->getMax(ctx.m_currentInfo, fname));
      return false;
    }
334
    if(type == ConfigInfo::CI_INT){
335 336 337 338
      MGM_REQUIRE(ctx.m_currentSection->put(pname, (Uint32)value_int));
    } else {
      MGM_REQUIRE(ctx.m_currentSection->put64(pname, value_int));
    }
339 340
    break;
  }
341
  case ConfigInfo::CI_STRING:
342 343
    MGM_REQUIRE(ctx.m_currentSection->put(pname, value));
    break;
344
  case ConfigInfo::CI_SECTION:
345
    abort();
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
  }
  return true;
}

//****************************************************************************
//  Is Empty Line
//****************************************************************************

bool InitConfigFileParser::isEmptyLine(const char* line) const {
  int i;
  
  // Check if it is a comment line
  if (line[0] == '#') return true;               

  // Check if it is a line with only spaces
  for (i = 0; i < MAX_LINE_LENGTH && line[i] != '\n' && line[i] != '\0'; i++) {
    if (line[i] != ' ' && line[i] != '\t') return false;
  }
  return true;
}

//****************************************************************************
//  Convert String to Int
//****************************************************************************
370 371
bool InitConfigFileParser::convertStringToUint64(const char* s, 
						 Uint64& val,
372 373 374 375 376 377 378 379
						 Uint32 log10base) {
  if (s == NULL)
    return false;
  if (strlen(s) == 0) 
    return false;

  errno = 0;
  char* p;
joreland@mysql.com's avatar
joreland@mysql.com committed
380
  Int64 v = strtoll(s, &p, log10base);
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  if (errno != 0)
    return false;
  
  long mul = 0;
  if (p != &s[strlen(s)]){
    char * tmp = strdup(p);
    trim(tmp);
    switch(tmp[0]){
    case 'k':
    case 'K':
      mul = 10;
      break;
    case 'M':
      mul = 20;
      break;
    case 'G':
      mul = 30;
      break;
    default:
      free(tmp);
      return false;
    }
    free(tmp);
  }
  
  val = (v << mul);
  return true;
}

bool InitConfigFileParser::convertStringToBool(const char* s, bool& val) {
  if (s == NULL) return false;
  if (strlen(s) == 0) return false;

  if (!strcmp(s, "Y") || !strcmp(s, "y") || 
      !strcmp(s, "Yes") || !strcmp(s, "YES") || !strcmp(s, "yes") || 
416 417
      !strcmp(s, "True") || !strcmp(s, "TRUE") || !strcmp(s, "true") ||
      !strcmp(s, "1")) {
418 419 420 421 422 423
    val = true;
    return true;
  }

  if (!strcmp(s, "N") || !strcmp(s, "n") || 
      !strcmp(s, "No") || !strcmp(s, "NO") || !strcmp(s, "no") || 
424 425
      !strcmp(s, "False") || !strcmp(s, "FALSE") || !strcmp(s, "false") ||
      !strcmp(s, "0")) {
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
    val = false;
    return true;
  }
  
  return false;  // Failure to convert
}

//****************************************************************************
//  Parse Section Header
//****************************************************************************
static void
trim(char * str){
  int len = strlen(str);
  for(len--;
      (str[len] == '\r' || str[len] == '\n' || 
       str[len] == ' ' || str[len] == '\t') && 
	len > 0; 
      len--)
    str[len] = 0;
  
  int pos = 0;
  while(str[pos] == ' ' || str[pos] == '\t')
    pos++;
  
  if(str[pos] == '\"' && str[len] == '\"') {
    pos++;
    str[len] = 0;
    len--;
  }
  
  memmove(str, &str[pos], len - pos + 2);
}

char* 
InitConfigFileParser::parseSectionHeader(const char* line) const {
  char * tmp = strdup(line);

  if(tmp[0] != '['){
    free(tmp);
    return NULL;
  }

  if(tmp[strlen(tmp)-1] != ']'){
    free(tmp);
    return NULL;
  }
  tmp[strlen(tmp)-1] = 0;

  tmp[0] = ' ';
  trim(tmp);

477 478 479 480 481 482 483 484 485
  // Get the correct header name if an alias
  {
    const char *tmp_alias= m_info->getAlias(tmp);
    if (tmp_alias) {
      free(tmp);
      tmp= strdup(tmp_alias);
    }
  }

486
  // Lookup token among sections
487 488 489 490
  if(!m_info->isSection(tmp)) {
    free(tmp);
    return NULL;
  }
491 492 493 494 495 496 497 498 499 500 501 502 503 504
  if(m_info->getInfo(tmp)) return tmp;

  free(tmp);
  return NULL;
}

//****************************************************************************
//  Parse Default Section Header
//****************************************************************************

char* 
InitConfigFileParser::parseDefaultSectionHeader(const char* line) const {
  static char token1[MAX_LINE_LENGTH], token2[MAX_LINE_LENGTH];

505
  int no = sscanf(line, "[%120[A-Z_a-z] %120[A-Z_a-z]]", token1, token2);
506 507 508 509 510

  // Not correct no of tokens 
  if (no != 2) return NULL;

  // Not correct keyword at end
511
  if (!strcasecmp(token2, "DEFAULT") == 0) return NULL;
512

513 514 515
  const char *token1_alias= m_info->getAlias(token1);
  if (token1_alias == 0)
    token1_alias= token1;
516

517 518
  if(m_info->getInfo(token1_alias)){
    return strdup(token1_alias);
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
  }
  
  // Did not find section
  return NULL;
}

const Properties *
InitConfigFileParser::getSection(const char * name, const Properties * src){
  const Properties * p;
  if(src && src->get(name, &p))
    return p;

  return 0;
}

//****************************************************************************
//  STORE section
//****************************************************************************
bool
InitConfigFileParser::storeSection(Context& ctx){
  if(ctx.m_currentSection == NULL)
    return true;
  for(int i = strlen(ctx.fname) - 1; i>=0; i--){
    ctx.fname[i] = toupper(ctx.fname[i]);
  }
544
  BaseString::snprintf(ctx.pname, sizeof(ctx.pname), ctx.fname);
545 546
  char buf[255];
  if(ctx.type == InitConfigFileParser::Section)
547
    BaseString::snprintf(buf, sizeof(buf), "%s", ctx.fname);
548
  if(ctx.type == InitConfigFileParser::DefaultSection)
549 550
    BaseString::snprintf(buf, sizeof(buf), "%s DEFAULT", ctx.fname);
  BaseString::snprintf(ctx.fname, sizeof(ctx.fname), buf);
551 552 553
  if(ctx.type == InitConfigFileParser::Section){
    for(int i = 0; i<m_info->m_NoOfRules; i++){
      const ConfigInfo::SectionRule & rule = m_info->m_SectionRules[i];
554 555
      if(!strcmp(rule.m_section, "*") || !strcmp(rule.m_section, ctx.fname)){
	if(!(* rule.m_sectionRule)(ctx, rule.m_ruleData)){
556
	  return false;
557 558
	}
      }
559
    }
560 561
  }
  if(ctx.type == InitConfigFileParser::DefaultSection)
562
    require(ctx.m_defaults->put(ctx.pname, ctx.m_currentSection));
563
  if(ctx.type == InitConfigFileParser::Section)
564
    require(ctx.m_config->put(ctx.pname, ctx.m_currentSection));
565 566 567 568 569 570 571 572 573 574 575
  delete ctx.m_currentSection; ctx.m_currentSection = NULL;
  return true;
}

void
InitConfigFileParser::Context::reportError(const char * fmt, ...){
  va_list ap;
  char buf[1000];
  
  va_start(ap, fmt);
  if (fmt != 0)
576
    BaseString::vsnprintf(buf, sizeof(buf)-1, fmt, ap);
577
  va_end(ap);
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
578 579
  fprintf(m_errstream, "Error line %d: %s\n",
	  m_lineno, buf);
580 581 582 583 584 585 586 587 588 589 590

  //m_currentSection->print();
}

void
InitConfigFileParser::Context::reportWarning(const char * fmt, ...){
  va_list ap;
  char buf[1000];
  
  va_start(ap, fmt);
  if (fmt != 0)
591
    BaseString::vsnprintf(buf, sizeof(buf)-1, fmt, ap);
592
  va_end(ap);
jonas@perch.ndb.mysql.com's avatar
ndb -  
jonas@perch.ndb.mysql.com committed
593 594
  fprintf(m_errstream, "Warning line %d: %s\n",
	  m_lineno, buf);
595
}