Logo Search packages:      
Sourcecode: adplug version File versions  Download package

adplugdb.cpp

/*
 * AdPlug - Replayer for many OPL2/OPL3 audio file formats.
 * Copyright (c) 1999 - 2003 Simon Peter <dn.tlp@gmx.net>, et al.
 * 
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * adplugdb.cpp - AdPlug database maintenance utility
 * Copyright (c) 2002 Riven the Mage <riven@ok.ru>
 * Copyright (c) 2002, 2003 Simon Peter <dn.tlp@gmx.net>
 */

#include <memory.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <binfile.h>
#include <string>
#include <iostream>

#if defined(HAVE_SYS_TYPES_H) && defined(HAVE_SYS_STAT_H)
#  if HAVE_SYS_TYPES_H
#    include <sys/types.h>
#  endif
#  if HAVE_SYS_STAT_H
#    include <sys/stat.h>
#  endif
#endif

#ifndef HAVE_MKDIR
#  define HAVE_MKDIR  0
#endif

#include "../src/adplug.h"
#include "../src/silentopl.h"
#include "../src/database.h"

/*
 * Apple (OS X) and Sun systems declare getopt in unistd.h, other systems
 * (Linux) use getopt.h.
 */
#if defined ( __APPLE__ ) || ( defined (__SVR4) && defined (__sun) )
#     include <unistd.h>
#else
#     include "getopt.h"
#endif

/***** Defines *****/

// Default file name of AdPlug's database file
#define ADPLUGDB_FILE         "adplug.db"

// Default AdPlug user's configuration subdirectory
#define ADPLUG_CONFDIR        ".adplug"

// Default path to AdPlug's system-wide database file
#ifdef ADPLUG_DATA_DIR
#  define ADPLUGDB_PATH       ADPLUG_DATA_DIR "/" ADPLUGDB_FILE
#else
#  define ADPLUGDB_PATH       ADPLUGDB_FILE
#endif

// Unknown filetype indicator
#define UNKNOWN_FILETYPE      "*** Unknown ***"

// Message urgency levels
#define MSG_PANIC 0     // Unmaskable
#define MSG_ERROR 1
#define MSG_WARN  2
#define MSG_NOTE  3
#define MSG_DEBUG 4

/***** Global variables *****/

static const struct {
  const char                        *typestr;
  CAdPlugDatabase::CRecord::RecordType    type;
} rtypes[] = {
  { "plain", CAdPlugDatabase::CRecord::Plain },
  { "songinfo", CAdPlugDatabase::CRecord::SongInfo },
  { "clockspeed", CAdPlugDatabase::CRecord::ClockSpeed },
  {0}
};

static struct {
  char                        *db_file;
  CAdPlugDatabase::CRecord::RecordType    rtype;
  int                         message_level;
  bool                              usedefaultdb, usercomment, cmdkeys;
  const char                        *homedir;
} cfg = {
  ADPLUGDB_PATH,
  CAdPlugDatabase::CRecord::Plain,
  MSG_NOTE,
  false, false, false,
  NULL
};

static CAdPlugDatabase  mydb;
static const char *program_name;

/***** Functions *****/

static void message(int level, const char *fmt, ...)
{
  va_list argptr;

  if(cfg.message_level < level) return;

  fprintf(stderr, "%s: ", program_name);
  va_start(argptr, fmt);
  vfprintf(stderr, fmt, argptr);
  va_end(argptr);
  fprintf(stderr, "\n");
}

static CAdPlugDatabase::CKey file2key(const char *filename)
{
  if(cfg.cmdkeys) {     // We got a key spec
    CAdPlugDatabase::CKey key;

    sscanf(filename, "%hx:%lx", &key.crc16, &key.crc32);
    return key;
  } else {        // We got a real filename
    binifstream f(filename);

    if(f.error()) {
      message(MSG_ERROR, "can't open specified file -- %s", filename);
      exit(EXIT_FAILURE);
    }

    return CAdPlugDatabase::CKey(f);
  }
}

static void usage()
{
  printf("Usage: %s [options] <command> [arguments]\n\n"
       "Commands:\n"
       "  add <files>      Add (and replace) files to database\n"
       "  list [files]     List files (or everything) from database\n"
       "  remove <files>   Remove files from database\n"
       "  merge <files>    Merge other databases with the current one\n"
       "\n"
       "Database options:\n"
       "  -d <file>        Use different database file\n"
#ifdef ADPLUG_DATA_DIR
       "  -s               Use system-wide database file (" ADPLUGDB_PATH ")\n"
#endif
       "  -t <type>        Add as different record type (plain, songinfo, clockspeed)\n"
       "  -c               Prompt for record comment\n"
       "  -k               Specify keys instead of files on commandline\n"
       "\n"
       "Generic options:\n"
       "  -q               Be more quiet\n"
       "  -v               Be more verbose\n"
       "  -h               Display this help\n"
       "  -V               Display version information\n",
       program_name);
}

static const std::string file2type(const char *filename)
{
  CPlayers::const_iterator    i;
  CSilentopl                  opl;
  CPlayer               *p;

  for(i = CAdPlug::players.begin(); i != CAdPlug::players.end(); i++)
    if((p = (*i)->factory(&opl)))
      if(p->load(filename)) {
      delete p;
      return (*i)->filetype;
      } else
      delete p;

  message(MSG_WARN, "unknown filetype -- %s", filename);
  return UNKNOWN_FILETYPE;
}

static void db_add(const char *filename)
{
  CAdPlugDatabase::CRecord *record = CAdPlugDatabase::CRecord::factory(cfg.rtype);

  if(cfg.cmdkeys) {
    message(MSG_ERROR, "adding records is only possible while specifying"
          "filenames");
    exit(EXIT_FAILURE);
  }

  if(!record) {
    message(MSG_PANIC, "internal error (not enough memory?)");
    exit(EXIT_FAILURE);
  }

  record->key = file2key(filename);
  record->filetype = file2type(filename);
  if(cfg.usercomment)
    std::cin >> record->comment;
  else
    record->comment = filename;
  if(record->filetype == UNKNOWN_FILETYPE) { delete record; return; }
  if(!record->user_read(std::cin, std::cout)) {
    message(MSG_ERROR, "data entry error");
    exit(EXIT_FAILURE);
  }

  if(mydb.lookup(record->key)) {
    message(MSG_NOTE, "replacing previous record -- %s", filename);
    mydb.wipe();
  }

  if(mydb.insert(record)) {
    message(MSG_NOTE, "added record, file type \"%s\" -- %s",
          record->filetype.c_str(), filename);
  } else {
    delete record;
    message(MSG_ERROR, "error adding record to database -- %s", filename);
    exit(EXIT_FAILURE);
  }
}

static bool db_resolve(const char *filename)
/* Resolves and lists one entry from the database */
{
  if(mydb.lookup(file2key(filename))) {
    message(MSG_NOTE, "viewing entry -- %s", filename);
    mydb.get_record()->user_write(std::cout);
    return true;
  } else {
    message(MSG_WARN, "no entry in database -- %s", filename);
    return false;
  }
}

static void db_remove(const char *filename)
/* Removes one entry from the database */
{
  if(mydb.lookup(file2key(filename))) {
    mydb.wipe();
    message(MSG_NOTE, "deleted entry -- %s", filename);
  } else
    message(MSG_WARN, "no entry in database, could not delete -- %s", filename);
}

static void copyright()
/* Print copyright notice and version information */
{
  printf("AdPlug database maintenance utility %s\n", CAdPlug::get_version().c_str());
  printf("Copyright (c) 2002 Riven the Mage <riven@ok.ru>\n"
       "Copyright (c) 2002, 2003 Simon Peter <dn.tlp@gmx.net>\n");
}

static void db_error(bool dbokay)
/* Checks if database is open. Exits program otherwise */
{
  if(!dbokay) {   // Database could not be opened
    message(MSG_ERROR, "database could not be opened -- %s", cfg.db_file);
    exit(EXIT_FAILURE);
  }
}

static void db_save(void)
/* Saves database to file, making path if it doesn't exist yet. */
{
#if HAVE_MKDIR
  std::string savedir;
#endif

  if(!mydb.save(cfg.db_file)) {
#if HAVE_MKDIR
    if(cfg.homedir) {
      savedir = cfg.homedir; savedir += "/" ADPLUG_CONFDIR;
      mkdir(savedir.c_str(), 0755);
      if(mydb.save(cfg.db_file)) return;
    }
#endif
    message(MSG_ERROR, "could not save database -- %s", cfg.db_file);
  }
}

static void shutdown(void)
{
  // Free userdb variable, if applicable
  if(cfg.homedir && !cfg.usedefaultdb) free(cfg.db_file);
}

/***** Main program *****/

int main(int argc, char *argv[])
{
  char            opt;
  bool            dbokay;
  unsigned int    i;

  // Init
  program_name = strrchr(argv[0], '/') ? strrchr(argv[0], '/') + 1 :
      (strrchr(argv[0], '\\') ? strrchr(argv[0], '\\') + 1 : argv[0]);
  atexit(shutdown);

  // Parse options
  while((opt = getopt(argc, argv, "d:t:qvhVsck")) != -1)
    switch(opt) {
    case 'd': cfg.db_file = optarg; break;            // Set database file
    case 't': // Different record type
      for(i = 0; rtypes[i].typestr; i++)
      if(!strcmp(rtypes[i].typestr, optarg)) {
        cfg.rtype = rtypes[i].type;
        break;
      }

      if(!rtypes[i].typestr) {
      message(MSG_ERROR, "unknown record type -- %s", optarg);
      exit(EXIT_FAILURE);
      }
      break;
    case 'q': if(cfg.message_level) cfg.message_level--; break;   // Be more quiet
    case 'v': cfg.message_level++; break;             // Be more verbose
    case 'h': usage(); exit(EXIT_SUCCESS); break;     // Display help
    case 'V': copyright(); exit(EXIT_SUCCESS); break; // Display version
    case 's':                                   // Use system-wide database
#ifdef ADPLUG_DATA_DIR
      cfg.usedefaultdb = true;
#else
      message(MSG_WARN, "option not supported on this system -- s");
#endif
      break;
    case 'c': cfg.usercomment = true; break;          // Prompt for comments
    case 'k': cfg.cmdkeys = true; break;        // Keys on commandline
    case '?': exit(EXIT_FAILURE);
    }

  // Check for commands
  if(argc == optind) {
    fprintf(stderr, "%s: need a command\n", program_name);
    fprintf(stderr, "Try '%s -h' for more information.\n", program_name);
    exit(EXIT_FAILURE);
  }

  // Try user's home directory first, before trying the default location.
  cfg.homedir = getenv("HOME");
  if(cfg.homedir && !cfg.usedefaultdb) {
    cfg.db_file = (char *)malloc(strlen(cfg.homedir) + strlen(ADPLUG_CONFDIR) +
                                                 strlen(ADPLUGDB_FILE) + 3);
    strcpy(cfg.db_file, cfg.homedir);
      strcat(cfg.db_file, "/" ADPLUG_CONFDIR "/");
      strcat(cfg.db_file, ADPLUGDB_FILE);
  }

  // Load database file
  message(MSG_DEBUG, "using database -- %s", cfg.db_file);
  dbokay = mydb.load(cfg.db_file);

  // Parse commands
  if(!strcmp(argv[optind], "add")) {      // Add file to database
    if(++optind < argc) {
      for(;optind < argc; optind++)
      db_add(argv[optind]);
      db_save();
    } else {
      message(MSG_ERROR, "add -- missing file argument");
      exit(EXIT_FAILURE);
    }
  } else
  if(!strcmp(argv[optind], "list")) {     // List (files from) database
    db_error(dbokay);
    if(++optind < argc) {
      for(;optind < argc; optind++) {
      db_resolve(argv[optind]);
      printf("\n");
      }
    } else {
      mydb.goto_begin();
      do {
      mydb.get_record()->user_write(std::cout);
      printf("\n");
      } while(mydb.go_forward());
    }
  } else
  if(!strcmp(argv[optind], "remove")) {   // Remove files from database
    db_error(dbokay);
    if(++optind < argc) {
      for(;optind < argc; optind++)
      db_remove(argv[optind]);
      db_save();
    } else {
      message(MSG_ERROR, "remove -- missing file argument");
      exit(EXIT_FAILURE);
    }
  } else
  if(!strcmp(argv[optind], "merge")) {    // Merge databases together
    db_error(dbokay);
    if(++optind < argc) {
      for(;optind < argc; optind++)
      if(mydb.load(argv[optind]))
        message(MSG_NOTE, "merged database -- %s", argv[optind]);
      else
        message(MSG_WARN, "could not open database -- %s", argv[optind]);
      db_save();
    } else {
      message(MSG_ERROR, "merge -- missing file argument");
      exit(EXIT_FAILURE);
    }
  } else {
    message(MSG_ERROR, "unknown command -- %s", argv[optind]);
    exit(EXIT_FAILURE);
  }

  return EXIT_SUCCESS;
}

Generated by  Doxygen 1.6.0   Back to index