backendmanager.h

Go to the documentation of this file.

/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2010,2011,2017,2018 Olly Betts
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef OM_HGUARD_BACKENDMANAGER_H
#define OM_HGUARD_BACKENDMANAGER_H

#include <xapian.h>
#include <vector>

// Paths to xapian-tcpsrv and xapian-progsrv.
#ifdef __WIN32__
// Under __WIN32__ we want \ path separators since we pass this path to
// CreateProcess().
# define XAPIAN_BIN_PATH "..\\bin\\"
# define EXE_SUFFIX ".exe"
#else
# define XAPIAN_BIN_PATH "../bin/"
# define EXE_SUFFIX
#endif
#define XAPIAN_TCPSRV XAPIAN_BIN_PATH "xapian-tcpsrv" EXE_SUFFIX
#define XAPIAN_PROGSRV XAPIAN_BIN_PATH "xapian-progsrv" EXE_SUFFIX

class BackendManager {
    std::string datadir;

    std::string dbtype;

  protected:
    void index_files_to_database(Xapian::WritableDatabase & database,
                                 const std::vector<std::string> & files);

    bool create_dir_if_needed(const std::string &dirname);

    virtual Xapian::Database do_get_database(const std::vector<std::string> &files);

    virtual std::string do_get_database_path(const std::vector<std::string> &files);

  public:
    BackendManager(const std::string& datadir_, const std::string& dbtype_)
        : datadir(datadir_), dbtype(dbtype_) {}

    virtual ~BackendManager();

    const std::string& get_dbtype() const { return dbtype; }

    const std::string & get_datadir() const { return datadir; }

    Xapian::Database get_database(const std::vector<std::string> &files);

    Xapian::Database get_database(const std::string &file);

    Xapian::Database get_database(const std::string &dbname,
                                  void (*gen)(Xapian::WritableDatabase&,
                                              const std::string &),
                                  const std::string &arg);

    virtual Xapian::Database get_database_by_path(const std::string& path);

    std::string get_database_path(const std::vector<std::string> &files);

    std::string get_database_path(const std::string &file);

    std::string get_database_path(const std::string &dbname,
                                  void (*gen)(Xapian::WritableDatabase&,
                                              const std::string &),
                                  const std::string &arg);

    virtual Xapian::WritableDatabase get_writable_database(const std::string & name, const std::string & file);

    virtual Xapian::WritableDatabase
    get_remote_writable_database(std::string args);

    virtual std::string get_writable_database_path(const std::string & name);

    virtual Xapian::WritableDatabase
    get_generated_database(const std::string& name);

    virtual std::string get_generated_database_path(const std::string & name);

    virtual void finalise_generated_database(const std::string& name);

    virtual Xapian::Database get_remote_database(const std::vector<std::string> & files, unsigned int timeout);

    virtual std::string get_writable_database_args(const std::string& path,
                                                   unsigned int timeout);

    virtual Xapian::Database get_writable_database_as_database();

    virtual Xapian::WritableDatabase get_writable_database_again();

    virtual std::string get_writable_database_path_again();

    virtual std::string get_compaction_output_path(const std::string& name);

    virtual void clean_up();

    static const char * get_xapian_progsrv_command();
};

#endif /* OM_HGUARD_BACKENDMANAGER_H */